Fixed protection level

git-shawn · git-shawn · commit 45d461f00058 · 2023-05-06T17:53:29.000-05:00
diff --git a/Sources/ScanKit/NSCodeScanner.swift b/Sources/ScanKit/NSCodeScanner.swift
@@ -32,23 +32,23 @@ import OSLog
 
 fileprivate let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "dev.fromshawn.scankit", category: "ScanKit")
 
-struct ScanKitPreview: NSViewControllerRepresentable {
+public struct ScanKitPreview: NSViewControllerRepresentable {
     var camera: ScanKitCamera
     
-    init(camera: ScanKitCamera, startScanningOnLoad: Bool = true) {
+    public init(camera: ScanKitCamera, startScanningOnLoad: Bool = true) {
         self.camera = camera
     }
     
-    func makeNSViewController(context: Context) -> NSCodeScanner {
+    public func makeNSViewController(context: Context) -> NSCodeScanner {
         return NSCodeScanner(camera: camera)
     }
     
-    func updateNSViewController(_ nsViewController: NSCodeScanner, context: Context) {
+    public func updateNSViewController(_ nsViewController: NSCodeScanner, context: Context) {
         // do nothing
     }
 }
 
-class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDelegate {
+public class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDelegate {
     
     weak var camera: ScanKitCamera?
     
@@ -61,12 +61,12 @@ class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDeleg
         fatalError("init(coder:) has not been implemented")
     }
     
-    override func loadView() {
+    public override func loadView() {
         view = NSView(frame: .zero)
         view.layerContentsRedrawPolicy = .crossfade
     }
     
-    override func viewDidLoad() {
+    public override func viewDidLoad() {
         super.viewDidLoad()
         
         addPreviewLayer()
@@ -77,12 +77,12 @@ class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDeleg
         }
     }
     
-    override func viewWillDisappear() {
+    public override func viewWillDisappear() {
         super.viewWillDisappear()
         camera?.stop()
     }
     
-    override func viewWillLayout() {
+    public override func viewWillLayout() {
         super.viewWillLayout()
         self.camera?.previewLayer.frame = self.view.bounds
     }
diff --git a/Sources/ScanKit/ScanKit.swift b/Sources/ScanKit/ScanKit.swift
@@ -32,7 +32,7 @@ import OSLog
 /// A drop-in code symbology scanner.
 public struct ScannerView: View {
     let showViewfinder: Bool
-    let completion: (Result<String, ScanKitCamera.ScanKitError>) -> ()
+    let completion: (Result<String, ScanKitError>) -> ()
     @Binding var scanning: Bool
     @StateObject var camera = ScanKitCamera()
     
@@ -59,10 +59,10 @@ public struct ScannerView: View {
     ///                 When `false` the preview will continue but frames will not be processed for
     ///                 instances of the selected symbology.
     ///   - completion: A completion handler that returns a `Result` of either `String` when information has been found and can be decoded or `ScanKitError` when an error occurs.
-    init(for symbology: VNBarcodeSymbology,
+    public init(for symbology: VNBarcodeSymbology,
          showViewfinder: Bool = true,
          isScanning: Binding<Bool>,
-         completion: @escaping (Result<String, ScanKitCamera.ScanKitError>) -> Void) {
+         completion: @escaping (Result<String, ScanKitError>) -> Void) {
         self.showViewfinder = showViewfinder
         self.completion = completion
         self._scanning = isScanning
@@ -84,7 +84,7 @@ public struct ScannerView: View {
                                         completion(.success(result))
                                     }
                                 } catch let error {
-                                    completion(.failure(error as! ScanKitCamera.ScanKitError))
+                                    completion(.failure(error as! ScanKitError))
                                 }
                             }
                         }
@@ -99,7 +99,7 @@ public struct ScannerView: View {
                                             completion(.success(result))
                                         }
                                     } catch let error {
-                                        completion(.failure(error as! ScanKitCamera.ScanKitError))
+                                        completion(.failure(error as! ScanKitError))
                                     }
                                 }
                             }
@@ -114,7 +114,7 @@ public struct ScannerView: View {
                                             completion(.success(result))
                                         }
                                     } catch let error {
-                                        completion(.failure(error as! ScanKitCamera.ScanKitError))
+                                        completion(.failure(error as! ScanKitError))
                                     }
                                 }
                             }
@@ -207,3 +207,17 @@ public class ScanKit {
         return results
     }
 }
+
+/// Possible ScanKitCamera errors to throw.
+public enum ScanKitError: Error, LocalizedError {
+    case visionFailed, notAuthorized
+    
+    public var errorDescription: String? {
+        switch self {
+        case .visionFailed:
+            return "ScanKit failed to intiailize the scanner."
+        case .notAuthorized:
+            return "ScanKit was unable to access the camera."
+        }
+    }
+}
diff --git a/Sources/ScanKit/ScanKitCamera.swift b/Sources/ScanKit/ScanKitCamera.swift
@@ -31,7 +31,7 @@ import Combine
 
 fileprivate let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "dev.fromshawn.scankit", category: "ScanKitCamera")
 
-class ScanKitCamera: NSObject, ObservableObject, AVCaptureVideoDataOutputSampleBufferDelegate {
+public class ScanKitCamera: NSObject, ObservableObject, AVCaptureVideoDataOutputSampleBufferDelegate {
     private let captureSession = AVCaptureSession()
     private var isCaptureSessionConfigured: Bool = false
     weak private var deviceInput: AVCaptureDeviceInput?
@@ -373,7 +373,7 @@ class ScanKitCamera: NSObject, ObservableObject, AVCaptureVideoDataOutputSampleB
     }
     
     /// A method of `AVCaptureVideoDataOutputSampleBufferDelegate` that, for the purposes of this class, processes `Vision` requests.
-    internal func captureOutput(_ output: AVCaptureOutput, didOutput sampleBuffer: CMSampleBuffer, from connection: AVCaptureConnection) {
+    public func captureOutput(_ output: AVCaptureOutput, didOutput sampleBuffer: CMSampleBuffer, from connection: AVCaptureConnection) {
         // Only process every tenth frame when scanning is true
         visionIterator += 1
         guard (visionIterator % 10 == 0), isScanning else { return }
@@ -437,20 +437,4 @@ class ScanKitCamera: NSObject, ObservableObject, AVCaptureVideoDataOutputSampleB
             }
         }
     }
-    
-    // MARK: - Error Handling
-    
-    /// Possible ScanKitCamera errors to throw.
-    enum ScanKitError: Error, LocalizedError {
-        case visionFailed, notAuthorized
-        
-        var errorDescription: String? {
-            switch self {
-            case .visionFailed:
-                return "ScanKit failed to intiailize the scanner."
-            case .notAuthorized:
-                return "ScanKit was unable to access the camera."
-            }
-        }
-    }
 }
