├── .github ├── dependabot.yml └── workflows │ ├── system.yml │ ├── build.yml │ └── test.yml ├── .gitignore ├── Eask ├── CHANGELOG.md ├── Makefile ├── scripts ├── generate-badges-system.el ├── _prepare.el └── generate-source.el ├── templates └── source.el ├── eask.el ├── etc └── badges │ └── emacs.svg ├── eask-api.el ├── README.md └── LICENSE /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions 4 | - package-ecosystem: 'github-actions' 5 | directory: '/' 6 | schedule: 7 | interval: 'daily' 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ignore these directories 2 | /.git 3 | /recipes 4 | 5 | # ignore generated files 6 | *.elc 7 | 8 | # eask packages 9 | .eask/ 10 | dist/ 11 | 12 | # packaging 13 | *-autoloads.el 14 | *-pkg.el 15 | 16 | # local test 17 | /_test 18 | 19 | # OS generated 20 | .DS_Store 21 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: eask; lexical-binding: t -*- 2 | 3 | (package "eask" 4 | "0.12.1" 5 | "Core Eask APIs, for Eask CLI development") 6 | 7 | (website-url "https://github.com/emacs-eask/eask") 8 | (keywords "lisp" "eask" "api") 9 | 10 | (package-file "eask.el") 11 | 12 | (script "test" "echo \"Error: no test specified\" && exit 1") 13 | 14 | (files "eask-api.el" 15 | "eask-core.el") 16 | 17 | (source 'gnu) 18 | (source 'melpa) 19 | (source 'jcs-elpa) 20 | 21 | (depends-on "emacs" "26.1") 22 | 23 | (setq network-security-level 'low) ; see https://github.com/jcs090218/setup-emacs-windows/issues/156#issuecomment-932956432 24 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | > [!IMPORTANT] 2 | > 3 | > The `CHANGELOG.md` is no longer being used since the release should follow the `emacs-eask/cli`'s version. 4 | 5 | # Change Log 6 | 7 | All notable changes to this project will be documented in this file. 8 | 9 | Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. 10 | 11 | 12 | ## 0.1.1 (Unreleased) 13 | > Released N/A 14 | 15 | * Add `eask-api-core.el` ([`8a2b440`](../../commit/8a2b440398caf85750cc0a726a65c2a27e129a5d)) 16 | * Add more generate rules ([`515f9d5`](../../commit/515f9d5366e84aa6fd6c6f9fb3803eca9e7ec5f0)) 17 | * Add utility function `eask-api-check-filename` ([`d7a688b`](../../commit/d7a688b0d98d2a8e702c5710826433e94d99d3d5)) 18 | 19 | ## 0.1.0 20 | > Released Sep 13, 2022 21 | 22 | * Initial release 23 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMACS ?= emacs 2 | EASK ?= eask 3 | 4 | .PHONY: clean checkdoc lint package install compile test 5 | 6 | ci: clean package install compile 7 | 8 | build-source: 9 | @echo "Building source..." 10 | $(EASK) load "scripts/generate-source.el" --allow-error 11 | 12 | generate_badges_system: 13 | @echo "Generating system badges.." 14 | @$(EASK) load "scripts/generate-badges-system.el" 15 | 16 | package: 17 | @echo "Packaging..." 18 | $(EASK) package 19 | 20 | install: 21 | @echo "Installing..." 22 | $(EASK) install 23 | 24 | compile: 25 | @echo "Compiling..." 26 | $(EASK) compile 27 | 28 | test: 29 | @echo "Testing..." 30 | $(EASK) test ert ./test/*.el 31 | 32 | checkdoc: 33 | @echo "Run checkdoc..." 34 | $(EASK) lint checkdoc 35 | 36 | lint: 37 | @echo "Run package-lint..." 38 | $(EASK) lint package 39 | 40 | clean: 41 | $(EASK) clean all 42 | -------------------------------------------------------------------------------- /scripts/generate-badges-system.el: -------------------------------------------------------------------------------- 1 | ;;; generate-badges-system.el --- Generate SVG badges, system -*- lexical-binding: t -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | 5 | (load-file "./scripts/_prepare.el") 6 | (require 'url-handlers) 7 | 8 | (defconst svg-url-format 9 | "https://img.shields.io/badge/Emacs-%s-7F5AB6.svg?logo=gnu%%20emacs&logoColor=white" 10 | "Format to generate badges.") 11 | 12 | (defconst output-dir "./etc/badges/" 13 | "Where the badges store.") 14 | 15 | (ignore-errors (make-directory output-dir t)) 16 | 17 | ;; Emacs 18 | (let* ((url (format svg-url-format emacs-version)) 19 | (file (concat output-dir "emacs.svg"))) 20 | (message "Download SVG from `%s` to `%s`" url file) 21 | (url-copy-file url file t)) 22 | 23 | ;; Local Variables: 24 | ;; coding: utf-8 25 | ;; no-byte-compile: t 26 | ;; End: 27 | ;;; generate-badges-system.el ends here 28 | -------------------------------------------------------------------------------- /.github/workflows/system.yml: -------------------------------------------------------------------------------- 1 | name: System 2 | 3 | on: 4 | workflow_run: 5 | workflows: ["Build"] 6 | types: 7 | - completed 8 | workflow_dispatch: 9 | 10 | concurrency: 11 | group: ${{ github.workflow }}-${{ github.ref }} 12 | cancel-in-progress: true 13 | 14 | env: 15 | REPO_BADGES: 'jcs-emacs/badges' 16 | 17 | jobs: 18 | generate_badge: 19 | runs-on: ubuntu-latest 20 | steps: 21 | - uses: jcs090218/setup-emacs@master 22 | with: 23 | version: 30.2 24 | 25 | - uses: emacs-eask/setup-eask@master 26 | with: 27 | version: 'snapshot' 28 | 29 | - uses: actions/checkout@v6 30 | 31 | - name: Generate SVG badges (system) 32 | run: make generate_badges_system 33 | 34 | - name: Set git config 35 | run: | 36 | git config user.name github-actions 37 | git config user.email github-actions@github.com 38 | 39 | - name: Commit 40 | continue-on-error: true 41 | run: | 42 | git pull 43 | git add . 44 | git commit -m "Update SVG badges - SYSTEM" 45 | git push 46 | -------------------------------------------------------------------------------- /templates/source.el: -------------------------------------------------------------------------------- 1 | ;;; eask-core.el --- Core Eask APIs -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2022-2025 Shen, Jen-Chieh 4 | 5 | ;; This file is not part of GNU Emacs. 6 | 7 | ;; This program is free software: you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | ;; 22 | ;; Core Eask APIs 23 | ;; 24 | ;; This file is generated from a template file, see templates/source.el file. 25 | ;; 26 | 27 | ;;; Code: 28 | { SOURCE } 29 | 30 | (provide 'eask-core) 31 | ;; Local Variables: 32 | ;; coding: utf-8 33 | ;; no-byte-compile: t 34 | ;; End: 35 | ;;; eask-core.el ends here 36 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | schedule: 9 | - cron: '0 * * * *' 10 | workflow_dispatch: 11 | 12 | concurrency: 13 | group: ${{ github.workflow }}-${{ github.ref }} 14 | cancel-in-progress: true 15 | 16 | jobs: 17 | build: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - uses: actions/checkout@v6 21 | with: 22 | repository: emacs-eask/cli 23 | 24 | - name: Move lisp to HOME 25 | run: | 26 | mv lisp ~/lisp 27 | rm -rf ~/lisp/extern 28 | 29 | - uses: actions/checkout@v6 30 | 31 | - uses: jcs090218/setup-emacs@master 32 | with: 33 | version: 30.2 34 | 35 | - uses: emacs-eask/setup-eask@master 36 | with: 37 | version: 'snapshot' 38 | 39 | - name: Build source - eask-core.el 40 | continue-on-error: true 41 | run: 42 | make build-source 43 | 44 | - name: Set git config 45 | run: | 46 | git config user.name github-actions 47 | git config user.email github-actions@github.com 48 | 49 | - name: Push generated source 50 | continue-on-error: true 51 | run: | 52 | git pull 53 | git add . 54 | git commit -m "Update source, eask-core.el" 55 | git push 56 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_run: 5 | workflows: ["Build"] 6 | types: 7 | - completed 8 | pull_request: 9 | workflow_dispatch: 10 | 11 | concurrency: 12 | group: ${{ github.workflow }}-${{ github.ref }} 13 | cancel-in-progress: true 14 | 15 | jobs: 16 | test: 17 | runs-on: ${{ matrix.os }} 18 | continue-on-error: ${{ matrix.experimental }} 19 | strategy: 20 | fail-fast: false 21 | matrix: 22 | os: [ubuntu-latest, macos-latest, windows-latest] 23 | emacs-version: 24 | - 26.3 25 | - 27.2 26 | - 28.2 27 | - 29.4 28 | - 30.2 29 | experimental: [false] 30 | include: 31 | - os: ubuntu-latest 32 | emacs-version: snapshot 33 | experimental: true 34 | - os: macos-latest 35 | emacs-version: snapshot 36 | experimental: true 37 | - os: windows-latest 38 | emacs-version: snapshot 39 | experimental: true 40 | exclude: 41 | - os: macos-latest 42 | emacs-version: 26.3 43 | - os: macos-latest 44 | emacs-version: 27.2 45 | 46 | steps: 47 | - uses: actions/checkout@v6 48 | 49 | - uses: jcs090218/setup-emacs@master 50 | with: 51 | version: ${{ matrix.emacs-version }} 52 | 53 | - uses: emacs-eask/setup-eask@master 54 | with: 55 | version: 'snapshot' 56 | 57 | - name: Run tests 58 | run: 59 | make ci 60 | -------------------------------------------------------------------------------- /scripts/_prepare.el: -------------------------------------------------------------------------------- 1 | ;;; _prepare.el --- Prepration -*- lexical-binding: t -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | 5 | (require 'thingatpt) 6 | (require 'json) 7 | (require 'subr-x) 8 | 9 | (defconst from-eask (bound-and-true-p eask-homedir) 10 | "It's non-nil if the environment is identified as CI.") 11 | 12 | ;; 13 | ;;; Util 14 | 15 | (defun locate-project-file (path) 16 | "Locate the project by enviornment." 17 | (let ((path (concat (if from-eask "./" "../") path))) 18 | (expand-file-name path))) 19 | 20 | (defun s-replace (old new s) 21 | "..." 22 | (declare (pure t) (side-effect-free t)) 23 | (replace-regexp-in-string (regexp-quote old) new s t t)) 24 | 25 | (defun s-count-matches (regexp s &optional start end) 26 | "..." 27 | (declare (side-effect-free t)) 28 | (save-match-data 29 | (with-temp-buffer 30 | (insert s) 31 | (goto-char (point-min)) 32 | (count-matches regexp (or start 1) (or end (point-max)))))) 33 | 34 | (defun let-kill-line () 35 | "Kill current line." 36 | (goto-char (line-beginning-position)) (kill-line 1)) 37 | 38 | (defun let-kill-scope () 39 | "Kill a scope." 40 | (interactive) 41 | (let ((beg (point))) 42 | (forward-sexp) 43 | (kill-region beg (point)))) 44 | 45 | (defun let-clean-newlines () 46 | "Make sure only one newline between blocks." 47 | (let* ((str (buffer-string)) 48 | (str (s-replace "\n\n\n" "\n\n" str))) 49 | (erase-buffer) 50 | (insert str))) 51 | 52 | ;; Local Variables: 53 | ;; coding: utf-8 54 | ;; no-byte-compile: t 55 | ;; End: 56 | ;;; _prepare.el ends here 57 | -------------------------------------------------------------------------------- /eask.el: -------------------------------------------------------------------------------- 1 | ;;; eask.el --- Core Eask APIs, for Eask CLI development -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2023-2025 Shen, Jen-Chieh 4 | 5 | ;; Author: Shen, Jen-Chieh 6 | ;; Maintainer: Shen, Jen-Chieh 7 | ;; URL: https://github.com/emacs-eask/eask 8 | ;; Version: 0.12.1 9 | ;; Package-Requires: ((emacs "26.1")) 10 | ;; Keywords: lisp eask api 11 | 12 | ;; This file is not part of GNU Emacs. 13 | 14 | ;; This program is free software: you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | ;; 29 | ;; This package provides everything you need for Eask CLI development. 30 | ;; 31 | ;; - auto-completion 32 | ;; - eldoc 33 | ;; - code navigation 34 | ;; - peek definition 35 | ;; 36 | ;; Generally, you would not want to call any of these functions or use any of 37 | ;; these variables from your Emacs editor environment. Unless you are extending 38 | ;; Eask's core functionalities. 39 | ;; 40 | ;; (@* "Usage" ) 41 | ;; 42 | ;; Call the following whenever you need the to know Eask's API, 43 | ;; 44 | ;; (require 'eask-core) 45 | ;; 46 | ;; Or enable it when the project is a valid Eask project, 47 | ;; 48 | ;; (add-hook 'emacs-lisp-hook #'eask-api-setup) 49 | ;; 50 | ;; For more information, please visit our repo page 51 | ;; https://github.com/emacs-eask/eask-api 52 | ;; 53 | 54 | ;;; Code: 55 | 56 | (defgroup eask nil 57 | "Core Eask APIs, for Eask CLI development." 58 | :prefix "eask-" 59 | :group 'tool 60 | :link '(url-link :tag "Repository" "https://github.com/emacs-eask/eask")) 61 | 62 | (require 'eask-api) 63 | 64 | (provide 'eask) 65 | ;;; eask.el ends here 66 | -------------------------------------------------------------------------------- /etc/badges/emacs.svg: -------------------------------------------------------------------------------- 1 | Emacs: 30.2Emacs30.2 -------------------------------------------------------------------------------- /eask-api.el: -------------------------------------------------------------------------------- 1 | ;;; eask-api.el --- Core Eask APIs -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2022-2025 Shen, Jen-Chieh 4 | 5 | ;; This file is not part of GNU Emacs. 6 | 7 | ;; This program is free software: you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | ;; 22 | ;; This is the core APIs of the Eask CLI, a tool for building and testing 23 | ;; Emacs Lisp packages 24 | ;; 25 | 26 | ;;; Code: 27 | 28 | (require 'cl-lib) 29 | (require 'subr-x) 30 | 31 | (defcustom eask-api-strict-p t 32 | "Set to nil if you want to load Eask API whenever it's possible." 33 | :type 'boolean 34 | :group 'eask) 35 | 36 | (defcustom eask-api-executable nil 37 | "Executable to eask-cli." 38 | :type 'string 39 | :group 'eask) 40 | 41 | ;; 42 | ;;; Externals 43 | 44 | (declare-function project-root "project" (project)) 45 | 46 | ;; 47 | ;;; Compat 48 | 49 | (defun eask-api-project-root () 50 | "Return project root." 51 | (if (fboundp #'project-root) 52 | (ignore-errors (project-root (project-current))) 53 | (cdr (project-current)))) 54 | 55 | ;; 56 | ;;; Executable 57 | 58 | (defun eask-api-executable () 59 | "Return Eask CLI path." 60 | (or eask-api-executable (executable-find "eask"))) 61 | 62 | (defun eask-api-executable-p () 63 | "Return t if Eask CLI is executed from executable and not shell script." 64 | (not 65 | (string= "bin" 66 | (file-name-nondirectory 67 | (directory-file-name (file-name-directory (eask-api-executable))))))) 68 | 69 | (defun eask-api-lisp-root () 70 | "Return Eask CLI `lisp' path." 71 | (file-name-as-directory 72 | (expand-file-name "lisp" 73 | (if (eask-api-executable-p) 74 | (eask-api-executable) 75 | (expand-file-name "../../" (eask-api-executable)))))) 76 | 77 | ;; 78 | ;;; Entry 79 | 80 | (defun eask-api-check-filename (name) 81 | "Return non-nil if NAME is a valid Eask-file." 82 | (when-let* ((name (file-name-nondirectory (directory-file-name name))) 83 | (prefix (cond ((string-prefix-p "Easkfile" name) "Easkfile") 84 | ((string-prefix-p "Eask" name) "Eask")))) 85 | (let ((suffix (car (split-string name prefix t)))) 86 | (or (null suffix) 87 | (string-match-p "^[.][.0-9]*$" suffix))))) 88 | 89 | (defun eask-api-files (&optional dir) 90 | "Return a list of Eask files. 91 | 92 | If argument DIR is nil, we use `default-directory' instead. 93 | 94 | This is a simpliy version of `eask--all-files' function." 95 | (setq dir (or dir default-directory)) 96 | (let ((files (or 97 | ;; Easkfile is common file for Eask development! 98 | (directory-files dir t "Easkfile[.0-9]*\\'") 99 | ;; Allow regular Eask project!? 100 | (unless eask-api-strict-p 101 | (directory-files dir t "Eask[.0-9]*\\'"))))) 102 | (cl-remove-if #'file-directory-p files))) 103 | 104 | ;;;###autoload 105 | (defun eask-api-setup () 106 | "Set up for `eask-api'. 107 | 108 | Since this is the entry, we only check for the project root and current 109 | workspace. The full version uses function `locate-dominating-file' to search 110 | for Eask-files, but we don't want to do that for our entry." 111 | (let* ((proj-root (eask-api-project-root)) 112 | (e-default (eask-api-files default-directory)) 113 | (e-project (unless e-default (eask-api-files proj-root))) 114 | (root (if e-default default-directory proj-root)) 115 | (files (or e-default e-project))) 116 | (when files 117 | (require 'eask-core) 118 | (list :root root :files files)))) 119 | 120 | (provide 'eask-api) 121 | ;;; eask-api.el ends here 122 | -------------------------------------------------------------------------------- /scripts/generate-source.el: -------------------------------------------------------------------------------- 1 | ;;; generate-source.el --- Generate source -*- lexical-binding: t; -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | 5 | (load-file "./scripts/_prepare.el") 6 | 7 | (defconst let-eask-lisp-path "~/lisp/" 8 | "The path points to the Eask's lisp directory.") 9 | 10 | ;; 11 | ;;; Generate it 12 | 13 | (with-current-buffer (find-file (locate-project-file "eask-core.el")) 14 | (erase-buffer) 15 | (insert-file-contents (locate-project-file "templates/source.el")) 16 | 17 | ;; navigate to insertion point 18 | (goto-char (point-min)) 19 | (search-forward "{ SOURCE }") 20 | (let-kill-line) 21 | 22 | (let* ((files (directory-files-recursively let-eask-lisp-path "[.]el$")) 23 | ;; Sort `_prepare.el' to the top! 24 | (files (sort files 25 | (lambda (file1 &rest _) 26 | (string-prefix-p "_" (file-name-nondirectory file1))))) 27 | ;; Exclude `extern' directory! 28 | (files (cl-remove-if (lambda (file1) 29 | (string-match-p "/lisp/extern/" file1)) 30 | files))) 31 | (dolist (path files) 32 | (message "Processing file %s..." path) 33 | (insert "\n") 34 | (insert ";; " path) 35 | (insert "\n") 36 | (insert 37 | (with-temp-buffer 38 | (insert-file-contents path) 39 | (goto-char (point-min)) 40 | (let ((forward-str "")) 41 | (while (not (eobp)) 42 | (let ((line (thing-at-point 'line)) 43 | (start (point))) 44 | (cond ((or (string-prefix-p ";;" line) 45 | (null line) 46 | (string-empty-p (string-trim line))) 47 | (let-kill-line)) 48 | ;; skip these 49 | ((or (string-prefix-p "(defclass " line) 50 | (string-prefix-p "(defun " line) 51 | (string-prefix-p "(defconst " line)) 52 | (insert "\n") 53 | (forward-sexp) 54 | (insert "\n\n") 55 | (beginning-of-line)) 56 | ;; Move macro to the top, avoid macro defined too late error. 57 | ((or (string-prefix-p "(defvar " line) 58 | (string-prefix-p "(defcustom " line) 59 | (string-prefix-p "(declare-function " line) 60 | (string-prefix-p "(defmacro " line)) 61 | (forward-sexp) 62 | (let* ((block (buffer-substring start (1+ (point)))) 63 | ;; If not end with newline, add a newline 64 | (end-with-nl (string-suffix-p "\n" block)) 65 | ;; Have newline in this block/scope. 66 | (have-nl (<= 2 (s-count-matches "\n" block))) 67 | ;; If there are more than 2 newlines, we want to 68 | ;; add newline on both ends. 69 | (nl-str (if have-nl "\n" ""))) 70 | (setq forward-str (concat forward-str 71 | nl-str ; Add newline in front. 72 | block 73 | (if end-with-nl "" "\n") 74 | nl-str))) ; Add newline behind. 75 | (delete-region start (1+ (point))) 76 | (beginning-of-line)) 77 | ;; Add require to avoid compile warnings. 78 | ((or (string-prefix-p "(require " line)) 79 | (forward-sexp) 80 | (when-let* ((params-count (s-count-matches " " (buffer-substring start (point)))) 81 | ((= params-count 1))) 82 | (forward-char -1) 83 | (insert " nil t")) ; Add no-error flag 84 | (forward-line 1) 85 | (beginning-of-line)) 86 | ;; other scope, we kill the entire scope 87 | ((string-prefix-p "(" line) (let-kill-scope)) 88 | ;; kill a line for everything else 89 | (t 90 | (let-kill-line))))) 91 | (goto-char (point-min)) 92 | (insert forward-str)) 93 | (buffer-string))))) 94 | ;; Make sure only one newline between each section. 95 | (let-clean-newlines) 96 | (save-buffer)) 97 | 98 | ;;; generate-source.el ends here 99 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 2 | [![JCS-ELPA](https://raw.githubusercontent.com/jcs-emacs/badges/master/elpa/v/eask.svg)](https://jcs-emacs.github.io/jcs-elpa/#/eask) 3 | [![MELPA](https://melpa.org/packages/eask-badge.svg)](https://melpa.org/#/eask) 4 | [![MELPA Stable](https://stable.melpa.org/packages/eask-badge.svg)](https://stable.melpa.org/#/eask) 5 | Emacs 6 | 7 | 8 | 9 | # eask 10 | > Core Eask APIs, for Eask CLI development 11 | 12 | [![Build](https://github.com/emacs-eask/eask/actions/workflows/build.yml/badge.svg)](https://github.com/emacs-eask/eask/actions/workflows/build.yml) 13 | [![CI](https://github.com/emacs-eask/eask/actions/workflows/test.yml/badge.svg)](https://github.com/emacs-eask/eask/actions/workflows/test.yml) 14 | [![System](https://github.com/emacs-eask/eask/actions/workflows/system.yml/badge.svg)](https://github.com/emacs-eask/eask/actions/workflows/system.yml) 15 | 16 | The goal of this package is to provide function signatures so you can 17 | develop Eask with your elisp environment. Few important feature that 18 | this package can do: 19 | 20 | 1. Provide auto-completion with `capf` (`auto-complete`, `company`, `corfu`, etc) 21 | 2. Provide function signatures and display arglist (`eldoc`) 22 | 23 | Generally, you would not want to call any of these functions or use any of 24 | these variables from your Emacs editor environment. Unless you are extending 25 | Eask's core functionalities. 26 | 27 | > [!NOTE] 28 | > 29 | > The core of this file (`eask-core.el`) is generated from the [emacs-eask/cli][]; therefore, please avoid directly modifying its contents in this repository! 30 | 31 | ## 🔨 Usage 32 | 33 | Call the following whenever you need to know Eask's API. 34 | 35 | ```elisp 36 | (require 'eask-core) 37 | ``` 38 | 39 | Or enable it when the project is a valid Eask project, 40 | 41 | ```elisp 42 | (add-hook 'emacs-lisp-hook #'eask-api-setup) 43 | ``` 44 | 45 | ## 🔧 Customization 46 | 47 | ### 🧪 Variables 48 | 49 | - `eask-api-strict-p` - Set to nil if you want to load Eask API whenever it's possible. 50 | 51 | ## 🛠️ Contribute 52 | 53 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) 54 | [![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple?logo=gnuemacs&logoColor=white)](https://github.com/bbatsov/emacs-lisp-style-guide) 55 | [![Donate on paypal](https://img.shields.io/badge/paypal-donate-1?logo=paypal&color=blue)](https://www.paypal.me/jcs090218) 56 | [![Become a patron](https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon)](https://www.patreon.com/jcs090218) 57 | 58 | If you would like to contribute to this project, you may either 59 | clone and make pull requests to this repository. Or you can 60 | clone the project and establish your own branch of this tool. 61 | Any methods are welcome! 62 | 63 | ### 🔬 Development 64 | 65 | To run the test locally, you will need the following tools: 66 | 67 | - [Eask](https://emacs-eask.github.io/) 68 | - [Make](https://www.gnu.org/software/make/) (optional) 69 | 70 | Install all dependencies and development dependencies: 71 | 72 | ```sh 73 | eask install-deps --dev 74 | ``` 75 | 76 | To test the package's installation: 77 | 78 | ```sh 79 | eask package 80 | eask install 81 | ``` 82 | 83 | To test compilation: 84 | 85 | ```sh 86 | eask compile 87 | ``` 88 | 89 | **🪧 The following steps are optional, but we recommend you follow these lint results!** 90 | 91 | The built-in `checkdoc` linter: 92 | 93 | ```sh 94 | eask lint checkdoc 95 | ``` 96 | 97 | The standard `package` linter: 98 | 99 | ```sh 100 | eask lint package 101 | ``` 102 | 103 | *📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.* 104 | 105 | ## ⚜️ License 106 | 107 | This program is free software; you can redistribute it and/or modify 108 | it under the terms of the GNU General Public License as published by 109 | the Free Software Foundation, either version 3 of the License, or 110 | (at your option) any later version. 111 | 112 | This program is distributed in the hope that it will be useful, 113 | but WITHOUT ANY WARRANTY; without even the implied warranty of 114 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 115 | GNU General Public License for more details. 116 | 117 | You should have received a copy of the GNU General Public License 118 | along with this program. If not, see . 119 | 120 | See [`LICENSE`](./LICENSE.txt) for details. 121 | 122 | 123 | 124 | [emacs-eask/cli]: https://github.com/emacs-eask/cli 125 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------