-
Notifications
You must be signed in to change notification settings - Fork 107
/
VisualReaderViewController.swift
378 lines (312 loc) · 13.1 KB
/
VisualReaderViewController.swift
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
//
// Copyright 2024 Readium Foundation. All rights reserved.
// Use of this source code is governed by the BSD-style license
// available in the top-level LICENSE file of the project.
//
import Combine
import Foundation
import ReadiumNavigator
import ReadiumShared
import SwiftUI
import UIKit
/// Base class for the reader view controller of a `VisualNavigator`.
class VisualReaderViewController<N: UIViewController & Navigator>: ReaderViewController<N>, VisualNavigatorDelegate {
private lazy var positionLabel = UILabel()
private let ttsViewModel: TTSViewModel?
private let ttsControlsViewController: UIHostingController<TTSControls>?
init(
navigator: N,
publication: Publication,
bookId: Book.Id,
books: BookRepository,
bookmarks: BookmarkRepository,
highlights: HighlightRepository?
) {
self.highlights = highlights
ttsViewModel = TTSViewModel(navigator: navigator, publication: publication)
ttsControlsViewController = ttsViewModel.map { UIHostingController(rootView: TTSControls(viewModel: $0)) }
super.init(
navigator: navigator,
publication: publication,
bookId: bookId,
books: books,
bookmarks: bookmarks
)
addHighlightDecorationsObserverOnce()
updateHighlightDecorations()
updatePageListDecorations()
}
@available(*, unavailable)
required init?(coder aDecoder: NSCoder) {
fatalError("init(coder:) has not been implemented")
}
override func viewDidLoad() {
super.viewDidLoad()
view.backgroundColor = .white
updateNavigationBar(animated: false)
addChild(navigator)
navigator.view.frame = view.bounds
navigator.view.autoresizingMask = [.flexibleWidth, .flexibleHeight]
view.addSubview(navigator.view)
navigator.didMove(toParent: self)
positionLabel.translatesAutoresizingMaskIntoConstraints = false
positionLabel.font = .systemFont(ofSize: 12)
positionLabel.textColor = .darkGray
// Prevents VoiceOver from selecting the position label while reading
// the page.
positionLabel.isAccessibilityElement = false
view.addSubview(positionLabel)
NSLayoutConstraint.activate([
positionLabel.centerXAnchor.constraint(equalTo: view.centerXAnchor),
positionLabel.bottomAnchor.constraint(equalTo: navigator.view.bottomAnchor, constant: -20),
])
if let state = ttsViewModel?.$state, let controls = ttsControlsViewController {
controls.view.backgroundColor = .clear
addChild(controls)
controls.view.translatesAutoresizingMaskIntoConstraints = false
view.addSubview(controls.view)
NSLayoutConstraint.activate([
controls.view.centerXAnchor.constraint(equalTo: view.centerXAnchor),
controls.view.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor, constant: 20),
])
controls.didMove(toParent: self)
state
.sink { state in
controls.view.isHidden = !state.showControls
}
.store(in: &subscriptions)
}
}
override func viewWillDisappear(_ animated: Bool) {
super.viewWillDisappear(animated)
ttsViewModel?.stop()
}
// MARK: - Navigation bar
private var navigationBarHidden: Bool = true {
didSet {
updateNavigationBar()
}
}
override func makeNavigationBarButtons() -> [UIBarButtonItem] {
var buttons: [UIBarButtonItem] = super.makeNavigationBarButtons()
// Text to speech
if let ttsViewModel = ttsViewModel {
buttons.append(UIBarButtonItem(image: UIImage(systemName: "speaker.wave.2.fill"), style: .plain, target: ttsViewModel, action: #selector(TTSViewModel.start)))
}
return buttons
}
func toggleNavigationBar() {
navigationBarHidden = !navigationBarHidden
}
func updateNavigationBar(animated: Bool = true) {
navigationController?.setNavigationBarHidden(navigationBarHidden, animated: animated)
setNeedsStatusBarAppearanceUpdate()
}
override var preferredStatusBarUpdateAnimation: UIStatusBarAnimation {
.slide
}
override var prefersStatusBarHidden: Bool {
navigationBarHidden
}
// MARK: - VisualNavigatorDelegate
override func navigator(_ navigator: Navigator, locationDidChange locator: Locator) {
super.navigator(navigator, locationDidChange: locator)
positionLabel.text = {
if let position = locator.locations.position {
return "\(position) / \(publication.positions.count)"
} else if let progression = locator.locations.totalProgression {
return "\(progression)%"
} else {
return nil
}
}()
}
func navigator(_ navigator: VisualNavigator, didTapAt point: CGPoint) {
// Turn pages when tapping the edge of the screen.
guard !DirectionalNavigationAdapter(navigator: navigator).didTap(at: point) else {
return
}
// clear a current search highlight
if let decorator = self.navigator as? DecorableNavigator {
decorator.apply(decorations: [], in: "search")
}
toggleNavigationBar()
}
func navigator(_ navigator: VisualNavigator, didPressKey event: KeyEvent) {
// Turn pages when pressing the arrow keys.
DirectionalNavigationAdapter(navigator: navigator).didPressKey(event: event)
}
// MARK: - Highlights
private let highlights: HighlightRepository?
private var highlightContextMenu: UIHostingController<HighlightContextMenu>?
private let highlightDecorationGroup = "highlights"
private var currentHighlightCancellable: AnyCancellable?
func saveHighlight(_ highlight: Highlight) {
guard let highlights = highlights else { return }
Task {
do {
try await highlights.add(highlight)
toast(NSLocalizedString("reader_highlight_success_message", comment: "Success message when adding a bookmark"), on: view, duration: 1)
} catch {
print(error)
toast(NSLocalizedString("reader_highlight_failure_message", comment: "Error message when adding a new bookmark failed"), on: view, duration: 2)
}
}
}
func updateHighlight(_ highlightID: Highlight.Id, withColor color: HighlightColor) {
guard let highlights = highlights else { return }
Task {
try! await highlights.update(highlightID, color: color)
}
}
func deleteHighlight(_ highlightID: Highlight.Id) {
guard let highlights = highlights else { return }
Task {
try! await highlights.remove(highlightID)
}
}
private func addHighlightDecorationsObserverOnce() {
if highlights == nil { return }
if let decorator = navigator as? DecorableNavigator {
decorator.observeDecorationInteractions(inGroup: highlightDecorationGroup) { [weak self] event in
self?.activateDecoration(event)
}
}
}
private func updateHighlightDecorations() {
guard let highlights = highlights else { return }
highlights.all(for: bookId)
.assertNoFailure()
.sink { [weak self] highlights in
if let self = self, let decorator = self.navigator as? DecorableNavigator {
let decorations = highlights.map { Decoration(id: $0.id!.string, locator: $0.locator, style: .highlight(tint: $0.color.uiColor, isActive: false)) }
decorator.apply(decorations: decorations, in: self.highlightDecorationGroup)
}
}
.store(in: &subscriptions)
}
private func activateDecoration(_ event: OnDecorationActivatedEvent) {
guard let highlights = highlights else { return }
let id = event.decoration.highlightID
currentHighlightCancellable = highlights.highlight(for: id).sink { _ in
} receiveValue: { [weak self] highlight in
guard let self = self else { return }
self.activateDecoration(for: highlight, on: event)
}
}
private func activateDecoration(for highlight: Highlight, on event: OnDecorationActivatedEvent) {
if highlightContextMenu != nil {
highlightContextMenu?.removeFromParent()
}
let menuView = HighlightContextMenu(colors: [.red, .green, .blue, .yellow],
systemFontSize: 20)
menuView.selectedColorPublisher.sink { [weak self] color in
self?.currentHighlightCancellable?.cancel()
self?.updateHighlight(event.decoration.highlightID, withColor: color)
self?.highlightContextMenu?.dismiss(animated: true, completion: nil)
}
.store(in: &subscriptions)
menuView.selectedDeletePublisher.sink { [weak self] _ in
self?.currentHighlightCancellable?.cancel()
self?.deleteHighlight(event.decoration.highlightID)
self?.highlightContextMenu?.dismiss(animated: true, completion: nil)
}
.store(in: &subscriptions)
highlightContextMenu = UIHostingController(rootView: menuView)
highlightContextMenu!.preferredContentSize = menuView.preferredSize
highlightContextMenu!.modalPresentationStyle = .popover
if let popoverController = highlightContextMenu!.popoverPresentationController {
popoverController.permittedArrowDirections = .down
popoverController.sourceRect = event.rect ?? .zero
popoverController.sourceView = view
popoverController.backgroundColor = .cyan
popoverController.delegate = self
present(highlightContextMenu!, animated: true, completion: nil)
}
}
}
extension Decoration {
var highlightID: Highlight.Id {
Highlight.Id(string: id)!
}
}
// MARK: - Page list decorations
// This is an example on how to use custom decoration style to display the
// page labels in a `publication.pageList` in the navigator as a side margin
// label.
//
// See http://kb.daisy.org/publishing/docs/navigation/pagelist.html
extension VisualReaderViewController {
/// Will take the `publication.pageList` and create a `Decoration` for each
/// label.
private func updatePageListDecorations() {
guard let navigator = navigator as? DecorableNavigator else {
return
}
let decorations: [Decoration] = publication.pageList.enumerated().compactMap { index, link in
guard let title = link.title,
let locator = self.publication.locate(link)
else {
return nil
}
return Decoration(
id: "page-list-\(index)",
locator: locator,
style: Decoration.Style(
id: .pageList,
config: PageListConfig(label: title)
)
)
}
navigator.apply(decorations: decorations, in: "page-list")
}
}
extension Decoration.Style.Id {
/// Decoration Style for a page number label.
///
/// This is an example of a custom Decoration Style ID declaration.
static let pageList: Decoration.Style.Id = "page_list"
}
struct PageListConfig: Hashable {
/// Page number label, taken from `publication.pageList[].title`.
var label: String
}
extension HTMLDecorationTemplate {
/// Concrete implementation of the `pageList` decoration style for
/// HTML-based navigators, such as the `EPUBNavigatorViewController`.
///
/// It must be added to `EPUBNavigatorViewController.Configuration.decorationTemplates`
/// when creating the navigator.
static var pageList: HTMLDecorationTemplate {
let className = "testapp-page-number"
return HTMLDecorationTemplate(
layout: .bounds,
width: .page,
element: { decoration in
let config = decoration.style.config as? PageListConfig
// Using `var(--RS__backgroundColor)` is a trick to use the
// same background color as the Readium theme. If we don't set
// it directly inline in the HTML, it might be forced
// transparent by Readium CSS.
return """
<div>
<span class="\(className)" style="background-color: var(--RS__backgroundColor) !important">
\(config?.label ?? "")
</span>
</div>
"""
},
stylesheet: """
.\(className) {
float: left;
margin-left: 4px;
padding: 0px 2px 0px 2px;
border: 1px solid;
border-radius: 10%;
box-shadow: rgba(50, 50, 93, 0.25) 0px 2px 5px -1px, rgba(0, 0, 0, 0.3) 0px 1px 3px -1px;
opacity: 0.8;
}
"""
)
}
}