GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/net/messagein.h Lines: 0 4 0.0 %
Date: 2018-09-20 Branches: 0 4 0.0 %

Line Branch Exec Source
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
26
#include "enums/simpletypes/beingid.h"
27
28
#include <string>
29
30
#include "localconsts.h"
31
32
namespace Net
33
{
34
35
/**
36
 * Used for parsing an incoming message.
37
 *
38
 * \ingroup Network
39
 */
40
class MessageIn notfinal
41
{
42
    public:
43
        A_DELETE_COPY(MessageIn)
44
45
        virtual ~MessageIn();
46
47
        uint16_t readId() const;
48
49
        /**
50
         * Returns the message ID.
51
         */
52
        int getId() const noexcept2 A_WARN_UNUSED
53
        { return mId; }
54
55
        /**
56
         * Returns the message length.
57
         */
58
        unsigned int getLength() const noexcept2 A_WARN_UNUSED
59
        { return mLength; }
60
61
        /**
62
         * Returns the length of unread data.
63
         */
64
        unsigned int getUnreadLength() const noexcept2 A_WARN_UNUSED
65
        { return mLength > mPos ? mLength - mPos : 0; }
66
67
        /**< Reads a byte. */
68
        unsigned char readUInt8(const char *const str);
69
70
        /**< Reads a byte. */
71
        signed char readInt8(const char *const str);
72
73
        /**< Reads a short. */
74
        int16_t readInt16(const char *const str);
75
76
        uint16_t readUInt16(const char *const str);
77
78
        /**< Reads a long. */
79
        int32_t readInt32(const char *const str);
80
81
        uint32_t readUInt32(const char *const str);
82
83
        int readItemId(const char *const str);
84
85
        int64_t readInt64(const char *const str);
86
87
        BeingId readBeingId(const char *const str);
88
89
        /**
90
         * Reads a special 3 byte block used by eAthena, containing x and y
91
         * coordinates and direction.
92
         */
93
        void readCoordinates(uint16_t &restrict x,
94
                             uint16_t &restrict y,
95
                             uint8_t &restrict direction,
96
                             const char *const str);
97
98
        /**
99
         * Reads a special 5 byte block used by eAthena, containing a source
100
         * and destination coordinate pair.
101
         */
102
        void readCoordinatePair(uint16_t &restrict srcX,
103
                                uint16_t &restrict srcY,
104
                                uint16_t &restrict dstX,
105
                                uint16_t &restrict dstY,
106
                                const char *const str);
107
108
        /**
109
         * Skips a given number of bytes.
110
         */
111
        void skip(const unsigned int length,
112
                  const char *const str);
113
114
        void skipToEnd(const char *const str);
115
116
        /**
117
         * Reads a string. If a length is not given (-1), it is assumed
118
         * that the length of the string is stored in a short at the
119
         * start of the string.
120
         */
121
        std::string readString(int length,
122
                               const char *const dstr);
123
124
        std::string readRawString(int length,
125
                                  const char *const dstr);
126
127
        unsigned char *readBytes(int length,
128
                                 const char *const dstr);
129
130
        static uint8_t fromServerDirection(const uint8_t serverDir)
131
                                           A_WARN_UNUSED;
132
133
        int getVersion() const noexcept2 A_WARN_UNUSED
134
        { return mVersion; }
135
136
        int getVersionMain() const noexcept2 A_WARN_UNUSED;
137
138
        int getVersionRe() const noexcept2 A_WARN_UNUSED;
139
140
        int getVersionZero() const noexcept2 A_WARN_UNUSED;
141
142
    protected:
143
        /**
144
         * Constructor.
145
         */
146
        MessageIn(const char *const data, const unsigned int length);
147
148
        const char *mData;     /**< The message data. */
149
        unsigned int mLength;  /**< The length of the data. */
150
151
        /**
152
         * Actual position in the packet. From 0 to packet->length.
153
         * A value bigger than packet->length means EOP was reached when
154
         * reading it.
155
         */
156
        unsigned int mPos;
157
        int mVersion;
158
        uint16_t mId;          /**< The message ID. */
159
        bool mIgnore;
160
};
161
162
}  // namespace Net
163
164
#endif  // NET_MESSAGEIN_H