diff --git a/Sources/ScanKit/UICodeScanner.swift b/Sources/ScanKit/UICodeScanner.swift
@@ -34,23 +34,23 @@ fileprivate let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "dev.
 
 //TODO: Decouple model from UIViewController :(
 
-struct ScanKitPreview: UIViewControllerRepresentable {
+public struct ScanKitPreview: UIViewControllerRepresentable {
     var camera: ScanKitCamera
     
-    init(camera: ScanKitCamera) {
+    public init(camera: ScanKitCamera) {
         self.camera = camera
     }
     
-    func makeUIViewController(context: Context) -> UICodeScanner {
+    public func makeUIViewController(context: Context) -> UICodeScanner {
         return UICodeScanner(camera: camera)
     }
     
-    func updateUIViewController(_ uiViewController: UICodeScanner, context: Context) {
+    public func updateUIViewController(_ uiViewController: UICodeScanner, context: Context) {
         // Do nothing!
     }
 }
 
-class UICodeScanner: UIViewController {
+public class UICodeScanner: UIViewController {
     weak var camera: ScanKitCamera?
     
     private var deviceOrientation: UIDeviceOrientation {
@@ -70,7 +70,7 @@ class UICodeScanner: UIViewController {
         fatalError("init(coder:) has not been implemented")
     }
     
-    override func viewDidLoad() {
+    public override func viewDidLoad() {
         super.viewDidLoad()
         addPreviewLayer()
         
@@ -80,12 +80,12 @@ class UICodeScanner: UIViewController {
         }
     }
     
-    override func viewWillDisappear(_ animated: Bool) {
+    public override func viewWillDisappear(_ animated: Bool) {
         super.viewWillDisappear(animated)
         camera?.stop()
     }
     
-    override func viewDidLayoutSubviews() {
+    public override func viewDidLayoutSubviews() {
         super.viewDidLayoutSubviews()
         
         // Update video orientation on rotate

Original file line number	Diff line number	Diff line change
`@@ -32,23 +32,23 @@ import OSLog`
`32`	`32`
`33`	`33`	`fileprivate let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "dev.fromshawn.scankit", category: "ScanKit")`
`34`	`34`
`35`		`-struct ScanKitPreview: NSViewControllerRepresentable {`
	`35`	`+public struct ScanKitPreview: NSViewControllerRepresentable {`
`36`	`36`	`var camera: ScanKitCamera`
`37`	`37`
`38`		`- init(camera: ScanKitCamera, startScanningOnLoad: Bool = true) {`
	`38`	`+ public init(camera: ScanKitCamera, startScanningOnLoad: Bool = true) {`
`39`	`39`	`self.camera = camera`
`40`	`40`	`}`
`41`	`41`
`42`		`- func makeNSViewController(context: Context) -> NSCodeScanner {`
	`42`	`+ public func makeNSViewController(context: Context) -> NSCodeScanner {`
`43`	`43`	`return NSCodeScanner(camera: camera)`
`44`	`44`	`}`
`45`	`45`
`46`		`- func updateNSViewController(_ nsViewController: NSCodeScanner, context: Context) {`
	`46`	`+ public func updateNSViewController(_ nsViewController: NSCodeScanner, context: Context) {`
`47`	`47`	`// do nothing`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
`51`		`-class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDelegate {`
	`51`	`+public class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDelegate {`
`52`	`52`
`53`	`53`	`weak var camera: ScanKitCamera?`
`54`	`54`
`@@ -61,12 +61,12 @@ class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDeleg`
`61`	`61`	`fatalError("init(coder:) has not been implemented")`
`62`	`62`	`}`
`63`	`63`
`64`		`- override func loadView() {`
	`64`	`+ public override func loadView() {`
`65`	`65`	`view = NSView(frame: .zero)`
`66`	`66`	`view.layerContentsRedrawPolicy = .crossfade`
`67`	`67`	`}`
`68`	`68`
`69`		`- override func viewDidLoad() {`
	`69`	`+ public override func viewDidLoad() {`
`70`	`70`	`super.viewDidLoad()`
`71`	`71`
`72`	`72`	`addPreviewLayer()`
`@@ -77,12 +77,12 @@ class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDeleg`
`77`	`77`	`}`
`78`	`78`	`}`
`79`	`79`
`80`		`- override func viewWillDisappear() {`
	`80`	`+ public override func viewWillDisappear() {`
`81`	`81`	`super.viewWillDisappear()`
`82`	`82`	`camera?.stop()`
`83`	`83`	`}`
`84`	`84`
`85`		`- override func viewWillLayout() {`
	`85`	`+ public override func viewWillLayout() {`
`86`	`86`	`super.viewWillLayout()`
`87`	`87`	`self.camera?.previewLayer.frame = self.view.bounds`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ import OSLog`
`32`	`32`	`/// A drop-in code symbology scanner.`
`33`	`33`	`public struct ScannerView: View {`
`34`	`34`	`let showViewfinder: Bool`
`35`		`- let completion: (Result<String, ScanKitCamera.ScanKitError>) -> ()`
	`35`	`+ let completion: (Result<String, ScanKitError>) -> ()`
`36`	`36`	`@Binding var scanning: Bool`
`37`	`37`	`@StateObject var camera = ScanKitCamera()`
`38`	`38`
`@@ -59,10 +59,10 @@ public struct ScannerView: View {`
`59`	`59`	/// When `false` the preview will continue but frames will not be processed for
`60`	`60`	`/// instances of the selected symbology.`
`61`	`61`	/// - completion: A completion handler that returns a `Result` of either `String` when information has been found and can be decoded or `ScanKitError` when an error occurs.
`62`		`- init(for symbology: VNBarcodeSymbology,`
	`62`	`+ public init(for symbology: VNBarcodeSymbology,`
`63`	`63`	`showViewfinder: Bool = true,`
`64`	`64`	`isScanning: Binding<Bool>,`
`65`		`- completion: @escaping (Result<String, ScanKitCamera.ScanKitError>) -> Void) {`
	`65`	`+ completion: @escaping (Result<String, ScanKitError>) -> Void) {`
`66`	`66`	`self.showViewfinder = showViewfinder`
`67`	`67`	`self.completion = completion`
`68`	`68`	`self._scanning = isScanning`
`@@ -84,7 +84,7 @@ public struct ScannerView: View {`
`84`	`84`	`completion(.success(result))`
`85`	`85`	`}`
`86`	`86`	`} catch let error {`
`87`		`- completion(.failure(error as! ScanKitCamera.ScanKitError))`
	`87`	`+ completion(.failure(error as! ScanKitError))`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`	`}`
`@@ -99,7 +99,7 @@ public struct ScannerView: View {`
`99`	`99`	`completion(.success(result))`
`100`	`100`	`}`
`101`	`101`	`} catch let error {`
`102`		`- completion(.failure(error as! ScanKitCamera.ScanKitError))`
	`102`	`+ completion(.failure(error as! ScanKitError))`
`103`	`103`	`}`
`104`	`104`	`}`
`105`	`105`	`}`
`@@ -114,7 +114,7 @@ public struct ScannerView: View {`
`114`	`114`	`completion(.success(result))`
`115`	`115`	`}`
`116`	`116`	`} catch let error {`
`117`		`- completion(.failure(error as! ScanKitCamera.ScanKitError))`
	`117`	`+ completion(.failure(error as! ScanKitError))`
`118`	`118`	`}`
`119`	`119`	`}`
`120`	`120`	`}`
`@@ -207,3 +207,17 @@ public class ScanKit {`
`207`	`207`	`return results`
`208`	`208`	`}`
`209`	`209`	`}`
	`210`	`+`
	`211`	`+/// Possible ScanKitCamera errors to throw.`
	`212`	`+public enum ScanKitError: Error, LocalizedError {`
	`213`	`+ case visionFailed, notAuthorized`
	`214`	`+`
	`215`	`+ public var errorDescription: String? {`
	`216`	`+ switch self {`
	`217`	`+ case .visionFailed:`
	`218`	`+ return "ScanKit failed to intiailize the scanner."`
	`219`	`+ case .notAuthorized:`
	`220`	`+ return "ScanKit was unable to access the camera."`
	`221`	`+ }`
	`222`	`+ }`
	`223`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -34,23 +34,23 @@ fileprivate let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "dev.`
`34`	`34`
`35`	`35`	`//TODO: Decouple model from UIViewController :(`
`36`	`36`
`37`		`-struct ScanKitPreview: UIViewControllerRepresentable {`
	`37`	`+public struct ScanKitPreview: UIViewControllerRepresentable {`
`38`	`38`	`var camera: ScanKitCamera`
`39`	`39`
`40`		`- init(camera: ScanKitCamera) {`
	`40`	`+ public init(camera: ScanKitCamera) {`
`41`	`41`	`self.camera = camera`
`42`	`42`	`}`
`43`	`43`
`44`		`- func makeUIViewController(context: Context) -> UICodeScanner {`
	`44`	`+ public func makeUIViewController(context: Context) -> UICodeScanner {`
`45`	`45`	`return UICodeScanner(camera: camera)`
`46`	`46`	`}`
`47`	`47`
`48`		`- func updateUIViewController(_ uiViewController: UICodeScanner, context: Context) {`
	`48`	`+ public func updateUIViewController(_ uiViewController: UICodeScanner, context: Context) {`
`49`	`49`	`// Do nothing!`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`
`53`		`-class UICodeScanner: UIViewController {`
	`53`	`+public class UICodeScanner: UIViewController {`
`54`	`54`	`weak var camera: ScanKitCamera?`
`55`	`55`
`56`	`56`	`private var deviceOrientation: UIDeviceOrientation {`
`@@ -70,7 +70,7 @@ class UICodeScanner: UIViewController {`
`70`	`70`	`fatalError("init(coder:) has not been implemented")`
`71`	`71`	`}`
`72`	`72`
`73`		`- override func viewDidLoad() {`
	`73`	`+ public override func viewDidLoad() {`
`74`	`74`	`super.viewDidLoad()`
`75`	`75`	`addPreviewLayer()`
`76`	`76`
`@@ -80,12 +80,12 @@ class UICodeScanner: UIViewController {`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`
`83`		`- override func viewWillDisappear(_ animated: Bool) {`
	`83`	`+ public override func viewWillDisappear(_ animated: Bool) {`
`84`	`84`	`super.viewWillDisappear(animated)`
`85`	`85`	`camera?.stop()`
`86`	`86`	`}`
`87`	`87`
`88`		`- override func viewDidLayoutSubviews() {`
	`88`	`+ public override func viewDidLayoutSubviews() {`
`89`	`89`	`super.viewDidLayoutSubviews()`
`90`	`90`
`91`	`91`	`// Update video orientation on rotate`