KeyboardLayout.h

/*
 * KeyboardLayout.h
 * This file is part of Open-Typer
 *
 * Copyright (C) 2023 - adazem009
 *
 * Open-Typer 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
 * (at your option) any later version.
 *
 * Open-Typer 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 Open-Typer. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef KEYBOARDLAYOUT_H
#define KEYBOARDLAYOUT_H
 
#include <QObject>
#include <QVariant>
#include <QPoint>
#include "Key.h"
 
class Q_DECL_EXPORT KeyboardLayout : public QObject
{
        Q_OBJECT
        Q_PROPERTY(QString layoutId READ layoutId WRITE setLayoutId NOTIFY layoutIdChanged)
        Q_PROPERTY(QString variant READ variant WRITE setVariant NOTIFY variantChanged)
#if QT_VERSION > QT_VERSION_CHECK(5, 15, 0)
        Q_PROPERTY(KeyboardRow rowB READ rowB NOTIFY rowBChanged)
        Q_PROPERTY(KeyboardRow rowC READ rowC NOTIFY rowCChanged)
        Q_PROPERTY(KeyboardRow rowD READ rowD NOTIFY rowDChanged)
        Q_PROPERTY(KeyboardRow rowE READ rowE NOTIFY rowEChanged)
#else
        Q_PROPERTY(QVariantList rowB READ rowB NOTIFY rowBChanged)
        Q_PROPERTY(QVariantList rowC READ rowC NOTIFY rowCChanged)
        Q_PROPERTY(QVariantList rowD READ rowD NOTIFY rowDChanged)
        Q_PROPERTY(QVariantList rowE READ rowE NOTIFY rowEChanged)
#endif
    public:
        enum Hand
        {
            Hand_Invalid = 0,
            Hand_Left = -1,
            Hand_Right = 1
        };
        Q_ENUM(Hand)
 
        enum Finger
        {
            Finger_Invalid = 0,
            Finger_LeftLittle = -5,
            Finger_LeftRing = -4,
            Finger_LeftMiddle = -3,
            Finger_LeftIndex = -2,
            Finger_LeftThumb = -1,
            Finger_RightThumb = 1,
            Finger_RightIndex = 2,
            Finger_RightMiddle = 3,
            Finger_RightRing = 4,
            Finger_RightLittle = 5
        };
        Q_ENUM(Finger)
 
        enum Row
        {
            Row_A = 0,
            Row_B = 1,
            Row_C = 2,
            Row_D = 3,
            Row_E = 4
        };
        Q_ENUM(Row)
 
        explicit KeyboardLayout(QObject *parent = nullptr);
        KeyboardLayout(QString id, QObject *parent = nullptr);
        QString layoutId(void);
        void setLayoutId(QString id);
        QString variant(void);
        void setVariant(QString variant);
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
        KeyboardRow rowB(void);
        KeyboardRow rowC(void);
        KeyboardRow rowD(void);
        KeyboardRow rowE(void);
#else
        QVariantList rowB(void);
        QVariantList rowC(void);
        QVariantList rowD(void);
        QVariantList rowE(void);
#endif
        Q_INVOKABLE Finger keyFinger(Row row, int id);
        Q_INVOKABLE Hand fingerHand(Finger finger);
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
        Q_INVOKABLE KeyboardRow characterKeys(QChar character);
#else
        Q_INVOKABLE QVariantList characterKeys(QChar character);
#endif
 
    private:
        void init(void);
        void loadLayout(QString rawData, QString variantName);
        QVariantList parse(QString data);
        QString nestedData(int *pos, QString data, QString startToken, QString endToken);
        QPair<QString, QString> keyText(QString id, bool *isDead = nullptr);
        QPoint keyPos(QString keyId, KeyboardUtils::KeyType *type = nullptr);
        void addKey(Key key, int x, int y);
        Key findKeyInRow(QChar character, KeyboardRow row, int *id = nullptr, bool *isShifted = nullptr, bool *ok = nullptr);
        Key findKey(QChar character, Row *row = nullptr, int *id = nullptr, bool *isShifted = nullptr, bool *ok = nullptr);
        KeyboardUtils::KeyType getShiftKey(Row row, int id);
        QString m_layoutId;
        QString m_variant;
        KeyboardRow m_rowB;
        KeyboardRow m_rowC;
        KeyboardRow m_rowD;
        KeyboardRow m_rowE;
 
    signals:
        void layoutIdChanged(QString id);
        void variantChanged(QString variant);
        void rowBChanged(KeyboardRow row);
        void rowCChanged(KeyboardRow row);
        void rowDChanged(KeyboardRow row);
        void rowEChanged(KeyboardRow row);
};
 
#endif // KEYBOARDLAYOUT_H