CRules.hh

/*
** TowBowlTactics, a turn-based strategy football game.
** 
** Copyright (C) 2006-2010 The TBT Team.
** 
** This program is free software; you can redistribute it and/or
** modify it under the terms of the GNU General Public License
** as published by the Free Software Foundation; either version 2
** of the License, or (at your option) any later version.
** 
** The complete GNU General Public Licence Notice can be found as the
** `NOTICE' file in the root directory.
** 
** The TBT Team consists of people listed in the `AUTHORS' file.
*/

#ifndef CRULES_HH_
# define CRULES_HH_

# include "rules/BaseApi.hh"
# include "rules/BaseCRules.hh"
# include "Constants.hh"
# include "Player.hh"

// Mostly a big hack, to have BaseCRules::onEvent(int) working.
DECLARE_EMPTY_PACKET(CUSTOM_EVENT, CustomEvent);

class Api;
class App;
class CMatch;
class CPlayerMsg;
class CTeamMsg;
class CTeam;
class SendingQueue;

class CRules : public BaseCRules
{
  friend class Api;
  
public:
  CRules(App* app);
  virtual ~CRules();

  // FIXME: see later.
  virtual void serialize(std::ostream& os) const;
  virtual void unserialize(std::istream& is);

  virtual Api*    getApi();
  App*            getApp();
  CMatch*         getMatch();
  CPlayerMsg*     getPlayerMsg();
  SendingQueue*   getSendingQueue();
  CTeamMsg*       getTeamMsg();


  void setState(int new_state);
  void switchToTeamState(int state);
  void restoreGameState();

  // For synchronization with server.
  void countRequestSending();
  void countRequestProcessed();
  void countQueryReceived();
  void countQueryProcessed();
  void freezeRequestSending();
  void unfreezeRequestSending();
  int  getNbRequestsSent() const;

  void sendPacketLater(const MsgMove& m);

  friend std::ostream& operator<< (std::ostream& os, const CRules& r);

private:
  const char* tokenToString(unsigned token) const;

  // Methods to catch server response.
  void msgIllegal(const MsgIllegal* m);
  void msgInitGame(const MsgInitGame* m);
  void msgDrawKicker(const MsgDrawKicker* m);
  void msgInitKickoff(const MsgInitKickoff* m);
  void msgTouchBack(const MsgTouchBack* m);
  void msgEndGame(const MsgEndGame* m);
  void msgCancelGame(const MsgCancelGame* m);
  void msgChatMessage(const MsgChat* m);
  void msgDebug(const MsgDebug* m);
  void msgCustomEvent(const CustomEvent* m);
  void msgRequestProcessed(const MsgRequestProcessed* m);

  App*      app_;
  Api*      api_;

  int       saved_game_state_;
  int       nb_requests_sent_;
  int       nb_server_queries_;
  
  CMatch*   match_;
  CTeam*    our_team_;
  CTeam*    other_team_;
  CTeamMsg* team_msg_;
  CPlayerMsg* player_msg_;
  SendingQueue* sq_;
};

# include "CRules.hxx"

#endif /* !CRULES_HH_ */