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
206
207
208
209
|
// Copyright (C) 2025 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.
#if canImport(WritingTools)
import Foundation
import WebKit
import WebKitSwift
@_spi(Private) import WebKit
@MainActor
protocol IntelligenceTextEffectViewManagerDelegate {
func updateTextChunkVisibility(_ chunk: IntelligenceTextEffectChunk, visible: Bool, force: Bool) async
}
@MainActor
class IntelligenceTextEffectViewManager<Source> where Source: IntelligenceTextEffectViewManagerDelegate, Source: PlatformIntelligenceTextEffectViewSource, Source.Chunk == IntelligenceTextEffectChunk {
init(source: Source? = nil, contentView: PlatformView) {
self.source = source
self.contentView = contentView
}
private weak var source: Source?
private let contentView: PlatformView
private var effectView: PlatformIntelligenceTextEffectView<Source>? = nil
private var activePonderingEffect: PlatformIntelligencePonderingTextEffect<IntelligenceTextEffectChunk>? = nil
private var activeReplacementEffect: PlatformIntelligenceReplacementTextEffect<IntelligenceTextEffectChunk>? = nil
var suppressEffectView = false
public var hasActiveEffects: Bool {
self.activePonderingEffect != nil || self.activeReplacementEffect != nil
}
private func setupViewIfNeeded() {
guard self.effectView == nil, let source = self.source else {
return
}
let effectView = PlatformIntelligenceTextEffectView(source: source)
#if os(iOS)
effectView.isUserInteractionEnabled = false
effectView.frame = contentView.frame
contentView.superview!.addSubview(effectView)
#else
effectView.frame = contentView.bounds
contentView.addSubview(effectView)
#endif
if self.suppressEffectView {
effectView.isHidden = true
}
// UIKit expects subviews of the effect view to be added after the effect view is added to its parent.
effectView.initializeSubviews()
self.effectView = effectView
}
private func destroyViewIfNeeded() {
guard self.activePonderingEffect == nil && self.activeReplacementEffect == nil else {
return
}
self.effectView?.removeFromSuperview()
self.effectView = nil
}
func setActivePonderingEffect(_ effect: PlatformIntelligencePonderingTextEffect<IntelligenceTextEffectChunk>?) async {
if self.activePonderingEffect == nil && effect == nil {
return
}
if self.activePonderingEffect != nil && effect != nil {
assertionFailure("Intelligence text effect coordinator: trying to either set a new pondering effect when there is an ongoing one.")
return
}
let oldEffect = self.activePonderingEffect
self.activePonderingEffect = effect
if let effect {
self.setupViewIfNeeded()
await self.effectView?.addEffect(effect)
} else {
// This needs to be manually invoked rather than relying on the associated delegate method being called. This is
// because when removing an effect, the delegate method is invoked after the effect removal function ends. Invoking
// this method manually ensures that the replacement effect doesn't start until the visibility has actually changed
// and this function terminates.
//
// Therefore, the delegate method itself must avoid any work so that it can be synchronous, which is what the platform
// interfaces expect.
await self.source?.updateTextChunkVisibility(oldEffect!.chunk, visible: true, force: true)
await self.effectView?.removeEffect(oldEffect!.id)
self.destroyViewIfNeeded()
}
}
func setActiveReplacementEffect(_ effect: PlatformIntelligenceReplacementTextEffect<IntelligenceTextEffectChunk>?) async {
if self.activeReplacementEffect == nil && effect == nil {
return
}
if self.activeReplacementEffect != nil && effect != nil {
assertionFailure("Intelligence text effect coordinator: trying to either set a new replacement effect when there is an ongoing one.")
return
}
let oldEffect = self.activeReplacementEffect
self.activeReplacementEffect = effect
if let effect {
self.setupViewIfNeeded()
await self.effectView?.addEffect(effect)
} else {
await self.effectView?.removeEffect(oldEffect!.id)
self.destroyViewIfNeeded()
}
}
func hideEffects() async {
guard !self.suppressEffectView else {
return
}
// On macOS, the effect view currently doesn't scroll with the web content. Therefore, the effects need to be suppressed
// when scrolling, resizing, or zooming.
//
// Consequently, since the effects will now be hidden, it is critical that the underlying text visibility is restored to be visible.
self.suppressEffectView = true
if let activePonderingEffect = self.activePonderingEffect {
await source?.updateTextChunkVisibility(activePonderingEffect.chunk, visible: true)
}
if let activeReplacementEffect = self.activeReplacementEffect {
await source?.updateTextChunkVisibility(activeReplacementEffect.chunk, visible: true)
}
self.effectView?.isHidden = true
}
func showEffects() async {
// FIXME: Ideally, after scrolling/resizing/zooming, the effects would be restored and visible.
}
func removeActiveEffects() async {
if self.activePonderingEffect != nil {
await self.setActivePonderingEffect(nil)
}
if self.activeReplacementEffect != nil {
await self.setActiveReplacementEffect(nil)
}
}
func updateActivePonderingEffect(transform: (Range<Int>) -> Range<Int>) {
if let activePonderingEffect = self.activePonderingEffect {
activePonderingEffect.chunk.range = transform(activePonderingEffect.chunk.range)
}
}
func reset() {
self.effectView?.removeAllEffects()
self.effectView?.removeFromSuperview()
self.effectView = nil
self.activePonderingEffect = nil
self.activeReplacementEffect = nil
self.suppressEffectView = false
}
func assertPonderingEffectIsInactive(file: StaticString = #file, line: UInt = #line) {
assert(self.activePonderingEffect == nil, "Intelligence text effect coordinator: expected pondering effect to be inactive", file: file, line: line)
}
func assertReplacementEffectIsInactive(file: StaticString = #file, line: UInt = #line) {
assert(self.activeReplacementEffect == nil, "Intelligence text effect coordinator: expected replacement effect to be inactive", file: file, line: line)
}
}
#endif
|
