1 | // Copyright (C) 2016 The Qt Company Ltd. |
2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only |
3 | |
4 | #ifndef QQUICKTEXTINPUT_P_P_H |
5 | #define QQUICKTEXTINPUT_P_P_H |
6 | |
7 | #include "qquicktextinput_p.h" |
8 | #include "qquicktext_p.h" |
9 | #include "qquickimplicitsizeitem_p_p.h" |
10 | #include "qquicktextutil_p.h" |
11 | |
12 | #include <QtQml/qqml.h> |
13 | #include <QtCore/qelapsedtimer.h> |
14 | #include <QtCore/qpointer.h> |
15 | #include <QtCore/qbasictimer.h> |
16 | #include <QtGui/qclipboard.h> |
17 | #include <QtGui/qguiapplication.h> |
18 | #include <QtGui/qpalette.h> |
19 | #include <QtGui/qtextlayout.h> |
20 | #include <QtGui/qstylehints.h> |
21 | #include <private/qlazilyallocated_p.h> |
22 | |
23 | #include "qplatformdefs.h" |
24 | |
25 | #include <memory> |
26 | |
27 | // |
28 | // W A R N I N G |
29 | // ------------- |
30 | // |
31 | // This file is not part of the Qt API. It exists purely as an |
32 | // implementation detail. This header file may change from version to |
33 | // version without notice, or even be removed. |
34 | // |
35 | // We mean it. |
36 | |
37 | QT_BEGIN_NAMESPACE |
38 | |
39 | class QQuickTextNode; |
40 | class QInputControl; |
41 | |
42 | class Q_QUICK_PRIVATE_EXPORT QQuickTextInputPrivate : public QQuickImplicitSizeItemPrivate |
43 | { |
44 | public: |
45 | Q_DECLARE_PUBLIC(QQuickTextInput) |
46 | |
47 | typedef QQuickTextInput Public; |
48 | |
49 | struct { |
50 | (); |
51 | |
52 | qreal ; |
53 | qreal ; |
54 | qreal ; |
55 | qreal ; |
56 | qreal ; |
57 | bool : 1; |
58 | bool : 1; |
59 | bool : 1; |
60 | bool : 1; |
61 | bool : 1; |
62 | }; |
63 | QLazilyAllocated<ExtraData> ; |
64 | |
65 | QQuickTextInputPrivate() |
66 | : hscroll(0) |
67 | , vscroll(0) |
68 | , cursorItem(nullptr) |
69 | , textNode(nullptr) |
70 | , m_maskData(nullptr) |
71 | , color(QRgb(0xFF000000)) |
72 | , selectionColor(QRgb(0xFF000080)) |
73 | , selectedTextColor(QRgb(0xFFFFFFFF)) |
74 | , m_cursor(0) |
75 | #if QT_CONFIG(im) |
76 | , m_preeditCursor(0) |
77 | , m_undoPreeditState(-1) |
78 | #endif |
79 | , m_blinkEnabled(false) |
80 | , m_blinkTimer(0) |
81 | , m_maxLength(32767) |
82 | , m_lastCursorPos(-1) |
83 | , m_undoState(0) |
84 | , m_selstart(0) |
85 | , m_selend(0) |
86 | #if QT_CONFIG(im) |
87 | , inputMethodHints(Qt::ImhNone) |
88 | #endif |
89 | , hAlign(QQuickTextInput::AlignLeft) |
90 | , vAlign(QQuickTextInput::AlignTop) |
91 | , wrapMode(QQuickTextInput::NoWrap) |
92 | , m_echoMode(QQuickTextInput::Normal) |
93 | , renderType(QQuickTextUtil::textRenderType<QQuickTextInput>()) |
94 | , updateType(UpdatePaintNode) |
95 | , mouseSelectionMode(QQuickTextInput::SelectCharacters) |
96 | , m_layoutDirection(Qt::LayoutDirectionAuto) |
97 | , m_passwordCharacter(QGuiApplication::styleHints()->passwordMaskCharacter()) |
98 | , m_passwordMaskDelay(QGuiApplication::styleHints()->passwordMaskDelay()) |
99 | , focusOnPress(true) |
100 | , cursorVisible(false) |
101 | , cursorPending(false) |
102 | , autoScroll(true) |
103 | , selectByMouse(true) |
104 | , canPaste(false) |
105 | , canPasteValid(false) |
106 | , canUndo(false) |
107 | , canRedo(false) |
108 | , hAlignImplicit(true) |
109 | , selectPressed(false) |
110 | , textLayoutDirty(true) |
111 | , persistentSelection(false) |
112 | , hasImState(false) |
113 | , m_separator(0) |
114 | , m_readOnly(0) |
115 | , m_textDirty(0) |
116 | #if QT_CONFIG(im) |
117 | , m_preeditDirty(0) |
118 | #endif |
119 | , m_selDirty(0) |
120 | , m_validInput(1) |
121 | , m_acceptableInput(1) |
122 | , m_blinkStatus(0) |
123 | , m_passwordEchoEditing(false) |
124 | , inLayout(false) |
125 | , requireImplicitWidth(false) |
126 | , overwriteMode(false) |
127 | #if QT_VERSION < QT_VERSION_CHECK(7, 0, 0) |
128 | , selectByTouchDrag(false) |
129 | #endif |
130 | { |
131 | } |
132 | |
133 | ~QQuickTextInputPrivate() |
134 | { |
135 | // If this control is used for password input, we don't want the |
136 | // password data to stay in the process memory, therefore we need |
137 | // to zero it out |
138 | if (m_echoMode != QQuickTextInput::Normal) |
139 | m_text.fill(c: u'\0'); |
140 | } |
141 | |
142 | void init(); |
143 | void cancelInput(); |
144 | void startCreatingCursor(); |
145 | void ensureVisible(int position, int preeditCursor = 0, int preeditLength = 0); |
146 | void updateHorizontalScroll(); |
147 | void updateVerticalScroll(); |
148 | bool determineHorizontalAlignment(); |
149 | bool setHAlign(QQuickTextInput::HAlignment, bool forceAlign = false); |
150 | void mirrorChange() override; |
151 | bool sendMouseEventToInputContext(QMouseEvent *event); |
152 | #if QT_CONFIG(im) |
153 | Qt::InputMethodHints effectiveInputMethodHints() const; |
154 | #endif |
155 | void handleFocusEvent(QFocusEvent *event); |
156 | |
157 | struct MaskInputData { |
158 | enum Casemode { NoCaseMode, Upper, Lower }; |
159 | QChar maskChar; // either the separator char or the inputmask |
160 | bool separator; |
161 | Casemode caseMode; |
162 | }; |
163 | |
164 | // undo/redo handling |
165 | enum CommandType { Separator, Insert, Remove, Delete, RemoveSelection, DeleteSelection, SetSelection }; |
166 | struct Command { |
167 | inline Command() {} |
168 | inline Command(CommandType t, int p, QChar c, int ss, int se) : type(t),uc(c),pos(p),selStart(ss),selEnd(se) {} |
169 | uint type : 4; |
170 | QChar uc; |
171 | int pos, selStart, selEnd; |
172 | }; |
173 | |
174 | enum DrawFlags { |
175 | DrawText = 0x01, |
176 | DrawSelections = 0x02, |
177 | DrawCursor = 0x04, |
178 | DrawAll = DrawText | DrawSelections | DrawCursor |
179 | }; |
180 | |
181 | QElapsedTimer tripleClickTimer; |
182 | QSizeF contentSize; |
183 | QPointF pressPos; |
184 | QPointF tripleClickStartPoint; |
185 | |
186 | QPointer<QQmlComponent> cursorComponent; |
187 | #if QT_CONFIG(validator) |
188 | QPointer<QValidator> m_validator; |
189 | #endif |
190 | |
191 | qreal hscroll; |
192 | qreal vscroll; |
193 | |
194 | QTextLayout m_textLayout; |
195 | QString m_text; |
196 | QString m_inputMask; |
197 | QString m_cancelText; |
198 | QFont font; |
199 | QFont sourceFont; |
200 | |
201 | QQuickItem *cursorItem; |
202 | QQuickTextNode *textNode; |
203 | std::unique_ptr<MaskInputData[]> m_maskData; |
204 | QInputControl *m_inputControl; |
205 | |
206 | QList<int> m_transactions; |
207 | QVector<Command> m_history; |
208 | |
209 | QColor color; |
210 | QColor selectionColor; |
211 | QColor selectedTextColor; |
212 | |
213 | QBasicTimer m_passwordEchoTimer; |
214 | int lastSelectionStart; |
215 | int lastSelectionEnd; |
216 | int m_cursor; |
217 | #if QT_CONFIG(im) |
218 | int m_preeditCursor; |
219 | int m_undoPreeditState; |
220 | #endif |
221 | bool m_blinkEnabled; |
222 | int m_blinkTimer; |
223 | int m_maxLength; |
224 | int m_lastCursorPos; |
225 | int m_undoState; |
226 | int m_selstart; |
227 | int m_selend; |
228 | |
229 | enum UpdateType { |
230 | UpdateNone, |
231 | UpdateOnlyPreprocess, |
232 | UpdatePaintNode |
233 | }; |
234 | |
235 | #if QT_CONFIG(im) |
236 | Qt::InputMethodHints inputMethodHints; |
237 | #endif |
238 | QQuickTextInput::HAlignment hAlign; |
239 | QQuickTextInput::VAlignment vAlign; |
240 | QQuickTextInput::WrapMode wrapMode; |
241 | QQuickTextInput::EchoMode m_echoMode; |
242 | QQuickTextInput::RenderType renderType; |
243 | UpdateType updateType; |
244 | QQuickTextInput::SelectionMode mouseSelectionMode; |
245 | Qt::LayoutDirection m_layoutDirection; |
246 | |
247 | QChar m_blank; |
248 | QChar m_passwordCharacter; |
249 | int m_passwordMaskDelay; |
250 | |
251 | bool focusOnPress:1; |
252 | bool cursorVisible:1; |
253 | bool cursorPending:1; |
254 | bool autoScroll:1; |
255 | bool selectByMouse:1; |
256 | bool canPaste:1; |
257 | bool canPasteValid:1; |
258 | bool canUndo:1; |
259 | bool canRedo:1; |
260 | bool hAlignImplicit:1; |
261 | bool selectPressed:1; |
262 | bool textLayoutDirty:1; |
263 | bool persistentSelection:1; |
264 | bool hasImState : 1; |
265 | bool m_separator : 1; |
266 | bool m_readOnly : 1; |
267 | bool m_textDirty : 1; |
268 | #if QT_CONFIG(im) |
269 | bool m_preeditDirty : 1; |
270 | #endif |
271 | bool m_selDirty : 1; |
272 | bool m_validInput : 1; |
273 | bool m_acceptableInput : 1; |
274 | bool m_blinkStatus : 1; |
275 | bool m_passwordEchoEditing : 1; |
276 | bool inLayout:1; |
277 | bool requireImplicitWidth:1; |
278 | bool overwriteMode:1; |
279 | #if QT_VERSION < QT_VERSION_CHECK(7, 0, 0) |
280 | bool selectByTouchDrag:1; |
281 | #endif |
282 | |
283 | static inline QQuickTextInputPrivate *get(QQuickTextInput *t) { |
284 | return t->d_func(); |
285 | } |
286 | bool hasPendingTripleClick() const { |
287 | return !tripleClickTimer.hasExpired(timeout: QGuiApplication::styleHints()->mouseDoubleClickInterval()); |
288 | } |
289 | |
290 | void setNativeCursorEnabled(bool) { |
291 | updateCursorBlinking(); |
292 | } |
293 | |
294 | int nextMaskBlank(int pos) |
295 | { |
296 | int c = findInMask(pos, forward: true, findSeparator: false); |
297 | m_separator |= (c != pos); |
298 | return (c != -1 ? c : m_maxLength); |
299 | } |
300 | |
301 | int prevMaskBlank(int pos) |
302 | { |
303 | int c = findInMask(pos, forward: false, findSeparator: false); |
304 | m_separator |= (c != pos); |
305 | return (c != -1 ? c : 0); |
306 | } |
307 | |
308 | bool isUndoAvailable() const { return !m_readOnly && m_undoState; } |
309 | bool isRedoAvailable() const { return !m_readOnly && m_undoState < (int)m_history.size(); } |
310 | void clearUndo() { |
311 | m_history.clear(); |
312 | m_undoState = 0; |
313 | #if QT_CONFIG(im) |
314 | m_undoPreeditState = -1; |
315 | #endif |
316 | } |
317 | |
318 | bool allSelected() const { return !m_text.isEmpty() && m_selstart == 0 && m_selend == (int)m_text.size(); } |
319 | bool hasSelectedText() const { return !m_text.isEmpty() && m_selend > m_selstart; } |
320 | |
321 | void setSelection(int start, int length); |
322 | |
323 | inline QString selectedText() const { return hasSelectedText() ? m_text.mid(position: m_selstart, n: m_selend - m_selstart) : QString(); } |
324 | QString textBeforeSelection() const { return hasSelectedText() ? m_text.left(n: m_selstart) : QString(); } |
325 | QString textAfterSelection() const { return hasSelectedText() ? m_text.mid(position: m_selend) : QString(); } |
326 | |
327 | int selectionStart() const { return hasSelectedText() ? m_selstart : -1; } |
328 | int selectionEnd() const { return hasSelectedText() ? m_selend : -1; } |
329 | |
330 | QRectF anchorRectangle() const; |
331 | |
332 | int positionAt(qreal x, qreal y, QTextLine::CursorPosition position) const; |
333 | int positionAt(const QPointF &point, QTextLine::CursorPosition position = QTextLine::CursorBetweenCharacters) const { |
334 | return positionAt(x: point.x(), y: point.y(), position); |
335 | } |
336 | |
337 | void removeSelection() |
338 | { |
339 | int priorState = m_undoState; |
340 | removeSelectedText(); |
341 | finishChange(validateFromState: priorState); |
342 | } |
343 | |
344 | int start() const { return 0; } |
345 | int end() const { return m_text.size(); } |
346 | |
347 | QString realText() const; |
348 | |
349 | #if QT_CONFIG(clipboard) |
350 | void copy(QClipboard::Mode mode = QClipboard::Clipboard) const; |
351 | void paste(QClipboard::Mode mode = QClipboard::Clipboard); |
352 | #endif |
353 | |
354 | #if QT_CONFIG(im) |
355 | void commitPreedit(); |
356 | void cancelPreedit(); |
357 | #endif |
358 | |
359 | Qt::CursorMoveStyle cursorMoveStyle() const { return m_textLayout.cursorMoveStyle(); } |
360 | void setCursorMoveStyle(Qt::CursorMoveStyle style) { m_textLayout.setCursorMoveStyle(style); } |
361 | |
362 | void moveCursor(int pos, bool mark = false); |
363 | void cursorForward(bool mark, int steps) |
364 | { |
365 | int c = m_cursor; |
366 | if (steps > 0) { |
367 | while (steps--) |
368 | c = cursorMoveStyle() == Qt::VisualMoveStyle ? m_textLayout.rightCursorPosition(oldPos: c) |
369 | : m_textLayout.nextCursorPosition(oldPos: c); |
370 | } else if (steps < 0) { |
371 | while (steps++) |
372 | c = cursorMoveStyle() == Qt::VisualMoveStyle ? m_textLayout.leftCursorPosition(oldPos: c) |
373 | : m_textLayout.previousCursorPosition(oldPos: c); |
374 | } |
375 | moveCursor(pos: c, mark); |
376 | } |
377 | |
378 | void cursorWordForward(bool mark) { moveCursor(pos: m_textLayout.nextCursorPosition(oldPos: m_cursor, mode: QTextLayout::SkipWords), mark); } |
379 | void cursorWordBackward(bool mark) { moveCursor(pos: m_textLayout.previousCursorPosition(oldPos: m_cursor, mode: QTextLayout::SkipWords), mark); } |
380 | |
381 | void home(bool mark) { moveCursor(pos: 0, mark); } |
382 | void end(bool mark) { moveCursor(pos: q_func()->text().size(), mark); } |
383 | |
384 | void backspace(); |
385 | void del(); |
386 | void deselect() { internalDeselect(); finishChange(); } |
387 | void selectAll() { m_selstart = m_selend = m_cursor = 0; moveCursor(pos: m_text.size(), mark: true); } |
388 | |
389 | void insert(const QString &); |
390 | void clear(); |
391 | void selectWordAtPos(int); |
392 | |
393 | void setCursorPosition(int pos) { if (pos <= m_text.size()) moveCursor(pos: qMax(a: 0, b: pos)); } |
394 | |
395 | bool fixup(); |
396 | |
397 | QString inputMask() const { return m_maskData ? m_inputMask + QLatin1Char(';') + m_blank : QString(); } |
398 | void setInputMask(const QString &mask) |
399 | { |
400 | parseInputMask(maskFields: mask); |
401 | if (m_maskData) |
402 | moveCursor(pos: nextMaskBlank(pos: 0)); |
403 | } |
404 | |
405 | // input methods |
406 | #if QT_CONFIG(im) |
407 | bool composeMode() const { return !m_textLayout.preeditAreaText().isEmpty(); } |
408 | |
409 | QString preeditAreaText() const { return m_textLayout.preeditAreaText(); } |
410 | #endif |
411 | |
412 | void updatePasswordEchoEditing(bool editing); |
413 | |
414 | void cancelPasswordEchoTimer() { |
415 | m_passwordEchoTimer.stop(); |
416 | } |
417 | |
418 | Qt::LayoutDirection textDirection() const; |
419 | Qt::LayoutDirection layoutDirection() const; |
420 | void setLayoutDirection(Qt::LayoutDirection direction) |
421 | { |
422 | if (direction != m_layoutDirection) { |
423 | m_layoutDirection = direction; |
424 | updateDisplayText(); |
425 | } |
426 | } |
427 | |
428 | #if QT_CONFIG(im) |
429 | void processInputMethodEvent(QInputMethodEvent *event); |
430 | #endif |
431 | void processKeyEvent(QKeyEvent* ev); |
432 | |
433 | void setBlinkingCursorEnabled(bool enable); |
434 | void updateCursorBlinking(); |
435 | |
436 | void updateLayout(); |
437 | void updateBaselineOffset(); |
438 | |
439 | qreal calculateImplicitWidthForText(const QString &text) const; |
440 | qreal getImplicitWidth() const override; |
441 | |
442 | inline qreal padding() const { return extra.isAllocated() ? extra->padding : 0.0; } |
443 | void setTopPadding(qreal value, bool reset = false); |
444 | void setLeftPadding(qreal value, bool reset = false); |
445 | void setRightPadding(qreal value, bool reset = false); |
446 | void setBottomPadding(qreal value, bool reset = false); |
447 | |
448 | bool isImplicitResizeEnabled() const; |
449 | void setImplicitResizeEnabled(bool enabled); |
450 | |
451 | private: |
452 | void removeSelectedText(); |
453 | void internalSetText(const QString &txt, int pos = -1, bool edited = true); |
454 | void updateDisplayText(bool forceUpdate = false); |
455 | |
456 | void internalInsert(const QString &s); |
457 | void internalDelete(bool wasBackspace = false); |
458 | void internalRemove(int pos); |
459 | |
460 | inline void internalDeselect() |
461 | { |
462 | m_selDirty |= (m_selend > m_selstart); |
463 | m_selstart = m_selend = 0; |
464 | } |
465 | |
466 | void internalUndo(int until = -1); |
467 | void internalRedo(); |
468 | void emitUndoRedoChanged(); |
469 | |
470 | bool emitCursorPositionChanged(); |
471 | |
472 | bool finishChange(int validateFromState = -1, bool update = false, bool edited = true); |
473 | |
474 | void addCommand(const Command& cmd); |
475 | |
476 | inline void separate() { m_separator = true; } |
477 | |
478 | bool separateSelection(); |
479 | void deleteStartOfWord(); |
480 | void deleteEndOfWord(); |
481 | void deleteEndOfLine(); |
482 | |
483 | enum ValidatorState { |
484 | #if QT_CONFIG(validator) |
485 | InvalidInput = QValidator::Invalid, |
486 | IntermediateInput = QValidator::Intermediate, |
487 | AcceptableInput = QValidator::Acceptable |
488 | #else |
489 | InvalidInput, |
490 | IntermediateInput, |
491 | AcceptableInput |
492 | #endif |
493 | }; |
494 | |
495 | // masking |
496 | void parseInputMask(const QString &maskFields); |
497 | bool isValidInput(QChar key, QChar mask) const; |
498 | ValidatorState hasAcceptableInput(const QString &text) const; |
499 | void checkIsValid(); |
500 | QString maskString(uint pos, const QString &str, bool clear = false) const; |
501 | QString clearString(uint pos, uint len) const; |
502 | QString stripString(const QString &str) const; |
503 | int findInMask(int pos, bool forward, bool findSeparator, QChar searchChar = QChar()) const; |
504 | }; |
505 | |
506 | QT_END_NAMESPACE |
507 | |
508 | #endif // QQUICKTEXTINPUT_P_P_H |
509 | |