Merge branch 'MikePopoloski:master' into master

Author: KitaevKN

.clang-tidy

@@ -14,6 +14,9 @@ Checks: >
     -modernize-use-emplace,
     -modernize-return-braced-init-list,
     -modernize-loop-convert,
+    -modernize-use-designated-initializers,
+    -modernize-use-ranges,
+    -modernize-use-integer-sign-comparison,
     -bugprone-suspicious-semicolon,
     -bugprone-branch-clone,
     -bugprone-sizeof-expression,
@@ -23,6 +26,8 @@ Checks: >
     -bugprone-unchecked-optional-access,
     -bugprone-assignment-in-if-condition,
     -bugprone-switch-missing-default-case,
+    -bugprone-suspicious-stringview-data-usage,
+    -bugprone-return-const-ref-from-parameter,
     -clang-analyzer-cplusplus.NewDelete*,
     -clang-analyzer-cplusplus.InnerPointer,
     -clang-analyzer-core.NullDereference,
@@ -36,6 +41,9 @@ Checks: >
     -misc-use-anonymous-namespace,
     -misc-include-cleaner,
     -misc-header-include-cycle,
+    -misc-use-internal-linkage,
     -performance-no-int-to-ptr,
     -performance-enum-size,
-    -portability-simd-intrinsics
+    -portability-simd-intrinsics,
+    -portability-template-virtual-member-function,
+    -performance-unnecessary-value-param

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,6 +7,9 @@ assignees: ''
 
 ---
 
+**Is your bug report related to the C++ slang project or the pyslang Python bindings?**
+C++ slang / Pyslang Python bindings
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,6 +7,9 @@ assignees: ''
 
 ---
 
+**Is your feature request related to the C++ slang project or the pyslang Python bindings?**
+C++ slang / Pyslang Python bindings
+
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is.
 

.github/copilot-instructions.md

@@ -0,0 +1,37 @@
+This project is a SystemVerilog compiler and set of related tools, developed in C++.
+Code in the repository is expected to be extremely high quality, with a focus on performance and correctness.
+Please follow the instructions below to ensure that your contributions meet these standards.
+
+## Development Flow
+cmake is used to build the project. The following commands are used to build and run the tests:
+```bash
+cmake -B build
+cmake --build build -j8
+ctest --test-dir build --output-on-failure
+```
+
+## Code Style
+Please follow the style of the existing code. Modern C++ features, up to C++ 20, are preferred, and the code should
+be written in a way that is easy to read and understand.
+
+`pre-commit` is used to enforce formatting prior to committing. It should be installed and configured to run
+automatically on commit.
+
+## Guidelines
+1. Follow C++ best practices and idiomatic patterns
+2. Maintain existing code structure and organization
+3. Write unit tests for new functionality.
+4. Document public APIs and complex logic.
+    - API reference documentation is added via Doxygen comments.
+    - More in-depth documentation is added via Markdown files in the `docs` directory.
+
+## Python Bindings
+This project includes Python bindings fsor the main library. These bindings are generated using pybind11.
+When adding to or changing the public API, consider updating the Python bindings as well.
+The bindings are located in the `bindings/python` directory. The tests and documentation for the Python bindings
+are in the 'pyslang' folder. The bindings are built using CMake, and the following commands
+are used to build and run the tests:
+```bash
+pip install . --no-build-isolation --config-settings build-dir=build/python_build
+pytest
+```

.github/workflows/build.yml

@@ -1,6 +1,7 @@
 name: CI Build
 
 on:
+  workflow_dispatch:
   push:
     branches: [ master ]
   pull_request:
@@ -15,7 +16,7 @@ jobs:
           - preset: clang-sanitize
             os: ubuntu-latest
           - preset: gcc-release
-            os: ubuntu-latest
+            os: ubuntu-24.04-arm
           - preset: gcc-11-release
             os: ubuntu-latest
           - preset: gcc-debug-shared
@@ -40,78 +41,19 @@ jobs:
       if: matrix.os == 'ubuntu-latest'
       run: |
         wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
-        sudo add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main"
+        sudo add-apt-repository "deb http://apt.llvm.org/noble/ llvm-toolchain-noble-20 main"
         sudo add-apt-repository ppa:ubuntu-toolchain-r/test
         sudo apt-get update
-        sudo apt-get install -y g++-13 g++-11 clang-18 clang-tidy-18
+        sudo apt-get install -y g++-14 g++-11 clang-20 clang-tidy-20
     - uses: ilammy/msvc-dev-cmd@v1
       if: matrix.os == 'windows-latest'
     - uses: maxim-lobanov/setup-xcode@v1
       if: matrix.os == 'macos-latest'
       with:
         xcode-version: 'latest'
     - name: Configure
-      run: cmake --preset ${{ matrix.preset }} -DSLANG_CI_BUILD=ON
+      run: cmake --preset ${{ matrix.preset }} -DSLANG_CI_BUILD=ON -DSLANG_INCLUDE_UVM_TEST=ON
     - name: Build
       run: cmake --build build/${{ matrix.preset }} -j8
     - name: Run tests
       run: ctest --test-dir build/${{ matrix.preset }} --output-on-failure --no-tests=error -j8
