aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/cerence/xt9/plugin/xt9inputmethodprivate_p.h
blob: 145f79c961168c2c9ac7268d840a4365291b2ea9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef XT9INPUTMETHODPRIVATE_P_H
#define XT9INPUTMETHODPRIVATE_P_H

#include <QtGlobal>
#include <et9api.h>
#include <QStringList>
#include "xt9callbacks.h"
#include "xt9ime.h"
#include <QtVirtualKeyboard/qvirtualkeyboardinputengine.h>
#include <QtVirtualKeyboard/private/qvirtualkeyboardabstractinputmethod_p.h>

QT_BEGIN_NAMESPACE
namespace QtVirtualKeyboard {

class Xt9InputMethod;

class Xt9InputMethodPrivate : public QVirtualKeyboardAbstractInputMethodPrivate, public Xt9RequestCallback
{
    Q_DECLARE_PUBLIC(Xt9InputMethod)
public:
    Xt9InputMethodPrivate(Xt9InputMethod *q_ptr, Xt9Ime *xt9Ime, const QString &aDlmFileName);

    inline Xt9Ime *xt9Ime() const;
    void sysInit();
    bool init(QLocale aLocale, QVirtualKeyboardInputEngine::InputMode aInputMode);
    virtual void uninit();
    void bindToDictionaryManager();
    virtual void bindToSettings();
    void bindToKeyboard();
    void dlmActivate();
    void dlmDeactivate();
    virtual void updateLdb();
    void updateDlm();
    void removeAllDynamicDictionaries();
    void updateDynamicDictionaries();
    void updateShiftState();
    bool updateLayout();
    virtual void updatePreeditText();
    void buildSelectionList();
    void buildSelectionList(ET9STATUS &eStatus);
    void selectionListUpdate();
    virtual void selectionListSelectItem(int index) = 0;
    void updatePunctuationBreaking();
    bool processBackspace();
    bool processKeyBySymbol(const QChar &symbol);
    virtual bool maybeInsertSpaceBeforeNextInputSymbol(QChar symbol) const;
    void setAutoSpaceAllowed(bool value);
    virtual bool isAutoSpaceAllowed() const;
    virtual bool isValidInputChar(const QChar &c) const;
    virtual bool isJoiner(const QChar &c) const;
    void setShiftState(bool shift, bool caps);
    virtual void reset();
    void onAvailableDynamicDictionariesChanged();
    void onActiveDynamicDictionariesChanged();
    void onUserDataPathChanged();
    void onUserDataReset();

    virtual ET9U32 inputModeToET9InputMode(QVirtualKeyboardInputEngine::InputMode aInputMode) const = 0;
    ET9STATUS request(ET9_Request *const pRequest) override;

public:
    Xt9InputMethod *q_ptr;
    QScopedPointer<Xt9Ime> _xt9Ime;
    QMetaObject::Connection availableDictionariesChangedConnection;
    QMetaObject::Connection activeDictionariesChangedConnection;
    QMetaObject::Connection userDataPathChangedConnection;
    QMetaObject::Connection userDataResetConnection;
    QMetaObject::Connection layoutChangedConnection;
    QMetaObject::Connection shiftActiveChangedConnection;
    QMetaObject::Connection capsLockActiveChangedConnection;
    QMetaObject::Connection inputMethodHintsChangedConnection;
    QLocale locale;
    QVirtualKeyboardInputEngine::InputMode inputMode;
    QStringList selectionList;
    QAtomicInt selectionListUpdateCount;
    int defaultListIndex;
    bool autoSpaceAllowed;
    bool initDone;
    const QString dlmFileName;
    QSharedPointer<Xt9DbFile> dlm;
    QMap<QString, quint16> dynamicDictionaries;
    QMap<QString, quint16> attachedDynamicDictionaries;
    QAtomicInt dynamicDictionaryNextId;
};

Xt9Ime *Xt9InputMethodPrivate::xt9Ime() const
{
    return _xt9Ime.data();
}

class Xt9DeferredSelectionListUpdate
{
    Q_DISABLE_COPY(Xt9DeferredSelectionListUpdate)
public:
    inline explicit Xt9DeferredSelectionListUpdate(Xt9InputMethodPrivate *d) :
        d(d)
    {
        d->selectionListUpdateCount.ref();
    }

    inline ~Xt9DeferredSelectionListUpdate()
    {
        if (!d->selectionListUpdateCount.deref()) {
            d->selectionListUpdate();
        }
    }

private:
    Xt9InputMethodPrivate *d;
};

} // namespace QtVirtualKeyboard
QT_END_NAMESPACE

#endif // XT9INPUTMETHODPRIVATE_P_H