PDF saving, printing #2247
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // | ||
| // WKPDFHUDViewWrapper.swift | ||
| // | ||
| // Copyright © 2024 DuckDuckGo. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| import Foundation | ||
| import WebKit | ||
|
|
||
| /// A wrapper for the PDF HUD window with Zoom controls, Download and Open in Preview buttons | ||
| /// Used to trigger Save PDF | ||
| struct WKPDFHUDViewWrapper { | ||
|
|
||
| static let WKPDFHUDViewClass: AnyClass? = NSClassFromString("WKPDFHUDView") | ||
| static let performActionForControlSelector = NSSelectorFromString("_performActionForControl:") | ||
| static let visibleKey = "_visible" | ||
| static let setVisibleSelector = NSSelectorFromString("_setVisible:") | ||
| static let savePDFControlId = "arrow.down.circle" | ||
|
|
||
| private let hudView: NSView | ||
|
|
||
| var isVisible: Bool { | ||
| get { | ||
| hudView.layer?.sublayers?.first?.opacity ?? 0 > 0 | ||
| } | ||
| nonmutating set { | ||
| guard hudView.responds(to: Self.setVisibleSelector) else { return } | ||
| hudView.perform(Self.setVisibleSelector, with: newValue) | ||
| } | ||
| } | ||
|
|
||
| /// Create a wrapper over the PDF HUD view validating its class is `WKPDFHUDView` | ||
| /// - parameter view: the WKPDFHUDView to wrap | ||
| /// - returns nil if the view | ||
| init?(view: NSView) { | ||
|
There was a problem hiding this comment. Suggestion: Would be good to add some markdown documentation for the two |
||
| guard type(of: view) == Self.WKPDFHUDViewClass else { return nil } | ||
|
|
||
| guard Self.WKPDFHUDViewClass?.instancesRespond(to: Self.performActionForControlSelector) == true else { | ||
| assertionFailure("WKPDFHUDView doesn‘t respond to _performActionForControl:") | ||
| return nil | ||
| } | ||
| self.hudView = view | ||
| } | ||
|
|
||
| /// Find WebView‘s PDF HUD view at a clicked point | ||
| /// | ||
| /// Used to get PDF controls view of a clicked WebView frame for `Print…` and `Save As…` PDF context menu commands | ||
| static func getPdfHudView(in webView: WKWebView, at location: NSPoint? = nil) -> Self? { | ||
| guard let hudView = webView.subviews.last(where: { type(of: $0) == Self.WKPDFHUDViewClass && $0.frame.contains(location ?? $0.frame.origin) }) else { | ||
| #if DEBUG | ||
| Task { | ||
| if await webView.mimeType == "application/pdf" { | ||
| assertionFailure("WebView doesn‘t have PDF HUD View") | ||
| } | ||
| } | ||
| #endif | ||
| return nil | ||
| } | ||
| return self.init(view: hudView) | ||
| } | ||
|
|
||
| func savePDF() { | ||
|
There was a problem hiding this comment. Is it possible to test this behaviour? |
||
| let wasVisible = isVisible | ||
| self.setIsVisibleIVar(true) | ||
| defer { | ||
| if !wasVisible { | ||
| self.setIsVisibleIVar(false) | ||
| } | ||
| } | ||
| hudView.perform(Self.performActionForControlSelector, with: Self.savePDFControlId) | ||
| } | ||
|
|
||
| // try to set _visible ivar value directly to avoid actually showing the HUD | ||
| private func setIsVisibleIVar(_ value: Bool) { | ||
| do { | ||
| try NSException.catch { | ||
| hudView.setValue(value, forKey: Self.visibleKey) | ||
| } | ||
| } catch { | ||
| assertionFailure("\(error)") | ||
| self.isVisible = value | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: can probably make these static let private as they don’t have to be accessed by/known to the outside
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
used in availability tests