├── Makefile ├── README.org ├── org-notely.el ├── makem.sh └── LICENSE /Makefile: -------------------------------------------------------------------------------- 1 | # * makem.sh/Makefile --- Script to aid building and testing Emacs Lisp packages 2 | 3 | # This Makefile is from the makem.sh repo: . 4 | 5 | # * Arguments 6 | 7 | # For consistency, we use only var=val options, not hyphen-prefixed options. 8 | 9 | # NOTE: I don't like duplicating the arguments here and in makem.sh, 10 | # but I haven't been able to find a way to pass arguments which 11 | # conflict with Make's own arguments through Make to the script. 12 | # Using -- doesn't seem to do it. 13 | 14 | ifdef auto-install 15 | AUTO_INSTALL = "--auto-install" 16 | endif 17 | 18 | ifdef sandbox 19 | SANDBOX = "--sandbox" 20 | endif 21 | 22 | ifdef sandbox-dir 23 | SANDBOX_DIR = "--sandbox-dir" "$(sandbox-dir)" 24 | endif 25 | 26 | ifdef debug 27 | DEBUG = "--debug" 28 | endif 29 | 30 | # ** Verbosity 31 | 32 | # Since the "-v" in "make -v" gets intercepted by Make itself, we have 33 | # to use a variable. 34 | 35 | verbose = $(v) 36 | 37 | ifneq (,$(findstring vv,$(verbose))) 38 | VERBOSE = "-vv" 39 | else ifneq (,$(findstring v,$(verbose))) 40 | VERBOSE = "-v" 41 | endif 42 | 43 | # * Rules 44 | 45 | # TODO: Handle cases in which "test" or "tests" are called and a 46 | # directory by that name exists, which can confuse Make. 47 | 48 | %: 49 | @./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(SANDBOX_DIR) $(AUTO_INSTALL) $(@) 50 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: org-notely 2 | 3 | #+PROPERTY: LOGGING nil 4 | 5 | # Note: This readme works with the org-make-toc package, which automatically updates the table of contents. 6 | 7 | # [[https://melpa.org/#/package-name][file:https://melpa.org/packages/org-notely-badge.svg]] [[https://stable.melpa.org/#/package-name][file:https://stable.melpa.org/packages/org-notely-badge.svg]] 8 | 9 | This package makes it easy to quickly take a note in a new heading displayed in a new, indirect buffer. It's similar to Org's built-in capture functionality, but it's not limited to one capture "session", so you can pop up a new note at any time, without interfering with other activities in Emacs. 10 | 11 | For convenience, the new, indirect buffer has =RET= bound to a command that renames the buffer according to the heading when pressed with point on the heading, and an inactive timestamp is automatically inserted at the beginning of the note. 12 | 13 | Used with [[https://github.com/alphapapa/yequake][Yequake]], it can also pop open a new Emacs frame. 14 | 15 | # * Screenshots 16 | # 17 | # This screenshot shows how to frobnicate the fripulator: 18 | # 19 | # [[screenshot1.png]] 20 | 21 | * Contents :noexport: 22 | :PROPERTIES: 23 | :TOC: this 24 | :END: 25 | - [[#installation][Installation]] 26 | - [[#usage][Usage]] 27 | - [[#changelog][Changelog]] 28 | 29 | * Installation 30 | :PROPERTIES: 31 | :TOC: 0 32 | :END: 33 | 34 | # ** MELPA 35 | 36 | # If you installed from MELPA, you're done. 37 | 38 | ** Quelpa 39 | 40 | Installing with [[https://framagit.org/steckerhalter/quelpa][Quelpa]] is easy: 41 | 42 | 1. Install [[https://github.com/quelpa/quelpa-use-package#installation][quelpa-use-package]] (which can be installed directly from MELPA). 43 | 2. Add this form to your init file: 44 | 45 | #+BEGIN_SRC elisp 46 | (use-package org-notely 47 | :quelpa (org-notely :fetcher github :repo "alphapapa/org-notely")) 48 | #+END_SRC 49 | 50 | * Usage 51 | :PROPERTIES: 52 | :TOC: 0 53 | :END: 54 | 55 | 1. Run =M-x customize-group RET org-notely RET= and configure the options =org-notely-file= and =org-notely-outline-path= according to your preferences. 56 | 2. =M-x org-notely RET= to pop up a new note buffer at the configured place. 57 | 3. =M-x org-notely-here RET= to pop up a new note buffer under the heading at point. 58 | 59 | ** Tips 60 | 61 | + The command ~org-notely~ accepts a ~point-marker~ argument, so one could easily write a command to add a new heading to any other certain heading (similar to Org Capture, but without requiring advance configuration). 62 | 63 | *** Yequake 64 | 65 | Yequake makes it easy to display =org-notely= in a new Emacs frame. Here's an example configuration: 66 | 67 | #+BEGIN_SRC elisp 68 | (use-package yequake 69 | :custom 70 | (yequake-frames 71 | (list (cons "org-notely" 72 | (list (cons 'buffer-fns '(org-notely)) 73 | (cons 'width 0.25) 74 | (cons 'height 0.5)))))) 75 | #+END_SRC 76 | 77 | Then bind a global keyboard shortcut in your desktop environment to run this command, which pops up a new Emacs frame showing a new =org-notely= buffer: 78 | 79 | #+BEGIN_SRC sh 80 | emacsclient -n -e '(yequake-toggle "org-notely")' 81 | #+END_SRC 82 | 83 | This configuration uses [[https://github.com/alphapapa/org-sidebar][org-sidebar]] to display a list of =org-notely= notes, organized by month and year, next to the new-note buffer: 84 | 85 | #+BEGIN_SRC elisp 86 | (use-package yequake 87 | :custom 88 | (yequake-frames 89 | '(("org-notely" 90 | (buffer-fns (lambda () 91 | (find-file-noselect org-notely-file)) 92 | (lambda () 93 | (org-with-wide-buffer 94 | (org-global-cycle '(4)) 95 | (goto-char (org-find-olp '("Notes") 'this-buffer)) 96 | (org-cycle) 97 | (org-tree-to-indirect-buffer) 98 | (let ((org-super-agenda-date-format "%Y %B")) 99 | (org-sidebar-ql (current-buffer) 100 | '(regexp ".") 101 | :narrow t :sort 'date 102 | :super-groups '((:auto-ts)))) 103 | (goto-char (org-end-of-subtree)))) 104 | org-notely) 105 | (width . 0.25) 106 | (height . 0.5))))) 107 | #+END_SRC 108 | 109 | * Changelog 110 | :PROPERTIES: 111 | :TOC: 0 112 | :END: 113 | 114 | ** 0.1-pre 115 | 116 | Initial release. 117 | 118 | * Development 119 | :PROPERTIES: 120 | :TOC: ignore 121 | :END: 122 | 123 | Bug reports, feature requests, suggestions — /oh my/! 124 | 125 | * License 126 | :PROPERTIES: 127 | :TOC: ignore 128 | :END: 129 | 130 | GPLv3 131 | 132 | # Local Variables: 133 | # eval: (require 'org-make-toc) 134 | # before-save-hook: org-make-toc 135 | # org-export-with-properties: () 136 | # org-export-with-title: t 137 | # End: 138 | 139 | -------------------------------------------------------------------------------- /org-notely.el: -------------------------------------------------------------------------------- 1 | ;;; org-notely.el --- Pop to new Org headings for quick notetaking -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2020 Adam Porter 4 | 5 | ;; Author: Adam Porter 6 | ;; Url: https://github.com/alphapapa/org-notely 7 | ;; Version: 0.1-pre 8 | ;; Package-Requires: ((emacs "26.1") (org "9.0")) 9 | ;; Keywords: convenience, outlines 10 | 11 | ;;; License: 12 | 13 | ;; This program is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation, either version 3 of the License, or 16 | ;; (at your option) any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; You should have received a copy of the GNU General Public License 24 | ;; along with this program. If not, see . 25 | 26 | ;;; Commentary: 27 | 28 | ;; This package makes it easy to quickly take a note in a new heading 29 | ;; displayed in a new indirect buffer. It's similar to Org's built-in 30 | ;; capture functionality, but it's not limited to one capture 31 | ;; "session", so you can pop up a new note at any time, without 32 | ;; interfering with other activities in Emacs. 33 | 34 | ;; This is especially useful with `yequake' because, since 35 | ;; `org-notely' returns a buffer, it can be used in the `yequake' 36 | ;; `buffer-fns'. So with one, globally bound keystroke, a new Emacs 37 | ;; frame appears showing a new, empty Org heading, timestamped with 38 | ;; the current time, ready for taking notes. See 39 | ;; . 40 | 41 | ;; [2020-01-29 Wed 18:18] Renaming to org-notepad because I want to 42 | ;; expand its scope slightly beyond just popping up a new note. I 43 | ;; want it to pop up a "notely"-like window with a new, empty heading, 44 | ;; but also showing existing notes for easy access. I'm just 45 | ;; experimenting for now. 46 | 47 | ;; [2022-08-15 Mon 19:17] Renaming to org-notely, because org-notepad 48 | ;; doesn't seem distinctive enough (and according to my "market 49 | ;; research," can have some negative connotations, reminding users of 50 | ;; notepad.exe). 51 | 52 | ;;; Code: 53 | 54 | ;;;; Requirements 55 | 56 | (require 'cl-lib) 57 | (require 'org) 58 | 59 | ;;;; Variables 60 | 61 | ;;;; Customization 62 | 63 | (defgroup org-notely nil 64 | "Options for `org-notely'." 65 | :group 'org 66 | :link '(url-link "https://github.com/alphapapa/org-notely")) 67 | 68 | (defcustom org-notely-file "~/org/temp.org" 69 | "File to put new notes in." 70 | :type '(file :must-match t)) 71 | 72 | (defcustom org-notely-outline-path '("Notes") 73 | "Outline path where new notes are created." 74 | :type '(repeat string)) 75 | 76 | (defcustom org-notely-new-note-hook 77 | '(org-notely-rebind-ret org-notely-new-note-timestamp) 78 | "Hook called when new note is created. 79 | Called with point on the new heading. Each hook function should 80 | return with point in the same place, unless its purpose is to 81 | move point." 82 | :type 'hook) 83 | 84 | ;;;; Commands 85 | 86 | ;;;###autoload 87 | (cl-defun org-notely (&optional parent-marker &key (bury t)) 88 | "Insert a new subheading at PARENT-MARKER and show it in an indirect buffer. 89 | Returns the indirect buffer. In the indirect buffer, \"RET\" is 90 | bound to a function which renames the buffer to the first 91 | heading's name when point is on a heading. When BURY, the parent 92 | buffer is buried. 93 | 94 | Interactively, PARENT-MARKER is set according to 95 | `org-notely-file' and `org-notely-outline-path', which see." 96 | ;; FIXME: If two notes are made in the same clock minute, they're both shown in the indirect 97 | ;; buffer, because the name of the buffer is computed to be the same, because the first 98 | ;; time, the buffer name is computed to be just the timestamp and filename, and the second 99 | ;; time it's computed the same, even if the heading was modified before. Or something like 100 | ;; that. This is way harder than it should be. But this works well enough for now. 101 | (interactive 102 | (progn 103 | (set-buffer (or (get-file-buffer org-notely-file) 104 | (find-file-noselect org-notely-file))) 105 | (list (org-find-olp org-notely-outline-path 'this-buffer)))) 106 | ;; NOTE: We do not use `with-current-buffer' around the whole function. Trust me. 107 | (goto-char parent-marker) 108 | (if (save-excursion 109 | (goto-char (org-end-of-subtree)) 110 | (outline-back-to-heading) 111 | (nth 4 (org-heading-components))) 112 | (progn 113 | ;; Last heading is non-empty: insert a new heading. 114 | (org-insert-heading-respect-content) 115 | ;; TODO: Ensure the region is deactivated before demotion. 116 | (org-do-demote)) 117 | ;; Last heading is empty: go to it. 118 | (goto-char (org-end-of-subtree)) 119 | (outline-back-to-heading)) 120 | (when bury 121 | (bury-buffer (current-buffer))) 122 | (set-buffer (org-notely-tree-indirect-buffer)) 123 | (run-hooks 'org-notely-new-note-hook) 124 | (switch-to-buffer (current-buffer))) 125 | 126 | ;;;###autoload 127 | (cl-defun org-notely-here () 128 | ;; TODO: Integrate with Embark properly. See . 129 | "Make a new heading at point and show it in an indirect buffer." 130 | (interactive) 131 | (org-notely (save-excursion 132 | (org-back-to-heading) 133 | (point-marker)))) 134 | 135 | ;;;; Functions 136 | 137 | (defun org-notely-new-note-timestamp () 138 | "Insert timestamp and leave point in heading. 139 | For `org-notely-new-note-hook'." 140 | (end-of-line) 141 | (save-excursion 142 | (insert "\n\n+ ") 143 | (org-insert-time-stamp (current-time) 'with-hm 'inactive) 144 | (insert " "))) 145 | 146 | (defun org-notely-tree-indirect-buffer () 147 | "Return an indirect buffer narrowed to current subtree. 148 | Like `org-tree-to-indirect-buffer', but does what we need." 149 | (let* ((pos (point)) 150 | (buffer-name (generate-new-buffer-name 151 | (concat (or (nth 4 (org-heading-components)) "") "::" 152 | (file-name-nondirectory (buffer-file-name (current-buffer)))))) 153 | (buffer (make-indirect-buffer (current-buffer) buffer-name 'clone))) 154 | (with-current-buffer buffer 155 | ;; NOTE: Point must be set again in the indirect buffer. I don't know why. 156 | (goto-char pos) 157 | (org-narrow-to-subtree) 158 | (current-buffer)))) 159 | 160 | (defun org-notely-rebind-ret () 161 | "Bind RET in current buffer to a special function in a copied keymap. 162 | The function renames the buffer to the first heading's name when 163 | point is on a heading, then calls `org-notely-goto-entry-end'." 164 | (let* ((map (copy-keymap (current-local-map))) 165 | (orig-def (lookup-key map (kbd "RET") t)) 166 | (docstring (format "With point on a heading, rename buffer accordingly, then call `org-notely-goto-entry-end'. 167 | Otherwise, call %s." 168 | orig-def)) 169 | (fn `(lambda () 170 | ,docstring 171 | (interactive) 172 | (if (save-excursion 173 | (beginning-of-line) 174 | (org-at-heading-p)) 175 | (progn 176 | (org-notely-rename-buffer) 177 | (org-notely-goto-entry-end)) 178 | (funcall #',orig-def))))) 179 | (define-key map (kbd "RET") fn) 180 | (use-local-map map))) 181 | 182 | (defun org-notely-goto-entry-end () 183 | "Move point to end of entry content." 184 | (goto-char (org-entry-end-position)) 185 | (when (re-search-backward (rx (not space)) (org-entry-beginning-position) t) 186 | (end-of-line))) 187 | 188 | (defun org-notely-rename-buffer () 189 | "Rename current buffer based on first heading in buffer." 190 | (interactive) 191 | (save-excursion 192 | (goto-char (point-min)) 193 | (unless (org-at-heading-p) 194 | (outline-next-heading)) 195 | (let* ((buffer (or (buffer-base-buffer (current-buffer)) 196 | (current-buffer))) 197 | (file-name (file-name-nondirectory (buffer-file-name buffer)))) 198 | (rename-buffer (concat (nth 4 (org-heading-components)) "::" file-name))))) 199 | 200 | ;;;; Footer 201 | 202 | (provide 'org-notely) 203 | 204 | ;;; org-notely.el ends here 205 | -------------------------------------------------------------------------------- /makem.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # * makem.sh --- Script to aid building and testing Emacs Lisp packages 4 | 5 | # https://github.com/alphapapa/makem.sh 6 | 7 | # * Commentary: 8 | 9 | # makem.sh is a script helps to build, lint, and test Emacs Lisp 10 | # packages. It aims to make linting and testing as simple as possible 11 | # without requiring per-package configuration. 12 | 13 | # It works similarly to a Makefile in that "rules" are called to 14 | # perform actions such as byte-compiling, linting, testing, etc. 15 | 16 | # Source and test files are discovered automatically from the 17 | # project's Git repo, and package dependencies within them are parsed 18 | # automatically. 19 | 20 | # Output is simple: by default, there is no output unless errors 21 | # occur. With increasing verbosity levels, more detail gives positive 22 | # feedback. Output is colored by default to make reading easy. 23 | 24 | # When desired, emacs-sandbox.sh can be used as a backend, which 25 | # allows package dependencies to be installed automatically into a 26 | # clean Emacs "sandbox" configuration without affecting the 27 | # developer's personal configuration. This is especially helpful when 28 | # upstream dependencies may have released new versions that differ 29 | # from those installed in the developer's personal configuration. See 30 | # . 31 | 32 | # * License: 33 | 34 | # This program is free software; you can redistribute it and/or modify 35 | # it under the terms of the GNU General Public License as published by 36 | # the Free Software Foundation, either version 3 of the License, or 37 | # (at your option) any later version. 38 | 39 | # This program is distributed in the hope that it will be useful, 40 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 41 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42 | # GNU General Public License for more details. 43 | 44 | # You should have received a copy of the GNU General Public License 45 | # along with this program. If not, see . 46 | 47 | # * Functions 48 | 49 | function usage { 50 | cat <. 87 | 88 | -s, --sandbox Run Emacs with emacs-sandbox.sh in a temporary 89 | directory (removing directory on exit). 90 | -S, --sandbox-dir DIR Use DIR for the sandbox directory (leaving it 91 | on exit). Implies -s. 92 | --auto-install Automatically install package dependencies. 93 | -i, --install PACKAGE Install PACKAGE before running rules. 94 | 95 | Source files are automatically discovered from git, or may be 96 | specified with options. 97 | 98 | Package dependencies are discovered from "Package-Requires" headers in 99 | source files and from a Cask file. 100 | EOF 101 | } 102 | 103 | # ** Elisp 104 | 105 | # These functions return a path to an elisp file which can be loaded 106 | # by Emacs on the command line with -l or --load. 107 | 108 | function elisp-buttercup-file { 109 | # The function buttercup-run, which is called by buttercup-run-discover, 110 | # signals an error if it can't find any Buttercup test suites. We don't 111 | # want that to be an error, so we define advice which ignores that error. 112 | local file=$(mktemp) 113 | cat >$file <$file <$file <&1) 178 | fi 179 | 180 | output_file=$(mktemp) 181 | $emacs_command -Q $batch_arg \ 182 | --load=$package_initialize_file \ 183 | -L "$load_path" \ 184 | "$@" \ 185 | &>$output_file 186 | 187 | exit=$? 188 | [[ $exit != 0 ]] && debug "Emacs exited non-zero: $exit" 189 | if [[ $verbose -gt 1 || $exit != 0 ]] 190 | then 191 | cat $output_file 192 | fi 193 | rm -f $output_file 194 | 195 | return $exit 196 | } 197 | 198 | # ** Compilation 199 | 200 | function batch-byte-compile { 201 | debug "batch-byte-compile: ERROR-ON-WARN:$compile_error_on_warn FILES:$@" 202 | 203 | [[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)") 204 | 205 | run_emacs \ 206 | "${error_on_warn[@]}" \ 207 | --funcall batch-byte-compile \ 208 | "$@" 209 | } 210 | 211 | # ** Files 212 | 213 | function project-elisp-files { 214 | # Echo list of Elisp files in project. 215 | git ls-files 2>/dev/null | egrep "\.el$" | exclude-files 216 | } 217 | 218 | function project-source-files { 219 | # Echo list of Elisp files that are not tests. 220 | project-elisp-files | egrep -v "$test_files_regexp" | feature-files 221 | } 222 | 223 | function project-test-files { 224 | # Echo list of Elisp test files. 225 | project-elisp-files | egrep "$test_files_regexp" 226 | } 227 | 228 | function exclude-files { 229 | # Filter out paths (STDIN) which should be excluded by default. 230 | egrep -v "(/\.cask/|-autoloads.el|.dir-locals)" 231 | } 232 | 233 | function feature-files { 234 | # Read paths on STDIN and echo ones that (provide 'a-feature). 235 | while read path 236 | do 237 | debug "PATH: $path" 238 | egrep "^\\(provide '" "$path" &>/dev/null \ 239 | && echo "$path" 240 | done 241 | } 242 | 243 | function load-files-args { 244 | # For file in $@, echo "--load $file". 245 | for file in "$@" 246 | do 247 | printf -- '--load %q ' "$file" 248 | done 249 | } 250 | 251 | function files_args { 252 | # For file in STDIN, echo "$file". 253 | while read file 254 | do 255 | printf -- '%q ' "$file" 256 | done 257 | } 258 | 259 | function test-files-p { 260 | # Return 0 if $project_test_files is non-empty. 261 | [[ "${project_test_files[@]}" ]] 262 | } 263 | 264 | function buttercup-tests-p { 265 | # Return 0 if Buttercup tests are found. 266 | test-files-p || die "No tests found." 267 | debug "Checking for Buttercup tests..." 268 | 269 | grep "(require 'buttercup)" "${project_test_files[@]}" &>/dev/null 270 | } 271 | 272 | function ert-tests-p { 273 | # Return 0 if ERT tests are found. 274 | test-files-p || die "No tests found." 275 | debug "Checking for ERT tests..." 276 | 277 | # We check for this rather than "(require 'ert)", because ERT may 278 | # already be loaded in Emacs and might not be loaded with 279 | # "require" in a test file. 280 | grep "(ert-deftest" "${project_test_files[@]}" &>/dev/null 281 | } 282 | 283 | function dependencies { 284 | # Echo list of package dependencies. 285 | 286 | # Search package headers. 287 | egrep '^;; Package-Requires: ' $(project-source-files) $(project-test-files) \ 288 | | egrep -o '\([^([:space:]][^)]*\)' \ 289 | | egrep -o '^[^[:space:])]+' \ 290 | | sed -r 's/\(//g' \ 291 | | egrep -v '^emacs$' # Ignore Emacs version requirement. 292 | 293 | # Search Cask file. 294 | if [[ -r Cask ]] 295 | then 296 | egrep '\(depends-on "[^"]+"' Cask \ 297 | | sed -r -e 's/\(depends-on "([^"]+)".*/\1/g' 298 | fi 299 | } 300 | 301 | # ** Utility 302 | 303 | function cleanup { 304 | # Remove temporary paths (${temp_paths[@]}). 305 | 306 | for path in "${temp_paths[@]}" 307 | do 308 | if [[ $debug ]] 309 | then 310 | debug "Debugging enabled: not deleting temporary path: $path" 311 | elif [[ -r $path ]] 312 | then 313 | rm -rf "$path" 314 | else 315 | debug "Temporary path doesn't exist, not deleting: $path" 316 | fi 317 | done 318 | } 319 | 320 | function echo_color { 321 | # This allows bold, italic, etc. without needing a function for 322 | # each variation. 323 | local color_code="COLOR_$1" 324 | shift 325 | 326 | if [[ $color ]] 327 | then 328 | echo -e "${!color_code}${@}${COLOR_off}" 329 | else 330 | echo "$@" 331 | fi 332 | } 333 | function debug { 334 | if [[ $debug ]] 335 | then 336 | function debug { 337 | echo_color yellow "DEBUG ($(ts)): $@" >&2 338 | } 339 | debug "$@" 340 | else 341 | function debug { 342 | true 343 | } 344 | fi 345 | } 346 | function error { 347 | echo_color red "ERROR ($(ts)): $@" >&2 348 | ((errors++)) 349 | return 1 350 | } 351 | function die { 352 | [[ $@ ]] && error "$@" 353 | exit $errors 354 | } 355 | function log { 356 | echo "LOG ($(ts)): $@" >&2 357 | } 358 | function log_color { 359 | local color=$1 360 | shift 361 | echo_color $color "LOG ($(ts)): $@" >&2 362 | } 363 | function success { 364 | if [[ $verbose -ge 2 ]] 365 | then 366 | log_color green "$@" >&2 367 | fi 368 | } 369 | function verbose { 370 | # $1 is the verbosity level, rest are echoed when appropriate. 371 | if [[ $verbose -ge $1 ]] 372 | then 373 | [[ $1 -eq 1 ]] && local color=blue 374 | [[ $1 -ge 2 ]] && local color=cyan 375 | 376 | shift 377 | log_color $color "$@" >&2 378 | fi 379 | } 380 | 381 | function ts { 382 | date "+%Y-%m-%d %H:%M:%S" 383 | } 384 | 385 | # * Rules 386 | 387 | # These functions are intended to be called as rules, like a Makefile. 388 | 389 | function all { 390 | verbose 1 "Running all rules..." 391 | 392 | lint 393 | tests 394 | } 395 | 396 | function compile { 397 | [[ $compile ]] || return 0 398 | unset compile # Only compile once. 399 | 400 | verbose 1 "Compiling..." 401 | debug "Byte-compile files: ${project_byte_compile_files[@]}" 402 | 403 | batch-byte-compile "${project_byte_compile_files[@]}" \ 404 | && success "Compiling finished without errors." \ 405 | || error "Compilation failed." 406 | } 407 | 408 | function batch { 409 | # Run Emacs with $batch_args and with project source and test files loaded. 410 | verbose 1 "Executing Emacs with arguments: ${batch_args[@]}" 411 | 412 | run_emacs \ 413 | $(load-files-args "${project_source_files[@]}" "${project_test_files[@]}") \ 414 | "${batch_args[@]}" 415 | } 416 | 417 | function interactive { 418 | # Run Emacs interactively. Most useful with --sandbox and --auto-install. 419 | unset batch_arg 420 | run_emacs \ 421 | $(load-files-args "${project_source_files[@]}" "${project_test_files[@]}") 422 | batch_arg="--batch" 423 | } 424 | 425 | function lint { 426 | verbose 1 "Linting..." 427 | 428 | lint-checkdoc 429 | lint-compile 430 | lint-package 431 | } 432 | 433 | function lint-checkdoc { 434 | verbose 1 "Linting checkdoc..." 435 | 436 | local checkdoc_file="$(elisp-checkdoc-file)" 437 | temp_paths+=("$checkdoc_file") 438 | 439 | run_emacs \ 440 | --load="$checkdoc_file" \ 441 | "${project_source_files[@]}" \ 442 | && success "Linting checkdoc finished without errors." \ 443 | || error "Linting checkdoc failed." 444 | } 445 | 446 | function lint-compile { 447 | verbose 1 "Linting compilation..." 448 | 449 | compile_error_on_warn=true 450 | batch-byte-compile "${project_byte_compile_files[@]}" \ 451 | && success "Linting compilation finished without errors." \ 452 | || error "Linting compilation failed." 453 | unset compile_error_on_warn 454 | } 455 | 456 | function lint-package { 457 | verbose 1 "Linting package..." 458 | 459 | run_emacs \ 460 | --load package-lint \ 461 | --funcall package-lint-batch-and-exit \ 462 | "${project_source_files[@]}" \ 463 | && success "Linting package finished without errors." \ 464 | || error "Linting package failed." 465 | } 466 | 467 | function tests { 468 | verbose 1 "Running all tests..." 469 | 470 | test-ert 471 | test-buttercup 472 | } 473 | 474 | function test-buttercup { 475 | buttercup-tests-p || return 0 476 | compile || die 477 | 478 | verbose 1 "Running Buttercup tests..." 479 | 480 | local buttercup_file="$(elisp-buttercup-file)" 481 | temp_paths+=("$buttercup_file") 482 | 483 | run_emacs \ 484 | --load buttercup \ 485 | --load "$buttercup_file" \ 486 | -f buttercup-run-discover \ 487 | && success "Buttercup tests finished without errors." \ 488 | || error "Buttercup tests failed." 489 | } 490 | 491 | function test-ert { 492 | ert-tests-p || return 0 493 | compile || die 494 | 495 | verbose 1 "Running ERT tests..." 496 | debug "Test files: ${project_test_files[@]}" 497 | 498 | run_emacs \ 499 | $(load-files-args "${project_test_files[@]}") \ 500 | -f ert-run-tests-batch-and-exit \ 501 | && success "ERT tests finished without errors." \ 502 | || error "ERT tests failed." 503 | } 504 | 505 | # * Defaults 506 | 507 | test_files_regexp='^(tests?|t)/' 508 | emacs_command="emacs" 509 | errors=0 510 | verbose=0 511 | compile=true 512 | batch_arg="--batch" 513 | 514 | # MAYBE: Disable color if not outputting to a terminal. (OTOH, the 515 | # colorized output is helpful in CI logs, and I don't know if, 516 | # e.g. GitHub Actions logging pretends to be a terminal.) 517 | color=true 518 | 519 | # TODO: Using the current directory (i.e. a package's repo root directory) in 520 | # load-path can cause weird errors in case of--you guessed it--stale .ELC files, 521 | # the zombie problem that just won't die. It's incredible how many different ways 522 | # this problem presents itself. In this latest example, an old .ELC file, for a 523 | # .EL file that had since been renamed, was present on my local system, which meant 524 | # that an example .EL file that hadn't been updated was able to "require" that .ELC 525 | # file's feature without error. But on another system (in this case, trying to 526 | # setup CI using GitHub Actions), the old .ELC was not present, so the example .EL 527 | # file was not able to load the feature, which caused a byte-compilation error. 528 | 529 | # In this case, I will prevent such example files from being compiled. But in 530 | # general, this can cause weird problems that are tedious to debug. I guess 531 | # the best way to fix it would be to actually install the repo's code as a 532 | # package into the sandbox, but doing that would require additional tooling, 533 | # pulling in something like Quelpa or package-build--and if the default recipe 534 | # weren't being used, the actual recipe would have to be fetched off MELPA or 535 | # something, which seems like getting too smart for our own good. 536 | 537 | # TODO: Emit a warning if .ELC files that don't match any .EL files are detected. 538 | load_path="." 539 | 540 | # ** Colors 541 | 542 | COLOR_off='\e[0m' 543 | COLOR_black='\e[0;30m' 544 | COLOR_red='\e[0;31m' 545 | COLOR_green='\e[0;32m' 546 | COLOR_yellow='\e[0;33m' 547 | COLOR_blue='\e[0;34m' 548 | COLOR_purple='\e[0;35m' 549 | COLOR_cyan='\e[0;36m' 550 | COLOR_white='\e[0;37m' 551 | 552 | # * Project files 553 | 554 | # MAYBE: Option to not byte-compile test files. (OTOH, byte-compiling reveals many 555 | # errors that would otherwise go unnoticed, so it's worth it to fix the warnings.) 556 | project_source_files=($(project-source-files)) 557 | project_test_files=($(project-test-files)) 558 | project_byte_compile_files=("${project_source_files[@]}" "${project_test_files[@]}") 559 | 560 | package_initialize_file="$(elisp-package-initialize-file)" 561 | temp_paths+=("$package_initialize_file") 562 | 563 | # * Args 564 | 565 | args=$(getopt -n "$0" \ 566 | -o dhi:sS:vf:C \ 567 | -l auto-install,debug,debug-load-path,help,install:,verbose,file:,no-color,no-compile,sandbox,sandbox-dir: \ 568 | -- "$@") \ 569 | || { usage; exit 1; } 570 | eval set -- "$args" 571 | 572 | while true 573 | do 574 | case "$1" in 575 | --auto-install) 576 | auto_install=true 577 | ;; 578 | -d|--debug) 579 | debug=true 580 | verbose=2 581 | ;; 582 | --debug-load-path) 583 | debug_load_path=true 584 | ;; 585 | -h|--help) 586 | usage 587 | exit 588 | ;; 589 | -i|--install) 590 | shift 591 | sandbox_install_packages_args+=(--install "$1") 592 | ;; 593 | -s|--sandbox) 594 | sandbox=true 595 | ;; 596 | -S|--sandbox-dir) 597 | shift 598 | sandbox=true 599 | sandbox_dir="$1" 600 | ;; 601 | -v|--verbose) 602 | ((verbose++)) 603 | ;; 604 | -f|--file) 605 | shift 606 | project_source_files+=("$1") 607 | project_byte_compile_files+=("$1") 608 | ;; 609 | --no-color) 610 | unset color 611 | ;; 612 | -C|--no-compile) 613 | unset compile 614 | ;; 615 | --) 616 | # Remaining args (required; do not remove) 617 | shift 618 | rest=("$@") 619 | break 620 | ;; 621 | esac 622 | 623 | shift 624 | done 625 | 626 | debug "ARGS: $args" 627 | debug "Remaining args: ${rest[@]}" 628 | 629 | # * Main 630 | 631 | trap cleanup EXIT INT TERM 632 | 633 | if ! [[ ${project_source_files[@]} ]] 634 | then 635 | error "No files specified and not in a git repo." 636 | exit 1 637 | fi 638 | 639 | if [[ $sandbox ]] 640 | then 641 | # Setup sandbox. 642 | type emacs-sandbox.sh &>/dev/null || die "emacs-sandbox.sh not found." 643 | 644 | if ! [[ $sandbox_dir ]] 645 | then 646 | # No sandbox dir specified: make temp dir and remove it on exit. 647 | sandbox_dir=$(mktemp -d) || die "Unable to make temp dir." 648 | temp_paths+=("$sandbox_dir") 649 | fi 650 | 651 | sandbox_basic_args=( 652 | -d "$sandbox_dir" 653 | ) 654 | [[ $debug ]] && sandbox_basic_args+=(--debug) 655 | 656 | if [[ $auto_install ]] 657 | then 658 | # Add dependencies to package install list. 659 | deps=($(dependencies)) 660 | debug "Installing dependencies: ${deps[@]}" 661 | 662 | for package in "${deps[@]}" 663 | do 664 | sandbox_install_packages_args+=(--install $package) 665 | done 666 | fi 667 | 668 | if [[ ${sandbox_install_packages_args[@]} ]] 669 | then 670 | # Initialize the sandbox (installs packages once rather than for every rule). 671 | emacs_command="emacs-sandbox.sh ${sandbox_basic_args[@]} ${sandbox_install_packages_args[@]} -- " 672 | debug "Initializing sandbox..." 673 | 674 | run_emacs || die "Unable to initialize sandbox." 675 | fi 676 | 677 | # After the sandbox is initialized and packages are installed, set the command 678 | # to prevent the package lists from being refreshed on each invocation. 679 | emacs_command="emacs-sandbox.sh ${sandbox_basic_args[@]} --no-refresh-packages -- " 680 | 681 | debug "Sandbox initialized." 682 | fi 683 | 684 | # Run rules. 685 | for rule in "${rest[@]}" 686 | do 687 | if [[ $batch ]] 688 | then 689 | debug "Adding batch argument: $rule" 690 | batch_args+=("$rule") 691 | 692 | elif [[ $rule = batch ]] 693 | then 694 | # Remaining arguments are passed to Emacs. 695 | batch=true 696 | elif type "$rule" 2>/dev/null | grep "$rule is a function" &>/dev/null 697 | then 698 | $rule 699 | elif [[ $rule = test ]] 700 | then 701 | # Allow the "tests" rule to be called as "test". Since "test" 702 | # is a shell builtin, this workaround is required. 703 | tests 704 | else 705 | error "Invalid rule: $rule" 706 | fi 707 | done 708 | 709 | # The batch rule. 710 | [[ $batch ]] && batch 711 | 712 | if [[ $errors -gt 0 ]] 713 | then 714 | log_color red "Finished with $errors errors." 715 | else 716 | success "Finished without errors." 717 | fi 718 | 719 | exit $errors 720 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------