nmhit 0.1.0__tar.gz

nmhit-0.1.0/.clang-format

@@ -0,0 +1,81 @@
+---
+Language: Cpp
+BasedOnStyle: LLVM
+
+# Indentation
+IndentWidth: 2
+TabWidth: 2
+UseTab: Never
+ContinuationIndentWidth: 2
+IndentCaseLabels: true
+
+# Line length
+ColumnLimit: 100
+
+# Braces (Allman style — opening brace on its own line)
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: true
+  AfterControlStatement: Always
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  BeforeCatch: true
+  BeforeElse: true
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+
+# Pointer / reference — middle spacing (int * p, not int* p or int *p)
+PointerAlignment: Middle
+ReferenceAlignment: Middle
+
+# Spaces
+SpaceAfterCStyleCast: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesInAngles: Never
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+
+# Return type on its own line for top-level definitions
+AlwaysBreakAfterReturnType: TopLevelDefinitions
+
+# Template declarations break to their own line
+AlwaysBreakTemplateDeclarations: Yes
+
+# Constructor initialiser lists
+BreakConstructorInitializers: BeforeColon
+ConstructorInitializerIndentWidth: 2
+
+# Short constructs
+AllowShortBlocksOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: Inline
+AllowShortLoopsOnASingleLine: false
+
+# Argument / parameter packing
+AlignAfterOpenBracket: Align
+BinPackArguments: false
+BinPackParameters: false
+
+# Alignment
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignOperands: Align
+AlignTrailingComments: true
+
+# Includes — preserve user ordering
+SortIncludes: Never
+IncludeBlocks: Preserve
+
+# Blank lines
+MaxEmptyLinesToKeep: 1
+KeepEmptyLinesAtTheStartOfBlocks: false

