itemdb.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  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/>.
 */
 
#pragma once
 
#include <list>
#include <map>
#include <string>
 
#include "utils/xml.h"
 
#define ITEMS_DB_FILE "items.xml"
 
class ItemInfo;
class SpriteDisplay;
 
namespace TmwAthena {
class TaItemDB;
}
 
namespace ManaServ {
class ManaServItemDB;
}
 
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 ==(const 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(std::list<ItemStat> stats);
 
class ItemDB
{
    public:
        ItemDB() = default;
        virtual ~ItemDB() = default;
 
        virtual void unload();
 
        bool isLoaded() const
        { return mLoaded; }
 
        bool exists(int id) const;
 
        const ItemInfo &get(int id) const;
        const ItemInfo &get(const std::string &name) const;
 
        virtual void init() = 0;
 
        virtual void readItemNode(XML::Node node, const std::string &filename) = 0;
 
        virtual void checkStatus() = 0;
 
    protected:
        void loadCommonRef(ItemInfo &itemInfo, XML::Node node, const std::string &filename);
 
        virtual void checkItemInfo(ItemInfo &itemInfo);
 
        void addItem(ItemInfo *itemInfo);
 
        void loadEmptyItemDefinition();
 
        // Default unknown reference
        ItemInfo *mUnknown = nullptr;
 
        bool mLoaded = false;
 
    private:
        void loadSpriteRef(ItemInfo &itemInfo, XML::Node node);
 
        void loadSoundRef(ItemInfo &itemInfo, XML::Node node);
 
        void loadFloorSprite(SpriteDisplay &display, XML::Node node);
 
        void loadReplacement(ItemInfo &info, XML::Node replaceNode);
 
        // Items database
        std::map<int, ItemInfo *> mItemInfos;
        std::map<std::string, ItemInfo *> mNamedItemInfos;
};
 
namespace TmwAthena {
 
class TaItemDB : public ItemDB
{
    public:
        TaItemDB() = default;
 
        ~TaItemDB() override
        { unload(); }
 
        void init() override;
 
        void readItemNode(XML::Node node, const std::string &filename) override;
 
        void checkStatus() override;
 
    private:
        void checkHairWeaponsRacesSpecialIds()
        {}
 
        void checkItemInfo(ItemInfo &itemInfo) override;
};
 
} // namespace TmwAthena
 
namespace ManaServ {
 
class ManaServItemDB : public ItemDB
{
    public:
        ManaServItemDB() = default;
 
        ~ManaServItemDB() override
        { unload(); }
 
        void init() override;
 
        void readItemNode(XML::Node node, const std::string &filename) override;
 
        void checkStatus() override;
 
    private:
        void checkItemInfo(ItemInfo &itemInfo) override;
};
 
} // namespace ManaServ
 
extern ItemDB *itemDb;