inventory.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 of the License, or
 * (at your option) 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 SHERLOCK_INVENTORY_H
#define SHERLOCK_INVENTORY_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/str-array.h"
#include "sherlock/objects.h"
#include "sherlock/resources.h"
#include "sherlock/saveload.h"

namespace Sherlock {

enum InvMode {
    INVMODE_EXIT = 0,
    INVMODE_LOOK = 1,
    INVMODE_USE = 2,
    INVMODE_GIVE = 3,
    INVMODE_FIRST = 4,
    INVMODE_PREVIOUS = 5,
    INVMODE_NEXT = 6,
    INVMODE_LAST = 7,
    INVMODE_INVALID = 8,
    INVMODE_USE55 = 255
};

enum InvNewMode {
    PLAIN_INVENTORY = 0, LOOK_INVENTORY_MODE = 1, USE_INVENTORY_MODE = 2,
    GIVE_INVENTORY_MODE = 3, INVENTORY_DONT_DISPLAY = 128
};

enum InvSlamMode { SLAM_DONT_DISPLAY, SLAM_DISPLAY = 1, SLAM_SECONDARY_BUFFER };


struct InventoryItem {
    int _requiredFlag;
    Common::String _name;
    Common::String _description;
    Common::String _examine;
    int _lookFlag;

    // Rose Tattoo fields
    int _requiredFlag1;
    UseType _verb;

    InventoryItem() : _requiredFlag(0), _lookFlag(0), _requiredFlag1(0) {}
    InventoryItem(int requiredFlag, const Common::String &name,
        const Common::String &description, const Common::String &examine);
    InventoryItem(int requiredFlag, const Common::String &name,
        const Common::String &description, const Common::String &examine, const Common::String &verbName);

    void synchronize(Serializer &s);
};

class Inventory : public Common::Array<InventoryItem> {
protected:
    SherlockEngine *_vm;
    Common::StringArray _names;

    void copyToInventory(Object &obj);
public:
    Common::Array<ImageFile *> _invShapes;
    bool _invGraphicsLoaded;
    InvMode _invMode;
    int _invIndex;
    int _holdings;      // Used to hold number of visible items in active inventory.
                        // Since Inventory array also contains some special hidden items
    void freeGraphics();
public:
    static Inventory *init(SherlockEngine *vm);
    Inventory(SherlockEngine *vm);
    virtual ~Inventory();

    void freeInv();

    void loadGraphics();

    int findInv(const Common::String &name);

    int putNameInInventory(const Common::String &name);

    int putItemInInventory(Object &obj);

    int deleteItemFromInventory(const Common::String &name);

    void synchronize(Serializer &s);

    virtual void loadInv() = 0;
};

} // End of namespace Sherlock

#endif