nmhit-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,98 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  # ── Python binding build + test (editable install, fast feedback) ────────────
+  python:
+    name: "Python ${{ matrix.python-version }} / ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15]
+        python-version: ["3.9", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install build and test dependencies
+        run: pip install scikit-build-core nanobind pytest
+
+      - name: Build and install (editable, no isolation)
+        run: pip install -e . --no-build-isolation -v
+
+      - name: Run Python tests
+        run: pytest python/tests/ -v
+
+  # ── Wheel + sdist packaging check (native arch only, no cross-compilation) ───
+  package:
+    name: "Package / ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build wheel (native arch)
+        uses: pypa/cibuildwheel@v2.19
+        env:
+          CIBW_BUILD: "cp39-*"
+          CIBW_SKIP:  "*-musllinux* *-manylinux_i686"
+          CIBW_ARCHS_LINUX: "x86_64"
+          CIBW_ARCHS_MACOS: "native"
+          CIBW_MANYLINUX_X86_64_IMAGE: manylinux_2_28
+          CIBW_TEST_REQUIRES: "pytest"
+          CIBW_TEST_COMMAND:  "pytest {project}/python/tests/ -v"
+
+  # ── Source distribution build check ─────────────────────────────────────────
+  sdist:
+    name: "Source distribution"
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build sdist
+        run: |
+          pip install build
+          python -m build --sdist
+
+  # ── C++ library tests (unmodified by Python changes) ────────────────────────
+  cpp:
+    name: "C++ / ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure
+        run: >
+          cmake -S . -B build
+          -DCMAKE_BUILD_TYPE=Release
+          -DNMHIT_BUILD_PYTHON=OFF
+
+      - name: Build
+        run: cmake --build build -j$(nproc 2>/dev/null || sysctl -n hw.ncpu)
+
+      - name: Test
+        run: ctest --test-dir build --output-on-failure

nmhit-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  # ── Build wheels (Linux + macOS) ─────────────────────────────────────────────
+  build-wheels:
+    name: "Wheels / ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up QEMU (Linux arm64 cross-build)
+        if: matrix.os == 'ubuntu-24.04'
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: arm64
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.19
+        env:
+          # STABLE_ABI: cp39-* produces one abi3 wheel covering Python 3.9+
+          CIBW_BUILD: "cp39-*"
+          CIBW_SKIP:  "*-musllinux* *-manylinux_i686"
+          CIBW_ARCHS_LINUX: "x86_64 aarch64"
+          CIBW_ARCHS_MACOS: "x86_64 arm64"
+          CIBW_MANYLINUX_X86_64_IMAGE:  manylinux_2_28
+          CIBW_MANYLINUX_AARCH64_IMAGE: manylinux_2_28
+          CIBW_TEST_REQUIRES: "pytest"
+          CIBW_TEST_COMMAND:  "pytest {project}/python/tests/ -v"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: wheelhouse/*.whl
+
+  # ── Build source distribution ─────────────────────────────────────────────────
+  build-sdist:
+    name: "Source distribution"
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build sdist
+        run: |
+          pip install build
+          python -m build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  # ── Publish to PyPI via OIDC trusted publishing ───────────────────────────────
+  publish:
+    name: "Publish to PyPI"
+    needs: [build-wheels, build-sdist]
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nmhit
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist/
+          merge-multiple: true
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No API token needed — configure Trusted Publishing once on pypi.org:
+        # Publisher: GitHub Actions, repo: <owner>/nmhit, workflow: release.yml,
+        # environment: pypi

nmhit-0.1.0/.gitignore

@@ -0,0 +1,38 @@
+# Cache directories
+.cache/
+
+# Build directories
+build/
+build-*/
+
+# CMake generated files
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake
+install_manifest.txt
+CTestTestfile.cmake
+
+# Compiled objects and libraries
+*.o
+*.a
+*.so
+*.so.*
+*.dylib
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Python packaging
+dist/
+*.egg-info/
+__pycache__/
+*.pyc
+*.pyi
+
+# scikit-build-core build directory
+_skbuild/

nmhit-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v19.1.7
+    hooks:
+      - id: clang-format
+        # Only format hand-written C++ — skip generated/ and Flex/Bison sources.
+        files: ^(src/|include/|tests/|python/src/).+\.(cpp|h)$

nmhit-0.1.0/CMakeLists.txt

@@ -0,0 +1,181 @@
+cmake_minimum_required(VERSION 3.20)
+project(neml2-hit VERSION 0.1.0 LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# ── Flex + Bison ───────────────────────────────────────────────────────────────
+# Debug builds regenerate the parser/lexer from source (flex + bison required).
+# All other build types (Release, RelWithDebInfo, MinSizeRel, …) use the
+# pre-generated files committed to generated/ and need no flex or bison.
+
+if(CMAKE_BUILD_TYPE STREQUAL "Debug" OR NOT CMAKE_BUILD_TYPE)
+  find_package(FLEX 2.6 REQUIRED)
+  find_package(BISON 3.7 REQUIRED)
+
+  FLEX_TARGET(
+    HITLexer
+    src/Lexer.l
+    ${CMAKE_CURRENT_BINARY_DIR}/Lexer.cpp
+    DEFINES_FILE ${CMAKE_CURRENT_BINARY_DIR}/Lexer.h
+  )
+
+  BISON_TARGET(
+    HITParser
+    src/Parser.y
+    ${CMAKE_CURRENT_BINARY_DIR}/Parser.cpp
+    DEFINES_FILE ${CMAKE_CURRENT_BINARY_DIR}/Parser.h
+  )
+
+  ADD_FLEX_BISON_DEPENDENCY(HITLexer HITParser)
+
+  set(_parser_sources
+    ${FLEX_HITLexer_OUTPUTS}
+    ${BISON_HITParser_OUTPUTS}
+  )
+  set(_parser_include_dir ${CMAKE_CURRENT_BINARY_DIR})
+
+  # Helper target: copy freshly-generated files back to generated/ for committing.
+  add_custom_target(update_generated
+    COMMAND ${CMAKE_COMMAND} -E copy
+      ${CMAKE_CURRENT_BINARY_DIR}/Lexer.cpp
+      ${CMAKE_CURRENT_BINARY_DIR}/Lexer.h
+      ${CMAKE_CURRENT_BINARY_DIR}/Parser.cpp
+      ${CMAKE_CURRENT_BINARY_DIR}/Parser.h
+      ${CMAKE_CURRENT_BINARY_DIR}/location.hh
+      ${CMAKE_CURRENT_SOURCE_DIR}/generated/
+    DEPENDS
+      ${FLEX_HITLexer_OUTPUTS}
+      ${BISON_HITParser_OUTPUTS}
+    COMMENT "Copying generated parser/lexer files to generated/"
+  )
+else()
+  set(_parser_sources
+    ${CMAKE_CURRENT_SOURCE_DIR}/generated/Lexer.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/generated/Lexer.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/generated/Parser.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/generated/Parser.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/generated/location.hh
+  )
+  set(_parser_include_dir ${CMAKE_CURRENT_SOURCE_DIR}/generated)
+endif()
+
+# ── library ───────────────────────────────────────────────────────────────────
+
+add_library(nmhit
+  ${_parser_sources}
+  src/Node.cpp
+  src/BraceExpr.cpp
+)
+
+target_include_directories(nmhit
+  PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:include>
+  PRIVATE
+    src
+    ${_parser_include_dir}
+)
+
+target_compile_options(nmhit PRIVATE -Wall -Wextra -Wno-unused-parameter)
+
+# ── install ───────────────────────────────────────────────────────────────────
+# C++ library install rules are skipped when building the Python wheel so that
+# headers, CMake config files, and pkg-config files don't end up inside the wheel.
+
+if(NOT NMHIT_BUILD_PYTHON)
+  include(CMakePackageConfigHelpers)
+
+  install(TARGETS nmhit
+    EXPORT nmhitTargets
+    ARCHIVE DESTINATION lib
+    LIBRARY DESTINATION lib
+    RUNTIME DESTINATION bin
+  )
+
+  install(DIRECTORY include/
+    DESTINATION include
+  )
+
+  configure_package_config_file(
+    cmake/nmhitConfig.cmake.in
+    ${CMAKE_CURRENT_BINARY_DIR}/nmhitConfig.cmake
+    INSTALL_DESTINATION lib/cmake/nmhit
+  )
+
+  write_basic_package_version_file(
+    ${CMAKE_CURRENT_BINARY_DIR}/nmhitConfigVersion.cmake
+    VERSION ${PROJECT_VERSION}
+    COMPATIBILITY SameMajorVersion
+  )
+
+  install(EXPORT nmhitTargets
+    FILE nmhitTargets.cmake
+    NAMESPACE nmhit::
+    DESTINATION lib/cmake/nmhit
+  )
+
+  install(FILES
+    ${CMAKE_CURRENT_BINARY_DIR}/nmhitConfig.cmake
+    ${CMAKE_CURRENT_BINARY_DIR}/nmhitConfigVersion.cmake
+    DESTINATION lib/cmake/nmhit
+  )
+
+  configure_file(
+    cmake/nmhit.pc.in
+    ${CMAKE_CURRENT_BINARY_DIR}/nmhit.pc
+    @ONLY
+  )
+
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/nmhit.pc
+    DESTINATION lib/pkgconfig
+  )
+endif()
+
+# ── tests ──────────────────────────────────────────────────────────────────────
+
+option(NMHIT_BUILD_TESTS "Build nmhit unit tests" ON)
+if(NMHIT_BUILD_TESTS)
+  enable_testing()
+  add_subdirectory(tests)
+endif()
+
+# ── Python bindings (nanobind) ─────────────────────────────────────────────────
+# Enabled by scikit-build-core via -DNMHIT_BUILD_PYTHON=ON.
+# Release builds use the pre-generated parser/lexer in generated/ so flex and
+# bison are not required on the wheel-build host.
+
+option(NMHIT_BUILD_PYTHON "Build Python bindings via nanobind" OFF)
+if(NMHIT_BUILD_PYTHON)
+  find_package(Python 3.9 REQUIRED COMPONENTS Interpreter Development.Module)
+
+  # Locate nanobind's CMake integration through the Python interpreter.
+  # scikit-build-core installs nanobind into the build venv so it is findable
+  # via `python -m nanobind --cmake_dir`.
+  execute_process(
+    COMMAND "${Python_EXECUTABLE}" -m nanobind --cmake_dir
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    OUTPUT_VARIABLE _NB_CMAKE_DIR
+    RESULT_VARIABLE _NB_RESULT
+  )
+  if(NOT _NB_RESULT EQUAL 0)
+    message(FATAL_ERROR "Could not locate nanobind CMake directory. "
+                        "Install it with: pip install nanobind")
+  endif()
+  list(APPEND CMAKE_PREFIX_PATH "${_NB_CMAKE_DIR}")
+  find_package(nanobind CONFIG REQUIRED)
+
+  nanobind_add_module(
+    _nmhit
+    STABLE_ABI  # Py_LIMITED_API=0x03090000: one .so covers Python 3.9+
+    NB_STATIC   # embed nanobind runtime; wheel is self-contained
+    python/src/_nmhit.cpp
+  )
+
+  target_link_libraries(_nmhit PRIVATE nmhit)
+
+  # Install into the nmhit/ subdirectory inside the wheel.
+  # scikit-build-core picks this up via wheel.packages = ["python/nmhit"].
+  install(TARGETS _nmhit DESTINATION nmhit)
+endif()

nmhit-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing to neml2-hit
+
+## Setting up your development environment
+
+### 1. Clone and configure a Debug build
+
+Flex ≥ 2.6 and Bison ≥ 3.7 are required for Debug builds; they regenerate
+`generated/Lexer.cpp` and `generated/Parser.cpp` from source.
+
+```bash
+git clone <repo-url>
+cd neml2-hit
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
+cmake --build build -j$(nproc)
+```
+
+### 2. Set up the Python bindings (optional)
+
+If you are working on `python/src/_nmhit.cpp` or `python/nmhit/__init__.py`,
+install the package in editable mode after the CMake build:
+
+```bash
+pip install scikit-build-core nanobind pytest   # build deps + test runner
+pip install -e . --no-build-isolation -v        # editable install
+pytest python/tests/ -v                         # run Python tests
+```
+
+`--no-build-isolation` skips the PEP 517 build venv and uses the already-installed
+`scikit-build-core` and `nanobind` packages directly, which avoids re-downloading them.
+scikit-build-core places its own CMake build in `_skbuild/` (separate from any `build/`
+you may have created for C++ development).
+Re-run `pip install -e . --no-build-isolation -v` whenever you change the C++ binding source.
+
+### 3. Install the pre-commit hook
+
+The project uses [pre-commit](https://pre-commit.com) to run `clang-format`
+automatically before every commit.  Install it once after cloning:
+
+```bash
+pip install pre-commit   # or: conda install pre-commit
+pre-commit install
+```
+
+From that point on, `clang-format` runs automatically on staged `*.cpp` and
+`*.h` files under `src/`, `include/`, and `tests/`.  Generated files in
+`generated/` and the Flex/Bison sources (`src/Lexer.l`, `src/Parser.y`) are
+intentionally excluded — no formatter exists for those file types.
+
+To run the hook manually across the whole tree:
+
+```bash
+pre-commit run --all-files
+```
+
+---
+
+## Development workflow
+
+### Editing C++ source only
+
+Make changes to `src/Node.cpp`, `src/BraceExpr.cpp`, `src/ParseDriver.h`,
+the public headers under `include/`, or the Python binding source at
+`python/src/_nmhit.cpp`, then rebuild:
+
+```bash
+cmake --build build -j$(nproc)
+./build/tests/test_hit
+```
+
+### Editing the lexer or parser
+
+`src/Lexer.l` (Flex) and `src/Parser.y` (Bison) require a Debug build.  After
+editing either file, the build system regenerates the corresponding sources
+automatically:
+
+```bash
+cmake --build build -j$(nproc)   # flex/bison run here
+./build/tests/test_hit
+```
+
+Once the tests pass, copy the regenerated files back to `generated/` so that
+non-Debug (Release) builds remain self-contained without requiring flex or bison:
+
+```bash
+cmake --build build --target update_generated
+git add generated/
+```
+
+Commit the grammar/lexer source and the regenerated files together in the same
+commit so the repository is always consistent.
+
+---
+
+## Running the tests
+
+```bash
+./build/tests/test_hit          # direct binary
+# or via CTest:
+ctest --test-dir build --output-on-failure
+```
+
+---
+
+## Code style
+
+`clang-format` (version 19) enforces the style defined in `.clang-format`.
+The pre-commit hook applies it automatically; you can also run it by hand:
+
+```bash
+clang-format -i src/Node.cpp src/BraceExpr.cpp src/ParseDriver.h \
+             include/nmhit/*.h tests/test_hit.cpp python/src/_nmhit.cpp
+```