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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*
* Copyright (C) 2024 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 INC. AND ITS CONTRIBUTORS ``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 INC. OR ITS 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.
*/
#pragma once
#if ENABLE(WRITING_TOOLS)
#import "Range.h"
#import "WritingToolsCompositionCommand.h"
#import "WritingToolsTypes.h"
#import <wtf/CheckedPtr.h>
#import <wtf/TZoneMalloc.h>
#import <wtf/WeakPtr.h>
namespace WebCore {
class CompositeEditCommand;
class EditCommandComposition;
class Document;
class DocumentFragment;
class DocumentMarker;
class Node;
class Page;
struct SimpleRange;
enum class TextAnimationRunMode : uint8_t;
class WritingToolsController final : public CanMakeWeakPtr<WritingToolsController>, public CanMakeCheckedPtr<WritingToolsController> {
WTF_MAKE_TZONE_ALLOCATED(WritingToolsController);
WTF_MAKE_NONCOPYABLE(WritingToolsController);
WTF_OVERRIDE_DELETE_FOR_CHECKED_PTR(WritingToolsController);
public:
explicit WritingToolsController(Page&);
void willBeginWritingToolsSession(const std::optional<WritingTools::Session>&, CompletionHandler<void(const Vector<WritingTools::Context>&)>&&);
void didBeginWritingToolsSession(const WritingTools::Session&, const Vector<WritingTools::Context>&);
void proofreadingSessionDidReceiveSuggestions(const WritingTools::Session&, const Vector<WritingTools::TextSuggestion>&, const CharacterRange&, const WritingTools::Context&, bool finished);
void proofreadingSessionDidUpdateStateForSuggestion(const WritingTools::Session&, WritingTools::TextSuggestion::State, const WritingTools::TextSuggestion&, const WritingTools::Context&);
void willEndWritingToolsSession(const WritingTools::Session&, bool accepted);
void didEndWritingToolsSession(const WritingTools::Session&, bool accepted);
void compositionSessionDidReceiveTextWithReplacementRange(const WritingTools::Session&, const AttributedString&, const CharacterRange&, const WritingTools::Context&, bool finished);
void writingToolsSessionDidReceiveAction(const WritingTools::Session&, WritingTools::Action);
void updateStateForSelectedSuggestionIfNeeded();
void respondToUnappliedEditing(EditCommandComposition*);
void respondToReappliedEditing(EditCommandComposition*);
// FIXME: Refactor `TextAnimationController` in such a way so as to not explicitly depend on `WritingToolsController`,
// and then remove these methods after doing so.
std::optional<SimpleRange> activeSessionRange() const;
void intelligenceTextAnimationsDidComplete();
private:
struct CompositionState : CanMakeCheckedPtr<CompositionState> {
WTF_MAKE_STRUCT_FAST_ALLOCATED;
WTF_STRUCT_OVERRIDE_DELETE_FOR_CHECKED_PTR(CompositionState);
enum class ClearStateDeferralReason : uint8_t {
SessionInProgress = 1 << 0,
AnimationInProgress = 1 << 1,
};
CompositionState(const Vector<Ref<WritingToolsCompositionCommand>>& unappliedCommands, const Vector<Ref<WritingToolsCompositionCommand>>& reappliedCommands, const WritingTools::Session& session)
: unappliedCommands(unappliedCommands)
, reappliedCommands(reappliedCommands)
, session(session)
{
}
// These two vectors should never have the same command in both of them.
Vector<Ref<WritingToolsCompositionCommand>> unappliedCommands;
Vector<Ref<WritingToolsCompositionCommand>> reappliedCommands;
WritingTools::Session session;
OptionSet<ClearStateDeferralReason> clearStateDeferralReasons;
bool shouldCommitAfterReplacement { false };
std::optional<CharacterRange> replacedRange;
std::optional<CharacterRange> pendingReplacedRange;
};
struct ProofreadingState : CanMakeCheckedPtr<ProofreadingState> {
WTF_MAKE_STRUCT_FAST_ALLOCATED;
WTF_STRUCT_OVERRIDE_DELETE_FOR_CHECKED_PTR(ProofreadingState);
ProofreadingState(const Ref<Range>& contextRange, const WritingTools::Session& session, int replacementLocationOffset)
: contextRange(contextRange)
, session(session)
, replacementLocationOffset(replacementLocationOffset)
{
}
Ref<Range> contextRange;
WritingTools::Session session;
int replacementLocationOffset { 0 };
};
template<WritingTools::Session::Type Type>
struct StateFromSessionType { };
template<>
struct StateFromSessionType<WritingTools::Session::Type::Proofreading> {
using Value = ProofreadingState;
};
template<>
struct StateFromSessionType<WritingTools::Session::Type::Composition> {
using Value = CompositionState;
};
class EditingScope {
WTF_MAKE_TZONE_ALLOCATED(EditingScope);
WTF_MAKE_NONCOPYABLE(EditingScope);
public:
EditingScope(Document&);
~EditingScope();
private:
RefPtr<Document> m_document;
bool m_editingWasSuppressed;
};
static CharacterRange characterRange(const SimpleRange& scope, const SimpleRange&);
static SimpleRange resolveCharacterRange(const SimpleRange& scope, CharacterRange);
static uint64_t characterCount(const SimpleRange&);
static String plainText(const SimpleRange&);
template<WritingTools::Session::Type Type>
StateFromSessionType<Type>::Value* currentState();
template<WritingTools::Session::Type Type>
const StateFromSessionType<Type>::Value* currentState() const;
std::optional<std::tuple<Node&, DocumentMarker&>> findTextSuggestionMarkerContainingRange(const SimpleRange&) const;
std::optional<std::tuple<Node&, DocumentMarker&>> findTextSuggestionMarkerByID(const SimpleRange& outerRange, const WritingTools::TextSuggestion::ID&) const;
void replaceContentsOfRangeInSession(ProofreadingState&, const SimpleRange&, const String&);
void replaceContentsOfRangeInSession(CompositionState&, const SimpleRange&, const AttributedString&, WritingToolsCompositionCommand::State);
void compositionSessionDidFinishReplacement();
void compositionSessionDidFinishReplacement(const WTF::UUID& sourceAnimationUUID, const WTF::UUID& destinationAnimationUUID, const CharacterRange&, const String&);
void smartReplySessionDidReceiveTextWithReplacementRange(const WritingTools::Session&, const AttributedString&, const CharacterRange&, const WritingTools::Context&, bool finished);
void compositionSessionDidReceiveTextWithReplacementRangeAsync(const WTF::UUID&, const WTF::UUID&, const AttributedString&, const CharacterRange&, const WritingTools::Context&, bool finished, TextAnimationRunMode);
void showOriginalCompositionForSession();
void showRewrittenCompositionForSession();
void restartCompositionForSession();
template<CompositionState::ClearStateDeferralReason Reason>
void removeCompositionClearStateDeferralReason();
template<WritingTools::Session::Type Type>
void writingToolsSessionDidReceiveAction(WritingTools::Action);
template<WritingTools::Session::Type Type>
void willEndWritingToolsSession(bool accepted);
template<WritingTools::Session::Type Type>
void didEndWritingToolsSession(bool accepted);
void commitComposition(CompositionState&, Document&);
RefPtr<Document> document() const;
WeakPtr<Page> m_page;
std::variant<std::monostate, ProofreadingState, CompositionState> m_state;
};
} // namespace WebKit
#endif
|
