First (incomplete) version of the new (lispkit pdf) library.

Author: objecthub

File.txt

@@ -0,0 +1,4 @@
+static let burnInAnnotationsOption: PDFDocumentWriteOption
+static let optimizeImagesForScreenOption: PDFDocumentWriteOption
+static let saveImagesAsJPEGOption: PDFDocumentWriteOption
+static let saveTextFromOCROption: PDFDocumentWriteOption

LispKit.xcodeproj/project.pbxproj

@@ -1344,6 +1344,8 @@
 		CCF602ED23A0FA9A00087740 /* pack.sld in Copy pre-installed LispKit library: SRFI 167 */ = {isa = PBXBuildFile; fileRef = CCF602E723A0F6B900087740 /* pack.sld */; };
 		CCF602EE23A0FA9A00087740 /* memory.sld in Copy pre-installed LispKit library: SRFI 167 */ = {isa = PBXBuildFile; fileRef = CCF602E823A0F6CB00087740 /* memory.sld */; };
 		CCF6C4172442F62800EB37AC /* VectorLibrary.swift in Sources */ = {isa = PBXBuildFile; fileRef = CC6A3B5D1C52E8EF00E962E2 /* VectorLibrary.swift */; };
+		CCF964052D00D66000F85FBA /* PDFLibrary.swift in Sources */ = {isa = PBXBuildFile; fileRef = CCF964042D00D65900F85FBA /* PDFLibrary.swift */; };
+		CCF964062D00D66000F85FBA /* PDFLibrary.swift in Sources */ = {isa = PBXBuildFile; fileRef = CCF964042D00D65900F85FBA /* PDFLibrary.swift */; };
 		CCF982F71D998B8A00B22A1D /* ImportSet.swift in Sources */ = {isa = PBXBuildFile; fileRef = CCF982F61D998B8A00B22A1D /* ImportSet.swift */; };
 		CCFB412725B2523C005B2429 /* ZIPFoundation in Frameworks */ = {isa = PBXBuildFile; productRef = CCFB412625B2523C005B2429 /* ZIPFoundation */; };
 		CCFB412B25B25316005B2429 /* ZipArchiveLibrary.swift in Sources */ = {isa = PBXBuildFile; fileRef = CCFB412A25B25316005B2429 /* ZipArchiveLibrary.swift */; };
@@ -3759,6 +3761,7 @@
 		CCF602E723A0F6B900087740 /* pack.sld */ = {isa = PBXFileReference; lastKnownFileType = text; path = pack.sld; sourceTree = "<group>"; };
 		CCF602E823A0F6CB00087740 /* memory.sld */ = {isa = PBXFileReference; lastKnownFileType = text; path = memory.sld; sourceTree = "<group>"; };
 		CCF602E923A0F8F800087740 /* SRFI-167.scm */ = {isa = PBXFileReference; lastKnownFileType = text; path = "SRFI-167.scm"; sourceTree = "<group>"; };
+		CCF964042D00D65900F85FBA /* PDFLibrary.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PDFLibrary.swift; sourceTree = "<group>"; };
 		CCF982F61D998B8A00B22A1D /* ImportSet.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ImportSet.swift; sourceTree = "<group>"; };
 		CCFB412A25B25316005B2429 /* ZipArchiveLibrary.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ZipArchiveLibrary.swift; sourceTree = "<group>"; };
 		CCFBE5C31ECBA8DA0032254B /* Pi.scm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = Pi.scm; sourceTree = "<group>"; };
@@ -4775,6 +4778,7 @@
 				CCD5B6152C3BC480002BF2F0 /* HTTPOAuthLibrary.swift */,
 				CC1D533C2BF1709E00EE1A24 /* JSONLibrary.swift */,
 				CCD5B5202C0D231E002BF2F0 /* JSONSchemaLibrary.swift */,
+				CCF964042D00D65900F85FBA /* PDFLibrary.swift */,
 				CC17F7472C7DB91000DDC4F9 /* KeychainLibrary.swift */,
 				CC894F1F2CC3022800896B1D /* PasteboardLibrary.swift */,
 				CC894F222CC3B08100896B1D /* PasteboardLibrary_iOS.swift */,
@@ -5542,6 +5546,7 @@
 				CCC0724A1F9C11FA0063974E /* Sysctl.swift in Sources */,
 				CC882C921C9E93A600D20039 /* Timer.swift in Sources */,
 				CCAD52E21C48468F00DBD8EE /* Expr.swift in Sources */,
+				CCF964062D00D66000F85FBA /* PDFLibrary.swift in Sources */,
 				CC76312720E95262005F27CE /* DrawingDocument.swift in Sources */,
 				CCFB412B25B25316005B2429 /* ZipArchiveLibrary.swift in Sources */,
 				CC35FD0D1C6FA4B700C8B992 /* VirtualMachine.swift in Sources */,
