├── src └── syntax_highlighting_ng │ ├── _version.py │ ├── config.json │ ├── icons │ └── button.png │ ├── libs │ └── pygments-2.18.0-py3-none-any.whl │ ├── consts.py │ ├── config.md │ ├── __init__.py │ ├── html_render.py │ ├── config.py │ ├── CHANGELOG.md │ ├── main.py │ └── LICENSE.txt ├── Dockerfile ├── tests ├── README.md ├── environment.yaml ├── test_const.py ├── assets │ └── test_html_render │ │ ├── simple.html │ │ └── conftest.html ├── test_anki.py ├── test_html_render.py └── conftest.py ├── requirements.txt ├── CONTRIBUTING.md ├── TODO.md ├── .pre-commit-config.yaml ├── pyproject.toml ├── CHANGELOG.md ├── NOTES.md ├── make.py ├── README.md └── LICENSE /src/syntax_highlighting_ng/_version.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | __version__ = "0.0.2" 3 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "hotkey": "Alt+s", 3 | "limitToLangs": [], 4 | "style": "default" 5 | } -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:latest 2 | COPY requirements.txt / 3 | RUN python -m venv /venv 4 | RUN /venv/bin/python -m pip install -r /requirements.txt -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/icons/button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cav71/syntax-highlighting-ng/HEAD/src/syntax_highlighting_ng/icons/button.png -------------------------------------------------------------------------------- /tests/README.md: -------------------------------------------------------------------------------- 1 | ### Tests 2 | 3 | How to run these tests (from the root source directory): 4 | 5 | ```bash 6 | STANDALONE_ADDON=1 PYTHONPATH=src pytest -vvs tests 7 | ``` 8 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/libs/pygments-2.18.0-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cav71/syntax-highlighting-ng/HEAD/src/syntax_highlighting_ng/libs/pygments-2.18.0-py3-none-any.whl -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # Please note that these are only build dependencies. They are not 2 | # required to run compiled builds of the add-on within Anki 3 | aab 4 | beautifulsoup4 5 | lxml 6 | mypy 7 | pytest 8 | pytest-cov 9 | pytest-html 10 | ruff 11 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## How to Contribute to this Project 2 | 3 | Please see the [common contribution guidelines](https://github.com/glutanimate/docs/blob/master/anki/add-ons/CONTRIBUTING.md#how-to-contribute-to-my-anki-add-ons) for my Anki add-ons. 4 | 5 | Thanks! -------------------------------------------------------------------------------- /tests/environment.yaml: -------------------------------------------------------------------------------- 1 | python=3.9 2 | pytest 3 | attrs 4 | jsonschema 5 | six 6 | whichcraft 7 | pygments 8 | ruff 9 | black 10 | mypy 11 | pre-commit 12 | bs4 13 | # need to run also: 14 | # conda uninstall --force rpds-py 15 | # pip install rpds-py aab 16 | -------------------------------------------------------------------------------- /tests/test_const.py: -------------------------------------------------------------------------------- 1 | 2 | 3 | def test_import(fake_anki21): 4 | "test the module import" 5 | import syntax_highlighting_ng 6 | from syntax_highlighting_ng import consts 7 | assert consts.sys_encoding 8 | assert consts.addon_path 9 | assert syntax_highlighting_ng.STANDALONE 10 | -------------------------------------------------------------------------------- /tests/assets/test_html_render/simple.html: -------------------------------------------------------------------------------- 1 |
2 | 
1a simple one-line
3 |
4 |
5 | -------------------------------------------------------------------------------- /TODO.md: -------------------------------------------------------------------------------- 1 | ## TODO 2 | 3 | These are the tasks in order of importance: 4 | 5 | - [ ] fix rendering bug screenshots/bug-001.png 6 | - [ ] re-enable options configuration for the add-on 7 | (syntax_highlighting_ng.main.onOptionsCall) 8 | - [ ] conda forge update on rpds-py -> 0.15.2 9 | - [ ] conda forge new package for aab 10 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/consts.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Syntax Highlighting add-on for Anki. 5 | 6 | Global variables 7 | 8 | Copyright: (c) 2018 Glutanimate 9 | License: GNU AGPLv3 10 | """ 11 | 12 | import sys 13 | import os 14 | 15 | sys_encoding = sys.getfilesystemencoding() 16 | addon_path = os.path.dirname(__file__) 17 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/psf/black 3 | rev: 23.7.0 4 | hooks: 5 | - id: black 6 | exclude: tests 7 | 8 | - repo: https://github.com/astral-sh/ruff-pre-commit 9 | # Ruff version. 10 | rev: v0.0.282 11 | hooks: 12 | - id: ruff 13 | args: [--fix, --exit-non-zero-on-fix] 14 | 15 | - repo: https://github.com/pre-commit/mirrors-mypy 16 | rev: v1.4.1 17 | hooks: 18 | - id: mypy 19 | exclude: ^(tests) 20 | 21 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/config.md: -------------------------------------------------------------------------------- 1 | ### Syntax Highlighting: Advanced Configuration 2 | 3 | These advanced settings do not sync and require a restart to apply. 4 | 5 | - `hotkey` [string]: Add-on invocation hotkey. Default: `Alt+S` 6 | - `limitToLags` [list]: List of programming languages to limit combobox menu to. Default: `[]` (i.e. no limit). Example: `["Python", "Java", "JavaScript"]`. 7 | - `style` [string]: Pre-defined [pygments style](https://pygments.org/styles/) to use for inline styling of code (not applicable to CSS mode). Default: `default`. Example: `monokai`. 8 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.ruff] 2 | target-version = "py39" 3 | line-length = 88 4 | 5 | ignore = [ 6 | # may be undefined, or defined from star imports 7 | "F405", 8 | # Module level import not at top of file 9 | "E402", 10 | # used; unable to detect undefined names 11 | "F403", 12 | ] 13 | 14 | unfixable = [ 15 | # Don't touch unused imports 16 | "F401", 17 | ] 18 | [tool.ruff.isort] 19 | known-first-party = ["syntax_highlighting_ng"] 20 | 21 | [tool.ruff.flake8-quotes] 22 | inline-quotes = "double" 23 | 24 | [tool.ruff.flake8-tidy-imports] 25 | ban-relative-imports = "all" 26 | 27 | [tool.ruff.per-file-ignores] 28 | # Tests can use relative imports and assertions 29 | "tests/**/*" = ["TID252", "S101"] 30 | 31 | 32 | [[tool.mypy.overrides]] 33 | module = [ 34 | "pygments.*", 35 | "aqt.*", 36 | "anki.*", 37 | ] 38 | ignore_missing_imports = true 39 | -------------------------------------------------------------------------------- /tests/test_anki.py: -------------------------------------------------------------------------------- 1 | # This tests the conftest fake_anki21 fixture, 2 | # to have tests not depend on an installed anki 3 | 4 | def test_plain_import(): 5 | "this test must fail" 6 | try: 7 | import anki # noqa: F401 8 | raise RuntimeError("the module anki shouldn't be available") 9 | except ModuleNotFoundError: 10 | pass 11 | 12 | def test_import_anki(fake_anki21): 13 | "test the module import" 14 | import anki 15 | assert anki.point_version() == 231001 16 | 17 | 18 | def test_import_anki_hooks(fake_anki21): 19 | "test the module import" 20 | from anki.hooks import addHook 21 | assert addHook("setupEditorButtons", lambda: None) == 999 22 | 23 | def test_import_aqt(fake_anki21): 24 | # from aqt import mw 25 | import aqt # noqa: F401 26 | 27 | def test_import_mw_from_aqt(fake_anki21): 28 | from aqt import mw 29 | assert mw.callme() == 123 30 | 31 | 32 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | Anki Add-on: Syntax Highlighting 5 | 6 | Module-level entry point for the add-on into Anki 2.0.x/2.1.x 7 | 8 | Please do not edit this file if you are not sure what you are doing. 9 | 10 | Copyright: (c) 2018 Glutanimate 11 | License: GNU AGPLv3 12 | """ 13 | import os 14 | import sys 15 | 16 | from ._version import __version__ # noqa: F401 17 | from .consts import addon_path 18 | 19 | # we need to import syntax_highlighting_ng without an installed anki, 20 | # hence this workaround 21 | # an improved design would be shifting all the addon api ia separate module 22 | # (eg. addon.py) and leaving __init__.py almost empty 23 | 24 | # always use shipped pygments library 25 | # TODO: properly vendorize pygments, lest we interfere with 26 | # other add-ons that might be shipping their own pygments 27 | sys.path.insert( 28 | 0, os.path.join(addon_path, "libs", "pygments-2.18.0-py3-none-any.whl") 29 | ) 30 | 31 | STANDALONE = False 32 | try: 33 | from . import main # noqa: F401 34 | except ModuleNotFoundError as e: 35 | if not os.environ.get("STANDALONE_ADDON") == "1": 36 | raise RuntimeError( 37 | "set env STANDALONE_ADDON=1 if you don't need anki modules" 38 | ) from e 39 | STANDALONE = True 40 | 41 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/html_render.py: -------------------------------------------------------------------------------- 1 | # TODO: consolidate all rendering functions here! 2 | # from pygments import highlight 3 | # from pygments.lexers import get_lexer_by_name, get_all_lexers 4 | # 5 | from __future__ import annotations 6 | import dataclasses as dc 7 | import pygments 8 | import pygments.lexers 9 | 10 | 11 | @dc.dataclass 12 | class Style: 13 | linenos: str = "inline" 14 | noclasses: bool = True 15 | style: str = "default" 16 | language: str = "Python" 17 | 18 | 19 | class RenderError(Exception): 20 | def render(self) -> str: 21 | raise NotImplementedError("adds .render method") 22 | 23 | 24 | class LanguageNotFound(RenderError): 25 | def render(self) -> str: 26 | return f""" 27 | Error: Selected language '{self.args[0]}' not found.
28 | If you set a custom lang selection please make sure
29 | you typed all list entries correctly. 30 | """ 31 | 32 | 33 | class InvalidStyle(LanguageNotFound): 34 | def render(self) -> str: 35 | return f""" 36 | Error: Selected style '{self.args[0]}' not found.
37 | If you set a custom style please make sure
38 | you typed it correctly. 39 | """ 40 | 41 | 42 | def render_string(txt: str, style: Style = Style()) -> str: 43 | from pygments.formatters import HtmlFormatter 44 | from pygments import util 45 | 46 | try: 47 | lexer = pygments.lexers.get_lexer_by_name(style.language, stripall=True) 48 | except util.ClassNotFound as exc: 49 | raise LanguageNotFound(style.language) from exc 50 | 51 | try: 52 | formatter = HtmlFormatter( 53 | linenos=style.linenos, noclasses=style.noclasses, style=style.style 54 | ) 55 | except util.ClassNotFound as exc: 56 | raise InvalidStyle(style.style) from exc 57 | 58 | return pygments.highlight(txt, lexer, formatter) 59 | -------------------------------------------------------------------------------- /tests/test_html_render.py: -------------------------------------------------------------------------------- 1 | # NOTE: see comment in syntax_highlighting_ng/__init__.py 2 | import os 3 | from pathlib import Path 4 | 5 | import pytest 6 | from bs4 import BeautifulSoup 7 | 8 | if os.getenv("STANDALONE_ADDON") != "1": 9 | raise pytest.skip( 10 | f"to run {__name__} must have STANDALONE_ADDON=1 in the environment", 11 | allow_module_level=True, 12 | ) 13 | 14 | from syntax_highlighting_ng import html_render 15 | 16 | 17 | def test_invalid_language(fake_anki21): 18 | text = "a simple one-line" 19 | style = html_render.Style(language="xxx") 20 | 21 | # wrong style 22 | pytest.raises(html_render.LanguageNotFound, html_render.render_string, text, style) 23 | try: 24 | html_render.render_string(text, style) 25 | except html_render.LanguageNotFound as e: 26 | assert e.render() == """ 27 | Error: Selected language 'xxx' not found.
28 | If you set a custom lang selection please make sure
29 | you typed all list entries correctly. 30 | """ 31 | 32 | def test_invalid_style(fake_anki21): 33 | text = "a simple one-line" 34 | style = html_render.Style(style="xxx") 35 | 36 | # wrong style 37 | pytest.raises(html_render.LanguageNotFound, html_render.render_string, text, style) 38 | try: 39 | html_render.render_string(text, style) 40 | except html_render.InvalidStyle as e: 41 | assert e.render() == """ 42 | Error: Selected style 'xxx' not found.
43 | If you set a custom style please make sure
44 | you typed it correctly. 45 | """ 46 | 47 | def test_render_simple(fake_anki21, assets): 48 | text = "a simple one-line" 49 | rendered = html_render.render_string(text) 50 | found = BeautifulSoup(rendered).prettify() 51 | assert found == assets.read_text("simple.html", fallback=found) 52 | 53 | 54 | def test_render_conftest(fake_anki21, assets): 55 | src = Path(__file__).parent / "conftest.py" 56 | rendered = html_render.render_string(src.read_text()) 57 | found = BeautifulSoup(rendered).prettify() 58 | assert found == assets.read_text("conftest.html", fallback=found) 59 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 |
4 | about this file 5 | > The format of this file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 6 |
7 | 8 | All notable changes to Syntax Highlighting will be documented here. You can click on each release number to be directed to a detailed log of all code commits for that particular release. The download links will direct you to the GitHub release page, allowing you to manually install a release if you want. 9 | 10 | If you enjoy Syntax Highlighting, please consider supporting my work on Patreon, or by buying me a cup of coffee :coffee:: 11 | 12 |

13 |      14 |

15 | 16 | :heart: My heartfelt thanks goes out to everyone who has supported this add-on through their tips, contributions, or any other means (you know who you are!). All of this would not have been possible without you. Thank you for being awesome! 17 | 18 | 19 | ## [Unreleased] 20 | 21 | ## [0.0.3] - 2023-12-25 22 | 23 | ### Added 24 | 25 | ### Removed 26 | 27 | ### Changed 28 | 29 | - update NOTES.md (internal) and main.py (copyright) 30 | - by default the generated html code doesn't get centered 31 | 32 | ### Fixed 33 | 34 | - Fixed option menu (it didn't display due to QT API change) 35 | 36 | ## [0.0.2] - 2023-12-19 37 | 38 | ### Added 39 | 40 | - rendering refactored (fixed a bug in pygments) 41 | - added more tests 42 | 43 | 44 | ## [0.0.1] - 2023-12-19 45 | 46 | ### Added 47 | 48 | - support for pre-commit 49 | - new pyproject.toml file 50 | - support for ruff and mypy 51 | - support for unittests 52 | 53 | ### Removed 54 | 55 | - Anki 2.0 support 56 | 57 | ### Changed 58 | 59 | - Documentation updates 60 | - moved to python 3 (3.9 the current Anki target) 61 | 62 | ### Fixed 63 | 64 | - fixes for python 3 65 | 66 | 67 | [Unreleased]: https://github.com/cav71/syntax-highlighting-ng/compare/v0.0.3...HEAD 68 | [0.0.3]: https://github.com/cav71/syntax-highlighting-ng/compare/v0.0.2...v0.0.3 69 | [0.0.2]: https://github.com/cav71/syntax-highlighting-ng/compare/v0.0.1...v0.0.2 70 | [0.0.1]: https://github.com/cav71/syntax-highlighting-ng/compare/v0.0.0-beta...v0.0.1 71 | 72 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/config.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Syntax Highlighting add-on for Anki. 5 | 6 | Configuration shim between Anki 2.0 and Anki 2.1 7 | 8 | Copyright: (c) 2018 Glutanimate 9 | License: GNU AGPLv3 10 | """ 11 | import os 12 | 13 | from aqt import mw 14 | from anki.hooks import addHook 15 | from . import consts 16 | 17 | KEY = "syntax_highlighting_ng_conf" 18 | 19 | defaults_path = os.path.join(consts.addon_path, "config.json") 20 | meta_path = os.path.join(consts.addon_path, "meta.json") 21 | 22 | ############################################################### 23 | ### 24 | # Configurable preferences 25 | ### 26 | ############################################################### 27 | 28 | # Defaults conf 29 | # - we create a new item in mw.col.conf. This syncs the 30 | # options across machines (but not on mobile) 31 | default_conf = { 32 | "linenos": True, # show numbers by default 33 | "centerfragments": False, # Use
when generating code fragments 34 | "cssclasses": False, # Use css classes instead of colors directly in html 35 | "defaultlangperdeck": True, # Default to last used language per deck 36 | "deckdefaultlang": {}, # Map to store the default language per deck 37 | "lang": "Python", 38 | } # default language is Python 39 | 40 | ############################################################### 41 | 42 | 43 | # Synced conf 44 | def sync_keys(tosync, ref): 45 | for key in [x for x in list(tosync.keys()) if x not in ref]: 46 | del tosync[key] 47 | 48 | for key in [x for x in list(ref.keys()) if x not in tosync]: 49 | tosync[key] = ref[key] 50 | 51 | 52 | def sync_config_with_default(col): 53 | if KEY not in col.conf: 54 | col.conf[KEY] = default_conf 55 | else: 56 | sync_keys(col.conf[KEY], default_conf) 57 | 58 | # Mark collection state as modified, else config changes get lost unless 59 | # some unrelated action triggers the flush of collection data to db 60 | col.setMod() 61 | # col.flush() 62 | 63 | 64 | def setupSyncedConf(): 65 | # If config options have changed, sync with default config first 66 | sync_config_with_default(mw.col) 67 | 68 | 69 | addHook("profileLoaded", setupSyncedConf) 70 | 71 | # Local conf 72 | 73 | 74 | def getConfig(): 75 | return mw.addonManager.getConfig(__name__) 76 | 77 | 78 | def writeConfig(config): 79 | mw.addonManager.writeConfig(__name__, config) 80 | 81 | 82 | local_conf = getConfig() 83 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | import sys 3 | import types 4 | from pathlib import Path 5 | import pytest 6 | from typing import Any, Callable 7 | 8 | 9 | @pytest.fixture(scope="function") 10 | def assets(request): 11 | 12 | class Asset: 13 | def __init__(self): 14 | self.basedir = Path(__file__).parent 15 | self.candidates = [ 16 | f"assets/{request.node.module.__name__}", 17 | "assets", 18 | ] 19 | def lookup(self, path: Path | str) -> Path|None: 20 | for candidate in self.candidates: 21 | if (target := (self.basedir / candidate / path)).exists(): 22 | return target 23 | 24 | def read_text(self, path: Path | str, fallback: str|None=None) -> str|None: 25 | dest = self.lookup(path) 26 | if fallback is not None: 27 | dest = dest or (self.basedir / self.candidates[0] / path) 28 | dest.parent.mkdir(exist_ok=True, parents=True) 29 | dest.write_text(fallback) 30 | 31 | return dest.read_text() 32 | 33 | 34 | return Asset() 35 | 36 | 37 | @pytest.fixture(scope="function") 38 | def fake_anki21(monkeypatch): 39 | # monkey patch a fake anki21 module 40 | 41 | class Anki(types.ModuleType): 42 | version = "23.10.1" 43 | 44 | def pointVersion(self): 45 | return self.point_version() 46 | def point_version(self): 47 | return 231001 48 | 49 | 50 | class AnkiHooks(types.ModuleType): 51 | def addHook(self, hook: str, func: Callable) -> None: 52 | return 999 53 | 54 | class Aqt(types.ModuleType): 55 | pass 56 | 57 | # form anki.qt.aqt.addons.AddonManager 58 | class AddonManager: 59 | def getConfig(self, module: str) -> dict[str, Any] | None: 60 | return {} 61 | 62 | class AqtMV(types.ModuleType): 63 | @property 64 | def addonManager(self): 65 | self._addon_manager = getattr(self, "_addon_manager", AddonManager()) 66 | return self._addon_manager 67 | 68 | def callme(self): 69 | return 123 70 | 71 | replacements = [ 72 | ("anki", Anki), 73 | ("anki.hooks", AnkiHooks), 74 | ("aqt", Aqt), 75 | ("aqt.mw", AqtMV), 76 | ] 77 | old = {} 78 | for name, cls in replacements: 79 | old[name] = sys.modules.get(name) 80 | sys.modules[name] = cls(name) 81 | 82 | monkeypatch.setenv("STANDALONE_ADDON", "1") 83 | yield old 84 | for name, mod in reversed(old.items()): 85 | if mod: 86 | sys.modules[name] = mod 87 | else: 88 | del sys.modules[name] 89 | 90 | -------------------------------------------------------------------------------- /NOTES.md: -------------------------------------------------------------------------------- 1 | ## setup 2 | 3 | > **NOTE** These are my personal note!!! 4 | 5 | ## Init 6 | 7 | ### setup conda env 8 | 9 | 1. base env 10 | ```bash 11 | conda create -n syntax-highlighting-ng --file tests/environment.yaml 12 | ``` 13 | 14 | 2. remove old pakage and install using pip newer: 15 | ```bash 16 | conda uninstall --force rpds-py 17 | pip install rpds-py aab 18 | ``` 19 | 20 | ### prepare the addon to Anki 21 | 22 | Quick cycle install: 23 | 24 | 1. build 25 | ```bash 26 | aab build 27 | (or) 28 | aab build -d local current 29 | ``` 30 | 31 | 2. Install from GUI *from file* 32 | 33 | **build/syntax-highlighting_ng-7b6cdd2-anki21.ankiaddon** 34 | 35 | 3. replace with current code 36 | ```bash 37 | D=~/Library/"Application Support"/Anki2/addons21 38 | rm -rf "$D"/syntax_highlighting_ng 39 | ln -s $(pwd)/src/syntax_highlighting_ng \ 40 | "$D"/syntax_highlighting_ng 41 | ``` 42 | 43 | Debug: 44 | 45 | 0. patch pydevd 46 | ```text 47 | --- /Users/antonio/shared/pydevd-2.10.0/_pydevd_bundle/pydevd_filtering.py 2023-12-18 15:35:50 48 | +++ /Users/antonio/shared/pydevd-2.10.0/_pydevd_bundle/pydevd_filtering.py.new 2023-12-18 15:35:22 49 | @@ -156,8 +156,8 @@ 50 | 51 | # Make sure we always get at least the standard library location (based on the `os` and 52 | # `threading` modules -- it's a bit weird that it may be different on the ci, but it happens). 53 | - roots.append(os.path.dirname(os.__file__)) 54 | - roots.append(os.path.dirname(threading.__file__)) 55 | + roots.append(os.path.dirname(os.__file__) if hasattr(os, "__file__") else "/Users/antonio/envs/syntax-highlighting-ng/lib/python3.12") 56 | + roots.append(os.path.dirname(threading.__file__) if hasattr(threading, "__file__") else "/Users/antonio/envs/syntax-highlighting-ng/lib/python3.12") 57 | if IS_PYPY: 58 | # On PyPy 3.6 (7.3.1) it wrongly says that sysconfig.get_path('stdlib') is 59 | # /lib-pypy when the installed version is /lib_pypy. 60 | --- /Users/antonio/shared/pydevd-2.10.0/pydevd_file_utils.py 2023-12-18 15:35:49 61 | +++ /Users/antonio/shared/pydevd-2.10.0/pydevd_file_utils.py.new 2023-12-18 15:35:33 62 | @@ -88,7 +88,7 @@ 63 | break 64 | 65 | if library_dir is None or not os_path_exists(library_dir): 66 | - library_dir = os.path.dirname(os.__file__) 67 | + library_dir = os.path.dirname(os.__file__) if hasattr(os, "__file__") else "/Users/antonio/envs/syntax-highlighting-ng/lib/python3.12" 68 | 69 | return library_dir 70 | ``` 71 | 72 | 1. use: 73 | ```python 74 | import sys; sys.path.insert(0, "/Users/antonio/shared/pydevd-2.10.0") 75 | import pydevd; pydevd.settrace('localhost', port=12345, stdoutToServer=True, stderrToServer=True) 76 | ``` 77 | 78 | 2. launch app 79 | ```bash 80 | PYDEVD_DISABLE_FILE_VALIDATION=1 open /Applications/Anki.app 81 | ``` 82 | 83 | 84 | ## Release 85 | 1. git tag -m "release" 0.0.3 86 | 2. aab build release 87 | 3. upload to anki 88 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to Syntax Highlighting will be documented here. You can click on each release number to be directed to a detailed log of all code commits for that particular release. The download links will direct you to the GitHub release page, allowing you to manually install a release if you want. 4 | 5 | If you enjoy Syntax Highlighting, please consider supporting my work on Patreon, or by buying me a cup of coffee :coffee:: 6 | 7 |

