zig build!

Author: chearon

.github/workflows/ci.yaml

@@ -19,12 +19,9 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - uses: actions/checkout@v4
-      - name: Install Dependencies
-        run: |
-          sudo apt update
-          sudo apt install -y libcairo2-dev libjpeg-dev libpango1.0-dev libgif-dev librsvg2-dev
+      - uses: mlugg/setup-zig@v2
       - name: Install
-        run: npm install --build-from-source
+        run: npm install
       - name: Test
         run: npm test
 
@@ -39,17 +36,9 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - uses: actions/checkout@v4
-      - name: Install Dependencies
-        run: |
-          Invoke-WebRequest "https://ftp.gnome.org/pub/GNOME/binaries/win64/gtk+/2.22/gtk+-bundle_2.22.1-20101229_win64.zip" -OutFile "gtk.zip"
-          Expand-Archive gtk.zip -DestinationPath "C:\GTK"
-          Invoke-WebRequest "https://downloads.sourceforge.net/project/libjpeg-turbo/2.0.4/libjpeg-turbo-2.0.4-vc64.exe" -OutFile "libjpeg.exe" -UserAgent NativeHost
-          .\libjpeg.exe /S
-          winget install --accept-source-agreements --id=Microsoft.VCRedist.2010.x64 -e
-          npm install -g node-gyp@8
-          npm prefix -g | % {npm config set node_gyp "$_\node_modules\node-gyp\bin\node-gyp.js"}
+      - uses: mlugg/setup-zig@v2
       - name: Install
-        run: npm install --build-from-source
+        run: npm install
       - name: Test
         run: npm test
 
@@ -64,12 +53,9 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - uses: actions/checkout@v4
-      - name: Install Dependencies
-        run: |
-          brew update
-          brew install python-setuptools pkg-config cairo pango libpng jpeg giflib librsvg
+      - uses: mlugg/setup-zig@v2
       - name: Install
-        run: npm install --build-from-source
+        run: npm install
       - name: Test
         run: npm test
 

.gitignore

@@ -19,3 +19,5 @@ package-lock.json
 npm-debug.log
 
 .idea
+
+.zig-cache/

build.zig

@@ -0,0 +1,62 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+    const cairo = b.dependency("cairo", .{
+        .use_spectre = false,
+        .use_xlib = false,
+        .use_xcb = false,
+        .use_png = true,
+        .use_glib = false
+    }).artifact("cairo");
+
+    const libjpeg_turbo = b.dependency("libjpeg_turbo", .{}).artifact("libjpeg_turbo");
+    
+    const giflib = b.dependency("giflib", .{}).artifact("giflib");
+
+    const canvas = b.addSharedLibrary(.{
+      .name = "canvas",
+      .root_module = b.createModule(.{
+        .target = target,
+        .optimize = optimize,
+      })
+    });
+    
+    const node_api_headers = b.dependency("node_api_headers", .{});
+    const node_addon_api = b.dependency("node_addon_api", .{});
+    
+    canvas.addIncludePath(node_api_headers.path("include"));
+    canvas.addIncludePath(node_addon_api.path("."));
+    canvas.addCSourceFiles(.{
+        .files = &.{
+            "src/bmp/BMPParser.cc",
+            "src/Canvas.cc",
+            "src/CanvasGradient.cc",
+            "src/CanvasPattern.cc",
+            "src/CanvasRenderingContext2d.cc",
+            "src/closure.cc",
+            "src/color.cc",
+            "src/Image.cc",
+            "src/ImageData.cc",
+            "src/init.cc",
+            "src/FontParser.cc"
+        } ,
+        .flags = &.{
+            "-DNAPI_DISABLE_CPP_EXCEPTIONS",
+            "-DNODE_ADDON_API_ENABLE_MAYBE"
+        }
+    });
+    
+    canvas.linker_allow_shlib_undefined = true;
+
+    canvas.linkLibC();
+    canvas.linkLibCpp();
+    canvas.linkLibrary(cairo);
+    canvas.linkLibrary(libjpeg_turbo);
+    canvas.linkLibrary(giflib);
+    
+    const move = b.addInstallFile(canvas.getEmittedBin(), "../bin/canvas.node");
+    move.step.dependOn(&canvas.step);
+    b.getInstallStep().dependOn(&move.step);
+}

build.zig.zon

@@ -0,0 +1,26 @@
+.{
+    .name = .canvas,
+    .fingerprint = 0xa59f6c18a5521654,
+    .version = "0.0.0",
+    .paths = .{""},
+    .dependencies = .{
+        .node_addon_api = .{
+            .url = "https://github.com/nodejs/node-addon-api/archive/refs/tags/v8.4.0.tar.gz",
+            .hash = "N-V-__8AAB0dFQBL0NSpsyPolKPJGjyCmfSTQ7Km5wrRQpb7"
+        },
+        .node_api_headers = .{
+            .url = "https://github.com/nodejs/node-api-headers/archive/refs/tags/v1.5.0.tar.gz",
+            .hash = "N-V-__8AAASNAQA0UI0mvQk4LyFEhdFuFBPgH8HSokdFFpnz"
+        },
+        .cairo = .{
+            .url = "https://github.com/bandithedoge/cairo.zig/archive/bfc51c8232486ed21e83e020711aa039c7b6bc04.tar.gz",
+            .hash = "cairo_zig-1.18.4-GbxI8QpbAQD1mm-pi1QJuwYmxvhdVf0K1XhMEFlgsVhb"
+        },
+        .libjpeg_turbo = .{
+            .path = "../libjpeg-turbo",
+        },
+        .giflib = .{
+            .path = "../giflib-5.2.2"
+        }
+    },
+}

