diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 00000000..3fc1c33f --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,212 @@ +name: 'Build' + +on: + push: + branches: [ '**' ] + +defaults: + run: + shell: bash + +jobs: + build_python_linux: + runs-on: ubuntu-latest + name: 'Python (Linux)' + strategy: + matrix: + python-version: [ '3.9', '3.10', '3.11', '3.12' ] + outputs: + artifact_name: ${{ steps.step_artifact_name.outputs.artifact_name }} + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: 'Prepare Artifact Name' + id: step_artifact_name + run: | + CURRENT_COMMIT="$(git rev-parse HEAD)" + CURRENT_COMMIT="${CURRENT_COMMIT:0:8}" + echo "git commit: $CURRENT_COMMIT" + + ARTIFACT_NAME="MyApp-$CURRENT_COMMIT" + echo "artifact name: $ARTIFACT_NAME" + echo "artifact_name=$ARTIFACT_NAME" >> $GITHUB_OUTPUT + - name: 'Install Python' + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + - name: 'Install pip' + run: | + python -m pip install --upgrade pip +# - name: 'Update Packages' +# run: | +# sudo apt update -y && sudo apt upgrade -y + - name: 'Install Dependencies' + run: | + sudo apt install -y patchelf libopengl0 libegl-dev + - name: 'Install just' + uses: taiki-e/install-action@just + - name: 'Create Virtual Environment' + run: | + python -m venv venv + source venv/bin/activate + python -m pip install --upgrade pip + python -m pip install wheel + python -m pip install -r requirements.txt + - name: 'Remove Qml Test Files' + run: | + find . -type f -name 'tst_*.qml' -delete + - name: 'Run Python Tests' + run: | + source venv/bin/activate + just test-python + just clean + just build + - name: 'Upload Build Artifact' + uses: actions/upload-artifact@v4 + if: matrix.python-version == '3.12' + with: + path: build/release + name: release-build-artifact + + build_python_windows: + runs-on: windows-latest + name: 'Python (Windows)' + strategy: + matrix: + python-version: [ '3.9', '3.10', '3.11', '3.12' ] + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: 'Prepare Artifact Name' + id: step_artifact_name + run: | + CURRENT_COMMIT="$(git rev-parse HEAD)" + CURRENT_COMMIT="${CURRENT_COMMIT:0:8}" + echo "git commit: $CURRENT_COMMIT" + + ARTIFACT_NAME="MyApp-$CURRENT_COMMIT" + echo "artifact name: $ARTIFACT_NAME" + echo "artifact_name=$ARTIFACT_NAME" >> $GITHUB_OUTPUT + - name: 'Install Python' + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + - name: 'Install pip' + run: | + python -m pip install --upgrade pip + - name: 'Install just' + uses: taiki-e/install-action@just + - name: 'Create Virtual Environment' + run: | + python -m venv venv + source venv/Scripts/activate + python -m pip install --upgrade pip + python -m pip install wheel + python -m pip install -r requirements.txt + - name: 'Remove Qml Test Files' + run: | + find . -type f -name 'tst_*.qml' -delete + - name: 'Run Python Tests' + run: | + source venv/Scripts/activate + just test-python + just clean + just build + + test_qml: + runs-on: ubuntu-latest + name: 'Qml' + steps: + - uses: actions/checkout@v4 + - name: 'Install Qt 6.7.2' + uses: jurplel/install-qt-action@v4 + with: + version: '6.7.2' + - name: 'Install just' + uses: taiki-e/install-action@just + - name: 'Run Qml Tests' + run: | + just test-qml + + distributable-windows: + runs-on: windows-latest + name: 'Build Windows' + needs: + - build_python_linux + - build_python_windows + - test_qml + steps: + - name: 'Checkout Repository' + uses: actions/checkout@v4 + - name: 'Download Build Artifact' + uses: actions/download-artifact@v4 + with: + path: build/release + name: release-build-artifact + - name: 'Install Python 3.12' + uses: actions/setup-python@v5 + with: + python-version: "3.12" + - name: 'Setup Build Environment' + run: | + python -m venv venv + source venv/Scripts/activate + python -m pip install --upgrade pip + python -m pip install wheel + python -m pip install -r requirements.txt + python -m pip install pyinstaller + - name: 'Build Bundle' + run: | + source venv/Scripts/activate + pyinstaller \ + --name MpApp \ + --workpath build-windows \ + --icon=build-aux/windows/icon.ico \ + --collect-binaries PySide6 \ + --add-data "LICENSE;." \ + --noconsole \ + build/release/main.py + - name: 'Remove Redundant Binaries' + run: | + find dist/MpApp -type f -name 'Qt6WebEngineCore.dll' -delete + find dist/MpApp -type f -name 'opengl32sw.dll' -delete + - name: 'Compress Artifact' + shell: pwsh + run: Compress-Archive -Path "dist\MpApp\*" -DestinationPath "${{ needs.build_python_linux.outputs.artifact_name }}.zip" + - name: 'Upload Artifact' + uses: actions/upload-artifact@v4 + with: + name: "${{ needs.build_python_linux.outputs.artifact_name }}-win-x86_64" + path: "${{ needs.build_python_linux.outputs.artifact_name }}.zip" + + distributable-linux: + runs-on: ubuntu-latest + name: 'Build Linux (Flatpak)' + container: + image: bilelmoussaoui/flatpak-github-actions:freedesktop-22.08 + options: --privileged + needs: + - build_python_linux + - build_python_windows + - test_qml + steps: + - name: 'Checkout Repository' + uses: actions/checkout@v4 + - name: 'Download Build Artifact' + uses: actions/download-artifact@v4 + with: + path: build/release + name: release-build-artifact + - name: 'Prepare Flatpak Build' + run: | + mv build-aux/linux/org.github.trin94.pyside6.template.yml org.github.trin94.pyside6.template.yml + - name: 'Build Flatpak' + uses: flatpak/flatpak-github-actions/flatpak-builder@v6 + with: + manifest-path: org.github.trin94.pyside6.template.yml + bundle: ${{ needs.build_python_linux.outputs.artifact_name }}-linux.flatpak + branch: main + cache: false + cache-key: flatpak-builder-${{ github.sha }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..3d44d59b --- /dev/null +++ b/.gitignore @@ -0,0 +1,528 @@ +# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm,qt,qtcreator,vscode,sublimetext,qml,linux,windows,macos,vim,emacs +# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm,qt,qtcreator,vscode,sublimetext,qml,linux,windows,macos,vim,emacs + +### Emacs ### +# -*- mode: gitignore; -*- +*~ +\#*\# +/.emacs.desktop +/.emacs.desktop.lock +*.elc +auto-save-list +tramp +.\#* + +# Org-mode +.org-id-locations +*_archive +ltximg/** + +# flymake-mode +*_flymake.* + +# eshell files +/eshell/history +/eshell/lastdir + +# elpa packages +/elpa/ + +# reftex files +*.rel + +# AUCTeX auto folder +/auto/ + +# cask packages +.cask/ +dist/ + +# Flycheck +flycheck_*.el + +# server auth directory +/server/ + +# projectiles files +.projectile + +# directory configuration +.dir-locals.el + +# network security +/network-security.data + + +### Linux ### + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### PyCharm ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ +.idea + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### PyCharm Patch ### +# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 + +# *.iml +# modules.xml +# .idea/misc.xml +# *.ipr + +# Sonarlint plugin +# https://plugins.jetbrains.com/plugin/7973-sonarlint +.idea/**/sonarlint/ + +# SonarQube Plugin +# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin +.idea/**/sonarIssues.xml + +# Markdown Navigator plugin +# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced +.idea/**/markdown-navigator.xml +.idea/**/markdown-navigator-enh.xml +.idea/**/markdown-navigator/ + +# Cache file creation bug +# See https://youtrack.jetbrains.com/issue/JBR-2257 +.idea/$CACHE_FILE$ + +# CodeStream plugin +# https://plugins.jetbrains.com/plugin/12206-codestream +.idea/codestream.xml + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +downloads/ +eggs/ +.eggs/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +pytestdebug.log + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ +doc/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +#poetry.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +# .env +.env/ +.venv/ +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ +pythonenv* + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# operating system-related files +# file properties cache/storage on macOS +*.DS_Store +# thumbnail cache on Windows +Thumbs.db + +# profiling data +.prof + + +### QML ### +# Cached binary representations of QML and JS files +*.qmlc +*.jsc + +### Qt ### +# C++ objects and libs +*.slo +*.lo +*.o +*.a +*.la +*.lai +*.so.* +*.dll +*.dylib + +# Qt-es +object_script.*.Release +object_script.*.Debug +*_plugin_import.cpp +/.qmake.cache +/.qmake.stash +*.pro.user +*.pro.user.* +*.qbs.user +*.qbs.user.* +*.moc +moc_*.cpp +moc_*.h +qrc_*.cpp +ui_*.h +Makefile* +*.qm +*.prl + +# Qt unit tests +target_wrapper.* + +# QtCreator +*.autosave + +# QtCreator Qml +*.qmlproject.user +*.qmlproject.user.* + +# QtCreator CMake +CMakeLists.txt.user* + +# QtCreator 4.8< compilation database +compile_commands.json + +# QtCreator local machine specific files for imported projects +*creator.user* + +### QtCreator ### +# gitignore for Qt Creator like IDE for pure C/C++ project without Qt +# +# Reference: http://doc.qt.io/qtcreator/creator-project-generic.html + + + +# Qt Creator autogenerated files + + +# A listing of all the files included in the project +*.files + +# Include directories +*.includes + +# Project configuration settings like predefined Macros +*.config + +# Qt Creator settings +*.creator + +# User project settings +*.creator.user* + +# Qt Creator backups + +# Flags for Clang Code Model +*.cxxflags +*.cflags + + +### SublimeText ### +# Cache files for Sublime Text +*.tmlanguage.cache +*.tmPreferences.cache +*.stTheme.cache + +# Workspace files are user-specific +*.sublime-workspace + +# Project files should be checked into the repository, unless a significant +# proportion of contributors will probably not be using Sublime Text +# *.sublime-project + +# SFTP configuration file +sftp-config.json + +# Package control specific files +Package Control.last-run +Package Control.ca-list +Package Control.ca-bundle +Package Control.system-ca-bundle +Package Control.cache/ +Package Control.ca-certs/ +Package Control.merged-ca-bundle +Package Control.user-ca-bundle +oscrypto-ca-bundle.crt +bh_unicode_properties.cache + +# Sublime-github package stores a github token in this file +# https://packagecontrol.io/packages/sublime-github +GitHub.sublime-settings + +### Vim ### +# Swap +[._]*.s[a-v][a-z] +!*.svg # comment out if you don't need vector files +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim +Sessionx.vim + +# Temporary +.netrwhist +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + +### vscode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +### Windows ### +# Windows thumbnail cache files +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# End of https://www.toptal.com/developers/gitignore/api/python,pycharm,qt,qtcreator,vscode,sublimetext,qml,linux,windows,macos,vim,emacs + +.flatpak-builder +build-dir +myapp/generated_resources.py +test/generated_resources.py diff --git a/Justfile b/Justfile new file mode 100644 index 00000000..a839a189 --- /dev/null +++ b/Justfile @@ -0,0 +1,276 @@ +# Copyright 2024 +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with this program. If not, see . + +PYTHON_DIR := invocation_directory() + '/' + if os_family() == 'windows' { '.venv/Scripts' } else { '.venv/bin' } +PYTHON := PYTHON_DIR + if os_family() == 'windows' { '/python.exe' } else { '/python3' } + +# + +TOOL_CLI_LUPDATE := PYTHON_DIR + '/pyside6-lupdate' +TOOL_CLI_LRELEASE := PYTHON_DIR + '/pyside6-lrelease' +TOOL_CLI_RCC := PYTHON_DIR + '/pyside6-rcc' +TOOL_CLI_QML_TESTRUNNER := 'qmltestrunner' + +# + +export QT_QPA_PLATFORM := 'offscreen' +export QT_QUICK_CONTROLS_STYLE := 'Material' +export QT_QUICK_CONTROLS_MATERIAL_VARIANT := 'dense' + +##### ##### +##### Names ##### +##### ##### + +NAME_APPLICATION := 'myapp' +NAME_DIRECTORY_BUILD := 'build' +NAME_DIRECTORY_BUILD_HELPERS := 'build-aux' +NAME_DIRECTORY_DATA := 'data' +NAME_DIRECTORY_I18N := 'i18n' +NAME_DIRECTORY_PY_SOURCES := 'myapp' +NAME_DIRECTORY_PY_TESTS := 'test' +NAME_DIRECTORY_QML_SOURCES := 'qml' +NAME_DIRECTORY_QML_TESTS := 'qml' +NAME_FILE_MAIN_ENTRY := 'main.py' +NAME_FILE_GENERATED_RESOURCES := 'generated_resources.py' + +##### ##### +##### Existing Directories ##### +##### ##### + +DIRECTORY_ROOT := invocation_directory() +DIRECTORY_BUILD_HELPERS := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_BUILD_HELPERS +DIRECTORY_DATA := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_DATA +DIRECTORY_I18N := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_I18N +DIRECTORY_PY_SOURCES := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_PY_SOURCES +DIRECTORY_PY_TESTS := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_PY_TESTS +DIRECTORY_QML_SOURCES := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_QML_SOURCES +DIRECTORY_QML_TESTS := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_QML_TESTS + +##### ##### +##### Existing Files ##### +##### ##### + +FILE_APP_ENTRY := DIRECTORY_ROOT + '/' + NAME_FILE_MAIN_ENTRY + +##### ##### +##### Generated Directories ##### +##### ##### + +DIRECTORY_BUILD := DIRECTORY_ROOT + '/' + NAME_DIRECTORY_BUILD +DIRECTORY_BUILD_QRC_QML := DIRECTORY_BUILD + '/qrc-' + NAME_DIRECTORY_QML_SOURCES +DIRECTORY_BUILD_QRC_DATA := DIRECTORY_BUILD + '/qrc-' + NAME_DIRECTORY_DATA +DIRECTORY_BUILD_QRC_I18N := DIRECTORY_BUILD + '/qrc-' + NAME_DIRECTORY_I18N +DIRECTORY_BUILD_TRANSLATIONS := DIRECTORY_BUILD + '/translations' +DIRECTORY_BUILD_RESOURCES := DIRECTORY_BUILD + '/resources' +DIRECTORY_BUILD_RELEASE := DIRECTORY_BUILD + '/release' +DIRECTORY_BUILD_PY := DIRECTORY_BUILD_RELEASE + '/' + NAME_DIRECTORY_PY_SOURCES + +##### ##### +##### Generated Files ##### +##### ##### + +FILE_BUILD_QRC_QML := DIRECTORY_BUILD_QRC_QML + '/' + NAME_DIRECTORY_QML_SOURCES + '.qrc' +FILE_BUILD_QRC_DATA := DIRECTORY_BUILD_QRC_DATA + '/' + NAME_DIRECTORY_DATA + '.qrc' +FILE_BUILD_QRC_I18N := DIRECTORY_BUILD_QRC_I18N + '/' + NAME_DIRECTORY_I18N + '.qrc' +FILE_BUILD_QRC_I18N_JSON := DIRECTORY_BUILD_QRC_I18N + '/' + NAME_APPLICATION + '.json' +FILE_BUILD_TRANSLATIONS_JSON := DIRECTORY_BUILD_TRANSLATIONS + '/' + NAME_APPLICATION + '.json' +FILE_BUILD_RESOURCES := DIRECTORY_BUILD_RESOURCES + '/' + NAME_FILE_GENERATED_RESOURCES +FILE_PY_SOURCES_RESOURCES := DIRECTORY_PY_SOURCES + '/' + NAME_FILE_GENERATED_RESOURCES +FILE_PY_TEST_RESOURCES := DIRECTORY_PY_TESTS + '/' + NAME_FILE_GENERATED_RESOURCES + +_default: + @just --list + +# Build full project into build/release +[group('build')] +build: _check-pyside-setup _clean-build _clean-develop _compile-resources + @rm -rf \ + {{ DIRECTORY_BUILD_PY }} + @mkdir -p \ + {{ DIRECTORY_BUILD_PY }} + @cp -r \ + {{ DIRECTORY_PY_SOURCES }}/. \ + {{ DIRECTORY_BUILD_PY }} + @cp \ + {{ FILE_BUILD_RESOURCES }} \ + {{ DIRECTORY_BUILD_PY }} + @cp \ + {{ FILE_APP_ENTRY }} \ + {{ DIRECTORY_BUILD_RELEASE }} + @echo ''; \ + echo 'Please find the finished project in {{ DIRECTORY_BUILD_RELEASE }}' + +# Build and compile resources into source directory +[group('build')] +build-develop: _check-pyside-setup _clean-develop _compile-resources + @# Generates resources and copies them into the source directory + @# This allows to develop/debug the project normally + + @cp \ + {{ FILE_BUILD_RESOURCES }} {{ DIRECTORY_PY_SOURCES }} + +# Remove ALL generated files +[group('build')] +clean: _clean-build _clean-develop _clean-test + +# Add new language +[group('i18n')] +add-translation locale: _check-pyside-setup _prepare-translation-extractions + @cd {{ DIRECTORY_BUILD_TRANSLATIONS }}; \ + {{ TOOL_CLI_LUPDATE }} \ + -verbose \ + -source-language en_US \ + -target-language {{ locale }} \ + -ts {{ DIRECTORY_I18N }}/{{ locale }}.ts + @echo '' + @just update-translations + +# Update *.ts files by traversing the source code +[group('i18n')] +update-translations: _check-pyside-setup _clean-develop _prepare-translation-extractions + @# Traverses *.qml and *.py files to update translation files + @# Requires translations in .py: QCoreApplication.translate("context", "string") + @# Requires translations in .qml: qsTranslate("context", "string") + + @cd {{ DIRECTORY_BUILD_TRANSLATIONS }}; \ + {{ TOOL_CLI_LUPDATE }} \ + -locations none \ + -project {{ FILE_BUILD_TRANSLATIONS_JSON }} + @cp -r \ + {{ DIRECTORY_BUILD_TRANSLATIONS }}/{{ NAME_DIRECTORY_I18N }}/*.ts \ + {{ DIRECTORY_I18N }} + +# Run Python and QML tests +[group('test')] +test: test-python test-qml + +# Run Python tests +[group('test')] +test-python: _check-pyside-setup _clean-test _compile-resources + @cp \ + {{ FILE_BUILD_RESOURCES }} \ + {{ FILE_PY_TEST_RESOURCES }} + @{{ PYTHON }} -m \ + pytest test + +# Run QML tests +[group('test')] +test-qml: _check-qml-setup + @{{ TOOL_CLI_QML_TESTRUNNER }} \ + -silent \ + -input {{ DIRECTORY_QML_TESTS }} + +_clean-build: + @rm -rf \ + {{ DIRECTORY_BUILD }} + +_clean-develop: + @rm -rf \ + {{ FILE_PY_SOURCES_RESOURCES }} + +_clean-test: + @rm -rf \ + {{ FILE_PY_TEST_RESOURCES }} + +_check-pyside-setup: + @which {{ PYTHON }} + @which {{ TOOL_CLI_LUPDATE }} + @which {{ TOOL_CLI_LRELEASE }} + @which {{ TOOL_CLI_RCC }} + @echo '' + +_check-qml-setup: + @which {{ TOOL_CLI_QML_TESTRUNNER }} + @echo '' + +_compile-resources: _generate-qrc-data _generate-qrc-i18n _generate-qrc-qml + @rm -rf \ + {{ DIRECTORY_BUILD_RESOURCES }} + @mkdir -p \ + {{ DIRECTORY_BUILD_RESOURCES }} + @cp -r \ + {{ DIRECTORY_BUILD_QRC_QML }}/. \ + {{ DIRECTORY_BUILD_QRC_DATA }}/. \ + {{ DIRECTORY_BUILD_QRC_I18N }}/. \ + {{ DIRECTORY_BUILD_RESOURCES }} + @{{ TOOL_CLI_RCC }} \ + {{ DIRECTORY_BUILD_RESOURCES }}/{{ NAME_DIRECTORY_DATA }}.qrc \ + {{ DIRECTORY_BUILD_RESOURCES }}/{{ NAME_DIRECTORY_I18N }}.qrc \ + {{ DIRECTORY_BUILD_RESOURCES }}/{{ NAME_DIRECTORY_QML_SOURCES }}.qrc \ + -o {{ FILE_BUILD_RESOURCES }} + +_generate-qrc-data: + @rm -rf \ + {{ DIRECTORY_BUILD_QRC_DATA }} + @mkdir -p \ + {{ DIRECTORY_BUILD_QRC_DATA }} + @cp -r \ + {{ DIRECTORY_DATA }} \ + {{ DIRECTORY_BUILD_QRC_DATA }} + @cd \ + {{ DIRECTORY_BUILD_QRC_DATA }}/{{ NAME_DIRECTORY_DATA }}; \ + {{ TOOL_CLI_RCC }} \ + --project | sed 's,./,{{ NAME_DIRECTORY_DATA }}/,' > {{ FILE_BUILD_QRC_DATA }} + +_generate-qrc-i18n: + @rm -rf \ + {{ DIRECTORY_BUILD_QRC_I18N }} + @mkdir -p \ + {{ DIRECTORY_BUILD_QRC_I18N }} + @cp -r \ + {{ DIRECTORY_I18N }} {{ DIRECTORY_BUILD_QRC_I18N }} + @{{ DIRECTORY_BUILD_HELPERS }}/generate-lupdate-project-file.py \ + --relative-to {{ DIRECTORY_BUILD_QRC_I18N }} \ + --out-file {{ FILE_BUILD_QRC_I18N_JSON }} + @cd \ + {{ DIRECTORY_BUILD_QRC_I18N }}; \ + {{ TOOL_CLI_LRELEASE }} \ + -project {{ FILE_BUILD_QRC_I18N_JSON }} + @cd \ + {{ DIRECTORY_BUILD_QRC_I18N }}/{{ NAME_DIRECTORY_I18N }}; \ + rm \ + {{ FILE_BUILD_QRC_I18N_JSON }} \ + *.ts + @cd \ + {{ DIRECTORY_BUILD_QRC_I18N }}/{{ NAME_DIRECTORY_I18N }}; \ + {{ TOOL_CLI_RCC }} \ + --project | sed 's,./,{{ NAME_DIRECTORY_I18N }}/,' > {{ FILE_BUILD_QRC_I18N }} + +_generate-qrc-qml: + @rm -rf \ + {{ DIRECTORY_BUILD_QRC_QML }} + @mkdir -p \ + {{ DIRECTORY_BUILD_QRC_QML }} + @cp -r \ + {{ DIRECTORY_QML_SOURCES }} \ + {{ DIRECTORY_BUILD_QRC_QML }} + @cd \ + {{ DIRECTORY_BUILD_QRC_QML }}/{{ NAME_DIRECTORY_QML_SOURCES }}; \ + {{ TOOL_CLI_RCC }} \ + --project | sed 's,./,{{ NAME_DIRECTORY_QML_SOURCES }}/,' > {{ FILE_BUILD_QRC_QML }} + +_prepare-translation-extractions: + @rm -rf \ + {{ DIRECTORY_BUILD_TRANSLATIONS }} + @mkdir -p \ + {{ DIRECTORY_BUILD_TRANSLATIONS }} + @cp -r \ + {{ DIRECTORY_I18N }} \ + {{ DIRECTORY_PY_SOURCES }} \ + {{ DIRECTORY_QML_SOURCES }} \ + {{ DIRECTORY_BUILD_TRANSLATIONS }} + @{{ DIRECTORY_BUILD_HELPERS }}/generate-lupdate-project-file.py \ + --relative-to {{ DIRECTORY_BUILD_TRANSLATIONS }} \ + --out-file {{ FILE_BUILD_TRANSLATIONS_JSON }} diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.MD b/README.MD new file mode 100644 index 00000000..2e996851 --- /dev/null +++ b/README.MD @@ -0,0 +1,85 @@ +# PySide6 + QtQuick Project Template (Unofficial) + +Unofficial opinionated project template to get started with PySide6 and QtQuick quickly without worrying about tooling. + +![screenshot](docs/picture.png) + +# Features + +* Compatible with Python **3.9+** +* Internationalization including (LTR/RTL) +* Resources compiled ahead of time: + * Everything in `data`, `i18n`, and `qml` will be compiled into a Python file + * Final build only consists of Python files +* Testing preconfigured (Python + Qml) +* CI preconfigured +* Client side window decorations implemented +* Qt creator not required (use your favorite text editor) + +# Development Setup + +## Quick Start + +This project assumes that a virtual environment is used. + +1. Set up the development environment for your OS + * [Linux](docs/dev-setup-linux.md) + * [Windows](docs/dev-setup-windows.md) +2. Run `just build-develop` to compile resources +3. Run `python main.py` to start the app + +## Just recipes + +```just +$ just --list +Available recipes: + [build] + build # Build full project into build/release + build-develop # Build and compile resources into source directory + clean # Remove ALL generated files + + [i18n] + add-translation locale # Add new language + update-translations # Update *.ts files by traversing the source code + + [test] + test # Run Python and QML tests + test-python # Run Python tests + test-qml # Run QML tests +``` + +## Workflow + +Run `just build-develop` after each change in the `data`, `i18n`, or `qml` directories. +This will *compile* everything into a Python file and move it into the `myapp` directory +where it will be picked up on app start. + +## Internationalization + +* Adding new languages is described [here](docs/internationalization.md) + +## Read Further + +* Qt6: https://doc.qt.io +* Python: https://www.python.org +* PySide6: https://doc.qt.io/qtforpython/contents.html +* QML Coding Conventions: https://doc.qt.io/qt-6/qml-codingconventions.html +* Python & Qml: https://doc.qt.io/qtforpython/PySide6/QtQml/index.html +* Scripting: https://doc.qt.io/qt-6/topics-scripting.html +* Importing JavaScript Resources in QML: https://doc.qt.io/qt-6/qtqml-javascript-imports.html +* Qt, QtQuick & Python examples are located in `venv/lib//site-packages/PySide6/examples` + after dev environment is set up completely + +# Dependencies + +* PySide6 https://pypi.org/project/PySide6 +* PyTest https://pypi.org/project/pytest +* Just https://github.com/casey/just + +* App Icon: https://commons.wikimedia.org/wiki/File:Qt_logo_2016.svg +* Material Icons: https://fonts.google.com/icons?selected=Material+Icons + +# FAQ + +* Only **PySide6**? Can I substitute **PySide6** with **PyQt6**? + > No. Resources will be compiled ahead of time and PyQt6 dropped support for this. diff --git a/build-aux/generate-lupdate-project-file.py b/build-aux/generate-lupdate-project-file.py new file mode 100755 index 00000000..43cfe32b --- /dev/null +++ b/build-aux/generate-lupdate-project-file.py @@ -0,0 +1,101 @@ +#!/usr/bin/env python +# +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import argparse +import json +import sys +from pathlib import Path + + +class ArgumentValidator: + _errors = [] + + def validate_directory(self, directory: Path, *, name: str): + if not directory.exists(): + self._errors.append(f'{name.capitalize()} {directory} does not exist') + elif not directory.is_dir(): + self._errors.append(f'{name.capitalize()} {directory} is not a directory') + + def break_on_errors(self): + if errors := self._errors: + for error in errors: + print(error, file=sys.stderr) + sys.exit(1) + + +class ProjectFileGenerator: + _extensions_ignored = {'.pyc'} + _extensions_translation = '.ts' + _files = [] + + def __init__(self, root_dir: Path): + self._root_dir = root_dir + + def glob_files(self): + self._files = [path for path in self._root_dir.rglob('*') if path.is_file()] + + def make_files_relative(self): + self._files = [path.relative_to(self._root_dir) for path in self._files] + + def remove_irrelevant_files(self): + self._files = [path for path in self._files if path.suffix not in self._extensions_ignored] + + def sort_files(self): + self._files = sorted(self._files) + + def generate_project_file(self, file: Path): + files = [str(path) for path in self._files if path.suffix != self._extensions_translation] + translations = [str(path) for path in self._files if path.suffix == self._extensions_translation] + structure = { + 'excluded': [], + 'includePaths': [], + 'projectFile': '', + 'sources': files, + 'translations': translations, + } + data = json.dumps([structure], indent=2, sort_keys=True) + file.write_text(data, encoding='utf-8') + + +def main(): + parser = argparse.ArgumentParser(description='Create a json project file') + parser.add_argument('--relative-to', type=str, required=True, + help='Root directory to look for files') + parser.add_argument('--out-file', type=str, required=True, + help='Path of the json project file to generate') + run(parser.parse_args()) + + +def run(args): + root_dir = Path(args.relative_to).absolute() + out_file = Path(args.out_file) + + validator = ArgumentValidator() + validator.validate_directory(root_dir, name='Root directory') + validator.break_on_errors() + + generator = ProjectFileGenerator(root_dir=root_dir) + generator.glob_files() + generator.make_files_relative() + generator.remove_irrelevant_files() + generator.sort_files() + generator.generate_project_file(file=out_file) + + +if __name__ == '__main__': + main() diff --git a/build-aux/generate-qt-creator-project-file.py b/build-aux/generate-qt-creator-project-file.py new file mode 100644 index 00000000..488cae22 --- /dev/null +++ b/build-aux/generate-qt-creator-project-file.py @@ -0,0 +1,118 @@ +#!/usr/bin/env python +# +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import argparse +import json +import sys +from pathlib import Path + + +class ArgumentValidator: + _errors = [] + + def validate_directory(self, directory: Path): + if not directory.exists(): + self._errors.append(f'Directory {directory} does not exist') + elif not directory.is_dir(): + self._errors.append(f'Directory {directory} is not a directory') + + def validate_directories(self, directories: list[Path]): + for directory in directories: + self.validate_directory(directory) + + def validate_files(self, files: list[Path]): + for file in files: + self._validate_file(file) + + def _validate_file(self, file: Path): + if not file.exists(): + self._errors.append(f'File {file} does not exist') + elif not file.is_file(): + self._errors.append(f'File {file} is not a file') + + def break_on_errors(self): + if errors := self._errors: + for error in errors: + print(error, file=sys.stderr) + sys.exit(1) + + +class ProjectFileGenerator: + _extensions_ignored = {'.pyc'} + _files = [] + + def __init__(self, root_dir: Path): + self._root_dir = root_dir + + def add(self, directories: list[Path], files: list[Path]): + for directory in directories: + for path in directory.rglob('*'): + if path.is_file(): + self._files.append(path) + self._files.extend(files) + + def remove_irrelevant_files(self): + self._files = [path for path in self._files if path.suffix not in self._extensions_ignored] + + def make_files_relative(self): + self._files = [path.relative_to(self._root_dir) for path in self._files] + + def sort_files(self): + self._files = sorted(self._files) + + def generate_project_file(self, output: Path): + structure = {'files': [str(file) for file in self._files]} + data = json.dumps(structure, indent=2, sort_keys=True) + output.write_text(data, encoding='utf-8') + + +def main(): + parser = argparse.ArgumentParser(description='Create a pyproject file') + parser.add_argument('--relative-to', type=str, required=True, + help='Root directory to make files relative to') + parser.add_argument('--include-directory', type=str, action='append', default=[], + help='Directory to include. Can be used multiple times') + parser.add_argument('--include-file', type=str, action='append', default=[], + help='File to include. Can be used multiple times') + parser.add_argument('--out-file', type=str, required=True, + help='Path of the pyproject file to generate') + run(parser.parse_args()) + + +def run(args): + root_dir = Path(args.relative_to).absolute() + out_file = Path(args.out_file) + directories = [Path(path).absolute() for path in args.include_directory] + files = [Path(path).absolute() for path in args.include_file] + + validator = ArgumentValidator() + validator.validate_directory(root_dir) + validator.validate_directories(directories) + validator.validate_files(files) + validator.break_on_errors() + + generator = ProjectFileGenerator(root_dir) + generator.add(directories, files) + generator.remove_irrelevant_files() + generator.make_files_relative() + generator.sort_files() + generator.generate_project_file(output=out_file) + + +if __name__ == '__main__': + main() diff --git a/build-aux/linux/Justfile b/build-aux/linux/Justfile new file mode 100755 index 00000000..8738a22a --- /dev/null +++ b/build-aux/linux/Justfile @@ -0,0 +1,12 @@ +#!/usr/bin/env just --justfile + +@_default: + just --list + +# Prints relevant info for flatpak pypi dependencies +print: + @python flatpak-pypi-checker.py \ + --dependency PySide6-Essentials==6.8.0::manylinux:x86_64 \ + --dependency shiboken6==6.8.0::manylinux:x86_64 \ + | jq + diff --git a/build-aux/linux/flatpak-pypi-checker.py b/build-aux/linux/flatpak-pypi-checker.py new file mode 100644 index 00000000..82c3cd4b --- /dev/null +++ b/build-aux/linux/flatpak-pypi-checker.py @@ -0,0 +1,120 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import argparse +import json +import re +import urllib.request +from dataclasses import dataclass + + +class RequirementsUpdater: + """""" + + @dataclass(frozen=True) + class Requirement: + name: str + version: str + filters: list[str] # filter1:filter2:filter3 + data: list = None + + _requirements: dict[str, Requirement] = {} # name mapped to object + + @property + def requirements(self) -> dict[str, Requirement]: + return dict(self._requirements) + + def configure_for(self, dependencies: list[str]) -> None: + for dependency in dependencies: + name, filters = dependency.split("::") + filters = [f.strip() for f in filters.split(":")] + + if "==" in name: + name, _, version = re.split("(>=|==|<=)", name) + elif "<=" in name: + raise ValueError("Version requirement '<=' currently not supported") + else: + version = "latest" + + self._requirements[name] = self.Requirement(name, version, filters) + + def resolve(self) -> None: + for requirement in self._requirements.values(): + name = requirement.name + + with urllib.request.urlopen(f"https://pypi.org/pypi/{name}/json", timeout=5) as connection: + data = json.loads(connection.read().decode("utf-8").strip()) + + version = data["info"]["version"] if requirement.version == "latest" else requirement.version + filters = requirement.filters + data = data["releases"][version] + + self._requirements[requirement.name] = self.Requirement(name, version, filters, data) + + def extract(self) -> list: + """""" + + def find_first_filename_matching(files: list, must_contain_substr: list[str]) -> dict: + for file in files: + if all(f in file["filename"] for f in must_contain_substr): + return file + raise StopIteration( + f"Cannot find file containing all required substrings: {", ".join(must_contain_substr)}" + ) + + dependencies = [] + + for requirement in self._requirements.values(): + filters = requirement.filters + release = find_first_filename_matching(files=requirement.data, must_contain_substr=filters) + value = { + "name": requirement.name, + "version": requirement.version, + "filename": release["filename"], + "sha256": release["digests"]["sha256"], + "url": release["url"], + } + dependencies.append(value) + + dependencies.sort(key=lambda x: x["name"]) + + return dependencies + + +def main(): + parser = argparse.ArgumentParser(description="Prints relevant info for flatpak pypi dependencies") + parser.add_argument( + "--dependency", + type=str, + action="append", + default=[], + help="dependency to consider: dependency::filename-filter1:filename-filter2", + ) + run(parser.parse_args()) + + +def run(args): + updater = RequirementsUpdater() + updater.configure_for(args.dependency) + updater.resolve() + + dependencies = updater.extract() + data = json.dumps(dependencies) + + print(data) + + +if __name__ == "__main__": + main() diff --git a/build-aux/linux/krb5.conf b/build-aux/linux/krb5.conf new file mode 100644 index 00000000..e0d80d36 --- /dev/null +++ b/build-aux/linux/krb5.conf @@ -0,0 +1,9 @@ +[libdefaults] +dns_lookup_realm = false +ticket_lifetime = 24h +renew_lifetime = 7d +forwardable = true +rdns = false +pkinit_anchors = FILE:/etc/ssl/certs/ca-certificates.crt +spake_preauth_groups = edwards25519 +default_ccache_name = KCM: diff --git a/build-aux/linux/org.github.trin94.pyside6.template.desktop b/build-aux/linux/org.github.trin94.pyside6.template.desktop new file mode 100644 index 00000000..52fe6a30 --- /dev/null +++ b/build-aux/linux/org.github.trin94.pyside6.template.desktop @@ -0,0 +1,8 @@ +[Desktop Entry] +Name=PySide6-Template +Icon=org.github.trin94.pyside6.template.svg +Exec=run-my-app +Terminal=false +Type=Application +Categories=Utility +StartupNotify=true diff --git a/build-aux/linux/org.github.trin94.pyside6.template.metainfo.xml b/build-aux/linux/org.github.trin94.pyside6.template.metainfo.xml new file mode 100644 index 00000000..bed31f8e --- /dev/null +++ b/build-aux/linux/org.github.trin94.pyside6.template.metainfo.xml @@ -0,0 +1,28 @@ + + + org.github.trin94.pyside6.template.desktop + CC0-1.0 + LGPL-3.0-or-later + PySide6-Template + Summary + +