8 |      9 |

10 | 11 | :heart: My heartfelt thanks goes out to everyone who has supported this add-on through their tips, contributions, or any other means (you know who you are!). All of this would not have been possible without you. Thank you for being awesome! 12 | 13 | ## [Unreleased] 14 | 15 | 16 | ## [2.0.2] - 2018-10-07 17 | 18 | ### Fixed 19 | 20 | - workaround for double-curly-bracket support (which otherwise conflict with Anki's card template system) 21 | 22 | ## [2.0.1] - 2018-10-06 23 | 24 | ### Changed 25 | 26 | - case-insensitive lexer sorting 27 | 28 | ## [2.0.0] - 2018-02-27 29 | 30 | This is the first public release of my fork of Tiago Barroso's *Syntax Highlighting for Code* add-on. I would like to extend my heartfelt gratitude to all of what he has done for the Anki community over the years. 31 | 32 | This update is meant to carry on his legacy by adding Anki 2.1 support, implementing some long-requested features, and refactoring major parts of the codebase. All of this was made possible through the generous support of a fellow Anki user who would like to remain anonymous. 33 | 34 | An overview of the most important changes in this release follows below: 35 | 36 | ### Added 37 | 38 | - **New**: Anki 2.1 compatibility 39 | - **New**: Option to apply syntax highlighting via CSS (thanks to [Tim Rae](https://github.com/timrae/SyntaxHighlight)!) 40 | - **New**: Ability to customize language selection and hotkey 41 | - **New**: Ability to customize [syntax highlighting theme](https://help.farbox.com/pygments.html) 42 | - **New**: Upgraded pygments from v1.6 to v2.2.0. This is a [major jump](http://pygments.org/docs/changelog/#version-2-2-0) and should come with a lot of added functionality in terms of supported languages and language features 43 | 44 | ### Fixed 45 | 46 | - **Fixed**: Position options dialog correctly 47 | - **Fixed**: Various improvements and bug fixes (e.g. the ImportErrors and KeyErrors frequently reported in earlier reviews) 48 | 49 | ## 2.0.0-beta - 2018-02-27 50 | 51 | See version notes above. 52 | 53 | 54 | [Unreleased]: https://github.com/glutanimate/syntax-highlighting/compare/v2.0.2...HEAD 55 | [2.0.2]: https://github.com/glutanimate/syntax-highlighting/compare/v2.0.1...v2.0.2 56 | [2.0.1]: https://github.com/glutanimate/syntax-highlighting/compare/v2.0.0...v2.0.1 57 | [2.0.0]: https://github.com/glutanimate/syntax-highlighting/compare/v2.0.0-beta...v2.0.0 58 | 59 | ----- 60 | 61 | The format of this file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -------------------------------------------------------------------------------- /make.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """make.py file 3 | 4 | This is the same as a `make` file, but in python. 5 | """ 6 | from __future__ import annotations 7 | import argparse 8 | import inspect 9 | import sys 10 | import json 11 | import logging 12 | import platform 13 | import subprocess 14 | from pathlib import Path 15 | 16 | log = logging.getLogger(__name__) 17 | 18 | IMAGE = "boox" 19 | VENV = "/venv" 20 | APPDIR = "/app" 21 | 22 | 23 | def run(cmd, parse=False): 24 | out = subprocess.check_output([str(c) for c in cmd], encoding="utf-8") 25 | if parse: 26 | if out.strip(): 27 | return json.loads(out) 28 | return None 29 | return out 30 | 31 | 32 | def error(msg, code=1): 33 | print(f"error: {msg}", file=sys.stderr) 34 | if code: 35 | sys.exit(code) 36 | 37 | 38 | def task_info(): 39 | print(f"sys.executable: {sys.executable}") 40 | print(f"sys.platform: {sys.platform}") 41 | print(f"platform.uname().system: {platform.uname().system}") 42 | print(f"platform.uname().machine: {platform.uname().machine}") 43 | print(f"platform.uname().release: {platform.uname().release}") 44 | 45 | 46 | def task_e2e(_): 47 | try: 48 | subprocess.check_call( 49 | [ 50 | f"{VENV}/bin/aab", 51 | "build", 52 | "-t", 53 | "anki21", 54 | "-d", 55 | "local", 56 | "current", 57 | ], 58 | cwd=APPDIR, 59 | ) 60 | except Exception: 61 | pass 62 | 63 | for p in sorted(Path(APPDIR).rglob("*")): 64 | print(f"| {p}") 65 | 66 | 67 | def task_cross_build(args): 68 | "cross build an anki plugin using docker" 69 | if sys.platform != "win32": 70 | error(f"must run on windows (found '{sys.platform}')") 71 | 72 | p = argparse.ArgumentParser() 73 | p.add_argument("-n", "--info", help="run the info task", action="store_true") 74 | p.add_argument("--rm", help="rebuild image from scratch", action="store_true") 75 | 76 | options = p.parse_args(args) 77 | 78 | if options.rm: 79 | log.info("removing image '%s'", IMAGE) 80 | run(["docker", "image", "rm", "-f", IMAGE]) 81 | 82 | if not run(["docker", "image", "ls", "--format", "json", IMAGE]): 83 | log.info("building image '%s'", IMAGE) 84 | run(["docker", "buildx", "build", "-t", IMAGE, "."]) 85 | 86 | app = "info" if options.info else "e2e" 87 | subprocess.check_call( 88 | [ 89 | "docker", 90 | "run", 91 | "-v", 92 | f"{str(Path.cwd())}:/app", 93 | "--rm", 94 | "-ti", 95 | IMAGE, 96 | "python", 97 | f"{APPDIR}/make.py", 98 | app, 99 | ] 100 | ) 101 | 102 | 103 | COMMANDS = { 104 | name[len("task_") :].replace("_", "-"): fn 105 | for name, fn in locals().items() 106 | if name.startswith("task_") 107 | } 108 | 109 | 110 | if __name__ == "__main__": 111 | logging.basicConfig(level=logging.DEBUG) 112 | 113 | def getdoc(fn): 114 | return ( 115 | fn.__doc__.strip().partition("\n")[0] if fn.__doc__ else "no help available" 116 | ) 117 | 118 | if len(sys.argv) < 2 or sys.argv[1] not in COMMANDS: 119 | txt = "\n".join(f" {cmd} - {getdoc(fn)}" for cmd, fn in COMMANDS.items()) 120 | print( # noqa: T201 121 | f"""\ 122 | make.py {{arguments}} 123 | 124 | Commands: 125 | 126 | {txt} 127 | 128 | Running on: {sys.platform} 129 | """, 130 | file=sys.stderr, 131 | ) 132 | sys.exit() 133 | 134 | workdir = Path(__file__).parent 135 | if sys.argv[1] not in COMMANDS: 136 | error(f"cannot find the command '{sys.argv[1]}' in: {','.join(COMMANDS)}") 137 | 138 | function = COMMANDS[sys.argv[1]] 139 | n = len(inspect.signature(function).parameters) 140 | if n == 1: 141 | function(sys.argv[2:]) 142 | elif n == 0: 143 | function() 144 | else: 145 | function(*sys.argv[2:]) 146 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # syntax-highlighting (NG) 2 | 3 | [![Release](https://img.shields.io/github/downloads/cav71/syntax-highlighting-ng/total?logo=github&label=downloads)](https://github.com/cav71/syntax-highlighting-ng/releases) 4 | [![License - GNU AGPLv3](https://img.shields.io/badge/license-%20%20GNU%20AGPLv3%20-green)](https://spdx.org/licenses/AGPL-3.0-only.html) 5 | [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) 6 | [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) 7 | 8 | This is a new fork from the original "*Syntax Highlighting for Code*" (see [License and Credits](#license-and-credits) below). 9 | 10 | This add-on allows you to insert syntax-highlighted code snippets into the spaced-repetition flashcard app [Anki](https://apps.ankiweb.net/). 11 | 12 | The main reasons are: 13 | * to fix these issues: 14 | [PR46](https://github.com/glutanimate/syntax-highlighting/issues/46), 15 | [PR47](https://github.com/glutanimate/syntax-highlighting/issues/47) 16 | * clean port to python 3 17 | * support for mypy/ruff linters 18 | * adds unittests 19 | * always target the latest Anki version (eg. 2.1) and the latest Anki python version (at the moment 3.9) 20 | 21 |

