pdfkit-rs 0.2.4

Safe Rust bindings for Apple's PDFKit framework — documents, pages, selections, outlines, annotations, destinations, actions, and view state on macOS
Documentation 
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

import AppKit
import Foundation
import PDFKit

public typealias PDFRustViewDelegateLinkClickCallback = @convention(c) (
    UnsafeMutableRawPointer?,
    UnsafeMutableRawPointer?,
    UnsafePointer<CChar>?
) -> Int32
public typealias PDFRustViewDelegateScaleFactorCallback = @convention(c) (
    UnsafeMutableRawPointer?,
    UnsafeMutableRawPointer?,
    Double
) -> Double
public typealias PDFRustViewDelegatePrintJobTitleCallback = @convention(c) (
    UnsafeMutableRawPointer?,
    UnsafeMutableRawPointer?
) -> UnsafeMutablePointer<CChar>?
public typealias PDFRustViewDelegateBoolCallback = @convention(c) (
    UnsafeMutableRawPointer?,
    UnsafeMutableRawPointer?
) -> Int32
public typealias PDFRustViewDelegateRemoteGoToCallback = @convention(c) (
    UnsafeMutableRawPointer?,
    UnsafeMutableRawPointer?,
    UnsafeMutableRawPointer?
) -> Int32

final class PDFRustViewDelegate: NSObject, PDFViewDelegate {

    let context: UnsafeMutableRawPointer?
    let linkClickCallback: PDFRustViewDelegateLinkClickCallback?
    let scaleFactorCallback: PDFRustViewDelegateScaleFactorCallback?
    let printJobTitleCallback: PDFRustViewDelegatePrintJobTitleCallback?
    let performPrintCallback: PDFRustViewDelegateBoolCallback?
    let performFindCallback: PDFRustViewDelegateBoolCallback?
    let performGoToPageCallback: PDFRustViewDelegateBoolCallback?
    let remoteGoToCallback: PDFRustViewDelegateRemoteGoToCallback?

    init(
        context: UnsafeMutableRawPointer?,
        linkClickCallback: PDFRustViewDelegateLinkClickCallback?,
        scaleFactorCallback: PDFRustViewDelegateScaleFactorCallback?,
        printJobTitleCallback: PDFRustViewDelegatePrintJobTitleCallback?,
        performPrintCallback: PDFRustViewDelegateBoolCallback?,
        performFindCallback: PDFRustViewDelegateBoolCallback?,
        performGoToPageCallback: PDFRustViewDelegateBoolCallback?,
        remoteGoToCallback: PDFRustViewDelegateRemoteGoToCallback?
    ) {
        self.context = context
        self.linkClickCallback = linkClickCallback
        self.scaleFactorCallback = scaleFactorCallback
        self.printJobTitleCallback = printJobTitleCallback
        self.performPrintCallback = performPrintCallback
        self.performFindCallback = performFindCallback
        self.performGoToPageCallback = performGoToPageCallback
        self.remoteGoToCallback = remoteGoToCallback
    }

    private func defaultPrintJobTitle(for view: PDFView) -> String {
        if let title = view.document?.documentAttributes?["Title"] as? String, !title.isEmpty {
            return title
        }
        if let lastPathComponent = view.document?.documentURL?.lastPathComponent, !lastPathComponent.isEmpty {
            return lastPathComponent
        }
        return "PDF Document"
    }

    func pdfViewWillClick(onLink sender: PDFView, with url: URL) {
        let handled = url.absoluteString.withCString { rawURL in
            (linkClickCallback?(context, pdf_retain_view(sender), rawURL) ?? 0) != 0
        }
        if !handled {
            NSWorkspace.shared.open(url)
        }
    }

    func pdfViewWillChangeScaleFactor(_ sender: PDFView, toScale scaler: CGFloat) -> CGFloat {
        let requestedScale = Double(scaler)
        let resolvedScale = scaleFactorCallback?(context, pdf_retain_view(sender), requestedScale)
            ?? requestedScale.clamped(to: 0.1...10.0)
        return CGFloat(resolvedScale)
    }

    func pdfViewPrintJobTitle(_ sender: PDFView) -> String {
        if let callback = printJobTitleCallback,
           let title = pdf_take_string(callback(context, pdf_retain_view(sender))),
           !title.isEmpty {
            return title
        }
        return defaultPrintJobTitle(for: sender)
    }

    func pdfViewPerformPrint(_ sender: PDFView) {
        _ = performPrintCallback?(context, pdf_retain_view(sender))
    }

    func pdfViewPerformFind(_ sender: PDFView) {
        _ = performFindCallback?(context, pdf_retain_view(sender))
    }

    func pdfViewPerformGo(toPage sender: PDFView) {
        _ = performGoToPageCallback?(context, pdf_retain_view(sender))
    }

    func pdfViewOpenPDF(_ sender: PDFView, forRemoteGoToAction action: PDFActionRemoteGoTo) {
        _ = remoteGoToCallback?(context, pdf_retain_view(sender), pdf_retain_action_remote_goto(action))
    }
}

private extension Double {
    func clamped(to range: ClosedRange<Double>) -> Double {
        min(max(self, range.lowerBound), range.upperBound)
    }
}

@_cdecl("pdf_view_delegate_new")
public func pdf_view_delegate_new(
    _ context: UnsafeMutableRawPointer?,
    _ linkClickCallback: PDFRustViewDelegateLinkClickCallback?,
    _ scaleFactorCallback: PDFRustViewDelegateScaleFactorCallback?,
    _ printJobTitleCallback: PDFRustViewDelegatePrintJobTitleCallback?,
    _ performPrintCallback: PDFRustViewDelegateBoolCallback?,
    _ performFindCallback: PDFRustViewDelegateBoolCallback?,
    _ performGoToPageCallback: PDFRustViewDelegateBoolCallback?,
    _ remoteGoToCallback: PDFRustViewDelegateRemoteGoToCallback?,
    _ outDelegate: UnsafeMutablePointer<UnsafeMutableRawPointer?>?,
    _ outError: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    pdf_run(outError) {
        guard let outDelegate else {
            throw PDFBridgeError.invalidArgument("missing view delegate output pointer")
        }
        let delegate = PDFRustViewDelegate(
            context: context,
            linkClickCallback: linkClickCallback,
            scaleFactorCallback: scaleFactorCallback,
            printJobTitleCallback: printJobTitleCallback,
            performPrintCallback: performPrintCallback,
            performFindCallback: performFindCallback,
            performGoToPageCallback: performGoToPageCallback,
            remoteGoToCallback: remoteGoToCallback
        )
        outDelegate.pointee = pdf_retain_view_delegate(delegate)
    }
}