ManaPlus
messagein.h
Go to the documentation of this file.
1 /*
2  * The ManaPlus Client
3  * Copyright (C) 2004-2009 The Mana World Development Team
4  * Copyright (C) 2009-2010 The Mana Developers
5  * Copyright (C) 2011-2018 The ManaPlus Developers
6  *
7  * This file is part of The ManaPlus Client.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <http://www.gnu.org/licenses/>.
21  */
22 
23 #ifndef NET_MESSAGEIN_H
24 #define NET_MESSAGEIN_H
25 
27 
28 #include <string>
29 
30 #include "localconsts.h"
31 
32 namespace Net
33 {
34 
41 {
42  public:
44 
45  virtual ~MessageIn();
46 
51  { return mId; }
52 
56  unsigned int getLength() const noexcept2 A_WARN_UNUSED
57  { return mLength; }
58 
63  { return mLength > mPos ? mLength - mPos : 0; }
64 
66  virtual unsigned char readUInt8(const char *const str);
67 
69  virtual signed char readInt8(const char *const str);
70 
72  virtual int16_t readInt16(const char *const str) = 0;
73 
74  virtual uint16_t readUInt16(const char *const str) = 0;
75 
77  virtual int32_t readInt32(const char *const str) = 0;
78 
79  virtual int64_t readInt64(const char *const str) = 0;
80 
81  virtual BeingId readBeingId(const char *const str) = 0;
82 
87  virtual void readCoordinates(uint16_t &restrict x,
88  uint16_t &restrict y,
89  uint8_t &restrict direction,
90  const char *const str);
91 
96  virtual void readCoordinatePair(uint16_t &restrict srcX,
97  uint16_t &restrict srcY,
98  uint16_t &restrict dstX,
99  uint16_t &restrict dstY,
100  const char *const str);
101 
105  virtual void skip(const unsigned int length,
106  const char *const str);
107 
108  void skipToEnd(const char *const str);
109 
115  virtual std::string readString(int length,
116  const char *const dstr);
117 
118  virtual std::string readRawString(int length,
119  const char *const dstr);
120 
121  unsigned char *readBytes(int length,
122  const char *const dstr);
123 
124  static uint8_t fromServerDirection(const uint8_t serverDir)
126 
127  unsigned int getVersion() const noexcept2 A_WARN_UNUSED
128  { return mVersion; }
129 
130  protected:
134  MessageIn(const char *const data, const unsigned int length);
135 
136  const char *mData;
137  unsigned int mLength;
144  unsigned int mPos;
145  unsigned int mVersion;
146  uint16_t mId;
147  bool mIgnore;
148 };
149 
150 } // namespace Net
151 
152 #endif // NET_MESSAGEIN_H
#define A_DELETE_COPY(func)
Definition: localconsts.h:52
unsigned int mVersion
Definition: messagein.h:145
virtual unsigned char readUInt8(const char *const str)
Definition: messagein.cpp:74
virtual BeingId readBeingId(const char *const str)=0
virtual ~MessageIn()
Definition: messagein.cpp:53
#define A_WARN_UNUSED
Definition: localconsts.h:172
unsigned int getLength() const
Definition: messagein.h:56
int BeingId
Definition: beingid.h:29
virtual int16_t readInt16(const char *const str)=0
unsigned int getUnreadLength() const
Definition: messagein.h:62
uint16_t mId
Definition: messagein.h:146
virtual void readCoordinates(uint16_t &x, uint16_t &y, uint8_t &direction, const char *const str)
Definition: messagein.cpp:131
virtual signed char readInt8(const char *const str)
Definition: messagein.cpp:87
int getId() const
Definition: messagein.h:50
unsigned int mPos
Definition: messagein.h:144
virtual int64_t readInt64(const char *const str)=0
virtual void readCoordinatePair(uint16_t &srcX, uint16_t &srcY, uint16_t &dstX, uint16_t &dstY, const char *const str)
Definition: messagein.cpp:163
uint32_t data
MessageIn(const char *const data, const unsigned int length)
Definition: messagein.cpp:41
virtual std::string readRawString(int length, const char *const dstr)
Definition: messagein.cpp:246
virtual void skip(const unsigned int length, const char *const str)
Definition: messagein.cpp:201
const char * mData
Definition: messagein.h:136
#define notfinal
Definition: localconsts.h:289
unsigned int getVersion() const
Definition: messagein.h:127
virtual uint16_t readUInt16(const char *const str)=0
void skipToEnd(const char *const str)
Definition: messagein.cpp:208
virtual int32_t readInt32(const char *const str)=0
#define restrict
Definition: localconsts.h:176
virtual std::string readString(int length, const char *const dstr)
Definition: messagein.cpp:219
static uint8_t fromServerDirection(const uint8_t serverDir)
Definition: messagein.cpp:101
unsigned int mLength
Definition: messagein.h:137
#define noexcept2
Definition: localconsts.h:49
unsigned char * readBytes(int length, const char *const dstr)
Definition: messagein.cpp:289