22 | 23 | 24 | ### Table of Contents 25 | 26 | 27 | 28 | - [Installation](#installation) 29 | - [Documentation](#documentation) 30 | - [Building](#building) 31 | - [Contributing](#contributing) 32 | - [License and Credits](#license-and-credits) 33 | 34 | 35 | 36 | ### Installation 37 | 38 | #### AnkiWeb 39 | 40 | The easiest way to install Syntax Highlighting is through [AnkiWeb](https://ankiweb.net/shared/info/566351439) code `566351439`. 41 | 42 | #### Manual installation 43 | 44 | Please click on the entry corresponding to your Anki version: 45 | 46 |
47 | 48 | Anki 2.1 49 | 50 | 1. Make sure you have the [latest version](https://apps.ankiweb.net/#download) of Anki 2.1 installed. Earlier releases (e.g. found in various Linux distros) do not support `.ankiaddon` packages. 51 | 2. Download the latest `.ankiaddon` package from the [releases tab](https://github.com/glutanimate/syntax-highlighting/releases) (you might need to click on *Assets* below the description to reveal the download links) 52 | 3. From Anki's main window, head to *Tools* → *Add-ons* 53 | 4. Drag-and-drop the `.ankiaddon` package onto the add-ons list 54 | 5. Restart Anki 55 | 56 |
57 | 58 |
59 | 60 | Anki 2.0 61 | **No support for 2.0** 62 |
63 | 64 | ### Documentation 65 | 66 | For further information on the use of this add-on please check out [the description text](docs/description.md) for AnkiWeb. 67 | 68 | ### Building 69 | 70 | With [Anki add-on builder](https://github.com/glutanimate/anki-addon-builder/) installed: 71 | 72 | git clone https://github.com/glutanimate/syntax-highlighting.git 73 | cd syntax-highlighting 74 | aab build 75 | 76 | For more information on the build process please refer to [`aab`'s documentation](https://github.com/glutanimate/anki-addon-builder/#usage). 77 | 78 | ### Contributing 79 | 80 | Contributions are welcome! Please review the [contribution guidelines](./CONTRIBUTING.md) on how to: 81 | 82 | - Report issues 83 | - File pull requests 84 | - Support the project as a non-developer 85 | 86 | ### License and Credits 87 | 88 | *Syntax Highlighting (NG)* is 89 | 90 | *Copyright © 2023- [Antonio Cavallo](https://github.com/cav71)* 91 | 92 | *Syntax Highlighting* is 93 | 94 | *Copyright © 2018-2019 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)* 95 | 96 | *Copyright © 2015 [Tim Rae](https://github.com/timrae)* 97 | 98 | *Copyright © 2012-2015 [Tiago Barroso](https://github.com/tmbb)* 99 | 100 | 101 | *Syntax Highlighting* is based on [*Syntax Highlighting for Code*](https://github.com/tmbb/SyntaxHighlight) by [Tiago Barroso](https://github.com/tmbb). All credit for the original add-on goes to him. A major thanks is also due for [Tim Rae](https://github.com/timrae), who extended the original add-on with CSS support. 102 | 103 | The present fork and update to Anki 2.1 was made possible through the generous support of a fellow Anki user who would like to remain anonymous. 104 | 105 | *Syntax Highlighting* ships with the following third-party open-source software: 106 | 107 | - [Pygments](http://pygments.org/) v2.17.2. Copyright (c) 2006-2023 by the Pygments Team. Licensed under the BSD license. 108 | 109 | Syntax Highlighting is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the [LICENSE](https://github.com/glutanimate/syntax-highlighting/blob/master/LICENSE) file that accompanied this program. 110 | 111 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. 112 | 113 | ---- 114 | 115 | 116 |
The continued development of this add-on is made possible
thanks to my Patreon and Ko-Fi supporters. 117 |
You guys rock ❤️ !
118 | 119 | 120 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/main.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Syntax Highlighting add-on for Anki. 5 | 6 | Main Module, hooks add-on methods into Anki. 7 | 8 | Copyright: (c) 2012-2015 Tiago Barroso 9 | (c) 2015 Tim Rae 10 | (c) 2018-2023 Glutanimate 11 | (c) 2023- A. Cavallo 12 | 13 | License: GNU AGPLv3 14 | """ 15 | 16 | from __future__ import unicode_literals, annotations 17 | 18 | import contextlib 19 | import logging 20 | import functools 21 | import os 22 | import sys 23 | import re 24 | import json 25 | import traceback 26 | 27 | from . import config, consts 28 | 29 | log = logging.getLogger(__name__) 30 | 31 | import pygments 32 | from pygments.lexers import get_all_lexers 33 | 34 | from aqt.qt import * 35 | from aqt import mw 36 | from aqt.main import AnkiQt 37 | from aqt.editor import Editor 38 | from aqt.utils import showWarning 39 | from anki.hooks import addHook, wrap 40 | 41 | log = getattr(mw.addonManager, "get_logger", logging.getLogger)(__name__) 42 | 43 | log.info( 44 | "addon syntax_highlighting_ng loaded pygments %s", 45 | getattr(pygments, "__version__", "N/A"), 46 | ) 47 | 48 | HOTKEY = config.local_conf["hotkey"] 49 | STYLE = config.local_conf["style"] 50 | LIMITED_LANGS = config.local_conf["limitToLangs"] 51 | 52 | # This code sets a correspondence between: 53 | # The "language names": long, descriptive names we want 54 | # to show the user AND 55 | # The "language aliases": short, cryptic names for internal 56 | # use by HtmlFormatter 57 | LANGUAGES_MAP = {lex[0]: lex[1][0] for lex in get_all_lexers() if lex[1]} 58 | 59 | 60 | # Misc 61 | 62 | 63 | def showError(msg, parent): 64 | showWarning(msg, title="Syntax Highlighting Error", parent=parent) 65 | 66 | 67 | def ui_code(fn): 68 | """ 69 | A decorator for UI-related code in Python. 70 | 71 | This decorator is used to handle exceptions related to UI 72 | rendering and display an error messages. 73 | 74 | Args: 75 | fn: The function to be decorated (first argument must be Editor). 76 | 77 | Returns: 78 | Callable[[Editor, ...], Any]: handles UI-related exceptions. 79 | 80 | Example usage: 81 | @ui_code 82 | def render_ui(ed, *args, **kwargs): 83 | # UI code here 84 | """ 85 | 86 | @functools.wraps(fn) 87 | def _fn(ed: Editor, *args, **kwargs) -> None | bool: 88 | from . import html_render 89 | 90 | try: 91 | return fn(ed, *args, **kwargs) 92 | except (html_render.LanguageNotFound, html_render.InvalidStyle) as e: 93 | print("".join(traceback.format_exc())) 94 | showError(e.render(), parent=ed.parentWindow) 95 | return False 96 | 97 | return _fn 98 | 99 | 100 | # Synced options and corresponding dialogs 101 | 102 | 103 | def get_deck_name(mw: AnkiQt) -> str | None: 104 | with contextlib.suppress(AttributeError): 105 | return mw.col.decks.current()["name"] 106 | # No deck opened? 107 | return None 108 | 109 | 110 | def get_default_lang(mw: AnkiQt) -> str: 111 | addon_conf = mw.col.conf[config.KEY] 112 | lang = addon_conf["lang"] 113 | if addon_conf["defaultlangperdeck"]: 114 | deck_name = get_deck_name(mw) 115 | if deck_name and deck_name in addon_conf["deckdefaultlang"]: 116 | lang = addon_conf["deckdefaultlang"][deck_name] 117 | return lang 118 | 119 | 120 | def set_default_lang(mw: AnkiQt, lang: str) -> None: 121 | addon_conf = mw.col.conf[config.KEY] 122 | addon_conf["lang"] = lang # Always update the overall default 123 | if addon_conf["defaultlangperdeck"]: 124 | deck_name = get_deck_name(mw) 125 | if deck_name: 126 | addon_conf["deckdefaultlang"][deck_name] = lang 127 | 128 | 129 | # type: ignore 130 | class SyntaxHighlightingOptions(QDialog): # type: ignore 131 | def __init__(self, mw): 132 | super(SyntaxHighlightingOptions, self).__init__() 133 | self.mw = mw 134 | self.addon_conf = None 135 | self.setupUi() 136 | 137 | def switch_linenos(self): 138 | linenos_ = self.addon_conf["linenos"] 139 | self.addon_conf["linenos"] = not linenos_ 140 | 141 | def switch_centerfragments(self): 142 | centerfragments_ = self.addon_conf["centerfragments"] 143 | self.addon_conf["centerfragments"] = not centerfragments_ 144 | 145 | def switch_defaultlangperdeck(self): 146 | defaultlangperdeck_ = self.addon_conf["defaultlangperdeck"] 147 | self.addon_conf["defaultlangperdeck"] = not defaultlangperdeck_ 148 | 149 | def switch_cssclasses(self): 150 | cssclasses_ = self.addon_conf["cssclasses"] 151 | self.addon_conf["cssclasses"] = not cssclasses_ 152 | 153 | def setupUi(self): 154 | self.addon_conf = self.mw.col.conf[config.KEY] 155 | 156 | linenos_label = QLabel("Line numbers") 157 | linenos_checkbox = QCheckBox("") 158 | linenos_checkbox.setChecked(self.addon_conf["linenos"]) 159 | linenos_checkbox.stateChanged.connect(self.switch_linenos) 160 | 161 | center_label = QLabel("Center code fragments") 162 | center_checkbox = QCheckBox("") 163 | center_checkbox.setChecked(self.addon_conf["centerfragments"]) 164 | center_checkbox.stateChanged.connect(self.switch_centerfragments) 165 | 166 | cssclasses_label = QLabel("Use CSS classes") 167 | cssclasses_checkbox = QCheckBox("") 168 | cssclasses_checkbox.setChecked(self.addon_conf["cssclasses"]) 169 | cssclasses_checkbox.stateChanged.connect(self.switch_cssclasses) 170 | 171 | defaultlangperdeck_label = QLabel( 172 | "Default to last language used per deck" 173 | ) 174 | defaultlangperdeck_checkbox = QCheckBox("") 175 | defaultlangperdeck_checkbox.setChecked(self.addon_conf["defaultlangperdeck"]) 176 | defaultlangperdeck_checkbox.stateChanged.connect(self.switch_defaultlangperdeck) 177 | 178 | grid = QGridLayout() 179 | grid.setSpacing(10) 180 | grid.addWidget(linenos_label, 0, 0) 181 | grid.addWidget(linenos_checkbox, 0, 1) 182 | grid.addWidget(center_label, 1, 0) 183 | grid.addWidget(center_checkbox, 1, 1) 184 | grid.addWidget(cssclasses_label, 2, 0) 185 | grid.addWidget(cssclasses_checkbox, 2, 1) 186 | grid.addWidget(defaultlangperdeck_label, 3, 0) 187 | grid.addWidget(defaultlangperdeck_checkbox, 3, 1) 188 | 189 | self.setLayout(grid) 190 | 191 | self.setWindowTitle("Syntax Highlighting Options") 192 | 193 | 194 | def onOptionsCall(mw: AnkiQt) -> None: 195 | """Call settings dialog""" 196 | dialog = SyntaxHighlightingOptions(mw) 197 | dialog.exec() 198 | 199 | 200 | options_action = QAction("Syntax Highlighting Options ...", mw) # type: ignore 201 | options_action.triggered.connect(lambda _, o=mw: onOptionsCall(o)) 202 | mw.form.menuTools.addAction(options_action) 203 | 204 | 205 | # Highlighter initialization 206 | 207 | 208 | def init_highlighter(ed: Editor, *args, **kwargs): 209 | # Get the last selected language (or the default language if the user 210 | # has never chosen any) 211 | 212 | previous_lang = get_default_lang(mw) 213 | ed.codeHighlightLangAlias = LANGUAGES_MAP.get(previous_lang, "") 214 | 215 | 216 | # Highlighter widgets 217 | 218 | # button icon 219 | standardHeight = 20 220 | standardWidth = 20 221 | icon_path = os.path.join(consts.addon_path, "icons", "button.png") 222 | 223 | 224 | # Editor widgets in Anki 2.0 225 | 226 | 227 | # This is taken from the aqt source code 228 | def add_plugin_button_( 229 | self, 230 | ed, 231 | name, 232 | func, 233 | text="", 234 | key=None, 235 | tip=None, 236 | height=False, 237 | width=False, 238 | icon=None, 239 | check=False, 240 | native=False, 241 | canDisable=True, 242 | ): 243 | b = QPushButton(text) 244 | 245 | if check: 246 | b.clicked[bool].connect(func) 247 | else: 248 | b.clicked.connect(func) 249 | 250 | if height: 251 | b.setFixedHeight(height) 252 | if width: 253 | b.setFixedWidth(width) 254 | 255 | if not native: 256 | b.setStyle(ed.plastiqueStyle) 257 | b.setFocusPolicy(Qt.NoFocus) 258 | else: 259 | b.setAutoDefault(False) 260 | 261 | if icon: 262 | b.setIcon(QIcon(icon)) 263 | if key: 264 | b.setShortcut(QKeySequence(key)) 265 | if tip: 266 | b.setToolTip(tip) 267 | if check: 268 | b.setCheckable(True) 269 | 270 | self.addWidget(b) # this part is changed 271 | 272 | if canDisable: 273 | ed._buttons[name] = b 274 | return b 275 | 276 | 277 | def add_code_langs_combobox(self, func, previous_lang): 278 | combo = QComboBox() 279 | combo.addItem(previous_lang) 280 | 281 | if LIMITED_LANGS: 282 | selection = LIMITED_LANGS 283 | else: 284 | selection = sorted(LANGUAGES_MAP.keys(), key=str.lower) 285 | 286 | for lang in selection: 287 | combo.addItem(lang) 288 | 289 | combo.activated[str].connect(func) 290 | self.addWidget(combo) 291 | return combo 292 | 293 | 294 | QSplitter.add_plugin_button_ = add_plugin_button_ # type: ignore 295 | QSplitter.add_code_langs_combobox = add_code_langs_combobox # type: ignore 296 | 297 | 298 | @ui_code 299 | def onCodeHighlightLangSelect(ed, lang): 300 | from . import html_render 301 | 302 | try: 303 | alias = LANGUAGES_MAP[lang] 304 | except KeyError: 305 | ed.codeHighlightLangAlias = "" 306 | raise html_render.LanguageNotFound(lang) 307 | set_default_lang(mw, lang) 308 | ed.codeHighlightLangAlias = alias 309 | 310 | 311 | # Editor widgets in Anki 2.1 312 | 313 | select_elm = ( 314 | """""" 317 | ) 318 | 319 | 320 | def onSetupButtons21(buttons, ed): 321 | """Add buttons to Editor for Anki 2.1.x""" 322 | # no need for a lambda since onBridgeCmd passes current editor instance 323 | # to method anyway (cf. "self._links[cmd](self)") 324 | b = ed.addButton( 325 | icon_path, 326 | "CH", 327 | highlight_code, 328 | tip="Paste highlighted code ({})".format(HOTKEY), 329 | keys=HOTKEY, 330 | ) 331 | buttons.append(b) 332 | 333 | # HTML "combobox" 334 | previous_lang = get_default_lang(mw) 335 | 336 | option_str = """""" 337 | options = [] 338 | 339 | if LIMITED_LANGS: 340 | selection = LIMITED_LANGS 341 | else: 342 | selection = sorted(LANGUAGES_MAP.keys(), key=str.lower) 343 | 344 | options.append(option_str.format(previous_lang)) 345 | for lang in selection: 346 | options.append(option_str.format(lang)) 347 | 348 | combo = select_elm.format("".join(options)) 349 | buttons.append(combo) 350 | 351 | return buttons 352 | 353 | 354 | def onBridgeCmd(ed, cmd, _old): 355 | if not cmd.startswith("shLang"): 356 | return _old(ed, cmd) 357 | (type, lang) = cmd.split(":") 358 | onCodeHighlightLangSelect(ed, lang) 359 | 360 | 361 | # Actual code highlighting 362 | 363 | 364 | @ui_code 365 | def highlight_code(ed): 366 | from . import html_render 367 | 368 | addon_conf = mw.col.conf[config.KEY] 369 | 370 | # Do we want line numbers? linenos is either true or false according 371 | # to the user's preferences 372 | linenos = addon_conf["linenos"] 373 | 374 | centerfragments = addon_conf["centerfragments"] 375 | 376 | # Do we want to use css classes or have formatting directly in HTML? 377 | # Using css classes takes up less space and gives the user more 378 | # customization options, but is less self-contained as it requires 379 | # setting the styling on every note type where code is used 380 | noclasses = not addon_conf["cssclasses"] 381 | 382 | # NOTE: we get the selected text (a pure string) 383 | selected_text = ed.web.selectedText() 384 | if selected_text: 385 | # Sometimes, self.web.selectedText() contains the unicode character 386 | # '\u00A0' (non-breaking space). This character messes with the 387 | # formatter for highlighted code. To correct this, we replace all 388 | # '\u00A0' characters with regular space characters 389 | code = selected_text.replace("\u00A0", " ") 390 | else: 391 | clipboard = QApplication.clipboard() 392 | # Get the code from the clipboard 393 | code = clipboard.text() 394 | 395 | # Select the lexer for the correct language 396 | style = html_render.Style( 397 | # NOTE: we specify the language to highlight for 398 | language=ed.codeHighlightLangAlias, 399 | style=STYLE, 400 | linenos="inline" if linenos is True else linenos, 401 | noclasses=noclasses, 402 | ) 403 | 404 | processed = html_render.render_string(code, style=style) 405 | 406 | if centerfragments: 407 | pretty_code = "".join( 408 | [ 409 | "
", 410 | processed, 411 | "
", 412 | ] 413 | ) 414 | else: 415 | pretty_code = "".join( 416 | ["
", processed, "
"] 417 | ) 418 | 419 | pretty_code = process_html(pretty_code) 420 | 421 | # These two lines insert a piece of HTML in the current cursor position 422 | ed.web.eval( 423 | "document.execCommand('inserthtml', false, %s);" % json.dumps(pretty_code) 424 | ) 425 | 426 | 427 | def process_html(html): 428 | """Modify highlighter output to address some Anki idiosyncracies""" 429 | # 1.) "Escape" curly bracket sequences reserved to Anki's card template 430 | # system by placing an invisible html tag inbetween 431 | for pattern, replacement in ( 432 | (r"{{", r"{{"), 433 | (r"}}", r"}}"), 434 | (r"::", r"::"), 435 | ): 436 | html = re.sub(pattern, replacement, html) 437 | return html 438 | 439 | 440 | # Hooks and monkey-patches 441 | 442 | 443 | addHook("setupEditorButtons", onSetupButtons21) 444 | Editor.onBridgeCmd = wrap(Editor.onBridgeCmd, onBridgeCmd, "around") 445 | 446 | Editor.__init__ = wrap(Editor.__init__, init_highlighter) 447 | -------------------------------------------------------------------------------- /tests/assets/test_html_render/conftest.html: -------------------------------------------------------------------------------- 1 |
2 | 
 1from __future__ import annotations
 3 |  2import sys
 4 |  3import types
 5 |  4from pathlib import Path
 6 |  5import pytest
 7 |  6
 8 |  7
 9 |  8@pytest.fixture(scope="function")
10 |  9def assets(request):
11 | 10
12 | 11    class Asset:
13 | 12        def __init__(self):
14 | 13            self.basedir = Path(__file__).parent
15 | 14            self.candidates = [
16 | 15                f"assets/{request.node.module.__name__}",
17 | 16                "assets",
18 | 17            ]
19 | 18        def lookup(self, path: Path | str) -> Path|None:
20 | 19            for candidate in self.candidates:
21 | 20                if (target := (self.basedir / candidate / path)).exists():
22 | 21                    return target
23 | 22
24 | 23        def read_text(self, path: Path | str, fallback: str|None=None) -> str|None:
25 | 24            dest = self.lookup(path)
26 | 25            if fallback is not None:
27 | 26                dest = dest or (self.basedir / self.candidates[0] / path)
28 | 27                dest.parent.mkdir(exist_ok=True, parents=True)
29 | 28                dest.write_text(fallback)
30 | 29
31 | 30            return dest.read_text()
32 | 31
33 | 32
34 | 33    return Asset()
35 | 34
36 | 35
37 | 36@pytest.fixture(scope="function")
38 | 37def fake_anki21(monkeypatch):
39 | 38    # monkey patch a fake anki21 module
40 | 39
41 | 40    class Anki(types.ModuleType):
42 | 41        version = "23.10.1"
43 | 42
44 | 43        def pointVersion(self):
45 | 44            return self.point_version()
46 | 45        def point_version(self):
47 | 46            return 231001
48 | 47
49 | 48
50 | 49    class AnkiHooks(types.ModuleType):
51 | 50        def addHook(self):
52 | 51            return 999
53 | 52
54 | 53    class Aqt(types.ModuleType):
55 | 54        pass
56 | 55
57 | 56    class AqtMV(types.ModuleType):
58 | 57        def callme(self):
59 | 58            return 123
60 | 59
61 | 60    replacements = [
62 | 61        ("anki", Anki),
63 | 62        ("anki.hooks", AnkiHooks),
64 | 63        ("aqt", Aqt),
65 | 64        ("aqt.mw", AqtMV),
66 | 65    ]
67 | 66    old = {}
68 | 67    for name, cls in replacements:
69 | 68        old[name] = sys.modules.get(name)
70 | 69        sys.modules[name] = cls(name)
71 | 70    yield old
72 | 71    for name, mod in reversed(old.items()):
73 | 72        if mod:
74 | 73            sys.modules[name] = mod
75 | 74        else:
76 | 75            del sys.modules[name]
77 |
78 |
79 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This Program is licensed under the GNU Affero General Public License 2 | version 3 ("AGPL"), extended by a number of Additional Terms under 3 | Section 7 of the AGPL. 4 | 5 | If not otherwise noted, this License applies to all files included 6 | with this Program. Files subject to different licensing terms might 7 | also ship with this Program, but will be clearly marked as such in 8 | additional LICENSE files accompanying them. 9 | 10 | The AGPLv3 License and Additional Terms follow. 11 | 12 | ============================================================================== 13 | 14 | GNU AFFERO GENERAL PUBLIC LICENSE 15 | Version 3, 19 November 2007 16 | 17 | Copyright (C) 2007 Free Software Foundation, Inc. 18 | Everyone is permitted to copy and distribute verbatim copies 19 | of this license document, but changing it is not allowed. 20 | 21 | Preamble 22 | 23 | The GNU Affero General Public License is a free, copyleft license for 24 | software and other kinds of works, specifically designed to ensure 25 | cooperation with the community in the case of network server software. 26 | 27 | The licenses for most software and other practical works are designed 28 | to take away your freedom to share and change the works. By contrast, 29 | our General Public Licenses are intended to guarantee your freedom to 30 | share and change all versions of a program--to make sure it remains free 31 | software for all its users. 32 | 33 | When we speak of free software, we are referring to freedom, not 34 | price. Our General Public Licenses are designed to make sure that you 35 | have the freedom to distribute copies of free software (and charge for 36 | them if you wish), that you receive source code or can get it if you 37 | want it, that you can change the software or use pieces of it in new 38 | free programs, and that you know you can do these things. 39 | 40 | Developers that use our General Public Licenses protect your rights 41 | with two steps: (1) assert copyright on the software, and (2) offer 42 | you this License which gives you legal permission to copy, distribute 43 | and/or modify the software. 44 | 45 | A secondary benefit of defending all users' freedom is that 46 | improvements made in alternate versions of the program, if they 47 | receive widespread use, become available for other developers to 48 | incorporate. Many developers of free software are heartened and 49 | encouraged by the resulting cooperation. However, in the case of 50 | software used on network servers, this result may fail to come about. 51 | The GNU General Public License permits making a modified version and 52 | letting the public access it on a server without ever releasing its 53 | source code to the public. 54 | 55 | The GNU Affero General Public License is designed specifically to 56 | ensure that, in such cases, the modified source code becomes available 57 | to the community. It requires the operator of a network server to 58 | provide the source code of the modified version running there to the 59 | users of that server. Therefore, public use of a modified version, on 60 | a publicly accessible server, gives the public access to the source 61 | code of the modified version. 62 | 63 | An older license, called the Affero General Public License and 64 | published by Affero, was designed to accomplish similar goals. This is 65 | a different license, not a version of the Affero GPL, but Affero has 66 | released a new version of the Affero GPL which permits relicensing under 67 | this license. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU Affero General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Remote Network Interaction; Use with the GNU General Public License. 554 | 555 | Notwithstanding any other provision of this License, if you modify the 556 | Program, your modified version must prominently offer all users 557 | interacting with it remotely through a computer network (if your version 558 | supports such interaction) an opportunity to receive the Corresponding 559 | Source of your version by providing access to the Corresponding Source 560 | from a network server at no charge, through some standard or customary 561 | means of facilitating copying of software. This Corresponding Source 562 | shall include the Corresponding Source for any work covered by version 3 563 | of the GNU General Public License that is incorporated pursuant to the 564 | following paragraph. 565 | 566 | Notwithstanding any other provision of this License, you have 567 | permission to link or combine any covered work with a work licensed 568 | under version 3 of the GNU General Public License into a single 569 | combined work, and to convey the resulting work. The terms of this 570 | License will continue to apply to the part which is the covered work, 571 | but the work with which it is combined will remain governed by version 572 | 3 of the GNU General Public License. 573 | 574 | 14. Revised Versions of this License. 575 | 576 | The Free Software Foundation may publish revised and/or new versions of 577 | the GNU Affero General Public License from time to time. Such new versions 578 | will be similar in spirit to the present version, but may differ in detail to 579 | address new problems or concerns. 580 | 581 | Each version is given a distinguishing version number. If the 582 | Program specifies that a certain numbered version of the GNU Affero General 583 | Public License "or any later version" applies to it, you have the 584 | option of following the terms and conditions either of that numbered 585 | version or of any later version published by the Free Software 586 | Foundation. If the Program does not specify a version number of the 587 | GNU Affero General Public License, you may choose any version ever published 588 | by the Free Software Foundation. 589 | 590 | If the Program specifies that a proxy can decide which future 591 | versions of the GNU Affero General Public License can be used, that proxy's 592 | public statement of acceptance of a version permanently authorizes you 593 | to choose that version for the Program. 594 | 595 | Later license versions may give you additional or different 596 | permissions. However, no additional obligations are imposed on any 597 | author or copyright holder as a result of your choosing to follow a 598 | later version. 599 | 600 | 15. Disclaimer of Warranty. 601 | 602 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 603 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 604 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 605 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 606 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 607 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 608 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 609 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 610 | 611 | 16. Limitation of Liability. 612 | 613 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 614 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 615 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 616 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 617 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 618 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 619 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 620 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 621 | SUCH DAMAGES. 622 | 623 | 17. Interpretation of Sections 15 and 16. 624 | 625 | If the disclaimer of warranty and limitation of liability provided 626 | above cannot be given local legal effect according to their terms, 627 | reviewing courts shall apply local law that most closely approximates 628 | an absolute waiver of all civil liability in connection with the 629 | Program, unless a warranty or assumption of liability accompanies a 630 | copy of the Program in return for a fee. 631 | 632 | END OF TERMS AND CONDITIONS 633 | 634 | ============================================================================== 635 | 636 | ADDITIONAL TERMS APPLICABLE TO THIS PROGRAM 637 | UNDER GNU AGPL VERSION 3 SECTION 7 638 | 639 | The following additional terms ("Additional Terms") supplement and modify the 640 | GNU Affero General Public License, Version 3 ("AGPL") applicable to the present 641 | Program. 642 | 643 | In addition to the terms and conditions of the AGPL, the present Program is 644 | subject to the further restrictions below: 645 | 646 | 1. Trademark and Publicity Rights. 647 | 648 | Except as expressly provided herein, no trademark or publicity rights are 649 | granted. This license does NOT give you any right, title or interest in the 650 | "Glutanimate" name or logo. 651 | 652 | 2. Origin of the Program. 653 | 654 | The origin of the Program must not be misrepresented; you must not claim 655 | that you wrote the original Program. Altered source versions must be plainly 656 | marked as such, and must not be misrepresented as being the original 657 | Program. 658 | 659 | 3. Legal Notices and Author Attributions. 660 | 661 | You must reproduce faithfully all trademark, copyright and other proprietary 662 | and legal notices on any copies of the Program or any other required author 663 | attributions. Legal notices or author attributions displayed as part of the 664 | user interface must be preserved as such. 665 | 666 | 4. Use of Names of Licensors or Authors for Publicity Purposes. 667 | 668 | Outside of the aforementioned legal notices and author attributions, neither 669 | the name of the copyright holder or its affiliates, any other party who 670 | modifies and/or conveys the Program, nor the names of the Program's 671 | sponsors/supporters/patrons may be used to endorse or promote products 672 | derived from this software without specific prior written permission. 673 | 674 | 5. Indemnification. 675 | 676 | IF YOU CONVEY A COVERED WORK AND AGREE WITH ANY RECIPIENT OF THAT COVERED 677 | WORK THAT YOU WILL ASSUME ANY LIABILITY FOR THAT COVERED WORK, YOU HEREBY 678 | AGREE TO INDEMNIFY, DEFEND AND HOLD HARMLESS THE OTHER LICENSORS AND AUTHORS 679 | OF THAT COVERED WORK FOR ANY DAMAGES, DEMANDS, CLAIMS, LOSSES, CAUSES OF 680 | ACTION, LAWSUITS, JUDGMENTS EXPENSES (INCLUDING WITHOUT LIMITATION 681 | REASONABLE ATTORNEYS' FEES AND EXPENSES) OR ANY OTHER LIABLITY ARISING FROM, 682 | RELATED TO OR IN CONNECTION WITH YOUR ASSUMPTIONS OF LIABILITY. 683 | 684 | 6. Preservation of Licensing Terms. 685 | 686 | Any covered work conveyed by you must include this license text in its 687 | entirety. 688 | 689 | ------------------------------------------------------------------------------- 690 | 691 | If you have any questions regarding this license, about any other legal 692 | details, or want to report an infringement of the aforementioned licensing 693 | terms, please feel free to contact me at: 694 | -------------------------------------------------------------------------------- /src/syntax_highlighting_ng/LICENSE.txt: -------------------------------------------------------------------------------- 1 | This Program is licensed under the GNU Affero General Public License 2 | version 3 ("AGPL"), extended by a number of Additional Terms under 3 | Section 7 of the AGPL. 4 | 5 | If not otherwise noted, this License applies to all files included 6 | with this Program. Files subject to different licensing terms might 7 | also ship with this Program, but will be clearly marked as such in 8 | additional LICENSE files accompanying them. 9 | 10 | The AGPLv3 License and Additional Terms follow. 11 | 12 | ============================================================================== 13 | 14 | GNU AFFERO GENERAL PUBLIC LICENSE 15 | Version 3, 19 November 2007 16 | 17 | Copyright (C) 2007 Free Software Foundation, Inc. 18 | Everyone is permitted to copy and distribute verbatim copies 19 | of this license document, but changing it is not allowed. 20 | 21 | Preamble 22 | 23 | The GNU Affero General Public License is a free, copyleft license for 24 | software and other kinds of works, specifically designed to ensure 25 | cooperation with the community in the case of network server software. 26 | 27 | The licenses for most software and other practical works are designed 28 | to take away your freedom to share and change the works. By contrast, 29 | our General Public Licenses are intended to guarantee your freedom to 30 | share and change all versions of a program--to make sure it remains free 31 | software for all its users. 32 | 33 | When we speak of free software, we are referring to freedom, not 34 | price. Our General Public Licenses are designed to make sure that you 35 | have the freedom to distribute copies of free software (and charge for 36 | them if you wish), that you receive source code or can get it if you 37 | want it, that you can change the software or use pieces of it in new 38 | free programs, and that you know you can do these things. 39 | 40 | Developers that use our General Public Licenses protect your rights 41 | with two steps: (1) assert copyright on the software, and (2) offer 42 | you this License which gives you legal permission to copy, distribute 43 | and/or modify the software. 44 | 45 | A secondary benefit of defending all users' freedom is that 46 | improvements made in alternate versions of the program, if they 47 | receive widespread use, become available for other developers to 48 | incorporate. Many developers of free software are heartened and 49 | encouraged by the resulting cooperation. However, in the case of 50 | software used on network servers, this result may fail to come about. 51 | The GNU General Public License permits making a modified version and 52 | letting the public access it on a server without ever releasing its 53 | source code to the public. 54 | 55 | The GNU Affero General Public License is designed specifically to 56 | ensure that, in such cases, the modified source code becomes available 57 | to the community. It requires the operator of a network server to 58 | provide the source code of the modified version running there to the 59 | users of that server. Therefore, public use of a modified version, on 60 | a publicly accessible server, gives the public access to the source 61 | code of the modified version. 62 | 63 | An older license, called the Affero General Public License and 64 | published by Affero, was designed to accomplish similar goals. This is 65 | a different license, not a version of the Affero GPL, but Affero has 66 | released a new version of the Affero GPL which permits relicensing under 67 | this license. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU Affero General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Remote Network Interaction; Use with the GNU General Public License. 554 | 555 | Notwithstanding any other provision of this License, if you modify the 556 | Program, your modified version must prominently offer all users 557 | interacting with it remotely through a computer network (if your version 558 | supports such interaction) an opportunity to receive the Corresponding 559 | Source of your version by providing access to the Corresponding Source 560 | from a network server at no charge, through some standard or customary 561 | means of facilitating copying of software. This Corresponding Source 562 | shall include the Corresponding Source for any work covered by version 3 563 | of the GNU General Public License that is incorporated pursuant to the 564 | following paragraph. 565 | 566 | Notwithstanding any other provision of this License, you have 567 | permission to link or combine any covered work with a work licensed 568 | under version 3 of the GNU General Public License into a single 569 | combined work, and to convey the resulting work. The terms of this 570 | License will continue to apply to the part which is the covered work, 571 | but the work with which it is combined will remain governed by version 572 | 3 of the GNU General Public License. 573 | 574 | 14. Revised Versions of this License. 575 | 576 | The Free Software Foundation may publish revised and/or new versions of 577 | the GNU Affero General Public License from time to time. Such new versions 578 | will be similar in spirit to the present version, but may differ in detail to 579 | address new problems or concerns. 580 | 581 | Each version is given a distinguishing version number. If the 582 | Program specifies that a certain numbered version of the GNU Affero General 583 | Public License "or any later version" applies to it, you have the 584 | option of following the terms and conditions either of that numbered 585 | version or of any later version published by the Free Software 586 | Foundation. If the Program does not specify a version number of the 587 | GNU Affero General Public License, you may choose any version ever published 588 | by the Free Software Foundation. 589 | 590 | If the Program specifies that a proxy can decide which future 591 | versions of the GNU Affero General Public License can be used, that proxy's 592 | public statement of acceptance of a version permanently authorizes you 593 | to choose that version for the Program. 594 | 595 | Later license versions may give you additional or different 596 | permissions. However, no additional obligations are imposed on any 597 | author or copyright holder as a result of your choosing to follow a 598 | later version. 599 | 600 | 15. Disclaimer of Warranty. 601 | 602 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 603 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 604 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 605 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 606 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 607 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 608 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 609 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 610 | 611 | 16. Limitation of Liability. 612 | 613 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 614 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 615 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 616 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 617 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 618 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 619 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 620 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 621 | SUCH DAMAGES. 622 | 623 | 17. Interpretation of Sections 15 and 16. 624 | 625 | If the disclaimer of warranty and limitation of liability provided 626 | above cannot be given local legal effect according to their terms, 627 | reviewing courts shall apply local law that most closely approximates 628 | an absolute waiver of all civil liability in connection with the 629 | Program, unless a warranty or assumption of liability accompanies a 630 | copy of the Program in return for a fee. 631 | 632 | END OF TERMS AND CONDITIONS 633 | 634 | ============================================================================== 635 | 636 | ADDITIONAL TERMS APPLICABLE TO THIS PROGRAM 637 | UNDER GNU AGPL VERSION 3 SECTION 7 638 | 639 | The following additional terms ("Additional Terms") supplement and modify the 640 | GNU Affero General Public License, Version 3 ("AGPL") applicable to the present 641 | Program. 642 | 643 | In addition to the terms and conditions of the AGPL, the present Program is 644 | subject to the further restrictions below: 645 | 646 | 1. Trademark and Publicity Rights. 647 | 648 | Except as expressly provided herein, no trademark or publicity rights are 649 | granted. This license does NOT give you any right, title or interest in the 650 | "Glutanimate" name or logo. 651 | 652 | 2. Origin of the Program. 653 | 654 | The origin of the Program must not be misrepresented; you must not claim 655 | that you wrote the original Program. Altered source versions must be plainly 656 | marked as such, and must not be misrepresented as being the original 657 | Program. 658 | 659 | 3. Legal Notices and Author Attributions. 660 | 661 | You must reproduce faithfully all trademark, copyright and other proprietary 662 | and legal notices on any copies of the Program or any other required author 663 | attributions. Legal notices or author attributions displayed as part of the 664 | user interface must be preserved as such. 665 | 666 | 4. Use of Names of Licensors or Authors for Publicity Purposes. 667 | 668 | Outside of the aforementioned legal notices and author attributions, neither 669 | the name of the copyright holder or its affiliates, any other party who 670 | modifies and/or conveys the Program, nor the names of the Program's 671 | sponsors/supporters/patrons may be used to endorse or promote products 672 | derived from this software without specific prior written permission. 673 | 674 | 5. Indemnification. 675 | 676 | IF YOU CONVEY A COVERED WORK AND AGREE WITH ANY RECIPIENT OF THAT COVERED 677 | WORK THAT YOU WILL ASSUME ANY LIABILITY FOR THAT COVERED WORK, YOU HEREBY 678 | AGREE TO INDEMNIFY, DEFEND AND HOLD HARMLESS THE OTHER LICENSORS AND AUTHORS 679 | OF THAT COVERED WORK FOR ANY DAMAGES, DEMANDS, CLAIMS, LOSSES, CAUSES OF 680 | ACTION, LAWSUITS, JUDGMENTS EXPENSES (INCLUDING WITHOUT LIMITATION 681 | REASONABLE ATTORNEYS' FEES AND EXPENSES) OR ANY OTHER LIABLITY ARISING FROM, 682 | RELATED TO OR IN CONNECTION WITH YOUR ASSUMPTIONS OF LIABILITY. 683 | 684 | 6. Preservation of Licensing Terms. 685 | 686 | Any covered work conveyed by you must include this license text in its 687 | entirety. 688 | 689 | ------------------------------------------------------------------------------- 690 | 691 | If you have any questions regarding this license, about any other legal 692 | details, or want to report an infringement of the aforementioned licensing 693 | terms, please feel free to contact me at: 694 | --------------------------------------------------------------------------------