vips-sys

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning as implemented by Cargo.

Release workflow supports manual workflow_dispatch with a tag input (in addition to tag push).
Release workflow hardening: concurrency group per tag, job timeouts, cargo publish --dry-run in verify, --locked on the real publish.

CI: softprops/action-gh-release@v3; changelog extract uses shell: bash.
Pin optional build-dep cc to 1.4.5 (used by feature stub).
Apply cargo fmt to build.rs (import order and line wrapping).
Point package.documentation and README docs links at https://docs.rs/vips-sys/ (drop GitHub Pages URLs).

Pregenerated bindings (src/bindings/prebuilt.rs) are used by default: no clang/bindgen required for normal cargo build. Enable feature bindgen only when refreshing bindings against local headers.
Bindgen (feature bindgen) allowlists vips_* / Vips* / VIPS_* plus a few GObject helpers, uses use_core() + core::ffi, and fingerprint-caches output in OUT_DIR.
Cargo resolver = "3" (edition 2024).
helpers::init / version / version_string use OnceLock; init returns a cached result before allocating CString.
bindgen is an optional build-dependency (default-features = false).
merge_includes dedups with a HashSet.
System pkg-config hit no longer merges vendor include paths (fewer FS probes).
Skip glib pkg-config probes when the bindgen feature is off.
Build script watches PKG_CONFIG_PATH / LIBVIPS_* env for correct rebuilds.

Vendored libvips as a git submodule at vendor/libvips (pinned to v8.18.6).
Static linking: pkg-config --static / vcpkg static triplet; optional meson+ninja build from vendored sources (static feature or LIBVIPS_STATIC=1).
Windows/vcpkg: VCPKG_ROOT, VCPKG_DEFAULT_TRIPLET; document vcpkg install vips:x64-windows[-static].
Env overrides: LIBVIPS_LIB_DIR, LIBVIPS_INCLUDE_DIR, LIBVIPS_NO_VENDOR, LIBVIPS_STATIC (0/false/off disable).
Export cargo:include for dependent sys crates.
cfg(vips_8_16) and cfg(vips_8_17).
helpers::version_string().
Feature bindgen to regenerate FFI from local headers.
Feature stub: link stub/vips_stub.c when no system libvips is found so cargo test --features helpers,stub works in sandboxes/CI. Real libraries are always preferred.
Unit test for helpers::init / version / version_string.
Multi-OS CI (Linux / macOS / Windows) and tag-driven Release workflow.

Rust edition 2024 (requires rustc 1.85+).
Default compile path no longer runs bindgen; src/bindings/prebuilt.rs is include!d unless feature bindgen is enabled.
Bindgen allowlist may omit some previously generated GLib/GObject symbols that were not part of the public libvips surface — use feature bindgen if you need a wider local set.
find_libvips no longer treats vendored headers alone as a linkable library.
CI workflows use actions/checkout@v7 with submodules: recursive and dtolnay/rust-toolchain@stable.
docs.rs metadata enables helpers only (not bindgen).
Removed generate.sh — use cargo build --features bindgen instead. wrapper.h is kept as the bindgen entry header.
Document MIT (this crate) vs LGPL-2.1 (libvips) in README and source headers.
Tag-driven Release workflow: verify version, test, cargo publish, GitHub Release.

prefer_static() matches env::var as Ok (was incorrectly Some).
helpers::version_string: remove explicit * on OnceLock::get_or_init (clippy::explicit_auto_deref, CodeQL alert #3353).
cargo publish verify no longer fails when the machine has no libvips: pregenerated bindings compile without headers/library; the build script only panics under feature bindgen if headers are missing.
MSVC: vcpkg::Config::target_triplet is called in place (was assigned back and failed to type-check).
MSVC: cfg-gate Unix meson/glib helpers so -D warnings / dead_code passes.

Fix: disable doctests for auto-generated bindings to avoid rustdoc failures.
Chore: refactor build script types to reduce clippy::type-complexity.
Docs: rewrite README.md in English and add README_CN.md with language switch.
Build: ensure bindgen does not generate comments to keep bindings lean.

Added optional feature ‘helpers’ to provide a minimum security package: ‘init’/’shutdown’/’version’ for quick verification and single testing.
Export the ‘LIBVIPS_VERSION’ environment variable during build time to make it easier for upper-level to see installed libvips versions.
Build period condition: When ‘>= 8.17.x’ is detected, ‘cfg(vips_8_17)’ is output to pave the way for conditional compilation at the upper layer.

Centralize binding generation to ‘build.rs’, use ‘bindgen’ ‘blocklist_*’ API, ‘CargoCallbacks’, turn off ‘ layout_tests’ for improved stability and repeatable builds.
‘pkg-config’ is responsible for the header file path detection, and automatically injects ‘-I’ to ‘bindgen’.
macOS/Apple Silicon does not require manual hardcoding of the ‘-I’ path, which is handled by ‘pkg-config’ by default.
Unified feature switches to control static/dynamic links (‘static’/’dynamic’) to reduce platform branch scattering.

Fixed ‘find_libvips’ return type mismatch in non-MSVC environments and compilation errors caused by misuse of ‘ String’. -Improved compatibility on different versions of ‘pkg-config’ to avoid vulnerabilities in parsing ‘–cflags’.

This site is open source. Improve this page.