@imagowave/vision-ocr 0.0.1

package/nitrogen/generated/ios/c++/HybridVisionOCRSpecSwift.hpp

@@ -0,0 +1,108 @@
+///
+/// HybridVisionOCRSpecSwift.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#include "HybridVisionOCRSpec.hpp"
+
+// Forward declaration of `HybridVisionOCRSpec_cxx` to properly resolve imports.
+namespace NitroVisionOcr { class HybridVisionOCRSpec_cxx; }
+
+// Forward declaration of `OcrResult` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrResult; }
+// Forward declaration of `OcrBlock` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrBlock; }
+// Forward declaration of `OcrBox` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrBox; }
+// Forward declaration of `OcrLine` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrLine; }
+// Forward declaration of `OcrWord` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrWord; }
+// Forward declaration of `HybridFrameSpec` to properly resolve imports.
+namespace margelo::nitro::camera { class HybridFrameSpec; }
+// Forward declaration of `OcrOptions` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrOptions; }
+// Forward declaration of `RLevel` to properly resolve imports.
+namespace margelo::nitro::visionocr { enum class RLevel; }
+
+#include "OcrResult.hpp"
+#include <optional>
+#include <string>
+#include "OcrBlock.hpp"
+#include <vector>
+#include "OcrBox.hpp"
+#include "OcrLine.hpp"
+#include "OcrWord.hpp"
+#include <memory>
+#include <VisionCamera/HybridFrameSpec.hpp>
+#include "OcrOptions.hpp"
+#include "RLevel.hpp"
+
+#include "NitroVisionOcr-Swift-Cxx-Umbrella.hpp"
+
+namespace margelo::nitro::visionocr {
+
+  /**
+   * The C++ part of HybridVisionOCRSpec_cxx.swift.
+   *
+   * HybridVisionOCRSpecSwift (C++) accesses HybridVisionOCRSpec_cxx (Swift), and might
+   * contain some additional bridging code for C++ <> Swift interop.
+   *
+   * Since this obviously introduces an overhead, I hope at some point in
+   * the future, HybridVisionOCRSpec_cxx can directly inherit from the C++ class HybridVisionOCRSpec
+   * to simplify the whole structure and memory management.
+   */
+  class HybridVisionOCRSpecSwift: public virtual HybridVisionOCRSpec {
+  public:
+    // Constructor from a Swift instance
+    explicit HybridVisionOCRSpecSwift(const NitroVisionOcr::HybridVisionOCRSpec_cxx& swiftPart):
+      HybridObject(HybridVisionOCRSpec::TAG),
+      _swiftPart(swiftPart) { }
+
+  public:
+    // Get the Swift part
+    inline NitroVisionOcr::HybridVisionOCRSpec_cxx& getSwiftPart() noexcept {
+      return _swiftPart;
+    }
+
+  public:
+    inline size_t getExternalMemorySize() noexcept override {
+      return _swiftPart.getMemorySize();
+    }
+    bool equals(const std::shared_ptr<HybridObject>& other) override {
+      if (auto otherCast = std::dynamic_pointer_cast<HybridVisionOCRSpecSwift>(other)) {
+        return _swiftPart.equals(otherCast->_swiftPart);
+      }
+      return false;
+    }
+    void dispose() noexcept override {
+      _swiftPart.dispose();
+    }
+    std::string toString() override {
+      return _swiftPart.toString();
+    }
+
+  public:
+    // Properties
+    
+
+  public:
+    // Methods
+    inline std::optional<OcrResult> call(const std::shared_ptr<margelo::nitro::camera::HybridFrameSpec>& frame, const std::optional<OcrOptions>& options) override {
+      auto __result = _swiftPart.call(frame, options);
+      if (__result.hasError()) [[unlikely]] {
+        std::rethrow_exception(__result.error());
+      }
+      auto __value = std::move(__result.value());
+      return __value;
+    }
+
+  private:
+    NitroVisionOcr::HybridVisionOCRSpec_cxx _swiftPart;
+  };
+
+} // namespace margelo::nitro::visionocr

package/nitrogen/generated/ios/swift/HybridVisionOCRSpec.swift

