423 lines
17 KiB
C++
423 lines
17 KiB
C++
#ifndef PROTOCOL_H
|
|
#define PROTOCOL_H
|
|
|
|
#include <QString>
|
|
#include <QMap>
|
|
#include <QHash>
|
|
#include <QObject>
|
|
#include <QVariant>
|
|
#include "protocol_item_ids.h"
|
|
#include "protocol_datastructures.h"
|
|
|
|
class QXmlStreamReader;
|
|
class QXmlStreamWriter;
|
|
class QXmlStreamAttributes;
|
|
|
|
class ProtocolResponse;
|
|
class DeckList;
|
|
class GameEvent;
|
|
class GameEventContainer;
|
|
class MoveCardToZone;
|
|
|
|
enum ItemId {
|
|
ItemId_CommandContainer = ItemId_Other + 50,
|
|
ItemId_GameEventContainer = ItemId_Other + 51,
|
|
ItemId_Command_DeckUpload = ItemId_Other + 100,
|
|
ItemId_Command_DeckSelect = ItemId_Other + 101,
|
|
ItemId_Command_SetSideboardPlan = ItemId_Other + 102,
|
|
ItemId_Event_ListChatChannels = ItemId_Other + 200,
|
|
ItemId_Event_ChatListPlayers = ItemId_Other + 201,
|
|
ItemId_Event_ChatJoinChannel = ItemId_Other + 202,
|
|
ItemId_Event_ListGames = ItemId_Other + 203,
|
|
ItemId_Event_UserJoined = ItemId_Other + 204,
|
|
ItemId_Event_GameStateChanged = ItemId_Other + 205,
|
|
ItemId_Event_PlayerPropertiesChanged = ItemId_Other + 206,
|
|
ItemId_Event_CreateArrows = ItemId_Other + 207,
|
|
ItemId_Event_CreateCounters = ItemId_Other + 208,
|
|
ItemId_Event_DrawCards = ItemId_Other + 209,
|
|
ItemId_Event_Join = ItemId_Other + 210,
|
|
ItemId_Event_Ping = ItemId_Other + 211,
|
|
ItemId_Response_ListUsers = ItemId_Other + 300,
|
|
ItemId_Response_GetUserInfo = ItemId_Other + 301,
|
|
ItemId_Response_DeckList = ItemId_Other + 302,
|
|
ItemId_Response_DeckDownload = ItemId_Other + 303,
|
|
ItemId_Response_DeckUpload = ItemId_Other + 304,
|
|
ItemId_Response_DumpZone = ItemId_Other + 305,
|
|
ItemId_Invalid = ItemId_Other + 1000
|
|
};
|
|
|
|
class ProtocolItem : public SerializableItem_Map {
|
|
Q_OBJECT
|
|
private:
|
|
static void initializeHashAuto();
|
|
bool receiverMayDelete;
|
|
public:
|
|
static const int protocolVersion = 9;
|
|
static void initializeHash();
|
|
virtual int getItemId() const = 0;
|
|
bool getReceiverMayDelete() const { return receiverMayDelete; }
|
|
void setReceiverMayDelete(bool _receiverMayDelete) { receiverMayDelete = _receiverMayDelete; }
|
|
ProtocolItem(const QString &_itemType, const QString &_itemSubType);
|
|
};
|
|
|
|
class ProtocolItem_Invalid : public ProtocolItem {
|
|
public:
|
|
ProtocolItem_Invalid() : ProtocolItem(QString(), QString()) { }
|
|
int getItemId() const { return ItemId_Invalid; }
|
|
};
|
|
|
|
class TopLevelProtocolItem : public SerializableItem {
|
|
Q_OBJECT
|
|
signals:
|
|
void protocolItemReceived(ProtocolItem *item);
|
|
private:
|
|
ProtocolItem *currentItem;
|
|
bool readCurrentItem(QXmlStreamReader *xml);
|
|
public:
|
|
TopLevelProtocolItem();
|
|
bool readElement(QXmlStreamReader *xml);
|
|
void writeElement(QXmlStreamWriter *xml);
|
|
};
|
|
|
|
// ----------------
|
|
// --- COMMANDS ---
|
|
// ----------------
|
|
|
|
class Command : public ProtocolItem {
|
|
Q_OBJECT
|
|
signals:
|
|
void finished(ProtocolResponse *response);
|
|
void finished(ResponseCode response);
|
|
private:
|
|
QVariant extraData;
|
|
public:
|
|
Command(const QString &_itemName = QString());
|
|
void setExtraData(const QVariant &_extraData) { extraData = _extraData; }
|
|
QVariant getExtraData() const { return extraData; }
|
|
void processResponse(ProtocolResponse *response);
|
|
};
|
|
|
|
class CommandContainer : public ProtocolItem {
|
|
Q_OBJECT
|
|
signals:
|
|
void finished(ProtocolResponse *response);
|
|
void finished(ResponseCode response);
|
|
private:
|
|
int ticks;
|
|
static int lastCmdId;
|
|
|
|
// XXX Move these out. They are only for processing inside the server.
|
|
ProtocolResponse *resp;
|
|
QList<ProtocolItem *> itemQueue;
|
|
GameEventContainer *gameEventQueuePublic;
|
|
GameEventContainer *gameEventQueueOmniscient;
|
|
GameEventContainer *gameEventQueuePrivate;
|
|
public:
|
|
CommandContainer(const QList<Command *> &_commandList = QList<Command *>(), int _cmdId = -1);
|
|
static SerializableItem *newItem() { return new CommandContainer; }
|
|
int getItemId() const { return ItemId_CommandContainer; }
|
|
int getCmdId() const { return static_cast<SerializableItem_Int *>(itemMap.value("cmd_id"))->getData(); }
|
|
int tick() { return ++ticks; }
|
|
void processResponse(ProtocolResponse *response);
|
|
QList<Command *> getCommandList() const { return typecastItemList<Command *>(); }
|
|
|
|
ProtocolResponse *getResponse() const { return resp; }
|
|
void setResponse(ProtocolResponse *_resp);
|
|
const QList<ProtocolItem *> &getItemQueue() const { return itemQueue; }
|
|
void enqueueItem(ProtocolItem *item) { itemQueue.append(item); }
|
|
GameEventContainer *getGameEventQueuePublic() const { return gameEventQueuePublic; }
|
|
void enqueueGameEventPublic(GameEvent *event, int gameId);
|
|
GameEventContainer *getGameEventQueueOmniscient() const { return gameEventQueueOmniscient; }
|
|
void enqueueGameEventOmniscient(GameEvent *event, int gameId);
|
|
GameEventContainer *getGameEventQueuePrivate() const { return gameEventQueuePrivate; }
|
|
void enqueueGameEventPrivate(GameEvent *event, int gameId);
|
|
};
|
|
|
|
class ChatCommand : public Command {
|
|
Q_OBJECT
|
|
public:
|
|
ChatCommand(const QString &_cmdName, const QString &_channel)
|
|
: Command(_cmdName)
|
|
{
|
|
insertItem(new SerializableItem_String("channel", _channel));
|
|
}
|
|
QString getChannel() const { return static_cast<SerializableItem_String *>(itemMap.value("channel"))->getData(); }
|
|
};
|
|
|
|
class GameCommand : public Command {
|
|
Q_OBJECT
|
|
public:
|
|
GameCommand(const QString &_cmdName, int _gameId)
|
|
: Command(_cmdName)
|
|
{
|
|
insertItem(new SerializableItem_Int("game_id", _gameId));
|
|
}
|
|
int getGameId() const { return static_cast<SerializableItem_Int *>(itemMap.value("game_id"))->getData(); }
|
|
void setGameId(int _gameId) { static_cast<SerializableItem_Int *>(itemMap.value("game_id"))->setData(_gameId); }
|
|
};
|
|
|
|
class Command_DeckUpload : public Command {
|
|
Q_OBJECT
|
|
public:
|
|
Command_DeckUpload(DeckList *_deck = 0, const QString &_path = QString());
|
|
static SerializableItem *newItem() { return new Command_DeckUpload; }
|
|
int getItemId() const { return ItemId_Command_DeckUpload; }
|
|
DeckList *getDeck() const;
|
|
QString getPath() const { return static_cast<SerializableItem_String *>(itemMap.value("path"))->getData(); }
|
|
};
|
|
|
|
class Command_DeckSelect : public GameCommand {
|
|
Q_OBJECT
|
|
public:
|
|
Command_DeckSelect(int _gameId = -1, DeckList *_deck = 0, int _deckId = -1);
|
|
static SerializableItem *newItem() { return new Command_DeckSelect; }
|
|
int getItemId() const { return ItemId_Command_DeckSelect; }
|
|
DeckList *getDeck() const;
|
|
int getDeckId() const { return static_cast<SerializableItem_Int *>(itemMap.value("deck_id"))->getData(); }
|
|
};
|
|
|
|
class Command_SetSideboardPlan : public GameCommand {
|
|
Q_OBJECT
|
|
public:
|
|
Command_SetSideboardPlan(int _gameId = -1, const QList<MoveCardToZone *> &_moveList = QList<MoveCardToZone *>());
|
|
static SerializableItem *newItem() { return new Command_SetSideboardPlan; }
|
|
int getItemId() const { return ItemId_Command_SetSideboardPlan; }
|
|
QList<MoveCardToZone *> getMoveList() const;
|
|
};
|
|
|
|
// -----------------
|
|
// --- RESPONSES ---
|
|
// -----------------
|
|
|
|
class ProtocolResponse : public ProtocolItem {
|
|
Q_OBJECT
|
|
private:
|
|
static QHash<QString, ResponseCode> responseHash;
|
|
public:
|
|
ProtocolResponse(int _cmdId = -1, ResponseCode _responseCode = RespNothing, const QString &_itemName = QString());
|
|
int getItemId() const { return ItemId_Other; }
|
|
static void initializeHash();
|
|
static SerializableItem *newItem() { return new ProtocolResponse; }
|
|
int getCmdId() const { return static_cast<SerializableItem_Int *>(itemMap.value("cmd_id"))->getData(); }
|
|
ResponseCode getResponseCode() const { return responseHash.value(static_cast<SerializableItem_String *>(itemMap.value("response_code"))->getData(), RespOk); }
|
|
};
|
|
|
|
class Response_ListUsers : public ProtocolResponse {
|
|
Q_OBJECT
|
|
public:
|
|
Response_ListUsers(int _cmdId = -1, ResponseCode _responseCode = RespOk, const QList<ServerInfo_User *> &_userList = QList<ServerInfo_User *>());
|
|
int getItemId() const { return ItemId_Response_ListUsers; }
|
|
static SerializableItem *newItem() { return new Response_ListUsers; }
|
|
QList<ServerInfo_User *> getUserList() const { return typecastItemList<ServerInfo_User *>(); }
|
|
};
|
|
|
|
class Response_GetUserInfo : public ProtocolResponse {
|
|
Q_OBJECT
|
|
public:
|
|
Response_GetUserInfo(int _cmdId = -1, ResponseCode _responseCode = RespOk, ServerInfo_User *_userInfo = 0);
|
|
int getItemId() const { return ItemId_Response_GetUserInfo; }
|
|
static SerializableItem *newItem() { return new Response_GetUserInfo; }
|
|
ServerInfo_User *getUserInfo() const { return static_cast<ServerInfo_User *>(itemMap.value("user")); }
|
|
};
|
|
|
|
class Response_DeckList : public ProtocolResponse {
|
|
Q_OBJECT
|
|
public:
|
|
Response_DeckList(int _cmdId = -1, ResponseCode _responseCode = RespOk, DeckList_Directory *_root = 0);
|
|
int getItemId() const { return ItemId_Response_DeckList; }
|
|
static SerializableItem *newItem() { return new Response_DeckList; }
|
|
DeckList_Directory *getRoot() const { return static_cast<DeckList_Directory *>(itemMap.value("directory")); }
|
|
};
|
|
|
|
class Response_DeckDownload : public ProtocolResponse {
|
|
Q_OBJECT
|
|
public:
|
|
Response_DeckDownload(int _cmdId = -1, ResponseCode _responseCode = RespOk, DeckList *_deck = 0);
|
|
int getItemId() const { return ItemId_Response_DeckDownload; }
|
|
static SerializableItem *newItem() { return new Response_DeckDownload; }
|
|
DeckList *getDeck() const;
|
|
};
|
|
|
|
class Response_DeckUpload : public ProtocolResponse {
|
|
Q_OBJECT
|
|
public:
|
|
Response_DeckUpload(int _cmdId = -1, ResponseCode _responseCode = RespOk, DeckList_File *_file = 0);
|
|
int getItemId() const { return ItemId_Response_DeckUpload; }
|
|
static SerializableItem *newItem() { return new Response_DeckUpload; }
|
|
DeckList_File *getFile() const { return static_cast<DeckList_File *>(itemMap.value("file")); }
|
|
};
|
|
|
|
class Response_DumpZone : public ProtocolResponse {
|
|
Q_OBJECT
|
|
public:
|
|
Response_DumpZone(int _cmdId = -1, ResponseCode _responseCode = RespOk, ServerInfo_Zone *zone = 0);
|
|
int getItemId() const { return ItemId_Response_DumpZone; }
|
|
static SerializableItem *newItem() { return new Response_DumpZone; }
|
|
ServerInfo_Zone *getZone() const { return static_cast<ServerInfo_Zone *>(itemMap.value("zone")); }
|
|
};
|
|
|
|
// --------------
|
|
// --- EVENTS ---
|
|
// --------------
|
|
|
|
class GenericEvent : public ProtocolItem {
|
|
Q_OBJECT
|
|
public:
|
|
GenericEvent(const QString &_eventName)
|
|
: ProtocolItem("generic_event", _eventName) { }
|
|
};
|
|
|
|
class GameEvent : public ProtocolItem {
|
|
Q_OBJECT
|
|
public:
|
|
GameEvent(const QString &_eventName, int _playerId);
|
|
int getPlayerId() const { return static_cast<SerializableItem_Int *>(itemMap.value("player_id"))->getData(); }
|
|
};
|
|
|
|
class GameEventContext : public ProtocolItem {
|
|
Q_OBJECT
|
|
public:
|
|
GameEventContext(const QString &_contextName);
|
|
};
|
|
|
|
class GameEventContainer : public ProtocolItem {
|
|
Q_OBJECT
|
|
private:
|
|
QList<GameEvent *> eventList;
|
|
GameEventContext *context;
|
|
protected:
|
|
void extractData();
|
|
public:
|
|
GameEventContainer(const QList<GameEvent *> &_eventList = QList<GameEvent *>(), int _gameId = -1, GameEventContext *_context = 0);
|
|
static SerializableItem *newItem() { return new GameEventContainer; }
|
|
int getItemId() const { return ItemId_GameEventContainer; }
|
|
QList<GameEvent *> getEventList() const { return eventList; }
|
|
GameEventContext *getContext() const { return context; }
|
|
void setContext(GameEventContext *_context);
|
|
void addGameEvent(GameEvent *event);
|
|
static GameEventContainer *makeNew(GameEvent *event, int _gameId);
|
|
|
|
int getGameId() const { return static_cast<SerializableItem_Int *>(itemMap.value("game_id"))->getData(); }
|
|
void setGameId(int _gameId) { static_cast<SerializableItem_Int *>(itemMap.value("game_id"))->setData(_gameId); }
|
|
};
|
|
|
|
class ChatEvent : public ProtocolItem {
|
|
Q_OBJECT
|
|
public:
|
|
ChatEvent(const QString &_eventName, const QString &_channel);
|
|
QString getChannel() const { return static_cast<SerializableItem_String *>(itemMap.value("channel"))->getData(); }
|
|
};
|
|
|
|
class Event_ListChatChannels : public GenericEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_ListChatChannels(const QList<ServerInfo_ChatChannel *> &_channelList = QList<ServerInfo_ChatChannel *>());
|
|
int getItemId() const { return ItemId_Event_ListChatChannels; }
|
|
static SerializableItem *newItem() { return new Event_ListChatChannels; }
|
|
QList<ServerInfo_ChatChannel *> getChannelList() const { return typecastItemList<ServerInfo_ChatChannel *>(); }
|
|
};
|
|
|
|
class Event_ChatListPlayers : public ChatEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_ChatListPlayers(const QString &_channel = QString(), const QList<ServerInfo_User *> &_playerList = QList<ServerInfo_User *>());
|
|
int getItemId() const { return ItemId_Event_ChatListPlayers; }
|
|
static SerializableItem *newItem() { return new Event_ChatListPlayers; }
|
|
QList<ServerInfo_User *> getPlayerList() const { return typecastItemList<ServerInfo_User *>(); }
|
|
};
|
|
|
|
class Event_ChatJoinChannel : public ChatEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_ChatJoinChannel(const QString &_channel = QString(), ServerInfo_User *_info = 0);
|
|
int getItemId() const { return ItemId_Event_ChatJoinChannel; }
|
|
static SerializableItem *newItem() { return new Event_ChatJoinChannel; }
|
|
ServerInfo_User *getUserInfo() const { return static_cast<ServerInfo_User *>(itemMap.value("user")); }
|
|
};
|
|
|
|
class Event_ListGames : public GenericEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_ListGames(const QList<ServerInfo_Game *> &_gameList = QList<ServerInfo_Game *>());
|
|
int getItemId() const { return ItemId_Event_ListGames; }
|
|
static SerializableItem *newItem() { return new Event_ListGames; }
|
|
QList<ServerInfo_Game *> getGameList() const { return typecastItemList<ServerInfo_Game *>(); }
|
|
};
|
|
|
|
class Event_UserJoined : public GenericEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_UserJoined(ServerInfo_User *_userInfo = 0);
|
|
int getItemId() const { return ItemId_Event_UserJoined; }
|
|
static SerializableItem *newItem() { return new Event_UserJoined; }
|
|
ServerInfo_User *getUserInfo() const { return static_cast<ServerInfo_User *>(itemMap.value("user")); }
|
|
};
|
|
|
|
class Event_Join : public GameEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_Join(ServerInfo_PlayerProperties *player = 0);
|
|
static SerializableItem *newItem() { return new Event_Join; }
|
|
int getItemId() const { return ItemId_Event_Join; }
|
|
ServerInfo_PlayerProperties *getPlayer() const { return static_cast<ServerInfo_PlayerProperties *>(itemMap.value("player_properties")); }
|
|
};
|
|
|
|
class Event_GameStateChanged : public GameEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_GameStateChanged(bool _gameStarted = false, int _activePlayer = -1, int _activePhase = -1, const QList<ServerInfo_Player *> &_playerList = QList<ServerInfo_Player *>());
|
|
static SerializableItem *newItem() { return new Event_GameStateChanged; }
|
|
int getItemId() const { return ItemId_Event_GameStateChanged; }
|
|
QList<ServerInfo_Player *> getPlayerList() const { return typecastItemList<ServerInfo_Player *>(); }
|
|
bool getGameStarted() const { return static_cast<SerializableItem_Bool *>(itemMap.value("game_started"))->getData(); }
|
|
int getActivePlayer() const { return static_cast<SerializableItem_Int *>(itemMap.value("active_player"))->getData(); }
|
|
int getActivePhase() const { return static_cast<SerializableItem_Int *>(itemMap.value("active_phase"))->getData(); }
|
|
};
|
|
|
|
class Event_PlayerPropertiesChanged : public GameEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_PlayerPropertiesChanged(int _playerId = -1, ServerInfo_PlayerProperties *_properties = 0);
|
|
static SerializableItem *newItem() { return new Event_PlayerPropertiesChanged; }
|
|
int getItemId() const { return ItemId_Event_PlayerPropertiesChanged; }
|
|
ServerInfo_PlayerProperties *getProperties() const { return static_cast<ServerInfo_PlayerProperties *>(itemMap.value("player_properties")); }
|
|
};
|
|
|
|
class Event_Ping : public GameEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_Ping(const QList<ServerInfo_PlayerPing *> &_pingList = QList<ServerInfo_PlayerPing *>());
|
|
static SerializableItem *newItem() { return new Event_Ping; }
|
|
int getItemId() const { return ItemId_Event_Ping; }
|
|
QList<ServerInfo_PlayerPing *> getPingList() const { return typecastItemList<ServerInfo_PlayerPing *>(); }
|
|
};
|
|
|
|
class Event_CreateArrows : public GameEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_CreateArrows(int _playerId = -1, const QList<ServerInfo_Arrow *> &_arrowList = QList<ServerInfo_Arrow *>());
|
|
int getItemId() const { return ItemId_Event_CreateArrows; }
|
|
static SerializableItem *newItem() { return new Event_CreateArrows; }
|
|
QList<ServerInfo_Arrow *> getArrowList() const { return typecastItemList<ServerInfo_Arrow *>(); }
|
|
};
|
|
|
|
class Event_CreateCounters : public GameEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_CreateCounters(int _playerId = -1, const QList<ServerInfo_Counter *> &_counterList = QList<ServerInfo_Counter *>());
|
|
int getItemId() const { return ItemId_Event_CreateCounters; }
|
|
static SerializableItem *newItem() { return new Event_CreateCounters; }
|
|
QList<ServerInfo_Counter *> getCounterList() const { return typecastItemList<ServerInfo_Counter *>(); }
|
|
};
|
|
|
|
class Event_DrawCards : public GameEvent {
|
|
Q_OBJECT
|
|
public:
|
|
Event_DrawCards(int _playerId = -1, int numberCards = -1, const QList<ServerInfo_Card *> &_cardList = QList<ServerInfo_Card *>());
|
|
int getItemId() const { return ItemId_Event_DrawCards; }
|
|
static SerializableItem *newItem() { return new Event_DrawCards; }
|
|
int getNumberCards() const { return static_cast<SerializableItem_Int *>(itemMap.value("number_cards"))->getData(); }
|
|
QList<ServerInfo_Card *> getCardList() const { return typecastItemList<ServerInfo_Card *>(); }
|
|
};
|
|
|
|
#endif
|