virtual-keyboard-parser.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_PARSER_H
#define COMMON_VIRTUAL_KEYBOARD_PARSER_H

#include "common/scummsys.h"

#ifdef ENABLE_VKEYBD

#include "common/formats/xmlparser.h"
#include "backends/vkeybd/virtual-keyboard.h"

namespace Common {

class VirtualKeyboardParser : public XMLParser {

public:

    enum ParseMode {
        kParseFull,

        kParseCheckResolutions
    };

    VirtualKeyboardParser(VirtualKeyboard *kbd);
    void setParseMode(ParseMode m) {
        _parseMode = m;
    }

protected:
    CUSTOM_XML_PARSER(VirtualKeyboardParser) {
        XML_KEY(keyboard)
            XML_PROP(initial_mode, true)
            XML_PROP(v_align, false)
            XML_PROP(h_align, false)
            XML_KEY(mode)
                XML_PROP(name, true)
                XML_PROP(resolutions, true)
                XML_KEY(layout)
                    XML_PROP(resolution, true)
                    XML_PROP(bitmap, true)
                    XML_PROP(transparent_color, false)
                    XML_PROP(display_font_color, false)
                    XML_KEY(map)
                        XML_KEY(area)
                            XML_PROP(shape, true)
                            XML_PROP(coords, true)
                            XML_PROP(target, true)
                        KEY_END()
                    KEY_END()
                KEY_END()
                XML_KEY(event)
                    XML_PROP(name, true)
                    XML_PROP(type, true)
                    XML_PROP(code, false)
                    XML_PROP(ascii, false)
                    XML_PROP(modifiers, false)
                    XML_PROP(mode, false)
                KEY_END()
            KEY_END()
        KEY_END()
    } PARSER_END()

protected:
    VirtualKeyboard *_keyboard;

    ParseMode _parseMode;
    VirtualKeyboard::Mode *_mode;
    String _initialModeName;
    bool _kbdParsed;
    bool _layoutParsed;

    virtual void cleanup();

    bool parserCallback_keyboard(ParserNode *node);
    bool parserCallback_mode(ParserNode *node);
    bool parserCallback_event(ParserNode *node);
    bool parserCallback_layout(ParserNode *node);
    bool parserCallback_map(ParserNode *node);
    bool parserCallback_area(ParserNode *node);
    virtual bool closedKeyCallback(ParserNode *node);

    byte parseFlags(const String &flags);
    bool parseRect(Rect &rect, const String &coords);
    bool parsePolygon(Polygon &poly, const String &coords);
    bool parseRectAsPolygon(Polygon &poly, const String &coords);
};

} // End of namespace GUI

#endif // #ifdef ENABLE_VKEYBD

#endif // #ifndef COMMON_VIRTUAL_KEYBOARD_PARSER_H