@@ -0,0 +1,56 @@
+///
+/// HybridVisionOCRSpec.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import VisionCamera
+import NitroModules
+
+/// See ``HybridVisionOCRSpec``
+public protocol HybridVisionOCRSpec_protocol: HybridObject {
+  // Properties
+  
+
+  // Methods
+  func call(frame: (any HybridFrameSpec), options: OcrOptions?) throws -> OcrResult?
+}
+
+public extension HybridVisionOCRSpec_protocol {
+  /// Default implementation of ``HybridObject.toString``
+  func toString() -> String {
+    return "[HybridObject VisionOCR]"
+  }
+}
+
+/// See ``HybridVisionOCRSpec``
+open class HybridVisionOCRSpec_base {
+  private weak var cxxWrapper: HybridVisionOCRSpec_cxx? = nil
+  public init() { }
+  public func getCxxWrapper() -> HybridVisionOCRSpec_cxx {
+  #if DEBUG
+    guard self is any HybridVisionOCRSpec else {
+      fatalError("`self` is not a `HybridVisionOCRSpec`! Did you accidentally inherit from `HybridVisionOCRSpec_base` instead of `HybridVisionOCRSpec`?")
+    }
+  #endif
+    if let cxxWrapper = self.cxxWrapper {
+      return cxxWrapper
+    } else {
+      let cxxWrapper = HybridVisionOCRSpec_cxx(self as! any HybridVisionOCRSpec)
+      self.cxxWrapper = cxxWrapper
+      return cxxWrapper
+    }
+  }
+}
+
+/**
+ * A Swift base-protocol representing the VisionOCR HybridObject.
+ * Implement this protocol to create Swift-based instances of VisionOCR.
+ * ```swift
+ * class HybridVisionOCR : HybridVisionOCRSpec {
+ *   // ...
+ * }
+ * ```
+ */
+public typealias HybridVisionOCRSpec = HybridVisionOCRSpec_protocol & HybridVisionOCRSpec_base

package/nitrogen/generated/ios/swift/HybridVisionOCRSpec_cxx.swift

