virtual-keyboard.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 COMMON_VIRTUAL_KEYBOARD_H
#define COMMON_VIRTUAL_KEYBOARD_H

#include "common/scummsys.h"

#ifdef ENABLE_VKEYBD

class OSystem;

#include "common/events.h"
#include "common/hashmap.h"
#include "common/hash-str.h"
#include "common/keyboard.h"
#include "common/list.h"
#include "common/str.h"
#include "common/fs.h"

#include "backends/vkeybd/image-map.h"
#include "graphics/surface.h"


namespace Common {

class Archive;

class VirtualKeyboardGUI;
class VirtualKeyboardParser;

class VirtualKeyboard {
protected:

    enum VKEventType {
        kVKEventKey,
        kVKEventModifier,
        kVKEventSwitchMode,
        kVKEventSubmit,
        kVKEventCancel,
        kVKEventClear,
        kVKEventMoveLeft,
        kVKEventMoveRight,
        kVKEventDelete
    };

    struct VKEvent {
        String name;
        VKEventType type;
        void *data;

        VKEvent() : data(0) {}
        ~VKEvent() {
            if (data)
                free(data);
        }
    };

    typedef HashMap<String, VKEvent *> VKEventMap;

    struct Mode {
        String              name;
        String              resolution;
        String              bitmapName;
        Graphics::Surface   *image;
        uint32              transparentColor;
        ImageMap            imageMap;
        VKEventMap          events;
        Rect                displayArea;
        uint32              displayFontColor;

        Mode() : image(0) {}
        ~Mode() {
            if (image) {
                image->free();
                delete image;
                image = 0;
            }
        }
    };

    typedef HashMap<String, Mode, IgnoreCase_Hash, IgnoreCase_EqualTo> ModeMap;

    enum HorizontalAlignment {
        kAlignLeft,
        kAlignCenter,
        kAlignRight
    };

    enum VerticalAlignment {
        kAlignTop,
        kAlignMiddle,
        kAlignBottom
    };

    struct VirtualKeyPress {
        KeyState key;
        uint strLen;
    };

    class KeyPressQueue {
    public:
        KeyPressQueue();
        void toggleFlags(byte fl);
        void clearFlags();
        void insertKey(KeyState key);
        void deleteKey();
        void moveLeft();
        void moveRight();
        KeyState pop();
        void clear();
        bool empty();
        String getString();
        uint getInsertIndex();
        bool hasStringChanged();

    private:
        byte _flags;
        String _flagsStr;

        typedef List<VirtualKeyPress> KeyPressList;
        KeyPressList _keys;
        String _keysStr;

        bool _strChanged;

        KeyPressList::iterator _keyPos;
        uint _strPos;
    };

public:

    VirtualKeyboard();

    virtual ~VirtualKeyboard();

    bool loadKeyboardPack(const String &packName);

    void show();

    void close(bool submit);

    bool isDisplaying();

    bool isLoaded() {
        return _loaded;
    }

protected:

    OSystem *_system;
    DisposablePtr<Archive> _fileArchive;

    friend class VirtualKeyboardGUI;
    VirtualKeyboardGUI *_kbdGUI;

    KeyPressQueue _keyQueue;

    friend class VirtualKeyboardParser;
    VirtualKeyboardParser *_parser;

    void reset();
    bool openPack(const String &packName, Archive *searchPath, DisposeAfterUse::Flag disposeSearchPath);
    void deleteEvents();
    bool checkModeResolutions();
    void switchMode(Mode *newMode);
    void switchMode(const String &newMode);
    void initKeymap();
    void handleMouseDown(int16 x, int16 y);
    void handleMouseUp(int16 x, int16 y);
    String findArea(int16 x, int16 y);
    void processAreaClick(const String &area);

    bool _loaded;

    ModeMap _modes;
    Mode *_initialMode;
    Mode *_currentMode;

    HorizontalAlignment  _hAlignment;
    VerticalAlignment    _vAlignment;

    String _areaDown;

    bool _submitKeys;

};

} // End of namespace Common

#endif // #ifdef ENABLE_VKEYBD

#endif // #ifndef COMMON_VIRTUAL_KEYBOARD_H