-
-  linux-coverage:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Install dependencies
-      run: |
-        sudo add-apt-repository ppa:ubuntu-toolchain-r/test
-        sudo apt-get update
-        sudo apt-get install -y g++-13 lcov
-    - name: Configure
-      run: cmake --preset=ci-coverage
-    - name: Build
-      run: cmake --build build/ci-coverage -j8
-    - name: Run tests
-      run: ctest --test-dir build/ci-coverage --output-on-failure --no-tests=error -j8
-    - name: Process coverage info
-      run: cmake --build build/ci-coverage -t coverage
-    - name: Submit to codecov.io
-      uses: codecov/codecov-action@v4
-      with:
-        files: build/ci-coverage/coverage.info
-        token: ${{ secrets.CODECOV_TOKEN }}
-        verbose: true
-
-  bindings:
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - uses: ilammy/msvc-dev-cmd@v1
-    - name: Configure
-      run: cmake -B build -DSLANG_INCLUDE_PYLIB=ON
-    - name: Build
-      run: cmake --build build --config Release -j8
-    - name: Run tests
-      run: ctest --test-dir build --output-on-failure -C Release --no-tests=error -j8
-
-  conan:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Install dependencies
-      run: |
-        pip3 install conan
-        conan profile detect
-    - name: Configure
-      run: |
-        conan install . -b missing
-        cmake --preset conan-gcc-x86_64-release
-    - name: Build
-      run: cmake --build --preset conan-gcc-x86_64-release -j8
-    - name: Run tests
-      run: ctest --preset conan-gcc-x86_64-release --output-on-failure --no-tests=error -j8

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,35 @@
+name: "Copilot Setup Steps"
+
+# Allow testing of the setup steps from your repository's "Actions" tab.
+on: workflow_dispatch
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
+      contents: read
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest pre-commit pybind11 scikit-build-core
+          pre-commit install
+          pre-commit run
+
+      - name: Configure and Build
+        run: |
+          cmake -B build
+          cmake --build build -j8

.github/workflows/coverage.yml

@@ -0,0 +1,43 @@
+name: Coverage
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  linux-coverage:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Install dependencies
+      run: |
+        sudo add-apt-repository ppa:ubuntu-toolchain-r/test
+        sudo apt-get update
+        sudo apt-get install -y g++-14
+        wget --quiet https://github.com/linux-test-project/lcov/releases/download/v2.3/lcov-2.3.tar.gz
+        tar -xf lcov-2.3.tar.gz
+        cd lcov-2.3
+        sudo make install
+        sudo cpan App::cpanminus
+        sudo cpanm --notest Capture::Tiny DateTime
+    - name: Configure
+      run: cmake --preset=ci-coverage
+    - name: Build
+      run: cmake --build build/ci-coverage -j8
+    - name: Run tests
+      run: ctest --test-dir build/ci-coverage --output-on-failure --no-tests=error -j8
+    - name: Process coverage info
+      run: cmake --build build/ci-coverage -t coverage
+    - name: Submit to codecov.io
+      uses: codecov/codecov-action@v5
+      with:
+        files: build/ci-coverage/coverage.info
+        plugins: noop
+        disable_search: true
+        token: ${{ secrets.CODECOV_TOKEN }}
+        verbose: true

.github/workflows/docs.yml

@@ -1,4 +1,5 @@
 name: docs
+description: Build and deploy documentation (both C++/slang and Python/pyslang)
 
 on:
   push:
@@ -14,19 +15,31 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+    - name: Install Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
     - name: Install dependencies
       run: |
-        pip install jinja2 pygments
-        wget https://sourceforge.net/projects/doxygen/files/rel-1.9.5/doxygen-1.9.5.linux.bin.tar.gz
-        tar -xvf doxygen-1.9.5.linux.bin.tar.gz
-        cp doxygen-1.9.5/bin/doxygen /usr/local/bin
-    - name: Build
+        pip install jinja2 pygments docutils
+        wget --quiet https://sourceforge.net/projects/doxygen/files/rel-1.13.2/doxygen-1.13.2.linux.bin.tar.gz
+        tar -xf doxygen-1.13.2.linux.bin.tar.gz
+        cp doxygen-1.13.2/bin/doxygen /usr/local/bin
+    - name: Build slang and pyslang docs via CMake
       run: |
         cmake -B build -DSLANG_INCLUDE_DOCS=ON -DSLANG_INCLUDE_TESTS=OFF
         cmake --build build --target docs -j8
+    - name: Compress docs artifacts
+      run: |
         tar -czvf slang.tar.gz build/docs build/bin/slang
+    - name: Upload artifact for preview
+      uses: actions/upload-artifact@v4
+      with:
+        name: slang-docs
+        path: slang.tar.gz
+        retention-days: 4
     - name: Upload
-      if: github.event_name != 'pull_request'
+      if: github.event_name != 'pull_request' && github.repository == 'MikePopoloski/slang'
       uses: appleboy/scp-action@master
       with:
         host: ${{ secrets.SSH_DEPLOY_HOST }}
@@ -37,7 +50,7 @@ jobs:
         source: slang.tar.gz
         target: upload/
     - name: Deploy
-      if: github.event_name != 'pull_request'
+      if: github.event_name != 'pull_request' && github.repository == 'MikePopoloski/slang'
       uses: appleboy/ssh-action@master
       with:
         host: ${{ secrets.SSH_DEPLOY_HOST }}

.github/workflows/python-build.yml

@@ -0,0 +1,37 @@
+name: "Python Build"
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build with Pip
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [windows-latest, macos-latest, ubuntu-latest]
+        python-version: ["3.11", "pypy-3.9"]
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: maxim-lobanov/setup-xcode@v1
+      if: matrix.platform == 'macos-latest'
+      with:
+        xcode-version: 'latest'
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+    - name: Build and install
+      run: pip install --verbose .
+    - name: Test
+      run: pytest