[ { "path": ".clang-format", "content": "---\n# SFT codestyle\n# Tab indent + space alignment\n# see documentation in doc/code_style/ for details and explainations.\nLanguage: Cpp\nAccessModifierOffset: -4\nAlignAfterOpenBracket: Align\nAlignArrayOfStructures: None\nAlignConsecutiveAssignments: false\nAlignConsecutiveBitFields: false\nAlignConsecutiveDeclarations: false\nAlignConsecutiveMacros: false\nAlignEscapedNewlines: DontAlign\nAlignOperands: Align\nAlignTrailingComments: true\nAllowAllArgumentsOnNextLine: true\nAllowAllParametersOfDeclarationOnNextLine: true\nAllowShortBlocksOnASingleLine: Never\nAllowShortCaseLabelsOnASingleLine: false\nAllowShortEnumsOnASingleLine: false\nAllowShortFunctionsOnASingleLine: Empty\nAllowShortIfStatementsOnASingleLine: Never\nAllowShortLambdasOnASingleLine: All\nAllowShortLoopsOnASingleLine: false\nAlwaysBreakAfterDefinitionReturnType: None\nAlwaysBreakAfterReturnType: None\nAlwaysBreakBeforeMultilineStrings: false\nAlwaysBreakTemplateDeclarations: Yes\nBinPackArguments: false\nBinPackParameters: false\nBraceWrapping:\n AfterCaseLabel: false\n AfterClass: false\n AfterControlStatement: Never\n AfterEnum: false\n AfterExternBlock: false\n AfterFunction: false\n AfterNamespace: false\n AfterObjCDeclaration: false\n AfterStruct: false\n AfterUnion: false\n BeforeCatch: true\n BeforeElse: true\n BeforeLambdaBody: false\n BeforeWhile: true\n IndentBraces: false\n SplitEmptyFunction: false\n SplitEmptyNamespace: false\n SplitEmptyRecord: false\nBreakAfterJavaFieldAnnotations: true\nBreakBeforeBinaryOperators: NonAssignment\nBreakBeforeBraces: Custom\nBreakBeforeInheritanceComma: false\nBreakBeforeTernaryOperators: false\nBreakConstructorInitializers: AfterColon\nBreakInheritanceList: BeforeComma\nBreakStringLiterals: false\nColumnLimit: 0\nCompactNamespaces: false\nConstructorInitializerAllOnOneLineOrOnePerLine: false\nConstructorInitializerIndentWidth: 4\nContinuationIndentWidth: 4\nCpp11BracedListStyle: true\nDeriveLineEnding: true\nDerivePointerAlignment: false\nDisableFormat: false\nExperimentalAutoDetectBinPacking: false\nFixNamespaceComments: true\nForEachMacros:\n - foreach\n - Q_FOREACH\n - BOOST_FOREACH\nIncludeBlocks: Preserve\nIncludeCategories:\n - Regex: '.*'\n Priority: 3\n SortPriority: 0\nIncludeIsMainRegex: ''\nIncludeIsMainSourceRegex: ''\nIndentCaseBlocks: false\nIndentCaseLabels: false\nIndentExternBlock: NoIndent\nIndentGotoLabels: false\nIndentPPDirectives: BeforeHash\nIndentWidth: 4\nIndentWrappedFunctionNames: false\n# clang-format-16 InsertNewlineAtEOF: true\nInsertTrailingCommas: Wrapped\nKeepEmptyLinesAtTheStartOfBlocks: false\nMacroBlockBegin: ''\nMacroBlockEnd: ''\nMaxEmptyLinesToKeep: 2\nNamespaceIndentation: None\nPenaltyBreakAssignment: 2\nPenaltyBreakBeforeFirstCallParameter: 1\nPenaltyBreakComment: 300\nPenaltyBreakFirstLessLess: 120\nPenaltyBreakString: 1000\nPenaltyBreakTemplateDeclaration: 10\nPenaltyExcessCharacter: 1000000\nPenaltyReturnTypeOnItsOwnLine: 200\nPointerAlignment: Right\nReflowComments: true\nSortIncludes: CaseInsensitive\nSortUsingDeclarations: true\nSpaceAfterCStyleCast: false\nSpaceAfterLogicalNot: false\nSpaceAfterTemplateKeyword: true\nSpaceBeforeAssignmentOperators: true\nSpaceBeforeCaseColon: false\nSpaceBeforeCpp11BracedList: false\nSpaceBeforeCtorInitializerColon: true\nSpaceBeforeInheritanceColon: true\nSpaceBeforeParens: ControlStatements\nSpaceBeforeRangeBasedForLoopColon: true\nSpaceBeforeSquareBrackets: false\nSpaceInEmptyBlock: false\nSpaceInEmptyParentheses: false\nSpacesBeforeTrailingComments: 1\nSpacesInAngles: Never\nSpacesInCStyleCastParentheses: false\nSpacesInConditionalStatement: false\nSpacesInContainerLiterals: false\nSpacesInParentheses: false\nSpacesInSquareBrackets: false\nStandard: Latest\nTabWidth: 4\nUseCRLF: false\nUseTab: AlignWithSpaces\n...\n" }, { "path": ".github/PULL_REQUEST_TEMPLATES/pull_request_template.md", "content": "### Merge Checklist\n\n\n\n\n- [ ] I have read the [contribution guide](doc/contributing.md)\n- [ ] I have added my info to [copying.md](copying.md) (only first time contributors)\n- [ ] I have run `make checkmerge` and fixed all mentioned problems\n\n\n### Description\n\n\n" }, { "path": ".github/PULL_REQUEST_TEMPLATES/release_template.md", "content": "### Checklist\n\n- [ ] Changelog\n - [ ] Release date\n - [ ] Version number in title\n - [ ] Full commit log\n- [ ] Bump version in `openage_version`\n" }, { "path": ".github/workflows/macosx-ci.yml", "content": "name: macOS-CI\non: [push, pull_request]\n\njobs:\n # https://docs.github.com/en/actions/reference/software-installed-on-github-hosted-runners\n # we install stuff not already there\n macos-build:\n runs-on: macos-latest\n steps:\n - name: Checkout sources\n uses: actions/checkout@v4\n\n # caching dependencies and ccache\n # https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows\n - name: Get timestamp\n id: timestamp\n shell: cmake -P {0}\n run: |\n string(TIMESTAMP current_date \"%Y-%m-%d-%H:%M:%S\" UTC)\n message(\"timestamp=${current_date}\" >> $GITHUB_OUTPUT)\n - name: Cache dependencies\n uses: actions/cache@v4\n id: cache-deps\n with:\n path: |\n ~/Library/Caches/pip\n ~/Library/Caches/Homebrew\n key: '${{ runner.os }}-deps-${{ steps.timestamp.outputs.timestamp }}'\n restore-keys: |\n ${{ runner.os }}-deps-\n - name: Cache ccache dir\n uses: actions/cache@v4\n id: cache-ccache\n with:\n path: ~/Library/Caches/ccache\n key: '${{ runner.os }}-ccache-${{ steps.timestamp.outputs.timestamp }}'\n restore-keys: |\n ${{ runner.os }}-ccache-\n - name: Brew update-reset\n run: brew update-reset\n - name: Brew update\n run: brew update\n - name: Brew install DeJaVu fonts\n run: brew install --cask font-dejavu\n - name: Install environment helpers with homebrew\n run: brew install --force ccache\n - name: Install LLVM with homebrew\n run: brew install --force llvm\n - name: Install openage dependencies with homebrew\n run: brew install --force cmake python3 libepoxy freetype fontconfig harfbuzz opus opusfile qt6 libogg libpng toml11 eigen\n - name: Install nyan dependencies with homebrew\n run: brew install --force flex make\n - name: Install python3 packages\n # cython, numpy and pygments are in homebrew,\n # but \"cython is keg-only, which means it was not symlinked into /usr/local\"\n # numpy pulls gcc as dep? and pygments doesn't work.\n run: pip3 install --upgrade --break-system-packages cython numpy mako lz4 pillow pygments setuptools toml\n - name: Configure\n run: ./configure --compiler=\"$(brew --prefix llvm)/bin/clang++\" --mode=release --ccache --download-nyan\n - name: Build\n run: make -j$(sysctl -n hw.logicalcpu) VERBOSE=1\n - name: Test\n run: make test\n" }, { "path": ".github/workflows/ubuntu-24.04.yml", "content": "name: Ubuntu 24.04 CI\n\non: [push, workflow_dispatch]\n\njobs:\n build-devenv:\n runs-on: ubuntu-24.04\n steps:\n - uses: actions/checkout@v4\n - name: Build the Docker image\n run: sudo DOCKER_BUILDKIT=1 docker build ./packaging/docker/devenv --file ./packaging/docker/devenv/Dockerfile.ubuntu.2404 --tag openage-devenv:latest\n shell: bash\n - name: Save the Docker image\n run: |\n mkdir -p /tmp/staging\n sudo docker save openage-devenv:latest | gzip > /tmp/staging/devenv.tar.gz\n shell: bash\n - name: Publish the Docker image\n uses: actions/upload-artifact@v4\n with:\n name: devenv-image-compressed.tar.gz\n path: '/tmp/staging/devenv.tar.gz'\n if-no-files-found: error\n retention-days: 30\n\n build:\n runs-on: ubuntu-24.04\n needs: build-devenv\n steps:\n - uses: actions/checkout@v4\n - name: Create tmp path\n run: mkdir -p /tmp/image\n shell: bash\n - name: Download devenv image\n uses: actions/download-artifact@v4\n with:\n name: devenv-image-compressed.tar.gz\n path: '/tmp/image'\n - name: Load Docker image\n run: sudo docker load --input /tmp/image/devenv.tar.gz\n - name: Build openage\n run: |\n sudo docker run --rm -v \"$(pwd)\":/mnt/openage -w /mnt/openage openage-devenv:latest \\\n bash -c 'mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=$(which gcc) -DCMAKE_CXX_COMPILER=$(which g++) -DCMAKE_CXX_FLAGS='' -DCMAKE_EXE_LINKER_FLAGS='' -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_MODULE_LINKER_FLAGS='' -DCMAKE_SHARED_LINKER_FLAGS='' -DDOWNLOAD_NYAN=YES -DCXX_OPTIMIZATION_LEVEL=auto -DCXX_SANITIZE_FATAL=False -DCXX_SANITIZE_MODE=none -DWANT_BACKTRACE=if_available -DWANT_GPERFTOOLS_PROFILER=if_available -DWANT_GPERFTOOLS_TCMALLOC=False -DWANT_INOTIFY=if_available -DWANT_NCURSES=if_available -DWANT_OPENGL=if_available -DWANT_VULKAN=if_available -G Ninja .. && cmake --build . --parallel $(nproc) -- -k1'\n - name: Compress build artifacts\n run: |\n mkdir -p /tmp/openage\n tar -czvf /tmp/openage/openage-build.tar.gz ./build\n - name: Publish build artifacts\n uses: actions/upload-artifact@v4\n with:\n name: openage-build.tar.gz\n path: '/tmp/openage/openage-build.tar.gz'\n if-no-files-found: error\n retention-days: 30\n" }, { "path": ".github/workflows/windows-server-2019.yml", "content": "name: Windows Server 2019 CI\n\non: [push, workflow_dispatch]\n\njobs:\n build-x64:\n runs-on: windows-2019\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: recursive\n path: source\n - name: Inspect environment\n run: |\n vswhere -latest\n shell: pwsh\n - name: Setup Python\n uses: actions/setup-python@v5\n with:\n python-version: '3.9'\n architecture: 'x64'\n - name: Install dependencies [vcpkg]\n run: |\n mkdir download\n cd download\n $zipfile = \"openage-dep-x64-windows.zip\"\n Invoke-WebRequest https://github.com/SFTtech/openage-dependencies/releases/download/v0.5.1/openage-dep-x64-windows.zip -OutFile $zipfile\n Expand-Archive -Path $zipfile -DestinationPath . -Force\n Remove-Item $zipfile\n (Get-ChildItem . -Recurse -File).FullName\n shell: pwsh\n - name: Install dependencies [winflexbison]\n run: |\n cd download\n $zipfile = \"winflexbison-2.5.24.zip\"\n Invoke-WebRequest https://github.com/lexxmark/winflexbison/releases/download/v2.5.24/win_flex_bison-2.5.24.zip -OutFile $zipfile\n mkdir winflexbison\n Expand-Archive -Path $zipfile -DestinationPath ./winflexbison -Force\n Remove-Item $zipfile\n (Get-ChildItem ./winflexbison -Recurse -File).FullName\n shell: pwsh\n - name: Install dependencies [Python]\n run: |\n python -m pip install --upgrade pip\n python -m pip install --upgrade Cython wheel numpy lz4 toml pillow pygments pyreadline3 mako\n shell: pwsh\n - name: Build\n run: |\n $TOOLCHAIN_FILE = Join-Path download openage-dep-x64-windows scripts buildsystems vcpkg.cmake | Resolve-Path\n $FLEX_PATH = (Get-ChildItem ./download -Recurse -Force -Filter 'win_flex.exe')[0].FullName\n mkdir build\n cd build\n cmake -DCMAKE_TOOLCHAIN_FILE=\"$TOOLCHAIN_FILE\" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TRY_COMPILE_CONFIGURATION=Debug -DCMAKE_CXX_FLAGS='/Zc:__cplusplus /permissive- /EHsc' -DCMAKE_EXE_LINKER_FLAGS='' -DCMAKE_MODULE_LINKER_FLAGS='' -DCMAKE_SHARED_LINKER_FLAGS='' -DDOWNLOAD_NYAN=YES -DCXX_OPTIMIZATION_LEVEL=auto -DCXX_SANITIZE_FATAL=False -DCXX_SANITIZE_MODE=none -DWANT_BACKTRACE=if_available -DWANT_GPERFTOOLS_PROFILER=if_available -DWANT_GPERFTOOLS_TCMALLOC=False -DWANT_INOTIFY=if_available -DWANT_NCURSES=if_available -DWANT_OPENGL=if_available -DWANT_VULKAN=if_available -DFLEX_EXECUTABLE=\"$FLEX_PATH\" -G \"Visual Studio 16 2019\" -A x64 ../source\n cmake --build . --config Debug -- -nologo -maxCpuCount\n shell: pwsh\n - name: Package\n run: |\n mkdir package\n cd package\n mkdir dll\n cd ..\n $STAGING_PATH = Resolve-Path package\n $DLL_PATH = Join-Path package dll | Resolve-Path\n\n cd build\n $NYAN_DLL = (Get-ChildItem . -Recurse -Force -Filter 'nyan.dll')[0].FullName\n $OPENAGE_DLL = (Get-ChildItem . -Recurse -Force -Filter 'openage.dll')[0].FullName\n $NATIVE_OUTPUT = Split-Path -Path $OPENAGE_DLL -Parent\n Copy-Item -Path ./openage -Destination $STAGING_PATH -Recurse\n Copy-Item -Path $NYAN_DLL -Destination $DLL_PATH\n Copy-Item -Path (Join-Path $NATIVE_OUTPUT *.dll) -Destination $DLL_PATH\n Copy-Item -Path run.* -Destination $STAGING_PATH\n shell: pwsh\n - name: Test\n run: |\n $DLL_PATH = Join-Path package dll | Resolve-Path\n cd package\n python -m openage --add-dll-search-path $DLL_PATH --version\n python -m openage --add-dll-search-path $DLL_PATH test -a\n shell: pwsh\n - name: Publish build artifacts\n uses: actions/upload-artifact@v4\n if: ${{ always() }}\n with:\n name: build-files\n path: './build'\n if-no-files-found: error\n retention-days: 30\n - name: Publish packaged artifacts\n uses: actions/upload-artifact@v4\n if: ${{ always() }}\n with:\n name: package-files\n path: './package'\n if-no-files-found: error\n retention-days: 30\n" }, { "path": ".github/workflows/windows-server-2022.yml", "content": "name: Windows Server 2022 CI\n\non: [push, workflow_dispatch]\n\njobs:\n build-x64:\n runs-on: windows-2022\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: recursive\n path: source\n - name: Inspect environment\n run: |\n vswhere -latest\n shell: pwsh\n - name: Setup Python\n uses: actions/setup-python@v5\n with:\n python-version: '3.9'\n architecture: 'x64'\n - name: Install dependencies [vcpkg]\n run: |\n mkdir download\n cd download\n $zipfile = \"openage-dep-x64-windows.zip\"\n Invoke-WebRequest https://github.com/SFTtech/openage-dependencies/releases/download/v0.5.1/openage-dep-x64-windows.zip -OutFile $zipfile\n Expand-Archive -Path $zipfile -DestinationPath . -Force\n Remove-Item $zipfile\n (Get-ChildItem . -Recurse -File).FullName\n shell: pwsh\n - name: Install dependencies [winflexbison]\n run: |\n cd download\n $zipfile = \"winflexbison-2.5.24.zip\"\n Invoke-WebRequest https://github.com/lexxmark/winflexbison/releases/download/v2.5.24/win_flex_bison-2.5.24.zip -OutFile $zipfile\n mkdir winflexbison\n Expand-Archive -Path $zipfile -DestinationPath ./winflexbison -Force\n Remove-Item $zipfile\n (Get-ChildItem ./winflexbison -Recurse -File).FullName\n shell: pwsh\n - name: Install dependencies [Python]\n run: |\n python -m pip install --upgrade pip\n python -m pip install --upgrade Cython wheel numpy lz4 toml pillow pygments pyreadline3 mako\n shell: pwsh\n - name: Build\n run: |\n $TOOLCHAIN_FILE = Join-Path download openage-dep-x64-windows scripts buildsystems vcpkg.cmake | Resolve-Path\n $FLEX_PATH = (Get-ChildItem ./download -Recurse -Force -Filter 'win_flex.exe')[0].FullName\n mkdir build\n cd build\n cmake -DCMAKE_TOOLCHAIN_FILE=\"$TOOLCHAIN_FILE\" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TRY_COMPILE_CONFIGURATION=Debug -DCMAKE_CXX_FLAGS='/Zc:__cplusplus /permissive- /EHsc' -DCMAKE_EXE_LINKER_FLAGS='' -DCMAKE_MODULE_LINKER_FLAGS='' -DCMAKE_SHARED_LINKER_FLAGS='' -DDOWNLOAD_NYAN=YES -DCXX_OPTIMIZATION_LEVEL=auto -DCXX_SANITIZE_FATAL=False -DCXX_SANITIZE_MODE=none -DWANT_BACKTRACE=if_available -DWANT_GPERFTOOLS_PROFILER=if_available -DWANT_GPERFTOOLS_TCMALLOC=False -DWANT_INOTIFY=if_available -DWANT_NCURSES=if_available -DWANT_OPENGL=if_available -DWANT_VULKAN=if_available -DFLEX_EXECUTABLE=\"$FLEX_PATH\" -G \"Visual Studio 17 2022\" -A x64 ../source\n cmake --build . --config Debug -- -nologo -maxCpuCount\n shell: pwsh\n - name: Package\n run: |\n mkdir package\n cd package\n mkdir dll\n cd ..\n $STAGING_PATH = Resolve-Path package\n $DLL_PATH = Join-Path package dll | Resolve-Path\n\n cd build\n $NYAN_DLL = (Get-ChildItem . -Recurse -Force -Filter 'nyan.dll')[0].FullName\n $OPENAGE_DLL = (Get-ChildItem . -Recurse -Force -Filter 'openage.dll')[0].FullName\n $NATIVE_OUTPUT = Split-Path -Path $OPENAGE_DLL -Parent\n Copy-Item -Path ./openage -Destination $STAGING_PATH -Recurse\n Copy-Item -Path $NYAN_DLL -Destination $DLL_PATH\n Copy-Item -Path (Join-Path $NATIVE_OUTPUT *.dll) -Destination $DLL_PATH\n Copy-Item -Path run.* -Destination $STAGING_PATH\n shell: pwsh\n - name: Test\n run: |\n $DLL_PATH = Join-Path package dll | Resolve-Path\n cd package\n python -m openage --add-dll-search-path $DLL_PATH --version\n python -m openage --add-dll-search-path $DLL_PATH test -a\n shell: pwsh\n - name: Publish build artifacts\n uses: actions/upload-artifact@v4\n if: ${{ always() }}\n with:\n name: build-files\n path: './build'\n if-no-files-found: error\n retention-days: 30\n - name: Publish packaged artifacts\n uses: actions/upload-artifact@v4\n if: ${{ always() }}\n with:\n name: package-files\n path: './package'\n if-no-files-found: error\n retention-days: 30\n" }, { "path": ".gitignore", "content": "# editor-specific files\n\\#*\n.#*\n*~\n.*.swp\n/CMakeLists.txt.user\n*.temp\n\n# ELF files\n*.o\n*.a\n*.so\n\n# python bytecode\n*.pyc\n*.pyo\n__pycache__\n*.pyd\n\n# MSVC files\n*.pdb\n*.dll\n*.exe\n\n# workflow\n*.orig\n/TODO.org\n\n# build system\n/bin\n/.bin\n/build\n/deps\n/.ccls-cache\n/.cache\n\n# Nix build output\n/result\n\n# root dir run script\n/run\n/run.cpp\n/run.html\n\n# CMake in-source builds\n/DartConfiguration.tcl\n/codegen_depend_cache\n/codegen_target_cache\n/Doxyfile\n/Testing\n/py/setup.py\nCTestTestfile.cmake\nCMakeFiles\ncmake_install.cmake\nCMakeCache.txt\nMakefile\n!/Makefile\n\n# debugging\ncallgrind.out.*\nperf.data*\n.gdb_history\n\n# code search\n/.ignore\n/.globalrc\n/GPATH\n/GRTAGS\n/GTAGS\n\n# IDEs\n.vscode\n.idea\n\n# CMake + ccls\n/compile_commands.json\n\n# Virtual Environments\n/.venv/\n\n# macOS\n.DS_Store\n\n# copyrighted assets\n/assets/converted/\n/assets/terrain/\n" }, { "path": ".mailmap", "content": "Michael Enßlin \nJonas Jelten \nJonas Jelten \nJonas Jelten \nRenée Kooi \nRenée Kooi \nIngo Saftbaumer \nIngo Saftbaumer \nJames Mintram \nSam Schetterer \nJimmy Berry \nJonathan Remnant \nHenry Snoek \ncoop shell (Michael Enßlin, Jonas Jelten, Andre Kupka) \nFranz-Niclas Muschter \nNiklas Fiekas \nWojciech Nawrocki \nSimon San <14062932+simonsan@users.noreply.github.com>\nTobias Feldballe \nTobias Feldballe \nJonas Borchelt \nDerek Frogget <114030121+derekfrogget@users.noreply.github.com>\nNikhil Ghosh \nDavid Wever <56411717+dmwever@users.noreply.github.com>\nNgô Xuân Minh \n" }, { "path": "CMakeLists.txt", "content": "# Copyright 2013-2023 the openage authors. See copying.md for legal info.\n\n# >=3.16 finding numpy with the findpython3 module\ncmake_minimum_required(VERSION 3.16)\n\n\n# main build configuration file\n\n# text art: figlet -f rounded \"[SFT] openage\" | sed -e 's/\\\\/\\\\\\\\/g'\nmessage(\"\n\n ___ ______ _______ _______ ___\n| _)/ _____|_______|_______|_ |\n| | ( (____ _____ _ | | ___ ____ _____ ____ _____ ____ _____\n| | \\\\____ \\\\| ___) | | | | / _ \\\\| _ \\\\| ___ | _ \\\\(____ |/ _ | ___ |\n| |_ _____) ) | | | _| | | |_| | |_| | ____| | | / ___ ( (_| | ____|\n|___|______/|_| |_| (___| \\\\___/| __/|_____)_| |_\\\\_____|\\\\___ |_____)\n |_| (_____|\n\nWelcome to the SFT technologies computer-aided openage build system!\n\nYou have chosen, or been chosen, to attempt the daring task of building openage.\nIf you have installed all the dependencies that are conveniently listed in\n[doc/building.md], this _might_ just work!\n\nIf it doesn't, consider reporting the issue, or ask for help:\n * GitHub: https://github.com/SFTtech/openage\n * Matrix: #sfttech:matrix.org\n\")\n\n\n##################################################\n# main buildsystem setup entry point\nproject(openage CXX)\n\n# C++ standard requirement\nset(CMAKE_CXX_STANDARD 20)\nset(CMAKE_CXX_STANDARD_REQUIRED ON)\n\n# Python and Cython requirements\nset(PYTHON_MIN_VERSION 3.9)\nset(CYTHON_MIN_VERSION 3.0.10)\nset(CYTHON_MIN_VERSION_FALLBACK 0.29.31)\nset(CYTHON_MAX_VERSION_FALLBACK 3.0.7)\n\n# CMake policies\nforeach(pol\n CMP0074 # use _ROOT vars in find_package()\n CMP0067 # honor language standard in try_compile()\n CMP0071 # enable automoc for generated files\n CMP0072 # prefers GLVND by default FindOpenGL\n CMP0048 # project() command manages VERSION variables\n CMP0094 # take the first satisfying Python version\n CMP0082 # run add_subdirectory() in the declaration order\n CMP0102 # Don't create empty cache entries\n )\n\tif (POLICY ${pol})\n\t\tcmake_policy(SET ${pol} NEW)\n\tendif()\nendforeach()\n\n# don't print 'Built target ...' messages\n# upstream since cmake v3.4.0-rc1 (by commit 1d3984780df8)\nset_property(GLOBAL PROPERTY TARGET_MESSAGES OFF)\n\n# Ensure CMAKE_BUILD_TYPE is set correctly.\nif(NOT CMAKE_BUILD_TYPE)\n\tset(CMAKE_BUILD_TYPE \"Debug\")\nendif()\nstring(TOUPPER \"CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE}\" BUILD_TYPE_CXX_FLAGS)\n\n\n##################################################\n# options: keep up to date with those in ./configure!\nif(NOT DEFINED WANT_BACKTRACE)\n\tset(WANT_BACKTRACE if_available)\nendif()\n\nif(NOT DEFINED WANT_INOTIFY)\n\tset(WANT_INOTIFY if_available)\nendif()\n\nif(NOT DEFINED WANT_OPENGL)\n\tset(WANT_OPENGL if_available)\nendif()\n\nif(NOT DEFINED WANT_VULKAN)\n\tset(WANT_VULKAN if_available)\nendif()\n\nif(NOT DEFINED WANT_GPERFTOOLS_PROFILER)\n\tset(WANT_GPERFTOOLS_PROFILER if_available)\nendif()\n\nif(NOT DEFINED WANT_GPERFTOOLS_TCMALLOC)\n\tset(WANT_GPERFTOOLS_TCMALLOC false)\nendif()\n\nif(NOT DEFINED WANT_NCURSES)\n\tset(WANT_NCURSES if_available)\nendif()\n\nif(NOT DEFINED WANT_IWYU)\n\tset(WANT_IWYU false)\nendif()\n\n##################################################\n# static content filesystem locations\nif(NOT DEFINED GLOBAL_ASSET_DIR)\n\tset(ASSET_DIR \"share/openage\")\n\tif(MSVC)\n\t\tset(GLOBAL_ASSET_DIR \"${ASSET_DIR}\")\n\telse()\n\t\tset(GLOBAL_ASSET_DIR \"${CMAKE_INSTALL_PREFIX}/${ASSET_DIR}\")\n\tendif()\nendif()\n\nif(NOT DEFINED GLOBAL_CONFIG_DIR)\n\tset(CONFIG_DIR \"etc/openage\")\n\tif(MSVC)\n\t\tset(GLOBAL_CONFIG_DIR \"${CONFIG_DIR}\")\n\telse()\n\t\tset(GLOBAL_CONFIG_DIR \"${CMAKE_INSTALL_PREFIX}/${CONFIG_DIR}\")\n\tendif()\nendif()\n\n\n##################################################\n# ccache setup\n\n# distros can also do this but they don't use this mechanism\noption(ENABLE_CCACHE \"prefix each compile command with ccache\")\n\nif(ENABLE_CCACHE)\n\tfind_program(CCACHE_FOUND \"ccache\")\n\n\tif(CCACHE_FOUND)\n\t\tset_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)\n\t\tset_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache)\n\telse()\n\t\tmessage(FATAL_ERROR \"ccache not found, but you requested it\")\n\tendif(CCACHE_FOUND)\nendif()\n\n\n##################################################\n# clang tidy static analysis\noption(\n\tENABLE_CLANG_TIDY\n\t\"activate clang tidy messages\"\n\tOFF\n)\nif(ENABLE_CLANG_TIDY)\n\tset(CMAKE_CXX_CLANG_TIDY \"clang-tidy;-checks=-*,readability-*\")\nendif()\n\n\n# option processing is now done.\n\n##################################################\n# include buildsystem features\n\n# add search paths to helper modules\nset(BUILDSYSTEM_DIR \"${CMAKE_SOURCE_DIR}/buildsystem\")\nset(CMAKE_MODULE_PATH \"${BUILDSYSTEM_DIR}\" \"${BUILDSYSTEM_DIR}/modules/\")\n\n# prioritize macOS frameworks since they're probably newer\n# than the system libraries\nset(CMAKE_FIND_FRAMEWORK LAST)\nset(CMAKE_FIND_APPBUNDLE LAST)\n\n# load helper modules\ninclude(GNUInstallDirs)\ninclude(CheckInSourceBuild)\ninclude(HandleCXXOptions)\ninclude(CheckCompilerFeatures)\ninclude(CMakeParseArguments)\ninclude(HandlePythonOptions)\ninclude(CheckRuntimeDependencies)\ninclude(DetectProjectVersion)\ninclude(DependencyFetch)\ninclude(FindPackageHandleStandardArgs)\n\n# include build configuration modules\ninclude(CTest)\n\n# initialize language support\ninclude(codegen)\ninclude(cpp)\ninclude(doxygen)\ninclude(options)\ninclude(python)\ninclude(util)\n\n\n# now that all modules and settings are loaded,\n# apply those to the project.\n\n\n##################################################\n# set project version\nif(USED_GIT_VERSION)\n\t# VERSION_FULL_STRING is the full git describe\n\tset(VERSION_FULL_STRING \"${PROJECT_VERSION}\")\n\t# PROJECT_VERSION is MAJOR.MINOR.PATCH.TWEAK with Commit-Count as Tweak\n\tSTRING(REGEX REPLACE \"v(([0-9]+.|[0-9]+)+)-([0-9]+)-g([a-f0-9]+)\"\n\t\t\t\"\\\\1.\\\\3\" PROJECT_VERSION \"${VERSION_FULL_STRING}\")\nendif()\nproject(openage VERSION \"${PROJECT_VERSION}\")\n\n# set CI version\nif(DEFINED ENV{CI_CFG_VERSION})\n set(CI_CFG_VERSION \"$ENV{CI_CFG_VERSION}\")\nelse()\n set(CI_CFG_VERSION \"NOT SET\")\nendif()\n\n\n##################################################\n# documentation generation\n\n# create documentation\ndoxygen_configure(libopenage/ openage/ doc/ README.md)\n\n\n##################################################\n# static content\nadd_subdirectory(assets/)\nadd_subdirectory(dist/)\nadd_subdirectory(cfg/)\n\n\n##################################################\n# C++ content\nadd_subdirectory(libopenage/)\n\n\n##################################################\n# Python content (uses the C++ library)\n\n# create a virtual library that, when linked to,\n# injects a header inclusion, and links to libopenage.\n# -> all cython modules get our hacks included and link to libopenage.\nadd_library(pyext_libopenage INTERFACE)\nif(MSVC)\n\tset(FORCE_INCLUDE_CXXFLAG \"/FI\")\nelse()\n\tset(FORCE_INCLUDE_CXXFLAG \"-include\")\nendif()\ntarget_compile_options(pyext_libopenage INTERFACE\n\t${FORCE_INCLUDE_CXXFLAG} \"${CMAKE_SOURCE_DIR}/libopenage/pyinterface/hacks.h\"\n)\ntarget_link_libraries(pyext_libopenage INTERFACE libopenage)\nset(PYEXT_LINK_LIBRARY pyext_libopenage)\n\nconfigure_file(run.py.in run.py)\nadd_cython_modules(EMBED NOINSTALL ${CMAKE_CURRENT_BINARY_DIR}/run.py)\nadd_py_modules(BININSTALL ${CMAKE_CURRENT_BINARY_DIR}/run.py AS openage)\nadd_subdirectory(openage/)\n\npython_finalize()\n\n\n##################################################\n# packaging.\n\n# Ensure that packaging is always the last step.\nadd_subdirectory(packaging)\n\n\n##################################################\n# show build configuration overview\n\nmessage(\"\")\nprint_config_options()\n\nmessage(\"${PROJECT_NAME} ${PROJECT_VERSION}\n\n version string | ${VERSION_FULL_STRING}\n compiler | ${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}\n python | ${PYTHON_VERSION_STRING}\n build type | ${CMAKE_BUILD_TYPE}\n cxxflags | ${CMAKE_CXX_FLAGS} ${EXTRA_FLAGS}\n build type flags | ${${BUILD_TYPE_CXX_FLAGS}}\n build dir | ${CMAKE_BINARY_DIR}\n install prefix | ${CMAKE_INSTALL_PREFIX}\npy install prefix | ${CMAKE_PY_INSTALL_PREFIX}\n\")\n\n##################################################\n# done! that was easy, right?\n" }, { "path": "Makefile", "content": "# type 'make help' for a list/explaination of recipes.\n\nBUILDDIR = bin\n\nMAKEARGS += $(if $(VERBOSE),,--no-print-directory)\n\n.PHONY: default\ndefault: build\n\n.PHONY: all\nall: default\n\n$(BUILDDIR):\n\t@echo \"call ./configure to initialize the build directory.\"\n\t@echo \"also see ./configure --help, and doc/building.md\"\n\t@echo \"\"\n\t@false\n\n.PHONY: install\ninstall: $(BUILDDIR)\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) install\n\n.PHONY: run\nrun: build\n\tcd $(BUILDDIR) && ./run main\n\n.PHONY: test\ntest: tests checkfast\n\n.PHONY: tests\ntests: build\n\tcd $(BUILDDIR) && ./run test -a\n\n.PHONY: build\nbuild: $(BUILDDIR)\n\t@$(MAKE) $(MAKEARGS) -C $(BUILDDIR)\n\n.PHONY: ninja\nninja: $(BUILDDIR)\n\t@ninja -C $(BUILDDIR)\n\n.PHONY: libopenage\nlibopenage: $(BUILDDIR)\n\t@$(MAKE) $(MAKEARGS) -C $(BUILDDIR) libopenage\n\n.PHONY: codegen\ncodegen: $(BUILDDIR)\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) cppgen\n\n.PHONY: cppgen\ncppgen: $(BUILDDIR)\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) cppgen\n\n.PHONY: pxdgen\npxdgen: $(BUILDDIR)\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) pxdgen\n\n.PHONY: compilepy\ncompilepy: $(BUILDDIR)\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) compilepy\n\n.PHONY: inplacemodules\ninplacemodules:\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) inplacemodules\n\n.PHONY: cythonize\ncythonize: $(BUILDDIR)\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) cythonize\n\n.PHONY: doc\ndoc: $(BUILDDIR)\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) doc\n\n.PHONY: cleanelf\ncleanelf: $(BUILDDIR)\n\t@# removes all object files and binaries\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) clean\n\n.PHONY: cleancodegen\ncleancodegen: $(BUILDDIR)\n\t@# removes all sourcefiles created by codegen\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) cleancodegen\n\n.PHONY: cleanpxdgen\ncleanpxdgen: $(BUILDDIR)\n\t@# removes all generated .pxd files\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) cleanpxdgen\n\n.PHONY: cleancython\ncleancython: $(BUILDDIR)\n\t@# removes all .cpp files created by Cython\n\t$(MAKE) $(MAKEARGS) -C $(BUILDDIR) cleancython\n\n.PHONY: clean\nclean: $(BUILDDIR) cleancodegen cleanpxdgen cleancython cleanelf\n\t@# removes object files, binaries, py modules, generated code\n\n.PHONY: cleaninsourcebuild\ncleaninsourcebuild:\n\t@echo \"cleaning remains of in-source builds\"\n\trm -rf DartConfiguration.tcl codegen_depend_cache codegen_target_cache Doxyfile Testing\n\t@find . -not -path \"./.bin/*\" -type f -name CTestTestfile.cmake -print -delete\n\t@find . -not -path \"./.bin/*\" -type f -name cmake_install.cmake -print -delete\n\t@find . -not -path \"./.bin/*\" -type f -name CMakeCache.txt -print -delete\n\t@find . -not -path \"./.bin/*\" -type f -name Makefile -not -path \"./Makefile\" -print -delete\n\t@find . -not -path \"./.bin/*\" -type d -name CMakeFiles -print -exec rm -r {} +\n\n.PHONY: cleanbuilddirs\ncleanbuilddirs: cleaninsourcebuild\n\t@if test -d bin; then $(MAKE) $(MAKEARGS) -C bin clean cleancython cleanpxdgen cleancodegen || true; fi\n\t@echo cleaning symlinks to build directories\n\trm -f bin\n\t@echo cleaning build directories\n\trm -rf .bin\n\t@echo cleaning cmake-time generated code\n\trm -f Doxyfile py/openage/config.py libopenage/config.h libopenage/config.cpp\n\n.PHONY: mrproper\nmrproper: cleanbuilddirs\n\t@echo cleaning converted assets\n\trm -rf userassets\n\n.PHONY: mrproperer\nmrproperer: mrproper\n\t@if ! test -d .git; then echo \"mrproperer is only available for gitrepos.\"; false; fi\n\t@echo removing ANYTHING that is not checked into the git repo\n\t@echo ENTER to confirm\n\t@read val\n\tgit clean -x -d -f\n\n.PHONY: checkfast\ncheckfast:\n\tpython3 -m buildsystem.codecompliance --fast\n\n.PHONY: checkmerge\ncheckmerge:\n\tpython3 -m buildsystem.codecompliance --merge\n\n.PHONY: checkchanged\ncheckchanged:\n\tpython3 -m buildsystem.codecompliance --merge --only-changed-files=origin/master\n\n.PHONY: checkuncommited\ncheckuncommited:\n\tpython3 -m buildsystem.codecompliance --merge --only-changed-files=HEAD\n\n.PHONY: checkpy\ncheckpy:\n\tpython3 -m buildsystem.codecompliance --pystyle --pylint\n\n.PHONY: checkall\ncheckall:\n\tpython3 -m buildsystem.codecompliance --all\n\n.PHONY: help\nhelp: $(BUILDDIR)/Makefile\n\t@echo \"openage Makefile\"\n\t@echo \"\"\n\t@echo \"wrapper that mostly forwards recipes to the cmake-generated Makefile in bin/\"\n\t@echo \"\"\n\t@echo \"targets:\"\n\t@echo \"\"\n\t@echo \"build -> build entire project\"\n\t@echo \"libopenage -> build libopenage\"\n\t@echo \"pxdgen -> generate .pxd files\"\n\t@echo \"cythonize -> compile .pyx files to .cpp\"\n\t@echo \"compilepy -> compile .py files to .pyc\"\n\t@echo \"inplacemodules -> create in-place modules\"\n\t@echo \"codegen -> generate cpp sources\"\n\t@echo \"doc -> create documentation files\"\n\t@echo \"\"\n\t@echo \"cleanelf -> remove C++ ELF files\"\n\t@echo \"cleancodegen -> undo 'make codegen'\"\n\t@echo \"cleancython -> undo 'make cythonize inplacemodules'\"\n\t@echo \"cleanpxdgen -> undo 'make pxdgen'\"\n\t@echo \"clean -> undo 'make' (all of the above)\"\n\t@echo \"cleanbuilddirs -> undo 'make' and './configure'\"\n\t@echo \"cleaninsourcebuild -> undo in-source build accidents\"\n\t@echo \"mrproper -> as above, but additionally delete user assets\"\n\t@echo \"mrproperer -> leaves nothing but ashes\"\n\t@echo \"\"\n\t@echo \"run -> run openage\"\n\t@echo \"tests -> run the tests (py + cpp)\"\n\t@echo \"\"\n\t@echo \"checkall -> full code compliance check\"\n\t@echo \"checkmerge -> code compliance check for merging to master\"\n\t@echo \"checkfast -> fast checks only\"\n\t@echo \"checkchanged -> full check for all files changed since origin/master\"\n\t@echo \"checkuncommited -> full check for all currently uncommited files\"\n\t@echo \"checkpy -> check python compliance\"\n\t@echo \"\"\n\t@echo \"test -> tests + checkfast. this is what you should use for regular devbuilds\"\n\t@echo \"\"\n\t@echo \"CMake help:\"\n\t@test -d $(BUILDDIR) && $(MAKE) -C $(BUILDDIR) help || echo \"no builddir is configured\"\n" }, { "path": "README.md", "content": "[![openage](/assets/logo/banner.svg)](http://openage.dev)\n=========================================================\n\n**openage**: a volunteer project to create a free engine clone of the *Genie Engine* used by *Age of Empires*, *Age of Empires II (HD)* and *Star Wars: Galactic Battlegrounds*, comparable to projects like [OpenMW](https://openmw.org/), [OpenRA](http://openra.net/), [OpenSAGE](https://github.com/OpenSAGE/OpenSAGE/), [OpenTTD](https://openttd.org/) and [OpenRCT2](https://openrct2.org/).\n\nopenage uses the original game assets (such as sounds and graphics), but (for obvious reasons) doesn't ship them.\nTo play, you require *[any of the original games (AoE1, AoE2)](/doc/media_convert.md)* or their *Definitive Edition* releases.\n\n[![github stars](https://img.shields.io/github/stars/SFTtech/openage.svg)](https://github.com/SFTtech/openage/stargazers)\n[![#sfttech on matrix.org](/assets/doc/matrixroom.svg)](https://matrix.to/#/#sfttech:matrix.org)\n[![GPL licensed](/assets/doc/license.svg)](/legal/GPLv3)\n\n\nContact\n-------\n| Contact | Where? |\n| ---------------- | -------------------------------------------------------------------------------------------------- |\n| Issue Tracker | [GitHub SFTtech/openage] |\n| Development Blog | [blog.openage.dev] |\n| Subreddit | [![reddit](/assets/doc/reddit.svg) /r/openage](https://www.reddit.com/r/openage/) |\n| Discussions | [GitHub Discussions] |\n| Matrix Chat | [![matrix](/assets/doc/matrix.svg) `#sfttech:matrix.org`](https://matrix.to/#/#sfttech:matrix.org) |\n| Money Sink | [![money sink](/assets/doc/liberapay.svg)](https://liberapay.com/SFTtech) |\n\n[GitHub SFTtech/openage]: https://github.com/SFTtech/openage/issues\n[blog.openage.dev]: https://blog.openage.dev\n[GitHub Discussions]: https://github.com/SFTtech/openage/discussions\n\nTechnical foundation\n--------------------\n\n| Technology | Component |\n| ------------ | ------------------------------------------------------------- |\n| **C++20** | Engine core |\n| **Python3** | Scripting, media conversion, in-game console, code generation |\n| [**Cython**] | Python/C++ Glue code |\n| [**Qt6**] | Graphical user interface |\n| [**CMake**] | Build system |\n| [**OpenGL**] | Rendering, shaders |\n| [**Opus**] | Audio codec |\n| [**nyan**] | Content Configuration and Modding |\n| [**Humans**] | Mixing together all of the above |\n\n[**Cython**]: https://cython.org/\n[**Qt6**]: https://contribute.qt-project.org/\n[**CMake**]: https://cmake.org/\n[**OpenGL**]: https://www.opengl.org/\n[**Opus**]: https://opus-codec.org/\n[**nyan**]: https://github.com/SFTtech/nyan\n[**Humans**]: https://www.youtube.com/watch?v=fQGbXmkSArs&t=18s\n\nGoals\n-----\n\n* Fully authentic look and feel\n * This can only be approximated since the behavior of the original game is mostly undocumented,\n and guessing/experimenting can only get you this close\n * We will not implement useless artificial limitations (max 30 selectable units...)\n* An easily-moddable content format: [**nyan** yet another notation](https://github.com/SFTtech/nyan)\n* An integrated Python console and API, comparable to [blender](https://www.blender.org/)\n* AI scripting in Python, you can use [machine learning](http://scikit-learn.org/stable/)\n * here is some [additional literature](http://www.deeplearningbook.org/)\n* Re-creating [free game assets](https://github.com/SFTtech/openage-data)\n* Multiplayer (obviously)\n* Matchmaking and ranking with a [haskell masterserver](https://github.com/SFTtech/openage-masterserver)\n* Optionally, [improvements](/doc/ideas/) over the original game\n* Awesome infrastructure such as our own [Kevin CI service](https://github.com/SFTtech/kevin)\n\nBut beware, for sanity reasons:\n\n* No network compatibility with the original game.\n You really wanna have the same problems again?\n* No binary compatibility with the original game.\n A one-way script to convert maps/savegames/missions to openage is planned though.\n\n\nCurrent State of the Project\n----------------------------\n\n**Important notice**: At the moment, \"gameplay\" is basically non-functional.\nWe're implementing the internal game simulation (how units even do anything) with simplicity and extensibility in mind, so we had to get rid of the temporary (but kind of working) previous version.\nWith these changes, we can (finally) actually make use of our converted asset packs and our nyan API!\nWe're working day and night to make gameplay return\\*.\nIf you're interested, we wrote detailed explanations on our blog: [Part 1](https://blog.openage.dev/new-gamestate-2020.html), [Part 2](https://blog.openage.dev/engine-core-modules.html), [Monthly Devlog](https://blog.openage.dev/tag/news.html).\n\n*\\* may not actually be every day and night*\n\n| Operating System | Build status |\n| :-----------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n| Debian Sid | [![Kevin CI status](https://cidata.sft.lol/openage/branches/master/status.svg)](/kevinfile) |\n| Ubuntu 24.04 LTS | [![Ubuntu 24.04 build status](https://github.com/SFTTech/openage/actions/workflows/ubuntu-24.04.yml/badge.svg?branch=master)](https://github.com/SFTtech/openage/actions/workflows/ubuntu-24.04.yml) |\n| macOS | [![macOS build status](https://github.com/SFTtech/openage/workflows/macOS-CI/badge.svg)](https://github.com/SFTtech/openage/actions?query=workflow%3AmacOS-CI) |\n| Windows Server 2019 | [![Windows Server 2019 build status](https://github.com/SFTtech/openage/actions/workflows/windows-server-2019.yml/badge.svg?branch=master)](https://github.com/SFTtech/openage/actions/workflows/windows-server-2019.yml) |\n| Windows Server 2022 | [![Windows Server 2022 build status](https://github.com/SFTtech/openage/actions/workflows/windows-server-2022.yml/badge.svg?branch=master)](https://github.com/SFTtech/openage/actions/workflows/windows-server-2022.yml) |\n\n[Todo: Kevin #11]: https://github.com/SFTtech/kevin/issues/11\n\n\nInstallation Packages\n---------------------\n\nThere are many missing parts for an actually working game.\nSo if you \"just wanna play\", [you'll be disappointed](#current-state-of-the-project), unfortunately.\n\nWe strongly recommend building the program from source to get the latest, greatest, and shiniest project state :)\n\n\n* For **Linux** check at [repology](https://repology.org/project/openage/versions) if your distribution has any packages available. Otherwise, you need to build from source.\n We don't release `*.deb`, `*.rpm`, Flatpak, snap or AppImage packages yet.\n* For **Windows** check our [release page](https://github.com/SFTtech/openage/releases) for the latest installer.\n Otherwise, you need to build from the source.\n\n* For **macOS** we currently don't have any packages, you need to build from source.\n\nIf you need help, maybe our [troubleshooting guide](/doc/troubleshooting.md) helps you.\n\n\nQuickstart\n----------\n\n* **How do I get this to run on my box?**\n 1. [Clone](https://docs.github.com/repositories/creating-and-managing-repositories/cloning-a-repository) the repo.\n 2. Install dependencies. See [doc/building.md](/doc/building.md#dependency-installation) to get instructions for your favorite platform.\n 3. Build the project:\n ```\n ./configure --download-nyan\n make\n ```\n\n**Alternative approach:**\nYou can build and run the project using Docker. See [Running with docker](/doc/build_instructions/docker.md) for more details.\n\n* **I compiled everything. Now how do I run it?**\n * Execute `cd bin && ./run main`.\n * [The convert script](/doc/media_convert.md) will transform original assets into openage formats, which are a lot saner and more moddable.\n * Use your brain and react to the things you'll see.\n\n* **Waaaaaah! It...**\n * segfaults\n * prints error messages I don't want to read\n * ate my dog\n\nAll of those are features, not bugs.\n\nTo turn them off, use `./bin/run --dont-segfault --no-errors --dont-eat-dog`.\n\n\nIf this still does not help, try our [troubleshooting guide](/doc/troubleshooting.md), the [contact section](#contact)\nor the [bug tracker](https://github.com/SFTtech/openage/issues).\n\nContributing\n============\n\nYou might ask yourself now \"Sounds cool, but how do I participate\nand ~~get famous~~ contribute useful features?\".\n\nFortunately for you, there is a lot to do and we are very grateful for your help.\n\n## Where do I start?\n\n* **Check the issues** [labelled with `good first issue`](https://github.com/SFTtech/openage/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). These are tasks that you can start right away and don't require much previous knowledge.\n* **Ask us** in the [chat](https://matrix.to/#/#sfttech:matrix.org). Someone there could need\n help with something.\n* You can also **take the initiative** and fix a bug you found, create an issue for discussion or\n implement a feature that we never thought of, but always wanted.\n\n\n## Ok, I found something. What now?\n\n* **[Tell us](#contact)**, if you haven't already. Chances are that we have additional information\n and directions.\n* **[Read the docs](/doc)**. They will answer most \"administrative\"\n questions like what code style is used and how the engine core parts are connected.\n* **Read the code** and get familiar with the engine component you want to work with.\n* Do not hesitate to **[ask us for help](#contact)** if you do not understand something.\n\n\n## How do I contribute my features/changes?\n\n* Read the **[contributing guide](/doc/contributing.md)**.\n* You can upload work-in-progress (WIP) versions or drafts of your contribution to get feedback or support.\n* Tell us (again) when you want us to review your work.\n\n## I want to help, but I'm not a programmer...\n\nThen openage might be a good reason to become one! We have many issues and tasks for beginners. You\njust have to ask and we'll find something. Alternatively, lurking is also allowed.\n\n----\n\nCheers, happy hecking!\n\n\nDevelopment Process\n-------------------\n\nWhat does openage development look like in practice?\n\n* extensive [synchronization](#contact)!\n* [doc/development.md](/doc/development.md).\n\nHow can I help?\n\n* [doc/contributing.md](/doc/contributing.md).\n\nAll documentation is also in this repo:\n\n* Code documentation is embedded in the sources for Doxygen (see [doc readme](/doc/README.md)).\n* Have a look at the [doc directory](/doc/). This folder tends to get outdated when code changes.\n\n\nLicense\n-------\n\n**GNU GPLv3** or later; see [copying.md](copying.md) and [legal/GPLv3](/legal/GPLv3).\n\nI know that probably nobody is ever gonna look at the `copying.md` file,\nbut if you want to contribute code to openage, please take the time to\nskim through it and add yourself to the authors list.\n" }, { "path": "assets/.gitignore", "content": "# converted game assets\n/converted/\n" }, { "path": "assets/CMakeLists.txt", "content": "# Copyright 2014-2017 the openage authors. See copying.md for legal info.\n\nadd_subdirectory(logo/)\nadd_subdirectory(shaders/)\nadd_subdirectory(test/)\nadd_subdirectory(textures/)\n\ninstall(DIRECTORY \"qml\"\n\tDESTINATION \"${ASSET_DIR}\"\n)\n\n# To show QML files in the QtCreator.\nfile(GLOB QML_SRC \"qml/*.qml\")\nadd_custom_target(qtcreator-show-qml SOURCES ${QML_SRC})\n" }, { "path": "assets/logo/CMakeLists.txt", "content": "install(\n\tFILES \"crown.svg\"\n\tRENAME \"openage.svg\"\n\tDESTINATION \"share/pixmaps/\"\n)\n\ninstall(\n\tFILES \"banner.svg\"\n\tDESTINATION \"${ASSET_DIR}\"\n)\n" }, { "path": "assets/qml/.gitignore", "content": "*.qmlc\n" }, { "path": "assets/qml/Actions.qml", "content": "// Copyright 2016-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\n\nimport yay.sfttech.openage 1.0 as OA\n\nItem {\n\tid: root\n\n\t/*\n\t * Calls 'actionMode.act(name)' to execute actions.\n\t */\n\tproperty var actionMode\n\n\t/*\n\t * Use \"act\" properties of these objects to access the Action.\n\t * Action has additional \"iconCheckedSource\" property.\n\t */\n\tproperty alias actionObjects: actionObjectList.children\n\n\tvisible: false\n\n\tExclusiveGroup {\n\t\tid: stanceGrp\n\t}\n\n\tExclusiveGroup {\n\t\tid: noGrp\n\t}\n\n\tItem {\n\t\tid: actionObjectList\n\n\t\tRepeater {\n\t\t\tmodel: OA.ActionsListModel {\n\t\t\t\tid: actionObjectListModel\n\t\t\t\taction_mode: root.actionMode\n\t\t\t}\n\n\t\t\tdelegate: Item {\n\t\t\t\tproperty QtObject act: Action {\n\t\t\t\t\tonTriggered: root.actionMode.act(name)\n\n\t\t\t\t\ticonSource: ico != -1 ? actionObjectListModel.iconsSource + \".\" + ico : \"\"\n\n\t\t\t\t\tproperty url iconCheckedSource: icoChk != -1 ? actionObjectListModel.iconsSource + \".\" + icoChk : \"\"\n\t\t\t\t\tcheckable: icoChk != -1\n\t\t\t\t\texclusiveGroup: icoChk == -1 ? null : (grpID == 1) ? stanceGrp : noGrp\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n" }, { "path": "assets/qml/ActionsGrid.qml", "content": "// Copyright 2016-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\n\nGrid {\n\tid: root\n\n\t/*\n\t * List of actions. Fields:\n\t * 'act' - button action of type 'Action' that may have 'url iconCheckedSource' property\n\t *\n\t * Use 'act.iconSource == \"\"' for gaps.\n\t */\n\tproperty var buttonActions\n\n\tspacing: metricsUnit * 0.5\n\n\tComponent {\n\t\tid: gridElement\n\n\t\tButtonExtruded {\n\t\t\tproperty bool flat\n\n\t\t\twidth: (root.height - root.spacing * (root.rows - 1)) / root.rows\n\t\t\theight: width\n\n\t\t\tvisible: iconSource != \"\"\n\n\t\t\tproperty url iconCheckedSource\n\t\t}\n\t}\n\n\tRepeater {\n\t\tmodel: parent.buttonActions\n\n\t\tdelegate: Loader {\n\t\t\tsourceComponent: gridElement\n\t\t\tactive: typeof act !== \"undefined\"\n\t\t\tonLoaded: {\n\t\t\t\titem.iconSource = Qt.binding(function() { return act.iconSource })\n\t\t\t\titem.action = act\n\n\t\t\t\titem.flat = Qt.binding(function() { return act.iconSourceChecked != \"\" })\n\t\t\t\titem.iconCheckedSource = Qt.binding(function() { return act.iconCheckedSource })\n\t\t\t}\n\t\t}\n\t}\n\n\t/*\n\t * Metric propagation.\n\t */\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tproperty int metricsUnit: metrics ? metrics.unit : fontMetrics.averageCharacterWidth\n}\n" }, { "path": "assets/qml/BindsHelp.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\n\nimport yay.sfttech.openage 1.0 as OA\n\nColumn {\n\tproperty var gameControl\n\n\tText {\n\t\tid: dummyText\n\t\tfont.pointSize: 9\n\t}\n\n\tText {\n\t\tfont.pointSize: dummyText.font.pointSize + 3\n\n\t\tcolor: \"white\"\n\t\ttext: gameControl.mode ? gameControl.mode.name : \"No Mode\"\n\t}\n\n\tRepeater {\n\t\tmodel: gameControlObj.mode ? gameControlObj.mode.binds : undefined\n\n\t\tText {\n\t\t\tfont.pointSize: dummyText.font.pointSize\n\t\t\tcolor: \"white\"\n\t\t\ttext: modelData\n\t\t}\n\t}\n\n\tText {\n\t\tfont.pointSize: dummyText.font.pointSize + 3\n\n\t\tcolor: \"white\"\n\t\ttext: \"Global Bindings\"\n\t}\n\n\tRepeater {\n\t\tmodel: OA.Engine.globalBinds\n\n\t\tText {\n\t\t\tfont.pointSize: dummyText.font.pointSize\n\t\t\tcolor: \"white\"\n\t\t\ttext: modelData\n\t\t}\n\t}\n}\n" }, { "path": "assets/qml/ButtonExtruded.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\nButton {\n\tstyle: ButtonExtrudedStyle {}\n}\n" }, { "path": "assets/qml/ButtonExtrudedStyle.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\n/*\n * Additionally accepts 'bool flat' and 'url iconCheckedSource'.\n */\nButtonStyle {\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tproperty int metricsUnit: metrics ? metrics.unit : fontMetrics.averageCharacterWidth\n\n\tbackground: Rectangle {\n\t\tanchors.fill: parent\n\n\t\timplicitWidth: 100\n\t\timplicitHeight: 25\n\n\t\tcolor: control.flat ? \"transparent\" : control.pressed ? \"black\" : \"white\"\n\n\t\tImage {\n\t\t\tanchors.fill: parent\n\n\t\t\tproperty int extrusion: control.flat ? 0 : metricsUnit / 4\n\n\t\t\tanchors.leftMargin: control.pressed ? 0 : extrusion\n\t\t\tanchors.topMargin: anchors.leftMargin\n\t\t\tanchors.rightMargin: control.pressed ? extrusion : 0\n\t\t\tanchors.bottomMargin: anchors.rightMargin\n\n\t\t\tsource: control.checked ? control.iconCheckedSource : control.iconSource\n\t\t\tfillMode: Image.Stretch\n\t\t}\n\t}\n\n\tlabel: Item {\n\t}\n}\n" }, { "path": "assets/qml/ButtonFlat.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\nButton {\n\tstyle: ButtonFlatStyle {}\n}\n" }, { "path": "assets/qml/ButtonFlatStyle.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\nButtonStyle {\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tQtObject {\n\t\tid: d\n\t\treadonly property color color: control.hovered || control.checked ? \"yellow\" : \"white\"\n\t}\n\n\tbackground: Rectangle {\n\t\timplicitWidth: control.iconSource ? 0 : 100\n\t\timplicitHeight: control.iconSource ? 0 : 25\n\n\t\tcolor: \"transparent\"\n\n\t\tborder.width: control.text || control.hovered || !control.iconSource || control.checked ? 1 : 0\n\t\tborder.color: control.checked ? \"yellow\" : \"white\"\n\t\tradius: 4\n\t}\n\n\tlabel: Item {\n\t\timplicitWidth: row.implicitWidth + (control.text ? fontMetrics.averageCharacterWidth * 2 : 0)\n\t\timplicitHeight: row.implicitHeight + (control.text ? fontMetrics.averageCharacterWidth : 0)\n\n\t\tRow {\n\t\t\tid: row\n\t\t\tanchors.centerIn: parent\n\n\t\t\tImage {\n\t\t\t\tsourceSize.width: control.buttonIconWidth\n\t\t\t\tsourceSize.height: control.buttonIconHeight\n\t\t\t\tsource: control.iconSource\n\t\t\t\tanchors.verticalCenter: parent.verticalCenter\n\t\t\t}\n\n\t\t\tText {\n\t\t\t\tid: text\n\n\t\t\t\tcolor: d.color\n\n\t\t\t\ttext: control.text\n\t\t\t}\n\t\t}\n\t}\n}\n" }, { "path": "assets/qml/CheckBoxFlat.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\nCheckBox {\n\tstyle: CheckBoxFlatStyle {}\n}\n" }, { "path": "assets/qml/CheckBoxFlatStyle.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\nCheckBoxStyle {\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tQtObject {\n\t\tid: metrics\n\t\treadonly property int unit: fontMetrics.averageCharacterWidth\n\t}\n\n\tQtObject {\n\t\tid: d\n\t\treadonly property color color: control.hovered ? \"yellow\" : \"white\"\n\t}\n\n\tindicator: Rectangle {\n\t\timplicitWidth: metrics.unit * 2\n\t\timplicitHeight: metrics.unit * 2\n\n\t\tcolor: \"transparent\"\n\n\t\tborder.width: 1\n\t\tborder.color: \"white\"\n\t\tradius: 4\n\n\t\tRectangle {\n\t\t\tvisible: control.checked\n\t\t\tcolor: d.color\n\t\t\tradius: 1\n\t\t\tanchors.margins: metrics.unit * .5\n\t\t\tanchors.fill: parent\n\t\t}\n\t}\n\n\tlabel: Text {\n\t\tcolor: d.color\n\t\ttext: control.text\n\t}\n}\n" }, { "path": "assets/qml/CreateGameWhenReady.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\n\nimport yay.sfttech.openage 1.0 as OA\n\nOA.GameCreator {\n\tid: root\n\n\tproperty bool enabled: false\n\tproperty var gameControl\n\tproperty int gameControlTargetModeIndex\n\n\tproperty int specState: gameSpec ? gameSpec.state : OA.GameSpec.Null\n\tproperty int gameState: game ? game.state : OA.GameMain.Null\n\n\tonSpecStateChanged: {\n\t\tif (enabled && specState == OA.GameSpec.Ready)\n\t\t\tactivate()\n\t}\n\n\tonGameStateChanged: {\n\t\tif (enabled && gameState == OA.GameMain.Running)\n\t\t\tif (gameControl.modeIndex != -1)\n\t\t\t\tgameControl.modeIndex = gameControlTargetModeIndex\n\t\t\telse\n\t\t\t\tconsole.error(\"CreateGameWhenReady: could not find the desired mode to switch to\")\n\t}\n}\n" }, { "path": "assets/qml/GeneratorControl.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Layouts 1.1\n\nimport yay.sfttech.openage 1.0 as OA\n\nItem {\n\tid: root\n\n\tproperty var generatorParameters\n\tproperty var gameSpec\n\tproperty var game\n\n\timplicitWidth: elements.width\n\timplicitHeight: elements.height\n\n\tColumn {\n\t\tid: elements\n\n\t\tspacing: genActions.spacing\n\n\t\tColumnLayout {\n\t\t\tid: genActions\n\n\t\t\tOA.GameSaver {\n\t\t\t\tid: gameSaver\n\n\t\t\t\tgame: root.game\n\t\t\t\tgeneratorParameters: root.generatorParameters\n\t\t\t}\n\n\t\t\tButtonFlat {\n\t\t\t\tLayout.fillWidth: true\n\n\t\t\t\ttext: \"save_game\"\n\t\t\t\tonClicked: gameSaver.activate()\n\t\t\t}\n\n\t\t\tOA.GameCreator {\n\t\t\t\tid: gameCreator\n\n\t\t\t\tgame: root.game\n\t\t\t\tgameSpec: root.gameSpec\n\t\t\t\tgeneratorParameters: root.generatorParameters\n\t\t\t}\n\n\t\t\tButtonFlat {\n\t\t\t\tLayout.fillWidth: true\n\n\t\t\t\ttext: \"generate_game\"\n\t\t\t\tonClicked: {\n\t\t\t\t\tgameCreator.activate()\n\t\t\t\t\tgameSaver.clearErrors()\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tButtonFlat {\n\t\t\t\tLayout.fillWidth: true\n\n\t\t\t\ttext: \"end_game\"\n\t\t\t\tonClicked: {\n\t\t\t\t\tgame.clear()\n\t\t\t\t\tgameCreator.clearErrors()\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tButtonFlat {\n\t\t\t\tLayout.fillWidth: true\n\n\t\t\t\ttext: \"reload_assets\"\n\t\t\t\tonClicked: gameSpec.invalidate()\n\t\t\t}\n\n\t\t\tButtonFlat {\n\t\t\t\tLayout.fillWidth: true\n\n\t\t\t\ttext: \"quit\"\n\t\t\t\tonClicked: game.engine.stop()\n\t\t\t}\n\t\t}\n\n\t\tText {\n\t\t\tproperty string errorStringSeparator: gameCreator.errorString && gameSaver.errorString ? \"\\n\" : \"\"\n\t\t\tproperty string errorString: gameCreator.errorString + errorStringSeparator + gameSaver.errorString\n\n\t\t\tcolor: errorString ? \"red\" : \"white\"\n\n\t\t\ttext: if (errorString)\n\t\t\t\t\t\"Error: \" + errorString\n\t\t\t\telse\n\t\t\t\t\tswitch (root.game.state) {\n\t\t\t\t\t\tcase OA.GameMain.Null:\n\t\t\t\t\t\t\t\"Not running\"\n\t\t\t\t\t\t\tbreak\n\n\t\t\t\t\t\tcase OA.GameMain.Running:\n\t\t\t\t\t\t\t\"Running\"\n\t\t\t\t\t\t\tbreak\n\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\t\"Unknown\"\n\t\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t}\n\t}\n}\n" }, { "path": "assets/qml/GeneratorParametersConfiguration.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Layouts 1.1\n\nimport yay.sfttech.openage 1.0 as OA\n\nItem {\n\tid: root\n\n\tproperty var generatorParameters\n\n\timplicitHeight: parameterTable.height\n\n\tGridLayout {\n\t\tid: parameterTable\n\n\t\tRepeater {\n\t\t\tmodel: root.generatorParameters\n\n\t\t\tText {\n\t\t\t\tLayout.row: index\n\t\t\t\tLayout.column: 0\n\n\t\t\t\tcolor: \"white\"\n\n\t\t\t\ttext: display\n\t\t\t}\n\t\t}\n\n\t\tRepeater {\n\t\t\tmodel: root.generatorParameters\n\n\t\t\tComponent {\n\t\t\t\tid: textField\n\n\t\t\t\tTextFieldFlat {\n\t\t\t\t\tproperty var model\n\n\t\t\t\t\ttext: model.edit\n\t\t\t\t\tonTextChanged: model.edit = text\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tComponent {\n\t\t\t\tid: checkBox\n\n\t\t\t\tCheckBoxFlat {\n\t\t\t\t\tproperty var model\n\n\t\t\t\t\tchecked: model.edit\n\t\t\t\t\tonCheckedChanged: model.edit = checked\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tdelegate: Loader {\n\t\t\t\tLayout.row: index\n\t\t\t\tLayout.column: 1\n\n\t\t\t\tsourceComponent: typeof(model.edit) == \"boolean\" ? checkBox : textField\n\n\t\t\t\tonLoaded: item.model = Qt.binding(function() { return model })\n\t\t\t}\n\t\t}\n\t}\n}\n" }, { "path": "assets/qml/IngameHud.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Layouts 1.1\n\nimport yay.sfttech.openage 1.0 as OA\n\nItem {\n\tid: root\n\n\tproperty var actionMode\n\tproperty string playerName\n\tproperty int civIndex\n\n\treadonly property int topStripSubid: 0\n\treadonly property int midStripSubid: 1\n\treadonly property int leftRectSubid: 2\n\treadonly property int rightRectSubid: 3\n\treadonly property int resBaseSubid: 4\n\n\treadonly property string srcPrefix: \"image://by-filename/converted/interface/hud\"\n\treadonly property string pad: \"0000\"\n\treadonly property string srcSuffix: \".slp.png\"\n\tproperty string hudImageSource: srcPrefix + (pad + civIndex).slice(-pad.length) + srcSuffix\n\n\treadonly property string iconsPrefix: \"image://by-filename/converted/interface/\"\n\treadonly property string iconsBorder: \"image://by-filename/converted/interface/53003.slp.png.1\"\n\n\twidth: 1289\n\theight: 960\n\n\tItem {\n\t\tanchors.left: parent.left\n\t\tanchors.right: parent.right\n\t\tanchors.top: parent.top\n\n\t\theight: metricsUnit * 1.5 * 2.5\n\n\t\tImage {\n\t\t\tanchors.fill: parent\n\t\t\tsource: hudImageSource + \".\" + root.topStripSubid\n\n\t\t\tsourceSize.height: parent.height\n\t\t\tfillMode: Image.Tile\n\t\t}\n\n\t\tRowLayout {\n\t\t\tanchors.fill: parent\n\t\t\tanchors.leftMargin: metricsUnit\n\t\t\tanchors.rightMargin: metricsUnit\n\t\t\tanchors.verticalCenter: parent.verticalCenter\n\t\t\tspacing: metricsUnit * 0.7\n\n\t\t\tRow {\n\t\t\t\tspacing: metricsUnit * 0.7\n\n\t\t\t\tComponent {\n\t\t\t\t\tid: resourceIndicator\n\n\t\t\t\t\tRectangle {\n\t\t\t\t\t\tproperty string amount\n\t\t\t\t\t\tproperty int iconIndex\n\t\t\t\t\t\tproperty bool warning\n\n\t\t\t\t\t\twidth: metricsUnit * 1.5 * 6.5\n\t\t\t\t\t\theight: metricsUnit * 1.5 * 1.7\n\n\t\t\t\t\t\tcolor: \"#7FFFFFFF\"\n\n\t\t\t\t\t\tRectangle {\n\t\t\t\t\t\t\tanchors.fill: parent\n\t\t\t\t\t\t\tanchors.rightMargin: metricsUnit * 0.3\n\t\t\t\t\t\t\tanchors.bottomMargin: metricsUnit * 0.3\n\n\t\t\t\t\t\t\tcolor: \"black\"\n\n\t\t\t\t\t\t\tImage {\n\t\t\t\t\t\t\t\tsourceSize.height: parent.height\n\n\t\t\t\t\t\t\t\tsource: hudImageSource + \".\" + (root.resBaseSubid + iconIndex)\n\t\t\t\t\t\t\t\tfillMode: Image.PreserveAspectFit\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\tText {\n\t\t\t\t\t\t\t\tanchors.right: parent.right\n\t\t\t\t\t\t\t\tanchors.rightMargin: metricsUnit / 2\n\t\t\t\t\t\t\t\tanchors.verticalCenter: parent.verticalCenter\n\t\t\t\t\t\t\t\ttext: amount\n\n\t\t\t\t\t\t\t\tcolor: \"white\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tRectangle {\n\t\t\t\t\t\t\tanchors.fill: parent\n\t\t\t\t\t\t\tanchors.rightMargin: metricsUnit * 0.3\n\t\t\t\t\t\t\tanchors.bottomMargin: metricsUnit * 0.3\n\n\t\t\t\t\t\t\tvisible: warning\n\n\t\t\t\t\t\t\tcolor: \"#80FFC100\"\n\n\t\t\t\t\t\t\tSequentialAnimation on opacity {\n\t\t\t\t\t\t\t\tloops: Animation.Infinite\n\t\t\t\t\t\t\t\tPropertyAnimation { from: 0; to: 1; duration: 250 }\n\t\t\t\t\t\t\t\tPropertyAnimation { from: 1; to: 0; duration: 250 }\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\n\t\t\t\tRepeater {\n\t\t\t\t\tmodel: OA.Resources {\n\t\t\t\t\t\tactionMode: root.actionMode\n\t\t\t\t\t}\n\n\t\t\t\t\tdelegate: Loader {\n\t\t\t\t\t\tsourceComponent: resourceIndicator\n\n\t\t\t\t\t\tonLoaded: {\n\t\t\t\t\t\t\titem.amount = Qt.binding(function() { return display })\n\t\t\t\t\t\t\titem.iconIndex = Qt.binding(function() { return index })\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tLoader {\n\t\t\t\t\tsourceComponent: resourceIndicator\n\n\t\t\t\t\tonLoaded: {\n\t\t\t\t\t\titem.amount = Qt.binding(function() { return root.actionMode.population })\n\t\t\t\t\t\titem.iconIndex = 4\n\t\t\t\t\t\titem.warning = Qt.binding(function() { return root.actionMode.population_warn })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tItem {\n\t\t\t\tLayout.fillWidth: true\n\t\t\t\tLayout.minimumWidth: epoch.implicitWidth\n\n\t\t\t\tRectangle {\n\t\t\t\t\tanchors.centerIn: parent\n\t\t\t\t\twidth: 200\n\t\t\t\t\theight: metricsUnit * 2.5\n\n\t\t\t\t\tcolor: \"black\"\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tid: epoch\n\t\t\t\t\t\tanchors.centerIn: parent\n\n\t\t\t\t\t\tcolor: \"white\"\n\t\t\t\t\t\ttext: root.playerName\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tRepeater {\n\t\t\t\tmodel: 5\n\n\t\t\t\tRectangle {\n\t\t\t\t\twidth: metricsUnit * 1.5 * 5\n\t\t\t\t\theight: metricsUnit * 1.5 * 1.5\n\n\t\t\t\t\tcolor: \"transparent\"\n\t\t\t\t\tborder.width: 1\n\t\t\t\t\tborder.color: \"white\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tItem {\n\t\tanchors.left: parent.left\n\t\tanchors.right: parent.right\n\t\tanchors.bottom: parent.bottom\n\n\t\theight: metricsUnit * 1.5 * 16\n\n\t\tImage {\n\t\t\tid: leftRect\n\n\t\t\tanchors.left: parent.left\n\t\t\tanchors.top: parent.top\n\t\t\tanchors.bottom: parent.bottom\n\n\t\t\twidth: height * 1.63\n\n\t\t\tsource: hudImageSource + \".\" + root.leftRectSubid\n\t\t\tfillMode: Image.Stretch\n\n\t\t\tActionsGrid {\n\t\t\t\tid: actionsGrid\n\n\t\t\t\tanchors.fill: parent\n\t\t\t\tanchors.topMargin: parent.height * 40 / 218\n\t\t\t\tanchors.leftMargin: parent.height * 40 / 218 + metricsUnit * 1.4\n\t\t\t\tanchors.rightMargin: parent.height * 40 / 218 + metricsUnit * 0.5\n\t\t\t\tanchors.bottomMargin: parent.height * 40 / 218 - metricsUnit * 1.4\n\n\t\t\t\tcolumns: 5\n\t\t\t\trows: 3\n\n\t\t\t\tActions {\n\t\t\t\t\tid: actions\n\n\t\t\t\t\tactionMode: root.actionMode\n\t\t\t\t}\n\n\t\t\t\tbuttonActions: actions.actionObjects\n\t\t\t}\n\t\t}\n\n\t\tColumnLayout {\n\t\t\tanchors.left: leftRect.right\n\t\t\tanchors.right: rightRect.left\n\t\t\tanchors.top: parent.top\n\t\t\tanchors.bottom: parent.bottom\n\n\t\t\tspacing: 0\n\n\t\t\tImage {\n\t\t\t\tid: borderStrip\n\n\t\t\t\tLayout.fillWidth: true\n\n\t\t\t\tsourceSize.height: metricsUnit * 1.4\n\n\t\t\t\tsource: hudImageSource + \".\" + root.midStripSubid\n\t\t\t\tfillMode: Image.Tile\n\t\t\t}\n\n\t\t\tRectangle {\n\t\t\t\tLayout.fillHeight: true\n\t\t\t\tLayout.fillWidth: true\n\n\t\t\t\tcolor: \"#41110d\"\n\n\t\t\t\tPaper {\n\t\t\t\t\tanchors.fill: parent\n\t\t\t\t\ttornBottom: false\n\t\t\t\t}\n\n\t\t\t\tItem {\n\t\t\t\t\tanchors.fill: parent\n\t\t\t\t\tid: selection_single_panel\n\t\t\t\t\tvisible: root.actionMode.selection_size == 1\n\n\t\t\t\t\tImage {\n\t\t\t\t\t\tanchors.top: parent.top\n\t\t\t\t\t\tanchors.topMargin: metricsUnit * 2\n\t\t\t\t\t\tanchors.left: parent.left\n\t\t\t\t\t\tanchors.leftMargin: metricsUnit * 2\n\n\t\t\t\t\t\twidth: 50\n\t\t\t\t\t\theight: 50\n\n\t\t\t\t\t\tid: selected_icon\n\n\t\t\t\t\t\tsource: root.actionMode.selection_icon ? iconsPrefix + root.actionMode.selection_icon : iconsBorder\n\t\t\t\t\t}\n\t\t\t\t\tImage {\n\t\t\t\t\t\tanchors.centerIn: selected_icon\n\n\t\t\t\t\t\twidth: 50\n\t\t\t\t\t\theight: 50\n\n\t\t\t\t\t\tsource: iconsBorder\n\t\t\t\t\t}\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tanchors.top: selected_icon.top\n\t\t\t\t\t\tanchors.left: selected_icon.right\n\t\t\t\t\t\tanchors.leftMargin: metricsUnit * 1.2\n\n\t\t\t\t\t\tid: selected_name\n\n\t\t\t\t\t\tcolor: \"black\"\n\t\t\t\t\t\ttext: root.actionMode.selection_name\n\t\t\t\t\t\tfont.pointSize: 16\n\t\t\t\t\t}\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tanchors.verticalCenter: selected_name.verticalCenter\n\t\t\t\t\t\tanchors.left: selected_name.right\n\t\t\t\t\t\tanchors.leftMargin: metricsUnit * 1.2\n\n\t\t\t\t\t\tid: selected_type\n\n\t\t\t\t\t\tcolor: \"black\"\n\t\t\t\t\t\topacity: 0.8\n\t\t\t\t\t\ttext: root.actionMode.selection_type\n\t\t\t\t\t}\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tanchors.top: selected_name.bottom\n\t\t\t\t\t\tanchors.left: selected_name.left\n\t\t\t\t\t\tanchors.topMargin: metricsUnit\n\n\t\t\t\t\t\tid: selected_hp\n\n\t\t\t\t\t\tcolor: \"black\"\n\t\t\t\t\t\ttext: root.actionMode.selection_hp\n\t\t\t\t\t}\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tanchors.top: selected_hp.bottom\n\t\t\t\t\t\tanchors.left: selected_icon.left\n\t\t\t\t\t\tanchors.topMargin: metricsUnit * 2\n\n\t\t\t\t\t\tcolor: \"black\"\n\t\t\t\t\t\ttext: root.actionMode.selection_attrs\n\t\t\t\t\t}\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tanchors.top: parent.top\n\t\t\t\t\t\tanchors.right: parent.right\n\t\t\t\t\t\tanchors.topMargin: metricsUnit * 2\n\t\t\t\t\t\tanchors.rightMargin: metricsUnit * 2\n\n\t\t\t\t\t\tcolor: \"black\"\n\t\t\t\t\t\ttext: root.actionMode.selection_owner\n\t\t\t\t\t\thorizontalAlignment: Text.AlignRight\n\t\t\t\t\t}\n\n\t\t\t\t}\n\n\t\t\t\tItem {\n\t\t\t\t\tanchors.fill: parent\n\t\t\t\t\tid: selection_group_panel\n\t\t\t\t\tvisible: root.actionMode.selection_size > 1\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tanchors.top: parent.top\n\t\t\t\t\t\tanchors.topMargin: metricsUnit * 2\n\t\t\t\t\t\tanchors.left: parent.left\n\t\t\t\t\t\tanchors.leftMargin: metricsUnit * 2\n\n\t\t\t\t\t\tcolor: \"black\"\n\t\t\t\t\t\ttext: root.actionMode.selection_name\n\t\t\t\t\t\tfont.pointSize: 14\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tItem {\n\t\t\t\t\tanchors.left: parent.left\n\t\t\t\t\tanchors.right: parent.right\n\t\t\t\t\tanchors.bottom: parent.bottom\n\t\t\t\t\tanchors.bottomMargin: metricsUnit * 3\n\t\t\t\t\tvisible: actionMode.ability.length\n\n\t\t\t\t\tText {\n\t\t\t\t\t\tanchors.centerIn: parent\n\n\t\t\t\t\t\ttext: actionMode.ability\n\t\t\t\t\t\tfont.pointSize: 14\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tImage {\n\t\t\tid: rightRect\n\n\t\t\tanchors.right: parent.right\n\t\t\tanchors.top: parent.top\n\t\t\tanchors.bottom: parent.bottom\n\n\t\t\twidth: height * 2.01\n\n\t\t\tsource: hudImageSource + \".\" + root.rightRectSubid\n\t\t\tfillMode: Image.Stretch\n\t\t}\n\t}\n\n\t/*\n\t * Metric propagation.\n\t */\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tproperty int metricsUnit: metrics ? metrics.unit : fontMetrics.averageCharacterWidth\n}\n" }, { "path": "assets/qml/Paper.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\n\nItem {\n\tid: root\n\n\t/*\n\t * A paper texture.\n\t */\n\tproperty url paperTextureSource: \"image://by-filename/converted/interface/scr5b.slp.png.0\"\n\n\t/*\n\t * This texture is tiled along the item edges, bottom faces the inside.\n\t * So, alpha should be zero for the pixels where to keep the paper, solid color - where it's torn off.\n\t */\n\tproperty url edgeHmapSource: \"image://by-filename/textures/torn_paper_edge.png.0\"\n\n\t/*\n\t * Which edges are torn off.\n\t */\n\tproperty bool tornTop: true\n\tproperty bool tornBottom: true\n\tproperty bool tornLeft: true\n\tproperty bool tornRight: true\n\n\t/*\n\t * Changing metrics.unit (currently bound to the font) scales all textures.\n\t * So the details on the textures stay exactly the same relatively to metricsUnit.\n\t */\n\tproperty real scaling: 8. / metricsUnit\n\n\ttransform: Scale { xScale: 1. / root.scaling; yScale: 1. / root.scaling}\n\n\tItem {\n\t\tanchors.left: parent.left\n\t\tanchors.top: parent.top\n\n\t\t/*\n\t\t * Do +.5 to avoid being less than parent due to truncation.\n\t\t */\n\t\twidth: (parent.width + .5) * root.scaling\n\t\theight: (parent.height + .5) * root.scaling\n\n\t\tItem {\n\t\t\tanchors.fill: parent\n\n\t\t\t/*\n\t\t\t * Hack, so the child has 'visible' and 'layer.enabled'.\n\t\t\t */\n\t\t\tclip: true\n\n\t\t\tItem {\n\t\t\t\tid: texturedPaper\n\n\t\t\t\t/*\n\t\t\t\t * Hack, so that this item has 'visible' and 'layer.enabled'.\n\t\t\t\t */\n\t\t\t\twidth: parent.width\n\t\t\t\theight: parent.height\n\t\t\t\tx: parent.width\n\n\t\t\t\tlayer.enabled: true\n\n\t\t\t\tImage {\n\t\t\t\t\tanchors.fill: parent\n\t\t\t\t\tsource: root.paperTextureSource\n\t\t\t\t\tfillMode: Image.Tile\n\n\t\t\t\t\t/*\n\t\t\t\t\t * Use an ellipse to darken parts that are far from the center.\n\t\t\t\t\t */\n\t\t\t\t\tlayer.enabled: true\n\t\t\t\t\tlayer.wrapMode: ShaderEffectSource.Repeat\n\t\t\t\t\tlayer.samplerName: \"paperSource\"\n\t\t\t\t\tlayer.effect: ShaderEffect {\n\t\t\t\t\t\tfragmentShader: \"\n\t\t\t\t\t\t\tuniform lowp sampler2D paperSource;\n\t\t\t\t\t\t\tvarying highp vec2 qt_TexCoord0;\n\n\t\t\t\t\t\t\tconst float exposure = .5;\n\t\t\t\t\t\t\tconst float times = 3.;\n\n\t\t\t\t\t\t\tvec3 burntMidtones(vec3 src, float exposure, float times) {\n\t\t\t\t\t\t\t\tfloat factor = 1. + exposure * (.33);\n\t\t\t\t\t\t\t\treturn pow(src.rgb, vec3(factor * times));\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\tvoid main() {\n\t\t\t\t\t\t\t\tvec4 bkg = texture2D(paperSource, qt_TexCoord0);\n\t\t\t\t\t\t\t\tvec3 burnt = burntMidtones(bkg.rgb, exposure, times);\n\n\t\t\t\t\t\t\t\tfloat burnGradient = pow(pow((qt_TexCoord0.x - .5), 2.) + pow((qt_TexCoord0.y - 1.), 2.), 1.) * .9;\n\n\t\t\t\t\t\t\t\tgl_FragColor = vec4(mix(bkg.rgb, burnt, vec3(burnGradient)), 1.);\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\n\t\t/*\n\t\t * Inverse QtGraphicalEffects.OpacityMask.\n\t\t */\n\t\tItem {\n\t\t\tanchors.fill: parent\n\n\t\t\tlayer.enabled: true\n\n\t\t\tlayer.effect: ShaderEffect {\n\t\t\t\tproperty variant source: texturedPaper\n\t\t\t\tproperty variant mask: rectWithTornOffEdges\n\n\t\t\t\tfragmentShader: \"\n\t\t\t\t\tuniform sampler2D source;\n\t\t\t\t\tuniform sampler2D mask;\n\t\t\t\t\tvarying highp vec2 qt_TexCoord0;\n\t\t\t\t\tvoid main() {\n\t\t\t\t\t\tgl_FragColor = texture2D(source, qt_TexCoord0) * (1. - texture2D(mask, qt_TexCoord0).a);\n\t\t\t\t\t}\n\t\t\t\t\"\n\t\t\t}\n\t\t}\n\n\t\t/*\n\t\t * Alpha == 1.0 where the edges are torn off.\n\t\t */\n\t\tItem {\n\t\t\tid: rectWithTornOffEdges\n\n\t\t\tanchors.fill: parent\n\t\t\tlayer.enabled: true\n\n\t\t\tImage {\n\t\t\t\tanchors.left: parent.left\n\t\t\t\tanchors.right: parent.right\n\t\t\t\tanchors.top: parent.top\n\n\t\t\t\tsource: root.edgeHmapSource\n\t\t\t\tfillMode: Image.Tile\n\n\t\t\t\tvisible: root.tornTop\n\t\t\t}\n\n\t\t\tImage {\n\t\t\t\tanchors.left: parent.left\n\t\t\t\tanchors.right: parent.right\n\t\t\t\tanchors.top: parent.top\n\n\t\t\t\tsource: root.edgeHmapSource\n\t\t\t\tfillMode: Image.Tile\n\n\t\t\t\ttransform: Rotation {\n\t\t\t\t\torigin.x: rectWithTornOffEdges.width / 2\n\t\t\t\t\torigin.y: rectWithTornOffEdges.height / 2\n\t\t\t\t\tangle: 180\n\t\t\t\t}\n\n\t\t\t\tvisible: root.tornBottom\n\t\t\t}\n\n\t\t\tImage {\n\t\t\t\tanchors.left: parent.left\n\t\t\t\tanchors.leftMargin: parent.height\n\t\t\t\tanchors.top: parent.top\n\n\t\t\t\twidth: parent.height\n\n\t\t\t\tsource: root.edgeHmapSource\n\t\t\t\tfillMode: Image.Tile\n\n\t\t\t\ttransform: Rotation {\n\t\t\t\t\torigin.y: rectWithTornOffEdges.height\n\t\t\t\t\tangle: -90\n\t\t\t\t}\n\n\t\t\t\tvisible: root.tornLeft\n\t\t\t}\n\n\t\t\tImage {\n\t\t\t\tanchors.right: parent.right\n\t\t\t\tanchors.rightMargin: parent.height\n\t\t\t\tanchors.top: parent.top\n\n\t\t\t\twidth: parent.height\n\n\t\t\t\tsource: root.edgeHmapSource\n\t\t\t\tfillMode: Image.Tile\n\n\t\t\t\ttransform: Rotation {\n\t\t\t\t\torigin.y: rectWithTornOffEdges.height\n\t\t\t\t\torigin.x: rectWithTornOffEdges.height\n\t\t\t\t\tangle: 90\n\t\t\t\t}\n\n\t\t\t\tvisible: root.tornRight\n\t\t\t}\n\n\t\t\tvisible: false\n\t\t}\n\t}\n\n\t/*\n\t * Average character width that the paper will adapt to (by scaling its texture).\n\t */\n\t/*\n\t * Metric propagation.\n\t */\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tproperty int metricsUnit: metrics ? metrics.unit : fontMetrics.averageCharacterWidth\n}\n" }, { "path": "assets/qml/TextFieldFlat.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\nTextField {\n\tstyle: TextFieldFlatStyle {}\n}\n" }, { "path": "assets/qml/TextFieldFlatStyle.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Controls.Styles 1.3\n\nTextFieldStyle {\n\ttextColor: \"white\"\n\n\tbackground: Rectangle {\n\t\tcolor: \"transparent\"\n\n\t\tborder.width: 1\n\t\tborder.color: \"white\"\n\t\tradius: 4\n\t}\n}\n" }, { "path": "assets/qml/TypePicker.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Layouts 1.1\n\nimport yay.sfttech.openage 1.0 as OA\n\nItem {\n\tid: root\n\n\t// input\n\tproperty var editorMode\n\tproperty var gameSpec\n\tproperty int iconHeight\n\n\tfunction toggle() {\n\t\tif (!categoryPicker.current && categoryButtons.children.length)\n\t\t\tcategoryButtons.children[0].checked = true\n\t\telse\n\t\t\tfor (var i = 0; i < categoryButtons.children.length; ++i) {\n\t\t\t\tvar item = categoryButtons.children[i]\n\n\t\t\t\tif (item.exclusiveGroup && item.exclusiveGroup == categoryPicker && item.checked) {\n\t\t\t\t\tfor (var j = (i + 1) % categoryButtons.children.length; j != i; j = (j + 1) % categoryButtons.children.length) {\n\t\t\t\t\t\tvar candidate = categoryButtons.children[j]\n\n\t\t\t\t\t\tif (candidate.exclusiveGroup && candidate.exclusiveGroup == categoryPicker) {\n\t\t\t\t\t\t\tcandidate.checked = true\n\t\t\t\t\t\t\tbreak\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t}\n\n\t// output\n\treadonly property int current: selectedType.current ? selectedType.current.thisTypeId : -1\n\tproperty int currentHighlighted: -1\n\n\treadonly property int currentTerrain: selectedTerrain.current ? selectedTerrain.current.thisTerrainId : -1\n\treadonly property bool paintTerrain: categoryPicker.current && categoryPicker.current.text == \"terrain\"\n\n\tColumnLayout {\n\t\tanchors.fill: parent\n\n\t\tRow {\n\t\t\tid: categoryButtons\n\n\t\t\tanchors.horizontalCenter: implicitWidth < parent.width ? parent.horizontalCenter : undefined\n\n\t\t\tExclusiveGroup {\n\t\t\t\tid: categoryPicker\n\t\t\t}\n\n\t\t\tOA.Category {\n\t\t\t\tid: categoryToUse\n\t\t\t\tname: categoryPicker.current && categoryPicker.current.text != \"terrain\" ? categoryPicker.current.text : \"\"\n\t\t\t\teditorMode: root.editorMode\n\t\t\t}\n\n\t\t\tButtonFlat {\n\t\t\t\tcheckable: true\n\t\t\t\texclusiveGroup: categoryPicker\n\n\t\t\t\ttext: \"terrain\"\n\t\t\t}\n\n\t\t\tRepeater {\n\t\t\t\tmodel: editorMode.categories\n\n\t\t\t\tButtonFlat {\n\t\t\t\t\tcheckable: true\n\t\t\t\t\texclusiveGroup: categoryPicker\n\n\t\t\t\t\ttext: modelData\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tRectangle {\n\t\t\tLayout.fillWidth: true\n\t\t\tLayout.fillHeight: true\n\t\t\tLayout.minimumWidth: metricsUnit * 10\n\t\t\tLayout.minimumHeight: metricsUnit * 10\n\n\t\t\tcolor: \"transparent\"\n\n\t\t\tborder.width: 1\n\t\t\tborder.color: \"white\"\n\t\t\tradius: 4\n\n\t\t\tFlickable {\n\t\t\t\tanchors.fill: parent\n\t\t\t\tanchors.margins: metricsUnit / 2\n\n\t\t\t\tboundsBehavior: Flickable.StopAtBounds\n\n\t\t\t\tclip: true\n\t\t\t\tcontentWidth: width\n\t\t\t\tcontentHeight: typeIcons.height\n\n\t\t\t\tFlow {\n\t\t\t\t\tid: typeIcons\n\n\t\t\t\t\tanchors.left: parent.left\n\t\t\t\t\tanchors.right: parent.right\n\n\t\t\t\t\tExclusiveGroup {\n\t\t\t\t\t\tid: selectedType\n\t\t\t\t\t}\n\n\t\t\t\t\tRepeater {\n\t\t\t\t\t\tmodel: categoryPicker.current && categoryPicker.current.text != \"terrain\" ? categoryToUse : undefined\n\n\t\t\t\t\t\tButtonFlat {\n\t\t\t\t\t\t\tcheckable: true\n\t\t\t\t\t\t\texclusiveGroup: selectedType\n\n\t\t\t\t\t\t\tproperty int thisTypeId: typeId\n\n\t\t\t\t\t\t\tproperty int buttonIconHeight: iconHeight\n\t\t\t\t\t\t\ticonSource: \"image://by-graphic-id/\" + display + \".0\"\n\n\t\t\t\t\t\t\tonHoveredChanged: {\n\t\t\t\t\t\t\t\tif (hovered)\n\t\t\t\t\t\t\t\t\troot.currentHighlighted = typeId\n\t\t\t\t\t\t\t\telse if (root.currentHighlighted == typeId)\n\t\t\t\t\t\t\t\t\troot.currentHighlighted = -1\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\tExclusiveGroup {\n\t\t\t\t\t\tid: selectedTerrain\n\t\t\t\t\t}\n\n\t\t\t\t\tRepeater {\n\t\t\t\t\t\tmodel: categoryPicker.current && categoryPicker.current.text == \"terrain\" ? gameSpec.terrainIdCount : undefined\n\n\t\t\t\t\t\tButtonFlat {\n\t\t\t\t\t\t\tcheckable: true\n\t\t\t\t\t\t\texclusiveGroup: selectedTerrain\n\n\t\t\t\t\t\t\tproperty int thisTerrainId: index\n\n\t\t\t\t\t\t\tproperty int buttonIconHeight: iconHeight\n\t\t\t\t\t\t\ticonSource: \"image://by-terrain-id/\" + index + \".0\"\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\t}\n\n\t/*\n\t * Metric propagation.\n\t */\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tproperty int metricsUnit: metrics ? metrics.unit : fontMetrics.averageCharacterWidth\n}\n" }, { "path": "assets/qml/main.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport QtQuick.Controls 1.1\nimport QtQuick.Layouts 1.1\nimport QtQuick.Controls.Styles 1.3\n\nimport yay.sfttech.livereload 1.0\nimport yay.sfttech.openage 1.0 as OA\n\nItem {\n\tid: root\n\n\t/*\n\t * Global metric declaration.\n\t */\n\tFontMetrics {\n\t\tid: fontMetrics\n\t}\n\n\tQtObject {\n\t\tid: metrics\n\t\tproperty real scale: 1\n\t\tproperty int unit: fontMetrics.averageCharacterWidth * scale\n\t}\n\n\tOA.GameSpec {\n\t\tid: specObj\n\n\t\t/**\n\t\t * States: Null, Loading, Ready\n\t\t */\n\n\t\t// Start loading assets immediately\n\t\tactive: true\n\n\t\tassetManager: amObj\n\n\t\tLR.tag: \"spec\"\n\t}\n\n\tOA.LegacyAssetManager {\n\t\tid: amObj\n\n\t\tassetDir: OA.MainArgs.assetDir\n\n\t\tengine: OA.Engine\n\n\t\tLR.tag: \"am\"\n\t}\n\n\tOA.GameMain {\n\t\tid: gameObj\n\n\t\t/**\n\t\t * States: Null, Running\n\t\t */\n\n\t\tengine: OA.Engine\n\n\t\tLR.tag: \"game\"\n\t}\n\n\tOA.GameControl {\n\t\tid: gameControlObj\n\n\t\tengine: OA.Engine\n\t\tgame: gameObj\n\n\t\t/**\n\t\t * must be run after the engine is attached\n\t\t */\n\t\tComponent.onCompleted: {\n\t\t\tmodes = [createModeObj, editorModeObj, actionModeObj]\n\t\t\tmodeIndex = 0\n\t\t}\n\n\t\tLR.tag: \"gamecontrol\"\n\t}\n\n\tOA.GeneratorParameters {\n\t\tid: genParamsObj\n\n\t\tLR.tag: \"gen\"\n\t}\n\n\tColumnLayout {\n\t\tid: controls\n\n\t\tanchors.left: parent.left\n\t\tanchors.right: parent.right\n\t\tanchors.top: parent.top\n\n\t\tspacing: fontMetrics.averageCharacterWidth * 2\n\n\t\tstate: gameControlObj.mode ? gameControlObj.mode.name : \"\"\n\n\t\tComponent {\n\t\t\tid: changeMode\n\n\t\t\tButtonFlat {\n\t\t\t\ttext: \"change_mode\"\n\t\t\t\tonClicked: gameControlObj.modeIndex = (gameControlObj.effectiveModeIndex + 1) % gameControlObj.modes.length\n\t\t\t}\n\t\t}\n\n\t\tOA.CreateMode {\n\t\t\tid: createModeObj\n\t\t\tLR.tag: \"createMode\"\n\t\t}\n\n\t\tOA.ActionMode {\n\t\t\tid: actionModeObj\n\t\t\tLR.tag: \"actionMode\"\n\t\t}\n\n\t\tOA.EditorMode {\n\t\t\tid: editorModeObj\n\n\t\t\tcurrentTypeId: typePicker.current\n\t\t\tcurrentTerrainId: typePicker.currentTerrain\n\t\t\tpaintTerrain: typePicker.paintTerrain\n\n\t\t\tonToggle: typePicker.toggle()\n\n\t\t\tLR.tag: \"editorMode\"\n\t\t}\n\n\t\tCreateGameWhenReady {\n\t\t\tenabled: createWhenReady.checked\n\n\t\t\tgame: gameObj\n\t\t\tgameSpec: specObj\n\t\t\tgeneratorParameters: genParamsObj\n\t\t\tgameControl: gameControlObj\n\n\t\t\tgameControlTargetModeIndex: gameControlObj.modes.indexOf(actionModeObj)\n\t\t}\n\n\t\tstates: [\n\t\t\tState {\n\t\t\t\tid: creationMode\n\t\t\t\tname: createModeObj.name\n\n\t\t\t\tproperty list content: [\n\t\t\t\t\tLoader {\n\t\t\t\t\t\tsourceComponent: changeMode\n\t\t\t\t\t},\n\t\t\t\t\tGeneratorParametersConfiguration {\n\t\t\t\t\t\tgeneratorParameters: genParamsObj\n\t\t\t\t\t},\n\t\t\t\t\tGeneratorControl {\n\t\t\t\t\t\tgeneratorParameters: genParamsObj\n\t\t\t\t\t\tgameSpec: specObj\n\t\t\t\t\t\tgame: gameObj\n\t\t\t\t\t},\n\t\t\t\t\tCheckBoxFlat {\n\t\t\t\t\t\tid: createWhenReady\n\t\t\t\t\t\ttext: \"create_when_ready\"\n\t\t\t\t\t\tvisible: specObj.state == OA.GameSpec.Loading\n\t\t\t\t\t}\n\t\t\t\t]\n\n\t\t\t\tPropertyChanges {\n\t\t\t\t\ttarget: controls\n\t\t\t\t\tchildren: creationMode.content\n\t\t\t\t\tanchors.topMargin: fontMetrics.averageCharacterWidth * 4\n\t\t\t\t\tanchors.leftMargin: fontMetrics.averageCharacterWidth * 2\n\t\t\t\t}\n\t\t\t},\n\t\t\tState {\n\t\t\t\tid: editorMode\n\t\t\t\tname: editorModeObj.name\n\n\t\t\t\tproperty list content: [\n\t\t\t\t\tLoader {\n\t\t\t\t\t\tsourceComponent: changeMode\n\t\t\t\t\t},\n\t\t\t\t\tTypePicker {\n\t\t\t\t\t\tid: typePicker\n\n\t\t\t\t\t\tLayout.preferredWidth: root.width / 4\n\t\t\t\t\t\tLayout.preferredHeight: root.height / 2\n\n\t\t\t\t\t\ticonHeight: fontMetrics.averageCharacterWidth * 8\n\n\t\t\t\t\t\teditorMode: editorModeObj\n\t\t\t\t\t\tgameSpec: specObj\n\t\t\t\t\t},\n\t\t\t\t\tText {\n\t\t\t\t\t\tcolor: \"white\"\n\t\t\t\t\t\ttext: typePicker.currentHighlighted != -1 ? typePicker.currentHighlighted : \"\"\n\t\t\t\t\t}\n\t\t\t\t]\n\n\t\t\t\tPropertyChanges {\n\t\t\t\t\ttarget: controls\n\t\t\t\t\tchildren: editorMode.content\n\t\t\t\t\tanchors.topMargin: fontMetrics.averageCharacterWidth * 4\n\t\t\t\t\tanchors.leftMargin: fontMetrics.averageCharacterWidth * 2\n\t\t\t\t}\n\t\t\t},\n\t\t\tState {\n\t\t\t\tid: actionMode\n\t\t\t\tname: actionModeObj.name\n\n\t\t\t\tproperty list content: [\n\t\t\t\t\tIngameHud {\n\t\t\t\t\t\tanchors.fill: root\n\n\t\t\t\t\t\tactionMode: actionModeObj\n\t\t\t\t\t\tplayerName: gameControlObj.currentPlayerName\n\t\t\t\t\t\tcivIndex: gameControlObj.currentCivIndex\n\t\t\t\t\t}\n\t\t\t\t]\n\n\t\t\t\tPropertyChanges {\n\t\t\t\t\ttarget: controls; children: actionMode.content\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n\n\tColumnLayout {\n\t\tanchors.left: parent.left\n\t\tanchors.right: parent.right\n\t\tanchors.top: parent.top\n\t\tanchors.topMargin: fontMetrics.averageCharacterWidth * 4\n\t\tanchors.rightMargin: fontMetrics.averageCharacterWidth * 2\n\n\t\tspacing: fontMetrics.averageCharacterWidth * 2\n\n\t\tBindsHelp {\n\t\t\tLayout.alignment: Qt.AlignRight\n\n\t\t\tgameControl: gameControlObj\n\t\t}\n\t}\n\n\tComponent.onCompleted: {\n\t\tOA.ImageProviderByFilename.gameSpec = specObj\n\t\tOA.ImageProviderById.gameSpec = specObj\n\t\tOA.ImageProviderByTerrainId.gameSpec = specObj\n\t}\n}\n" }, { "path": "assets/shaders/CMakeLists.txt", "content": "install(DIRECTORY \".\"\n\tDESTINATION \"${ASSET_DIR}/shaders\"\n\tFILES_MATCHING PATTERN \"*.glsl\"\n)\n" }, { "path": "assets/shaders/alphamask.frag.glsl", "content": "// alpha masking shader\n//\n// applies an alpha mask texture to a base texture,\n// then draws the masked texture.\n\n// the base and mask texture, base is the plain terrain tile\nuniform sampler2D base_texture;\nuniform sampler2D mask_texture;\n\n// disable blending and show the mask instead\nuniform bool show_mask;\n\n// get those interpolated texture position from vertexshader\nvarying vec2 base_tex_position;\nvarying vec2 mask_tex_position;\n\n\nvoid main() {\n\t// get the texel from the uniform texture.\n\tvec4 base_pixel = texture2D(base_texture, base_tex_position);\n\tvec4 mask_pixel = texture2D(mask_texture, mask_tex_position);\n\n\tfloat factor = 1.0 - mask_pixel.x;\n\n\tvec4 blended_pixel = vec4(base_pixel.r, base_pixel.g, base_pixel.b, base_pixel.a - factor);\n\n\tif (show_mask) {\n\t\tgl_FragColor = mask_pixel;\n\t} else {\n\t\tgl_FragColor = blended_pixel;\n\t}\n}\n" }, { "path": "assets/shaders/alphamask.vert.glsl", "content": "// vertex shader for applying an alpha mask to a texture\n\n// modelview*projection matrix\nuniform mat4 mvp_matrix;\n\n// the position of this vertex\nattribute vec4 vertex_position;\n\n// send the texture coordinates to the fragmentshader\nattribute vec2 base_tex_coordinates;\nattribute vec2 mask_tex_coordinates;\n\n// send the texture coordinates to the fragmentshader\nvarying vec2 base_tex_position;\nvarying vec2 mask_tex_position;\n\nvoid main(void) {\n\t// transform the position with the mvp matrix\n\tgl_Position = gl_ModelViewProjectionMatrix * vertex_position;\n\n\t// set the fixpoints for the tex coordinates at this vertex\n\tmask_tex_position = mask_tex_coordinates;\n\tbase_tex_position = base_tex_coordinates;\n}\n" }, { "path": "assets/shaders/equalsEpsilon.glsl", "content": "bool equalsEpsilon(vec4 left, vec4 right, float epsilon) {\n\treturn all(lessThanEqual(abs(left - right), vec4(epsilon)));\n}\n\nbool equalsEpsilon(vec3 left, vec3 right, float epsilon) {\n\treturn all(lessThanEqual(abs(left - right), vec3(epsilon)));\n}\n\nbool equalsEpsilon(vec2 left, vec2 right, float epsilon) {\n\treturn all(lessThanEqual(abs(left - right), vec2(epsilon)));\n}\n\nbool equalsEpsilon(float left, float right, float epsilon) {\n return (abs(left - right) <= epsilon);\n}\n" }, { "path": "assets/shaders/final.frag.glsl", "content": "#version 330\n\nin vec2 tex_pos;\n\nout vec4 out_col;\n\nuniform sampler2D tex;\n\nvoid main() {\n\tout_col = texture(tex, tex_pos);\n}\n" }, { "path": "assets/shaders/final.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\n\nout vec2 tex_pos;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n\ttex_pos = uv;\n}\n" }, { "path": "assets/shaders/hud_drag_select.frag.glsl", "content": "#version 330\n\n// Color of the drag rectangle\nuniform vec4 in_col;\n\nlayout(location=0) out vec4 out_col;\n\nvoid main() {\n\tout_col = in_col;\n}\n" }, { "path": "assets/shaders/hud_drag_select.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n}\n" }, { "path": "assets/shaders/identity.vert.glsl", "content": "#version 120\n\n// no-transformation texture mapping vertex shader\n\n// the position of this vertex\nattribute vec4 vertex_position;\n\n// interpolated texture coordinates sent to fragment shader\nvarying vec2 tex_position;\n\nvoid main(void) {\n\tgl_Position = vertex_position;\n\n\t// convert from screen coordinates (-1, 1) to texture coordinates (0, 1)\n\ttex_position = (vertex_position.xy + vec2(1.f)) / 2.f;\n}\n" }, { "path": "assets/shaders/maptexture.frag.glsl", "content": "#version 120\n// total basic standard texture drawing fragment shader\n\n// the texture data\nuniform sampler2D texture;\n\n// interpolated texture coordinates received from vertex shader\nvarying vec2 tex_position;\n\nvoid main (void) {\n\t// this sets the fragment color to the corresponding texel.\n\tgl_FragColor = texture2D(texture, tex_position);\n}\n" }, { "path": "assets/shaders/maptexture.vert.glsl", "content": "//total basic standard texture mapping vertex shader\n\n//modelview*projection matrix\nuniform mat4 mvp_matrix;\n\n//the position of this vertex\nattribute vec4 vertex_position;\n\n//the texture coordinates assigned to this vertex\nattribute vec2 tex_coordinates;\n\n//interpolated texture coordinates sent to fragment shader\nvarying vec2 tex_position;\n\nvoid main(void) {\n\t//transform the vertex coordinates\n\tgl_Position = gl_ModelViewProjectionMatrix * vertex_position;\n\n\t//pass the fix points for texture coordinates set at this vertex\n\ttex_position = tex_coordinates;\n}\n" }, { "path": "assets/shaders/skybox.frag.glsl", "content": "#version 330\n\nuniform vec4 in_col;\n\nlayout(location=0) out vec4 out_col;\n\nvoid main() {\n\tout_col = in_col;\n}\n" }, { "path": "assets/shaders/skybox.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n}\n" }, { "path": "assets/shaders/teamcolors.frag.glsl", "content": "//team color replacement shader\n//\n//looks for an alpha value specified by 'alpha_marker'\n//and then replaces this pixel with the desired color,\n//tinted for player_number, and using the given color as base.\n\n//the unmodified texture itself\nuniform sampler2D texture;\n\n//the desired player number the final resulting colors\nuniform int player_number;\n\n//the alpha value which marks colors to be replaced\nuniform float alpha_marker;\n\n//color entries for all players and their subcolors\nuniform vec4 player_color[NUM_OF_PLAYER_COLORS];\n\n//interpolated texture coordinates sent from vertex shader\nvarying vec2 tex_position;\n\n//create epsilon environment for float comparison\nconst float EPSILON = 0.001;\n\n//do the lookup in the player color table\n//for a playernumber (red, blue, etc)\n//get the subcolor (brightness variations)\nvec4 get_color(int playernum, int subcolor) {\n\treturn player_color[((playernum-1) * 8) + subcolor];\n}\n\nvoid main() {\n\t//get the texel from the uniform texture.\n\tvec4 pixel = texture2D(texture, tex_position);\n\n\t//check if this texel has an alpha marker, so we can replace it's rgb values.\n\tif (player_number != 1 && equalsEpsilon(pixel[3], alpha_marker, EPSILON)) {\n\t\t//try to find the base color, there are 8 of them.\n\t\tfor(int i = 0; i <= 7; i++) {\n\t\t\tif (equalsEpsilon(vec3(pixel), vec3(player_color[i]), EPSILON)) {\n\t\t\t\t//base color found, now replace it with the same color\n\t\t\t\t//but player_number tinted.\n\t\t\t\tgl_FragColor = get_color(player_number, i);\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\n\t\t//unknown base color gets pink muhahaha\n\t\tpixel = vec4(255.0/255.0, 20.0/255.0, 147.0/255.0, 1.0);\n\t}\n\n\t//else the texel had no marker so we can just draw it without player coloring\n\tgl_FragColor = pixel;\n}\n" }, { "path": "assets/shaders/terrain.frag.glsl", "content": "#version 330\n\nin vec2 tex_pos;\n\nlayout(location=0) out vec4 out_col;\n\nuniform sampler2D tex;\n\nvoid main()\n{\n vec4 tex_val = texture(tex, tex_pos);\n\tout_col = tex_val;\n}\n" }, { "path": "assets/shaders/terrain.vert.glsl", "content": "#version 330\n\nlayout (location = 0) in vec3 position;\nlayout (location = 1) in vec2 uv;\n\nout vec2 tex_pos;\n\nuniform mat4 model;\n\n// camera parameters for transforming the object position\n// and scaling the subtex to the correct size\nlayout (std140) uniform camera {\n // view matrix (world to view space)\n mat4 view;\n // projection matrix (view to clip space)\n mat4 proj;\n // inverse zoom factor (1.0 / zoom)\n float inv_zoom;\n // inverse viewport size (1.0 / viewport size)\n vec2 inv_viewport_size;\n};\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 1.0);\n tex_pos = vec2(uv.x, 1.0 - uv.y);\n}\n" }, { "path": "assets/shaders/texturefont.frag.glsl", "content": "varying vec2 tex_position;\nuniform sampler2D texture;\nuniform vec4 color;\n\nvoid main() {\n\t// Glyph's image data is stored in the RED channel of the texture\n\tfloat red = texture2D(texture, tex_position).r;\n\tif (red < 0.01) {\n\t\tdiscard;\n\t}\n\n\tgl_FragColor = color * vec4(1.0f, 1.0f, 1.0f, red);\n}\n" }, { "path": "assets/shaders/texturefont.vert.glsl", "content": "attribute vec4 vertex_position;\nattribute vec2 tex_coordinates;\nvarying vec2 tex_position;\n\nvoid main() {\n\tgl_Position = gl_ModelViewProjectionMatrix * vertex_position;\n\ttex_position = tex_coordinates;\n}\n" }, { "path": "assets/shaders/world2d.frag.glsl", "content": "#version 330\n\nin vec2 vert_uv;\n\nlayout(location=0) out vec4 col;\nlayout(location=1) out uint id;\n\nuniform sampler2D tex;\nuniform uint u_id;\n\n// position (top left corner) and size: (x, y, width, height)\nuniform vec4 tile_params;\n\nvec2 uv = vec2(\n\tvert_uv.x * tile_params.z + tile_params.x,\n\tvert_uv.y * tile_params.w + tile_params.y\n);\n\nvoid main() {\n\tvec4 tex_val = texture(tex, uv);\n\tint alpha = int(round(tex_val.a * 255));\n\tswitch (alpha) {\n\t\tcase 0:\n\t\t\tcol = tex_val;\n\t\t\tdiscard;\n\n\t\t\t// do not save the ID\n\t\t\treturn;\n\t\tcase 254:\n\t\t\tcol = vec4(1.0f, 0.0f, 0.0f, 1.0f);\n\t\t\tbreak;\n\t\tcase 252:\n\t\t\tcol = vec4(0.0f, 1.0f, 0.0f, 1.0f);\n\t\t\tbreak;\n\t\tcase 250:\n\t\t\tcol = vec4(0.0f, 0.0f, 1.0f, 1.0f);\n\t\t\tbreak;\n\t\tdefault:\n\t\t\tcol = tex_val;\n\t\t\tbreak;\n\t}\n\tid = u_id;\n}\n" }, { "path": "assets/shaders/world2d.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 v_position;\nlayout(location=1) in vec2 uv;\n\nout vec2 vert_uv;\n\n// camera parameters for transforming the object position\n// and scaling the subtex to the correct size\nlayout (std140) uniform camera {\n // view matrix (world to view space)\n mat4 view;\n // projection matrix (view to clip space)\n mat4 proj;\n // inverse zoom factor (1.0 / zoom)\n // high zoom = upscale subtex\n // low zoom = downscale subtex\n float inv_zoom;\n // inverse viewport size (1.0 / viewport size)\n vec2 inv_viewport_size;\n};\n\n// can be used to move the object position in world space _before_\n// it's transformed to clip space\n// this is usually unnecessary because we want to draw the\n// subtex where the object is, so this can be set to the identity matrix\nuniform mat4 model;\n\n// position of the object in world space\nuniform vec3 obj_world_position;\n\n// flip the subtexture horizontally/vertically\nuniform bool flip_x;\nuniform bool flip_y;\n\n// parameters for scaling and moving the subtex\n// to the correct position in clip space\n\n// animation scalefactor\n// scales the vertex positions so that they\n// match the subtex dimensions\n//\n// high animation scale = downscale subtex\n// low animation scale = upscale subtex\nuniform float scale;\n\n// size of the subtex (in pixels)\nuniform vec2 subtex_size;\n\n// offset of the subtex anchor point\n// from the subtex center (in pixels)\n// used to move the subtex so that the anchor point\n// is at the object position\nuniform vec2 anchor_offset;\n\nvoid main() {\n // translate the position of the object from world space to clip space\n // this is the position where we want to draw the subtex in 2D\n\tvec4 obj_clip_pos = proj * view * model * vec4(obj_world_position, 1.0);\n\n // subtex has to be scaled to account for the zoom factor\n // and the animation scale factor. essentially this is (animation scale / zoom).\n float zoom_scale = scale * inv_zoom;\n\n // Scale the subtex vertices\n // we have to account for the viewport size to get the correct dimensions\n // and then scale the subtex to the zoom factor to get the correct size\n vec2 vert_scale = zoom_scale * subtex_size * inv_viewport_size;\n\n // Scale the anchor offset with the same method as above\n // to get the correct anchor position in the viewport\n vec2 anchor_scale = zoom_scale * anchor_offset * inv_viewport_size;\n\n // if the subtex is flipped, we also need to flip the anchor offset\n // essentially, we invert the coordinates for the flipped axis\n float anchor_x = float(flip_x) * -1.0 * anchor_scale.x + float(!flip_x) * anchor_scale.x;\n float anchor_y = float(flip_y) * -1.0 * anchor_scale.y + float(!flip_y) * anchor_scale.y;\n\n // offset the clip position by the offset of the subtex anchor\n // imagine this as pinning the subtex to the object position at the subtex anchor point\n obj_clip_pos += vec4(anchor_x, anchor_y, 0.0, 0.0);\n\n // create a move matrix for positioning the vertices\n // uses the vert scale and the transformed object position in clip space\n mat4 move = mat4(vert_scale.x, 0.0, 0.0, 0.0,\n 0.0, vert_scale.y, 0.0, 0.0,\n 0.0, 0.0, 1.0, 0.0,\n obj_clip_pos.x, obj_clip_pos.y, obj_clip_pos.z, 1.0);\n\n // calculate the final vertex position\n gl_Position = move * vec4(v_position, 0.0, 1.0);\n\n // if the subtex is flipped, we also need to flip the uv tex coordinates\n // essentially, we invert the coordinates for the flipped axis\n\n // !flip_x is default because OpenGL uses bottom-left as its origin\n float uv_x = float(!flip_x) * uv.x + float(flip_x) * (1.0 - uv.x);\n float uv_y = float(flip_y) * uv.y + float(!flip_y) * (1.0 - uv.y);\n\n vert_uv = vec2(uv_x, uv_y);\n}\n" }, { "path": "assets/shaders/world3d.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\n\nout vec2 vert_uv;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 0.0, 1.0);\n vert_uv = vec2(uv.x, 1.0 - uv.y);\n}\n" }, { "path": "assets/test/CMakeLists.txt", "content": "# Copyright 2023-2023 the openage authors. See copying.md for legal info.\n\nadd_subdirectory(nyan/)\nadd_subdirectory(qml/)\nadd_subdirectory(shaders/)\nadd_subdirectory(textures/)\n" }, { "path": "assets/test/nyan/CMakeLists.txt", "content": "install(DIRECTORY \".\"\n\tDESTINATION \"${ASSET_DIR}/test/nyan\"\n\tFILES_MATCHING PATTERN \"*.nyan\"\n)\n" }, { "path": "assets/test/nyan/pong.nyan", "content": "!version 1\n\nPongGame():\n ball : Ball\n player1 : Player\n player2 : Player\n\nBall():\n Color():\n r : int = 0\n g : int = 200\n b : int = 0\n color : Color = Color\n\nPlayer():\n lives : int = 3\n size : int = 200\n\nGameTest(PongGame):\n ball = Ball\n player1 = Player\n player2 = Player\n\nLeftColor():\n r = 0\n g = 20\n b = 230\n\nRightColor():\n r = 180\n g = 40\n b = 0\n" }, { "path": "assets/test/qml/CMakeLists.txt", "content": "install(DIRECTORY \".\"\n\tDESTINATION \"${ASSET_DIR}/test/qml\"\n\tFILES_MATCHING PATTERN \"*.qml\"\n)\n" }, { "path": "assets/test/qml/main.qml", "content": "// Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\nimport QtQuick 2.4\nimport yay.sfttech.livereload 1.0\nimport yay.sfttech.openage 1.0 as OA\n\nItem {\n\tid: root\n\n\tRectangle {\n\t\twidth: 200\n\t\theight: 200\n\t\tcolor: \"red\"\n\n\t\tRectangle {\n\t\t\tx: 100\n\t\t\ty: 100\n\t\t\twidth: 100\n\t\t\theight: 100\n\t\t\tcolor: \"blue\"\n\n\t\t\tRectangle {\n\t\t\t\tid: r\n\t\t\t\twidth: 50\n\t\t\t\theight: 50\n\t\t\t\tcolor: \"green\"\n\t\t\t}\n\t\t}\n\n\t\tMouseArea {\n\t\t\tanchors.fill: parent\n\t\t\tonClicked: r.color = \"yellow\"\n\t\t}\n\t}\n}\n" }, { "path": "assets/test/shaders/CMakeLists.txt", "content": "install(DIRECTORY \".\"\n\tDESTINATION \"${ASSET_DIR}/test/shaders\"\n\tFILES_MATCHING PATTERN \"*.glsl\"\n)\n" }, { "path": "assets/test/shaders/demo_0_display.frag.glsl", "content": "#version 330\n\nout vec4 col;\n\nvoid main() {\n col = vec4(1.0, 0.4, 0.0, 0.8);\n}\n" }, { "path": "assets/test/shaders/demo_0_display.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/demo_1_display.frag.glsl", "content": "#version 330\n\nuniform sampler2D color_texture;\n\nin vec2 v_uv;\nout vec4 col;\n\nvoid main() {\n\tcol = texture(color_texture, v_uv);\n}\n" }, { "path": "assets/test/shaders/demo_1_display.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n\tv_uv = uv;\n}\n" }, { "path": "assets/test/shaders/demo_1_obj.frag.glsl", "content": "#version 330\n\nin vec2 v_uv;\nuniform sampler2D tex;\nuniform uint u_id;\n\nlayout(location=0) out vec4 col;\nlayout(location=1) out uint id;\n\nvoid main() {\n\tvec4 tex_val = texture(tex, v_uv);\n\tif (tex_val.a == 0) {\n\t\tdiscard;\n\t}\n\tcol = tex_val;\n\tid = u_id;\n}\n" }, { "path": "assets/test/shaders/demo_1_obj.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\nuniform mat4 mv;\nuniform mat4 proj;\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = proj * mv * vec4(position, 0.0, 1.0);\n\tv_uv = vec2(uv.x, 1.0 - uv.y);\n}\n" }, { "path": "assets/test/shaders/demo_2_display.frag.glsl", "content": "#version 330\n\nuniform sampler2D color_texture;\n\nin vec2 v_uv;\nout vec4 col;\n\nvoid main() {\n\tcol = texture(color_texture, v_uv);\n}\n" }, { "path": "assets/test/shaders/demo_2_display.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n\tv_uv = uv;\n}\n" }, { "path": "assets/test/shaders/demo_2_obj.frag.glsl", "content": "#version 330\n\nin vec2 v_uv;\nuniform sampler2D tex;\nuniform uint u_id;\n\nlayout(location=0) out vec4 col;\nlayout(location=1) out uint id;\n\nvoid main() {\n\tvec4 tex_val = texture(tex, v_uv);\n\tint alpha = int(round(tex_val.a * 255));\n\tswitch (alpha) {\n\t\tcase 0:\n\t\tdiscard;\n\t\tbreak;\n\t\tcase 254:\n\t\tcol = vec4(1.0f, 0.0f, 0.0f, 1.0f);\n\t\tbreak;\n\t\tcase 252:\n\t\tcol = vec4(0.0f, 1.0f, 0.0f, 1.0f);\n\t\tbreak;\n\t\tcase 250:\n\t\tcol = vec4(0.0f, 0.0f, 1.0f, 1.0f);\n\t\tbreak;\n\t\tdefault:\n\t col = tex_val;\n\t\tbreak;\n\t}\n\tid = u_id;\n}\n" }, { "path": "assets/test/shaders/demo_2_obj.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\n\nuniform mat4 mv;\nuniform mat4 proj;\nuniform vec4 offset_tile;\n\nfloat width = offset_tile.y - offset_tile.x;\nfloat height = offset_tile.w - offset_tile.z;\n\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = proj * mv * vec4(position, 0.0, 1.0);\n v_uv = vec2((uv.x * width) + offset_tile.x, (((1.0 - uv.y) * height) + offset_tile.z));\n}\n" }, { "path": "assets/test/shaders/demo_4_display.frag.glsl", "content": "#version 330\n\nuniform sampler2D color_texture;\n\nin vec2 v_uv;\nout vec4 col;\n\nvoid main() {\n\tcol = texture(color_texture, v_uv);\n}\n" }, { "path": "assets/test/shaders/demo_4_display.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n\tv_uv = uv;\n}\n" }, { "path": "assets/test/shaders/demo_4_obj.frag.glsl", "content": "#version 330\n\nin vec2 v_uv;\nuniform sampler2D tex;\nuniform uint u_id;\n\nlayout(location=0) out vec4 col;\nlayout(location=1) out uint id;\n\nvoid main() {\n\tvec4 tex_val = texture(tex, v_uv);\n\tint alpha = int(round(tex_val.a * 255));\n\tswitch (alpha) {\n\t\tcase 0:\n\t\tdiscard;\n\t\tbreak;\n\t\tcase 254:\n\t\tcol = vec4(1.0f, 0.0f, 0.0f, 1.0f);\n\t\tbreak;\n\t\tcase 252:\n\t\tcol = vec4(0.0f, 1.0f, 0.0f, 1.0f);\n\t\tbreak;\n\t\tcase 250:\n\t\tcol = vec4(0.0f, 0.0f, 1.0f, 1.0f);\n\t\tbreak;\n\t\tdefault:\n\t col = tex_val;\n\t\tbreak;\n\t}\n\tid = u_id;\n}\n" }, { "path": "assets/test/shaders/demo_4_obj.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\n\nuniform mat4 mv;\nuniform mat4 proj;\nuniform vec4 offset_tile;\n\nfloat width = offset_tile.y - offset_tile.x;\nfloat height = offset_tile.w - offset_tile.z;\n\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = proj * mv * vec4(position, 0.0, 1.0);\n v_uv = vec2((uv.x * width) + offset_tile.x, (((1.0 - uv.y) * height) + offset_tile.z));\n}\n" }, { "path": "assets/test/shaders/demo_5_obj.frag.glsl", "content": "#version 330\n\nin vec2 tex_pos;\n\nlayout(location=0) out vec4 out_col;\n\nuniform sampler2D tex;\n\nvoid main()\n{\n vec4 tex_val = texture(tex, tex_pos);\n\tout_col = tex_val;\n}\n" }, { "path": "assets/test/shaders/demo_5_obj.vert.glsl", "content": "#version 330\n\nlayout (location = 0) in vec3 position;\nlayout (location = 1) in vec2 uv;\n\nout vec2 tex_pos;\n\nuniform mat4 model;\n\nlayout (std140) uniform cam {\n mat4 view;\n mat4 proj;\n};\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 1.0);\n tex_pos = vec2(uv.x, 1.0 - uv.y);\n}\n" }, { "path": "assets/test/shaders/demo_6_2d.frag.glsl", "content": "#version 330\n\nin vec2 vert_uv;\n\nlayout(location=0) out vec4 col;\n\nuniform sampler2D tex;\n\n// position (top left corner) and size: (x, y, width, height)\nuniform vec4 tile_params;\n\nvec2 uv = vec2(\n\tvert_uv.x * tile_params.z + tile_params.x,\n\tvert_uv.y * tile_params.w + tile_params.y\n);\n\nvoid main() {\n\tvec4 tex_val = texture(tex, uv);\n\tint alpha = int(round(tex_val.a * 255));\n\tswitch (alpha) {\n\t\tcase 0:\n\t\t\tcol = tex_val;\n\t\t\tdiscard;\n\t\tcase 254:\n\t\t\tcol = vec4(1.0f, 0.0f, 0.0f, 1.0f);\n\t\t\tbreak;\n\t\tcase 252:\n\t\t\tcol = vec4(0.0f, 1.0f, 0.0f, 1.0f);\n\t\t\tbreak;\n\t\tcase 250:\n\t\t\tcol = vec4(0.0f, 0.0f, 1.0f, 1.0f);\n\t\t\tbreak;\n\t\tdefault:\n\t\t\tcol = tex_val;\n\t\t\tbreak;\n\t}\n}\n" }, { "path": "assets/test/shaders/demo_6_2d.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 v_position;\nlayout(location=1) in vec2 uv;\n\nout vec2 vert_uv;\n\n// camera parameters for transforming the object position\n// and scaling the subtex to the correct size\nlayout (std140) uniform camera {\n // view matrix (world to view space)\n mat4 view;\n // projection matrix (view to clip space)\n mat4 proj;\n // inverse zoom factor (1.0 / zoom)\n // high zoom = upscale subtex\n // low zoom = downscale subtex\n float inv_zoom;\n // inverse viewport size (1.0 / viewport size)\n vec2 inv_viewport_size;\n};\n\n// position of the object in world space\nuniform vec3 obj_world_position;\n\n// parameters for scaling and moving the subtex\n// to the correct position in clip space\n\n// animation scalefactor\n// scales the vertex positions so that they\n// match the subtex dimensions\n//\n// high animation scale = downscale subtex\n// low animation scale = upscale subtex\nuniform float scale;\n\n// size of the subtex (in pixels)\nuniform vec2 subtex_size;\n\n// offset of the subtex anchor point\n// from the subtex center (in pixels)\n// used to move the subtex so that the anchor point\n// is at the object position\nuniform vec2 anchor_offset;\n\nvoid main() {\n // translate the position of the object from world space to clip space\n // this is the position where we want to draw the subtex in 2D\n\tvec4 obj_clip_pos = proj * view * vec4(obj_world_position, 1.0);\n\n // subtex has to be scaled to account for the zoom factor\n // and the animation scale factor. essentially this is (animation scale / zoom).\n float zoom_scale = scale * inv_zoom;\n\n // Scale the subtex vertices\n // we have to account for the viewport size to get the correct dimensions\n // and then scale the subtex to the zoom factor to get the correct size\n vec2 vert_scale = zoom_scale * subtex_size * inv_viewport_size;\n\n // Scale the anchor offset with the same method as above\n // to get the correct anchor position in the viewport\n vec2 anchor_scale = zoom_scale * anchor_offset * inv_viewport_size;\n\n // offset the clip position by the offset of the subtex anchor\n // imagine this as pinning the subtex to the object position at the subtex anchor point\n obj_clip_pos += vec4(anchor_scale.x, anchor_scale.y, 0.0, 0.0);\n\n // create a move matrix for positioning the vertices\n // uses the vert scale and the transformed object position in clip space\n mat4 move = mat4(vert_scale.x, 0.0, 0.0, 0.0,\n 0.0, vert_scale.y, 0.0, 0.0,\n 0.0, 0.0, 1.0, 0.0,\n obj_clip_pos.x, obj_clip_pos.y, obj_clip_pos.z, 1.0);\n\n // calculate the final vertex position\n gl_Position = move * vec4(v_position, 0.0, 1.0);\n\n // flip y axis because OpenGL uses bottom-left as its origin\n float uv_x = uv.x;\n float uv_y = 1.0 - uv.y;\n\n vert_uv = vec2(uv_x, uv_y);\n}\n" }, { "path": "assets/test/shaders/demo_6_2d_frame.frag.glsl", "content": "#version 330\n\nout vec4 outcol;\n\nuniform vec4 incol;\n\nvoid main() {\n outcol = incol;\n}\n" }, { "path": "assets/test/shaders/demo_6_2d_frame.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 v_position;\n\n// camera parameters for transforming the object position\n// and scaling the subtex to the correct size\nlayout (std140) uniform camera {\n // view matrix (world to view space)\n mat4 view;\n // projection matrix (view to clip space)\n mat4 proj;\n // inverse zoom factor (1.0 / zoom)\n float inv_zoom;\n // inverse viewport size (1.0 / viewport size)\n vec2 inv_viewport_size;\n};\n\n// position of the object in world space\nuniform vec3 obj_world_position;\n\n// parameters for scaling and moving the subtex\n// to the correct position in clip space\n\n// animation scalefactor\n// scales the vertex positions so that they\n// match the subtex dimensions\n//\n// high animation scale = downscale subtex\n// low animation scale = upscale subtex\nuniform float scale;\n\n// size of the frame (in pixels)\nuniform vec2 frame_size;\n\nvoid main() {\n // translate the position of the object from world space to clip space\n // this is the position where we want to draw the subtex in 2D\n\tvec4 obj_clip_pos = proj * view * vec4(obj_world_position, 1.0);\n\n // subtex has to be scaled to account for the zoom factor\n // and the animation scale factor. essentially this is (animation scale / zoom).\n float zoom_scale = scale * inv_zoom;\n\n // Scale the subtex vertices\n // we have to account for the viewport size to get the correct dimensions\n // and then scale the frame to the zoom factor to get the correct size\n vec2 vert_scale = zoom_scale * frame_size * inv_viewport_size;\n\n // create a move matrix for positioning the vertices\n // uses the vert scale and the transformed object position in clip space\n mat4 move = mat4(vert_scale.x, 0.0, 0.0, 0.0,\n 0.0, vert_scale.y, 0.0, 0.0,\n 0.0, 0.0, 1.0, 0.0,\n obj_clip_pos.x, obj_clip_pos.y, obj_clip_pos.z, 1.0);\n\n // calculate the final vertex position\n gl_Position = move * vec4(v_position, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/demo_6_2d_frustum_frame.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 v_position;\n\nvoid main() {\n // flip the y coordinate in OpenGL\n gl_Position = vec4(v_position.x, v_position.y, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/demo_6_3d.frag.glsl", "content": "#version 330\n\nin vec2 tex_pos;\n\nlayout(location=0) out vec4 out_col;\n\nuniform sampler2D tex;\n\nvoid main()\n{\n vec4 tex_val = texture(tex, tex_pos);\n\tout_col = tex_val;\n}\n" }, { "path": "assets/test/shaders/demo_6_3d.vert.glsl", "content": "#version 330\n\nlayout (location = 0) in vec3 position;\nlayout (location = 1) in vec2 uv;\n\nout vec2 tex_pos;\n\n// camera parameters for transforming the object position\n// and scaling the subtex to the correct size\nlayout (std140) uniform camera {\n // view matrix (world to view space)\n mat4 view;\n // projection matrix (view to clip space)\n mat4 proj;\n // inverse zoom factor (1.0 / zoom)\n float inv_zoom;\n // inverse viewport size (1.0 / viewport size)\n vec2 inv_viewport_size;\n};\n\nvoid main() {\n\tgl_Position = proj * view * vec4(position, 1.0);\n tex_pos = vec2(uv.x, 1.0 - uv.y);\n}\n" }, { "path": "assets/test/shaders/demo_6_display.frag.glsl", "content": "#version 330\n\nuniform sampler2D color_texture;\n\nin vec2 v_uv;\nout vec4 col;\n\nvoid main() {\n\tcol = texture(color_texture, v_uv);\n}\n" }, { "path": "assets/test/shaders/demo_6_display.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n\tv_uv = uv;\n}\n" }, { "path": "assets/test/shaders/demo_7_shader_command.frag.glsl", "content": "#version 330\n\nin vec2 tex_coord;\nout vec4 frag_color;\n\nuniform float time;\n\nvoid main() {\n\t// PLACEHOLDER: color\n\t// PLACEHOLDER: alpha\n\tfrag_color = vec4(r, g, b, alpha);\n}\n" }, { "path": "assets/test/shaders/demo_7_shader_command.vert.glsl", "content": "#version 330\n\nin vec2 position;\nout vec2 tex_coord;\n\nvoid main() {\n\ttex_coord = position.xy * 0.5 + 0.5;\n\tgl_Position = vec4(position.xy, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/demo_7_snippets/alpha.snippet", "content": "float alpha = (sin(time) + 1.0) * 0.5;\n" }, { "path": "assets/test/shaders/demo_7_snippets/color.snippet", "content": "float r = 0.5 + 0.5 * sin(time);\nfloat g = 0.5 + 0.5 * sin(time + 2.0);\nfloat b = 0.5 + 0.5 * sin(time + 4.0);\n" }, { "path": "assets/test/shaders/pathfinding/CMakeLists.txt", "content": "install(DIRECTORY \".\"\n\tDESTINATION \"${ASSET_DIR}/test/shaders/pathfinding\"\n\tFILES_MATCHING PATTERN \"*.glsl\"\n)\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_cost_field.frag.glsl", "content": "#version 330\n\nin float v_cost;\n\nout vec4 out_col;\n\nvoid main()\n{\n if (v_cost == 255.0) {\n out_col = vec4(0.0, 0.0, 0.0, 1.0);\n return;\n }\n float cost = (v_cost / 256) * 2.0;\n float red = clamp(cost, 0.0, 1.0);\n float green = clamp(2.0 - cost, 0.0, 1.0);\n\tout_col = vec4(red, green, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_cost_field.vert.glsl", "content": "#version 330\n\nlayout (location = 0) in vec3 position;\nlayout (location = 1) in float cost;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nout float v_cost;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 1.0);\n v_cost = cost;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_display.frag.glsl", "content": "#version 330\n\nuniform sampler2D color_texture;\n\nin vec2 v_uv;\nout vec4 col;\n\nvoid main() {\n\tcol = texture(color_texture, v_uv);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_display.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n\tv_uv = uv;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_flow_field.frag.glsl", "content": "#version 330\n\n/// Flow field value\nin float flow_val;\n\n/// Integration field flags\nin float int_val;\n\nout vec4 outcol;\n\nint WAVEFRONT_BLOCKED = 0x04;\nint LINE_OF_SIGHT = 0x20;\nint PATHABLE = 0x10;\n\nvoid main() {\n int flow_flags = int(flow_val) & 0xF0;\n int int_flags = int(int_val);\n if (bool(int_flags & WAVEFRONT_BLOCKED)) {\n // wavefront blocked\n outcol = vec4(0.9, 0.9, 0.9, 1.0);\n return;\n }\n\n if (bool(int_flags & LINE_OF_SIGHT)) {\n // line of sight\n outcol = vec4(1.0, 1.0, 1.0, 1.0);\n return;\n }\n\n if (bool(flow_flags & PATHABLE)) {\n // pathable\n outcol = vec4(0.7, 0.7, 0.7, 1.0);\n return;\n }\n\n // not pathable\n outcol = vec4(0.0, 0.0, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_flow_field.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec3 position;\nlayout(location=1) in float flow_cell;\nlayout(location=2) in float int_cell;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nout float flow_val;\nout float int_val;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 1.0);\n flow_val = flow_cell;\n int_val = int_cell;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_grid.frag.glsl", "content": "#version 330\n\nout vec4 out_col;\n\nvoid main()\n{\n\tout_col = vec4(0.0, 0.0, 0.0, 0.3);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_grid.vert.glsl", "content": "#version 330\n\nlayout (location = 0) in vec3 position;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 1.0);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_integration_field.frag.glsl", "content": "#version 330\n\nin float v_cost;\n\nout vec4 out_col;\n\nvoid main()\n{\n if (v_cost > 512.0) {\n out_col = vec4(0.0, 0.0, 0.0, 1.0);\n return;\n }\n float cost = 0.05 * v_cost;\n float green = clamp(1.0 - cost, 0.0, 1.0);\n\tout_col = vec4(0.75, green, 0.5, 1.0);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_integration_field.vert.glsl", "content": "#version 330\n\nlayout (location = 0) in vec3 position;\nlayout (location = 1) in float cost;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nout float v_cost;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 1.0);\n v_cost = cost;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_obj.frag.glsl", "content": "#version 330\n\nuniform vec4 color;\n\nout vec4 outcol;\n\nvoid main() {\n outcol = color;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_obj.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_vector.frag.glsl", "content": "#version 330\n\nuniform vec4 color;\n\nout vec4 outcol;\n\nvoid main() {\n outcol = color;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_0_vector.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec3 position;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 1.0);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_1_display.frag.glsl", "content": "#version 330\n\nuniform sampler2D color_texture;\n\nin vec2 v_uv;\nout vec4 col;\n\nvoid main() {\n\tcol = texture(color_texture, v_uv);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_1_display.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\nlayout(location=1) in vec2 uv;\nout vec2 v_uv;\n\nvoid main() {\n\tgl_Position = vec4(position, 0.0, 1.0);\n\tv_uv = uv;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_1_grid.frag.glsl", "content": "#version 330\n\nout vec4 out_col;\n\nvoid main()\n{\n\tout_col = vec4(0.0, 0.0, 0.0, 0.3);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_1_grid.vert.glsl", "content": "#version 330\n\nlayout (location = 0) in vec2 position;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 0.0, 1.0);\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_1_obj.frag.glsl", "content": "#version 330\n\nuniform vec4 color;\n\nout vec4 outcol;\n\nvoid main() {\n outcol = color;\n}\n" }, { "path": "assets/test/shaders/pathfinding/demo_1_obj.vert.glsl", "content": "#version 330\n\nlayout(location=0) in vec2 position;\n\nuniform mat4 model;\nuniform mat4 view;\nuniform mat4 proj;\n\nvoid main() {\n\tgl_Position = proj * view * model * vec4(position, 0.0, 1.0);\n}\n" }, { "path": "assets/test/textures/CMakeLists.txt", "content": "install(DIRECTORY \".\"\n\tDESTINATION \"${ASSET_DIR}/test/textures\"\n\tPATTERN \"CMakeLists.txt\" EXCLUDE\n)\n" }, { "path": "assets/test/textures/test_animation.sprite", "content": "# Copyright 2021-2021 the openage authors. See copying.md for legal info.\n# openage sprite definition file\n\nversion 2\n\ntexture 0 \"test_texture.texture\"\n\nscalefactor 1.0\n\nlayer 0 mode=loop position=20 time_per_frame=0.125\n\nangle 0\n\nframe 0 0 0 0 0\nframe 1 0 0 0 1\nframe 2 0 0 0 2\nframe 3 0 0 0 3\nframe 4 0 0 0 4\nframe 5 0 0 0 5\nframe 6 0 0 0 6\nframe 7 0 0 0 7\nframe 8 0 0 0 8\nframe 9 0 0 0 9\nframe 10 0 0 0 10\nframe 11 0 0 0 11\nframe 12 0 0 0 12\nframe 13 0 0 0 13\nframe 14 0 0 0 14\nframe 15 0 0 0 15\nframe 16 0 0 0 16\nframe 17 0 0 0 17\n" }, { "path": "assets/test/textures/test_gaben.sprite", "content": "# Copyright 2023-2023 the openage authors. See copying.md for legal info.\n# openage sprite definition file\n\nversion 2\n\ntexture 0 \"test_gaben.texture\"\n\nscalefactor 0.2\n\nlayer 0 mode=once\n\nangle 0\n\nframe 0 0 0 0 0\n" }, { "path": "assets/test/textures/test_gaben.texture", "content": "# Copyright 2023-2023 the openage authors.\n# openage texture definition file\n\nversion 1\n\nimagefile \"gaben.png\"\n\nsize 719 1073\n\npxformat rgba8 cbits=True\n\nsubtex 0 0 719 1073 359 1000\n" }, { "path": "assets/test/textures/test_missing.sprite", "content": "# Copyright 2023-2023 the openage authors. See copying.md for legal info.\n# openage sprite definition file\n\nversion 2\n\ntexture 0 \"test_missing.texture\"\n\nscalefactor 1.0\n\nlayer 0 mode=once\n\nangle 0\n\nframe 0 0 0 0 0\n" }, { "path": "assets/test/textures/test_missing.texture", "content": "# Copyright 2023-2023 the openage authors.\n# openage texture definition file\n\nversion 1\n\nimagefile \"missing.png\"\n\nsize 32 32\n\npxformat rgba8 cbits=True\n\nsubtex 0 0 32 32 16 16\n" }, { "path": "assets/test/textures/test_tank.sprite", "content": "# Copyright 2023-2023 the openage authors. See copying.md for legal info.\n# openage sprite definition file\n\nversion 2\n\ntexture 0 \"test_tank.texture\"\n\nscalefactor 2.0\n\nlayer 0 mode=off\n\nangle 0\nangle 45\nangle 90\nangle 135\nangle 180\nangle 225\nangle 270\nangle 315\n\nframe 0 0 0 0 0\nframe 0 45 0 0 1\nframe 0 90 0 0 2\nframe 0 135 0 0 3\nframe 0 180 0 0 4\nframe 0 225 0 0 5\nframe 0 270 0 0 6\nframe 0 315 0 0 7\n" }, { "path": "assets/test/textures/test_tank.texture", "content": "# The image file was adapted from the \"German WW2 isometric pixel tanks\" sprite pack,\n# Copyright 2020-2020 by jh2assets.\n#\n# It's licensed under the terms of the Creative Commons Attribution v4.0 International license.\n# (https://creativecommons.org/licenses/by/4.0/)\n#\n# The original version can be found at:\n# https://jimhatama.itch.io/german-ww2-pixel-tanks\n#\n# Modifications by us:\n# - Merged sprites from the \"german_panzer4\" animation into one spritesheet\n#\n# Copyright 2023-2023 the openage authors.\n# openage texture definition file\n\nversion 1\n\nimagefile \"test_tank.png\"\n\nsize 153 178\n\npxformat rgba8 cbits=False\n\nsubtex 109 101 32 45 16 22\nsubtex 81 55 68 44 34 22\nsubtex 1 40 78 37 39 18\nsubtex 82 1 70 52 35 26\nsubtex 73 101 34 54 17 27\nsubtex 1 79 70 51 35 25\nsubtex 1 1 79 37 38 18\nsubtex 1 132 68 45 34 22\n" }, { "path": "assets/test/textures/test_tank_mirrored.sprite", "content": "# Copyright 2023-2023 the openage authors. See copying.md for legal info.\n# openage sprite definition file\n\nversion 2\n\ntexture 0 \"test_tank.texture\"\n\nscalefactor 2.0\n\nlayer 0 mode=off\n\nangle 0\nangle 45\nangle 90\nangle 135\nangle 180\nangle 225 mirror_from=135\nangle 270 mirror_from=90\nangle 315 mirror_from=45\n\nframe 0 0 0 0 0\nframe 0 45 0 0 1\nframe 0 90 0 0 2\nframe 0 135 0 0 3\nframe 0 180 0 0 4\n" }, { "path": "assets/test/textures/test_terrain.terrain", "content": "# Copyright 2023-2023 the openage authors. See copying.md for legal info.\n# openage terrain definition file\n\nversion 2\n\ntexture 0 \"test_terrain.texture\"\n\nscalefactor 1.0\n\nlayer 0\n\nframe 0 0 0 0\n" }, { "path": "assets/test/textures/test_terrain.texture", "content": "# Copyright 2023-2023 the openage authors.\n# openage texture definition file\n\nversion 1\n\nimagefile \"test_terrain.png\"\n\nsize 500 500\n\npxformat rgba8 cbits=True\n\nsubtex 0 0 500 500 0 0\n" }, { "path": "assets/test/textures/test_terrain2.terrain", "content": "# Copyright 2023-2023 the openage authors. See copying.md for legal info.\n# openage terrain definition file\n\nversion 2\n\ntexture 0 \"test_terrain2.texture\"\n\nscalefactor 1.0\n\nlayer 0\n\nframe 0 0 0 0\n" }, { "path": "assets/test/textures/test_terrain2.texture", "content": "# Copyright 2023-2023 the openage authors.\n# openage texture definition file\n\nversion 1\n\nimagefile \"test_terrain2.png\"\n\nsize 500 500\n\npxformat rgba8 cbits=True\n\nsubtex 0 0 500 500 0 0\n" }, { "path": "assets/test/textures/test_texture.texture", "content": "# The image file was adapted from the \"Elemental Ground Monk\" sprite pack,\n# Copyright 2021-2021 by chierit.\n#\n# It's licensed under the terms of the Creative Commons Attribution v4.0 International license.\n# (https://creativecommons.org/licenses/by/4.0/)\n#\n# The original version can be found at:\n# https://chierit.itch.io/elementals-ground-monk\n#\n# Modifications by us:\n# - Extracted sprites from the \"3_atk\" animation\n# - Added an outline to the monk with the openage outline colour command (RGBA: 0,0,0,252)\n# - Changed orange colour (239,105,47,255) with the openage playercolor colour command (RGBA: 239,105,47,254)\n#\n# Copyright 2021-2021 the openage authors.\n# See copying.md for further legal info.\n\n# openage texture definition file\n\nversion 1\n\nimagefile \"test_texture.png\"\n\nsize 208 160\n\npxformat rgba8 cbits=True\n\nsubtex 0 0 28 39 0 0\nsubtex 28 0 27 37 0 0\nsubtex 55 0 36 38 0 0\nsubtex 91 0 40 36 0 0\nsubtex 91 36 42 37 0 0\nsubtex 0 73 33 42 0 0\nsubtex 33 73 36 46 0 0\nsubtex 69 73 35 37 0 0\nsubtex 131 0 28 33 0 0\nsubtex 133 33 27 45 0 0\nsubtex 104 78 28 46 0 0\nsubtex 0 124 47 31 0 0\nsubtex 160 0 48 41 0 0\nsubtex 160 41 48 41 0 0\nsubtex 132 82 48 41 0 0\nsubtex 47 123 51 37 0 0\nsubtex 0 41 55 31 0 0\nsubtex 132 123 48 31 0 0\n" }, { "path": "assets/textures/CMakeLists.txt", "content": "install(DIRECTORY \".\"\n\tDESTINATION \"${ASSET_DIR}/textures\"\n\tPATTERN \"CMakeLists.txt\" EXCLUDE\n)\n" }, { "path": "assets/textures/torn_paper_edge.docx", "content": "# x,y,w,h,cx,cy\n0,0,512,16,0,0\n" }, { "path": "buildsystem/CheckCompilerFeatures.cmake", "content": "# Copyright 2015-2021 the openage authors. See copying.md for legal info.\n\ninclude(CheckCXXSourceRuns)\n\nif(cxx_thread_local IN_LIST CMAKE_CXX_COMPILE_FEATURES)\n\tset(HAVE_THREAD_LOCAL_STORAGE true)\nelse()\n\tset(HAVE_THREAD_LOCAL_STORAGE false)\nendif()\n\ncheck_cxx_source_runs(\"\n#include \n#include \n\nclass Cat {\npublic:\n\tvirtual int maunz() const { return 42; };\n\n\tauto operator <=>(const Cat &other) const = default;\n};\n\ntemplate \nconcept Meowable = std::same_as || std::derived_from;\n\ntemplate \nint meow(const T &cat) {\n\treturn cat.maunz();\n}\n\nclass HouseCat : public Cat {\npublic:\n\tint maunz() const override { return 1337; };\n};\n\nint main() {\n\tHouseCat mrr{};\n\tCat rrarrr{};\n\treturn meow(mrr) > meow(rrarrr) ? 0 : 1;\n}\n\"\nHAVE_REQUIRED_CXX20_SUPPORT\n)\n\nif(NOT HAVE_REQUIRED_CXX20_SUPPORT)\n\tmessage(\"\n\nThe compiler doesn't support required C++20 features:\n * Concepts\n * Default comparisons\nThe following versions support these features:\n * clang++ >= 10\n * g++ >= 10\n * Microsoft Visual Studio 2019 >= 16.8\nPlease upgrade your compiler to build openage.\n\n\")\n\tmessage(FATAL_ERROR \"aborting\")\nendif()\n" }, { "path": "buildsystem/CheckInSourceBuild.cmake", "content": "# Copyright 2015-2018 the openage authors. See copying.md for legal info.\n\nif(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})\n\tif(ALLOW_IN_SOURCE_BUILD)\n\t\tmessage(\"in-source build\")\n\telse()\n\t\tmessage(\"\n\n\nIn-source builds are disallowed. They are a source of infinite pain,\n- cluttering up the source folder\n- causing cmake to silently refuse creating out-of-source builds\n- overwriting the root Makefile (which contains cleaninsourcebuild)\n\nTo perform an out-of-source build,\n- mkdir bin; cd bin; cmake ..\n- or use ./configure, which will do this automatically\n\nIf you really want to perform an in-source build, use -DALLOW_IN_SOURCE_BUILD=TRUE\n\nYou need to run 'make cleaninsourcebuild' right now, since this (failed)\nattempt already produced traces of an in-source build.\ncmake will attempt in-source-builds instead of regular ones until you clean\nthose traces (remove CMakeCache.txt and CMakeFiles).\n\n\n\n\")\n\t\tmessage(FATAL_ERROR \"aborting\")\n\tendif()\nelse()\n\t# Check if the source directory has a generated file.\n\tif (EXISTS ${CMAKE_SOURCE_DIR}/openage/config.py)\n\t\t# Clean the generated files from the source directory.\n\t\texecute_process(\n\t\t\tCOMMAND git clean -Xf -- libopenage/ openage/\n\t\t\tWORKING_DIRECTORY ${CMAKE_SOURCE_DIR})\n\tendif()\nendif()\n" }, { "path": "buildsystem/CheckRuntimeDependencies.cmake", "content": "# Copyright 2015-2023 the openage authors. See copying.md for legal info.\n\n# python modules\n# a list of imported modules may be obtained via\n#\n# grep -RE '^ *(import |from [^.])' | cut -d: -f2- | \\\n# sed 's/^ *//g' | sort -u | grep -v openage\nset(REQUIRED_PYTHON_MODULES \"PIL.Image\" \"PIL.ImageDraw\" \"numpy\" \"pygments\" \"mako.template\" \"toml\" \"lz4\")\n\n# command-line tools\n# example: set(REQUIRED_UTILITIES \"foobar\")\n\n# Checks if the specified python module exists\n#\n# check_python_module_exists( )\n# : The python module.\n# : TRUE of FALSE based on the check.\nfunction(check_python_module_exists MODULE EXISTS)\n\tset(STATEMENT \"from importlib import import_module; import_module(\\\"${MODULE}\\\")\")\n\texecute_process(\n\t\tCOMMAND ${PYTHON} -c \"${STATEMENT}\"\n\t\tRESULT_VARIABLE PY_RESULT)\n\n\tif(PY_RESULT EQUAL 0)\n\t\tset(${EXISTS} TRUE PARENT_SCOPE)\n\telse()\n\t\tset(${EXISTS} FALSE PARENT_SCOPE)\n\tendif()\nendfunction()\n\n# loop through all required python modules to find them\nforeach(_PYTHON_MODULE ${REQUIRED_PYTHON_MODULES})\n\tif(\"${PY_MOD_${_PYTHON_MODULE}_EXISTS}\" STREQUAL \"FOUND\")\n\t\tcontinue()\n\tendif()\n\n\tcheck_python_module_exists(${_PYTHON_MODULE} EXISTS)\n\n\tif(EXISTS)\n\t\tmessage(STATUS \"Checking python3 module ${_PYTHON_MODULE} - Success\")\n\t\tset(PY_MOD_${_PYTHON_MODULE}_EXISTS \"FOUND\" CACHE INTERNAL \"Python module availability\")\n\telse()\n\t\tmessage(FATAL_ERROR \"Checking python3 module ${_PYTHON_MODULE} - Not Found\")\n\tendif()\nendforeach()\n\n# loop through all required utilities to find them\nforeach(_UTILITY ${REQUIRED_UTILITIES})\n\tif(\"${UTILITY_${_UTILITY}_EXISTS}\" STREQUAL \"FOUND\")\n\t\tcontinue()\n\tendif()\n\n\tfind_program(${_UTILITY}_EXECUTABLE\n\t\tNAMES \"${_UTILITY}\"\n\t)\n\n\tif(${_UTILITY}_EXECUTABLE)\n\t\tmessage(STATUS \"Checking utility program ${_UTILITY} - Success\")\n\t\tset(UTILITY_${_UTILITY}_EXISTS \"FOUND\" CACHE INTERNAL \"Helper program availability\")\n\telse()\n\t\tmessage(FATAL_ERROR \"Checking utility program ${_UTILITY} - Not Found\")\n\tendif()\nendforeach()\n" }, { "path": "buildsystem/DependencyFetch.cmake", "content": "# Copyright 2017-2017 the openage authors. See copying.md for legal info.\n\n# Fetch project with given name from the Internet.\n# Basically wraps ExternalProject and does a nested cmake invocation.\n#\n# Usage:\n# fetch_project(\n# NAME ${projectname}\n# [DISABLE_UPDATES]\n# ${locationspecification...}\n# )\n#\n# Arguments:\n# NAME -- custom name of the project\n# DISABLE_UPDATES -- when set, don't do automatic git updates\n# locationspecification -- passed to ExternalProject_Add\n#\n# sets in caller scope:\n# ${projectname}_SOURCE_DIR -- subproject source directory\n# ${projectname}_BINARY_DIR -- subproject binary directory\n# ${projectname}_SUBPROJ_DIR -- everything of the subproject\n# -- (including src and bin directory)\n#\n# You need to specify the location with options of\n# ExternalProject_Add, for example:\n#\n# fetch_project(\n# NAME yourmom\n# GIT_REPOSITORY https://github.com/nevergonna/giveyouup\n# GIT_TAG origin/master\n# )\n#\nfunction(fetch_project)\n\tcmake_parse_arguments(PROJ \"DISABLE_UPDATES\" \"NAME\" \"\" ${ARGN})\n\n\tif(PROJ_NAME STREQUAL \"\")\n\t\tmessage(FATAL_ERROR \"no project name given\")\n\tendif()\n\n\tset(PROJ_DIR \"${CMAKE_BINARY_DIR}/${PROJ_NAME}-external\")\n\tset(PROJ_DL_DIR \"${PROJ_DIR}/dl\")\n\tset(PROJ_SRC_DIR \"${PROJ_DIR}/source\")\n\tset(PROJ_BIN_DIR \"${PROJ_DIR}/bin\")\n\tset(PROJ_STAMP_DIR \"${PROJ_DIR}/stamp\")\n\n\t# CLion creates this file for multiple projects\n\tfile(REMOVE \"${PROJ_DL_DIR}/CMakeCache.txt\")\n\n\t# create the ExternalProject configuration file\n\t# for the nested cmake call.\n\tconfigure_file(\n\t\t\"${BUILDSYSTEM_DIR}/templates/ExternalFetch.cmake.in\"\n\t\t\"${PROJ_DL_DIR}/CMakeLists.txt\"\n\t\t@ONLY\n\t)\n\n\t# run cmake to \"configure\" the external project.\n\t# this prepares the download that will be done in the next step.\n\texecute_process(COMMAND\n\t\t${CMAKE_COMMAND}\n\t\t\"-G${CMAKE_GENERATOR}\"\n\t\t\"-DCMAKE_MAKE_PROGRAM:FILE=${CMAKE_MAKE_PROGRAM}\"\n\t\t.\n\t\tOUTPUT_QUIET\n\t\tRESULT_VARIABLE config_ok\n\t\tWORKING_DIRECTORY \"${PROJ_DL_DIR}\"\n\t)\n\n\tif(config_ok)\n\t\tmessage(FATAL_ERROR \"Failed to set up external project ${PROJ_NAME}\")\n\tendif()\n\n\t# Now actually download the project.\n\t# This does not \"build\" it! The \"build\" is the download execution.\n\texecute_process(COMMAND\n\t\t${CMAKE_COMMAND} --build .\n\t\tOUTPUT_QUIET\n\t\tRESULT_VARIABLE download_ok\n\t\tWORKING_DIRECTORY \"${PROJ_DL_DIR}\"\n\t)\n\n\tif(download_ok)\n\t\tmessage(FATAL_ERROR \"Failed to download external project ${PROJ_NAME}.\")\n\tendif()\n\n\tset(${PROJ_NAME}_SOURCE_DIR \"${PROJ_SRC_DIR}\" PARENT_SCOPE)\n\tset(${PROJ_NAME}_BINARY_DIR \"${PROJ_BIN_DIR}\" PARENT_SCOPE)\n\tset(${PROJ_NAME}_SUBPROJ_DIR \"${PROJ_DIR}\" PARENT_SCOPE)\nendfunction()\n" }, { "path": "buildsystem/DetectProjectVersion.cmake", "content": "# Copyright 2015-2023 the openage authors. See copying.md for legal info.\n\n# Determines the version of the project\n# stores a full version string with commit hash and number in the variable `PROJECT_VERSION`\n\n# If the project version was already defined or previously retrieved, don't bother.\nif(PROJECT_VERSION)\n\treturn()\nendif()\n\n# if .git exists, try running git describe\nif(IS_DIRECTORY \"${CMAKE_SOURCE_DIR}/.git\")\n\tmessage(STATUS \"Set PROJECT_VERSION from git.\")\n\texecute_process(\n\t\tCOMMAND git describe --tags --long\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t\tRESULT_VARIABLE _RES\n\t\tOUTPUT_VARIABLE PROJECT_VERSION\n\t\tERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE\n\t)\n\n\tif(_RES EQUAL 0)\n\t\tset(USED_GIT_VERSION 1)\n\t\treturn()\n\tendif()\nendif()\n\n# Fallback for downloaded zip's or git unavailability\nset(PROJECT_VERSION_FILE \"${CMAKE_SOURCE_DIR}/openage_version\")\nif(EXISTS ${PROJECT_VERSION_FILE})\n\tfile(STRINGS ${PROJECT_VERSION_FILE} FILE_DESCRIBE_VERSION)\n\n\tSTRING(REGEX REPLACE \"([0-9]+\\\\.[0-9]+\\\\.[0-9]+)\"\n\t\t \"\\\\1\" PROJECT_VERSION \"${FILE_DESCRIBE_VERSION}\")\nendif()\n\n# Still could not detect the version. Don't worry, raise a warning (shout a curse word?) and move on.\nif(NOT PROJECT_VERSION)\n\tmessage(WARNING \"Could not determine project version.\")\n\tset(PROJECT_VERSION \"0.0\")\nendif()\n" }, { "path": "buildsystem/HandleCXXOptions.cmake", "content": "# Copyright 2015-2023 the openage authors. See copying.md for legal info.\n\n# sets CXXFLAGS and compiler for the project\n\n#TODO: integrate PGO (profile-guided optimization) build\n\n\ninclude(CheckCXXCompilerFlag)\n\nmacro(set_compiler_version_flags TYPE MINIMAL FLAGS INVERS EQTYPE)\n\tif(${INVERS} CMAKE_CXX_COMPILER_VERSION VERSION_${EQTYPE} ${MINIMAL})\n\t\tif(${TYPE} STREQUAL \"CXX\")\n\t\t\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} ${FLAGS}\")\n\t\telseif(${TYPE} STREQUAL \"EXTRA\")\n\t\t\tset(EXTRA_FLAGS \"${EXTRA_FLAGS} ${FLAGS}\")\n\t\telse()\n\t\t\tmessage(FATAL_ERROR \"Invalid compiler flag type specified!\")\n\t\tendif()\n\tendif()\nendmacro()\n\nmacro(set_compiler_greater_flags TYPE MINIMAL FLAGS)\n\tset_compiler_version_flags(${TYPE} ${MINIMAL} ${FLAGS} NOT LESS)\nendmacro()\n\nmacro(set_compiler_equal_flags TYPE MINIMAL FLAGS)\n\tset_compiler_version_flags(${TYPE} ${MINIMAL} ${FLAGS} \"\" EQUAL)\nendmacro()\n\nmacro(set_compiler_flags TYPE FLAGS)\n\tset_compiler_version_flags(${TYPE} \"0.0\" ${FLAGS} \"\" GREATER)\nendmacro()\n\nmacro(test_compiler_flag_apply TYPE FLAG NAME DONTRUN)\n\tif(NOT ${DONTRUN})\n\t\tcheck_cxx_compiler_flag(\"${FLAG}\" ${NAME})\n\t\tif(${NAME})\n\t\t\tset_compiler_flags(${TYPE} \"${FLAG}\")\n\t\tendif()\n\tendif()\nendmacro()\n\nmacro(set_linker_flags FLAGS)\n\tset(CMAKE_EXE_LINKER_FLAGS \"${CMAKE_EXE_LINKER_FLAGS} ${FLAGS}\")\n\tset(CMAKE_MODULE_LINKER_FLAGS \"${CMAKE_MODULE_LINKER_FLAGS} ${FLAGS}\")\n\tset(CMAKE_SHARED_LINKER_FLAGS \"${CMAKE_SHARED_LINKER_FLAGS} ${FLAGS}\")\n\tset(CMAKE_STATIC_LINKER_FLAGS \"${CMAKE_STATIC_LINKER_FLAGS} ${FLAGS}\")\nendmacro()\n\nmacro(set_cxx_optimize_flags FLAGS)\n\tset(${BUILD_TYPE_CXX_FLAGS} \"${${BUILD_TYPE_CXX_FLAGS}} ${FLAGS}\")\nendmacro()\n\n\nset(CMAKE_EXPORT_COMPILE_COMMANDS ON)\nif(NOT MSVC)\n\tset(EXTRA_FLAGS \"${EXTRA_FLAGS} -Wall -Wextra -pedantic\")\nendif()\n\n# set up gold linker features\nmacro(try_enable_gold_linker)\n\t# Activate ld.gold instead of the default\n\toption(USE_LD_GOLD \"Use GNU gold linker\" ON)\n\tif(USE_LD_GOLD)\n\t\tif(MINGW)\n\t\t\texecute_process(COMMAND ${CMAKE_CXX_COMPILER} -Wl,--major-image-version,0,--minor-image-version,0 -fuse-ld=gold -Wl,--version ERROR_QUIET OUTPUT_VARIABLE LD_VERSION)\n\t\telse()\n\t\t\texecute_process(COMMAND ${CMAKE_CXX_COMPILER} -fuse-ld=gold -Wl,--version ERROR_QUIET OUTPUT_VARIABLE LD_VERSION)\n\t\tendif()\n\t\tif(\"${LD_VERSION}\" MATCHES \"GNU gold\")\n\t\t\tset(HAVE_LD_GOLD TRUE)\n\t\t\tset_linker_flags(\"-fuse-ld=gold\")\n\t\telse()\n\t\t\tset(HAVE_LD_GOLD FALSE)\n\t\t\tmessage(WARNING \"GNU gold linker isn't available, using the default system linker.\")\n\t\tendif()\n\tendif()\n\n\t# do splitdebug by default when in debug mode\n\tset(DEBUG_FISSION_DEFAULT OFF)\n\tif(HAVE_LD_GOLD AND CMAKE_BUILD_TYPE STREQUAL \"Debug\")\n\t\tcheck_cxx_compiler_flag(\"-gsplit-dwarf\" HAVE_GSPLIT_DWARF_SUPPORT)\n\t\tif(HAVE_GSPLIT_DWARF_SUPPORT)\n\t\t\tset(DEBUG_FISSION_DEFAULT ON)\n\t\tendif()\n\tendif()\n\n\t# https://gcc.gnu.org/wiki/DebugFission\n\toption(DEBUG_FISSION \"Enable Debug Fission\" DEBUG_FISSION_DEFAULT)\n\tif(DEBUG_FISSION)\n\t\tif(NOT HAVE_LD_GOLD)\n\t\t\tmessage(FATAL_ERROR \"GNU gold linker required for Debug Fission\")\n\t\tendif()\n\t\tset(CMAKE_CXX_FLAGS \"${CMAKE_CXX_FLAGS} -gsplit-dwarf\")\n\t\tset_linker_flags(\"-Wl,--gdb-index\")\n\tendif()\nendmacro()\n\n# check for compiler versions\nif(\"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"GNU\")\n\tset_compiler_greater_flags(\"CXX\" 4.9 \"-fdiagnostics-color=auto\")\n\tset_compiler_greater_flags(\"EXTRA\" 5.0 \"-Wsuggest-override\")\n\ttry_enable_gold_linker()\n\nelseif(\"${CMAKE_CXX_COMPILER_ID}\" MATCHES \"Clang\")\n\tset_compiler_flags(\"EXTRA\" \"-Wno-gnu-statement-expression\")\n\ttry_enable_gold_linker()\n\n\tif(APPLE)\n\t\tset_compiler_flags(\"CXX\" \"-stdlib=libc++\")\n\tendif()\n\nelseif(MSVC)\n\t# Don't worry. You're not alone. If you face an issue, just ask.\n\n\t# Enable multi processor compilation on MSVC\n\tset_compiler_flags(\"CXX\" \"/MP\")\n\n\treturn() # The following flag specifications don't apply.\n\nelse() # \"Intel\", etc..\n\tmessage(WARNING \"Using untested compiler, at least I hope it's free software. Continue on your own, warrior.\")\nendif()\n\n# optional code warnings from include-what-you-use\nif(\"${CXX_INCLUDE_WHAT_YOU_USE}\" STREQUAL \"warn\")\n\tset(CXX_INCLUDE_WHAT_YOU_USE)\nelseif(\"${CXX_INCLUDE_WHAT_YOU_USE}\" STREQUAL \"error\")\n\tset(CXX_INCLUDE_WHAT_YOU_USE \"--error_always\")\nendif()\n\n# optimization settings.\n# TODO: multi-configuration support for xcode, vstudio, ...\n# the following code just makes sense for single-config\n# generation, e.g. makefiles.\n# we'd have to perform the flag generation for other types as well.\n\n# these flags will now be extended by the following code.\nset(CMAKE_CXX_FLAGS_DEBUG \"-g\")\nset(CMAKE_CXX_FLAGS_RELEASE \"-DNDEBUG\")\n\n# If CXX_OPTIMIZATION_LEVEL was not provided, default to auto\nif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"\")\n\tset(CXX_OPTIMIZATION_LEVEL \"auto\")\nendif()\n\nif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"auto\")\n\tif(${CMAKE_BUILD_TYPE} STREQUAL \"Debug\")\n\t\tset(CXX_OPTIMIZATION_LEVEL \"g\")\n\telse()\n\t\tset(CXX_OPTIMIZATION_LEVEL \"3\")\n\tendif()\nendif()\n\nif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"0\")\n\tset_cxx_optimize_flags(\"-O0\")\nelseif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"1\")\n\tset_cxx_optimize_flags(\"-O1\")\nelseif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"2\")\n\tset_cxx_optimize_flags(\"-O2\")\nelseif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"3\")\n\tset_cxx_optimize_flags(\"-O3\")\nelseif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"g\")\n\tif(\"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"GNU\")\n\t\tset_cxx_optimize_flags(\"-Og\")\n\telse()\n\t\tset_cxx_optimize_flags(\"-O0\")\n\tendif()\nelseif(\"${CXX_OPTIMIZATION_LEVEL}\" STREQUAL \"max\")\n\tset_cxx_optimize_flags(\"-O3 -march=native\")\n\n\tif(\"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"GNU\")\n\t\tinclude(ProcessorCount)\n\t\tProcessorCount(N)\n\t\tif(NOT N EQUAL 0)\n\t\t\tset_cxx_optimize_flags(\"-flto=${N}\")\n\t\t\tset_linker_flags(\"-flto=${N}\")\n\t\tendif()\n\tendif()\nendif()\n\n\n# sanitizing options\n\nif(NOT CXX_SANITIZE_MODE)\n\tset(CXX_SANITIZE_MODE \"none\")\nendif()\n\nif(\"${CXX_SANITIZE_MODE}\" STREQUAL \"none\")\n\t# Do nothing\n\tif(\"${CXX_SANITIZE_FATAL}\")\n\t\tmessage(WARNING \"CXX_SANITIZE_FATAL is only valid when CXX_SANITIZE_MODE is not none\")\n\tendif()\nelse()\n\tset_compiler_flags(\"CXX\" \"-fno-omit-frame-pointer\")\n\tif(\"${CXX_SANITIZE_FATAL}\" AND \"${CMAKE_CXX_COMPILER_ID}\" MATCHES \"Clang\")\n\t\tset_compiler_flags(\"CXX\" \"-fno-sanitize-recover\")\n\tendif()\n\n\tif(\"${CXX_SANITIZE_MODE}\" STREQUAL \"yes\")\n\t\tset_compiler_flags(\"CXX\" \"-fsanitize=address\")\n\t\tset_compiler_flags(\"CXX\" \"-fsanitize=undefined\")\n\telseif(\"${CXX_SANITIZE_MODE}\" STREQUAL \"mem\")\n\t\tif(NOT APPLE)\n\t\t\tset_compiler_flags(\"CXX\" \"-fsanitize=memory\")\n\t\tendif()\n\telseif(\"${CXX_SANITIZE_MODE}\" STREQUAL \"thread\")\n\t\tif(NOT APPLE)\n\t\t\tset_compiler_flags(\"CXX\" \"-fsanitize=thread\")\n\t\tendif()\n\t\tif(\"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"GNU\")\n\t\t\tset_compiler_flags(\"CXX\" \"-fPIC\")\n\t\t\tset_compiler_flags(\"CXX\" \"-pie\")\n\t\tendif()\n\telse()\n\t\tmessage(WARNING \"Unknown sanitizer mode provided: ${CXX_SANITIZE_MODE}\")\n\tendif()\nendif()\n" }, { "path": "buildsystem/HandlePythonOptions.cmake", "content": "# Copyright 2015-2025 the openage authors. See copying.md for legal info.\n\n# finds the python interpreter, install destination and extension flags.\n\n# the Python version number requirement is in modules/FindPython_test.cpp\nfind_package(Python ${PYTHON_MIN_VERSION} REQUIRED)\n\nfind_package(Cython ${CYTHON_MIN_VERSION})\nif(NOT CYTHON_FOUND)\n\tmessage(\"Checking for alternative Cython fallback version (>=${CYTHON_MIN_VERSION_FALLBACK} AND <=${CYTHON_MAX_VERSION_FALLBACK})\")\n\tfind_package(Cython ${CYTHON_MIN_VERSION_FALLBACK} QUIET)\n\tif(CYTHON_VERSION VERSION_LESS ${CYTHON_MIN_VERSION} AND CYTHON_VERSION VERSION_GREATER ${CYTHON_MAX_VERSION_FALLBACK})\n\t\tmessage(FATAL_ERROR \"Cython version ${CYTHON_VERSION} is not compatible\")\n\telse()\n\t\tmessage(\"Compatible Cython version ${CYTHON_VERSION} found\")\n\tendif()\nendif()\n\npy_get_config_var(EXT_SUFFIX PYEXT_SUFFIX)\nif(MINGW)\n\tstring(REGEX REPLACE \"dll\" \"pyd\" PYEXT_SUFFIX \"${PYEXT_SUFFIX}\")\nendif()\n\n# This is the only useful thing after cleaning up what python suggests\nif(NOT \"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"MSVC\")\n\tset(PYEXT_CXXFLAGS \"-fwrapv\")\nendif()\n\n\n# numpy deprecated api\n# http://docs.cython.org/en/latest/src/userguide/source_files_and_compilation.html#configuring-the-c-build\nif(CYTHON_VERSION VERSION_GREATER_EQUAL 3)\n\tset(PYEXT_CXXFLAGS \"${PYEXT_CXXFLAGS} -DNPY_NO_DEPRECATED_API=NPY_1_7_API_VERSION\")\nelse()\n\n\t# suppress #warning about deprecated numpy api\n\tif(\"${CMAKE_CXX_COMPILER_ID}\" STREQUAL \"GNU\")\n\t\tset(PYEXT_CXXFLAGS \"${PYEXT_CXXFLAGS} -Wno-cpp\")\n\telseif(\"${CMAKE_CXX_COMPILER_ID}\" MATCHES \"Clang\")\n\t\tset(PYEXT_CXXFLAGS \"${PYEXT_CXXFLAGS} -Wno-#warnings\")\n\tendif()\nendif()\n\n# silence cython+python3.8 tp_print deprecation warning\n# https://github.com/cython/cython/pull/3201\n# https://github.com/cython/cython/issues/3474\nif(PYTHON_VER VERSION_GREATER_EQUAL 3.8 AND PYTHON_VERSION VERSION_LESS 3.9)\n\tset(PYEXT_CXXCLAGS \"${PYEXT_CXXCLAGS}\" \"-Wno-deprecated-declarations\")\nendif()\n\nset(PYEXT_LIBRARY \"${PYTHON_LIBRARIES}\")\nmessage(\"PYTHON_LIBRARIES: \" \"${PYTHON_LIBRARIES}\")\n#Windows always uses optimized version of Python lib\nif(WIN32 AND \"${CMAKE_BUILD_TYPE}\" STREQUAL \"Debug\")\n\t#get index of string \"optimized\" and increment it by 1 so index points at the path of the optimized lib\n\tlist(FIND PYEXT_LIBRARY \"optimized\" _index)\n\tif(${_index} GREATER -1)\n\t\tMATH(EXPR _index \"${_index}+1\")\n\t\tlist(GET PYEXT_LIBRARY ${_index} PYEXT_LIBRARY)\n\tendif()\n\tmessage(\"force linking to python release lib, instead of debug lib when cythonising\")\n\tset(force_optimized_lib_flag \"--force_optimized_lib\")\nendif()\n\nset(PYEXT_INCLUDE_DIRS \"${PYTHON_INCLUDE_DIRS};${NUMPY_INCLUDE_DIR}\")\n\nif(NOT CMAKE_PY_INSTALL_PREFIX)\n\tif(MSVC)\n\t\tset(CMAKE_PY_INSTALL_PREFIX \"python\")\n\telse()\n\t\t# get site-packages directory, prepended with cmake's install prefix\n\t\tpy_exec(\"import sys, sysconfig, os; print(os.path.join('${CMAKE_INSTALL_PREFIX}', os.path.relpath(sysconfig.get_path('purelib'), os.path.normpath(sys.prefix))))\" PREFIX)\n\t\tset(CMAKE_PY_INSTALL_PREFIX \"${PREFIX}\")\n\tendif()\nendif()\n" }, { "path": "buildsystem/__init__.py", "content": "# Copyright 2015-2020 the openage authors. See copying.md for legal info.\n\n\"\"\"\nCMake build helpers; see doc/buildsystem.md for further info.\n\nModules in the 'buildsystem' package are not intended to be installed\nwith openage, or used from outside the build process; otherwise, they\nwould be in the 'openage' package.\n\"\"\"\n" }, { "path": "buildsystem/check_py_file_list.py", "content": "# Copyright 2015-2021 the openage authors. See copying.md for legal info.\n\n\"\"\"\nTests whether the files listed via add_py_module are consistent with the\n.py files in the openage directory.\n\"\"\"\n\nimport argparse\nimport os\nimport sys\n\n\ndef main():\n \"\"\" CLI entry point \"\"\"\n cli = argparse.ArgumentParser()\n cli.add_argument('py_file_list', help=(\n \"semicolon-separated list of listed .py files\"\n ))\n cli.add_argument('py_module_dir', help=(\n \"directory containing the python module to check\"\n ))\n cli.add_argument('-v', '--verbose', action='store_true', help=(\n \"produce verbose output\"\n ))\n args = cli.parse_args()\n\n openage_dir = os.path.realpath(args.py_module_dir)\n\n listed = set()\n with open(args.py_file_list, encoding='utf8') as fileobj:\n for filename in fileobj.read().strip().split(';'):\n filepath = os.path.realpath(os.path.normpath(filename))\n if filepath.startswith(openage_dir):\n listed.add(filepath)\n elif args.verbose:\n print(\"Ignoring \" + filepath + \" outside \" + openage_dir)\n\n if args.verbose:\n print(\"Files listed in \" + args.py_file_list + \":\",\n *sorted(listed), sep='\\n\\t')\n\n actual = set()\n for dirname, _, files in os.walk(openage_dir):\n dirname = os.path.realpath(os.path.abspath(dirname))\n for filename in files:\n if filename.endswith('.py'):\n actual.add(os.path.join(dirname, filename))\n\n if args.verbose:\n print(\"Files available:\", *sorted(actual), sep='\\n\\t')\n\n success = True\n for filename in sorted(actual - listed):\n success = False\n print(\"file was not listed via add_py_module: \" +\n os.path.relpath(filename, openage_dir))\n\n for filename in sorted(listed - actual):\n success = False\n print(\"file was listed via add_py_module but does not exist: \" +\n os.path.relpath(filename, openage_dir))\n\n if success:\n return 0\n\n return 1\n\n\nif __name__ == '__main__':\n sys.exit(main())\n" }, { "path": "buildsystem/codecompliance/__init__.py", "content": "# Copyright 2015-2016 the openage authors. See copying.md for legal info.\n\n\"\"\"\nCode compliance checker module\n\nIntegrated into the root Makefile.\n\"\"\"\n" }, { "path": "buildsystem/codecompliance/__main__.py", "content": "# Copyright 2014-2025 the openage authors. See copying.md for legal info.\n\n\"\"\"\nEntry point for the code compliance checker.\n\"\"\"\n\nimport argparse\nimport importlib\nimport os\nimport shutil\nimport subprocess\nimport sys\n\nfrom .util import log_setup\n\n\ndef parse_args():\n \"\"\" Returns the raw argument namespace. \"\"\"\n\n cli = argparse.ArgumentParser()\n check_types = cli.add_mutually_exclusive_group()\n check_types.add_argument(\"--fast\", action=\"store_true\",\n help=\"do all checks that can be performed quickly\")\n check_types.add_argument(\"--merge\", action=\"store_true\",\n help=\"do all checks that are required before merges to master\")\n check_types.add_argument(\"--all\", action=\"store_true\",\n help=\"do all checks, even the really slow ones\")\n\n cli.add_argument(\"--only-changed-files\", metavar='GITREF',\n help=(\"slow checks are only done on files that have \"\n \"changed since GITREF.\"))\n cli.add_argument(\"--authors\", action=\"store_true\",\n help=(\"check whether all git authors are in copying.md. \"\n \"repo must be a git repository.\"))\n cli.add_argument(\"--clang-tidy\", action=\"store_true\",\n help=(\"Check the C++ code with clang-tidy. Make sure you have build the \"\n \"project with ./configure --clang-tidy or have set \"\n \"CMAKE_CXX_CLANG_TIDY for your CMake build.\"))\n cli.add_argument(\"--cppstyle\", action=\"store_true\",\n help=\"check the cpp code style\")\n cli.add_argument(\"--cython\", action=\"store_true\",\n help=\"check if cython is turned off\")\n cli.add_argument(\"--headerguards\", action=\"store_true\",\n help=\"check all header guards\")\n cli.add_argument(\"--legal\", action=\"store_true\",\n help=\"check whether all sourcefiles have legal headers\")\n cli.add_argument(\"--filemodes\", action=\"store_true\",\n help=(\"check whether files in the repo have the \"\n \"correct access bits (-> 0644) \"))\n cli.add_argument(\"--pylint\", action=\"store_true\",\n help=\"run pylint on the python code\")\n cli.add_argument(\"--pystyle\", action=\"store_true\",\n help=(\"check whether the python code complies with \"\n \"(a selected subset of) pep8.\"))\n cli.add_argument(\"--textfiles\", action=\"store_true\",\n help=\"check text files for whitespace issues\")\n cli.add_argument(\"--test-git-change-years\", action=\"store_true\",\n help=(\"when doing legal checks, test whether the \"\n \"copyright year matches the git history.\"))\n\n cli.add_argument(\"--fix\", action=\"store_true\",\n help=\"try to automatically fix the found issues\")\n\n cli.add_argument(\"-v\", \"--verbose\", action=\"count\", default=0,\n help=\"increase program verbosity\")\n cli.add_argument(\"-q\", \"--quiet\", action=\"count\", default=0,\n help=\"decrease program verbosity\")\n\n args = cli.parse_args()\n process_args(args, cli.error)\n\n return args\n\n\ndef process_args(args, error):\n \"\"\"\n Sanitizes the given argument namespace, modifying it in the process.\n\n Calls error (with a string argument) in case of errors.\n \"\"\"\n # this method is very flat; artificially nesting it would be bullshit.\n # pylint: disable=too-many-branches\n\n # set up log level\n log_setup(args.verbose - args.quiet)\n\n if args.fast or args.merge or args.all:\n # enable \"fast\" tests\n args.authors = True\n args.cppstyle = True\n args.cython = True\n args.headerguards = True\n args.legal = True\n args.filemodes = True\n args.textfiles = True\n\n if args.merge or args.all:\n # enable tests that are required before merging to master\n args.pystyle = True\n args.pylint = True\n args.test_git_change_years = True\n\n if args.all:\n # enable tests that take a bit longer\n args.clang_tidy = True\n\n if not any((args.headerguards, args.legal, args.authors, args.pystyle,\n args.cppstyle, args.cython, args.test_git_change_years,\n args.pylint, args.filemodes, args.textfiles, args.clang_tidy)):\n error(\"no checks were specified\")\n\n has_git = bool(shutil.which('git'))\n is_git_repo = os.path.exists('.git')\n\n if args.only_changed_files and not all((has_git, is_git_repo)):\n error(\"can not check only changed files: git is required\")\n\n if args.authors:\n if not all((has_git, is_git_repo)):\n # non-fatal fail\n print(\"can not check author list for compliance: git is required\")\n args.authors = False\n\n if args.test_git_change_years:\n if not args.legal:\n error(\"--test-git-change-years may only be passed with --legal\")\n\n if not all((has_git, is_git_repo)):\n error(\"--test-git-change-years requires git\")\n\n if args.pystyle:\n if not importlib.util.find_spec('pep8') and \\\n not importlib.util.find_spec('pycodestyle'):\n\n error(\"pep8 or pycodestyle python module \"\n \"required for style checking\")\n\n if args.pylint:\n if not importlib.util.find_spec('pylint'):\n error(\"pylint python module required for linting\")\n\n if args.clang_tidy:\n if not shutil.which('clang-tidy'):\n error(\"--clang-tidy requires clang-tidy to be installed\")\n\n\ndef get_changed_files(gitref):\n \"\"\"\n return a list of changed files\n \"\"\"\n invocation = ['git', 'diff', '--name-only', '--diff-filter=ACMRTUXB',\n gitref]\n\n try:\n file_list = subprocess.check_output(invocation)\n\n except subprocess.CalledProcessError as exc:\n raise RuntimeError(\n \"could not determine list of recently-changed files with git\"\n ) from exc\n\n return set(file_list.decode('ascii').strip().split('\\n'))\n\n\ndef main(args):\n \"\"\"\n Takes an argument namespace as returned by parse_args.\n\n Calls find_all_issues(main args, list of files to consider)\n\n Returns True if no issues were found.\n \"\"\"\n if args.only_changed_files:\n check_files = get_changed_files(args.only_changed_files)\n else:\n check_files = None\n\n auto_fixes = []\n fixes_possible = False\n\n issues_count = 0\n for title, text, apply_fix in find_all_issues(args, check_files):\n issues_count += 1\n print(f\"\\x1b[33;1mWARNING\\x1b[m {title}: {text}\")\n\n if apply_fix:\n fixes_possible = True\n\n if args.fix:\n print(\" This will be fixed automatically.\")\n auto_fixes.append(apply_fix)\n else:\n print(\" This can be fixed automatically.\")\n\n # nicely seperate warnings\n print()\n\n if args.fix and auto_fixes:\n print(f\"\\x1b[33;1mApplying {len(auto_fixes):d} automatic fixes...\\x1b[m\")\n\n for auto_fix in auto_fixes:\n print(auto_fix())\n issues_count -= 1\n\n print()\n\n if issues_count > 0:\n plural = \"s\" if issues_count > 1 else \"\"\n\n if args.fix and auto_fixes:\n remainfound = f\"remain{plural}\"\n else:\n remainfound = (\"were\" if issues_count > 1 else \"was\") + \" found\"\n\n print(f\"==> \\x1b[33;1m{issues_count} issue{plural}\\x1b[m {remainfound}.\")\n\n if not args.fix and fixes_possible:\n print(\"When invoked with --fix, I can try \"\n \"to automatically resolve some of the issues.\\n\")\n\n return issues_count == 0\n\n\ndef find_all_issues(args, check_files=None):\n \"\"\"\n Invokes all the individual issue checkers, and yields their returned\n issues.\n\n If check_files is not None, all other files are ignored during the\n more resource-intense checks.\n That is, check_files is the set of files to verify.\n\n Yields tuples of (title, text) that are displayed as warnings.\n \"\"\"\n\n # pylint: disable=too-many-function-args, no-value-for-parameter\n # no-value-for-parameter has to be used because pylint is dumb\n\n if args.headerguards:\n from .headerguards import find_issues\n yield from find_issues('libopenage')\n\n if args.authors:\n from .authors import find_issues\n yield from find_issues()\n\n if args.pystyle:\n from .pystyle import find_issues\n yield from find_issues(check_files, ('openage', 'buildsystem', 'etc/gdb_pretty'))\n\n if args.cython:\n from buildsystem.codecompliance.cython import find_issues\n yield from find_issues(check_files, ('openage',))\n\n if args.cppstyle:\n from .cppstyle import find_issues\n yield from find_issues(check_files, ('libopenage',))\n\n if args.pylint:\n from .pylint import find_issues\n yield from find_issues(check_files, ('openage', 'buildsystem', 'etc/gdb_pretty'))\n\n if args.textfiles:\n from .textfiles import find_issues\n yield from find_issues(\n ('openage', 'libopenage', 'buildsystem', 'doc', 'legal', 'etc/gdb_pretty'),\n ('.pxd', '.pyx', '.pxi', '.py',\n '.h', '.cpp', '.template',\n '', '.txt', '.md', '.conf',\n '.cmake', '.in', '.yml', '.supp', '.desktop'))\n\n if args.legal:\n from .legal import find_issues\n yield from find_issues(check_files,\n ('openage', 'buildsystem', 'libopenage', 'etc/gdb_pretty'),\n args.test_git_change_years)\n\n if args.filemodes:\n from .modes import find_issues\n yield from find_issues(check_files, ('openage', 'buildsystem',\n 'libopenage', 'etc/gdb_pretty'))\n if args.clang_tidy:\n from .clangtidy import find_issues\n yield from find_issues(check_files, ('libopenage', ))\n\n\nif __name__ == '__main__':\n if main(parse_args()):\n sys.exit(0)\n else:\n sys.exit(1)\n" }, { "path": "buildsystem/codecompliance/authors.py", "content": "# Copyright 2014-2024 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks whether all authors are properly listed in copying.md.\n\"\"\"\n\nimport re\n\nimport logging\n\nfrom .util import Strlazy\n\n\ndef deobfuscate_email(string):\n \"\"\"\n Should reveal the original email address passed into obfuscate_email\n\n deobfuscate_email('first dawt last+tag à gmail dawt com')\n = 'first.last+tag@gmail.com'\n \"\"\"\n replacements = {\n ' dawt ': '.',\n ' à ': '@'\n }\n\n for key, value in replacements.items():\n string = string.replace(key, value)\n\n return string\n\n\ndef get_author_emails_copying_md():\n \"\"\"\n yields all emails from the author table in copying.md\n\n they must be part of a line like\n\n | name | nick | email |\n \"\"\"\n with open(\"copying.md\", encoding='utf8') as fobj:\n for line in fobj:\n match = re.match(r\"^.*\\|[^|]*\\|[^|]*\\|([^|]+)\\|.*$\", line)\n if not match:\n continue\n\n email = match.group(1).strip()\n if 'à' in email:\n email = deobfuscate_email(email)\n\n if not any(email.startswith(prefix) for prefix in (\"E-Mail\", \"-\" * 15))\\\n and '@' not in email:\n raise ValueError(f\"no @ or à was found in email: {email}\")\n\n yield email\n\n\ndef get_author_emails_git_shortlog(exts):\n \"\"\"\n yields emails of all authors that have authored any of the files ending\n in exts (plus their templates)\n\n parses the output of git shortlog -sne\n \"\"\"\n from subprocess import Popen, PIPE\n\n invocation = ['git', 'shortlog', '-sne', '--']\n for ext in exts:\n invocation.append(f\"*{ext}\")\n invocation.append(f\"*{ext}.in\")\n invocation.append(f\"*{ext}.template\")\n\n with Popen(invocation, stdout=PIPE) as invoc:\n output = invoc.communicate()[0]\n\n for line in output.decode('utf-8', errors='replace').split('\\n'):\n match = re.match(\"^ +[0-9]+\\t[^<]*\\\\<(.*)\\\\>$\", line)\n if match:\n yield match.group(1).lower()\n\n\ndef find_issues():\n \"\"\"\n compares the output of git shortlog -sne to the authors table in copying.md\n\n prints all discrepancies, and returns False if one is detected.\n \"\"\"\n relevant_exts = ('.cpp', '.h', '.py', '.pyi', '.pyx', '.cmake',\n '.qml')\n\n copying_md_emails = set(get_author_emails_copying_md())\n logging.debug(\"scanned authors in copying.md:\\n%s\",\n Strlazy(lambda: f\"{chr(10).join(sorted(copying_md_emails))}\"))\n\n git_shortlog_emails = set(get_author_emails_git_shortlog(relevant_exts))\n logging.debug(\"scanned authors from git shortlog:\\n%s\",\n Strlazy(lambda: f\"{chr(10).join(sorted(git_shortlog_emails))}\"))\n\n # look for git emails that are unlisted in copying.md\n for email in git_shortlog_emails - copying_md_emails:\n if email in {'coop@sft.mx', '?'}:\n continue\n\n yield (\n \"author inconsistency\",\n f\"{email}\\n\\temail appears in git log, but not in copying.md or .mailmap\",\n None\n )\n" }, { "path": "buildsystem/codecompliance/clangtidy.py", "content": "# Copyright 2024-2024 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks clang-tidy errors on cpp files\n\"\"\"\n\nimport subprocess\nfrom .cppstyle import filter_file_list\nfrom .util import findfiles\n\n\ndef find_issues(check_files, dirnames):\n \"\"\"\n Invoke clang-tidy to check C++ files for issues.\n Yields issues found by clang-tidy in real-time.\n \"\"\"\n # Specify the checks to include\n # 4 checks we focus on\n checks_to_include = [\n 'clang-analyzer-*',\n 'bugprone-*',\n 'concurrency-*',\n 'performance-*'\n ]\n # Create the checks string\n checks = ', '.join(checks_to_include)\n\n # Invocation command\n invocation = ['clang-tidy', f'-checks=-*,{checks}']\n\n # Use utility functions from util.py and cppstyle.py\n if check_files is not None:\n filenames = list(filter_file_list(check_files, dirnames))\n else:\n filenames = list(filter_file_list(findfiles(dirnames), dirnames))\n\n if not filenames:\n print(\"No files to check.\")\n return # No files to check\n\n for filename in filenames:\n # Run clang-tidy for each file\n print(f\"Starting clang-tidy check on file: {filename}\")\n try:\n with subprocess.Popen(\n invocation + [filename],\n stdout=subprocess.PIPE,\n stderr=subprocess.PIPE,\n text=True\n ) as process:\n # Stream output in real-time\n while True:\n output = process.stdout.readline()\n if output:\n yield (\"clang-tidy output\", output.strip(), None)\n elif process.poll() is not None:\n break\n\n # Capture remaining errors (if any)\n for error_line in process.stderr:\n yield (\"clang-tidy error\", error_line.strip(), None)\n\n # Handle exception\n except subprocess.SubprocessError as exc:\n yield (\n \"clang-tidy error\",\n f\"An error occurred while running clang-tidy on {filename}: {str(exc)}\",\n None\n )\n" }, { "path": "buildsystem/codecompliance/cppstyle.py", "content": "# Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks some code style rules for cpp files.\n\"\"\"\n\nimport re\n\nfrom .util import findfiles, readfile, issue_str_line\n\n# spaces missing in `if () {` and `for`, `while`, ...\nMISSING_SPACES_RE = re.compile(\n # on of the folowing, the first group is used for the column where\n # the pointer is going to show\n r\"(?:\"\n # a ) folowed by a { without a space between\n r\"(?:\\)(\\{))|\"\n # a if/for/while folowed by a ( without a space between\n r\"(?:\\s+(?:if|for|while)(\\())\"\n r\")\"\n)\n\n# extra spaces before a ;\nEXTRA_SPACES_RE = re.compile(\n # on of the folowing, the first group is used for the column where\n # the pointer is going to show\n r\"(?:\"\n # a space before a \";\"\n r\"(?:(\\s+);)\"\n r\")\"\n)\n\n# indentation fails looking at a file\nINDENT_FAIL_RE = re.compile(\n # leading whitespace fail\n r\"(?:\"\n r\"(\\n\\t*[ ]+\\t+)\" # \\n tab* space+ tab+\n r\")\"\n)\n\n# we need both because we look at the file first.\n# indentation fails when looking at a line\nINDENT_FAIL_LINE_RE = re.compile(\n # leading whitespace fail\n r\"(?:\"\n r\"(^\\t*[ ]+\\t+)\" # tab* space+ tab+\n r\")\"\n)\n\n\ndef filter_file_list(check_files, dirnames):\n \"\"\"\n Yields all those files in check_files that are in one of the directories\n and end in '.cpp' or '.h' and some other conditions.\n \"\"\"\n for filename in check_files:\n if not (filename.endswith('.cpp') or filename.endswith('.h')):\n continue\n\n if filename.endswith('.gen.h') or filename.endswith('.gen.cpp'):\n # TODO all this for now, until someone fixes the codegen.\n continue\n\n if any(filename.startswith(dirname) for dirname in dirnames):\n yield filename\n\n\ndef find_issues(check_files, dirnames):\n \"\"\"\n Finds all issues in the given directories (filtered by check_files).\n \"\"\"\n\n if check_files is not None:\n filenames = filter_file_list(check_files, dirnames)\n else:\n filenames = filter_file_list(findfiles(dirnames), dirnames)\n\n for filename in filenames:\n data = readfile(filename)\n analyse_each_line = False\n\n if MISSING_SPACES_RE.search(data) or\\\n EXTRA_SPACES_RE.search(data) or\\\n INDENT_FAIL_RE.search(data):\n\n analyse_each_line = True\n\n # if there are possible issues perform a per line analysis\n if analyse_each_line:\n yield from find_issues_with_lines(data, filename)\n\n\ndef find_issues_with_lines(data, filename):\n \"\"\"\n Checks a file for issues per line\n \"\"\"\n\n for num, line in enumerate(data.splitlines(True), start=1):\n\n match = MISSING_SPACES_RE.search(line)\n if match:\n start = match.start(1) + match.start(2)\n end = start + 1\n yield issue_str_line(\"Missing space\",\n filename, line, num,\n (start, end))\n\n match = EXTRA_SPACES_RE.search(line)\n if match:\n yield issue_str_line(\"Extra space\",\n filename, line, num,\n (match.start(1), match.end(1)))\n\n match = INDENT_FAIL_LINE_RE.search(line)\n if match:\n yield issue_str_line(\"Wrong indentation\",\n filename, line, num,\n (match.start(1), match.end(1)))\n" }, { "path": "buildsystem/codecompliance/cython.py", "content": "# Copyright 2021-2021 the openage authors. See copying.md for legal info.\n\n\"\"\"\nVerifies that Cython directives for profiling are deactivated.\n\"\"\"\n\nimport re\n\nfrom buildsystem.codecompliance.util import issue_str_line\n\nfrom .util import findfiles, readfile\n\n\nGLOBAL_PROFILE_DIREC = re.compile((\n # global profiling directive for a file\n r\"^(# cython: .*(profile=True|linetrace=True).*\\n)\"\n))\n\nFUNC_PROFILE_DIREC = re.compile((\n # profiling for single functions\n r\"@cython\\.profile\\(True\\)\"\n))\n\n\ndef filter_file_list(check_files, dirnames):\n \"\"\"\n Yields all those files in check_files that are in one of the directories\n and end in '.py'x.\n \"\"\"\n for filename in check_files:\n if not filename.endswith('.pyx'):\n continue\n\n if any(filename.startswith(dirname) for dirname in dirnames):\n yield filename\n\n\ndef find_issues(check_files, dirnames):\n \"\"\"\n Finds all issues in the given directories (filtered by check_files).\n \"\"\"\n if check_files:\n filenames = filter_file_list(check_files, dirnames)\n\n else:\n filenames = findfiles(dirnames, ('.pyx',))\n\n for filename in filenames:\n data = readfile(filename)\n\n for num, line in enumerate(data.splitlines(True), start=1):\n match = GLOBAL_PROFILE_DIREC.match(line)\n if match:\n yield issue_str_line(\"cython profiling activated in header\",\n filename, line, num,\n (match.start(1), match.end(1)))\n\n match = FUNC_PROFILE_DIREC.search(line)\n if match:\n yield issue_str_line(\"cython function profiling activated in file\",\n filename, line, num,\n (match.start(0), match.end(0)))\n" }, { "path": "buildsystem/codecompliance/headerguards.py", "content": "# Copyright 2014-2021 the openage authors. See copying.md for legal info.\n\n\"\"\"\nVerifies the guard macros of all C++ header files.\n\"\"\"\n\nimport re\n\nfrom .util import findfiles, readfile\n\n\nclass HeaderIssue(Exception):\n \"\"\" Some issue was detected with the Header guard. \"\"\"\n\n\nGUARD_RE = re.compile((\n # allow any number of comments or empty lines\n \"^(\\\\n|(#|//).*\\\\n)*\"\n\n # the header guard\n \"#pragma once\\n\"\n))\n\nNO_GUARD_REQUIRED_RE = re.compile((\n # allow any number of comments or empty lines\n \"^(\\\\n|(#|//).*\\\\n)*\"\n\n # require comment \"has no header guard\"\n \"(#|//) has no header guard:\"\n))\n\n\ndef find_issues(dirname):\n \"\"\"\n checks all headerguards in header files in the cpp folders.\n \"\"\"\n for fname in findfiles((dirname,), ('.h',)):\n try:\n data = readfile(fname)\n\n if NO_GUARD_REQUIRED_RE.match(data):\n # this file needs no header guard, for the reason\n # detailed in the comment.\n continue\n\n match = GUARD_RE.match(data)\n if not match:\n raise HeaderIssue(\"No valid header guard found (e.g. #pragma once)\")\n\n except HeaderIssue as exc:\n yield (f\"header guard issue in {fname}\", exc.args[0], None)\n" }, { "path": "buildsystem/codecompliance/legal.py", "content": "# Copyright 2014-2023 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks the legal headers of all files.\n\"\"\"\n\nfrom datetime import date\nimport re\nfrom subprocess import Popen, PIPE\n\nfrom .util import findfiles, readfile, writefile, has_ext, SHEBANG\n\n\nOPENAGE_AUTHORS = (\n \"Copyright (?P\\\\d{4})-(?P\\\\d{4}) the openage authors\\\\.\"\n)\nOPENAGE_AUTHORTEMPLATE = (\n \"Copyright {crstart}-{crend} the openage authors.\"\n)\n\nNATIVELEGALHEADER = re.compile(\n \"^\"\n # Allow shebang line, followed by an optional empty line.\n \"(\" + SHEBANG + \")?\"\n\n # Next line must be the copyright line.\n \"(#|//) \" + OPENAGE_AUTHORS + \" See copying\\\\.md for legal info\\\\.\\n\"\n)\n\nTHIRDPARTYLEGALHEADER = re.compile(\n \"^\"\n # 3rd-party copyright/license\n \"(#|//) This file (was (taken|adapted)|contains (data|code)) from .*\\n\"\n \"(#|//) Copyright \\\\d{4}-\\\\d{4} .*\\n\"\n \"(#|//) .*license.*\\n\"\n\n # any number of lines containing further 3rd-party copyright info\n \"((#|//) .*\\\\n)*\"\n\n # the openage copyright\n \"(#|//) (Modifications|Other (data|code)|Everything else) \" +\n OPENAGE_AUTHORS + \"\\n\"\n \"(#|//) See copying\\\\.md for further legal info\\\\.\\n\")\n\n# Empty files (consisting of only comments) don't require a legal header.\nEMPTYFILE = re.compile(\"^(((#|//) .*)?\\n)*$\")\n\n# cython-generated files\nCYTHONGENERATED = re.compile(\"^[^\\\\n]*(Generated by Cython |failed Cython compilation.)\")\n\n\n# all those files will be checked.\nEXTENSIONS_REQUIRING_LEGAL_HEADERS = {\n '.h', '.cpp', '.py', '.pyx', '.pxi', '.cmake', '.h.in',\n '.cpp.in', '.py.in', '.h.template', '.cpp.template',\n '.py.template', '.qml'\n}\n\n\ndef get_git_change_year(filename):\n \"\"\" Returns git-log's opinion on when the file was last changed. \"\"\"\n\n invocation = [\n 'git', 'log', '-1', '--format=%ad', '--date=short', '--no-merges', '--',\n filename\n ]\n\n with Popen(invocation, stdout=PIPE) as proc:\n output = proc.communicate()[0].decode('utf-8', errors='ignore').strip()\n\n if proc.returncode != 0 or not output:\n # git doesn't know about the file\n return None\n\n return int(output[:4])\n\n\ndef match_legalheader(data):\n \"\"\"\n Tests whether data matches any of the regular expressions,\n and returns a tuple of (matching header regex, match).\n \"\"\"\n for hdr in (NATIVELEGALHEADER,\n THIRDPARTYLEGALHEADER,\n EMPTYFILE,\n CYTHONGENERATED):\n\n match = re.match(hdr, data)\n if match is not None:\n return hdr, match\n\n raise ValueError(\"no match found\")\n\n\ndef create_year_fix(filename, file_content, expected_end_year,\n found_start_year, headertype):\n \"\"\"\n Create a function that, when called, fixes the copyright header.\n \"\"\"\n\n # check if a fix can be created\n if headertype not in {NATIVELEGALHEADER, THIRDPARTYLEGALHEADER}:\n return None\n\n def year_fix_function():\n \"\"\"\n Store the file with correct copyright years.\n \"\"\"\n\n fixed_file, success = re.subn(\n OPENAGE_AUTHORS,\n OPENAGE_AUTHORTEMPLATE.format(crstart=found_start_year,\n crend=expected_end_year),\n file_content\n )\n\n if not success:\n raise ValueError(\"copyright year fix did not suceeed\")\n\n writefile(filename, fixed_file)\n\n return f\"Copyright for {filename} was fixed.\"\n\n return year_fix_function\n\n\ndef test_headers(check_files, paths, git_change_years, third_party_files):\n \"\"\" Tests all in-sourcefile legal headers. \"\"\"\n\n if not git_change_years:\n print(\"warning: I won't check if the copyright matches the git history.\")\n print(\" Run with --test-git-change-years to enable the check.\")\n\n # determine all uncommited files from git.\n # those definitely need the current year in the copyright message.\n with Popen(['git', 'diff', '--name-only', 'HEAD'], stdout=PIPE) as proc:\n uncommited = set(proc.communicate()[0].decode('ascii').strip().split('\\n'))\n\n current_calendar_year = date.today().year\n\n for filename in findfiles(paths, EXTENSIONS_REQUIRING_LEGAL_HEADERS):\n try:\n file_content = readfile(filename)\n headertype, match = match_legalheader(file_content)\n except ValueError:\n yield (\n \"Legal header missing or invalid\",\n (filename + \"\\nSee copying.md for a template\"),\n None\n )\n continue\n\n if headertype is THIRDPARTYLEGALHEADER:\n third_party_files.add(filename)\n\n try:\n found_start_year = int(match.group('crstart'))\n found_end_year = int(match.group('crend'))\n except IndexError:\n # this header type has/needs no copyright years\n # (e.g. empty file)\n continue\n\n expected_end_year = None\n if filename in uncommited:\n expected_end_year = current_calendar_year\n elif git_change_years:\n if check_files is None or filename in check_files:\n expected_end_year = get_git_change_year(filename)\n\n if expected_end_year is None:\n continue\n\n if found_end_year != expected_end_year:\n\n fix = create_year_fix(\n filename,\n file_content,\n expected_end_year,\n found_start_year,\n headertype\n )\n\n yield (\n \"Bad copyright year\",\n (filename + \"\\n\" +\n f\"\\tExpected {expected_end_year}\\n\" +\n f\"\\tFound {found_end_year}\"),\n fix\n )\n\n\ndef find_issues(check_files, paths, git_change_years=False):\n \"\"\"\n Tests all source files for the required legal headers.\n \"\"\"\n\n third_party_files = set()\n\n yield from test_headers(\n check_files, paths, git_change_years, third_party_files)\n\n # test whether all third-party files are listed in copying.md\n listed_files = set()\n for line in readfile('copying.md').split('\\n'):\n match = re.match(\"^ - `([^`]+)`.*$\", line)\n if not match:\n continue\n\n filename = match.group(1)\n listed_files.add(filename)\n\n # file listed, but has no 3rd-party header?\n for filename in sorted(listed_files - third_party_files):\n if has_ext(filename, EXTENSIONS_REQUIRING_LEGAL_HEADERS):\n yield (\n \"third-party file listing issue\",\n (f\"{filename}\\n\\tlisted in copying.md, but has no \"\n \"third-party license header.\"),\n None\n )\n\n # file has 3rd-party header, but is not listed?\n for filename in sorted(third_party_files - listed_files):\n yield (\n \"third-party file listing issue\",\n (f\"{filename}\\n\\thas a third-party license header, but isn't \"\n \"listed in copying.md\"),\n None\n )\n" }, { "path": "buildsystem/codecompliance/modes.py", "content": "# Copyright 2016-2022 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks the mode of all files and prevents executable source files.\n\"\"\"\n\nimport re\nimport pathlib\nimport stat\n\nfrom .util import findfiles, SHEBANG\n\n\nSHEBANG_RE = re.compile(\"^\" + SHEBANG)\n\nEXTENSIONS_NO_X_BIT = {\n '.h', '.cpp', '.py', '.pyx', '.pxi', '.cmake', '.h.in',\n '.cpp.in', '.py.in', '.h.template', '.cpp.template',\n '.py.template', '.qml'\n}\n\nEXTENSIONS_SHEBANG_XBIT = {\n '.sh', '.py'\n}\n\n\ndef check_mode(filename):\n \"\"\"\n Test if the the file has no executable bit set.\n \"\"\"\n\n path = pathlib.Path(filename)\n filemode = path.stat().st_mode\n\n x_ok = False\n\n if filemode & (stat.S_IXGRP | stat.S_IXOTH | stat.S_IXUSR):\n\n if path.suffix in EXTENSIONS_SHEBANG_XBIT:\n # if the file is allowed to have a shebang,\n # allow its executable bit if it actually has a shebang\n with path.open(encoding='utf-8') as file:\n firstline = file.readline()\n\n if SHEBANG_RE.match(firstline):\n x_ok = True\n\n if not x_ok:\n raise ValueError(f'file {filename} is executable')\n\n\ndef find_issues(check_files, paths):\n \"\"\"\n Check all source files for their required filesystem bits.\n \"\"\"\n\n for filename in findfiles(paths, EXTENSIONS_NO_X_BIT):\n if check_files and filename not in check_files:\n continue\n\n try:\n check_mode(filename)\n except ValueError as exc:\n yield (\"wrong file access bits\", str(exc), None)\n continue\n" }, { "path": "buildsystem/codecompliance/pylint.py", "content": "# Copyright 2015-2023 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks the Python modules with pylint.\n\"\"\"\n\nfrom pylint import lint\n\nfrom .pystyle import filter_file_list\nfrom .util import findfiles\n\n\ndef find_pyx_modules(dirnames):\n \"\"\" Yields the names of all .pyx modules. \"\"\"\n for pyx_file in findfiles(dirnames, [\".pyx\"]):\n yield pyx_file.replace('/', '.')[:-len(\".pyx\")]\n\n\ndef find_issues(check_files, dirnames):\n \"\"\" Invokes the external utility. \"\"\"\n\n invocation = ['--rcfile=etc/pylintrc', '--reports=n']\n\n from multiprocessing import cpu_count\n invocation.append(f\"--jobs={cpu_count():d}\")\n\n if check_files is None:\n invocation.extend(dirnames)\n else:\n check_files = list(filter_file_list(check_files, dirnames))\n if not check_files:\n return\n invocation.extend(check_files)\n\n try:\n lint.Run(invocation)\n except SystemExit as exc:\n error_count = exc.args[0]\n if error_count != 0:\n if check_files is None:\n msg = f\"python code is noncompliant: {error_count:d}\"\n else:\n msg = (\"false positives may result from not checking the \"\n \"entire codebase\")\n\n yield \"linting issue\", msg, None\n" }, { "path": "buildsystem/codecompliance/pystyle.py", "content": "# Copyright 2014-2018 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks PEP8 compliance, with some exceptions.\n\"\"\"\n\ntry:\n from pycodestyle import StyleGuide\nexcept ImportError:\n from pep8 import StyleGuide\n\n\n# these errors will be ignored by pep8\nIGNORE_ERRORS = (\n \"E221\", # multiple spaces before operator\n \"E241\", # multiple spaces after ','\n \"E251\", # unexpected spaces around keyword / parameter equals\n \"E501\", # line too long\n)\n\n\ndef filter_file_list(check_files, dirnames):\n \"\"\"\n Yields all those files in check_files that are in one of the directories\n and end in '.py'.\n \"\"\"\n for filename in check_files:\n if not filename.endswith('.py'):\n continue\n\n if any(filename.startswith(dirname) for dirname in dirnames):\n yield filename\n\n\ndef find_issues(check_files, dirnames):\n \"\"\"\n Finds all issues in the given directories (filtered by check_files).\n \"\"\"\n checker = StyleGuide()\n checker.options.ignore = IGNORE_ERRORS\n\n filenames = dirnames\n if check_files is not None:\n filenames = filter_file_list(check_files, dirnames)\n\n report = checker.check_files(filenames)\n\n if report.messages:\n yield (\"style issue\", \"python code violates pep8\", None)\n" }, { "path": "buildsystem/codecompliance/textfiles.py", "content": "# Copyright 2015-2019 the openage authors. See copying.md for legal info.\n\n\"\"\"\nChecks some general whitespace rules and the encoding for text files.\n\"\"\"\n\nimport re\n\nfrom .util import findfiles, readfile, has_ext, issue_str_line, BADUTF8FILES\n\nTRAIL_WHITESPACE_RE = re.compile((\n # trailing whitespace\n r\"( |\\t)+\\n\"\n))\n\nIMMEDIATE_TODO_RE = re.compile(\n \"as\" + \"df\",\n re.IGNORECASE # pylint: disable=no-member\n)\n\n\ndef find_issues(dirnames, exts):\n \"\"\"\n Checks all files ending in exts in dirnames.\n \"\"\"\n for filename in findfiles(dirnames, exts):\n data = readfile(filename)\n analyse_each_line = False\n\n if filename.endswith('.gen.h') or filename.endswith('.gen.cpp'):\n # TODO all this for now, until someone fixes the codegen.\n continue\n\n if filename.startswith('openage/') and filename.endswith('.cpp'):\n # allow issues for Cython-generated files.\n continue\n\n if '\\r\\n' in data:\n yield \"Windows EOL format\", filename, None\n\n if data.endswith('\\n\\n'):\n yield \"Trailing newline at file end\", filename, None\n\n if data and not data.endswith('\\n'):\n yield \"File does not end in '\\\\n'\", filename, None\n\n if has_ext(filename, ('.py', '.pyx', '.pxd')):\n if '\\t' in data:\n yield \"File contains tabs\", filename, None\n\n if TRAIL_WHITESPACE_RE.search(data) or IMMEDIATE_TODO_RE.search(data):\n analyse_each_line = True\n\n # If there are possible issues, perform an in-depth analysis.\n if analyse_each_line:\n yield from find_issues_with_lines(filename)\n\n for filename in BADUTF8FILES:\n yield \"Not valid UTF-8\", filename\n\n\ndef find_issues_with_lines(filename):\n \"\"\"\n Checks a file for issues per line.\n \"\"\"\n data = readfile(filename)\n\n for num, line in enumerate(data.splitlines(True), start=1):\n\n match = TRAIL_WHITESPACE_RE.search(line)\n if match:\n yield issue_str_line(\"Trailing whitespace\", filename, line, num,\n (match.start(1), match.end(1)))\n\n match = IMMEDIATE_TODO_RE.search(line)\n if match:\n yield issue_str_line(\"Found 'as\"\n \"df', indicating an immediate TODO\",\n filename, line, num,\n (match.start(), match.end()))\n" }, { "path": "buildsystem/codecompliance/util.py", "content": "# Copyright 2014-2023 the openage authors. See copying.md for legal info.\n\n\"\"\"\nSome utilities.\n\"\"\"\n\nimport logging\nimport os\n\n\nSHEBANG = \"#!/.*\\n(#?\\n)?\"\n\nFILECACHE = {}\nBADUTF8FILES = set()\n\n\ndef log_setup(setting, default=1):\n \"\"\"\n Perform setup for the logger.\n Run before any logging.log thingy is called.\n\n if setting is 0: the default is used, which is WARNING.\n else: setting + default is used.\n \"\"\"\n\n levels = (logging.ERROR, logging.WARNING, logging.INFO,\n logging.DEBUG, logging.NOTSET)\n\n factor = clamp(default + setting, 0, len(levels) - 1)\n level = levels[factor]\n\n logging.basicConfig(level=level, format=\"[%(asctime)s] %(message)s\")\n logging.captureWarnings(True)\n\n\ndef clamp(number, smallest, largest):\n \"\"\" return number but limit it to the inclusive given value range \"\"\"\n return max(smallest, min(number, largest))\n\n\nclass Strlazy:\n # pylint: disable=too-few-public-methods\n \"\"\"\n to be used like this: logging.debug(\"rolf %s\", strlazy(lambda: do_something()))\n so do_something is only called when the debug message is actually printed\n do_something could also be an f-string.\n \"\"\"\n def __init__(self, fun):\n self.fun = fun\n\n def __str__(self):\n return self.fun()\n\n\ndef has_ext(fname, exts):\n \"\"\"\n Returns true if fname ends in any of the extensions in ext.\n \"\"\"\n for ext in exts:\n if ext == '':\n if os.path.splitext(fname)[1] == '':\n return True\n elif fname.endswith(ext):\n return True\n\n return False\n\n\ndef readfile(filename):\n \"\"\"\n reads the file, and returns it as a str object.\n\n if the file has already been read in the past,\n returns it from the cache.\n \"\"\"\n if filename not in FILECACHE:\n with open(filename, 'rb') as fileobj:\n data = fileobj.read()\n\n try:\n data = data.decode('utf-8')\n except UnicodeDecodeError:\n data = data.decode('utf-8', errors='replace')\n BADUTF8FILES.add(filename)\n\n FILECACHE[filename] = data\n\n return FILECACHE[filename]\n\n\ndef writefile(filename, new_content):\n \"\"\"\n writes the file and update it in the cache.\n \"\"\"\n if filename in BADUTF8FILES:\n raise ValueError(f\"{filename}: cannot write due to utf8-errors.\")\n\n with open(filename, 'w', encoding='utf8') as fileobj:\n fileobj.write(new_content)\n\n FILECACHE[filename] = new_content\n\n\ndef findfiles(paths, exts=None):\n \"\"\"\n yields all files in paths with names ending in an ext from exts.\n\n If exts is None, all extensions are accepted.\n\n hidden dirs and files are ignored.\n \"\"\"\n for path in paths:\n for filename in os.listdir(path):\n if filename.startswith('.'):\n continue\n\n filename = os.path.join(path, filename)\n\n if os.path.isdir(filename):\n yield from findfiles((filename,), exts)\n continue\n\n if exts is None or has_ext(filename, exts):\n yield filename\n\n\ndef issue_str(title, filename, fix=None):\n \"\"\"\n Creates a formated (title, text) desciption of an issue.\n\n TODO use this function and issue_str_line for all issues, so the format\n can be easily changed (exta text, colors, etc)\n \"\"\"\n return (title, filename, fix)\n\n\n# gread hint, pylint. thank you so much.\n# pylint: disable=too-many-arguments\ndef issue_str_line(title, filename, line, line_number, highlight, fix=None):\n \"\"\"\n Creates a formated (title, text) desciption of an issue with information\n about the location in the file.\n line: line content\n line_number: line id in the file\n highlight: a tuple of (start, end), where\n start: match start in the line\n end: match end in the line\n \"\"\"\n\n start, end = highlight\n start += 1\n line = line.replace(\"\\n\", \"\").replace(\"\\t\", \" \")\n\n return (\n title,\n (\n filename + \"\\n\"\n \"\\tline: \" + str(line_number) + \"\\n\" # line number\n \"\\tat: '\" + line + \"'\\n\" # line content\n \"\\t \" + (' ' * start) + # mark position with ^\n \"\\x1b[32;1m^\" + (\"~\" * (end - start)) + \"\\x1b[m\"\n ),\n fix\n )\n" }, { "path": "buildsystem/codegen.cmake", "content": "# Copyright 2014-2025 the openage authors. See copying.md for legal info.\n\n# set CODEGEN_SCU_FILE to the absolute path to SCU file\nmacro(get_codegen_scu_file)\n\tset(CODEGEN_SCU_FILE \"${CMAKE_BINARY_DIR}/libopenage/codegen_scu.gen.cpp\")\nendmacro()\n\nfunction(codegen_run)\n\t# this function must be called once all required assets have been created, but before the executable is finalized.\n\n\t# make sure this function gets called only once\n\tget_property(codegen_run GLOBAL PROPERTY SFT_CODEGEN_HAS_BEEN_RUN)\n\tif(codegen_run)\n\t\tmessage(FATAL_ERROR \"codegen has already been run\")\n\tendif()\n\tset_property(GLOBAL PROPERTY SFT_CODEGEN_HAS_BEEN_RUN 1)\n\n\tset(CODEGEN_INVOCATION\n\t\t\"${PYTHON}\" -m openage codegen\n\t\t\"--input-dir=${CMAKE_SOURCE_DIR}\"\n\t\t\"--output-dir=${CMAKE_BINARY_DIR}\"\n\t\t\"--generated-list-file=${CMAKE_BINARY_DIR}/codegen_generated_files\"\n\t\t\"--depend-list-file=${CMAKE_BINARY_DIR}/codegen_depends\")\n\n\texecute_process(COMMAND\n\t\t${CODEGEN_INVOCATION} --mode=dryrun\n\t\tWORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\"\n\t\tRESULT_VARIABLE COMMAND_RESULT\n\t)\n\n\tif(NOT ${COMMAND_RESULT} EQUAL 0)\n\t\tmessage(FATAL_ERROR \"failed to get target list from codegen invocation\")\n\tendif()\n\n\tFILE(READ \"${CMAKE_BINARY_DIR}/codegen_generated_files\" CODEGEN_TARGET_FILES)\n\tFILE(READ \"${CMAKE_BINARY_DIR}/codegen_depends\" CODEGEN_DEPENDS)\n\tSTRING(REGEX REPLACE \"\\n\" \";\" CODEGEN_TARGET_FILES ${CODEGEN_TARGET_FILES})\n\tSTRING(REGEX REPLACE \"\\n\" \";\" CODEGEN_DEPENDS ${CODEGEN_DEPENDS})\n\n\t# as the codegen creates all files at once,\n\t# let the buildsystem only depend on this single dummy file.\n\t# otherwise the codegen invocation would be done for each generated source.\n\tset(CODEGEN_TIMEFILE \"${CMAKE_BINARY_DIR}/codegen_timefile\")\n\n\tadd_custom_command(\n\t\tOUTPUT \"${CODEGEN_TIMEFILE}\"\n\t\tBYPRODUCTS ${CODEGEN_TARGET_FILES}\n\t\tCOMMAND ${CODEGEN_INVOCATION} --mode=codegen \"--touch-file-on-cache-change=${CMAKE_CURRENT_LIST_FILE}\" --force-rerun-on-generated-list-change\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E touch \"${CODEGEN_TIMEFILE}\"\n\t\tWORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\"\n\t\tDEPENDS ${CODEGEN_DEPENDS}\n\t\tCOMMENT \"openage.codegen: generating c++ code\"\n\t)\n\n\tadd_custom_target(cppgen\n\t\tDEPENDS \"${CODEGEN_TIMEFILE}\"\n\t)\n\n\tadd_custom_target(cleancodegen\n\t\tCOMMAND ${CODEGEN_INVOCATION} --mode=clean\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E remove \"${CODEGEN_TIMEFILE}\"\n\t\tWORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\"\n\t)\n\n\tget_codegen_scu_file()\n\tget_filename_component(CODEGEN_SCU_DIR ${CODEGEN_SCU_FILE} DIRECTORY)\n\n\tset(CODEGEN_SCU_CONTENT \"// Generated by codegen.\\n\\n\")\n\tlist(SORT CODEGEN_TARGET_FILES)\n\tforeach(target ${CODEGEN_TARGET_FILES})\n\t\tif(\"${target}\" MATCHES \"\\\\.cpp$\")\n\t\t\tfile(RELATIVE_PATH target_rel ${CODEGEN_SCU_DIR} ${target})\n\t\t\tstring(APPEND CODEGEN_SCU_CONTENT \"#include \\\"${target_rel}\\\"\\n\")\n\t\tendif()\n\tendforeach()\n\n\twrite_on_change(${CODEGEN_SCU_FILE} \"${CODEGEN_SCU_CONTENT}\")\nendfunction()\n" }, { "path": "buildsystem/compilepy.py", "content": "# Copyright 2015-2022 the openage authors. See copying.md for legal info.\n\n\"\"\"\nCompiles python modules with cpython to pyc/pyo files.\n\"\"\"\n\nimport argparse\nimport importlib.util\nimport os\nimport py_compile\nimport shutil\nimport sys\n\n\ndef clone_file_to_dir(sourcefile, input_dir, output_dir):\n \"\"\"\n Make a copy of sourcefile from input_dir to output_dir\n Try hardlinking first; on failure fallback to copy.\n Caveat: source files already in output_dir are not cloned.\n\n :return: the path of file created in output_dir\n \"\"\"\n if os.path.samefile(input_dir, output_dir) or sourcefile.startswith(output_dir):\n return sourcefile\n\n relsrcpath = os.path.relpath(sourcefile, input_dir)\n targetfile = os.path.join(output_dir, relsrcpath)\n\n if os.path.exists(targetfile) and os.path.samefile(sourcefile, targetfile):\n return targetfile\n\n os.makedirs(os.path.dirname(targetfile), exist_ok=True)\n\n # try to hardlink\n try:\n os.link(sourcefile, targetfile)\n return targetfile\n except OSError:\n pass\n\n # we don't try to symlink, because then Python may \"intelligently\"\n # determine the actual location, and refuse to work.\n\n # fallback to copying the file\n shutil.copy(sourcefile, targetfile)\n\n return targetfile\n\n\ndef main():\n \"\"\" CLI entry point \"\"\"\n cli = argparse.ArgumentParser()\n cli.add_argument(\"pymodule_list_file\", help=(\n \"semicolon-separated list of all modules that shall be compiled\"\n ))\n cli.add_argument(\"input_dir\", help=(\n \"base directory where files from the above list are in.\"\n ))\n cli.add_argument(\"output_dir\", help=(\n \"base directory where output files will be created.\"\n ))\n cli.add_argument(\"--print-output-paths-only\", action=\"store_true\", help=(\n \"print the paths of the compiled output files and exit\"\n ))\n args = cli.parse_args()\n\n with open(args.pymodule_list_file, encoding='utf8') as fileobj:\n modules = fileobj.read().strip().split(';')\n if modules == ['']:\n modules = []\n\n if not os.path.isdir(args.output_dir):\n cli.error(f\"not a directory: '{args.output_dir}'\")\n\n all_output_files = []\n to_compile = []\n\n for module in modules:\n # the module is required in the output directory\n sourcefile = clone_file_to_dir(module, args.input_dir, args.output_dir)\n outputfile = importlib.util.cache_from_source(sourcefile)\n all_output_files.append(outputfile)\n\n if os.path.exists(outputfile):\n if os.path.getmtime(outputfile) >= os.path.getmtime(sourcefile):\n continue\n\n os.remove(outputfile)\n\n to_compile.append((sourcefile, outputfile))\n\n if args.print_output_paths_only:\n print(';'.join(all_output_files))\n sys.exit(0)\n\n maxwidth = len(str(len(to_compile)))\n for idx, (module, outputfile) in enumerate(to_compile):\n try:\n print(f\"[{idx+1:{maxwidth}}/{len(to_compile)}] \"\n f\"Compiling {module} to {outputfile}\")\n py_compile.compile(module, cfile=outputfile, doraise=True)\n\n except py_compile.PyCompileError as exc:\n print(f\"FAILED to compile '{exc.file}':\")\n print(exc.msg)\n sys.exit(1)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "buildsystem/cpp.cmake", "content": "# Copyright 2014-2018 the openage authors. See copying.md for legal info.\n\n# declare a new 'empty' executable file.\n# you need to use add_sources to add source files to it, and finalize_binary to finalize it.\n# then you can add libraries, include dirs, etc.\nfunction(declare_binary target_name output_name type)\n\t# create the executable\n\tif(type STREQUAL \"executable\")\n\t\tadd_executable(\"${target_name}\" ${sources})\n\telseif(type STREQUAL \"library\")\n\t\tadd_library(\"${target_name}\" SHARED ${sources})\n\tendif()\n\n\tset_target_properties(\"${target_name}\" PROPERTIES OUTPUT_NAME \"${output_name}\")\n\n\tset_property(GLOBAL APPEND PROPERTY SFT_BINARIES \"${target_name}\")\n\n\t# process further arguments\n\tforeach(flag ${ARGN})\n\t\tif(flag STREQUAL \"allow_no_undefined\")\n\t\t\tif(NOT type STREQUAL \"library\")\n\t\t\t\tmessage(FATAL_ERROR \"finalize_binary flag 'allow_no_undefined' is only valid for libraries!\")\n\t\t\tendif()\n\n\t\t\tif(NOT \"${CMAKE_CXX_FLAGS}\" MATCHES \"-fsanitize\" AND NOT MSVC)\n\t\t\t\tif(APPLE)\n\t\t\t\t\tset(link_flag \"-undefined,error\")\n\t\t\t\telse()\n\t\t\t\t\tset(link_flag \"--no-undefined\")\n\t\t\t\tendif()\n\t\t\t\tset_target_properties(\"${target_name}\" PROPERTIES\n\t\t\t\t\tCOMPILE_FLAGS \"${EXTRA_FLAGS}\"\n\t\t\t\t\tLINK_FLAGS \"-Wl,${link_flag}\"\n\t\t\t\t)\n\t\t\tendif()\n\t\telse()\n\t\t\tmessage(FATAL_ERROR \"declare_binary encountered unknown flag: ${flag}\")\n\t\tendif()\n\tendforeach()\nendfunction()\n\n\n# add source files to a binary\n#\n# by default, the filename is interpreted as relative to the current directory\n# to specify absolute filenames, write ABSOLUTE\n# to specify a file that will be auto-generated, write GENERATED, all files after\n# this modifier are marked as generated.\nfunction(add_sources target_name)\n\tset(generated FALSE)\n\n\tget_property(binary_list GLOBAL PROPERTY SFT_BINARIES)\n\tlist(FIND binary_list \"${target_name}\" index)\n\tif(index EQUAL -1)\n\t\tmessage(FATAL_ERROR \"attempting to add source to unknown binary ${target_name}\")\n\tendif()\n\n\tforeach(source ${ARGN})\n\t\tif(source STREQUAL GENERATED)\n\t\t\tset(generated TRUE)\n\t\telse()\n\t\t\tif(NOT IS_ABSOLUTE \"${source}\")\n\t\t\t\tset(source \"${CMAKE_CURRENT_SOURCE_DIR}/${source}\")\n\t\t\tendif()\n\t\t\tfile(TO_CMAKE_PATH \"${source}\" source)\n\n\t\t\t# add all sources as private, otherwise _ALL SOURCES_\n\t\t\t# would be compiled again for each library that links against\n\t\t\t# the $target_name\n\t\t\ttarget_sources(\"${target_name}\" PRIVATE \"${source}\")\n\n\t\t\tif(generated)\n\t\t\t\tset_source_files_properties(\"${source}\" PROPERTIES GENERATED ON)\n\t\t\t\tset_property(GLOBAL PROPERTY SFT_BINARY_HAS_GENERATED_SRCS_${target_name} TRUE)\n\t\t\tendif()\n\t\tendif()\n\tendforeach()\nendfunction()\n\n\n# finalize the executable definition\nfunction(finalize_binary target_name)\n\tget_property(has_generated_sources GLOBAL PROPERTY SFT_BINARY_HAS_GENERATED_SRCS_${target_name})\n\n\t# make the binary depend on codegen iff it has any generated files\n\t#if(has_generated_sources)\n\t#\tadd_dependencies(\"${target_name}\" codegen)\n\t#endif()\n\n\tpretty_print_target(\"cpp\" \"${target_name}\" \"[${source_file_count} sources]\")\nendfunction()\n" }, { "path": "buildsystem/cythonize.py", "content": "#!/usr/bin/env python3\n#\n# Copyright 2015-2025 the openage authors. See copying.md for legal info.\n\n\"\"\"\nRuns Cython on all modules that were listed via add_cython_module.\n\"\"\"\n\nimport argparse\nimport os\nimport sys\nfrom contextlib import redirect_stdout\nfrom multiprocessing import cpu_count\nfrom pathlib import Path\n\nfrom Cython.Build import cythonize\n\n\nclass LineFilter:\n \"\"\" Proxy for a stream (default stdout) to filter out whole unwanted lines \"\"\"\n # pylint: disable=too-few-public-methods\n def __init__(self, stream=None, filters=None):\n self.stream = stream or sys.stdout\n self.filters = filters or []\n self.buf = \"\"\n\n def __getattr__(self, attr_name):\n return getattr(self.stream, attr_name)\n\n def __enter__(self):\n return self\n\n def __exit__(self, *args):\n self.stream.write(self.buf)\n self.buf = \"\"\n\n def write(self, data):\n \"\"\"\n Writes to output stream, buffered line-wise,\n omitting lines given in to constructor in filter\n \"\"\"\n self.buf += data\n lines = self.buf.split('\\n')\n for line in lines[:-1]:\n if not any(f(line) for f in self.filters):\n self.stream.write(line + '\\n')\n self.buf = lines[-1]\n\n\nclass CythonFilter(LineFilter):\n \"\"\" Filters output of cythonize for useless warnings \"\"\"\n # pylint: disable=too-few-public-methods\n def __init__(self):\n filters = [\n lambda x: 'put \"# distutils: language=c++\" in your .pyx or .pxd file(s)' in x,\n lambda x: x.startswith('Compiling ') and x.endswith(' because it changed.')\n ]\n super().__init__(filters=filters)\n\n\ndef read_list_from_file(filename):\n \"\"\" Reads a semicolon-separated list of file entires \"\"\"\n with open(filename, encoding='utf8') as fileobj:\n data = fileobj.read().strip()\n\n return [Path(filename).resolve() for filename in data.split(';')]\n\n\ndef remove_if_exists(filename):\n \"\"\" Deletes the file (if it exists) \"\"\"\n if filename.is_file():\n print(filename.relative_to(os.getcwd()))\n filename.unlink()\n\n\ndef cythonize_wrapper(modules, force_optimized_lib = False, **kwargs):\n \"\"\" Calls cythonize, filtering useless warnings \"\"\"\n bin_dir, bin_modules = kwargs['build_dir'], []\n src_dir, src_modules = Path.cwd(), []\n\n for module in modules:\n if Path(bin_dir) in module.parents:\n bin_modules.append(str(module.relative_to(bin_dir)))\n else:\n src_modules.append(str(module.relative_to(src_dir)))\n\n with CythonFilter() as cython_filter:\n with redirect_stdout(cython_filter):\n if src_modules:\n cythonize(src_modules, **kwargs)\n if sys.platform == 'win32' and force_optimized_lib:\n win_use_optimized_lib_python(src_modules, bin_dir)\n\n if bin_modules:\n os.chdir(bin_dir)\n cythonize(bin_modules, **kwargs)\n if sys.platform == 'win32' and force_optimized_lib:\n win_use_optimized_lib_python(bin_modules, bin_dir)\n os.chdir(src_dir)\n\n\ndef win_use_optimized_lib_python(modules, path):\n \"\"\"\n Add an #ifdef statement in cythonized .cpp files to temporarily undefine _DEBUG before\n #include \"Python.h\"\n\n This function modifies the generated C++ files from Cython to prevent linking to\n the debug version of the Python library on Windows. The debug version of the\n Python library cannot import Python libraries that contain extension modules.\n see: https://github.com/python/cpython/issues/127619 (To unserstand the problem)\n see: https://stackoverflow.com/a/59566420 (To understand the soloution)\n \"\"\"\n\n for module in modules:\n module = str(module)\n if path:\n module = path + \"\\\\\" + module\n module = module.removesuffix(\".py\").removesuffix(\".pyx\")\n module = module + \".cpp\"\n with open(module, \"r\", encoding='utf8') as file:\n text = file.read()\n if not text.count(\"OPENAGE: UNDEF_DEBUG_INSERTED\"):\n text = text.replace(\n '#include \"Python.h\"',\n (\n \"\\n\\n// OPENAGE: UNDEF_DEBUG_INSERTED\\n\"\n \"// Avoid linking to the debug version of the Python library on Windows\\n\\n\"\n \"#ifdef _DEBUG\\n\"\n \"#define _DEBUG_WAS_DEFINED\\n\"\n \"#undef _DEBUG\\n#endif\\n\"\n \"#include \\\"Python.h\\\"\\n\"\n \"#ifdef _DEBUG_WAS_DEFINED\\n\"\n \"#define _DEBUG\\n\"\n \"#undef _DEBUG_WAS_DEFINED\\n\"\n \"#endif\\n\\n\"\n \"// OPENAGE: UNDEF_DEBUG_INSERTED\\n\\n\"\n ),\n 1\n )\n with open(module, \"w\", encoding='utf8') as file:\n file.write(text)\n\n\ndef main():\n \"\"\" CLI entry point \"\"\"\n cli = argparse.ArgumentParser()\n cli.add_argument(\"module_list\", help=(\n \"Module list file (semicolon-separated).\"\n ))\n cli.add_argument(\"embedded_module_list\", help=(\n \"Embedded module list file (semicolon-separated).\\n\"\n \"Modules in this list are compiled with the --embed option.\"\n ))\n cli.add_argument(\"depends_list\", help=(\n \"Dependency list file (semicolon-separated).\\n\"\n \"Contains all .pxd and other files that may get included.\\n\"\n \"Used to verify that all dependencies are properly listed \"\n \"in the CMake build configuration.\"\n ))\n cli.add_argument(\"--clean\", action=\"store_true\", help=(\n \"Clean compilation results and exit.\"\n ))\n cli.add_argument(\"--build-dir\", help=(\n \"Build output directory to generate the cpp files in.\"\n \"note: this is also added for module search path.\"\n ))\n cli.add_argument(\"--memcleanup\", type=int, default=0, help=(\n \"Generate memory cleanup code to make valgrind happy:\\n\"\n \"0: nothing, 1+: interned objects,\\n\"\n \"2+: cdef globals, 3+: types objects\"\n ))\n cli.add_argument(\"--threads\", type=int, default=cpu_count(),\n help=\"number of compilation threads to use\")\n cli.add_argument(\"--force_optimized_lib\", action=\"store_true\",\n help= \"edit compiled .cpp files to link to optimized version of python libary\")\n args = cli.parse_args()\n\n # cython emits warnings on using absolute paths to modules\n # https://github.com/cython/cython/issues/2323\n modules = read_list_from_file(args.module_list)\n embedded_modules = read_list_from_file(args.embedded_module_list)\n depends = set(read_list_from_file(args.depends_list))\n\n if args.clean:\n for module in modules + embedded_modules:\n rel_module = module.relative_to(Path.cwd())\n build_module = args.build_dir / rel_module\n remove_if_exists(build_module.with_suffix('.cpp'))\n remove_if_exists(build_module.with_suffix('.html'))\n sys.exit(0)\n\n from Cython.Compiler import Options\n Options.annotate = True\n Options.fast_fail = True\n Options.generate_cleanup_code = args.memcleanup\n Options.cplus = 1\n\n # build cython modules (emits shared libraries)\n cythonize_args = {\n 'compiler_directives': {'language_level': 3},\n 'build_dir': args.build_dir,\n 'include_path': [args.build_dir],\n 'nthreads': args.threads\n }\n\n # this is deprecated, but still better than\n # writing funny lines at the head of each file.\n cythonize_args['language'] = 'c++'\n\n cythonize_wrapper(modules, args.force_optimized_lib, **cythonize_args)\n\n # build standalone executables that embed the py interpreter\n Options.embed = \"main\"\n\n cythonize_wrapper(embedded_modules, args.force_optimized_lib, **cythonize_args)\n\n # verify depends\n from Cython.Build.Dependencies import _dep_tree\n\n depend_failed = False\n # TODO figure out a less hacky way of getting the depends out of Cython\n # pylint: disable=no-member, protected-access\n for module, files in _dep_tree.__cimported_files_cache.items():\n for filename in files:\n if not filename.startswith('.'):\n # system include starts with /\n continue\n\n if os.path.realpath(os.path.abspath(filename)) not in depends:\n print(\"\\x1b[31mERR\\x1b[m unlisted dependency: \" + filename)\n depend_failed = True\n\n if depend_failed:\n sys.exit(1)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "buildsystem/doxygen.cmake", "content": "# Copyright 2014-2016 the openage authors. See copying.md for legal info.\n\n# Doxygen integration\n\n# enable doxygen for all given folder names\nfunction(doxygen_init)\n\tfind_package(Doxygen)\n\tif(DOXYGEN_FOUND)\n\t\tfind_file(DOT dot HINTS \"/usr/bin/dot\")\n\n\t\tif(NOT ${DOT} STREQUAL \"DOT-NOTFOUND\")\n\t\t\tset(DOT_EXECUTABLE \"${DOT}\" PARENT_SCOPE)\n\t\t\tset(HAVE_DOT \"YES\" PARENT_SCOPE)\n\t\telse()\n\t\t\tset(DOT_EXECUTABLE \"/bin/false\" PARENT_SCOPE)\n\t\t\tset(HAVE_DOT \"NO\" PARENT_SCOPE)\n\t\t\tmessage(WARNING \"graphviz dot couldn't be found, you won't have cool graphs in the docs.\")\n\t\tendif()\n\tendif()\n\n\tset(DOXYGEN_EXECUTABLE \"${DOXYGEN_EXECUTABLE}\" PARENT_SCOPE)\n\tset(DOXYGEN_FOUND \"${DOXYGEN_FOUND}\" PARENT_SCOPE)\nendfunction()\n\nfunction(doxygen_configure)\n\tif(DOXYGEN_FOUND)\n\t\t# add doc target\n\t\tadd_custom_target(doc\n\t\t\t\"${DOXYGEN_EXECUTABLE}\" \"${CMAKE_BINARY_DIR}/Doxyfile\"\n\t\t\tWORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\"\n\t\t\tCOMMENT \"generating docs (via Doxygen)\"\n\t\t\tVERBATIM\n\t\t)\n\n\t\t# create doc folder name list\n\t\tforeach(folder ${ARGN})\n\t\t\tset(DOXYGEN_SCAN_FOLDERS \"${DOXYGEN_SCAN_FOLDERS} \\\"${CMAKE_CURRENT_SOURCE_DIR}/${folder}\\\"\")\n\t\tendforeach()\n\n\t\t# adapt doxygen config\n\t\tconfigure_file(\"${BUILDSYSTEM_DIR}/templates/Doxyfile.in\" \"${CMAKE_BINARY_DIR}/Doxyfile\" @ONLY)\n\telse()\n\t\t# add no-op doc target\n\t\tadd_custom_target(doc\n\t\t\tCOMMAND echo \"When you configured the project, Doxygen could not be found.\"\n\t\t\tCOMMAND echo \"Install Doxygen and `./configure` again, then try to generate docs.\"\n\t\t\tCOMMAND false\n\t\t\tVERBATIM\n\t\t)\n\t\tmessage(WARNING \"doxygen couldn't be found, you won't be able to generate docs\")\n\tendif()\nendfunction()\n\ndoxygen_init()\n" }, { "path": "buildsystem/doxygen_custom.css", "content": "/*******************************************************\n * Make footer black and content white\n */\n\nbody {\n\tbackground-color: #445;\n}\n\ndiv.contents {\n\tbackground-color: white;\n\tpadding-top: 10px;\n\tpadding-left: 12px;\n\tpadding-right: 8px;\n\tpadding-bottom: 1em;\n\tmargin: 0;\n}\n\n\n/*******************************************************\n * Header\n */\n\n#titlearea {\n\tpadding: 1em 0;\n\tbackground-color: white;\n\tborder-bottom: 2px solid #5373B4;\n}\n\n#projectlogo {\n\tpadding-left: 1em;\n\ttext-align: left;\n}\n\n#projectlogo img {\n\theight: 6em;\n}\n\n#projectname {\n\tvisibility: hidden; /* Hide project name, it's already on the logo */\n\ttext-align: right;\n\tpadding-right: .3em;\n}\n\n#projectnumber {\n\tvisibility: visible; /* Show openage version, because this is a children of\n\t #projectname and I've made that invisible */\n}\n\n#projectalign {\n\twidth: 100%; /* So I can align the version number to the right */\n}\n\n\n/*******************************************************\n * Main navbar\n */\n\n.sm {\n\tbackground-image: none;\n\tbackground-color: black;\n}\n\n.sm a {\n\tbackground-image: none;\n\tbackground-color: black;\n\tcolor: white;\n\ttext-shadow: 0 1px 1px black;\n\tborder: none;\n}\n\n.sm a.highlighted,\n.sm a:hover,\n.sm a:active,\n.sm a:focus {\n\tbackground-image: url(\"tab_a.png\");\n\tbackground-repeat: repeat;\n\ttext-shadow: 0 1px 1px black;\n\tborder: none;\n}\n\n.sm ul a.highlighted,\n.sm ul a:hover,\n.sm ul a:active,\n.sm ul a:focus {\n\tbackground-image: none;\n\tbackground-color: #ccc;\n\ttext-shadow: none;\n\tborder: none;\n\tcolor: inherit;\n}\n\n/*\n * Those tiny arrows are instead a 0px box with a 4px border, that triangle it's\n * the one border, the remaining borders are transparent\n */\n.sm a span.sub-arrow {\n\tborder-color: white transparent transparent transparent;\n}\n\n.sm ul a span.sub-arrow {\n\tborder-color: transparent transparent transparent black;\n}\n\n.sm ul a.highlighted span.sub-arrow {\n\tborder-color: transparent transparent transparent white;\n}\n\n\n/*******************************************************\n * Hierarchy navbar\n */\n\n.navpath ul {\n\tbackground-color: #445;\n\tbackground-image: none;\n\n\tborder: 0;\n}\n\n.navpath ul li.navelem {\n\tcolor: white;\n}\n\n.navpath ul li.navelem a {\n\tcolor: #eee;\n\ttext-shadow: 0px 1px 1px black;\n}\n\n.navpath ul li.navelem a:hover {\n\tcolor: white;\n\ttext-decoration: underline;\n}\n\n/*******************************************************\n * Directory tables\n */\n\ntable.directory tr.even {\n\tbackground-color: #eee;\n}\n\ntable.directory td.entry {\n\tcolor: #444;\n}\n\ntable.directory td.desc {\n\tborder-left: 2px solid white;\n}\n\n/* Icons looked off */\n.iconfclosed,\n.iconfopen,\n.icondoc {\n\tmargin-top: 3px;\n}\n\n\n/*******************************************************\n * Footer\n */\n\nhr.footer {\n\tdisplay: none;\n}\n\naddress.footer {\n\t/*background-color: black;*/\n\tcolor: white;\n\tpadding: 1em;\n\tborder-top: 2px solid #aac;\n}\n\ndiv.contents {\n\tbackground-color: white;\n\tpadding-top: 10px;\n\tpadding-left: 12px;\n\tpadding-right: 8px;\n\tpadding-bottom: 1em;\n\tmargin: 0;\n}\n\n\n/*******************************************************\n * Content\n */\n\ndiv.textblock {\n\tmax-width: 900px;\n}\n\n/*\n * Single-line code blocks\n */\npre.fragment {\n\tpadding: .7em;\n\tborder: none;\n\tbackground-color: #f2f2f5;\n}\n\n/*\n * Multiple-line code blocks\n */\ndiv.fragment {\n\tborder: none;\n\tbackground-color: #f2f2f5;\n\tpadding: .7em;\n}\n\ndiv.fragment div.line {\n\tpadding: .5em;\n\ttext-indent: 0;\n}\n\ndiv.fragment div.line span.lineno {\n\tpadding: .5em;\n\ttext-indent: 0;\n\tborder-right: 2px solid #aac;\n}\n\n/*\n * Inline code\n */\ncode {\n\tbackground-color: #eee;\n\tpadding: 0.3em;\n\tmargin: 0;\n\tfont-size: 85%;\n\tborder-radius: 3px;\n}\n\n/*\n * Tables\n */\ntable.doxtable {\n\tborder-bottom: 1px solid #9CAFD4;\n}\n\ntable.doxtable th {\n\tbackground-color: #374F7F;\n\tcolor: white;\n\tborder: none;\n}\n\ntable.doxtable tr:nth-child(even) {\n\tbackground-color: #f2f2f5;\n}\n\ntable.doxtable tr:nth-child(odd) {\n\tbackground-color: white;\n}\n\ntable.doxtable td {\n\tborder: none;\n}\n\n/* Index letters (those in a black box) */\ndiv.ah, span.ah {\n\tbackground-color: black;\n\tbackground-image: none;\n\tborder: none;\n}\n\n/* Index bar */\ndiv.qindex {\n\tborder: 1px solid #bac8e4;\n\tborder-left: 0;\n\tborder-right: 0;\n\tpadding: .7em 0;\n\tbackground-color: white;\n}\n" }, { "path": "buildsystem/inplacemodules.py", "content": "# Copyright 2015-2021 the openage authors. See copying.md for legal info.\n\n\"\"\"\nInstalls the Python extension modules that were created in the configuration\nspecific subdirectory of the build directory to the places where they would\nbe expected.\n\nAttemts to use OS facilities such as hardlinking, and falls back to copying.\n\"\"\"\n\nimport argparse\nimport os\nfrom pathlib import Path\nimport shutil\n\n\ndef main():\n \"\"\" CLI entry point \"\"\"\n cli = argparse.ArgumentParser()\n cli.add_argument(\"module_list_file\", help=(\n \"semicolon-separated list of all modules that shall be installed \"\n \"in-place.\"\n ))\n cli.add_argument(\"configuration\", help=(\n \"the build configuration like Debug or Release\"\n ))\n cli.add_argument(\"--clean\", action=\"store_true\", help=(\n \"remove instead of creating\"\n ))\n args = cli.parse_args()\n\n with open(args.module_list_file, encoding='utf8') as fileobj:\n modules = fileobj.read().strip().split(';')\n if modules == ['']:\n modules = []\n\n for module in modules:\n sourcefile = Path(module)\n\n if args.configuration in sourcefile.parts:\n # If `sourcefile` has a configuration component, remove it.\n file_parts = list(sourcefile.parts)\n file_parts.remove(args.configuration)\n targetfile = Path(*file_parts)\n else:\n continue\n\n if targetfile.exists():\n if args.clean:\n print(targetfile)\n targetfile.unlink()\n continue\n\n if targetfile.stat().st_mtime >= sourcefile.stat().st_mtime:\n continue\n\n targetfile.unlink()\n\n if args.clean:\n continue\n\n # try to hardlink\n try:\n os.link(sourcefile, targetfile)\n continue\n except OSError:\n pass\n\n # we don't try to symlink, because then Python may \"intelligently\"\n # determine the actual location, and refuse to work.\n\n # fallback to copying the file\n shutil.copy(sourcefile, targetfile)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "buildsystem/modules/DownloadCache.cmake", "content": "# Copyright 2017-2017 the openage authors. See copying.md for legal info.\n\n# DownloadCache, as the name suggests, downloads a file and\n# if it succeeds, caches it for subsequent runs.\n\n# function args:\n# * url: the source URL to download the file from.\n# * download_path: the destination file path.\nfunction(download_cache url download_path)\n\tset(download_stamp_path \"${download_path}.stamp\")\n\tif(EXISTS \"${download_stamp_path}\")\n\t\tmessage(STATUS \"using cached ${download_path}\")\n\t\treturn()\n\tendif()\n\tfile(DOWNLOAD \"${url}\" \"${download_path}\"\n\t\tSTATUS download_status\n\t\tSHOW_PROGRESS\n\t)\n\tlist(GET download_status 0 status_code)\n\tif(NOT status_code EQUAL 0)\n\t\tlist(GET dowload_status 1 reason)\n\t\tmessage(FATAL_ERROR \"Failed to download from ${url}: ${reason}\")\n\tendif()\n\tfile(WRITE \"${download_stamp_path}\" \"\")\nendfunction()\n" }, { "path": "buildsystem/modules/FindCython.cmake", "content": "# Copyright 2015-2016 the openage authors. See copying.md for legal info.\n\n# This module defines:\n#\n# CYTHON_FOUND\n# CYTHON_VERSION - e.g. '0.23dev'\n# CYTHON - invocation (using python)\n#\n# It depends on:\n#\n# PYTHON\n\nset(CYTHON \"${PYTHON} -m cython\")\npy_exec(\"import cython; print(cython.__version__)\" CYTHON_VERSION)\n\ninclude(FindPackageHandleStandardArgs)\nfind_package_handle_standard_args(Cython VERSION_VAR CYTHON_VERSION REQUIRED_VARS CYTHON)\n" }, { "path": "buildsystem/modules/FindEpoxy.cmake", "content": "# Copyright 2015-2016 the openage authors. See copying.md for legal info.\n\nfind_path(EPOXY_INCLUDE_DIRS epoxy/gl.h\n\tHINTS\n\t$ENV{EPOXY_DIR}\n\tPATH_SUFFIXES include src\n\tPATHS\n\t/usr/include\n\t/usr/local/include\n\t/sw/include\n\t/opt/local/include\n\t/usr/freeware/include\n)\n\nfind_library(EPOXY_LIBRARIES\n\tNAMES epoxy\n\tHINTS\n\t$ENV{EPOXY_DIR}\n\tPATH_SUFFIXES lib64 lib\n\tPATHS\n\t/usr/lib\n\t/usr/local/lib\n\t/sw\n\t/usr/freeware\n)\n\ninclude(\"FindPackageHandleStandardArgs\")\nfind_package_handle_standard_args(Epoxy DEFAULT_MSG EPOXY_LIBRARIES EPOXY_INCLUDE_DIRS)\n\nmark_as_advanced(EPOXY_LIBRARIES EPOXY_INCLUDE_DIRS)\n" }, { "path": "buildsystem/modules/FindGCCBacktrace.cmake", "content": "# Copyright 2015-2017 the openage authors. See copying.md for legal info.\n\n# This module defines:\n#\n# GCCBacktrace_FOUND - whether libbacktrace was found\n# GCCBacktrace_INCLUDE_DIRS - The include dirs for libbacktrace\n# GCCBacktrace_LIBRARIES - The list of libraries\n\nfind_path(GCCBacktrace_INCLUDE_DIR \"backtrace.h\")\nfind_library(GCCBacktrace_LIBRARY\n\tNAMES\n\t\t\"backtrace\"\n\tPATHS\n\t\t/usr/lib\n\t\t/usr/local/lib\n\t\t/sw\n\t\t/usr/freeware\n)\n\ninclude(CheckCXXSourceCompiles)\nlist(APPEND CMAKE_REQUIRED_INCLUDES ${GCCBacktrace_INCLUDE_DIR})\nlist(APPEND CMAKE_REQUIRED_LIBRARIES ${GCCBacktrace_LIBRARY})\nset(CMAKE_REQUIRED_QUIET TRUE)\nCHECK_CXX_SOURCE_COMPILES(\"\n#include \n#include \n\nint callback(void * /* unused */, uintptr_t pc) {\n\tstd::cout << (void *) pc << std::endl;\n\treturn 0;\n}\n\nint main() {\n\tstruct backtrace_state *state = nullptr;\n\tstate = backtrace_create_state(nullptr, false, nullptr, nullptr);\n\tbacktrace_simple(state, 0, callback, nullptr, nullptr);\n\treturn 0;\n}\n\" HAVE_GCC_BACKTRACE)\n\nif(NOT HAVE_GCC_BACKTRACE)\n\tunset(GCCBacktrace_INCLUDE_DIR)\n\tunset(GCCBacktrace_LIBRARY)\nelse()\n\tset(GCCBacktrace_LIBRARIES ${GCCBacktrace_LIBRARY})\n\tset(GCCBacktrace_INCLUDE_DIRS ${GCCBacktrace_INCLUDE_DIR})\nendif()\n\n# handle the QUIETLY and REQUIRED arguments and set BACKTRACE_FOUND to TRUE if\n# all listed variables are TRUE\ninclude(FindPackageHandleStandardArgs)\nfind_package_handle_standard_args(\n\tGCCBacktrace\n\tFOUND_VAR GCCBacktrace_FOUND\n\tREQUIRED_VARS GCCBacktrace_LIBRARIES GCCBacktrace_INCLUDE_DIRS)\n\nmark_as_advanced(GCCBacktrace_LIBRARIES GCCBacktrace_INCLUDE_DIRS)\n" }, { "path": "buildsystem/modules/FindGPerfTools.cmake", "content": "# This file was taken from VAST,\n# Copyright 2014-2014 Matthias Vallentin.\n# It's licensed under the terms of the 3-clause BSD license.\n# Modifications Copyright 2014-2020 the openage authors.\n# See copying.md for further legal info.\n\n# Tries to find Gperftools.\n#\n# Usage of this module as follows:\n#\n# find_package(Gperftools)\n#\n# Variables used by this module, they can change the default behaviour and need\n# to be set before calling find_package:\n#\n# Gperftools_ROOT_DIR Set this variable to the root installation of\n# Gperftools if the module has problems finding\n# the proper installation path.\n#\n# Variables defined by this module:\n#\n# GPERFTOOLS_FOUND System has Gperftools libs/headers\n# GPERFTOOLS_LIBRARIES The Gperftools libraries (tcmalloc & profiler)\n# GPERFTOOLS_TCMALLOC The tcmalloc library\n# GPERFTOOLS_PROFILER The profiler library\n# GPERFTOOLS_INCLUDE_DIR The location of Gperftools headers\n\nfind_library(GPERFTOOLS_TCMALLOC\n\tNAMES tcmalloc\n\tHINTS ${Gperftools_ROOT_DIR}/lib)\n\nfind_library(GPERFTOOLS_PROFILER\n\tNAMES profiler\n\tHINTS ${Gperftools_ROOT_DIR}/lib)\n\nfind_library(GPERFTOOLS_TCMALLOC_AND_PROFILER\n\tNAMES tcmalloc_and_profiler\n\tHINTS ${Gperftools_ROOT_DIR}/lib)\n\nfind_path(GPERFTOOLS_INCLUDE_DIR\n\tNAMES gperftools/heap-profiler.h\n\tHINTS ${Gperftools_ROOT_DIR}/include)\n\nset(GPERFTOOLS_LIBRARIES ${GPERFTOOLS_TCMALLOC_AND_PROFILER})\n\ninclude(FindPackageHandleStandardArgs)\nfind_package_handle_standard_args(\n\tGPerfTools\n\tDEFAULT_MSG\n\tGPERFTOOLS_LIBRARIES\n\tGPERFTOOLS_INCLUDE_DIR)\n\nmark_as_advanced(\n\tGperftools_ROOT_DIR\n\tGPERFTOOLS_TCMALLOC\n\tGPERFTOOLS_PROFILER\n\tGPERFTOOLS_TCMALLOC_AND_PROFILER\n\tGPERFTOOLS_LIBRARIES\n\tGPERFTOOLS_INCLUDE_DIR)\n" }, { "path": "buildsystem/modules/FindHarfBuzz.cmake", "content": "# Copyright 2015-2016 the openage authors. See copying.md for legal info.\n\n# FindHarfBuzz\n# ---------\n#\n# Locate HarfBuzz, the awesome text shaping library.\n#\n# The module defines the following variables:\n#\n# ::\n#\n# HarfBuzz_FOUND - Found HarfBuzz library\n# HarfBuzz_INCLUDE_DIRS - HarfBuzz include directories\n# HarfBuzz_LIBRARIES - The libraries needed to use HarfBuzz\n# HarfBuzz_VERSION_STRING - the version of HarfBuzz found\n#\n# Example Usage:\n#\n# ::\n#\n# find_package(HarfBuzz REQUIRED)\n# include_directories(${HarfBuzz_INCLUDE_DIRS})\n#\n# ::\n#\n# add_executable(foo foo.cc)\n# target_link_libraries(foo ${HarfBuzz_LIBRARIES})\n\nfind_path(HarfBuzz_INCLUDE_DIR harfbuzz/hb.h\n\tHINTS $ENV{HARFBUZZ_DIR}\n\tPATHS\n\t\t/usr/include\n\t\t/usr/local/include\n\t\t/sw/include\n\t\t/opt/local/include\n\t\t/usr/freeware/include\n)\n\nfind_library(HarfBuzz_LIBRARY\n\tNAMES harfbuzz libharfbuzz\n\tHINTS $ENV{HARFBUZZ_DIR}\n\tPATH_SUFFIXES lib64 lib\n\tPATHS\n\t\t/usr/lib\n\t\t/usr/local/lib\n\t\t/sw\n\t\t/usr/freeware\n)\n\nif(HarfBuzz_INCLUDE_DIR)\n\tset(HarfBuzz_VERSION_FILE \"${HarfBuzz_INCLUDE_DIR}/harfbuzz/hb-version.h\")\n\tif(EXISTS \"${HarfBuzz_VERSION_FILE}\")\n\t\tfile(STRINGS \"${HarfBuzz_VERSION_FILE}\" hb_version_str\n\t\t REGEX \"^#define[\\t ]+HB_VERSION_STRING[\\t ]+\\\".*\\\"\")\n\n\t\tstring(REGEX REPLACE \"^#define[\\t ]+HB_VERSION_STRING[\\t ]+\\\"([^\\\"]*)\\\".*\" \"\\\\1\"\n\t\t HarfBuzz_VERSION_STRING \"${hb_version_str}\")\n\t\tunset(hb_version_str)\n\tendif()\n\tunset(HarfBuzz_VERSION_FILE)\nendif()\n\ninclude(FindPackageHandleStandardArgs)\nfind_package_handle_standard_args(HarfBuzz\n\tFOUND_VAR HarfBuzz_FOUND\n\tREQUIRED_VARS HarfBuzz_LIBRARY HarfBuzz_INCLUDE_DIR\n\tVERSION_VAR HarfBuzz_VERSION_STRING\n)\n\nif(HarfBuzz_FOUND)\n\tset(HarfBuzz_INCLUDE_DIRS \"${HarfBuzz_INCLUDE_DIR}\")\n\tset(HarfBuzz_LIBRARIES \"${HarfBuzz_LIBRARY}\")\nendif()\n\nmark_as_advanced(HarfBuzz_INCLUDE_DIR HarfBuzz_LIBRARY)\n" }, { "path": "buildsystem/modules/FindInotify.cmake", "content": "# Copyright 2014-2020 the openage authors. See copying.md for legal info.\n\n# This module defines\n#\n# INOTIFY_INCLUDE_DIR\n# INOTIFY_FOUND\n\nfind_path(INOTIFY_INCLUDE_DIR sys/inotify.h HINTS /usr/include/${CMAKE_LIBRARY_ARCHITECTURE})\n\ninclude(FindPackageHandleStandardArgs)\nfind_package_handle_standard_args(Inotify DEFAULT_MSG INOTIFY_INCLUDE_DIR)\n\nmark_as_advanced(INOTIFY_INCLUDE_DIR)\n" }, { "path": "buildsystem/modules/FindOgg.cmake", "content": "# Copyright 2018-2018 the openage authors. See copying.md for legal info.\n\n# - Find ogg library\n# Find the native Ogg headers and library.\n# This module defines\n# OGG_INCLUDE_DIRS - where to find ogg/ogg.h etc.\n# OGG_LIBRARIES - List of libraries when using libogg\n# OGG_FOUND - True if ogg is found.\n\nfind_path(OGG_INCLUDE_DIR\n\tNAMES ogg/ogg.h\n\tDOC \"Ogg include directory\"\n)\n\nfind_library(OGG_LIBRARY\n\tNAMES ogg\n\tDOC \"Path to ogg library\"\n)\n\n# handle the QUIETLY and REQUIRED arguments and set OGG_FOUND to TRUE if\n# all listed variables are TRUE\ninclude(FindPackageHandleStandardArgs)\nfind_package_handle_standard_args(Ogg DEFAULT_MSG OGG_LIBRARY OGG_INCLUDE_DIR)\n\nmark_as_advanced(OGG_INCLUDE_DIR OGG_LIBRARY)\n\n# export the variables\nset(OGG_LIBRARIES \"${OGG_LIBRARY}\")\nset(OGG_INCLUDE_DIRS \"${OGG_INCLUDE_DIR}\")\n" }, { "path": "buildsystem/modules/FindOpusfile.cmake", "content": "# This file was taken from Unvanquished,\n# Copyright 2000-2009 Kitware, Inc., Insight Software Consortium\n# It's licensed under the terms of the 3-clause OpenBSD license.\n# Modifications Copyright 2014-2020 the openage authors.\n# See copying.md for further legal info.\n\n# - Find opus library\n# Find the native Opus headers and libraries.\n# This module defines\n# OPUS_INCLUDE_DIRS - where to find opus/opus.h, opus/opusfile.h, etc\n# OPUS_LIBRARIES - List of libraries when using libopus\n# OPUSFILE_FOUND - True if opus is found.\n\n# find the opusfile header, defines our api.\nfind_path(OPUSFILE_INCLUDE_DIR\n\tNAMES opus/opusfile.h\n\tDOC \"Opusfile include directory\"\n)\nmark_as_advanced(OPUSFILE_INCLUDE_DIR)\n\n# find the opus header\nfind_path(OPUS_INCLUDE_DIR\n\tNAMES opus/opus.h\n\tDOC \"Opus include directory\"\n)\nmark_as_advanced(OPUS_INCLUDE_DIR)\n\n# look for libopusfile, the highlevel container-aware api.\nfind_library(OPUSFILE_LIBRARY\n\tNAMES opusfile\n\tDOC \"Path to OpusFile library\"\n)\nmark_as_advanced(OPUSFILE_LIBRARY)\n\n# find libopus, the core codec component.\nfind_library(OPUS_LIBRARY\n\tNAMES opus\n\tDOC \"Path to Opus library\"\n)\nmark_as_advanced(OPUS_LIBRARY)\n\n\n# handle the QUIETLY and REQUIRED arguments and set OPUS_FOUND to TRUE if\n# all listed variables are TRUE\ninclude(FindPackageHandleStandardArgs)\nfind_package_handle_standard_args(Opusfile DEFAULT_MSG OPUSFILE_LIBRARY OPUS_LIBRARY OPUS_INCLUDE_DIR)\n\n# export the variables\nset(OPUS_LIBRARIES \"${OPUSFILE_LIBRARY}\" \"${OPUS_LIBRARY}\")\nset(OPUS_INCLUDE_DIRS \"${OPUSFILE_INCLUDE_DIR}\" \"${OPUS_INCLUDE_DIR}\" \"${OPUS_INCLUDE_DIR}/opus\")\n" }, { "path": "buildsystem/modules/FindPython.cmake", "content": "# Copyright 2015-2025 the openage authors. See copying.md for legal info.\n\n# Find Python\n# ~~~~~~~~~~~\n#\n# Find the Python interpreter, and related info.\n#\n# This is a wrapper around FindPython3.cmake,\n# which sets many more variables:\n# https://cmake.org/cmake/help/latest/module/FindPython3.html\n#\n# This file defines the following variables:\n#\n# PYTHON_FOUND - True when python was found.\n# PYTHON - The full path to the Python interpreter.\n# PYTHON_INCLUDE_DIRS - Include path for Python extensions.\n# PYTHON_LIBRARIES - Library and Linker options for Python extensions.\n#\n# Also defines py_exec and py_get_config_var.\n\n###############################################################\n\nset(PYTHON_USED_VERSION \"${PYTHON_MIN_VERSION}\")\n\n# You can manually pass the directory to an interpreter\n# by defining PYTHON_DIR or passing -DPYTHON_DIR=\"\"\n# to CMake. It's used as a hint where to look at\n# https://cmake.org/cmake/help/latest/module/FindPython3.html#hints\nif(PYTHON_DIR)\n\tset(Python3_ROOT_DIR \"${PYTHON_DIR}\")\n\nelseif(Python3_ROOT_DIR OR Python3_EXECUTABLE)\n\t# python paths given directly\n\nelse()\n\t# when there are multiple pythons, preferrably use the version of\n\t# the default `python3` executable.\n\texecute_process(\n\t\tCOMMAND \"python3\" -c \"import platform; print(platform.python_version())\"\n\t\tOUTPUT_VARIABLE PYVER_OUTPUT\n\t\tRESULT_VARIABLE PYVER_RETVAL\n\t)\n\n\t# if a system version exists, check if it's compatible with our min requirements\n\tif(PYVER_RETVAL EQUAL 0)\n\t\tstring(REGEX MATCH \"^[0-9]+\\\\.[0-9]+\" PYTHON_USED_VERSION \"${PYVER_OUTPUT}\")\n\n\t\tif(PYTHON_USED_VERSION VERSION_GREATER_EQUAL PYTHON_MIN_VERSION)\n\t\t\t# set EXACT so we get the system version from find_package\n\t\t\tset(need_exact_version \"EXACT\")\n\n\t\telse()\n\t\t\t# search for alternatives if version doesn't fulfill min requirements\n\t\t\tset(PYTHON_USED_VERSION \"${PYTHON_MIN_VERSION}\")\n\n\t\tendif()\n\tendif()\nendif()\n###############################################################\n\n# Never use the Windows Registry to find python\nset(Python3_FIND_REGISTRY \"NEVER\")\n\n# use cmake's FindPython3 to locate library and interpreter\nfind_package(Python3 ${PYTHON_USED_VERSION} ${need_exact_version} COMPONENTS Interpreter Development NumPy)\n\n# python version string to cpython api test in modules/FindPython_test.cpp\n# we use the solution from CPython's header (see https://github.com/SFTtech/openage/issues/1438#issuecomment-1036311012):\n# define PY_VERSION_HEX ((PY_MAJOR_VERSION << 24) | \\\n# (PY_MINOR_VERSION << 16) | \\\n# (PY_MICRO_VERSION << 8) | \\\n# (PY_RELEASE_LEVEL << 4) | \\\n# (PY_RELEASE_SERIAL << 0))\nmath(EXPR BIT_SHIFT_HEX \"${Python3_VERSION_MAJOR} << 24 | ${Python3_VERSION_MINOR} << 16\" OUTPUT_FORMAT HEXADECIMAL)\nset(PYTHON_MIN_VERSION_HEX \"${BIT_SHIFT_HEX}\")\n\n\n# there's a static_assert that tests the Python version.\n# that way, we verify the interpreter and the library version.\n# (the interpreter provided us the library location)\n\nif(WIN32 AND \"${CMAKE_BUILD_TYPE}\" STREQUAL \"Debug\")\n\tset(TEMP_CMAKE_TRY_COMPILE_CONFIGURATION ${CMAKE_TRY_COMPILE_CONFIGURATION})\n\tset(CMAKE_TRY_COMPILE_CONFIGURATION \"Release\")\nendif()\n\ntry_compile(PYTHON_TEST_RESULT\n\t\"${CMAKE_BINARY_DIR}\"\n\tSOURCES \"${CMAKE_CURRENT_LIST_DIR}/FindPython_test.cpp\"\n\tLINK_LIBRARIES Python3::Python\n\tCXX_STANDARD ${CMAKE_CXX_STANDARD}\n\tCOMPILE_DEFINITIONS \"-DTARGET_VERSION=${PYTHON_MIN_VERSION_HEX}\"\n\tOUTPUT_VARIABLE PYTHON_TEST_OUTPUT\n)\n\nif(WIN32 AND \"${CMAKE_BUILD_TYPE}\" STREQUAL \"Debug\")\n\tset(CMAKE_TRY_COMPILE_CONFIGURATION ${TEMP_CMAKE_TRY_COMPILE_CONFIGURATION})\nendif()\n\n\nif(NOT PYTHON_TEST_RESULT)\n\tmessage(STATUS \"!! No suitable Python interpreter was found !!\n\nWe need a Python interpreter >= ${PYTHON_MIN_VERSION} that is shipped with libpython and header files.\nYou can tell the python find module where your python is installed:\n Executable location: -DPython3_EXECUTABLE=/path/to/executable\n Root directory: -DPython3_ROOT_DIR=/directory/of/executable/\n\nWe tried with Python ${PYTHON_FIND_VERSION}, but test compilation failed:\n\n${PYTHON_TEST_OUTPUT}\n\")\n\tmessage(FATAL_ERROR \"No suitable Python was found!\")\n\nelseif(PYTHON_TEST_RESULT)\n\t# Interfacing\n\t# Python.cmake vars <= Python3.cmake vars\n\tset(PYTHON ${Python3_EXECUTABLE} CACHE FILEPATH \"Location of the Python interpreter\" FORCE)\n\tset(PYTHON_FOUND ${Python3_Interpreter_FOUND})\n\tset(PYTHON_LIBRARIES ${Python3_LIBRARIES} CACHE STRING \"Linker invocation for the Python library\" FORCE)\n\tset(PYTHON_INCLUDE_DIRS ${Python3_INCLUDE_DIRS} CACHE PATH \"Location of the Python include dir\" FORCE)\n\tset(PYTHON_VERSION_STRING ${Python3_VERSION})\n\n\t# Numpy.cmake vars <= Python3.cmake vars\n\tset(NUMPY_FOUND ${Python3_NumPy_FOUND})\n\tset(NUMPY_VERSION ${Python3_NumPy_VERSION})\n\tset(NUMPY_INCLUDE_DIR ${Python3_NumPy_INCLUDE_DIRS} CACHE STRING \"Linker invocation for the NumPy library\" FORCE)\n\n\tinclude(FindPackageHandleStandardArgs)\n\tfind_package_handle_standard_args(Python REQUIRED_VARS PYTHON PYTHON_INCLUDE_DIRS PYTHON_LIBRARIES)\nendif()\n\nunset(PYTHON_TEST_RESULT)\nunset(PYTHON_TEST_OUTPUT)\n\n\n# helper functions\n\nfunction(py_exec STATEMENTS RESULTVAR)\n\t# executes some python statement(s), and returns the result in RESULTVAR.\n\t# aborts with a fatal error on error.\n\t# no single quotes are allowed in STATEMENTS.\n\texecute_process(\n\t\tCOMMAND \"${PYTHON}\" -c \"${STATEMENTS}\"\n\t\tOUTPUT_VARIABLE PY_OUTPUT\n\t\tRESULT_VARIABLE PY_RETVAL\n\t)\n\n\tif(NOT PY_RETVAL EQUAL 0)\n\t\tmessage(FATAL_ERROR \"failed:\\n${PYTHON} -c '${STATEMENTS}'\\n${PY_OUTPUT}\")\n\tendif()\n\n\tstring(STRIP \"${PY_OUTPUT}\" PY_OUTPUT_STRIPPED)\n\n\tset(\"${RESULTVAR}\" \"${PY_OUTPUT_STRIPPED}\" PARENT_SCOPE)\nendfunction()\n\n\nfunction(py_get_config_var VAR RESULTVAR)\n\t# uses py_exec to determine a config var as in sysconfig.get_config_var().\n\tpy_exec(\n\t\t\"from sysconfig import get_config_var; print(get_config_var('${VAR}'))\"\n\t\tRESULT\n\t)\n\n\tset(\"${RESULTVAR}\" \"${RESULT}\" PARENT_SCOPE)\nendfunction()\n" }, { "path": "buildsystem/modules/FindPython_test.cpp", "content": "// Copyright 2014-2023 the openage authors. See copying.md for legal info.\n\n#include \n\nint main() {\n\t// set by preprocessor:\n\tconstexpr uint64_t min_ver = TARGET_VERSION;\n\n\tstatic_assert(PY_VERSION_HEX >= min_ver, \"unsuitable: \" PY_VERSION);\n\n\tPy_Initialize();\n\tPy_Finalize();\n}\n" }, { "path": "buildsystem/options.cmake", "content": "# Copyright 2014-2018 the openage authors. See copying.md for legal info.\n\n# logs whether the option NAME is enabled\n# sets WITH_${VARNAME} to HAVE\n# errors if WANT_${VARNAME} conflicts with HAVE\nfunction(have_config_option NAME VARNAME HAVE)\n\tset(WANT \"${WANT_${VARNAME}}\")\n\tset(WITH_${VARNAME} \"${HAVE}\" PARENT_SCOPE)\n\n\tif(HAVE)\n\t\tset_property(GLOBAL APPEND PROPERTY SFT_CONFIG_OPTIONS_ENABLED \"${NAME}\")\n\n\t\tif(NOT WANT)\n\t\t\tmessage(FATAL_ERROR \"${NAME}: WANT_${VARNAME}=${WANT}, but WITH_${VARNAME}=${HAVE}\")\n\t\tendif()\n\telse()\n\t\tset_property(GLOBAL APPEND PROPERTY SFT_CONFIG_OPTIONS_DISABLED \"${NAME}\")\n\n\t\tif(WANT STREQUAL \"if_available\")\n\t\t\tmessage(STATUS \"optional dependency is unavailable: ${NAME}\")\n\t\telseif(WANT)\n\t\t\tmessage(FATAL_ERROR \"${NAME}: WANT_${VARNAME}=${WANT}, but WITH_${VARNAME}=${HAVE}\")\n\t\tendif()\n\tendif()\nendfunction()\n\nfunction(print_config_options)\n\tget_property(enabled_opts GLOBAL PROPERTY SFT_CONFIG_OPTIONS_ENABLED)\n\tget_property(disabled_opts GLOBAL PROPERTY SFT_CONFIG_OPTIONS_DISABLED)\n\n\tmessage(\"enabled options:\")\n\tif(enabled_opts)\n\t\tforeach(opt ${enabled_opts})\n\t\t\tmessage(\"\\t${opt}\")\n\t\tendforeach()\n\telse()\n\t\tmessage(\"\\t\")\n\tendif()\n\n\tmessage(\"\")\n\n\tmessage(\"disabled options:\")\n\tif(disabled_opts)\n\t\tforeach(opt ${disabled_opts})\n\t\t\tmessage(\"\\t${opt}\")\n\t\tendforeach()\n\telse()\n\t\tmessage(\"\\t\")\n\tendif()\n\n\tmessage(\"\")\nendfunction()\n\nfunction(get_config_option_string)\n\tget_property(enabled_opts GLOBAL PROPERTY SFT_CONFIG_OPTIONS_ENABLED)\n\n\tif(enabled_opts)\n\t\tLIST(GET enabled_opts 0 CONFIG_OPTION_STRING)\n\t\tLIST(REMOVE_AT enabled_opts 0)\n\n\t\tforeach(opt ${enabled_opts})\n\t\t\tset(CONFIG_OPTION_STRING \"${CONFIG_OPTION_STRING}, ${opt}\")\n\t\tendforeach()\n\telse()\n\t\tset(CONFIG_OPTION_STRING \"< no options enabled >\")\n\tendif()\n\n\tset(CONFIG_OPTION_STRING \"${CONFIG_OPTION_STRING}\" PARENT_SCOPE)\nendfunction()\n" }, { "path": "buildsystem/pxdgen.py", "content": "# Copyright 2015-2023 the openage authors. See copying.md for legal info.\n\n\"\"\"\nAuto-generates PXD files from annotated C++ headers.\n\nInvoked via cmake during the regular build process.\n\"\"\"\n\nimport argparse\nimport os\nfrom pathlib import Path\nimport re\nimport sys\n\nfrom pygments.token import Token\nfrom pygments.lexers import get_lexer_for_filename\n\n\nCWD = os.getcwd()\n\n\nclass ParserError(Exception):\n \"\"\"\n Represents a fatal parsing error in PXDGenerator.\n \"\"\"\n\n def __init__(self, filename, lineno, message):\n super().__init__(f\"{filename}:{lineno} {message}\")\n\n\nclass PXDGenerator:\n \"\"\"\n Represents, and performs, a single conversion of a C++ header file to a\n PXD file.\n\n @param filename:\n input (C++ header) file name. is opened and read.\n the output filename is the same, but with .pxd instead of .h.\n \"\"\"\n\n def __init__(self, filename):\n self.filename = filename\n\n self.warnings = []\n\n # current parsing state (not valid until self.parse() is called)\n self.stack, self.lineno, self.annotations = None, None, None\n\n def parser_error(self, message, lineno=None):\n \"\"\"\n Returns a ParserError object for this generator, at the current line.\n \"\"\"\n if lineno is None:\n lineno = self.lineno\n\n return ParserError(self.filename, lineno, message)\n\n def tokenize(self):\n \"\"\"\n Tokenizes the input file.\n\n Yields (tokentype, val) pairs, where val is a string.\n\n The concatenation of all val strings is equal to the input file's\n content.\n \"\"\"\n # contains all namespaces and other '{' tokens\n self.stack = []\n # current line number\n self.lineno = 1\n\n # we're using the pygments lexer (mainly because that was the first\n # google hit for 'python c++ lexer', and it's fairly awesome to use)\n\n lexer = get_lexer_for_filename('.cpp')\n\n with open(self.filename, encoding='utf8') as infile:\n code = infile.read()\n\n for token, val in lexer.get_tokens(code):\n # ignore whitespaces\n yield token, val\n self.lineno += val.count('\\n')\n\n def handle_singleline_comment(self, val):\n \"\"\"\n Breaks down a '//'-style single-line comment, and passes the result\n to handle_comment()\n\n @param val:\n the comment text, as string, including the '//'\n \"\"\"\n try:\n val = re.match('^// (.*)$', val).group(1)\n except AttributeError as ex:\n raise self.parser_error(\"invalid single-line comment\") from ex\n\n self.handle_comment(val)\n\n def handle_multiline_comment(self, val):\n \"\"\"\n Breaks down a '/* */'-style multi-line comment, and passes the result\n to handle_comment()\n\n @param val:\n the comment text, as string, including the '/*' and '*/'\n \"\"\"\n try:\n # pylint: disable=no-member\n val = re.match(r\"^/\\*(.*)\\*/$\", val, re.DOTALL).group(1)\n except AttributeError as ex:\n raise self.parser_error(\"invalid multi-line comment\") from ex\n\n # for a comment '/* foo\\n * bar\\n */', val is now 'foo\\n * bar\\n '\n # however, we'd prefer ' * foo\\n * bar'\n val = ' * ' + val.rstrip()\n # actually, we'd prefer [' * foo', ' * bar'].\n lines = val.split('\\n')\n\n comment_lines = []\n for idx, line in enumerate(lines):\n try:\n line = re.match(r'^ \\*( (.*))?$', line).group(2) or \"\"\n except AttributeError as ex:\n raise self.parser_error(\"invalid multi-line comment line\",\n idx + self.lineno) from ex\n\n # if comment is still empty, don't append anything\n if comment_lines or line.strip() != \"\":\n comment_lines.append(line)\n\n self.handle_comment('\\n'.join(comment_lines).rstrip())\n\n def handle_comment(self, val):\n \"\"\"\n Handles any comment, with its format characters removed,\n extracting the pxd annotation\n \"\"\"\n\n annotations = re.findall(r\"pxd:\\s(.*?)(:pxd|$)\",\n val, re.DOTALL) # pylint: disable=no-member\n annotations = [annotation[0] for annotation in annotations]\n\n if not annotations:\n raise self.parser_error(\"comment contains no valid pxd annotation\")\n\n for annotation in annotations:\n # remove empty lines at end\n annotation = annotation.rstrip()\n\n annotation_lines = annotation.split('\\n')\n for idx, line in enumerate(annotation_lines):\n if line.strip() != \"\":\n # we've found the first non-empty annotation line\n self.add_annotation(annotation_lines[idx:])\n break\n else:\n raise self.parser_error(\"pxd annotation is empty:\\n\" + val)\n\n def add_annotation(self, annotation_lines):\n \"\"\"\n Adds a (current namespace, pxd annotation) tuple to self.annotations.\n \"\"\"\n if \"{\" in self.stack:\n raise self.parser_error(\"PXD annotation is brace-enclosed\")\n if not self.stack:\n namespace = None\n else:\n namespace = \"::\".join(self.stack)\n\n self.annotations.append((namespace, annotation_lines))\n\n def handle_token(self, token, val):\n \"\"\"\n Handles one token while the parser is in its regular state.\n\n Returns the new state integer.\n \"\"\"\n # accept any token here\n if token == Token.Keyword and val == 'namespace':\n # advance to next state on 'namespace'\n return 1\n\n if (token, val) == (Token.Punctuation, '{'):\n # we're in a struct/class/...\n self.stack.append('{')\n\n elif (token, val) == (Token.Punctuation, '}'):\n try:\n # leave the struct/class/...\n self.stack.pop()\n except IndexError as ex:\n raise self.parser_error(\"unmatched '}'\") from ex\n\n elif token == Token.Comment.Single and 'pxd:' in val:\n self.handle_singleline_comment(val)\n\n elif token == Token.Comment.Multiline and 'pxd:' in val:\n self.handle_multiline_comment(val)\n\n else:\n # we don't care about all those other tokens\n pass\n\n return 0\n\n def parse(self):\n \"\"\"\n Parses the input file.\n\n Internally calls self.tokenize().\n\n Adds all found PXD annotations to self.annotations,\n together with info about the namespace in which they were encountered.\n \"\"\"\n\n def handle_state_0(self, token, val, namespace_parts):\n del namespace_parts\n return self.handle_token(token, val)\n\n def handle_state_1(self, token, val, namespace_parts):\n # we're inside a namespace definition; expect Token.Name\n # TODO: pygments 2.9 correctly reports Token.Name.Namespace\n # we can require this version eventually and change the condition\n if token not in Token.Name:\n raise self.parser_error(\n \"expected identifier after 'namespace'\")\n namespace_parts.append(val)\n return 2\n\n def handle_state_2(self, token, val, namespace_parts):\n # either :: or {\n # the former is for nested namespaces,\n # the latter ends the namespace\n if (token, val) == (Token.Operator, ':'):\n return 3\n\n if (token, val) != (Token.Punctuation, '{'):\n raise self.parser_error(\"expected '{' or '::' after \"\n f\"'namespace {self.stack[-1]}'\")\n # { found, so fill the stack\n self.stack.append('::'.join(namespace_parts))\n namespace_parts.clear()\n return 0\n\n def handle_state_3(self, token, val, namespace_parts):\n del namespace_parts\n if (token, val) == (Token.Operator, ':'):\n # now, a name must follow\n return 1\n\n raise self.parser_error(\"nested namespaces are separated \"\n \"with '::'\")\n\n transitions = {0: handle_state_0,\n 1: handle_state_1,\n 2: handle_state_2,\n 3: handle_state_3}\n\n self.annotations = []\n state = 0\n\n # to build up nested namespaces\n namespace_parts = []\n\n for token, val in self.tokenize():\n # ignore whitespaces\n if token in Token.Text and not val.strip():\n continue\n\n try:\n state = transitions[state](self, token, val, namespace_parts)\n\n except KeyError as exp:\n raise ValueError(\"reached invalid state in pxdgen\") from exp\n\n if self.stack:\n raise self.parser_error(\"expected '}', but found EOF\")\n\n def get_pxd_lines(self):\n \"\"\"\n calls self.parse() and processes the pxd annotations to pxd code lines.\n \"\"\"\n\n from datetime import datetime\n year = datetime.now().year\n yield (f\"# Copyright 2013-{year} the openage authors. \"\n \"See copying.md for legal info.\")\n\n yield \"\"\n\n yield (\"# Auto-generated from annotations in \" +\n self.filename.name)\n\n yield \"# \" + str(self.filename)\n\n self.parse()\n\n # namespace of the previous pxd annotation\n previous_namespace = None\n\n for namespace, annotation_lines in self.annotations:\n yield \"\"\n\n if namespace != previous_namespace:\n yield \"\"\n\n if namespace:\n prefix = \" \"\n\n if namespace != previous_namespace:\n yield (\n \"cdef extern \"\n \"from r\\\"\" + self.filename.as_posix() + \"\\\" \"\n \"namespace \\\"\" + namespace + \"\\\" \"\n \"nogil\"\n \":\"\n )\n else:\n prefix = \"\"\n\n for annotation in annotation_lines:\n annotation = self.postprocess_annotation_line(annotation)\n if annotation:\n yield prefix + annotation\n else:\n # don't emit a line that consists of just the prefix\n # (avoids trailing whitespace)\n yield \"\"\n\n previous_namespace = namespace\n\n yield \"\"\n\n def postprocess_annotation_line(self, annotation):\n \"\"\"\n Post-processes each individual annotation line, applying hacks and\n testing it, etc.\n\n See libopenage/pyinterface/hacks.h for documentation on the individual\n hacks.\n \"\"\"\n annotation = annotation.rstrip()\n if annotation.endswith(';'):\n self.warnings.append(\n \"cython declaration ends in ';', \"\n \"what have you done?\")\n\n if annotation.endswith(')'):\n self.warnings.append(\n \"mark the function as 'except +' or \"\n \"'noexcept':\\n\" + annotation)\n\n elif annotation.endswith('noexcept'):\n annotation = annotation[:-8].rstrip()\n\n if 'cdef ' in annotation:\n self.warnings.append(\n \"there's no need to use 'cdef' in PXD annotations:\\n\" +\n annotation)\n\n return annotation\n\n def generate(self, pxdfile, ignore_timestamps=False, print_warnings=True):\n \"\"\"\n reads the input file and writes the output file.\n the output file is updated only if its content will change.\n\n on parsing failure, raises ParserError.\n \"\"\"\n if not ignore_timestamps and os.path.exists(pxdfile):\n # skip the file if the timestamp is up to date\n if os.path.getmtime(self.filename) <= os.path.getmtime(pxdfile):\n return False\n\n result = \"\\n\".join(self.get_pxd_lines())\n\n if os.path.exists(pxdfile):\n with open(pxdfile, encoding='utf8') as outfile:\n if outfile.read() == result:\n # don't write the file if the content is up to date\n return False\n\n if not pxdfile.parent.is_dir():\n pxdfile.parent.mkdir()\n\n with pxdfile.open('w', encoding='utf8') as outfile:\n if pxdfile.is_absolute():\n printpath = pxdfile\n else:\n printpath = os.path.relpath(pxdfile, CWD)\n print(f\"\\x1b[36mpxdgen: generate {printpath}\\x1b[0m\")\n\n outfile.write(result)\n\n if print_warnings and self.warnings:\n print(f\"\\x1b[33;1mWARNING\\x1b[m pxdgen[{self.filename}]:\")\n for warning in self.warnings:\n print(warning)\n\n return True\n\n\ndef parse_args():\n \"\"\"\n pxdgen command-line interface.\n\n designed to allow both manual and automatic (via CMake) usage.\n \"\"\"\n cli = argparse.ArgumentParser()\n\n cli.add_argument('files', nargs='*', metavar='HEADERFILE',\n help=\"input files (usually cpp .h files).\")\n cli.add_argument('--file-list',\n help=(\"a file containing a semicolon-separated \"\n \"list of input files.\"))\n cli.add_argument('--ignore-timestamps', action='store_true',\n help=(\"force generating even if the output file is already\"\n \" up to date\"))\n cli.add_argument('--output-dir',\n help=(\"build directory corresponding to the CWD to write\"\n \" the generated file(s) in.\"))\n cli.add_argument('-v', '--verbose', action=\"store_true\",\n help=\"increase logging verbosity\")\n\n args = cli.parse_args()\n\n if args.file_list:\n with open(args.file_list, encoding='utf8') as flist:\n file_list = flist.read().strip().split(';')\n else:\n file_list = []\n\n from itertools import chain\n args.all_files = list(chain(args.files, file_list))\n\n return args\n\n\ndef main():\n \"\"\" CLI entry point \"\"\"\n args = parse_args()\n cppname = \"libopenage\"\n cppdir = Path(cppname).absolute()\n out_cppdir = Path(args.output_dir) / cppname\n\n if args.verbose:\n hdr_count = len(args.all_files)\n plural = \"s\" if hdr_count > 1 else \"\"\n\n print(f\"extracting pxd information from {hdr_count} header{plural}...\")\n\n for filename in args.all_files:\n filename = Path(filename).resolve()\n if cppdir not in filename.parents:\n print(f\"pxdgen source file is not in {cppdir!r}: {filename!r}\")\n sys.exit(1)\n\n # join out_cppdir with relative path from cppdir\n pxdfile_relpath = filename.with_suffix('.pxd').relative_to(cppdir)\n pxdfile = out_cppdir / pxdfile_relpath\n\n if args.verbose:\n print(f\"creating '{pxdfile}' for '{filename}':\")\n\n generator = PXDGenerator(filename)\n\n result = generator.generate(\n pxdfile,\n ignore_timestamps=args.ignore_timestamps,\n print_warnings=True\n )\n\n if args.verbose and not result:\n print(\"nothing done.\")\n\n # create empty __init__.py in all parent directories.\n # Cython requires this; else it won't find the .pxd files.\n for dirname in pxdfile_relpath.parents:\n template = out_cppdir / dirname / \"__init__\"\n for extension in (\"py\", \"pxd\"):\n initfile = template.with_suffix(\".\" + extension)\n if not initfile.exists():\n print(\"\\x1b[36mpxdgen: create package index \"\n f\"{initfile.relative_to(args.output_dir)}\\x1b[0m\")\n\n initfile.touch()\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "buildsystem/python.cmake", "content": "# Copyright 2014-2025 the openage authors. See copying.md for legal info.\n\n# provides macros for defining python extension modules and pxdgen sources.\n# and a 'finalize' function that must be called in the end.\n\nfunction(python_init)\n\t# filled by pxdgen; written to bin/py/pxdgen_sources for use by pxdgen.py.\n\tset_property(GLOBAL PROPERTY SFT_PXDGEN_SOURCES)\n\n\t# filled by add_cython_modules. used by cythonize.py.\n\tset_property(GLOBAL PROPERTY SFT_CYTHON_MODULES)\n\tset_property(GLOBAL PROPERTY SFT_CYTHON_MODULES_EMBED)\n\n\t# list of pxd files added manually\n\t# filled by add_pxds only. for use as depends list for cythonize.py.\n\tset_property(GLOBAL PROPERTY SFT_PXD_FILES)\n\n\t# filled by pxdgen. for use as output list for the pxdgen target.\n\tset_property(GLOBAL PROPERTY SFT_GENERATED_PXD_FILES)\n\n\t# filled with all .py filenames; used for installing.\n\tset_property(GLOBAL PROPERTY SFT_PY_FILES)\n\n\t# filled with the relative source dirs of the above py files.\n\tset_property(GLOBAL PROPERTY SFT_PY_FILES_RELSRCDIRS)\n\n\t# filled with all .py filenames that should not be installed.\n\tset_property(GLOBAL PROPERTY SFT_PY_FILES_NOINSTALL)\n\n\t# filled with all .py filenames that are installed to the elf binary directory.\n\tset_property(GLOBAL PROPERTY SFT_PY_FILES_BININSTALL)\n\n\t# filled with replacement names that are used for installing each entry in SFT_PY_FILES\n\t# special value __nope is used if no replacement should be done.\n\t# thank you cmake for not providing a dict\n\t# where i could just look the original name up to get the replacement name.\n\tset_property(GLOBAL PROPERTY SFT_PY_FILES_INSTALLNAMES)\n\n\t# filled with all cython module target names; used for in-place creation.\n\tset_property(GLOBAL PROPERTY SFT_CYTHON_MODULE_TARGETS)\nendfunction()\n\n\nfunction(cython_get_target_name RESULT_VAR)\n\tfile(RELATIVE_PATH REL_CURRENT_SOURCE_DIR\n\t\t\"${CMAKE_SOURCE_DIR}\"\n\t\t\"${CMAKE_CURRENT_SOURCE_DIR}\")\n\n\tget_filename_component(OUTPUTNAME \"${source}\" NAME_WE)\n\n\tset(TARGETNAME \"${REL_CURRENT_SOURCE_DIR}/${OUTPUTNAME}\")\n\tstring(REPLACE \"/\" \"_\" TARGETNAME \"${TARGETNAME}\")\n\n\tset(\"${RESULT_VAR}\" \"${TARGETNAME}\" PARENT_SCOPE)\nendfunction()\n\n\nfunction(cython_modname_sanitize RESULT_VAR SOURCE)\n\tif(NOT IS_ABSOLUTE \"${SOURCE}\")\n\t\tset(SOURCE \"${CMAKE_CURRENT_SOURCE_DIR}/${SOURCE}\")\n\tendif()\n\n\tif(NOT \"${SOURCE}\" MATCHES \".*\\\\.pyx?$\")\n\t\tmessage(FATAL_ERROR \"non-.py/.pyx file given: ${SOURCE}\")\n\tendif()\n\n\tset(\"${RESULT_VAR}\" \"${SOURCE}\" PARENT_SCOPE)\nendfunction()\n\n\nfunction(add_cython_modules)\n\t# adds a new module for cython compilation, by relative filename.\n\t# synoposis:\n\t# add_cython_modules(\n\t# test.pyx\n\t# EMBED __main__.pyx\n\t# STANDALONE EMBED foo/bar.pyx\n\t# NOINSTALL STANDALONE foo/test.pyx\n\t# )\n\t#\n\t# test.pyx is compiled to a shared library linked against PYEXT_LINK_LIBRARY\n\t# __main__.pyx is compiled to a executable with embedded python interpreter,\n\t# linked against libpython and PYEXT_LINK_LIBRARY.\n\t# foo/bar.pyx is compiled to a executable with embedded python interpreter,\n\t# linked only against libpython.\n\t# foo/test.pyx is compiled to a shared library linked against nothing, and will\n\t# not be installed.\n\t#\n\t# PYEXT_LINK_LIBRARY is linked to all non-standalone cython modules,\n\t# and is used e.g. to inject compiler options\n\n\tfile(RELATIVE_PATH REL_CURRENT_SOURCE_DIR\n\t\t\"${CMAKE_SOURCE_DIR}\"\n\t\t\"${CMAKE_CURRENT_SOURCE_DIR}\")\n\n\tset(EMBED_NEXT FALSE)\n\tset(STANDALONE_NEXT FALSE)\n\tset(NOINSTALL_NEXT FALSE)\n\tforeach(source ${ARGN})\n\t\tif(source STREQUAL \"EMBED\")\n\t\t\tset(EMBED_NEXT TRUE)\n\t\telseif(source STREQUAL \"STANDALONE\")\n\t\t\tset(STANDALONE_NEXT TRUE)\n\t\telseif(source STREQUAL \"NOINSTALL\")\n\t\t\tset(NOINSTALL_NEXT TRUE)\n\t\telse()\n\t\t\tcython_modname_sanitize(source \"${source}\")\n\n\t\t\t# construct some hopefully unique target name\n\t\t\tcython_get_target_name(TARGETNAME \"${source}\")\n\n\t\t\tget_filename_component(OUTPUTNAME \"${source}\" NAME_WE)\n\t\t\tset(CPPNAME \"${CMAKE_CURRENT_BINARY_DIR}/${OUTPUTNAME}.cpp\")\n\t\t\tset_source_files_properties(\"${CPPNAME}\" PROPERTIES GENERATED ON)\n\n\t\t\t# generate the pretty module name\n\t\t\tset(PRETTY_MODULE_NAME \"${REL_CURRENT_SOURCE_DIR}/${OUTPUTNAME}\")\n\t\t\tstring(REPLACE \"/\" \".\" PRETTY_MODULE_NAME \"${PRETTY_MODULE_NAME}\")\n\t\t\tstring(REGEX REPLACE \"^\\\\.\" \"\" PRETTY_MODULE_NAME \"${PRETTY_MODULE_NAME}\")\n\t\t\tset(PRETTY_MODULE_PROPERTIES \"\")\n\n\t\t\tif(EMBED_NEXT)\n\t\t\t\tset(PRETTY_MODULE_PROPERTIES \"${PRETTY_MODULE_PROPERTIES} [embedded interpreter]\")\n\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_CYTHON_MODULES_EMBED \"${source}\")\n\t\t\t\tadd_executable(\"${TARGETNAME}\" \"${CPPNAME}\")\n\n\t\t\t\tif(MINGW)\n\t\t\t\t\tset_target_properties(\"${TARGETNAME}\" PROPERTIES LINK_FLAGS \"-municode\")\n\t\t\t\tendif()\n\n\t\t\t\ttarget_link_libraries(\"${TARGETNAME}\" PRIVATE ${PYEXT_LIBRARY})\n\t\t\telse()\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_CYTHON_MODULES \"${source}\")\n\t\t\t\tadd_library(\"${TARGETNAME}\" MODULE \"${CPPNAME}\")\n\n\t\t\t\tset_target_properties(\"${TARGETNAME}\" PROPERTIES\n\t\t\t\t\tPREFIX \"\"\n\t\t\t\t\tSUFFIX \"${PYEXT_SUFFIX}\"\n\t\t\t\t)\n\n\t\t\t\tif(WIN32)\n\t\t\t\t\ttarget_link_libraries(\"${TARGETNAME}\" PRIVATE ${PYEXT_LIBRARY})\n\t\t\t\tendif()\n\t\t\tendif()\n\n\t\t\tif(NOINSTALL_NEXT)\n\t\t\t\tset(PRETTY_MODULE_PROPERTIES \"${PRETTY_MODULE_PROPERTIES} [noinstall]\")\n\t\t\telse()\n\t\t\t\tinstall(\n\t\t\t\t\tTARGETS \"${TARGETNAME}\"\n\t\t\t\t\tDESTINATION \"${CMAKE_PY_INSTALL_PREFIX}/${REL_CURRENT_SOURCE_DIR}\"\n\t\t\t\t)\n\t\t\tendif()\n\n\t\t\tset_target_properties(\"${TARGETNAME}\" PROPERTIES\n\t\t\t\tCOMPILE_FLAGS \"${PYEXT_CXXFLAGS}\"\n\t\t\t\tINCLUDE_DIRECTORIES \"${PYEXT_INCLUDE_DIRS}\"\n\t\t\t\tOUTPUT_NAME \"${OUTPUTNAME}\"\n\t\t\t)\n\n\t\t\tif (STANDALONE_NEXT)\n\t\t\t\tset(PRETTY_MODULE_PROPERTIES \"${PRETTY_MODULE_PROPERTIES} [standalone]\")\n\t\t\telse()\n\t\t\t\tset_target_properties(\"${TARGETNAME}\" PROPERTIES LINK_DEPENDS_NO_SHARED 1)\n\t\t\t\ttarget_link_libraries(\"${TARGETNAME}\" PRIVATE \"${PYEXT_LINK_LIBRARY}\")\n\t\t\tendif()\n\n\t\t\t# Since this module is not embedded with python interpreter,\n\t\t\t# Mac OS X requires a link flag to resolve undefined symbols\n\t\t\tif(NOT EMBED_NEXT AND APPLE)\n\t\t\t\tset_target_properties(\"${TARGETNAME}\" PROPERTIES LINK_FLAGS \"-undefined dynamic_lookup\" )\n\t\t\tendif()\n\n\t\t\tadd_dependencies(\"${TARGETNAME}\" cythonize)\n\n\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_CYTHON_MODULE_TARGETS \"${TARGETNAME}\")\n\n\t\t\tpretty_print_target(\"cython module\" \"${PRETTY_MODULE_NAME}\" \"${PRETTY_MODULE_PROPERTIES}\")\n\n\t\t\t# Reset the flags before processing the next cython module\n\t\t\tset(EMBED_NEXT FALSE)\n\t\t\tset(NOINSTALL_NEXT FALSE)\n\t\t\tset(STANDALONE_NEXT FALSE)\n\t\tendif()\n\tendforeach()\nendfunction()\n\n\nfunction(pyext_link_libraries SOURCE)\n\t# link a cython module to some libraries\n\t#\n\t# synoposis:\n\t# pyext_link_libraries(\n\t# somemodule.pyx\n\t# PNG::PNG\n\t# ${OPUS_LIBRARIES}\n\t# )\n\tcython_modname_sanitize(source \"${SOURCE}\")\n\tcython_get_target_name(TARGETNAME \"${SOURCE}\")\n\n\tforeach(library ${ARGN})\n\t\ttarget_link_libraries(\"${TARGETNAME}\" PRIVATE \"${library}\")\n\tendforeach()\nendfunction()\n\n\nfunction(pyext_include_directories SOURCE)\n\t# build a cython module with given include dirs\n\t#\n\t# synoposis:\n\t# pyext_include_directories(\n\t# somemodule.pyx\n\t# ${OPUS_INCLUDE_DIRS}\n\t# )\n\tcython_modname_sanitize(source \"${SOURCE}\")\n\tcython_get_target_name(TARGETNAME \"${SOURCE}\")\n\n\tforeach(directory ${ARGN})\n\t\ttarget_include_directories(\"${TARGETNAME}\" PRIVATE \"${directory}\")\n\tendforeach()\nendfunction()\n\n\nfunction(pxdgen)\n\t# add a C++ header file as pxdgen source file\n\tforeach(source ${ARGN})\n\t\tif(NOT IS_ABSOLUTE \"${source}\")\n\t\t\tset(source \"${CMAKE_CURRENT_SOURCE_DIR}/${source}\")\n\t\tendif()\n\n\t\tget_filename_component(source_ext \"${source}\" EXT)\n\t\tif(NOT \"${source_ext}\" STREQUAL \".h\")\n\t\t\tmessage(FATAL_ERROR \"non-.h file given to pxdgen: ${source}\")\n\t\tendif()\n\n\t\t# TODO: change if multiple files with the same name are supported in a directory\n\t\tget_filename_component(source_name_without_ext \"${source}\" NAME_WE)\n\t\tset(PXDNAME \"${CMAKE_CURRENT_BINARY_DIR}/${source_name_without_ext}.pxd\")\n\t\tset_source_files_properties(\"${PXDNAME}\" PROPERTIES GENERATED ON)\n\n\t\tset_property(GLOBAL APPEND PROPERTY SFT_PXDGEN_SOURCES \"${source}\")\n\t\tset_property(GLOBAL APPEND PROPERTY SFT_GENERATED_PXD_FILES \"${PXDNAME}\")\n\tendforeach()\nendfunction()\n\n\nfunction(add_pxds)\n\t# add a .pxd or other additional Cython source\n\tforeach(source ${ARGN})\n\t\tif(NOT IS_ABSOLUTE \"${source}\")\n\t\t\tset(source \"${CMAKE_CURRENT_SOURCE_DIR}/${source}\")\n\t\tendif()\n\n\t\tif(NOT \"${source}\" MATCHES \".*\\\\.px[id]$\")\n\t\t\tmessage(FATAL_ERROR \"non-pxd/pxi file given to add_pxds: ${source}\")\n\t\tendif()\n\n\t\tset_property(GLOBAL APPEND PROPERTY SFT_PXD_FILES \"${source}\")\n\tendforeach()\nendfunction()\n\n\nfunction(add_py_modules)\n\t# add a .py file for installing\n\t#\n\t# add_py_module (\n\t# somefile.py\n\t# NOINSTALL otherfile.py # do not install this file\n\t# BININSTALL wtf.py # install to $PREFIX/bin/wtf.py\n\t# BININSTALL lol.py AS rofl # install lol.py to $PREFIX/bin/rofl\n\t# )\n\t#\n\t# because cmake is such a nice language,\n\t# the handling of the above is quite painful.\n\n\tfile(RELATIVE_PATH REL_CURRENT_SOURCE_DIR \"${CMAKE_SOURCE_DIR}\" \"${CMAKE_CURRENT_SOURCE_DIR}\")\n\n\tset(NOINSTALL_NEXT FALSE)\n\tset(BININSTALL_NEXT FALSE)\n\tset(AS_NEXT FALSE)\n\tset(IN_BININSTALL FALSE)\n\tforeach(source ${ARGN})\n\t\t# keyword parsing so the next arg knows\n\t\t# what the previous keyword was.\n\t\tif(source STREQUAL \"NOINSTALL\")\n\t\t\tset(NOINSTALL_NEXT TRUE)\n\t\telseif(source STREQUAL \"BININSTALL\")\n\t\t\tset(BININSTALL_NEXT TRUE)\n\t\telseif(source STREQUAL \"AS\")\n\t\t\tset(AS_NEXT TRUE)\n\t\telse()\n\t\t\tif(NOT ${source} MATCHES \".*\\\\.py$\" AND NOT AS_NEXT)\n\t\t\t\tmessage(FATAL_ERROR \"non-Python file given to add_py_modules: ${source}\")\n\t\t\tendif()\n\n\t\t\tif(IN_BININSTALL AND NOT AS_NEXT)\n\t\t\t\t# if after the source file for /bin installation no AS\n\t\t\t\t# follows, normal source listings follow.\n\t\t\t\tset(IN_BININSTALL FALSE)\n\t\t\tendif()\n\n\t\t\tif(NOT IS_ABSOLUTE \"${source}\" AND NOT AS_NEXT)\n\t\t\t\t# make the source absolute, except when source is the \"AS $replacementname\"\n\t\t\t\tset(source \"${CMAKE_CURRENT_SOURCE_DIR}/${source}\")\n\t\t\tendif()\n\n\t\t\tif(NOINSTALL_NEXT OR BININSTALL_NEXT)\n\t\t\t\t# if source should not be installed or be installed to bin/\n\t\t\t\t# it is excluded from the big python installation list\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_PY_FILES_NOINSTALL \"${source}\")\n\t\t\t\tset(NOINSTALL_NEXT FALSE)\n\t\t\tendif()\n\n\t\t\tif(BININSTALL_NEXT)\n\t\t\t\t# if the file is to be installed to bin/\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_PY_FILES_BININSTALL \"${source}\")\n\t\t\t\tset(BININSTALL_NEXT FALSE)\n\t\t\t\tset(IN_BININSTALL TRUE)\n\t\t\tendif()\n\n\t\t\tif(AS_NEXT)\n\t\t\t\t# the replacement name must be after the BININSTALL definition\n\t\t\t\tif(NOT IN_BININSTALL)\n\t\t\t\t\tmessage(FATAL_ERROR \"you used AS without BININSTALL!\")\n\t\t\t\tendif()\n\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_PY_FILES_INSTALLNAMES \"${source}\")\n\t\t\telse()\n\t\t\t\t# in all cases except the \"AS $newname\",\n\t\t\t\t# add the python file to the to-compile list.\n\n\t\t\t\tif(\"${REL_CURRENT_SOURCE_DIR}\" STREQUAL \"\")\n\t\t\t\t\tset(REL_CURRENT_SOURCE_DIR \"./\")\n\t\t\t\tendif()\n\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_PY_FILES \"${source}\")\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_PY_FILES_RELSRCDIRS \"${REL_CURRENT_SOURCE_DIR}\")\n\t\t\tendif()\n\n\t\t\tif(NOT IN_BININSTALL)\n\t\t\t\t# don't replace the install name if we're in the \"AS $name\"\n\t\t\t\t# or no AS followed the BININSTALL\n\n\t\t\t\tset_property(GLOBAL APPEND PROPERTY SFT_PY_FILES_INSTALLNAMES \"__nope\")\n\t\t\tendif()\n\n\t\t\tif(AS_NEXT)\n\t\t\t\t# reset the alias and bin-install flags\n\t\t\t\t# so they count only for one (the current) source file.\n\t\t\t\tset(AS_NEXT FALSE)\n\t\t\t\tset(IN_BININSTALL FALSE)\n\t\t\tendif()\n\t\tendif()\n\tendforeach()\nendfunction()\n\n\nfunction(python_finalize)\n\t# pxdgen (.h -> .pxd)\n\n\tget_property(pxdgen_sources GLOBAL PROPERTY SFT_PXDGEN_SOURCES)\n\twrite_on_change(\"${CMAKE_BINARY_DIR}/py/pxdgen_sources\" \"${pxdgen_sources}\")\n\tset(PXDGEN_TIMEFILE \"${CMAKE_BINARY_DIR}/py/pxdgen_timefile\")\n\tadd_custom_command(OUTPUT \"${PXDGEN_TIMEFILE}\"\n\t\tCOMMAND \"${PYTHON}\" -m buildsystem.pxdgen\n\t\t--file-list \"${CMAKE_BINARY_DIR}/py/pxdgen_sources\"\n\t\t--output-dir \"${CMAKE_BINARY_DIR}\"\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E touch \"${PXDGEN_TIMEFILE}\"\n\t\tDEPENDS ${pxdgen_sources} \"${CMAKE_BINARY_DIR}/py/pxdgen_sources\"\n\t\tCOMMENT \"pxdgen: generating .pxd files from headers\"\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t)\n\tadd_custom_target(pxdgen ALL DEPENDS \"${PXDGEN_TIMEFILE}\")\n\n\n\t# cythonize (.pyx -> .cpp)\n\n\tget_property(cython_modules GLOBAL PROPERTY SFT_CYTHON_MODULES)\n\twrite_on_change(\"${CMAKE_BINARY_DIR}/py/cython_modules\" \"${cython_modules}\")\n\tget_property(cython_modules_embed GLOBAL PROPERTY SFT_CYTHON_MODULES_EMBED)\n\twrite_on_change(\"${CMAKE_BINARY_DIR}/py/cython_modules_embed\" \"${cython_modules_embed}\")\n\tget_property(pxd_list GLOBAL PROPERTY SFT_PXD_FILES)\n\tget_property(generated_pxd_list GLOBAL PROPERTY SFT_GENERATED_PXD_FILES)\n\twrite_on_change(\"${CMAKE_BINARY_DIR}/py/pxd_list\" \"${pxd_list};${generated_pxd_list}\")\n\tset(CYTHONIZE_TIMEFILE \"${CMAKE_BINARY_DIR}/py/cythonize_timefile\")\n\tadd_custom_command(OUTPUT \"${CYTHONIZE_TIMEFILE}\"\n\t\t# remove unneeded files from the previous builds (if any)\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E remove -f\n\t\t\t\"${CMAKE_BINARY_DIR}/__init__.py\"\n\t\t\t\"${CMAKE_BINARY_DIR}/__init__.pxd\"\n\t\tCOMMAND \"${PYTHON}\" -m buildsystem.cythonize\n\t\t\"${CMAKE_BINARY_DIR}/py/cython_modules\"\n\t\t\"${CMAKE_BINARY_DIR}/py/cython_modules_embed\"\n\t\t\"${CMAKE_BINARY_DIR}/py/pxd_list\"\n\t\t${force_optimized_lib_flag}\n\t\t\"--build-dir\" \"${CMAKE_BINARY_DIR}\"\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E touch \"${CYTHONIZE_TIMEFILE}\"\n\t\tDEPENDS\n\t\t\"${PXDGEN_TIMEFILE}\"\n\t\t${cython_modules}\n\t\t${cython_modules_embed}\n\t\t${pxd_list}\n\t\t\"${CMAKE_BINARY_DIR}/py/cython_modules\"\n\t\t\"${CMAKE_BINARY_DIR}/py/cython_modules_embed\"\n\t\t\"${CMAKE_BINARY_DIR}/py/pxd_list\"\n\t\tCOMMENT \"cythonize.py: compiling .pyx files to .cpp\"\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t)\n\tadd_custom_target(cythonize ALL DEPENDS \"${CYTHONIZE_TIMEFILE}\")\n\n\n\t# py compile (.py -> .pyc)\n\n\tget_property(py_files GLOBAL PROPERTY SFT_PY_FILES)\n\tget_property(py_files_srcdirs GLOBAL PROPERTY SFT_PY_FILES_RELSRCDIRS)\n\tget_property(py_files_noinstall GLOBAL PROPERTY SFT_PY_FILES_NOINSTALL)\n\tget_property(py_files_bininstall GLOBAL PROPERTY SFT_PY_FILES_BININSTALL)\n\tget_property(py_install_names GLOBAL PROPERTY SFT_PY_FILES_INSTALLNAMES)\n\n\twrite_on_change(\"${CMAKE_BINARY_DIR}/py/py_files\" \"${py_files}\")\n\tset(COMPILEPY_TIMEFILE \"${CMAKE_BINARY_DIR}/py/compilepy_timefile\")\n\tset(COMPILEPY_INVOCATION\n\t\t\"${PYTHON}\" -m buildsystem.compilepy\n\t\t\"${CMAKE_BINARY_DIR}/py/py_files\"\n\t\t\"${CMAKE_SOURCE_DIR}\"\n\t\t\"${CMAKE_BINARY_DIR}\"\n\t)\n\n\t# determine the compiled file name for all source files\n\texecute_process(COMMAND\n\t\t${COMPILEPY_INVOCATION} \"--print-output-paths-only\"\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t\tOUTPUT_VARIABLE py_compiled_files\n\t\tRESULT_VARIABLE COMMAND_RESULT\n\t)\n\tif(NOT ${COMMAND_RESULT} EQUAL 0)\n\t\tmessage(FATAL_ERROR \"failed to get output list from compilepy invocation\")\n\tendif()\n\tstring(STRIP \"${py_compiled_files}\" py_compiled_files)\n\n\tadd_custom_command(OUTPUT \"${COMPILEPY_TIMEFILE}\"\n\t\tCOMMAND ${COMPILEPY_INVOCATION}\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E touch \"${COMPILEPY_TIMEFILE}\"\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t\tDEPENDS \"${CMAKE_BINARY_DIR}/py/py_files\" ${py_files}\n\t\tCOMMENT \"compiling .py files to .pyc files\"\n\t)\n\tadd_custom_target(compilepy ALL DEPENDS \"${COMPILEPY_TIMEFILE}\")\n\n\tlist(LENGTH py_files py_files_count)\n\tmath(EXPR py_files_count_range \"${py_files_count} - 1\")\n\n\tforeach(idx RANGE ${py_files_count_range})\n\t\tlist(GET py_files ${idx} pyfile)\n\t\tlist(GET py_compiled_files ${idx} pycfile)\n\t\tlist(GET py_files_srcdirs ${idx} pyrelsrcdir)\n\t\tlist(GET py_install_names ${idx} pyinstallname)\n\t\tfile(TO_CMAKE_PATH ${pycfile} pycfile)\n\n\t\tlist(FIND py_files_noinstall \"${pyfile}\" do_install)\n\t\tlist(FIND py_files_bininstall \"${pyfile}\" do_bininstall)\n\n\t\tif(do_install LESS 0)\n\t\t\tinstall(\n\t\t\t\tFILES \"${pyfile}\"\n\t\t\t\tDESTINATION \"${CMAKE_PY_INSTALL_PREFIX}/${pyrelsrcdir}\"\n\t\t\t)\n\t\t\tinstall(\n\t\t\t\tFILES \"${pycfile}\"\n\t\t\t\tDESTINATION \"${CMAKE_PY_INSTALL_PREFIX}/${pyrelsrcdir}/__pycache__\"\n\t\t\t)\n\t\telseif(do_bininstall GREATER -1)\n\t\t\t# install the python file to the elf binary dir\n\n\t\t\tif(\"${pyinstallname}\" STREQUAL \"__nope\")\n\t\t\t\tinstall(\n\t\t\t\t\tPROGRAMS \"${pyfile}\"\n\t\t\t\t\tDESTINATION \"${CMAKE_INSTALL_BINDIR}\"\n\t\t\t\t)\n\t\t\telse()\n\t\t\t\t# optionally, rename the file:\n\t\t\t\tinstall(\n\t\t\t\t\tPROGRAMS \"${pyfile}\"\n\t\t\t\t\tRENAME \"${pyinstallname}\"\n\t\t\t\t\tDESTINATION \"${CMAKE_INSTALL_BINDIR}\"\n\t\t\t\t)\n\t\t\tendif()\n\t\tendif()\n\tendforeach()\n\n\t##################################################\n\t# code generation\n\n\tcodegen_run()\n\n\t# inplace module install (bin/module.so -> module.so)\n\t# MSVC, Xcode (multi-config generators) produce outputs\n\t# in a directory different from `CMAKE_CURRENT_BINARY_DIR`.\n\t# link/copy the output files as required for the cython modules.\n\n\tget_property(cython_module_targets GLOBAL PROPERTY SFT_CYTHON_MODULE_TARGETS)\n\tset(cython_module_files_expr)\n\tforeach(cython_module_target ${cython_module_targets})\n\t\tlist(APPEND cython_module_files_expr \"$\")\n\tendforeach()\n\n\tset(INPLACEMODULES_LISTFILE \"${CMAKE_BINARY_DIR}/py/inplace_module_list_$\")\n\tfile(GENERATE\n\t\tOUTPUT ${INPLACEMODULES_LISTFILE}\n\t\tCONTENT \"${cython_module_files_expr}\"\n\t)\n\tset(INPLACEMODULES_INVOCATION\n\t\t\"${PYTHON}\" -m buildsystem.inplacemodules\n\t\t${INPLACEMODULES_LISTFILE}\n\t\t\"$\"\n\t)\n\tset(INPLACEMODULES_TIMEFILE \"${CMAKE_BINARY_DIR}/py/inplacemodules_timefile\")\n\tadd_custom_command(OUTPUT \"${INPLACEMODULES_TIMEFILE}\"\n\t\tCOMMAND ${INPLACEMODULES_INVOCATION}\n\t\tDEPENDS\n\t\t${INPLACEMODULES_LISTFILE} ${cython_module_targets}\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E touch \"${INPLACEMODULES_TIMEFILE}\"\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t\tCOMMENT \"creating in-place modules\"\n\t)\n\tadd_custom_target(inplacemodules ALL DEPENDS \"${INPLACEMODULES_TIMEFILE}\")\n\n\n\t# cleaning of all in-sourcedir stuff\n\n\tadd_custom_target(cleancython\n\t\tCOMMAND ${INPLACEMODULES_INVOCATION} --clean\n\t\tCOMMAND \"${PYTHON}\" -m buildsystem.cythonize --clean\n\t\t\"${CMAKE_BINARY_DIR}/py/cython_modules\"\n\t\t\"${CMAKE_BINARY_DIR}/py/cython_modules_embed\"\n\t\t\"${CMAKE_BINARY_DIR}/py/pxd_list\"\n\t\t\"--build-dir\" \"${CMAKE_BINARY_DIR}\"\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t)\n\tadd_custom_command(TARGET cleancython POST_BUILD\n\t\t# general deleters to catch files that have already been un-listed.\n\t\tCOMMAND find openage -name \"'*.cpp'\" -type f -print -delete\n\t\tCOMMAND find openage -name \"'*.html'\" -type f -print -delete\n\t\tCOMMAND find openage -name \"'*.so'\" -type f -print -delete\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E remove \"${CYTHONIZE_TIMEFILE}\"\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E remove \"${INPLACEMODULES_TIMEFILE}\"\n\t\tWORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\"\n\t)\n\n\tadd_custom_target(cleanpxdgen\n\t\tCOMMAND find libopenage -name \"'*.pxd'\" -type f -print -delete\n\t\tCOMMAND find libopenage -name \"__init__.py\" -type f -print -delete\n\t\tCOMMAND \"${CMAKE_COMMAND}\" -E remove \"${PXDGEN_TIMEFILE}\"\n\t\tWORKING_DIRECTORY \"${CMAKE_BINARY_DIR}\"\n\t)\n\n\n\t# check for any unlisted .py files, and error.\n\n\texecute_process(\n\t\tCOMMAND \"${PYTHON}\" -m buildsystem.check_py_file_list\n\t\t\"${CMAKE_BINARY_DIR}/py/py_files\"\n\t\t\"${CMAKE_SOURCE_DIR}/openage\"\n\t\tWORKING_DIRECTORY \"${CMAKE_SOURCE_DIR}\"\n\t\tRESULT_VARIABLE res\n\t)\n\tif(NOT res EQUAL 0)\n\t\tmessage(FATAL_ERROR \".py file listing inconsistent\")\n\tendif()\nendfunction()\n\npython_init()\n" }, { "path": "buildsystem/scripts/EmbedFont.cmake", "content": "# Copyright 2017-2017 the openage authors. See copying.md for legal info.\n\nif(NOT forward_variables)\n\tmessage(FATAL_ERROR \"CMake configuration variables not available. Please include(ForwardVariables.cmake)\")\nendif()\n\ninclude(\"${buildsystem_dir}/modules/DownloadCache.cmake\")\nset(dejavu_dir \"${downloads_dir}/DejaVu\")\nset(dejavu_zip \"dejavu-fonts-ttf-2.37.tar.bz2\")\nset(dejavu_zip_download_path \"${dejavu_dir}/${dejavu_zip}\")\n# TODO: disable downloading for CI builds. \ndownload_cache(\n\t\"https://github.com/dejavu-fonts/dejavu-fonts/releases/download/version_2_37/${dejavu_zip}\"\n\t\"${dejavu_zip_download_path}\"\n)\n\nexecute_process(COMMAND\n\t\"${CMAKE_COMMAND}\" -E tar xf \"${dejavu_zip_download_path}\"\n\tWORKING_DIRECTORY \"${dejavu_dir}\"\n)\n\nfile(GLOB_RECURSE dejavu_fonts \"${dejavu_dir}/DejaVuSerif*.ttf\")\nfile(COPY ${dejavu_fonts} DESTINATION \"${CMAKE_INSTALL_PREFIX}/share/fonts\")\n\nfile(GLOB_RECURSE dejavu_conf \"${dejavu_dir}/*dejavu-serif.conf\")\nfile(COPY ${dejavu_conf} DESTINATION \"${CMAKE_INSTALL_PREFIX}/${py_install_prefix}/fonts/conf.d\")\n" }, { "path": "buildsystem/scripts/EmbedPython.cmake", "content": "# Copyright 2017-2022 the openage authors. See copying.md for legal info.\n\nif(NOT forward_variables)\n\tmessage(FATAL_ERROR \"CMake configuration variables not available. Please include(ForwardVariables.cmake)\")\nendif()\n\ninclude(\"${buildsystem_dir}/modules/DownloadCache.cmake\")\nif(sizeof_void_p EQUAL 8)\n\tset(py_arch \"amd64\")\nelse()\n\tset(py_arch \"win32\")\nendif()\nset(python_embed_zip \"python-${py_version}-embed-${py_arch}.zip\")\nset(python_zip_download_path \"${downloads_dir}/${python_embed_zip}\")\n# TODO: disable downloading for CI builds. \ndownload_cache(\n\t\"https://www.python.org/ftp/python/${py_version}/${python_embed_zip}\"\n\t\"${python_zip_download_path}\"\n)\n\nexecute_process(COMMAND\n\t\"${CMAKE_COMMAND}\" -E tar xf \"${python_zip_download_path}\"\n\tWORKING_DIRECTORY \"${CMAKE_INSTALL_PREFIX}/${py_install_prefix}\"\n)\n\nexecute_process(COMMAND\n\t\"${PYTHON}\" \"${buildsystem_dir}/scripts/copy_modules.py\"\n\tnumpy PIL pyreadline3 readline\n\t\"${CMAKE_INSTALL_PREFIX}/${py_install_prefix}\"\n)\n" }, { "path": "buildsystem/scripts/EmbedWinDependencies.cmake", "content": "# Copyright 2017-2020 the openage authors. See copying.md for legal info.\n\nif(NOT forward_variables)\n\tmessage(FATAL_ERROR \"CMake configuration variables not available. Please include(ForwardVariables.cmake)\")\nendif()\n\nget_filename_component(cl_directory \"${cmake_linker}\" DIRECTORY)\nfind_program(dumpbin dumpbin.exe PATHS \"${cl_directory}\")\nif(NOT dumpbin)\n\tmessage(SEND_ERROR \"Cannot locate dumpbin.\")\n\treturn()\nendif()\n\n# Paths for applocal and powershell\nset(APPLOCAL_SCRIPT \"${vcpkg_dir}/../../scripts/buildsystems/msbuild/applocal.ps1\")\nset(POWERSHELL_COMMAND \"$ENV{SYSTEMROOT}/System32/WindowsPowerShell/v1.0/powershell.exe\")\n\n# function to wrap the dependency resolving and copying logic on Windows.\n# Inspired by `applocal.ps1` from vcpkg which recursively descends into the\n# dependency tree of a binary and copies each to the target directory.\nfunction(resolve binary)\n\tget_filename_component(bin_dir \"${binary}\" DIRECTORY)\n\texecute_process(COMMAND \"${dumpbin}\" /DEPENDENTS \"${binary}\"\n\t\tRESULT_VARIABLE dump_result\n\t\tOUTPUT_VARIABLE dump_output\n\t)\n\tif(NOT dump_result EQUAL 0)\n\t\tmessage(SEND_ERROR \"dumpbin returned ${dump_result}.\")\n\t\treturn()\n\tendif()\n\tstring(REGEX MATCHALL \" [^\\\\\\n]+\\\\.dll\" dll_list ${dump_output})\n\tforeach(item ${dll_list})\n\t\tstring(STRIP \"${item}\" dll_name)\n\t\tset(dll_src_path \"${vcpkg_dir}/bin/${dll_name}\")\n\t\tset(dll_dest_path \"${bin_dir}/${dll_name}\")\n\t\tif(NOT EXISTS \"${dll_dest_path}\" AND EXISTS \"${dll_src_path}\")\n\t\t\tmessage(STATUS \"Copying ${dll_name}\")\n\t\t\tfile(COPY \"${dll_src_path}\" DESTINATION \"${bin_dir}\")\n\t\t\tresolve(\"${dll_dest_path}\")\n\t\tendif()\n\tendforeach()\nendfunction()\n\n\n# windeployqt\nif(use_windeployqt AND windeployqt)\n\tforeach(file ${CMAKE_INSTALL_MANIFEST_FILES})\n\t\tif((file MATCHES \"\\\\.dll$\") AND NOT (\"${file}\" STREQUAL \"nyan.dll\"))\n\t\t\tresolve(\"${file}\")\n\t\t\tif(windeployqt)\n\t\t\t\tmessage(STATUS \"Calling windeployqt with ${file}.\")\n\t\t\t\texecute_process(COMMAND \"${CMAKE_COMMAND}\" -E env \"PATH=${vcpkg_dir}/bin;$ENV{PATH}\"\n\t\t\t\t\t\"${windeployqt}\"\n\t\t\t\t\t--qmldir \"${CMAKE_INSTALL_PREFIX}/${asset_dir}/qml\"\n\t\t\t\t\t--dir \"${CMAKE_INSTALL_PREFIX}/bin/qml\"\n\t\t\t\t\t--plugindir \"${CMAKE_INSTALL_PREFIX}/bin/plugins\"\n\t\t\t\t\t--libdir \"${CMAKE_INSTALL_PREFIX}/bin\"\n\t\t\t\t\t--list \"target\"\n\t\t\t\t\t--verbose 2\n\t\t\t\t\t\"${file}\"\n\t\t\t\t)\n\t\t\tendif()\n\t\tendif()\n\tendforeach()\nendif()\n\n# applocal\nif((EXISTS ${POWERSHELL_COMMAND}) AND (EXISTS ${APPLOCAL_SCRIPT}))\n\tforeach(file ${CMAKE_INSTALL_MANIFEST_FILES})\n\t\tif(file MATCHES \"\\\\.dll$\")\n\t\t\tmessage(STATUS \"Calling applocal.ps1 with ${file}.\")\n\t\t\texecute_process(COMMAND \"${POWERSHELL_COMMAND}\" \"${APPLOCAL_SCRIPT}\"\n\t\t\t\t\t-targetBinary \"${file}\"\n\t\t\t\t\t-installedDir \"${vcpkg_dir}/bin\"\n\t\t\t\t\t-tlogFile \"${LOGFILES_DIR}/applocal.log\"\n\t\t\t\t\t-copiedFilesLog \"${LOGFILES_DIR}/applocal_copied_files.log\"\n\t\t\t\t\tERROR_FILE \"${LOGFILES_DIR}/applocal_error.log\"\n\t\t\t\t\tOUTPUT_FILE \"${LOGFILES_DIR}/applocal_output.log\"\n\t\t\t)\n\t\tendif()\n\tendforeach()\nendif()\n\n# Copy qt.conf to python-directory\nfile(COPY \"${buildsystem_dir}/templates/qt.conf\"\n\tDESTINATION \"${CMAKE_INSTALL_PREFIX}/${py_install_prefix}\"\n)\n\n# The fonts directory defaults to the same directory as the executable.\n# In this case, it is python.exe at `py_install_prefix`.\nfile(COPY \"${vcpkg_dir}/tools/fontconfig/fonts\"\n\tDESTINATION \"${CMAKE_INSTALL_PREFIX}/${py_install_prefix}\"\n)\n\ninclude(\"${CMAKE_CURRENT_LIST_DIR}/EmbedFont.cmake\")\ninclude(\"${CMAKE_CURRENT_LIST_DIR}/EmbedPython.cmake\")\n" }, { "path": "buildsystem/scripts/copy_modules.py", "content": "# Copyright 2017-2020 the openage authors. See copying.md for legal info.\n\n\"\"\"\nCopies the specified modules to the required directory.\nUsed for packaging the python dependencies.\n\"\"\"\n\nimport argparse\nimport importlib\nimport importlib.abc\nimport importlib.util\nimport os\nimport shutil\nimport sys\n\n\ndef copy_module(name, destination):\n \"\"\"Copy the importable module 'name' to the 'destination' directory\"\"\"\n loader = importlib.util.find_spec(name).loader\n if not isinstance(loader, importlib.abc.FileLoader):\n sys.exit(f\"Loader for module {name} is not handled\")\n\n print(f'Copying \"{name}\" to \"{destination}\"')\n filename = loader.get_filename(name)\n if loader.is_package(name):\n pkgdir, _ = os.path.split(filename)\n shutil.copytree(pkgdir, os.path.join(destination, name))\n else:\n shutil.copy2(filename, destination)\n\n\ndef main():\n \"\"\" CLI entry point \"\"\"\n cli = argparse.ArgumentParser()\n cli.add_argument(\"pymodule_name\", nargs='+', help=(\n \"list of all modules that shall be copied\"\n ))\n cli.add_argument(\"dest_dir\", help=(\n \"destination directory where modules will be copied\"\n ))\n args = cli.parse_args()\n for module in args.pymodule_name:\n copy_module(module, args.dest_dir)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "buildsystem/templates/Doxyfile.in", "content": "# Doxyfile 1.8.12\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) for a project.\n#\n# All text after a double hash (##) is considered a comment and is placed in\n# front of the TAG it is preceding.\n#\n# All text after a single hash (#) is considered a comment and will be ignored.\n# The format is:\n# TAG = value [value, ...]\n# For lists, items can also be appended using:\n# TAG += value [value, ...]\n# Values that contain spaces should be placed between quotes (\\\" \\\").\n\n#---------------------------------------------------------------------------\n# Project related configuration options\n#---------------------------------------------------------------------------\n\n# This tag specifies the encoding used for all characters in the config file\n# that follow. The default is UTF-8 which is also the encoding used for all text\n# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv\n# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv\n# for the list of possible encodings.\n# The default value is: UTF-8.\n\nDOXYFILE_ENCODING = UTF-8\n\n# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\n# double-quotes, unless you are using Doxywizard) that should identify the\n# project for which the documentation is generated. This name is used in the\n# title of most generated pages and in a few other places.\n# The default value is: My Project.\n\nPROJECT_NAME = @PROJECT_NAME@\n\n# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\n# could be handy for archiving the generated documentation or if some version\n# control system is used.\n\nPROJECT_NUMBER = @PROJECT_VERSION@\n\n# Using the PROJECT_BRIEF tag one can provide an optional one line description\n# for a project that appears at the top of each page and should give viewer a\n# quick idea about the purpose of the project. Keep the description short.\n\nPROJECT_BRIEF =\n\n# With the PROJECT_LOGO tag one can specify a logo or an icon that is included\n# in the documentation. The maximum height of the logo should not exceed 55\n# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy\n# the logo to the output directory.\n\nPROJECT_LOGO = @CMAKE_SOURCE_DIR@/assets/logo/banner.png\n\n# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\n# into which the generated documentation will be written. If a relative path is\n# entered, it will be relative to the location where doxygen was started. If\n# left blank the current directory will be used.\n\nOUTPUT_DIRECTORY = doc\n\n# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-\n# directories (in 2 levels) under the output directory of each output format and\n# will distribute the generated files over these directories. Enabling this\n# option can be useful when feeding doxygen a huge amount of source files, where\n# putting all generated files in the same directory would otherwise causes\n# performance problems for the file system.\n# The default value is: NO.\n\nCREATE_SUBDIRS = YES\n\n# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII\n# characters to appear in the names of generated files. If set to NO, non-ASCII\n# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode\n# U+3044.\n# The default value is: NO.\n\nALLOW_UNICODE_NAMES = NO\n\n# The OUTPUT_LANGUAGE tag is used to specify the language in which all\n# documentation generated by doxygen is written. Doxygen will use this\n# information to generate all constant output in the proper language.\n# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,\n# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),\n# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,\n# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),\n# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,\n# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,\n# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,\n# Ukrainian and Vietnamese.\n# The default value is: English.\n\nOUTPUT_LANGUAGE = English\n\n# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member\n# descriptions after the members that are listed in the file and class\n# documentation (similar to Javadoc). Set to NO to disable this.\n# The default value is: YES.\n\nBRIEF_MEMBER_DESC = YES\n\n# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief\n# description of a member or function before the detailed description\n#\n# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n# brief descriptions will be completely suppressed.\n# The default value is: YES.\n\nREPEAT_BRIEF = YES\n\n# This tag implements a quasi-intelligent brief description abbreviator that is\n# used to form the text in various listings. Each string in this list, if found\n# as the leading text of the brief description, will be stripped from the text\n# and the result, after processing the whole list, is used as the annotated\n# text. Otherwise, the brief description is used as-is. If left blank, the\n# following values are used ($name is automatically replaced with the name of\n# the entity):The $name class, The $name widget, The $name file, is, provides,\n# specifies, contains, represents, a, an and the.\n\nABBREVIATE_BRIEF =\n\n# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n# doxygen will generate a detailed section even if there is only a brief\n# description.\n# The default value is: NO.\n\nALWAYS_DETAILED_SEC = NO\n\n# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all\n# inherited members of a class in the documentation of that class as if those\n# members were ordinary class members. Constructors, destructors and assignment\n# operators of the base classes will not be shown.\n# The default value is: NO.\n\nINLINE_INHERITED_MEMB = NO\n\n# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path\n# before files name in the file list and in the header files. If set to NO the\n# shortest path that makes the file name unique will be used\n# The default value is: YES.\n\nFULL_PATH_NAMES = YES\n\n# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\n# Stripping is only done if one of the specified strings matches the left-hand\n# part of the path. The tag can be used to show relative paths in the file list.\n# If left blank the directory from which doxygen is run is used as the path to\n# strip.\n#\n# Note that you can specify absolute paths here, but also relative paths, which\n# will be relative from the directory where doxygen is started.\n# This tag requires that the tag FULL_PATH_NAMES is set to YES.\n\nSTRIP_FROM_PATH =\n\n# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\n# path mentioned in the documentation of a class, which tells the reader which\n# header file to include in order to use a class. If left blank only the name of\n# the header file containing the class definition is used. Otherwise one should\n# specify the list of include paths that are normally passed to the compiler\n# using the -I flag.\n\nSTRIP_FROM_INC_PATH =\n\n# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\n# less readable) file names. This can be useful is your file systems doesn't\n# support long names like on DOS, Mac, or CD-ROM.\n# The default value is: NO.\n\nSHORT_NAMES = NO\n\n# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\n# first line (until the first dot) of a Javadoc-style comment as the brief\n# description. If set to NO, the Javadoc-style will behave just like regular Qt-\n# style comments (thus requiring an explicit @brief command for a brief\n# description.)\n# The default value is: NO.\n\nJAVADOC_AUTOBRIEF = YES\n\n# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\n# line (until the first dot) of a Qt-style comment as the brief description. If\n# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\n# requiring an explicit \\brief command for a brief description.)\n# The default value is: NO.\n\nQT_AUTOBRIEF = YES\n\n# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\n# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\n# a brief description. This used to be the default behavior. The new default is\n# to treat a multi-line C++ comment block as a detailed description. Set this\n# tag to YES if you prefer the old behavior instead.\n#\n# Note that setting this tag to YES also means that rational rose comments are\n# not recognized any more.\n# The default value is: NO.\n\nMULTILINE_CPP_IS_BRIEF = NO\n\n# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\n# documentation from any documented member that it re-implements.\n# The default value is: YES.\n\nINHERIT_DOCS = YES\n\n# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new\n# page for each member. If set to NO, the documentation of a member will be part\n# of the file/class/namespace that contains it.\n# The default value is: NO.\n\nSEPARATE_MEMBER_PAGES = NO\n\n# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\n# uses this value to replace tabs by spaces in code fragments.\n# Minimum value: 1, maximum value: 16, default value: 4.\n\nTAB_SIZE = 8\n\n# This tag can be used to specify a number of aliases that act as commands in\n# the documentation. An alias has the form:\n# name=value\n# For example adding\n# \"sideeffect=@par Side Effects:\\n\"\n# will allow you to put the command \\sideeffect (or @sideeffect) in the\n# documentation, which will result in a user-defined paragraph with heading\n# \"Side Effects:\". You can put \\n's in the value part of an alias to insert\n# newlines.\n\nALIASES =\n\n# This tag can be used to specify a number of word-keyword mappings (TCL only).\n# A mapping has the form \"name=value\". For example adding \"class=itcl::class\"\n# will allow you to use the command class in the itcl::class meaning.\n\nTCL_SUBST =\n\n# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources\n# only. Doxygen will then generate output that is more tailored for C. For\n# instance, some of the names that are used will be different. The list of all\n# members will be omitted, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_FOR_C = NO\n\n# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\n# Python sources only. Doxygen will then generate output that is more tailored\n# for that language. For instance, namespaces will be presented as packages,\n# qualified scopes will look different, etc.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_JAVA = NO\n\n# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n# sources. Doxygen will then generate output that is tailored for Fortran.\n# The default value is: NO.\n\nOPTIMIZE_FOR_FORTRAN = NO\n\n# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n# sources. Doxygen will then generate output that is tailored for VHDL.\n# The default value is: NO.\n\nOPTIMIZE_OUTPUT_VHDL = NO\n\n# Doxygen selects the parser to use depending on the extension of the files it\n# parses. With this tag you can assign which parser to use for a given\n# extension. Doxygen has a built-in mapping, but you can override or extend it\n# using this tag. The format is ext=language, where ext is a file extension, and\n# language is one of the parsers supported by doxygen: IDL, Java, Javascript,\n# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:\n# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:\n# Fortran. In the later case the parser tries to guess whether the code is fixed\n# or free formatted code, this is the default for Fortran type files), VHDL. For\n# instance to make doxygen treat .inc files as Fortran files (default is PHP),\n# and .f files as C (default is Fortran), use: inc=Fortran f=C.\n#\n# Note: For files without extension you can use no_extension as a placeholder.\n#\n# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\n# the files are not read by doxygen.\n\nEXTENSION_MAPPING =\n\n# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\n# according to the Markdown format, which allows for more readable\n# documentation. See http://daringfireball.net/projects/markdown/ for details.\n# The output of markdown processing is further processed by doxygen, so you can\n# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\n# case of backward compatibilities issues.\n# The default value is: YES.\n\nMARKDOWN_SUPPORT = YES\n\n# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up\n# to that level are automatically included in the table of contents, even if\n# they do not have an id attribute.\n# Note: This feature currently applies only to Markdown headings.\n# Minimum value: 0, maximum value: 99, default value: 0.\n# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.\n\nTOC_INCLUDE_HEADINGS = 0\n\n# When enabled doxygen tries to link words that correspond to documented\n# classes, or namespaces to their corresponding documentation. Such a link can\n# be prevented in individual cases by putting a % sign in front of the word or\n# globally by setting AUTOLINK_SUPPORT to NO.\n# The default value is: YES.\n\nAUTOLINK_SUPPORT = YES\n\n# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n# to include (a tag file for) the STL sources as input, then you should set this\n# tag to YES in order to let doxygen match functions declarations and\n# definitions whose arguments contain STL classes (e.g. func(std::string);\n# versus func(std::string) {}). This also make the inheritance and collaboration\n# diagrams that involve STL classes more complete and accurate.\n# The default value is: NO.\n\nBUILTIN_STL_SUPPORT = NO\n\n# If you use Microsoft's C++/CLI language, you should set this option to YES to\n# enable parsing support.\n# The default value is: NO.\n\nCPP_CLI_SUPPORT = NO\n\n# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\n# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen\n# will parse them like normal C++ but will assume all classes use public instead\n# of private inheritance when no explicit protection keyword is present.\n# The default value is: NO.\n\nSIP_SUPPORT = NO\n\n# For Microsoft's IDL there are propget and propput attributes to indicate\n# getter and setter methods for a property. Setting this option to YES will make\n# doxygen to replace the get and set methods by a property in the documentation.\n# This will only work if the methods are indeed getting or setting a simple\n# type. If this is not the case, or you want to show the methods anyway, you\n# should set this option to NO.\n# The default value is: YES.\n\nIDL_PROPERTY_SUPPORT = YES\n\n# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n# tag is set to YES then doxygen will reuse the documentation of the first\n# member in the group (if any) for the other members of the group. By default\n# all members of a group must be documented explicitly.\n# The default value is: NO.\n\nDISTRIBUTE_GROUP_DOC = NO\n\n# If one adds a struct or class to a group and this option is enabled, then also\n# any nested class or struct is added to the same group. By default this option\n# is disabled and one has to add nested compounds explicitly via \\ingroup.\n# The default value is: NO.\n\nGROUP_NESTED_COMPOUNDS = NO\n\n# Set the SUBGROUPING tag to YES to allow class member groups of the same type\n# (for instance a group of public functions) to be put as a subgroup of that\n# type (e.g. under the Public Functions section). Set it to NO to prevent\n# subgrouping. Alternatively, this can be done per class using the\n# \\nosubgrouping command.\n# The default value is: YES.\n\nSUBGROUPING = YES\n\n# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\n# are shown inside the group in which they are included (e.g. using \\ingroup)\n# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\n# and RTF).\n#\n# Note that this feature does not work in combination with\n# SEPARATE_MEMBER_PAGES.\n# The default value is: NO.\n\nINLINE_GROUPED_CLASSES = NO\n\n# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\n# with only public data fields or simple typedef fields will be shown inline in\n# the documentation of the scope in which they are defined (i.e. file,\n# namespace, or group documentation), provided this scope is documented. If set\n# to NO, structs, classes, and unions are shown on a separate page (for HTML and\n# Man pages) or section (for LaTeX and RTF).\n# The default value is: NO.\n\nINLINE_SIMPLE_STRUCTS = NO\n\n# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\n# enum is documented as struct, union, or enum with the name of the typedef. So\n# typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n# with name TypeT. When disabled the typedef will appear as a member of a file,\n# namespace, or class. And the struct will be named TypeS. This can typically be\n# useful for C code in case the coding convention dictates that all compound\n# types are typedef'ed and only the typedef is referenced, never the tag name.\n# The default value is: NO.\n\nTYPEDEF_HIDES_STRUCT = NO\n\n# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\n# cache is used to resolve symbols given their name and scope. Since this can be\n# an expensive process and often the same symbol appears multiple times in the\n# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\n# doxygen will become slower. If the cache is too large, memory is wasted. The\n# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\n# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\n# symbols. At the end of a run doxygen will report the cache usage and suggest\n# the optimal cache size from a speed point of view.\n# Minimum value: 0, maximum value: 9, default value: 0.\n\nLOOKUP_CACHE_SIZE = 0\n\n#---------------------------------------------------------------------------\n# Build related configuration options\n#---------------------------------------------------------------------------\n\n# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in\n# documentation are documented, even if no documentation was available. Private\n# class members and static file members will be hidden unless the\n# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\n# Note: This will also disable the warnings about undocumented members that are\n# normally produced when WARNINGS is set to YES.\n# The default value is: NO.\n\nEXTRACT_ALL = YES\n\n# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will\n# be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PRIVATE = YES\n\n# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal\n# scope will be included in the documentation.\n# The default value is: NO.\n\nEXTRACT_PACKAGE = NO\n\n# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be\n# included in the documentation.\n# The default value is: NO.\n\nEXTRACT_STATIC = YES\n\n# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined\n# locally in source files will be included in the documentation. If set to NO,\n# only classes defined in header files are included. Does not have any effect\n# for Java sources.\n# The default value is: YES.\n\nEXTRACT_LOCAL_CLASSES = YES\n\n# This flag is only useful for Objective-C code. If set to YES, local methods,\n# which are defined in the implementation section but not in the interface are\n# included in the documentation. If set to NO, only methods in the interface are\n# included.\n# The default value is: NO.\n\nEXTRACT_LOCAL_METHODS = NO\n\n# If this flag is set to YES, the members of anonymous namespaces will be\n# extracted and appear in the documentation as a namespace called\n# 'anonymous_namespace{file}', where file will be replaced with the base name of\n# the file that contains the anonymous namespace. By default anonymous namespace\n# are hidden.\n# The default value is: NO.\n\nEXTRACT_ANON_NSPACES = NO\n\n# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\n# undocumented members inside documented classes or files. If set to NO these\n# members will be included in the various overviews, but no documentation\n# section is generated. This option has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_MEMBERS = NO\n\n# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all\n# undocumented classes that are normally visible in the class hierarchy. If set\n# to NO, these classes will be included in the various overviews. This option\n# has no effect if EXTRACT_ALL is enabled.\n# The default value is: NO.\n\nHIDE_UNDOC_CLASSES = NO\n\n# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\n# (class|struct|union) declarations. If set to NO, these declarations will be\n# included in the documentation.\n# The default value is: NO.\n\nHIDE_FRIEND_COMPOUNDS = NO\n\n# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any\n# documentation blocks found inside the body of a function. If set to NO, these\n# blocks will be appended to the function's detailed documentation block.\n# The default value is: NO.\n\nHIDE_IN_BODY_DOCS = NO\n\n# The INTERNAL_DOCS tag determines if documentation that is typed after a\n# \\internal command is included. If the tag is set to NO then the documentation\n# will be excluded. Set it to YES to include the internal documentation.\n# The default value is: NO.\n\nINTERNAL_DOCS = NO\n\n# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file\n# names in lower-case letters. If set to YES, upper-case letters are also\n# allowed. This is useful if you have classes or files whose names only differ\n# in case and if your file system supports case sensitive file names. Windows\n# and Mac users are advised to set this option to NO.\n# The default value is: system dependent.\n\nCASE_SENSE_NAMES = YES\n\n# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\n# their full class and namespace scopes in the documentation. If set to YES, the\n# scope will be hidden.\n# The default value is: NO.\n\nHIDE_SCOPE_NAMES = NO\n\n# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will\n# append additional text to a page's title, such as Class Reference. If set to\n# YES the compound reference will be hidden.\n# The default value is: NO.\n\nHIDE_COMPOUND_REFERENCE= NO\n\n# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\n# the files that are included by a file in the documentation of that file.\n# The default value is: YES.\n\nSHOW_INCLUDE_FILES = YES\n\n# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each\n# grouped member an include statement to the documentation, telling the reader\n# which file to include in order to use the member.\n# The default value is: NO.\n\nSHOW_GROUPED_MEMB_INC = NO\n\n# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\n# files with double quotes in the documentation rather than with sharp brackets.\n# The default value is: NO.\n\nFORCE_LOCAL_INCLUDES = NO\n\n# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\n# documentation for inline members.\n# The default value is: YES.\n\nINLINE_INFO = YES\n\n# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\n# (detailed) documentation of file and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order.\n# The default value is: YES.\n\nSORT_MEMBER_DOCS = YES\n\n# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\n# descriptions of file, namespace and class members alphabetically by member\n# name. If set to NO, the members will appear in declaration order. Note that\n# this will also influence the order of the classes in the class list.\n# The default value is: NO.\n\nSORT_BRIEF_DOCS = NO\n\n# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\n# (brief and detailed) documentation of class members so that constructors and\n# destructors are listed first. If set to NO the constructors will appear in the\n# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\n# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\n# member documentation.\n# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\n# detailed member documentation.\n# The default value is: NO.\n\nSORT_MEMBERS_CTORS_1ST = NO\n\n# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\n# of group names into alphabetical order. If set to NO the group names will\n# appear in their defined order.\n# The default value is: NO.\n\nSORT_GROUP_NAMES = NO\n\n# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\n# fully-qualified names, including namespaces. If set to NO, the class list will\n# be sorted only by class name, not including the namespace part.\n# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n# Note: This option applies only to the class list, not to the alphabetical\n# list.\n# The default value is: NO.\n\nSORT_BY_SCOPE_NAME = NO\n\n# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\n# type resolution of all parameters of a function it will reject a match between\n# the prototype and the implementation of a member function even if there is\n# only one candidate or it is obvious which candidate to choose by doing a\n# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\n# accept a match between prototype and implementation in such cases.\n# The default value is: NO.\n\nSTRICT_PROTO_MATCHING = NO\n\n# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo\n# list. This list is created by putting \\todo commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TODOLIST = YES\n\n# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test\n# list. This list is created by putting \\test commands in the documentation.\n# The default value is: YES.\n\nGENERATE_TESTLIST = YES\n\n# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug\n# list. This list is created by putting \\bug commands in the documentation.\n# The default value is: YES.\n\nGENERATE_BUGLIST = YES\n\n# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)\n# the deprecated list. This list is created by putting \\deprecated commands in\n# the documentation.\n# The default value is: YES.\n\nGENERATE_DEPRECATEDLIST= YES\n\n# The ENABLED_SECTIONS tag can be used to enable conditional documentation\n# sections, marked by \\if ... \\endif and \\cond \n# ... \\endcond blocks.\n\nENABLED_SECTIONS =\n\n# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\n# initial value of a variable or macro / define can have for it to appear in the\n# documentation. If the initializer consists of more lines than specified here\n# it will be hidden. Use a value of 0 to hide initializers completely. The\n# appearance of the value of individual variables and macros / defines can be\n# controlled using \\showinitializer or \\hideinitializer command in the\n# documentation regardless of this setting.\n# Minimum value: 0, maximum value: 10000, default value: 30.\n\nMAX_INITIALIZER_LINES = 30\n\n# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\n# the bottom of the documentation of classes and structs. If set to YES, the\n# list will mention the files that were used to generate the documentation.\n# The default value is: YES.\n\nSHOW_USED_FILES = YES\n\n# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\n# will remove the Files entry from the Quick Index and from the Folder Tree View\n# (if specified).\n# The default value is: YES.\n\nSHOW_FILES = YES\n\n# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\n# page. This will remove the Namespaces entry from the Quick Index and from the\n# Folder Tree View (if specified).\n# The default value is: YES.\n\nSHOW_NAMESPACES = YES\n\n# The FILE_VERSION_FILTER tag can be used to specify a program or script that\n# doxygen should invoke to get the current version for each file (typically from\n# the version control system). Doxygen will invoke the program by executing (via\n# popen()) the command command input-file, where command is the value of the\n# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\n# by doxygen. Whatever the program writes to standard output is used as the file\n# version. For an example see the documentation.\n\nFILE_VERSION_FILTER =\n\n# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n# by doxygen. The layout file controls the global structure of the generated\n# output files in an output format independent way. To create the layout file\n# that represents doxygen's defaults, run doxygen with the -l option. You can\n# optionally specify a file name after the option, if omitted DoxygenLayout.xml\n# will be used as the name of the layout file.\n#\n# Note that if you run doxygen from a directory containing a file called\n# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\n# tag is left empty.\n\nLAYOUT_FILE =\n\n# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\n# the reference definitions. This must be a list of .bib files. The .bib\n# extension is automatically appended if omitted. This requires the bibtex tool\n# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.\n# For LaTeX the style of the bibliography can be controlled using\n# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\n# search path. See also \\cite for info how to create references.\n\nCITE_BIB_FILES =\n\n#---------------------------------------------------------------------------\n# Configuration options related to warning and progress messages\n#---------------------------------------------------------------------------\n\n# The QUIET tag can be used to turn on/off the messages that are generated to\n# standard output by doxygen. If QUIET is set to YES this implies that the\n# messages are off.\n# The default value is: NO.\n\nQUIET = NO\n\n# The WARNINGS tag can be used to turn on/off the warning messages that are\n# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES\n# this implies that the warnings are on.\n#\n# Tip: Turn warnings on while writing the documentation.\n# The default value is: YES.\n\nWARNINGS = YES\n\n# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate\n# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\n# will automatically be disabled.\n# The default value is: YES.\n\nWARN_IF_UNDOCUMENTED = NO\n\n# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\n# potential errors in the documentation, such as not documenting some parameters\n# in a documented function, or documenting parameters that don't exist or using\n# markup commands wrongly.\n# The default value is: YES.\n\nWARN_IF_DOC_ERROR = YES\n\n# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\n# are documented, but have no documentation for their parameters or return\n# value. If set to NO, doxygen will only warn about wrong or incomplete\n# parameter documentation, but not about the absence of documentation.\n# The default value is: NO.\n\nWARN_NO_PARAMDOC = NO\n\n# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when\n# a warning is encountered.\n# The default value is: NO.\n\nWARN_AS_ERROR = NO\n\n# The WARN_FORMAT tag determines the format of the warning messages that doxygen\n# can produce. The string should contain the $file, $line, and $text tags, which\n# will be replaced by the file and line number from which the warning originated\n# and the warning text. Optionally the format may contain $version, which will\n# be replaced by the version of the file (if it could be obtained via\n# FILE_VERSION_FILTER)\n# The default value is: $file:$line: $text.\n\nWARN_FORMAT = \"$file:$line: $text\"\n\n# The WARN_LOGFILE tag can be used to specify a file to which warning and error\n# messages should be written. If left blank the output is written to standard\n# error (stderr).\n\nWARN_LOGFILE =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the input files\n#---------------------------------------------------------------------------\n\n# The INPUT tag is used to specify the files and/or directories that contain\n# documented source files. You may enter file names like myfile.cpp or\n# directories like /usr/src/myproject. Separate the files or directories with\n# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING\n# Note: If this tag is empty the current directory is searched.\n\nINPUT = @DOXYGEN_SCAN_FOLDERS@\n\n# This tag can be used to specify the character encoding of the source files\n# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\n# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\n# documentation (see: http://www.gnu.org/software/libiconv) for the list of\n# possible encodings.\n# The default value is: UTF-8.\n\nINPUT_ENCODING = UTF-8\n\n# If the value of the INPUT tag contains directories, you can use the\n# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\n# *.h) to filter out the source-files in the directories.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# read by doxygen.\n#\n# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,\n# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,\n# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,\n# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,\n# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.\n\nFILE_PATTERNS = *.cpp \\\n *.h \\\n *.py \\\n *.pyx \\\n *.pxd \\\n *.in \\\n *.md\n\n# The RECURSIVE tag can be used to specify whether or not subdirectories should\n# be searched for input files as well.\n# The default value is: NO.\n\nRECURSIVE = YES\n\n# The EXCLUDE tag can be used to specify files and/or directories that should be\n# excluded from the INPUT source files. This way you can easily exclude a\n# subdirectory from a directory tree whose root is specified with the INPUT tag.\n#\n# Note that relative paths are relative to the directory from which doxygen is\n# run.\n\nEXCLUDE =\n\n# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\n# directories that are symbolic links (a Unix file system feature) are excluded\n# from the input.\n# The default value is: NO.\n\nEXCLUDE_SYMLINKS = NO\n\n# If the value of the INPUT tag contains directories, you can use the\n# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n# certain files from those directories.\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories for example use the pattern */test/*\n\nEXCLUDE_PATTERNS =\n\n# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n# (namespaces, classes, functions, etc.) that should be excluded from the\n# output. The symbol name can be a fully qualified name, a word, or if the\n# wildcard * is used, a substring. Examples: ANamespace, AClass,\n# AClass::ANamespace, ANamespace::*Test\n#\n# Note that the wildcards are matched against the file with absolute path, so to\n# exclude all test directories use the pattern */test/*\n\nEXCLUDE_SYMBOLS =\n\n# The EXAMPLE_PATH tag can be used to specify one or more files or directories\n# that contain example code fragments that are included (see the \\include\n# command).\n\nEXAMPLE_PATH =\n\n# If the value of the EXAMPLE_PATH tag contains directories, you can use the\n# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\n# *.h) to filter out the source-files in the directories. If left blank all\n# files are included.\n\nEXAMPLE_PATTERNS =\n\n# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n# searched for input files to be used with the \\include or \\dontinclude commands\n# irrespective of the value of the RECURSIVE tag.\n# The default value is: NO.\n\nEXAMPLE_RECURSIVE = NO\n\n# The IMAGE_PATH tag can be used to specify one or more files or directories\n# that contain images that are to be included in the documentation (see the\n# \\image command).\n\nIMAGE_PATH =\n\n# The INPUT_FILTER tag can be used to specify a program that doxygen should\n# invoke to filter for each input file. Doxygen will invoke the filter program\n# by executing (via popen()) the command:\n#\n# \n#\n# where is the value of the INPUT_FILTER tag, and is the\n# name of an input file. Doxygen will then use the output that the filter\n# program writes to standard output. If FILTER_PATTERNS is specified, this tag\n# will be ignored.\n#\n# Note that the filter must not add or remove lines; it is applied before the\n# code is scanned, but not when the output code is generated. If lines are added\n# or removed, the anchors will not be placed correctly.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nINPUT_FILTER =\n\n# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n# basis. Doxygen will compare the file name with each pattern and apply the\n# filter if there is a match. The filters are a list of the form: pattern=filter\n# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\n# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\n# patterns match the file name, INPUT_FILTER is applied.\n#\n# Note that for custom extensions or not directly supported extensions you also\n# need to set EXTENSION_MAPPING for the extension otherwise the files are not\n# properly processed by doxygen.\n\nFILTER_PATTERNS =\n\n# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n# INPUT_FILTER) will also be used to filter the input files that are used for\n# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\n# The default value is: NO.\n\nFILTER_SOURCE_FILES = NO\n\n# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\n# it is also possible to disable source filtering for a specific pattern using\n# *.ext= (so without naming a filter).\n# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\n\nFILTER_SOURCE_PATTERNS =\n\n# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\n# is part of the input, its contents will be placed on the main page\n# (index.html). This can be useful if you have a project on for instance GitHub\n# and want to reuse the introduction page also for the doxygen output.\n\nUSE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/README.md\n\n#---------------------------------------------------------------------------\n# Configuration options related to source browsing\n#---------------------------------------------------------------------------\n\n# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\n# generated. Documented entities will be cross-referenced with these sources.\n#\n# Note: To get rid of all source code in the generated output, make sure that\n# also VERBATIM_HEADERS is set to NO.\n# The default value is: NO.\n\nSOURCE_BROWSER = YES\n\n# Setting the INLINE_SOURCES tag to YES will include the body of functions,\n# classes and enums directly into the documentation.\n# The default value is: NO.\n\nINLINE_SOURCES = NO\n\n# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\n# special comment blocks from generated source code fragments. Normal C, C++ and\n# Fortran comments will always remain visible.\n# The default value is: YES.\n\nSTRIP_CODE_COMMENTS = YES\n\n# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\n# function all documented functions referencing it will be listed.\n# The default value is: NO.\n\nREFERENCED_BY_RELATION = NO\n\n# If the REFERENCES_RELATION tag is set to YES then for each documented function\n# all documented entities called/used by that function will be listed.\n# The default value is: NO.\n\nREFERENCES_RELATION = NO\n\n# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\n# to YES then the hyperlinks from functions in REFERENCES_RELATION and\n# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\n# link to the documentation.\n# The default value is: YES.\n\nREFERENCES_LINK_SOURCE = YES\n\n# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\n# source code will show a tooltip with additional information such as prototype,\n# brief description and links to the definition and documentation. Since this\n# will make the HTML file larger and loading of large files a bit slower, you\n# can opt to disable this feature.\n# The default value is: YES.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nSOURCE_TOOLTIPS = YES\n\n# If the USE_HTAGS tag is set to YES then the references to source code will\n# point to the HTML generated by the htags(1) tool instead of doxygen built-in\n# source browser. The htags tool is part of GNU's global source tagging system\n# (see http://www.gnu.org/software/global/global.html). You will need version\n# 4.8.6 or higher.\n#\n# To use it do the following:\n# - Install the latest version of global\n# - Enable SOURCE_BROWSER and USE_HTAGS in the config file\n# - Make sure the INPUT points to the root of the source tree\n# - Run doxygen as normal\n#\n# Doxygen will invoke htags (and that will in turn invoke gtags), so these\n# tools must be available from the command line (i.e. in the search path).\n#\n# The result: instead of the source browser generated by doxygen, the links to\n# source code will now point to the output of htags.\n# The default value is: NO.\n# This tag requires that the tag SOURCE_BROWSER is set to YES.\n\nUSE_HTAGS = NO\n\n# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\n# verbatim copy of the header file for each class for which an include is\n# specified. Set to NO to disable this.\n# See also: Section \\class.\n# The default value is: YES.\n\nVERBATIM_HEADERS = YES\n\n#---------------------------------------------------------------------------\n# Configuration options related to the alphabetical class index\n#---------------------------------------------------------------------------\n\n# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\n# compounds will be generated. Enable this if the project contains a lot of\n# classes, structs, unions or interfaces.\n# The default value is: YES.\n\nALPHABETICAL_INDEX = YES\n\n# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in\n# which the alphabetical index list will be split.\n# Minimum value: 1, maximum value: 20, default value: 5.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nCOLS_IN_ALPHA_INDEX = 5\n\n# In case all classes in a project start with a common prefix, all classes will\n# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\n# can be used to specify a prefix (or a list of prefixes) that should be ignored\n# while generating the index headers.\n# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\n\nIGNORE_PREFIX =\n\n#---------------------------------------------------------------------------\n# Configuration options related to the HTML output\n#---------------------------------------------------------------------------\n\n# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output\n# The default value is: YES.\n\nGENERATE_HTML = YES\n\n# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\n# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\n# it.\n# The default directory is: html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_OUTPUT = html\n\n# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\n# generated HTML page (for example: .htm, .php, .asp).\n# The default value is: .html.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FILE_EXTENSION = .html\n\n# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\n# each generated HTML page. If the tag is left blank doxygen will generate a\n# standard header.\n#\n# To get valid HTML the header file that includes any scripts and style sheets\n# that doxygen needs, which is dependent on the configuration options used (e.g.\n# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\n# default header using\n# doxygen -w html new_header.html new_footer.html new_stylesheet.css\n# YourConfigFile\n# and then modify the file new_header.html. See also section \"Doxygen usage\"\n# for information on how to generate the default header that doxygen normally\n# uses.\n# Note: The header is subject to change so you typically have to regenerate the\n# default header when upgrading to a newer version of doxygen. For a description\n# of the possible markers and block names see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_HEADER =\n\n# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\n# generated HTML page. If the tag is left blank doxygen will generate a standard\n# footer. See HTML_HEADER for more information on how to generate a default\n# footer and what special commands can be used inside the footer. See also\n# section \"Doxygen usage\" for information on how to generate the default footer\n# that doxygen normally uses.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_FOOTER =\n\n# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\n# sheet that is used by each HTML page. It can be used to fine-tune the look of\n# the HTML output. If left blank doxygen will generate a default style sheet.\n# See also section \"Doxygen usage\" for information on how to generate the style\n# sheet that doxygen normally uses.\n# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\n# it is more robust and this tag (HTML_STYLESHEET) will in the future become\n# obsolete.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_STYLESHEET =\n\n# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined\n# cascading style sheets that are included after the standard style sheets\n# created by doxygen. Using this option one can overrule certain style aspects.\n# This is preferred over using HTML_STYLESHEET since it does not replace the\n# standard style sheet and is therefore more robust against future updates.\n# Doxygen will copy the style sheet files to the output directory.\n# Note: The order of the extra style sheet files is of importance (e.g. the last\n# style sheet in the list overrules the setting of the previous ones in the\n# list). For an example see the documentation.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_STYLESHEET = \"@CMAKE_SOURCE_DIR@/buildsystem/doxygen_custom.css\"\n\n# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\n# other source files which should be copied to the HTML output directory. Note\n# that these files will be copied to the base HTML output directory. Use the\n# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\n# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\n# files will be copied as-is; there are no commands or markers available.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_EXTRA_FILES =\n\n# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\n# will adjust the colors in the style sheet and background images according to\n# this color. Hue is specified as an angle on a colorwheel, see\n# http://en.wikipedia.org/wiki/Hue for more information. For instance the value\n# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\n# purple, and 360 is red again.\n# Minimum value: 0, maximum value: 359, default value: 220.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_HUE = 220\n\n# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\n# in the HTML output. For a value of 0 the output will use grayscales only. A\n# value of 255 will produce the most vivid colors.\n# Minimum value: 0, maximum value: 255, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_SAT = 100\n\n# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\n# luminance component of the colors in the HTML output. Values below 100\n# gradually make the output lighter, whereas values above 100 make the output\n# darker. The value divided by 100 is the actual gamma applied, so 80 represents\n# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\n# change the gamma.\n# Minimum value: 40, maximum value: 240, default value: 80.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_COLORSTYLE_GAMMA = 80\n\n# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n# page will contain the date and time when the page was generated. Setting this\n# to YES can help to show when doxygen was last run and thus if the\n# documentation is up to date.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_TIMESTAMP = YES\n\n# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n# documentation will contain sections that can be hidden and shown after the\n# page has loaded.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_DYNAMIC_SECTIONS = YES\n\n# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\n# shown in the various tree structured indices initially; the user can expand\n# and collapse entries dynamically later on. Doxygen will expand the tree to\n# such a level that at most the specified number of entries are visible (unless\n# a fully collapsed tree already exceeds this amount). So setting the number of\n# entries 1 will produce a full collapsed tree by default. 0 is a special value\n# representing an infinite number of entries and will result in a full expanded\n# tree by default.\n# Minimum value: 0, maximum value: 9999, default value: 100.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nHTML_INDEX_NUM_ENTRIES = 100\n\n# If the GENERATE_DOCSET tag is set to YES, additional index files will be\n# generated that can be used as input for Apple's Xcode 3 integrated development\n# environment (see: http://developer.apple.com/tools/xcode/), introduced with\n# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a\n# Makefile in the HTML output directory. Running make will produce the docset in\n# that directory and running make install will install the docset in\n# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\n# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html\n# for more information.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_DOCSET = NO\n\n# This tag determines the name of the docset feed. A documentation feed provides\n# an umbrella under which multiple documentation sets from a single provider\n# (such as a company or product suite) can be grouped.\n# The default value is: Doxygen generated docs.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_FEEDNAME = \"Doxygen generated docs\"\n\n# This tag specifies a string that should uniquely identify the documentation\n# set bundle. This should be a reverse domain-name style string, e.g.\n# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_BUNDLE_ID = org.doxygen.Project\n\n# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\n# the documentation publisher. This should be a reverse domain-name style\n# string, e.g. com.mycompany.MyDocSet.documentation.\n# The default value is: org.doxygen.Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_ID = org.doxygen.Publisher\n\n# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\n# The default value is: Publisher.\n# This tag requires that the tag GENERATE_DOCSET is set to YES.\n\nDOCSET_PUBLISHER_NAME = Publisher\n\n# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\n# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\n# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\n# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on\n# Windows.\n#\n# The HTML Help Workshop contains a compiler that can convert all HTML output\n# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\n# files are now used as the Windows 98 help format, and will replace the old\n# Windows help format (.hlp) on all Windows platforms in the future. Compressed\n# HTML files also contain an index, a table of contents, and you can search for\n# words in the documentation. The HTML workshop also contains a viewer for\n# compressed HTML files.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_HTMLHELP = NO\n\n# The CHM_FILE tag can be used to specify the file name of the resulting .chm\n# file. You can add a path in front of the file if the result should not be\n# written to the html output directory.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_FILE =\n\n# The HHC_LOCATION tag can be used to specify the location (absolute path\n# including file name) of the HTML help compiler (hhc.exe). If non-empty,\n# doxygen will try to run the HTML help compiler on the generated index.hhp.\n# The file has to be specified with full path.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nHHC_LOCATION =\n\n# The GENERATE_CHI flag controls if a separate .chi index file is generated\n# (YES) or that it should be included in the master .chm file (NO).\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nGENERATE_CHI = NO\n\n# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)\n# and project file content.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nCHM_INDEX_ENCODING =\n\n# The BINARY_TOC flag controls whether a binary table of contents is generated\n# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it\n# enables the Previous and Next buttons.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nBINARY_TOC = NO\n\n# The TOC_EXPAND flag can be set to YES to add extra items for group members to\n# the table of contents of the HTML help documentation and to the tree view.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\n\nTOC_EXPAND = NO\n\n# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\n# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\n# (.qch) of the generated HTML documentation.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_QHP = NO\n\n# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\n# the file name of the resulting .qch file. The path specified is relative to\n# the HTML output folder.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQCH_FILE =\n\n# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\n# Project output. For more information please see Qt Help Project / Namespace\n# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_NAMESPACE = org.doxygen.Project\n\n# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\n# Help Project output. For more information please see Qt Help Project / Virtual\n# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-\n# folders).\n# The default value is: doc.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_VIRTUAL_FOLDER = doc\n\n# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\n# filter to add. For more information please see Qt Help Project / Custom\n# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n# filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_NAME =\n\n# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\n# custom filter to add. For more information please see Qt Help Project / Custom\n# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\n# filters).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_CUST_FILTER_ATTRS =\n\n# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n# project's filter section matches. Qt Help Project / Filter Attributes (see:\n# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHP_SECT_FILTER_ATTRS =\n\n# The QHG_LOCATION tag can be used to specify the location of Qt's\n# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the\n# generated .qhp file.\n# This tag requires that the tag GENERATE_QHP is set to YES.\n\nQHG_LOCATION =\n\n# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\n# generated, together with the HTML files, they form an Eclipse help plugin. To\n# install this plugin and make it available under the help contents menu in\n# Eclipse, the contents of the directory containing the HTML and XML files needs\n# to be copied into the plugins directory of eclipse. The name of the directory\n# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\n# After copying Eclipse needs to be restarted before the help appears.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_ECLIPSEHELP = NO\n\n# A unique identifier for the Eclipse help plugin. When installing the plugin\n# the directory name containing the HTML and XML files should also have this\n# name. Each documentation set should have its own identifier.\n# The default value is: org.doxygen.Project.\n# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\n\nECLIPSE_DOC_ID = org.doxygen.Project\n\n# If you want full control over the layout of the generated HTML pages it might\n# be necessary to disable the index and replace it with your own. The\n# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\n# of each HTML page. A value of NO enables the index and the value YES disables\n# it. Since the tabs in the index contain the same information as the navigation\n# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nDISABLE_INDEX = NO\n\n# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n# structure should be generated to display hierarchical information. If the tag\n# value is set to YES, a side panel will be generated containing a tree-like\n# index structure (just like the one that is generated for HTML Help). For this\n# to work a browser that supports JavaScript, DHTML, CSS and frames is required\n# (i.e. any modern browser). Windows users are probably better off using the\n# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can\n# further fine-tune the look of the index. As an example, the default style\n# sheet generated by doxygen has an example that shows how to put an image at\n# the root of the tree instead of the PROJECT_NAME. Since the tree basically has\n# the same information as the tab index, you could consider setting\n# DISABLE_INDEX to YES when enabling this option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nGENERATE_TREEVIEW = NO\n\n# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\n# doxygen will group on one line in the generated HTML documentation.\n#\n# Note that a value of 0 will completely suppress the enum values from appearing\n# in the overview section.\n# Minimum value: 0, maximum value: 20, default value: 4.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nENUM_VALUES_PER_LINE = 4\n\n# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\n# to set the initial width (in pixels) of the frame in which the tree is shown.\n# Minimum value: 0, maximum value: 1500, default value: 250.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nTREEVIEW_WIDTH = 250\n\n# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to\n# external symbols imported via tag files in a separate window.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nEXT_LINKS_IN_WINDOW = NO\n\n# Use this tag to change the font size of LaTeX formulas included as images in\n# the HTML documentation. When you change the font size after a successful\n# doxygen run you need to manually remove any form_*.png images from the HTML\n# output directory to force them to be regenerated.\n# Minimum value: 8, maximum value: 50, default value: 10.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_FONTSIZE = 10\n\n# Use the FORMULA_TRANPARENT tag to determine whether or not the images\n# generated for formulas are transparent PNGs. Transparent PNGs are not\n# supported properly for IE 6.0, but are supported on all modern browsers.\n#\n# Note that when changing this option you need to delete any form_*.png files in\n# the HTML output directory before the changes have effect.\n# The default value is: YES.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nFORMULA_TRANSPARENT = YES\n\n# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\n# http://www.mathjax.org) which uses client side Javascript for the rendering\n# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX\n# installed or if you want to formulas look prettier in the HTML output. When\n# enabled you may also need to install MathJax separately and configure the path\n# to it using the MATHJAX_RELPATH option.\n# The default value is: NO.\n# This tag requires that the tag GENERATE_HTML is set to YES.\n\nUSE_MATHJAX = NO\n\n# When MathJax is enabled you can set the default output format to be used for\n# the MathJax output. See the MathJax site (see:\n# http://docs.mathjax.org/en/latest/output.html) for more details.\n# Possible values are: HTML-CSS (which is slower, but has the best\n# compatibility), NativeMML (i.e. MathML) and SVG.\n# The default value is: HTML-CSS.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_FORMAT = HTML-CSS\n\n# When MathJax is enabled you need to specify the location relative to the HTML\n# output directory using the MATHJAX_RELPATH option. The destination directory\n# should contain the MathJax.js script. For instance, if the mathjax directory\n# is located at the same level as the HTML output directory, then\n# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\n# Content Delivery Network so you can quickly see the result without installing\n# MathJax. However, it is strongly recommended to install a local copy of\n# MathJax from http://www.mathjax.org before deployment.\n# The default value is: http://cdn.mathjax.org/mathjax/latest.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest\n\n# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\n# extension names that should be enabled during MathJax rendering. For example\n# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_EXTENSIONS =\n\n# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\n# of code that will be used on startup of the MathJax code. See the MathJax site\n# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an\n# example see the documentation.\n# This tag requires that the tag USE_MATHJAX is set to YES.\n\nMATHJAX_CODEFILE =\n\n# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\n# the HTML output. The underlying search engine uses javascript and DHTML and\n# should work on any modern browser. Note that when using HTML help\n# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\n# there is already a search function so this one should typically be disabled.\n# For large projects the javascript based search engine can be slow, then\n# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\n# search using the keyboard; to jump to the search box use + S\n# (what the is depends on the OS and browser, but it is typically\n# , /