lib/bindings.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const bindings = require('../build/Release/canvas.node')
+const bindings = require('../bin/canvas.node')
 
 module.exports = bindings
 

lib/jpegstream.js

@@ -13,10 +13,6 @@ class JPEGStream extends Readable {
   constructor (canvas, options) {
     super()
 
-    if (canvas.streamJPEGSync === undefined) {
-      throw new Error('node-canvas was built without JPEG support.')
-    }
-
     this.options = options
     this.canvas = canvas
   }

package.json

@@ -24,15 +24,15 @@
   "homepage": "https://github.com/Automattic/node-canvas",
   "repository": "git://github.com/Automattic/node-canvas.git",
   "scripts": {
-    "prebenchmark": "node-gyp build",
+    "prebenchmark": "zig build",
     "benchmark": "node benchmarks/run.js",
     "lint": "standard examples/*.js test/server.js test/public/*.js benchmarks/run.js lib/context2d.js util/has_lib.js browser.js index.js",
     "test": "mocha test/*.test.js",
-    "pretest-server": "node-gyp build",
+    "pretest-server": "zig build",
     "test-server": "node test/server.js",
     "generate-wpt": "node ./test/wpt/generate.js",
     "test-wpt": "mocha test/wpt/generated/*.js",
-    "install": "prebuild-install -r napi || node-gyp rebuild",
+    "install": "zig build",
     "tsd": "tsd"
   },
   "files": [

src/Canvas.cc

@@ -11,20 +11,15 @@
 #include <cstring>
 #include <cctype>
 #include <ctime>
-#include <glib.h>
 #include "PNG.h"
 #include <sstream>
 #include <stdlib.h>
 #include <string>
 #include <unordered_set>
 #include "Util.h"
 #include <vector>
-#include "node_buffer.h"
 #include "FontParser.h"
-
-#ifdef HAVE_JPEG
 #include "JPEGStream.h"
-#endif
 
 #define GENERIC_FACE_ERROR \
   "The second argument to registerFont is required, and should be an object " \
@@ -49,9 +44,7 @@ Canvas::Initialize(Napi::Env& env, Napi::Object& exports) {
     InstanceMethod<&Canvas::ToBuffer>("toBuffer", napi_default_method),
     InstanceMethod<&Canvas::StreamPNGSync>("streamPNGSync", napi_default_method),
     InstanceMethod<&Canvas::StreamPDFSync>("streamPDFSync", napi_default_method),
-#ifdef HAVE_JPEG
     InstanceMethod<&Canvas::StreamJPEGSync>("streamJPEGSync", napi_default_method),
-#endif
     InstanceAccessor<&Canvas::GetType>("type", napi_default_jsproperty),
     InstanceAccessor<&Canvas::GetStride>("stride", napi_default_jsproperty),
     InstanceAccessor<&Canvas::GetWidth, &Canvas::SetWidth>("width", napi_default_jsproperty),
@@ -84,8 +77,8 @@ Canvas::Canvas(const Napi::CallbackInfo& info) : Napi::ObjectWrap<Canvas>(info),
   this->width = 0;
   this->height = 0;
 
-  int32_t width;
-  int32_t height;
+  uint32_t width;
+  uint32_t height;
 
   if (info[0].IsNumber()) {
     width = info[0].As<Napi::Number>().Int32Value();
@@ -224,13 +217,11 @@ Canvas::ToPngBufferAsync(Closure* base) {
     closure);
 }
 
-#ifdef HAVE_JPEG
 void
 Canvas::ToJpegBufferAsync(Closure* base) {
   JpegClosure* closure = static_cast<JpegClosure*>(base);
   write_to_jpeg_buffer(closure->canvas->ensureSurface(), closure);
 }
-#endif
 
 static void
 parsePNGArgs(Napi::Value arg, PngClosure& pngargs) {
@@ -275,7 +266,6 @@ parsePNGArgs(Napi::Value arg, PngClosure& pngargs) {
   }
 }
 
-#ifdef HAVE_JPEG
 static void parseJPEGArgs(Napi::Value arg, JpegClosure& jpegargs) {
   // "If Type(quality) is not Number, or if quality is outside that range, the
   // user agent must use its default quality value, as if the quality argument
@@ -307,9 +297,6 @@ static void parseJPEGArgs(Napi::Value arg, JpegClosure& jpegargs) {
     }
   }
 }
-#endif
-
-#if CAIRO_VERSION >= CAIRO_VERSION_ENCODE(1, 16, 0)
 
 static inline void setPdfMetaStr(cairo_surface_t* surf, Napi::Object opts,
   cairo_pdf_metadata_t t, const char* propName) {
@@ -343,8 +330,6 @@ static void setPdfMetadata(Canvas* canvas, Napi::Object opts) {
   setPdfMetaDate(surf, opts, CAIRO_PDF_METADATA_MOD_DATE, "modDate");
 }
 
-#endif // CAIRO 16+
-
 /*
  * Converts/encodes data to a Buffer. Async when a callback function is passed.
 
@@ -380,11 +365,9 @@ Canvas::ToBuffer(const Napi::CallbackInfo& info) {
     // mime type may be present, but it's not checked
     PdfSvgClosure* closure = static_cast<PdfSvgClosure*>(_closure);
     if (isPDF()) {
-#if CAIRO_VERSION >= CAIRO_VERSION_ENCODE(1, 16, 0)
       if (info[1].IsObject()) { // toBuffer("application/pdf", config)
         setPdfMetadata(this, info[1].As<Napi::Object>());
       }
-#endif // CAIRO 16+
     }
 
     cairo_surface_t *surf = ensureSurface();
@@ -403,10 +386,6 @@ Canvas::ToBuffer(const Napi::CallbackInfo& info) {
   if (info[0].StrictEquals(Napi::String::New(env, "raw"))) {
     cairo_surface_t *surface = ensureSurface();
     cairo_surface_flush(surface);
-    if (nBytes() > node::Buffer::kMaxLength) {
-      Napi::Error::New(env, "Data exceeds maximum buffer length.").ThrowAsJavaScriptException();
-      return env.Undefined();
-    }
     return Napi::Buffer<uint8_t>::Copy(env, cairo_image_surface_get_data(surface), nBytes());
   }
 
@@ -467,7 +446,6 @@ Canvas::ToBuffer(const Napi::CallbackInfo& info) {
     return env.Undefined();
   }
 
-#ifdef HAVE_JPEG
   // Sync JPEG
   Napi::Value jpegStr = Napi::String::New(env, "image/jpeg");
   if (info[0].StrictEquals(jpegStr)) {
@@ -503,7 +481,6 @@ Canvas::ToBuffer(const Napi::CallbackInfo& info) {
     worker->Queue();
     return env.Undefined();
   }
-#endif
 
   return env.Undefined();
 }
@@ -608,11 +585,9 @@ Canvas::StreamPDFSync(const Napi::CallbackInfo& info) {
     return;
   }
 
-#if CAIRO_VERSION >= CAIRO_VERSION_ENCODE(1, 16, 0)
   if (info[1].IsObject()) {
     setPdfMetadata(this, info[1].As<Napi::Object>());
   }
-#endif
 
   cairo_surface_finish(ensureSurface());
 
@@ -638,7 +613,6 @@ Canvas::StreamPDFSync(const Napi::CallbackInfo& info) {
  * Stream JPEG data synchronously.
  */
 
-#ifdef HAVE_JPEG
 static uint32_t getSafeBufSize(Canvas* canvas) {
   // Don't allow the buffer size to exceed the size of the canvas (#674)
   // TODO not sure if this is really correct, but it fixed #674
@@ -659,7 +633,6 @@ Canvas::StreamJPEGSync(const Napi::CallbackInfo& info) {
   uint32_t bufsize = getSafeBufSize(this);
   write_to_jpeg_stream(ensureSurface(), bufsize, &closure);
 }
-#endif
 
 char *
 str_value(Napi::Maybe<Napi::Value> maybe, const char *fallback, bool can_be_number) {
@@ -714,16 +687,14 @@ Canvas::ParseFont(const Napi::CallbackInfo& info) {
 // This returns an approximate value only, suitable for
 // Napi::MemoryManagement:: AdjustExternalMemory.
 // The formats that don't map to intrinsic types (RGB30, A1) round up.
-int32_t
+uint32_t
 Canvas::approxBytesPerPixel() {
   switch (format) {
   case CAIRO_FORMAT_ARGB32:
   case CAIRO_FORMAT_RGB24:
     return 4;
-#ifdef CAIRO_FORMAT_RGB30
   case CAIRO_FORMAT_RGB30:
     return 3;
-#endif
   case CAIRO_FORMAT_RGB16_565:
     return 2;
   case CAIRO_FORMAT_A8:

src/Canvas.h

@@ -6,11 +6,13 @@ struct Closure;
 
 #include "closure.h"
 #include <cairo.h>
-#include "dll_visibility.h"
 #include <napi.h>
 #include <vector>
 #include <cstddef>
 
+#define DLL_PUBLIC __attribute__ ((visibility ("default")))
+#define DLL_LOCAL  __attribute__ ((visibility ("hidden")))
+
 /*
  * Canvas types.
  */
@@ -62,7 +64,7 @@ class Canvas : public Napi::ObjectWrap<Canvas> {
     DLL_PUBLIC inline int getWidth() { return width; }
     DLL_PUBLIC inline int getHeight() { return height; }
 
-    int32_t approxBytesPerPixel();
+    uint32_t approxBytesPerPixel();
     void setFormat(cairo_format_t format);
     cairo_format_t getFormat();
     void resurface(Napi::Object This);