Skip to main content

C++ OpenSCAD evaluator with Python bindings

Project description

openscad_cpp_evaluator

A C++20 port of openscad_evaluator (Python): an AST-walking geometry engine that takes a parsed OpenSCAD AST and produces Manifold CSG geometry, ready to export to STL/OBJ/OFF/3MF or hand off to a renderer.

Built on:

  • openscad_cpp_parser (git submodule) for lexing/parsing/AST/scope resolution.
  • Manifold v3.5.2 for the actual CSG boolean/mesh engine.
  • Boost.Polygon for roof()'s Voronoi-diagram construction.
  • nothings/stb (header-only) for surface()'s image loader and the built-in font provider's TrueType parsing/rasterization.

All fetched automatically via CMake FetchContent — no manual dependency installation beyond the toolchain below.

Status

All planned phases (0–9) are complete: the full primitive/transform/boolean/modifier/control-flow language surface, every builtin function, STL/OBJ/OFF/3MF import and export, hull()/minkowski()/ linear_extrude()/rotate_extrude()/roof()/offset()/surface()/DXF & SVG import/text(), an opt-in content-hash geometry cache, per-call-site profiling, and a gdb-style --debug REPL. See CLAUDE.md for the full phase-by-phase history and architecture notes.

Build

Requires:

  • CMake ≥ 3.24
  • A C++20 compiler (Clang, GCC, or MSVC — all three are covered by CI)
  • Bison ≥ 3.8 and Flex
    • macOS: brew install bison flex (the system bison is too old; CMake auto-detects Homebrew's)
    • Linux: sudo apt-get install bison flex
    • Windows: MSYS2's bison/flex (pacman -S bison flex) — GitHub's windows-latest runner ships MSYS2 pre-installed at C:\msys64; CMake auto-detects it there too

GoogleTest and every other C++ dependency are fetched automatically.

git clone --recurse-submodules <this-repo>
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j

(Omitting -DCMAKE_BUILD_TYPE=Release builds unoptimized — pass it explicitly for anything performance-sensitive.)

On Windows, CMake defaults to the multi-config Visual Studio generator, which ignores CMAKE_BUILD_TYPE; pass --config Release to cmake --build (and -C Release to ctest) instead.

Test

ctest --test-dir build --output-on-failure

Run a single binary or filter:

build/tests/oscad_eval_tests
build/tests/oscad_eval_tests --gtest_filter='FormatNumber.*'

The suite runs twice in CI — once with the bytecode VM on (the default) and once with it off (OSCAD_BYTECODE_VM=0) — so a regression in either the compiled or interpreted expression-eval path is caught.

CLI

build/tools/cli/openscad-cpp-evaluator <input.scad> -o <output.{stl,obj,off,3mf}> [--format stl|obj|off|3mf] [--debug]

The output format is inferred from -o's extension, or set explicitly with --format. --debug drops into a gdb-style REPL (break/run/continue/step/next/finish/print/ backtrace/set/list/quit/help) before and during evaluation.

build/tools/cli/openscad-cpp-evaluator model.scad -o model.stl

Architecture

See CLAUDE.md for the full per-file architecture map, the Python-reference cross-check history, and the rationale behind every non-obvious design choice (the two-pass resolve/generate CSG pipeline, the FontProvider injection seam, the closure-detection rule, etc.).

CI

GitHub Actions builds and tests on Linux, macOS, and Windows on every push/PR (.github/workflows/ci.yml).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openscad_cpp_evaluator-0.4.3.tar.gz (614.3 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

openscad_cpp_evaluator-0.4.3-cp312-abi3-win_amd64.whl (5.0 MB view details)

Uploaded CPython 3.12+Windows x86-64

openscad_cpp_evaluator-0.4.3-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (3.2 MB view details)

Uploaded CPython 3.12+manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

openscad_cpp_evaluator-0.4.3-cp312-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (2.9 MB view details)

Uploaded CPython 3.12+manylinux: glibc 2.27+ ARM64manylinux: glibc 2.28+ ARM64

openscad_cpp_evaluator-0.4.3-cp312-abi3-macosx_13_0_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.12+macOS 13.0+ x86-64

openscad_cpp_evaluator-0.4.3-cp312-abi3-macosx_13_0_arm64.whl (2.0 MB view details)

Uploaded CPython 3.12+macOS 13.0+ ARM64

File details

Details for the file openscad_cpp_evaluator-0.4.3.tar.gz.

File metadata

  • Download URL: openscad_cpp_evaluator-0.4.3.tar.gz
  • Upload date:
  • Size: 614.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for openscad_cpp_evaluator-0.4.3.tar.gz
Algorithm Hash digest
SHA256 ecd9e2ddbaa43ded8ebabd83808b7874b3ae5221ea390abe20740ca0ab520458
MD5 3145e822f2c14d5e1de6483016e06a5d
BLAKE2b-256 668aecd0ca38c0e4875aebe00257c54f3c9b11778a1d609011a299c6652b97ce

See more details on using hashes here.

File details

Details for the file openscad_cpp_evaluator-0.4.3-cp312-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.3-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 1db401a3c62a00bca09e88077c566a591f2267db5ce1e3c429dac796027b976a
MD5 eff3c5ef72d6733e86f66f4629c40d47
BLAKE2b-256 2b8b8bba894bb8cc90c6c3995364a8878d4751987ba368e7fd3bfad37ec3fa46

See more details on using hashes here.

File details

Details for the file openscad_cpp_evaluator-0.4.3-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.3-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 6c4579facccfa3bd048cf4ceee67232b3a470bae754ff3575f4ed60dc0349322
MD5 9fafd69636598882179f2f0a54781752
BLAKE2b-256 afc697196f6970fea2d01fc2e873b71fad4f70ab75eb64922b85814e8d519e4c

See more details on using hashes here.

File details

Details for the file openscad_cpp_evaluator-0.4.3-cp312-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.3-cp312-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 0cbf16f6a99ca468ddde5f64d07917a5e70fb8eb1b9a1a205a428f818a7b3bb0
MD5 2f28dcd12d2b36a4b5dfe1ea3ea8387f
BLAKE2b-256 c4ea8161cbe1a87c09bff44d6db9e4a7aff242811d2dda44d5274d80316169be

See more details on using hashes here.

File details

Details for the file openscad_cpp_evaluator-0.4.3-cp312-abi3-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.3-cp312-abi3-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 6d7867da181c51b9c7397f036f5d5c549cb89890a66649119c0963a3c238a520
MD5 ad130c6ee867997ea5eebe785f5a3b5c
BLAKE2b-256 165bbb22ef7dd832cd4241877aa4c3cb9f1aa70b12e3799dfa834dec82a4552a

See more details on using hashes here.

File details

Details for the file openscad_cpp_evaluator-0.4.3-cp312-abi3-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.3-cp312-abi3-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 a76c19b6975b1cac327fccd0bd823e62ff5c4a9aa6b42dff04c17692c3451502
MD5 08aa289d94c22b87224ec4b6c4bf30b2
BLAKE2b-256 f8bbe8261d9d80e59dbdc1428013f3d1075f47c0e859c0df3af3defb725fe134

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page