Showing preview only (1,223K chars total). Download the full file or copy to clipboard to get everything.
Repository: zealdocs/zeal
Branch: main
Commit: 705ae49fbbea
Files: 159
Total size: 1.1 MB
Directory structure:
gitextract_ypzf_fv3/
├── .editorconfig
├── .gitattributes
├── .github/
│ ├── CODEOWNERS
│ ├── dependabot.yml
│ └── workflows/
│ ├── analyze-codeql.yaml
│ ├── analyze-coverity.yaml
│ ├── appimage/
│ │ ├── Dockerfile
│ │ ├── action.yaml
│ │ └── entrypoint.sh
│ ├── build-check.yaml
│ ├── lock.yaml
│ ├── release/
│ │ └── cliff.toml
│ └── release.yaml
├── .gitignore
├── CHANGELOG.md
├── CMakeLists.txt
├── CMakePresets.json
├── COPYING
├── LICENSES/
│ ├── GPL-3.0-or-later.txt
│ ├── LicenseRef-Kapeli.txt
│ ├── MIT.txt
│ └── MS-RL.txt
├── README.md
├── REUSE.toml
├── assets/
│ ├── CMakeLists.txt
│ └── freedesktop/
│ ├── CMakeLists.txt
│ ├── org.zealdocs.zeal.appdata.xml.in
│ └── org.zealdocs.zeal.desktop
├── cmake/
│ ├── CodeSign.cmake
│ ├── GetVersionFromGit.cmake
│ └── MacOSXBundleInfo.plist.in
├── pkg/
│ ├── appimage/
│ │ ├── README.md
│ │ └── appimage-amd64.yaml
│ └── wix/
│ ├── cpack_post_build.cmake
│ ├── cpack_pre_build.cmake
│ ├── exitdialog.wxs
│ ├── patch.xml
│ ├── template.xml
│ └── ui.wxs
├── src/
│ ├── CMakeLists.txt
│ ├── app/
│ │ ├── CMakeLists.txt
│ │ ├── main.cpp
│ │ ├── resources/
│ │ │ ├── browser/
│ │ │ │ ├── 404.html
│ │ │ │ ├── assets/
│ │ │ │ │ └── css/
│ │ │ │ │ ├── highlight.css
│ │ │ │ │ └── welcome.css
│ │ │ │ └── welcome.html
│ │ │ ├── icons/
│ │ │ │ └── README.md
│ │ │ └── zeal.icns
│ │ ├── versioninfo.rc.in
│ │ └── zeal.qrc
│ ├── contrib/
│ │ └── cpp-httplib/
│ │ └── httplib.h
│ └── libs/
│ ├── CMakeLists.txt
│ ├── browser/
│ │ ├── CMakeLists.txt
│ │ ├── searchtoolbar.cpp
│ │ ├── searchtoolbar.h
│ │ ├── settings.cpp
│ │ ├── settings.h
│ │ ├── urlrequestinterceptor.cpp
│ │ ├── urlrequestinterceptor.h
│ │ ├── webbridge.cpp
│ │ ├── webbridge.h
│ │ ├── webcontrol.cpp
│ │ ├── webcontrol.h
│ │ ├── webpage.cpp
│ │ ├── webpage.h
│ │ ├── webview.cpp
│ │ └── webview.h
│ ├── core/
│ │ ├── CMakeLists.txt
│ │ ├── application.cpp
│ │ ├── application.h
│ │ ├── applicationsingleton.cpp
│ │ ├── applicationsingleton.h
│ │ ├── extractor.cpp
│ │ ├── extractor.h
│ │ ├── filemanager.cpp
│ │ ├── filemanager.h
│ │ ├── httpserver.cpp
│ │ ├── httpserver.h
│ │ ├── networkaccessmanager.cpp
│ │ ├── networkaccessmanager.h
│ │ ├── settings.cpp
│ │ └── settings.h
│ ├── registry/
│ │ ├── CMakeLists.txt
│ │ ├── cancellationtoken.h
│ │ ├── docset.cpp
│ │ ├── docset.h
│ │ ├── docsetmetadata.cpp
│ │ ├── docsetmetadata.h
│ │ ├── docsetregistry.cpp
│ │ ├── docsetregistry.h
│ │ ├── itemdatarole.h
│ │ ├── listmodel.cpp
│ │ ├── listmodel.h
│ │ ├── searchmodel.cpp
│ │ ├── searchmodel.h
│ │ ├── searchquery.cpp
│ │ ├── searchquery.h
│ │ └── searchresult.h
│ ├── sidebar/
│ │ ├── CMakeLists.txt
│ │ ├── container.cpp
│ │ ├── container.h
│ │ ├── proxyview.cpp
│ │ ├── proxyview.h
│ │ ├── view.cpp
│ │ ├── view.h
│ │ ├── viewprovider.cpp
│ │ └── viewprovider.h
│ ├── ui/
│ │ ├── CMakeLists.txt
│ │ ├── aboutdialog.cpp
│ │ ├── aboutdialog.h
│ │ ├── aboutdialog.ui
│ │ ├── browsertab.cpp
│ │ ├── browsertab.h
│ │ ├── docsetlistitemdelegate.cpp
│ │ ├── docsetlistitemdelegate.h
│ │ ├── docsetsdialog.cpp
│ │ ├── docsetsdialog.h
│ │ ├── docsetsdialog.ui
│ │ ├── mainwindow.cpp
│ │ ├── mainwindow.h
│ │ ├── qxtglobalshortcut/
│ │ │ ├── CMakeLists.txt
│ │ │ ├── qxtglobalshortcut.cpp
│ │ │ ├── qxtglobalshortcut.h
│ │ │ ├── qxtglobalshortcut_mac.cpp
│ │ │ ├── qxtglobalshortcut_noop.cpp
│ │ │ ├── qxtglobalshortcut_p.h
│ │ │ ├── qxtglobalshortcut_win.cpp
│ │ │ └── qxtglobalshortcut_x11.cpp
│ │ ├── searchitemdelegate.cpp
│ │ ├── searchitemdelegate.h
│ │ ├── searchsidebar.cpp
│ │ ├── searchsidebar.h
│ │ ├── settingsdialog.cpp
│ │ ├── settingsdialog.h
│ │ ├── settingsdialog.ui
│ │ ├── sidebarviewprovider.cpp
│ │ ├── sidebarviewprovider.h
│ │ └── widgets/
│ │ ├── CMakeLists.txt
│ │ ├── layouthelper.cpp
│ │ ├── layouthelper.h
│ │ ├── searchedit.cpp
│ │ ├── searchedit.h
│ │ ├── shortcutedit.cpp
│ │ ├── shortcutedit.h
│ │ ├── toolbarframe.cpp
│ │ └── toolbarframe.h
│ └── util/
│ ├── CMakeLists.txt
│ ├── caseinsensitivemap.h
│ ├── fuzzy.cpp
│ ├── fuzzy.h
│ ├── humanizer.cpp
│ ├── humanizer.h
│ ├── plist.cpp
│ ├── plist.h
│ ├── sqlitedatabase.cpp
│ ├── sqlitedatabase.h
│ └── tests/
│ ├── CMakeLists.txt
│ └── fuzzy_test.cpp
└── vcpkg.json
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
# EditorConfig (https://editorconfig.org)
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_size = 4
indent_style = space
max_line_length = 100
trim_trailing_whitespace = true
[{*.cmake,CMakeLists.txt}]
# TODO: indent_size = 2
indent_size = 4
[*.css]
indent_size = 2
[*.json]
indent_size = 2
[*.{yaml,yml}]
indent_size = 2
================================================
FILE: .gitattributes
================================================
# Autodetect text files
* text=auto
# Enforce text mode
*.c text
*.cmake text
*.conf text
*.cpp text
*.css text
*.desktop text
*.h text
*.html text
*.in text
*.json text
*.md text
*.qrc text
*.ui text
*.yaml text
*.yml text
.editorconfig text
.gitignore text
CMakeLists.txt text
COPYING text
# Binary files
*.icns binary
*.ico binary
*.png binary
*.woff binary
*.woff2 binary
================================================
FILE: .github/CODEOWNERS
================================================
# This file allows automatic assignment of pull requests.
# See https://help.github.com/articles/about-codeowners/
* @trollixx
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
commit-message:
prefix: ci(github)
labels: []
================================================
FILE: .github/workflows/analyze-codeql.yaml
================================================
name: CodeQL Scan
on:
push:
branches: [main]
pull_request:
# The branches below must be a subset of the branches above.
branches: [main]
schedule:
- cron: '0 8 * * 6'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
analyze-codeql:
name: Analyze
runs-on: ubuntu-24.04
permissions:
security-events: write
steps:
- name: Checkout Repository
uses: actions/checkout@v6
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
- name: Install Dependencies
run: |
sudo apt-get -y -qq update
sudo apt-get -y -qq --no-install-recommends install \
cmake \
extra-cmake-modules \
libarchive-dev \
libgl1-mesa-dev \
libqt6opengl6-dev \
libsqlite3-dev \
libvulkan-dev \
libxcb-keysyms1-dev \
ninja-build \
qt6-base-private-dev \
qt6-webengine-dev \
qt6-webengine-dev-tools
- name: Configure & Build
uses: lukka/run-cmake@v10
with:
configurePreset: ninja-multi
buildPreset: ninja-multi-release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v4
================================================
FILE: .github/workflows/analyze-coverity.yaml
================================================
name: Coverity Scan
on:
push:
branches: [main]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
analyze-coverity:
name: Analyze
if: github.repository == 'zealdocs/zeal'
runs-on: ubuntu-24.04
steps:
- name: Checkout Repository
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Install Dependencies
run: |
sudo apt-get -y -qq update
sudo apt-get -y -qq --no-install-recommends install \
cmake \
extra-cmake-modules \
git \
libarchive-dev \
libgl1-mesa-dev \
libqt6opengl6-dev \
libsqlite3-dev \
libvulkan-dev \
libxcb-keysyms1-dev \
ninja-build \
qt6-base-private-dev \
qt6-webengine-dev \
qt6-webengine-dev-tools
- name: Configure
run: cmake -B build -G Ninja
- name: Retrieve Application Version
run: |
zeal_version=$(<build/zeal_version)
echo "Zeal Version: ${zeal_version}"
echo "ZEAL_VERSION=${zeal_version}" >> $GITHUB_ENV
- name: Coverity Scan
uses: vapier/coverity-scan-action@v1
with:
command: ninja -C build
version: ${{ env.ZEAL_VERSION }}
email: ${{ secrets.COVERITY_SCAN_EMAIL }}
token: ${{ secrets.COVERITY_SCAN_TOKEN }}
- name: Upload Build Log
uses: actions/upload-artifact@v7
with:
name: build-log
path: cov-int/build-log.txt
if-no-files-found: ignore
================================================
FILE: .github/workflows/appimage/Dockerfile
================================================
FROM ubuntu:jammy
# Force older pipx to use global location.
ENV PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin PIPX_MAN_DIR=/usr/local/share/man
RUN apt-get update -q -y \
# Install appimage-builder and appimagetool dependencies.
&& DEBIAN_FRONTEND="noninteractive" apt-get install -q -y --no-install-recommends \
appstream curl desktop-file-utils fakeroot file git gnupg patchelf pipx squashfs-tools zsync \
# Install appimagetool, it has to be extracted because FUSE doesn't work in containers without extra fiddling.
&& cd /tmp \
&& curl -sLO https://github.com/AppImage/appimagetool/releases/download/continuous/appimagetool-x86_64.AppImage \
&& chmod +x appimagetool-x86_64.AppImage \
&& ./appimagetool-x86_64.AppImage --appimage-extract \
&& mv squashfs-root/ /opt/appimagetool.AppDir \
&& ln -s /opt/appimagetool.AppDir/AppRun /usr/local/bin/appimagetool \
&& rm appimagetool-x86_64.AppImage \
&& cd - \
# Install appimage-builder.
&& pipx install git+https://github.com/AppImageCrafters/appimage-builder.git@d96cf01e131e01b9f9e713db8efa7d20c57f6a09 \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/*
# Set entrypoint.
COPY entrypoint.sh /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]
================================================
FILE: .github/workflows/appimage/action.yaml
================================================
name: 'AppImage Builder'
description: 'Create an AppImage with appimage-builder.'
inputs:
recipe:
description: 'Path to the appimage-builder recipe.'
required: true
default: 'AppImageBuilder.yml'
apt_dependencies:
description: 'List of packages to install with apt-get.'
required: false
runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.recipe }}
- ${{ inputs.apt_dependencies }}
================================================
FILE: .github/workflows/appimage/entrypoint.sh
================================================
#!/bin/bash
# Should be in .gitignore.
export APPIMAGE_BUILD_DIR=build.appimage
# Install dependencies
if [ ! -z ${INPUT_APT_DEPENDENCIES+x} ]; then
apt-get update -q -y
apt-get install -q -y --no-install-recommends ${INPUT_APT_DEPENDENCIES}
fi
# Run appimage-builder
appimage-builder --skip-test --build-dir ${APPIMAGE_BUILD_DIR} --appdir ${APPIMAGE_BUILD_DIR}/AppDir --recipe ${INPUT_RECIPE}
================================================
FILE: .github/workflows/build-check.yaml
================================================
name: Build Check
on:
push:
branches: [main]
pull_request:
branches: [main]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build-ubuntu:
name: ${{ matrix.config.name }}
runs-on: ${{ matrix.config.os }}
strategy:
fail-fast: false
matrix:
config:
- name: Ubuntu 24.04 / Qt 5
os: ubuntu-24.04
qt_packages: >-
libqt5x11extras5-dev
qtwebengine5-dev
configurePreset: ninja-multi
buildPreset: ninja-multi-release
- name: Ubuntu 24.04 / Qt 5 / Portable
os: ubuntu-24.04
qt_packages: >-
libqt5x11extras5-dev
qtwebengine5-dev
configurePreset: ninja-multi-portable
buildPreset: ninja-multi-portable-release
- name: Ubuntu 24.04 / Qt 6
os: ubuntu-24.04
qt_packages: >-
libgl1-mesa-dev
libqt6opengl6-dev
qt6-base-private-dev
qt6-webengine-dev
qt6-webengine-dev-tools
configurePreset: ninja-multi
buildPreset: ninja-multi-release
- name: Ubuntu 24.04 / Qt 6 / Portable
os: ubuntu-24.04
qt_packages: >-
libgl1-mesa-dev
libqt6opengl6-dev
qt6-base-private-dev
qt6-webengine-dev
qt6-webengine-dev-tools
configurePreset: ninja-multi-portable
buildPreset: ninja-multi-portable-release
- name: Ubuntu 24.04 ARM64 / Qt 6
os: ubuntu-24.04-arm
qt_packages: >-
libgl1-mesa-dev
libqt6opengl6-dev
qt6-base-private-dev
qt6-webengine-dev
qt6-webengine-dev-tools
configurePreset: ninja-multi
buildPreset: ninja-multi-release
- name: Ubuntu 24.04 ARM64 / Qt 6 / Portable
os: ubuntu-24.04-arm
qt_packages: >-
libgl1-mesa-dev
libqt6opengl6-dev
qt6-base-private-dev
qt6-webengine-dev
qt6-webengine-dev-tools
configurePreset: ninja-multi-portable
buildPreset: ninja-multi-portable-release
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Install Dependencies
run: |
sudo apt-get -y -qq update
sudo apt-get -y -qq --no-install-recommends install \
cmake \
extra-cmake-modules \
libarchive-dev \
libsqlite3-dev \
libvulkan-dev \
libxcb-keysyms1-dev \
ninja-build \
${{ matrix.config.qt_packages }}
- name: Configure & Build
uses: lukka/run-cmake@v10
with:
configurePreset: ${{ matrix.config.configurePreset }}
buildPreset: ${{ matrix.config.buildPreset }}
build-windows:
name: ${{ matrix.config.name }}
runs-on: ${{ matrix.config.os }}
strategy:
fail-fast: false
matrix:
config:
- name: Windows Server 2022 / Qt 5
os: windows-2022
arch: win64_msvc2019_64
qt_modules: >-
qtwebengine
qt_version: "5.15.2"
configurePreset: ninja-multi-vcpkg
buildPreset: ninja-multi-vcpkg-release
publishArtifacts: false
- name: Windows Server 2022 / Qt 5 / Portable
os: windows-2022
arch: win64_msvc2019_64
qt_modules: >-
qtwebengine
qt_version: "5.15.2"
configurePreset: ninja-multi-vcpkg-portable
buildPreset: ninja-multi-vcpkg-portable-release
publishArtifacts: false
- name: Windows Server 2022 / Qt 6
os: windows-2022
arch: win64_msvc2022_64
qt_modules: >-
qtpositioning
qtwebchannel
qtwebengine
qt_version: "6.10.2"
configurePreset: ninja-multi-vcpkg
buildPreset: ninja-multi-vcpkg-release
publishArtifacts: true
- name: Windows Server 2022 / Qt 6 / Portable
os: windows-2022
arch: win64_msvc2022_64
qt_modules: >-
qtpositioning
qtwebchannel
qtwebengine
qt_version: "6.10.2"
configurePreset: ninja-multi-vcpkg-portable
buildPreset: ninja-multi-vcpkg-portable-release
publishArtifacts: true
env:
VCPKG_BINARY_SOURCES: clear;files,${{ github.workspace }}/.vcpkg-cache,readwrite
VCPKG_BUILD_TYPE: release
VCPKG_DEFAULT_TRIPLET: x64-windows
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
# Workaround for https://github.com/lukka/run-vcpkg/issues/251.
- name: Prepare vcpkg binary cache
uses: actions/cache@v5
with:
path: ${{ github.workspace }}/.vcpkg-cache
key: vcpkg-${{ matrix.config.os }}-${{ matrix.config.buildPreset }}-${{ hashFiles(format('build/{0}/vcpkg_installed/vcpkg/status', matrix.config.configurePreset)) }}
restore-keys: vcpkg-${{ matrix.config.os }}-${{ matrix.config.buildPreset }}-
- name: Prepare vcpkg
uses: lukka/run-vcpkg@v11
with:
vcpkgDirectory: ${{ github.workspace }}/.vcpkg
- name: Install Qt
uses: jurplel/install-qt-action@v4
with:
arch: ${{ matrix.config.arch }}
modules: ${{ matrix.config.qt_modules }}
version: ${{ matrix.config.qt_version }}
cache: true
- name: Configure & Build
uses: lukka/run-cmake@v10
with:
configurePreset: ${{ matrix.config.configurePreset }}
buildPreset: ${{ matrix.config.buildPreset }}
configurePresetAdditionalArgs: "['-DVCPKG_DISABLE_COMPILER_TRACKING=ON']"
- name: Retrieve Application Version
run: |
$zeal_version = Get-Content build/${{ matrix.config.configurePreset }}/zeal_version
Write-Output "Zeal Version: $zeal_version"
"ZEAL_VERSION=$zeal_version" >> $env:GITHUB_ENV
- name: Package
if: matrix.config.publishArtifacts
run: cmake --build build --preset ${{ matrix.config.buildPreset }} --target package
env:
CODESIGN_CERTIFICATE_BASE64: ${{ secrets.CODESIGN_CERTIFICATE_BASE64 }}
CODESIGN_PASSWORD: ${{ secrets.CODESIGN_PASSWORD }}
- name: Upload ZIP Artifacts
if: matrix.config.publishArtifacts
uses: actions/upload-artifact@v7
with:
name: zeal-${{ env.ZEAL_VERSION }}${{ matrix.config.configurePreset == 'ninja-multi-vcpkg-portable' && '-portable' || '' }}-windows-x64.zip
path: |
build/${{ matrix.config.configurePreset }}/zeal-*.zip
build/${{ matrix.config.configurePreset }}/zeal-*.zip.sha256
- name: Upload MSI Artifacts
if: matrix.config.publishArtifacts && matrix.config.configurePreset == 'ninja-multi-vcpkg'
uses: actions/upload-artifact@v7
with:
name: zeal-${{ env.ZEAL_VERSION }}-windows-x64.msi
path: |
build/${{ matrix.config.configurePreset }}/zeal-*.msi
build/${{ matrix.config.configurePreset }}/zeal-*.msi.sha256
build-appimage:
name: AppImage
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Build AppImage
uses: ./.github/workflows/appimage/
with:
recipe: pkg/appimage/appimage-amd64.yaml
apt_dependencies: >-
appstream
build-essential
cmake extra-cmake-modules
libarchive-dev
libayatana-appindicator3-dev
libqt5x11extras5-dev
libsqlite3-dev
libxcb-keysyms1-dev
ninja-build
qtbase5-dev
qtwebengine5-dev
- name: Upload AppImage
uses: actions/upload-artifact@v7
with:
name: zeal-dev-x86_64.AppImage # TODO: Provide real version.
path: zeal-*.AppImage
================================================
FILE: .github/workflows/lock.yaml
================================================
name: Lock Issues
on:
schedule:
- cron: "0 0 * * *"
workflow_dispatch:
permissions:
issues: write
pull-requests: write
concurrency:
group: lock
jobs:
lock-issues:
name: Lock Old Issues
if: github.repository == 'zealdocs/zeal'
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v6
with:
issue-inactive-days: 180
issue-lock-reason: ""
process-only: issues
================================================
FILE: .github/workflows/release/cliff.toml
================================================
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
# Set via GITHUB_REPO and GITHUB_TOKEN environment variables.
#[remote.github]
#owner = "zealdocs"
#repo = "zeal"
#token = ""
[changelog]
# Template docs: https://keats.github.io/tera/docs/.
body = """\
<!-- TODO: Update milestone link, review commits. -->
{% if version and previous.version %}
[Full Changelog]({{ self::diff_url() }}) | [Resolved Issues]({{ self::remote_url() }}/milestone/TBD?closed=1)
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim }}
{% for commit in commits %}
{% if commit.github.pr_title -%}
{%- set commit_message = commit.github.pr_title -%}
{%- else -%}
{%- set commit_message = commit.message -%}
{%- endif -%}
- {% if commit.scope %}**{{ commit.scope }}:** {% endif %}\
{{ commit.message | split(pat="\n") | first | trim }} \
({{ self::commit_link(id=commit.id) }})\
{% endfor %}
{% endfor %}
---
{%- if github -%}\
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
{% raw %}\n{% endraw -%}
#### New Contributors
{%- endif %}
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
- @{{ contributor.username }} made their first contribution
{%- if contributor.pr_number %} in \
{{ self::pr_link(pr_number=contributor.pr_number) }}\
{%- endif %}
{%- endfor -%}
{%- endif -%}
{%- macro remote_url() -%}
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}
{%- macro diff_url() -%}
{{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}
{%- endmacro -%}
{%- macro pr_link(pr_number) -%}
[#{{ pr_number }}]({{ self::remote_url() }}/pull/{{ pr_number }})
{%- endmacro -%}
{%- macro commit_link(id) -%}
[`{{ id | truncate(length=7, end="") }}`]({{ self::remote_url() }}/commit/{{ id }})
{%- endmacro -%}
"""
# Remove the leading and trailing whitespace from the template.
trim = true
# Template for the changelog footer.
footer = """
"""
# Postprocessors.
postprocessors = []
[git]
# Parse the commits based on https://www.conventionalcommits.org.
conventional_commits = true
# Filter out the commits that are not conventional.
filter_unconventional = true
# Process each line of a commit as an individual commit.
split_commits = false
# Regex for preprocessing the commit messages.
commit_preprocessors = [
# Remove issue numbers from commits.
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
]
# Regex for parsing and grouping commits.
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->Features" },
{ message = "^fix", group = "<!-- 1 -->Bug Fixes" },
{ message = "^perf", group = "<!-- 2 -->Performance" },
{ message = "^doc", group = "<!-- 3 -->Documentation" },
{ message = "^build", group = "<!-- 4 -->Build System" },
{ message = "^ci", group = "<!-- 5 -->CI/CD" },
# Skipped groups:
{ message = "^chore", skip = true },
{ message = "^refactor", skip = true },
]
# Filter out the commits that are not matched by commit parsers.
filter_commits = false
# Sort the tags topologically.
topo_order = false
# Sort the commits inside sections by oldest/newest order.
sort_commits = "oldest"
================================================
FILE: .github/workflows/release.yaml
================================================
name: Release
on:
push:
tags:
- "v*.*.*"
# Required for creating GitHub release.
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build-windows:
name: ${{ matrix.config.name }}
runs-on: ${{ matrix.config.os }}
strategy:
fail-fast: false
matrix:
config:
- name: Windows Server 2022 / Qt 6
os: windows-2022
arch: win64_msvc2022_64
qt_modules: >-
qtpositioning
qtwebchannel
qtwebengine
qt_version: "6.10.2"
configurePreset: ninja-multi-vcpkg
buildPreset: ninja-multi-vcpkg-release
- name: Windows Server 2022 / Qt 6 / Portable
os: windows-2022
arch: win64_msvc2022_64
qt_modules: >-
qtpositioning
qtwebchannel
qtwebengine
qt_version: "6.10.2"
configurePreset: ninja-multi-vcpkg-portable
buildPreset: ninja-multi-vcpkg-portable-release
env:
VCPKG_BINARY_SOURCES: clear;files,${{ github.workspace }}/.vcpkg-cache,readwrite
VCPKG_BUILD_TYPE: release
VCPKG_DEFAULT_TRIPLET: x64-windows
ZEAL_RELEASE_BUILD: ON
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
# Workaround for https://github.com/lukka/run-vcpkg/issues/251.
- name: Prepare vcpkg binary cache
uses: actions/cache@v5
with:
path: ${{ github.workspace }}/.vcpkg-cache
key: vcpkg-${{ matrix.config.os }}-${{ matrix.config.buildPreset }}-${{ hashFiles(format('build/{0}/vcpkg_installed/vcpkg/status', matrix.config.configurePreset)) }}
restore-keys: vcpkg-${{ matrix.config.os }}-${{ matrix.config.buildPreset }}-
- name: Prepare vcpkg
uses: lukka/run-vcpkg@v11
with:
vcpkgDirectory: ${{ github.workspace }}/.vcpkg
- name: Install Qt
uses: jurplel/install-qt-action@v4
with:
arch: ${{ matrix.config.arch }}
modules: ${{ matrix.config.qt_modules }}
version: ${{ matrix.config.qt_version }}
cache: true
- name: Configure & Build
uses: lukka/run-cmake@v10
with:
configurePreset: ${{ matrix.config.configurePreset }}
buildPreset: ${{ matrix.config.buildPreset }}
configurePresetAdditionalArgs: "['-DVCPKG_DISABLE_COMPILER_TRACKING=ON']"
- name: Retrieve Application Version
run: |
$zeal_version = Get-Content build/${{ matrix.config.configurePreset }}/zeal_version
Write-Output "Zeal Version: $zeal_version"
"ZEAL_VERSION=$zeal_version" >> $env:GITHUB_ENV
- name: Package
run: cmake --build build --preset ${{ matrix.config.buildPreset }} --target package
env:
CODESIGN_CERTIFICATE_BASE64: ${{ secrets.CODESIGN_CERTIFICATE_BASE64 }}
CODESIGN_PASSWORD: ${{ secrets.CODESIGN_PASSWORD }}
- name: Update GitHub Release
uses: softprops/action-gh-release@v2
with:
draft: true
# Only upload the following artifacts:
# - Portable 7-Zip and ZIP packages.
# - Non-portable MSI package.
files: |
build/${{ matrix.config.configurePreset }}/zeal-${{ env.ZEAL_VERSION }}-portable-windows-x64.*
build/${{ matrix.config.configurePreset }}/zeal-${{ env.ZEAL_VERSION }}-windows-x64.msi*
build-appimage:
name: AppImage
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Build AppImage
uses: ./.github/workflows/appimage/
with:
recipe: pkg/appimage/appimage-amd64.yaml
apt_dependencies: >-
appstream
build-essential
cmake extra-cmake-modules
libayatana-appindicator3-dev
libarchive-dev
libqt5x11extras5-dev
libsqlite3-dev
libxcb-keysyms1-dev
ninja-build
qtbase5-dev
qtwebengine5-dev
- name: Generate Digest Files
run: for file in zeal-*.AppImage*; do sha256sum $file > $file.sha256; done
- name: Update GitHub Release
uses: softprops/action-gh-release@v2
with:
draft: true
fail_on_unmatched_files: true
files: |
zeal-*.AppImage*
build-ubuntu:
name: ${{ matrix.config.name }}
runs-on: ${{ matrix.config.os }}
strategy:
fail-fast: false
matrix:
config:
- name: Ubuntu 24.04 / Source
os: ubuntu-24.04
qt_packages: >-
libgl1-mesa-dev
libqt6opengl6-dev
qt6-base-private-dev
qt6-webengine-dev
qt6-webengine-dev-tools
configurePreset: ninja-multi
buildPreset: ninja-multi-release
env:
ZEAL_RELEASE_BUILD: ON
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Install Dependencies
run: |
sudo apt-get -y -qq update
sudo apt-get -y -qq --no-install-recommends install \
cmake \
extra-cmake-modules \
libarchive-dev \
libsqlite3-dev \
libvulkan-dev \
libxcb-keysyms1-dev \
ninja-build \
${{ matrix.config.qt_packages }}
- name: Configure & Package Source
uses: lukka/run-cmake@v10
with:
configurePreset: ${{ matrix.config.configurePreset }}
buildPreset: ${{ matrix.config.buildPreset }}
buildPresetAdditionalArgs: "['--target package_source']"
- name: Generate Changelog
uses: orhun/git-cliff-action@v4
id: git-cliff
with:
args: --latest
config: .github/workflows/release/cliff.toml
env:
GITHUB_REPO: ${{ github.repository }}
- name: Update GitHub Release
uses: softprops/action-gh-release@v2
with:
draft: true
fail_on_unmatched_files: true
body: ${{ steps.git-cliff.outputs.content }}
# Only upload the following artifacts:
# - Source packages.
files: |
build/${{ matrix.config.configurePreset }}/zeal-*.*
================================================
FILE: .gitignore
================================================
# C++ objects and libs
*.a
*.dll
*.dylib
*.la
*.lai
*.lo
*.o
*.slo
*.so
# CMake
build.*/
build/
CMakeLists.txt.user
CMakeUserPresets.json
# AppImage Builder
*.AppImage
*.AppImage.zsync
appimage-builder-cache/
squashfs-root/
# WiX Toolset
*.msi
*.wixobj
*.wixpdb
# Qt Creator
*.autosave
# VS Code
.vscode/
# Linux appdata
/assets/freedesktop/org.zealdocs.zeal.appdata.xml
================================================
FILE: CHANGELOG.md
================================================
# Changelog
The version history is available on [GitHub Releases](https://github.com/zealdocs/zeal/releases).
================================================
FILE: CMakeLists.txt
================================================
cmake_minimum_required(VERSION 3.16.3)
# CMake options.
set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
set(CMAKE_DISABLE_SOURCE_CHANGES ON)
set(CMAKE_ERROR_DEPRECATED TRUE)
set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
project(Zeal
VERSION 0.8.0
DESCRIPTION "A simple documentation browser."
HOMEPAGE_URL "https://zealdocs.org"
LANGUAGES CXX
)
# Set to TRUE for a tagged release.
# NOTE: Don't forget to add a new release entry in the AppStream metadata!
if(NOT ZEAL_RELEASE_BUILD AND DEFINED ENV{ZEAL_RELEASE_BUILD})
set(ZEAL_RELEASE_BUILD $ENV{ZEAL_RELEASE_BUILD})
endif()
# Project information.
set(PROJECT_COMPANY_NAME "Oleg Shparber")
set(PROJECT_COPYRIGHT "© 2013-2026 Oleg Shparber and other contributors")
# Find available major Qt version. It will be stored in QT_VERSION_MAJOR.
if(NOT ZEAL_USE_QT5)
find_package(QT NAMES Qt6 COMPONENTS Core)
set(QT_MINIMUM_VERSION 6.2.0)
endif()
if(NOT QT_FOUND)
find_package(QT NAMES Qt5 REQUIRED COMPONENTS Core)
set(QT_MINIMUM_VERSION 5.15.2)
endif()
message(NOTICE "Detected Qt version: ${QT_VERSION}")
# Determine version for dev builds.
if(NOT ZEAL_RELEASE_BUILD)
message(NOTICE "Building unreleased code. Proceed at your own risk!")
# TODO: Add support for metadata passed from env, e.g. aur, appimage, etc.
include(GetVersionFromGit)
if(Zeal_GIT_VERSION_SHA)
# Extra check in case we forgot to bump version in project() directive.
if(NOT PROJECT_VERSION_PATCH EQUAL Zeal_GIT_VERSION_PATCH_NEXT)
message(WARNING "Incorrect patch version! Forgot to bump?")
endif()
set(ZEAL_VERSION_SUFFIX "-dev.${Zeal_GIT_VERSION_AHEAD}+${Zeal_GIT_VERSION_SHA}")
else()
set(ZEAL_VERSION_SUFFIX "-dev")
endif()
endif()
set(ZEAL_VERSION_FULL "${Zeal_VERSION}${ZEAL_VERSION_SUFFIX}")
message(NOTICE "Calculated Zeal version: ${ZEAL_VERSION_FULL}")
file(WRITE "${CMAKE_BINARY_DIR}/zeal_version" ${ZEAL_VERSION_FULL})
# A custom target to print the full version.
# Usage: cmake --build build --preset ninja-multi-vcpkg-release --target zeal_version
add_custom_target(zeal_version
COMMAND ${CMAKE_COMMAND} -E echo "Zeal version: ${ZEAL_VERSION_FULL}"
VERBATIM
)
if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.24.0")
set(CMAKE_COMPILE_WARNING_AS_ERROR ON)
endif()
option(BUILD_TESTING "Build the testing suite" ON)
if(BUILD_TESTING)
enable_testing()
endif()
add_subdirectory(assets)
add_subdirectory(src)
================================================
FILE: CMakePresets.json
================================================
{
"version": 3,
"cmakeMinimumRequired": {
"major": 3,
"minor": 21,
"patch": 0
},
"configurePresets": [
{
"name": "ninja-multi",
"generator": "Ninja Multi-Config",
"binaryDir": "${sourceDir}/build/${presetName}",
"warnings": {
"deprecated": true,
"dev": true,
"uninitialized": true,
"unusedCli": true
}
},
{
"name": "ninja-multi-portable",
"inherits": [
"ninja-multi",
"config-portable"
]
},
{
"name": "ninja-multi-vcpkg",
"condition": {
"type": "equals",
"lhs": "${hostSystemName}",
"rhs": "Windows"
},
"inherits": [
"ninja-multi"
],
"cacheVariables": {
"CMAKE_TOOLCHAIN_FILE": {
"type": "FILEPATH",
"value": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
},
"X_VCPKG_APPLOCAL_DEPS_INSTALL": "ON"
}
},
{
"name": "ninja-multi-vcpkg-portable",
"inherits": [
"ninja-multi-vcpkg",
"config-portable"
]
},
{
"name": "config-portable",
"hidden": true,
"cacheVariables": {
"ZEAL_PORTABLE_BUILD": {
"type": "BOOL",
"value": "ON"
}
}
},
{
"name": "config-release",
"hidden": true,
"cacheVariables": {
"ZEAL_RELEASE_BUILD": {
"type": "BOOL",
"value": "ON"
}
}
},
{
"name": "config-testing",
"hidden": true,
"cacheVariables": {
"BUILD_TESTING": {
"type": "BOOL",
"value": "ON"
}
}
},
{
"name": "ninja-multi-vcpkg-test",
"inherits": [
"ninja-multi-vcpkg",
"config-testing"
]
}
],
"buildPresets": [
{
"name": "ninja-multi-debug",
"configurePreset": "ninja-multi",
"configuration": "Debug"
},
{
"name": "ninja-multi-release",
"configurePreset": "ninja-multi",
"configuration": "RelWithDebInfo"
},
{
"name": "ninja-multi-debug-portable",
"configurePreset": "ninja-multi-portable",
"configuration": "Debug"
},
{
"name": "ninja-multi-portable-release",
"configurePreset": "ninja-multi-portable",
"configuration": "RelWithDebInfo"
},
{
"name": "ninja-multi-vcpkg-debug",
"configurePreset": "ninja-multi-vcpkg",
"configuration": "Debug"
},
{
"name": "ninja-multi-vcpkg-release",
"configurePreset": "ninja-multi-vcpkg",
"configuration": "RelWithDebInfo"
},
{
"name": "ninja-multi-vcpkg-portable-debug",
"configurePreset": "ninja-multi-vcpkg-portable",
"configuration": "Debug"
},
{
"name": "ninja-multi-vcpkg-portable-release",
"configurePreset": "ninja-multi-vcpkg-portable",
"configuration": "RelWithDebInfo"
}
],
"testPresets": [
{
"name": "ninja-multi-vcpkg-test-debug",
"configurePreset": "ninja-multi-vcpkg-test",
"configuration": "Debug",
"output": {
"outputOnFailure": true
}
}
]
}
================================================
FILE: COPYING
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
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.
================================================
FILE: LICENSES/GPL-3.0-or-later.txt
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <https://www.gnu.org/licenses/>.
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:
<program> Copyright (C) <year> <name of author>
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 <https://www.gnu.org/licenses/>.
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 <https://www.gnu.org/philosophy/why-not-lgpl.html>.
================================================
FILE: LICENSES/LicenseRef-Kapeli.txt
================================================
These files are used under permission from Bogdan Popescu (https://github.com/Kapeli).
See https://github.com/Kapeli/Dash-X-Platform-Resources for more details.
================================================
FILE: LICENSES/MIT.txt
================================================
MIT License
Copyright (c) Oleg Shparber, et al. <https://zealdocs.org>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.
================================================
FILE: LICENSES/MS-RL.txt
================================================
Microsoft Reciprocal License (Ms-RL)
This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software.
1. Definitions
The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law.
A "contribution" is the original software, or any additions or changes to the software.
A "contributor" is any person that distributes its contribution under this license.
"Licensed patents" are a contributor's patent claims that read directly on its contribution.
2. Grant of Rights
(A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create.
(B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software.
3. Conditions and Limitations
(A) Reciprocal Grants- For any file you distribute that contains code from the software (in source code or binary format), you must provide recipients the source code to that file along with a copy of this license, which license will govern that file. You may license other files that are entirely your own work and do not contain code from the software under any terms you choose.
(B) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks.
(C) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically.
(D) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software.
(E) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license.
(F) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees, or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement.
================================================
FILE: README.md
================================================
# Zeal
[](https://github.com/zealdocs/zeal/releases)
[](https://gitter.im/zealdocs/zeal)
[](https://web.libera.chat/#zealdocs)
[](https://telegram.me/zealdocsapp)
[](https://twitter.com/zealdocs)
[](https://github.com/zealdocs/zeal/actions/workflows/build-check.yaml)
[](https://scan.coverity.com/projects/4271)
Zeal is a simple offline documentation browser inspired by [Dash](https://kapeli.com/dash).

## Download
Get binary builds for Windows and Linux from the [download page](https://zealdocs.org/download.html).
## How to use
After installing Zeal go to `Tools->Docsets`, select the ones you want, and click the `Download` button.
## How to compile
### Build dependencies
* [CMake](https://cmake.org/).
* [Qt](https://www.qt.io/) version 5.15.2 or above. Required module: Qt WebEngine Widgets.
* [libarchive](https://libarchive.org/).
* [SQLite](https://sqlite.org/).
* X11 platforms only: Qt X11 Extras and `xcb-util-keysyms`.
### Build instructions
```sh
cmake -B build
cmake --build build
```
More detailed instructions are available in the [wiki](https://github.com/zealdocs/zeal/wiki).
## Query & Filter docsets
You can limit the search scope by using ':' to indicate the desired docsets:
`java:BaseDAO`
You can also search multiple docsets separating them with a comma:
`python,django:string`
## Command line
If you prefer, you can start Zeal with a query from the command line:
`zeal python:pprint`
## Create your own docsets
Follow instructions in the [Dash docset generation guide](https://kapeli.com/docsets).
## Contact and Support
We want your feedback! Here's a list of different ways to contact developers and request help:
* Report bugs and submit feature requests to [GitHub issues](https://github.com/zealdocs/zeal/issues).
* Reach developers and other Zeal users in `#zealdocs` IRC channel on [Libera Chat](https://libera.chat) ([web client](https://web.libera.chat/#zealdocs)).
* Ask any questions in our [GitHub discussions](https://github.com/zealdocs/zeal/discussions).
* Do not forget to follow [@zealdocs](https://twitter.com/zealdocs) on Twitter!
* Finally, for private communication shoot an email to <support@zealdocs.org>.
## License
This software is licensed under the terms of the GNU General Public License version 3 (GPLv3) or later. Full text of the license is available in the [COPYING](COPYING) file and [online](https://www.gnu.org/licenses/gpl-3.0.html).
================================================
FILE: REUSE.toml
================================================
version = 1
# GPL-3.0-or-later for the main source code and assets.
[[annotations]]
path = [
"assets/**/*",
"cmake/*",
"pkg/**/*",
"README.md",
"src/**/*.ui",
"src/app/resources/browser/*.html",
"src/app/resources/browser/assets/css/highlight.css",
"src/app/resources/browser/assets/css/welcome.css",
"src/app/resources/icons/**/*",
"src/app/resources/zeal.*",
"src/app/zeal.qrc",
# Windows CMake files.
# CMake and vcpkg files.
"**/*.cmake",
"**/CMakeLists.txt",
"CMakePresets.json",
"vcpkg.json",
]
SPDX-FileCopyrightText = "Oleg Shparber, et al. <https://zealdocs.org>"
SPDX-License-Identifier = "GPL-3.0-or-later"
# MIT for auxiliary files.
[[annotations]]
path = [
".editorconfig",
".gitattributes",
".github/**/*",
".gitignore",
"CHANGELOG.md",
]
SPDX-FileCopyrightText = "Oleg Shparber, et al. <https://zealdocs.org>"
SPDX-License-Identifier = "MIT"
[[annotations]]
path = "src/app/resources/browser/assets/css/oat.min.css"
SPDX-FileCopyrightText = "Copyright (c) Kailash Nadh <https://github.com/knadh/oat>"
SPDX-License-Identifier = "MIT"
[[annotations]]
path = "src/contrib/cpp-httplib/httplib.h"
SPDX-FileCopyrightText = "Copyright (c) 2023 Yuji Hirose. All rights reserved."
SPDX-License-Identifier = "MIT"
[[annotations]]
path = "src/app/resources/icons/type/*.png"
SPDX-FileCopyrightText = "Bogdan Popescu, et al. <https://github.com/Kapeli/Dash-X-Platform-Resources>"
SPDX-License-Identifier = "LicenseRef-Kapeli"
================================================
FILE: assets/CMakeLists.txt
================================================
add_subdirectory(freedesktop)
================================================
FILE: assets/freedesktop/CMakeLists.txt
================================================
if(UNIX AND NOT APPLE)
find_package(ECM 1.0.0 REQUIRED NO_MODULE)
set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH})
include(ECMInstallIcons)
if(QT_VERSION_MAJOR EQUAL 5)
include(KDEInstallDirs)
else()
# Workaround until KDEInstallDirs6 is ready to use.
include(GNUInstallDirs)
set(KDE_INSTALL_APPDIR "${CMAKE_INSTALL_DATAROOTDIR}/applications")
set(KDE_INSTALL_ICONDIR "${CMAKE_INSTALL_DATAROOTDIR}/icons")
set(KDE_INSTALL_METAINFODIR "${CMAKE_INSTALL_DATAROOTDIR}/metainfo")
endif()
ecm_install_icons(ICONS "16-apps-zeal.png"
"24-apps-zeal.png"
"32-apps-zeal.png"
"64-apps-zeal.png"
"128-apps-zeal.png"
DESTINATION ${KDE_INSTALL_ICONDIR}
)
# For development builds insert an extra release in the AppStream metadata.
if(NOT ZEAL_RELEASE_BUILD)
string(TIMESTAMP ZEAL_APPSTREAM_DEV_RELEASE "\n <release date=\"%Y-%m-%d\" version=\"${ZEAL_VERSION_FULL}\" type=\"development\" />")
endif()
configure_file(
org.zealdocs.zeal.appdata.xml.in
org.zealdocs.zeal.appdata.xml
)
install(FILES ${CMAKE_BINARY_DIR}/assets/freedesktop/org.zealdocs.zeal.appdata.xml
DESTINATION ${KDE_INSTALL_METAINFODIR}
)
install(FILES "org.zealdocs.zeal.desktop"
DESTINATION ${KDE_INSTALL_APPDIR}
)
endif()
================================================
FILE: assets/freedesktop/org.zealdocs.zeal.appdata.xml.in
================================================
<?xml version="1.0" encoding="UTF-8"?>
<component type="desktop">
<id>org.zealdocs.zeal</id>
<launchable type="desktop-id">org.zealdocs.zeal.desktop</launchable>
<name>Zeal</name>
<metadata_license>CC0-1.0</metadata_license>
<project_license>GPL-3.0-or-later</project_license>
<developer id="org.zealdocs">
<name>Oleg Shparber</name>
</developer>
<summary>Documentation browser</summary>
<description>
<p>Zeal is a simple offline documentation browser inspired by Dash. It offers access to over 200 docsets covering various libraries and APIs.</p>
</description>
<categories>
<category>Development</category>
</categories>
<url type="homepage">https://zealdocs.org/</url>
<url type="bugtracker">https://github.com/zealdocs/zeal/issues</url>
<url type="help">https://zealdocs.org/usage.html</url>
<url type="contact">https://go.zealdocs.org/l/contact</url>
<screenshots>
<screenshot type="default">
<caption>The main window</caption>
<image>https://i.imgur.com/FvGEguY.png</image>
</screenshot>
</screenshots>
<provides>
<id>zeal.desktop</id>
</provides>
<releases>@ZEAL_APPSTREAM_DEV_RELEASE@
<release date="2025-02-27" version="0.8.0" type="stable">
<url>https://github.com/zealdocs/zeal/releases/tag/v0.8.0</url>
</release>
<release date="2024-09-08" version="0.7.2" type="stable">
<url>https://github.com/zealdocs/zeal/releases/tag/v0.7.2</url>
</release>
<release date="2024-05-27" version="0.7.1" type="stable">
<url>https://github.com/zealdocs/zeal/releases/tag/v0.7.1</url>
</release>
<release date="2023-09-20" version="0.7.0" type="stable">
<url>https://github.com/zealdocs/zeal/releases/tag/v0.7.0</url>
</release>
<release date="2018-09-28" version="0.6.1" type="stable">
<url>https://github.com/zealdocs/zeal/releases/tag/v0.6.1</url>
</release>
</releases>
<update_contact>support@zealdocs.org</update_contact>
<content_rating type="oars-1.1" />
</component>
================================================
FILE: assets/freedesktop/org.zealdocs.zeal.desktop
================================================
[Desktop Entry]
Version=1.0
Name=Zeal
GenericName=Documentation Browser
Comment=Simple API documentation browser
Exec=zeal %u
Icon=zeal
Terminal=false
Type=Application
Categories=Development;Documentation;
MimeType=x-scheme-handler/dash;x-scheme-handler/dash-plugin;
StartupWMClass=Zeal
================================================
FILE: cmake/CodeSign.cmake
================================================
#
# CodeSign.cmake - CMake helper for signing Windows executables
#
# SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>
# SPDX-License-Identifier: MIT
#
include_guard()
# codesign(FILES <files>...
# [DESCRIPTION] <description-string>
# [URL] <url-string>
# [CERTIFICATE_FILE] <filename>
# [PASSWORD] <password-string>
# [TIMESTAMP_URL] <url-string>
# [QUIET]
# [VERBOSE]
# [DEBUG])
function(codesign)
# Cleans up temporary files created during signing.
macro(_cleanup)
if(DEFINED _certificate_file)
file(REMOVE ${_certificate_file})
endif()
endmacro()
# Sets '_certificate_file' variable to a temporary file path.
macro(_set_temporary_certificate_file)
# Determine temporary file location. Try to keep it local to the build.
if(CMAKE_BINARY_DIR)
set(_temp_path ${CMAKE_BINARY_DIR})
elseif(CPACK_TEMPORARY_DIRECTORY)
set(_temp_path ${CPACK_TEMPORARY_DIRECTORY})
else()
set(_temp_path $ENV{TEMP})
endif()
set(_certificate_file "${_temp_path}/codesign.tmp")
# Remove file if left from previous run.
_cleanup()
endmacro()
if(NOT WIN32)
message(FATAL_ERROR "Code signing is only supported on Windows.")
endif()
cmake_parse_arguments(_ARG
"QUIET;VERBOSE;DEBUG" # Options.
"DESCRIPTION;URL;CERTIFICATE_FILE;PASSWORD;TIMESTAMP_URL" # Single-value keywords.
"FILES" # Multi-value keywords.
${ARGN}
)
if(NOT _ARG_FILES)
message(FATAL_ERROR "FILES argument is required.")
endif()
# Find signtool executable.
# TODO: Add option for path to signtool.exe.
# Add Windows 10 SDK paths.
get_filename_component(_w10sdk_root_path
"[HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows Kits\\Installed Roots;KitsRoot10]"
ABSOLUTE CACHE
)
if(_w10sdk_root_path)
file(GLOB _w10sdk_paths "${_w10sdk_root_path}/bin/10.*")
list(REVERSE _w10sdk_paths) # Newest version first.
# Detect target architecture.
# https://learn.microsoft.com/en-us/windows/win32/winprog64/wow64-implementation-details#environment-variables
if(CMAKE_SYSTEM_PROCESSOR STREQUAL "AMD64")
set(_w10sdk_arch "x64")
elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "X86")
set(_w10sdk_arch "x86")
elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "ARM64")
set(_w10sdk_arch "arm64")
else()
message(WARNING "Unknown architecture: ${CMAKE_SYSTEM_PROCESSOR}.")
endif()
endif()
# TODO: Add microsoft.windows.sdk.buildtools path.
find_program(_cmd
NAMES signtool
PATHS ${_w10sdk_paths}
PATH_SUFFIXES ${_w10sdk_arch}
)
if(NOT _cmd)
message(NOTICE "signtool.exe was not found, no binaries will be signed.")
return()
endif()
message(DEBUG "Found signtool.exe: ${_cmd}")
# Start constructing command.
set(_cmd_args "sign")
list(APPEND _cmd_args "/fd" "sha256")
# Set certificate file.
if(NOT _ARG_CERTIFICATE_FILE)
if(CODESIGN_CERTIFICATE_FILE)
if(NOT EXISTS ${CODESIGN_CERTIFICATE_FILE})
message(NOTICE "Certificate file '${CODESIGN_CERTIFICATE_FILE}' does not exist.")
return()
endif()
set(_ARG_CERTIFICATE_FILE ${CODESIGN_CERTIFICATE_FILE})
elseif(DEFINED ENV{CODESIGN_CERTIFICATE_FILE})
if("$ENV{CODESIGN_CERTIFICATE_FILE}" STREQUAL "")
message(NOTICE "CODESIGN_CERTIFICATE_FILE is set to an empty string.")
return()
endif()
if(NOT EXISTS $ENV{CODESIGN_CERTIFICATE_FILE})
message(NOTICE "Certificate file '$ENV{CODESIGN_CERTIFICATE_FILE}' (set in CODESIGN_CERTIFICATE_FILE) does not exist.")
return()
endif()
set(_ARG_CERTIFICATE_FILE $ENV{CODESIGN_CERTIFICATE_FILE})
elseif(DEFINED ENV{CODESIGN_CERTIFICATE})
if("$ENV{CODESIGN_CERTIFICATE}" STREQUAL "")
message(NOTICE "CODESIGN_CERTIFICATE is set to an empty string.")
return()
endif()
# Store certificate value in a temporary file for signtool to use.
_set_temporary_certificate_file()
file(WRITE ${_certificate_file} $ENV{CODESIGN_CERTIFICATE})
set(_ARG_CERTIFICATE_FILE ${_certificate_file})
elseif(DEFINED ENV{CODESIGN_CERTIFICATE_BASE64})
if("$ENV{CODESIGN_CERTIFICATE_BASE64}" STREQUAL "")
message(NOTICE "CODESIGN_CERTIFICATE_BASE64 is set to an empty string.")
return()
endif()
# Read base64-encoded certificate from environment variable,
# decode with `certutil.exe`, and store in a temporary file
# for signtool to use.
#
# This is useful for GitHub Actions, which cannot handle unencoded
# multiline secrets.
_set_temporary_certificate_file()
# Save base64-encoded certificate to file.
set(_certificate_base64_file "${_certificate_file}.base64")
file(WRITE ${_certificate_base64_file} $ENV{CODESIGN_CERTIFICATE_BASE64})
# Decode certificate.
set(_cmd_certutil_args "-decode" ${_certificate_base64_file} ${_certificate_file})
execute_process(COMMAND "certutil.exe" ${_cmd_certutil_args}
RESULT_VARIABLE _rc
OUTPUT_VARIABLE _stdout
# For some reason certutil prints errors to stdout.
# ERROR_VARIABLE _stderr
)
# Remove temporary file first.
file(REMOVE ${_certificate_base64_file})
if(NOT _rc EQUAL 0)
message(WARNING "Failed to decode certificate: ${_stdout}")
_cleanup()
return()
endif()
unset(_rc)
unset(_stdout)
set(_ARG_CERTIFICATE_FILE ${_certificate_file})
else()
message(NOTICE "Certificate is not provided, no binaries will be signed.")
return()
endif()
endif()
list(APPEND _cmd_args "/f" ${_ARG_CERTIFICATE_FILE})
# Set password.
if(NOT _ARG_PASSWORD)
if(CODESIGN_PASSWORD)
set(_ARG_PASSWORD ${CODESIGN_PASSWORD})
elseif(DEFINED ENV{CODESIGN_PASSWORD})
if("$ENV{CODESIGN_PASSWORD}" STREQUAL "")
message(NOTICE "CODESIGN_PASSWORD is set to an empty string. Unset if not used.")
_cleanup()
return()
endif()
set(_ARG_PASSWORD $ENV{CODESIGN_PASSWORD})
endif()
endif()
if(_ARG_PASSWORD)
list(APPEND _cmd_args "/p" ${_ARG_PASSWORD})
endif()
# Set description.
if(NOT _ARG_DESCRIPTION AND PROJECT_DESCRIPTION)
set(_ARG_DESCRIPTION ${PROJECT_DESCRIPTION})
endif()
if(_ARG_DESCRIPTION)
list(APPEND _cmd_args "/d" ${_ARG_DESCRIPTION})
endif()
# Set project URL.
if(NOT _ARG_URL AND PROJECT_HOMEPAGE_URL)
set(_ARG_URL ${PROJECT_HOMEPAGE_URL})
endif()
if(_ARG_URL)
list(APPEND _cmd_args "/du" ${_ARG_URL})
endif()
# Set timestamp server.
if(NOT _ARG_TIMESTAMP_URL)
set(_ARG_TIMESTAMP_URL "http://timestamp.digicert.com")
endif()
if(_ARG_TIMESTAMP_URL)
list(APPEND _cmd_args "/tr" ${_ARG_TIMESTAMP_URL} "/td" "sha256")
endif()
# Set quiet, verbose, or debug options.
if(_ARG_QUIET)
list(APPEND _cmd_args "/q")
endif()
if(_ARG_VERBOSE)
list(APPEND _cmd_args "/v")
endif()
if(_ARG_DEBUG)
list(APPEND _cmd_args "/debug")
endif()
foreach(_file ${_ARG_FILES})
if(NOT EXISTS ${_file})
message(NOTICE "Cannot find file to sign: ${_file}")
continue()
endif()
message(STATUS "Signing ${_file}...")
execute_process(
COMMAND "${_cmd}" ${_cmd_args} "${_file}"
RESULT_VARIABLE _rc
OUTPUT_VARIABLE _stdout
ERROR_VARIABLE _stderr
)
if(_rc EQUAL 0)
message(STATUS "Successfully signed: ${_file}")
else()
message(NOTICE "Failed to sign: ${_stderr}")
if(NOT _ARG_QUIET)
message(VERBOSE ${_stdout})
endif()
endif()
endforeach()
_cleanup()
endfunction()
================================================
FILE: cmake/GetVersionFromGit.cmake
================================================
#
# GetVersionFromGit.cmake - CMake helper for getting version information from Git
#
# SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>
# SPDX-License-Identifier: MIT
#
# Based on https://github.com/fakenmc/cmake-git-semver by Nuno Fachada.
# This module is public domain, use it as it fits you best.
#
# This cmake module sets the project version and partial version
# variables by analysing the git tag and commit history. It expects git
# tags defined with semantic versioning 2.0.0 (http://semver.org/).
#
# The module expects the PROJECT_NAME variable to be set, and recognizes
# the GIT_FOUND, GIT_EXECUTABLE and VERSION_UPDATE_FROM_GIT variables.
# If Git is found and VERSION_UPDATE_FROM_GIT is set to boolean TRUE,
# the project version will be updated using information fetched from the
# most recent git tag and commit. Otherwise, the module will try to read
# a VERSION file containing the full and partial versions. The module
# will update this file each time the project version is updated.
#
# Once done, this module will define the following variables:
#
# ${PROJECT_NAME}_GIT_VERSION_STRING - Version string without metadata
# such as "v2.0.0" or "v1.2.41-beta.1". This should correspond to the
# most recent git tag.
# ${PROJECT_NAME}_GIT_VERSION_STRING_FULL - Version string with metadata
# such as "v2.0.0+3.a23fbc" or "v1.3.1-alpha.2+4.9c4fd1"
# ${PROJECT_NAME}_GIT_VERSION_MAJOR - Major version integer (e.g. 2 in v2.3.1-RC.2+21.ef12c8)
# ${PROJECT_NAME}_GIT_VERSION_MINOR - Minor version integer (e.g. 3 in v2.3.1-RC.2+21.ef12c8)
# ${PROJECT_NAME}_GIT_VERSION_PATCH - Patch version integer (e.g. 1 in v2.3.1-RC.2+21.ef12c8)
# ${PROJECT_NAME}_GIT_VERSION_TWEAK - Tweak version string (e.g. "RC.2" in v2.3.1-RC.2+21.ef12c8)
# ${PROJECT_NAME}_GIT_VERSION_AHEAD - How many commits ahead of last tag (e.g. 21 in v2.3.1-RC.2+21.ef12c8)
# ${PROJECT_NAME}_GIT_VERSION_SHA - The git sha1 of the most recent commit (e.g. the "ef12c8" in v2.3.1-RC.2+21.ef12c8)
# Only if VERSION_UPDATE_FROM_GIT is TRUE:
# ${PROJECT_NAME}_VERSION - Same as ${PROJECT_NAME}_GIT_VERSION_STRING,
# without the preceding 'v', e.g. "2.0.0" or "1.2.41-beta.1"
# Check if .git directory is present.
if(NOT IS_DIRECTORY "${CMAKE_SOURCE_DIR}/.git")
message(NOTICE "Cannot find Git metadata, using static version string.")
return()
endif()
# Check if Git executable is present.
find_package(Git)
if(NOT GIT_FOUND)
message(NOTICE "Cannot find Git executable, using static version string.")
return()
endif()
# Check if Git executable version is >= 2.15. Required for --is-shallow-repository argument.
# See https://stackoverflow.com/a/37533086.
if(GIT_VERSION_STRING VERSION_LESS "2.15")
message(NOTICE "Git executable is too old (< 2.15), using static version string.")
return()
endif()
# Detect shallow clone.
execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse --is-shallow-repository
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
RESULT_VARIABLE IS_SHALLOW_RESULT
OUTPUT_VARIABLE IS_SHALLOW_OUTPUT
OUTPUT_STRIP_TRAILING_WHITESPACE
ERROR_QUIET)
if(IS_SHALLOW_RESULT AND NOT IS_SHALLOW_RESULT EQUAL 0)
message(NOTICE "Cannot perform shallow clone detection, using static version string.")
unset(IS_SHALLOW_RESULT)
unset(IS_SHALLOW_OUTPUT)
return()
endif()
unset(IS_SHALLOW_RESULT)
if(NOT "${IS_SHALLOW_OUTPUT}" STREQUAL "false")
message(NOTICE "Shallow clone detected, using static version string.")
unset(IS_SHALLOW_OUTPUT)
return()
endif()
unset(IS_SHALLOW_OUTPUT)
# Get last tag from git
execute_process(COMMAND ${GIT_EXECUTABLE} describe --abbrev=0 --tags
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
OUTPUT_VARIABLE ${PROJECT_NAME}_GIT_VERSION_STRING
OUTPUT_STRIP_TRAILING_WHITESPACE)
# How many commits since the last tag
execute_process(COMMAND ${GIT_EXECUTABLE} rev-list ${${PROJECT_NAME}_GIT_VERSION_STRING}^..HEAD --count
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
OUTPUT_VARIABLE ${PROJECT_NAME}_GIT_VERSION_AHEAD
OUTPUT_STRIP_TRAILING_WHITESPACE)
# Get current commit SHA from git
execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
OUTPUT_VARIABLE ${PROJECT_NAME}_GIT_VERSION_SHA
OUTPUT_STRIP_TRAILING_WHITESPACE)
# Get partial versions into a list
string(REGEX MATCHALL "-.*$|[0-9]+" ${PROJECT_NAME}_PARTIAL_VERSION_LIST
${${PROJECT_NAME}_GIT_VERSION_STRING})
# Set the version numbers
list(GET ${PROJECT_NAME}_PARTIAL_VERSION_LIST
0 ${PROJECT_NAME}_GIT_VERSION_MAJOR)
list(GET ${PROJECT_NAME}_PARTIAL_VERSION_LIST
1 ${PROJECT_NAME}_GIT_VERSION_MINOR)
list(GET ${PROJECT_NAME}_PARTIAL_VERSION_LIST
2 ${PROJECT_NAME}_GIT_VERSION_PATCH)
# Calculate next patch version.
math(EXPR ${PROJECT_NAME}_GIT_VERSION_PATCH_NEXT ${${PROJECT_NAME}_GIT_VERSION_PATCH}+1)
# The tweak part is optional, so check if the list contains it
list(LENGTH ${PROJECT_NAME}_PARTIAL_VERSION_LIST
${PROJECT_NAME}_PARTIAL_VERSION_LIST_LEN)
if (${PROJECT_NAME}_PARTIAL_VERSION_LIST_LEN GREATER 3)
list(GET ${PROJECT_NAME}_PARTIAL_VERSION_LIST 3 ${PROJECT_NAME}_GIT_VERSION_TWEAK)
string(SUBSTRING ${${PROJECT_NAME}_GIT_VERSION_TWEAK} 1 -1 ${PROJECT_NAME}_GIT_VERSION_TWEAK)
endif()
# Unset the list
unset(${PROJECT_NAME}_PARTIAL_VERSION_LIST)
# Set full project version string
set(${PROJECT_NAME}_GIT_VERSION_STRING_FULL
${${PROJECT_NAME}_GIT_VERSION_STRING}+${${PROJECT_NAME}_GIT_VERSION_AHEAD}.${${PROJECT_NAME}_GIT_VERSION_SHA})
if(VERSION_UPDATE_FROM_GIT)
# Set project version (without the preceding 'v')
set(${PROJECT_NAME}_VERSION ${${PROJECT_NAME}_GIT_VERSION_MAJOR}.${${PROJECT_NAME}_GIT_VERSION_MINOR}.${${PROJECT_NAME}_GIT_VERSION_PATCH})
if (${PROJECT_NAME}_GIT_VERSION_TWEAK)
set(${PROJECT_NAME}_VERSION ${${PROJECT_NAME}_VERSION}-${${PROJECT_NAME}_GIT_VERSION_TWEAK})
endif()
endif()
================================================
FILE: cmake/MacOSXBundleInfo.plist.in
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleExecutable</key>
<string>${MACOSX_BUNDLE_EXECUTABLE_NAME}</string>
<key>CFBundleIconFile</key>
<string>${MACOSX_BUNDLE_ICON_FILE}</string>
<key>CFBundleIdentifier</key>
<string>${MACOSX_BUNDLE_GUI_IDENTIFIER}</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleLongVersionString</key>
<string>${MACOSX_BUNDLE_LONG_VERSION_STRING}</string>
<key>CFBundleName</key>
<string>${MACOSX_BUNDLE_BUNDLE_NAME}</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>${MACOSX_BUNDLE_SHORT_VERSION_STRING}</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>${MACOSX_BUNDLE_BUNDLE_VERSION}</string>
<key>CSResourcesFileMapped</key>
<true/>
<key>NSHumanReadableCopyright</key>
<string>${MACOSX_BUNDLE_COPYRIGHT}</string>
<key>NSPrincipalClass</key>
<string>NSApplication</string>
<key>NSHighResolutionCapable</key>
<true/>
<key>NSSupportsAutomaticGraphicsSwitching</key>
<true/>
</dict>
</plist>
================================================
FILE: pkg/appimage/README.md
================================================
# AppImage Package
## Local Testing
Run Docker container:
```shell
docker run -it --rm -v $(pwd):/src --entrypoint /bin/bash ubuntu:jammy
```
Install `appimage-builder` and `appimagetool` dependencies:
```shell
apt-get update -q -y
DEBIAN_FRONTEND="noninteractive" apt-get install -q -y --no-install-recommends appstream curl desktop-file-utils fakeroot file git gnupg patchelf squashfs-tools zsync python3-pip python3-setuptools python3-wheel
```
Install appimagetool, it has to be extracted because FUSE doesn't work in containers without extra fiddling.
```shell
cd /tmp
curl -sLO https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage
chmod +x appimagetool-x86_64.AppImage
./appimagetool-x86_64.AppImage --appimage-extract
mv squashfs-root/ /opt/appimagetool.AppDir
ln -s /opt/appimagetool.AppDir/AppRun /usr/local/bin/appimagetool
cd -
```
Install appimage-builder.
```shell
pip3 install git+https://github.com/AppImageCrafters/appimage-builder.git@669213cb730e007d5b316ed19b39691fbdcd41c4
```
Install build dependencies:
```shell
apt-get install -q -y --no-install-recommends build-essential cmake extra-cmake-modules libappindicator-dev libarchive-dev libqt5x11extras5-dev libsqlite3-dev libxcb-keysyms1-dev ninja-build qtbase5-dev qtwebengine5-dev
```
Run `appimage-builder`:
```shell
cd /src
appimage-builder --skip-test --build-dir build.appimage --appdir build.appimage/AppDir --recipe pkg/appimage/appimage-amd64.yaml
```
================================================
FILE: pkg/appimage/appimage-amd64.yaml
================================================
version: 1
script:
- cmake -B $BUILD_DIR/cmake-build -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo
- cmake --build $BUILD_DIR/cmake-build
- cmake --install $BUILD_DIR/cmake-build --prefix $TARGET_APPDIR/usr
- appstreamcli validate $TARGET_APPDIR/usr/share/metainfo/org.zealdocs.zeal.appdata.xml
AppDir:
app_info:
id: org.zealdocs.zeal
name: zeal
icon: zeal
version: 0.8.0 # TODO: Use version from CMake.
exec: usr/bin/zeal
exec_args: $@
runtime:
env:
APPDIR_LIBRARY_PATH: $APPDIR/lib/x86_64-linux-gnu:$APPDIR/usr/lib/x86_64-linux-gnu
QTWEBENGINE_DISABLE_SANDBOX: 1
apt:
arch: amd64
sources:
- sourceline: deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ jammy main restricted universe multiverse
key_url: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x871920d1991bc93c
- sourceline: deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ jammy-updates main restricted universe multiverse
- sourceline: deb [arch=amd64] http://security.ubuntu.com/ubuntu/ jammy-security main restricted universe multiverse
- sourceline: deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ jammy-backports main restricted universe multiverse
include:
# Required Qt packages.
- libqt5concurrent5
- libqt5gui5
- libqt5network5
- libqt5webchannel5
- libqt5webengine5
- libqt5webenginewidgets5
- libqt5widgets5
- libqt5x11extras5
- qt5-gtk-platformtheme
- qtwayland5
# Other dependencies.
- libsqlite3-0
- libarchive13
- libfontconfig1
- libfreetype6
exclude:
- "*dbgsym*"
- adwaita-icon-theme
- dconf-service
- gcc-*
- gnupg
- humanity-icon-theme
- libsystemd0
- libwacom*
- perl
- perl-*
- sound-theme-freedesktop
- systemd
- systemd-*
files:
exclude:
- etc/systemd
- lib/systemd
- usr/bin/*-linux-gnu-*
- usr/bin/dpkg*
- usr/bin/systemd*
- usr/include
- usr/lib/x86_64-linux-gnu/gconv
- usr/share/doc
- usr/share/man
AppImage:
arch: x86_64
comp: zstd
sign-key: None
update-information: gh-releases-zsync|zealdocs|zeal|latest|zeal-*x86_64.AppImage.zsync
================================================
FILE: pkg/wix/cpack_post_build.cmake
================================================
if(CPACK_SOURCE_INSTALLED_DIRECTORIES)
message(DEBUG "Skipping package signing for source package generator.")
return()
endif()
if(NOT CPACK_GENERATOR STREQUAL "WIX")
message(DEBUG "Skipping package signing for ${CPACK_GENERATOR} generator.")
return()
endif()
include(CodeSign)
codesign(FILES ${CPACK_PACKAGE_FILES} QUIET)
================================================
FILE: pkg/wix/cpack_pre_build.cmake
================================================
if(CPACK_SOURCE_INSTALLED_DIRECTORIES)
message(DEBUG "Skipping package signing for source package generator.")
return()
endif()
# TODO: Automatically generate list.
set(_file_list
"zeal.exe"
"archive.dll"
"zlib1.dll"
"sqlite3.dll"
)
include(CodeSign)
foreach(_file ${_file_list})
codesign(FILES "${CPACK_TEMPORARY_DIRECTORY}/${_file}" QUIET)
endforeach()
================================================
FILE: pkg/wix/exitdialog.wxs
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->
<!-- SPDX-FileCopyrightText: .NET Foundation and contributors. All rights reserved. -->
<!-- SPDX-License-Identifier: MS-RL -->
<!-- Upstream: https://github.com/wixtoolset/wix3/blob/develop/src/ext/UIExtension/wixlib/ExitDialog.wxs -->
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Fragment>
<UI>
<Dialog Id="Zeal_ExitDialog" Width="370" Height="270" Title="!(loc.ExitDialog_Title)">
<Control Id="Finish" Type="PushButton" X="236" Y="243" Width="56" Height="17" Default="yes" Cancel="yes" Text="!(loc.WixUIFinish)" />
<Control Id="Cancel" Type="PushButton" X="304" Y="243" Width="56" Height="17" Disabled="yes" Text="!(loc.WixUICancel)" />
<Control Id="Bitmap" Type="Bitmap" X="0" Y="0" Width="370" Height="234" TabSkip="no" Text="!(loc.ExitDialogBitmap)" />
<Control Id="Back" Type="PushButton" X="180" Y="243" Width="56" Height="17" Disabled="yes" Text="!(loc.WixUIBack)" />
<Control Id="BottomLine" Type="Line" X="0" Y="234" Width="370" Height="0" />
<Control Id="Description" Type="Text" X="135" Y="70" Width="220" Height="40" Transparent="yes" NoPrefix="yes" Text="!(loc.ExitDialogDescription)" />
<Control Id="Title" Type="Text" X="135" Y="20" Width="220" Height="60" Transparent="yes" NoPrefix="yes" Text="!(loc.ExitDialogTitle)" />
<!-- Customization for Zeal installer. -->
<Control Id="LaunchCheckBox" Type="CheckBox" X="20" Y="243" Width="100" Height="17" Property="LAUNCHAPPONEXIT" Hidden="yes" CheckBoxValue="1" Text="Launch [ProductName]">
<Condition Action="show">NOT Installed OR WIX_UPGRADE_DETECTED</Condition>
</Control>
</Dialog>
<InstallUISequence>
<Show Dialog="Zeal_ExitDialog" OnExit="success" Overridable="yes" />
</InstallUISequence>
<AdminUISequence>
<Show Dialog="Zeal_ExitDialog" OnExit="success" Overridable="yes" />
</AdminUISequence>
</UI>
</Fragment>
</Wix>
================================================
FILE: pkg/wix/patch.xml
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
<CPackWiXPatch>
<CPackWiXFragment Id="#PRODUCT">
<Condition Message="This package can only be installed on 64-bit versions of Windows."><![CDATA[VersionNT64]]></Condition>
</CPackWiXFragment>
</CPackWiXPatch>
================================================
FILE: pkg/wix/template.xml
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
<!-- Based on: https://gitlab.kitware.com/cmake/cmake/-/blob/master/Utilities/Release/WiX/WIX.template.in -->
<?include "cpack_variables.wxi"?>
<?define AppExeName="zeal.exe" ?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"
xmlns:util="http://schemas.microsoft.com/wix/UtilExtension"
RequiredVersion="3.6.3303.0">
<Product Id="$(var.CPACK_WIX_PRODUCT_GUID)"
Name="$(var.CPACK_PACKAGE_NAME)"
Language="1033"
Version="$(var.CPACK_PACKAGE_VERSION)"
Manufacturer="$(var.CPACK_PACKAGE_VENDOR)"
UpgradeCode="$(var.CPACK_WIX_UPGRADE_GUID)">
<Package InstallScope="perMachine" InstallerVersion="301" Compressed="yes"/>
<Media Id="1" Cabinet="media1.cab" EmbedCab="yes"/>
<MajorUpgrade
Schedule="afterInstallInitialize"
DowngradeErrorMessage="A later version of [ProductName] is already installed. Setup will now exit."/>
<WixVariable Id="WixUILicenseRtf" Value="$(var.CPACK_WIX_LICENSE_RTF)"/>
<Property Id="WIXUI_INSTALLDIR" Value="INSTALL_ROOT"/>
<?ifdef CPACK_WIX_PRODUCT_ICON?>
<Property Id="ARPPRODUCTICON">ProductIcon.ico</Property>
<Icon Id="ProductIcon.ico" SourceFile="$(var.CPACK_WIX_PRODUCT_ICON)"/>
<?endif?>
<?ifdef CPACK_WIX_UI_BANNER?>
<WixVariable Id="WixUIBannerBmp" Value="$(var.CPACK_WIX_UI_BANNER)"/>
<?endif?>
<?ifdef CPACK_WIX_UI_DIALOG?>
<WixVariable Id="WixUIDialogBmp" Value="$(var.CPACK_WIX_UI_DIALOG)"/>
<?endif?>
<UI>
<UIRef Id="$(var.CPACK_WIX_UI_REF)"/>
<Publish Dialog="Zeal_ExitDialog" Control="Finish" Order="1" Event="DoAction" Value="LaunchApplication">LAUNCHAPPONEXIT</Publish>
</UI>
<?include "properties.wxi"?>
<?include "product_fragment.wxi"?>
<!-- Dash protocol handlers. -->
<Component Id="ProtocolHandlers" Directory="INSTALL_ROOT">
<?foreach UrlScheme in dash;dash-plugin ?>
<!-- Remove broken HKCU keys. -->
<RemoveRegistryKey Action="removeOnInstall" Root="HKCU" Key="Software\Classes\$(var.UrlScheme)" />
<RegistryKey Root="HKLM" Key="Software\Classes\$(var.UrlScheme)">
<RegistryValue Type="string" Value="URL:Dash Plugin Protocol (Zeal)" />
<RegistryValue Name="URL Protocol" Type="string" Value="" />
<RegistryKey Key="DefaultIcon">
<RegistryValue Type="string" Value=""[#CM_FP_zeal.exe],1"" />
</RegistryKey>
<RegistryKey Key="shell\open\command">
<RegistryValue Type="string" Value=""[#CM_FP_zeal.exe]" "%1"" />
</RegistryKey>
</RegistryKey>
<?endforeach ?>
</Component>
<!-- Custom properties to control installation options -->
<Property Id="LAUNCHAPPONEXIT" Value="1" Secure="yes"/>
<!-- Set properties based on existing conditions, prevents changing state on upgrade. -->
<SetProperty Id="LicenseAccepted" After="AppSearch" Value="1">WIX_UPGRADE_DETECTED</SetProperty>
<FeatureRef Id="ProductFeature">
<ComponentRef Id="ProtocolHandlers" />
</FeatureRef>
<!-- Action to launch application after installer exits. -->
<Property Id="WixShellExecTarget" Value="[#CM_FP_zeal.exe]"/>
<CustomAction Id="LaunchApplication" BinaryKey="WixCA" DllEntry="WixShellExec" Impersonate="yes"/>
<!-- Close running Zeal processes. -->
<util:CloseApplication CloseMessage="yes" Target="$(var.AppExeName)" ElevatedCloseMessage="yes" RebootPrompt="no" TerminateProcess="0" />
<InstallExecuteSequence>
<Custom Action="WixCloseApplications" Before="RemoveFiles" />
</InstallExecuteSequence>
</Product>
</Wix>
================================================
FILE: pkg/wix/ui.wxs
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->
<!-- SPDX-FileCopyrightText: .NET Foundation and contributors. All rights reserved. -->
<!-- SPDX-License-Identifier: MS-RL -->
<!-- Upstream: https://github.com/wixtoolset/wix3/blob/develop/src/ext/UIExtension/wixlib/WixUI_InstallDir.wxs -->
<!--
First-time install dialog sequence:
- WixUI_WelcomeDlg
- WixUI_LicenseAgreementDlg
- WixUI_InstallDirDlg
- WixUI_VerifyReadyDlg
- WixUI_DiskCostDlg
Maintenance dialog sequence:
- WixUI_MaintenanceWelcomeDlg
- WixUI_MaintenanceTypeDlg
- WixUI_InstallDirDlg
- WixUI_VerifyReadyDlg
Patch dialog sequence:
- WixUI_WelcomeDlg
- WixUI_VerifyReadyDlg
-->
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Fragment>
<UI Id="Zeal_InstallDir">
<TextStyle Id="WixUI_Font_Normal" FaceName="Tahoma" Size="8" />
<TextStyle Id="WixUI_Font_Bigger" FaceName="Tahoma" Size="12" />
<TextStyle Id="WixUI_Font_Title" FaceName="Tahoma" Size="9" Bold="yes" />
<Property Id="DefaultUIFont" Value="WixUI_Font_Normal" />
<Property Id="WixUI_Mode" Value="InstallDir" />
<DialogRef Id="BrowseDlg" />
<DialogRef Id="DiskCostDlg" />
<DialogRef Id="ErrorDlg" />
<DialogRef Id="FatalError" />
<DialogRef Id="FilesInUse" />
<DialogRef Id="MsiRMFilesInUse" />
<DialogRef Id="PrepareDlg" />
<DialogRef Id="ProgressDlg" />
<DialogRef Id="ResumeDlg" />
<DialogRef Id="UserExit" />
<Publish Dialog="BrowseDlg" Control="OK" Event="DoAction" Value="WixUIValidatePath" Order="3">1</Publish>
<Publish Dialog="BrowseDlg" Control="OK" Event="SpawnDialog" Value="InvalidDirDlg" Order="4"><![CDATA[NOT WIXUI_DONTVALIDATEPATH AND WIXUI_INSTALLDIR_VALID<>"1"]]></Publish>
<Publish Dialog="Zeal_ExitDialog" Control="Finish" Event="EndDialog" Value="Return" Order="999">1</Publish>
<Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="LicenseAgreementDlg">NOT Installed</Publish>
<Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="VerifyReadyDlg">Installed AND PATCH</Publish>
<Publish Dialog="LicenseAgreementDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg">1</Publish>
<Publish Dialog="LicenseAgreementDlg" Control="Next" Event="NewDialog" Value="InstallDirDlg">LicenseAccepted = "1"</Publish>
<Publish Dialog="InstallDirDlg" Control="Back" Event="NewDialog" Value="LicenseAgreementDlg">1</Publish>
<Publish Dialog="InstallDirDlg" Control="Next" Event="SetTargetPath" Value="[WIXUI_INSTALLDIR]" Order="1">1</Publish>
<Publish Dialog="InstallDirDlg" Control="Next" Event="DoAction" Value="WixUIValidatePath" Order="2">NOT WIXUI_DONTVALIDATEPATH</Publish>
<Publish Dialog="InstallDirDlg" Control="Next" Event="SpawnDialog" Value="InvalidDirDlg" Order="3"><![CDATA[NOT WIXUI_DONTVALIDATEPATH AND WIXUI_INSTALLDIR_VALID<>"1"]]></Publish>
<Publish Dialog="InstallDirDlg" Control="Next" Event="NewDialog" Value="VerifyReadyDlg" Order="4">WIXUI_DONTVALIDATEPATH OR WIXUI_INSTALLDIR_VALID="1"</Publish>
<Publish Dialog="InstallDirDlg" Control="ChangeFolder" Property="_BrowseProperty" Value="[WIXUI_INSTALLDIR]" Order="1">1</Publish>
<Publish Dialog="InstallDirDlg" Control="ChangeFolder" Event="SpawnDialog" Value="BrowseDlg" Order="2">1</Publish>
<Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="InstallDirDlg" Order="1">NOT Installed</Publish>
<Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="MaintenanceTypeDlg" Order="2">Installed AND NOT PATCH</Publish>
<Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg" Order="2">Installed AND PATCH</Publish>
<Publish Dialog="MaintenanceWelcomeDlg" Control="Next" Event="NewDialog" Value="MaintenanceTypeDlg">1</Publish>
<Publish Dialog="MaintenanceTypeDlg" Control="RepairButton" Event="NewDialog" Value="VerifyReadyDlg">1</Publish>
<Publish Dialog="MaintenanceTypeDlg" Control="RemoveButton" Event="NewDialog" Value="VerifyReadyDlg">1</Publish>
<Publish Dialog="MaintenanceTypeDlg" Control="Back" Event="NewDialog" Value="MaintenanceWelcomeDlg">1</Publish>
<Property Id="ARPNOMODIFY" Value="1" />
</UI>
<UIRef Id="WixUI_Common" />
</Fragment>
</Wix>
================================================
FILE: src/CMakeLists.txt
================================================
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
# Find includes in corresponding build directories.
set(CMAKE_INCLUDE_CURRENT_DIR ON)
## Build options
option(ZEAL_PORTABLE_BUILD "Build portable version")
if(ZEAL_PORTABLE_BUILD)
add_definitions(-DPORTABLE_BUILD)
endif()
## Macros.
add_definitions(-DZEAL_VERSION="${ZEAL_VERSION_FULL}")
# QString options
add_definitions(-DQT_USE_QSTRINGBUILDER)
add_definitions(-DQT_RESTRICTED_CAST_FROM_ASCII)
add_definitions(-DQT_NO_CAST_TO_ASCII)
add_definitions(-DQT_NO_URL_CAST_FROM_STRING)
## Handle moc, uic, and rcc files.
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTOUIC ON)
set(CMAKE_AUTORCC ON)
include_directories(libs)
add_subdirectory(libs)
add_subdirectory(app)
================================================
FILE: src/app/CMakeLists.txt
================================================
find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Concurrent WebEngineWidgets Widgets REQUIRED)
if (Qt${QT_VERSION_MAJOR}Widgets_VERSION VERSION_LESS QT_MINIMUM_VERSION)
message(FATAL_ERROR "Qt version >= ${QT_MINIMUM_VERSION} is required.")
endif()
# Define output binary name.
if(APPLE)
set(_project_output_name ${CMAKE_PROJECT_NAME})
else()
string(TOLOWER ${CMAKE_PROJECT_NAME} _project_output_name)
endif()
set(PROJECT_EXECUTABLE_NAME "${_project_output_name}${CMAKE_EXECUTABLE_SUFFIX}")
message(STATUS "Project executable name: ${PROJECT_EXECUTABLE_NAME}")
# Only support installing runtime dependencies with Qt >=6.5.1 (see QTBUG-111741).
if(Qt${QT_VERSION_MAJOR}Widgets_VERSION VERSION_GREATER_EQUAL "6.5.1")
set(_use_qt_cmake_commands TRUE)
qt_standard_project_setup()
endif()
if(APPLE)
list(APPEND App_RESOURCES resources/zeal.icns)
elseif(WIN32)
configure_file(versioninfo.rc.in ${CMAKE_CURRENT_BINARY_DIR}/versioninfo.rc)
list(APPEND App_RESOURCES ${CMAKE_CURRENT_BINARY_DIR}/versioninfo.rc)
else()
set(App_RESOURCES) # Silence CMake warning.
endif()
if(QT_VERSION_MAJOR EQUAL 6)
qt_add_executable(App WIN32
main.cpp
zeal.qrc
${App_RESOURCES}
)
else()
add_executable(App WIN32
main.cpp
zeal.qrc
${App_RESOURCES}
)
endif()
target_link_libraries(App PRIVATE Core Util Qt${QT_VERSION_MAJOR}::Widgets)
set_target_properties(App PROPERTIES
OUTPUT_NAME ${_project_output_name}
RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}
)
# Install Qt runtime dependencies on Windows.
if(WIN32 AND _use_qt_cmake_commands)
qt_generate_deploy_script(
TARGET App
OUTPUT_SCRIPT _qt_deploy_script
CONTENT "
# TODO: Run windeployqt after build.
# Override deployment script's working directory.
# set(QT_DEPLOY_PREFIX \"$<TARGET_FILE_DIR:App>\")
qt_deploy_runtime_dependencies(
EXECUTABLE \"$<TARGET_FILE:App>\"
BIN_DIR .
NO_TRANSLATIONS
NO_COMPILER_RUNTIME
)")
endif()
if(APPLE)
set_target_properties(App PROPERTIES
MACOSX_BUNDLE TRUE
MACOSX_BUNDLE_BUNDLE_NAME ${CMAKE_PROJECT_NAME}
MACOSX_BUNDLE_GUI_IDENTIFIER "org.zealdocs.zeal"
MACOSX_BUNDLE_BUNDLE_VERSION ${PROJECT_VERSION}
MACOSX_BUNDLE_LONG_VERSION_STRING ${PROJECT_VERSION}
MACOSX_BUNDLE_SHORT_VERSION_STRING "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
MACOSX_BUNDLE_ICON_FILE "zeal.icns"
MACOSX_BUNDLE_COPYRIGHT ${PROJECT_COPYRIGHT}
RESOURCE "resources/zeal.icns"
)
elseif(WIN32)
install(TARGETS App RUNTIME DESTINATION .)
if(_use_qt_cmake_commands)
# Install Qt runtime dependencies.
install(SCRIPT ${_qt_deploy_script})
unset(_qt_deploy_script)
unset(_use_qt_cmake_commands)
endif()
elseif(UNIX)
include(GNUInstallDirs)
install(TARGETS App DESTINATION ${CMAKE_INSTALL_BINDIR})
endif()
#
# CPack configuration.
#
set(CPACK_GENERATOR "7Z;ZIP")
set(CPACK_VERBATIM_VARIABLES YES)
# Usage: cmake --build --preset <preset-name> --target package
# E.g. cmake --build build --preset ninja-multi-vcpkg-release --target package
set(CPACK_PACKAGE_NAME ${CMAKE_PROJECT_NAME})
set(CPACK_PACKAGE_DESCRIPTION ${CMAKE_PROJECT_DESCRIPTION})
set(CPACK_PACKAGE_VENDOR ${PROJECT_COMPANY_NAME})
set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})
set(CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/src/app/resources/zeal.ico")
# Set binary package file name.
if(WIN32)
if(CMAKE_SYSTEM_PROCESSOR STREQUAL "AMD64")
set(_package_file_name_suffix "-windows-x64")
elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "X86")
set(_package_file_name_suffix "-windows-x86")
elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "ARM64")
set(_package_file_name_suffix "-windows-arm64")
else()
set(_package_file_name_suffix "-windows-unknown")
endif()
else()
set(_package_file_name_suffix "")
endif()
if(ZEAL_PORTABLE_BUILD)
string(PREPEND _package_file_name_suffix "-portable")
endif()
set(CPACK_PACKAGE_FILE_NAME "${_project_output_name}-${ZEAL_VERSION_FULL}${_package_file_name_suffix}")
set(CPACK_PACKAGE_INSTALL_DIRECTORY ${CPACK_PACKAGE_NAME})
set(CPACK_PACKAGE_EXECUTABLES ${_project_output_name} ${CPACK_PACKAGE_NAME})
set(CPACK_CREATE_DESKTOP_LINKS ${_project_output_name} ${CPACK_PACKAGE_NAME})
# Allow CPack to do text to RTF conversion.
configure_file("${CMAKE_SOURCE_DIR}/COPYING" "${CMAKE_CURRENT_BINARY_DIR}/license.txt" COPYONLY)
set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_BINARY_DIR}/license.txt")
set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
set(CPACK_PACKAGE_CHECKSUM SHA256)
if(WIN32)
# CPack WiX configuration.
set(CPACK_WIX_UPGRADE_GUID "5C4B6030-A1B4-4EFE-A5AF-28F6FA2E7978")
set(CPACK_WIX_PROPERTY_ARPURLINFOABOUT ${CMAKE_PROJECT_HOMEPAGE_URL})
set(CPACK_WIX_PRODUCT_ICON "${CMAKE_SOURCE_DIR}/src/app/resources/zeal.ico")
#set(CPACK_WIX_UI_BANNER "${CMAKE_SOURCE_DIR}/pkg/wix/banner.png")
#set(CPACK_WIX_UI_DIALOG "${CMAKE_SOURCE_DIR}/pkg/wix/dialog.png")
set(CPACK_WIX_EXTENSIONS "WixUtilExtension")
set(CPACK_WIX_UI_REF "Zeal_InstallDir")
set(CPACK_WIX_TEMPLATE "${CMAKE_SOURCE_DIR}/pkg/wix/template.xml")
set(CPACK_WIX_PATCH_FILE "${CMAKE_SOURCE_DIR}/pkg/wix/patch.xml")
set(CPACK_WIX_EXTRA_SOURCES
"${CMAKE_SOURCE_DIR}/pkg/wix/ui.wxs"
"${CMAKE_SOURCE_DIR}/pkg/wix/exitdialog.wxs"
)
set(CPACK_PRE_BUILD_SCRIPTS "${CMAKE_SOURCE_DIR}/pkg/wix/cpack_pre_build.cmake")
if(NOT ZEAL_PORTABLE_BUILD)
list(APPEND CPACK_GENERATOR "WIX")
set(CPACK_POST_BUILD_SCRIPTS "${CMAKE_SOURCE_DIR}/pkg/wix/cpack_post_build.cmake")
endif()
endif()
# Set options for the source package.
# Usage: cmake --build <build> --target package_source
set(CPACK_SOURCE_GENERATOR "TGZ;TXZ;ZIP")
set(CPACK_SOURCE_PACKAGE_FILE_NAME "${_project_output_name}-${ZEAL_VERSION_FULL}")
set(CPACK_SOURCE_IGNORE_FILES
# Directories.
".git/"
".github/"
".vscode/"
"build/"
# Files.
".editorconfig"
".gitattributes"
".gitignore"
)
include(CPack)
================================================
FILE: src/app/main.cpp
================================================
// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>
// Copyright (C) 2013-2014 Jerzy Kozera
// SPDX-License-Identifier: GPL-3.0-or-later
#include <core/application.h>
#include <core/applicationsingleton.h>
#include <registry/searchquery.h>
#include <QApplication>
#include <QCommandLineParser>
#include <QDataStream>
#include <QDesktopServices>
#include <QDir>
#include <QIcon>
#include <QMessageBox>
#include <QTextStream>
#include <QTimer>
#include <QUrlQuery>
#ifdef Q_OS_WINDOWS
#include <QSettings>
#include <Windows.h>
#include <utility> // for std::ignore
#endif
#include <cstdlib>
using namespace Zeal;
struct CommandLineParameters
{
bool forceMinimized;
bool preventActivation;
#ifdef Q_OS_WINDOWS
bool attachConsole;
bool registerProtocolHandlers;
bool unregisterProtocolHandlers;
#endif
Registry::SearchQuery query;
};
QString stripParameterUrl(const QString &url, const QString &scheme)
{
QString str = url.mid(scheme.length() + 1);
if (str.startsWith(QLatin1String("//"))) {
str = str.mid(2);
}
if (str.endsWith(QLatin1Char('/'))) {
str = str.left(str.length() - 1);
}
return str;
}
CommandLineParameters parseCommandLine(const QStringList &arguments)
{
QCommandLineParser parser;
parser.setApplicationDescription(QObject::tr("Zeal - Offline documentation browser."));
parser.addHelpOption();
parser.addVersionOption();
parser.addOptions({
{QStringLiteral("minimized"), QObject::tr("Start minimized regardless of settings.")}
});
#ifdef Q_OS_WINDOWS
parser.addOptions({
{QStringLiteral("attach-console"), QObject::tr("Attach console for logging.")},
{QStringLiteral("register"), QObject::tr("Register protocol handlers.")},
{QStringLiteral("unregister"), QObject::tr("Unregister protocol handlers.")}
});
#endif
parser.addPositionalArgument(QStringLiteral("url"), QObject::tr("dash[-plugin]:// URL"));
parser.process(arguments);
CommandLineParameters clParams;
clParams.forceMinimized = parser.isSet(QStringLiteral("minimized"));
clParams.preventActivation = false;
#ifdef Q_OS_WINDOWS
clParams.attachConsole = parser.isSet(QStringLiteral("attach-console"));
clParams.registerProtocolHandlers = parser.isSet(QStringLiteral("register"));
clParams.unregisterProtocolHandlers = parser.isSet(QStringLiteral("unregister"));
if (clParams.registerProtocolHandlers && clParams.unregisterProtocolHandlers) {
QTextStream(stderr) << QObject::tr("Parameter conflict: --register and --unregister.\n");
::exit(EXIT_FAILURE);
}
#endif
// TODO: Support dash-feed:// protocol
const QString arg
= QUrl::fromPercentEncoding(parser.positionalArguments().value(0).toUtf8());
if (arg.startsWith(QLatin1String("dash:"))) {
clParams.query.setQuery(stripParameterUrl(arg, QStringLiteral("dash")));
} else if (arg.startsWith(QLatin1String("dash-plugin:"))) {
const QUrlQuery urlQuery(stripParameterUrl(arg, QStringLiteral("dash-plugin")));
const QString keys = urlQuery.queryItemValue(QStringLiteral("keys"));
if (!keys.isEmpty())
clParams.query.setKeywords(keys.split(QLatin1Char(',')));
clParams.query.setQuery(urlQuery.queryItemValue(QStringLiteral("query")));
const QString preventActivation
= urlQuery.queryItemValue(QStringLiteral("prevent_activation"));
clParams.preventActivation = preventActivation == QLatin1String("true");
} else {
clParams.query.setQuery(arg);
}
return clParams;
}
#ifdef Q_OS_WINDOWS
void registerProtocolHandler(const QString &scheme, const QString &description)
{
const QString appPath = QDir::toNativeSeparators(QCoreApplication::applicationFilePath());
const QString regPath = QStringLiteral("HKEY_CURRENT_USER\\Software\\Classes\\") + scheme;
QScopedPointer<QSettings> reg(new QSettings(regPath, QSettings::NativeFormat));
reg->setValue(QStringLiteral("Default"), description);
reg->setValue(QStringLiteral("URL Protocol"), QString());
reg->beginGroup(QStringLiteral("DefaultIcon"));
reg->setValue(QStringLiteral("Default"), QString("%1,1").arg(appPath));
reg->endGroup();
reg->beginGroup(QStringLiteral("shell"));
reg->beginGroup(QStringLiteral("open"));
reg->beginGroup(QStringLiteral("command"));
reg->setValue(QStringLiteral("Default"), QVariant(appPath + QLatin1String(" %1")));
}
void registerProtocolHandlers(const QHash<QString, QString> &protocols, bool force = false)
{
const QString regPath = QStringLiteral("HKEY_CURRENT_USER\\Software\\Classes");
QScopedPointer<QSettings> reg(new QSettings(regPath, QSettings::NativeFormat));
const QStringList groups = reg->childGroups();
for (auto it = protocols.cbegin(); it != protocols.cend(); ++it) {
if (force || !groups.contains(it.key()))
registerProtocolHandler(it.key(), it.value());
}
}
void unregisterProtocolHandlers(const QHash<QString, QString> &protocols)
{
const QString regPath = QStringLiteral("HKEY_CURRENT_USER\\Software\\Classes");
QScopedPointer<QSettings> reg(new QSettings(regPath, QSettings::NativeFormat));
for (auto it = protocols.cbegin(); it != protocols.cend(); ++it) {
reg->remove(it.key());
}
}
#endif
int main(int argc, char *argv[])
{
// Do not allow Qt version lower than the app was compiled with.
QT_REQUIRE_VERSION(argc, argv, QT_VERSION_STR)
QCoreApplication::setApplicationName(QStringLiteral("Zeal"));
QCoreApplication::setApplicationVersion(ZEAL_VERSION);
QCoreApplication::setOrganizationDomain(QStringLiteral("zealdocs.org"));
QCoreApplication::setOrganizationName(QStringLiteral("Zeal"));
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
QCoreApplication::setAttribute(Qt::AA_UseHighDpiPixmaps);
#endif
// Use Fusion style on Windows 10 & 11. This enables proper dark mode support.
// See https://www.qt.io/blog/dark-mode-on-windows-11-with-qt-6.5.
// TODO: Make style configurable, detect -style argument.
#if defined(Q_OS_WINDOWS) && (QT_VERSION >= QT_VERSION_CHECK(6, 5, 0))
const auto osName = QSysInfo::prettyProductName();
if (osName.startsWith("Windows 10") || osName.startsWith("Windows 11")) {
QApplication::setStyle("fusion");
}
#endif
QScopedPointer<QApplication> qapp(new QApplication(argc, argv));
const CommandLineParameters clParams = parseCommandLine(qapp->arguments());
#ifdef Q_OS_WINDOWS
const static QHash<QString, QString> protocols = {
{QStringLiteral("dash"), QStringLiteral("URL:Dash Protocol (Zeal)")},
{QStringLiteral("dash-plugin"), QStringLiteral("URL:Dash Plugin Protocol (Zeal)")}
};
if (clParams.registerProtocolHandlers) {
registerProtocolHandlers(protocols, clParams.registerProtocolHandlers);
return EXIT_SUCCESS;
}
if (clParams.unregisterProtocolHandlers) {
unregisterProtocolHandlers(protocols);
return EXIT_SUCCESS;
}
#endif
#ifdef Q_OS_WINDOWS
if (clParams.attachConsole && AttachConsole(ATTACH_PARENT_PROCESS)) {
FILE *fp = nullptr;
std::ignore = freopen_s(&fp, "CONOUT$", "w", stdout);
std::ignore = freopen_s(&fp, "CONOUT$", "w", stderr);
std::ignore = freopen_s(&fp, "CONIN$", "r", stdin);
}
#endif // Q_OS_WINDOWS
QScopedPointer<Core::ApplicationSingleton> appSingleton(new Core::ApplicationSingleton());
if (appSingleton->isSecondary()) {
#ifdef Q_OS_WINDOWS
::AllowSetForegroundWindow(appSingleton->primaryPid());
#endif
QByteArray ba;
QDataStream out(&ba, QIODevice::WriteOnly);
out << clParams.query << clParams.preventActivation;
if (!appSingleton->sendMessage(ba)) {
QTextStream(stderr) << "Failed to send query to the primary instance." << '\n';
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
// Set application-wide window icon. All message boxes and other windows will use it by default.
qapp->setDesktopFileName(QStringLiteral("org.zealdocs.zeal"));
qapp->setWindowIcon(QIcon::fromTheme(QStringLiteral("zeal"),
QIcon(QStringLiteral(":/zeal.ico"))));
QDir::setSearchPaths(QStringLiteral("typeIcon"), {QStringLiteral(":/icons/type")});
QScopedPointer<Core::Application> app(new Core::Application());
QObject::connect(appSingleton.data(), &Core::ApplicationSingleton::messageReceived,
[&app](const QByteArray &data) {
Registry::SearchQuery query;
bool preventActivation;
QDataStream in(data);
in >> query >> preventActivation;
app->executeQuery(query, preventActivation);
});
app->showMainWindow(clParams.forceMinimized);
if (!clParams.query.isEmpty()) {
QTimer::singleShot(0, app.data(), [&app, clParams] {
app->executeQuery(clParams.query, clParams.preventActivation);
});
}
return qapp->exec();
}
================================================
FILE: src/app/resources/browser/404.html
================================================
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>File not found</title>
<link rel="stylesheet" type="text/css" href="assets/css/oat.min.css">
<link rel="stylesheet" type="text/css" href="assets/css/welcome.css">
</head>
<body>
<div class="page">
<div class="brand">
<h1>File not found</h1>
<p>Encountered a problem? Please <a onclick="zAppBridge.openShortUrl('report-bug')">report</a>!</p>
</div>
<div class="actions">
<h2>Get in touch</h2>
<div class="command-block" onclick="zAppBridge.openShortUrl('gitter')">
<h3>Matrix</h3>
<p>Chat with developers and other users</p>
</div>
<div class="command-block" onclick="zAppBridge.openShortUrl('github')">
<h3>GitHub</h3>
<p>Contribute to the project</p>
</div>
</div>
</div>
<footer class="footer">
<div class="icon-links">
<!-- Simple Icons: GitHub (CC0) -->
<a class="icon-link" onclick="zAppBridge.openShortUrl('github')" title="GitHub">
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor">
<path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/>
</svg>
</a>
<!-- Simple Icons: Matrix (CC0) -->
<a class="icon-link" onclick="zAppBridge.openShortUrl('gitter')" title="Matrix">
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor">
<path d="M.632.55v22.9H2.28V24H0V0h2.28v.55zm7.043 7.26v1.157h.033c.309-.443.683-.784 1.117-1.024.433-.245.936-.365 1.5-.365.54 0 1.033.107 1.481.314.448.208.785.582 1.02 1.108.254-.374.6-.706 1.034-.992.434-.287.95-.43 1.546-.43.453 0 .872.056 1.26.167.388.11.716.286.993.53.276.245.489.559.646.951.152.392.23.863.23 1.417v5.728h-2.349V11.52c0-.286-.01-.559-.032-.812a1.755 1.755 0 0 0-.18-.66 1.106 1.106 0 0 0-.438-.448c-.194-.11-.457-.166-.785-.166-.332 0-.6.064-.803.189a1.38 1.38 0 0 0-.48.499 1.946 1.946 0 0 0-.231.696 5.56 5.56 0 0 0-.06.785v4.768h-2.35v-4.8c0-.254-.004-.503-.018-.752a2.074 2.074 0 0 0-.143-.688 1.052 1.052 0 0 0-.415-.503c-.194-.125-.476-.19-.854-.19-.111 0-.259.024-.439.074-.18.051-.36.143-.53.282-.171.138-.319.337-.439.595-.12.259-.18.6-.18 1.02v4.966H5.46V7.81zm15.693 15.64V.55H21.72V0H24v24h-2.28v-.55z"/>
</svg>
</a>
<!-- Simple Icons: X / Twitter (CC0) -->
<a class="icon-link" onclick="zAppBridge.openShortUrl('twitter')" title="X">
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor">
<path d="M14.234 10.162 22.977 0h-2.072l-7.591 8.824L7.251 0H.258l9.168 13.343L.258 24H2.33l8.016-9.318L16.749 24h6.993zm-2.837 3.299-.929-1.329L3.076 1.56h3.182l5.965 8.532.929 1.329 7.754 11.09h-3.182z"/>
</svg>
</a>
</div>
<!-- Lucide: Bug (ISC) -->
<a class="report-link" onclick="zAppBridge.openShortUrl('report-bug')">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<path d="M12 20v-9"/>
<path d="M14 7a4 4 0 0 1 4 4v3a6 6 0 0 1-12 0v-3a4 4 0 0 1 4-4z"/>
<path d="M14.12 3.88 16 2"/>
<path d="M21 21a4 4 0 0 0-3.81-4"/>
<path d="M21 5a4 4 0 0 1-3.55 3.97"/>
<path d="M22 13h-4"/>
<path d="M3 21a4 4 0 0 1 3.81-4"/>
<path d="M3 5a4 4 0 0 0 3.55 3.97"/>
<path d="M6 13H2"/>
<path d="m8 2 1.88 1.88"/>
<path d="M9 7.13V6a3 3 0 1 1 6 0v1.13"/>
</svg>
<span>Report a problem</span>
</a>
</footer>
<script type="text/javascript" src="qrc:///qtwebchannel/qwebchannel.js"></script>
<script>
new QWebChannel(qt.webChannelTransport, (channel) => {
window.zAppBridge = channel.objects.zAppBridge;
});
</script>
</body>
</html>
================================================
FILE: src/app/resources/browser/assets/css/highlight.css
================================================
/* Highlight on navigation to an anchor. */
@keyframes targetNavigatedAnimation {
from { background: #fff; }
50% { background: #ff0; }
to { background: #fff; }
}
*:target {
animation: targetNavigatedAnimation .5s linear;
}
================================================
FILE: src/app/resources/browser/assets/css/welcome.css
================================================
/* Custom styles for Zeal's built-in browser pages. Depends on oat.min.css. */
body {
user-select: none;
min-height: 100dvh;
display: flex;
flex-direction: column;
align-items: center;
}
.page {
flex: 1;
display: grid;
grid-template-columns: 1fr 1.5fr;
align-content: center;
gap: 1.5rem 3rem;
max-width: 720px;
width: 100%;
padding: 2rem;
}
.brand {
display: flex;
flex-direction: column;
justify-content: center;
gap: 0.25rem;
}
.brand h1 {
font-size: 2rem;
line-height: 1.1;
}
.brand .version {
font-weight: 300;
opacity: 0.5;
margin-left: 0.3rem;
font-size: 1rem;
}
.brand > p {
opacity: 0.6;
}
.actions {
display: flex;
flex-direction: column;
gap: 0.5rem;
}
.actions > h2 {
font-size: 0.7rem;
text-transform: uppercase;
letter-spacing: 0.07em;
opacity: 0.45;
margin-top: 0.5rem;
margin-bottom: 0;
}
.command-block {
cursor: pointer;
padding: 0.625rem 0.875rem;
border-radius: 6px;
border: 1px solid #e2e8f0;
transition:
border-color 0.15s,
background 0.15s;
}
.command-block:hover {
border-color: #94a3b8;
background: #f8fafc;
}
.command-block h3 {
font-size: 0.875rem;
font-weight: 600;
margin-bottom: 0.125rem;
}
.command-block p {
font-size: 0.775rem;
opacity: 0.55;
margin: 0;
}
.footer {
display: flex;
flex-direction: column;
align-items: center;
gap: 0.625rem;
width: 100%;
max-width: 720px;
padding: 1rem 2rem;
border-top: 1px solid #e2e8f0;
}
.icon-links {
display: flex;
gap: 1.25rem;
align-items: center;
}
.icon-link {
cursor: pointer;
display: inline-flex;
color: inherit;
text-decoration: none;
opacity: 0.45;
transition: opacity 0.15s;
}
.icon-link:hover {
opacity: 0.85;
text-decoration: none;
}
.icon-link svg {
width: 1.2rem;
height: 1.2rem;
}
.report-link {
display: inline-flex;
align-items: center;
gap: 0.3rem;
font-size: 0.75rem;
cursor: pointer;
opacity: 0.4;
transition: opacity 0.15s;
text-decoration: none;
color: inherit;
}
.report-link:hover {
opacity: 0.7;
text-decoration: none;
}
.report-link svg {
width: 0.85rem;
height: 0.85rem;
}
@media (prefers-color-scheme: dark) {
.command-block {
border-color: #334155;
}
.command-block:hover {
border-color: #475569;
background: #1e293b;
}
.footer {
border-color: #334155;
}
}
================================================
FILE: src/app/resources/browser/welcome.html
================================================
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Welcome</title>
<link rel="stylesheet" type="text/css" href="assets/css/oat.min.css">
<link rel="stylesheet" type="text/css" href="assets/css/welcome.css">
</head>
<body>
<div class="page">
<div class="brand">
<h1>Zeal<span class="version" id="version"></span></h1>
<p>Docs for everyone</p>
</div>
<div class="actions">
<h2>Customize</h2>
<div class="command-block" onclick="zAppBridge.triggerAction('openDocsetManager')">
<h3>Docsets</h3>
<p>Install and update docsets</p>
</div>
<div class="command-block" onclick="zAppBridge.triggerAction('openPreferences')">
<h3>Preferences</h3>
<p>Adjust application settings</p>
</div>
<h2>Get in touch</h2>
<div class="command-block" onclick="zAppBridge.openShortUrl('gitter')">
<h3>Matrix</h3>
<p>Chat with developers and other users</p>
</div>
<div class="command-block" onclick="zAppBridge.openShortUrl('github')">
<h3>GitHub</h3>
<p>Contribute to the project</p>
</div>
</div>
</div>
<footer class="footer">
<div class="icon-links">
<!-- Simple Icons: GitHub (CC0) -->
<a class="icon-link" onclick="zAppBridge.openShortUrl('github')" title="GitHub">
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor">
<path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/>
</svg>
</a>
<!-- Simple Icons: Matrix (CC0) -->
<a class="icon-link" onclick="zAppBridge.openShortUrl('gitter')" title="Matrix">
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor">
<path d="M.632.55v22.9H2.28V24H0V0h2.28v.55zm7.043 7.26v1.157h.033c.309-.443.683-.784 1.117-1.024.433-.245.936-.365 1.5-.365.54 0 1.033.107 1.481.314.448.208.785.582 1.02 1.108.254-.374.6-.706 1.034-.992.434-.287.95-.43 1.546-.43.453 0 .872.056 1.26.167.388.11.716.286.993.53.276.245.489.559.646.951.152.392.23.863.23 1.417v5.728h-2.349V11.52c0-.286-.01-.559-.032-.812a1.755 1.755 0 0 0-.18-.66 1.106 1.106 0 0 0-.438-.448c-.194-.11-.457-.166-.785-.166-.332 0-.6.064-.803.189a1.38 1.38 0 0 0-.48.499 1.946 1.946 0 0 0-.231.696 5.56 5.56 0 0 0-.06.785v4.768h-2.35v-4.8c0-.254-.004-.503-.018-.752a2.074 2.074 0 0 0-.143-.688 1.052 1.052 0 0 0-.415-.503c-.194-.125-.476-.19-.854-.19-.111 0-.259.024-.439.074-.18.051-.36.143-.53.282-.171.138-.319.337-.439.595-.12.259-.18.6-.18 1.02v4.966H5.46V7.81zm15.693 15.64V.55H21.72V0H24v24h-2.28v-.55z"/>
</svg>
</a>
<!-- Simple Icons: X / Twitter (CC0) -->
<a class="icon-link" onclick="zAppBridge.openShortUrl('twitter')" title="X">
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor">
<path d="M14.234 10.162 22.977 0h-2.072l-7.591 8.824L7.251 0H.258l9.168 13.343L.258 24H2.33l8.016-9.318L16.749 24h6.993zm-2.837 3.299-.929-1.329L3.076 1.56h3.182l5.965 8.532.929 1.329 7.754 11.09h-3.182z"/>
</svg>
</a>
</div>
<!-- Lucide: Bug (ISC) -->
<a class="report-link" onclick="zAppBridge.openShortUrl('report-bug')">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<path d="M12 20v-9"/>
<path d="M14 7a4 4 0 0 1 4 4v3a6 6 0 0 1-12 0v-3a4 4 0 0 1 4-4z"/>
<path d="M14.12 3.88 16 2"/>
<path d="M21 21a4 4 0 0 0-3.81-4"/>
<path d="M21 5a4 4 0 0 1-3.55 3.97"/>
<path d="M22 13h-4"/>
<path d="M3 21a4 4 0 0 1 3.81-4"/>
<path d="M3 5a4 4 0 0 0 3.55 3.97"/>
<path d="M6 13H2"/>
<path d="m8 2 1.88 1.88"/>
<path d="M9 7.13V6a3 3 0 1 1 6 0v1.13"/>
</svg>
<span>Report a problem</span>
</a>
</footer>
<script type="text/javascript" src="qrc:///qtwebchannel/qwebchannel.js"></script>
<script>
new QWebChannel(qt.webChannelTransport, (channel) => {
window.zAppBridge = channel.objects.zAppBridge;
document.getElementById("version").textContent = zAppBridge.AppVersion;
});
</script>
</body>
</html>
================================================
FILE: src/app/resources/icons/README.md
================================================
# Resources
## Dash Type Icons (`type`)
Upstream repository: <https://github.com/Kapeli/Dash-X-Platform-Resources>
Optimized with:
```shell
find . -type f -iname '*.png' -exec pngcrush -ow -rem allb -reduce {} \;
find . -type f -name "*.png" -exec convert {} -strip {} \;
optipng *.png
```
The following icons are renamed:
* `Enum` to `Enumeration`
* `Struct` to `Structure`
================================================
FILE: src/app/versioninfo.rc.in
================================================
// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>
// SPDX-License-Identifier: GPL-3.0-or-later
#include <winver.h>
#pragma code_page(65001)
IDI_ICON1 ICON DISCARDABLE "resources/zeal.ico"
#define VER_COMPANYNAME_STR "${PROJECT_COMPANY_NAME}"
#define VER_FILEDESCRIPTION_STR "${CMAKE_PROJECT_DESCRIPTION}"
#define VER_FILEVERSION ${PROJECT_VERSION_MAJOR},${PROJECT_VERSION_MINOR},${PROJECT_VERSION_PATCH}
#define VER_FILEVERSION_STR "${PROJECT_VERSION}"
#define VER_INTERNALNAME_STR "${CMAKE_PROJECT_NAME}"
#define VER_LEGALCOPYRIGHT_STR "${PROJECT_COPYRIGHT}"
#define VER_LEGALTRADEMARKS1_STR ""
#define VER_LEGALTRADEMARKS2_STR ""
#define VER_ORIGINALFILENAME_STR "${PROJECT_EXECUTABLE_NAME}"
#define VER_PRODUCTNAME_STR "${CMAKE_PROJECT_NAME}"
#define VER_PRODUCTVERSION ${PROJECT_VERSION_MAJOR},${PROJECT_VERSION_MINOR},${PROJECT_VERSION_PATCH}
#define VER_PRODUCTVERSION_STR "${PROJECT_VERSION}"
#ifndef DEBUG
#define VER_DEBUG 0
#else
#define VER_DEBUG VS_FF_DEBUG
#endif
VS_VERSION_INFO VERSIONINFO
FILEVERSION VER_FILEVERSION
PRODUCTVERSION VER_PRODUCTVERSION
FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
//TODO: Set file flags.
//FILEFLAGS (VER_PRIVATEBUILD|VER_PRERELEASE|VER_DEBUG)
FILEFLAGS 0
FILEOS VOS__WINDOWS32
FILETYPE VFT_DLL
FILESUBTYPE VFT2_UNKNOWN
BEGIN
BLOCK "StringFileInfo"
BEGIN
BLOCK "040904B0"
BEGIN
VALUE "CompanyName", VER_COMPANYNAME_STR
VALUE "FileDescription", VER_FILEDESCRIPTION_STR
VALUE "FileVersion", VER_FILEVERSION_STR
VALUE "InternalName", VER_INTERNALNAME_STR
VALUE "LegalCopyright", VER_LEGALCOPYRIGHT_STR
VALUE "LegalTrademarks1", VER_LEGALTRADEMARKS1_STR
VALUE "LegalTrademarks2", VER_LEGALTRADEMARKS2_STR
VALUE "OriginalFilename", VER_ORIGINALFILENAME_STR
VALUE "ProductName", VER_PRODUCTNAME_STR
VALUE "ProductVersion", VER_PRODUCTVERSION_STR
END
END
BLOCK "VarFileInfo"
BEGIN
VALUE "Translation", 0x0409, 1200
END
END
================================================
FILE: src/app/zeal.qrc
================================================
<RCC>
<qresource prefix="/">
<file alias="zeal.ico">resources/zeal.ico</file>
</qresource>
<qresource prefix="/browser">
<file alias="404.html">resources/browser/404.html</file>
<file alias="assets/css/highlight.css">resources/browser/assets/css/highlight.css</file>
<file alias="assets/css/oat.min.css">resources/browser/assets/css/oat.min.css</file>
<file alias="assets/css/welcome.css">resources/browser/assets/css/welcome.css</file>
<file alias="welcome.html">resources/browser/welcome.html</file>
</qresource>
<qresource prefix="/icons/type">
<file alias="Abbreviation.png">resources/icons/type/Abbreviation.png</file>
<file alias="Abbreviation@2x.png">resources/icons/type/Abbreviation@2x.png</file>
<file alias="Alias.png">resources/icons/type/Alias.png</file>
<file alias="Alias@2x.png">resources/icons/type/Alias@2x.png</file>
<file alias="Annotation.png">resources/icons/type/Annotation.png</file>
<file alias="Annotation@2x.png">resources/icons/type/Annotation@2x.png</file>
<file alias="Attribute.png">resources/icons/type/Attribute.png</file>
<file alias="Attribute@2x.png">resources/icons/type/Attribute@2x.png</file>
<file alias="Axiom.png">resources/icons/type/Axiom.png</file>
<file alias="Axiom@2x.png">resources/icons/type/Axiom@2x.png</file>
<file alias="Binding.png">resources/icons/type/Binding.png</file>
<file alias="Binding@2x.png">resources/icons/type/Binding@2x.png</file>
<file alias="Block.png">resources/icons/type/Block.png</file>
<file alias="Block@2x.png">resources/icons/type/Block@2x.png</file>
<file alias="Bookmark.png">resources/icons/type/Bookmark.png</file>
<file alias="Bookmark@2x.png">resources/icons/type/Bookmark@2x.png</file>
<file alias="Builtin.png">resources/icons/type/Builtin.png</file>
<file alias="Builtin@2x.png">resources/icons/type/Builtin@2x.png</file>
<file alias="Callback.png">resources/icons/type/Callback.png</file>
<file alias="Callback@2x.png">resources/icons/type/Callback@2x.png</file>
<file alias="Category.png">resources/icons/type/Category.png</file>
<file alias="Category@2x.png">resources/icons/type/Category@2x.png</file>
<file alias="Class.png">resources/icons/type/Class.png</file>
<file alias="Class@2x.png">resources/icons/type/Class@2x.png</file>
<file alias="Collection.png">resources/icons/type/Collection.png</file>
<file alias="Collection@2x.png">resources/icons/type/Collection@2x.png</file>
<file alias="Column.png">resources/icons/type/Column.png</file>
<file alias="Column@2x.png">resources/icons/type/Column@2x.png</file>
<file alias="Command.png">resources/icons/type/Command.png</file>
<file alias="Command@2x.png">resources/icons/type/Command@2x.png</file>
<file alias="Component.png">resources/icons/type/Component.png</file>
<file alias="Component@2x.png">resources/icons/type/Component@2x.png</file>
<file alias="Constant.png">resources/icons/type/Constant.png</file>
<file alias="Constant@2x.png">resources/icons/type/Constant@2x.png</file>
<file alias="Constructor.png">resources/icons/type/Constructor.png</file>
<file alias="Constructor@2x.png">resources/icons/type/Constructor@2x.png</file>
<file alias="Conversion.png">resources/icons/type/Conversion.png</file>
<file alias="Conversion@2x.png">resources/icons/type/Conversion@2x.png</file>
<file alias="Data Source.png">resources/icons/type/Data Source.png</file>
<file alias="Data Source@2x.png">resources/icons/type/Data Source@2x.png</file>
<file alias="Database.png">resources/icons/type/Database.png</file>
<file alias="Database@2x.png">resources/icons/type/Database@2x.png</file>
<file alias="Decorator.png">resources/icons/type/Decorator.png</file>
<file alias="Decorator@2x.png">resources/icons/type/Decorator@2x.png</file>
<file alias="Define.png">resources/icons/type/Define.png</file>
<file alias="Define@2x.png">resources/icons/type/Define@2x.png</file>
<file alias="Delegate.png">resources/icons/type/Delegate.png</file>
<file alias="Delegate@2x.png">resources/icons/type/Delegate@2x.png</file>
<file alias="Device.png">resources/icons/type/Device.png</file>
<file alias="Device@2x.png">resources/icons/type/Device@2x.png</file>
<file alias="Diagram.png">resources/icons/type/Diagram.png</file>
<file alias="Diagram@2x.png">resources/icons/type/Diagram@2x.png</file>
<file alias="Directive.png">resources/icons/type/Directive.png</file>
<file alias="Directive@2x.png">resources/icons/type/Directive@2x.png</file>
<file alias="Element.png">resources/icons/type/Element.png</file>
<file alias="Element@2x.png">resources/icons/type/Element@2x.png</file>
<file alias="Entry.png">resources/icons/type/Entry.png</file>
<file alias="Entry@2x.png">resources/icons/type/Entry@2x.png</file>
<file alias="Enumeration.png">resources/icons/type/Enumeration.png</file>
<file alias="Enumeration@2x.png">resources/icons/type/Enumeration@2x.png</file>
<file alias="Environment.png">resources/icons/type/Environment.png</file>
<file alias="Environment@2x.png">resources/icons/type/Environment@2x.png</file>
<file alias="Error.png">resources/icons/type/Error.png</file>
<file alias="Error@2x.png">resources/icons/type/Error@2x.png</file>
<file alias="Event.png">resources/icons/type/Event.png</file>
<file alias="Event@2x.png">resources/icons/type/Event@2x.png</file>
<file alias="Exception.png">resources/icons/type/Exception.png</file>
<file alias="Exception@2x.png">resources/icons/type/Exception@2x.png</file>
<file alias="Expression.png">resources/icons/type/Expression.png</file>
<file alias="Expression@2x.png">resources/icons/type/Expression@2x.png</file>
<file alias="Extension.png">resources/icons/type/Extension.png</file>
<file alias="Extension@2x.png">resources/icons/type/Extension@2x.png</file>
<file alias="Field.png">resources/icons/type/Field.png</file>
<file alias="Field@2x.png">resources/icons/type/Field@2x.png</file>
<file alias="File.png">resources/icons/type/File.png</file>
<file alias="File@2x.png">resources/icons/type/File@2x.png</file>
<file alias="Filter.png">resources/icons/type/Filter.png</file>
<file alias="Filter@2x.png">resources/icons/type/Filter@2x.png</file>
<file alias="Flag.png">resources/icons/type/Flag.png</file>
<file alias="Flag@2x.png">resources/icons/type/Flag@2x.png</file>
<file alias="Foreign Key.png">resources/icons/type/Foreign Key.png</file>
<file alias="Foreign Key@2x.png">resources/icons/type/Foreign Key@2x.png</file>
<file alias="Framework.png">resources/icons/type/Framework.png</file>
<file alias="Framework@2x.png">resources/icons/type/Framework@2x.png</file>
<file alias="Function.png">resources/icons/type/Function.png</file>
<file alias="Function@2x.png">resources/icons/type/Function@2x.png</file>
<file alias="Global.png">resources/icons/type/Global.png</file>
<file alias="Global@2x.png">resources/icons/type/Global@2x.png</file>
<file alias="Glossary.png">resources/icons/type/Glossary.png</file>
<file alias="Glossary@2x.png">resources/icons/type/Glossary@2x.png</file>
<file alias="Guide.png">resources/icons/type/Guide.png</file>
<file alias="Guide@2x.png">resources/icons/type/Guide@2x.png</file>
<file alias="Handler.png">resources/icons/type/Handler.png</file>
<file alias="Handler@2x.png">resources/icons/type/Handler@2x.png</file>
<file alias="Helper.png">resources/icons/type/Helper.png</file>
<file alias="Helper@2x.png">resources/icons/type/Helper@2x.png</file>
<file alias="Hook.png">resources/icons/type/Hook.png</file>
<file alias="Hook@2x.png">resources/icons/type/Hook@2x.png</file>
<file alias="Index.png">resources/icons/type/Index.png</file>
<file alias="Index@2x.png">resources/icons/type/Index@2x.png</file>
<file alias="Indirection.png">resources/icons/type/Indirection.png</file>
<file alias="Indirection@2x.png">resources/icons/type/Indirection@2x.png</file>
<file alias="Inductive.png">resources/icons/type/Inductive.png</file>
<file alias="Inductive@2x.png">resources/icons/type/Inductive@2x.png</file>
<file alias="Instance.png">resources/icons/type/Instance.png</file>
<file alias="Instance@2x.png">resources/icons/type/Instance@2x.png</file>
<file alias="Instruction.png">resources/icons/type/Instruction.png</file>
<file alias="Instruction@2x.png">resources/icons/type/Instruction@2x.png</file>
<file alias="Interface.png">resources/icons/type/Interface.png</file>
<file alias="Interface@2x.png">resources/icons/type/Interface@2x.png</file>
<file alias="Iterator.png">resources/icons/type/Iterator.png</file>
<file alias="Iterator@2x.png">resources/icons/type/Iterator@2x.png</file>
<file alias="Keyword.png">resources/icons/type/Keyword.png</file>
<file alias="Keyword@2x.png">resources/icons/type/Keyword@2x.png</file>
<file alias="Kind.png">resources/icons/type/Kind.png</file>
<file alias="Kind@2x.png">resources/icons/type/Kind@2x.png</file>
<file alias="Lemma.png">resources/icons/type/Lemma.png</file>
<file alias="Lemma@2x.png">resources/icons/type/Lemma@2x.png</file>
<file alias="Library.png">resources/icons/type/Library.png</file>
<file alias="Library@2x.png">resources/icons/type/Library@2x.png</file>
<file alias="Literal.png">resources/icons/type/Literal.png</file>
<file alias="Literal@2x.png">resources/icons/type/Literal@2x.png</file>
<file alias="Macro.png">resources/icons/type/Macro.png</file>
<file alias="Macro@2x.png">resources/icons/type/Macro@2x.png</file>
<file alias="Member.png">resources/icons/type/Member.png</file>
<file alias="Member@2x.png">resources/icons/type/Member@2x.png</file>
<file alias="Message.png">resources/icons/type/Message.png</file>
<file alias="Message@2x.png">resources/icons/type/Message@2x.png</file>
<file alias="Method.png">resources/icons/type/Method.png</file>
<file alias="Method@2x.png">resources/icons/type/Method@2x.png</file>
<file alias="Mixin.png">resources/icons/type/Mixin.png</file>
<file alias="Mixin@2x.png">resources/icons/type/Mixin@2x.png</file>
<file alias="Modifier.png">resources/icons/type/Modifier.png</file>
<file alias="Modifier@2x.png">resources/icons/type/Modifier@2x.png</file>
<file alias="Module.png">resources/icons/type/Module.png</file>
<file alias="Module@2x.png">resources/icons/type/Module@2x.png</file>
<file alias="Namespace.png">resources/icons/type/Namespace.png</file>
<file alias="Namespace@2x.png">resources/icons/type/Namespace@2x.png</file>
<file alias="NewSnippet.png">resources/icons/type/NewSnippet.png</file>
<file alias="NewSnippet@2x.png">resources/icons/type/NewSnippet@2x.png</file>
<file alias="Node.png">resources/icons/type/Node.png</file>
<file alias="Node@2x.png">resources/icons/type/Node@2x.png</file>
<file alias="Notation.png">resources/icons/type/Notation.png</file>
<file alias="Notation@2x.png">resources/icons/type/Notation@2x.png</file>
<file alias="Object.png">resources/icons/type/Object.png</file>
<file alias="Object@2x.png">resources/icons/type/Object@2x.png</file>
<file alias="Operator.png">resources/icons/type/Operator.png</file>
<file alias="Operator@2x.png">resources/icons/type/Operator@2x.png</file>
<file alias="Option.png">resources/icons/type/Option.png</file>
<file alias="Option@2x.png">resources/icons/type/Option@2x.png</file>
<file alias="Package.png">resources/icons/type/Package.png</file>
<file alias="Package@2x.png">resources/icons/type/Package@2x.png</file>
<file alias="Parameter.png">resources/icons/type/Parameter.png</file>
<file alias="Parameter@2x.png">resources/icons/type/Parameter@2x.png</file>
<file alias="Pattern.png">resources/icons/type/Pattern.png</file>
<file alias="Pattern@2x.png">resources/icons/type/Pattern@2x.png</file>
<file alias="Pipe.png">resources/icons/type/Pipe.png</file>
<file alias="Pipe@2x.png">resources/icons/type/Pipe@2x.png</file>
<file alias="Plugin.png">resources/icons/type/Plugin.png</file>
<file alias="Plugin@2x.png">resources/icons/type/Plugin@2x.png</file>
<file alias="Procedure.png">resources/icons/type/Procedure.png</file>
<file alias="Procedure@2x.png">resources/icons/type/Procedure@2x.png</file>
<file alias="Projection.png">resources/icons/type/Projection.png</file>
<file alias="Projection@2x.png">resources/icons/type/Projection@2x.png</file>
<file alias="Property.png">resources/icons/type/Property.png</file>
<file alias="Property@2x.png">resources/icons/type/Property@2x.png</file>
<file alias="Protocol.png">resources/icons/type/Protocol.png</file>
<file alias="Protocol@2x.png">resources/icons/type/Protocol@2x.png</file>
<file alias="Provider.png">resources/icons/type/Provider.png</file>
<file alias="Provider@2x.png">resources/icons/type/Provider@2x.png</file>
<file alias="Provisioner.png">resources/icons/type/Provisioner.png</file>
<file alias="Provisioner@2x.png">resources/icons/type/Provisioner@2x.png</file>
<file alias="Query.png">resources/icons/type/Query.png</file>
<file alias="Query@2x.png">resources/icons/type/Query@2x.png</file>
<file alias="Reference.png">resources/icons/type/Reference.png</file>
<file alias="Reference@2x.png">resources/icons/type/Reference@2x.png</file>
<file alias="Register.png">resources/icons/type/Register.png</file>
<file alias="Register@2x.png">resources/icons/type/Register@2x.png</file>
<file alias="Record.png">resources/icons/type/Record.png</file>
<file alias="Record@2x.png">resources/icons/type/Record@2x.png</file>
<file alias="Relationship.png">resources/icons/type/Relationship.png</file>
<file alias="Relationship@2x.png">resources/icons/type/Relationship@2x.png</file>
<file alias="Report.png">resources/icons/type/Report.png</file>
<file alias="Report@2x.png">resources/icons/type/Report@2x.png</file>
<file alias="Request.png">resources/icons/type/Request.png</file>
<file alias="Request@2x.png">resources/icons/type/Request@2x.png</file>
<file alias="Resource.png">resources/icons/type/Resource.png</file>
<file alias="Resource@2x.png">resources/icons/type/Resource@2x.png</file>
<file alias="Role.png">resources/icons/type/Role.png</file>
<file alias="Role@2x.png">resources/icons/type/Role@2x.png</file>
<file alias="Sample.png">resources/icons/type/Sample.png</file>
<file alias="Sample@2x.png">resources/icons/type/Sample@2x.png</file>
<file alias="Schema.png">resources/icons/type/Schema.png</file>
<file alias="Schema@2x.png">resources/icons/type/Schema@2x.png</file>
<file alias="Script.png">resources/icons/type/Script.png</file>
<file alias="Script@2x.png">resources/icons/type/Script@2x.png</file>
<file alias="Section.png">resources/icons/type/Section.png</file>
<file alias="Section@2x.png">resources/icons/type/Section@2x.png</file>
<file alias="Sender.png">resources/icons/type/Sender.png</file>
<file alias="Sender@2x.png">resources/icons/type/Sender@2x.png</file>
<file alias="Service.png">resources/icons/type/Service.png</file>
<file alias="Service@2x.png">resources/icons/type/Service@2x.png</file>
<file alias="Setting.png">resources/icons/type/Setting.png</file>
<file alias="Setting@2x.png">resources/icons/type/Setting@2x.png</file>
<file alias="Shortcut.png">resources/icons/type/Shortcut.png</file>
<file alias="Shortcut@2x.png">resources/icons/type/Shortcut@2x.png</file>
<file alias="Signature.png">resources/icons/type/Signature.png</file>
<file alias="Signature@2x.png">resources/icons/type/Signature@2x.png</file>
<file alias="Special Form.png">resources/icons/type/Special Form.png</file>
<file alias="Special Form@2x.png">resources/icons/type/Special Form@2x.png</file>
<file alias="State.png">resources/icons/type/State.png</file>
<file alias="State@2x.png">resources/icons/type/State@2x.png</file>
<file alias="Statement.png">resources/icons/type/Statement.png</file>
<file alias="Statement@2x.png">resources/icons/type/Statement@2x.png</file>
<file alias="Structure.png">resources/icons/type/Structure.png</file>
<file alias="Structure@2x.png">resources/icons/type/Structure@2x.png</file>
<file alias="Style.png">resources/icons/type/Style.png</file>
<file alias="Style@2x.png">resources/icons/type/Style@2x.png</file>
<file alias="Syntax.png">resources/icons/type/Syntax.png</file>
<file alias="Syntax@2x.png">resources/icons/type/Syntax@2x.png</file>
<file alias="Subroutine.png">resources/icons/type/Subroutine.png</file>
<file alias="Subroutine@2x.png">resources/icons/type/Subroutine@2x.png</file>
<file alias="Table.png">resources/icons/type/Table.png</file>
<file alias="Table@2x.png">resources/icons/type/Table@2x.png</file>
<file alias="Tactic.png">resources/icons/type/Tactic.png</file>
<file alias="Tactic@2x.png">resources/icons/type/Tactic@2x.png</file>
<file alias="Tag.png">resources/icons/type/Tag.png</file>
<file alias="Tag@2x.png">resources/icons/type/Tag@2x.png</file>
<file alias="Template.png">resources/icons/type/Template.png</file>
<file alias="Template@2x.png">resources/icons/type/Template@2x.png</file>
<file alias="Test.png">resources/icons/type/Test.png</file>
<file alias="Test@2x.png">resources/icons/type/Test@2x.png</file>
<file alias="Trait.png">resources/icons/type/Trait.png</file>
<file alias="Trait@2x.png">resources/icons/type/Trait@2x.png</file>
<file alias="Trigger.png">resources/icons/type/Trigger.png</file>
<file alias="Trigger@2x.png">resources/icons/type/Trigger@2x.png</file>
<file alias="Type.png">resources/icons/type/Type.png</file>
<file alias="Type@2x.png">resources/icons/type/Type@2x.png</file>
<file alias="Union.png">resources/icons/type/Union.png</file>
<file alias="Union@2x.png">resources/icons/type/Union@2x.png</file>
<file alias="Unknown.png">resources/icons/type/Unknown.png</file>
<file alias="Unknown@2x.png">resources/icons/type/Unknown@2x.png</file>
<file alias="Value.png">resources/icons/type/Value.png</file>
<file alias="Value@2x.png">resources/icons/type/Value@2x.png</file>
<file alias="Variable.png">resources/icons/type/Variable.png</file>
<file alias="Variable@2x.png">resources/icons/type/Variable@2x.png</file>
<file alias="Variant.png">resources/icons/type/Variant.png</file>
<file alias="Variant@2x.png">resources/icons/type/Variant@2x.png</file>
<file alias="View.png">resources/icons/type/View.png</file>
<file alias="View@2x.png">resources/icons/type/View@2x.png</file>
<file alias="Widget.png">resources/icons/type/Widget.png</file>
<file alias="Widget@2x.png">resources/icons/type/Widget@2x.png</file>
<file alias="Word.png">resources/icons/type/Word.png</file>
<file alias="Word@2x.png">resources/icons/type/Word@2x.png</file>
</qresource>
<qresource prefix="/icons/logo">
<file alias="64x64.png">resources/icons/l
gitextract_ypzf_fv3/ ├── .editorconfig ├── .gitattributes ├── .github/ │ ├── CODEOWNERS │ ├── dependabot.yml │ └── workflows/ │ ├── analyze-codeql.yaml │ ├── analyze-coverity.yaml │ ├── appimage/ │ │ ├── Dockerfile │ │ ├── action.yaml │ │ └── entrypoint.sh │ ├── build-check.yaml │ ├── lock.yaml │ ├── release/ │ │ └── cliff.toml │ └── release.yaml ├── .gitignore ├── CHANGELOG.md ├── CMakeLists.txt ├── CMakePresets.json ├── COPYING ├── LICENSES/ │ ├── GPL-3.0-or-later.txt │ ├── LicenseRef-Kapeli.txt │ ├── MIT.txt │ └── MS-RL.txt ├── README.md ├── REUSE.toml ├── assets/ │ ├── CMakeLists.txt │ └── freedesktop/ │ ├── CMakeLists.txt │ ├── org.zealdocs.zeal.appdata.xml.in │ └── org.zealdocs.zeal.desktop ├── cmake/ │ ├── CodeSign.cmake │ ├── GetVersionFromGit.cmake │ └── MacOSXBundleInfo.plist.in ├── pkg/ │ ├── appimage/ │ │ ├── README.md │ │ └── appimage-amd64.yaml │ └── wix/ │ ├── cpack_post_build.cmake │ ├── cpack_pre_build.cmake │ ├── exitdialog.wxs │ ├── patch.xml │ ├── template.xml │ └── ui.wxs ├── src/ │ ├── CMakeLists.txt │ ├── app/ │ │ ├── CMakeLists.txt │ │ ├── main.cpp │ │ ├── resources/ │ │ │ ├── browser/ │ │ │ │ ├── 404.html │ │ │ │ ├── assets/ │ │ │ │ │ └── css/ │ │ │ │ │ ├── highlight.css │ │ │ │ │ └── welcome.css │ │ │ │ └── welcome.html │ │ │ ├── icons/ │ │ │ │ └── README.md │ │ │ └── zeal.icns │ │ ├── versioninfo.rc.in │ │ └── zeal.qrc │ ├── contrib/ │ │ └── cpp-httplib/ │ │ └── httplib.h │ └── libs/ │ ├── CMakeLists.txt │ ├── browser/ │ │ ├── CMakeLists.txt │ │ ├── searchtoolbar.cpp │ │ ├── searchtoolbar.h │ │ ├── settings.cpp │ │ ├── settings.h │ │ ├── urlrequestinterceptor.cpp │ │ ├── urlrequestinterceptor.h │ │ ├── webbridge.cpp │ │ ├── webbridge.h │ │ ├── webcontrol.cpp │ │ ├── webcontrol.h │ │ ├── webpage.cpp │ │ ├── webpage.h │ │ ├── webview.cpp │ │ └── webview.h │ ├── core/ │ │ ├── CMakeLists.txt │ │ ├── application.cpp │ │ ├── application.h │ │ ├── applicationsingleton.cpp │ │ ├── applicationsingleton.h │ │ ├── extractor.cpp │ │ ├── extractor.h │ │ ├── filemanager.cpp │ │ ├── filemanager.h │ │ ├── httpserver.cpp │ │ ├── httpserver.h │ │ ├── networkaccessmanager.cpp │ │ ├── networkaccessmanager.h │ │ ├── settings.cpp │ │ └── settings.h │ ├── registry/ │ │ ├── CMakeLists.txt │ │ ├── cancellationtoken.h │ │ ├── docset.cpp │ │ ├── docset.h │ │ ├── docsetmetadata.cpp │ │ ├── docsetmetadata.h │ │ ├── docsetregistry.cpp │ │ ├── docsetregistry.h │ │ ├── itemdatarole.h │ │ ├── listmodel.cpp │ │ ├── listmodel.h │ │ ├── searchmodel.cpp │ │ ├── searchmodel.h │ │ ├── searchquery.cpp │ │ ├── searchquery.h │ │ └── searchresult.h │ ├── sidebar/ │ │ ├── CMakeLists.txt │ │ ├── container.cpp │ │ ├── container.h │ │ ├── proxyview.cpp │ │ ├── proxyview.h │ │ ├── view.cpp │ │ ├── view.h │ │ ├── viewprovider.cpp │ │ └── viewprovider.h │ ├── ui/ │ │ ├── CMakeLists.txt │ │ ├── aboutdialog.cpp │ │ ├── aboutdialog.h │ │ ├── aboutdialog.ui │ │ ├── browsertab.cpp │ │ ├── browsertab.h │ │ ├── docsetlistitemdelegate.cpp │ │ ├── docsetlistitemdelegate.h │ │ ├── docsetsdialog.cpp │ │ ├── docsetsdialog.h │ │ ├── docsetsdialog.ui │ │ ├── mainwindow.cpp │ │ ├── mainwindow.h │ │ ├── qxtglobalshortcut/ │ │ │ ├── CMakeLists.txt │ │ │ ├── qxtglobalshortcut.cpp │ │ │ ├── qxtglobalshortcut.h │ │ │ ├── qxtglobalshortcut_mac.cpp │ │ │ ├── qxtglobalshortcut_noop.cpp │ │ │ ├── qxtglobalshortcut_p.h │ │ │ ├── qxtglobalshortcut_win.cpp │ │ │ └── qxtglobalshortcut_x11.cpp │ │ ├── searchitemdelegate.cpp │ │ ├── searchitemdelegate.h │ │ ├── searchsidebar.cpp │ │ ├── searchsidebar.h │ │ ├── settingsdialog.cpp │ │ ├── settingsdialog.h │ │ ├── settingsdialog.ui │ │ ├── sidebarviewprovider.cpp │ │ ├── sidebarviewprovider.h │ │ └── widgets/ │ │ ├── CMakeLists.txt │ │ ├── layouthelper.cpp │ │ ├── layouthelper.h │ │ ├── searchedit.cpp │ │ ├── searchedit.h │ │ ├── shortcutedit.cpp │ │ ├── shortcutedit.h │ │ ├── toolbarframe.cpp │ │ └── toolbarframe.h │ └── util/ │ ├── CMakeLists.txt │ ├── caseinsensitivemap.h │ ├── fuzzy.cpp │ ├── fuzzy.h │ ├── humanizer.cpp │ ├── humanizer.h │ ├── plist.cpp │ ├── plist.h │ ├── sqlitedatabase.cpp │ ├── sqlitedatabase.h │ └── tests/ │ ├── CMakeLists.txt │ └── fuzzy_test.cpp └── vcpkg.json
SYMBOL INDEX (567 symbols across 78 files)
FILE: src/app/main.cpp
type CommandLineParameters (line 32) | struct CommandLineParameters
function QString (line 46) | QString stripParameterUrl(const QString &url, const QString &scheme)
function CommandLineParameters (line 61) | CommandLineParameters parseCommandLine(const QStringList &arguments)
function registerProtocolHandler (line 124) | void registerProtocolHandler(const QString &scheme, const QString &descr...
function registerProtocolHandlers (line 144) | void registerProtocolHandlers(const QHash<QString, QString> &protocols, ...
function unregisterProtocolHandlers (line 156) | void unregisterProtocolHandlers(const QHash<QString, QString> &protocols)
function main (line 167) | int main(int argc, char *argv[])
FILE: src/contrib/cpp-httplib/httplib.h
function namespace (line 441) | namespace httplib {
function from_chars_result (line 605) | inline from_chars_result<double> from_chars(const char *first, const cha...
type SSLVerifierResponse (line 620) | enum SSLVerifierResponse {
type StatusCode (line 629) | enum StatusCode {
type Response (line 714) | struct Response
type FormData (line 717) | struct FormData {
type FormField (line 725) | struct FormField {
type MultipartFormData (line 734) | struct MultipartFormData {
type UploadFormData (line 751) | struct UploadFormData {
function class (line 759) | class DataSink {
type FormDataProvider (line 800) | struct FormDataProvider {
function class (line 816) | class ContentReader {
function const (line 830) | bool operator()(ContentReceiver receiver) const {
type class (line 853) | enum class
type class (line 859) | enum class
type SanEntry (line 862) | struct SanEntry {
type VerifyContext (line 868) | struct VerifyContext {
function ErrorCode (line 888) | enum class ErrorCode : int {
type Request (line 940) | struct Request {
type Response (line 1004) | struct Response {
type class (line 1067) | enum class
function class (line 1111) | class Stream {
function class (line 1136) | class TaskQueue {
type worker (line 1157) | struct worker {
type class (line 1179) | enum class
function namespace (line 1194) | namespace detail {
type class (line 1284) | enum class
function is_running (line 1377) | bool is_running() const;
function namespace (line 1619) | namespace detail {
function class (line 1648) | class ClientImpl {
function port (line 1808) | int port() const;
type PemMemory (line 2369) | struct PemMemory {
function is_valid (line 2380) | bool is_valid() const override;
function is_numeric (line 2473) | inline bool is_numeric(const std::string &str) {
function get_header_value_u64 (line 2479) | inline size_t get_header_value_u64(const Headers &headers,
function get_header_value_u64 (line 2496) | inline size_t get_header_value_u64(const Headers &headers,
function set_connection_timeout (line 2530) | void ClientImpl::set_connection_timeout(
function set_read_timeout (line 2538) | void ClientImpl::set_read_timeout(
function set_write_timeout (line 2545) | void ClientImpl::set_write_timeout(
function set_max_timeout (line 2552) | void ClientImpl::set_max_timeout(
function set_connection_timeout (line 2560) | void Client::set_connection_timeout(
function set_read_timeout (line 2566) | void
function set_write_timeout (line 2572) | void
function set_max_timeout (line 2577) | inline void Client::set_max_timeout(time_t msec) {
function set_max_timeout (line 2582) | void
function namespace (line 2619) | namespace detail {
function getline (line 4382) | inline bool stream_line_reader::getline() {
function append (line 4422) | inline void stream_line_reader::append(char c) {
function mmap (line 4435) | inline mmap::mmap(const char *path) { open(path); }
function mmap (line 4437) | inline mmap::~mmap() { close(); }
function open (line 4439) | inline bool mmap::open(const char *path) {
function close (line 4518) | inline void mmap::close() {
function close_socket (line 4549) | inline int close_socket(socket_t sock) {
function read_socket (line 4570) | inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int fl...
function ContentProviderWithoutLength (line 12171) | inline ContentProviderWithoutLength ClientImpl::get_multipart_content_pr...
function process_socket (line 12215) | inline bool ClientImpl::process_socket(
function Result (line 12226) | inline Result ClientImpl::Get(const std::string &path,
function Result (line 12231) | inline Result ClientImpl::Get(const std::string &path, const Params &par...
function Result (line 12240) | inline Result ClientImpl::Get(const std::string &path, const Headers &he...
function Result (line 12254) | inline Result ClientImpl::Get(const std::string &path,
function Result (line 12261) | inline Result ClientImpl::Get(const std::string &path, const Headers &he...
function Result (line 12268) | inline Result ClientImpl::Get(const std::string &path,
function Result (line 12276) | inline Result ClientImpl::Get(const std::string &path, const Headers &he...
function Result (line 12298) | inline Result ClientImpl::Get(const std::string &path, const Params &par...
function Result (line 12306) | inline Result ClientImpl::Get(const std::string &path, const Params &par...
function Result (line 12321) | inline Result ClientImpl::Head(const std::string &path) {
function Result (line 12325) | inline Result ClientImpl::Head(const std::string &path,
function Result (line 12338) | inline Result ClientImpl::Post(const std::string &path) {
function Result (line 12342) | inline Result ClientImpl::Post(const std::string &path,
function Result (line 12347) | inline Result ClientImpl::Post(const std::string &path, const char *body,
function Result (line 12354) | inline Result ClientImpl::Post(const std::string &path, const std::strin...
function Result (line 12360) | inline Result ClientImpl::Post(const std::string &path, const Params &pa...
function Result (line 12364) | inline Result ClientImpl::Post(const std::string &path, size_t content_l...
function Result (line 12372) | inline Result ClientImpl::Post(const std::string &path, size_t content_l...
function Result (line 12381) | inline Result ClientImpl::Post(const std::string &path,
function Result (line 12389) | inline Result ClientImpl::Post(const std::string &path,
function Result (line 12398) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12404) | inline Result ClientImpl::Post(const std::string &path,
function Result (line 12410) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12420) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12434) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12443) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12452) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12462) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12474) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12483) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12493) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12506) | inline Result ClientImpl::Post(const std::string &path, const Headers &h...
function Result (line 12532) | inline Result ClientImpl::Put(const std::string &path) {
function Result (line 12536) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12540) | inline Result ClientImpl::Put(const std::string &path, const char *body,
function Result (line 12547) | inline Result ClientImpl::Put(const std::string &path, const std::string...
function Result (line 12553) | inline Result ClientImpl::Put(const std::string &path, const Params &par...
function Result (line 12557) | inline Result ClientImpl::Put(const std::string &path, size_t content_le...
function Result (line 12565) | inline Result ClientImpl::Put(const std::string &path, size_t content_le...
function Result (line 12574) | inline Result ClientImpl::Put(const std::string &path,
function Result (line 12582) | inline Result ClientImpl::Put(const std::string &path,
function Result (line 12591) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12597) | inline Result ClientImpl::Put(const std::string &path,
function Result (line 12603) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12613) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12627) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12636) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12645) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12655) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12667) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12676) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12686) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12699) | inline Result ClientImpl::Put(const std::string &path, const Headers &he...
function Result (line 12725) | inline Result ClientImpl::Patch(const std::string &path) {
function Result (line 12729) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12734) | inline Result ClientImpl::Patch(const std::string &path, const char *body,
function Result (line 12741) | inline Result ClientImpl::Patch(const std::string &path,
function Result (line 12748) | inline Result ClientImpl::Patch(const std::string &path, const Params &p...
function Result (line 12752) | inline Result ClientImpl::Patch(const std::string &path, size_t content_...
function Result (line 12760) | inline Result ClientImpl::Patch(const std::string &path, size_t content_...
function Result (line 12769) | inline Result ClientImpl::Patch(const std::string &path,
function Result (line 12777) | inline Result ClientImpl::Patch(const std::string &path,
function Result (line 12786) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12792) | inline Result ClientImpl::Patch(const std::string &path,
function Result (line 12798) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12808) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12822) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12831) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12840) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12850) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12862) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12871) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12881) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12894) | inline Result ClientImpl::Patch(const std::string &path, const Headers &...
function Result (line 12920) | inline Result ClientImpl::Delete(const std::string &path,
function Result (line 12925) | inline Result ClientImpl::Delete(const std::string &path,
function Result (line 12931) | inline Result ClientImpl::Delete(const std::string &path, const char *body,
function Result (line 12938) | inline Result ClientImpl::Delete(const std::string &path,
function Result (line 12946) | inline Result ClientImpl::Delete(const std::string &path,
function Result (line 12955) | inline Result ClientImpl::Delete(const std::string &path, const Params &...
function Result (line 12960) | inline Result ClientImpl::Delete(const std::string &path,
function Result (line 12968) | inline Result ClientImpl::Delete(const std::string &path,
function Result (line 12988) | inline Result ClientImpl::Options(const std::string &path) {
function Result (line 12992) | inline Result ClientImpl::Options(const std::string &path,
function stop (line 13005) | inline void ClientImpl::stop() {
function set_connection_timeout (line 13039) | inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
function set_read_timeout (line 13044) | inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
function set_write_timeout (line 13049) | inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
function set_max_timeout (line 13054) | inline void ClientImpl::set_max_timeout(time_t msec) {
function set_basic_auth (line 13058) | inline void ClientImpl::set_basic_auth(const std::string &username,
function set_bearer_token_auth (line 13064) | inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
function set_keep_alive (line 13068) | inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
function set_follow_location (line 13070) | inline void ClientImpl::set_follow_location(bool on) { follow_location_ ...
function set_path_encode (line 13072) | inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
function set_hostname_addr_map (line 13074) | inline void
function set_default_headers (line 13079) | inline void ClientImpl::set_default_headers(Headers headers) {
function set_header_writer (line 13083) | inline void ClientImpl::set_header_writer(
function set_address_family (line 13088) | inline void ClientImpl::set_address_family(int family) {
function set_tcp_nodelay (line 13092) | inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
function set_ipv6_v6only (line 13094) | inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
function set_socket_options (line 13096) | inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
function set_compress (line 13100) | inline void ClientImpl::set_compress(bool on) { compress_ = on; }
function set_decompress (line 13102) | inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
function set_payload_max_length (line 13104) | inline void ClientImpl::set_payload_max_length(size_t length) {
function set_interface (line 13109) | inline void ClientImpl::set_interface(const std::string &intf) {
function set_proxy (line 13113) | inline void ClientImpl::set_proxy(const std::string &host, int port) {
function set_proxy_basic_auth (line 13118) | inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
function set_proxy_bearer_token_auth (line 13124) | inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &t...
function set_digest_auth (line 13129) | inline void ClientImpl::set_digest_auth(const std::string &username,
function set_ca_cert_path (line 13135) | inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file...
function set_proxy_digest_auth (line 13141) | inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
function enable_server_certificate_verification (line 13147) | inline void ClientImpl::enable_server_certificate_verification(bool enab...
function enable_server_hostname_verification (line 13151) | inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
function X509_STORE (line 13158) | inline X509_STORE *ClientImpl::create_ca_cert_store(const char *ca_cert,
function set_server_certificate_verifier (line 13182) | inline void ClientImpl::set_server_certificate_verifier(
function set_logger (line 13188) | inline void ClientImpl::set_logger(Logger logger) {
function set_error_logger (line 13192) | inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
function ClientConnection (line 13200) | inline ClientConnection::~ClientConnection() {
function Client (line 13216) | inline Client::Client(const std::string &scheme_host_port)
function Client (line 13267) | inline Client::Client(const std::string &host, int port)
function Client (line 13270) | inline Client::Client(const std::string &host, int port,
function Result (line 13282) | inline Result Client::Get(const std::string &path, DownloadProgress prog...
function Result (line 13285) | inline Result Client::Get(const std::string &path, const Headers &headers,
function Result (line 13289) | inline Result Client::Get(const std::string &path,
function Result (line 13294) | inline Result Client::Get(const std::string &path, const Headers &headers,
function Result (line 13300) | inline Result Client::Get(const std::string &path,
function Result (line 13307) | inline Result Client::Get(const std::string &path, const Headers &headers,
function Result (line 13314) | inline Result Client::Get(const std::string &path, const Params ¶ms,
function Result (line 13318) | inline Result Client::Get(const std::string &path, const Params ¶ms,
function Result (line 13325) | inline Result Client::Get(const std::string &path, const Params ¶ms,
function Result (line 13334) | inline Result Client::Head(const std::string &path) { return cli_->Head(...
function Result (line 13335) | inline Result Client::Head(const std::string &path, const Headers &heade...
function Result (line 13339) | inline Result Client::Post(const std::string &path) { return cli_->Post(...
function Result (line 13340) | inline Result Client::Post(const std::string &path, const Headers &heade...
function Result (line 13343) | inline Result Client::Post(const std::string &path, const char *body,
function Result (line 13349) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13356) | inline Result Client::Post(const std::string &path, const std::string &b...
function Result (line 13361) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13367) | inline Result Client::Post(const std::string &path, size_t content_length,
function Result (line 13374) | inline Result Client::Post(const std::string &path, size_t content_length,
function Result (line 13382) | inline Result Client::Post(const std::string &path,
function Result (line 13388) | inline Result Client::Post(const std::string &path,
function Result (line 13396) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13404) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13413) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13420) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13428) | inline Result Client::Post(const std::string &path, const Params ¶ms) {
function Result (line 13431) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13435) | inline Result Client::Post(const std::string &path,
function Result (line 13440) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13445) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13451) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13457) | inline Result Client::Post(const std::string &path, const Headers &headers,
function Result (line 13466) | inline Result Client::Put(const std::string &path) { return cli_->Put(pa...
function Result (line 13467) | inline Result Client::Put(const std::string &path, const Headers &header...
function Result (line 13470) | inline Result Client::Put(const std::string &path, const char *body,
function Result (line 13476) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13482) | inline Result Client::Put(const std::string &path, const std::string &body,
function Result (line 13487) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13493) | inline Result Client::Put(const std::string &path, size_t content_length,
function Result (line 13500) | inline Result Client::Put(const std::string &path, size_t content_length,
function Result (line 13508) | inline Result Client::Put(const std::string &path,
function Result (line 13514) | inline Result Client::Put(const std::string &path,
function Result (line 13522) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13530) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13539) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13546) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13554) | inline Result Client::Put(const std::string &path, const Params ¶ms) {
function Result (line 13557) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13561) | inline Result Client::Put(const std::string &path,
function Result (line 13566) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13571) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13577) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13583) | inline Result Client::Put(const std::string &path, const Headers &headers,
function Result (line 13592) | inline Result Client::Patch(const std::string &path) {
function Result (line 13595) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13598) | inline Result Client::Patch(const std::string &path, const char *body,
function Result (line 13604) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13611) | inline Result Client::Patch(const std::string &path, const std::string &...
function Result (line 13616) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13622) | inline Result Client::Patch(const std::string &path, size_t content_length,
function Result (line 13629) | inline Result Client::Patch(const std::string &path, size_t content_length,
function Result (line 13637) | inline Result Client::Patch(const std::string &path,
function Result (line 13643) | inline Result Client::Patch(const std::string &path,
function Result (line 13651) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13659) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13668) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13675) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13683) | inline Result Client::Patch(const std::string &path, const Params ¶m...
function Result (line 13686) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13690) | inline Result Client::Patch(const std::string &path,
function Result (line 13695) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13700) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13706) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13712) | inline Result Client::Patch(const std::string &path, const Headers &head...
function Result (line 13721) | inline Result Client::Delete(const std::string &path,
function Result (line 13725) | inline Result Client::Delete(const std::string &path, const Headers &hea...
function Result (line 13729) | inline Result Client::Delete(const std::string &path, const char *body,
function Result (line 13735) | inline Result Client::Delete(const std::string &path, const Headers &hea...
function Result (line 13742) | inline Result Client::Delete(const std::string &path, const std::string ...
function Result (line 13747) | inline Result Client::Delete(const std::string &path, const Headers &hea...
function Result (line 13753) | inline Result Client::Delete(const std::string &path, const Params ¶ms,
function Result (line 13757) | inline Result Client::Delete(const std::string &path, const Headers &hea...
function Result (line 13762) | inline Result Client::Options(const std::string &path) {
function Result (line 13765) | inline Result Client::Options(const std::string &path, const Headers &he...
function send (line 13776) | inline bool Client::send(Request &req, Response &res, Error &error) {
function Result (line 13780) | inline Result Client::send(const Request &req) { return cli_->send(req); }
function stop (line 13782) | inline void Client::stop() { cli_->stop(); }
function set_hostname_addr_map (line 13792) | inline void
function set_default_headers (line 13797) | inline void Client::set_default_headers(Headers headers) {
function set_header_writer (line 13801) | inline void Client::set_header_writer(
function set_address_family (line 13806) | inline void Client::set_address_family(int family) {
function set_tcp_nodelay (line 13810) | inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
function set_socket_options (line 13812) | inline void Client::set_socket_options(SocketOptions socket_options) {
function set_connection_timeout (line 13816) | inline void Client::set_connection_timeout(time_t sec, time_t usec) {
function set_read_timeout (line 13820) | inline void Client::set_read_timeout(time_t sec, time_t usec) {
function set_write_timeout (line 13824) | inline void Client::set_write_timeout(time_t sec, time_t usec) {
function set_basic_auth (line 13828) | inline void Client::set_basic_auth(const std::string &username,
function set_bearer_token_auth (line 13832) | inline void Client::set_bearer_token_auth(const std::string &token) {
function set_keep_alive (line 13836) | inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
function set_follow_location (line 13837) | inline void Client::set_follow_location(bool on) {
function set_path_encode (line 13841) | inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
function set_url_encode (line 13843) | [[deprecated("Use set_path_encode instead")]]
function set_compress (line 13848) | inline void Client::set_compress(bool on) { cli_->set_compress(on); }
function set_decompress (line 13850) | inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
function set_payload_max_length (line 13852) | inline void Client::set_payload_max_length(size_t length) {
function set_interface (line 13856) | inline void Client::set_interface(const std::string &intf) {
function set_proxy (line 13860) | inline void Client::set_proxy(const std::string &host, int port) {
function set_proxy_basic_auth (line 13863) | inline void Client::set_proxy_basic_auth(const std::string &username,
function set_proxy_bearer_token_auth (line 13867) | inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
function set_logger (line 13871) | inline void Client::set_logger(Logger logger) {
function set_error_logger (line 13875) | inline void Client::set_error_logger(ErrorLogger error_logger) {
function SSLServer (line 13886) | inline SSLServer::SSLServer(const char *cert_path, const char *private_k...
function SSLServer (line 13918) | inline SSLServer::SSLServer(const PemMemory &pem) {
function SSLServer (line 13939) | inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callb...
function SSLServer (line 13950) | inline SSLServer::~SSLServer() {
function process_and_close_socket (line 13956) | inline bool SSLServer::process_and_close_socket(socket_t sock) {
function update_certs_pem (line 14026) | inline bool SSLServer::update_certs_pem(const char *cert_pem,
function SSLClient (line 14042) | inline SSLClient::~SSLClient() {
function shutdown_ssl (line 14052) | inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracef...
function shutdown_ssl_impl (line 14056) | inline void SSLClient::shutdown_ssl_impl(Socket &socket,
function process_socket (line 14073) | inline bool SSLClient::process_socket(
function create_and_connect_socket (line 14086) | inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &...
function connect_with_proxy (line 14096) | inline bool SSLClient::connect_with_proxy(
function ensure_socket_connection (line 14190) | inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &e...
function SSLClient (line 14205) | inline SSLClient::SSLClient(const std::string &host)
function SSLClient (line 14208) | inline SSLClient::SSLClient(const std::string &host, int port)
function SSLClient (line 14211) | inline SSLClient::SSLClient(const std::string &host, int port,
function SSLClient (line 14233) | inline SSLClient::SSLClient(const std::string &host, int port,
function set_ca_cert_store (line 14251) | inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
function set_server_certificate_verifier (line 14260) | inline void
function set_session_verifier (line 14266) | inline void SSLClient::set_session_verifier(
function enable_windows_certificate_verification (line 14273) | inline void SSLClient::enable_windows_certificate_verification(bool enab...
function load_ca_cert_store (line 14278) | inline void SSLClient::load_ca_cert_store(const char *ca_cert,
function load_certs (line 14286) | inline bool SSLClient::load_certs() {
function initialize_ssl (line 14312) | inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
function set_digest_auth (line 14459) | inline void Client::set_digest_auth(const std::string &username,
function set_proxy_digest_auth (line 14464) | inline void Client::set_proxy_digest_auth(const std::string &username,
function enable_server_certificate_verification (line 14469) | inline void Client::enable_server_certificate_verification(bool enabled) {
function enable_server_hostname_verification (line 14473) | inline void Client::enable_server_hostname_verification(bool enabled) {
function enable_windows_certificate_verification (line 14479) | inline void Client::enable_windows_certificate_verification(bool enabled) {
function set_ca_cert_path (line 14487) | inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
function set_ca_cert_store (line 14492) | inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
function load_ca_cert_store (line 14500) | inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t ...
function set_server_certificate_verifier (line 14504) | inline void
function set_session_verifier (line 14512) | inline void Client::set_session_verifier(
function namespace (line 14532) | namespace tls {
function PeerCert (line 14604) | inline PeerCert::~PeerCert() {
function check_hostname (line 14618) | inline bool PeerCert::check_hostname(const char *hostname) const {
function validity (line 14628) | inline bool PeerCert::validity(time_t ¬_before, time_t ¬_after) co...
function check_hostname (line 14645) | inline bool VerifyContext::check_hostname(const char *hostname) const {
function validity (line 14655) | inline bool VerifyContext::validity(time_t ¬_before,
function SSL_CTX (line 14690) | inline SSL_CTX *Client::ssl_context() const {
function set_server_certificate_verifier (line 14695) | inline void Client::set_server_certificate_verifier(
function namespace (line 14711) | namespace tls {
function set_ca_cert_store (line 15810) | inline void ClientImpl::set_ca_cert_store(X509_STORE *ca_cert_store) {
function SSLServer (line 15816) | inline SSLServer::SSLServer(X509 *cert, EVP_PKEY *private_key,
function SSLServer (line 15822) | inline SSLServer::SSLServer(
function SSL_CTX (line 15836) | inline SSL_CTX *SSLServer::ssl_context() const {
function update_certs (line 15840) | inline void SSLServer::update_certs(X509 *cert, EVP_PKEY *private_key,
function SSLClient (line 15847) | inline SSLClient::SSLClient(const std::string &host, int port,
function set_server_certificate_verifier (line 15859) | inline void SSLClient::set_server_certificate_verifier(
function SSL_CTX (line 15869) | inline SSL_CTX *SSLClient::ssl_context() const {
function verify_host (line 15873) | inline bool SSLClient::verify_host(X509 *server_cert) const {
function verify_host_with_subject_alt_name (line 15899) | inline bool
function verify_host_with_common_name (line 15960) | inline bool SSLClient::verify_host_with_common_name(X509 *server_cert) c...
function namespace (line 15988) | namespace tls {
function ctx_t (line 16191) | inline ctx_t create_client_context() {
function ctx_t (line 16235) | inline ctx_t create_server_context() {
function free_context (line 16282) | inline void free_context(ctx_t ctx) {
function set_min_version (line 16286) | inline bool set_min_version(ctx_t ctx, Version version) {
function load_ca_pem (line 16315) | inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
function load_ca_file (line 16334) | inline bool load_ca_file(ctx_t ctx, const char *file_path) {
function load_ca_dir (line 16348) | inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
function load_system_certs (line 16362) | inline bool load_system_certs(ctx_t ctx) {
function set_client_cert_pem (line 16443) | inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char ...
function set_client_cert_file (line 16489) | inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
function set_verify_client (line 16522) | inline void set_verify_client(ctx_t ctx, bool require) {
function session_t (line 16537) | inline session_t create_session(ctx_t ctx, socket_t sock) {
function free_session (line 16567) | inline void free_session(session_t session) {
function set_sni (line 16571) | inline bool set_sni(session_t session, const char *hostname) {
function set_hostname (line 16585) | inline bool set_hostname(session_t session, const char *hostname) {
function TlsError (line 16590) | inline TlsError connect(session_t session) {
function TlsError (line 16611) | inline TlsError accept(session_t session) {
function connect_nonblocking (line 16625) | inline bool connect_nonblocking(session_t session, socket_t sock,
function accept_nonblocking (line 16665) | inline bool accept_nonblocking(session_t session, socket_t sock,
function read (line 16682) | inline ssize_t read(session_t session, void *buf, size_t len, TlsError &...
function write (line 16708) | inline ssize_t write(session_t session, const void *buf, size_t len,
function pending (line 16735) | inline int pending(const_session_t session) {
function shutdown (line 16742) | inline void shutdown(session_t session, bool graceful) {
function is_peer_closed (line 16761) | inline bool is_peer_closed(session_t session, socket_t sock) {
function cert_t (line 16789) | inline cert_t get_peer_cert(const_session_t session) {
function free_cert (line 16801) | inline void free_cert(cert_t cert) {
function verify_hostname (line 16808) | inline bool verify_hostname(cert_t cert, const char *hostname) {
function hostname_mismatch_code (line 16866) | inline uint64_t hostname_mismatch_code() {
function get_verify_result (line 16870) | inline long get_verify_result(const_session_t session) {
function std (line 16879) | inline std::string get_cert_subject_cn(cert_t cert) {
function std (line 16895) | inline std::string get_cert_issuer_name(cert_t cert) {
function get_cert_sans (line 16906) | inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
function get_cert_validity (line 16980) | inline bool get_cert_validity(cert_t cert, time_t ¬_before,
function std (line 17006) | inline std::string get_cert_serial(cert_t cert) {
function get_cert_der (line 17021) | inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
function peek_error (line 17044) | inline uint64_t peek_error() {
function get_error (line 17049) | inline uint64_t get_error() {
function std (line 17056) | inline std::string error_string(uint64_t code) {
function ca_store_t (line 17062) | inline ca_store_t create_ca_store(const char *pem, size_t len) {
function free_ca_store (line 17086) | inline void free_ca_store(ca_store_t store) {
function set_ca_store (line 17094) | inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
function get_ca_certs (line 17118) | inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
function std (line 17141) | inline std::vector<std::string> get_ca_names(ctx_t ctx) {
function update_server_cert (line 17157) | inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
function update_server_client_ca (line 17208) | inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
function set_verify_callback (line 17230) | inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
function get_verify_error (line 17250) | inline long get_verify_error(const_session_t session) {
function std (line 17257) | inline std::string verify_error_string(long error_code) {
FILE: src/libs/browser/searchtoolbar.h
function namespace (line 13) | namespace Zeal {
FILE: src/libs/browser/settings.cpp
function QWebEngineProfile (line 74) | QWebEngineProfile *Settings::defaultProfile()
FILE: src/libs/browser/settings.h
function namespace (line 11) | namespace Zeal {
FILE: src/libs/browser/urlrequestinterceptor.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/browser/webbridge.cpp
function QString (line 28) | QString WebBridge::appVersion() const
FILE: src/libs/browser/webbridge.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/browser/webcontrol.cpp
function QString (line 134) | QString WebControl::title() const
function QUrl (line 139) | QUrl WebControl::url() const
function QWebEngineHistory (line 144) | QWebEngineHistory *WebControl::history() const
function QByteArray (line 155) | QByteArray WebControl::saveHistory() const
FILE: src/libs/browser/webcontrol.h
function namespace (line 12) | namespace Zeal {
FILE: src/libs/browser/webpage.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/browser/webview.cpp
function QWebEngineView (line 103) | QWebEngineView *WebView::createWindow(QWebEnginePage::WebWindowType type)
FILE: src/libs/browser/webview.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/core/application.cpp
function Application (line 89) | Application *Application::instance()
function QNetworkAccessManager (line 116) | QNetworkAccessManager *Application::networkManager() const
function Settings (line 121) | Settings *Application::settings() const
function FileManager (line 131) | FileManager *Application::fileManager() const
function HttpServer (line 136) | HttpServer *Application::httpServer() const
function QString (line 141) | QString Application::cacheLocation()
function QString (line 150) | QString Application::configLocation()
function QVersionNumber (line 160) | QVersionNumber Application::version()
function QString (line 166) | QString Application::versionString()
function QNetworkReply (line 189) | QNetworkReply *Application::download(const QUrl &url)
function QString (line 279) | QString Application::userAgent()
function QString (line 284) | QString Application::userAgentJson() const
FILE: src/libs/core/application.h
function namespace (line 14) | namespace Zeal {
FILE: src/libs/core/applicationsingleton.cpp
type SharedData (line 19) | struct SharedData
function qint64 (line 77) | qint64 ApplicationSingleton::primaryPid() const
function QString (line 144) | QString ApplicationSingleton::computeId()
FILE: src/libs/core/applicationsingleton.h
function namespace (line 12) | namespace Zeal {
FILE: src/libs/core/extractor.h
type archive (line 9) | struct archive
function namespace (line 11) | namespace Zeal {
FILE: src/libs/core/filemanager.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/core/httpserver.cpp
function QUrl (line 54) | QUrl HttpServer::baseUrl() const
function QUrl (line 59) | QUrl HttpServer::mount(const QString &prefix, const QString &path)
function QString (line 88) | QString HttpServer::sanitizePrefix(const QString &prefix)
FILE: src/libs/core/httpserver.h
function namespace (line 13) | namespace httplib {
function namespace (line 17) | namespace Zeal {
FILE: src/libs/core/networkaccessmanager.cpp
function QNetworkReply (line 37) | QNetworkReply *NetworkAccessManager::createRequest(QNetworkAccessManager...
FILE: src/libs/core/networkaccessmanager.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/core/settings.cpp
function QSettings (line 417) | QSettings *Settings::qsettings(QObject *parent)
function QDataStream (line 427) | QDataStream &operator<<(QDataStream &out, Settings::ContentAppearance po...
function QDataStream (line 433) | QDataStream &operator>>(QDataStream &in, Settings::ContentAppearance &po...
function QDataStream (line 441) | QDataStream &operator<<(QDataStream &out, Settings::ExternalLinkPolicy p...
function QDataStream (line 447) | QDataStream &operator>>(QDataStream &in, Settings::ExternalLinkPolicy &p...
FILE: src/libs/core/settings.h
type class (line 56) | enum class
type class (line 64) | enum class
type ProxyType (line 77) | enum ProxyType : unsigned int {
FILE: src/libs/registry/cancellationtoken.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/registry/docset.cpp
type InfoPlist (line 41) | namespace InfoPlist {
function QString (line 218) | QString Docset::name() const
function QString (line 223) | QString Docset::title() const
function QStringList (line 228) | QStringList Docset::keywords() const
function QString (line 233) | QString Docset::version() const
function QString (line 243) | QString Docset::feedUrl() const
function QString (line 248) | QString Docset::path() const
function QString (line 253) | QString Docset::documentPath() const
function QIcon (line 258) | QIcon Docset::icon() const
function QIcon (line 263) | QIcon Docset::symbolTypeIcon(const QString &symbolType) const
function QUrl (line 271) | QUrl Docset::indexFileUrl() const
function QUrl (line 401) | QUrl Docset::searchResultUrl(const SearchResult &result) const
function QUrl (line 574) | QUrl Docset::createPageUrl(const QString &path, const QString &fragment)...
function QString (line 608) | QString Docset::parseSymbolType(const QString &str)
function QUrl (line 742) | QUrl Docset::baseUrl() const
function sqliteScoreFunction (line 771) | static void sqliteScoreFunction(sqlite3_context *context, int argc, sqli...
FILE: src/libs/registry/docset.h
function namespace (line 14) | namespace Zeal {
FILE: src/libs/registry/docsetmetadata.cpp
function QString (line 109) | QString DocsetMetadata::name() const
function QIcon (line 114) | QIcon DocsetMetadata::icon() const
function QString (line 119) | QString DocsetMetadata::title() const
function QStringList (line 124) | QStringList DocsetMetadata::aliases() const
function QStringList (line 129) | QStringList DocsetMetadata::versions() const
function QString (line 134) | QString DocsetMetadata::latestVersion() const
function QUrl (line 144) | QUrl DocsetMetadata::feedUrl() const
function QUrl (line 149) | QUrl DocsetMetadata::url() const
function DocsetMetadata (line 159) | DocsetMetadata DocsetMetadata::fromDashFeed(const QUrl &feedUrl, const Q...
FILE: src/libs/registry/docsetmetadata.h
function namespace (line 13) | namespace Zeal {
FILE: src/libs/registry/docsetregistry.cpp
function MergeQueryResults (line 28) | void MergeQueryResults(QList<SearchResult> &finalResult, const QList<Sea...
function QAbstractItemModel (line 53) | QAbstractItemModel *DocsetRegistry::model() const
function QString (line 58) | QString DocsetRegistry::storagePath() const
function QStringList (line 104) | QStringList DocsetRegistry::names() const
function Docset (line 164) | Docset *DocsetRegistry::docset(const QString &name) const
function Docset (line 169) | Docset *DocsetRegistry::docset(int index) const
function Docset (line 179) | Docset *DocsetRegistry::docsetForUrl(const QUrl &url)
FILE: src/libs/registry/docsetregistry.h
function namespace (line 17) | namespace Zeal {
FILE: src/libs/registry/itemdatarole.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/registry/listmodel.cpp
function QVariant (line 31) | QVariant ListModel::headerData(int section, Qt::Orientation orientation,...
function QVariant (line 47) | QVariant ListModel::data(const QModelIndex &index, int role) const
function QModelIndex (line 139) | QModelIndex ListModel::index(int row, int column, const QModelIndex &par...
function QModelIndex (line 159) | QModelIndex ListModel::parent(const QModelIndex &child) const
function QString (line 254) | QString ListModel::pluralize(const QString &s)
FILE: src/libs/registry/listmodel.h
function namespace (line 12) | namespace Zeal {
FILE: src/libs/registry/searchmodel.cpp
function SearchModel (line 17) | SearchModel *SearchModel::clone(QObject *parent)
function QVariant (line 29) | QVariant SearchModel::data(const QModelIndex &index, int role) const
function QModelIndex (line 57) | QModelIndex SearchModel::index(int row, int column, const QModelIndex &p...
FILE: src/libs/registry/searchquery.cpp
function SearchQuery (line 22) | SearchQuery SearchQuery::fromString(const QString &str)
function QString (line 41) | QString SearchQuery::toString() const
function QStringList (line 55) | QStringList SearchQuery::keywords() const
function QString (line 90) | QString SearchQuery::query() const
function QDataStream (line 100) | QDataStream &operator<<(QDataStream &out, const Zeal::Registry::SearchQu...
function QDataStream (line 106) | QDataStream &operator>>(QDataStream &in, Zeal::Registry::SearchQuery &qu...
FILE: src/libs/registry/searchresult.h
function namespace (line 12) | namespace Zeal {
FILE: src/libs/sidebar/container.h
function namespace (line 11) | namespace Zeal {
FILE: src/libs/sidebar/proxyview.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/sidebar/view.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/sidebar/viewprovider.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/ui/aboutdialog.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/ui/browsertab.cpp
function BrowserTab (line 148) | BrowserTab *BrowserTab::clone(QWidget *parent) const
function SearchSidebar (line 179) | SearchSidebar *BrowserTab::searchSidebar()
function QIcon (line 206) | QIcon BrowserTab::docsetIcon(const QUrl &url) const
FILE: src/libs/ui/browsertab.h
function namespace (line 14) | namespace Zeal {
FILE: src/libs/ui/docsetlistitemdelegate.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/ui/docsetsdialog.cpp
function QListWidgetItem (line 651) | QListWidgetItem *DocsetsDialog::findDocsetListItem(const QString &name) ...
function QNetworkReply (line 674) | QNetworkReply *DocsetsDialog::download(const QUrl &url)
function QString (line 840) | QString DocsetsDialog::docsetNameForTmpFilePath(const QString &filePath)...
function QString (line 859) | QString DocsetsDialog::cacheLocation(const QString &fileName)
FILE: src/libs/ui/docsetsdialog.h
function namespace (line 21) | namespace Zeal {
FILE: src/libs/ui/mainwindow.cpp
function BrowserTab (line 184) | BrowserTab *MainWindow::createTab()
function BrowserTab (line 239) | BrowserTab *MainWindow::currentTab() const
function BrowserTab (line 244) | BrowserTab *MainWindow::tabAt(int index) const
FILE: src/libs/ui/mainwindow.h
function namespace (line 19) | namespace Zeal {
FILE: src/libs/ui/qxtglobalshortcut/qxtglobalshortcut.cpp
function QKeySequence (line 203) | QKeySequence QxtGlobalShortcut::shortcut() const
FILE: src/libs/ui/qxtglobalshortcut/qxtglobalshortcut.h
function class (line 41) | class QxtGlobalShortcut : public QObject
FILE: src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_mac.cpp
function OSStatus (line 48) | OSStatus qxt_mac_handle_hot_key(EventHandlerCallRef nextHandler, EventRe...
function quint32 (line 77) | quint32 QxtGlobalShortcutPrivate::nativeModifiers(Qt::KeyboardModifiers ...
function quint32 (line 93) | quint32 QxtGlobalShortcutPrivate::nativeKeycode(Qt::Key key)
FILE: src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_noop.cpp
function quint32 (line 22) | quint32 QxtGlobalShortcutPrivate::nativeModifiers(Qt::KeyboardModifiers ...
function quint32 (line 29) | quint32 QxtGlobalShortcutPrivate::nativeKeycode(Qt::Key key)
FILE: src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_p.h
function class (line 49) | class QxtGlobalShortcutPrivate : public QAbstractNativeEventFilter
FILE: src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_win.cpp
function quint32 (line 60) | quint32 QxtGlobalShortcutPrivate::nativeModifiers(Qt::KeyboardModifiers ...
function quint32 (line 78) | quint32 QxtGlobalShortcutPrivate::nativeKeycode(Qt::Key key)
FILE: src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_x11.cpp
function quint32 (line 93) | quint32 QxtGlobalShortcutPrivate::nativeModifiers(Qt::KeyboardModifiers ...
function quint32 (line 108) | quint32 QxtGlobalShortcutPrivate::nativeKeycode(Qt::Key key)
FILE: src/libs/ui/searchitemdelegate.cpp
function QSize (line 208) | QSize SearchItemDelegate::sizeHint(const QStyleOptionViewItem &option,
FILE: src/libs/ui/searchitemdelegate.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/ui/searchsidebar.cpp
function SearchSidebar (line 277) | SearchSidebar *SearchSidebar::clone(QWidget *parent) const
FILE: src/libs/ui/searchsidebar.h
function namespace (line 18) | namespace Zeal {
FILE: src/libs/ui/settingsdialog.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/ui/sidebarviewprovider.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/ui/widgets/layouthelper.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/ui/widgets/searchedit.cpp
function QString (line 144) | QString SearchEdit::currentCompletion(const QString &text) const
FILE: src/libs/ui/widgets/searchedit.h
function namespace (line 14) | namespace Zeal {
FILE: src/libs/ui/widgets/shortcutedit.cpp
function QKeySequence (line 57) | QKeySequence ShortcutEdit::keySequence() const
FILE: src/libs/ui/widgets/shortcutedit.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/ui/widgets/toolbarframe.h
function namespace (line 9) | namespace Zeal {
FILE: src/libs/util/caseinsensitivemap.h
function namespace (line 11) | namespace Zeal {
FILE: src/libs/util/fuzzy.cpp
type Zeal (line 10) | namespace Zeal {
type Util (line 11) | namespace Util {
type Fuzzy (line 12) | namespace Fuzzy {
function precomputeBonus (line 25) | void precomputeBonus(const QString &haystack, double *matchBonus)
function hasMatch (line 55) | bool hasMatch(const QString &needle, const QString &haystack)
function score (line 87) | double score(const QString &needle, const QString &haystack, QVect...
function computeScore (line 107) | double computeScore(const QString &needle, const QString &haystack...
function scoreFunction (line 229) | double scoreFunction(const QString &needle, const QString &haystack)
function scoreFunction (line 235) | double scoreFunction(const char *needle, const char *haystack)
FILE: src/libs/util/fuzzy.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/util/humanizer.cpp
function QString (line 21) | QString humanizeDuration(double seconds)
function QString (line 59) | QString Humanizer::fromNow(const QDateTime& dt)
FILE: src/libs/util/humanizer.h
function namespace (line 12) | namespace Zeal {
FILE: src/libs/util/plist.h
function namespace (line 10) | namespace Zeal {
FILE: src/libs/util/sqlitedatabase.cpp
function QStringList (line 55) | QStringList SQLiteDatabase::tables()
function QStringList (line 77) | QStringList SQLiteDatabase::views()
function QVariant (line 184) | QVariant SQLiteDatabase::value(int index) const
function QString (line 215) | QString SQLiteDatabase::lastError() const
function sqlite3 (line 245) | sqlite3 *SQLiteDatabase::handle() const
FILE: src/libs/util/sqlitedatabase.h
type sqlite3 (line 11) | struct sqlite3
type sqlite3_stmt (line 12) | struct sqlite3_stmt
function namespace (line 14) | namespace Zeal {
FILE: src/libs/util/tests/fuzzy_test.cpp
class FuzzyTest (line 12) | class FuzzyTest : public QObject
Condensed preview — 159 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (1,248K chars).
[
{
"path": ".editorconfig",
"chars": 362,
"preview": "# EditorConfig (https://editorconfig.org)\nroot = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\n"
},
{
"path": ".gitattributes",
"chars": 379,
"preview": "# Autodetect text files\n* text=auto\n\n# Enforce text mode\n*.c text\n*.cmake text\n*.conf text\n*.cpp text\n*.css text\n*.deskt"
},
{
"path": ".github/CODEOWNERS",
"chars": 134,
"preview": "# This file allows automatic assignment of pull requests.\n# See https://help.github.com/articles/about-codeowners/\n\n* "
},
{
"path": ".github/dependabot.yml",
"chars": 177,
"preview": "version: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"daily\"\n "
},
{
"path": ".github/workflows/analyze-codeql.yaml",
"chars": 1262,
"preview": "name: CodeQL Scan\n\non:\n push:\n branches: [main]\n pull_request:\n # The branches below must be a subset of the bra"
},
{
"path": ".github/workflows/analyze-coverity.yaml",
"chars": 1590,
"preview": "name: Coverity Scan\n\non:\n push:\n branches: [main]\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n "
},
{
"path": ".github/workflows/appimage/Dockerfile",
"chars": 1263,
"preview": "FROM ubuntu:jammy\n\n# Force older pipx to use global location.\nENV PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin PIPX_M"
},
{
"path": ".github/workflows/appimage/action.yaml",
"chars": 429,
"preview": "name: 'AppImage Builder'\ndescription: 'Create an AppImage with appimage-builder.'\ninputs:\n recipe:\n description: 'Pa"
},
{
"path": ".github/workflows/appimage/entrypoint.sh",
"chars": 405,
"preview": "#!/bin/bash\n\n# Should be in .gitignore.\nexport APPIMAGE_BUILD_DIR=build.appimage\n\n# Install dependencies\nif [ ! -z ${INP"
},
{
"path": ".github/workflows/build-check.yaml",
"chars": 8391,
"preview": "name: Build Check\n\non:\n push:\n branches: [main]\n pull_request:\n branches: [main]\n\nconcurrency:\n group: ${{ gith"
},
{
"path": ".github/workflows/lock.yaml",
"chars": 443,
"preview": "name: Lock Issues\n\non:\n schedule:\n - cron: \"0 0 * * *\"\n workflow_dispatch:\n\npermissions:\n issues: write\n pull-req"
},
{
"path": ".github/workflows/release/cliff.toml",
"chars": 3308,
"preview": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# Set via GITHUB_REPO and GITHUB_TOKEN envi"
},
{
"path": ".github/workflows/release.yaml",
"chars": 6522,
"preview": "name: Release\n\non:\n push:\n tags:\n - \"v*.*.*\"\n\n# Required for creating GitHub release.\npermissions:\n contents: "
},
{
"path": ".gitignore",
"chars": 377,
"preview": "# C++ objects and libs\n*.a\n*.dll\n*.dylib\n*.la\n*.lai\n*.lo\n*.o\n*.slo\n*.so\n\n# CMake\nbuild.*/\nbuild/\nCMakeLists.txt.user\nCMa"
},
{
"path": "CHANGELOG.md",
"chars": 111,
"preview": "# Changelog\n\nThe version history is available on [GitHub Releases](https://github.com/zealdocs/zeal/releases).\n"
},
{
"path": "CMakeLists.txt",
"chars": 2471,
"preview": "cmake_minimum_required(VERSION 3.16.3)\n\n# CMake options.\nset(CMAKE_DISABLE_IN_SOURCE_BUILD ON)\nset(CMAKE_DISABLE_SOURCE_"
},
{
"path": "CMakePresets.json",
"chars": 3184,
"preview": "{\n \"version\": 3,\n \"cmakeMinimumRequired\": {\n \"major\": 3,\n \"minor\": 21,\n \"patch\": 0\n },\n \"configurePresets\":"
},
{
"path": "COPYING",
"chars": 32423,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "LICENSES/GPL-3.0-or-later.txt",
"chars": 34509,
"preview": "GNU GENERAL PUBLIC LICENSE\nVersion 3, 29 June 2007\n\nCopyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>\n\n"
},
{
"path": "LICENSES/LicenseRef-Kapeli.txt",
"chars": 162,
"preview": "These files are used under permission from Bogdan Popescu (https://github.com/Kapeli).\n\nSee https://github.com/Kapeli/Da"
},
{
"path": "LICENSES/MIT.txt",
"chars": 1096,
"preview": "MIT License\n\nCopyright (c) Oleg Shparber, et al. <https://zealdocs.org>\n\nPermission is hereby granted, free of charge, t"
},
{
"path": "LICENSES/MS-RL.txt",
"chars": 3058,
"preview": "Microsoft Reciprocal License (Ms-RL)\n\nThis license governs use of the accompanying software. If you use the software, yo"
},
{
"path": "README.md",
"chars": 3158,
"preview": "# Zeal\n\n[](https://github.com/zea"
},
{
"path": "REUSE.toml",
"chars": 1523,
"preview": "version = 1\n\n# GPL-3.0-or-later for the main source code and assets.\n[[annotations]]\npath = [\n \"assets/**/*\",\n \"cm"
},
{
"path": "assets/CMakeLists.txt",
"chars": 30,
"preview": "add_subdirectory(freedesktop)\n"
},
{
"path": "assets/freedesktop/CMakeLists.txt",
"chars": 1460,
"preview": "if(UNIX AND NOT APPLE)\n find_package(ECM 1.0.0 REQUIRED NO_MODULE)\n set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH})\n "
},
{
"path": "assets/freedesktop/org.zealdocs.zeal.appdata.xml.in",
"chars": 2026,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<component type=\"desktop\">\n <id>org.zealdocs.zeal</id>\n <launchable type=\"deskt"
},
{
"path": "assets/freedesktop/org.zealdocs.zeal.desktop",
"chars": 287,
"preview": "[Desktop Entry]\nVersion=1.0\nName=Zeal\nGenericName=Documentation Browser\nComment=Simple API documentation browser\nExec=ze"
},
{
"path": "cmake/CodeSign.cmake",
"chars": 8717,
"preview": "#\n# CodeSign.cmake - CMake helper for signing Windows executables\n#\n# SPDX-FileCopyrightText: Oleg Shparber, et al. <htt"
},
{
"path": "cmake/GetVersionFromGit.cmake",
"chars": 5900,
"preview": "#\n# GetVersionFromGit.cmake - CMake helper for getting version information from Git\n#\n# SPDX-FileCopyrightText: Oleg Shp"
},
{
"path": "cmake/MacOSXBundleInfo.plist.in",
"chars": 1393,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.c"
},
{
"path": "pkg/appimage/README.md",
"chars": 1490,
"preview": "# AppImage Package\n\n## Local Testing\n\nRun Docker container:\n\n```shell\ndocker run -it --rm -v $(pwd):/src --entrypoint /b"
},
{
"path": "pkg/appimage/appimage-amd64.yaml",
"chars": 2286,
"preview": "version: 1\n\nscript:\n - cmake -B $BUILD_DIR/cmake-build -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo\n - cmake --build $BU"
},
{
"path": "pkg/wix/cpack_post_build.cmake",
"chars": 341,
"preview": "if(CPACK_SOURCE_INSTALLED_DIRECTORIES)\n message(DEBUG \"Skipping package signing for source package generator.\")\n r"
},
{
"path": "pkg/wix/cpack_pre_build.cmake",
"chars": 386,
"preview": "if(CPACK_SOURCE_INSTALLED_DIRECTORIES)\n message(DEBUG \"Skipping package signing for source package generator.\")\n r"
},
{
"path": "pkg/wix/exitdialog.wxs",
"chars": 2232,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->\n<!"
},
{
"path": "pkg/wix/patch.xml",
"chars": 395,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->\n<!"
},
{
"path": "pkg/wix/template.xml",
"chars": 4079,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->\n<!"
},
{
"path": "pkg/wix/ui.wxs",
"chars": 4638,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!-- SPDX-FileCopyrightText: Oleg Shparber, et al. <https://zealdocs.org>. -->\n<!"
},
{
"path": "src/CMakeLists.txt",
"chars": 727,
"preview": "set(CMAKE_CXX_STANDARD 17)\nset(CMAKE_CXX_STANDARD_REQUIRED ON)\n\n# Find includes in corresponding build directories.\nset("
},
{
"path": "src/app/CMakeLists.txt",
"chars": 6128,
"preview": "find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Concurrent WebEngineWidgets Widgets REQUIRED)\nif (Qt${QT_VERSION_MAJOR}Wid"
},
{
"path": "src/app/main.cpp",
"chars": 9152,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/app/resources/browser/404.html",
"chars": 4654,
"preview": "<html>\n\n<head>\n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n <title>"
},
{
"path": "src/app/resources/browser/assets/css/highlight.css",
"chars": 240,
"preview": "/* Highlight on navigation to an anchor. */\n@keyframes targetNavigatedAnimation {\n from { background: #fff; }\n 50%"
},
{
"path": "src/app/resources/browser/assets/css/welcome.css",
"chars": 2279,
"preview": "/* Custom styles for Zeal's built-in browser pages. Depends on oat.min.css. */\n\nbody {\n\tuser-select: none;\n\tmin-height: "
},
{
"path": "src/app/resources/browser/welcome.html",
"chars": 5050,
"preview": "<html>\n\n<head>\n <meta charset=\"utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n <title>"
},
{
"path": "src/app/resources/icons/README.md",
"chars": 381,
"preview": "# Resources\n\n## Dash Type Icons (`type`)\n\nUpstream repository: <https://github.com/Kapeli/Dash-X-Platform-Resources>\n\nOp"
},
{
"path": "src/app/versioninfo.rc.in",
"chars": 2110,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include <wi"
},
{
"path": "src/app/zeal.qrc",
"chars": 20630,
"preview": "<RCC>\n <qresource prefix=\"/\">\n <file alias=\"zeal.ico\">resources/zeal.ico</file>\n </qresource>\n <qresourc"
},
{
"path": "src/contrib/cpp-httplib/httplib.h",
"chars": 583472,
"preview": "//\n// httplib.h\n//\n// Copyright (c) 2026 Yuji Hirose. All rights reserved.\n// MIT License\n//\n\n#ifndef CPPHTTPLIB_HTTP"
},
{
"path": "src/libs/CMakeLists.txt",
"chars": 146,
"preview": "add_subdirectory(browser)\nadd_subdirectory(core)\nadd_subdirectory(registry)\nadd_subdirectory(sidebar)\nadd_subdirectory(u"
},
{
"path": "src/libs/browser/CMakeLists.txt",
"chars": 365,
"preview": "add_library(Browser STATIC\n searchtoolbar.cpp\n settings.cpp\n urlrequestinterceptor.cpp\n webbridge.cpp\n we"
},
{
"path": "src/libs/browser/searchtoolbar.cpp",
"chars": 5737,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"se"
},
{
"path": "src/libs/browser/searchtoolbar.h",
"chars": 1237,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/browser/settings.cpp",
"chars": 3701,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"se"
},
{
"path": "src/libs/browser/settings.h",
"chars": 815,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/browser/urlrequestinterceptor.cpp",
"chars": 1634,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2019 Kay Gawlik\n// SPDX-License-Identifie"
},
{
"path": "src/libs/browser/urlrequestinterceptor.h",
"chars": 741,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2019 Kay Gawlik\n// SPDX-License-Identifie"
},
{
"path": "src/libs/browser/webbridge.cpp",
"chars": 629,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"we"
},
{
"path": "src/libs/browser/webbridge.h",
"chars": 754,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/browser/webcontrol.cpp",
"chars": 3516,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/browser/webcontrol.h",
"chars": 1452,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/browser/webpage.cpp",
"chars": 3780,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2019 Kay Gawlik\n// SPDX-License-Identifie"
},
{
"path": "src/libs/browser/webpage.h",
"chars": 779,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2019 Kay Gawlik\n// SPDX-License-Identifie"
},
{
"path": "src/libs/browser/webview.cpp",
"chars": 6698,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/browser/webview.h",
"chars": 1188,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/core/CMakeLists.txt",
"chars": 1984,
"preview": "add_library(Core STATIC\n application.cpp\n applicationsingleton.cpp\n extractor.cpp\n filemanager.cpp\n https"
},
{
"path": "src/libs/core/application.cpp",
"chars": 8758,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"ap"
},
{
"path": "src/libs/core/application.h",
"chars": 2464,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/core/applicationsingleton.cpp",
"chars": 4507,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"ap"
},
{
"path": "src/libs/core/applicationsingleton.h",
"chars": 1030,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/core/extractor.cpp",
"chars": 3640,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"ex"
},
{
"path": "src/libs/core/extractor.h",
"chars": 1018,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/core/filemanager.cpp",
"chars": 1686,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"fi"
},
{
"path": "src/libs/core/filemanager.h",
"chars": 511,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/core/httpserver.cpp",
"chars": 2764,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"ht"
},
{
"path": "src/libs/core/httpserver.h",
"chars": 886,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/core/networkaccessmanager.cpp",
"chars": 1754,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"ne"
},
{
"path": "src/libs/core/networkaccessmanager.h",
"chars": 795,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/core/settings.cpp",
"chars": 17499,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"se"
},
{
"path": "src/libs/core/settings.h",
"chars": 3716,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/registry/CMakeLists.txt",
"chars": 476,
"preview": "add_library(Registry STATIC\n docset.cpp\n docsetmetadata.cpp\n docsetregistry.cpp\n listmodel.cpp\n searchmod"
},
{
"path": "src/libs/registry/cancellationtoken.h",
"chars": 739,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2015 Artur Spychaj\n// SPDX-License-Identi"
},
{
"path": "src/libs/registry/docset.cpp",
"chars": 28782,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/docset.h",
"chars": 2824,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/docsetmetadata.cpp",
"chars": 5212,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/docsetmetadata.h",
"chars": 1274,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/docsetregistry.cpp",
"chars": 6218,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/docsetregistry.h",
"chars": 1944,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/itemdatarole.h",
"chars": 525,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/registry/listmodel.cpp",
"chars": 8768,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/listmodel.h",
"chars": 1964,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/searchmodel.cpp",
"chars": 2624,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/searchmodel.h",
"chars": 1204,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/searchquery.cpp",
"chars": 2315,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/searchquery.h",
"chars": 2351,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/registry/searchresult.h",
"chars": 820,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/sidebar/CMakeLists.txt",
"chars": 234,
"preview": "add_library(Sidebar STATIC\n container.cpp\n proxyview.cpp\n view.cpp\n viewprovider.cpp\n)\n\nfind_package(Qt${QT_"
},
{
"path": "src/libs/sidebar/container.cpp",
"chars": 1061,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"co"
},
{
"path": "src/libs/sidebar/container.h",
"chars": 711,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/sidebar/proxyview.cpp",
"chars": 1413,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"pr"
},
{
"path": "src/libs/sidebar/proxyview.h",
"chars": 691,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/sidebar/view.cpp",
"chars": 213,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"vi"
},
{
"path": "src/libs/sidebar/view.h",
"chars": 428,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/sidebar/viewprovider.cpp",
"chars": 237,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"vi"
},
{
"path": "src/libs/sidebar/viewprovider.h",
"chars": 589,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/ui/CMakeLists.txt",
"chars": 649,
"preview": "add_subdirectory(qxtglobalshortcut)\nadd_subdirectory(widgets)\n\nset(Ui_FORMS\n aboutdialog.ui\n docsetsdialog.ui\n "
},
{
"path": "src/libs/ui/aboutdialog.cpp",
"chars": 584,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"ab"
},
{
"path": "src/libs/ui/aboutdialog.h",
"chars": 555,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/ui/aboutdialog.ui",
"chars": 10966,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ui version=\"4.0\">\n <class>Zeal::WidgetUi::AboutDialog</class>\n <widget class=\"QD"
},
{
"path": "src/libs/ui/browsertab.cpp",
"chars": 7232,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"br"
},
{
"path": "src/libs/ui/browsertab.h",
"chars": 1364,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/ui/docsetlistitemdelegate.cpp",
"chars": 3852,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/docsetlistitemdelegate.h",
"chars": 993,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/docsetsdialog.cpp",
"chars": 29345,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/docsetsdialog.h",
"chars": 2953,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/docsetsdialog.ui",
"chars": 6892,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ui version=\"4.0\">\n <class>Zeal::WidgetUi::DocsetsDialog</class>\n <widget class=\""
},
{
"path": "src/libs/ui/mainwindow.cpp",
"chars": 22608,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/mainwindow.h",
"chars": 2465,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/qxtglobalshortcut/CMakeLists.txt",
"chars": 1680,
"preview": "list(APPEND QxtGlobalShortcut_SOURCES\n qxtglobalshortcut.cpp\n)\n\nif(APPLE)\n list(APPEND QxtGlobalShortcut_SOURCES\n "
},
{
"path": "src/libs/ui/qxtglobalshortcut/qxtglobalshortcut.cpp",
"chars": 7762,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n/************"
},
{
"path": "src/libs/ui/qxtglobalshortcut/qxtglobalshortcut.h",
"chars": 2839,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n/************"
},
{
"path": "src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_mac.cpp",
"chars": 9413,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n/************"
},
{
"path": "src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_noop.cpp",
"chars": 1072,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"qx"
},
{
"path": "src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_p.h",
"chars": 3377,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n/************"
},
{
"path": "src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_win.cpp",
"chars": 7269,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n/************"
},
{
"path": "src/libs/ui/qxtglobalshortcut/qxtglobalshortcut_x11.cpp",
"chars": 6238,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n/************"
},
{
"path": "src/libs/ui/searchitemdelegate.cpp",
"chars": 8968,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/searchitemdelegate.h",
"chars": 1189,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/searchsidebar.cpp",
"chars": 13428,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"se"
},
{
"path": "src/libs/ui/searchsidebar.h",
"chars": 2091,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/ui/settingsdialog.cpp",
"chars": 13759,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/settingsdialog.h",
"chars": 810,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/settingsdialog.ui",
"chars": 30393,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ui version=\"4.0\">\n <class>Zeal::WidgetUi::SettingsDialog</class>\n <widget class="
},
{
"path": "src/libs/ui/sidebarviewprovider.cpp",
"chars": 790,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"si"
},
{
"path": "src/libs/ui/sidebarviewprovider.h",
"chars": 690,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/ui/widgets/CMakeLists.txt",
"chars": 246,
"preview": "add_library(Widgets STATIC\n layouthelper.cpp\n searchedit.cpp\n shortcutedit.cpp\n toolbarframe.cpp\n)\n\nfind_pac"
},
{
"path": "src/libs/ui/widgets/layouthelper.cpp",
"chars": 134,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"la"
},
{
"path": "src/libs/ui/widgets/layouthelper.h",
"chars": 659,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/ui/widgets/searchedit.cpp",
"chars": 4593,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/widgets/searchedit.h",
"chars": 979,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/widgets/shortcutedit.cpp",
"chars": 2347,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/widgets/shortcutedit.h",
"chars": 808,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2013-2014 Jerzy Kozera\n// SPDX-License-Id"
},
{
"path": "src/libs/ui/widgets/toolbarframe.cpp",
"chars": 705,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"to"
},
{
"path": "src/libs/ui/widgets/toolbarframe.h",
"chars": 503,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/util/CMakeLists.txt",
"chars": 544,
"preview": "add_library(Util STATIC\n fuzzy.cpp\n humanizer.cpp\n plist.cpp\n sqlitedatabase.cpp\n\n # Show headers without"
},
{
"path": "src/libs/util/caseinsensitivemap.h",
"chars": 635,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/util/fuzzy.cpp",
"chars": 8090,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"fu"
},
{
"path": "src/libs/util/fuzzy.h",
"chars": 3203,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/util/humanizer.cpp",
"chars": 2461,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"hu"
},
{
"path": "src/libs/util/humanizer.h",
"chars": 548,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/util/plist.cpp",
"chars": 1567,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \"pl"
},
{
"path": "src/libs/util/plist.h",
"chars": 493,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#ifndef ZEAL"
},
{
"path": "src/libs/util/sqlitedatabase.cpp",
"chars": 5646,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2016 Jerzy Kozera\n// SPDX-License-Identif"
},
{
"path": "src/libs/util/sqlitedatabase.h",
"chars": 1006,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// Copyright (C) 2016 Jerzy Kozera\n// SPDX-License-Identif"
},
{
"path": "src/libs/util/tests/CMakeLists.txt",
"chars": 229,
"preview": "find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Test)\n\n# Fuzzy matching tests\nadd_executable(fuzzy_test fuzzy_tes"
},
{
"path": "src/libs/util/tests/fuzzy_test.cpp",
"chars": 20642,
"preview": "// Copyright (C) Oleg Shparber, et al. <https://zealdocs.org>\n// SPDX-License-Identifier: GPL-3.0-or-later\n\n#include \".."
},
{
"path": "vcpkg.json",
"chars": 391,
"preview": "{\n \"$schema\": \"https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json\",\n \"builtin-baseline"
}
]
// ... and 1 more files (download for full content)
About this extraction
This page contains the full source code of the zealdocs/zeal GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 159 files (1.1 MB), approximately 295.0k tokens, and a symbol index with 567 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.