pax_global_header00006660000000000000000000000064143755251250014523gustar00rootroot0000000000000052 comment=d27e42dec6b6255246bd488e12ea2662018f12ab nheko-0.11.3/000077500000000000000000000000001437552512500127115ustar00rootroot00000000000000nheko-0.11.3/.ci/000077500000000000000000000000001437552512500133625ustar00rootroot00000000000000nheko-0.11.3/.ci/bintray-release.json000066400000000000000000000017461437552512500173530ustar00rootroot00000000000000{ "files": [ { "includePattern": "nheko-VERSION_NAME_VALUE.dmg", "matrixParams": { "override": 1 }, "uploadPattern": "nheko/VERSION_NAME_VALUE/nheko-VERSION_NAME_VALUE.dmg" }, { "includePattern": "nheko-VERSION_NAME_VALUE-x86_64.AppImage", "matrixParams": { "override": 1 }, "uploadPattern": "nheko/VERSION_NAME_VALUE/nheko-VERSION_NAME_VALUE-x86_64.AppImage" } ], "package": { "desc": "Desktop client for the Matrix protocol", "issue_tracker_url": "https://github.com/Nheko-Reborn/nheko/issues", "licenses": [ "GPL-3.0" ], "name": "nheko", "public_download_numbers": true, "public_stats": true, "repo": "nheko", "subject": "nheko-reborn", "vcs_url": "https://github.com/Nheko-Reborn/nheko", "website_url": "https://github.com/Nheko-Reborn/nheko" }, "publish": true, "version": { "name": "VERSION_NAME_VALUE", "vcs_tag": "VERSION_NAME_VALUE" } } nheko-0.11.3/.ci/format.sh000077500000000000000000000004241437552512500152110ustar00rootroot00000000000000#!/usr/bin/env sh # Runs the Clang Formatter # Return codes: # - 1 there are files to be formatted # - 0 everything looks fine set -eu FILES=$(find src -type f \( -iname "*.cpp" -o -iname "*.h" \)) for f in $FILES do clang-format -i "$f" done; git diff --exit-code nheko-0.11.3/.ci/install.sh000077500000000000000000000020421437552512500153650ustar00rootroot00000000000000#!/usr/bin/env sh set -ex if [ "$FLATPAK" ]; then sudo apt-get -y install flatpak flatpak-builder elfutils flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo flatpak --noninteractive install --user flathub org.kde.Platform//5.15 flatpak --noninteractive install --user flathub org.kde.Sdk//5.15 exit fi if [ "$TRAVIS_OS_NAME" = "osx" ]; then curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py sudo python get-pip.py sudo pip install --upgrade pip sudo pip install dmgbuild export CMAKE_PREFIX_PATH=/usr/local/opt/qt5 fi if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo update-alternatives --install /usr/bin/gcc gcc "/usr/bin/${CC}" 10 sudo update-alternatives --install /usr/bin/g++ g++ "/usr/bin/${CXX}" 10 sudo update-alternatives --set gcc "/usr/bin/${CC}" sudo update-alternatives --set g++ "/usr/bin/${CXX}" wget https://cmake.org/files/v3.15/cmake-3.15.5-Linux-x86_64.sh sudo sh cmake-3.15.5-Linux-x86_64.sh --skip-license --prefix=/usr/local fi nheko-0.11.3/.ci/licenses.sh000077500000000000000000000005261437552512500155310ustar00rootroot00000000000000#!/usr/bin/env sh # Runs the license update # Return codes: # - 1 there are files to be formatted # - 0 everything looks fine set -eu FILES=$(find src resources/qml -type f \( -iname "*.cpp" -o -iname "*.h" -o -iname "*.qml" \)) reuse addheader --copyright="Nheko Contributors" --license="GPL-3.0-or-later" $FILES git diff --exit-code nheko-0.11.3/.ci/linux/000077500000000000000000000000001437552512500145215ustar00rootroot00000000000000nheko-0.11.3/.ci/linux/deploy.sh000077500000000000000000000030421437552512500163530ustar00rootroot00000000000000#!/usr/bin/env sh set -ex APP=nheko DIR=${APP}.AppDir # unused but may be useful... #TAG=$(git tag -l --points-at HEAD) # Set up AppImage structure. for d in bin lib share/pixmaps share/applications do mkdir -p ${DIR}/usr/$d done # Copy resources. cp build/nheko ${DIR}/usr/bin cp resources/nheko.desktop ${DIR}/usr/share/applications/nheko.desktop cp resources/nheko.png ${DIR}/usr/share/pixmaps/nheko.png for iconSize in 16 32 48 64 128 256 512; do IconDir=${DIR}/usr/share/icons/hicolor/${iconSize}x${iconSize}/apps mkdir -p ${IconDir} cp resources/nheko-${iconSize}.png ${IconDir}/nheko.png done # Only download the file when not already present if ! [ -f linuxdeployqt-6-x86_64.AppImage ] ; then wget -c "https://github.com/probonopd/linuxdeployqt/releases/download/6/linuxdeployqt-6-x86_64.AppImage" fi chmod a+x linuxdeployqt*.AppImage unset QTDIR unset QT_PLUGIN_PATH unset LD_LIBRARY_PATH ARCH=$(uname -m) export ARCH LD_LIBRARY_PATH=$(pwd)/.deps/usr/lib/:/usr/local/lib/:$LD_LIBRARY_PATH export LD_LIBRARY_PATH for res in ./linuxdeployqt*.AppImage do linuxdeployqt=$res done ./"$linuxdeployqt" ${DIR}/usr/share/applications/*.desktop -unsupported-allow-new-glibc -bundle-non-qt-libs -qmldir=./resources/qml -appimage chmod +x nheko-*x86_64.AppImage mkdir artifacts cp nheko-*x86_64.AppImage artifacts/ if [ -n "$VERSION" ]; then # commented out for now, as AppImage file appears to already contain the version. #mv nheko-*x86_64.AppImage nheko-${VERSION}-x86_64.AppImage echo "nheko-${VERSION}-x86_64.AppImage" fi nheko-0.11.3/.ci/macos/000077500000000000000000000000001437552512500144645ustar00rootroot00000000000000nheko-0.11.3/.ci/macos/Brewfile000066400000000000000000000003751437552512500161530ustar00rootroot00000000000000tap "nlohmann/json" brew "python3" brew "pkg-config" brew "clang-format" brew "cmake" brew "ninja" brew "openssl" brew "qt5" brew "nlohmann_json" brew "gstreamer" brew "gst-plugins-base" brew "gst-plugins-good" brew "gst-plugins-bad" brew "qtkeychain" nheko-0.11.3/.ci/macos/build.sh000077500000000000000000000015371437552512500161300ustar00rootroot00000000000000#!/usr/bin/env sh set -u # unused #TAG=$(git tag -l --points-at HEAD) # Add Qt binaries to path PATH="$(brew --prefix qt5):${PATH}" export PATH CMAKE_PREFIX_PATH="$(brew --prefix qt5)" export CMAKE_PREFIX_PATH cmake -GNinja -S. -Bbuild \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ -DCMAKE_INSTALL_PREFIX=.deps/usr \ -DHUNTER_ROOT="../.hunter" \ -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF \ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DHUNTER_CONFIGURATION_TYPES=RelWithDebInfo \ -DUSE_BUNDLED_OPENSSL=ON \ -DCI_BUILD=ON cmake --build build ( cd build || exit git clone https://github.com/Nheko-Reborn/qt-jdenticon.git ( cd qt-jdenticon || exit qmake make -j 4 cp libqtjdenticon.dylib ../nheko.app/Contents/MacOS ) "$(brew --prefix qt5)/bin/macdeployqt" nheko.app -always-overwrite -qmldir=../resources/qml/ ) nheko-0.11.3/.ci/macos/notarize.sh000077500000000000000000000074041437552512500166630ustar00rootroot00000000000000#!/bin/sh set -u # Modified version of script found at: # https://forum.qt.io/topic/96652/how-to-notarize-qt-application-on-macos/18 # Add Qt binaries to path PATH="/usr/local/opt/qt@5/bin/:${PATH}" export PATH security unlock-keychain -p "${RUNNER_USER_PW}" login.keychain if [ -n "${CI_PIPELINE_TRIGGERED:-}" ] && [ "${TRIGGERED_BY:-}" = "cirrus" ]; then echo "cirrus build id: ${TRIGGER_BUILD_ID}" cat "${TRIGGER_PAYLOAD}" # download the build artifacts from cirrus api curl "https://api.cirrus-ci.com/v1/artifact/build/${TRIGGER_BUILD_ID}/binaries.zip" -o binaries.zip # cirrus ci artifacts task name is 'binaries' so that's the zip name. unzip binaries.zip # we zip 'build/nheko.app' in cirrus ci, cirrus itself puts it in a 'build' directory # so move it to the right place for the rest of the process. ( cd build || exit unzip nheko.zip ) fi if [ ! -d "build/nheko.app" ]; then echo "nheko.app is missing, you did something wrong!" exit 1 fi echo "[INFO] Signing app contents" find "build/nheko.app/Contents"|while read -r fname; do if [ -f "$fname" ]; then echo "[INFO] Signing $fname" codesign --force --timestamp --options=runtime --sign "${APPLE_DEV_IDENTITY}" "$fname" fi done codesign --force --timestamp --options=runtime --sign "${APPLE_DEV_IDENTITY}" "build/nheko.app" NOTARIZE_SUBMIT_LOG=$(mktemp /tmp/notarize-submit.XXXXXX) NOTARIZE_STATUS_LOG=$(mktemp /tmp/notarize-status.XXXXXX) finish() { rm "$NOTARIZE_SUBMIT_LOG" "$NOTARIZE_STATUS_LOG" } trap finish EXIT dmgbuild -s .ci/macos/settings.json "Nheko" nheko.dmg codesign -s "${APPLE_DEV_IDENTITY}" nheko.dmg user=$(id -nu) chown "${user}" nheko.dmg echo "--> Start Notarization process" # OLD altool usage: xcrun altool -t osx -f nheko.dmg --primary-bundle-id "io.github.nheko-reborn.nheko" --notarize-app -u "${APPLE_DEV_USER}" -p "${APPLE_DEV_PASS}" > "$NOTARIZE_SUBMIT_LOG" 2>&1 xcrun notarytool submit nheko.dmg --apple-id "${APPLE_DEV_USER}" --password "${APPLE_DEV_PASS}" --team-id "${APPLE_TEAM_ID}" > "$NOTARIZE_SUBMIT_LOG" 2>&1 # OLD altool usage: requestUUID="$(awk -F ' = ' '/RequestUUID/ {print $2}' "$NOTARIZE_SUBMIT_LOG")" requestUUID="$(awk -F ': ' '/id/ {print $2}' "$NOTARIZE_SUBMIT_LOG" | head -1)" if [ -z "${requestUUID}" ]; then echo "Something went wrong when submitting the request... we don't have a UUID" exit 1 else echo "Received requestUUID: \"${requestUUID}\"" fi while sleep 60 && date; do echo "--> Checking notarization status for \"${requestUUID}\"" # OLD altool usage: xcrun altool --notarization-info "${requestUUID}" -u "${APPLE_DEV_USER}" -p "${APPLE_DEV_PASS}" > "$NOTARIZE_STATUS_LOG" 2>&1 xcrun notarytool info "${requestUUID}" --apple-id "${APPLE_DEV_USER}" --password "${APPLE_DEV_PASS}" --team-id "${APPLE_TEAM_ID}" > "$NOTARIZE_STATUS_LOG" 2>&1 sub_status="$(awk -F ': ' '/status/ {print $2}' "$NOTARIZE_STATUS_LOG")" #isSuccess=$(grep "success" "$NOTARIZE_STATUS_LOG") #isFailure=$(grep "invalid" "$NOTARIZE_STATUS_LOG") echo "Status for submission \"${requestUUID}\": \"${sub_status}\"" if [ "${sub_status}" = "Accepted" ]; then echo "Notarization done!" xcrun stapler staple -v nheko.dmg echo "Stapler done!" break fi if [ "${sub_status}" = "Invalid" ] || [ "${sub_status}" = "Rejected" ]; then echo "Notarization failed" xcrun notarytool log "${requestUUID}" --apple-id "${APPLE_DEV_USER}" --password "${APPLE_DEV_PASS}" --team-id "${APPLE_TEAM_ID}" > "$NOTARIZE_STATUS_LOG" 2>&1 cat "$NOTARIZE_STATUS_LOG" 1>&2 exit 1 fi echo "Notarization not finished yet, sleep 1m then check again..." done VERSION=${CI_COMMIT_SHORT_SHA} if [ -n "$VERSION" ]; then mv nheko.dmg "nheko-${VERSION}_${PLAT}.dmg" mkdir artifacts cp "nheko-${VERSION}_${PLAT}.dmg" artifacts/ finheko-0.11.3/.ci/macos/settings.json000066400000000000000000000007071437552512500172230ustar00rootroot00000000000000{ "background": "builtin-arrow", "compression-level": 9, "contents": [ { "path": "./build/Nheko.app", "type": "file", "x": 140, "y": 120 }, { "path": "/Applications", "type": "link", "x": 500, "y": 120 } ], "format": "UDZO", "title": "Nheko", "window": { "position": { "x": 100, "y": 100 }, "size": { "height": 280, "width": 640 } } } nheko-0.11.3/.ci/script.sh000077500000000000000000000043121437552512500152250ustar00rootroot00000000000000#!/usr/bin/env bash set -ex if [ "$FLATPAK" ]; then mkdir -p build-flatpak cd build-flatpak jobsarg="" if [ "$ARCH" = "arm64" ]; then jobsarg="--jobs=2" fi flatpak-builder --ccache --repo=repo --subject="Build of Nheko ${VERSION} $jobsarg `date`" app ../io.github.NhekoReborn.Nheko.json & # to prevent flatpak builder from timing out on arm, run it in the background and print something every minute for up to 30 minutes. minutes=0 limit=40 while kill -0 $! >/dev/null 2>&1; do if [ $minutes == $limit ]; then break; fi minutes=$((minutes+1)) sleep 60 done flatpak build-bundle repo nheko-${VERSION}-${ARCH}.flatpak io.github.NhekoReborn.Nheko master mkdir ../artifacts mv nheko-*.flatpak ../artifacts exit fi if [ "$TRAVIS_OS_NAME" = "linux" ]; then # make build use all available cores export CMAKE_BUILD_PARALLEL_LEVEL=$(cat /proc/cpuinfo | awk '/^processor/{print $3}' | wc -l) export PATH="/usr/local/bin/:${PATH}" cmake --version fi if [ "$TRAVIS_OS_NAME" = "linux" ]; then # shellcheck disable=SC1090 . "/opt/qt${QT_PKG}/bin/qt${QT_PKG}-env.sh" || true; fi if [ "$TRAVIS_OS_NAME" = "osx" ]; then export CMAKE_PREFIX_PATH=/usr/local/opt/qt5 fi mkdir -p .deps/usr .hunter # Build nheko if [ "$TRAVIS_OS_NAME" = "osx" ]; then cmake -GNinja -H. -Bbuild \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ -DCMAKE_INSTALL_PREFIX=.deps/usr \ -DHUNTER_ROOT=".hunter" \ -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF \ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DHUNTER_CONFIGURATION_TYPES=RelWithDebInfo \ -DCMAKE_PREFIX_PATH=/usr/local/opt/qt5 \ -DCI_BUILD=ON else cmake -GNinja -H. -Bbuild \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ -DCMAKE_INSTALL_PREFIX=.deps/usr \ -DHUNTER_ROOT=".hunter" \ -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF \ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DHUNTER_CONFIGURATION_TYPES=RelWithDebInfo \ -DUSE_BUNDLED_OPENSSL=OFF \ -DCI_BUILD=ON fi cmake --build build if [ "$TRAVIS_OS_NAME" = "osx" ]; then make lint; if [ "$DEPLOYMENT" = 1 ] && [ -n "$VERSION" ] ; then make macos-deploy; fi fi if [ "$TRAVIS_OS_NAME" = "linux" ] && [ "$DEPLOYMENT" = 1 ] && [ -n "$VERSION" ]; then make linux-deploy; fi nheko-0.11.3/.ci/upload-nightly-gitlab.sh000077500000000000000000000014501437552512500201210ustar00rootroot00000000000000#!/bin/sh file="$1" fileName="nheko-${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}-${file##*-}" uri=$(curl -H "Authorization: Bearer ${MATRIX_ACCESS_TOKEN}" -H "Content-Type: application/x-compressed" -X POST --data-binary "@${file}" "https://matrix.neko.dev/_matrix/media/r0/upload?filename=${fileName}" --http1.1 | python3 -c "import sys, json; print(json.load(sys.stdin)['content_uri'])") echo "Uploaded to ${uri}" curl -H "Authorization: Bearer ${MATRIX_ACCESS_TOKEN}" -H "Content-Type: application/json" -X PUT -d "{ \"body\": \"${fileName}\", \"filename\": \"${fileName}\", \"info\": { \"mimetype\": \"application/x-compressed\", \"size\": $(wc -c < ${file}) }, \"msgtype\": \"m.file\", \"url\": \"${uri}\" }" "https://matrix.neko.dev/_matrix/client/r0/rooms/${ROOM}/send/m.room.message/$(date +%s)" nheko-0.11.3/.ci/upload-nightly.ps1000066400000000000000000000016761437552512500167610ustar00rootroot00000000000000$file = "nheko_win_64.zip" $fileName = "nheko-${env:APPVEYOR_REPO_BRANCH}-${env:APPVEYOR_REPO_COMMIT}-win64.zip" $response = Invoke-RestMethod -uri "https://matrix.neko.dev/_matrix/media/r0/upload?filename=$fileName" -Method Post -Infile "$file" -ContentType 'application/x-compressed' -Headers @{"Authorization"="Bearer ${env:MATRIX_ACCESS_TOKEN}"} $txId = [DateTimeOffset]::Now.ToUnixTimeSeconds() $fileSize = (Get-Item $file).Length $body = @{ "body" = "${fileName}" "filename"= "${fileName}" "info" = @{ "mimetype" = "application/x-compressed" "size" = ${fileSize} } "msgtype" = "m.file" "url" = ${response}.content_uri } | ConvertTo-Json $room = "!TshDrgpBNBDmfDeEGN:neko.dev" Invoke-RestMethod -uri "https://matrix.neko.dev/_matrix/client/r0/rooms/${room}/send/m.room.message/${txid}" -Method Put -Body "$body" -ContentType 'application/json' -Headers @{"Authorization"="Bearer ${env:MATRIX_ACCESS_TOKEN}"} nheko-0.11.3/.ci/upload-nightly.sh000077500000000000000000000015151437552512500166630ustar00rootroot00000000000000#!/bin/sh file=$(find artifacts/ -type f -exec basename {} \;) fileName="nheko-${TRAVIS_BRANCH}-${file#nheko-}" uri=$(curl -H "Authorization: Bearer ${MATRIX_ACCESS_TOKEN}" -H "Content-Type: application/x-compressed" -X POST --data-binary "@artifacts/${file}" "https://matrix.neko.dev/_matrix/media/r0/upload?filename=${fileName}" --http1.1 | python -c "import sys, json; print(json.load(sys.stdin)['content_uri'])") echo "Uploaded to ${uri}" curl -H "Authorization: Bearer ${MATRIX_ACCESS_TOKEN}" -H "Content-Type: application/json" -X PUT -d "{ \"body\": \"${fileName}\", \"filename\": \"${fileName}\", \"info\": { \"mimetype\": \"application/x-compressed\", \"size\": $(wc -c < artifacts/${file}) }, \"msgtype\": \"m.file\", \"url\": \"${uri}\" }" "https://matrix.neko.dev/_matrix/client/r0/rooms/${ROOM}/send/m.room.message/$(date +%s)" nheko-0.11.3/.cirrus.yml000066400000000000000000000016131437552512500150220ustar00rootroot00000000000000task: macos_instance: image: ghcr.io/cirruslabs/macos-monterey-xcode:13 name: Build - macOS Apple Silicon only_if: $CIRRUS_REPO_OWNER == 'Nheko-Reborn' environment: GITLAB_TRIGGER_TOKEN: ENCRYPTED[!5fb4bbdecbde3b2c766ac7383dca573cd5ec8b815c5ac9bede0cadfe9ad70ecd3e64b1728f7840da087099f3fc1fd4f7!] homebrew_script: - brew bundle --file .ci/macos/Brewfile build_script: - export PATH="$(brew --prefix qt5)/bin/:${PATH}" - ./.ci/macos/build.sh zip_script: - ditto -c -k --sequesterRsrc --keepParent build/nheko.app build/nheko.zip gitlab_script: - curl -X POST --fail -F token="${GITLAB_TRIGGER_TOKEN}" -F ref="${CIRRUS_BRANCH}" -F "variables[TRIGGER_BUILD_ID]=${CIRRUS_BUILD_ID}" -F "variables[TRIGGERED_BY]=cirrus" "https://nheko.im/api/v4/projects/2/trigger/pipeline" binaries_artifacts: path: build/nheko.zipnheko-0.11.3/.clang-format000066400000000000000000000006301437552512500152630ustar00rootroot00000000000000--- Language: Cpp Standard: c++17 AccessModifierOffset: -4 AlignAfterOpenBracket: Align AlignConsecutiveAssignments: true AllowShortFunctionsOnASingleLine: InlineOnly BasedOnStyle: Mozilla ColumnLimit: 100 IndentCaseLabels: false IndentWidth: 4 KeepEmptyLinesAtTheStartOfBlocks: false PointerAlignment: Right Cpp11BracedListStyle: true PenaltyReturnTypeOnItsOwnLine: 0 --- BasedOnStyle: WebKit Language: ObjCnheko-0.11.3/.github/000077500000000000000000000000001437552512500142515ustar00rootroot00000000000000nheko-0.11.3/.github/CONTRIBUTING.md000066400000000000000000000026141437552512500165050ustar00rootroot00000000000000## Contributing to nheko Any kind of contribution to the project is greatly appreciated. - Bug fixes - Implementing new features - UI/UX improvements/suggestions - Code refactoring - Translations ### Working on new features Everything on the issue tracker is up for grabs unless someone else is currently working on it. If you're planning to work on a new feature leave a message on the Matrix room (or in the corresponding issue), so we won't end up having duplicate work. ### Submitting a translation Example for a Japanese translation. - Create a new translation file using the prototype in English - e.g `cp resources/langs/nheko_en.ts resources/langs/nheko_ja.ts` - Open the new translation file and change the line regarding the locale to reflect the current language. - e.g `` => `` - Run `make update-translations` to update the translation files with any missing text. - Fill out the translation file (Qt Linguist can make things easier). - Submit a PR! ### Code style We use clang-format to enforce a certain style as defined by the `.clang-format` file in the root of the repo. Travis-CI will run the linter (macOS job) on each commit and the build will fail if the style guide isn't followed. You can run the linter locally with `make lint`. If you have any questions don't hesitate to reach out to us on #nheko:matrix.org. nheko-0.11.3/.github/ISSUE_TEMPLATE/000077500000000000000000000000001437552512500164345ustar00rootroot00000000000000nheko-0.11.3/.github/ISSUE_TEMPLATE/bug_report.yaml000066400000000000000000000102671437552512500214760ustar00rootroot00000000000000name: Bug Report description: Create a report to help us improve #title: "[Bug]: " labels: [bug] body: - type: markdown attributes: value: | Thanks for taking the time to fill out this bug report! Please try to fill out all fields to the best of your ability. - type: textarea id: description attributes: label: Describe the bug description: A clear and concise description of what the bug is. placeholder: Enter your description here. validations: required: true - type: textarea id: reproduction-steps attributes: label: To Reproduce description: Steps to reproduce the behavior. placeholder: | 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error value: | 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error validations: required: true - type: textarea id: behaviour attributes: label: What happened? description: A clear and concise description of what actually happened. validations: required: false - type: textarea id: expected-behaviour attributes: label: Expected behavior description: A clear and concise description of what you expected to happen. validations: required: false - type: textarea id: screenshots attributes: label: Screenshots description: If applicable, add screenshots to help explain your problem. placeholder: Upload your screenshots here. You can paste them or click on "Attach files". validations: required: false - type: input id: version attributes: label: Version description: Get the version from the settings menu (bottom right corner) placeholder: 0.0.1-deafbeef validations: required: true - type: dropdown id: os attributes: label: Operating system multiple: true options: - Linux - macOS - Windows - BSD - Haiku - Other - type: dropdown id: install-method attributes: label: Installation method multiple: true options: - Flathub - Flatpak nightly repo or download - AppImage - Windows download - macOS DMG file - Some repository (AUR, homebrew, distribution repository, PPA, etc) - Local build - type: input id: qt-version attributes: label: Qt version description: What version of Qt does your system use? (If you compiled Nheko yourself.) placeholder: 5.15.2. validations: required: false - type: input id: compiler attributes: label: C++ compiler description: What compiler (and version) did you use (if you compiled Nheko yourself)? placeholder: gcc-9000 validations: required: false - type: input id: de attributes: label: Desktop Environment description: If you are on Linux, describe your desktop environment. placeholder: KDE with i3 as the window manager validations: required: false - type: checkboxes id: profiles attributes: label: Did you use profiles? description: Usually by passing the --profile command line parameter. If you don't know, answer 'no'. options: - label: Profiles used? required: false - type: textarea id: logs attributes: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. placeholder: | The log file is located in Linux: ~/.cache/nheko/ macOS: ~/Library/Caches/nheko or /Library/Caches/nheko Windows: C:/Users//AppData/Local/nheko/cache render: shell - type: textarea id: backtrace attributes: label: Backtrace description: If the program crashed send a backtrace. placeholder: | You can retrieve a backtrace by building nheko with -DCMAKE_BUILD_TYPE=Debug and running it through gdb or lldb. gdb ./build/nheko >> run ... Make the program crash >> bt render: shell nheko-0.11.3/.github/ISSUE_TEMPLATE/feature_request.yaml000066400000000000000000000031211437552512500225200ustar00rootroot00000000000000name: Feature request description: Suggest an idea for this project labels: [enhancement] body: - type: markdown attributes: value: | Please verify that there is no feature request for this already! - type: textarea id: problem attributes: label: The Problem description: Is your feature request related to a problem? Please describe. placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" validations: required: true - type: textarea id: solution attributes: label: The Solution description: Describe the solution you'd like placeholder: A clear and concise description of what you want to happen. validations: required: true - type: textarea id: alternatives attributes: label: Alternatives description: Describe alternatives you've considered. placeholder: A clear and concise description of any alternative solutions or features you've considered. validations: required: false - type: textarea id: context attributes: label: Additional context description: Describe alternatives you've considered. placeholder: Add any other context or screenshots about the feature request here. validations: required: false - type: checkboxes id: version-check attributes: label: Happens in the latest version description: Please verify that this is still missing in the latest version. options: - label: Yes, this feature is still missing. required: true nheko-0.11.3/.gitignore000066400000000000000000000024041437552512500147010ustar00rootroot00000000000000/build* tags cscope* .clang_complete *wintoastlib* /.ccls-cache /.cache /.exrc .gdb_history .hunter resources/complete-emoji.txt # GTAGS GTAGS GRTAGS GPATH # C++ objects and libs *.slo *.lo *.o *.a *.la *.lai *.so *.dll *.dylib vgcore.* heaptrack.* massif.* # Qt-es /.qmake.cache /.qmake.stash *.pro.user *.pro.user.* *.qbs.user *.qbs.user.* *.moc CMakeLists.txt.user moc_*.cpp qrc_*.cpp ui_*.h *-build-* /.clangd/ # QtCreator *.autosave # VSCode .vscode/* #QtCtreator Qml *.qmlproject.user *.qmlproject.user.* # Vim *.swp *.swo *.swn # CLion /.idea #####=== CMake ===##### CMakeCache.txt CMakeFiles cmake_install.cmake install_manifest.txt #####=== OSX ===##### .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 # Visual Studio .vs build-vc vcpkg # Directories potentially created on remote AFP share .AppleDB .AppleDesktop Network Trash Folder Temporary Items .apdisk # Nix result *.dmg dist/MacOS/nheko.app/Contents/MacOS/nheko .clang compile_commands.json # AppImage *.AppImage *.AppDir # Artifacts *.rpm *.deb package.dir # Dependencies .third-party .deps # Archives *.bz2 nheko-0.11.3/.gitlab-ci.yml000066400000000000000000000306051437552512500153510ustar00rootroot00000000000000variables: CCACHE_COMPILERCHECK: content CCACHE_DIR: "${CI_PROJECT_DIR}/.ccache" # prevent configure tzdata hanging apt install commands DEBIAN_FRONTEND: noninteractive build-clazy: stage: build image: ubuntu:22.04 tags: [docker] variables: CLAZY_CHECKS: level0,level1,no-non-pod-global-static TRAVIS_OS_NAME: linux before_script: - apt-get update - apt-get -y install --no-install-suggests --no-install-recommends ca-certificates build-essential ninja-build cmake gcc make automake liblmdb-dev libre2-dev libssl-dev libqt5multimedia5-plugins libqt5multimediagsttools5 libqt5multimediaquick5 libqt5svg5-dev qtmultimedia5-dev qtquickcontrols2-5-dev qttools5-dev qttools5-dev-tools qtdeclarative5-dev qml-module-qtmultimedia qml-module-qtquick-controls2 qml-module-qtquick-layouts qml-module-qt-labs-platform qt5keychain-dev ccache clazy libcurl4-openssl-dev libevent-dev libspdlog-dev git nlohmann-json3-dev libcmark-dev asciidoc # libolm-dev script: - export PATH="/usr/local/bin/:/usr/lib/ccache:${PATH}" - export CMAKE_BUILD_PARALLEL_LEVEL=$(cat /proc/cpuinfo | awk '/^processor/{print $3}' | wc -l) - cmake -GNinja -H. -Bbuild -DCMAKE_INSTALL_PREFIX=.deps/usr -DHUNTER_ENABLED=OFF -DBUILD_SHARED_LIBS=OFF -DUSE_BUNDLED_OPENSSL=ON -DUSE_BUNDLED_MTXCLIENT=ON -DUSE_BUNDLED_COEURL=ON -DUSE_BUNDLED_LMDBXX=ON -DUSE_BUNDLED_OLM=ON -DVOIP=OFF -DCMAKE_BUILD_TYPE=Release -DCI_BUILD=ON -DFETCHCONTENT_QUIET=OFF -DCMAKE_CXX_COMPILER=clazy - cmake --build build rules: - if : '$CI_PIPELINE_TRIGGERED == null' cache: key: "$CI_JOB_NAME" paths: - .ccache build-gcc11: stage: build image: ubuntu:22.04 tags: [docker] variables: TRAVIS_OS_NAME: linux before_script: - apt-get update - apt-get -y install --no-install-suggests --no-install-recommends ca-certificates build-essential ninja-build cmake gcc make automake ccache liblmdb-dev libssl-dev libqt5multimedia5-plugins libqt5multimediagsttools5 libqt5multimediaquick5 libqt5svg5-dev qtmultimedia5-dev qtquickcontrols2-5-dev qttools5-dev qttools5-dev-tools qtdeclarative5-dev qml-module-qtmultimedia qml-module-qtquick-controls2 qml-module-qtquick-layouts qml-module-qt-labs-platform qt5keychain-dev ccache clazy libcurl4-openssl-dev libevent-dev libspdlog-dev git nlohmann-json3-dev libcmark-dev asciidoc # libolm-dev # need recommended deps for wget - apt-get -y install wget - /usr/sbin/update-ccache-symlinks - rm -rf ../.hunter && mv .hunter ../.hunter || true script: - export PATH="/usr/lib/ccache:${PATH}" - cmake -GNinja -H. -Bbuild -DCMAKE_INSTALL_PREFIX=.deps/usr -DHUNTER_ROOT="../.hunter" -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF -DUSE_BUNDLED_OPENSSL=ON -DUSE_BUNDLED_LMDB=OFF -DUSE_BUNDLED_QTKEYCHAIN=OFF -DVOIP=OFF -DCMAKE_BUILD_TYPE=Release -DHUNTER_CONFIGURATION_TYPES=Release -DCI_BUILD=ON -DFETCHCONTENT_QUIET=OFF -DJSON_ImplicitConversions=OFF - cmake --build build after_script: - mv ../.hunter .hunter rules: - if : '$CI_PIPELINE_TRIGGERED == null' cache: key: "$CI_JOB_NAME" paths: - .hunter/ - .ccache build-gcc10: stage: build image: debian:bullseye tags: [docker] variables: TRAVIS_OS_NAME: linux before_script: - apt-get update - apt-get -y install --no-install-suggests --no-install-recommends ca-certificates build-essential ninja-build cmake gcc make automake ccache liblmdb-dev libssl-dev libqt5multimedia5-plugins libqt5multimediagsttools5 libqt5multimediaquick5 libqt5svg5-dev qtmultimedia5-dev qtquickcontrols2-5-dev qttools5-dev qttools5-dev-tools qtdeclarative5-dev qml-module-qtmultimedia qml-module-qtquick-controls2 qml-module-qtquick-layouts qml-module-qt-labs-platform qt5keychain-dev ccache clazy libcurl4-openssl-dev libevent-dev libspdlog-dev git nlohmann-json3-dev libcmark-dev asciidoc # libolm-dev # need recommended deps for wget - apt-get -y install wget - /usr/sbin/update-ccache-symlinks - rm -rf ../.hunter && mv .hunter ../.hunter || true script: - export PATH="/usr/lib/ccache:${PATH}" - cmake -GNinja -H. -Bbuild -DCMAKE_INSTALL_PREFIX=.deps/usr -DHUNTER_ROOT="../.hunter" -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF -DUSE_BUNDLED_OPENSSL=ON -DUSE_BUNDLED_LMDB=OFF -DUSE_BUNDLED_QTKEYCHAIN=OFF -DVOIP=OFF -DCMAKE_BUILD_TYPE=Release -DHUNTER_CONFIGURATION_TYPES=Release -DCI_BUILD=ON -DFETCHCONTENT_QUIET=OFF -DJSON_ImplicitConversions=OFF -DMAN=OFF - cmake --build build after_script: - mv ../.hunter .hunter rules: - if : '$CI_PIPELINE_TRIGGERED == null' cache: key: "$CI_JOB_NAME" paths: - .hunter/ - .ccache build-macos: stage: build tags: [macos] before_script: - rm -rf ../.hunter && mv .hunter ../.hunter || true script: - ./.ci/macos/build.sh after_script: - mv ../.hunter .hunter rules: - if : '$CI_PIPELINE_TRIGGERED == null' artifacts: paths: - build/nheko.app name: nheko-${CI_COMMIT_SHORT_SHA}-macos-app expose_as: 'macos-app' public: false cache: key: "${CI_JOB_NAME}" paths: - .hunter/ - "${CCACHE_DIR}" codesign-macos: stage: deploy tags: [macos] variables: PLAT: "intel" before_script: - pip3 install dmgbuild script: - export PATH=/usr/local/opt/qt@5/bin/:${PATH} - ./.ci/macos/notarize.sh after_script: - ./.ci/upload-nightly-gitlab.sh artifacts/nheko-${CI_COMMIT_SHORT_SHA}_${PLAT}.dmg needs: - job: build-macos optional: true # optional since we want to be able to also trigger this job from cirrus ci for apple silicon builds. rules: - if : '$CI_PIPELINE_TRIGGERED && $CI_COMMIT_REF_PROTECTED == "true"' variables: PLAT: "m1" - if : '$CI_COMMIT_BRANCH == "master"' - if : $CI_COMMIT_TAG artifacts: paths: - artifacts/nheko-${CI_COMMIT_SHORT_SHA}_${PLAT}.dmg - /tmp/notarize* name: nheko-${CI_COMMIT_SHORT_SHA}-macos build-flatpak-amd64: stage: build image: ubuntu:latest #image: 'registry.gitlab.gnome.org/gnome/gnome-runtime-images/gnome:master' tags: [docker] before_script: - apt-get update && apt-get -y install flatpak-builder git python3 curl python3-aiohttp python3-tenacity gir1.2-ostree-1.0 - flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo # see https://github.com/flatpak/flatpak-builder/issues/495 - git config --global protocol.file.allow always script: - export VERSION=$(git describe) - mkdir -p build-flatpak - cd build-flatpak - flatpak-builder --install-deps-from=flathub --user --disable-rofiles-fuse --ccache --repo=repo --default-branch=${CI_COMMIT_REF_NAME//\//_} --subject="Build of Nheko ${VERSION} `date`" app ../io.github.NhekoReborn.Nheko.yaml - flatpak build-bundle repo nheko-amd64.flatpak io.github.NhekoReborn.Nheko ${CI_COMMIT_REF_NAME//\//_} after_script: - bash ./.ci/upload-nightly-gitlab.sh build-flatpak/nheko-amd64.flatpak - (cd ./scripts && ./upload-to-flatpak-repo.sh ../build-flatpak/repo) || true rules: - if : '$CI_PIPELINE_TRIGGERED == null' cache: key: "$CI_JOB_NAME" paths: - build-flatpak/.flatpak-builder/ artifacts: expose_as: 'flatpak-amd64' paths: ['build-flatpak/nheko-amd64.flatpak'] name: flatpak-${CI_COMMIT_REF_NAME}-${VERSION}-amd64 build-flatpak-arm64: stage: build image: ubuntu:latest #image: 'registry.gitlab.gnome.org/gnome/gnome-runtime-images/gnome:master' tags: [docker-arm64] before_script: - apt-get update && apt-get -y install flatpak-builder git python3 curl python3-aiohttp python3-tenacity gir1.2-ostree-1.0 - flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo # see https://github.com/flatpak/flatpak-builder/issues/495 - git config --global protocol.file.allow always script: - export VERSION=$(git describe) - if [ "$(grep MemTotal /proc/meminfo | tr -cd '[0-9]')" -lt "6000000" ]; then export EXTRA_FLAGS='--jobs=3'; fi - mkdir -p build-flatpak - cd build-flatpak - flatpak-builder --install-deps-from=flathub --user --disable-rofiles-fuse --ccache $EXTRA_FLAGS --repo=repo --default-branch=${CI_COMMIT_REF_NAME//\//_} --subject="Build of Nheko ${VERSION} `date` for arm64" app ../io.github.NhekoReborn.Nheko.yaml - flatpak build-bundle repo nheko-arm64.flatpak io.github.NhekoReborn.Nheko ${CI_COMMIT_REF_NAME//\//_} after_script: - bash ./.ci/upload-nightly-gitlab.sh build-flatpak/nheko-arm64.flatpak - (cd ./scripts && ./upload-to-flatpak-repo.sh ../build-flatpak/repo) || true rules: - if : '$CI_PIPELINE_TRIGGERED == null' cache: key: "$CI_JOB_NAME" paths: - build-flatpak/.flatpak-builder/ artifacts: expose_as: 'flatpak-arm64' paths: ['build-flatpak/nheko-arm64.flatpak'] name: flatpak-${CI_COMMIT_REF_NAME}-${VERSION}-arm64 appimage-amd64: stage: build image: ubuntu:22.04 tags: [docker] allow_failure: true before_script: # Installing the packages needed to download and install third-party tools - apt-get update && apt-get install -y software-properties-common git wget curl python3 python3-pip python3-setuptools # Installing the packages needed to compile nheko and third-party tools - apt-get -y install --no-install-suggests --no-install-recommends ca-certificates build-essential ninja-build cmake gcc make automake ccache liblmdb-dev libssl-dev libqt5multimedia5-plugins libqt5multimediagsttools5 libqt5multimediaquick5 libqt5svg5-dev qtmultimedia5-dev qtquickcontrols2-5-dev qttools5-dev qttools5-dev-tools qtdeclarative5-dev qml-module-qtmultimedia qml-module-qtquick-controls2 qml-module-qtquick-layouts qml-module-qt-labs-platform qt5keychain-dev ccache clazy libcurl4-openssl-dev libevent-dev libspdlog-dev nlohmann-json3-dev libcmark-dev asciidoc libre2-dev libgtest-dev libgl1-mesa-dev qml-module-qtquick-particles2 # Installing the packages needed to build AppImage - apt-get -yq install breeze-icon-theme desktop-file-utils elfutils fakeroot file gnupg2 gtk-update-icon-cache libgdk-pixbuf2.0-dev libgdk-pixbuf2.0-0 libglib2.0-bin librsvg2-dev libyaml-dev strace zsync squashfs-tools - wget https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage -O /usr/local/bin/appimagetool && \ - chmod +x /usr/local/bin/appimagetool - export HOME_DIR=$(pwd) # Workaround for https://github.com/AppImageCrafters/appimage-builder/issues/280 - cd /tmp - git clone https://github.com/AppImageCrafters/appimage-builder - cd appimage-builder - git checkout 9733877eed75aea0fa8e9a1cd26c22d77a10aa4a - pip3 install . - pip3 install cffi - cd $HOME_DIR - /usr/sbin/update-ccache-symlinks - rm -rf ../.hunter && mv .hunter ../.hunter || true script: - export PATH="/usr/local/bin/:/usr/lib/ccache:${PATH}" - cmake -GNinja -H. -Bbuild -DCMAKE_INSTALL_PREFIX=/usr -DHUNTER_ROOT=".hunter" -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF -DUSE_BUNDLED_OPENSSL=ON -DUSE_BUNDLED_LMDB=OFF -DUSE_BUNDLED_QTKEYCHAIN=OFF -DUSE_BUNDLED_LIBEVENT=OFF -DVOIP=OFF -DMAN=OFF -DCMAKE_BUILD_TYPE=Release -DHUNTER_CONFIGURATION_TYPES=Release -DCI_BUILD=ON -DFETCHCONTENT_QUIET=OFF -DJSON_ImplicitConversions=OFF - DESTDIR=`pwd`/AppDir ninja -C build install/local - DESTDIR=`pwd`/AppDir ninja -C build _deps/cmark-build/src/install - mkdir -p AppDir/usr/lib/x86_64-linux-gnu AppDir/lib/x86_64-linux-gnu - appimage-builder --skip-test after_script: - bash ./.ci/upload-nightly-gitlab.sh nheko-latest-x86_64.AppImage rules: - if : '$CI_PIPELINE_TRIGGERED == null' artifacts: paths: - 'nheko-latest-x86_64.AppImage' expire_in: 1 week expose_as: 'appimage-amd64' cache: key: "$CI_JOB_NAME" paths: - .hunter/ - .ccache linting: stage: build image: alpine:latest tags: [docker] before_script: - apk update && apk add make git python3 py3-pip - apk add clang-extra-tools --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main - export PATH="$PATH:/root/.local/bin" - pip3 install --user reuse script: - make lint - make license rules: - if : '$CI_PIPELINE_TRIGGERED == null' nheko-0.11.3/AppImageBuilder.yml000066400000000000000000000063611437552512500164340ustar00rootroot00000000000000# appimage-builder recipe see https://appimage-builder.readthedocs.io for details version: 1 AppDir: path: ./AppDir app_info: id: nheko name: nheko icon: nheko version: latest exec: usr/bin/nheko exec_args: $@ runtime: env: APPDIR_LIBRARY_PATH: $APPDIR/usr/lib/x86_64-linux-gnu:$APPDIR/usr/lib/x86_64-linux-gnu/gstreamer-1.0:$APPDIR/usr/lib/x86_64-linux-gnu/gconv:$APPDIR/lib/x86_64-linux-gnu:$APPDIR/usr/lib/x86_64-linux-gnu/pulseaudio apt: arch: amd64 allow_unauthenticated: true sources: - sourceline: deb http://archive.ubuntu.com/ubuntu/ jammy main restricted universe multiverse - sourceline: deb http://archive.ubuntu.com/ubuntu/ jammy-updates main restricted universe multiverse - sourceline: deb http://archive.ubuntu.com/ubuntu/ jammy-security main restricted universe multiverse - sourceline: deb http://archive.ubuntu.com/ubuntu/ jammy-backports main restricted universe multiverse - sourceline: deb http://archive.canonical.com/ubuntu jammy partner key_url: http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x871920d1991bc93c include: # idk, need there ca-certificates, but some systems may not have - ca-certificates - gstreamer1.0-plugins-good - libbs2b0 - libbz2-1.0 - libcurl4 - libelf1 - libexpat1 - libevent-core-2.1-7 - libevent-pthreads-2.1-7 - libjpeg-turbo8 - libkf5archive5 - liblmdb0 - liblz4-1 - libnorm1 - libnss-mdns - libpcre3 - qml-module-qt-labs-platform - qml-module-qt-labs-settings - qml-module-qtgraphicaleffects - qml-module-qtquick-particles2 - qml-module-qtmultimedia - qml-module-qtquick2 - qml-module-qtquick-controls2 - qml-module-qtquick-layouts - qml-module-qtquick-window2 - libcmark0.30.2 - libfmt8 - libolm3 - libqt5core5a - libqt5dbus5 - libqt5gui5 - libqt5keychain1 - libqt5multimedia5 - libqt5multimedia5-plugins - libqt5network5 - libqt5quickwidgets5 - libqt5svg5 - libqt5widgets5 - libspdlog1-fmt8 - libxcb-ewmh2 - libxcb1 - librubberband2 - libsm6 - libsnappy1v5 - libxau6 - libxcb-render-util0 - libxcb-sync1 - libxcb-xinerama0 - libxcb-xkb1 - libxcursor1 - libxdmcp6 - libxext6 - libxfixes3 - libxrender1 - libxshmfence1 - libxv1 - libxxf86vm1 - libzstd1 exclude: [] files: exclude: - usr/share/man - usr/share/doc - usr/bin/cmark - usr/bin/dbus* - usr/bin/openssl - usr/bin/c_rehash - usr/bin/session-migration - usr/include - usr/sbin - lib/systemd test: fedora: image: appimagecrafters/tests-env:fedora-30 command: ./AppRun use_host_x: true debian: image: appimagecrafters/tests-env:debian-stable command: ./AppRun use_host_x: true arch: image: appimagecrafters/tests-env:archlinux-latest command: ./AppRun use_host_x: true centos: image: appimagecrafters/tests-env:centos-7 command: ./AppRun use_host_x: true ubuntu: image: appimagecrafters/tests-env:ubuntu-xenial command: ./AppRun use_host_x: true AppImage: arch: x86_64 update-information: None sign-key: None nheko-0.11.3/CHANGELOG.md000066400000000000000000001640221437552512500145270ustar00rootroot00000000000000# Changelog ## [0.11.3] -- 2023-02-23 ### Bugfix - Fix redundant null byte inserted with the emoji completer ## [0.11.2] -- 2023-02-20 ### Highlights - Improved Markdown input πŸ—’οΈ - You can now enter strike-through and spoilers using `~~` and `||` respectively. - Single line-breaks now also create a line-break in the formatted message. - Code tags now preserve whitespace. - User search in the invite dialog πŸ§‘β€πŸ€β€πŸ§‘ (Malte E) - Can search either locally or consult the user directory on your server. ### Features - Allow disabling animations before login. - Set the window role to "imageoverlay" on X11. (Thulinma) ### Improvements - The Nheko binary should now be slightly smaller. - You can now build Nheko against a system install of the blurhash and cpp-httplib libraries. (vitaly) - You can now enable scrollbars for the room and community lists in the settings. (balsof) - Add a generic video icon when there is no thumbnail. (LorenDB) - Pause video when switching rooms. (LorenDB) - Add a fancy delegate when encryption is enabled. (LorenDB) - Standardise command format messages. (phyto) - Automatically fetch keys for undecrypted messages after verification. - Remove all notifications on exit on Linux. (ShootingStarDragons) - Document markdown features and /cmark command in the man page. (tastytea) - Speedup the user completer. - Allow closing menus on Wayland by clicking the window. (ShootingStarDragons) - Merge Debian/Ubuntu Dependencies in the README. (enigma9o7) - Update zsh completions. (tastytea) - Skip empty requests for cross-signing keys when user only has one device. (Jason) - Hide image overlay when saving a file. (ShootingStarDragons) - Make it more obvious that the add reaction button is not an emoji. - Build only the gstreamer qml plugin in flatpak. - Update Ubuntu dependency list for building from source. (tastytea) ### Translations - Estonian (Priit) - Ukrainian (NullPointerException) - Indonesian (Linerly) - Chinese (Poesty Li) - Esperanto (Tirifto) - French (MayeulC, CB, Glandos, Rick) - Dutch (Thulinma) - Italian (DynamoFox, Elia Tomasi, Joseph Curto, Quanterxotur) - Russian (Evgeny, SOT-TECH) - Finnish (Lurkki) ### Bugfixes - You can now forward stickers again. - Edits shouldn't "jump" out of threads anymore. - Focus text input when quick switcher is closed. (LorenDB) - Fix rare freeze with an empty list in a completer. - Don't fail the plugins check on GStreamer 1.22 during a video call. - Allow nested ()/[] brackets in URLs. (mauke) - Make br tags work properly again. - Don't double free call devices. (Jason) - Work around multiple destructor calls on Clang. (Jason) - Html in sidebar. ### Notes You may want to build against the most recent mtxclient (0.9.2) for additional bugfixes. cpp-httplib and blurhash are still bundled by default and shipped with the source tarball. Explicitly disable the bundling for those packages to build against system versions. ## [0.11.1] -- 2023-01-15 ### Hotfix Release - Fixes issue where CPU usage could be excessive even when nheko was idle or minimized. (See #1284) - Add failed state for queued (pending) messages ## [0.11.0] -- 2023-01-12 ### Highlights - Search in your timeline πŸ” - Works in encrypted rooms. - Search is entirely local. - It might be a bit slow on some systems, since it needs to paginate the room to search instead of relying on the server. - Pushrule support! 🫸🫷 - Notifications should now be faster and not rely on the server. - Notifications should work properly in encrypted rooms. - MSC3664 is supported for pushrules for reply (needs server support). - Mentions get highlighted in the timeline. - Decrypting notifications can be disabled for improved privacy. - Threads 🧡 - Threads are a simple way to structure large rooms. - Start a new thread from any event. - Focus on a specific thread by clicking on the colored thread button next to any event from this thread. - Replies automatically land inside the thread. ### Features - Remember where you left off using the new unread indicator! --- - Navigate to space when selected in quick switcher or via link. - (Re-)Add an AppImage build. (Zhymabek Roman) - Render and send confetti! πŸŽ‰ (LorenDB) - Focus text field on most key presses. - Show link to next room for tombstone events. - macOS: Only play notification sound when pushrule says so. - macOS: Builds for Apple Silicon. - macOS: Allow quick replies from notifications. - Completer for /commands. - Allow opening room settings from room list. (LorenDB) - Allow setting the status message via the dbus API. (LorenDB) - Check out this for one possible usecase: https://schlomp.space/tastytea/dotfiles/src/commit/485aa7103c4f414ce0731804acf34a65a772fd28/.local/bin/mpd2nheko (Setting your currently playing song as your status) - Allow swapping Enter and Shift-Enter. (LordMZTE) - Preliminary support for VoIP v1. (Rohit) - Allow applying permission changes in spaces recursively. - Allow modifying permissions of users not in the room. ### Improvements - Prompt before deleting the database when the error could be resolved by the user. - Improve logging in particular for sync or registration errors. - Speedup quick switcher. - Prune image cache in the background. - Store all secrets encrypted in the database (apart from the pickle). - Speedup fetching olm sessions from the database. - Increase database resiliency at the cost of a lot of performance. - Rename spaces to communities. - Handle some rate limiting better in some cases. - More fine grained control over logging. (Forest) ### Translations - Ukrainian (NullPointerException) - Indonesian (Linerly as always <3) - Portugese (Brazil) (Daimar, zerowhy, Terry) - Estonian (Priit also a valued regular) - Finnish (Lurkki, you might know them too!) - Chinese (Chen Shaoji, Poesty Li, ling, Eric) - Russian (SOT-TECH, Evgeny, Carmina16, Mihail Iosilevich, Artem, Herecore, Alexey Murz, glebasson) - Occidental (Carmina16) - Polish (Romanik) - Dutch (Thulinma) - French (GitEz-code, Guillaume Girol, lascapi) - Esperanto (Tirifto) ### Bugfixes - Fix regional indicators. β€ŒπŸ‡¦β€Œ-β€ŒπŸ‡Ώβ€Œ - Pasting from Safari on macOS. - Potential crash when closing the room directory. - text selection in the raw message dialog. - Pagination after a timeline clear. - Entering newlines on Windows. - Work around crash in QQC2 in alias dialog. - Fix forwarding between encrypted rooms. - Blurry icons on HiDPI screens. (q234rty) - Fix CMark warning when configuring. (FINALLY!) - Blurry thumbnails. (again?!?) - Upload box thumbnail size. (foxb612) - Previews getting sorted above normal rooms in space view. - Excessive summary calls. - Usage type buttons for Sticker/Emoji packs. - Old server lookups overwriting new ones, possibly preventing any login. - Crash in member list. - Stripping fallbacks of plain text bodies. - Different greens. - Spoilers in replies. - Invites without state. ### Notes We bumped the required mtxclient version to 0.9.0 and the required coeurl version to 0.3.0. Supported Matrix API versions are now 1.1 to 1.5. ## [0.10.2] -- 2022-09-22 ### Security release - Fixes potential secret poisoning by the homeserver - A crash when validation malicious html Thanks to the matrix.org security team for disclosing this issue. An update is highly recommended. Otherwise you can temporarily protect against this issue by not verifying your own devices and not pressing the request button in the setting. ## [0.10.1] -- 2022-09-07 ### Highlights - Community editing support 🀼 - You can now create communities. - You can add and remove rooms to and from communities in various ways. - Prettier joins ✨ - You can now see the avatar, title, topic and member count of the room you are trying to join. - You can see if a room requires knocking or can be joined directly. - Requires MSC3266 support from your server. ### Features - Add a discrete edit button to room profiles. (Hiers) - Don't escape the summary tags on sending. - Focus message area when pressing Escape. (Forest) - Barebones spoiler support on desktop platforms. - Enable encryption for DMs started from a profile by default. - Enable option to disable notification sounds and badges on macOS. - Speed up the completion trie. (nenomius) ### Translations - Polish (Romanik, luff) - Dutch (Thulinma) - Finnish (Lurkki) - Estonian (Priit) - Indonesian (Linerly) ### Bugfixes - Fix crash on empty private receipts sent by some servers. - Don't set a transient parent for child chat windows. - Validate roomid, state_key, event_id and userids sent by the server. - Fix empty widgets showing up in the widget list. - Clean up linter config. (Forest) - Use the right palette colors for reactions. (Forest) - Fix groups sidebar's grammar. (Forest) - Fix version position. (Zirnc) - Properly validate urls in image tags. - Case insensitive member search. - Fix crash on global profiles. - Fix crash on incomplete identity keys. - Fix message notification format on Windows. - Fix room members menu opening profiles for the wrong room. ### Notes Requires mtxclient 0.8.1 and fixes a few crashes that can be abused by remote users. ## [0.10.0] -- 2022-07-22 ### Highlights - Notification counts πŸ’― (LorenDB, d42) - You can now see notification counts in more spaces, like your task bar or in the community sidebar. - For better work-life balance you can hide the notification counts on a per space basis. - For notification counts in the task bar your desktop environment needs to support the Unity protocol. - Notifications are also preserved across restarts now. - Moderation πŸ‘‍♀️ - You can now change the permissions and aliases of a room. - Permissions are shown in the Memberlist - A new `/redact` command to redact an event or all messages by a user. - You can now provide a reason when inviting, knocking, kicking and banning users. - Faster startup ⚑ - On at least some systems startup should now be instant even with thousands of rooms. - Encryption improvements πŸ›‘οΈ - Support for the most recent changes to Matrix E2EE including fallback keys, no longer relying on the sender_key. - Compatibility and stability improvements when dealing with different base64 encodings and when verifying users and devices. - Fetch the whole online key backup at the klick of a button. - Integration with external apps πŸ—ΊοΈ (LorenDB) - Nheko now has a D-Bus API, which you can enable in the settings menu. - This allows applications like KRunner or Rofi to list and switch between rooms. ### Features - Create a room link from a room. (brausepulver) - Support rendering policy rules. - Show notification counts for spaces (with options to disable them per space). (LorenDB) - Keep notification counts across restarts. - Support the new call events (but not the signaling yet). (r0hit) - Add a dbus API, which allows external applications to list and switch rooms in Nheko. (LorenDB) - Support editing room aliases. - Support editing room permissions. - Allow redacting all locally cached messages of a user using `/redact @userid:server.tld reason`. - Request full online key backup when toggling the online backup button. - Support the `knock_restricted` join rule. - Allow cancelling uploads using escape. (r0hit) - Send images on enter. - Close image viewer when clicking on the background. - Speedup startup by not loading messages for the room preview. - Make settings slightly narrower. - Show unread counts in the taskbar (if the Unity protocol is supported). (d42) - Indicate if a room has no topic in the settings. (LorenDB) - Simplify Fedora build instructions. (DaKnig) - Support e2ee fallback keys. - Allow opening rooms in separate windows. - Support more image formats in flatpak. - Show powerlevels in the memberlist. - Use less exotic emoji shortcodes. (Bulby) - Support sorting and filtering the memberlist. (LorenDB) - Make initial spinner half transparent. (LorenDB) - Fancier rendering for image pack changes. (tastytea) - Allow accessing member list and room settings for spaces. (LorenDB) - Add zsh completions. (tastytea) - Fancy rendering for Powerlevel changes. (MTRNord) - Make sender_key in encrypted messages optional. - Close current room using Ctrl-W. (LorenDB) - Allow knocking on failed room joins. - Allow knocking via matrix.to urls. - Allow specifying reasons for every room membership change. - Make room name and topic editing inline. - Add a jump to bottom button. (Malte) - Port room creation to qml. (Malte) - Streamline direct chat creation. (Malte) ### Translations - Russian (Alexey Murz Korepov, Artem, Herecore, balsoft, librehacker, glebasson, Mihail Iosilevich) - Chinese (Nekogawa Mio, Poesty Li, Reiuji Utsuho, hulb, ling, RainSlide, hosxy) - German - Dutch (Jaron ViΓ«tor) - Finnish (Lurkki, Aminda) - Indonesian (Linerly) - Estonian (Priit) - French (Symphorien, Glandos, Eldred) - Serbian (Miroslav) ### Bugfixes - Fix verification requests not stopping properly when initiated from this instance. - Don't send matrix.to markdown links in replies. - Make the database work on 32bit systems again. (MayeulC) - Add missing window decoration to room directory dialog on macOS. - Don't crash on empty image packs. - Fix spacing of encryption indicator in the room tite if it contains widgets. - Emojis during verification should no longer be clipped. - Don't ping the whole room when replying to users with a localpart of `room`. - Make icons sharp on all platforms. (q234rty) - Work around synapse not sending the original resolution when requesting large thumbnails to make large thumbnails less blurry. (brausepulver) - Fix weak symbols from private object destructor. (Jason) - Fix failed uploads not cancelling properly. - Edits now properly update in replies again. - Improve text paste experience. (Syldra) - Pins should now properly update when the events are fetched. - Support latest iteration of the hidden read receipts MSC. - Fix cursor movement with some themes. (Syldra) - Properly handle glare during verification. - Set an Element Android compatible height for custom emotes. - Don't crash because of reusing items in completer on some platforms. - Fix the privacy screen on popped out windows. - Properly scale animated images. - Don't clip pinned messages. - Use correct powerlevels for direct chats. - Properly close cursors before committing txn. - Don't fail if a different client used the wrong base64 encoding when setting up SSSS. - Spaces usually aren't DMs. (LorenDB) - Don't send invalid aliases to the server on room creation. (Apurv) - Fix invite dialog. ### Notes This release requires Matrix API v1.1-v1.3. Please make sure your server is up to date. This release limits the maximum connections per host to 8. For best performance we recommend your server supports http/2 so that slow requests don't slow down other parts of the app (like sending messages). Nheko now has KRunner and Rofi plugins (developed by LorenDB and LordMZTE respectively). ## [0.9.3] -- 2022-03-25 ### Highlights - New upload UX - Queue multiple uploads by pasting or dragging multiple files. - Videos will now properly have a thumbnail as well as images. - Duration, width and height is now also properly included so that clients can resize appropriately. - Thumbnails are excluded if they are bigger than the original image. (tastytea) - Improvements for mobile devices (Malte E) - You should now be able to scroll by touching anywhere with no random dead zones. - Preedit text can now be used in a completer and is properly sent - If an input method is active, pressing Enter will not send the current message. ### Features - Optionally always open videos and images in an external program. (math) ### Improvements - Build macOS releases against Qt 5.15.3 to resolve missing spaces after some punctuation. - Send the shortcode as the body for stickers without a body. - Elide long usernames in the timeline. (Malte E) - Cleanup the reply popup. (Malte E) - Use standard buttons where possible. (tastytea) - Various improvements to the bubble layout. (Malte E) - Enable online key backup by default. - Update the bundled gstreamer in our Flatpaks. ### Translations - Indonesian (Linerly) - Estonian (Priit) - Finnish (Priit) - Esperanto (Tirifto) ### Bugfixes - Fix hovering the action menu. - Try to avoid using unknown UIA flows. - Don't Components actively in use. - Fix screensharing. - Fix device id when doing SSO logins. ## [0.9.2] -- 2022-03-09 ### Highlights - Message bubbles (Malte E) πŸ’¬ - Give a colorful and space saving background to messages. - Optionally shrink the usernames to save even more space. - Your messages are on the opposite side of messages sent by other users. - Basic widgets πŸ—” - Widgets in a room are shown below the topic. - Open them in your browser to view them. ### Features - Autocompleter for custom emotes using `~`. Note that this currently inserts raw html into the message input. - Support running Nheko without a secrets service using a hidden setting. - Add zooming and panning to the image overlay. - Add a manpage. (tastytea) - Offline indicator. (LorenDB) - Proper previews for unjoined rooms in spaces (on supported servers). - `/reset-state` /command to reset the state of a single room. - Allow hiding some events from the timeline. (tastytea) - Hidden read receipts. (Symphorien) - Open room members dialog when clicking the encryption indicator. - Click to copy room id. (Malte E) - Allow specifiying a reason for message removal, bans and kicks. (tastytea) ### Improvements - Speed up blurhash and jdenticon rendering. - Use fewer threads for image decoding reducing memory use. - Document secret service installation on Arch. (Marshall Lochbaum) - Make edits replace previous notifications for the same message on Linux. - Add alternatives for Alt-A as a shortcut on systems where that is already used. - Apply clang-tidy suggestions. (MTRNord) - Make custom emotes twice as high as the text to improve legibility. (tastytea) - Ensure high quality scaling is used for custom emotes. (tastytea) - Reduce allocations for the timeline by around a factor of 2. - Render messages half as often, when displaying them for the first time. - Increase maximum number of items in completers to 30. - Run the gstreamer event loop also on macOS and Windows. - Make presence update dynamically. - Cleanup the raw message dialog. - Make settings responsive. - Improve Login and Registration pages. - Add custom stickers & emotes to Q&A. - Improve scrolling on touch screens. (Malte E) - Reduce size of state events. - Update OpenSUSE install instructions. (LorenDB) - Use newer flatpak runtime. - Fallback to using the shortcode in custom emotes, when there is no title set. (Ivan Pavluk) - Improve a lot of hovering behaviours. - Make spinboxes in scrollable pages unscrollable. (Malte E) - Fix deprecation warnings in gstreamer code. (Scow) - Make room directory fit mobile screens. (Malte E) - Make room search accessible on mobile. (Malte E) - Fix calls on mobile. - Add arch binary repo. (digital-mystik) - Improve long topics in the room settings. (Malte E) - Fix typos. (ISSOtm) - Improve the message input on mobile devices. (Malte E) ### Translations - Indonesian (Linerly) - Spanish (Lluise, Diego Collado, Richard, Edd Ludd, Drake) - Catalan (Edd Ludd) - French (ISSOtm) - Estonian (Priit) - Dutch (Thulinma) - Chinese (hulb) ### Bugfixes - Wrap member events. - Fix rendering of some emoji. - Fix crash when accepting invites. - Don't fail startup on servers without presence. - Fix grayscale images in notifications when using dunst. - Clear sticker search. (tastytea) - Limit width of username and roomname in the respective settings. - Application name on Wayland. - Memory leak when closing dialogs. - Fix editing pending messages. - Fix missing Windows runtime. (MTRNord) - Fix a long standing issue where the font was set to a random one instead of the system default. - Allow clicking on images in replies to scroll to that image again. - Don't force https, when logging into a http only server. ## [0.9.1-1] -- 2021-02-24 - Rebuild against newer mtxclient to fix an incompatibility with Matrix v1.1 and newer. If you use the binary packages for macOS or Windows, you will need this update. Otherwise you can just wait for your distribution to update the mtxclient package instead. ## [0.9.1] -- 2021-12-21 ### Highlights - Support pinned messages. ### Features - Add recently used reactions. (LorenDB) - Show spaces as a tree, that allows you to collapse sections. - Add a filter for direct chats ### Improvements - Set the app_id on Wayland. Useful for custom WM rules. - Set notification category on Linux. - Make Nheko show up in system notification settings on Linux. - Make notification count bubbles expand some more. (LorenDB) - Strip space chars from recovery passphrase. Should make them easier to enter. - Make it obvious that undecryptable messages are a notification and not the actual message. (LorenDB) - Added window role to image overlay. (Thulinma) - Only show room pack button, when you can actually create one. - Show some avatar for image packs. - Allow clicking links in replies. - Limit max memory usage of images. - Allow swiping between views in single page mode Allows access to spaces on mobile for example. - Get rid of a few clang-tidy warnings. (Marcus Hoffmann) - Navigate to subspaces by clicking on them. - Delete rooms even if we fail to leave. - Change QML UI for redactions. - If the locale is set to C, force english locale This fixes date formatting as well as count based translations. - Use a more random hash to generate user colors. - Mark rooms as direct chats in the proper places. - Update macOS icon package to macOS-y style. (Quinn) - Preliminary gstreamer 1.20 compatibility. ### Translations - Indonesian (Linerly) - Estonian (Priit JΓ΅erΓΌΓΌt) - French (Eldred HABERT) - Dutch (Thulinma) - Esperanto (Tirifto) - Finnish (Priit JΓ΅erΓΌΓΌt) - Italian (Elia Tomasi) - French (Mayeul Cantan) ### Bugfixes - Fix crash when receiving matrix uri. - Make opening room members from rooms settings dialog work. (LorenDB) - Fix turnserver check not being started when restoring from cache. - Vertically align message input. - Properly set position of resize handler after letting it go. - Fix escaped html showing up in playable media message labels. ## [0.9.0] -- 2021-11-19 ### Highlights - Somewhat stable end to end encryption - Show the room verification status - Configure Nheko to only send to verified users - Store the encryption keys securely in the OS-provided secrets service. - Support online keybackup as well as sharing historical session keys. - Crosssigning bootstrapping - Crosssigning is used to simplify the verification process. In this release Nheko can setup crosssigning on a new account without having to use a different client. - Nheko now also prompts you, if there are any unverified devices and asks you to verify them. - Room directory (Manu) - Search for rooms on your server and other servers. (Prezu) - If their topic interests you and it has the right amount of members, join the room and the discussion! - Custom sticker packs - Add a custom sticker picker, that allows you to send stickers from MSC2545. - Support creating new sticker (and emote) packs. - You can share packs in a room and enable them globally or just for that room. - Token authenticated registration (Callum) - Sign up with a token to servers, that have otherwise disabled registration. - This was done as part of GSoC and makes it easier to run private servers for your family and friends! ### Features - Support email in registration (required on matrix.org for example) - Warn, if an @room would mention the whole room, because some people don't like that. - Support device removal as well as renaming. (Thulinma) - Show your devices without encryption support, when showing your profile. (Thulinma) - Move to the next room with unread messages by pressing `Alt-A`. (Symphorien) - Support jdenticons as a placeholder for rooms or users without avatars. (LorenDB) - You will need to install https://github.com/Nheko-Reborn/qt-jdenticon - Properly sign macOS builds. - Support animated images like GIF and WebP. - Optionally just play them on hover. - Support accepting knocks in the timeline. - Close a room when clicking it again. (LorenDB) - Close image overlay with escape. - Support .well-known discovery during registration. - Limited spaces support. - No nice display of nested spaces. - No previews of unjoined rooms. - No way to edit a space. - Render room avatar changes in the timeline. (BShipman) - Support pulling out the sidebar to make it wider. - Allow editing pending messages instead of blocking until they are sent. (balsoft) - Support mnemonics in the context menus. (AppAraat) - Support TOFU for encryption. (Trust on first use) - Right click -> copy address location. - Forward messages. (Jedi18) - Alt-F to forward messages. - A new video and audio player, that should look a bit nicer. ### Improvements - Translation updates: - French by MayeulC, ISSOtm, Glandos, Carl Schwan - Dutch by Thulinma, Bas van Rossem, Glael, Thijs - Esperanto by Tirifto, Colin - Estonian by Priit - Indonesian by Linerly - German by 123, Konstantin, fnetX, Mr. X, CryptKid - Portuguese (Portugal) by Tnpod, Xenovox, Gabriel R - Portuguese (Brazil) by Terry, zerowhy - Finnish by sdrrespudro, Priit - Polish by Prezu, AXD, stabor - Malayalam by vachan-maker - Italian by Daniele, Lorenzo - Spanish by lluise - Russian by kirillpt - Various wording improvements throughout. - Verification status and identity keys should now update properly after login. - Clicking the user in a read receipt opens their profile. (LorenDB) - Invites should now work properly on mobile. - Use the modern notifications on macOS. - Decode blurhashes faster. - Port various dialogs to Qml. (LorenDB) - Improve paste support on Windows, when mimetype detection fails and pasting SVGs (Thulinma) - --help and --version now work, even if Nheko is already running somewhere. - Update emoji support to version 14. - Properly navigate to linked to events. (Thulinma) - Lots of smaller bugfixes and refactorings. (LorenDB) - Scroll entire profile page and properly trim contents. (Thulinma) - Make it easy to switch between global and room specific profiles. (Thulinma) - Deduplicate messages sent by the server. (Thulinma) - Decrease the margin of blockquotes. (tastytea) - Alerts now work, if the homeserver does not implement the notifications endpoint. (Thulinma) - Right click menu now works on replies. - Decrypt encrypted media only in memory. (On macOS it still uses a tempfile because of ) - Don't use CC-BY in the appstream license to not confuse Gnome Software. - Document how to sync the repo on Gentoo. (alfasi) - Support online key backup. - Improve FAQ. (harmathy) - Support Backtab/Shift-Tab for moving backwards in completer selections. - Clear cache to support the new features. - Improve the emoji completer (less jitter and fix places where it didn't open). (Thomaps Karpiniec) - Cleanup @room escape logic. - Improve performance of timeline rendering. - Add fallback for sent stickers, so that they show on iOS. - Load rooms somewhat lazily. - Properly scale avatars to DPI. - Round avatars once in the backend instead of on every render. - Request keys of all members, when opening a room the first time. - Timeout TCP connections, if heartbeat can't be heard. - Change secrets name. You might need to rerequest your secrets after upgrading! - Protect against replay attacks where megolm sessions are reused. - Add "request keys" button to undecryptable messages. - Remove superfluous permissions in Flatpak. - Properly set window parents on Wayland. - Properly show users and allow opening their profiles in the members and read receipt dialogs. (LorenDB) - Use Qt5.15 Connections syntax in Qml. - Remove "respond to keyrequests option". We now reply to the right requests automatically and securely. - Show confirmation prompt when leaving a room. - Add trailing newline to session export for gomuks compatibility. - Use a fancy Nheko logo as the loading indicator. - Improve how the invite dialog handles users. (LorenDB) - Store more data about megolm sessions. - Speed up database queries by caching transactions. - Use curl for network requests. - This removes the boost dependency. - Proxies now work using the usual curl variables. - Fixes a myriad of crashes. - Faster. - Less CPU load. - Less bandwidth usage. - Cleanup user color generation. - Show borders around tables. - Improve wording of a few menu entries. (absorber) - Highlight navigated to message. - Switched to the fluent icon set. (LorenDB) ### Bugfixes - Redaction of edited messages should now actually show those messages as removed. - Bootstrap after registration should run properly now. - Getting logged out after registration should not happen anymore. - Removed edgecases where identity keys could get uploaded twice. - Fix the event loop when fetching secrets breaking random things like scrolling. - Don't crash when clearing an empty timeline. - Opening an invite in your browser or a matrix: URI should not crash Nheko anymore or do nothing. - When clicking on an item in the roomlist, you don't have to move your mouse anymore, before being able to click again. - Don't hide space childs when viewing that specific space and its children are hidden. - Only allow specific URI schemes to be followed automatically. - Properly hide day change indicator, when loading older messages. - Rotate session properly when 'verified only' is set. - Handle missing keys in key queries properly. - Properly show the window title for Qml dialogs on windows. - Don't show decryption errors in replies. - Don't crash when storing secrets. - Don't send megolm messages to ourselves, if possible. - Fix SSSS without a password. - Fix a few edge cases with OTK upload. - Cache more media properly (i.e. in the Goose Chooser). - Inline images in messages now load properly. - Don't show verification requests after startup. - Emoji picker now follows the theme. - Send less newlines in the reply fallback. - Fix tags going missing when joining spaces. - Handle inline images with single quotes. (Cadair) - Delay key requests until a room is opened. - Fix rooms not showing, when groups endpoint is missing. - Don't use deprecated parameters in /login. - Fix encoding issues when translating matrix.to to matrix: URIs. - Prevent edits from stripping the whole message, if it had a quote. ### Packaging changes - Removed the AppImage - Removed dependency on boost - Now depends on [coeurl](https://nheko.im/nheko-reborn/coeurl), which depends on libevent and libcurl. - VOIP support now needs to be explicitly controlled using the VOIP and SCREENSHARE_X11 cmake options. ## [0.8.2] -- 2021-04-23 ### Highlights - Edits - If you made a typo, just press the `Up` key and edit what you wrote. - Messages other users edited will get updated automatically and have a small pen symbol next to them. - Privacy Screen - Blur your messages, when Nheko looses focus, which prevents others from peeking at your messages. - You can configure the timeout of when this happens. - Improved notifications (contributed by lorendb) - No more breakage, because the message included a > on KDE based DEs. - Render html and images where possible in the notification. - Render if a message is a reply or someone sent an emote message more nicely where possible. - Encrypted notifications now show, that the content is encrypted instead of being empty. - Screenshare support in calls on X11 (contributed by trilene) - Share your screen in a call! - Select if your mouse cursor should be shown or not and if your webcam should be included. - SEND MESSAGES AS RAINBOWS! (contributed by LordMZTE) - YES MESSAGES, EMOTES AND NOTICES! ### Features - Set your displayname and avatar from Nheko either globally or per room. (contributed by jedi18) - Show room topic in the room settings. - Double tap a message to reply to it. - Leave a room using `/part` or `/leave`. (contributed by lorendb) - Show mxid when hovering a username or avatar. - Allow opening matrix: uris on Windows. - Disable room pings caused by replies sent via Nheko (unless you are using Element Web/Desktop). ### Improvements - Userprofile can be closed via the Escape key. No more hotel california! (contributed by lorendb) - Most dialogs are now centered on the Nheko window. (contributed by lorendb) - Update Hungarian translations. (contributed by maxigaz) - Update Estonian translations. (contributed by Priit) - Update Russian translations. (contributed by Alexey Murz and Artem) - Update Swedish translations. (contributed by Emilie) - Update French translations. (contributed by MayeulC, Nicolas Guichard and Carl Schwan) - Allow drag and drop of files on the whole timeline. (contributed by lorendb) - Enable notifications on Haiku. (contributed by kallisti5) - Update scheme handler to the latest matrix: scheme proposal. - Close completers when typing a space after the colon. (contributed by jedi18) - Port room settings to Qml. (contributed by jedi18) - Improved read marker handling. Read marker should now get stuck less often. - Various changes around hover and tap handling in the timeline, which hopefully now works more predicatably. - Buttons in the timeline are now rendered in a box on hover on desktop platforms. - Complete room links in the timeline after typing a # character. (contributed by jedi18) - An improved quick switcher with better rendering and search. (contributed by jedi18) - Some fixes around inline emoji and images. - Jump into new rooms, after you created them. (contrubuted by jedi18) - Improved search in the emoji picker. - Allow disabling certificate checks via the config file. - Use native menus where possible. - Fix video playback on Windows. (contrubuted by jedi18) - Send image messages by pressing Enter. (contributed by salahmak) - Escape closes the upload widget. (contributed by salahmak) - Improve session rotation and sharing in E2EE rooms. ### Bugfixes - Emojis joined from separate emojis with a 0xfe0f in the middle should now render correctly. - Fix a bug when logging out of a non default profile clearing the wrong profile. (contrubuted by lorendb) - Various fixed around profile handling. (contributed by lorendb) - Focus message input after a reaction. (contributed by jedi18) - Disable native rendering to prevent kerning bugs on non integer scale factors. - Fix duplex call devices not showing up. (contributed by trilene) - Fix a few crashes when leaving a room. (contributed by jedi18) - Fix hidden tags not updating properly. (contributed by jedi18) - Fix some issues with login, when a server had SSO as well as password login enabled (for example matrix.org). - Properly set the dialog flag for dialogs on most platforms. (Wayland does not support that.) - Properly add license to source files. - Fix fingerprint increasing the minimum window size. - Don't send markdown links in the plain text body of events when autocompleting user or room names. - Fix webcam not working in flatpaks. - Fix markdown override in replies. - Fix unsupported events causing errors when saving them. (contributed by anjanik) - Fix exif rotation not being respected anymore in E2EE rooms. - Remove unused qml plugins in the windows package. - Fix broken olm channels automatically when noticed. - Fix pasting not overwriting the selection. - Fix Nheko sometimes overwriting received keys with keys it requested, even if they have a higher minimum index. ### Packaging changes - Added xcb dependency on X11 based platforms for screensharing (optional) - Bumped lmdbxx version from 0.9.14.0 to 1.0.0, which is a BREAKING change. You can get the new version here: https://github.com/hoytech/lmdbxx/releases (repo changed) - Removed tweeny as a dependency. ## [0.8.1] -- 2021-01-27 ### Features - `/plain` and `/md` commands to override the current markdown setting. (contributed by lorendb) - Allow persistent hiding of rooms with a specific tag (or from a community) via a context menu. - Allow open media messages in an external program immediately. (contributed by rnhmjoj) ### Improvements - Use async dbus connection for notifications. (contributed by lorendb) - Update Hungarian translations. (contributed by maxigaz) - Update Finnish translations. (contributed by Priit) - Update Malayalam translations. (contributed by vachan-maker) - Update Dutch translations. (contributed by Glael) - Store splitter size across restarts. - Add a border around the completer. (contributed by lorendb) - Request keys for messages with unknown message indices (once per restart, when they are shown). - Move the database location to XDG_DATA_DIR. (contributed by rnhmjoj) - Reload the timeline after key backup import. - Autoclose completer on `space`, when there are no matches. - Make completer only react, when the mouse cursor is moved. ### Bugfixes - Fix unhandled exception, when a device has no keys. - Fix some cmake warnings regarding GNUInstallDirs. - Fix tags being broken. If you have no tags showing up, you may want to logout and login again. - Fix versionOk being called on the wrong thread. (contributed by Jedi18) - Fix font tags showing up in media message filenames. - Fix user profile in dark themes showing the wrong colors. (contributed by lorendb) - Fix emoji category switching on old Qt versions. (contributed by lorendb) - Fix old messages being replayed after a limited timeline. - Fix empty secrets being returned from the wallet breaking verification. - Make matrix link chat invites create a direct chat. - Fix focus handling on room change or reply button clicks. - Fix username completion deleting the character before it. ## [0.8.0] -- 2021-01-21 ### Highlights - Voice and Video Calls (contributed by trilene) - Call your friends right from within Nheko. - Use your camera if you want them to see your face! - This requires a somewhat new gstreamer, so our builds don't support it on all platforms yet. - Cross-Signing and Device/User Verification (contributed by Chethan) - Verify who you are talking to! - Ensure no malicious people eavesdrop on you! - Enable your connected devices to access key backup and your friends to see, which of your devices you trust! - Show devices in a users profile. - Separate profiles (contributed by lorendb) - Run multiple Nheko instances with separate profiles side by side. - Use multiple accounts at the same time in separate windows. ### Features - Before a call select which audio device to use. (contributed by trilene) - Auto request unknown keys from your own devices. - Add a command to clear the timeline and reload it. (/clear-timeline). - Add a command to rotate the outbound megolm session. (/rotate-megolm-session). - React to messages instead of replying with arbitrary strings using `/react`. - Inline emoji and user completers. (contributed by Lurkki) - Show filename on hover over an image. (contributed by kamathmanu) - Mobile mode, that disables text selection and changes some dialogs. - Allow sending text after a `/shrug` command. (contributed by MayeulC) - Allow selecting a ringtone. (contributed by trilene) - View avatars fullscreen. (contributed by kamathmanu) - Request or download cross signing secrets in the settings. - Support 'matrix:' URIs. This works in app on all platforms and on Linux Nheko may be opened by clicking a 'matrix:' link. - Support inline replies on notifications on Linux. ### Improvements - Remove dependency on libsodium. - Keep a cache of received messages on disk. - Warn when kicking, banning or inviting people. - Align day separators in the timeline. (contributed by not-chicken) - Confirm quit during an active call. (contributed by trilene) - Make timestamps somwhat fixed width. - Add NixOS to readme. (contributed by Tony) - Speed up database accesses. - A lot of translation updates by various users. - Port a few more parts of the UI to Qml. - Various end-to-end encryption fixes. - Use a QFontComboBox to select fonts. (contributed by lorendb) - Delete text in input area with Ctrl+U. (contributed by lorendb) - Reduce memory usage by not loading members into RAM. - Speed up rendering the timeline by a lot by removing excessive clipping. - Reload encrypted message when room_key is received. - Improve wording in various places. (contributed by MayeulC) - Improve rendering of avatars in various places. (contributed by MayeulC) - Riot -> Element in README. (Contributed by Kim) - Improve login and registration page error reporting. (contributed by kirillpt) - Move CI to Gitlab. - Use system Nheko icon on login page. (contributed by lorendb) - Add Fedora build requirements. (contributed by trilene) - Add ripple effect to various buttons. - Allow more font sizes to be selected. - Swedish translation. (contributed by Emilie) - German translation. (contributed by Mr X and various others) - Romanian translation. (contributed by Mihai) - Polish translation. (contributed by luff) - Russian translation. (contributed by kirillpt and librehacker) - Italian translation. (contributed by Lorenzo) - French translation. (contributed by MayeulC) - Hungarian translation. (contributed by maxigaz) - Show read markers when clicking read indicator. (contributed by lorendb) ### Bugfixes - Fix text sometimes being rendered blurry. - Fix not being able to change theme (contributed by not-chicken) - Fix relations sometimes being sent as null in encrypted messages. - Don't send formatted body without format. - Links sometimes not opening properly from Qml. - Fix autolinking breaking on single quotes. - Fix translation loading on some locales. - Don't send url in encrypted file events. - Prevent duplicate messages from showing up in the timeline. - Fix crash when pasting image from clipboard on macOS. - Settings toggles don't get stuck anymore. (contributed by kirillpt) - Fix some emojis being rendered as two emoji. - Fix SSO login on some servers that allow multiple login methods. (contributed by d42) ### For packagers - Nheko now depends on QtKeychain. - Nheko optionally depends on GStreamer for VOIP. - Nheko does not depend on Sodium anymore. - Minimum OpenSSL version is now 1.1. ## [0.7.2] -- 2020-06-12 ### Highlights - Reactions - React to a message with an emoji! πŸŽ‰ - Reactions are shown below a message in a small bubble with a counter. - By clicking on that, others can add to the reaction count. - It may help you celebrating a new Nheko Release or react with a πŸ‘Ž to a failed build to express your frustration. - This uses a new emoji picker. The picker will be improved in the near future (better scrolling, sections, favorites, recently used or similar) and then probably replace the current picker. - Support for tagging rooms `[tag]` - Assign custom tags to rooms from the context menu in the room list. - This allows filtering rooms via the group list. This puts you in a focus mode showing only the selected tags. - You can assign multiple tags to group rooms however you like. - SSO Login - With this you can now login on servers, that only provide SSO. - Just enter any mxid on the server. Nheko will figure out that you need to use SSO and redirect your browser to the login page. - Complete the login in your browser and Nheko should automatically log you in. - Presence - Shows online status of the people you are talking to. - You can define a custom status message to tell others what you are currently up to. - The status message appears next to the usernames in the timeline. - Your server needs to have presence enabled for this to work. ### Features - Respect exif rotation of images - An italian translation (contributed by Lorenzo Ancora) - Optional alerts in your taskbar (contributed by z33ky) - Optional bigger emoji only messages in the timeline (contributed by lkito) - Optional hover feedback on messages (contributed by lkito) - `/roomnick` to change your displayname in a single room. - Preliminary support for showing inline images. - Warn about unencrypted messages in encrypted rooms. ### Improvements - perf: Use less CPU to sort the room list. - Limit size of replies. This currently looks a bit rough, but should improve in the future with a gradient or at some other transition. - perf: Only clean out old messages from the database every 500 syncs. (There is usually more than one sync every second) - Improve the login and register masks a bit with hints and validation. - Descriptions for settings (contributed by lkito) - A visual indicator, that nheko is fetching messages and improved scrolling (contributed by Lasath Fernando) ### Bugfixes - Fix not being able to join rooms - Fix scale factor setting - Buildfixes against gcc10 and Qt5.15 (missing includes) - Settings now apply immediately again after changing them (only exception should be the scale factor) - Join messages should never have empty texts now - Timeline should now fail to render less often on platforms with native sibling windows. - Don't rescale images on every frame on highdpi screens. ### Upgrade Notes This updates includes some changes to the database. Older versions don't handle that gracefully and will delete your database. It is therefore recommended to not downgrade below this version! ## [0.7.1] -- 2020-04-24 ### Features - Show decrypted message source (helps debugging) - Allow user to show / hide messages in encrypted rooms in sidebar ### Bugfixes - Fix display of images sent by the user (thank you, wnereiz and not-chicken for reporting) - Fix crash when trying to maximize image, that wasn't downloaded yet. - Fix Binding restoreMode flooding logs on Qt 5.14.2+ - Fix with some qml styles hidden menu items leave empty space - Fix encrypted messages not showing a user in the sidebar - Fix hangs when generating colors with some system theme color schemes (#172) ## [0.7.0] -- 2020-04-19 0.7.0 *requires* mtxclient 0.3.0. Make sure you compile against 0.3.0 if you do not use the mtxclient bundled with nheko. ### Features - Make nheko session import / export format match riot. Fixes #48 - Implement proper replies - Add .well-known support for auto-completing homeserver information - Add mentions viewer so you can see all the messages you have been mentioned in - Currently broken due to QML changes. Will be fixed in the future. - Add emoji font selection preference - Encryption and decryption of media in E2EE rooms - Square avatars - Support for muting and unmuting rooms - Basic support for playing audio and video messages in the timeline - Support for a lot more event types (hiding them will come in the future) - Support for sending all messages as plain text - Support for inviting, kicking, banning and unbanning users - Sort the room list by importance of messages (thanks @Alch-Emi) - Experimental support for [blurhashes](https://github.com/matrix-org/matrix-doc/pull/2448) ### Improvements - Add dedicated reply button to Timeline items. Add button for other options so that right click isn't always required. - Fix various things with regards to emoji rendering and the emoji picker - Lots and lots and lots of localization updates. - Additional tweaks to the system theme - Render timeline in Qml to drop memory usage - Reduce memory usage of avatars - Close notifications after they have been read on Linux - Escape html properly in most places - A lot of improvements around the image overlay - The settings page now resizes properly for small screens - Miscellaneous styling improvements - Simplify and speedup build - Display more emojis in the selected emoji font - Use 'system' theme as default if QT_QPA_PLATFORMTHEME is set ### Bugfixes - Fix messages stuck on unread - Reduce the amount of messages shown as "xxx sent an encrypted message" - Fix various race conditions and crashes - Fix some compatibility issues with the construct homeserver Be aware, that Nheko now requires Qt 5.10 and boost 1.70 or higher. ## [0.6.4] - 2019-05-22 *Most* of the below fixes are due to updates in mtxclient. Make sure you compile against 0.2.1 if you do not use the mtxclient bundled with nheko to get these fixes. ### Features - Support V3 Rooms ### Improvements - Fix #19 - Fix initial sync issue caused by matrix-org/synapse#4898 (thanks @monokelpinguin) - Add additional lmbd max_dbs setting (thanks @AndrewJDR) - Update DE translations (thanks @miocho) - Update Dutch translations (thanks @vistaus) - Fix text input UI bug (thanks @0xd800) - Update linkifyMessage to parse HTML better (thanks @monokelpinguin) - Update to Boost 1.69.0 - Fix some memory-leak scenarios due to mismatched new / delete (thanks @monokelpinguin) ### Other Changes - mtxclient now builds as a Shared Library by default (instead of statically) ## [0.6.3] - 2019-02-08 ### Features - Room notifications now distinguish between general and user mentions by using different colors - User names are now colored based on both the theme and a hash from their user id. - Add font selection preference ### Improvements - Fix room joining issue by escaping (thanks rnhmjoj) - Mild tweaks to the dark and light themes - Add paragraph tags back to markdown, fixing #2 / mujx#438 - Tweak author text to help differentiate it from the message text - Some Russian translations have been added/fixed (thanks tim77) - Partially address some build issues (related to #10) ## [0.6.2] - 2018-10-07 ### Features - Display tags as sorting items in the community panel (#401 @vberger) - Add ability to configure the font size. ### Improvements - Don't enable tray by default. - Hard-coded pixel values were removed. The sizes are derived from the font. ### Other changes - Removed room re-ordering option. ## [0.6.1] - 2018-09-26 ### Improvements - Add infinite scroll in member list. (#446) - Use QPushButton on the preview modal. ### Bug fixes - Clear text selection when focus is lost. (#409) - Don't clear the member list when the modal is hidden. (#447) ## [0.6.0] - 2018-09-21 ### Features - Support for sending & receiving markdown formatted messages. (#283) - Import/Export of megolm session keys. (Incompatible with Riot) (#358) - macOS: The native emoji picker can be used. - Context menu option to show the raw text message of an event. (#437) - Rooms with unread messages are marked in the room list. (#313) - Clicking on a user pill link will open the user profile. ### Improvements - Update Polish translation (#430) - Enable Qt auto scaling. (#397) - Enable colors in the console logger. - Refactor styling to better work with the system theme. ### Bug fixes - Fixed crash when switching rooms. (#433) - Fixed crash during low connectivity. (#406) - Fixed issue with downloading media that don't have a generated thumbnail. - macOS: Add missing border on the top bar. - Fallback to the login screen when the one-time keys cannot be uploaded. - Show the sidebar after initial sync. (#412) - Fix regression, where cache format changes didn't trigger a logout. ## [0.5.5] - 2018-09-01 ### Features - Add the ability to change the room avatar. (#418) - Show the room id in the room settings modal. (#416) ### Improvements - More flicker improvements. - Auto remove old messages from cache. ### Bug fixes - Fixed issue where nheko will stop retrying initial sync. (#422) - Fixed the incomplete version string on Info.plist (macOS) (#423) - Fixed a use-after-free error during logout. - Temporary fix to work with servers that don't support e2ee. i.e Construct, Dendrite (#371) ## [0.5.4] - 2018-08-21 Small release to address a crash during logout. ### Features - The settings page now includes the device id & device fingerprint (thanks @valkum ) - The Polish translation has been updated (thanks @m4sk1n ) ## [0.5.3] - 2018-08-12 ### Features - Add option to disable desktop notifications (#388) - Allow user to configure join rules for a room. - Add tab-completion for usernames (#394). ### Improvements - Remove the space gap taken by the typing notifications. - Remove hover event from emoji picker. - Add tooltips for the message indicators (#377). - Fix compilation on FreeBSD (#403) - Update Polish translation. - Small modal improvements. ### Bug fixes - Remove dash from the version string when building outside of git. - Remove unwanted whitespace from the user settings menu. - Consider the scale ratio when scaling down images (#393). ## [0.5.2] - 2018-07-28 ### Features - Mark own read messages with a double checkmark (#377). - Add option to specify the scale factor (#357, #335, #230). - Add input field to specify the device name on login. - Add option to ignore key requests altogether. - Show device list in user profile & add option to create 1-1 chat. ### Improvements - Add foreground color for disabled buttons on the dark theme. - Increase the opacity of the hover color on the room list. - Add missing tooltips on buttons (#249). - Performance Improvements when filtering large number for rooms. - Clear timeline widgets when they exceed a certain limit, to reduce the memory footprint (#158). - Use native scrollbar in the timeline. - Enable scrollbar on the room list for macOS. - Remove some timeline flickering on macOS. - Remove pixel values from modals. - Update Polish translation. ### Bug fixes - Fix crash when the server doesn't have the joined_groups endpoint (#389). - Reject key requests for users that are not members of the room. - Add user avatar after the `encryption is enabled` message (#378) ## [0.5.1] - 2018-07-17 ### Improvements - Add the -v / --version option, which displays the version of the application. - Explicitly set no timeout for the Linux notifications. ### Bug fixes - Fix crash when drag 'n drop files on text input. (#363) - Convert MXC to HTTP URI for video files. - Don't display the `m.room.encryption` event twice. - Properly reset the auto-complete anchor when the popup closes. (#305) - Use a brighter color for button's text on the system theme. (#355) ## [0.5.0] - 2018-07-15 ### Features - End-to-End encryption for text messages. - Context menu option to request missing encryption keys. - Desktop notifications on all platforms (Linux, macOS, Windows). - Responsive UI (hidden sidebar/timeline). - Basic support for replies (#292) ### Improvements - Save timeline messages in cache for faster startup times. - Debug logs will now be saved in a file. - New translations - French (#329) - Polish (#349) - No dependencies will be downloaded during build. ### Bug fixes - Allow close events from the session manager (#353). - Send image dimensions in m.image event (#215). - Allow arbitrary resizing of the main window & restore sidebar's size (#160, #163, #187, #127). ## [0.4.3] - 2018-06-02 ### Bug fixes - Overdue fixes for some regressions with regard to widget height introduced in the previous two releases - The matrix id will be shown on hover on the display name. ## [0.4.2] - 2018-05-25 ### Bug fixes - Make the number of unread messages fit in the bubble (#330) - Use white for messages on the dark theme (#331) - Fix "jumpy messages" regression ## [0.4.1] - 2018-05-23 ### Features - Menu to modify the name & topic of the room. - Desktop notifications for macOS. - Option to start in tray (#319) - Russian translation (#318) - Read support for the room access level (#324) ### Improvements - HiDPI avatars. ### Bug fixes - Fix for the line break on messages with very long words/links. - Translations are working again. ## [0.4.0] - 2018-05-03 ### Features - Basic member list - Basic room settings menu - Support for displaying stickers - Fuzzy search for rooms ### Improvements - Cache refactoring (reduced memory consumption) - Implement media cache (faster avatar loading) - Show room tooltips when the sidebar is collapsed - Flicker-free auto-completion menus (rooms, users) - Improved message spacing in the timeline - Improved macOS installer - Fancier date separator widget - Minor popup improvements ### Bug fixes - Fix UI inconsistencies between room list & communities - Adjust popup completion menu to fit its contents - Fix stuck typing notifications - Handle invalid access tokens ## [0.3.1] - 2018-04-13 ### Improvements - The auto-completion menu can be navigated with TAB. (#294 ) ### Bug fixes - Show auto-completion menu even if there are fewer than the max number of matches (#294) - Hide emoji panel when it's not under the mouse cursor. (#254, #246) ## [0.3.0] - 2018-04-03 ### Features - Add auto-completion pop-up for usernames (triggered with @). (#40) - Add ability to redact messages. - Add context menu option to save images. (#265) - Pin invites to the top of the room list. (#252) - Add environment variable to allow insecure connections (e.g self-signed certs) (#260) ### Improvements - Updated dark theme. - Add border in community list. - Add version & build info in the settings menu. - Easier packaging by allowing to use already built dependencies. ### Bug fixes - Fix invite unreadable button colors on the system theme. (#248) - Track invites so they can be removed from other clients. (#213) - Fix text color on the room switcher. (#245) ## [0.2.1] - 2018-03-13 ### Features - Implement user registration with reCAPTCHA - Add context menu option to mark events individually as read ### Bug fixes - Update room name & avatar on newly created rooms - Fix image uploading that was causing other image items to render its content ## [0.2.0] - 2018-03-05 ### Features - Support for pasting media & files into a room (#180) - Server-side message & mention notifications - Two new commands (`/fliptable`, `/shrug`) - Option to disable typing notifications - Check-mark to messages that have been received by the server (#93) - Basic communities support (#195) - Read receipt support - Re-ordering of rooms based on activity ### Improvements - Automatically focus on input when opening a dialog - Keep syncing regardless of connectivity (#93) - Create widgets on demand for messages added to the end of the timeline - Messages received by `/messages` will be rendered upon entering the room - Load last content from all rooms - Load the initial cache data without blocking the UI ### Bug fixes - Messages will be visible in the side bar after initial sync - Enable room switcher only in the chat view (#251) - Retry initial sync forever (#234) - Show loading indicator while waiting for `/login` & `/logout` - Disable minimize to tray except for the chat view. - Fixed transparency issue on custom dialogs (#87) - Fixed crash when there weren't any rooms ## [0.1.0] - 2017-12-26 The first release providing the basic features to make use of the Matrix network. nheko-0.11.3/CMakeLists.txt000066400000000000000000000606101437552512500154540ustar00rootroot00000000000000cmake_minimum_required(VERSION 3.13) option(APPVEYOR_BUILD "Build on appveyor" OFF) option(CI_BUILD "Set when building in CI. Enables -Werror where possible" OFF) option(ASAN "Compile with address sanitizers" OFF) option(QML_DEBUGGING "Enable qml debugging" OFF) option(COMPILE_QML "Compile Qml. It will make Nheko faster, but you will need to recompile it, when you update Qt." OFF) if(UNIX AND NOT APPLE) option(MAN "Build man page" ON) else() option(MAN "Build man page" OFF) endif() option(FLATPAK "Set this only if Nheko is built as a flatpak" OFF) option(JSON_ImplicitConversions "Disable implicit conversions in nlohmann/json" ON) set( CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_LIST_DIR}/toolchain.cmake" CACHE FILEPATH "Default toolchain" ) set(CMAKE_CXX_STANDARD 20 CACHE STRING "C++ standard") set(CMAKE_CXX_STANDARD_REQUIRED ON CACHE BOOL "Require C++ standard to be supported") set(CMAKE_POSITION_INDEPENDENT_CODE ON CACHE BOOL "compile as PIC by default") option(HUNTER_ENABLED "Enable Hunter package manager" OFF) include("cmake/HunterGate.cmake") HunterGate( URL "https://github.com/cpp-pm/hunter/archive/v0.24.8.tar.gz" SHA1 "ca7838dded9a1811b04ffd56175f629e0af82d3d" LOCAL ) macro(hunter_add_package_safe) set(pkg_temp_backup_libdir "$ENV{PKG_CONFIG_LIBDIR}") set(pkg_temp_backup_path "$ENV{PKG_CONFIG_PATH}") hunter_add_package(${ARGV}) if("${pkg_temp_backup_path}" STREQUAL "") unset(ENV{PKG_CONFIG_PATH}) else() set(ENV{PKG_CONFIG_PATH} "${pkg_temp_backup_path}") endif() if("${pkg_temp_backup_libdir}" STREQUAL "") unset(ENV{PKG_CONFIG_LIBDIR}) else() set(ENV{PKG_CONFIG_LIBDIR} "${pkg_temp_backup_libdir}") endif() message("pkg_conf_path: '$ENV{PKG_CONFIG_PATH}', pkg_conf_libdir: '$ENV{PKG_CONFIG_LIBDIR}'") endmacro() option(USE_BUNDLED_SPDLOG "Use the bundled version of spdlog." ${HUNTER_ENABLED}) option(USE_BUNDLED_OLM "Use the bundled version of libolm." ${HUNTER_ENABLED}) option(USE_BUNDLED_GTEST "Use the bundled version of Google Test." ${HUNTER_ENABLED}) option(USE_BUNDLED_CMARK "Use the bundled version of cmark." ${HUNTER_ENABLED}) option(USE_BUNDLED_JSON "Use the bundled version of nlohmann json." ${HUNTER_ENABLED}) option(USE_BUNDLED_OPENSSL "Use the bundled version of OpenSSL." OFF) option(USE_BUNDLED_MTXCLIENT "Use the bundled version of the Matrix Client library." ${HUNTER_ENABLED}) option(USE_BUNDLED_LMDB "Use the bundled version of lmdb." ${HUNTER_ENABLED}) option(USE_BUNDLED_LMDBXX "Use the bundled version of lmdb++." ${HUNTER_ENABLED}) option(USE_BUNDLED_QTKEYCHAIN "Use the bundled version of Qt5Keychain." ${HUNTER_ENABLED}) option(USE_BUNDLED_COEURL "Use a bundled version of the Curl wrapper" ${HUNTER_ENABLED}) option(USE_BUNDLED_LIBEVENT "Use the bundled version of libevent." ${HUNTER_ENABLED}) option(USE_BUNDLED_LIBCURL "Use the bundled version of libcurl." ${HUNTER_ENABLED}) option(USE_BUNDLED_RE2 "Use the bundled version of re2." ${HUNTER_ENABLED}) option(USE_BUNDLED_CPPHTTPLIB "Use the bundled version of cpp-httplib." ON) option(USE_BUNDLED_BLURHASH "Use the bundled version of blurhash." ON) include(CMakeDependentOption) set(VOIP_DEFAULT ON) if (APPLE OR WIN32) set(VOIP_DEFAULT OFF) endif() option(VOIP "Whether to enable voip support. Disable this, if you don't have gstreamer." ${VOIP_DEFAULT}) cmake_dependent_option(SCREENSHARE_X11 "Whether to enable screenshare support on X11." ON "VOIP" OFF) list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake") if(${CMAKE_VERSION} VERSION_LESS "3.14.0") message("Adding FetchContent_MakeAvailable") # from cmakes sources macro(FetchContent_MakeAvailable) foreach(contentName IN ITEMS ${ARGV}) string(TOLOWER ${contentName} contentNameLower) FetchContent_GetProperties(${contentName}) if(NOT ${contentNameLower}_POPULATED) FetchContent_Populate(${contentName}) # Only try to call add_subdirectory() if the populated content # can be treated that way. Protecting the call with the check # allows this function to be used for projects that just want # to ensure the content exists, such as to provide content at # a known location. if(EXISTS ${${contentNameLower}_SOURCE_DIR}/CMakeLists.txt) add_subdirectory(${${contentNameLower}_SOURCE_DIR} ${${contentNameLower}_BINARY_DIR}) endif() endif() endforeach() endmacro() endif() # Include Qt basic functions include(QtCommon) project(nheko LANGUAGES CXX C) include(GNUInstallDirs) set(CPACK_PACKAGE_VERSION_MAJOR "0") set(CPACK_PACKAGE_VERSION_MINOR "11") set(CPACK_PACKAGE_VERSION_PATCH "3") set(PROJECT_VERSION_MAJOR ${CPACK_PACKAGE_VERSION_MAJOR}) set(PROJECT_VERSION_MINOR ${CPACK_PACKAGE_VERSION_MINOR}) set(PROJECT_VERSION_PATCH ${CPACK_PACKAGE_VERSION_PATCH}) # Set PROJECT_VERSION_PATCH & PROJECT_VERSION_TWEAK to 0 if not present # Needed by add_project_meta. fix_project_version() # Set additional project information set(COMPANY "Nheko") set(COPYRIGHT "Copyright (c) 2023 Nheko Contributors") set(IDENTIFIER "io.github.nheko-reborn.nheko") add_project_meta(META_FILES_TO_INCLUDE) if(NOT MSVC AND NOT APPLE) set(THREADS_PREFER_PTHREAD_FLAG ON) find_package(Threads REQUIRED) endif() if (BUILD_DOCS) find_package(Doxygen) if (DOXYGEN_FOUND) set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Doxyfile.in) set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT}) add_custom_target(docs ALL COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM ) else (DOXYGEN_FOUND) message("Doxygen need to be installed to generate the doxygen documentation") endif (DOXYGEN_FOUND) endif() # ## coeurl # ## Need to repeat all libevent deps?!? if (USE_BUNDLED_LIBEVENT) hunter_add_package_safe(Libevent) find_package(Libevent CONFIG REQUIRED) else() find_package(PkgConfig REQUIRED) pkg_check_modules(libevent_core REQUIRED IMPORTED_TARGET libevent_core) if (WIN32) pkg_check_modules(libevent_windows REQUIRED IMPORTED_TARGET libevent_windows) else() pkg_check_modules(libevent_pthreads REQUIRED IMPORTED_TARGET libevent_pthreads) endif() endif() # curl if (USE_BUNDLED_LIBCURL) hunter_add_package_safe(CURL) find_package(CURL CONFIG REQUIRED) else() find_package(PkgConfig REQUIRED) pkg_check_modules(libcurl REQUIRED IMPORTED_TARGET libcurl) endif() # spdlog if(USE_BUNDLED_SPDLOG) hunter_add_package_safe(spdlog) endif() find_package(spdlog 1.0.0 CONFIG REQUIRED) if(USE_BUNDLED_COEURL) include(FetchContent) FetchContent_Declare( coeurl GIT_REPOSITORY https://nheko.im/Nheko-Reborn/coeurl.git GIT_TAG v0.3.0 ) FetchContent_MakeAvailable(coeurl) set(COEURL_TARGET_NAME coeurl::coeurl) else() find_package(PkgConfig) pkg_check_modules(coeurl IMPORTED_TARGET coeurl>=0.3.0) if (TARGET PkgConfig::coeurl) set(COEURL_TARGET_NAME PkgConfig::coeurl) endif() endif() if(NOT TARGET PkgConfig::coeurl) find_package(coeurl 0.2.1 CONFIG) if (TARGET coeurl::coeurl) set(COEURL_TARGET_NAME coeurl::coeurl) endif() endif() if (NOT COEURL_TARGET_NAME) message(ERROR "Couldn't find coeurl") endif() if(USE_BUNDLED_RE2) hunter_add_package(re2) find_package(re2 CONFIG REQUIRED) else() find_package(PkgConfig REQUIRED) pkg_check_modules(re2 REQUIRED IMPORTED_TARGET re2) endif() # # LMDB # #include(LMDB) if(USE_BUNDLED_LMDB) hunter_add_package_safe(lmdb) find_package(liblmdb CONFIG REQUIRED) target_include_directories(liblmdb::lmdb INTERFACE "${HUNTER_INSTALL_PREFIX}/include/lmdb") else() find_package(LMDB REQUIRED) endif() # # Discover Qt dependencies. # find_package(Qt5 5.15 COMPONENTS Core Widgets LinguistTools Concurrent Svg Multimedia Qml QuickControls2 QuickWidgets REQUIRED) find_package(Qt5QuickCompiler) find_package(Qt5DBus) if (USE_BUNDLED_QTKEYCHAIN) include(FetchContent) FetchContent_Declare( qt5keychain GIT_REPOSITORY https://github.com/frankosterfeld/qtkeychain.git GIT_TAG v0.13.1 ) if (BUILD_SHARED_LIBS) set(QTKEYCHAIN_STATIC OFF CACHE INTERNAL "") else() set(QTKEYCHAIN_STATIC ON CACHE INTERNAL "") endif() set(BUILD_TEST_APPLICATION OFF CACHE INTERNAL "") FetchContent_MakeAvailable(qt5keychain) else() find_package(Qt5Keychain REQUIRED) endif() if (APPLE) find_package(Qt5MacExtras REQUIRED) endif(APPLE) if (Qt5Widgets_FOUND) if (Qt5Widgets_VERSION VERSION_LESS 5.15.0) message(STATUS "Qt version ${Qt5Widgets_VERSION}") message(WARNING "Minimum supported Qt5 version is 5.15!") endif() endif(Qt5Widgets_FOUND) set(CMAKE_INCLUDE_CURRENT_DIR ON) if(NOT MSVC) set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} \ -Wall \ -Wextra \ -pedantic \ -fsized-deallocation \ -fdiagnostics-color=always \ -Wunreachable-code \ -Wno-attributes" ) if (NOT CMAKE_COMPILER_IS_GNUCXX) # -Wshadow is buggy and broken in GCC, so do not enable it. # see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=79328 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wshadow") endif() endif() if (MSVC) set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /bigobj" ) endif() if(NOT (CMAKE_BUILD_TYPE OR CMAKE_CONFIGURATION_TYPES)) set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE) message("Setting build type to '${CMAKE_BUILD_TYPE}'") else(NOT (CMAKE_BUILD_TYPE OR CMAKE_CONFIGURATION_TYPES)) message("Build type set to '${CMAKE_BUILD_TYPE}'") endif(NOT (CMAKE_BUILD_TYPE OR CMAKE_CONFIGURATION_TYPES)) set(SPDLOG_DEBUG_ON false) # Windows doesn't handle CMAKE_BUILD_TYPE. if(NOT WIN32) if(CMAKE_BUILD_TYPE STREQUAL "Debug") set(SPDLOG_DEBUG_ON true) else() set(SPDLOG_DEBUG_ON false) endif() endif() find_program(GIT git) if(GIT) execute_process( WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} COMMAND ${GIT} rev-parse --short HEAD OUTPUT_VARIABLE GIT_OUT OUTPUT_STRIP_TRAILING_WHITESPACE ) if(GIT_OUT) set(CPACK_PACKAGE_VERSION_PATCH "${CPACK_PACKAGE_VERSION_PATCH}-${GIT_OUT}") else() set(CPACK_PACKAGE_VERSION_PATCH "${CPACK_PACKAGE_VERSION_PATCH}") endif() endif(GIT) set(CPACK_PACKAGE_VERSION ${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}) set(PROJECT_VERSION ${CPACK_PACKAGE_VERSION}) message(STATUS "Version: ${PROJECT_VERSION}") cmake_host_system_information(RESULT BUILD_HOST QUERY HOSTNAME) include(CheckSymbolExists) check_symbol_exists(backtrace_symbols_fd "execinfo.h" HAVE_BACKTRACE_SYMBOLS_FD) configure_file(cmake/nheko.h config/nheko.h) # # Declare source and header files. # set(SRC_FILES # Dialogs src/dialogs/FallbackAuth.cpp src/dialogs/FallbackAuth.h src/dialogs/ReCaptcha.cpp src/dialogs/ReCaptcha.h # Emoji src/emoji/EmojiModel.cpp src/emoji/EmojiModel.h src/emoji/Provider.cpp src/emoji/Provider.h # Timeline src/timeline/CommunitiesModel.cpp src/timeline/CommunitiesModel.h src/timeline/DelegateChooser.cpp src/timeline/DelegateChooser.h src/timeline/EventStore.cpp src/timeline/EventStore.h src/timeline/InputBar.cpp src/timeline/InputBar.h src/timeline/Permissions.cpp src/timeline/Permissions.h src/timeline/PresenceEmitter.cpp src/timeline/PresenceEmitter.h src/timeline/Reaction.cpp src/timeline/Reaction.h src/timeline/RoomlistModel.cpp src/timeline/RoomlistModel.h src/timeline/TimelineFilter.cpp src/timeline/TimelineFilter.h src/timeline/TimelineModel.cpp src/timeline/TimelineModel.h src/timeline/TimelineViewManager.cpp src/timeline/TimelineViewManager.h # UI components src/ui/HiddenEvents.cpp src/ui/HiddenEvents.h src/ui/MxcAnimatedImage.cpp src/ui/MxcAnimatedImage.h src/ui/MxcMediaProxy.cpp src/ui/MxcMediaProxy.h src/ui/NhekoCursorShape.cpp src/ui/NhekoCursorShape.h src/ui/NhekoDropArea.cpp src/ui/NhekoDropArea.h src/ui/NhekoEventObserver.cpp src/ui/NhekoEventObserver.h src/ui/NhekoGlobalObject.cpp src/ui/NhekoGlobalObject.h src/ui/RoomSettings.cpp src/ui/RoomSettings.h src/ui/RoomSummary.cpp src/ui/RoomSummary.h src/ui/Theme.cpp src/ui/Theme.h src/ui/UIA.cpp src/ui/UIA.h src/ui/UserProfile.cpp src/ui/UserProfile.h src/voip/CallDevices.cpp src/voip/CallDevices.h src/voip/CallManager.cpp src/voip/CallManager.h src/voip/WebRTCSession.cpp src/voip/WebRTCSession.h src/encryption/DeviceVerificationFlow.cpp src/encryption/DeviceVerificationFlow.h src/encryption/Olm.cpp src/encryption/Olm.h src/encryption/SelfVerificationStatus.cpp src/encryption/SelfVerificationStatus.h src/encryption/VerificationManager.cpp src/encryption/VerificationManager.h # Generic notification stuff src/notifications/Manager.cpp src/notifications/Manager.h src/dock/Dock.cpp src/dock/Dock.h src/AliasEditModel.cpp src/AliasEditModel.h src/AvatarProvider.cpp src/AvatarProvider.h src/BlurhashProvider.cpp src/BlurhashProvider.h src/Cache.cpp src/Cache.h src/CacheCryptoStructs.h src/CacheStructs.h src/Cache_p.h src/ChatPage.cpp src/ChatPage.h src/Clipboard.cpp src/Clipboard.h src/ColorImageProvider.cpp src/ColorImageProvider.h src/CombinedImagePackModel.cpp src/CombinedImagePackModel.h src/CommandCompleter.cpp src/CommandCompleter.h src/CompletionModelRoles.h src/CompletionProxyModel.cpp src/CompletionProxyModel.h src/Config.h src/EventAccessors.cpp src/EventAccessors.h src/ImagePackListModel.cpp src/ImagePackListModel.h src/InviteesModel.cpp src/InviteesModel.h src/JdenticonProvider.cpp src/JdenticonProvider.h src/Logging.cpp src/Logging.h src/LoginPage.cpp src/LoginPage.h src/MainWindow.cpp src/MainWindow.h src/MatrixClient.cpp src/MatrixClient.h src/MemberList.cpp src/MemberList.h src/MxcImageProvider.cpp src/MxcImageProvider.h src/PowerlevelsEditModels.cpp src/PowerlevelsEditModels.h src/ReadReceiptsModel.cpp src/ReadReceiptsModel.h src/RegisterPage.cpp src/RegisterPage.h src/RoomDirectoryModel.cpp src/RoomDirectoryModel.h src/RoomsModel.cpp src/RoomsModel.h src/SSOHandler.cpp src/SSOHandler.h src/SingleImagePackModel.cpp src/SingleImagePackModel.h src/TrayIcon.cpp src/TrayIcon.h src/UserDirectoryModel.cpp src/UserDirectoryModel.h src/UserSettingsPage.cpp src/UserSettingsPage.h src/UsersModel.cpp src/UsersModel.h src/Utils.cpp src/Utils.h includes/jdenticoninterface.h src/main.cpp ) include(FeatureSummary) if(USE_BUNDLED_OPENSSL) hunter_add_package_safe(OpenSSL) endif() find_package(OpenSSL 1.1.0 REQUIRED) if(USE_BUNDLED_OLM) include(FetchContent) FetchContent_Declare( Olm GIT_REPOSITORY https://gitlab.matrix.org/matrix-org/olm.git GIT_TAG 3.2.12 ) set(OLM_TESTS OFF CACHE INTERNAL "") FetchContent_MakeAvailable(Olm) else() find_package(Olm 3.2.7 REQUIRED) set_package_properties(Olm PROPERTIES DESCRIPTION "An implementation of the Double Ratchet cryptographic ratchet" URL "https://git.matrix.org/git/olm/about/" TYPE REQUIRED ) endif() if(USE_BUNDLED_SPDLOG) hunter_add_package_safe(spdlog) endif() find_package(spdlog 1.0.0 CONFIG REQUIRED) if(USE_BUNDLED_CMARK) include(FetchContent) FetchContent_Declare( cmark GIT_REPOSITORY https://github.com/commonmark/cmark.git GIT_TAG 0.30.2 CMAKE_ARGS "CMARK_STATIC=ON CMARK_SHARED=OFF CMARK_TESTS=OFF CMARK_TESTS=OFF" ) FetchContent_MakeAvailable(cmark) if (MSVC) add_library(cmark::cmark ALIAS cmark) else() add_library(cmark::cmark ALIAS cmark_static) endif() else() find_package(cmark REQUIRED 0.29.0) endif() if(USE_BUNDLED_JSON) hunter_add_package_safe(nlohmann_json) endif() find_package(nlohmann_json 3.2.0) set_package_properties(nlohmann_json PROPERTIES DESCRIPTION "JSON for Modern C++, a C++11 header-only JSON class" URL "https://nlohmann.github.io/json/" TYPE REQUIRED ) if(USE_BUNDLED_LMDBXX) include(FetchContent) FetchContent_Declare( lmdbxx URL "https://raw.githubusercontent.com/hoytech/lmdbxx/1.0.0/lmdb++.h" DOWNLOAD_NO_EXTRACT TRUE CONFIGURE_COMMAND "" BUILD_COMMAND "" ) FetchContent_Populate(lmdbxx) add_library(lmdbxx INTERFACE) target_include_directories(lmdbxx INTERFACE ${lmdbxx_SOURCE_DIR}) add_library(lmdbxx::lmdbxx ALIAS lmdbxx) else() if(NOT LMDBXX_INCLUDE_DIR) find_path(LMDBXX_INCLUDE_DIR NAMES lmdb++.h PATHS /usr/include /usr/local/include $ENV{LIB_DIR}/include $ENV{LIB_DIR}/include/lmdbxx) endif() add_library(lmdbxx INTERFACE) target_include_directories(lmdbxx INTERFACE ${LMDBXX_INCLUDE_DIR}) add_library(lmdbxx::lmdbxx ALIAS lmdbxx) endif() if(USE_BUNDLED_MTXCLIENT) include(FetchContent) FetchContent_Declare( MatrixClient GIT_REPOSITORY https://github.com/Nheko-Reborn/mtxclient.git GIT_TAG v0.9.2 ) set(BUILD_LIB_EXAMPLES OFF CACHE INTERNAL "") set(BUILD_LIB_TESTS OFF CACHE INTERNAL "") FetchContent_MakeAvailable(MatrixClient) else() find_package(MatrixClient 0.9.0 REQUIRED) endif() if (VOIP) include(FindPkgConfig) pkg_check_modules(GSTREAMER REQUIRED IMPORTED_TARGET gstreamer-sdp-1.0>=1.18 gstreamer-webrtc-1.0>=1.18) if (SCREENSHARE_X11 AND NOT WIN32 AND NOT APPLE) pkg_check_modules(XCB REQUIRED IMPORTED_TARGET xcb xcb-ewmh) endif() endif() # single instance functionality set(QAPPLICATION_CLASS QApplication CACHE STRING "Inheritance class for SingleApplication") add_subdirectory(third_party/SingleApplication-3.3.2/) feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES) # this must be defined here to make the moc work properly if (NOT APPLE AND NOT WIN32) add_compile_definitions(NHEKO_DBUS_SYS) endif() # # Bundle translations. # include(Translations) set(TRANSLATION_DEPS ${LANG_QRC} ${QRC} ${QM_SRC}) if (APPLE) set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -framework Foundation -framework Cocoa -framework UserNotifications") set(SRC_FILES ${SRC_FILES} src/notifications/NotificationManagerProxy.h src/notifications/MacNotificationDelegate.h src/notifications/MacNotificationDelegate.mm src/notifications/ManagerMac.mm src/notifications/ManagerMac.cpp src/emoji/MacHelper.mm src/emoji/MacHelper.h) if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.16.0") set_source_files_properties( src/notifications/NotificationManagerProxy.h src/notifications/MacNotificationDelegate.h src/notifications/MacNotificationDelegate.mm src/notifications/ManagerMac.mm src/emoji/MacHelper.mm src/emoji/MacHelper.h PROPERTIES SKIP_PRECOMPILE_HEADERS ON) endif() elseif (WIN32) file(DOWNLOAD "https://raw.githubusercontent.com/mohabouje/WinToast/41ed1c58d5dce0ee9c01dbdeac05be45358d4f57/src/wintoastlib.cpp" ${PROJECT_SOURCE_DIR}/src/wintoastlib.cpp EXPECTED_HASH SHA256=1A1A7CE41C1052B12946798F4A6C67CE1FAD209C967F5ED4D720B173527E2073) file(DOWNLOAD "https://raw.githubusercontent.com/mohabouje/WinToast/41ed1c58d5dce0ee9c01dbdeac05be45358d4f57/src/wintoastlib.h" ${PROJECT_SOURCE_DIR}/src/wintoastlib.h EXPECTED_HASH SHA256=b4481023c5782733795838be22bf1a75f45d87458cd4d9a5a75f664a146eea11) set(SRC_FILES ${SRC_FILES} src/notifications/ManagerWin.cpp src/wintoastlib.cpp src/wintoastlib.h) else () set(SRC_FILES ${SRC_FILES} src/dbus/NhekoDBusApi.h src/dbus/NhekoDBusBackend.h src/dbus/NhekoDBusApi.cpp src/dbus/NhekoDBusBackend.cpp src/notifications/ManagerLinux.cpp ) endif () set(NHEKO_DEPS ${SRC_FILES} ${TRANSLATION_DEPS} ${META_FILES_TO_INCLUDE}) if(ASAN) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address,undefined") endif() if(WIN32) add_executable (nheko WIN32 ${OS_BUNDLE} ${NHEKO_DEPS}) target_compile_definitions(nheko PRIVATE _WIN32_WINNT=0x0601 NOMINMAX WIN32_LEAN_AND_MEAN STRICT) else() add_executable (nheko ${OS_BUNDLE} ${NHEKO_DEPS}) if (HAVE_BACKTRACE_SYMBOLS_FD AND NOT CMAKE_BUILD_TYPE STREQUAL "Release") set_target_properties(nheko PROPERTIES ENABLE_EXPORTS ON) endif() endif() set_target_properties(nheko PROPERTIES CMAKE_SKIP_INSTALL_RPATH TRUE AUTOMOC ON) if(APPLE) target_link_libraries (nheko PRIVATE Qt5::MacExtras) elseif(WIN32) target_compile_definitions(nheko PRIVATE WIN32_LEAN_AND_MEAN) target_link_libraries (nheko PRIVATE ${NTDLIB} Qt5::WinMain) if(MSVC) target_compile_options(nheko PUBLIC "/Zc:__cplusplus") endif() else() target_link_libraries (nheko PRIVATE Qt5::DBus) if (FLATPAK) target_compile_definitions(nheko PRIVATE NHEKO_FLATPAK) endif() endif() target_include_directories(nheko PRIVATE src includes) if (USE_BUNDLED_CPPHTTPLIB) target_include_directories(nheko PRIVATE third_party/cpp-httplib-0.5.12) target_sources(nheko PRIVATE third_party/cpp-httplib-0.5.12/httplib.h) else() find_package(httplib REQUIRED) target_link_libraries(nheko PRIVATE httplib::httplib) endif() if (USE_BUNDLED_BLURHASH) target_include_directories(nheko PRIVATE third_party/blurhash) set(BLURHASH_SRC_FILES third_party/blurhash/blurhash.cpp third_party/blurhash/blurhash.hpp ) target_sources(nheko PRIVATE ${BLURHASH_SRC_FILES}) else() find_package(PkgConfig REQUIRED) pkg_check_modules(blurhash REQUIRED IMPORTED_TARGET blurhash) target_link_libraries(nheko PRIVATE PkgConfig::blurhash) endif() # Fixup bundled keychain include dirs if (USE_BUNDLED_QTKEYCHAIN) target_include_directories(nheko PRIVATE ${qt5keychain_SOURCE_DIR} ${qt5keychain_BINARY_DIR}) endif() if (NOT JSON_ImplicitConversions) set_target_properties(nlohmann_json::nlohmann_json PROPERTIES INTERFACE_COMPILE_DEFINITIONS "JSON_USE_IMPLICIT_CONVERSIONS=\$;JSON_DIAGNOSTICS=\$" ) target_compile_definitions(nheko PUBLIC JSON_USE_IMPLICIT_CONVERSIONS=0) endif() target_link_libraries(nheko PRIVATE ${COEURL_TARGET_NAME} MatrixClient::MatrixClient cmark::cmark spdlog::spdlog Qt5::Widgets Qt5::Svg Qt5::Concurrent Qt5::Multimedia Qt5::Qml Qt5::QuickControls2 Qt5::QuickWidgets qt5keychain nlohmann_json::nlohmann_json lmdbxx::lmdbxx liblmdb::lmdb SingleApplication::SingleApplication) if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.16.0") target_precompile_headers(nheko PRIVATE ) endif() if (TARGET PkgConfig::GSTREAMER) target_link_libraries(nheko PRIVATE PkgConfig::GSTREAMER) target_compile_definitions(nheko PRIVATE GSTREAMER_AVAILABLE) if (TARGET PkgConfig::XCB) target_link_libraries(nheko PRIVATE PkgConfig::XCB) target_compile_definitions(nheko PRIVATE XCB_AVAILABLE) endif() endif() if(MSVC) target_link_libraries(nheko PRIVATE ntdll) endif() if(QML_DEBUGGING) target_compile_definitions(nheko PRIVATE QML_DEBUGGING) endif() if(NOT MSVC AND NOT HAIKU) if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug" OR CI_BUILD) target_compile_options(nheko PRIVATE "-Werror") endif() endif() #if(NOT MSVC) # target_link_options(nheko PRIVATE "LINKER:,--gc-sections") #endif() if(MAN) add_subdirectory(man) endif() if(UNIX AND NOT APPLE) if(FLATPAK) set(APPID "io.github.NhekoReborn.Nheko") set_target_properties(nheko PROPERTIES OUTPUT_NAME "${APPID}") else() set(APPID "nheko") endif() install (TARGETS nheko RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}") install (FILES "resources/nheko-16.png" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/16x16/apps" RENAME "${APPID}.png") install (FILES "resources/nheko-32.png" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/32x32/apps" RENAME "${APPID}.png") install (FILES "resources/nheko-48.png" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/48x48/apps" RENAME "${APPID}.png") install (FILES "resources/nheko-64.png" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/64x64/apps" RENAME "${APPID}.png") install (FILES "resources/nheko-128.png" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/128x128/apps" RENAME "${APPID}.png") install (FILES "resources/nheko-256.png" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/256x256/apps" RENAME "${APPID}.png") install (FILES "resources/nheko-512.png" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/512x512/apps" RENAME "${APPID}.png") install (FILES "resources/nheko.svg" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/apps" RENAME "${APPID}.svg") install (FILES "resources/_nheko" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/zsh/site-functions") configure_file("resources/nheko.desktop.in" "resources/nheko.desktop" @ONLY) install (FILES "${CMAKE_CURRENT_BINARY_DIR}/resources/nheko.desktop" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/applications" RENAME "${APPID}.desktop") configure_file("resources/nheko.appdata.xml.in" "resources/nheko.appdata.xml" @ONLY) install (FILES "${CMAKE_CURRENT_BINARY_DIR}/resources/nheko.appdata.xml" DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/metainfo" RENAME "${APPID}.appdata.xml") if(NOT TARGET uninstall) configure_file( "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" IMMEDIATE @ONLY) add_custom_target(uninstall COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake) endif() endif() nheko-0.11.3/CMakeSettings.json000066400000000000000000000034611437552512500163110ustar00rootroot00000000000000{ "configurations": [ { "name": "Debug", "generator": "Visual Studio 16 2019 Win64", "configurationType": "Debug", "buildRoot": "${workspaceRoot}\\build-vc\\${name}", "cmakeCommandArgs": "", "variables": [ { "name": "HUNTER_ENABLED", "value": "OFF", "type": "BOOL" }, { "name": "BUILD_SHARED_LIBS", "value": "ON", "type": "BOOL" }, { "name": "CMAKE_INSTALL_PREFIX", "value": "${workspaceRoot}/.deps", "type": "STRING" }, { "name": "Qt5_DIR", "value": "C:\\Qt\\5.12.5\\msvc2017_64\\lib\\cmake\\Qt5", // <-- change qt location here "type": "STRING" } ], "cmakeToolchain": "${workspaceRoot}\\toolchain.cmake", "inheritEnvironments": [ "msvc_x64" ] }, { "name": "Release", "generator": "Visual Studio 16 2019 Win64", "configurationType": "Release", "buildRoot": "${workspaceRoot}\\build-vc\\${name}", "cmakeCommandArgs": "", "variables": [ { "name": "HUNTER_ENABLED", "value": "ON", "type": "BOOL" }, { "name": "BUILD_SHARED_LIBS", "value": "OFF", "type": "BOOL" }, { "name": "CMAKE_INSTALL_PREFIX", "value": "${workspaceRoot}/.deps", "type": "STRING" }, { "name": "Qt5_DIR", "value": "C:\\Qt\\5.12.5\\msvc2017_64\\lib\\cmake\\Qt5", // <-- change qt location here "type": "STRING" } ], "cmakeToolchain": "${workspaceRoot}\\toolchain.cmake", "inheritEnvironments": [ "msvc_x64" ] } ] }nheko-0.11.3/COPYING000066400000000000000000001045251437552512500137530ustar00rootroot00000000000000 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: {{ project }} Copyright (C) {{ year }} {{ organization }} 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 . nheko-0.11.3/Makefile000066400000000000000000000031301437552512500143460ustar00rootroot00000000000000DEPS_BUILD_DIR=.deps DEPS_SOURCE_DIR=deps debug: @cmake -H. -GNinja \ -Bbuild \ -DCMAKE_BUILD_TYPE=Debug \ -DCMAKE_EXPORT_COMPILE_COMMANDS=1 \ -DCMAKE_INSTALL_PREFIX=${DEPS_BUILD_DIR}/usr @cmake --build build third-party: @cmake -GNinja -H${DEPS_SOURCE_DIR} -B${DEPS_BUILD_DIR} \ -DCMAKE_BUILD_TYPE=Release \ -DUSE_BUNDLED_BOOST=OFF @cmake --build ${DEPS_BUILD_DIR} docker-third-party: @cmake -GNinja -H${DEPS_SOURCE_DIR} -B${DEPS_BUILD_DIR} -DCMAKE_BUILD_TYPE=Release @cmake --build ${DEPS_BUILD_DIR} ci: cmake -H${DEPS_SOURCE_DIR} -B${DEPS_BUILD_DIR} -DCMAKE_BUILD_TYPE=Release cmake --build ${DEPS_BUILD_DIR} cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=RelWithDebInfo cmake --build build release: @cmake -H. -GNinja \ -Bbuild \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=${DEPS_BUILD_DIR}/usr @cmake --build build linux-install: cp -f nheko*.AppImage ~/.local/bin macos-app-install: cp -Rf build/nheko.app /Applications lint: ./.ci/format.sh license: ./.ci/licenses.sh image: docker build -t nheko-app-image . linux-deploy: ./.ci/linux/deploy.sh macos-deploy: ./.ci/macos/deploy.sh docker-app-image: image docker run \ -e CXX=g++-5 \ -e CC=gcc-5 \ -v `pwd`:/build nheko-app-image make docker-third-party docker run \ -e CXX=g++-5 \ -e CC=gcc-5 \ -v `pwd`:/build nheko-app-image make release docker run \ --privileged \ -v `pwd`:/build nheko-app-image make linux-deploy update-translations: lupdate \ -locations relative \ -Iinclude/dialogs \ -Iinclude \ src/ resources/qml/ -ts resources/langs/nheko_*.ts -no-obsolete clean: rm -rf build nheko-0.11.3/README.md000066400000000000000000000420071437552512500141730ustar00rootroot00000000000000nheko ---- [![Build Status](https://nheko.im/nheko-reborn/nheko/badges/master/pipeline.svg)](https://nheko.im/nheko-reborn/nheko/-/pipelines/latest) [![Build status](https://ci.appveyor.com/api/projects/status/07qrqbfylsg4hw2h/branch/master?svg=true)](https://ci.appveyor.com/project/redsky17/nheko/branch/master) [![Stable Version](https://img.shields.io/badge/download-stable-green.svg)](https://github.com/Nheko-Reborn/nheko/releases/v0.8.2-RC) [![Nightly](https://img.shields.io/badge/download-nightly-green.svg)](https://matrix-static.neko.dev/room/!TshDrgpBNBDmfDeEGN:neko.dev/) Download Nightly Flatpak [![#nheko-reborn:matrix.org](https://img.shields.io/matrix/nheko-reborn:matrix.org.svg?label=%23nheko-reborn:matrix.org)](https://matrix.to/#/#nheko-reborn:matrix.org) [![AUR: nheko](https://img.shields.io/badge/AUR-nheko-blue.svg)](https://aur.archlinux.org/packages/nheko) Download on Flathub The motivation behind the project is to provide a native desktop app for [Matrix] that feels more like a mainstream chat app ([Element], Telegram etc) and less like an IRC client. ### Translations ### [![Translation status](http://weblate.nheko.im/widgets/nheko/-/nheko-master/svg-badge.svg)](http://weblate.nheko.im/engage/nheko/?utm_source=widget) Help us with translations so as many people as possible will be able to use nheko! ### Note regarding End-to-End encryption The current implementation is mostly stable, but it was never audited. If you rely on it for security, we can't make any guarantees. ## Features Most of the features you would expect from a chat application are missing right now but we are getting close to a more feature complete client. Specifically there is support for: - E2E encryption. - VoIP calls (voice & video). - User registration. - Creating, joining & leaving rooms. - Sending & receiving invites. - Sending & receiving files and emoji (inline widgets for images, audio and file messages). - Replies with text, images and other media (and actually render them as inline widgets). - Typing notifications. - Username auto-completion. - Message & mention notifications. - Redacting messages. - Read receipts. - Basic communities support. - Room switcher (ctrl-K). - Light, Dark & System themes. - Creating separate profiles (command line only, use `-p name`). - D-Bus API to allow integration with third-party plugins (does not support Windows or macOS). ## Installation ### Releases Releases for Linux (AppImage), macOS (disk image) & Windows (x64 installer) can be found in the [GitHub releases](https://github.com/Nheko-Reborn/nheko/releases). ### Repositories [![Packaging status](https://repology.org/badge/tiny-repos/nheko.svg)](https://repology.org/project/nheko/versions) #### Arch Linux ```bash pacaur -S nheko # nheko-git ``` Nheko requires a secret server to run, so you'll need to install and configure a service such as [KDE Wallet](https://wiki.archlinux.org/title/KDE_Wallet) or [GNOME Keyring](https://wiki.archlinux.org/title/GNOME/Keyring) if not provided by your desktop environment. Binary releases of the stable builds are available (using [Open Build Service](https://build.opensuse.org/)). To add this [unofficial repository](https://wiki.archlinux.org/title/Unofficial_user_repositories), execute the following block after reviewing the [PKGBUILD and service files](https://build.opensuse.org/package/show/home:digital_mystik:AUR/nheko): ``` curl -s 'https://download.opensuse.org/repositories/home:/digital_mystik:/AUR/Arch/x86_64/home_digital_mystik_AUR_Arch.key' | sudo pacman-key -a - && sudo pacman-key --lsign-key 4D41B287F3ABC4B8 echo ' [home_digital_mystik_AUR_Arch] Server = https://download.opensuse.org/repositories/home:/digital_mystik:/AUR/Arch/x86_64/' | sudo tee --append /etc/pacman.conf sudo pacman -Syu nheko ``` This imports the repository's public PGP key and locally signs it, adds the pertinent entry to `/etc/pacman.conf`, and installs nheko after updating the databases/system; one can now treat nheko as a typical package. To undo these changes, delete the repository entry from `/etc/pacman.conf`, and remove the public signing key with `sudo pacman-key -d 4D41B287F3ABC4B8`. #### Debian (10 and above) / Ubuntu (18.04 and above) ```bash sudo apt install nheko ``` #### Fedora ```bash sudo dnf install nheko ``` #### Gentoo Linux ```bash sudo eselect repository enable guru sudo emaint sync -r guru sudo emerge -a nheko ``` If you are using Gnome Keyring or KeepassXC as your secrets daemon, ensure that the `gnome-keyring` useflag is enabled on `dev-libs/qtkeychain`. #### Mageia (9 and above) ```bash sudo urpmi nheko ``` #### Nix(os) ```bash nix-env -iA nixpkgs.nheko # or nix-shell -p nheko --run nheko ``` #### Alpine Linux (and postmarketOS) Make sure you have the testing repositories from `edge` enabled. Note that this is not needed on postmarketOS. ```sh sudo apk add nheko ``` #### openSUSE Note: these instructions have only been tested on Tumbleweed. First, install nheko: ```bash sudo zypper addrepo https://download.opensuse.org/repositories/network:messaging:matrix/openSUSE_Tumbleweed/network:messaging:matrix.repo sudo zypper ref sudo zypper in nheko ``` If you want to add jdenticon support: ```bash sudo zypper install qt-jdenticon ``` #### Flatpak ``` flatpak install flathub io.github.NhekoReborn.Nheko ``` #### Guix ``` guix install nheko ``` #### Steam Deck Install nheko via the `Discover` app in Desktop Mode (this installs the flatpak). To also make it work in Game Mode you'll have create a wrapper script that starts kwalletd and then nheko. You can create `/home/deck/nheko.sh` with the following content and then add this script as a "Non-Steam Game" to Steam. ```bash #!/bin/sh kwalletd5& flatpak run --env=XDG_CURRENT_DESKTOP=KDE --env=KDE_SESSION_VERSION=5 --branch=stable --arch=x86_64 --command=io.github.NhekoReborn.Nheko --file-forwarding io.github.NhekoReborn.Nheko @@u @@ ``` #### macOS (10.14 and above) with [homebrew](https://brew.sh/): ```sh brew install --cask nheko ``` #### Windows with [Chocolatey](https://chocolatey.org/): ```posh choco install nheko-reborn ``` #### D-Bus plugins nheko does not provide binaries for any D-Bus plugins. However, we do provide the following list of known plugins: - [nheko-krunner](https://github.com/LorenDB/nheko-krunner) - [rofi-nheko](https://mzte.de/git/LordMZTE/rofi-nheko) ### FAQ --- **Q:** Why don't videos run for me on Windows? **A:** You're probably missing the required video codecs, download [K-Lite Codec Pack](https://codecguide.com/download_kl.htm). --- **Q:** What commands are supported by nheko? **A:** See --- **Q:** Does nheko support end-to-end encryption (EE2E)? **A:** Yes, see [feature list](#features) --- **Q:** Can I test a bleeding edge development version? **A:** Checkout nightly builds --- **Q:** How do I add stickers and custom emojis? **A:** Stickers and custom emojis are organized in image packs. There is one user image pack that only your account has access to and there are room image packs that are accessible by everyone in the room they are defined in. You can activate a room image pack globally to use it in any room. To manage image packs in nheko, go to the room settings and enter the Sticker & Emote Settings. You will see the Private pack (your user image pack) and can edit it there. The Shortcode is a unique identifier you use to select the image with and the Body is the alternate text that is displayed on clients that don't support images (like the alt tag in HTML images). If you have the necessary permissions you can create new room packs with the button at the bottom of the image pack list. They are the same as the user pack but you can create as many as you want and everyone in the room can use them. It might be a good idea to create an extra room just for your image packs to make sharing easier. --- **Q:** I can't see some image types! **A:** Nheko uses Qt's image plugins to render images. You might need to install additional packages to display some image types like webp. Usually those packages are called `qt5-image-formats-plugins`, `qt5-imageformats` or similar. KDE has similar plugins, that can extend the supported image types even more. --- ### Build Requirements - Qt5 (5.15 or greater). Required for overlapping hover handlers in Qml. - CMake 3.15 or greater. (Lower version may work, but may break boost linking) - [mtxclient](https://github.com/Nheko-Reborn/mtxclient) - [coeurl](https://nheko.im/nheko-reborn/coeurl) - [LMDB](https://symas.com/lightning-memory-mapped-database/) - [lmdb++](https://github.com/hoytech/lmdbxx) (0.9.14 too old) - [cmark](https://github.com/commonmark/cmark) 0.29 or greater. - [libolm](https://gitlab.matrix.org/matrix-org/olm) - [spdlog](https://github.com/gabime/spdlog) (1.8.1 too old) - [GStreamer](https://gitlab.freedesktop.org/gstreamer) 1.18.0 or greater (optional, needed for VoIP support. Pass `-DVOIP=OFF` to disable.). - Installing the gstreamer core library plus gst-plugins-base, gst-plugins-good & gst-plugins-bad is often sufficient. The qmlgl plugin though is often packaged separately. The actual plugin requirements are as follows: - Voice call support: dtls, opus, rtpmanager, srtp, webrtc - Video call support (optional): compositor, opengl, qmlgl, rtp, vpx - [libnice](https://gitlab.freedesktop.org/libnice/libnice) - XCB, XCB-EWMH: For screensharing support on X11. VOIP needs to be enabled. Can be disabled with `-DSCREENSHARE_X11=OFF`. - [qtkeychain](https://github.com/frankosterfeld/qtkeychain) (You need at least version 0.12 for proper Gnome Keychain support. The bundled version requires libsecret, unless you pass `-DLIBSECRET_SUPPORT=OFF`.) - A compiler that supports C++ 20: - Clang 11 (Only clazy 13 is tested in CI) - GCC 10 (tested on Gitlab CI) - MSVC 19.13 (tested on AppVeyor) Nheko can use bundled version for most of those libraries automatically, if the versions in your distro are too old. To use them, you can enable the hunter integration by passing `-DHUNTER_ENABLED=ON`. It is probably wise to link those dependencies statically by passing `-DBUILD_SHARED_LIBS=OFF` You can select which bundled dependencies you want to use by passing various `-DUSE_BUNDLED_*` flags. By default all dependencies are bundled *if* you enable hunter. (The exception to that is OpenSSL, which is always disabled by default.) If you experience build issues and you are trying to link `mtxclient` library without hunter, make sure the library version(commit) as mentioned in the `CMakeList.txt` is used. Sometimes we have to make breaking changes in `mtxclient` and for that period the master branch of both repos may not be compatible. The bundle flags are currently: - USE_BUNDLED_SPDLOG - USE_BUNDLED_OLM - USE_BUNDLED_GTEST - USE_BUNDLED_CMARK - USE_BUNDLED_JSON - USE_BUNDLED_OPENSSL - USE_BUNDLED_MTXCLIENT - USE_BUNDLED_LMDB - USE_BUNDLED_LMDBXX - USE_BUNDLED_COEURL - USE_BUNDLED_LIBCURL - USE_BUNDLED_LIBEVENT A note on bundled OpenSSL: You need to explicitly enable it and it will not be using your system certificate directory by default, if you enable it. You need to override that at runtime with the SSL_CERT_FILE variable. On Windows it will still be using your system certificates though, since it loads them from the system store instead of the OpenSSL directory. #### Linux (Appimage) If you don't want to install any external dependencies, you can generate an AppImage locally using docker. It is not that well maintained though... ```bash make docker-app-image ``` #### Arch Linux ```bash sudo pacman -S qt5-base \ qt5-tools \ qt5-multimedia \ qt5-svg \ cmake \ gcc \ fontconfig \ lmdb \ cmark \ boost \ qtkeychain-qt5 ``` #### Debian 11+ / Ubuntu 22.04 *Older OS versions require a newer version of Qt5 than offered in official repositories.* *Build requirements + qml modules needed at runtime (you may not need all of them, but the following seem to work according to reports):* ```bash sudo apt install --no-install-recommends g++ cmake make zlib1g-dev libssl-dev libolm-dev liblmdb-dev libcmark-dev nlohmann-json3-dev libspdlog-dev libevent-dev libcurl4-openssl-dev libre2-dev libxcb-ewmh-dev asciidoc-base \ qt{base,declarative,tools,multimedia,quickcontrols2-}5-dev libqt5svg5-dev qt5keychain-dev qml-module-qt{gstreamer,multimedia,quick-extras,-labs-settings,-labs-platform,graphicaleffects,quick-controls2,quick-particles2} \ libgstreamer1.0-dev libgstreamer-plugins-{base,bad}1.0-dev qtgstreamer-plugins-qt5 libnice-dev ``` lmdb++-dev is too old so bundled lmdbxx must be used. libspdlog-dev in debian bullseye is too old (without backporting) so requires using hunter to use bundled spdlog. Suggested flags for debian bullseye: `-DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF -DUSE_BUNDLED_OPENSSL=OFF` Suggested flags for debian bookworm: `-DUSE_BUNDLED_COEURL=1 -DUSE_BUNDLED_MTXCLIENT=1 -DUSE_BUNDLED_LMDBXX=1` #### Fedora ```bash sudo dnf builddep nheko # note that some newer packages might not be captured by that ``` #### Gentoo Linux ```bash sudo emerge -a ">=dev-qt/qtgui-5.15.0" media-libs/fontconfig dev-libs/qtkeychain ``` #### Guix ```bash guix environment nheko ``` #### macOS (Xcode 10.2 or later) ```bash brew update brew install qt5 lmdb cmake llvm spdlog boost cmark libolm qtkeychain ``` #### Windows 1. Install Visual Studio 2022's "Desktop Development" and "Linux Development with C++" (for the CMake integration) workloads. 2. Download the latest Qt for windows installer and install it somewhere. Make sure to install the `MSVC 2022 64-bit` toolset for at least Qt 5.15. 3. If you don't have openssl installed, you will need to install perl to build it (i.e. Strawberry Perl). ### Building We can now build nheko: ```bash cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release cmake --build build ``` To use bundled dependencies you can use hunter, i.e.: ```bash cmake -S. -Bbuild -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF -DUSE_BUNDLED_OPENSSL=OFF cmake --build build --config Release ``` Adapt the USE_BUNDLED_* as needed. If the build fails with the following error ``` Could not find a package configuration file provided by "Qt5Widgets" with any of the following names: Qt5WidgetsConfig.cmake qt5widgets-config.cmake ``` You might need to pass `-DCMAKE_PREFIX_PATH` to cmake to point it at your qt5 install. e.g on macOS ``` cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=$(brew --prefix qt5) cmake --build build ``` The `nheko` binary will be located in the `build` directory. #### Windows After installing all dependencies, you need to edit the `CMakeSettings.json` to be able to load and compile nheko within Visual Studio. You need to fill out the paths for the `Qt5_DIR`. The Qt5 dir should point to the `lib\cmake\Qt5` dir. Examples for the paths are: - `C:\\Qt\\5.15.1\\msvc2017_64\\lib\\cmake\\Qt5` You should also enable hunter by setting `HUNTER_ENABLED` to `ON` and `BUILD_SHARED_LIBS` to `OFF`. Now right click into the root nheko source directory and choose `Open in Visual Studio`. You can choose the build type Release and Debug in the top toolbar. After a successful CMake generation you can select the `nheko.exe` as the run target. Now choose `Build all` in the CMake menu or press `F7` to compile the executable. To be able to run the application the last step is to install the needed Qt dependencies next to the nheko binary. Start the "Qt x.xx.x 64-bit for Desktop (MSVC 2017)" command promt and run `windeployqt`. ```cmd cd \build-vc\Release\Release windeployqt nheko.exe ``` The final binary will be located inside `build-vc\Release\Release` for the Release build and `build-vc\Debug\Debug` for the Debug build. Also copy the respective cmark.dll to the binary dir from `build/cmark-build/src/Release` (or Debug). ### Contributing See [CONTRIBUTING](.github/CONTRIBUTING.md). ### Using the D-Bus API Currently, there is no documentation for the D-Bus API, so if you'd like to make use of it, come ask for support in [#nheko:nheko.im](https://matrix.to/#/#nheko:nheko.im). ### Screens Here are some screen shots to get a feel for the UI, but things will probably change. ![nheko start](https://nheko-reborn.github.io/images/screenshots/Start.png) ![nheko login](https://nheko-reborn.github.io/images/screenshots/login.png) ![nheko chat](https://nheko-reborn.github.io/images/screenshots/chat.png) ![nheko settings](https://nheko-reborn.github.io/images/screenshots/settings.png) ![nheko mobile](https://nheko-reborn.github.io/images/screenshots/mobile.png) ### Third party - [Single Application for Qt](https://github.com/itay-grudev/SingleApplication) - [Fluent Icons](https://github.com/microsoft/fluentui-system-icons) [Matrix]:https://matrix.org [Element]:https://element.io nheko-0.11.3/appveyor.yml000066400000000000000000000131241437552512500153020ustar00rootroot00000000000000--- version: 0.11.3-{build} configuration: Release image: Visual Studio 2022 platform: x64 environment: BINTRAY_APIKEY: secure: "iGl5mzE9/ta9kFELUxDw9XtlYMSCMai9xowXIkYzU8WKHz7NfW0mLwMJZvblZFXJ" MATRIX_ACCESS_TOKEN: secure: Qoy+QQ8zWXYCQrck9GtXJsoPTv9r/rhgCDUlKJ6ue+gkteYG40E9MxgwP1svn6bse20H4z6Svrxn8kFbcJB7Wg2Cnv1s326/vsJJzhWir2eHFFGK+f4SB992/U0HoQmk3Cq5hPk7dLcA7KqHIa1g1PTSFPfl1VODJ2UqqAyn8nzbC5ym+wwU1buJqoWPlTyHBW7eE8wNe77+qI18XpF7NN8yuOOyg3Tzup9YyXLrI36XiJu/5JD3j3s3V1QiUTpuLyQzqwuBUOf1MHTbzuPwHm3ZwzSM98WD6aL6riaK9qa7mDbSx1aY0ukIYSY9IdAfHNwZY/DEAn+QAVD+ZTvPq04ASv+kmSFpOBKr07kpqfM= cache: - c:\hunter\ -> appveyor.yml, CMakeLists.txt - build\_deps -> appveyor.yml, CMakeLists.txt build: verbosity: minimal install: - set QT_DIR=C:\Qt\5.15\msvc2019_64 - set PATH=C:\Strawberry\perl\bin;C:\Python39-x64;%QT_DIR%\bin;%PATH% build_script: # VERSION format: branch-master/branch-1.2 # INSTVERSION format: x.y.z # WINVERSION format: 9999.0.0.123/1.2.0.234 - if "%APPVEYOR_REPO_TAG%"=="false" set INSTVERSION=0.11.3 - if "%APPVEYOR_REPO_TAG%"=="false" set VERSION=0.11.3 - if "%APPVEYOR_REPO_TAG%"=="false" if "%APPVEYOR_REPO_BRANCH%"=="master" set INSTVERSION=9999.0 - if "%APPVEYOR_REPO_TAG%"=="false" set WINVERSION=%INSTVERSION%.0.%APPVEYOR_BUILD_NUMBER% # VERSION format: v1.2.3/v1.3.4 # INSTVERSION format: 1.2.3/1.3.4 # WINVERSION format: 1.2.3.123/1.3.4.234 - if "%APPVEYOR_REPO_TAG%"=="true" set VERSION=%APPVEYOR_REPO_TAG_NAME% - if "%APPVEYOR_REPO_TAG%"=="true" set INSTVERSION=%VERSION:~1% - if "%APPVEYOR_REPO_TAG%"=="true" set WINVERSION=%VERSION:~1%.%APPVEYOR_BUILD_NUMBER% - set DATE=%date:~10,4%-%date:~4,2%-%date:~7,2% - echo %VERSION% - echo %INSTVERSION% - echo %DATE% # Build nheko - cmake -G "Visual Studio 17 2022" -A x64 -H. -Bbuild -DHUNTER_ROOT="C:\hunter" -DHUNTER_ENABLED=ON -DBUILD_SHARED_LIBS=OFF -DUSE_BUNDLED_OPENSSL=ON -DCMAKE_BUILD_TYPE=Release -DHUNTER_CONFIGURATION_TYPES=Release - cmake --build build --config Release - call "C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat" x64 - git clone https://github.com/Nheko-Reborn/qt-jdenticon.git - cd qt-jdenticon - qmake - nmake - cd .. after_build: # Variables - set BUILD=%APPVEYOR_BUILD_FOLDER% - echo %BUILD% - mkdir NhekoRelease - copy build\Release\nheko.exe NhekoRelease\nheko.exe - copy qt-jdenticon\release\qtjdenticon0.dll NhekoRelease\qtjdenticon.dll - copy build\_deps\cmark-build\src\Release\cmark.dll NhekoRelease\cmark.dll - windeployqt --qmldir resources\qml\ NhekoRelease\nheko.exe - 7z a nheko_win_64.zip .\NhekoRelease\* - ls -lh build\Release\ - ls -lh NhekoRelease\ - mkdir NhekoData - xcopy .\NhekoRelease\*.* NhekoData\*.* /s /e /c /y # # Create the Qt Installer Framework version # - mkdir installer - mkdir installer\config - mkdir installer\packages - mkdir installer\packages\io.github.nhekoreborn.nheko - mkdir installer\packages\io.github.nhekoreborn.nheko\data - mkdir installer\packages\io.github.nhekoreborn.nheko\meta # Copy installer data - copy %BUILD%\resources\nheko.ico installer\config - copy %BUILD%\resources\nheko.png installer\config - copy %BUILD%\COPYING installer\packages\io.github.nhekoreborn.nheko\meta\license.txt - copy %BUILD%\deploy\installer\config.xml installer\config - copy %BUILD%\deploy\installer\controlscript.qs installer\config - copy %BUILD%\deploy\installer\uninstall.qs installer\packages\io.github.nhekoreborn.nheko\data - copy %BUILD%\deploy\installer\gui\package.xml installer\packages\io.github.nhekoreborn.nheko\meta - copy %BUILD%\deploy\installer\gui\installscript.qs installer\packages\io.github.nhekoreborn.nheko\meta # Amend version and date - sed -i "s/__VERSION__/0.11.3/" installer\config\config.xml - sed -i "s/__VERSION__/0.11.3/" installer\packages\io.github.nhekoreborn.nheko\meta\package.xml - sed -i "s/__DATE__/%DATE%/" installer\packages\io.github.nhekoreborn.nheko\meta\package.xml # Copy nheko data - xcopy NhekoData\*.* installer\packages\io.github.nhekoreborn.nheko\data\*.* /s /e /c /y - move NhekoRelease\nheko.exe installer\packages\io.github.nhekoreborn.nheko\data - mkdir tools - curl -L -O https://download.qt.io/official_releases/qt-installer-framework/4.3.0/QtInstallerFramework-windows-x86-4.3.0.exe - 7z x QtInstallerFramework-windows-x86-4.3.0.exe -otools -aoa - set PATH=%BUILD%\tools\bin;%PATH% - binarycreator.exe -f -c installer\config\config.xml -p installer\packages nheko-installer.exe - copy nheko-installer.exe nheko-%APPVEYOR_REPO_TAG_NAME%-installer.exe - copy nheko-installer.exe nheko-%APPVEYOR_PULL_REQUEST_HEAD_COMMIT%-installer.exe - ps: .\.ci\upload-nightly.ps1 on_success: - if "%APPVEYOR_REPO_TAG%" == "true" (curl -T nheko-%APPVEYOR_REPO_TAG_NAME%-installer.exe -uredsky17:%BINTRAY_APIKEY% https://api.bintray.com/content/nheko-reborn/nheko/%APPVEYOR_REPO_TAG_NAME%/nheko/%APPVEYOR_REPO_TAG_NAME%/) deploy: - description: "Development builds" provider: GitHub auth_token: secure: "ShStWeqp+TkYqJPQr7uFZb+B8ZTgC7Iwth+IkhjfRDCTLhy8gtWvlPzlQilder3E" artifact: nheko-${APPVEYOR_REPO_TAG_NAME}-installer.exe force_update: true prerelease: true on: appveyor_repo_tag: true artifacts: - path: nheko_win_64.zip - path: nheko-$(APPVEYOR_REPO_TAG_NAME)-installer.exe - path: nheko-$(APPVEYOR_PULL_REQUEST_HEAD_COMMIT)-installer.exe nheko-0.11.3/cmake/000077500000000000000000000000001437552512500137715ustar00rootroot00000000000000nheko-0.11.3/cmake/Doxyfile.in000066400000000000000000003045721437552512500161170ustar00rootroot00000000000000# Doxyfile 1.8.7 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = "nheko" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify an logo or icon that is included in # the documentation. The maximum height of the logo should not exceed 55 pixels # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = ${CMAKE_CURRENT_BINARY_DIR}/docs # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a # new page for each member. If set to NO, the documentation of a member will be # part of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by by putting a % sign in front of the word # or globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = YES # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined # locally in source files will be included in the documentation. If set to NO # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When set to YES local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = YES # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO these classes will be included in the various overviews. This option has # no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the # todo list. This list is created by putting \todo commands in the # documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the # test list. This list is created by putting \test commands in the # documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES the list # will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. Do not use file names with spaces, bibtex cannot handle them. See # also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO doxygen will only warn about wrong or incomplete parameter # documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. # Note: If this tag is empty the current directory is searched. INPUT = ../src ../include # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank the # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER ) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = YES # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES, then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- # defined cascading style sheet that is included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefor more robust against future updates. # Doxygen will copy the style sheet file to the output directory. For an example # see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the stylesheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to NO can help when comparing the output of multiple runs. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler ( hhc.exe). If non-empty # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated ( # YES) or that it should be included in the master .chm file ( NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated ( # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using prerendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /