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.5.tar.gz (618.1 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.5-cp312-abi3-win_amd64.whl (5.0 MB view details)

Uploaded CPython 3.12+Windows x86-64

openscad_cpp_evaluator-0.4.5-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.5-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.5-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.5-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.5.tar.gz.

File metadata

  • Download URL: openscad_cpp_evaluator-0.4.5.tar.gz
  • Upload date:
  • Size: 618.1 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.5.tar.gz
Algorithm Hash digest
SHA256 86b051a4417a6eb8211b3cfc76aa37e457d13339f97d00ec75fa22a37f59207b
MD5 280137c22849c073e1dfdf44338e8200
BLAKE2b-256 92940fff08883f52953f297dc66033a46f1b6a6fe84eea7b55dca7fb4b2d9df9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.5-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 bfb4933574eca2ba24dcbf38a7459cf212e618015b66e6767121cac5a4ff0a47
MD5 db6ac53c153eb20e639bdcabcf027368
BLAKE2b-256 2a8fb877fcdd135f5bf2e3e35ce6a6470038dc44782523726cc7fe5cfef44e8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.5-cp312-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1649874996fa75eb9e0bac166420f3c79e4843ed4c81fcde2b1c9b20f4a629c3
MD5 a74f6b76d5d6e396710082f8117d0885
BLAKE2b-256 9c7d250ef16aff026ad9b5d173aab4a7b6cf7d63eff0aa3243de113573dccc68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.5-cp312-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 aae0bad98bb5ff1449bd9bcfc1cb8540cd35ffb44a6fa0eca850a1b1740af8fe
MD5 d8c8f8cede13a964d6f52f62edcb00e7
BLAKE2b-256 5e06426536fcdd8013496890be685a8fb6efd70b75d8791a85c21b85341b7e6a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.5-cp312-abi3-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 ebf0e6b1e8d9d3769f1592127e85856a436c168fc06a2c0a1930458344ff1212
MD5 45f741cf45b298c9f0da14ed8c466c6a
BLAKE2b-256 30e1007559fa6318f295337dd5d6df55a7de5a467be30c70c1dc9f8511e007cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openscad_cpp_evaluator-0.4.5-cp312-abi3-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 a473b49ba99108c1cc684b4264c319250f8d98921f6c86c84171d391bf70d363
MD5 ebeae6ecd792c5eb2e07e3c5f58258ac
BLAKE2b-256 7d009db9010e8cdc5f1176f5c2dce9ce8f458839778afea81ebd1e75fa044929

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