@@ -5716,6 +5721,7 @@
 				CCC48CA025E5B96800D082AD /* CaptureGroup.swift in Sources */,
 				CC372CD327D367CC0091C474 /* BitsetLibrary.swift in Sources */,
 				CCC48CD325E5B98600D082AD /* ListLibrary.swift in Sources */,
+				CCF964052D00D66000F85FBA /* PDFLibrary.swift in Sources */,
 				CCC48CB125E5B97100D082AD /* Library.swift in Sources */,
 				CCC48CD225E5B98600D082AD /* CharSetLibrary.swift in Sources */,
 				CCC48CCD25E5B98600D082AD /* CoreLibrary.swift in Sources */,
@@ -5817,7 +5823,7 @@
 					"@executable_path/../Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				MARKETING_VERSION = 2.4.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++14";
@@ -5859,7 +5865,7 @@
 					"@executable_path/../Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				MARKETING_VERSION = 2.4.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++14";
@@ -5890,7 +5896,7 @@
 				ENABLE_USER_SCRIPT_SANDBOXING = NO;
 				GCC_C_LANGUAGE_STANDARD = gnu17;
 				LOCALIZATION_PREFERS_STRING_CATALOGS = YES;
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
 				MTL_FAST_MATH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = net.objecthub.LispKitRepl;
@@ -5920,7 +5926,7 @@
 				ENABLE_USER_SCRIPT_SANDBOXING = NO;
 				GCC_C_LANGUAGE_STANDARD = gnu17;
 				LOCALIZATION_PREFERS_STRING_CATALOGS = YES;
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				MTL_FAST_MATH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = net.objecthub.LispKitRepl;
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -6078,7 +6084,7 @@
 					"@executable_path/../Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				MARKETING_VERSION = 2.5.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu99 gnu++11";
@@ -6114,7 +6120,7 @@
 					"@executable_path/../Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				MARKETING_VERSION = 2.5.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu99 gnu++11";
@@ -6140,7 +6146,7 @@
 					"@executable_path/../Frameworks",
 					"@loader_path/../Frameworks",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				PRODUCT_BUNDLE_IDENTIFIER = net.objecthub.LispKitTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = macosx;
@@ -6160,7 +6166,7 @@
 					"@executable_path/../Frameworks",
 					"@loader_path/../Frameworks",
 				);
-				MACOSX_DEPLOYMENT_TARGET = 13.0;
+				MACOSX_DEPLOYMENT_TARGET = 13.4;
 				PRODUCT_BUNDLE_IDENTIFIER = net.objecthub.LispKitTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = macosx;

Package.swift

