[
{
"path": ".editorconfig",
"content": "root = true\n\n[*]\nend_of_line = lf\ninsert_final_newline = true\n\n# Matches multiple files with brace expansion notation\n[*.{cc,hh}]\ncharset = utf-8\nindent_style = tab\nindent_size = 3\ntrim_trailing_whitespace = true\n\n"
},
{
"path": ".gitattributes",
"content": "*.hh linguist-language=C++\n*.cc linguist-language=C++\nlibs/** linguist-vendored"
},
{
"path": ".github/workflows/appimage-modern.yml",
"content": "# Modern AppImage build using AppImageBuilder\n# Supports both x86_64 and arm64 architectures on current GitHub runners\n# Uses Ubuntu 22.04 base for maximum compatibility\n\nname: AppImage (Modern)\n\non:\n release:\n types: [created]\n # Uncomment for testing\n #push:\n # branches: [devel]\n\njobs:\n build:\n name: AppImage ${{ matrix.arch }}\n\n strategy:\n fail-fast: false\n matrix:\n include:\n - arch: x86_64\n os: ubuntu-24.04\n ubuntu_arch: amd64\n appimage_arch: x86_64\n repo: http://archive.ubuntu.com/ubuntu/\n - arch: arm64\n os: ubuntu-24.04-arm\n ubuntu_arch: arm64\n appimage_arch: aarch64\n repo: http://ports.ubuntu.com/ubuntu-ports/\n\n runs-on: ${{ matrix.os }}\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n\n - name: Install AppImageBuilder\n run: |\n sudo apt update\n sudo apt install -y python3-pip\n\n - name: Clean up any existing AppDir\n run: |\n sudo rm -rf AppDir || true\n\n - name: Create AppImageBuilder recipe\n run: |\n cat > AppImageBuilder.yml << 'EOF'\n version: 1\n\n script:\n - mkdir -p AppDir\n\n AppDir:\n path: ./AppDir\n app_info:\n id: science.cadabra.cadabra2-gtk\n name: Cadabra2\n icon: cadabra2-gtk\n version: latest\n exec: usr/bin/cadabra2-gtk\n exec_args: $@\n\n apt:\n arch: ${{ matrix.ubuntu_arch }}\n sources:\n - sourceline: deb ${{ matrix.repo }} jammy main universe\n key_url: 'http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x871920D1991BC93C'\n - sourceline: deb ${{ matrix.repo }} jammy-updates main universe\n key_url: 'http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x871920D1991BC93C'\n\n include:\n # Core system libraries\n - libc6\n - libstdc++6\n - libgcc-s1\n\n # Shell interpreters\n - bash\n - dash\n - perl-base\n \n # Cadabra dependencies\n - libgmp10\n - libgmpxx4ldbl\n - libboost-system1.74.0\n - libboost-filesystem1.74.0\n - libboost-program-options1.74.0\n - libboost-date-time1.74.0\n - libsqlite3-0\n - uuid-runtime\n - libssl3\n - libtbb12\n\n # GTK and GUI dependencies\n - libgtkmm-3.0-1v5\n - libgtk-3-0\n - libgdk-pixbuf2.0-0\n - libcairo2\n - libpango-1.0-0\n - libpangocairo-1.0-0\n - libatk1.0-0\n - libglib2.0-0\n - librsvg2-common\n - adwaita-icon-theme\n - hicolor-icon-theme\n - libwayland-client0\n - libwayland-cursor0\n - libwayland-egl1-mesa\n \n # Python dependencies (Ubuntu 22.04 uses Python 3.10)\n - python3.10\n - libpython3.10\n - python3-pip\n - python3-gmpy2\n\n exclude:\n - adwaita-icon-theme-full\n - humanity-icon-theme\n - ubuntu-mono\n\n files:\n exclude:\n - usr/lib/python*/site-packages/pip*\n - usr/lib/python*/site-packages/setuptools*\n - usr/share/doc\n - usr/share/man\n - usr/share/locale\n - var/cache\n - var/lib/apt\n - etc/apt\n\n runtime:\n env:\n PATH: '${APPDIR}/usr/bin:${PATH}'\n PYTHONHOME: '${APPDIR}/usr'\n PYTHONPATH: '${APPDIR}/usr/lib/python3.10/site-packages:${APPDIR}/usr/lib/python3.10:${APPDIR}/usr/lib/python3.10/dist-packages'\n LD_LIBRARY_PATH: '${APPDIR}/usr/lib:${APPDIR}/usr/lib/${{ matrix.arch }}-linux-gnu:${LD_LIBRARY_PATH}'\n LC_ALL: C.UTF-8\n LANG: C.UTF-8\n\n AppImage:\n update-information: gh-releases-zsync|kpeeters|cadabra2|latest|Cadabra*${{ matrix.arch }}.AppImage.zsync\n sign-key: None\n arch: ${{ matrix.appimage_arch }}\n comp: gzip\n EOF\n\n - name: Build Cadabra2 in container\n run: |\n # Use Docker to build for the target architecture with Ubuntu 22.04\n docker run --rm --privileged \\\n --platform linux/${{ matrix.arch }} \\\n -v $PWD:/workspace \\\n -w /workspace \\\n ubuntu:22.04 /bin/bash -c \"\n # Stop on error inside the Docker container\n set -e\n \n # Install dependencies\n apt update\n DEBIAN_FRONTEND=noninteractive apt install -y \\\n build-essential cmake git \\\n python3-dev python3-pip g++ \\\n libgmp3-dev libgtkmm-3.0-dev \\\n libboost-all-dev libssl-dev \\\n libsqlite3-dev uuid-dev \\\n python3-matplotlib python3-sympy \\\n python3-gmpy2 python3-numpy \\\n squashfs-tools file desktop-file-utils fakeroot strace patchelf zsync\n\n # Install directly from the main branch of the appimage-builder repository,\n # to deal with the issue reported in\n # https://github.com/AppImageCrafters/appimage-builder/pull/281\n pip3 install git+https://github.com/AppImageCrafters/appimage-builder.git@main\n\n # Patch mpmath (bug fixed only in ubuntu-22.04)\n # sed -i \\\"s/if other is 0:/if other == 0:/g\\\" /usr/lib/python3/dist-packages/mpmath/ctx_mp_python.py\n # cat /usr/lib/python3/dist-packages/mpmath/ctx_mp_python.py\n \n # Build Cadabra2\n git config --global --add safe.directory /workspace\n mkdir -p build\n cd build\n cmake -DCMAKE_INSTALL_PREFIX=/usr \\\n -DCMAKE_BUILD_TYPE=Release \\\n -DENABLE_MATHEMATICA=OFF \\\n -DAPPIMAGE_MODE=ON \\\n ..\n\n VERSION=\\$(cat /workspace/build/VERSION)\n echo \\\"Building version \\${VERSION}\\\"\n\n make -j\\$(nproc)\n make install DESTDIR=/workspace/build/AppDir\n make test\n \n # Install Python packages directly into the AppDir after 'make install'\n # Ensure the target path is correct for your AppDir's Python installation\n pip3 install --target=/workspace/build/AppDir/usr/lib/python3.10/site-packages --upgrade mpmath>=1.2.0\n pip3 install --target=/workspace/build/AppDir/usr/lib/python3.10/site-packages astunparse\n pip3 install --target=/workspace/build/AppDir/usr/lib/python3.10/site-packages pillow sympy matplotlib numpy\n\n # Update version in AppImageBuilder.yml\n sed -i \\\"s/version: latest/version: \\${VERSION}/\\\" /workspace/AppImageBuilder.yml\n\n # Build the AppImage\n echo \\\"Now going to run appimage-builder, using:\\\"\n echo \\\"---------\\\"\n cat /workspace/AppImageBuilder.yml\n echo \\\"---------\\\"\n echo \\\"Here we go...\\\"\n appimage-builder --recipe /workspace/AppImageBuilder.yml --skip-test\n echo \\\"This is /workspace/build/AppDir/usr/bin/ :\\\"\n echo \\\"---------\\\"\n ls -la /workspace/build/AppDir/usr/bin/\n echo \\\"---------\\\"\n \"\n\n - name: Rename AppImage\n run: |\n VERSION=`cat build/VERSION`\n sudo chown runner:docker build -R\n\n # Find and rename the AppImage\n ls -la .\n APPIMAGE_FILE=$(find . -name \"*.AppImage\" -type f | head -n 1)\n if [ -n \"$APPIMAGE_FILE\" ]; then\n mv \"$APPIMAGE_FILE\" \"Cadabra_${VERSION}_${{ matrix.arch }}.AppImage\"\n chmod +x \"Cadabra_${VERSION}_${{ matrix.arch }}.AppImage\"\n fi\n\n - name: Upload artifacts\n uses: actions/upload-artifact@v4\n with:\n name: cadabra2-appimage-${{ matrix.arch }}\n path: Cadabra_*_${{ matrix.arch }}.AppImage\n retention-days: 7\n\n - name: Upload to release\n if: github.event_name == 'release'\n run: |\n gh release upload \"${{ github.ref_name }}\" Cadabra_*_${{ matrix.arch }}.AppImage --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n# - name: Generate zsync file\n# if: github.event_name == 'release'\n# run: |\n# # Install zsync\n# sudo apt install -y zsync\n# \n# # Generate zsync file for the AppImage\n# APPIMAGE_FILE=$(find . -name \"Cadabra_*_${{ matrix.arch }}.AppImage\" -type f | head -n 1)\n# if [ -n \\\"$APPIMAGE_FILE\\\" ]; then\n# zsyncmake \\\"$APPIMAGE_FILE\\\"\n# \n# # Upload zsync file to release\n# gh release upload ${{ github.ref_name }} *.zsync --clobber || true\n# fi\n# env:\n# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n"
},
{
"path": ".github/workflows/c++lib.yml",
"content": "# This is a build which gets triggered on every commit push, to\n# ensure that Cadabra builds as c++lib. Does not yet contain any\n# tests, it just checks for build issues.\n\nname: c++lib\n\non: [push]\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n \n steps:\n - uses: actions/checkout@v3\n\n - name: get dependencies\n run: sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install git cmake python3-dev g++ libpcre3 libpcre3-dev libgmp3-dev libboost-all-dev libgmp-dev libsqlite3-dev uuid-dev libmpfr-dev libmpc-dev \n\n - name: configure\n run: mkdir build-lib && cd build-lib && cmake -DBUILD_AS_CPP_LIBRARY=ON ..\n \n - name: make\n run: cd build-lib && make\n \n"
},
{
"path": ".github/workflows/docker.yml",
"content": "\n# Build docker images with a Jupyter server with Cadabra\n# kernel whenever a commit is pushed to github.\n#\n# Lint this thing with\n#\n# yq eval docker.yml\n\nname: Docker\n\n# on: [push]\n\non:\n release:\n types: [released]\n\njobs:\n build:\n runs-on: ubuntu-latest\n\n# strategy:\n# fail-fast: false\n# matrix:\n# arch:\n# - amd64\n# - arm64\n\n steps:\n - name: Prepare\n run: |\n platform=${{ matrix.platform }}\n echo \"PLATFORM_PAIR=${platform//\\//-}\" >> $GITHUB_ENV \n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@master\n\n - uses: actions/checkout@v3\n\n# - name: Exit if not on master branch\n# if: github.ref != 'refs/heads/master'\n# run: exit 1\n \n - name: Log in to Docker Hub\n uses: docker/login-action@master\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_PASSWORD }}\n\n - name: Extract metadata (tags, labels) for Docker\n id: meta\n uses: docker/metadata-action@master\n with:\n images: kpeeters/cadabra2-jupyter\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Build Docker image\n uses: docker/build-push-action@master\n with:\n platforms: linux/amd64, linux/arm64\n context: .\n file: docker/Dockerfile\n push: true\n#${{ github.ref == 'master' }}\n labels: ${{ steps.meta.outputs.labels }}\n tags: kpeeters/cadabra2-jupyter:latest\n# outputs: type=docker\n\n# - name: Upload artifact to github assets\n# uses: actions/upload-artifact@main\n# with:\n# name: cadabra2-jupyter-${{ matrix.arch }}\n# path: cadabra2-jupyter-${{ matrix.arch }}.tar\n"
},
{
"path": ".github/workflows/fedora-40-package.yml",
"content": "# Create a Fedora 40 package on a github release event.\n# This assumes that the cadabra version is the same as the\n# release name, and it will attempt to add the .rpm file\n# to the release assets.\n\nname: Fedora-40 package\n\n# on: [push]\n\non:\n release:\n types: [created]\n\njobs:\n build:\n\n strategy:\n matrix:\n include:\n - os: ubuntu-24.04\n name: x86_64\n display-name: \"Fedora 40 x86_64\"\n - os: ubuntu-24.04-arm\n name: arm64\n display-name: \"Fedora 40 arm64\"\n runs-on: ${{ matrix.os }}\n \n steps:\n - uses: actions/checkout@v3\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull Fedora image\n run: docker pull fedora:40\n\n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Build RPM in Fedora container\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n fedora:40 \\\n bash -c \" \n git config --global --add safe.directory /workspace\n dnf install -y rpm-build make gcc-c++ git python3-devel cmake gmp-devel libuuid-devel sqlite-devel openssl-devel gtkmm30-devel boost-devel python3-matplotlib python3-pip \n pip3 install sympy \n mkdir build \n cd build \n cmake -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr .. \n make \n cpack \n \"\n\n - name: Set version variables from output of cmake\n run: |\n VER=$(cat ${{ github.workspace }}/build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n\n - name: Upload Release Assets\n run: |\n gh release upload \"${{ env.VERSION }}\" build/cadabra2-${{ env.VERSION }}-fedora40-${{ matrix.name }}.rpm --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n test:\n needs: build\n runs-on: ubuntu-24.04\n \n steps:\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull Fedora image\n run: docker pull fedora:40\n\n - name: Download package and run inside Fedora container\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n fedora:40 \\\n bash -c \" \n dnf install -y xorg-x11-server-Xvfb wget curl jq\n export VERSION=\\$(curl -s https://api.github.com/repos/kpeeters/cadabra2/releases|& jq .[0].tag_name -r)\n export RPMNAME=cadabra2-\\${VERSION}-fedora40-x86_64.rpm\n wget https://github.com/kpeeters/cadabra2/releases/download/\\${VERSION}/\\${RPMNAME}\n dnf install -y \\${RPMNAME}\n printf 'import sys\\nprint(sys.path)\\nimport cdb.main\\nex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n' > tst.cdb\n cadabra2 tst.cdb\n \n xvfb-run -a cadabra2-gtk &\n APP_PID=\\$!\n sleep 10\n if kill -0 \\$APP_PID 2>/dev/null; then\n echo 'cadabra2-gtk started successfully'\n kill \\$APP_PID\n exit 0\n else\n echo 'cadabra2-gtk failed to start'\n exit 1\n fi\n \"\n"
},
{
"path": ".github/workflows/fedora-41-package.yml",
"content": "# Create a Fedora 41 package on a github release event.\n# This assumes that the cadabra version is the same as the\n# release name, and it will attempt to add the .rpm file\n# to the release assets.\n\nname: Fedora-41 package\n\n# on: [push]\n\non:\n release:\n types: [created]\n\njobs:\n build:\n\n strategy:\n matrix:\n include:\n - os: ubuntu-24.04\n name: x86_64\n display-name: \"Fedora 41 x86_64\"\n - os: ubuntu-24.04-arm\n name: arm64\n display-name: \"Fedora 41 arm64\"\n runs-on: ${{ matrix.os }}\n \n steps:\n - uses: actions/checkout@v3\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull Fedora image\n run: docker pull fedora:41\n\n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Build RPM in Fedora container\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n fedora:41 \\\n bash -c \" \n git config --global --add safe.directory /workspace\n dnf install -y rpm-build make gcc-c++ git python3-devel cmake gmp-devel libuuid-devel sqlite-devel openssl-devel gtkmm30-devel boost-devel python3-matplotlib python3-pip \n pip3 install sympy \n mkdir build \n cd build \n cmake -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr .. \n make \n cpack \n \"\n\n - name: Set version variables from output of cmake\n run: |\n VER=$(cat ${{ github.workspace }}/build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n\n - name: Upload Release Assets\n run: |\n gh release upload \"${{ env.VERSION }}\" build/cadabra2-${{ env.VERSION }}-fedora41-${{ matrix.name }}.rpm --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n test:\n needs: build\n runs-on: ubuntu-24.04\n \n steps:\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull Fedora image\n run: docker pull fedora:41\n\n - name: Download package and run inside Fedora container\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n fedora:41 \\\n bash -c \" \n dnf install -y xorg-x11-server-Xvfb wget curl jq\n export VERSION=\\$(curl -s https://api.github.com/repos/kpeeters/cadabra2/releases|& jq .[0].tag_name -r)\n export RPMNAME=cadabra2-\\${VERSION}-fedora41-x86_64.rpm\n wget https://github.com/kpeeters/cadabra2/releases/download/\\${VERSION}/\\${RPMNAME}\n dnf install -y \\${RPMNAME}\n printf 'import sys\\nprint(sys.path)\\nimport cdb.main\\nex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n' > tst.cdb\n cadabra2 tst.cdb\n \n xvfb-run -a cadabra2-gtk &\n APP_PID=\\$!\n sleep 10\n if kill -0 \\$APP_PID 2>/dev/null; then\n echo 'cadabra2-gtk started successfully'\n kill \\$APP_PID\n exit 0\n else\n echo 'cadabra2-gtk failed to start'\n exit 1\n fi\n \"\n"
},
{
"path": ".github/workflows/fedora-42-package.yml",
"content": "# Create a Fedora 41 package on a github release event.\n# This assumes that the cadabra version is the same as the\n# release name, and it will attempt to add the .rpm file\n# to the release assets.\n\nname: Fedora-42 package\n\n# on: [push]\n\non:\n release:\n types: [created]\n\njobs:\n build:\n\n strategy:\n matrix:\n include:\n - os: ubuntu-24.04\n name: x86_64\n display-name: \"Fedora 42 x86_64\"\n - os: ubuntu-24.04-arm\n name: arm64\n display-name: \"Fedora 42 arm64\"\n runs-on: ${{ matrix.os }}\n \n steps:\n - uses: actions/checkout@v3\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull Fedora image\n run: docker pull fedora:42\n\n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Build RPM in Fedora container\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n fedora:42 \\\n bash -c \" \n git config --global --add safe.directory /workspace\n dnf install -y rpm-build make gcc-c++ git python3-devel cmake gmp-devel libuuid-devel sqlite-devel openssl-devel gtkmm30-devel boost-devel python3-matplotlib python3-pip \n pip3 install sympy \n mkdir build \n cd build \n cmake -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr .. \n make \n cpack \n \"\n\n - name: Set version variables from output of cmake\n run: |\n VER=$(cat ${{ github.workspace }}/build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n\n - name: Upload Release Assets\n if: github.event_name == 'release'\n run: |\n gh release upload \"${{ env.VERSION }}\" build/cadabra2-${{ env.VERSION }}-fedora42-${{ matrix.name }}.rpm --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Store package as build artifact\n uses: actions/upload-artifact@v4\n if: github.event_name == 'push'\n with:\n name: cadabra2-fedora42-${{ matrix.name }}.rpm\n path: build/cadabra2-${{ env.VERSION }}-fedora42-${{ matrix.name }}.rpm\n\n test:\n needs: build\n runs-on: ubuntu-latest\n if: github.event_name == 'release' # only test release builds\n \n steps:\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull Fedora image\n run: docker pull fedora:42\n\n - name: Download package and run inside Fedora container\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n fedora:42 \\\n bash -c \" \n dnf install -y xorg-x11-server-Xvfb wget curl jq\n export VERSION=\\$(curl -s https://api.github.com/repos/kpeeters/cadabra2/releases|& jq .[0].tag_name -r)\n export RPMNAME=cadabra2-\\${VERSION}-fedora42-x86_64.rpm\n wget https://github.com/kpeeters/cadabra2/releases/download/\\${VERSION}/\\${RPMNAME}\n dnf install -y \\${RPMNAME}\n printf 'import sys\\nprint(sys.path)\\nimport cdb.main\\nex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n' > tst.cdb\n cadabra2 tst.cdb\n \n xvfb-run -a cadabra2-gtk &\n APP_PID=\\$!\n sleep 10\n if kill -0 \\$APP_PID 2>/dev/null; then\n echo 'cadabra2-gtk started successfully'\n kill \\$APP_PID\n exit 0\n else\n echo 'cadabra2-gtk failed to start'\n exit 1\n fi\n \"\n"
},
{
"path": ".github/workflows/freebsd.yml",
"content": "# This is a build which gets triggered on every commit push, to\n# ensure that we get some warnings when we push code that does\n# not build on Linux.\n\nname: FreeBSD\n\non: [push]\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n \n steps:\n - uses: actions/checkout@v4\n\n - name: Build and test in FreeBSD\n id: test\n uses: vmactions/freebsd-vm@v1\n with:\n usesh: true\n prepare: |\n pkg install -y curl cmake python311 gettext-runtime pkgconf boost-libs\n pkg install -y fontconfig harfbuzz pcre jsoncpp gmp atkmm cairomm glibmm gtkmm30 pangomm\n pkg install -y git py311-sympy py311-numpy\n\n run: |\n pwd\n env\n freebsd-version\n sysctl hw.model\n sysctl hw.ncpu\n sysctl hw.physmem\n sysctl hw.usermem\n mkdir build && cd build && cmake -DENABLE_MATHEMATICA=OFF ..\n make\n make install\n make check\n"
},
{
"path": ".github/workflows/homebrew-devel.yml",
"content": "# This is a build which gets triggered on every push to the\n# 'devel' branch, to update the homebrew-repo the cadabra2-devel\n# package.\n\nname: Homebrew-devel\n\non:\n push:\n branches:\n - devel\n \njobs:\n build:\n\n runs-on: ubuntu-latest\n \n steps:\n - name: Checkout Cadabra\n uses: actions/checkout@v4\n with:\n ref: 'devel'\n \n - name: Checkout Homebrew repo\n uses: actions/checkout@v4\n with:\n repository: kpeeters/homebrew-repo\n path: homebrew-repo\n token: ${{ secrets.ACTIONS_HOMEBREW_REPO_TOKEN }}\n \n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Get dependencies\n run: sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install git cmake jq python3-dev g++ libpcre3 libpcre3-dev libgmp3-dev libgtkmm-3.0-dev libboost-all-dev libgmp-dev libsqlite3-dev uuid-dev libmpfr-dev libmpc-dev\n\n - name: Configure\n run: mkdir build && cd build && cmake -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr ..\n\n - name: Set variables\n run: |\n export VERSION=$(cat build/VERSION)\n export COMMIT=$(curl -s https://api.github.com/repos/kpeeters/cadabra2/commits/devel | jq -r .sha)\n wget https://github.com/kpeeters/cadabra2/archive/${COMMIT}.tar.gz\n export SHA=`cat ${COMMIT}.tar.gz | sha256sum -b | cut -d \" \" -f 1`\n echo \"SHA=${SHA}\" >> $GITHUB_ENV\n echo \"VERSION=$VERSION\" >> $GITHUB_ENV\n echo \"COMMIT=$COMMIT\" >> $GITHUB_ENV\n \n - name: Update Homebrew repo\n run: |\n cd homebrew-repo\n cat cadabra2-devel.rb | sed -e 's/^ url .*/ url \"https:\\/\\/github.com\\/kpeeters\\/cadabra2\\/archive\\/${{ env.COMMIT }}.tar.gz\"/' | sed -e 's/^ sha256.*/ sha256 \"${{ env.SHA }}\"/' | sed -e 's/^ version.*/ version \"${{ env.VERSION }}.${{ env.COMMIT }}\"/' > out.rb\n mv out.rb cadabra2-devel.rb\n cat cadabra2-devel.rb\n git config user.name \"Kasper Peeters\"\n git config user.email \"info@cadabra.science\"\n git add cadabra2-devel.rb\n git diff-index --quiet HEAD || (git commit -a -m \"Update to release ${{ env.VERSION }} commit ${{ env.COMMIT }}.\" && git push)\n\n \n test:\n needs: build\n runs-on: macos-latest\n \n steps:\n - name: get dependencies\n run: brew update && brew upgrade && brew tap kpeeters/repo && brew install --verbose cadabra2-devel\n\n - name: show where cadabra is located\n run: cat `which cadabra2`\n \n - name: test simple cli run\n run: printf \"import sys\\nprint(sys.path)\\nimport cdb.main\\nex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n\" > tst.cdb && cadabra2 tst.cdb\n \n - name: test gtk app launch\n run: |\n cadabra2-gtk &\n APP_PID=$!\n sleep 10\n \n if kill -0 $APP_PID 2>/dev/null; then\n echo \"cadabra2-gtk started successfully\"\n kill $APP_PID\n exit 0\n else\n echo \"cadabra2-gtk failed to start\"\n exit 1\n fi\n\n - name: Upload build logs\n if: always() \n uses: actions/upload-artifact@v4\n with:\n name: brew-build-logs\n path: |\n ~/Library/Logs/Homebrew/\n retention-days: 2\n\n \n"
},
{
"path": ".github/workflows/homebrew.yml",
"content": "# This is a build which gets triggered on every release, to\n# update the homebrew-repo.\n\nname: Homebrew\n\non:\n release:\n types: [released]\n\n# on: [push]\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n \n steps:\n - name: Checkout Cadabra\n uses: actions/checkout@v4\n\n - name: Checkout Homebrew repo\n uses: actions/checkout@v4\n with:\n repository: kpeeters/homebrew-repo\n path: homebrew-repo\n token: ${{ secrets.ACTIONS_HOMEBREW_REPO_TOKEN }}\n \n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Get dependencies\n run: sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install git cmake jq python3-dev g++ libpcre3 libpcre3-dev libgmp3-dev libgtkmm-3.0-dev libboost-all-dev libgmp-dev libsqlite3-dev uuid-dev libmpfr-dev libmpc-dev\n\n - name: Configure\n run: mkdir build && cd build && cmake -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr ..\n\n - name: Set variables\n run: |\n export VERSION=$(cat build/VERSION)\n echo \"VERSION=$VERSION\" >> $GITHUB_ENV\n wget https://github.com/kpeeters/cadabra2/archive/refs/tags/${VERSION}.tar.gz\n export SHA=`cat ${VERSION}.tar.gz | sha256sum -b | cut -d \" \" -f 1`\n echo \"SHA=${SHA}\" >> $GITHUB_ENV\n \n - name: Update Homebrew repo\n run: |\n cd homebrew-repo\n cat cadabra2.rb | sed -e 's/^ url .*/ url \"https:\\/\\/github.com\\/kpeeters\\/cadabra2\\/archive\\/refs\\/tags\\/${{ env.VERSION }}.tar.gz\"/' | sed -e 's/^ sha256.*/ sha256 \"${{ env.SHA }}\"/' | sed -e 's/^ version.*/ version \"${{ env.VERSION }}\"/' > out.rb\n mv out.rb cadabra2.rb\n cat cadabra2.rb\n git config user.name \"Kasper Peeters\"\n git config user.email \"info@cadabra.science\"\n git add cadabra2.rb\n git diff-index --quiet HEAD || (git commit -a -m \"Update to release ${{ env.VERSION }}.\" && git push)\n\n\n test:\n needs: build\n runs-on: macos-latest\n \n steps:\n - name: get dependencies\n run: brew update && brew upgrade && brew tap kpeeters/repo && brew install cadabra2\n\n - name: show where cadabra is located\n run: cat `which cadabra2`\n \n - name: test simple cli run\n run: printf \"ex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n\" > tst.cdb && cadabra2 tst.cdb\n\n - name: test gtk app launch\n run: |\n cadabra2-gtk &\n APP_PID=$!\n sleep 10\n \n if kill -0 $APP_PID 2>/dev/null; then\n echo \"Application started successfully\"\n kill $APP_PID\n exit 0\n else\n echo \"Application failed to start\"\n exit 1\n fi\n\n"
},
{
"path": ".github/workflows/linux.yml",
"content": "# This is a build which gets triggered on every commit push, to\n# ensure that we get some warnings when we push code that does\n# not build on Linux.\n\nname: Linux\n\non: [push]\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n \n steps:\n - uses: actions/checkout@v3\n\n# - name: Exit if not on devel branch\n# if: github.ref != 'refs/heads/devel'\n# run: exit 1\n \n# - name: setup python\n# uses: actions/setup-python@v4\n# with:\n# python-version: 3.11\n\n - name: get dependencies\n run: sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install ninja-build git cmake python3-dev g++ libpcre3 libpcre3-dev libgmp3-dev libgtkmm-3.0-dev libboost-all-dev libgmp-dev libsqlite3-dev uuid-dev libmpfr-dev libmpc-dev libtbb-dev catch2 && python3 --version && which python3 && python3 -m pip install --upgrade pip && python3 -m pip install wheel && python3 -m pip install sympy gmpy2 numpy\n\n - name: configure\n run: mkdir build && cd build && cmake -G Ninja -DENABLE_MATHEMATICA=OFF ..\n \n - name: build\n run: cd build && cmake --build .\n \n - name: test\n env:\n CTEST_OUTPUT_ON_FAILURE: 1\n run: cd build && ctest ARGS=\"-V\"\n"
},
{
"path": ".github/workflows/macos.yml",
"content": "# This is a build which gets triggered on every commit push, to\n# ensure that we get some warnings when we push code that does\n# not build on macOS.\n\nname: macOS\n\non: [push]\n\njobs:\n build:\n\n runs-on: macos-latest\n \n steps:\n - uses: actions/checkout@v4\n\n# - name: Exit if not on devel branch\n# if: github.ref != 'refs/heads/devel'\n# run: exit 1\n \n# - name: remove python 3.12\n# run: brew uninstall python@3.12\n \n - name: get dependencies\n run: brew install cmake ninja boost pcre gmp python@3.13 pkgconfig gtkmm3 adwaita-icon-theme catch2 tbb && python3 -m pip install --break-system-packages --user sympy gmpy2 numpy\n\n - name: configure\n run: mkdir build && cd build && cmake -G Ninja -DENABLE_MATHEMATICA=OFF -DPython_EXECUTABLE=python3.12 ..\n \n - name: build\n run: cd build && cmake --build .\n \n - name: test\n env:\n CTEST_OUTPUT_ON_FAILURE: 1\n run: cd build && ctest ARGS=\"-V\"\n"
},
{
"path": ".github/workflows/opensuse-tumbleweed-package.yml",
"content": "# Create a OpenSUSE Tumbleweed package on a github release event.\n# This assumes that the cadabra version is the same as the\n# release name, and it will attempt to add the .rpm file\n# to the release assets.\n\nname: OpenSUSE-Tumbleweed package\n\n# on: [push]\n\non:\n release:\n types: [created]\n\n\njobs:\n build:\n\n runs-on: ubuntu-24.04\n \n steps:\n - uses: actions/checkout@v3\n\n# - name: Exit if not on devel branch\n# if: github.ref != 'refs/heads/devel'\n# run: exit 1\n \n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull OpenSUSE image\n run: docker pull opensuse/tumbleweed:latest\n\n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Build RPM\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n opensuse/tumbleweed:latest \\\n bash -c \"\n zypper refresh\n zypper update\n zypper -n install --no-recommends rpmbuild git cmake python313-devel gcc-c++ \\\n gmp-devel libuuid-devel \\\n gtkmm3-devel sqlite3-devel \\\n python313-matplotlib libopenssl-devel \\\n libboost_system-devel libboost_filesystem-devel \\\n libboost_date_time-devel libboost_program_options-devel \n git config --global --add safe.directory /workspace\n mkdir build \n cd build \n cmake -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr .. \n make \n cpack \n \"\n\n - name: Set version variables from output of cmake\n run: |\n VER=$(cat ${{ github.workspace }}/build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n\n - name: Upload Release Assets\n run: |\n gh release upload \"${{ env.VERSION }}\" build/cadabra2-${{ env.VERSION }}-tumbleweed.rpm --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n test:\n needs: build\n runs-on: ubuntu-24.04\n \n steps:\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@master\n\n - name: Pull OpenSUSE image\n run: docker pull opensuse/tumbleweed:latest\n\n - name: Download package and run inside OpenSUSE container\n run: |\n docker run --rm \\\n -v ${{ github.workspace }}:/workspace \\\n -w /workspace \\\n opensuse/tumbleweed:latest \\\n bash -c \"\n zypper clean --all\n zypper refresh\n zypper update\n zypper se -s libboost_filesystem\n zypper -n install xvfb-run wget curl jq\n export VERSION=\\$(curl -s https://api.github.com/repos/kpeeters/cadabra2/releases|& jq .[0].tag_name -r)\n export RPMNAME=cadabra2-\\${VERSION}-tumbleweed.rpm\n wget https://github.com/kpeeters/cadabra2/releases/download/\\${VERSION}/\\${RPMNAME}\n zypper --no-gpg-checks -n install \\${RPMNAME}\n printf 'import sys\\nprint(sys.path)\\nimport cdb.main\\nex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n' > tst.cdb\n cadabra2 tst.cdb\n \n xvfb-run -a cadabra2-gtk &\n APP_PID=\\$!\n sleep 10\n if kill -0 \\$APP_PID 2>/dev/null; then\n echo 'cadabra2-gtk started successfully'\n kill \\$APP_PID\n exit 0\n else\n echo 'cadabra2-gtk failed to start'\n exit 1\n fi\n \"\n"
},
{
"path": ".github/workflows/tarball.yml",
"content": "# This is a build which gets triggered on every release, to\n# generate a tarball which includes all submodules.\n\nname: Tarball\n\non:\n release:\n types: [released]\n\n# on: [push]\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n \n steps:\n - name: Checkout Cadabra\n uses: actions/checkout@v4\n\n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Create tarball\n run: |\n export CDB_MAJOR=`cat cmake/version.cmake |grep 'MAJOR '|sed -e 's/[^ ]* \\([0-9]*\\).*/\\1/'`\n export CDB_MINOR=`cat cmake/version.cmake |grep 'MINOR '|sed -e 's/[^ ]* \\([0-9]*\\).*/\\1/'`\n export CDB_PATCH=`cat cmake/version.cmake |grep 'PATCH '|sed -e 's/[^ ]* \\([0-9]*\\).*/\\1/'`\n export VERSION=${CDB_MAJOR}.${CDB_MINOR}.${CDB_PATCH}\n echo \"VERSION=$VERSION\" >> $GITHUB_ENV\n mkdir -p submodules\n cd submodules\n git clone -b kpeeters/cadabra https://github.com/kpeeters/MicroTeX.git microtex\n cd ../..\n mv cadabra2 cadabra2-${VERSION}\n tar zcf cadabra2-${VERSION}-source-inclusive.tar.gz --exclude \".git\" cadabra2-${VERSION}\n mv cadabra2-${VERSION} cadabra2 \n \n - name: Upload tarball to assets\n run: |\n gh release upload \"${{ env.VERSION }}\" ${{ github.workspace }}/../cadabra2-${VERSION}-source-inclusive.tar.gz --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n"
},
{
"path": ".github/workflows/ubuntu-22.04-package.yml",
"content": "# Create an Ubuntu 22.04 package on a github release event.\n# This assumes that the cadabra version is the same as the\n# release name, and it will attempt to add the .deb file\n# to the release assets.\n\nname: Ubuntu-22.04 package\n\n# on: [push]\n\non:\n release:\n types: [created]\n\njobs:\n build:\n\n strategy:\n matrix:\n include:\n - os: ubuntu-22.04\n name: x86_64\n display-name: \"Ubuntu 22.04 x86_64\"\n - os: ubuntu-22.04-arm\n name: arm64\n display-name: \"Ubuntu 22.04 arm64\"\n runs-on: ${{ matrix.os }}\n \n steps:\n - uses: actions/checkout@v3\n\n# - name: Exit if not on devel branch\n# if: github.ref != 'refs/heads/devel'\n# run: exit 1\n \n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Get dependencies\n run: sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install git cmake ninja-build python3-dev g++ libpcre3 libpcre3-dev libgmp3-dev libgtkmm-3.0-dev libboost-all-dev libgmp-dev libsqlite3-dev uuid-dev libmpfr-dev libmpc-dev libtbb-dev catch2 && python3 --version && which python3 && python3 -m pip install --upgrade pip && python3 -m pip install wheel && python3 -m pip install sympy gmpy2 numpy\n\n - name: Configure\n run: mkdir build && cd build && cmake -G Ninja -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr ..\n \n - name: Build\n run: cd build && cmake --build .\n \n - name: Create the .deb package\n run: cd build && cpack\n \n - name: Set version variables from output of cmake\n run: |\n VER=$(cat build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n\n - name: Upload Release Assets\n run: |\n gh release upload \"${{ env.VERSION }}\" build/cadabra2-${{ env.VERSION }}-ubuntu-22.04-jammy-${{ matrix.name }}.deb --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n\n test:\n needs: build\n runs-on: ubuntu-22.04\n\n steps:\n - name: Get and install package\n run: |\n sudo apt install xvfb\n export VERSION=$(curl -s https://api.github.com/repos/kpeeters/cadabra2/releases|& jq .[0].tag_name -r)\n export DEBNAME=cadabra2-${VERSION}-ubuntu-22.04-jammy-x86_64.deb\n wget https://github.com/kpeeters/cadabra2/releases/download/${VERSION}/${DEBNAME}\n sudo apt -y update\n sudo apt -y upgrade\n sudo apt -y install ./${DEBNAME}\n\n - name: Test simple cli run\n run: printf \"import sys\\nprint(sys.path)\\nimport cdb.main\\nex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n\" > tst.cdb && cadabra2 tst.cdb\n\n - name: Test gtk app launch\n run: |\n xvfb-run -a cadabra2-gtk &\n APP_PID=$!\n sleep 10\n \n if kill -0 $APP_PID 2>/dev/null; then\n echo \"Application started successfully\"\n kill $APP_PID\n exit 0\n else\n echo \"Application failed to start\"\n exit 1\n fi\n"
},
{
"path": ".github/workflows/ubuntu-24.04-package.yml",
"content": "# Create an Ubuntu 24.04 package on a github release event.\n# This assumes that the cadabra version is the same as the\n# release name, and it will attempt to add the .deb file\n# to the release assets.\n\nname: Ubuntu-24.04 package\n\n# on: [push]\n\non:\n release:\n types: [created]\n\njobs:\n build:\n\n strategy:\n matrix:\n include:\n - os: ubuntu-24.04\n name: x86_64\n display-name: \"Ubuntu 24.04 x86_64\"\n - os: ubuntu-24.04-arm\n name: arm64\n display-name: \"Ubuntu 24.04 arm64\"\n runs-on: ${{ matrix.os }}\n \n steps:\n - uses: actions/checkout@v3\n\n# - name: Exit if not on devel branch\n# if: github.ref != 'refs/heads/devel'\n# run: exit 1\n \n - name: Set up GitHub CLI\n run: |\n sudo apt-get update\n sudo apt-get install -y gh\n\n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - name: Get dependencies\n run: sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install git cmake ninja-build python3-dev g++ libpcre3 libpcre3-dev libgmp3-dev libgtkmm-3.0-dev libboost-all-dev libgmp-dev libsqlite3-dev uuid-dev libmpfr-dev libmpc-dev libtbb-dev catch2 && python3 --version && which python3 && python3 -m pip install --upgrade pip && python3 -m pip install wheel && python3 -m pip install sympy gmpy2 numpy\n\n - name: configure\n run: mkdir build && cd build && cmake -G Ninja -DPACKAGING_MODE=ON -DENABLE_MATHEMATICA=OFF -DCMAKE_INSTALL_PREFIX=/usr ..\n \n - name: Make\n run: cd build && cmake --build .\n \n - name: Create the .deb package\n run: cd build && cpack\n \n - name: Set version variables from output of cmake\n run: |\n VER=$(cat build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n\n - name: Upload Release Assets\n if: github.event_name == 'release'\n run: |\n gh release upload \"${{ env.VERSION }}\" build/cadabra2-${{ env.VERSION }}-ubuntu-24.04-noble-${{ matrix.name }}.deb --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Store package as build artifact\n uses: actions/upload-artifact@v4\n if: github.event_name == 'push'\n with:\n name: cadabra2-ubuntu-24.04-noble-${{ matrix.name }}.deb\n path: build/cadabra2-${{ env.VERSION }}-ubuntu-24.04-noble.deb\n\n\n test:\n needs: build\n runs-on: ubuntu-24.04\n\n steps:\n - name: Install prerequisites for testing\n run: |\n sudo apt install xvfb imagemagick\n sudo apt-mark hold firefox\n \n - name: Get and install package (release mode)\n if: github.event_name == 'release'\n run: |\n export VERSION=$(curl -s https://api.github.com/repos/kpeeters/cadabra2/releases|& jq .[0].tag_name -r)\n export DEBNAME=cadabra2-${VERSION}-ubuntu-24.04-noble-x86_64.deb\n wget https://github.com/kpeeters/cadabra2/releases/download/${VERSION}/${DEBNAME}\n sudo apt -y update\n sudo apt -y upgrade\n sudo apt -y install ./${DEBNAME}\n\n - name: Download package (push mode)\n uses: actions/download-artifact@v4\n if: github.event_name == 'push'\n with:\n name: cadabra2-ubuntu-24.04-noble-x86_64.deb\n\n - name: Install package (push mode)\n if: github.event_name == 'push'\n run: |\n ls -la\n sudo apt -y update\n sudo apt -y upgrade\n sudo apt -y install ./cadabra2*.deb\n\n - name: Test simple cli run\n run: printf \"import sys\\nprint(sys.path)\\nimport cdb.main\\nex:=(A+B) (C+D);\\ndistribute(ex);\\nquit()\\n\" > tst.cdb && cadabra2 tst.cdb\n\n - name: Test gtk app launch and take screenshot\n run: |\n MESA_LOADER_DRIVER_OVERRIDE=llvmpipe LIBGL_ALWAYS_SOFTWARE=1 xvfb-run -a -s \"-screen 0 1920x1080x24 -ac\" cadabra2-gtk -n &\n APP_PID=$!\n sleep 10\n \n if kill -0 $APP_PID 2>/dev/null; then\n echo \"Application started successfully\"\n DISPLAY=:99 import -window root screenshot.png\n kill $APP_PID\n exit 0\n else\n echo \"Application failed to start\"\n exit 1\n fi\n\n - name: Upload screenshot\n uses: actions/upload-artifact@v4\n with:\n name: app-screenshot-ubuntu-24.04\n path: screenshot.png\n"
},
{
"path": ".github/workflows/windows-installer.yml",
"content": "# Create Windows installer on a github release event. This assumes\n# that the cadabra version is the same as the release name, and it\n# will attempt to add the installer file to the release assets.\n\nname: Windows 11 installer\n\n# on: [push]\n\non:\n release:\n types: [created]\n\ndefaults:\n run:\n shell: msys2 {0}\n\njobs:\n msys2-ucrt64:\n strategy:\n matrix:\n include:\n - os: windows-2022\n name: x86_64\n display-name: \"Windows 11 x86_64\"\n msystem: ucrt64\n midfix: ucrt-x86_64\n - os: windows-11-arm\n name: arm64\n msystem: clangarm64\n midfix: clang-aarch64\n display-name: \"Windows 11 arm64\"\n runs-on: ${{ matrix.os }}\n name: Windows 11\n defaults:\n run:\n shell: msys2 {0}\n\n steps:\n - name: Install WiX v4/v5 Tool\n run: |\n dotnet tool install --tool-path c:\\WiX\\bin wix --version 5.0.2\n c:\\WiX\\bin\\wix extension add --global WixToolset.UI.wixext/5.0.2\n shell: pwsh\n\n - name: Add WiX toolkit to PATH\n shell: bash\n run: |\n echo \"WiX installed at ${WIX}, hopefully...\"\n echo \"Listing C:/WiX/bin\"\n ls \"C:/WiX/bin\"\n echo \"Listing Program Files (x86):\"\n ls \"C:/Program Files (x86)/\"\n echo \"Listing Program Files:\" \n ls \"C:/Program Files/\"\n echo \"${WIX}bin\" >> $GITHUB_PATH\n\n - uses: msys2/setup-msys2@v2\n with:\n msystem: ${{ matrix.msystem }}\n update: true\n install: >-\n curl\n git\n mingw-w64-${{ matrix.midfix }}-gcc\n mingw-w64-${{ matrix.midfix }}-python\n mingw-w64-${{ matrix.midfix }}-gtkmm3\n mingw-w64-${{ matrix.midfix }}-boost \n mingw-w64-${{ matrix.midfix }}-sqlite3\n mingw-w64-${{ matrix.midfix }}-cmake\n mingw-w64-${{ matrix.midfix }}-python-matplotlib\n mingw-w64-${{ matrix.midfix }}-python-sympy\n mingw-w64-${{ matrix.midfix }}-github-cli\n \n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - uses: actions/checkout@master\n name: Checkout source\n \n - name: Build\n run: |\n mkdir build\n cd build\n # Turn off searching Python in the registry, as that contains the\n # windows Python which is not the MSYS python that we want to use.\n cmake -DPython_FIND_REGISTRY=NEVER ..\n ninja\n ninja install\n cpack\n\n - name: Upload WiX log file\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: wix-${{ matrix.name }}.log\n path: build/_CPack_Packages/win64/WIX/wix.log\n retention-days: 2\n\n - name: Set version variables from output of cmake\n run: |\n VER=$(cat build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n GITVER=$(cat build/GIT_TAG_VERSION)\n echo \"GIT_TAG_VERSION=$GITVER\" >> $GITHUB_ENV\n\n - name: Upload release assets\n run: |\n gh release upload \"${{ env.GIT_TAG_VERSION }}\" build/cadabra2-${{ env.VERSION }}-win64.msi --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n"
},
{
"path": ".github/workflows/windows.yml",
"content": "# Create Windows installer on a github push or release event\n# (upload to the release assets in the latter case).\n\nname: Windows 11\n\non: [push]\n\n#on:\n# release:\n# types: [created]\n\ndefaults:\n run:\n shell: msys2 {0}\n\njobs:\n msys2-ucrt64:\n strategy:\n matrix:\n include:\n - os: windows-2022\n name: x86_64\n display-name: \"Windows 11 x86_64\"\n msystem: ucrt64\n midfix: ucrt-x86_64\n - os: windows-11-arm\n name: arm64\n msystem: clangarm64\n midfix: clang-aarch64\n display-name: \"Windows 11 arm64\"\n runs-on: ${{ matrix.os }}\n name: Windows build\n defaults:\n run:\n shell: msys2 {0}\n\n steps:\n - name: Install WiX v4/v5 Tool\n run: |\n dotnet tool install --tool-path c:\\WiX\\bin wix --version 5.0.2\n c:\\WiX\\bin\\wix extension add --global WixToolset.UI.wixext/5.0.2\n shell: pwsh\n\n - name: Add WiX toolkit to PATH\n shell: bash\n run: |\n echo \"WiX installed at ${WIX}, hopefully...\"\n echo \"Listing C:/WiX/bin\"\n ls \"C:/WiX/bin\"\n echo \"Listing Program Files (x86):\"\n ls \"C:/Program Files (x86)/\"\n echo \"Listing Program Files:\" \n ls \"C:/Program Files/\"\n echo \"${WIX}bin\" >> $GITHUB_PATH\n\n - uses: msys2/setup-msys2@v2\n with:\n msystem: ${{ matrix.msystem }}\n update: true\n install: >-\n curl\n git\n mingw-w64-${{ matrix.midfix }}-gcc\n mingw-w64-${{ matrix.midfix }}-python\n mingw-w64-${{ matrix.midfix }}-gtkmm3\n mingw-w64-${{ matrix.midfix }}-boost \n mingw-w64-${{ matrix.midfix }}-sqlite3\n mingw-w64-${{ matrix.midfix }}-cmake\n mingw-w64-${{ matrix.midfix }}-python-matplotlib\n mingw-w64-${{ matrix.midfix }}-python-sympy\n mingw-w64-${{ matrix.midfix }}-github-cli\n \n - name: Authenticate GitHub CLI\n run: gh auth setup-git\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n \n - uses: actions/checkout@master\n name: Checkout source\n \n - name: Build\n run: |\n mkdir build\n cd build\n # Turn off searching Python in the registry, as that contains the\n # windows Python which is not the MSYS python that we want to use.\n cmake -DPython_FIND_REGISTRY=NEVER ..\n ninja\n ninja install\n cpack\n\n - name: Upload cmake_install.cmake file\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: cmake_install-${{ matrix.name }}.cmake\n path: build/cmake_install.cmake\n retention-days: 2\n\n - name: Upload frontend/cmake_install.cmake file\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: frontend-cmake_install-${{ matrix.name }}.cmake\n path: build/frontend/cmake_install.cmake\n retention-days: 2\n \n - name: Upload frontend/gtkmm/cmake_install.cmake file\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: frontend-gtkmm-cmake_install-${{ matrix.name }}.cmake\n path: build/frontend/gtkmm/cmake_install.cmake\n retention-days: 2\n \n - name: Upload WiX log file\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: wix-${{ matrix.name }}.log\n path: build/_CPack_Packages/win64/WIX/wix.log\n retention-days: 2\n\n - name: Set version variables from output of cmake\n run: |\n VER=$(cat build/VERSION)\n echo \"VERSION=$VER\" >> $GITHUB_ENV\n GITVER=$(cat build/GIT_TAG_VERSION)\n echo \"GIT_TAG_VERSION=$GITVER\" >> $GITHUB_ENV\n\n - name: Upload installer as build artifact\n uses: actions/upload-artifact@v4\n with:\n name: cadabra2-windows-${{ matrix.name }}.msi\n path: build/cadabra2-${{ env.VERSION }}-win64.msi\n retention-days: 2\n\n - name: Upload release assets\n if: github.event_name == 'release'\n run: |\n mv build/cadabra2-${{ env.VERSION }}-win64.msi build/cadabra2-${{ env.GIT_TAG_VERSION }}-windows-${{ matrix.name }}.msi\n gh release upload \"${{ env.GIT_TAG_VERSION }}\" build/cadabra2-${{ env.GIT_TAG_VERSION }}-windows-${{ matrix.name }}.msi --clobber\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n test:\n needs: msys2-ucrt64\n strategy:\n fail-fast: false\n matrix:\n include:\n - os: windows-2022\n name: x86_64\n display-name: \"Windows 11 x86_64\"\n - os: windows-11-arm\n name: arm64\n display-name: \"Windows 11 arm64\"\n runs-on: ${{ matrix.os }}\n \n steps:\n - name: Download installer\n uses: actions/download-artifact@v4\n with:\n name: cadabra2-windows-${{ matrix.name }}.msi\n\n - name: Install silently\n shell: pwsh\n run: |\n dir\n $installer = Get-ChildItem -Filter \"cadabra*.msi\" | Select-Object -First 1 -ExpandProperty Name\n if (-not $installer) {\n Write-Error \"No installer found\"\n exit 1\n }\n $installerPath = (Get-Item -Path \".\\$installer\").FullName \n Write-Host \"Installing $installerPath\"\n Start-Process -FilePath \"msiexec\" -ArgumentList \"/i\", \"$installerPath\", \"/qn\", \"/l*v\", \"install.log\" -Wait\n Write-Host \"Installer finished\"\n\n - name: Upload installation log\n uses: actions/upload-artifact@v4\n with:\n name: install-${{ matrix.os }}.log\n path: install.log\n\n - name: Check installation location\n shell: cmd\n run: |\n echo \"Main folder:\"\n dir \"C:\\Program Files\\Cadabra\" \n \n - name: Start GUI and take screenshot\n shell: pwsh\n run: |\n # Attempt to start the notebook\n if (-not (Test-Path \"C:\\Program Files\\Cadabra\\cadabra2-gtk.exe\")) {\n Write-Host \"Executable not found\"\n exit 1\n }\n $process = Start-Process \"C:\\Program Files\\Cadabra\\cadabra2-gtk.exe\" -ArgumentList \"-n\", \"Examples\\schwarzschild.cnb\" -WorkingDirectory \"C:\\Program Files\\Cadabra\" -PassThru\n Start-Sleep -Seconds 120\n\n # Take screenshot\n Add-Type -AssemblyName System.Windows.Forms\n Add-Type -AssemblyName System.Drawing\n \n $screen = [System.Windows.Forms.Screen]::PrimaryScreen.Bounds\n $bitmap = New-Object System.Drawing.Bitmap($screen.Width, $screen.Height)\n $graphics = [System.Drawing.Graphics]::FromImage($bitmap)\n $graphics.CopyFromScreen($screen.Location, [System.Drawing.Point]::Empty, $screen.Size)\n $bitmap.Save(\"screenshot.png\")\n $graphics.Dispose()\n $bitmap.Dispose()\n\n # Cleanup\n Stop-Process -Id $process.Id -Force\n \n - name: Upload cadabra_log.txt\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: cadabra_log-${{ matrix.os }}.txt\n path: C:\\Windows\\Temp\\cadabra_log.txt\n\n - name: Upload screenshot\n uses: actions/upload-artifact@v4\n with:\n name: app-screenshot-${{ matrix.os }}\n path: screenshot.png\n \n"
},
{
"path": ".gitignore",
"content": ".cache\nweb2/cadabra2/source/book\n*.orig\n*.bak\ndoxygen\n.DS_Store\n*~\n*.o\nbuild\nbuild-lib\njbuild\ninstall\n.ipynb_checkpoints\n__pycache__\n.vscode\n.vs\nCMakeSettings.json\nconfig/pre_install.rtf\n.ccls-cache\n*appdata.xml\nconfig/install_script.iss\nconfig/science.cadabra.cadabra2-gtk.desktop\n"
},
{
"path": ".gitmodules",
"content": "[submodule \"submodules/microtex\"]\n\tpath = submodules/microtex\n\turl = https://github.com/kpeeters/MicroTeX\n\tbranch = kpeeters/cadabra\n"
},
{
"path": ".travis.yml",
"content": "branches:\n only:\n - master\n - feature/pybind\n \nos:\n - linux\n addons:\n apt:\n sources:\n - ubuntu-toolchain-r-test\n packages:\n - g++-6\n env:\n - MATRIX_EVAL=\"CC=gcc-6 && CXX=g++-6\"\t\n - osx\n\ncompiler:\n - gcc\n\nlanguage: cpp\n\nsudo: required\n\ndist: trusty\n\nenv:\n global:\n - CTEST_EXT_COLOR_OUTPUT=TRUE\n - CTEST_BUILD_FLAGS=-j4\n\nmatrix:\n exclude:\n - os: osx\n compiler: gcc\nscript:\n - cmake --build .\n - ctest -VV .\n\nbefore_script:\n - mkdir build\n - cd build\n - cmake ..\n\nbefore_install:\n - if [ \"$TRAVIS_PULL_REQUEST\" == \"false\" ]; then openssl aes-256-cbc -K $encrypted_0c0fd3a7dbd0_key -iv $encrypted_0c0fd3a7dbd0_iv -in config/travisci_rsa.enc -out config/travisci_rsa -d; fi\n - if [ \"$TRAVIS_PULL_REQUEST\" == \"false\" ]; then chmod 0600 config/travisci_rsa; cp config/travisci_rsa ~/.ssh/id_rsa; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"linux\" ]]; then sudo apt-get -qq update; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"linux\" ]]; then sudo apt-get install -y cmake python3-dev\n g++ libpcre3 libpcre3-dev libgmp3-dev uuid-dev python3-pip; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"linux\" ]]; then sudo apt-get install -y libgtkmm-3.0-dev\n libjsoncpp-dev libboost-regex-dev libboost-system-dev libboost-program-options-dev libboost-date-time-dev libboost-filesystem-dev libgmp-dev libsqlite3-dev; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then brew update; brew unlink json-c; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then brew outdated cmake || brew upgrade cmake; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then brew outdated boost || travis_wait brew upgrade boost; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then brew outdated gmp || brew upgrade gmp; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then brew outdated pkgconfig || brew upgrade pkgconfig; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then brew install jsoncpp python3 gtkmm3 gnome-icon-theme; fi\n - if [[ \"$TRAVIS_OS_NAME\" == \"osx\" ]]; then sudo pip3 install matplotlib sympy; fi\n - if [ \"$TRAVIS_PULL_REQUEST\" == \"false\" ]; then if [[ \"$TRAVIS_OS_NAME\" == \"linux\" ]]; then if [[ \"`${CC} --version |grep gcc`\" != \"\" ]]; then sudo apt-get install --yes doxygen graphviz texlive-font-utils; ./config/publish-doxygen; fi; fi; fi\n\ninstall:\n - pip3 install --user sympy\n\n\nnotifications:\n email:\n recipients:\n - kasper.peeters@phi-sci.com\n on_success: always\n on_failure: always\n"
},
{
"path": "CITATION.cff",
"content": "cff-version: 1.2.0\nmessage: \"If you use this software, please cite it as below.\"\nauthors:\n- family-names: \"Peeters\"\n given-names: \"Kasper\"\n orcid: \"https://orcid.org/0000-0002-3077-8193\"\ntitle: \"My Research Software\"\nversion: 2.0.4\ndoi: 10.5281/zenodo.2500762\ndate-released: 2017-12-18\nurl: \"https://github.com/kpeeters/cadabra2\"\npreferred-citation:\n type: article\n authors:\n - family-names: \"Peeters\"\n given-names: \"Kasper\"\n orcid: \"https://orcid.org/0000-0002-3077-8193\"\n doi: doi.org/10.21105/joss.01118\n journal: \"The Journal of Open Source Software\"\n start: 1118 # First page number\n end: 1119 # Last page number\n title: \"Cadabra2: computer algebra for field theory revisited\"\n issue: 3\n volume: 32\n year: 2018"
},
{
"path": "CMakeLists.txt",
"content": "set(CMAKE_LEGACY_CYGWIN_WIN32 0)\nif(WIN32)\n # We want to use WiX 4.x but cpack only supports that from 3.30.\n set(CADABRA_CMAKE_VERSION 3.30)\nelse()\n set(CADABRA_CMAKE_VERSION 3.12)\nendif()\n\n# Policy settings for CMake to resolve ambiguities.\n\nif(POLICY CMP0042)\n cmake_policy(SET CMP0042 NEW)\n message(STATUS \"Set CMake policy CMP0042 to NEW\")\nendif()\nif(POLICY CMP0054)\n cmake_policy(SET CMP0054 NEW)\n message(STATUS \"Set CMake policy CMP0054 to NEW\")\nendif()\nif(POLICY CMP0127)\n cmake_policy(SET CMP0127 NEW)\n message(STATUS \"Set CMake policy CMP0127 to NEW\")\nendif()\nif(POLICY CMP0148)\n cmake_policy(SET CMP0148 NEW)\n message(STATUS \"Set CMake policy CMP0148 to NEW\")\nendif()\nif(POLICY CMP0167)\n cmake_policy(SET CMP0167 NEW)\n message(STATUS \"Set CMake policy CMP0167 to NEW\")\nendif()\nif(POLICY CMP0094)\n cmake_policy(SET CMP0094 NEW)\n message(STATUS \"Set CMake policy CMP0094 to NEW (use first Python found)\")\nendif()\nif(POLICY CMP0169)\n cmake_policy(SET CMP0169 NEW)\n message(STATUS \"Set CMake policy CMP0169 to NEW (use new FetchContent)\")\n # CMake 3.30: call FetchContent_Populate() with just the name of a\n # dependency. This modern alternative was introduced in cmake 3.14\n # but we still support 3.12; we call the old behaviour in\n # frontend/gtkmm/CMakeLists.txt\nendif()\nif(POLICY CMP0177)\n cmake_policy(SET CMP0177 NEW)\n message(STATUS \"Set CMake policy CMP0177 to NEW (destination paths are normalised)\")\nendif()\nif(POLICY CMP0087)\n cmake_policy(SET CMP0087 NEW)\n message(STATUS \"Set CMake policy CMP0089 to NEW (evaluate generator expressions in install(CODE))\")\nendif()\n\ncmake_minimum_required(VERSION ${CADABRA_CMAKE_VERSION})\nset(CMAKE_CXX_STANDARD 17)\nset(CMAKE_CXX_STANDARD_REQUIRED ON)\n\nproject(Cadabra)\n\nif (${CMAKE_SYSTEM_NAME} MATCHES \"Darwin\")\n set(MACOS TRUE)\nendif()\n\n#---------------------------------------------------------------------------\n# Preamble\n#---------------------------------------------------------------------------\n\nset(CMAKE_EXPORT_COMPILE_COMMANDS ON)\n\n# Aliases for directories\nset(CADABRA_ROOT_DIR ${CMAKE_SOURCE_DIR})\nset(CADABRA_CLIENT_SERVER_DIR ${CADABRA_ROOT_DIR}/client_server)\nset(CADABRA_CORE_DIR ${CADABRA_ROOT_DIR}/core)\nset(CADABRA_FRONTEND_DIR ${CADABRA_ROOT_DIR}/frontend)\nset(CADABRA_IMAGES_DIR ${CADABRA_ROOT_DIR}/images)\nset(CADABRA_LIBS_DIR ${CADABRA_ROOT_DIR}/libs)\n\ninclude(cmake/functions.cmake)\n\n# Include Visual Studio specific build commands\nif (MSVC)\n # https://developercommunity.visualstudio.com/content/problem/618088/cmake-msvc-toolset-version-is-incorrect-in-visual.html\n if ((MSVC_VERSION EQUAL 1921 OR MSVC_VERSION EQUAL 1922) AND MSVC_TOOLSET_VERSION EQUAL 141)\n\t set(MSVC_TOOLSET_VERSION 142)\n endif()\n message(STATUS \"MSVC_VERSION = ${MSVC_VERSION}, MSVC_TOOLSET_VERSION = ${MSVC_TOOLSET_VERSION}\")\n include(cmake/windows.cmake)\nendif()\n\n# Make sure the build type is non-empty.\nif(NOT DEFINED CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL \"\")\n set(CMAKE_BUILD_TYPE \"Release\")\nendif()\nset(CADABRA_BUILD_TYPE \"${CMAKE_BUILD_TYPE}\")\nif (CMAKE_BUILD_TYPE MATCHES \"^Debug$\")\n set(CADABRA_DEBUG_BUILD TRUE)\nendif()\nmessage(STATUS \"Build type = ${CMAKE_BUILD_TYPE}\")\n\n# Set path to additional cmake files\nset(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} \"${CMAKE_SOURCE_DIR}/cmake/modules\")\nif (APPLE)\n set(ENV{PKG_CONFIG_PATH} \"/usr/local/opt/libffi/lib/pkgconfig:\")\nendif()\n\nset(PKG_CONFIG_USE_STATIC_LIBS OFF)\n\nif(NOT APPLE)\n find_package(TBB QUIET) \n if(TBB_FOUND)\n message(STATUS \"TBB found, will make some operations parallel\")\n else()\n message(STATUS \"TBB not found, parallel operations disabled\")\n endif()\nelse()\n message(STATUS \"Apple's toolchain not yet supporting TBB properly, disabled\")\nendif()\n\n# Get version information.\ninclude(cmake/version.cmake)\nprint_header(\"Building Cadabra version ${CADABRA_VERSION_SEM} (${SYSTEM_BITS}-bit)\")\nmessage(STATUS \"Build id '${CADABRA_VERSION_BUILD}' dated ${CADABRA_VERSION_DATE}\")\nmessage(STATUS \"Build mode is set to '${CMAKE_BUILD_TYPE}'\")\nstring(TOLOWER ${CMAKE_SYSTEM_PROCESSOR} STANDARD_ARCH_NAME)\nif(STANDARD_ARCH_NAME STREQUAL \"aarch64\")\n set(STANDARD_ARCH_NAME \"arm64\")\nendif()\nif(STANDARD_ARCH_NAME STREQUAL \"amd64\")\n set(STANDARD_ARCH_NAME \"x86_64\")\nendif()\nmessage(STATUS \"Architecture is '${CMAKE_SYSTEM_PROCESSOR}' (package names will use '${STANDARD_ARCH_NAME}')\")\nif(WIN32)\n if(\"${STANDARD_ARCH_NAME}\" STREQUAL \"x86_64\")\n set(MSYS_ENV \"ucrt64\")\n set(WIX_SHORT_ARCH \"x64\")\n else()\n set(MSYS_ENV \"clangarm64\")\n set(WIX_SHORT_ARCH \"arm64\")\n endif()\n message(STATUS \"MSYS environment set to ${MSYS_ENV}\")\nendif()\n\n# Store the version number in a build/VERSION file (so that e.g. github\n# actions can pick it up).\nfile(WRITE build/VERSION \"${CADABRA_VERSION_SEM}\")\nfile(WRITE build/GIT_TAG_VERSION \"${CADABRA_VERSION_GITHUB_TAG}\")\n\n# Notify about install directory\nif (\"${CMAKE_INSTALL_PREFIX}\" STREQUAL \"\")\n\tmessage(STATUS \"Install directory not set\")\nelse()\n\tmessage(STATUS \"Install directory set to ${CMAKE_INSTALL_PREFIX}\")\nendif()\n\n# Turn Mathematica support on/off.\noption(ENABLE_MATHEMATICA \"Enable Mathematica support\" OFF)\n\n# Are we trying to build cadabra as a c++ library?\noption(BUILD_AS_CPP_LIBRARY \"Build cadabra as a C++ library\" OFF)\nif (BUILD_AS_CPP_LIBRARY)\n enable_testing()\n add_subdirectory(c++lib)\n configure_file(\n\t \"${PROJECT_SOURCE_DIR}/core/Config.hh.in\"\n\t \"${PROJECT_SOURCE_DIR}/core/Config.hh\"\n )\n # Bail out early.\n return()\nendif()\n\n# Switch between GTK4 and GTK3.\noption(USE_GTK4 \"Build for GTK4 (instead of GTK3)\" OFF)\n\n# Include packaging logic.\ninclude(cmake/packaging.cmake)\n\n#---------------------------------------------------------------------------\n# User options and other notifications\n#---------------------------------------------------------------------------\n\n#\noption(MSVC_TARGET_CONSOLE \"Force Release book on MSVC to display a console window\" OFF)\n\noption(APPIMAGE_MODE \"Run in AppImage mode, overriding path settings\" OFF)\nif(APPIMAGE_MODE)\n message(STATUS \"Building for AppImage packaging (Debian paths, MicroTeX)\")\n if(\"${CMAKE_INSTALL_PREFIX}\" STREQUAL \"/usr\")\n else()\n MESSAGE(FATAL_ERROR \"Building with -DAPPIMAGE_MODE=ON also requires -DCMAKE_INSTALL_PREFIX=/usr\")\n endif()\nendif()\n\noption(PACKAGING_MODE \"Run in packaging mode, overriding path settings\" OFF)\nif (PACKAGING_MODE)\n\tmessage(STATUS \"Building in packaging mode\")\n\tif(\"${CMAKE_INSTALL_PREFIX}\" STREQUAL \"/usr\")\n\telse()\n\t\tMESSAGE(FATAL_ERROR \"Building with -DPACKAGING_MODE=ON also requires -DCMAKE_INSTALL_PREFIX=/usr\")\n\tendif()\nelse()\n\tmessage(STATUS \"Building in user mode\")\nendif()\n\noption(ENABLE_JUPYTER \"Enable building the Xeus-based Jupyter kernel\" OFF)\noption(ENABLE_PY_JUPYTER \"Enable building the default Jupyter kernel\" ON)\n\nif(ENABLE_JUPYTER)\n # Currently only possible when building against Conda.\n set(CONDA_FOUND TRUE)\nelse()\n set(CONDA_FOUND FALSE)\nendif()\n\noption(BUILD_TESTS \"Build tests\" ON)\nif (BUILD_TESTS)\n message(STATUS \"Building tests\")\n # Allows tests to be built in all subdirectories.\n enable_testing()\nendif()\n\noption(ENABLE_FRONTEND \"Enable the UI frontend\" ON)\n\noption(ENABLE_SYSTEM_JSONCPP \"Use the system-provided jsoncpp library\" OFF)\n\noption(INSTALL_TARGETS_ONLY \"Only install targets; skipping icons, shared libraries etc...\" OFF)\nif (INSTALL_TARGETS_ONLY)\n\tmessage(STATUS \"INSTALL_TARGETS_ONLY is enabled, please make sure all auxillary files and programs Cadabra requires are already installed\")\nendif()\n\n#---------------------------------------------------------------------------\n# Compiler flags.\n#---------------------------------------------------------------------------\n\n# - Set the C++ standard to C++17\n# - Turn optimizations on\n# - Turn off warnings we don't need\n\ninclude(CheckIPOSupported)\ncheck_ipo_supported(RESULT IPO_SUPPORTED OUTPUT error)\nif( IPO_SUPPORTED )\n message(STATUS \"IPO / LTO enabled\")\nelse()\n message(STATUS \"IPO / LTO not supported: <${error}>\")\nendif()\n\n\n\n# GCC\nif(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUCXX)\n if (ENABLE_FRONTEND)\n if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.9)\n message(FATAL_ERROR \"GCC version must be at least 4.9 for regex support! See http://askubuntu.com/questions/428198/getting-installing-gcc-g-4-9-on-ubuntu and then set the environment variables CXX to g++-4.9 and CC to gcc-4.9. You may have to erase the build directory before re-running cmake.\")\n endif()\n if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14.0)\n message(STATUS \"This version of g++ (${CMAKE_CXX_COMPILER_VERSION}) incorrectly warns about possibly uninitialised memory when using std::variant containing a std::shared_ptr. Disabling this warning.\")\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -Wno-maybe-uninitialized\")\n endif()\n endif()\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -g -O2 -Wall -Wextra -Wunused -Wno-psabi -Wno-unknown-pragmas -Wno-misleading-indentation -fvisibility=hidden -Wno-unused-but-set-variable -Wno-unused-parameter\")\nendif()\n\n# Clang\nif(\"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"Clang\")\n # For Clang, need to additionally check version to avoid compiler bugs\n if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 3.5)\n message(FATAL_ERROR \"Clang version must be at least 3.5 to avoid known bugs.\")\n endif()\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -g -O2 -fvisibility=hidden -Wall -Wextra -Wunused -Wno-unused-parameter -Wno-null-pointer-subtraction\")\nendif()\n\n# Visual Studio\nif(MSVC)\n set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)\n # Disable specific warnings\n set(MSVC_FLAGS\n \"/wd4250\"\t\t\t\t\t\t# inherits via dominance (rampant in the GTKMM codebase)\n \"/wd4101\"\t\t\t\t\t\t# unreferenced local variable\n \"/wd4244\"\t\t\t\t\t\t# conversion from x to y, possible loss of data\n \"/wd4267\"\t\t\t\t\t\t# same as 4244\n \"/wd4305\"\t\t\t\t\t\t# truncation from '' to 'char'\n \"/wd4309\"\t\t\t\t\t\t# truncation of constant value\n \"/wd4390\"\t\t\t\t\t\t# empty control statement, due to a DEBUG macro which requires trailing ;\n \"/wd4996\"\t\t\t\t\t\t# deprecated POSIX functions\n \"-D_CRT_SECURE_NO_WARNINGS\"\t\t# don't warn about deprecated functions\n \"-D_SCL_SECURE_NO_WARNINGS\"\t\t# don't warn about unsafe function calls (e.g. std::copy with raw pointers)\n \"-DNOMINMAX\"\t\t\t\t\t# prevent windows headers from defining min and max macros\n \"-DWIN32_LEAN_AND_MEAN\"\t\t\t# stop windows from including a bunch of garbage\n \"-DBOOST_ALL_DYN_LINK\"\t\t\t# ensure boost's auto-linking is enabled\n )\n foreach(FLAG ${MSVC_FLAGS})\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} ${FLAG}\")\n endforeach()\nendif()\n\n\n#---------------------------------------------------------------------------\n# Configure the various parts of Cadabra.\n#---------------------------------------------------------------------------\n\n# if(MATHEMATICA_FOUND)\n# # To avoid issues finding Mathematica's libWSTP64i4,\n# # when linking to Mathematica we set the RPATH.\n# # That's not something we want to do in general, as e.g. Debian's\n# # packages are not supposed to set RPATH.\n# SET(CMAKE_SKIP_BUILD_RPATH FALSE)\n# SET(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)\n# SET(CMAKE_INSTALL_RPATH \"${CMAKE_INSTALL_PREFIX}/lib\")\n# SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)\n# endif()\n\nconfigure_file(\n\t\"${CMAKE_CURRENT_SOURCE_DIR}/config/postinst.in\"\n\t\"${CMAKE_CURRENT_BINARY_DIR}/postinst\"\n\t@ONLY\n)\nconfigure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/config/install_script.iss.in\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/config/install_script.iss\"\n )\nconfigure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/config/pre_install.rtf.in\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/config/pre_install.rtf\"\n )\nconfigure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/config/science.cadabra.cadabra2-gtk.desktop.in\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/config/science.cadabra.cadabra2-gtk.desktop\"\n )\nconfigure_file(\n \"${CMAKE_CURRENT_SOURCE_DIR}/frontend/gtkmm/science.cadabra.cadabra2-gtk.appdata.xml.in\"\n \"${CMAKE_CURRENT_SOURCE_DIR}/frontend/gtkmm/science.cadabra.cadabra2-gtk.appdata.xml\" \n)\n\n\n#---------------------------------------------------------------------------\n# Configure Mathematica (if enabled).\n#---------------------------------------------------------------------------\n\nif(ENABLE_MATHEMATICA)\n print_header(\"Configuring Mathematica\")\n cmake_policy(SET CMP0077 NEW)\n set(Mathematica_USE_STATIC_LIBRARIES TRUE)\n find_package(Mathematica COMPONENTS WSTP)\nendif()\n\n\n#---------------------------------------------------------------------------\n# Configure Python.\n#---------------------------------------------------------------------------\n\nprint_header(\"Configuring Python\")\n\ninclude(GNUInstallDirs)\n\nset(Python_POSTFIX \"3\")\nfind_package(Python REQUIRED COMPONENTS Interpreter Development)\nset(PYTHON_EXECUTABLE ${Python_EXECUTABLE} CACHE INTERNAL \"\")\nset(PYBIND11_PYTHON_VERSION ${Python_VERSION} CACHE INTERNAL \"\")\nfind_package(pybind11 CONFIG)\nif (NOT pybind11_FOUND OR pybind11_VERSION VERSION_LESS 2.13.6)\n if(pybind11_FOUND)\n message(STATUS \"Found pybind11 with version ${pybind11_VERSION} < 2.13.6, using included pybind11 instead.\")\n else()\n message(STATUS \"System-supplied pybind11 not found, using included pybind11.\")\n endif()\n add_subdirectory(libs/pybind11)\nendif()\n\nmessage(STATUS \"Found python ${Python_LIBRARIES}\")\nmessage(STATUS \"Python version is ${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}.\")\n\n# The PYTHON_SITE_PATH variable is used for installation purposes\n# only. It is ideally a path relative to CMAKE_INSTALL_PREFIX, not an\n# absolute path which uses this variable explictly. See the CMake docs\n# for `install`.\nif(WIN32)\n set(PYTHON_SITE_PATH lib/python${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}/site-packages)\n # NOTE: if you change the CDB_BIN_PATH, you also need to change the stripping\n # logic in InstallPrefix.cc. Note that CDB_BIN_PATH needs to be a relative path.\n set(CDB_BIN_PATH .)\nelse()\n set(CDB_BIN_PATH bin)\n if(PACKAGING_MODE AND IS_DEBIAN_PACKAGE)\n # Debian packages install all their Python things in 'dist-packages', not 'site-packages'.\n set(PYTHON_SITE_PATH lib/python${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}/dist-packages)\n # set(Python_SITE_DIST \"dist-packages\")\n elseif(APPIMAGE_MODE)\n set(PYTHON_SITE_PATH lib/python${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}/dist-packages)\n set(Python_SITE_DIST \"dist-packages\")\n else()\n # The builder can override the path by setting it externally.\n if(NOT DEFINED PYTHON_SITE_PATH)\n # set(PYTHON_SITE_PATH ${Python_SITEARCH})\n # For everyone else there is 'site-packages' which we get from\n # calling into python's 'site' package (and hoping that the 0th\n # element is where we should be writing).\n execute_process(\n\tCOMMAND ${Python_EXECUTABLE} -c \"import site; print(site.getsitepackages()[0])\"\n\tOUTPUT_VARIABLE PYTHON_SITE_PATH\n\tOUTPUT_STRIP_TRAILING_WHITESPACE\n )\n endif()\n endif()\nendif()\nif(IS_ABSOLUTE ${PYTHON_SITE_PATH})\n # CPack on windows complains if `install` commands contain absolute paths,\n # so we do our best to make PYTHON_SITE_PATH relative to CMAKE_INSTALL_PREFIX.\n # Of course, the net effect will be the same, as `install` with a relative\n # DESTINATION will prepend CMAKE_INSTALL_PREFIX.\n message(STATUS \"Making PYTHON_SITE_PATH relative if possible\")\n string(REPLACE \"${CMAKE_INSTALL_PREFIX}/\" \"\" PYTHON_SITE_PATH_REL \"${PYTHON_SITE_PATH}\")\n set(PYTHON_SITE_PATH ${PYTHON_SITE_PATH_REL})\nelse()\n message(STATUS \"PYTHON_SITE_PATH is already relative\")\nendif()\n\nmessage(STATUS \"PYTHON_SITE_PATH = ${PYTHON_SITE_PATH}\")\nif(IS_ABSOLUTE ${PYTHON_SITE_PATH})\n message(STATUS \"Installing Cadabra Python module in ${PYTHON_SITE_PATH}\")\n message(STATUS \"Installing Cadabra packages in ${PYTHON_SITE_PATH}/cdb/\")\nelse()\n message(STATUS \"Installing Cadabra Python module in ${CMAKE_INSTALL_PREFIX}/${PYTHON_SITE_PATH}\")\n message(STATUS \"Installing Cadabra packages in ${CMAKE_INSTALL_PREFIX}/${PYTHON_SITE_PATH}/cdb/\")\nendif()\nmessage(STATUS \"Installing binaries in ${CMAKE_INSTALL_PREFIX}/bin/\")\nmessage(STATUS \"Installing manual pages in ${CMAKE_INSTALL_PREFIX}/share/man/\")\nmessage(STATUS \"Installing fonts/icons in ${CMAKE_INSTALL_PREFIX}/share/cadabra2/\")\nif(\"${Python_CDB_EXECUTABLE}\" STREQUAL \"\")\n # We start the cadabra2 python script by using the current environment,\n # so that e.g. Fedora 42 does not hard-code the python path as a\n # dependency. However, on macOS with Homebrew, we need to be able\n # to override this because otherwise we will not be running in the\n # venv which homebrew created for our package. See cadabra2.rb and\n # cadabra2-devel.rb where this is used.\n set(Python_CDB_EXECUTABLE \"/usr/bin/env python3\")\nendif()\nmessage(STATUS \"Starting cadabra2 using '${Python_CDB_EXECUTABLE}'\")\nmessage(STATUS \"For reference:\")\nmessage(STATUS \" Python executable (Python_EXECUTABLE) ${Python_EXECUTABLE}\")\nmessage(STATUS \" Python standard platform-independent installation directory (Python_STDLIB) ${Python_STDLIB}\")\nmessage(STATUS \" Python standard platform-dependent installation directory (Python_STDARCH) ${Python_STDARCH}\")\nmessage(STATUS \" Python 3rd-party platform-independent installation directory (Python_SITELIB) ${Python_SITELIB}\")\nmessage(STATUS \" Python 3rd-party platform-dependent installation directory (Python_SITEARCH) ${Python_SITEARCH}\")\n# We need to give our Python module an abi-name extension\n# so that it can be installed in a folder which does not\n# contain the abi name. See\n# https://www.python.org/dev/peps/pep-3149/\nexecute_process(\n\tCOMMAND ${Python_EXECUTABLE} -c \"import sysconfig; print(sysconfig.get_config_var('SOABI'))\"\n\tOUTPUT_VARIABLE Python_SOABI\n\tOUTPUT_STRIP_TRAILING_WHITESPACE\n\t)\nmessage(STATUS \"Python abi name ${Python_SOABI}\")\n\n# Suffixes\nif(WIN32)\n\tset(STATIC_LIB_SUFFIX \"lib\")\n\tset(SHARED_LIB_SUFFIX \"dll\")\n\tset(Python_MOD_SUFFIX \"pyd\")\n\tset(CMAKE_FIND_LIBRARY_PREFIXES \"lib\" ${CMAKE_FIND_LIBRARY_PREFIXES})\n\tset(CMAKE_SHARED_LIBRARY_SUFFIX \".dll\")\n\tset(CMAKE_FIND_LIBRARY_SUFFIXES \".dll.a\")\nelse()\n\tset(STATIC_LIB_SUFFIX \"a\")\n\tset(SHARED_LIB_SUFFIX \"so\")\n\tset(Python_MOD_EXT \"so\") \n\tset(Python_MOD_SUFFIX \"${Python_SOABI}.so\")\nendif()\n\nmessage(STATUS \"Python module extension ${Python_MOD_SUFFIX}\")\n\n\n#---------------------------------------------------------------------------\n# Add subdirectories to project.\n#---------------------------------------------------------------------------\n\nprint_header(\"Build tools and options\")\n# Mimalloc makes the cadabra2 module crash when run\n# as jupyter kernel, so disable for now.\n#find_package(mimalloc 2.0 QUIET)\nif(mimalloc_FOUND)\n message(STATUS \"Using mimalloc allocator\")\nelse()\n message(STATUS \"Using glibc allocator\")\nendif()\nfind_package(Catch2 3 QUIET) # This is optional; we will not run the C++ tests if Catch2 is not found\nif(Catch2_FOUND)\n message(STATUS \"Will run C++ tests with Catch2\")\n include(Catch)\nelse()\n message(STATUS \"Catch2 not found, will not run C++ tests\")\nendif()\n\n# Jupyter kernel\nprint_header(\"Configuring Jupyter kernel\")\nif(ENABLE_JUPYTER)\n message(STATUS \"Building the Xeus-based Jupyter kernel\")\n # Currently only possible when building against Conda.\n set(CONDA_FOUND TRUE)\nelse()\n set(CONDA_FOUND FALSE)\n if(ENABLE_PY_JUPYTER)\n message(STATUS \"Building the default Jupyter kernel\")\n else()\n message(STATUS \"Not building a Jupyter kernel\")\n endif()\nendif()\nif(ENABLE_PY_JUPYTER)\n add_subdirectory(jupyterkernel)\nendif()\n\n# Core/packages\nadd_subdirectory(client_server)\nadd_subdirectory(core)\n\n# Frontend\nif(ENABLE_FRONTEND)\n set(ENABLE_MICROTEX TRUE)\n if(ENABLE_MICROTEX)\n set(USE_MICROTEX TRUE)\n set(tinyxml2_BUILD_TESTING FALSE)\n endif()\n add_subdirectory(frontend)\nendif()\n\n# Tests\nif(BUILD_TESTS)\n add_subdirectory(tests)\nendif()\n\nadd_subdirectory(web2 EXCLUDE_FROM_ALL)\n\n# Generate the core/Config.hh file; this needs to come as late as possible\n# in this CMakeLists.txt to ensure that all variables have been set.\nconfigure_file(\n\t\"${PROJECT_SOURCE_DIR}/core/Config.hh.in\"\n\t\"${PROJECT_SOURCE_DIR}/core/Config.hh\"\n)\n\n# Some additional logic to install all runtime dependencies of our binaries\n# into the target installation directory on windows. \nif(WIN32)\n set(EXECUTABLES\n core/cadabra2-cli\n core/cdb-nbtool\n client_server/cadabra-server\n frontend/gtkmm/cadabra2-gtk\n )\n list(JOIN EXECUTABLES \" \" LEXECUTABLES)\n # Custom command to run ldd, get dependencies, and install these in a\n # folder ready to be processed by `install`. The 'ldd' command does not\n # run on the '*.pyd' file, but if we rename or copy it to have extension '.dll'\n # all goes through fine...\n set(LDDSTR \"ldd /${MSYS_ENV}/lib/gdk-pixbuf-2.0/2.10.0/loaders/pixbufloader_svg.dll core/cadabra2.dll ${LEXECUTABLES} | sed -e '/not found/d' -e '/Windows/d' -e '/System32/d' -e '/SysWOW64/d' | grep '=>' | sed -e 's/^[^=]*=>[ ]*\\\\([^ ]*\\\\).*/\\\\1/' | sort | uniq > ${CMAKE_BINARY_DIR}/ldd_dependencies.txt\")\n message(STATUS \"Determining dependencies using command ${LDDSTR}\")\n add_custom_command(\n OUTPUT dummy1\n COMMAND cp core/cadabra2.pyd core/cadabra2.dll\n COMMAND ${CMAKE_COMMAND} -E env bash -c \"${LDDSTR}\"\n COMMAND touch dummy1\n VERBATIM\n DEPENDS core/cadabra2.pyd ${EXECUTABLES}\n COMMENT \"Using ldd to determine dependencies of ${EXECUTABLES}\"\n )\n add_custom_command(\n OUTPUT dummy2\n DEPENDS dummy1\n COMMAND ${CMAKE_COMMAND} -E env bash -c \"cat ${CMAKE_BINARY_DIR}/ldd_dependencies.txt && mkdir -p ${CMAKE_SOURCE_DIR}/deps && for f in `cat ${CMAKE_BINARY_DIR}/ldd_dependencies.txt`; do cp \\${f} ${CMAKE_SOURCE_DIR}/deps/; done\"\n COMMAND touch dummy2\n VERBATIM\n COMMENT \"Copying dependencies into ${CMAKE_SOURCE_DIR}/deps\"\n )\n add_custom_target(\"do_deps\" ALL DEPENDS dummy2)\n \n # Install all the dependencies into the root destination folder.\n install(DIRECTORY deps/ DESTINATION . FILES_MATCHING PATTERN \"*.dll\") \n\n # And install a few more which, for reasons unknown, are not reported by dll.\n install(CODE \"execute_process(COMMAND ls \\\"/${MSYS_ENV}/bin\\\") \" )\n winstall(FILES /${MSYS_ENV}/bin/libcharset-1.dll DESTINATION .)\n winstall(FILES /${MSYS_ENV}/bin/librsvg-2-2.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libxml2-2.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/liblzma-5.dll DESTINATION .)\n # FIXME: these can be found by running ldd on numpy and matplotlib dlls.\n winstall(FILES /${MSYS_ENV}/bin/libopenblas.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libgomp-1.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libgfortran-5.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libquadmath-0.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libsharpyuv-0.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libjpeg-8.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libtiff-6.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libdeflate.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libjbig-0.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libLerc.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libwebp-7.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libzstd.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libimagequant.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libopenjp2-7.dll DESTINATION .) \n\n # These are necessary only on ARM64.\n winstall(FILES /${MSYS_ENV}/bin/libgmp-10.dll DESTINATION .) \n winstall(FILES /${MSYS_ENV}/bin/libgmpxx-4.dll DESTINATION .) \n \n # We need gdbus to setup the dbus, needed by Glib, otherwise anything\n # gtk-related will just bail out at start. We also need the helper\n # program to spawn programs using Glib.\n winstall(FILES /${MSYS_ENV}/bin/gdbus.exe DESTINATION .)\n winstall(FILES /${MSYS_ENV}/bin/gspawn-win64-helper.exe DESTINATION .)\n winstall(FILES /${MSYS_ENV}/bin/gspawn-win64-helper-console.exe DESTINATION .)\n winstall(FILES /${MSYS_ENV}/bin/gdk-pixbuf-query-loaders.exe DESTINATION .)\nendif()\n \n#---------------------------------------------------------------------------\n# Provide uninstall target.\n#---------------------------------------------------------------------------\n\nconfigure_file(\n\t\"${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in\"\n\t\"${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake\"\n\tIMMEDIATE @ONLY\n)\n\nadd_custom_target(uninstall\n\t\"${CMAKE_COMMAND}\" -P \"${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake\"\n)\n\n#---------------------------------------------------------------------------\n# Provide target to build AppImage.\n#---------------------------------------------------------------------------\n\n# if(APPIMAGE_MODE)\n# add_custom_target(appimage\n# COMMAND mkdir -p AppDir/${Python_SITELIB}\n# COMMAND cp -a ${CMAKE_SOURCE_DIR}/config/AppRun AppDir/\n# COMMAND chmod gou+x ${CMAKE_SOURCE_DIR}/config/AppRun AppDir/AppRun\n# COMMAND cp -a ${Python_SITELIB}/setuptools AppDir/${Python_SITELIB}/\n# COMMAND cp -a ${Python_STDARCH}/* AppDir/${Python_STDARCH}/\n# )\n# endif()\n\nif(WIN32)\n add_custom_target(windows-installer\n COMMAND cpack\n# COMMAND osslsigncode sign -pkcs12 \"/mnt/c/path/to/certificate.p12\" -pass \"certificate password\" -n \"Cadabra2\" -i \"https://cadabra.science\" -t \"http://timestamp.comodoca.com/authenticode\" -in \"cadabra2-${CADABRA_VERSION_SEM}-win64.exe\" -out \"cadabra2-${CADABRA_VERSION_SEM}-win64-installer.exe\"\n COMMAND gh auth setup-git\n COMMAND release upload \"${CADABRA_VERSION_SEM}\" cadabra2-${CADABRA_VERSION_SEM}-win64.msi --clobber\n )\nendif()\n\nprint_header(\"All scripts completed\")\n"
},
{
"path": "CODE_OF_CONDUCT.md",
"content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at kasper.peeters@phi-sci.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
},
{
"path": "CONTRIBUTING.md",
"content": "How to contribute\n=================\n\nIf you want to help out with Cadabra, or think you can contribute a\nuseful add-on package or perhaps just a sample notebook or a bit of\ndocumentation, you are more than welcome! Even just dropping us a\nnote with some details about what computations you do with Cadabra\nis a useful contribution, and helps to get a better idea of what\npeople expect from the software. \n\nBelow are some tips on how to get started contributing to Cadabra. For\nany questions, please post in the [questions and answers][1] forum or\nget in touch directly via [email][2]\n\n\nGet familiar with the software\n------------------------------\n\nThe first thing to do is to get familiar with how the software works,\nby playing with the [tutorials][3] Details of the software, including\nsome of the logic that is behind its inner workings, are described in\nthe [reference guide][4], and documentation is available separately\nfor all [properties and algorithms][5]. If you get stuck, do not\nhesitate to post a question on the [questions and answers][1] site. If\nyou want to contribute at the level of the C++ core, or if you are\nsimply interested in how things work behind the scenes, you will find\nthe [doxygen][6] documentation useful.\n\n\nIdentify something to work on\n-----------------------------\n\nMost likely you will have used (or will have tried to use) Cadabra for\na concrete project, and found that you see room for improvement. This\ncan be as simple as reporting a bug, perhaps even fixing it, or adding\na tutorial or other documentation, providing add-on functionality in\nthe form of packages, or helping with the core. We are also always\ninterested to hear about issues installing Cadabra on new systems.\n\n\nSetup your development environment\n----------------------------------\n\nContributions in any form are welcome, but if you want to submit\nsubstantial code contributions, it is useful to get familiar with the\ngit version control system. This is used to track software changes\nover time and to effectively manage contributions from different\nauthors. We also utilise [github][7], a web interface to git,\nextensively and use it for communication, issue tracking, merging\npatches (pull requests) and so on. Check out the source code from\nthere and follow the instructions on how to build it.\n\n\nCode conventions\n----------------\n\nTo generate debug output, we use the [dbg][8] facility. To turn this\non for a particular source file, comment out the `DBG_MACRO_DISABLE`\ndefinition at the top. You will then get nicely formatted debug output\nwhile running.\n\nCode is formatted using tabs for indentation, K&R style braces,\nwith some fine-tuning. All is taken care of by `make format` in the\ntop-level directory, which runs through the entire source tree and\ndoes a reformat using `astyle`.\n\n\nDocumentation\n-------------\n\nWe have tutorials, manual pages and reference documentation. In\naddition, there are user-contributed notebooks. In this sense, we try\nto follow [divio][9]. Contributions to all of these parts of the\ndocumentation are welcome.\n\n\n[1] https://cadabra.science/qa/\n[2] mailto:info@cadabra.science\n[3] https://cadabra.science/tutorials.html\n[4] https://cadabra.science/help.html\n[5] https://cadabra.science/man.html\n[6] https://cadabra.science/doxygen/html/\n[7] https://github.com/kpeeters/cadabra2\n[8] https://github.com/sharkdp/dbg-macro\n[9] https://www.divio.com/blog/documentation/\n"
},
{
"path": "JUPYTER.rst",
"content": "Building the Cadabra Jupyter kernel\n===================================\n\nThe Cadabra build scripts can now build a Jupyter kernel, so that you\ncan use the Jupyter notebook to write Cadabra code (using all of the\nCadabra notation, i.e. without having to resort to the much more ugly\nPython interface). At the moment this is only supported by compiling\nagainst a Conda python, simply because that enables us to build on the\n'xeus' library more easily.\n\nBuilding a Conda package\n------------------------\n\nAfter installation, first activate your miniconda distribution::\n\n source ~/miniconda3/bin/activate\n\nAll dependencies to build a Conda package of Cadabra can then be\ninstalled from Conda directly, with::\n\n conda install conda-build\n\nThen build with::\n\n cd conda\n conda-build .\n \nTo install::\n\n conda install --use-local cadabra2\n\n\n\n \n\nBuilding using Conda (old)\n--------------------------\n\nThe following instructions have been tested on a clean Ubuntu 18.04\ninstallation.\n\nThe Cadabra Jupyter kernel uses the Xeus library, which is most easily\nobtained by getting it from Conda. If you do not have Conda yet, get\na minimal installation (MiniConda) from\n\n https://docs.conda.io/en/latest/miniconda.html\n\n(install a Python3.x version). \n\nWhen building against Conda, Cadabra will build only the Python module\nand the cadabra-jupyter-kernel binary. It is not possible to build\nmany of the other parts of Cadabra using Conda, for various reasons:\nConda's glibmm is not built with C++11 enabled, there is no gtkmm\nlibrary, and probably others. For a discussion on this, see\n\n https://groups.google.com/a/continuum.io/d/msg/anaconda/oHtExJU9oiM/oMZLGpn1CAAJ\n\nand if you don't think this is a problem, see e.g.\n\n https://unix.stackexchange.com/questions/414904/anaconda-qt-vs-system-qt\n\nAfter installation, first activate your miniconda distribution::\n\n source ~/miniconda3/bin/activate\n\nAll dependencies for Cadabra's Jupyter kernel can then be installed from\nConda directly, with::\n\n conda install cmake pkg-config glibmm zeromq cppzmq xtl cryptopp \\\n\t sqlite util-linux xeus nlohmann_json sympy \\\n\t\t\t\t\t\tjupyter -c conda-forge\n\t \nNow it is time to do the Cadabra build. Configure with options which\nensure that CMake picks up the Conda libraries first, and make it\ninstall the Cadabra things in a place which does not interfere with\nany 'normal' build you may have sitting around::\n\n cd cadabra2\n mkdir build\n cd build\n cmake -DENABLE_JUPYTER=ON -DENABLE_FRONTEND=OFF \\\n -DCMAKE_INCLUDE_PATH=${HOME}/miniconda3/include \\\n -DCMAKE_LIBRARY_PATH=${HOME}/miniconda3/lib \\\n -DCMAKE_INSTALL_PREFIX=${HOME}/miniconda3 \\\n ..\n\nYou should see that it has configured using the Conda Python; look for\nthe `Configuring Python` block, which should be something like::\n\n -------------------------------------------\n Configuring Python\n -------------------------------------------\n -- Building for use with Python 3 (good!)\n -- Found PythonInterp: /home/kasper/miniconda3/bin/python3.7 (found version \"3.7.1\") \n -- Found PythonLibs: /home/kasper/miniconda3/lib/libpython3.7m.so\n -- pybind11 v2.3.dev0\n -- Found python /home/kasper/miniconda3/lib/libpython3.7m.so\n\nNote the reference to the Conda installation path. Further down you\nshould then also see a block for the Jupyter kernel::\n\n -------------------------------------------\n Configuring Jupyter kernel build\n -------------------------------------------\n \nIf that's all ok, you can build with the standard::\n\n make\n sudo make install\n\nThis will install the kernel in::\n\n ${HOME}/miniconda3/bin/\n\nand the JSON configuration files in::\n\n ${HOME}/miniconda3/share/jupyter/kernels/cadabra/\n\nIf you now start Jupyter, you should be able to choose a Cadabra\nkernel::\n\n ${HOME}/miniconda3/bin/jupyter notebook\n\nThere is a sample `schwarzschild.ipynb` in the `examples` directory.\t\n\n\n\nSetting up a Jupyterhub server for Cadabra\n------------------------------------------\n\nThe following instructions setup a JupyterHub installation using 'The\nLittlest JupyterHub' (TLJH). These instructions have been tested on a\nclean Ubuntu 18.04 installation.\n\nFirst install TLJH as per the instructions at::\n\n https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/custom-server.html\n\n(note that you *first* need to do a sudo command, otherwise the\ninstaller will ask for the password but you won't see that prompt,\nmaking it look like the installation process hangs).\n\n*New*: it should now also be possible to simply install the conda\npackage for the Jupyter kernel. *New*\n\nBecome root (you cannot write into `/opt/tljh` otherwise) and set the\nconda path using::\n\n sudo su\n export PATH=/opt/tljh/user/bin:${PATH}\n\nInstall the prerequisites with::\n\n conda install cmake pkg-config glibmm zeromq cppzmq xtl cryptopp \\\n\t sqlite util-linux xeus nlohmann_json sympy \\\n\t\t\t\t\t\t-c conda-forge\n\t \nBuild the Cadabra Jupyter kernel with::\n \n cd cadabra2\n mkdir build\n cd build\n cmake -DENABLE_JUPYTER=ON -DENABLE_FRONTEND=OFF \\\n -DCMAKE_INCLUDE_PATH=/opt/tljh/user/include \\\n -DCMAKE_LIBRARY_PATH=/opt/tljh/user/lib \\\n -DCMAKE_INSTALL_PREFIX=/opt/tljh/user/ \\\n ..\n make install\n\nThe 'new' button in the Jupyterhub file browser should now offer you\nthe option of creating a new Cadabra notebook.\n\n\nCreating a Conda package of the Cadabra Jupyter kernel\n------------------------------------------------------\n\nTo build a Conda package of the Cadabra Jupyter kernel from scratch,\nfirst install miniconda as above, and activate::\n\n source ~/miniconda3/bin/activate\n\nNow the fun starts. Conda is an absolutely horrendous packaging\nsystem, which absolutely does *not* get dependencies right, but we\nwill have to live with it. First, update the base conda distribution::\n\n conda update -n base -c defaults conda \n conda update --all\n\nThen activate the `conda-forge` channel, and update to the latest of\neverything::\n\n conda config --add channels conda-forge\n conda update --all\n\nDo *not* use `conda config --set channel_priority strict` as that\n*will* break the build with an endless list of package conflicts.\nThere are other ways to add the conda-forge channel, all subtly\ndifferent; avoid adding `-c conda-forge` as that is just broken beyond\nbelief too. Now install the prerequisites for building conda\npackages::\n\n conda install conda-build anaconda-client \\\n xeus pkg-config glibmm\n\nThat last line should not have been necessary, as build requirements\nin `meta.yaml` should have taken care of it, but alas, it does not\nwork that way. It spits out various messages about packages being\n*downgraded*; don't ask, I told you the system was broken.\n\nNow change to the `conda` directory and build the package::\n\n cd cadabra2/conda\n export PKG_CONFIG_PATH=${HOME}/miniconda3/lib/pkgconfig\n conda build .\n\nAgain, that path setting should have been handled automatically...\nTo upload::\n\n anaconda login\n anaconda upload /path/to/conda-package.tar.bz2\n\n\n"
},
{
"path": "LICENSE",
"content": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n {one line to give the program's name and a brief idea of what it does.}\n Copyright (C) {year} {name of author}\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n {project} Copyright (C) {year} {fullname}\n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n.\n"
},
{
"path": "Makefile",
"content": "\nall:\n\t@echo -n \"\\nTo build Cadabra, \\n\\n mkdir build\\n cd build\\n cmake ..\\n make\\n\\nThe other targets here are (for maintainer purposes only)\\n\\n tarball: build a tarball cadabra2-latest.tar.gz of current HEAD\\n doc: generate doxygen docs in doc\\n webup: build web pages/tutorials/man pages and upload to server\\n updatesnoop: sync snoop repo\\n packages: create deb/rpm packages on buildbot\\n\\nIf you need help, email info@cadabra.science\\n\\n\"\n\n.PHONY: doc tarball findclay webbuild claybuild webup format packages updatesnoop\n\ntarball:\n\tgit archive --format=tar --prefix=cadabra2-latest/ HEAD | gzip > ${HOME}/tmp/cadabra2-latest.tar.gz\n\ndoc:\n\tdoxygen config/Doxyfile\n\nwebbuild:\n\tcd build; make -f web2/Makefile\n\nclaybuild:\n\tcd web2/cadabra2/source; rm -Rf build; clay build\n\nCMD_NOT_FOUND = $(error $(1) is required for this rule)\nCHECK_CMD = $(if $(shell command -v $(1)),,$(call CMD_NOT_FOUND,$(1)))\n\nfindclay:\n\t$(call CHECK_CMD, clay)\n\nwebup: findclay webbuild claybuild\n\tdoxygen config/Doxyfile\n\trsync -avz --chmod=+rx doxygen/ cadabra_web:/var/www/cadabra2/doxygen/\n\tcd web2/cadabra2/source; rsync -avz --chmod=+rx build/ cadabra_web:/var/www/cadabra2/; rsync -avz --chmod=+rx static/styles/ cadabra_web:/var/www/cadabra2/static/styles; scp static/cadabra_in* cadabra_web:/var/www/cadabra2/static/; rsync -avz --chmod=+rx static/fonts/ cadabra_web:/var/www/cadabra2/static/fonts; rsync -avz --chmod=+rx static/images/ cadabra_web:/var/www/cadabra2/static/images/; rsync -avz --chmod=+rx static/icons/ cadabra_web:/var/www/cadabra2/static/icons/; rsync -avz --chmod=+rx static/pdf/ cadabra_web:/var/www/cadabra2/static/pdf/; rsync -avz --chmod=+rx static/js/ cadabra_web:/var/www/cadabra2/static/js/; rsync -avz --chmod=+r static/robots.txt cadabra_web:/var/www/cadabra2\n\nformat:\n\tastyle --style=k/r --indent=tab=3 --recursive --attach-classes --attach-namespaces --indent-classes --indent-namespaces --indent-switches --break-closing-braces '*.hh'\n\tastyle --style=k/r --indent=tab=3 --recursive --attach-classes --attach-namespaces --indent-classes --indent-namespaces --indent-switches --break-closing-braces '*.cc'\n\tfind . -name \"*.cc\" -exec sed -i -e 's/^\\([ \\t]*\\)\\([\\{\\}]\\)/\\1\\t\\2/' '{}' ';'\n\tfind . -name \"*.hh\" -exec sed -i -e 's/^\\([ \\t]*\\)\\([\\{\\}]\\)/\\1\\t\\2/' '{}' ';'\n\npackages:\n\tbash config/buildbot.sh\n\nappimage:\n\t(mkdir build-appimage; cd build-appimage; cmake -DAPPIMAGE_MODE=ON -DCMAKE_INSTALL_PREFIX=/usr ..; make; make install DESTDIR=AppDir; make appimage)\n\nupdatesnoop:\n\tcp ../snoop/src/Snoop.cc ../snoop/src/SnoopPrivate.hh ../snoop/src/Snoop.hh client_server/\n"
},
{
"path": "README.rst",
"content": "Cadabra\n=======\n\n.. image:: https://joss.theoj.org/papers/10.21105/joss.01118/status.svg\n :target: https://doi.org/10.21105/joss.01118\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2500762.svg\n :target: https://doi.org/10.5281/zenodo.2500762\n\n.. image:: https://github.com/kpeeters/cadabra2/workflows/Linux/badge.svg\n :target: https://github.com/kpeeters/cadabra2/actions?query=workflow%3ALinux\n\n.. image:: https://github.com/kpeeters/cadabra2/workflows/macOS/badge.svg\n :target: https://github.com/kpeeters/cadabra2/actions?query=workflow%3AmacOS\n\n.. image:: https://github.com/kpeeters/cadabra2/workflows/Docker/badge.svg\n :target: https://github.com/kpeeters/cadabra2/actions?query=workflow%3ADocker\n\n.. image:: https://github.com/kpeeters/cadabra2/workflows/Windows%2011/badge.svg\n :target: https://github.com/kpeeters/cadabra2/actions?query=workflow%3AWindows%2011\n\n.. image:: https://github.com/kpeeters/cadabra2/workflows/FreeBSD/badge.svg\n :target: https://github.com/kpeeters/cadabra2/actions?query=workflow%3AFreeBSD\n\n*A field-theory motivated approach to computer algebra.*\n\nKasper Peeters \n\n- End-user documentation at https://cadabra.science/\n- Source code documentation at https://cadabra.science/doxygen/html\n\nThis repository holds the 2.x series of the Cadabra computer algebra\nsystem. It supersedes the 1.x series, which can still be found at\nhttps://github.com/kpeeters/cadabra.\n\nCadabra is a symbolic computer algebra system, designed specifically\nfor the solution of problems encountered in quantum and classical\nfield theory. It has extensive functionality for tensor computer\nalgebra, tensor polynomial simplification including multi-term\nsymmetries, fermions and anti-commuting variables, Clifford algebras\nand Fierz transformations, implicit coordinate dependence, multiple\nindex types and many more. The input format is a subset of TeX. Both a\ncommand-line and a graphical interface are available, and there is a\nkernel for Jupyter.\n\n\nInstallation\n-------------\n\nCadabra builds on Linux, macOS, OpenBSD, FreeBSD and Windows. Select\nyour system from the list below for detailed instructions.\n\n- `Linux (Debian/Ubuntu/Mint)`_\n- `Linux (Fedora 24 and later)`_\n- `Linux (CentOS/Scientific Linux)`_\n- `Linux (openSUSE)`_\n- `Linux (Arch/Manjaro)`_\n- `Linux (Solus)`_\n- `OpenBSD`_\n- `FreeBSD`_\n- `macOS`_\n- `Windows`_\n\nBinaries for most of these platforms are provided from the download\npage at https://cadabra.science/download.html, which links to\nhttps://github.com/kpeeters/cadabra2/releases/latest. These binaries\nare automatically generated on every release.\n\nSee `Building Cadabra as C++ library`_ for instructions on how to\nbuild the entire Cadabra functionality as a library which you can use\nin a C++ program.\n\nSee `Building a Jupyter kernel`_ for information on the Jupyter kernel\nfor Cadabra sessions.\n\nSee `Notes on Python paths`_ for some remarks on where Cadabra\ninstalls its Python modules and how this plays with various types of\nPython installations.\n\n\nLinux (Debian/Ubuntu/Mint)\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOn Debian/Ubuntu you can install all that is needed with::\n\n sudo apt install git cmake libpython3-dev python3-dev g++ libgmp3-dev \\\n libgtkmm-3.0-dev libboost-all-dev libssl-dev libgmp-dev libsqlite3-dev uuid-dev \\\n python3-matplotlib python3-mpmath python3-sympy python3-gmpy2\n\n(on Ubuntu 14.04 you need to replace `cmake` with `cmake3` and also\ninstall g++-4.9; get in touch if you don't know how to do this). On\nolder systems you may want to install `sympy` using `sudo pip3 install\nsympy`, but that is discouraged in general.\n\t \nThis is the development platform and issues are typically first fixed\nhere. You can use either g++ or the clang++ compiler to build. You need to\nclone the cadabra2 git repository (if you download the .zip file you\nwill not have all data necessary to build). So first do::\n\n git clone https://github.com/kpeeters/cadabra2\n\nBuilding is then done with the standard::\n\n cd cadabra2\n mkdir build\n cd build\n cmake ..\n make\n sudo make install\n\nThis will produce the command line app ``cadabra2`` and the Gtk\nnotebook interface ``cadabra2-gtk``. You can also find the latter in\nthe 'Education' menu.\n\nLinux (Fedora 24 and later)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nFedora 24 is the first Fedora to have Python 3; you can build Cadabra\nusing Python 2 but you are strongly encouraged to upgrade. The Fedora\nplatform receives less testing so please get in touch if you run into\nany issues. You can use either g++ or the clang++ compiler.\n\nInstall the dependencies with::\n\n sudo dnf install git python3-devel make cmake gcc-c++ \\\n gmp-devel libuuid-devel sqlite-devel \\\n gtkmm30-devel boost-devel \\\n python3-matplotlib \\\n python3-pip\n sudo pip3 install sympy\n\nYou need to clone the cadabra2 git repository (if you download the\n.zip file you will not have all data necessary to build). So first do::\n\n git clone https://github.com/kpeeters/cadabra2\n\nBuilding is then done with the standard::\n\n cd cadabra2\n mkdir build\n cd build\n cmake ..\n make\n sudo make install\n\nThis will produce the command line app ``cadabra2`` and the Gtk\nnotebook interface ``cadabra2-gtk``. You can also find the latter\nwhen searching for the 'Cadabra' app from the 'Activities' menu.\n\nLinux (CentOS/Scientific Linux)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOn CentOS/Scientific Linux you need to activate The Software\nCollections (SCL) and Extra Packages for Enterprise Linux (EPEL) to\nget access to a modern C++ compiler, Python3 and all required build\ntools.\n\nOn *CentOS* first do::\n\n sudo yum install centos-release-scl epel-release\n\nOn *Scientific Linux* the equivalent is::\n\n sudo yum install yum-conf-softwarecollections epel-release\n\t \nNow install all build dependencies with::\n \n sudo yum install devtoolset-7 rh-python36 cmake3 \\\n\t gmp-devel libuuid-devel sqlite-devel \\\n gtkmm30-devel boost-devel git \\\n\t python-matplotlib \n\nYou need to enable the Python3 and C++ compiler which you just\ninstalled with::\n\n scl enable rh-python36 bash\t\t\t\t\t\n scl enable devtoolset-7 bash\n\n(note: do *not* use sudo here!).\n\t \nYou also need to install sympy by hand::\n\n sudo pip3 install sympy\n\nNow need to clone the cadabra2 git repository (if you download the\n.zip file you will not have all data necessary to build)::\n\n git clone https://github.com/kpeeters/cadabra2\n\nBuilding is then done with the standard::\n\n cd cadabra2\n mkdir build\n cd build\n cmake3 .. \n make\n sudo make install\n\nThis will produce the command line app ``cadabra2`` and the Gtk\nnotebook interface ``cadabra2-gtk``. You can also find the latter in\nthe 'Education' menu.\n\n\nLinux (openSUSE)\n~~~~~~~~~~~~~~~~\n\nFor openSUSE (tested on 'Leap 15.2', probably also fine with minor\nchanges for 'Tumbleweed') you first need to install the dependencies\nwith::\n\n sudo zypper install --no-recommends git cmake python3-devel gcc-c++ \\\n gmp-devel libuuid-devel sqlite-devel \\\n gtkmm3-devel \\\n python3-matplotlib \\\n python3-sympy \\\n libboost_system1_71_0-devel libboost_filesystem1_71_0-devel \\\n libboost_date_time1_71_0-devel libboost_program_options1_71_0-devel\n\nThis platform receives less testing so please get in touch if you run\ninto any issues. You need to clone the cadabra2 git repository (if you\ndownload the .zip file you will not have all data necessary to\nbuild). So first do::\n\n git clone https://github.com/kpeeters/cadabra2\n\nBuilding is then done with the standard::\n\n cd cadabra2\n mkdir build\n cd build\n cmake .. \n make\n sudo make install\n\nThis will produce the command line app ``cadabra2`` and the Gtk\nnotebook interface ``cadabra2-gtk``. \n\n\nLinux (Arch/Manjaro)\n~~~~~~~~~~~~~~~~~~~~\n\nThe package for Arch Linux is cadabra2\nhttps://aur.archlinux.org/packages/cadabra2/ Building and\ninstalling (including dependencies) can be accomplished with::\n\n yay -S cadabra2\n\nAlternatively use ``makepkg``::\n\n git clone https://aur.archlinux.org/cadabra2.git\n cd cadabra2\n makepkg -si\n\nPlease consult the Arch Wiki\nhttps://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages\nfor more information regarding installing packages from the AUR.\n\n\nLinux (Solus)\n~~~~~~~~~~~~~\n\nSupport for Solux Linux is experimental. To build from source on Solus\nLinux, first install the dependencies by doing::\n\n sudo eopkg install -c system.devel\n sudo eopkg install libboost-devel gmp-devel libgtkmm-3-devel \n sudo eopkg install sqlite3-devel python3-devel\n sudo eopkg install git cmake make g++\n\nThen configure and build with::\n\n cd cadabra2\n mkdir build\n cd build\n cmake .. -DCMAKE_INSTALL_PREFIX=/usr\n make\n sudo make install\n\nThis installs below ``/usr`` (instead of ``/usr/local`` on other\nplatforms) because I could not figure out how to make it pick up\nlibraries there.\n\nAny feedback on these instructions is welcome.\n\n\nOpenBSD\n~~~~~~~\n\nInstall the dependencies with::\n\n pkg_add git cmake boost python-3.6.2 gtk3mm gmp gmpxx py3-sympy\n\nWe will build using the default clang-4.0.0 compiler; building with\nthe alternative g++-4.9.4 leads to trouble when linking against the\nlibraries added with pkg_add.\n\nConfigure and build with::\n\n cd cadabra2\n mkdir build\n cd build\n cmake -DENABLE_MATHEMATICA=OFF ..\n make\n su\n make install\n\nThe command-line version is now available as ``cadabra2`` and the\nnotebook interface as ``cadabra2-gtk``.\n\nAny feedback on this platform is welcome as this is not our\ndevelopment platform and testing is done only occasionally.\n\n\nFreeBSD\n~~~~~~~\n\nThe recommended way to install Cadabra is through::\n\n pkg install cadabra2\n\nIt is also possible to build and install Cadabra from the port::\n\n cd /usr/ports/math/cadabra2 && make install clean\n\nThe command-line version is now available as ``cadabra2`` and the\nnotebook interface as ``cadabra2-gtk``.\n\nAny feedback on this platform is welcome as this is not our\ndevelopment platform.\n\n\nmacOS\n~~~~~\n\nCadabra builds with the standard Apple compiler, on both Intel and\nApple silicon, but you do need a number of packages from Homebrew (see\nhttps://brew.sh). Install the required dependencies with::\n\n brew install cmake boost gmp python3 \n brew install pkgconfig \n brew install gtkmm3 adwaita-icon-theme\n pip3 install sympy gmpy2\n\nIf the lines above prompt you to install XCode, go ahead and let it do\nthat.\n\nYou can build against an Anaconda Python installation (in case you\nprefer Anaconda over the Homebrew Python); cmake will automatically\npick this up if available.\n\nYou need to clone the cadabra2 git repository (if you download the\n.zip file you will not have all data necessary to build). So do::\n\n git clone https://github.com/kpeeters/cadabra2\n\nAfter that you can build with the standard::\n\n cd cadabra2\n mkdir build\n cd build\n cmake -DENABLE_MATHEMATICA=OFF ..\n make\n sudo make install\n\n(*note* the `-DENABLE_MATHEMATICA=OFF` in the `cmake` line above; the\nMathematica scalar backend does not yet work on macOS).\n \nThis will produce the command line app ``cadabra2`` and the Gtk\nnotebook interface ``cadabra2-gtk``. \n\nFeedback from macOS users is *very* welcome because this is not the main\ndevelopment platform.\n\n\nWindows\n~~~~~~~\n\nOn Windows compilation is easiest by using the MSYS2 system, as their\ngtkmm-3.0 packages just work and the whole system can be driven from the\ncommand line. We used to build Cadabra using the vcpkg packages, but\nthey no longer provide packages for gtkmm-3.0, and in general the lack\nof binary packages means that build times are on the order of many, many\nhours, instead of just a few minutes with MSYS2. More info on building and\npackaging gtk apps on windows at https://www.gtk.org/docs/installations/windows/.\n\nInstall MSYS2 from https://www.msys2.org and start a UCRT64 shell.\nFirst update with (if you don't do this you may end up not being able\nto install some of the required packages due to version conflicts)::\n\n pacman -Suy\n\nThen install a compiler and the dependencies of Cadabra with::\n\n pacman -S mingw-w64-ucrt-x86_64-gcc\n pacman -S mingw-w64-ucrt-x86_64-gtkmm3\n pacman -S mingw-w64-ucrt-x86_64-boost \n pacman -S mingw-w64-ucrt-x86_64-sqlite3\n pacman -S mingw-w64-ucrt-x86_64-cmake\n pacman -S mingw-w64-ucrt-x86_64-python\n pacman -S mingw-w64-ucrt-x86_64-python-matplotlib\n pacman -S mingw-w64-ucrt-x86_64-python-sympy\n pacman -S mingw-w64-ucrt-x86_64-osslsigncode\n pacman -S git\n\nCheckout Cadabra and build::\n\n git clone https://github.com/kpeeters/cadabra2\n cd cadabra2\n mkdir build\n cd build\n cmake ..\n ninja\n ninja install\n\nThis will leave an installation in `Program Files (x86)/Cadabra`, from where\nyou can start `cadabra2-gtk`. \n\nTo build an installer, simply run `cpack` after having built\nCadabra. \n \n\nBuilding a Jupyter kernel\n-------------------------\n\nAs of version 2.3.4 the standard build process (as described above)\nalso creates a Jupyter kernel, which is written in Python on top of\n`ipykernel` (thanks to Fergus Baker). This should work on most\nplatforms out-of-the-box; you do not need to do anything else. The\nJupyter kernel allows you to use Cadabra notation inside a Jupyter\nnotebook session.\n\nThe distribution also still contains code for the 'old' Jupyter\nkernel, which is written in C++ on top of `xeus`. Building this kernel\nis more complicated mainly because of this dependency, and there is\nnot much of an advantage over the Python kernel; it's mainly left in\nthe tree for future reference, For full instructions on how to build\nthe old `xeus`-based kernel, see\nhttps://github.com/kpeeters/cadabra2/blob/master/JUPYTER.rst.\n\n\nCreating an AppImage\n--------------------\n\nThe Cadabra build system can create an AppImage for use on a wide\nvariety of Linux distributions (this is used to create the AppImage\nwhich is available from the `releases` on github). This build process\nhas been tested by using Ubuntu 20.04 as base system. Install the\nprerequisites as above,::\n\n sudo apt install git cmake libpython3-dev python3-dev g++ libgmp3-dev \\\n libgtkmm-3.0-dev libboost-all-dev libssl-dev libgmp-dev libsqlite3-dev uuid-dev \\\n python3-matplotlib python3-mpmath python3-sympy python3-gmpy2\n\nNow configure and build with::\n\n cmake -DAPPIMAGE_MODE=ON -DCMAKE_INSTALL_PREFIX=/usr ..\n make\n make install DESTDIR=AppDir\n\nThis installs everything in the `AppDir` folder ready for packaging.\nThen run::\n\n make appimage\n\nto create the AppImage itself. If you run into trouble with this,\nplease first consult the comments in the top-level `CMakeLists.txt`\nfile about `linuxdeploy` and friends.\n\n\n\nTutorials and other help\n------------------------\n\nPlease consult https://cadabra.science/ for tutorial-style notebooks\nand all other documentation, and https://cadabra.science/doxygen/html/\nfor doxygen documentation of the current master branch. The latter can\nalso be generated locally; you will need (on Debian and derivatives)::\n\n sudo apt-get install doxygen libjs-mathjax \n\nFor any questions, please contact info@cadabra.science .\n\n\nBuilding Cadabra as C++ library\n-------------------------------\n\nIf you want to use the functionality of Cadabra inside your own C++\nprograms, you can build Cadabra as a shared library. To do this::\n\n mkdir build-lib\n cd build-lib\n cmake -DBUILD_AS_CPP_LIBRARY=ON ..\n make\n sudo make install\n\nThere is a sample program `simple.cc\n`_\nin the `c++lib` directory which shows how to use the Cadabra library.\n\n\nNotes on Python paths\n---------------------\n\nCadabra tries to play nice with a large variety of Python\ninstallations, which is not an easy task. In general, it will try to\ninstall in such a way that the Python interpreter which is specified\nat build time will be able to import the `cadabra2` Python module\nwithout any change to its path. This is necessary so that e.g. a\nJupyter notebook will be able to find this module. Cadabra will\ntherefore install its Python module in\n`site.getsitepackages()[0]`. Since this module constructs its\ndocstrings dynamically on load, the manual pages are also stored\nrelative to this module.\n\nHowever, Cadabra will install its binaries according to standard\nCMake logic in `$CMAKE_INSTALL_PREFIX/bin/`. On systems that have\nPython installed in subtree which is not below `$CMAKE_INSTALL_PREFIX`,\nthis means that the Cadabra binaries and the Cadabra Python module\nwill not be in the same subtree. This typically happens on systems\nwith Python coming from Homebrew, as these will have Python somewhere\nbelow `/opt/homebrew` even when `$CMAKE_INSTALL_PREFIX` is `/usr/local/`.\n\nOn some systems, users or package managers prefer that\n`site.getsitepackages()[0]` remains under control of the package\nmanager (Homebrew is the typical example). In this case, if you do not\nwant to write there, your only option is to first create a virtual\nenvironment before you run Cadabra's `cmake`.\n\n\nSpecial thanks\n--------------\n\nSpecial thanks to José M. Martín-García (for the xPerm\ncanonicalisation code), James Allen (for writing much of the factoring\ncode), Dominic Price (for the meld algorithm implementation, many\nadditions to the notebook interface, the conversion to pybind and the\nWindows port), Fergus Baker (for the new Jupyter kernel), Isuru\nFernando (for the Conda packaging), the Software Sustainability\nInstitute and the Institute of Advanced Study. Thanks to the many\npeople who have sent me bug reports (keep 'm coming), and thanks to\nall of you who use Cadabra, sent feedback or cited the Cadabra\npapers.\n\nLicenses\n--------\n\nCadabra itself is licensed under the GPL-3.0. It includes some dependencies\nwhich have the following licenses:\n\n* tiny-process-lib [https://gitlab.com/eidheim/tiny-process-library/]\n MIT license\n\n \n"
},
{
"path": "c++lib/.gitignore",
"content": "Makefile\ntreetracker\n"
},
{
"path": "c++lib/CMakeLists.txt",
"content": "cmake_minimum_required(VERSION 3.12)\n\nset(CMAKE_CXX_STANDARD 17)\nproject(Cadabra)\n\n#---------------------------------------------------------------------------\n# Preamble.\n#---------------------------------------------------------------------------\n\n# Set path to additional cmake files\nset(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} \"${CMAKE_CURRENT_SOURCE_DIR}/../cmake/modules\")\n\n# Disable warning 'MACOSX_RPATH is enabled by default'\nif (POLICY CMP0042)\n cmake_policy(SET CMP0042 NEW)\nendif(POLICY CMP0042)\n\n# Disable warning 'Only interpret if() arguments as variables or keywords when unquoted'\nif (POLICY CMP0054)\n cmake_policy(SET CMP0054 NEW)\nendif()\n\n# Ensure that we can build the library and install it without having to\n# build the samples.\nset(CMAKE_SKIP_INSTALL_ALL_DEPENDENCY TRUE)\n\nfind_package(Python REQUIRED COMPONENTS Interpreter Development)\nmessage(STATUS \"Found python library: ${Python_LIBRARIES}\")\nmessage(STATUS \"Found python headers: ${Python_INCLUDE_DIRS}\")\nmessage(STATUS \"Python version is ${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}.\")\n\n#---------------------------------------------------------------------------\n# User options.\n#---------------------------------------------------------------------------\n\nset(INSTALL_LIB_DIR lib CACHE PATH \"Installation directory for library\")\nset(INSTALL_INCLUDE_DIR include/cadabra2++ CACHE PATH \"Installation directory for header files\")\n\n# Scalar backend options\noption(USE_TREETRACKER \"Use the TreeTracker scalar backend\" OFF)\nset(PATH_TREETRACKER \"./treetracker\" CACHE STRING \"Path to the TreeTracker library\")\n\n\n#---------------------------------------------------------------------------\n# Compiler flags.\n#---------------------------------------------------------------------------\n\nadd_definitions(\"-DNO_SYMPY\")\nif(CMAKE_COMPILER_IS_GNUCXX)\n add_definitions(\"-Wall -g -Wno-unused-but-set-variable\")\nendif()\n\nif(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUCXX)\n if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14.0)\n message(STATUS \"This version of g++ (${CMAKE_CXX_COMPILER_VERSION}) incorrectly warns about possibly uninitialised memory when using std::variant containing a std::shared_ptr. Disabling this warning.\")\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -Wno-maybe-uninitialized\")\n endif()\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -O2\")\nendif()\n\nif(\"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"Clang\")\n set(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -O2\")\nendif()\n\nif(MSVC)\n\tset(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)\n\tset(MSVC_FLAGS\n\t\t\"/wd4101\"\t\t\t\t\t\t# unreferenced local variable\n\t\t\"/wd4250\"\t\t\t\t\t\t# inherits via dominance\n\t\t\"/wd4244\"\t\t\t\t\t\t# conversion from x to y, possible loss of data\n\t\t\"/wd4267\"\t\t\t\t\t\t# same as 4244\n\t\t\"/wd4996\"\t\t\t\t\t\t# deprecated POSIX functions\n\t\t\"-D_CRT_SECURE_NO_WARNINGS\"\t\t# don't warn about deprecated functions\n\t)\n\tforeach(FLAG ${MSVC_FLAGS})\n\t\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} ${FLAG}\")\n\tendforeach()\n\nendif()\n\n\n#---------------------------------------------------------------------------\n# Find libraries.\n#---------------------------------------------------------------------------\n\n# Locate gmpxx. On Homebrew there seems to be constantly something wrong with\n# the pkgconfig for gmpxx. So we just add the include path by hand.\nif(APPLE)\n add_definitions(\"-I/usr/local/include -I/opt/local/include\")\nendif()\nif(MSVC)\n find_package(GMPXX REQUIRED)\n set(GMP_LIB \"${GMPXX_LIBRARIES}\")\n set(GMPXX_LIB \"${GMPXX_LIBRARIES}\")\n include_directories(\"${VCPKG_INCLUDE_DIRS}\")\nelse()\n find_library(GMP_LIB gmp REQUIRED)\n find_library(GMPXX_LIB gmpxx REQUIRED)\n message(STATUS \"Found gmp ${GMP_LIB}\")\n message(STATUS \"Found gmpxx ${GMPXX_LIB}\")\nendif()\n\n\n#---------------------------------------------------------------------------\n# Enumerate source files.\n#---------------------------------------------------------------------------\n\nSET(RESERVED_NODE_SRC_FILES\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/ReservedNode.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Equals.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Sum.cc\n)\n\nset(LOCAL_SRC_FILES\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Adjform.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Algorithm.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Cleanup.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Combinatorics.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Compare.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/DisplayBase.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/DisplayTeX.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/DisplaySympy.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/DisplayTerminal.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Grouping.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/TerminalStream.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Multiplier.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/NDSolver.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/NEvaluator.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/NTensor.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/NInterpolatingFunction.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Exceptions.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Exchange.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/ExManip.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Functional.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/IndexIterator.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/IndexClassifier.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Hash.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Kernel.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Parser.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/PreClean.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/PreProcessor.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/ProgressMonitor.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Props.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Stopwatch.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Storage.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Symbols.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/YoungTab.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Accent.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/AntiCommuting.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/AntiSymmetric.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Commuting.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/CommutingAsProduct.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/CommutingAsSum.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/CommutingBehaviour.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Coordinate.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/DAntiSymmetric.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Depends.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/DependsInherit.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Derivative.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/DerivativeOp.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Determinant.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Diagonal.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/DifferentialForm.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/DiracBar.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Distributable.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/EpsilonTensor.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/ExteriorDerivative.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/FilledTableau.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/GammaMatrix.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/GammaTraceless.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/ImaginaryI.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/ImplicitIndex.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Indices.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Integer.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/InverseMetric.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/KroneckerDelta.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/LaTeXForm.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Matrix.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Metric.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/NonCommuting.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/NumericalFlat.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/PartialDerivative.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/RiemannTensor.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/SatisfiesBianchi.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/SelfAntiCommuting.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/SelfCommuting.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/SelfNonCommuting.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/SortOrder.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Spinor.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Symbol.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Symmetric.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Tableau.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/TableauBase.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/TableauInherit.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/TableauSymmetry.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Trace.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Traceless.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/Weight.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/WeightInherit.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/WeylTensor.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/modules/xperm_new.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/canonicalise.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/collect_components.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/collect_factors.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/collect_terms.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/combine.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/complete.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/decompose_product.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/distribute.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/drop_weight.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/einsteinify.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/eliminate_kronecker.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/eliminate_metric.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/epsilon_to_delta.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/evaluate.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/expand.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/expand_delta.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/expand_diracbar.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/expand_power.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/factor_in.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/factor_out.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/fierz.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/first_order_form.cc \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/flatten_product.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/flatten_sum.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/indexsort.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/integrate_by_parts.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/join_gamma.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/keep_terms.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/lr_tensor.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/order.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/product_rule.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/reduce_delta.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/rename_dummies.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/rewrite_indices.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/simplify.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/sort_product.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/sort_sum.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/split_gamma.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/split_index.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/substitute.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/sym.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/tab_basics.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/take_match.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/replace_match.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/unwrap.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/vary.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/young_project.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/young_project_product.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/young_project_tensor.cc\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/meld.cc\n SympyDummy.cc\n)\nset(MAIN_HEADERS\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Adjform.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Algorithm.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Combinatorics.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Compare.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/DisplayBase.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/DisplayTerminal.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/NEvaluator.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Equals.hh \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Exceptions.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/ExManip.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/IndexClassifier.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/IndexIterator.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Kernel.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/lru_cache.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Hash.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Multiplier.hh \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/NTensor.hh \n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Parser.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/ProgressMonitor.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Props.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/ReservedNode.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Storage.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Stopwatch.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/Sum.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/TerminalStream.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/tree.hh\n ${CMAKE_CURRENT_SOURCE_DIR}/../core/YoungTab.hh\n )\nFILE(GLOB ALGO_HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/../core/algorithms/*.hh)\nFILE(GLOB PROP_HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/../core/properties/*.hh)\n\n# Copy relevant header files to the binary directory\nfile(COPY ${MAIN_HEADERS} DESTINATION ${CMAKE_BINARY_DIR}/include/cadabra2++)\nfile(COPY ${ALGO_HEADERS} DESTINATION ${CMAKE_BINARY_DIR}/include/cadabra2++/algorithms)\nfile(COPY ${PROP_HEADERS} DESTINATION ${CMAKE_BINARY_DIR}/include/cadabra2++/properties)\n\n# Create a 'master' header which includes all the above for convenience\nfile(WRITE \"${CMAKE_BINARY_DIR}/include/cadabra2++.hh\" \"// Main headers\\n\")\nforeach(HEADER ${MAIN_HEADERS})\n\tget_filename_component(FILENAME \"${HEADER}\" NAME)\n\tfile(APPEND \"${CMAKE_BINARY_DIR}/include/cadabra2++.hh\" \"#include \\\"cadabra2++/${FILENAME}\\\"\\n\")\nendforeach()\nfile(APPEND \"${CMAKE_BINARY_DIR}/include/cadabra2++.hh\" \"\\n// Properties\\n\")\nforeach(HEADER ${PROP_HEADERS})\n\tget_filename_component(FILENAME \"${HEADER}\" NAME)\n\tfile(APPEND \"${CMAKE_BINARY_DIR}/include/cadabra2++.hh\" \"#include \\\"cadabra2++/properties/${FILENAME}\\\"\\n\")\nendforeach()\nfile(APPEND \"${CMAKE_BINARY_DIR}/include/cadabra2++.hh\" \"\\n// Algorithms\\n\")\nforeach(HEADER ${ALGO_HEADERS})\n\tget_filename_component(FILENAME \"${HEADER}\" NAME)\n\tfile(APPEND \"${CMAKE_BINARY_DIR}/include/cadabra2++.hh\" \"#include \\\"cadabra2++/algorithms/${FILENAME}\\\"\\n\")\nendforeach()\nfile(READ ${CMAKE_CURRENT_SOURCE_DIR}/cpplib.hh.in CPPLIB_HH_IN)\nfile(APPEND \"${CMAKE_BINARY_DIR}/include/cadabra2++.hh\" \"\\n//Helper functions\\n${CPPLIB_HH_IN}\")\n\nset(LIB_INCLUDE_DIRS\n\t\".\" \n\t\"${CADABRA_CORE_DIR}\"\n\t\"${CADABRA_LIBS_DIR}/pybind11/include\"\n\t\"${CADABRA_LIBS_DIR}/internal/include\"\n\t\"${CADABRA_LIBS_DIR}/dbg\"\n\t${Python_INCLUDE_DIRS}\n)\nmessage(\"${LIB_INCLUDE_DIRS}\")\n\nif(USE_TREETRACKER)\n add_definitions(-DUSE_TREETRACKER)\n if(EXISTS \"${PATH_TREETRACKER}/treetracker.h\" OR EXISTS \"${CMAKE_CURRENT_SOURCE_DIR}/${PATH_TREETRACKER}/treetracker.h\")\n\t include_directories(${PATH_TREETRACKER})\n\t message(\"-- Using the TreeTracker scalar backend at ${PATH_TREETRACKER}\")\n else()\n\t message(FATAL_ERROR \"-- Cannot find the 'treetracker.h' file in '${PATH_TREETRACKER}'\")\n endif()\nelse()\n message(\"-- Not using the TreeTracker scalar backend\")\nendif()\n\n\n#---------------------------------------------------------------------------\n# Targets\n#---------------------------------------------------------------------------\n\nadd_library(cadabra2++objects OBJECT ${LOCAL_SRC_FILES} ${RESERVED_NODE_SRC_FILES})\nset_property(TARGET cadabra2++objects PROPERTY POSITION_INDEPENDENT_CODE 1)\ntarget_include_directories(cadabra2++objects PUBLIC \"${LIB_INCLUDE_DIRS}\")\n\nadd_library(cadabra2++ SHARED $)\nset_target_properties(cadabra2++ PROPERTIES PUBLIC_HEADER \"${PUBLIC_HEADER_FILES}\")\n\ntarget_link_libraries(cadabra2++ ${GMPXX_LIB} ${GMP_LIB} ${Python_LIBRARIES})\n\nadd_library(cadabra2++_static STATIC $)\ntarget_link_libraries(cadabra2++_static ${GMPXX_LIB} ${GMP_LIB} ${Python_LIBRARIES})\n\nif(TBB_FOUND)\n target_link_libraries(cadabra2++ TBB::tbb)\n target_compile_definitions(cadabra2++objects PRIVATE HAS_TBB)\nendif()\n\n# Trivial example\nadd_executable(trivial trivial.cc)\ntarget_include_directories(trivial PUBLIC\n \"${CADABRA_LIBS_DIR}/pybind11/include\"\n \"${CMAKE_BINARY_DIR}/include\"\n \"${CMAKE_BINARY_DIR}/include/cadabra2++\"\n ${Python_INCLUDE_DIRS}\n)\ntarget_link_libraries(trivial cadabra2++)\n\n# Sample executable\nadd_executable(simple simple.cc)\ntarget_include_directories(simple PUBLIC\n \"${CADABRA_LIBS_DIR}/pybind11/include\"\n \"${CMAKE_BINARY_DIR}/include\"\n \"${CMAKE_BINARY_DIR}/include/cadabra2++\"\n ${Python_INCLUDE_DIRS}\n)\ntarget_link_libraries(simple cadabra2++)\n \n# Test for adjform\nadd_executable(adjform adjform.cc)\ntarget_include_directories(adjform PUBLIC\n \"${CADABRA_LIBS_DIR}/pybind11/include\"\n \"${CMAKE_BINARY_DIR}/include\"\n \"${CMAKE_BINARY_DIR}/include/cadabra2++\"\n ${Python_INCLUDE_DIRS}\n)\ntarget_link_libraries(adjform cadabra2++)\n \n# Test for numerical evaluation\nadd_executable(nevaluate nevaluate.cc)\ntarget_include_directories(nevaluate PUBLIC\n \"${CADABRA_LIBS_DIR}/pybind11/include\"\n \"${CMAKE_BINARY_DIR}/include\"\n \"${CMAKE_BINARY_DIR}/include/cadabra2++\"\n ${Python_INCLUDE_DIRS}\n)\ntarget_link_libraries(nevaluate cadabra2++)\n \n\n#---------------------------------------------------------------------------\n# Installation\n#---------------------------------------------------------------------------\n\ninstall(TARGETS cadabra2++ LIBRARY DESTINATION \"${INSTALL_LIB_DIR}\")\ninstall(TARGETS cadabra2++_static LIBRARY DESTINATION \"${INSTALL_LIB_DIR}\" ARCHIVE DESTINATION \"${INSTALL_LIB_DIR}\")\ninstall(DIRECTORY ${CMAKE_BINARY_DIR}/include DESTINATION \"${INSTALL_INCLUDE_DIR}\")\n\ninstall(DIRECTORY \n\tDESTINATION bin \n\tDIRECTORY_PERMISSIONS \n\t\tOWNER_READ \n\t\tOWNER_WRITE \n\t\tOWNER_EXECUTE\n\t\tGROUP_READ \n\t\tGROUP_EXECUTE\n\t\tWORLD_READ \n\t\tWORLD_EXECUTE\n)\n\ninstall(DIRECTORY \n\tDESTINATION lib\n\tDIRECTORY_PERMISSIONS \n\t\tOWNER_READ \n\t\tOWNER_WRITE \n\t\tOWNER_EXECUTE\n\t\tGROUP_READ \n\t\tGROUP_EXECUTE\n\t\tWORLD_READ \n\t\tWORLD_EXECUTE\n)\n"
},
{
"path": "c++lib/README.txt",
"content": "This directory contains code to illustrate the use of Cadabra from\nwithin C++ programs.\n"
},
{
"path": "c++lib/SympyDummy.cc",
"content": "\n#include \"Parser.hh\"\n#include \"Cleanup.hh\"\n#include \"PreClean.hh\"\n#include \"SympyCdb.hh\"\n#include \"DisplaySympy.hh\"\n#ifdef USE_TREETRACKER\n#include \"treetracker.h\"\n#endif\n#include \n\ncadabra::Ex::iterator sympy::apply(const cadabra::Kernel& kernel, cadabra::Ex& ex, cadabra::Ex::iterator& it,\n const std::vector& head, std::vector args,\n const std::string& method)\n\t{\n\tstd::ostringstream str;\n\n\tif(head.size()>0)\n\t\tstr << head[0] << \"(\";\n\n\tcadabra::DisplaySympy ds(kernel, ex);\n\tds.output(str, it);\n\n\tif(head.size()>0)\n\t\tif(args.size()>0)\n\t\t\tstr << \", \" << args[0] << \")\";\n\tstr << method;\n\n\tif(head.size()>0)\n\t\tstr << \")\";\n\n\t//\tstd::cerr << \"Send: \" << str.str() << std::endl;\n\n#ifdef USE_TREETRACKER\n\n\tauto res = TreeTracker::FromString(str.str());\n\tres.RecursiveSimplify();\n\tstd::stringstream istr;\n\tres.ShowTree(istr, 0, false, true);\n\t//\tstd::cerr << \"Return: \" << istr.str() << std::endl;\n\tauto ptr = std::make_shared();\n\tcadabra::Parser parser(ptr);\n\tistr >> parser;\n\tpre_clean_dispatch_deep(kernel, *parser.tree);\n\tcleanup_dispatch_deep(kernel, *parser.tree);\n\t//parser.tree->print_recursive_treeform(std::cerr, parser.tree->begin());\n\tds.import(*parser.tree);\n\n\tcadabra::Ex::iterator first=parser.tree->begin();\n\tit = ex.move_ontop(it, first);\n#endif\n\n\treturn it;\n\t}\n\nvoid sympy::invert_matrix(const cadabra::Kernel& kernel, cadabra::Ex& ex,\n\t\t\t\t\t\t\t\t cadabra::Ex& rules, const cadabra::Ex& tocompute)\n\t{\n\tthrow std::logic_error(\"Not implemented: sympy::invert_matrix\");\n\t}\n\nvoid sympy::determinant(const cadabra::Kernel&, cadabra::Ex& ex, cadabra::Ex& rules, const cadabra::Ex& tocompute)\n\t{\n\tthrow std::logic_error(\"Not implemented: sympy::determinant\");\n\t}\n\nvoid sympy::trace(const cadabra::Kernel&, cadabra::Ex& ex, cadabra::Ex& rules, const cadabra::Ex& tocompute)\n\t{\n\tthrow std::logic_error(\"Not implemented: sympy::trace\");\n\t}\n"
},
{
"path": "c++lib/adjform.cc",
"content": "#include \"cadabra2++.hh\"\n#include \n\nusing namespace cadabra;\nusing namespace cadabra::cpplib;\n\nint main(int, char**)\n{\n\tKernel k(true);\n\tpprint_enable_utf8();\n //{\\mu,\\nu}::Indices(vector).\n //tr{#}::Trace.\n //u^{\\mu}::SelfNonCommuting.\n //u^{\\mu}::ImplicitIndex.\n //ex:=tr{A u^{\\nu} u^{\\mu} u^{\\mu} u^{\\nu} + B u^{\\mu} u^{\\mu} u^{\\nu} u^{\\nu}}:\n //meld(_);\n\n\tinject_property(k, \"{A,B,C,D }\");\n\tinject_property(k, \"tr{#}\");\n\n\tauto ex = R\"(tr(A B C D + B C D A)\"_ex(k);\n\tmeld m(k, *ex);\n\tstd::cout << pprint(k, ex) << '\\n';\n\tm.apply_pre_order();\n\tstd::cout << pprint(k, ex) << '\\n';\n\t// assert ex == $2 * Tr{ A B C D }$\n\t\n}\n"
},
{
"path": "c++lib/cpplib.hh.in",
"content": "#ifdef _MSC_VER\n#define WIN32_LEAN_AND_MEAN\n#include \n#endif\n\nnamespace cadabra {\n\tnamespace cpplib {\n\n\t\tusing ExPtr = std::shared_ptr;\n\n\t\tnamespace detail {\n\t\t\tstruct ExConstructorProxy\n\t\t\t{\n\t\t\t\tExConstructorProxy(const char* data) : data(data) {}\n\t\t\t\tExPtr operator () (Kernel& kernel)\n\t\t\t\t{\n\t\t\t\t\treturn kernel.ex_from_string(data);\n\t\t\t\t}\n\t\t\t\tstd::string data;\n\t\t\t};\n\n\t\t\tstruct ExPrettyPrinter\n\t\t\t{\n\t\t\t\tExPrettyPrinter(const Kernel& kernel, Ex::iterator it, bool use_unicode = true)\n\t\t\t\t\t: kernel(kernel)\n\t\t\t\t\t, ex(it)\n\t\t\t\t\t, use_unicode(use_unicode) {}\n\t\t\t\tconst Kernel& kernel;\n\t\t\t\tEx ex;\n\t\t\t\tbool use_unicode;\n\t\t\t};\n\t\t}\n\n\t\tExPtr copy(const ExPtr& ex)\n\t\t{\n\t\t\treturn std::make_shared(*ex);\n\t\t}\n\n\t\ttemplate \n\t\tvoid inject_property(Kernel& kernel, const ExPtr& pattern, const ExPtr& args = nullptr)\n\t\t{\n\t\t\tkernel.inject_property(new Prop(), pattern, args);\n\t\t}\n\n\t\ttemplate \n\t\tvoid inject_property(Kernel& kernel, const char* pattern, const ExPtr& args = nullptr)\n\t\t{\n\t\t\tinject_property(kernel, kernel.ex_from_string(pattern), args);\n\t\t}\n\n\t\ttemplate \n\t\tvoid inject_property(Kernel& kernel, const ExPtr& pattern, const char* args)\n\t\t{\n\t\t\tinject_property(kernel, pattern, kernel.ex_from_string(args));\n\t\t}\n\n\t\ttemplate \n\t\tvoid inject_property(Kernel& kernel, const char* pattern, const char* args)\n\t\t{\n\t\t\tinject_property(kernel, kernel.ex_from_string(pattern), kernel.ex_from_string(args));\n\t\t}\n\n\t\ttemplate \n\t\tExPtr apply(const Kernel& kernel, const ExPtr& ex, Args&&... args, bool deep = true, bool repeat = false, unsigned int depth = 0)\n\t\t{\n\t\t\tAlgo algo(kernel, *ex, std::forward(args)...);\n\t\t\talgo.apply_generic(deep, repeat, depth);\n\t\t\treturn ex;\n\t\t}\n\n\t\ttemplate \n\t\tExPtr apply(const Kernel& kernel, const ExPtr& ex, Ex::iterator it, Args&&... args, bool deep = true, bool repeat = false, unsigned int depth = 0)\n\t\t{\n\t\t\tAlgo algo(kernel, *ex, std::forward(args)...);\n\t\t\talgo.apply_generic(it, deep, repeat, depth);\n\t\t\treturn ex;\n\t\t}\n\n\t\ttemplate \n\t\tExPtr apply_preorder(const Kernel& kernel, const ExPtr& ex, Args&&... args)\n\t\t{\n\t\t\tAlgo algo(kernel, *ex, std::forward(args)...);\n\t\t\talgo.apply_pre_order();\n\t\t\treturn ex;\n\t\t}\n\n\t\tinline void pprint_enable_utf8()\n\t\t{\n\t\t\t// Set the codepage on windows to utf8\n#ifdef _MSC_VER\n\t\t\tSetConsoleOutputCP(65001);\n#endif\n\t\t}\n\n\t\tinline detail::ExConstructorProxy operator \"\" _ex(const char* ex, std::size_t n)\n\t\t{\n\t\t\treturn detail::ExConstructorProxy(ex);\n\t\t}\n\n\t\tinline detail::ExPrettyPrinter pprint(const Kernel& kernel, const ExPtr& ex, bool use_unicode = true)\n\t\t{\n\t\t\treturn detail::ExPrettyPrinter(kernel, ex->begin(), use_unicode);\n\t\t}\n\n\t\tinline detail::ExPrettyPrinter pprint(const Kernel& kernel, const Ex& ex, bool use_unicode = true)\n\t\t{\n\t\t\treturn detail::ExPrettyPrinter(kernel, ex.begin(), use_unicode);\n\t\t}\n\n\t\tinline detail::ExPrettyPrinter pprint(const Kernel& kernel, Ex::iterator it, bool use_unicode = true)\n\t\t{\n\t\t\treturn detail::ExPrettyPrinter(kernel, it, use_unicode);\n\t\t}\n\n\t\tinline std::ostream& operator << (std::ostream& stream, const detail::ExPrettyPrinter& pretty_printer)\n\t\t{\n\t\t\tDisplayTerminal dt(pretty_printer.kernel, pretty_printer.ex, pretty_printer.use_unicode);\n\t\t\tdt.output(stream);\n\t\t\treturn stream;\n\t\t}\n\t}\n}\n"
},
{
"path": "c++lib/nevaluate.cc",
"content": "#include \"cadabra2++.hh\"\n#include \n\nusing namespace cadabra;\nusing namespace cadabra::cpplib;\n\nint main(int, char **)\n\t{\n\tKernel k(true);\n\tpprint_enable_utf8();\n\t//{\\mu,\\nu}::Indices(vector).\n\t// tr{#}::Trace.\n\t// u^{\\mu}::SelfNonCommuting.\n\t// u^{\\mu}::ImplicitIndex.\n\t// ex:=tr{A u^{\\nu} u^{\\mu} u^{\\mu} u^{\\nu} + B u^{\\mu} u^{\\mu} u^{\\nu}\n\t// u^{\\nu}}: meld(_);\n\n//\tinject_property(k, \"{A,B,C,D }\");\n//\tinject_property(k, \"tr{#}\");\n\n\t// Scalar broadcast\n\tNTensor t3a( { 2.0 } );\n\tstd::cerr << \"t3a.shape.size() = \" << t3a.shape.size() << std::endl;\n\tstd::cerr << \"t3a.shape[0] = \" << t3a.shape[0] << std::endl;\t\n\tNTensor t432a=t3a.broadcast( {4, 1}, 1 );\n\tstd::cerr << t432a << std::endl;\n\n\t// NTensor broadcast\n\tNTensor t3( { 1.0, 2.0, 3.0 } );\n\tNTensor t432=t3.broadcast( {4,3,2}, 1 );\n\tstd::cerr << t432 << std::endl;\n\n\tNTensor t3c( { 1.0, 2.0, 3.0 } );\n\tNTensor t432c1=t3c.broadcast( {3,3,2}, 1 );\n\tstd::cerr << t432c1 << std::endl;\n\tNTensor t432c2=t3c.broadcast( {3,3,2}, 0 );\n\tstd::cerr << t432c2 << std::endl;\n\n\n\t// Multiplying two scalar variables which each take\n\t// an array of values leads to an outer product.\n\n\tauto ex1b = \"B*A + A\"_ex(k);\n\tNEvaluator ev1b(ex1b->begin());\n\tev1b.set_variable(Ex(\"A\"), NTensor({1.0, 2.0, 3.0}));\n\tev1b.set_variable(Ex(\"B\"), NTensor({0.5, 1.0, 5.0, 10.0}));\n\t// This should give a {3, 4} tensor.\n\tauto res1b = ev1b.evaluate();\n\tstd::cout << \"B*A + A = \" << res1b << \"\\n\\n\";\n\n\tauto ex1 = \"B*A + C\"_ex(k);\n\tNEvaluator ev1(ex1->begin());\n\tev1.set_variable(Ex(\"A\"), NTensor({1.0, 2.0, 3.0}));\n\tev1.set_variable(Ex(\"B\"), NTensor({0.5, 1.0, 5.0, 10.0}));\n\tev1.set_variable(Ex(\"C\"), NTensor({1.0, -1.0}));\n\t// This should give a {3, 4, 2} tensor.\n\tauto res1 = ev1.evaluate();\n\tstd::cout << \"B*A + C = \" << res1 << \"\\n\\n\";\n\n\t// Trigonometric functions.\n\n\tauto ex2 = R\"( A + B \\cos( C ) )\"_ex(k);\n\tstd::cout << pprint(k, ex2) << '\\n';\n\tNTensor nt2({2,4}, 0.0);\n\tnt2.at({1,2}) = 3.1415;\n\tfor(auto& v: nt2.values)\n\t\tstd::cout << v << \", \";\n\tstd::cout << \"\\n\\n\";\n\tstd::cout << nt2 << std::endl;\n\n\tNEvaluator ev(ex2->begin());\n\tev.set_variable(Ex(\"C\"), { 3.0 });\n\tev.set_variable(Ex(\"B\"), { 2.3 });\n\tev.set_variable(Ex(\"A\"), { 1.2 });\n\tauto res2 = ev.evaluate();\n\tstd::cout << \"A + B cos(C) = \" << res2 << \"\\n\\n\";\n\n\t// Double trig.\n\tStopwatch sw;\n\tauto ex3 = R\"( \\cos(x) \\sin(y) )\"_ex(k);\n\tNEvaluator ev3(ex3->begin());\n\tev3.set_variable(Ex(\"x\"), NTensor::linspace(0.0, 3.14, 1000));\n\tev3.set_variable(Ex(\"y\"), NTensor::linspace(0.0, 3.14, 1000));\n\tsw.start();\n\tint num=100;\n\tfor(int i=0; i\n#include \n\n/// \\file simple.cc\n/// \\ingroup libcadabra\n///\n/// Sample program to demonstrate the use of Cadabra directly from C++ code.\n\nvoid test1()\n\t{\n\t// The following few lines are equivalent to entering\n\t//\n\t// {r,t}::Coordinate.\n\t// {m,n}::Indices(values={t,r}, position=free).\n\t// ex:= A_{m} A^{m};\n\t// rl:= A_{t} = 3 + a;\n\t// evaluate(ex, rl);\n\t//\n\t// in the Cadabra notebook.\n\n\tcadabra::Kernel kernel;\n\n\tkernel.inject_property(new cadabra::Coordinate(), kernel.ex_from_string(\"{r,t}\"), 0);\n\tkernel.inject_property(new cadabra::Indices(), kernel.ex_from_string(\"{m,n}\"),\n\t kernel.ex_from_string(\"values={t,r}, position=free\"));\n\n\tauto ex = kernel.ex_from_string(\"A_{m} A^{m}\");\n\tauto rl = kernel.ex_from_string(\"A_{t} = 3 + a \");\n\tcadabra::evaluate ev(kernel, *ex, *rl);\n\tev.apply_generic();\n\n\t// Pretty-printing stream object.\n\tcadabra::TerminalStream ss(kernel, std::cerr);\n\tss << ex << std::endl;\n\t}\n\nvoid test2()\n\t{\n\t// The following few lines are equivalent to entering\n\t//\n\t// {m,n,p,q}::Indices(position=free).\n\t// \\partial{#}::PartialDerivative;\n\t// ex:= \\int{ F_{m n} F^{m n} }{x};\n\t// rl:= F_{m n} = \\\\partial_{m}{A_{n}} - \\\\partial_{n}{A_{m}};\n\t// substitute(ex, rl, deep=True);\n\t//\n\t// in the Cadabra notebook.\n\n\tcadabra::Kernel kernel;\n\n\tauto ind1 = kernel.ex_from_string(\"{m,n,p,q}\");\n\tauto ind2 = kernel.ex_from_string(\"position=free\");\n\tkernel.inject_property(new cadabra::Indices(), ind1, ind2);\n\n\tauto pd = kernel.ex_from_string(\"\\\\partial{#}\");\n\tkernel.inject_property(new cadabra::PartialDerivative(), pd, 0);\n\n\tauto ex = kernel.ex_from_string(\"\\\\int{ F_{m n} F^{m n} }{x}\");\n\tauto rl = kernel.ex_from_string(\"F_{m n} = \\\\partial_{m}{A_{n}} - \\\\partial_{n}{A_{m}}\");\n\n\t// Pretty-printing stream object.\n\tcadabra::TerminalStream ss(kernel, std::cerr);\n\n\tss << ex << std::endl;\n\tss << rl << std::endl;\n\n\t// Apply the 'substitute' algorithm.\n\tcadabra::substitute subs(kernel, *ex, *rl);\n\tsubs.apply_generic();\n\n\tss << ex << std::endl;\n\t}\n\n\nint main(int argc, char **argv)\n\t{\n\ttest1();\n\ttest2();\n\t}\n"
},
{
"path": "c++lib/trivial.cc",
"content": "#include \"cadabra2++.hh\"\n#include \n\nusing namespace cadabra;\nusing namespace cadabra::cpplib;\n\nint main() {\n Kernel k(true);\n inject_property(k, \"{A,B}\");\n auto ex = \"A B - B A\"_ex(k);\n sort_product sp(k, *ex);\n sp.apply_generic();\n\n\tcollect_terms ct(k, *ex);\n\tct.apply_generic();\n\t\n std::cout << pprint(k, ex) << std::endl;\n}\n"
},
{
"path": "client_server/Actions.cc",
"content": "\n\n#include \"Actions.hh\"\n#include \"DataCell.hh\"\n#include \"DocumentThread.hh\"\n#include \"GUIBase.hh\"\n\n#include \n#include \n#include \n\nusing namespace cadabra;\n\n#define DEBUG(ln)\n// #define DEBUG(ln) ln\n\n\nActionBase::ActionBase(DataCell::id_t id)\n\t: ref_id(id)\n\t{\n\t}\n\nbool ActionBase::undoable() const\n\t{\n\treturn true;\n\t}\n\nvoid ActionBase::execute(DocumentThread& cl, GUIBase& )\n\t{\n\tif(ref_id.id==0) {\n\t\t// A zero ID means the current cell.\n\t\tref = cl.current_cell;\n\t\treturn;\n\t\t}\n\telse {\n\t\t// Lookup the cell with the given ID.\n\t\tauto it=cl.doc.begin();\n\t\twhile(it!=cl.doc.end()) {\n\t\t\tif((*it).id().id==ref_id.id) {\n\t\t\t\tref=it;\n\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t++it;\n\t\t\t}\n\t\t}\n\n\t// Not found, throw exception.\n\tstd::string class_name = boost::core::demangle(typeid(*this).name());\n\tthrow std::logic_error(class_name + \": cannot find cell with id \"+std::to_string(ref_id.id));\n\t}\n\nActionAddCell::ActionAddCell(DataCell cell, DataCell::id_t ref_id, Position pos_, bool activate_)\n\t: ActionBase(ref_id)\n\t, newcell(cell)\n\t, pos(pos_)\n\t, activate(activate_)\n\t, is_replacement(false)\n\t, is_input_form(false)\n\t{\n\t}\n\nvoid ActionAddCell::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\t// Insert this DataCell into the DTree document. We first need\n\t// to figure out whether we already have a cell with the DataCell's\n\t// cell_id; in this case we have to replace, not append/insert.\n\tauto it=cl.doc.begin();\n\twhile(it!=cl.doc.end()) {\n\t\tif((*it).id().id==newcell.id().id) {\n\t\t\t// FIXME: right now we only change textbuf.\n\t\t\tDEBUG( std::cerr << \"found! \" << it->id().id << \", \" << static_cast(it->cell_type) << std::endl; )\n\t\t\tit->textbuf=newcell.textbuf;\n\t\t\tgb.update_cell(cl.doc, it);\n\t\t\tis_replacement=true;\n\t\t\treturn;\n\t\t\t}\n\t\t++it;\n\t\t}\n\n\t// If we get here we have to append/insert.\n\tDEBUG( std::cerr << \"ActionAddCell::execute: add cell with id \" << newcell.id().id; )\n\tswitch(pos) {\n\t\tcase Position::before:\n\t\t\tnewref = cl.doc.insert(ref, newcell);\n\t\t\tDEBUG( std::cerr << \" before \"; )\n\t\t\tbreak;\n\t\tcase Position::after:\n\t\t\tnewref = cl.doc.insert_after(ref, newcell);\n\t\t\tDEBUG( std::cerr << \" after \"; )\t\t\t\n\t\t\tbreak;\n\t\tcase Position::child:\n\t\t\tnewref = cl.doc.append_child(ref, newcell);\n\t\t\tDEBUG( std::cerr << \" as child of \"; )\t\t\t\n\t\t\tbreak;\n\t\t}\n\tDEBUG( std::cerr << \" \" << ref->id().id << std::endl; )\n\t\t\n\tchild_num=cl.doc.index(newref);\n\tDEBUG( std::cerr << \"ActionAddCell::execute: added as child \" << child_num <<\n\t\t\t \": |\" << newcell.textbuf << \"|\" << std::endl; )\n\tgb.add_cell(cl.doc, newref, true);\n\tif(activate)\n\t\tgb.position_cursor(cl.doc, newref, -1);\n\t\n\tif(newcell.cell_type == DataCell::CellType::input_form)\n\t\tis_input_form=true;\n\t}\n\nvoid ActionAddCell::revert(DocumentThread& cl, GUIBase& gb)\n\t{\n\t// Remove the GUI cell from the notebook and then\n\t// remove the corresponding DataCell from the DTree.\n\n\tDEBUG( std::cerr << \"ActionAddCell::revert: removing child \" << child_num << std::endl; )\n\n\tDTree::sibling_iterator ch;\n\tswitch(pos) {\n\t\tcase Position::before:\n\t\t\t// `ref` is a cell after our cell.\n\t\t\tch = cl.doc.child(cl.doc.parent(ref), child_num);\n\t\t\tbreak;\n\t\tcase Position::after:\n\t\t\t// `ref` is a cell before our cell.\n\t\t\tch = cl.doc.child(cl.doc.parent(ref), child_num);\n\t\t\tbreak;\n\t\tcase Position::child:\n\t\t\t// `ref` is a parent of our cell.\n\t\t\tch = cl.doc.child(ref, child_num);\n\t\t\tbreak;\n\t\t}\n\tDEBUG( std::cerr << \"ActionAddCell::revert: removing cell \" << ch->textbuf << std::endl; )\n\tgb.remove_cell(cl.doc, ch);\n\t// std::cerr << \"ActionAddCell::revert: finally erase datacell\" << std::endl;\n\tcl.doc.erase(ch);\n\t}\n\nbool ActionAddCell::undoable() const\n\t{\n\treturn !(is_replacement || is_input_form);\n\t}\n\nActionPositionCursor::ActionPositionCursor(DataCell::id_t ref_id, Position pos_)\n\t: ActionBase(ref_id), needed_new_cell_with_id(0), pos(pos_)\n\t{\n\t}\n\nvoid ActionPositionCursor::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tswitch(pos) {\n\t\tcase Position::in:\n\t\t\t// std::cerr << \"in\" << std::endl;\n\t\t\tnewref = ref;\n\t\t\tbreak;\n\t\tcase Position::next: {\n\t\t\tDTree::sibling_iterator sib=ref;\n\t\t\tbool found=false;\n\t\t\twhile(cl.doc.is_valid(++sib)) {\n\t\t\t\tif(sib->cell_type==DataCell::CellType::python || sib->cell_type==DataCell::CellType::latex) {\n\t\t\t\t\tif(!sib->hidden) {\n\t\t\t\t\t\tnewref=sib;\n\t\t\t\t\t\tfound=true;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\tif(!found) {\n\t\t\t\tif(ref->textbuf==\"\") { // If the last cell is empty, stay where we are.\n\t\t\t\t\tnewref=ref;\n\t\t\t\t\t}\n\t\t\t\telse {\n\t\t\t\t\t// Make sure that we store the generated cell id so we\n\t\t\t\t\t// can re-use it if we execute this in redo.\n\t\t\t\t\tif(needed_new_cell_with_id > 0) {\n\t\t\t\t\t\tDataCell::id_t id;\n\t\t\t\t\t\tid.id = needed_new_cell_with_id;\n\t\t\t\t\t\tDataCell newcell(id, DataCell::CellType::python, \"\");\n\t\t\t\t\t\tnewref = cl.doc.insert(sib, newcell);\n\t\t\t\t\t\t}\n\t\t\t\t\telse {\n\t\t\t\t\t\tDataCell newcell(DataCell::CellType::python, \"\");\n\t\t\t\t\t\tneeded_new_cell_with_id=newcell.id().id;\n\t\t\t\t\t\tnewref = cl.doc.insert(sib, newcell);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\tbreak;\n\t\t\t}\n\t\tcase Position::previous: {\n\t\t\tbool found=false;\n\t\t\tDTree::sibling_iterator sib=ref;\n\t\t\twhile(cl.doc.is_valid(--sib)) {\n\t\t\t\tif(sib->cell_type==DataCell::CellType::python || sib->cell_type==DataCell::CellType::latex) {\n\t\t\t\t\tif(!sib->hidden) {\n\t\t\t\t\t\tnewref=sib;\n\t\t\t\t\t\tfound=true;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\tif(!found)\n\t\t\t\tnewref=ref; // No previous sibling cell. FIXME: walk tree structure\n\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t// Update GUI.\n\tif(needed_new_cell_with_id > 0) {\n\t\t// std::cerr << \"cadabra-client: adding new visual cell before positioning cursor\" << std::endl;\n\t\tgb.add_cell(cl.doc, newref, true);\n\t\t}\n\t// std::cerr << \"cadabra-client: positioning cursor\" << std::endl;\n\tgb.position_cursor(cl.doc, newref, -1);\n\tDEBUG( std::cerr << \"ActionPositionCursor::execute: done\" << std::endl; )\n\t}\n\nvoid ActionPositionCursor::revert(DocumentThread& cl, GUIBase& gb)\n\t{\n\tif(needed_new_cell_with_id > 0) {\n\t\tgb.remove_cell(cl.doc, newref);\n\t\tcl.doc.erase(newref);\n\t\t}\n\tgb.position_cursor(cl.doc, ref, -1);\n\tDEBUG( std::cerr << \"ActionPositionCursor::revert: done\" << std::endl; )\n\t}\n\nActionRemoveCell::ActionRemoveCell(DataCell::id_t ref_id)\n\t: ActionBase(ref_id)\n\t{\n\t}\n\nActionRemoveCell::~ActionRemoveCell()\n\t{\n\t}\n\nvoid ActionRemoveCell::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tgb.remove_cell(cl.doc, ref);\n\n\treference_parent_cell = cl.doc.parent(ref);\n\treference_child_index = cl.doc.index(ref);\n\tremoved_tree=DTree(ref);\n\tDEBUG( std::cerr << \"removed has \" << cl.doc.number_of_children(ref) << \" children\" << std::endl; )\n\tcl.doc.erase(ref);\n\t}\n\nvoid ActionRemoveCell::revert(DocumentThread& cl, GUIBase& gb)\n\t{\n\tDEBUG( std::cerr << \"need to undo a remove cell at index \" << reference_child_index << std::endl; )\n\tDTree::iterator newcell;\n\tif(cl.doc.number_of_children(reference_parent_cell)==0) {\n\t\tnewcell = cl.doc.append_child(reference_parent_cell, removed_tree.begin());\n\t\t}\n\telse {\n\t\tauto it = cl.doc.child(reference_parent_cell, reference_child_index);\n\t\t//\t\t++it;\n\t\tnewcell = cl.doc.insert_subtree(it, removed_tree.begin());\n\t\tDEBUG( std::cerr << \"added doc cell \" << newcell->textbuf << \" at \" << &(*newcell) << \" before \" << it->textbuf << std::endl; )\n\t\t}\n\tgb.add_cell(cl.doc, newcell, true);\n\tDEBUG( std::cerr << \"added vis rep\" << std::endl; )\n\t}\n\n\nActionReplaceCell::ActionReplaceCell(DataCell::id_t ref_id)\n\t: ActionBase(ref_id)\n\t{\n\t}\n\nActionReplaceCell::~ActionReplaceCell()\n\t{\n\t}\n\nvoid ActionReplaceCell::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\t}\n\nvoid ActionReplaceCell::revert(DocumentThread& cl, GUIBase& gb)\n\t{\n\t}\n\nbool ActionReplaceCell::undoable() const\n\t{\n\treturn false;\n\t}\n\nActionSplitCell::ActionSplitCell(DataCell::id_t ref_id)\n\t: ActionBase(ref_id)\n\t{\n\t}\n\nActionSplitCell::~ActionSplitCell()\n\t{\n\t}\n\nvoid ActionSplitCell::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tsize_t pos = gb.get_cursor_position(cl.doc, ref);\n\n\tstd::string segment1=ref->textbuf.substr(0, pos);\n\tstd::string segment2=ref->textbuf.substr(pos);\n\n\t// Strip leading newline in 2nd segment, if any.\n\tif(segment2.size()>0) {\n\t\tif(segment2[0]=='\\n')\n\t\t\tsegment2=segment2.substr(1);\n\t\t}\n\n\tDataCell newcell(ref->cell_type, segment2);\n\tnewref = cl.doc.insert_after(ref, newcell);\n\tref->textbuf=segment1;\n\n\tgb.add_cell(cl.doc, newref, true);\n\tgb.update_cell(cl.doc, ref);\n\t}\n\nvoid ActionSplitCell::revert(DocumentThread&, GUIBase& )\n\t{\n\t// FIXME: implement\n\t}\n\n\n\nActionSetRunStatus::ActionSetRunStatus(DataCell::id_t ref_id, bool running)\n\t: ActionBase(ref_id), new_running_(running)\n\t{\n\t}\n\nbool ActionSetRunStatus::undoable() const\n\t{\n\treturn false;\n\t}\n\nvoid ActionSetRunStatus::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tgb.update_cell(cl.doc, ref);\n\n\twas_running_=ref->running;\n\tref->running=new_running_;\n\t}\n\nvoid ActionSetRunStatus::revert(DocumentThread&, GUIBase& )\n\t{\n\t}\n\n\nActionRunCell::ActionRunCell(DataCell::id_t ref_id)\n\t: ActionBase(ref_id), run_all_cells(false)\n\t{\n\t}\n\nActionRunCell::ActionRunCell()\n\t: ActionBase(DataCell::id_t()), run_all_cells(true)\n\t{\n\t}\n\nActionRunCell::~ActionRunCell()\n\t{\n\t}\n\nbool ActionRunCell::undoable() const\n\t{\n\treturn false;\n\t}\n\nvoid ActionRunCell::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tif(!run_all_cells) {\n\t\tActionBase::execute(cl, gb);\n\t\tcl.run_cell(ref, false);\n\t\t}\n\telse {\n\t\tcl.run_all_cells();\n\t\t}\n\t}\n\nvoid ActionRunCell::revert(DocumentThread&, GUIBase& )\n\t{\n\t}\n\n\nActionOpen::ActionOpen(const std::string& n)\n\t: ActionBase(DataCell::id_t()), notebook_name(n)\n\t{\n\t}\n\nActionOpen::~ActionOpen()\n\t{\n\t}\n\nbool ActionOpen::undoable() const\n\t{\n\treturn false;\n\t}\n\nvoid ActionOpen::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tstd::ifstream file(notebook_name);\n\tstd::string content, line;\n\t\n\twhile(std::getline(file, line))\n\t\tcontent+=line;\n\n\tcl.load_from_string(content);\n\t}\n\nvoid ActionOpen::revert(DocumentThread&, GUIBase& )\n\t{\n\t}\n\n\nActionSetVariableList::ActionSetVariableList(DataCell::id_t ref_id, std::set variables)\n\t: ActionBase(ref_id), new_variables_(variables)\n\t{\n\t}\n\nbool ActionSetVariableList::undoable() const\n\t{\n\treturn false;\n\t}\n\nvoid ActionSetVariableList::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tref->variables_referenced=new_variables_;\n\t}\n\nvoid ActionSetVariableList::revert(DocumentThread&, GUIBase& )\n\t{\n\t}\n\n\nActionInsertText::ActionInsertText(DataCell::id_t ref_id, int pos, const std::string& content)\n\t: ActionBase(ref_id), insert_pos(pos), text(content)\n\t{\n\t}\n\nvoid ActionInsertText::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tref->textbuf.insert(insert_pos, text);\n\tDEBUG( std::cerr << \"ActionInsertText::execute: textbuf now |\" << ref->textbuf << \"|\" << std::endl; )\n\tgb.update_cell(cl.doc, ref);\n\t}\n\nvoid ActionInsertText::revert(DocumentThread& cl, GUIBase& gb)\n\t{\n\tref->textbuf.erase(insert_pos, text.size());\n\tDEBUG( std::cerr << \"ActionInsertText::revert: textbuf now |\" << ref->textbuf << \"|\" << std::endl; )\n\tgb.update_cell(cl.doc, ref);\n\t}\n\n\nActionCompleteText::ActionCompleteText(DataCell::id_t ref_id, int pos, const std::string& content, int alt)\n\t: ActionBase(ref_id), insert_pos(pos), text(content), alternative_(alt)\n\t{\n\t}\n\nvoid ActionCompleteText::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tauto endpos = ref->textbuf.insert(insert_pos, text);\n\t// std::cerr << \"complete: textbuf now |\" << ref->textbuf << \"|\" << std::endl;\n\tgb.update_cell(cl.doc, ref);\n\tgb.position_cursor(cl.doc, ref, insert_pos+text.size());\n\t}\n\nvoid ActionCompleteText::revert(DocumentThread& cl, GUIBase& gb)\n\t{\n\tref->textbuf.erase(insert_pos, text.size());\n\tgb.update_cell(cl.doc, ref);\n\tgb.position_cursor(cl.doc, ref, insert_pos);\n\t}\n\nint ActionCompleteText::length() const\n\t{\n\treturn text.size();\n\t}\n\nint ActionCompleteText::alternative() const\n\t{\n\treturn alternative_;\n\t}\n\nActionEraseText::ActionEraseText(DataCell::id_t ref_id, int start, int end)\n\t: ActionBase(ref_id), from_pos(start), to_pos(end)\n\t{\n\t}\n\nvoid ActionEraseText::execute(DocumentThread& cl, GUIBase& gb)\n\t{\n\tActionBase::execute(cl, gb);\n\n\tDEBUG( std::cerr << from_pos << \", \" << to_pos << std::endl; )\n\tremoved_text=ref->textbuf.substr(from_pos, to_pos-from_pos);\n\tref->textbuf.erase(from_pos, to_pos-from_pos);\n\t}\n\nvoid ActionEraseText::revert(DocumentThread& cl, GUIBase& gb)\n\t{\n\tref->textbuf.insert(from_pos, removed_text);\n\tgb.update_cell(cl.doc, ref);\n\tgb.position_cursor(cl.doc, ref, from_pos+removed_text.size());\n\t}\n\n"
},
{
"path": "client_server/Actions.hh",
"content": "\n#pragma once\n\n#include \"DataCell.hh\"\n#include \"DocumentThread.hh\"\n\n#include \n\nnamespace cadabra {\n\n\tclass DocumentThread;\n\tclass GUIBase;\n\n\t/// \\ingroup clientserver\n\t///\n\t/// All actions derive from the ActionBase object, which defines\n\t/// the interface they need to implement. These objects are used to\n\t/// pass (user) action instructions around. They can be stored in\n\t/// undo/redo stacks. All actions run on the GUI thread. The\n\t/// update_gui members typically call members of the GUIBase class.\n\t/// Action objects are allowed to modify the DTree document doc,\n\t/// since they essentially contain code which is part of the\n\t/// DocumentThread object.\n\t///\n\t/// All modifications to the document are done by calling 'perform' with an\n\t/// action object. This enables us to implement an undo stack. This method\n\t/// will take care of making the actual change to the DTree document, and\n\t/// call back on the 'change' methods above to inform the derived class\n\t/// that a change has been made.\n\n\n\tclass ActionBase {\n\t\tpublic:\n\t\t\tActionBase(DataCell::id_t ref_id);\n\n\t\t\t/// Perform the action. This should update both the document\n\t\t\t/// tree data structure and the GUI. The latter is updated\n\t\t\t/// by calling relevant methods on the GUIBase object passed\n\t\t\t/// in.\n\t\t\t///\n\t\t\t/// The base class just looks up the cell given its `id_t`.\n\t\t\t/// If your action does not refer to a cell at all, you do\n\t\t\t/// not need to call the base class `execute`.\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&);\n\n\t\t\t/// Revert the change to the DTree document and the GUI.\n\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&)=0;\n\n\t\t\t/// Can this action be undone?\n\t\t\tvirtual bool undoable() const;\n\n\t\t\tDataCell::id_t ref_id;\n\n\t\t\t/// If you want a callback once this action has finished,\n\t\t\t/// set it here before queuing.\n\t\t\tstd::function callback;\n\t\t\t\n\t\tprotected:\n\t\t\tDTree::iterator ref;\n\t\t};\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Add a cell to the notebook.\n\n\tclass ActionAddCell : public ActionBase {\n\t\tpublic:\n\t\t\tenum class Position { before, after, child };\n\n\t\t\tActionAddCell(DataCell, DataCell::id_t ref_, Position pos_, bool activate=false);\n\t\t\tvirtual ~ActionAddCell() {};\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\t\t/// Can this action be undone?\n\t\t\tvirtual bool undoable() const override;\n\t\tprivate:\n\t\t\t// Keep track of the location where this cell is inserted into\n\t\t\t// the notebook.\n\n\t\t\tDataCell newcell;\n\t\t\tDTree::iterator newref;\n\t\t\tPosition pos;\n\t\t\tint child_num;\n\t\t\tbool activate;\n\n\t\t\t// If we are replacing a cell, keep track of that so we\n\t\t\t// report that we are not undoable.\n\t\t\tbool is_replacement;\n\n\t\t\t// For input-form cells, we want no undo, as they will go\n\t\t\t// when the owner cell will be reverted.\n\t\t\tbool is_input_form;\n\t\t};\n\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Position the cursor relative to the indicated cell. If position is 'next' and\n\t/// there is no input cell following the indicated one, create a new one.\n\n\tclass ActionPositionCursor : public ActionBase {\n\t\tpublic:\n\t\t\tenum class Position { in, next, previous };\n\n\t\t\tActionPositionCursor(DataCell::id_t ref_id_, Position pos_);\n\t\t\tvirtual ~ActionPositionCursor() {};\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\tprivate:\n\t\t\tuint64_t needed_new_cell_with_id;\n\t\t\tDTree::iterator newref;\n\t\t\tPosition pos;\n\t\t};\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Update the running status of the indicated cell.\n\n\tclass ActionSetRunStatus : public ActionBase {\n\t\tpublic:\n\t\t\tActionSetRunStatus(DataCell::id_t ref_id_, bool running);\n\t\t\tvirtual ~ActionSetRunStatus() {};\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\t\tvirtual bool undoable() const override;\n\t\tprivate:\n\t\t\tDTree::iterator this_cell;\n\t\t\tbool was_running_, new_running_;\n\t\t};\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Update the list of referenced variables in this cell.\n\n\tclass ActionSetVariableList : public ActionBase {\n\t\tpublic:\n\t\t\tActionSetVariableList(DataCell::id_t ref_id_, std::set);\n\t\t\tvirtual ~ActionSetVariableList() {};\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\t\tvirtual bool undoable() const override;\n\t\tprivate:\n\t\t\tDTree::iterator this_cell;\n\t\t\tstd::set new_variables_;\n\t\t};\n\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Remove a cell and all its child cells from the document.\n\n\tclass ActionRemoveCell : public ActionBase {\n\t\tpublic:\n\t\t\tActionRemoveCell(DataCell::id_t ref_id_);\n\t\t\tvirtual ~ActionRemoveCell();\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\tprivate:\n\t\t\t// Keep track of the location where this cell (and its child\n\t\t\t// cells) was in the notebook. We keep a reference to the\n\t\t\t// parent cell and the index of the current cell as child of\n\t\t\t// that parent.\n\n\t\t\tDTree removed_tree;\n\t\t\tDTree::iterator reference_parent_cell;\n\t\t\tsize_t reference_child_index;\n\t\t};\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Replace the contents of a cell. Not undo-able.\n\n\tclass ActionReplaceCell : public ActionBase {\n\t\tpublic:\n\t\t\tActionReplaceCell(DataCell::id_t ref_id_);\n\t\t\tvirtual ~ActionReplaceCell();\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\t\tvirtual bool undoable() const override;\n\t\tprivate:\n\t\t};\n\t\n\t/// \\ingroup clientserver\n\t///\n\t/// Split a cell into two separate cells, at the point of the cursor.\n\n\tclass ActionSplitCell : public ActionBase {\n\t\tpublic:\n\t\t\tActionSplitCell(DataCell::id_t ref_id);\n\t\t\tvirtual ~ActionSplitCell();\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\tprivate:\n\t\t\tDTree::iterator newref; // the newly created cell\n\t\t};\n\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Run a cell or run all cells. \n\n\tclass ActionRunCell : public ActionBase {\n\t\tpublic:\n\t\t\t// Run a particular cell.\n\t\t\tActionRunCell(DataCell::id_t ref_id);\n\t\t\t// Run all cells.\n\t\t\tActionRunCell();\n\t\t\t\n\t\t\tvirtual ~ActionRunCell();\n\t\t\t\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\t\t\t\n\t\t\tvirtual bool undoable() const override;\n\t\tprivate:\n\t\t\tbool run_all_cells;\n\t};\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Open a notebook from a file, in the current window.\n\n\tclass ActionOpen : public ActionBase {\n\t\tpublic:\n\t\t\tActionOpen(const std::string&);\n\t\t\tvirtual ~ActionOpen();\n\t\t\t\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\t\t\t\n\t\t\tvirtual bool undoable() const override;\n\t\tprivate:\n\t\t\tstd::string notebook_name;\n\t};\n\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Add a text string (can be just a single character) at the point\n\t/// of the cursor.\n\t/// This action is assumed to be triggered from a user change to\n\t/// the GUI cells, so will not update the GUI itself, only the\n\t/// underlying DTree. However, the revert method will need to\n\t/// update the GUI representation.\n\n\tclass ActionInsertText : public ActionBase {\n\t\tpublic:\n\t\t\tActionInsertText(DataCell::id_t ref_id, int pos, const std::string&);\n\t\t\tvirtual ~ActionInsertText() {};\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\tprivate:\n\t\t\tDTree::iterator this_cell;\n\t\t\tint insert_pos;\n\t\t\tstd::string text;\n\t\t};\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Complete text at a point in a GUI cell with one or more\n\t/// alternative.\n\t/// In contrast to ActionInsertText, this one is triggered from\n\t/// the server-side, so will update the GUI both for execute\n\t/// and revert.\n\n\tclass ActionCompleteText : public ActionBase {\n\t\tpublic:\n\t\t\tActionCompleteText(DataCell::id_t ref_id, int pos, const std::string&, int alternative);\n\t\t\tvirtual ~ActionCompleteText() {};\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\t\tint length() const;\n\t\t\tint alternative() const;\n\t\t\t\n\t\tprivate:\n\t\t\tDTree::iterator this_cell;\n\t\t\tint insert_pos;\n\t\t\tstd::string text;\n\t\t\tint alternative_; // in case there is more than one completion alternative\n\t\t};\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Remove a text string starting at the indicated position, and\n\t/// with the indicated length, from the indicated cell.\n\t/// This action is assumed to be triggered from a user change to\n\t/// the GUI cells, so will not update the GUI itself, only the\n\t/// underlying DTree. However, the revert method will need to\n\t/// update the GUI representation.\n\n\tclass ActionEraseText : public ActionBase {\n\t\tpublic:\n\t\t\tActionEraseText(DataCell::id_t ref_id, int, int);\n\t\t\tvirtual ~ActionEraseText() {};\n\n\t\t\tvirtual void execute(DocumentThread&, GUIBase&) override;\n\t\t\tvirtual void revert(DocumentThread&, GUIBase&) override;\n\n\t\tprivate:\n\t\t\tDTree::iterator this_cell;\n\t\t\tint from_pos, to_pos;\n\t\t\tstd::string removed_text;\n\t\t};\n\n\t}\n\n\n//\n// class ActionMergeCells\n\n\n\n"
},
{
"path": "client_server/CMakeLists.txt",
"content": "# cmake_minimum_required(VERSION ${CADABRA_CMAKE_VERSION})\nproject(Cadabra)\n\nif(POLICY CMP0167)\n cmake_policy(SET CMP0167 NEW)\nendif()\n\n#---------------------------------------------------------------------------\n# Preamble.\n#---------------------------------------------------------------------------\n\nprint_header(\"Configuring client-server\")\n\nset(INSTALL_LATEX_DIR \"share/cadabra2\")\n\n\n#---------------------------------------------------------------------------\n# Locate libraries.\n#---------------------------------------------------------------------------\n\nif(USE_GTK4)\n find_package(GLIBMM4 REQUIRED)\nelse()\n find_package(GLIBMM3 REQUIRED)\nendif()\n \nfind_package(SQLITE3 REQUIRED)\n# Don't set pthreads to required. Either we're on a platform where explict\n# linking with -lpthread is the norm (e.g. Linux) and it'll be found, or we're\n# on a platform that include pthreads by default (e.g. BSD, macOS) where this\n# won't find anything, or we're on a road-much-less-traveled OS where the user\n# can figure out what's wrong without a hard error here.\nfind_package(Threads)\n\n# We need at least Boost 1.71.0 because we now use `beast` (for the\n# websocket functionality) which was not stable before that version.\n# Actually, it is probably not stable before 1.75.0, but if we go that\n# high we cannot build on Ubuntu 20.04 anymore.\nfind_package(Boost 1.71.0 COMPONENTS program_options date_time filesystem REQUIRED)\n\n# OpenSSL needs to be linked in explicitly (probably because the boost\n# material referring to it is all in headers?). If you use a cmake module,\n# you will run into issues on MSYS2, so do *not* be tempted to do that\n# unless you test on MSYS2 first.\nset(OpenSSL_USE_STATIC_LIBS OFF)\nfind_package(OpenSSL REQUIRED)\nmessage(STATUS \"OPENSSL_LIBRARIES: ${OPENSSL_LIBRARIES}\")\nmessage(STATUS \"OPENSSL_SSL_LIBRARY: ${OPENSSL_SSL_LIBRARY}\")\nmessage(STATUS \"OPENSSL_CRYPTO_LIBRARY: ${OPENSSL_CRYPTO_LIBRARY}\")\nmessage(STATUS \"OPENSSL_INCLUDE_DIR: ${OPENSSL_INCLUDE_DIR}\")\n\n#---------------------------------------------------------------------------\n# Enumerate input files.\n#---------------------------------------------------------------------------\n\nset(CADABRA_SERVER_SRC\n cadabra-server.cc\n Server.cc\n Snoop.cc\n websocket_client.cc\n websocket_server.cc\n ${CADABRA_CORE_DIR}/InstallPrefix.cc\n ${CADABRA_CORE_DIR}/DataCell.cc\n ${CADABRA_CORE_DIR}/Exceptions.cc\n ${CADABRA_CORE_DIR}/CdbPython.cc \n ${CADABRA_CORE_DIR}/Stopwatch.cc \n ${CADABRA_CORE_DIR}/pythoncdb/py_helpers.cc\n ${CADABRA_LIBS_DIR}/whereami/whereami.c\n ${CADABRA_LIBS_DIR}/base64/base64.cc\n)\n\nset(CADABRA_CLIENT_SRC\n ScriptThread.cc\n ComputeThread.cc \n DocumentThread.cc \n Actions.cc \n Snoop.cc\n websocket_client.cc\n websocket_server.cc\n ${CADABRA_CORE_DIR}/DataCell.cc \n ${CADABRA_CORE_DIR}/Exceptions.cc \n ${CADABRA_CORE_DIR}/InstallPrefix.cc\n ${CADABRA_CORE_DIR}/Stopwatch.cc\n ${CADABRA_LIBS_DIR}/whereami/whereami.c\n)\n \nset(JUPYTER_KERNEL_SRC\n cadabra-jupyter-kernel.cc\n cadabra-jupyter-kernel.hh\n cadabra-jupyter-main.cc\n Server.cc\n ${CADABRA_CORE_DIR}/InstallPrefix.cc\n ${CADABRA_CORE_DIR}/DataCell.cc\n ${CADABRA_CORE_DIR}/Exceptions.cc \n ${CADABRA_CORE_DIR}/CdbPython.cc \n ${CADABRA_CORE_DIR}/Stopwatch.cc \n ${CADABRA_LIBS_DIR}/whereami/whereami.c\n ${CADABRA_LIBS_DIR}/base64/base64.cc\n)\n \n\n# set(CONNECTION_FILE ${CMAKE_CURRENT_SOURCE_DIR}/connection.json)\n# \n# add_custom_command(TARGET echo_kernel POST_BUILD\n# COMMAND ${CMAKE_COMMAND} -E\n# copy \"${CONNECTION_FILE}\" \"${CMAKE_CURRENT_BINARY_DIR}/\")\n# \n# add_custom_command(TARGET echo_kernel POST_BUILD\n# COMMAND ${CMAKE_COMMAND} -E\n# copy \"${CMAKE_BINARY_DIR}/${XEUS_RUNTIME_FILE}\" \"${CMAKE_CURRENT_BINARY_DIR}/\")\n\n#---------------------------------------------------------------------------\n# Include directories and preprocessor directives.\n#---------------------------------------------------------------------------\n\ninclude_directories(\n \".\" \n \"${CADABRA_CORE_DIR}\"\n \"${CADABRA_LIBS_DIR}/pybind11/include\"\n# \"${CADABRA_LIBS_DIR}/websocketpp\" \n \"${CADABRA_LIBS_DIR}/internal/include\"\n \"${CADABRA_LIBS_DIR}/whereami\"\n \"${CADABRA_LIBS_DIR}/base64\"\n \"${CADABRA_LIBS_DIR}/nlohmann\"\n ${OPENSSL_INCLUDE_DIR}\n ${Boost_INCLUDE_DIRS}\n ${Python_INCLUDE_DIRS}\n ${SQLITE3_INCLUDE_DIR}\n)\n\n# add_definitions(\n# -D_WEBSOCKETPP_CPP11_STL_\n# -DBOOST_ASIO_HAS_STD_CHRONO\n# -DBOOST_BIND_GLOBAL_PLACEHOLDERS\n# )\n\n#---------------------------------------------------------------------------\n# Make targets.\n#---------------------------------------------------------------------------\n\n# add_executable(tst tst.cc)\n# target_link_libraries(tst\n# ${Boost_LIBRARIES}\n# Threads::Threads\n# )\n\n# Server executable\nif(WIN32)\n message(STATUS \"Using the win32 subsystem for cadabra-server\")\n add_executable(cadabra-server WIN32 ${CADABRA_SERVER_SRC}) \nelse()\n add_executable(cadabra-server ${CADABRA_SERVER_SRC})\nendif()\n\n# target_link_libraries(cadabra-server cadabra_server)\ntarget_link_libraries(cadabra-server\n pybind11::embed\n ${Boost_LIBRARIES}\n ${SQLITE3_LIBRARIES}\n ${Python_LIBRARIES}\n ${GLIBMM_LIBRARIES} \n ${OPENSSL_LIBRARIES}\n Threads::Threads\n pthread\n )\nif(WIN32)\n target_link_libraries(cadabra-server ws2_32 mswsock bcrypt)\n endif()\n if(UNIX)\n if(${CMAKE_SYSTEM_NAME} MATCHES \".*BSD|DragonFly\")\n target_link_libraries(cadabra-server util)\n else()\n target_link_libraries(cadabra-server dl util)\n endif()\n endif()\n\n# Client library\nadd_library(cadabra_client STATIC ${CADABRA_CLIENT_SRC})\ntarget_link_libraries(cadabra_client\n ${Boost_LIBRARIES}\n ${SQLITE3_LIBRARIES}\n ${Python_LIBRARIES}\n ${GLIBMM_LIBRARIES}\n Threads::Threads\n ${OPENSSL_LIBRARIES}\n )\nif(WIN32)\n target_link_libraries(cadabra_client ws2_32 bcrypt)\nendif()\n\n# cadabra2html\nadd_executable(cadabra2html \n cadabra2html.cc \n ${CADABRA_LIBS_DIR}/base64/base64.cc\n )\ntarget_link_libraries(cadabra2html cadabra_client)\n\n# cadabra2latex\nadd_executable(cadabra2latex \n cadabra2latex.cc \n ${CADABRA_LIBS_DIR}/base64/base64.cc\n )\ntarget_link_libraries(cadabra2latex cadabra_client)\n\n# Make sure sqlite3.dll is copied into the build directory on Windows.\nif (WIN32)\n add_custom_command(TARGET cadabra_client POST_BUILD \n COMMAND ${CMAKE_COMMAND} -E copy_if_different\n ${SQLITE3_LIBRARIES}\n ${PROJECT_BINARY_DIR}/${CADABRA_BUILD_TYPE}/sqlite3.dll\n )\nendif()\n\n\n#---------------------------------------------------------------------------\n# Installation.\n#---------------------------------------------------------------------------\n\n# The preamble 'notebook.tex' should be kept in sync with the one in\n# ../frontend/common/texengine; this one is meant for printing so\n# slightly different, but cadabra-specific macros should be copied.\n\nif (NOT INSTALL_TARGETS_ONLY)\n install(FILES notebook.tex DESTINATION ${INSTALL_LATEX_DIR})\n install(FILES notebook.html DESTINATION ${INSTALL_LATEX_DIR})\nendif()\n#set(INSTALL_LIB_DIR lib CACHE PATH \"Installation directory for libraries\")\n\ninstall(TARGETS cadabra-server DESTINATION ${CDB_BIN_PATH})\ninstall(TARGETS cadabra2html cadabra2latex DESTINATION ${CDB_BIN_PATH})\n\n# We don't need to install the libcadabra_client library as it is statically\n# linked with our binaries anyway.\n# install(\n# TARGETS cadabra_client \n# RUNTIME DESTINATION bin COMPONENT runtime \n# LIBRARY ARCHIVE DESTINATION lib \n# LIBRARY DESTINATION lib\n# )\n# install(TARGETS cadabra_server LIBRARY ARCHIVE DESTINATION lib LIBRARY DESTINATION lib)\n\nif(ENABLE_JUPYTER)\n install(TARGETS cadabra-jupyter-kernel DESTINATION ${CDB_BIN_PATH})\n install(FILES kernel.json connection.json DESTINATION share/jupyter/kernels/cadabra)\nendif()\n\nif (MSVC AND NOT INSTALL_TARGETS_ONLY)\n # GTK helpers\n install(\n FILES\n \"${_VCPKG_ROOT_DIR}/installed/x64-windows/tools/glib/gspawn-win64-helper.exe\" \n \"${_VCPKG_ROOT_DIR}/installed/x64-windows/tools/glib/gspawn-win64-helper-console.exe\"\n DESTINATION\n ${CDB_BIN_PATH}\n )\n # Python (for some reason this is not copied in)\n get_filename_component(CDB_PYTHON_BASE ${Python_LIBRARIES} NAME_WE)\n get_filename_component(CDB_PYTHON_PATH ${Python_LIBRARIES} DIRECTORY)\n message(\"--- Python directory: ${CDB_PYTHON_PATH}\")\n string(TOLOWER ${CDB_PYTHON_BASE} CDB_PYTHON_BASE)\n message(\"--- Python library: ${CDB_PYTHON_BASE}.dll\")\n install(FILES \"${CDB_PYTHON_PATH}/../${CDB_PYTHON_BASE}.dll\"\n DESTINATION ${CDB_BIN_PATH}\n )\nendif()\n\n# manual pages\nif(NOT MSVC)\n install(\n FILES\n ../man/man1/cadabra-server.1\n DESTINATION\n share/man/man1\n )\nendif()\n"
},
{
"path": "client_server/ComputeThread.cc",
"content": "\n#include \n#include \n#include \n#include \"ComputeThread.hh\"\n#include \"DocumentThread.hh\"\n#include \"GUIBase.hh\"\n#include \"Actions.hh\"\n#include \"InstallPrefix.hh\"\n#include \"popen2.hh\"\n#include \n#include \n#include \"internal/unistd.h\"\n#include \"CdbPython.hh\"\n\nusing namespace cadabra;\n\nComputeThread::ComputeThread(int server_port, std::string token, std::string ip_address)\n\t: gui(0), docthread(0), connection_is_open(false), restarting_kernel(false), server_pid(0),\n\t server_stdout(0), server_stderr(0), forced_server_port(server_port), forced_server_token(token),\n\t forced_server_ip_address(ip_address)\n\t{\n\t// The ComputeThread constructor (but _not_ the run() member!) is\n\t// always run on the gui thread, so we can grab the gui thread id\n\t// here.\n\n\tgui_thread_id=std::this_thread::get_id();\n\t}\n\nComputeThread::~ComputeThread()\n\t{\n\tif(server_stdout!=0) {\n\t\tclose(server_stdout);\n\t\t// close(server_stderr);\n\t\tGlib::spawn_close_pid(server_pid);\n\t\tserver_pid=0;\n\t\tserver_stdout=0;\n\t\tserver_stderr=0;\n\t\t}\n\t}\n\nvoid ComputeThread::set_master(GUIBase *b, DocumentThread *d)\n\t{\n\tgui=b;\n\tdocthread=d;\n\t}\n\nvoid ComputeThread::init()\n\t{\n\t// Setup the WebSockets client.\n\t}\n\nvoid ComputeThread::try_connect()\n\t{\n\twsclient.set_connect_handler(std::bind(&ComputeThread::on_open, this));\n\twsclient.set_fail_handler(std::bind(&ComputeThread::on_fail, this, std::placeholders::_1));\n\twsclient.set_close_handler(std::bind(&ComputeThread::on_close, this));\n\twsclient.set_message_handler(std::bind(&ComputeThread::on_message, this, std::placeholders::_1));\n\n\tstd::ostringstream uristr;\n\turistr << \"ws://\" << (forced_server_ip_address.empty() ? \"127.0.0.1\" : forced_server_ip_address) << \":\" << port;\n\twsclient.connect(uristr.str());\n\n\t// std::cerr << \"cadabra-client: connect done\" << std::endl;\n\t}\n\nvoid ComputeThread::run()\n\t{\n\t// This does *not* run on the GUI thread.\n\t\n\tinit();\n\ttry_spawn_server();\n\ttry_connect();\n\n\t// Enter run loop, which will never terminate anymore. The on_fail and on_close\n\t// handlers will re-try to establish connections when they go bad.\n\n\twsclient.run();\n\t}\n\nvoid ComputeThread::terminate()\n\t{\n\twsclient.stop();\n\n\t// If we have started the server ourselves, stop it now so we do\n\t// not leave mess behind.\n\t// http://riccomini.name/posts/linux/2012-09-25-kill-subprocesses-linux-bash/\n\n\tif(server_pid!=0) {\n\t\tstd::cerr << \"cadabra-client: killing server\" << std::endl;\n\n\t\tif(server_stdout!=0) {\n\t\t\tclose(server_stdout);\n\t\t\t// close(server_stderr);\n\t\t\tGlib::spawn_close_pid(server_pid);\n\t\t\tserver_pid=0;\n\t\t\tserver_stdout=0;\n\t\t\tserver_stderr=0;\n\t\t\t}\n\t\t//\t\tkill(server_pid, SIGKILL);\n\t\t// \t\tif(server_stdout)\n\t\t//\t\t\tpclose2(server_stdout, server_pid);\n\t\t}\n\t}\n\nbool ComputeThread::kernel_is_connected() const\n\t{\n\treturn connection_is_open;\n\t}\n\nvoid ComputeThread::all_cells_nonrunning()\n\t{\n\tfor(auto it: running_cells) {\n\t\tstd::shared_ptr rs_action =\n\t\t std::make_shared(it.first, false);\n\t\tdocthread->queue_action(rs_action);\n\t\t}\n\tif(gui) {\n\t\tgui->process_data();\n\t\tgui->on_kernel_runstatus(false);\n\t\t}\n\trunning_cells.clear();\n\t}\n\nvoid ComputeThread::on_fail(const boost::beast::error_code& ec)\n\t{\n\tif(!restarting_kernel) {\n\t\tstd::cerr << \"cadabra-client: connection to server on port \" << port << \" failed, \" << ec.message() << std::endl;\n\t\t}\n\tconnection_is_open=false;\n\tall_cells_nonrunning();\n\tif(gui && server_pid!=0) {\n\t\t// When a kernel restart is in progress, server_pid will be zero\n\t\t// and this block never runs.\n\t\tclose(server_stdout);\n\t\t// close(server_stderr);\n\t\t// std::cerr << \"closing connetion to terminated server\" << std::endl;\n\t\tGlib::spawn_close_pid(server_pid);\n\t\t//\t\tkill(server_pid, SIGKILL);\n\t\tserver_pid=0;\n\t\tserver_stdout=0;\n\t\tserver_stderr=0;\n\t\tgui->on_network_error();\n\t\t}\n\n\ttry_spawn_server();\n\ttry_connect();\n\t}\n\nusing SlotSpawnChildSetup = sigc::slot;\n\nvoid ComputeThread::try_spawn_server()\n\t{\n\t// Startup the server. First generate a UUID, pass this to the\n\t// starting server, then use this UUID to get access to the server\n\t// port.\n\n\t// std::cerr << \"cadabra-client: spawning server\" << std::endl;\n\n\tif(forced_server_port!=0) {\n\t\tport=forced_server_port;\n\t\tauthentication_token=forced_server_token;\n\t\treturn;\n\t\t}\n\n\tstd::vector argv, envp;\n#if defined(_WIN32) || defined(_WIN64)\n\targv.push_back(\"cadabra-server.exe\");\n#else\n\tconst char *appdir = getenv(\"APPDIR\");\n\tif(appdir) {\n\t\t// std::cerr << \"This is an AppImage, APPDIR = \" << appdir << std::endl;\n\t\targv.push_back(std::string(appdir)+\"/usr/bin/cadabra-server\");\n\t\t}\n\telse {\n\t\t// std::cerr << \"Not an AppImage.\" << std::endl;\n\t\targv.push_back(\"cadabra-server\");\n\t\t}\n#endif\n\tGlib::Pid pid;\n\tstd::string wd(\"\");\n\n\t// See https://bugs.launchpad.net/inkscape/+bug/1662531 for things related to\n\t// the 'envp' argument in the call below.\n\ttry {\n#ifdef _WIN32\n\t\tGlib::SpawnFlags flags = Glib::SPAWN_DO_NOT_REAP_CHILD | Glib::SPAWN_SEARCH_PATH | Glib::SpawnFlags::SPAWN_STDERR_TO_DEV_NULL;\n#else\n #if GLIBMM_MAJOR_VERSION > 2 || (GLIBMM_MAJOR_VERSION == 2 && GLIBMM_MINOR_VERSION >= 68)\n\t\tGlib::SpawnFlags flags = Glib::SpawnFlags::DEFAULT | Glib::SpawnFlags::SEARCH_PATH,\n #else\n\t\tGlib::SpawnFlags flags = Glib::SPAWN_DO_NOT_REAP_CHILD | Glib::SPAWN_SEARCH_PATH;\n #endif\n#endif\n\t\t\n\t\tGlib::spawn_async_with_pipes(wd, argv, /* envp, WITH envp, Fedora 27 fails to start python properly */\n\t\t\t\t\t\t\t\t\t\t\t flags,\n\t\t sigc::slot(),\n\t\t &pid,\n\t\t 0,\n\t\t &server_stdout,\n\t\t 0); // We need to see stderr on the console\n\t\t//\t\t\t\t\t\t\t\t\t\t &server_stderr);\n\n//#if GLIBMM_MAJOR_VERSION > 2 || (GLIBMM_MAJOR_VERSION == 2 && GLIBMM_MINOR_VERSION >= 68)\n//\t\t\t\t\t\t\t\t\t\t\t Glib::SpawnFlags::DEFAULT | Glib::SpawnFlags::SEARCH_PATH,\n//\t\t sigc::slot(),\n//#else\n//\t\t flags,\n//\t\t sigc::slot([](){ FreeConsole(); }),\n//#endif\n//\t\t &pid,\n//\t\t 0,\n//\t\t &server_stdout,\n//\t\t 0); // We need to see stderr on the console\n//\t\t//\t\t\t\t\t\t\t\t\t\t &server_stderr);\n\n\t\tchar buffer[100];\n\t\tFILE *f = fdopen(server_stdout, \"r\");\n\t\tif(fscanf(f, \"%99s\", buffer)!=1) {\n\t\t\tthrow std::logic_error(\"Failed to read port from server.\");\n\t\t\t}\n\t\tport = atoi(buffer);\n\t\tif(fscanf(f, \"%99s\", buffer)!=1) {\n\t\t\tthrow std::logic_error(\"Failed to read authentication token from server.\");\n\t\t\t}\n\t\tauthentication_token=std::string(buffer);\n\t\t// std::cerr << \"auth token: \" << authentication_token << std::endl;\n\t\t}\n\tcatch(Glib::SpawnError& err) {\n\t\tstd::cerr << \"Failed to start server \" << argv[0] << \": \" << err.what() << std::endl;\n\t\t// FIXME: cannot just fall through, the server is not up!\n\t\t}\n\t}\n\nvoid ComputeThread::on_open()\n\t{\n\tconnection_is_open=true;\n\trestarting_kernel=false;\n\tif(gui) {\n\t\tgui->on_connect();\n\t\tgui->on_kernel_runstatus(false);\n\t\t}\n\n\t//\t// now it is safe to use the connection\n\t//\tstd::string msg;\n\t//\n\t////\tif(stopit) {\n\t////\t\tmsg =\n\t////\t\t\t\"{ \\\"header\\\": { \\\"uuid\\\": \\\"none\\\", \\\"msg_type\\\": \\\"execute_interrupt\\\" },\"\n\t////\t\t\t\" \\\"content\\\": { \\\"code\\\": \\\"print(42)\\n\\\"} \"\n\t////\t\t\t\"}\";\n\t////\t\t}\n\t////\telse {\n\t//\t\tmsg =\n\t//\t\t\t\"{ \\\"header\\\": { \\\"uuid\\\": \\\"none\\\", \\\"msg_type\\\": \\\"execute_request\\\" },\"\n\t//\t\t\t\" \\\"content\\\": { \\\"code\\\": \\\"import time\\nprint(42)\\ntime.sleep(10)\\n\\\"} \"\n\t//\t\t\t\"}\";\n\t////\t\t}\n\t//\n\t////\tc->send(hdl, \"import time\\nfor i in range(0,10):\\n print('this is python talking '+str(i))\\nex=Ex('A_{m n}')\\nprint(str(ex))\", websocketpp::frame::opcode::text);\n\t//\tc->send(hdl, msg, websocketpp::frame::opcode::text);\n\t}\n\nvoid ComputeThread::on_close()\n\t{\n\t// std::cerr << \"cadabra-client: connection closed\" << std::endl;\n\tconnection_is_open=false;\n\tall_cells_nonrunning();\n\tif(gui) {\n\t\tif(restarting_kernel) {\n\t\t\tgui->on_disconnect(\"restarting kernel\");\n\t\t\tgui->on_kernel_runstatus(true);\n\t\t\t}\n\t\telse {\n\t\t\tgui->on_disconnect(\"not connected\");\n\t\t\t}\n\t\t}\n\n\tsleep(1); // do not cause a torrent...\n\ttry_connect();\n\t}\n\nvoid ComputeThread::cell_finished_running(DataCell::id_t id)\n\t{\n\tif(id.id==0) {\n\t\t// This was code without a cell representation (run in\n\t\t// response to e.g. a slider update). Ignore.\n\t\t}\n\telse {\n\t\tauto it=running_cells.find(id);\n\t\tif(it==running_cells.end()) {\n\t\t\tthrow std::logic_error(\"Cannot find cell with id = \"+std::to_string(id.id));\n\t\t\t}\n\t\t\n\t\tif(it->second==1) {\n\t\t\t// Mark this cell as no longer running.\n\t\t\tstd::shared_ptr rs_action =\n\t\t\t\tstd::make_shared(id, false);\n\t\t\tdocthread->queue_action(rs_action);\n\n\t\t\trunning_cells.erase(it);\n\t\t\t}\n\t\telse\n\t\t\tit->second -= 1;\n\t\t}\n\t}\n\nvoid ComputeThread::on_message(const std::string& msg)\n\t{\n\t// Parse the JSON message.\n\tnlohmann::json root;\n\n\ttry {\n\t\troot=nlohmann::json::parse(msg);\n\t\t}\n\tcatch(nlohmann::json::exception& e) {\n\t\tstd::cerr << \"cadabra-client: cannot parse message.\" << std::endl;\n\t\treturn;\n\t\t}\n\tif(getenv(\"CADABRA_SHOW_RECEIVED\")) {\n\t\tstd::cerr << \"RECV: \" << root.dump(3) << std::endl;\n\t\t}\n\t\n\tif(root.count(\"header\")==0) {\n\t\tstd::cerr << \"cadabra-client: received message without 'header'.\" << std::endl;\n\t\treturn;\n\t\t}\n\tif(root.count(\"content\")==0) {\n\t\tstd::cerr << \"cadabra-client: received message without 'content'.\" << std::endl;\n\t\treturn;\n\t\t}\n\tconst nlohmann::json& header = root[\"header\"];\n\tconst nlohmann::json& content = root[\"content\"];\n\tconst std::string msg_type = root.value(\"msg_type\", \"\");\n\n\tDataCell::id_t parent_id;\n\tparent_id.id = header.value(\"parent_id\", uint64_t(0));\n\tif(header.value(\"parent_origin\", \"\")==\"client\")\n\t\tparent_id.created_by_client=true;\n\telse\n\t\tparent_id.created_by_client=false;\n\tDataCell::id_t cell_id;\n\tcell_id.id = header[\"cell_id\"].get();\n\tif(header.value(\"cell_origin\", \"\")==\"client\")\n\t\tcell_id.created_by_client=true;\n\telse\n\t\tcell_id.created_by_client=false;\n\t// std::cerr << \"received cell with id \" << cell_id.id << std::endl;\n\n\t// Determine if this refers to a special cell in the interactive console.\n\tif (interactive_cells.find(parent_id.id) != interactive_cells.end()) {\n\t\tinteractive_cells.insert(cell_id.id);\n\t\tdocthread->on_interactive_output(root);\n\t}\n\telse if (interactive_cells.find(cell_id.id) != interactive_cells.end()) {\n\t\tdocthread->on_interactive_output(root);\n\t\t}\n\telse if (msg_type.find(\"csl_\") == 0) {\n\t\troot[\"header\"][\"from_server\"] = true;\n\t\tdocthread->on_interactive_output(root);\n\t\t}\n\telse if (msg_type == \"progress_update\") {\n\t\tstd::string msg = content.value(\"msg\", \"Idle\");\n\t\tint n = content.value(\"n\", 0);\n\t\tint total = content.value(\"total\", 0);\n\t\t// FIXME: do something with 'pulse':\n\t\t// int pulse = content.value(\"pulse\", false);\n\t\tdocthread->set_progress(msg, n, total);\n\t}\n\telse if(msg_type==\"completed\") {\n\t\t// std::cerr << \"received completion of \" << content[\"original\"] << \" -> \" << content[\"completed\"] << std::endl;\n\n\t\t// Finally, the action to add the output cell.\n\t\tstd::string toadd=content[\"completed\"].get();\n\t\tif(toadd.size()>0) {\n\t\t\ttoadd=toadd.substr(content[\"original\"].get().size());\n\t\t\tint pos=content[\"position\"].get();\n\t\t\tint alternative=content[\"alternative\"].get();\n\t\t\tstd::shared_ptr action =\n\t\t\t\tstd::make_shared(cell_id, pos, toadd, alternative);\n\t\t\tdocthread->queue_action(action);\n\t\t\t}\n\t\t}\n\telse {\n\t\ttry {\n\t\t\tbool finished = header[\"last_in_sequence\"].get();\n\n\t\t\tif (finished) {\n\t\t\t\tif(parent_id.id!=0) {\n\t\t\t\t\t// If this cell references variables, store them in the DataCell.\n\t\t\t\t\tif(content.count(\"variables\")>0) {\n\t\t\t\t\t\tstd::set vars;\n\t\t\t\t\t\tfor(const auto& var: content[\"variables\"])\n\t\t\t\t\t\t\tvars.insert(var);\n\t\t\t\t\t\t\n\t\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t\t\tstd::make_shared(parent_id, vars);\n\t\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\tcell_finished_running(parent_id);\n\t\t\t\t}\n\n\t\t\tif (content.count(\"output\")>0 && content[\"output\"].get().size() > 0) {\n\t\t\t\tif (msg_type == \"output\") {\n\t\t\t\t\tstd::string output = \"\\\\begin{verbatim}\" + content[\"output\"].get() + \"\\\\end{verbatim}\";\n\n\t\t\t\t\t// Stick an AddCell action onto the stack. We instruct the\n\t\t\t\t\t// action to add this result output cell as a child of the\n\t\t\t\t\t// corresponding input cell.\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::output, output);\n\n\t\t\t\t\t// Finally, the action to add the output cell.\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t}\n\t\t\t\telse if (msg_type == \"verbatim\") {\n\t\t\t\t\tstd::string output = \"\\\\begin{verbatim}\" + content[\"output\"].get() + \"\\\\end{verbatim}\";\n\n\t\t\t\t\t// Stick an AddCell action onto the stack. We instruct the\n\t\t\t\t\t// action to add this result output cell as a child of the\n\t\t\t\t\t// corresponding input cell.\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::verbatim, output);\n\n\t\t\t\t\t// Finally, the action to add the output cell.\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t}\n\t\t\t\telse if (msg_type == \"latex_view\") {\n\t\t\t\t\t// std::cerr << \"received latex cell \" << content[\"output\"].asString() << std::endl;\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::latex_view, content[\"output\"].get());\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t}\n\t\t\t\telse if (msg_type == \"input_form\") {\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::input_form, content[\"output\"].get());\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t}\n\t\t\t\telse if (msg_type == \"error\" || msg_type==\"fault\") {\n\t\t\t\t\tstd::string error = \"\\\\begin{verbatim}\" + content[\"output\"].get()\n\t\t\t\t\t + \"\\\\end{verbatim}\";\n\t\t\t\t\t//if (msg_type == \"fault\") {\n\t\t\t\t\t//\terror = \"Kernel fault\\\\begin{small}\" + error + \"\\\\end{small}\";\n\t\t\t\t\t//\t}\n\n\t\t\t\t\t// Stick an AddCell action onto the stack. We instruct the\n\t\t\t\t\t// action to add this result output cell as a child of the\n\t\t\t\t\t// corresponding input cell.\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::error, error);\n\n\t\t\t\t\t// Finally, the action.\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\n\t\t\t\t\t// Position the cursor in the cell that generated the error. All other cells on\n\t\t\t\t\t// the execute queue have been cancelled by the server.\n\t\t\t\t\tstd::shared_ptr actionpos =\n\t\t\t\t\t std::make_shared(parent_id, ActionPositionCursor::Position::in);\n\t\t\t\t\tdocthread->queue_action(actionpos);\n\n\t\t\t\t\t// Action has stopped, so mark all cells as non-running.\n\t\t\t\t\tall_cells_nonrunning();\n\t\t\t\t\t}\n\t\t\t\telse if (msg_type == \"image_png\") {\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::image_png, content[\"output\"].get());\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t}\n\t\t\t\telse if (msg_type == \"image_svg\") {\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::image_svg, content[\"output\"].get());\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t}\n\t\t\t\telse if (msg_type == \"slider\") {\n\t\t\t\t\tDataCell result(cell_id, DataCell::CellType::slider, content[\"output\"].get());\n\t\t\t\t\tstd::shared_ptr action =\n\t\t\t\t\t std::make_shared(result, parent_id, ActionAddCell::Position::child);\n\t\t\t\t\tdocthread->queue_action(action);\n\t\t\t\t\t}\n\t\t\t\telse {\n\t\t\t\t\tstd::cerr << \"cadabra-client: received cell we did not expect: \"\n\t\t\t\t\t << msg_type << \": \" << content << std::endl;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\tcatch (std::logic_error& ex) {\n\t\t\t// WARNING: if the server sends\n\t\t\tstd::cerr << \"cadabra-client: trouble processing server response: \" << ex.what() << std::endl;\n\t\t\t}\n\t\t}\n\n\t// Update kernel busy indicator depending on number of running cells.\n\tif(number_of_cells_executing()>0)\n\t\tgui->on_kernel_runstatus(true);\n\telse\n\t\tgui->on_kernel_runstatus(false);\n\n\tgui->process_data();\n\t}\n\nvoid ComputeThread::execute_interactive(uint64_t id, const std::string& code)\n\t{\n\tassert(gui_thread_id == std::this_thread::get_id());\n\n\tif (!connection_is_open)\n\t\treturn;\n\n\tif (code.substr(0, 7) == \"reset()\")\n\t\treturn restart_kernel();\n\n\tnlohmann::json req, header, content;\n\n\theader[\"msg_type\"] = \"execute_request\";\n\theader[\"cell_id\"] = id;\n\theader[\"interactive\"] = true;\n\tcontent[\"code\"] = code.c_str();\n\n\treq[\"auth_token\"] = authentication_token;\n\treq[\"header\"] = header;\n\treq[\"content\"] = content;\n\n\tstd::ostringstream oss;\n\toss << req << std::endl;\n\tif(getenv(\"CADABRA_SHOW_SENT\")) {\n\t\tstd::cerr << \"SENT: \" << req.dump(3) << std::endl;\n\t\t}\n\twsclient.send(oss.str());\n\tinteractive_cells.insert(id);\n\t}\n\nvoid ComputeThread::execute_cell(DTree::iterator it, std::string no_assign, std::vector output_cell_ids)\n\t{\n\t// This absolutely has to be run on the main GUI thread.\n\tassert(gui_thread_id==std::this_thread::get_id());\n\n\tif(connection_is_open==false)\n\t\treturn;\n\n\tconst DataCell& dc=(*it);\n\n\t// std::cout << \"cadabra-client: ComputeThread going to execute \" << dc.textbuf << std::endl;\n\n\tif((it->textbuf).substr(0,7)==\"reset()\") {\n\t\trestart_kernel();\n\n\t\tstd::shared_ptr action =\n\t\t std::make_shared(it->id(), ActionPositionCursor::Position::next);\n\n\t\tdocthread->queue_action(action);\n\t\treturn;\n\t\t}\n\n\t// Position the cursor in the next cell so this one will not\n\t// accidentally get executed twice. This runs synchronously!\n\tstd::shared_ptr actionpos =\n\t std::make_shared(it->id(), ActionPositionCursor::Position::next);\n\tdocthread->queue_action(actionpos);\n\tgui->process_data();\n\n\t// For a code cell, construct a server request message and then\n\t// send the cell to the server.\n\tif(it->cell_type==DataCell::CellType::python) {\n\t\tauto rit=running_cells.find(dc.id());\n\t\tif(rit==running_cells.end())\n\t\t\trunning_cells[dc.id()]=1;\n\t\telse\n\t\t\trit->second += 1;\n\n\t\t// Schedule an action to update the running status of this cell.\n\t\tstd::shared_ptr rs_action =\n\t\t std::make_shared(it->id(), true);\n\t\tdocthread->queue_action(rs_action);\n\n\t\tnlohmann::json req, header, content;\n\t\theader[\"uuid\"]=\"none\";\n\t\theader[\"cell_id\"]=dc.id().id;\n\t\tif(dc.id().created_by_client)\n\t\t\theader[\"cell_origin\"]=\"client\";\n\t\telse\n\t\t\theader[\"cell_origin\"]=\"server\";\n\t\theader[\"msg_type\"]=\"execute_request\";\n\t\theader[\"output_cell_ids\"]=output_cell_ids;\n\t\treq[\"auth_token\"]=authentication_token;\n\t\treq[\"header\"]=header;\n\t\tcontent[\"remove_variable_assignments\"]=no_assign;\n\t\tcontent[\"code\"]=dc.textbuf;\n\t\treq[\"content\"]=content;\n\n\t\tgui->on_kernel_runstatus(true);\n\t\tstd::ostringstream str;\n\t\tstr << req << std::endl;\n\t\tif(getenv(\"CADABRA_SHOW_SENT\")) {\n\t\t\tstd::cerr << \"SENT: \" << req.dump(3) << std::endl;\n\t\t\t}\n\t\twsclient.send(str.str());\n\t\t// NOTE: we can get a return message in on_message at any point after this,\n\t\t// it will come in on a different thread!\n\t\t}\n\n\t// For a LaTeX cell, immediately request a new latex output cell to be displayed.\n\tif(it->cell_type==DataCell::CellType::latex) {\n\t\t// Stick an AddCell action onto the stack. We instruct the\n\t\t// action to add this result output cell as a child of the\n\t\t// corresponding input cell.\n\t\tDataCell result(DataCell::CellType::latex_view, it->textbuf);\n\n\t\tstd::shared_ptr action =\n\t\t std::make_shared(result, it->id(), ActionAddCell::Position::child);\n\t\tdocthread->queue_action(action);\n\t\t}\n\t}\n\nvoid ComputeThread::update_variable_on_server(std::string variable, double value)\n\t{\n\tnlohmann::json req, header, content;\n\theader[\"uuid\"]=\"none\";\n\theader[\"cell_id\"]=0;\n\theader[\"cell_origin\"]=\"client\";\n\theader[\"msg_type\"]=\"execute_request\";\n\treq[\"auth_token\"]=authentication_token;\n\treq[\"header\"]=header;\n\tcontent[\"code\"]=variable + \"=\" + std::to_string(value);\n\treq[\"content\"]=content;\n\t\n\tstd::ostringstream str;\n\tstr << req << std::endl;\n\tif(getenv(\"CADABRA_SHOW_SENT\")) {\n\t\tstd::cerr << \"SENT: \" << req.dump(3) << std::endl;\n\t\t}\n\twsclient.send(str.str());\n\t}\n\n\nint ComputeThread::number_of_cells_executing() const\n\t{\n\treturn running_cells.size();\n\t}\n\nvoid ComputeThread::stop()\n\t{\n\tif(connection_is_open==false)\n\t\treturn;\n\n\t// std::cerr << \"stopping existing kernel\" << std::endl;\n\t\n\tnlohmann::json req, header, content;\n\theader[\"uuid\"]=\"none\";\n\theader[\"msg_type\"]=\"execute_interrupt\";\n\treq[\"auth_token\"]=authentication_token;\n\treq[\"header\"]=header;\n\n\tstd::ostringstream str;\n\tstr << req << std::endl;\n\n\t//\tstd::cerr << str.str() << std::endl;\n\n\tserver_pid=0;\n\tif(getenv(\"CADABRA_SHOW_SENT\")) {\n\t\tstd::cerr << \"SENT: \" << req.dump(3) << std::endl;\n\t\t}\n\twsclient.send(str.str());\n\t// Do not yet mark cells non-running, otherwise we are unable to\n\t// process any error messages. Do this once the stop comes through.\n\t// all_cells_nonrunning();\t\n\t}\n\nvoid ComputeThread::restart_kernel()\n\t{\n\tif(connection_is_open==false)\n\t\treturn;\n\n\trestarting_kernel=true;\n\n\t// Restarting the kernel means all previously running blocks have stopped running.\n\t// Inform the GUI about this.\n\t// FIXME: set all running flags to false\n\tgui->on_kernel_runstatus(false);\n\n\t// std::cerr << \"cadabra-client: restarting kernel\" << std::endl;\n\tnlohmann::json req, header, content;\n\theader[\"uuid\"]=\"none\";\n\theader[\"msg_type\"]=\"exit\";\n\theader[\"from_server\"] = true;\n\treq[\"auth_token\"]=authentication_token;\n\treq[\"header\"]=header;\n\n\tstd::ostringstream str;\n\tstr << req << std::endl;\n\n\t//\tstd::cerr << str.str() << std::endl;\n\n\tif(getenv(\"CADABRA_SHOW_SENT\")) {\n\t\tstd::cerr << \"SENT: \" << req.dump(3) << std::endl;\n\t\t}\n\twsclient.send(str.str());\n\tdocthread->on_interactive_output(req);\n\t}\n\nbool ComputeThread::complete(DTree::iterator it, int pos, int alternative)\n\t{\n\tif(connection_is_open==false)\n\t\treturn false;\n\n\tconst DataCell& dc=(*it);\n\n\tnlohmann::json req, header, content;\n\theader[\"uuid\"]=\"none\";\n\theader[\"cell_id\"]=dc.id().id;\n\tif(dc.id().created_by_client)\n\t\theader[\"cell_origin\"]=\"client\";\n\telse\n\t\theader[\"cell_origin\"]=\"server\";\n\theader[\"msg_type\"]=\"complete\";\n\treq[\"auth_token\"]=authentication_token;\n\treq[\"header\"]=header;\n\tstd::string todo = it->textbuf.substr(0,pos);\n//\tif(todo.size()>0 && todo[todo.size()-1]=='\\n')\n//\t\ttodo=todo.substr(0, todo.size()-1);\n\t// std::cerr << \"to complete full: \" << todo << std::endl;\n\tsize_t lst=todo.find_last_of(\"\\n(){}[]:\\t \");\n\tif(lst!=std::string::npos)\n\t\ttodo=todo.substr(lst+1);\n\t// std::cerr << \"to complete strip: \" << todo << std::endl;\n\n\tif(todo.size()==0)\n\t\treturn false;\n\n\treq[\"string\"]=todo;\n\treq[\"position\"]=pos;\n\treq[\"alternative\"]=alternative;\n\n\tstd::ostringstream str;\n\tstr << req << std::endl;\n\n\t// std::cerr << str.str() << std::endl;\n\n\tserver_pid=0;\n\tif(getenv(\"CADABRA_SHOW_SENT\")) {\n\t\tstd::cerr << \"SENT: \" << req.dump(3) << std::endl;\n\t\t}\n\twsclient.send(str.str());\n\n\treturn true;\n\t}\n"
},
{
"path": "client_server/ComputeThread.hh",
"content": "\n#pragma once\n\n#include \n#include \n#include \n#include \n#include \"websocket_client.hh\"\n\n#include \"DataCell.hh\"\n\nnamespace cadabra {\n\n\tclass GUIBase;\n\tclass DocumentThread;\n\n\t/// \\ingroup clientserver\n\t///\n\t/// Base class which talks to the server and sends Action objects back to the\n\t/// DocumentThread.\n\t///\n\t/// ComputeThread is the base class which takes care of doing actual\n\t/// computations with the cells in a document. It handles talking to\n\t/// the server backend. It knows how to pass cells to the server and\n\t/// ask them to be executed. Results are reported back to the GUI by\n\t/// putting ActionBase objects onto its todo stack. ComputeThread never\n\t/// directly modifies the document tree.\n\n\tclass ComputeThread {\n\t\tpublic:\n\t\t\t/// If the ComputeThread is constructed with a null pointer to the\n\t\t\t/// gui, there will be no gui updates, just DTree updates.\n\n\t\t\tComputeThread(int server_port=0, std::string token=\"\", std::string ip_address=\"127.0.0.1\");\n\t\t\tComputeThread(const ComputeThread& )=delete; // You cannot copy this object\n\t\t\t~ComputeThread();\n\n\t\t\t/// Determine the objects that this compute thread should be\n\t\t\t/// talking to.\n\t\t\tvoid set_master(GUIBase *, DocumentThread *);\n\n\t\t\t/// Main entry point, which will connect to the server and\n\t\t\t/// then start an event loop to handle communication with the\n\t\t\t/// server. Only terminates when the connection drops, so run\n\t\t\t/// your GUI on a different thread.\n\n\t\t\tvoid run();\n\n\t\t\t/// In order to execute code on the server, call the\n\t\t\t/// following from the GUI thread. This method returns as\n\t\t\t/// soon as the request has been put on the network queue. If\n\t\t\t/// no communication with the server is necessary, this\n\t\t\t/// returns immediately. The ComputeThread will report the\n\t\t\t/// result of the computation/processing by adding actions to\n\t\t\t/// the DocumentThread owned pending_actions stack, by\n\t\t\t/// calling queue_action. It will never modify the cell\n\t\t\t/// directly, and will also never modify any other cells in\n\t\t\t/// the document tree.\n\n\t\t\tvoid execute_cell(DTree::iterator, std::string no_assign=\"\",\n\t\t\t\t\t\t\t\t\tstd::vector output_cell_ids=std::vector() );\n\n\t\t\tvoid execute_interactive(uint64_t id, const std::string& code);\n\n\t\t\t/// Update a variable in the kernel. This does essentially the\n\t\t\t/// same thing as execute_cell, but will not refer to any\n\t\t\t/// cell as it creates the code itself.\n\n\t\t\tvoid update_variable_on_server(std::string variable, double value);\n\t\t\t\n\t\t\t/// Stop the current cell execution on the server and remove\n\t\t\t/// all other cells from the run queue as well.\n\n\t\t\tvoid stop();\n\n\t\t\t/// Restart the kernel.\n\n\t\t\tvoid restart_kernel();\n\n\t\t\t/// Request completion of a string. Returns `false` if the current\n\t\t\t/// cell cannot be completed, in which case the TAB which led to\n\t\t\t/// the request should be interpreted literally and used for spacing.\n\t\t\t/// The `alternative` argument is the serial number of the requested\n\t\t\t/// completion, in case there is more than one possible completion.\n\n\t\t\tbool complete(DTree::iterator, int pos, int alternative);\n\n\t\t\t// Determine if there are still cells running on the server.\n\t\t\t// FIXME: this does not guarantee thread-safety but at the moment\n\t\t\t// is only used for updating status bars etc.\n\t\t\t// FIXME: can be moved to DocumentThread.\n\n\t\t\tint number_of_cells_executing(void) const;\n\n\t\t\t/// Terminate the compute thread, in preparation for shutting\n\t\t\t/// down the client altogether.\n\n\t\t\tvoid terminate();\n\n\t\t\t/// Return the status of the connection to the kernel.\n\t\t\tbool kernel_is_connected() const;\n\t\t\t\n\t\tprivate:\n\t\t\tGUIBase *gui;\n\t\t\tDocumentThread *docthread;\n\n\t\t\t// For debugging purposes, we keep record of the gui thread id,\n\t\t\t// so that we can flag when code runs on the wrong thread.\n\t\t\t// Gets initialised in the ComputeThread constructor.\n\t\t\tstd::thread::id gui_thread_id;\n\n\t\t\t// Keeping track of cells which are running on the server, in\n\t\t\t// a form which allows us to look them up quickly based only\n\t\t\t// on the id (which is all that the server knows about). A\n\t\t\t// cell can be queued multiple times for running; this is the\n\t\t\t// integer in the map.\n\n\t\t\tstd::map running_cells;\n\n\t\t\t// WebSocket++ things.\n\t\t\twebsocket_client wsclient;\n\t\t\tbool connection_is_open, restarting_kernel;\n\n\t\t\tvoid init();\n\t\t\tvoid try_connect();\n\t\t\tvoid try_spawn_server();\n\t\t\tvoid on_open();\n\t\t\tvoid on_fail(const boost::beast::error_code&);\n\t\t\tvoid on_close();\n\t\t\tvoid on_message(const std::string& msg);\n\n\t\t\tvoid cell_finished_running(DataCell::id_t);\n\n\t\t\t/// Set all cells to be non-running (e.g. after a kernel failure) and\n\t\t\t/// report the status of each cell to the GUI.\n\t\t\tvoid all_cells_nonrunning();\n\n\t\t\tstd::set interactive_cells;\n\n\t\t\t// Self-started server\n\t\t\tGlib::Pid server_pid;\n\t\t\tint server_stdout, server_stderr;\n\t\t\tunsigned short port;\n\t\t\tstd::string authentication_token;\n\t\t\tint forced_server_port;\n\t\t\tstd::string forced_server_token;\n\t\t\tstd::string forced_server_ip_address;\n\t\t};\n\n\t}\n"
},
{
"path": "client_server/DocumentThread.cc",
"content": "\n#include \"Actions.hh\"\n#include \"DocumentThread.hh\"\n#include \"GUIBase.hh\"\n#include \"ComputeThread.hh\"\n#include \"CdbPython.hh\"\n\n#include \n#include \n#include \n#include \n#include \n\n//#include \n\n#include \n#include \n#ifndef EMSCRIPTEN\n#include \n#include \"Snoop.hh\"\n#endif\n#include \"Config.hh\"\n\nusing namespace cadabra;\n\nDocumentThread::DocumentThread(GUIBase* g)\n\t: gui(g)\n\t, compute(0)\n\t, current_cell(doc.end())\n\t, follow_mode(false)\n\t, follow_cell(doc.end())\n\t, follow_last_cell(doc.end())\n\t, disable_stacks(false)\n\t{\n\t// Setup logging.\n\tstd::string version=std::string(CADABRA_VERSION_SEM);\n#ifndef EMSCRIPTEN\n\tsnoop::log.init(\"Cadabra\", version, \"log.cadabra.science\");\n\tsnoop::log.set_sync_immediately(true);\n#endif\n\t//\tsnoop::log(snoop::warn) << \"Starting\" << snoop::flush;\n\n\t}\n\nvoid DocumentThread::on_interactive_output(const nlohmann::json& )\n\t{\n\n\t}\n\nvoid DocumentThread::set_progress(const std::string& msg, int cur_step, int total_steps)\n\t{\n\n\t}\n\nvoid DocumentThread::set_compute_thread(ComputeThread *cl)\n\t{\n\tcompute = cl;\n\t}\n\nvoid DocumentThread::new_document()\n\t{\n\t// Setup a single-cell document. This operation itself cannot be undone,\n\t// so we do it directly on the doc, not using Actions.\n\n\tDataCell top(DataCell::CellType::document);\n\tDTree::iterator doc_it = doc.set_head(top);\n\tgui->add_cell(doc, doc_it, false);\n\n\t// One Python input cell in the empty document.\n\n\tDataCell one(DataCell::CellType::python, \"\");\n\tDTree::iterator one_it = doc.append_child(doc_it, one);\n\tgui->add_cell(doc, one_it, false);\n\n\t// Put a 'position cursor' action on the stack to be executed as\n\t// soon as the GUI is up.\n\n\tstd::shared_ptr actionpos =\n\t std::make_shared(one_it->id(), ActionPositionCursor::Position::in);\n\tqueue_action(actionpos);\n\t}\n\nvoid DocumentThread::load_from_string(const std::string& json)\n\t{\n\tstd::lock_guard guard(stack_mutex);\n\tpending_actions=std::queue >();\n\tdoc.clear();\n\tJSON_deserialise(json, doc);\n\tgui->remove_all_cells();\n\tbuild_visual_representation();\n\t}\n\nvoid DocumentThread::undo()\n\t{\n\tstack_mutex.lock();\n\tif(undo_stack.size()==0) {\n\t\t//std::cerr << \"no entries left on the stack\" << std::endl;\n\t\tstack_mutex.unlock();\n\t\treturn;\n\t\t}\n\n\tdisable_stacks=true;\n\tauto ua = undo_stack.top();\n\t//std::cerr << \"Undo action \" << typeid(*ua).name() << std::endl;\n\n\tredo_stack.push(ua);\n\tundo_stack.pop();\n\t// std::cerr << \"DocumentThread::undo: undo_stack.size() == \" << undo_stack.size() << std::endl;\n\tua->revert(*this, *gui);\n\tdisable_stacks=false;\n\n\tstack_mutex.unlock();\n\t}\n\nvoid DocumentThread::redo()\n\t{\n\tstack_mutex.lock();\n\tif(redo_stack.size()==0) {\n\t\t//std::cerr << \"no entries left on the stack\" << std::endl;\n\t\tstack_mutex.unlock();\n\t\treturn;\n\t\t}\n\n\tdisable_stacks=true;\n\tauto ua = redo_stack.top();\n\t//std::cerr << \"Undo action \" << typeid(*ua).name() << std::endl;\n\n\tundo_stack.push(ua);\n\tredo_stack.pop();\n\tua->execute(*this, *gui);\n\tdisable_stacks=false;\n\n\tstack_mutex.unlock();\n\t}\n\nvoid DocumentThread::build_visual_representation()\n\t{\n\t// Because the add_cell method figures out by itself where to generate the VisualCell,\n\t// we only have feed all cells in turn.\n\n\tDTree::iterator doc_it=doc.begin();\n\twhile(doc_it!=doc.end()) {\n\t\t// std::cout << \"ADDING:\" << doc_it->textbuf << std::endl;\n\t\tgui->add_cell(doc, doc_it, false);\n\t\t++doc_it;\n\t\t}\n\t}\n\n//const DTree& DocumentThread::dtree()\n//\t{\n//\treturn doc;\n//\t}\n\ntemplate\nstruct ci_equal {\n\t\tbool operator()(charT ch1, charT ch2) {\n\t\treturn std::toupper(ch1) == std::toupper(ch2);\n\t\t}\n};\n\ntemplate\nint ci_find_substr( const T& str1, const T& str2, int start_pos )\n\t{\n\tauto start=str1.begin();\n\tstart+=start_pos;\n\ttypename T::const_iterator it = std::search( start, str1.end(),\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tstr2.begin(), str2.end(), ci_equal() );\n\tif ( it != str1.end() ) return it - str1.begin();\n\telse return -1;\n\t}\n\nstd::pair DocumentThread::find_string(DTree::iterator start_it, size_t start_pos, const std::string& f, bool case_ins) const\n\t{\n\t// std::cerr << \"finding from pos \" << start_pos << \", \" << &(*start_it) << \": \" << start_it->textbuf.substr(0,30) << std::endl;\n\tDTree::iterator doc_it=start_it;\n\twhile(doc_it!=doc.end()) {\n\t\t//\t\tstd::cout << doc_it->textbuf << std::endl;\n\t\t// FIXME: re-enable searching in output cells.\n\t\tif(doc_it->hidden==false && (doc_it->cell_type==DataCell::CellType::python || doc_it->cell_type==DataCell::CellType::latex)) {\n\t\t\tsize_t pos;\n\t\t\tif(case_ins)\n\t\t\t\tpos = ci_find_substr(doc_it->textbuf, f, start_pos);\n\t\t\telse\n\t\t\t\tpos = doc_it->textbuf.find(f, start_pos);\n\n\t\t\tif(pos!=std::string::npos)\n\t\t\t\treturn std::make_pair(doc_it, pos);\n\t\t\t}\n\t\tstart_pos=0; // after one fail, start next cell at zero\n\t\t++doc_it;\n\t\t}\n\treturn std::make_pair(doc.end(), std::string::npos);\n\t}\n\nvoid DocumentThread::queue_action(std::shared_ptr ab)\n\t{\n\tstd::lock_guard guard(stack_mutex);\n\tpending_actions.push(ab);\n\t}\n\nvoid DocumentThread::run_all_cells()\n\t{\n\tfollow_mode=true;\n\tDTree::sibling_iterator sib=doc.begin(doc.begin());\n\twhile(sib!=doc.end(doc.begin())) {\n\t\tif(sib->cell_type==DataCell::CellType::python) {\n\t\t\trun_cell(DTree::iterator(sib), false);\n\t\t\tfollow_last_cell=DTree::iterator(sib);\n\t\t\t}\t\t\t\n\t\t++sib;\n\t\t}\n\t}\n\nvoid DocumentThread::run_cell(DTree::iterator it, bool shift_pressed)\n\t{\n\t// First ensure that this cell is not already running, otherwise all hell\n\t// will break loose when we try to double-remove the existing output cell etc.\n\n\tif(it->running)\n\t\treturn;\n\n\t// Ensure this cell is not empty either.\n\n\tif(it->textbuf.size()==0)\n\t\treturn;\n\n\t// Remove child nodes, if any.\n\t// FIXME: Does it make more sense to do this only after the\n\t// execution result comes back from the server?\n\n\tDTree::sibling_iterator sib=doc.begin(it);\n\tgui->dim_output_cells(it);\n\twhile(sib!=doc.end(it)) {\n\t\t// std::cout << \"cadabra-client: scheduling output cell for removal: \" << sib->id().id << std::endl;\n\t\tstd::shared_ptr action = std::make_shared(sib->id());\n\t\tqueue_action(action);\n\t\t++sib;\n\t\t}\n\n\t// Since the user has initiated this cell execution, we can\n\t// turn on cell follow mode.\n\tfollow_cell=it;\n\tfollow_mode=true;\n\n\t// Execute the cell.\n\t// std::cerr << \"Executing cell \" << it->id().id << std::endl;\n\n\t// If this is a LaTeX input cell, and auto-close is turned on, close\n\t// the input cell. Make sure to also feed that into the document\n\t// itself!\n\tif(it->cell_type==DataCell::CellType::latex) \n\t\tif(prefs.auto_close_latex) \n\t\t\tgui->hide_visual_cells(it);\n\t\n\t// Execute the cell. Make sure this comes after the hiding logic above.\n\tcompute->execute_cell(it);\n\t}\n\n\nvoid DocumentThread::run_cells_referencing_variable(std::string variable, double value)\n\t{\n\t// First update the variable itself.\n\tcompute->update_variable_on_server(variable, value);\n\n\t// Re-run all cells referencing this variable.\n\tfollow_mode=false;\n\tDTree::iterator it = doc.begin();\n\twhile(it!=doc.end()) {\n\t\tif(it->cell_type==DataCell::CellType::python) {\n\t\t\tif(it->variables_referenced.count(variable)==1) {\n\t\t\t\tif(it->textbuf.find(\"slider(\")==std::string::npos) {\n\t\t\t\t\t// We have found a cell which depends on the variable.\n\t\t\t\t\t// Collect the cell_id's of the current output cells,\n\t\t\t\t\t// so that we can re-use these.\n\t\t\t\t\tstd::vector output_cell_ids;\n\t\t\t\t\tDTree::iterator sib = doc.begin(it);\n\t\t\t\t\twhile(sib != doc.end(it)) {\n\t\t\t\t\t\toutput_cell_ids.push_back(sib->id().id);\n\t\t\t\t\t\t++sib;\n\t\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// Now execute.\n\t\t\t\t\tcompute->execute_cell(it, variable, output_cell_ids);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t++it;\n\t\t}\n\t}\n\nvoid DocumentThread::process_action_queue()\n\t{\n\t// This routine *absolutely* has to be run on the main GUI thread. Anything\n\t// else is a bug.\n\n\tif(main_thread_id != std::this_thread::get_id())\n\t\tstd::cerr << \"INTERNAL ERROR: DocumentThread::process_action_queue not running on main thread.\"\n\t\t\t\t\t << std::endl;\n\n\tstack_mutex.lock();\n\twhile(pending_actions.size()>0) {\n\t\t// std::cerr << \"pending_actions.size() == \" << pending_actions.size() << std::endl;\n\t\tstd::shared_ptr ab = pending_actions.front();\n\t\t// Unlock the action queue while we are processing this particular action,\n\t\t// so that other actions can be added which we run.\n\t\tstack_mutex.unlock();\n\t\t// std::cerr << \"Executing action \" << typeid(*ab).name() << \" for \" << ab->ref_id.id << std::endl;\n\t\t// Execute the action; this will run synchronously, so after\n\t\t// this returns the doc and visual representation have both been\n\t\t// updated.\n\t\ttry {\n\t\t\tab->execute(*this, *gui);\n\t\t}\n\t\tcatch (const std::exception& err) {\n\t\t\ton_unhandled_error(err);\n\t\t}\n\t\t// Lock the queue to remove the action just executed, and\n\t\t// add it to the undo stack.\n\t\tstack_mutex.lock();\n\t\tif(ab->undoable())\n\t\t\tundo_stack.push(ab);\n\t\tif(ab->callback != nullptr)\n\t\t\tab->callback();\n\t\tif(pending_actions.size()>0) // some actions clear the queue\n\t\t\tpending_actions.pop();\n\t\t}\n\tstack_mutex.unlock();\n\t}\n\nbool DocumentThread::on_unhandled_error(const std::exception& err)\n\t{\n\treturn true;\n\t}\n\nDocumentThread::Prefs::Prefs(bool use_defaults)\n\t{\n#ifndef EMSCRIPTEN\n\tconfig_path=std::string(Glib::get_user_config_dir()) + \"/cadabra2.conf\";\n\ttry {\n\n\t\tif (!use_defaults) {\n\t\t\tstd::ifstream f(config_path);\n\t\t\tif (f) {\n\t\t\t\ttry {\n\t\t\t\t\tf >> data;\n\t\t\t\t\t}\n\t\t\t\tcatch(nlohmann::json::exception& ex) {\n\t\t\t\t\tstd::cerr << \"Config file \" << config_path << \" is not JSON; ignoring.\" << std::endl;\n\t\t\t\t\tdata = nlohmann::json::object();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\telse {\n\t\t\t\tdata = nlohmann::json::object();\n\n\t\t\t\t// Backwards compatibility, check to see if cadabra.conf exists\n\t\t\t\t// and if so take the is_registered variable from there\n\t\t\t\tstd::ifstream old_f(std::string(Glib::get_user_config_dir()) + \"/cadabra.conf\");\n\t\t\t\tif (old_f) {\n\t\t\t\t\tstd::string line;\n\t\t\t\t\twhile (old_f.good()) {\n\t\t\t\t\t\tstd::getline(old_f, line);\n\t\t\t\t\t\tif (line.find(\"registered=true\") != std::string::npos) {\n\t\t\t\t\t\t\tdata[\"is_registered\"] = true;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\tcatch(std::exception& ex) {\n\t\tdata = nlohmann::json::object();\n\t\t}\n\n\tfont_step = data.value(\"font_step\", 0);\n\thighlight = data.value(\"highlight\", false);\n\tis_registered = data.value(\"is_registered\", false);\n\tis_anonymous = data.value(\"is_anonymous\", false);\n\tgit_path = data.value(\"git_path\", \"\");\n\tpython_path = data.value(\"python_path\", \"\");\n\tmove_into_new_cell = data.value(\"move_into_new_cell\", false);\n\ttab_completion = data.value(\"tab_completion\", true);\n\tmicrotex = data.value(\"microtex\", true);\n\tauto_close_latex = data.value(\"auto_close_latex\", true);\n\n\t// Force microtex when this is an AppImage.\n\tconst char *appdir = getenv(\"APPDIR\");\n\tif(appdir)\n\t\tmicrotex=true;\n\t// Force microtex when we are on Windows.\n#if(_WIN32)\n\tmicrotex = true;\n#endif\n\n\tif(git_path==\"\")\n\t\tgit_path=\"/usr/bin/git\";\n\n\t// Get the colours for syntax highlighting.\n\tif(data.count(\"colours\")==0)\n\t\tdata[\"colours\"]={ {\"python\", nlohmann::json::object() }, {\"latex\", nlohmann::json::object() } };\n\n\tconst auto& python_colours = data[\"colours\"][\"python\"];\n\n\tcolours[\"python\"][\"keyword\"] = python_colours.value(\"keyword\", \"RoyalBlue\");\n\tcolours[\"python\"][\"operator\"] = python_colours.value(\"operator\", \"SlateGray\");\n\tcolours[\"python\"][\"brace\"] = python_colours.value(\"brace\", \"SlateGray\");\n\tcolours[\"python\"][\"string\"] = python_colours.value(\"string\", \"ForestGreen\");\n\tcolours[\"python\"][\"comment\"] = python_colours.value(\"comment\", \"Silver\");\n\tcolours[\"python\"][\"object\"] = python_colours.value(\"object\", \"DarkGray\");\n\tcolours[\"python\"][\"number\"] = python_colours.value(\"number\", \"Sienna\");\n\tcolours[\"python\"][\"maths\"] = python_colours.value(\"maths\", \"Olive\");\n\tcolours[\"python\"][\"function\"] = python_colours.value(\"function\", \"FireBrick\");\n\tcolours[\"python\"][\"decorator\"] = python_colours.value(\"decorator\", \"DarkViolet\");\n\tcolours[\"python\"][\"class\"] = python_colours.value(\"class\", \"MediumOrchid\");\n\n\tconst auto& latex_colours = data[\"colours\"][\"latex\"];\n\tcolours[\"latex\"][\"command\"] = latex_colours.value(\"command\", \"rgb(52,101,164)\");\n\tcolours[\"latex\"][\"parameter\"] = latex_colours.value(\"brace\", \"rgb(245,121,0)\");\n\tcolours[\"latex\"][\"comment\"] = latex_colours.value(\"comment\", \"Silver\");\n\tcolours[\"latex\"][\"maths\"] = latex_colours.value(\"maths\", \"Sienna\");\n#endif\n\t}\n\nvoid DocumentThread::Prefs::save()\n\t{\n\tstd::ofstream f(config_path);\n\tif (f) {\n\t\tdata[\"font_step\"] = font_step;\n\t\tdata[\"highlight\"] = highlight;\n\t\tdata[\"is_registered\"] = is_registered;\n\t\tdata[\"is_anonymous\"] = is_anonymous;\n\t\tdata[\"python_path\"] = python_path;\n\t\tdata[\"move_into_new_cell\"] = move_into_new_cell;\n\t\tdata[\"tab_completion\"] = tab_completion;\n\t\tdata[\"microtex\"] = microtex;\n\t\tdata[\"auto_close_latex\"] = auto_close_latex;\n\t\tfor (const auto& lang : colours) {\n\t\t\tfor (const auto& kw : lang.second)\n\t\t\t\tdata[\"colours\"][lang.first][kw.first] = kw.second;\n\t\t\t}\n\t\tdata[\"git_path\"] = git_path;\n\t\tf << data << '\\n';\n\t\t}\n\telse\n\t\tstd::cerr << \"Warning: could not write to config file\\n\";\n\t}\n\nvoid DocumentThread::set_user_details(const std::string& name, const std::string& email, const std::string& affiliation)\n\t{\n#ifndef EMSCRIPTEN\n\tsnoop::log(\"name\") << name << snoop::flush;\n\tsnoop::log(\"email\") << email << snoop::flush;\n\tsnoop::log(\"affiliation\") << affiliation << snoop::flush;\n#endif\n\t}\n\nbool DocumentThread::help_type_and_topic(const std::string& before, const std::string& after,\n help_t& help_type, std::string& help_topic) const\n\t{\n\thelp_t objtype=help_t::algorithm;\n\tif(! (before.size()==0 && after.size()==0) ) {\n\t\t// We provide help for properties, algorithms and reserved node\n\t\t// names. Properties are delimited to the left by '::' and to\n\t\t// the right by anything non-alnum. Algorithms are delimited to\n\t\t// the left by non-alnum except '_' and to the right by '('. Reserved node\n\t\t// names are TeX symbols, starting with '\\'.\n\t\t//\n\t\t// So scan the 'before' string for a left-delimiter and the 'after' string\n\t\t// for a right-delimiter.\n\n\t\tint lpos=before.size()-1;\n\t\twhile(lpos>=0) {\n\t\t\tif(before[lpos]==':' && lpos>0 && before[lpos-1]==':') {\n\t\t\t\tobjtype=help_t::property;\n\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\tif(before[lpos]=='\\\\') {\n\t\t\t\tobjtype=help_t::latex;\n\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\tif(isalnum(before[lpos])==0 && before[lpos]!='_') {\n\t\t\t\tobjtype=help_t::algorithm;\n\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t--lpos;\n\t\t\t}\n\t\tif(objtype==help_t::none) return false;\n\t\t++lpos;\n\n\t\tsize_t rpos=0;\n\t\twhile(rpos\n#include \n#include \n#include