BaseRules.hh

Go to the documentation of this file.

/*
** 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 BASE_RULES_HH_
# define BASE_RULES_HH_

# include "tools.hh"
# include "Packet.hh"
# include "PacketHandler.hh"
# include "PacketHistory.hh"
# include "PacketSender.hh"

# define UID_COACH_BASE     0        ///< Base uid for coachs
# define UID_VIEWER_BASE    100      ///< Base uid for viewers

const unsigned MAX_TOKEN    = 256;
const unsigned BASE_TOKEN_START = MAX_TOKEN - 8;

// Some very common game state.
const int GS_WAIT       = 0xFFFE; 
const int GS_END        = 0xFFFF; 

// Viewers State (VS). Only for the server. Set by the server.
const unsigned VS_HAVEVIEWER    = 0x0800; 
const unsigned VS_READY     = 0x2000; 

const unsigned MSG_SYNC     = BASE_TOKEN_START; 

DECLARE_EMPTY_PACKET(MSG_SYNC, MsgSync);

// Custom events.
const unsigned CUSTOM_EVENT = BASE_TOKEN_START + 1;

const unsigned CLIENT_UID   = BASE_TOKEN_START + 2; 

DECLARE_PACKET(CLIENT_UID, ClientUid);
  int league_id;
  int nb_coach;
  int nb_team;
END_PACKET

const unsigned BASE_TOKEN_LAST  = BASE_TOKEN_START + 3;

struct RuleDescription
{
  const char* name;
  const char* description;
  const char* server_lib;
  int major;
  int minor;
};


class BaseRules
{
public:
  BaseRules();
  virtual ~BaseRules();




  void          sendPacket(const Packet& p) const;

  void          handleWith(BasePacketHandler* bph, int when = 0);

  const PacketHistory& getHistory() const;

  int           getCoachNumber() const;

  int           getTeamNumber() const;

  int           getState() const;
  void          setState(int new_state);

  const char*   stringifyToken(unsigned token) const;

  static const char* stringifyGameState(int game_state);


  void          setSendPacketObject(PacketSender* ps);

  void          handlePacket(const Packet* p);

  void          setTeamNumber(int coach_nb, int team_nb);

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

protected:
  virtual const char* tokenToString(unsigned token) const;

private:

  int           state_;
  int           coach_number_;
  int           team_number_;

protected:

  PacketSender* packet_sender_;
  typedef std::vector<std::pair<int, BasePacketHandler*> > PktHList;
  PktHList      pkt_hdl_[MAX_TOKEN];

  PacketHistory pkt_history_;

};

#endif /* !BASE_RULES_HH_ */