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.2.0.tar.gz (602.0 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.2.0-cp312-abi3-win_amd64.whl (4.8 MB view details)

Uploaded CPython 3.12+Windows x86-64

openscad_cpp_evaluator-0.2.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (3.0 MB view details)

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

openscad_cpp_evaluator-0.2.0-cp312-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (2.7 MB view details)

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

openscad_cpp_evaluator-0.2.0-cp312-abi3-macosx_13_0_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.12+macOS 13.0+ x86-64

openscad_cpp_evaluator-0.2.0-cp312-abi3-macosx_13_0_arm64.whl (1.8 MB view details)

Uploaded CPython 3.12+macOS 13.0+ ARM64

File details

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

File metadata

  • Download URL: openscad_cpp_evaluator-0.2.0.tar.gz
  • Upload date:
  • Size: 602.0 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.2.0.tar.gz
Algorithm Hash digest
SHA256 77de705fbc650e9ae427d23db11a513e2a476c805b07ca0054e987800ff62175
MD5 192a996d38e00fd1f35982ae799613e2
BLAKE2b-256 8d4b2c41550468c00884c0e5219e572f7ea0a0f2ad3d8822f890ca3ec0f98354

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.2.0-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 b6e5c184ca2861f8ed8f2b5623a0c27c60fe8b1337b0d2e37f373f05d1c62061
MD5 34b2e1455c5cdf925c99d9389013e2bd
BLAKE2b-256 235fd3d56d7649803ce99dfaa72256fca3963f7e33cd51838a52397f3ffa58e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.2.0-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c216f3bf27bb1d8342a5a0b7e00867424fc895184ce44d816930d5d17e8ef04c
MD5 43913496e9e5844670b2f16cf7a5697a
BLAKE2b-256 2cfa7f852dbdbf31aefe807c0d5f89d7673f482f2bb5b099bd32ded6b97efc8c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.2.0-cp312-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 a7db9f296ae0c9b785fa08488c375138f2aad7ac6ea1339f61ed1c9a6800d425
MD5 88e2cb9af0692c4e8621f1930dae057d
BLAKE2b-256 9382aa5c67ca2a0ce50854842b2f93d9873d6102f2e51117548edad64a81a3ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.2.0-cp312-abi3-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 a25c79d42a3cea8376c204cbb989085602ee909bee9784ad1e99b4878abf2212
MD5 563841b399834aaf0f81d789a346b52a
BLAKE2b-256 1a1909e2115053dd918a3c5cfefa0c2caa91e608399595dc9760fa06e4f33097

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.2.0-cp312-abi3-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 51363fee95279b6bae13da9aa73e03c9bdad411fe911831c0a12b3849b5b0cd4
MD5 1add2b48896a15bf9b62bda333fbe237
BLAKE2b-256 33c4fe2b318cac7fc035fe32b4d8dc4a1fdc8214f16db7cef50aad2fba406fa9

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