summaryrefslogtreecommitdiff
path: root/src/resources/itemdb.h
blob: e80f2cd0c43fdc14c11240b3e2e135e836221544 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ITEM_MANAGER_H
#define ITEM_MANAGER_H

#include <list>
#include <map>
#include <string>

#include "utils/xml.h"

#define ITEMS_DB_FILE "items.xml"

class ItemInfo;
class SpriteDisplay;

// Used to make the compiler uderstand the iteminfo friendship.
namespace TmwAthena { class TaItemDB; };
namespace ManaServ { class ManaServItemDB; };

/**
 * Nano-description functions
 */
class ItemStat
{
    friend class ItemDB;
    friend class TmwAthena::TaItemDB;
    friend class ManaServ::ManaServItemDB;

    public:
        ItemStat(const std::string &tag,
             const std::string &format):
        mTag(tag), mFormat(format) {}

        bool operator ==(std::string &name) const
        { return mTag == name; }

    private:
        std::string mTag;
        std::string mFormat;
};

// Used to set nano-description
static std::list<ItemStat> extraStats;
void setStatsList(const std::list<ItemStat> &stats);

/**
 * Item information database generic definition.
 */
class ItemDB
{
    public:
        ItemDB() :
          mUnknown(0),
          mLoaded(false)
        {}

        ~ItemDB()
        {}

        /**
         * Loads the item data from <code>items.xml</code>.
         */
        virtual void load() = 0;

        /**
         * Frees item data.
         */
        virtual void unload();

        /**
         * Tells whether the item database is loaded.
         */
        bool isLoaded() const
        { return mLoaded; }

        bool exists(int id);

        const ItemInfo &get(int id);
        const ItemInfo &get(const std::string &name);

    protected:
        /**
         * Permits to load item definitions which are common
         * for each protocols to avoid code duplication.
         */
        void loadCommonRef(ItemInfo *itemInfo, xmlNodePtr node);

        /**
         * Checks the items parameters consistency.
         */
        virtual void checkItemInfo(ItemInfo* itemInfo);

        /**
         * Register the item to mItemInfos and mNamedItemsInfos
         */
        void addItem(ItemInfo *itemInfo);

        // Default unknown reference
        ItemInfo *mUnknown;

        bool mLoaded;

    private:
        /**
         * Loads the sprite references contained in a <sprite> tag.
         */
        void loadSpriteRef(ItemInfo *itemInfo, xmlNodePtr node);

        /**
         * Loads the sound references contained in a <sound> tag.
         */
         void loadSoundRef(ItemInfo *itemInfo, xmlNodePtr node);

        /**
         * Loads the floor item references contained in a <floor> tag.
         */
        void loadFloorSprite(SpriteDisplay *display, xmlNodePtr node);

        // Items database
        typedef std::map<int, ItemInfo*> ItemInfos;
        typedef std::map<std::string, ItemInfo*> NamedItemInfos;

        ItemInfos mItemInfos;
        NamedItemInfos mNamedItemInfos;
};

namespace TmwAthena {

class TaItemInfo;

/**
 * Item information database TmwAthena specific class.
 */
class TaItemDB: public ItemDB
{
    public:
        TaItemDB() : ItemDB()
        { load(); }

        ~TaItemDB()
        { unload(); }

        /**
         * Loads the item data from <code>items.xml</code>.
         */
        void load();

    private:
        /**
         * Check items id specific hard limits and log errors found.
         * TODO: Do it.
         */
        void checkHairWeaponsRacesSpecialIds()
        {}

        void checkItemInfo(ItemInfo* itemInfo);
};

}; // namespace TmwAthena

namespace ManaServ {

class ManaServItemInfo;

/**
 * Item information database TmwAthena specific class.
 */
class ManaServItemDB: public ItemDB
{
    public:
        ManaServItemDB() : ItemDB()
        { load(); }

        ~ManaServItemDB()
        { unload(); }

        /**
         * Loads the item data from <code>items.xml</code>.
         */
        void load();

    private:
        void checkItemInfo(ItemInfo* itemInfo);
};

}; // namespace ManaServ

extern ItemDB *itemDb;

#endif