menu.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 SCI_GRAPHICS_MENU_H
#define SCI_GRAPHICS_MENU_H

namespace Sci {

enum {
    SCI_MENU_ATTRIBUTE_SAID     = 0x6d,
    SCI_MENU_ATTRIBUTE_TEXT     = 0x6e,
    SCI_MENU_ATTRIBUTE_KEYPRESS = 0x6f,
    SCI_MENU_ATTRIBUTE_ENABLED  = 0x70,
    SCI_MENU_ATTRIBUTE_TAG      = 0x71
};

enum {
    SCI_MENU_REPLACE_ONCONTROL  = 0x03,
    SCI_MENU_REPLACE_ONALT      = 0x02,
    SCI_MENU_REPLACE_ONFUNCTION = 'F'
};

struct GuiMenuEntry {
    uint16 id;
    Common::String text;
    Common::String textSplit;
    int16 textWidth;

    GuiMenuEntry(uint16 curId)
     : id(curId), textWidth(0) { }
};
typedef Common::List<GuiMenuEntry *> GuiMenuList;

struct GuiMenuItemEntry {
    uint16 menuId;
    uint16 id;
    bool enabled;
    uint16 tag;
    uint16 keyPress;
    uint16 keyModifier;
    bool separatorLine;
    reg_t saidVmPtr;
    Common::String text;
    Common::String textSplit;
    reg_t textVmPtr;
    int16 textWidth;
    Common::String textRightAligned;
    int16 textRightAlignedWidth;

    GuiMenuItemEntry(uint16 curMenuId, uint16 curId)
     : menuId(curMenuId), id(curId),
        enabled(true), tag(0), keyPress(0), keyModifier(0), separatorLine(false), textWidth(0), textRightAlignedWidth(0) {
        saidVmPtr = NULL_REG;
        textVmPtr = NULL_REG;
    }
};
typedef Common::List<GuiMenuItemEntry *> GuiMenuItemList;

class GfxMenu {
public:
    GfxMenu(EventManager *event, SegManager *segMan, GfxPorts *ports, GfxPaint16 *paint16, GfxText16 *text16, GfxScreen *screen, GfxCursor *cursor);
    ~GfxMenu();

    void reset();
    void kernelAddEntry(const Common::String &title, Common::String content, reg_t contentVmPtr);
    void kernelSetAttribute(uint16 menuId, uint16 itemId, uint16 attributeId, reg_t value);
    reg_t kernelGetAttribute(uint16 menuId, uint16 itemId, uint16 attributeId);

    void drawBar();
    reg_t kernelSelect(reg_t eventObject, bool pauseSound);

    void kernelDrawStatus(const char *text, int16 colorPen, int16 colorBack);
    void kernelDrawMenuBar(bool clear);

private:
    GuiMenuItemEntry *findItem(uint16 menuId, uint16 itemId);
    void calculateMenuWidth();
    void calculateMenuAndItemWidth();
    void drawMenu(uint16 oldMenuId, uint16 newMenuId);
    void invertMenuSelection(uint16 itemId);
    void interactiveStart(bool pauseSound);
    void interactiveEnd(bool pauseSound);
    GuiMenuItemEntry *interactiveWithKeyboard();
    GuiMenuItemEntry *interactiveWithMouse();
    uint16 mouseFindMenuSelection(Common::Point mousePosition);
    uint16 mouseFindMenuItemSelection(Common::Point mousePosition, uint16 menuId);
    GuiMenuItemEntry *interactiveGetItem(uint16 menuId, uint16 itemId, bool menuChanged);

    EventManager *_event;
    SegManager *_segMan;
    GfxPorts *_ports;
    GfxPaint16 *_paint16;
    GfxText16 *_text16;
    GfxScreen *_screen;
    GfxCursor *_cursor;

    GuiMenuList _list;
    GuiMenuItemList _itemList;

    uint16 _curMenuId;
    uint16 _curItemId;

    Port *_oldPort;
    reg_t _barSaveHandle;
    reg_t _menuSaveHandle;
    Common::Rect _menuRect;

    bool _mouseOldState;
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_MENU_H