Description

+ + + pointing + keyboard + touch + + + + + What's new? + + + + run-my-app + + https://github.com/trin94/PySide6-project-template + https://github.com/trin94/PySide6-project-template/issues + elias.mr1@gmail.com + diff --git a/build-aux/linux/org.github.trin94.pyside6.template.svg b/build-aux/linux/org.github.trin94.pyside6.template.svg new file mode 100644 index 00000000..13163453 --- /dev/null +++ b/build-aux/linux/org.github.trin94.pyside6.template.svg @@ -0,0 +1,3 @@ + + + diff --git a/build-aux/linux/org.github.trin94.pyside6.template.yml b/build-aux/linux/org.github.trin94.pyside6.template.yml new file mode 100644 index 00000000..b110daa8 --- /dev/null +++ b/build-aux/linux/org.github.trin94.pyside6.template.yml @@ -0,0 +1,110 @@ +# Supposed to be called at repository root level - copied during CI build to root level +# +# To build: +# just +# flatpak-builder build-dir org.github.trin94.pyside6.template.yml --force-clean +# flatpak-builder --run build-dir org.github.trin94.pyside6.template.yml run-my-app + +app-id: org.github.trin94.pyside6.template +runtime: org.freedesktop.Platform +runtime-version: '23.08' +sdk: org.freedesktop.Sdk +command: run-my-app + +finish-args: + - --share=ipc + - --socket=wayland + - --socket=fallback-x11 + - --socket=pulseaudio + - --filesystem=host + - --device=dri + +build-options: + cflags: -O2 -g + cxxflags: -O2 -g + env: + V: '1' + +cleanup: + - /include + - /lib/debug + - /lib/pkgconfig + - /lib/python3.12/site-packages/PySide6/examples + - /lib/python3.12/site-packages/PySide6/lupdate + - /lib/python3.12/site-packages/PySide6/assistant + - /lib/python3.12/site-packages/PySide6/qmllint + - /lib/python3.12/site-packages/PySide6/linguist + - /lib/python3.12/site-packages/PySide6/Qt/lib/libQt6WebEngineCore.so.6 + - /lib/python3.12/site-packages/PySide6/Qt/translations/qtwebengine_locales + - /lib/python3.12/site-packages/PySide6/Qt/resources + - /man + - /share/doc + - /share/gtk-doc + - /share/man + - '*.la' + - '*.a' + +modules: + - name: python + sources: + - type: archive + url: https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tar.xz + sha256: 24887b92e2afd4a2ac602419ad4b596372f67ac9b077190f459aba390faf5550 + + # https://github.com/flathub/io.qt.qtwebengine.BaseApp/tree/branch/6.7/krb5 + - name: krb5 + subdir: src + cleanup: + - /bin + - /share/et + - /share/examples + - /share/man + config-opts: + - --localstatedir=/var/lib + - --sbindir=${FLATPAK_DEST}/bin + - --disable-rpath + - --disable-static + post-install: + - install -Dm644 ../krb5.conf -t ${FLATPAK_DEST}/etc/ + sources: + - type: file + path: build-aux/linux/krb5.conf + - type: archive + url: https://kerberos.org/dist/krb5/1.21/krb5-1.21.2.tar.gz + sha256: 9560941a9d843c0243a71b17a7ac6fe31c7cebb5bce3983db79e52ae7e850491 + + - name: pypi-dependencies + buildsystem: simple + build-commands: [ ] + config-opts: + - --force-clean + modules: + - name: python3-PySide6 + buildsystem: simple + build-commands: + - pip3 install --verbose --exists-action=i --no-index --find-links="file://${PWD}" + --prefix=${FLATPAK_DEST} "PySide6-Essentials>=6.8.0" --no-build-isolation + sources: + - type: file + url: https://files.pythonhosted.org/packages/3b/92/9fa08c01ba811e2405059239e16d21b2e5c40b39de204c88fc35ac01c4ff/shiboken6-6.8.0-cp39-abi3-manylinux_2_28_x86_64.whl + sha256: ad88c0e73c9e4de3723c6e6b846e651729433ff9d9086bb2b4e6d49965477d97 + - type: file + url: https://files.pythonhosted.org/packages/9d/fd/17510a0abd503a904ce3b9f1af87385435cf9340fb79c020a53d3a8385a5/PySide6_Essentials-6.8.0-cp39-abi3-manylinux_2_28_x86_64.whl + sha256: da99a94806416ec1e386426a474e7d1e514c1cdf8ad171c005376f4f633e7216 + + - name: myapp + buildsystem: simple + build-commands: + - mkdir -p /app/app-directory + - cp -r myapp /app/app-directory + - install -D main.py /app/app-directory + - install -Dm644 org.github.trin94.pyside6.template.svg /app/share/icons/hicolor/scalable/apps/org.github.trin94.pyside6.template.svg + - install -Dm644 org.github.trin94.pyside6.template.desktop /app/share/applications/org.github.trin94.pyside6.template.desktop + - install -Dm644 org.github.trin94.pyside6.template.metainfo.xml -t /app/share/metainfo + - sed -i 's|/usr/bin/env python|/app/bin/python3|' /app/app-directory/main.py + - ln -s /app/app-directory/main.py /app/bin/run-my-app + sources: + - type: dir + path: build/release + - type: dir + path: build-aux/linux diff --git a/build-aux/windows/icon.ico b/build-aux/windows/icon.ico new file mode 100644 index 00000000..39edede4 Binary files /dev/null and b/build-aux/windows/icon.ico differ diff --git a/data/app-icon.svg b/data/app-icon.svg new file mode 100644 index 00000000..cb8989bb --- /dev/null +++ b/data/app-icon.svg @@ -0,0 +1,67 @@ + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/data/icons/close_black_24dp.svg b/data/icons/close_black_24dp.svg new file mode 100644 index 00000000..5f1267d7 --- /dev/null +++ b/data/icons/close_black_24dp.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/data/icons/close_fullscreen_black_24dp.svg b/data/icons/close_fullscreen_black_24dp.svg new file mode 100644 index 00000000..6c9d1b12 --- /dev/null +++ b/data/icons/close_fullscreen_black_24dp.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/data/icons/minimize_black_24dp.svg b/data/icons/minimize_black_24dp.svg new file mode 100644 index 00000000..fd35c432 --- /dev/null +++ b/data/icons/minimize_black_24dp.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/data/icons/open_in_full_black_24dp.svg b/data/icons/open_in_full_black_24dp.svg new file mode 100644 index 00000000..86df2c53 --- /dev/null +++ b/data/icons/open_in_full_black_24dp.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/data/qtquickcontrols2.conf b/data/qtquickcontrols2.conf new file mode 100644 index 00000000..a94c63b9 --- /dev/null +++ b/data/qtquickcontrols2.conf @@ -0,0 +1,7 @@ +[Controls] +Style=Material + +[Material] +Variant=Dense +Accent=LightGreen +Theme=Dark diff --git a/docs/dev-setup-linux.md b/docs/dev-setup-linux.md new file mode 100644 index 00000000..bab06907 --- /dev/null +++ b/docs/dev-setup-linux.md @@ -0,0 +1,14 @@ +# Development Setup - Linux + +## Tools + +* Make sure `python` is on version **3.8** or later +* Install `just` (https://github.com/casey/just) + +## Checkout + +1. Clone this repository +1. Set up virtual environment: + 1. `python -m venv venv` + 1. `source venv/bin/activate` (*bash*) or `source venv/bin/activate.fish` (*fish*) +1. Install requirements `python -m pip install -r requirements.txt` diff --git a/docs/dev-setup-windows.md b/docs/dev-setup-windows.md new file mode 100644 index 00000000..20f2301f --- /dev/null +++ b/docs/dev-setup-windows.md @@ -0,0 +1,18 @@ +# Development Setup - Windows + +## Tools + +1. Install [python v3.8+](https://www.python.org/downloads/) +1. Install [git-bash](https://git-scm.com/downloads) +1. Install [just](https://github.com/casey/just) + +**just is supposed to be used from git-bash** + +## Checkout + +1. Clone this repository +1. Open git-bash in the directory +1. Set up virtual environment: + 1. `python -m venv venv` + 1. `source venv/Scripts/activate` +1. Install requirements `python -m pip install -r requirements.txt` diff --git a/docs/internationalization.md b/docs/internationalization.md new file mode 100644 index 00000000..79d76bfb --- /dev/null +++ b/docs/internationalization.md @@ -0,0 +1,16 @@ +# Adding Languages + +* Checkout repository +* Make sure development environment is set up correctly for your OS +* Create a new translation file by running + ```shell + just add-translation # just add-translation fr_FR + ``` +* New `.ts` file appears in the `i18n` directory +* Translate the `ts` file using Qt Linguist 6 +* To test the translation: + * Add a new entry in the `MyAppLanguageModel.qml` file + * Run + ```shell + just build-develop + ``` diff --git a/docs/picture.png b/docs/picture.png new file mode 100644 index 00000000..107acfcf Binary files /dev/null and b/docs/picture.png differ diff --git a/i18n/de_DE.ts b/i18n/de_DE.ts new file mode 100644 index 00000000..6f0a9af0 --- /dev/null +++ b/i18n/de_DE.ts @@ -0,0 +1,88 @@ + + + + + HeaderBar + + &Help + + + + &Action 1 + + + + &Action 2 + + + + &Action 3 + + + + &Menu 1 + + + + &Action 4 + + + + &Action 5 + + + + &Menu 2 + + + + &Options + + + + &Language + + + + Showcase translated Qt internal strings + + + + + Languages + + English + Englisch + + + German + Deutsch + + + Hebrew + Hebräisch + + + + MainPage + + Have fun! + Viel Spaß! + + + Exposed from Python: '%1' + + + + + MessageBoxes + + Title + + + + Change the language and look at the 'Yes' and 'Cancel' buttons + + + + diff --git a/i18n/he_IL.ts b/i18n/he_IL.ts new file mode 100644 index 00000000..962fd772 --- /dev/null +++ b/i18n/he_IL.ts @@ -0,0 +1,88 @@ + + + + + HeaderBar + + &Help + + + + &Action 1 + + + + &Action 2 + + + + &Action 3 + + + + &Menu 1 + + + + &Action 4 + + + + &Action 5 + + + + &Menu 2 + + + + &Options + + + + &Language + + + + Showcase translated Qt internal strings + + + + + Languages + + English + אנגלית + + + German + גֶרמָנִיָת + + + Hebrew + עִברִית + + + + MainPage + + Have fun! + תעשה חיים! + + + Exposed from Python: '%1' + + + + + MessageBoxes + + Title + + + + Change the language and look at the 'Yes' and 'Cancel' buttons + + + + diff --git a/main.py b/main.py new file mode 100755 index 00000000..f6a4c514 --- /dev/null +++ b/main.py @@ -0,0 +1,11 @@ +#!/usr/bin/env python + + +def main(): + from myapp.startup import perform_startup + + perform_startup() + + +if __name__ == '__main__': + main() diff --git a/myapp/__init__.py b/myapp/__init__.py new file mode 100644 index 00000000..398a9d14 --- /dev/null +++ b/myapp/__init__.py @@ -0,0 +1,14 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . diff --git a/myapp/application.py b/myapp/application.py new file mode 100644 index 00000000..c76df5b0 --- /dev/null +++ b/myapp/application.py @@ -0,0 +1,84 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import platform +import sys + +from PySide6.QtCore import QUrl, QTranslator, QLocale, QLibraryInfo +from PySide6.QtGui import QGuiApplication, QIcon +from PySide6.QtQml import QQmlApplicationEngine + + +class MyApplication(QGuiApplication): + + def __init__(self, args): + super().__init__(args) + self._engine = QQmlApplicationEngine() + self._translator_myapp = QTranslator() + self._translator_qt = QTranslator() + + def set_window_icon(self): + icon = QIcon(':/data/app-icon.svg') + self.setWindowIcon(icon) + + def set_up_signals(self): + self.aboutToQuit.connect(self._on_quit) + self._engine.uiLanguageChanged.connect(self._retranslate) + + def _on_quit(self) -> None: + del self._engine + + def _retranslate(self): + locale = QLocale(self._engine.uiLanguage()) + + self.removeTranslator(self._translator_qt) + self.removeTranslator(self._translator_myapp) + + self._translator_qt.load(locale, "qtbase", "_", QLibraryInfo.location(QLibraryInfo.TranslationsPath)) + self._translator_myapp.load(f':/i18n/{locale.name()}.qm') + + self.installTranslator(self._translator_qt) + self.installTranslator(self._translator_myapp) + + self.setLayoutDirection(locale.textDirection()) + + def set_up_imports(self): + self._engine.addImportPath(':/qml') + + def set_up_window_event_filter(self): + if platform.system() == "Windows": + from myapp.framelesswindow.win import WindowsEventFilter + self._event_filter = WindowsEventFilter(border_width=5) + self.installNativeEventFilter(self._event_filter) + elif platform.system() == 'Linux': + from myapp.framelesswindow.linux import LinuxEventFilter + self._event_filter = LinuxEventFilter(border_width=5) + self.installEventFilter(self._event_filter) + + def start_engine(self): + self._engine.load(QUrl.fromLocalFile(':/qml/main.qml')) + + def set_up_window_effects(self): + if sys.platform == 'win32': + hwnd = self.topLevelWindows()[0].winId() + from myapp.framelesswindow.win import WindowsWindowEffect + self._effects = WindowsWindowEffect() + self._effects.addShadowEffect(hwnd) + self._effects.addWindowAnimation(hwnd) + + def verify(self): + if not self._engine.rootObjects(): + sys.exit(-1) diff --git a/myapp/framelesswindow/__init__.py b/myapp/framelesswindow/__init__.py new file mode 100644 index 00000000..398a9d14 --- /dev/null +++ b/myapp/framelesswindow/__init__.py @@ -0,0 +1,14 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . diff --git a/myapp/framelesswindow/linux/__init__.py b/myapp/framelesswindow/linux/__init__.py new file mode 100644 index 00000000..501c1359 --- /dev/null +++ b/myapp/framelesswindow/linux/__init__.py @@ -0,0 +1,16 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from .event import LinuxEventFilter diff --git a/myapp/framelesswindow/linux/event.py b/myapp/framelesswindow/linux/event.py new file mode 100644 index 00000000..99ed3003 --- /dev/null +++ b/myapp/framelesswindow/linux/event.py @@ -0,0 +1,69 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 3. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# Inspired and based on: +# - https://github.com/zhiyiYo/PyQt-Frameless-Window +# - https://gitee.com/Virace/pyside6-qml-frameless-window/tree/main + + +from typing import Optional + +from PySide6.QtCore import QCoreApplication, QObject, QEvent, Qt +from PySide6.QtGui import QCursor, QGuiApplication, QWindow + + +class LinuxEventFilter(QObject): + + def __init__(self, border_width=None) -> None: + super().__init__() + self.border_width = border_width + + self._app: QGuiApplication = QCoreApplication.instance() + self._window: Optional[QWindow] = None + + def eventFilter(self, obj, event): + if event.type() != QEvent.MouseButtonPress and event.type() != QEvent.MouseMove: + return False + + if self._window is None: + self._window = self._app.topLevelWindows()[0] + + pos = QCursor.pos() - self._window.position() + edges = Qt.Edge(0) + if pos.x() < self.border_width: + edges |= Qt.LeftEdge + if pos.x() >= self._window.width() - self.border_width: + edges |= Qt.RightEdge + if pos.y() < self.border_width: + edges |= Qt.TopEdge + if pos.y() >= self._window.height() - self.border_width: + edges |= Qt.BottomEdge + + if event.type() == QEvent.MouseMove and self._window.windowState() == Qt.WindowNoState: + if edges in (Qt.LeftEdge | Qt.TopEdge, Qt.RightEdge | Qt.BottomEdge): + self._app.setOverrideCursor(Qt.SizeFDiagCursor) + elif edges in (Qt.RightEdge | Qt.TopEdge, Qt.LeftEdge | Qt.BottomEdge): + self._app.setOverrideCursor(Qt.SizeBDiagCursor) + elif edges in (Qt.TopEdge, Qt.BottomEdge): + self._app.setOverrideCursor(Qt.SizeVerCursor) + elif edges in (Qt.LeftEdge, Qt.RightEdge): + self._app.setOverrideCursor(Qt.SizeHorCursor) + else: + self._app.restoreOverrideCursor() + + if event.type() == QEvent.MouseButtonPress and edges: + self._window.startSystemResize(edges) + return True + + return super().eventFilter(obj, event) diff --git a/myapp/framelesswindow/win/__init__.py b/myapp/framelesswindow/win/__init__.py new file mode 100644 index 00000000..40c0b085 --- /dev/null +++ b/myapp/framelesswindow/win/__init__.py @@ -0,0 +1,22 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# Inspired and based on: +# - https://github.com/zhiyiYo/PyQt-Frameless-Window +# - https://gitee.com/Virace/pyside6-qml-frameless-window/tree/main + + +from .effect import WindowsWindowEffect +from .event import WindowsEventFilter diff --git a/myapp/framelesswindow/win/c_structures.py b/myapp/framelesswindow/win/c_structures.py new file mode 100644 index 00000000..bf2f181b --- /dev/null +++ b/myapp/framelesswindow/win/c_structures.py @@ -0,0 +1,172 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 3. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +# Inspired and based on: +# - https://github.com/zhiyiYo/PyQt-Frameless-Window +# - https://gitee.com/Virace/pyside6-qml-frameless-window/tree/main + + +from ctypes import POINTER, Structure, c_int +from ctypes.wintypes import DWORD, HWND, ULONG, POINT, RECT, UINT, BOOL, HRGN +from enum import Enum + + +class WINDOWCOMPOSITIONATTRIB(Enum): + WCA_UNDEFINED = 0 + WCA_NCRENDERING_ENABLED = 1 + WCA_NCRENDERING_POLICY = 2 + WCA_TRANSITIONS_FORCEDISABLED = 3 + WCA_ALLOW_NCPAINT = 4 + WCA_CAPTION_BUTTON_BOUNDS = 5 + WCA_NONCLIENT_RTL_LAYOUT = 6 + WCA_FORCE_ICONIC_REPRESENTATION = 7 + WCA_EXTENDED_FRAME_BOUNDS = 8 + WCA_HAS_ICONIC_BITMAP = 9 + WCA_THEME_ATTRIBUTES = 10 + WCA_NCRENDERING_EXILED = 11 + WCA_NCADORNMENTINFO = 12 + WCA_EXCLUDED_FROM_LIVEPREVIEW = 13 + WCA_VIDEO_OVERLAY_ACTIVE = 14 + WCA_FORCE_ACTIVEWINDOW_APPEARANCE = 15 + WCA_DISALLOW_PEEK = 16 + WCA_CLOAK = 17 + WCA_CLOAKED = 18 + WCA_ACCENT_POLICY = 19 + WCA_FREEZE_REPRESENTATION = 20 + WCA_EVER_UNCLOAKED = 21 + WCA_VISUAL_OWNER = 22 + WCA_HOLOGRAPHIC = 23 + WCA_EXCLUDED_FROM_DDA = 24 + WCA_PASSIVEUPDATEMODE = 25 + WCA_USEDARKMODECOLORS = 26 + WCA_CORNER_STYLE = 27 + WCA_PART_COLOR = 28 + WCA_DISABLE_MOVESIZE_FEEDBACK = 29 + WCA_LAST = 30 + + +class ACCENT_STATE(Enum): + """ Client area status enumeration class """ + ACCENT_DISABLED = 0 + ACCENT_ENABLE_GRADIENT = 1 + ACCENT_ENABLE_TRANSPARENTGRADIENT = 2 + ACCENT_ENABLE_BLURBEHIND = 3 # Aero effect + ACCENT_ENABLE_ACRYLICBLURBEHIND = 4 # Acrylic effect + ACCENT_ENABLE_HOSTBACKDROP = 5 # Mica effect + ACCENT_INVALID_STATE = 6 + + +class ACCENT_POLICY(Structure): + """ Specific attributes of client area """ + + _fields_ = [ + ("AccentState", DWORD), + ("AccentFlags", DWORD), + ("GradientColor", DWORD), + ("AnimationId", DWORD), + ] + + +class WINDOWCOMPOSITIONATTRIBDATA(Structure): + _fields_ = [ + ("Attribute", DWORD), + # Pointer() receives any ctypes type and returns a pointer type + ("Data", POINTER(ACCENT_POLICY)), + ("SizeOfData", ULONG), + ] + + +class DWMNCRENDERINGPOLICY(Enum): + DWMNCRP_USEWINDOWSTYLE = 0 + DWMNCRP_DISABLED = 1 + DWMNCRP_ENABLED = 2 + DWMNCRP_LAS = 3 + + +class DWMWINDOWATTRIBUTE(Enum): + DWMWA_NCRENDERING_ENABLED = 1 + DWMWA_NCRENDERING_POLICY = 2 + DWMWA_TRANSITIONS_FORCEDISABLED = 3 + DWMWA_ALLOW_NCPAINT = 4 + DWMWA_CAPTION_BUTTON_BOUNDS = 5 + DWMWA_NONCLIENT_RTL_LAYOUT = 6 + DWMWA_FORCE_ICONIC_REPRESENTATION = 7 + DWMWA_FLIP3D_POLICY = 8 + DWMWA_EXTENDED_FRAME_BOUNDS = 9 + DWMWA_HAS_ICONIC_BITMAP = 10 + DWMWA_DISALLOW_PEEK = 11 + DWMWA_EXCLUDED_FROM_PEEK = 12 + DWMWA_CLOAK = 13 + DWMWA_CLOAKED = 14 + DWMWA_FREEZE_REPRESENTATION = 15 + DWMWA_PASSIVE_UPDATE_MODE = 16 + DWMWA_USE_HOSTBACKDROPBRUSH = 17 + DWMWA_USE_IMMERSIVE_DARK_MODE = 18 + DWMWA_WINDOW_CORNER_PREFERENCE = 19 + DWMWA_BORDER_COLOR = 20 + DWMWA_CAPTION_COLOR = 21 + DWMWA_TEXT_COLOR = 22 + DWMWA_VISIBLE_FRAME_BORDER_THICKNESS = 23 + DWMWA_LAST = 24 + + +class MARGINS(Structure): + _fields_ = [ + ("cxLeftWidth", c_int), + ("cxRightWidth", c_int), + ("cyTopHeight", c_int), + ("cyBottomHeight", c_int), + ] + + +class MINMAXINFO(Structure): + _fields_ = [ + ("ptReserved", POINT), + ("ptMaxSize", POINT), + ("ptMaxPosition", POINT), + ("ptMinTrackSize", POINT), + ("ptMaxTrackSize", POINT), + ] + + +class PWINDOWPOS(Structure): + _fields_ = [ + ('hWnd', HWND), + ('hwndInsertAfter', HWND), + ('x', c_int), + ('y', c_int), + ('cx', c_int), + ('cy', c_int), + ('flags', UINT) + ] + + +class NCCALCSIZE_PARAMS(Structure): + _fields_ = [ + ('rgrc', RECT * 3), + ('lppos', POINTER(PWINDOWPOS)) + ] + + +LPNCCALCSIZE_PARAMS = POINTER(NCCALCSIZE_PARAMS) + + +class DWM_BLURBEHIND(Structure): + _fields_ = [ + ('dwFlags', DWORD), + ('fEnable', BOOL), + ('hRgnBlur', HRGN), + ('fTransitionOnMaximized', BOOL), + ] diff --git a/myapp/framelesswindow/win/effect.py b/myapp/framelesswindow/win/effect.py new file mode 100644 index 00000000..be0b24d9 --- /dev/null +++ b/myapp/framelesswindow/win/effect.py @@ -0,0 +1,86 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 3. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +# Inspired and based on: +# - https://github.com/zhiyiYo/PyQt-Frameless-Window +# - https://gitee.com/Virace/pyside6-qml-frameless-window/tree/main + + +from ctypes import POINTER, byref, c_bool, c_int, pointer, sizeof, WinDLL, windll +from ctypes.wintypes import DWORD, LONG, LPCVOID + +import win32con +import win32gui + +from .c_structures import ACCENT_POLICY, MARGINS, WINDOWCOMPOSITIONATTRIB, WINDOWCOMPOSITIONATTRIBDATA, DWM_BLURBEHIND + + +class WindowsWindowEffect: + + def __init__(self): + self.user32 = WinDLL("user32") + self.dwmapi = WinDLL("dwmapi") + self.SetWindowCompositionAttribute = self.user32.SetWindowCompositionAttribute + self.DwmExtendFrameIntoClientArea = self.dwmapi.DwmExtendFrameIntoClientArea + self.DwmEnableBlurBehindWindow = self.dwmapi.DwmEnableBlurBehindWindow + self.DwmSetWindowAttribute = self.dwmapi.DwmSetWindowAttribute + + self.SetWindowCompositionAttribute.restype = c_bool + self.DwmExtendFrameIntoClientArea.restype = LONG + self.DwmEnableBlurBehindWindow.restype = LONG + self.DwmSetWindowAttribute.restype = LONG + + self.SetWindowCompositionAttribute.argtypes = [ + c_int, + POINTER(WINDOWCOMPOSITIONATTRIBDATA), + ] + self.DwmSetWindowAttribute.argtypes = [c_int, DWORD, LPCVOID, DWORD] + self.DwmExtendFrameIntoClientArea.argtypes = [c_int, POINTER(MARGINS)] + self.DwmEnableBlurBehindWindow.argtypes = [c_int, POINTER(DWM_BLURBEHIND)] + + # Initialize structure + self.accentPolicy = ACCENT_POLICY() + self.winCompAttrData = WINDOWCOMPOSITIONATTRIBDATA() + self.winCompAttrData.Attribute = WINDOWCOMPOSITIONATTRIB.WCA_ACCENT_POLICY.value + self.winCompAttrData.SizeOfData = sizeof(self.accentPolicy) + self.winCompAttrData.Data = pointer(self.accentPolicy) + + def addShadowEffect(self, hWnd): + if not self._isDwmCompositionEnabled(): + return + hWnd = int(hWnd) + margins = MARGINS(-1, -1, -1, -1) + self.DwmExtendFrameIntoClientArea(hWnd, byref(margins)) + + @staticmethod + def _isDwmCompositionEnabled(): + bResult = c_int(0) + windll.dwmapi.DwmIsCompositionEnabled(byref(bResult)) + return bool(bResult.value) + + @staticmethod + def addWindowAnimation(hWnd): + hWnd = int(hWnd) + style = win32gui.GetWindowLong(hWnd, win32con.GWL_STYLE) + win32gui.SetWindowLong( + hWnd, + win32con.GWL_STYLE, + style + | win32con.WS_MINIMIZEBOX + | win32con.WS_MAXIMIZEBOX + | win32con.WS_CAPTION + | win32con.CS_DBLCLKS + | win32con.WS_THICKFRAME, + ) diff --git a/myapp/framelesswindow/win/event.py b/myapp/framelesswindow/win/event.py new file mode 100644 index 00000000..226b2017 --- /dev/null +++ b/myapp/framelesswindow/win/event.py @@ -0,0 +1,131 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 3. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +# Inspired and based on: +# - https://github.com/zhiyiYo/PyQt-Frameless-Window +# - https://gitee.com/Virace/pyside6-qml-frameless-window/tree/main + + +import ctypes.wintypes + +import PySide6.QtCore +import win32api +import win32con +import win32gui + +from .c_structures import MINMAXINFO, NCCALCSIZE_PARAMS + + +class WindowsEventFilter(PySide6.QtCore.QAbstractNativeEventFilter): + def __init__(self, border_width=None) -> None: + super().__init__() + self.border_width = border_width + self.monitor_info = None + + def nativeEventFilter(self, eventType, message): + msg = ctypes.wintypes.MSG.from_address(message.__int__()) + + if not msg.hWnd: + return False, 0 + + if msg.message == win32con.WM_NCHITTEST and (self.border_width is not None): + + x, y, w, h = self.get_window_size(msg.hWnd) + x_pos = (win32api.LOWORD(msg.lParam) - x) % 65536 + y_pos = win32api.HIWORD(msg.lParam) - y + + lx = x_pos < self.border_width + rx = x_pos + 9 > w - self.border_width + ty = y_pos < self.border_width + by = y_pos > h - self.border_width + + if lx and ty: + return True, win32con.HTTOPLEFT + elif rx and by: + return True, win32con.HTBOTTOMRIGHT + elif rx and ty: + return True, win32con.HTTOPRIGHT + elif lx and by: + return True, win32con.HTBOTTOMLEFT + elif ty: + return True, win32con.HTTOP + elif by: + return True, win32con.HTBOTTOM + elif lx: + return True, win32con.HTLEFT + elif rx: + return True, win32con.HTRIGHT + elif msg.message == win32con.WM_NCCALCSIZE: + if self.isWindowMaximized(msg.hWnd): + self.monitorNCCALCSIZE(msg) + return True, 0 + elif msg.message == win32con.WM_GETMINMAXINFO: + if self.isWindowMaximized(msg.hWnd): + window_rect = win32gui.GetWindowRect(msg.hWnd) + if not window_rect: + return False, 0 + + # get the monitor handle + monitor = win32api.MonitorFromRect(window_rect) + if not monitor: + return False, 0 + + # get the monitor info + self.monitor_info = win32api.GetMonitorInfo(monitor) + monitor_rect = self.monitor_info['Monitor'] + work_area = self.monitor_info['Work'] + + # convert lParam to MINMAXINFO pointer + info = ctypes.cast(msg.lParam, ctypes.POINTER(MINMAXINFO)).contents + + # adjust the size of window + info.ptMaxSize.x = work_area[2] - work_area[0] + info.ptMaxSize.y = work_area[3] - work_area[1] + info.ptMaxTrackSize.x = info.ptMaxSize.x + info.ptMaxTrackSize.y = info.ptMaxSize.y + + # modify the upper left coordinate + info.ptMaxPosition.x = abs(window_rect[0] - monitor_rect[0]) + info.ptMaxPosition.y = abs(window_rect[1] - monitor_rect[1]) + return True, 1 + return False, 0 + + @classmethod + def get_window_size(cls, hwnd): + left, top, right, bottom = win32gui.GetWindowRect(hwnd) + + width = right - left + height = bottom - top + return left, top, width, height + + def monitorNCCALCSIZE(self, msg: ctypes.wintypes.MSG): + monitor = win32api.MonitorFromWindow(msg.hWnd) + if monitor is None and not self.monitor_info: + return + elif monitor is not None: + self.monitor_info = win32api.GetMonitorInfo(monitor) + params = ctypes.cast(msg.lParam, + ctypes.POINTER(NCCALCSIZE_PARAMS)).contents + params.rgrc[0].left = self.monitor_info['Work'][0] + params.rgrc[0].top = self.monitor_info['Work'][1] + params.rgrc[0].right = self.monitor_info['Work'][2] + params.rgrc[0].bottom = self.monitor_info['Work'][3] + + @classmethod + def isWindowMaximized(cls, hwnd) -> bool: + windowPlacement = win32gui.GetWindowPlacement(hwnd) + if not windowPlacement: + return False + return windowPlacement[1] == win32con.SW_MAXIMIZE diff --git a/myapp/pyobjects/__init__.py b/myapp/pyobjects/__init__.py new file mode 100644 index 00000000..9f472b14 --- /dev/null +++ b/myapp/pyobjects/__init__.py @@ -0,0 +1,17 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +from .example_singleton import SingletonPyObject diff --git a/myapp/pyobjects/example_singleton.py b/myapp/pyobjects/example_singleton.py new file mode 100644 index 00000000..faf184b8 --- /dev/null +++ b/myapp/pyobjects/example_singleton.py @@ -0,0 +1,32 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +from PySide6.QtCore import QObject, Signal, Property +from PySide6.QtQml import QmlElement, QmlSingleton + +QML_IMPORT_NAME = "pyobjects" +QML_IMPORT_MAJOR_VERSION = 1 + + +@QmlElement +@QmlSingleton +class SingletonPyObject(QObject): + + def get_exposed_property(self) -> str: + return 'py property' + + exposed_property_changed = Signal(str) + exposed_property = Property(str, get_exposed_property, notify=exposed_property_changed) diff --git a/myapp/startup.py b/myapp/startup.py new file mode 100644 index 00000000..c7f18916 --- /dev/null +++ b/myapp/startup.py @@ -0,0 +1,72 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import os +import sys + + +class StartUp: + """Necessary steps for environment, Python and Qt""" + + @staticmethod + def configure_qt_application_data(): + from PySide6.QtCore import QCoreApplication + QCoreApplication.setApplicationName('my app name') + QCoreApplication.setOrganizationName('my org name') + QCoreApplication.setApplicationVersion('my app version') + + @staticmethod + def configure_environment_variables(): + # Qt expects 'qtquickcontrols2.conf' at root level, but the way we handle resources does not allow that. + # So we need to override the path here + os.environ['QT_QUICK_CONTROLS_CONF'] = ':/data/qtquickcontrols2.conf' + + @staticmethod + def import_resources(): + # noinspection PyUnresolvedReferences + import myapp.generated_resources + + @staticmethod + def import_bindings(): + # noinspection PyUnresolvedReferences + import myapp.pyobjects + + @staticmethod + def start_application(): + from myapp.application import MyApplication + app = MyApplication(sys.argv) + + app.set_window_icon() + app.set_up_signals() + app.set_up_imports() + app.set_up_window_event_filter() + app.start_engine() + app.set_up_window_effects() + app.verify() + + sys.exit(app.exec()) + + +def perform_startup(): + we = StartUp() + + we.configure_qt_application_data() + we.configure_environment_variables() + + we.import_resources() + we.import_bindings() + + we.start_application() diff --git a/qml/app/MyAppMainPage.qml b/qml/app/MyAppMainPage.qml new file mode 100644 index 00000000..8f3db87b --- /dev/null +++ b/qml/app/MyAppMainPage.qml @@ -0,0 +1,97 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick +import QtQuick.Controls +import QtQuick.Layouts + +import header +import pyobjects + + +Page { + id: root + + required property var appWindow + + anchors { + fill: root + } + + header: MyAppHeader { + appWindow: root.appWindow + } + + ColumnLayout { + spacing: 8 + width: root.width + + Image { + source: "qrc:/data/app-icon.svg" + asynchronous: true + + Layout.alignment: Qt.AlignHCenter + Layout.preferredWidth: 308 + Layout.preferredHeight: 226 + Layout.topMargin: 30 + } + + Label { + text: Qt.application.name + ' (' + Qt.application.version + ')' + + font { + bold: true + pixelSize: Qt.application.font.pixelSize * 1.5 + } + + Layout.alignment: Qt.AlignHCenter + Layout.topMargin: 45 + } + + Label { + text: 'Running on ' + Qt.platform.os + + font { + bold: true + pixelSize: Qt.application.font.pixelSize * 1.5 + } + + Layout.alignment: Qt.AlignHCenter + } + + Label { + text: qsTranslate("MainPage", "Have fun!") + color: Material.accent + + font { + bold: true + pixelSize: Qt.application.font.pixelSize * 1.5 + } + + Layout.alignment: Qt.AlignHCenter + Layout.topMargin: 45 + } + + Label { + text: qsTranslate("MainPage", "Exposed from Python: '%1'").arg(SingletonPyObject.exposed_property) + + Layout.alignment: Qt.AlignHCenter + Layout.topMargin: 45 + } + } + +} diff --git a/qml/app/qmldir b/qml/app/qmldir new file mode 100644 index 00000000..4ba53f24 --- /dev/null +++ b/qml/app/qmldir @@ -0,0 +1,2 @@ +qmldir app +MyAppMainPage MyAppMainPage.qml diff --git a/qml/header/MyAppHeader.qml b/qml/header/MyAppHeader.qml new file mode 100644 index 00000000..3c3da662 --- /dev/null +++ b/qml/header/MyAppHeader.qml @@ -0,0 +1,60 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick + + +Item { + id: root + + required property var appWindow + + width: parent.width + height: headerBar.height + + TapHandler { + gesturePolicy: TapHandler.DragThreshold + + onTapped: { + if (tapCount === 2) { + if (root.appWindow.visibility === Window.Maximized) { + root.appWindow.showNormal() + } else { + root.appWindow.showMaximized() + } + } + } + } + + DragHandler { + target: null + grabPermissions: TapHandler.CanTakeOverFromAnything + + onActiveChanged: { + if (active) { + root.appWindow.startSystemMove() + } + } + } + + MyAppHeaderContent { + id: headerBar + + appWindow: root.appWindow + } + +} diff --git a/qml/header/MyAppHeaderContent.qml b/qml/header/MyAppHeaderContent.qml new file mode 100644 index 00000000..0676f4b6 --- /dev/null +++ b/qml/header/MyAppHeaderContent.qml @@ -0,0 +1,135 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick +import QtQuick.Controls + + +Item { + id: root + + required property var appWindow + + width: parent.width + height: menuBar.height + + Row { + width: root.width + spacing: 0 + + MenuBar { + id: menuBar + + background: Rectangle { + color: "transparent" + } + + MyAppMenu1 {} + MyAppMenu2 {} + MyAppOptionsMenu {} + MyAppHelpMenu {} + } + + Label { + text: Qt.application.name + horizontalAlignment: Text.AlignHCenter + verticalAlignment: Text.AlignVCenter + width: root.width - menuBar.width * 2 + height: menuBar.height + elide: LayoutMirroring.enabled ? Text.ElideLeft : Text.ElideRight + } + + Item { + id: buttonWrapper + + width: menuBar.width + height: menuBar.height + + ToolButton { + objectName: 'minimizeButton' + + height: buttonWrapper.height + focusPolicy: Qt.NoFocus + + icon { + source: "qrc:/data/icons/minimize_black_24dp.svg" + width: 18 + height: 18 + } + + anchors { + right: maximizeButton.left + } + + onClicked: { + root.appWindow.showMinimized() + } + } + + ToolButton { + id: maximizeButton + + focusPolicy: Qt.NoFocus + height: buttonWrapper.height + + icon { + property bool maximized: root.appWindow.visibility === Window.Maximized + property url iconMaximize: "qrc:/data/icons/open_in_full_black_24dp.svg" + property url iconNormalize: "qrc:/data/icons/close_fullscreen_black_24dp.svg" + + source: maximized ? iconNormalize : iconMaximize + width: 18 + height: 18 + } + + anchors { + right: closeButton.left + } + + onClicked: { + if (root.appWindow.visibility === Window.Maximized) { + root.appWindow.showNormal() + } else { + root.appWindow.showMaximized() + } + } + } + + ToolButton { + id: closeButton + + height: buttonWrapper.height + focusPolicy: Qt.NoFocus + + icon { + source: "qrc:/data/icons/close_black_24dp.svg" + width: 18 + height: 18 + } + + anchors { + right: buttonWrapper.right + } + + onClicked: { + root.appWindow.close() + } + } + } + } + +} diff --git a/qml/header/MyAppHelpMenu.qml b/qml/header/MyAppHelpMenu.qml new file mode 100644 index 00000000..69593e81 --- /dev/null +++ b/qml/header/MyAppHelpMenu.qml @@ -0,0 +1,53 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick.Controls + +import shared + + +MyAppAutoWidthMenu { + title: qsTranslate("HeaderBar", "&Help") + + Action { + text: qsTranslate("HeaderBar", "&Action 1") + shortcut: "CTRL+N" + + onTriggered: { + console.log("Action 1 pressed") + } + } + + Action { + text: qsTranslate("HeaderBar", "&Action 2") + + onTriggered: { + console.log("Action 2 pressed") + } + } + + MenuSeparator { } + + Action { + text: qsTranslate("HeaderBar", "&Action 3") + + onTriggered: { + console.log("Action 3 pressed") + } + } + +} diff --git a/qml/header/MyAppMenu1.qml b/qml/header/MyAppMenu1.qml new file mode 100644 index 00000000..fea7761a --- /dev/null +++ b/qml/header/MyAppMenu1.qml @@ -0,0 +1,69 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick.Controls + +import shared + + +MyAppAutoWidthMenu { + title: qsTranslate("HeaderBar", "&Menu 1") + + Action { + text: qsTranslate("HeaderBar", "&Action 1") + shortcut: "CTRL+N" + + onTriggered: { + console.log("Action 1 pressed") + } + } + + Action { + text: qsTranslate("HeaderBar", "&Action 2") + + onTriggered: { + console.log("Action 2 pressed") + } + } + + Action { + text: qsTranslate("HeaderBar", "&Action 3") + + onTriggered: { + console.log("Action 3 pressed") + } + } + + Action { + text: qsTranslate("HeaderBar", "&Action 4") + + onTriggered: { + console.log("Action 4 pressed") + } + } + + MenuSeparator { } + + Action { + text: qsTranslate("HeaderBar", "&Action 5") + + onTriggered: { + console.log("Action 5 pressed") + } + } + +} diff --git a/qml/header/MyAppMenu2.qml b/qml/header/MyAppMenu2.qml new file mode 100644 index 00000000..556fdb6e --- /dev/null +++ b/qml/header/MyAppMenu2.qml @@ -0,0 +1,53 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick.Controls + +import shared + + +MyAppAutoWidthMenu { + title: qsTranslate("HeaderBar", "&Menu 2") + + Action { + text: qsTranslate("HeaderBar", "&Action 1") + shortcut: "CTRL+N" + + onTriggered: { + console.log("Action 1 pressed") + } + } + + Action { + text: qsTranslate("HeaderBar", "&Action 2") + + onTriggered: { + console.log("Action 2 pressed") + } + } + + MenuSeparator { } + + Action { + text: qsTranslate("HeaderBar", "&Action 3") + + onTriggered: { + console.log("Action 3 pressed") + } + } + +} diff --git a/qml/header/MyAppOptionsMenu.qml b/qml/header/MyAppOptionsMenu.qml new file mode 100644 index 00000000..e123cb03 --- /dev/null +++ b/qml/header/MyAppOptionsMenu.qml @@ -0,0 +1,85 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick +import QtQuick.Controls +import QtQuick.Dialogs + +import shared +import models + + +MyAppAutoWidthMenu { + id: root + + title: qsTranslate("HeaderBar", "&Options") + + MyAppAutoWidthMenu { + title: qsTranslate("HeaderBar", "&Language") + + Repeater { + model: MyAppLanguageModel {} + + MenuItem { + id: _itemDelegate + + required property string language // from model + required property string abbrev // from model + + text: qsTranslate("Languages", _itemDelegate.language) + + onTriggered: { + animationDelayTimer.start() + } + + Timer { + id: animationDelayTimer + + interval: 125 + + onTriggered: { + Qt.uiLanguage = _itemDelegate.abbrev + } + } + } + } + } + + MenuSeparator { + } + + Action { + text: qsTranslate("HeaderBar", "Showcase translated Qt internal strings") + + property var factory: Component + { + MessageDialog { + title: qsTranslate("MessageBoxes", "Title") + text: qsTranslate("MessageBoxes", "Change the language and look at the 'Yes' and 'Cancel' buttons") + buttons: MessageDialog.Yes | MessageDialog.Cancel + visible: true + } + } + + onTriggered: { + const dialog = factory.createObject(root) + dialog.closed.connect(dialog.destroy) + dialog.open() + } + } + +} diff --git a/qml/header/qmldir b/qml/header/qmldir new file mode 100644 index 00000000..59c24db6 --- /dev/null +++ b/qml/header/qmldir @@ -0,0 +1,2 @@ +module header +MyAppHeader MyAppHeader.qml diff --git a/qml/main.qml b/qml/main.qml new file mode 100644 index 00000000..12152019 --- /dev/null +++ b/qml/main.qml @@ -0,0 +1,83 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick +import QtQuick.Controls + +import app + + +ApplicationWindow { + id: root + + width: 1280 + height: 720 + flags: Qt.FramelessWindowHint | Qt.Window + visible: true + + LayoutMirroring.enabled: Qt.application.layoutDirection === Qt.RightToLeft + LayoutMirroring.childrenInherit: true + + MyAppMainPage { + appWindow: _shared + + anchors { + fill: root.contentItem + margins: _private.windowBorder + } + } + + Component.onCompleted: { + // load language from settings + // Qt.uiLanguage = ... + } + + QtObject { + id: _private // Implementation details not exposed to child items + + readonly property bool maximized: root.visibility === Window.Maximized + readonly property bool fullscreen: root.visibility === Window.FullScreen + readonly property int windowBorder: fullscreen || maximized ? 0 : 1 + } + + QtObject { + id: _shared // Properties and functions exposed to child items + + readonly property var visibility: root.visibility + + function startSystemMove() { + root.startSystemMove() + } + + function showMinimized() { + root.showMinimized() + } + + function showMaximized() { + root.showMaximized() + } + + function showNormal() { + root.showNormal() + } + + function close() { + root.close() + } + } + +} diff --git a/qml/models/MyAppLanguageModel.qml b/qml/models/MyAppLanguageModel.qml new file mode 100644 index 00000000..0dcd35ee --- /dev/null +++ b/qml/models/MyAppLanguageModel.qml @@ -0,0 +1,40 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick + + +ListModel { + readonly property var languagesForTranslationTool: [ + qsTranslate("Languages", "English"), + qsTranslate("Languages", "German"), + qsTranslate("Languages", "Hebrew"), + ] + + ListElement { + language: "English" + abbrev: "en_US" + } + ListElement { + language: "German" + abbrev: "de_DE" + } + ListElement { + language: "Hebrew" + abbrev: "he_IL" + } +} diff --git a/qml/models/qmldir b/qml/models/qmldir new file mode 100644 index 00000000..506dc45e --- /dev/null +++ b/qml/models/qmldir @@ -0,0 +1,2 @@ +module models +MyAppLanguageModel MyAppLanguageModel.qml diff --git a/qml/models/tst_MyAppLanguageModel.qml b/qml/models/tst_MyAppLanguageModel.qml new file mode 100644 index 00000000..75e2c791 --- /dev/null +++ b/qml/models/tst_MyAppLanguageModel.qml @@ -0,0 +1,65 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick +import QtTest + + +TestCase { + id: testCase + + name: "MyAppLanguageModelTest" + + Component { + id: objectUnderTest + + MyAppLanguageModel {} + } + + function extractLanguagesFrom(model: MyAppLanguageModel): Array { + const languages = [] + for (let i = 0; i < model.count; i++) { + languages.push(model.get(i).abbrev) + } + return languages + } + + function test_languageExists_data() { + return [ + {tag: 'de_DE', abbrev: 'de_DE'}, + {tag: 'en_US', abbrev: 'en_US'}, + {tag: 'he_IL', abbrev: 'he_IL'}, + ] + } + + function test_languageExists(data) { + const control = createTemporaryObject(objectUnderTest, testCase) + verify(control) + + const languages = extractLanguagesFrom(control) + verify(languages.includes(data.abbrev)) + } + + function test_languageDoesNotExist() { + const control = createTemporaryObject(objectUnderTest, testCase) + verify(control) + + const languages = extractLanguagesFrom(control) + verify(!languages.includes('something-else')) + } + +} diff --git a/qml/shared/MyAppAutoWidthMenu.qml b/qml/shared/MyAppAutoWidthMenu.qml new file mode 100644 index 00000000..bb227319 --- /dev/null +++ b/qml/shared/MyAppAutoWidthMenu.qml @@ -0,0 +1,52 @@ +/* +Copyright + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +import QtQuick +import QtQuick.Controls + + +Menu { + id: root + + /* + Taken and adapted from: + https://martin.rpdev.net/2018/03/13/qt-quick-controls-2-automatically-set-the-width-of-menus.html + */ + + readonly property bool mMirrored: count > 0 && itemAt(0).mirrored + + x: mMirrored ? -width + parent.width : 0 + + width: { + let result = 0 + let padding = 0 + for (let i = 0; i < root.count; ++i) { + let item = root.itemAt(i) + + if (!isMenuSeparator(item)) { + result = Math.max(item.contentItem.implicitWidth, result) + padding = Math.max(item.padding, padding) + } + } + return result + padding * 2 + } + + function isMenuSeparator(item) { + return item instanceof MenuSeparator + } + +} diff --git a/qml/shared/qmldir b/qml/shared/qmldir new file mode 100644 index 00000000..35b5150f --- /dev/null +++ b/qml/shared/qmldir @@ -0,0 +1,2 @@ +module components.shared +MyAppAutoWidthMenu MyAppAutoWidthMenu.qml diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..ffb7031f --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +PySide6-Essentials==6.8.0 +pytest>=8.3.3 +pywin32>=307; sys_platform == 'win32' diff --git a/test/__init__.py b/test/__init__.py new file mode 100644 index 00000000..f8c365e8 --- /dev/null +++ b/test/__init__.py @@ -0,0 +1,23 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 3. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +try: + import test.generated_resources +except ImportError: + import sys + + print('Can not find resource module \'test.generated_resources\'', file=sys.stderr) + print('To execute individual tests, please run \'just test\' once before', file=sys.stderr) + sys.exit(1) diff --git a/test/services/__init__.py b/test/services/__init__.py new file mode 100644 index 00000000..b88e35f5 --- /dev/null +++ b/test/services/__init__.py @@ -0,0 +1,13 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 3. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . diff --git a/test/services/test_resource_availability.py b/test/services/test_resource_availability.py new file mode 100644 index 00000000..ae44f418 --- /dev/null +++ b/test/services/test_resource_availability.py @@ -0,0 +1,33 @@ +# Copyright +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import pytest +from PySide6.QtCore import QFile + + +@pytest.mark.parametrize('file_path', [ + ':/data/app-icon.svg', + ':/i18n/de_DE.qm', + ':/i18n/he_IL.qm', +]) +def test_resource_exist(file_path): + file = QFile(file_path) + assert file.exists() + + +def test_resource_does_not_exist(): + file = QFile(':/random/file/which/not.exists') + assert not file.exists()