@@ -0,0 +1,149 @@
+///
+/// HybridVisionOCRSpec_cxx.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+import VisionCamera
+
+/**
+ * A class implementation that bridges HybridVisionOCRSpec over to C++.
+ * In C++, we cannot use Swift protocols - so we need to wrap it in a class to make it strongly defined.
+ *
+ * Also, some Swift types need to be bridged with special handling:
+ * - Enums need to be wrapped in Structs, otherwise they cannot be accessed bi-directionally (Swift bug: https://github.com/swiftlang/swift/issues/75330)
+ * - Other HybridObjects need to be wrapped/unwrapped from the Swift TCxx wrapper
+ * - Throwing methods need to be wrapped with a Result<T, Error> type, as exceptions cannot be propagated to C++
+ */
+open class HybridVisionOCRSpec_cxx {
+  /**
+   * The Swift <> C++ bridge's namespace (`margelo::nitro::visionocr::bridge::swift`)
+   * from `NitroVisionOcr-Swift-Cxx-Bridge.hpp`.
+   * This contains specialized C++ templates, and C++ helper functions that can be accessed from Swift.
+   */
+  public typealias bridge = margelo.nitro.visionocr.bridge.swift
+
+  /**
+   * Holds an instance of the `HybridVisionOCRSpec` Swift protocol.
+   */
+  private var __implementation: any HybridVisionOCRSpec
+
+  /**
+   * Holds a weak pointer to the C++ class that wraps the Swift class.
+   */
+  private var __cxxPart: bridge.std__weak_ptr_HybridVisionOCRSpec_
+
+  /**
+   * Create a new `HybridVisionOCRSpec_cxx` that wraps the given `HybridVisionOCRSpec`.
+   * All properties and methods bridge to C++ types.
+   */
+  public init(_ implementation: any HybridVisionOCRSpec) {
+    self.__implementation = implementation
+    self.__cxxPart = .init()
+    /* no base class */
+  }
+
+  /**
+   * Get the actual `HybridVisionOCRSpec` instance this class wraps.
+   */
+  @inline(__always)
+  public func getHybridVisionOCRSpec() -> any HybridVisionOCRSpec {
+    return __implementation
+  }
+
+  /**
+   * Casts this instance to a retained unsafe raw pointer.
+   * This acquires one additional strong reference on the object!
+   */
+  public func toUnsafe() -> UnsafeMutableRawPointer {
+    return Unmanaged.passRetained(self).toOpaque()
+  }
+
+  /**
+   * Casts an unsafe pointer to a `HybridVisionOCRSpec_cxx`.
+   * The pointer has to be a retained opaque `Unmanaged<HybridVisionOCRSpec_cxx>`.
+   * This removes one strong reference from the object!
+   */
+  public class func fromUnsafe(_ pointer: UnsafeMutableRawPointer) -> HybridVisionOCRSpec_cxx {
+    return Unmanaged<HybridVisionOCRSpec_cxx>.fromOpaque(pointer).takeRetainedValue()
+  }
+
+  /**
+   * Gets (or creates) the C++ part of this Hybrid Object.
+   * The C++ part is a `std::shared_ptr<HybridVisionOCRSpec>`.
+   */
+  public func getCxxPart() -> bridge.std__shared_ptr_HybridVisionOCRSpec_ {
+    let cachedCxxPart = self.__cxxPart.lock()
+    if Bool(fromCxx: cachedCxxPart) {
+      return cachedCxxPart
+    } else {
+      let newCxxPart = bridge.create_std__shared_ptr_HybridVisionOCRSpec_(self.toUnsafe())
+      __cxxPart = bridge.weakify_std__shared_ptr_HybridVisionOCRSpec_(newCxxPart)
+      return newCxxPart
+    }
+  }
+
+  
+
+  /**
+   * Get the memory size of the Swift class (plus size of any other allocations)
+   * so the JS VM can properly track it and garbage-collect the JS object if needed.
+   */
+  @inline(__always)
+  public var memorySize: Int {
+    return MemoryHelper.getSizeOf(self.__implementation) + self.__implementation.memorySize
+  }
+
+  /**
+   * Compares this object with the given [other] object for reference equality.
+   */
+  @inline(__always)
+  public func equals(other: HybridVisionOCRSpec_cxx) -> Bool {
+    return self.__implementation === other.__implementation
+  }
+
+  /**
+   * Call dispose() on the Swift class.
+   * This _may_ be called manually from JS.
+   */
+  @inline(__always)
+  public func dispose() {
+    self.__implementation.dispose()
+  }
+
+  /**
+   * Call toString() on the Swift class.
+   */
+  @inline(__always)
+  public func toString() -> String {
+    return self.__implementation.toString()
+  }
+
+  // Properties
+  
+
+  // Methods
+  @inline(__always)
+  public final func call(frame: bridge.std__shared_ptr_margelo__nitro__camera__HybridFrameSpec_, options: bridge.std__optional_OcrOptions_) -> bridge.Result_std__optional_OcrResult__ {
+    do {
+      let __result = try self.__implementation.call(frame: { () -> any HybridFrameSpec in
+        let __unsafePointer = bridge.get_std__shared_ptr_margelo__nitro__camera__HybridFrameSpec_(frame)
+        let __instance = HybridFrameSpec_cxx.fromUnsafe(__unsafePointer)
+        return __instance.getHybridFrameSpec()
+      }(), options: options.value)
+      let __resultCpp = { () -> bridge.std__optional_OcrResult_ in
+        if let __unwrappedValue = __result {
+          return bridge.create_std__optional_OcrResult_(__unwrappedValue)
+        } else {
+          return .init()
+        }
+      }()
+      return bridge.create_Result_std__optional_OcrResult__(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__optional_OcrResult__(__exceptionPtr)
+    }
+  }
+}

package/nitrogen/generated/ios/swift/OcrBlock.swift

@@ -0,0 +1,64 @@
+///
+/// OcrBlock.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Represents an instance of `OcrBlock`, backed by a C++ struct.
+ */
+public typealias OcrBlock = margelo.nitro.visionocr.OcrBlock
+
+public extension OcrBlock {
+  private typealias bridge = margelo.nitro.visionocr.bridge.swift
+
+  /**
+   * Create a new instance of `OcrBlock`.
+   */
+  init(text: String, box: OcrBox?, lines: [OcrLine]?) {
+    self.init(std.string(text), { () -> bridge.std__optional_OcrBox_ in
+      if let __unwrappedValue = box {
+        return bridge.create_std__optional_OcrBox_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }(), { () -> bridge.std__optional_std__vector_OcrLine__ in
+      if let __unwrappedValue = lines {
+        return bridge.create_std__optional_std__vector_OcrLine__({ () -> bridge.std__vector_OcrLine_ in
+          var __vector = bridge.create_std__vector_OcrLine_(__unwrappedValue.count)
+          for __item in __unwrappedValue {
+            __vector.push_back(__item)
+          }
+          return __vector
+        }())
+      } else {
+        return .init()
+      }
+    }())
+  }
+
+  @inline(__always)
+  var text: String {
+    return String(self.__text)
+  }
+  
+  @inline(__always)
+  var box: OcrBox? {
+    return self.__box.value
+  }
+  
+  @inline(__always)
+  var lines: [OcrLine]? {
+    return { () -> [OcrLine]? in
+      if bridge.has_value_std__optional_std__vector_OcrLine__(self.__lines) {
+        let __unwrapped = bridge.get_std__optional_std__vector_OcrLine__(self.__lines)
+        return __unwrapped.map({ __item in __item })
+      } else {
+        return nil
+      }
+    }()
+  }
+}

package/nitrogen/generated/ios/swift/OcrBox.swift

@@ -0,0 +1,44 @@
+///
+/// OcrBox.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Represents an instance of `OcrBox`, backed by a C++ struct.
+ */
+public typealias OcrBox = margelo.nitro.visionocr.OcrBox
+
+public extension OcrBox {
+  private typealias bridge = margelo.nitro.visionocr.bridge.swift
+
+  /**
+   * Create a new instance of `OcrBox`.
+   */
+  init(x: Double, y: Double, width: Double, height: Double) {
+    self.init(x, y, width, height)
+  }
+
+  @inline(__always)
+  var x: Double {
+    return self.__x
+  }
+  
+  @inline(__always)
+  var y: Double {
+    return self.__y
+  }
+  
+  @inline(__always)
+  var width: Double {
+    return self.__width
+  }
+  
+  @inline(__always)
+  var height: Double {
+    return self.__height
+  }
+}

package/nitrogen/generated/ios/swift/OcrLine.swift

@@ -0,0 +1,82 @@
+///
+/// OcrLine.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Represents an instance of `OcrLine`, backed by a C++ struct.
+ */
+public typealias OcrLine = margelo.nitro.visionocr.OcrLine
+
+public extension OcrLine {
+  private typealias bridge = margelo.nitro.visionocr.bridge.swift
+
+  /**
+   * Create a new instance of `OcrLine`.
+   */
+  init(text: String, box: OcrBox?, words: [OcrWord]?, confidence: Double?) {
+    self.init(std.string(text), { () -> bridge.std__optional_OcrBox_ in
+      if let __unwrappedValue = box {
+        return bridge.create_std__optional_OcrBox_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }(), { () -> bridge.std__optional_std__vector_OcrWord__ in
+      if let __unwrappedValue = words {
+        return bridge.create_std__optional_std__vector_OcrWord__({ () -> bridge.std__vector_OcrWord_ in
+          var __vector = bridge.create_std__vector_OcrWord_(__unwrappedValue.count)
+          for __item in __unwrappedValue {
+            __vector.push_back(__item)
+          }
+          return __vector
+        }())
+      } else {
+        return .init()
+      }
+    }(), { () -> bridge.std__optional_double_ in
+      if let __unwrappedValue = confidence {
+        return bridge.create_std__optional_double_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }())
+  }
+
+  @inline(__always)
+  var text: String {
+    return String(self.__text)
+  }
+  
+  @inline(__always)
+  var box: OcrBox? {
+    return self.__box.value
+  }
+  
+  @inline(__always)
+  var words: [OcrWord]? {
+    return { () -> [OcrWord]? in
+      if bridge.has_value_std__optional_std__vector_OcrWord__(self.__words) {
+        let __unwrapped = bridge.get_std__optional_std__vector_OcrWord__(self.__words)
+        return __unwrapped.map({ __item in __item })
+      } else {
+        return nil
+      }
+    }()
+  }
+  
+  @inline(__always)
+  var confidence: Double? {
+    return { () -> Double? in
+      if bridge.has_value_std__optional_double_(self.__confidence) {
+        let __unwrapped = bridge.get_std__optional_double_(self.__confidence)
+        return __unwrapped
+      } else {
+        return nil
+      }
+    }()
+  }
+}

package/nitrogen/generated/ios/swift/OcrOptions.swift

@@ -0,0 +1,113 @@
+///
+/// OcrOptions.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Represents an instance of `OcrOptions`, backed by a C++ struct.
+ */
+public typealias OcrOptions = margelo.nitro.visionocr.OcrOptions
+
+public extension OcrOptions {
+  private typealias bridge = margelo.nitro.visionocr.bridge.swift
+
+  /**
+   * Create a new instance of `OcrOptions`.
+   */
+  init(includeBoxes: Bool?, includeConfidence: Bool?, recognitionLevel: RLevel?, recognitionLanguages: [String]?, usesLanguageCorrection: Bool?) {
+    self.init({ () -> bridge.std__optional_bool_ in
+      if let __unwrappedValue = includeBoxes {
+        return bridge.create_std__optional_bool_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }(), { () -> bridge.std__optional_bool_ in
+      if let __unwrappedValue = includeConfidence {
+        return bridge.create_std__optional_bool_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }(), { () -> bridge.std__optional_RLevel_ in
+      if let __unwrappedValue = recognitionLevel {
+        return bridge.create_std__optional_RLevel_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }(), { () -> bridge.std__optional_std__vector_std__string__ in
+      if let __unwrappedValue = recognitionLanguages {
+        return bridge.create_std__optional_std__vector_std__string__({ () -> bridge.std__vector_std__string_ in
+          var __vector = bridge.create_std__vector_std__string_(__unwrappedValue.count)
+          for __item in __unwrappedValue {
+            __vector.push_back(std.string(__item))
+          }
+          return __vector
+        }())
+      } else {
+        return .init()
+      }
+    }(), { () -> bridge.std__optional_bool_ in
+      if let __unwrappedValue = usesLanguageCorrection {
+        return bridge.create_std__optional_bool_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }())
+  }
+
+  @inline(__always)
+  var includeBoxes: Bool? {
+    return { () -> Bool? in
+      if bridge.has_value_std__optional_bool_(self.__includeBoxes) {
+        let __unwrapped = bridge.get_std__optional_bool_(self.__includeBoxes)
+        return __unwrapped
+      } else {
+        return nil
+      }
+    }()
+  }
+  
+  @inline(__always)
+  var includeConfidence: Bool? {
+    return { () -> Bool? in
+      if bridge.has_value_std__optional_bool_(self.__includeConfidence) {
+        let __unwrapped = bridge.get_std__optional_bool_(self.__includeConfidence)
+        return __unwrapped
+      } else {
+        return nil
+      }
+    }()
+  }
+  
+  @inline(__always)
+  var recognitionLevel: RLevel? {
+    return self.__recognitionLevel.value
+  }
+  
+  @inline(__always)
+  var recognitionLanguages: [String]? {
+    return { () -> [String]? in
+      if bridge.has_value_std__optional_std__vector_std__string__(self.__recognitionLanguages) {
+        let __unwrapped = bridge.get_std__optional_std__vector_std__string__(self.__recognitionLanguages)
+        return __unwrapped.map({ __item in String(__item) })
+      } else {
+        return nil
+      }
+    }()
+  }
+  
+  @inline(__always)
+  var usesLanguageCorrection: Bool? {
+    return { () -> Bool? in
+      if bridge.has_value_std__optional_bool_(self.__usesLanguageCorrection) {
+        let __unwrapped = bridge.get_std__optional_bool_(self.__usesLanguageCorrection)
+        return __unwrapped
+      } else {
+        return nil
+      }
+    }()
+  }
+}

package/nitrogen/generated/ios/swift/OcrResult.swift

@@ -0,0 +1,53 @@
+///
+/// OcrResult.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Represents an instance of `OcrResult`, backed by a C++ struct.
+ */
+public typealias OcrResult = margelo.nitro.visionocr.OcrResult
+
+public extension OcrResult {
+  private typealias bridge = margelo.nitro.visionocr.bridge.swift
+
+  /**
+   * Create a new instance of `OcrResult`.
+   */
+  init(text: String, blocks: [OcrBlock]?) {
+    self.init(std.string(text), { () -> bridge.std__optional_std__vector_OcrBlock__ in
+      if let __unwrappedValue = blocks {
+        return bridge.create_std__optional_std__vector_OcrBlock__({ () -> bridge.std__vector_OcrBlock_ in
+          var __vector = bridge.create_std__vector_OcrBlock_(__unwrappedValue.count)
+          for __item in __unwrappedValue {
+            __vector.push_back(__item)
+          }
+          return __vector
+        }())
+      } else {
+        return .init()
+      }
+    }())
+  }
+
+  @inline(__always)
+  var text: String {
+    return String(self.__text)
+  }
+  
+  @inline(__always)
+  var blocks: [OcrBlock]? {
+    return { () -> [OcrBlock]? in
+      if bridge.has_value_std__optional_std__vector_OcrBlock__(self.__blocks) {
+        let __unwrapped = bridge.get_std__optional_std__vector_OcrBlock__(self.__blocks)
+        return __unwrapped.map({ __item in __item })
+      } else {
+        return nil
+      }
+    }()
+  }
+}