@@ -40,7 +40,7 @@ import PackageDescription
 let package = Package(
   name: "LispKit",
   platforms: [
-    .macOS(.v13),
+    .macOS("13.4"),
     .iOS(.v16)
   ],
   products: [

Sources/LispKit/Compiler/EvalError.swift

@@ -193,6 +193,11 @@ public enum EvalError: Int, Hashable, Codable {
   case urlFormatConstraintError
   case urlAuthorityError
   case urlPrototypeInvalid
+  case cannotCreatePdf
+  case invalidPDFDisplayBox
+  case invalidPDFAccessIdentifier
+  case invalidPDFDocGenerationOption
+  case unknownPDFAnnotationType
 
   public var message: String {
     switch self {
@@ -532,6 +537,16 @@ public enum EvalError: Int, Hashable, Codable {
         return "invalid URL authority specifier: $0"
       case .urlPrototypeInvalid:
         return "$0 is not a valid URL prototype for procedure $,1"
+      case .cannotCreatePdf:
+        return "cannot create pdf document from bytevector $0"
+      case .invalidPDFDisplayBox:
+        return "not a valid PDF display box specifier: $0"
+      case .invalidPDFAccessIdentifier:
+        return "invalid PDF access permission identifier: $0"
+      case .invalidPDFDocGenerationOption:
+        return "invalid PDF document generation option: $0"
+      case .unknownPDFAnnotationType:
+        return "unknown PDF annotation type: $0"
     }
   }
 

Sources/LispKit/Graphics/Drawing.swift

@@ -21,6 +21,7 @@
 import CoreGraphics
 import Cocoa
 import AppKit
+import PDFKit
 
 ///
 /// Class `Drawing` represents a sequence of drawing instructions. The class offers the
@@ -84,15 +85,15 @@ public final class Drawing: NativeObject {
         context.cgContext.endTransparencyLayer()
         context.restoreGraphicsState()
       }
-      self.drawInline()
+      self.drawInline(in: context)
     }
   }
 
   /// Draw the drawing into the current graphics context without saving and restoring the
   /// graphics state.
-  public func drawInline() {
+  public func drawInline(in context: NSGraphicsContext) {
     for instruction in self.instructions {
-      instruction.draw()
+      instruction.draw(in: context)
     }
   }
 
@@ -322,19 +323,28 @@ public enum DrawingInstruction {
   case text(String, font: NSFont?, color: Color?, style: NSParagraphStyle?, at: ObjectLocation)
   case attributedText(NSAttributedString, at: ObjectLocation)
   case image(NSImage, ObjectLocation, operation: NSCompositingOperation, opacity: Double)
+  case page(PDFPage, PDFDisplayBox, NSRect)
   case inline(Drawing)
   case include(Drawing, clippedTo: Shape?)
 
-  fileprivate func draw() {
+  /// Draw the instruction if there is a valid current drawing context
+  public func draw() {
+    if let context = NSGraphicsContext.current {
+      self.draw(in: context)
+    }
+  }
+  
+  /// Draw the instruction into the given drawing context
+  public func draw(in context: NSGraphicsContext) {
     switch self {
       case .setStrokeColor(let color):
         color.nsColor.setStroke()
       case .setFillColor(let color):
         color.nsColor.setFill()
       case .setStrokeWidth(let width):
-        NSGraphicsContext.current?.cgContext.setLineWidth(CGFloat(width))
+        context.cgContext.setLineWidth(CGFloat(width))
       case .setBlendMode(let blendMode):
-        NSGraphicsContext.current?.cgContext.setBlendMode(blendMode)
+        context.cgContext.setBlendMode(blendMode)
       case .setShadow(let color, let dx, let dy, let blurRadius):
         let shadow = NSShadow()
         shadow.shadowOffset = NSSize(width: dx, height: dy)
@@ -356,20 +366,19 @@ public enum DrawingInstruction {
         transform.invert()
         transform.concat()
       case .strokeLine(let start, let end):
-        if let context = NSGraphicsContext.current?.cgContext {
-          context.beginPath()
-          context.move(to: start)
-          context.addLine(to: end)
-          context.strokePath()
-        }
+        let context = context.cgContext
+        context.beginPath()
+        context.move(to: start)
+        context.addLine(to: end)
+        context.strokePath()
       case .strokeRect(let rct):
-        NSGraphicsContext.current?.cgContext.stroke(rct)
+        context.cgContext.stroke(rct)
       case .fillRect(let rct):
-        NSGraphicsContext.current?.cgContext.fill(rct)
+        context.cgContext.fill(rct)
       case .strokeEllipse(let rct):
-        NSGraphicsContext.current?.cgContext.strokeEllipse(in: rct)
+        context.cgContext.strokeEllipse(in: rct)
       case .fillEllipse(let rct):
-        NSGraphicsContext.current?.cgContext.fillEllipse(in: rct)
+        context.cgContext.fillEllipse(in: rct)
       case .stroke(let shape, let width):
         shape.stroke(lineWidth: width)
       case .strokeDashed(let shape, let width, let dashLengths, let dashPhase):
@@ -436,10 +445,23 @@ public enum DrawingInstruction {
                        respectFlipped: true,
                        hints: [:])
         }
+      case .page(let page, let box, let rect):
+        let context = context.cgContext
+        context.saveGState()
+        // PDF coordinate system is Y-flipped from Core Graphics
+        context.translateBy(x: rect.origin.x, y: rect.origin.y + rect.height)
+        // Apply the PDF's crop box transform
+        let bounds = page.bounds(for: box)
+        page.transform(context, for: box)
+        // Scale PDF to view size
+        context.scaleBy(x: rect.width / bounds.width, y: -rect.height / bounds.height)
+        // Draw
+        page.draw(with: box, to: context)
+        context.restoreGState()
       case .include(let drawing, let clippingRegion):
         drawing.draw(clippedTo: clippingRegion)
       case .inline(let drawing):
-        drawing.drawInline()
+        drawing.drawInline(in: context)
     }
   }
 

Sources/LispKit/Primitives/DrawingLibrary.swift

@@ -237,11 +237,14 @@ public final class DrawingLibrary: NativeLibrary {
     self.define(Procedure("rect?", isRect))
     self.define(Procedure("rect", rect))
     self.define(Procedure("rect-point", rectPoint))
-    self.define(Procedure("rect-size", rectSize))
     self.define(Procedure("rect-x", rectX))
     self.define(Procedure("rect-y", rectY))
+    self.define(Procedure("rect-size", rectSize))
     self.define(Procedure("rect-width", rectWidth))
     self.define(Procedure("rect-height", rectHeight))
+    self.define(Procedure("rect-max-point", rectMaxPoint))
+    self.define(Procedure("rect-max-x", rectMaxX))
+    self.define(Procedure("rect-max-y", rectMaxY))
     self.define(Procedure("move-rect", moveRect))
 
     // Utilities
@@ -924,7 +927,7 @@ public final class DrawingLibrary: NativeLibrary {
     }
   }
 
-  private func makeBitmap(drawing: Expr, size: Expr, dpi: Expr?) throws -> Expr {
+  private func makeBitmap(expr: Expr, size: Expr, dpi: Expr?, ipol: Expr?) throws -> Expr {
     guard case .pair(.flonum(let w), .flonum(let h)) = size, w > 0.0 && h > 0.0 else {
       throw RuntimeError.eval(.invalidSize, size)
     }
@@ -949,27 +952,44 @@ public final class DrawingLibrary: NativeLibrary {
                                         bytesPerRow: 0,
                                         bitsPerPixel: 0) else {
       throw RuntimeError.eval(.cannotCreateBitmap,
-                              .pair(drawing, .pair(size, .pair(dpi ?? .fixnum(72), .null))))
+                              .pair(expr, .pair(size, .pair(dpi ?? .fixnum(72), .null))))
     }
     // Set the intended size of the image (vs. size of the bitmap above)
     bitmap.size = NSSize(width: w, height: h)
     // Create a graphics context for drawing into the bitmap
     guard let context = NSGraphicsContext(bitmapImageRep: bitmap) else {
       throw RuntimeError.eval(.cannotCreateBitmap,
-                              .pair(drawing, .pair(size, .pair(dpi ?? .fixnum(72), .null))))
+                              .pair(expr, .pair(size, .pair(dpi ?? .fixnum(72), .null))))
     }
     let previous = NSGraphicsContext.current
     // Create a flipped graphics context if required
     NSGraphicsContext.current = NSGraphicsContext(cgContext: context.cgContext, flipped: true)
-    let transform = NSAffineTransform()
-    transform.translateX(by: 0.0, yBy: CGFloat(h))
-    transform.scaleX(by: 1.0, yBy: -1.0)
-    transform.concat()
     defer {
       NSGraphicsContext.current = previous
     }
+    // Set interpolation quality
+    if let ipol,
+       let quality = CGInterpolationQuality(rawValue: Int32(try ipol.asInt(above: 0, below: 5))) {
+      NSGraphicsContext.current?.cgContext.interpolationQuality = quality
+    }
     // Draw into the bitmap
-    try self.drawing(from: drawing).draw()
+    switch expr {
+      case .object(let obj):
+        if let imageBox = obj as? NativeImage {
+          imageBox.value.draw(in: NSRect(origin: .zero, size: bitmap.size),
+                              from: .zero,
+                              operation: .copy,
+                              fraction: 1.0)
+          break
+        }
+        fallthrough
+      default:
+        let transform = NSAffineTransform()
+        transform.translateX(by: 0.0, yBy: CGFloat(h))
+        transform.scaleX(by: 1.0, yBy: -1.0)
+        transform.concat()
+        try self.drawing(from: expr).draw()
+    }
     // Create an image and add the bitmap as a representation
     let nsimage = NSImage(size: bitmap.size)
     nsimage.addRepresentation(bitmap)
@@ -1763,6 +1783,14 @@ public final class DrawingLibrary: NativeLibrary {
     return point
   }
 
+  private func rectMaxPoint(expr: Expr) throws -> Expr {
+    guard case .pair(.pair(.flonum(let x), .flonum(let y)),
+                     .pair(.flonum(let w), .flonum(let h))) = expr else {
+      throw RuntimeError.eval(.invalidRect, expr)
+    }
+    return .pair(.flonum(x + w), .flonum(y + h))
+  }
+  
   private func rectX(expr: Expr) throws -> Expr {
     guard case .pair(.pair(.flonum(let x), .flonum(_)), .pair(.flonum(_), .flonum(_))) = expr else {
       throw RuntimeError.eval(.invalidRect, expr)
@@ -1777,6 +1805,20 @@ public final class DrawingLibrary: NativeLibrary {
     return .flonum(y)
   }
 
+  private func rectMaxX(expr: Expr) throws -> Expr {
+    guard case .pair(.pair(.flonum(let x), .flonum(_)), .pair(.flonum(let w), .flonum(_))) = expr else {
+      throw RuntimeError.eval(.invalidRect, expr)
+    }
+    return .flonum(x + w)
+  }
+  
+  private func rectMaxY(expr: Expr) throws -> Expr {
+    guard case .pair(.pair(.flonum(_), .flonum(let y)), .pair(.flonum(_), .flonum(let h))) = expr else {
+      throw RuntimeError.eval(.invalidRect, expr)
+    }
+    return .flonum(y + h)
+  }
+  
   private func rectSize(expr: Expr) throws -> Expr {
     guard case .pair(.pair(.flonum(_), .flonum(_)), let size) = expr else {
       throw RuntimeError.eval(.invalidRect, expr)