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
|
/*
* Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef InputMethodController_h
#define InputMethodController_h
#include "core/editing/CompositionUnderline.h"
#include "core/editing/PlainTextRange.h"
#include "wtf/Vector.h"
namespace WebCore {
class Editor;
class EditorClient;
class Frame;
class Range;
class Text;
class InputMethodController {
WTF_MAKE_NONCOPYABLE(InputMethodController);
public:
enum ConfirmCompositionBehavior {
DoNotKeepSelection,
KeepSelection,
};
static PassOwnPtr<InputMethodController> create(Frame&);
~InputMethodController();
// international text input composition
bool hasComposition() const;
void setComposition(const String&, const Vector<CompositionUnderline>&, unsigned selectionStart, unsigned selectionEnd);
void setCompositionFromExistingText(const Vector<CompositionUnderline>&, unsigned compositionStart, unsigned compositionEnd);
// Inserts the text that is being composed as a regular text and returns true
// if composition exists.
bool confirmComposition();
// Inserts the given text string in the place of the existing composition
// and returns true.
bool confirmComposition(const String& text);
// Inserts the text that is being composed or specified non-empty text and
// returns true.
bool confirmCompositionOrInsertText(const String& text, ConfirmCompositionBehavior);
void confirmCompositionAndResetState();
// Deletes the existing composition text.
void cancelComposition();
void cancelCompositionIfSelectionIsInvalid();
PassRefPtr<Range> compositionRange() const;
// getting international text input composition state (for use by InlineTextBox)
Text* compositionNode() const { return m_compositionNode.get(); }
unsigned compositionStart() const { return m_compositionStart; }
unsigned compositionEnd() const { return m_compositionEnd; }
bool compositionUsesCustomUnderlines() const { return !m_customCompositionUnderlines.isEmpty(); }
const Vector<CompositionUnderline>& customCompositionUnderlines() const { return m_customCompositionUnderlines; }
void clear();
PlainTextRange getSelectionOffsets() const;
// Returns true if setting selection to specified offsets, otherwise false.
bool setEditableSelectionOffsets(const PlainTextRange&);
void extendSelectionAndDelete(int before, int after);
private:
class SelectionOffsetsScope {
WTF_MAKE_NONCOPYABLE(SelectionOffsetsScope);
public:
SelectionOffsetsScope(InputMethodController*);
~SelectionOffsetsScope();
private:
InputMethodController* m_inputMethodController;
const PlainTextRange m_offsets;
};
friend class SelectionOffsetsScope;
Frame& m_frame;
RefPtr<Text> m_compositionNode;
// We don't use PlainTextRange which is immutable, for composition range.
unsigned m_compositionStart;
unsigned m_compositionEnd;
// startOffset and endOffset of CompositionUnderline are based on
// m_compositionNode.
Vector<CompositionUnderline> m_customCompositionUnderlines;
explicit InputMethodController(Frame&);
Editor& editor() const;
bool insertTextForConfirmedComposition(const String& text);
void selectComposition() const;
enum FinishCompositionMode { ConfirmComposition, CancelComposition };
// Returns true if composition exists.
bool finishComposition(const String&, FinishCompositionMode);
bool setSelectionOffsets(const PlainTextRange&);
};
} // namespace WebCore
#endif // InputMethodController_h
|
