├── docs └── images │ ├── default-yellow.png │ └── casual-isearch-tmenu.png ├── scripts └── read-version.sh ├── .gitignore ├── tests ├── Makefile ├── test-casual-isearch-version.el ├── casual-isearch-test-utils.el ├── test-casual-isearch-utils.el ├── test-casual-isearch-settings.el └── test-casual-isearch.el ├── lisp ├── casual-isearch-version.el ├── casual-isearch-utils.el ├── casual-isearch-settings.el ├── Makefile └── casual-isearch.el ├── Makefile ├── README.org └── LICENSE /docs/images/default-yellow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kickingvegas/casual-isearch/HEAD/docs/images/default-yellow.png -------------------------------------------------------------------------------- /docs/images/casual-isearch-tmenu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kickingvegas/casual-isearch/HEAD/docs/images/casual-isearch-tmenu.png -------------------------------------------------------------------------------- /scripts/read-version.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | ## 3 | # Copyright 2024 Charles Y. Choi 4 | # 5 | 6 | grep 'Version: ' $1 | awk '{print $3}' 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled 2 | *.elc 3 | 4 | # Packaging 5 | .cask 6 | 7 | # Backup files 8 | *~ 9 | 10 | # Undo-tree save-files 11 | *.~undo-tree 12 | -------------------------------------------------------------------------------- /tests/Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | # Copyright 2024 Charles Y. Choi 3 | # 4 | # This program is free software; you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | TIMESTAMP := $(shell /bin/date "+%Y%m%d_%H%M%S") 18 | 19 | .PHONY: tests 20 | 21 | tests: 22 | $(MAKE) -C ../lisp tests 23 | -------------------------------------------------------------------------------- /lisp/casual-isearch-version.el: -------------------------------------------------------------------------------- 1 | ;;; casual-isearch-version.el --- Casual Version -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | 23 | ;;; Code: 24 | 25 | (defconst casual-isearch-version "2.0.0" 26 | "Casual I-Search Version.") 27 | 28 | (defun casual-isearch-version () 29 | "Show current version of Casual I-Search." 30 | (interactive) 31 | (message casual-isearch-version)) 32 | 33 | (provide 'casual-isearch-version) 34 | ;;; casual-isearch-version.el ends here 35 | -------------------------------------------------------------------------------- /tests/test-casual-isearch-version.el: -------------------------------------------------------------------------------- 1 | ;;; test-casual-isearch-version.el --- Casual Re-Builder Version Tests -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | 23 | ;; 24 | 25 | ;;; Code: 26 | (require 'ert) 27 | (require 'casual-isearch-test-utils) 28 | (require 'casual-isearch-version) 29 | 30 | (ert-deftest test-casual-isearch-version () 31 | (should (stringp (casual-isearch-version))) 32 | (should (stringp casual-isearch-version))) 33 | 34 | (provide 'test-casual-isearch-version) 35 | ;;; test-casual-isearch-version.el ends here 36 | -------------------------------------------------------------------------------- /tests/casual-isearch-test-utils.el: -------------------------------------------------------------------------------- 1 | ;;; casual-isearch-test-utils.el --- Casual Test Utils -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | 23 | ;; 24 | 25 | ;;; Code: 26 | (require 'ert) 27 | (require 'casual-lib) 28 | (require 'kmacro) 29 | (require 'isearch) 30 | 31 | (defun casualt-setup () 32 | "Casual menu test setup function." 33 | ) 34 | 35 | (defun casualt-breakdown (&optional clear) 36 | "Casual menu test breakdown function, if CLEAR is non-nil then clear state." 37 | ) 38 | 39 | (provide 'casual-isearch-test-utils) 40 | ;;; casual-isearch-test-utils.el ends here 41 | -------------------------------------------------------------------------------- /tests/test-casual-isearch-utils.el: -------------------------------------------------------------------------------- 1 | ;;; test-casual-isearch-utils.el --- Casual Re-Builder Utils Tests -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | 23 | ;; 24 | 25 | ;;; Code: 26 | (require 'ert) 27 | (require 'casual-isearch-test-utils) 28 | (require 'casual-isearch-utils) 29 | 30 | (ert-deftest test-casual-isearch-unicode-get () 31 | (let ((casual-lib-use-unicode nil)) 32 | (should (string-equal (casual-isearch-unicode-get :previous) "Previous")) 33 | (should (string-equal (casual-isearch-unicode-get :next) "Next"))) 34 | 35 | (let ((casual-lib-use-unicode t)) 36 | (should (string-equal (casual-isearch-unicode-get :previous) "↑")) 37 | (should (string-equal (casual-isearch-unicode-get :next) "↓")))) 38 | 39 | (provide 'test-casual-isearch-utils) 40 | ;;; test-casual-isearch-utils.el ends here 41 | -------------------------------------------------------------------------------- /lisp/casual-isearch-utils.el: -------------------------------------------------------------------------------- 1 | ;;; casual-isearch-utils.el --- Casual Re-Builder Utils -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | ;; 23 | 24 | ;;; Code: 25 | (require 'simple) 26 | (require 'isearch) 27 | (require 'casual-lib) 28 | 29 | (defconst casual-isearch-unicode-db 30 | '((:previous . '("↑" "Previous")) 31 | (:next . '("↓" "Next"))) 32 | 33 | "Unicode symbol DB to use for RE-Builder Transient menus.") 34 | 35 | (defun casual-isearch-unicode-get (key) 36 | "Lookup Unicode symbol for KEY in DB. 37 | 38 | - KEY symbol used to lookup Unicode symbol in DB. 39 | 40 | If the value of customizable variable `casual-lib-use-unicode' 41 | is non-nil, then the Unicode symbol is returned, otherwise a 42 | plain ASCII-range string." 43 | (casual-lib-unicode-db-get key casual-isearch-unicode-db)) 44 | 45 | (provide 'casual-isearch-utils) 46 | ;;; casual-isearch-utils.el ends here 47 | -------------------------------------------------------------------------------- /tests/test-casual-isearch-settings.el: -------------------------------------------------------------------------------- 1 | ;;; test-casual-isearch-settings.el --- Casual Re-Builder Settings Tests -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | 23 | ;; 24 | 25 | ;;; Code: 26 | 27 | (require 'ert) 28 | (require 'casual-isearch-test-utils) 29 | (require 'casual-isearch-settings) 30 | 31 | (ert-deftest test-casual-isearch-settings-tmenu-bindings () 32 | (casualt-setup) 33 | (let ((test-vectors (list))) 34 | (push (casualt-suffix-test-vector "G" #'casual-isearch--customize-group) test-vectors) 35 | 36 | (push (casualt-suffix-test-vector "u" #'casual-lib-customize-casual-lib-use-unicode) test-vectors) 37 | (push (casualt-suffix-test-vector "n" #'casual-lib-customize-casual-lib-hide-navigation) test-vectors) 38 | (push (casualt-suffix-test-vector "a" #'casual-isearch-about) test-vectors) 39 | (push (casualt-suffix-test-vector "v" #'casual-isearch-version) test-vectors) 40 | 41 | (casualt-suffix-testbench-runner test-vectors 42 | #'casual-isearch-settings-tmenu 43 | '(lambda () (random 5000)))) 44 | (casualt-breakdown t)) 45 | 46 | (ert-deftest test-casual-isearch-about () 47 | (should (stringp (casual-isearch-about)))) 48 | 49 | (provide 'test-casual-isearch-settings) 50 | ;;; test-casual-isearch-setttings.el ends here 51 | -------------------------------------------------------------------------------- /lisp/casual-isearch-settings.el: -------------------------------------------------------------------------------- 1 | ;;; casual-isearch-settings.el --- Casual Re-Builder Settings -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | ;; 23 | 24 | ;;; Code: 25 | (require 'isearch) 26 | (require 'casual-lib) 27 | (require 'casual-isearch-version) 28 | 29 | (transient-define-prefix casual-isearch-settings-tmenu () 30 | "Casual I-Search settings menu." 31 | ["I-Search: Settings" 32 | ["Customize" 33 | ("G" "I-Search Group" casual-isearch--customize-group) 34 | (casual-lib-customize-unicode) 35 | (casual-lib-customize-hide-navigation)]] 36 | 37 | [:class transient-row 38 | (casual-lib-quit-one) 39 | ("a" "About" casual-isearch-about :transient nil) 40 | ("v" "Version" casual-isearch-version :transient nil) 41 | (casual-lib-quit-all)]) 42 | 43 | (defun casual-isearch--customize-group () 44 | "Customize I-Search group." 45 | (interactive) 46 | (customize-group "isearch")) 47 | 48 | (defun casual-isearch-about-isearch () 49 | "Casual I-Search is a Transient menu for I-Search. 50 | 51 | Learn more about using Casual I-Search at our discussion group on GitHub. 52 | Any questions or comments about it should be made there. 53 | URL `https://github.com/kickingvegas/casual-isearch/discussions' 54 | 55 | If you find a bug or have an enhancement request, please file an issue. 56 | Our best effort will be made to answer it. 57 | URL `https://github.com/kickingvegas/casual-isearch/issues' 58 | 59 | If you enjoy using Casual I-Search, consider making a modest financial 60 | contribution to help support its development and maintenance. 61 | URL `https://www.buymeacoffee.com/kickingvegas' 62 | 63 | Casual I-Search was conceived and crafted by Charles Choi in 64 | San Francisco, California. 65 | 66 | Thank you for using Casual I-Search. 67 | 68 | Always choose love." 69 | (ignore)) 70 | 71 | (defun casual-isearch-about () 72 | "About information for Casual I-Search." 73 | (interactive) 74 | (describe-function #'casual-isearch-about-isearch)) 75 | 76 | (provide 'casual-isearch-settings) 77 | ;;; casual-isearch-settings.el ends here 78 | -------------------------------------------------------------------------------- /lisp/Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | # Copyright 2024 Charles Y. Choi 3 | # 4 | # This program is free software; you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | TIMESTAMP := $(shell /bin/date "+%Y%m%d_%H%M%S") 18 | 19 | EMACS_MAC_APP_HOME=/Applications/MacPorts/EmacsMac.app 20 | EMACS_MAC_APP_SH=$(EMACS_MAC_APP_HOME)/Contents/MacOS/Emacs.sh 21 | 22 | ifneq ("$(wildcard $(EMACS_MAC_APP_SH))","") 23 | EXEC_NAME=$(EMACS_MAC_APP_SH) 24 | else 25 | EXEC_NAME=emacs 26 | endif 27 | 28 | PACKAGE_NAME=casual-isearch 29 | ELISP_INCLUDES=casual-isearch-version.el \ 30 | casual-isearch-utils.el \ 31 | casual-isearch-settings.el 32 | ELISP_PACKAGES= 33 | ELISP_TEST_INCLUDES=casual-isearch-test-utils.el 34 | CASUAL_BASE_DIR=$(HOME)/Projects/elisp 35 | CASUAL_LIB_DIR=$(CASUAL_BASE_DIR)/casual-lib 36 | CASUAL_LIB_LISP_DIR=$(CASUAL_LIB_DIR)/lisp 37 | CASUAL_LIB_TEST_INCLUDES=$(CASUAL_LIB_DIR)/tests/casual-lib-test-utils.el 38 | EMACS_ELPA_DIR=$(HOME)/.config/emacs/elpa 39 | PACKAGE_PATHS= \ 40 | -L $(EMACS_ELPA_DIR)/compat-30.0.0.0 \ 41 | -L $(EMACS_ELPA_DIR)/seq-2.24 \ 42 | -L $(EMACS_ELPA_DIR)/transient-current \ 43 | -L $(CASUAL_LIB_LISP_DIR) 44 | 45 | .PHONY: tests compile regression 46 | 47 | .SUFFIXES: .el .elc .elt 48 | 49 | .el.elc : 50 | $(EXEC_NAME) -Q --batch $(patsubst %, -l %, $(ELISP_INCLUDES)) \ 51 | -f batch-byte-compile $< 52 | 53 | .el.elt : 54 | $(EXEC_NAME) -Q --batch \ 55 | $(PACKAGE_PATHS) \ 56 | $(patsubst %, -l %, $(ELISP_INCLUDES)) \ 57 | -l $< \ 58 | -l $(CASUAL_LIB_TEST_INCLUDES) \ 59 | -l $(patsubst %, ../tests/%, $(ELISP_TEST_INCLUDES)) \ 60 | -l $(patsubst %, ../tests/test-%, $<) \ 61 | -f ert-run-tests-batch-and-exit 62 | 63 | tests: $(ELISP_PACKAGES:.el=.elt) $(ELISP_INCLUDES:.el=.elt) $(PACKAGE_NAME).elt 64 | 65 | compile: $(ELISP_PACKAGES:.el=.elc) $(ELISP_INCLUDES:.el=.elc) $(PACKAGE_NAME).elc 66 | 67 | $(PACKAGE_NAME).elc: $(PACKAGE_NAME).el 68 | $(EXEC_NAME) -Q --batch $(patsubst %, -l %, $(ELISP_INCLUDES)) \ 69 | $(patsubst %, -l %, $(ELISP_PACKAGES)) \ 70 | $(PACKAGE_PATHS) \ 71 | -f batch-byte-compile $< 72 | 73 | $(PACKAGE_NAME).elt: $(PACKAGE_NAME).el 74 | $(EXEC_NAME) -Q --batch \ 75 | $(PACKAGE_PATHS) \ 76 | $(patsubst %, -l %, $(ELISP_INCLUDES)) \ 77 | $(patsubst %, -l %, $(ELISP_PACKAGES)) \ 78 | -l $< \ 79 | -l $(CASUAL_LIB_TEST_INCLUDES) \ 80 | -l ../tests/$(ELISP_TEST_INCLUDES) \ 81 | -l $(patsubst %, ../tests/test-%, $<) \ 82 | -f ert-run-tests-batch-and-exit 83 | 84 | regression: clean compile tests 85 | 86 | clean: 87 | rm -f *.elc 88 | -------------------------------------------------------------------------------- /tests/test-casual-isearch.el: -------------------------------------------------------------------------------- 1 | ;;; test-casual-isearch.el --- Casual Re-Builder Tests -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; Keywords: tools 7 | 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | 21 | ;;; Commentary: 22 | 23 | ;; 24 | 25 | ;;; Code: 26 | 27 | (require 'ert) 28 | (require 'casual-isearch-test-utils) 29 | (require 'casual-lib-test-utils) 30 | (require 'casual-isearch) 31 | 32 | (ert-deftest test-casual-isearch-tmenu () 33 | (let ((tmpfile "casual-isearch-tmenu.txt")) 34 | (casualt-setup) 35 | (cl-letf (;;((symbol-function #') (lambda () t)) 36 | (casualt-mock #'isearch-edit-string) 37 | (casualt-mock #'isearch-yank-word-or-char) 38 | (casualt-mock #'isearch-yank-symbol-or-char) 39 | (casualt-mock #'isearch-yank-line) 40 | (casualt-mock #'isearch-yank-kill) 41 | (casualt-mock #'isearch-forward-thing-at-point) 42 | (casualt-mock #'isearch-query-replace) 43 | (casualt-mock #'isearch-query-replace-regexp) 44 | (casualt-mock #'isearch-toggle-case-fold) 45 | (casualt-mock #'isearch-toggle-lax-whitespace) 46 | (casualt-mock #'isearch-occur) 47 | (casualt-mock #'isearch-highlight-regexp) 48 | (casualt-mock #'isearch-highlight-lines-matching-regexp) 49 | (casualt-mock #'isearch-repeat-forward) 50 | (casualt-mock #'isearch-repeat-backward)) 51 | 52 | (let ((test-vectors 53 | '((:binding "e" :command isearch-edit-string) 54 | (:binding "w" :command isearch-yank-word-or-char) 55 | (:binding "s" :command isearch-yank-symbol-or-char) 56 | (:binding "l" :command isearch-yank-line) 57 | (:binding "y" :command isearch-yank-kill) 58 | (:binding "t" :command isearch-forward-thing-at-point) 59 | 60 | (:binding "r" :command isearch-query-replace) 61 | (:binding "x" :command isearch-query-replace-regexp) 62 | 63 | (:binding "X" :command casual-isearch--toggle-regex-and-edit) 64 | (:binding "S" :command casual-isearch--toggle-symbol-and-edit) 65 | (:binding "W" :command casual-isearch--toggle-word-and-edit) 66 | (:binding "F" :command isearch-toggle-case-fold) 67 | (:binding "L" :command isearch-toggle-lax-whitespace) 68 | (:binding "o" :command isearch-occur) 69 | (:binding "h" :command isearch-highlight-regexp) 70 | (:binding "H" :command isearch-highlight-lines-matching-regexp) 71 | (:binding "n" :command isearch-repeat-forward) 72 | (:binding "p" :command isearch-repeat-backward) 73 | (:binding "RET" :command isearch-exit)))) 74 | 75 | (casualt-suffix-testcase-runner test-vectors 76 | #'casual-isearch-tmenu 77 | '(lambda () (random 5000))))) 78 | (casualt-breakdown))) 79 | 80 | 81 | 82 | (provide 'test-casual-isearch) 83 | ;;; test-casual-isearch.el ends here 84 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | # Copyright 2024 Charles Y. Choi 3 | # 4 | # This program is free software; you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | ## Requirements 18 | # - Python 3.11+ 19 | # - GNU awk 5.3+ 20 | # - Python semver 21 | # - Bash 22 | 23 | ## User Actions 24 | # To run test suite: 25 | # $ make tests 26 | 27 | # To update development branch with fetch and pull 28 | # $ make checkout-development 29 | 30 | # To create a pull request on the development branch: 31 | # $ make create-pr 32 | 33 | # Bumping development version after PR is merged: 34 | # $ make BUMP_LEVEL=prerelease bump 35 | 36 | # To create a pull request on the main branch: 37 | # $ make create-release-pr 38 | 39 | # To create a new release tag (only after merging create-release-pr): 40 | # $ make BUMP_LEVEL={patch|minor|major} create-release-tag 41 | 42 | # To setup for new sprint development: 43 | # $ make new-sprint 44 | 45 | LISP_DIR=./lisp 46 | MAIN_EL=$(LISP_DIR)/casual-isearch.el 47 | VERSION_EL=$(LISP_DIR)/casual-isearch-version.el 48 | 49 | TIMESTAMP := $(shell /bin/date "+%Y%m%d_%H%M%S") 50 | VERSION := $(shell ./scripts/read-version.sh $(MAIN_EL)) 51 | # BUMP_LEVEL: major|minor|patch|prerelease|build 52 | BUMP_LEVEL=patch 53 | VERSION_BUMP := $(shell python -m semver bump $(BUMP_LEVEL) $(VERSION)) 54 | VERSION_LAST_TAG := $(shell git tag --sort=-creatordate | head -n 1) 55 | 56 | .PHONY: tests \ 57 | create-pr \ 58 | bump-casual \ 59 | bump \ 60 | checkout-development \ 61 | checkout-main \ 62 | sync-development-with-main \ 63 | new-sprint \ 64 | create-merge-development-branch \ 65 | create-pr \ 66 | create-release-pr \ 67 | create-release-tag \ 68 | create-gh-release \ 69 | status 70 | 71 | ## Run test regression 72 | tests: 73 | $(MAKE) -C lisp tests 74 | 75 | ## Bump Patch Version 76 | bump-casual: 77 | sed -i 's/;; Version: $(VERSION)/;; Version: $(VERSION_BUMP)/' $(MAIN_EL) 78 | sed -i 's/(defconst casual-isearch-version "$(VERSION)"/(defconst casual-isearch-version "$(VERSION_BUMP)"/' $(VERSION_EL) 79 | 80 | bump: bump-casual 81 | git commit -m 'Bump version to $(VERSION_BUMP)' $(MAIN_EL) $(VERSION_EL) 82 | git push 83 | 84 | checkout-development: 85 | git checkout development 86 | git branch --set-upstream-to=origin/development development 87 | git fetch origin --prune 88 | git pull 89 | 90 | checkout-main: 91 | git checkout main 92 | git branch --set-upstream-to=origin/main main 93 | git fetch origin --prune 94 | git pull 95 | 96 | sync-development-with-main: checkout-main checkout-development 97 | git merge main 98 | 99 | 100 | new-sprint: VERSION_BUMP:=$(shell python -m semver nextver $(VERSION) prerelease) 101 | new-sprint: sync-development-with-main bump 102 | 103 | create-merge-development-branch: checkout-development 104 | git checkout -b merge-development-to-main-$(TIMESTAMP) 105 | git push --set-upstream origin merge-development-to-main-$(TIMESTAMP) 106 | 107 | ## Create GitHub pull request for development 108 | create-pr: 109 | gh pr create --base development --fill 110 | 111 | create-patch-pr: 112 | gh pr create --base main --fill 113 | 114 | ## Create GitHub pull request for release 115 | create-release-pr: create-merge-development-branch 116 | gh pr create --base main \ 117 | --title "Merge development to main $(TIMESTAMP)" \ 118 | --fill-verbose 119 | 120 | create-release-tag: checkout-main bump 121 | git tag $(VERSION_BUMP) 122 | git push origin $(VERSION_BUMP) 123 | 124 | create-gh-release: VERSION_BUMP:=$(shell python -m semver nextver $(VERSION) $(BUMP_LEVEL)) 125 | create-gh-release: create-release-tag 126 | gh release create -t v$(VERSION_BUMP) --generate-notes $(VERSION_BUMP) 127 | 128 | status: 129 | git status 130 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * NOTICE 2 | 3 | This package has been superseded by the package [[https://github.com/kickingvegas/casual][casual]]. Please install the package ~casual~ from either [[https://melpa.org/#/casual][MELPA]] or [[https://stable.melpa.org/#/casual][MELPA stable]]. 4 | 5 | Upon installation and upgrade of ~casual~, this package will be uninstalled from your Emacs configuration. Please revisit your configuration of Casual I-Search in your initialization file(s) accordingly. 6 | 7 | This repository should be treated as an archive. All future development on Casual I-Search will be done in the [[https://github.com/kickingvegas/casual][Casual repository]]. 8 | 9 | * Casual I-Search - A Transient menu for I-Search 10 | 11 | This package contains a [[https://github.com/magit/transient][Transient]] menu for I-Search. When in basic I-Search mode, this menu can be raised by pressing the ~C-o~ key. A menu of different isearch commands will be offered as shown below: 12 | 13 | [[file:docs/images/casual-isearch-tmenu.png]] 14 | 15 | * Requirements 16 | Casual I-Search requires usage of 17 | - Emacs ≥ 29.1 18 | - Casual Lib ≥ 1.1.0 19 | 20 | * Install 21 | Use the following lines to install casual-isearch-tmenu. 22 | #+begin_src elisp :lexical yes 23 | (require 'casual-isearch) 24 | (keymap-set isearch-mode-map "C-o" #'casual-isearch-tmenu) 25 | #+end_src 26 | 27 | Alternately install with ~use-package~ using the following initialization: 28 | #+begin_src elisp :lexical no 29 | (use-package casual-isearch 30 | :ensure t 31 | :bind (:map isearch-mode-map ("C-o" . casual-isearch-tmenu))) 32 | #+end_src 33 | 34 | The keybinding to ~casual-isearch-tmenu~ can be changed to user preference. 35 | 36 | ** A Note on Package Dependencies 37 | Casual I-Search requires Casual Lib which in turn requires a recent installation of Transient 0.6.0+ from either [[https://elpa.gnu.org/packages/transient.html][ELPA]] or [[https://melpa.org/#/transient][MELPA]]. As an older version of Transient is built-in to the Emacs release, the package manager ~package.el~ will /not/ update this package unless the customizable variable ~package-install-upgrade-built-in~ is set to ~t~. Set this variable and proceed with installing Casual I-Search. Alternately invoking ~package-install~ with a prefix (~C-u~) will temporarily coerce the update of the built-in package. (example: ~C-u M-x package-install~ ~casual-isearch~) 38 | 39 | As Transient is closely tied to Magit, installing the latest version of Magit (via [[https://elpa.nongnu.org/nongnu/magit.html][non-GNU ELPA]] or [[https://melpa.org/#/magit][MELPA]]) before installing Casual I-Search can also pick up the latest version of Transient. 40 | 41 | 42 | * Menu Commands 43 | The following I-Search commands are grouped as follows in the Transient menu ~casual-isearch-tmenu~. Keys associated with each command are shown enclosed in parentheses. 44 | 45 | ** Edit Search String 46 | - ~isearch-edit-string~ (~e~) 47 | - ~isearch-yank-word-or-char~ (~w~) 48 | - ~isearch-yank-symbol-or-char~ (~s~) 49 | - ~isearch-yank-line~ (~l~) 50 | - ~isearch-yank-kill~ (~y~) 51 | - ~isearch-forward-thing-at-point~ (~t~) 52 | ** Replace 53 | - ~isearch-query-replace~ (~r~) 54 | - ~isearch-query-replace-regexp~ (~x~) 55 | ** Toggle 56 | - ~isearch-toggle-regexp~ (~X~) 57 | - ~isearch-toggle-symbol~ (~S~) 58 | - ~isearch-toggle-word~ (~W~) 59 | - ~isearch-toggle-case-fold~ (~F~) 60 | - ~isearch-toggle-lax-whitespace~ (~L~) 61 | ** Misc 62 | - ~isearch-occur~ (~o~) 63 | - ~isearch-highlight-regexp~ (~h~) 64 | - ~isearch-highlight-lines-matching-regexp~ (~H~) 65 | - ~unhighlight-regexp~ (~u~) 66 | ** Navigation 67 | - ~isearch-repeat-forward~ (~n~) 68 | - ~isearch-repeat-backward~ (~p~) 69 | 70 | ** Exit 71 | To exit search, press the ~RET~ key. This will leave the point at the last successful search item. 72 | 73 | 74 | * Usage 75 | When in search mode (typically via the keybinding ~C-s~ or ~C-r~), pressing the keybinding ~C-o~ (or binding of your preference) will raise the Transient menu ~casual-isearch-tmenu~. Once raised, only the /I-Search/ commands in the *Replace* and *Misc* sections will automatically dismiss the menu when selected. All other /I-Search/ commands will /not/ dismiss the menu. 76 | 77 | Note that editing the search text via ~isearch-edit-string~ will enter a recursive editing mode that is normally exited when pressing the return (~RET~) key. 78 | 79 | Use ~C-g~ to dismiss this Transient menu. 80 | 81 | * See Also 82 | Casual I-Search is part of a suite of user interfaces for different Emacs packages called [[https://github.com/kickingvegas/casual-suite][Casual Suite]]. 83 | 84 | Different interfaces include those for Dired, Info, Calc, Bookmarks, RE-Builder, IBuffer, and others. Learn more about them today! 85 | 86 | * Sponsorship 87 | If you enjoy using Casual I-Search, consider making a modest financial contribution to help support its development and maintenance. 88 | 89 | [[https://www.buymeacoffee.com/kickingvegas][file:docs/images/default-yellow.png]] 90 | -------------------------------------------------------------------------------- /lisp/casual-isearch.el: -------------------------------------------------------------------------------- 1 | ;;; casual-isearch.el --- Transient UI for I-Search -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2023-2024 Charles Choi 4 | 5 | ;; Author: Charles Choi 6 | ;; URL: https://github.com/kickingvegas/casual-isearch 7 | ;; Keywords: wp 8 | ;; Version: 2.0.0 9 | ;; Package-Requires: ((emacs "29.1") (casual-lib "1.1.0")) 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; NOTICE 27 | ;; This package `casual-isearch' has been superseded by the package `casual'. 28 | ;; Please update to the `casual' package from either MELPA or MELPA stable. Upon 29 | ;; installation and upgrade of the `casual' package, this package will be 30 | ;; removed. 31 | 32 | ;; Provides a Transient menu interface to a subset of isearch functions. 33 | ;; Said functions are grouped as follows in the following sections: 34 | ;; - Edit Search String 35 | ;; - Replace 36 | ;; - Toggle 37 | ;; - Misc 38 | ;; - Navigation 39 | 40 | ;; INSTALLATION 41 | ;; Enter the code below into your init file to load and install 42 | ;; `casual-isearch-tmenu'. Tune the keybinding to your taste. 43 | 44 | ;; (require 'casual-isearch) 45 | ;; (keymap-set isearch-mode-map "C-o" #'casual-isearch-tmenu) 46 | 47 | ;; Alternately with `use-package': 48 | ;; (use-package casual-isearch 49 | ;; :ensure t 50 | ;; :bind (:map isearch-mode-map ("C-o" . casual-isearch-tmenu))) 51 | 52 | ;; NOTE: This package requires `casual-lib' which in turn requires an update of 53 | ;; the built-in package `transient' ≥ 0.6.0. Please customize the variable 54 | ;; `package-install-upgrade-built-in' to t to allow for `transient' to be 55 | ;; updated. For further details, consult the INSTALL section of this package's 56 | ;; README. 57 | 58 | ;;; Code: 59 | (require 'casual-lib) 60 | (require 'casual-isearch-utils) 61 | (require 'casual-isearch-settings) 62 | 63 | (display-warning 64 | :warning 65 | (concat 66 | "NOTICE: " 67 | "The package casual-isearch has been superseded by the package casual. " 68 | "Please upgrade to casual at your earliest convenience.")) 69 | 70 | (defun casual-isearch--toggle-regex-and-edit () 71 | "Invoke `isearch-toggle-regexp' then `isearch-edit-string'." 72 | (interactive) 73 | (isearch-toggle-regexp) 74 | (isearch-edit-string)) 75 | 76 | (defun casual-isearch--toggle-symbol-and-edit () 77 | "Invoke `isearch-toggle-symbol' then `isearch-edit-string'." 78 | (interactive) 79 | (isearch-toggle-symbol) 80 | (isearch-edit-string)) 81 | 82 | (defun casual-isearch--toggle-word-and-edit () 83 | "Invoke `isearch-toggle-word' then `isearch-edit-string'." 84 | (interactive) 85 | (isearch-toggle-symbol) 86 | (isearch-edit-string)) 87 | 88 | (transient-define-prefix casual-isearch-tmenu () 89 | "Transient menu for I-Search." 90 | [["Edit Search String" 91 | ("e" "Edit the search string (recursive)" isearch-edit-string 92 | :transient t) 93 | ("w" "Pull next word or character from buffer" isearch-yank-word-or-char 94 | :transient t) 95 | ("s" "Pull next symbol or character from buffer" isearch-yank-symbol-or-char 96 | :transient t) 97 | ("l" "Pull rest of line from buffer" isearch-yank-line :transient t) 98 | ("y" "Pull string from kill ring" isearch-yank-kill :transient t) 99 | ("t" "Pull thing from buffer" isearch-forward-thing-at-point)] 100 | 101 | ["Replace" 102 | ("r" "Start ‘query-replace’" isearch-query-replace 103 | :if-nil buffer-read-only) 104 | ("x" "Start ‘query-replace-regexp’" isearch-query-replace-regexp 105 | :if-nil buffer-read-only)]] 106 | 107 | [["Toggle" 108 | ("X" "Regexp searching (edit)" 109 | casual-isearch--toggle-regex-and-edit 110 | :transient t) 111 | ("S" "Symbol searching (edit)" 112 | casual-isearch--toggle-symbol-and-edit 113 | :transient t) 114 | ("W" "Word searching (edit)" 115 | casual-isearch--toggle-word-and-edit 116 | :transient t) 117 | ("F" "Case fold" 118 | isearch-toggle-case-fold 119 | :transient t) 120 | ("L" "Lax whitespace" 121 | isearch-toggle-lax-whitespace 122 | :transient t)] 123 | 124 | ["Misc" 125 | ("o" "Occur" isearch-occur) 126 | ("h" "Highlight" isearch-highlight-regexp) 127 | ("H" "Highlight lines" isearch-highlight-lines-matching-regexp) 128 | ("u" "Unhighlight" unhighlight-regexp)] 129 | 130 | ["Navigation" 131 | ("p" "Previous" isearch-repeat-backward 132 | :description (lambda () (casual-isearch-unicode-get :previous)) 133 | :transient t) 134 | ("n" "Next" isearch-repeat-forward 135 | :description (lambda () (casual-isearch-unicode-get :next)) 136 | :transient t)]] 137 | 138 | [:class transient-row 139 | (casual-lib-quit-one) 140 | ("RET" "Exit Search" isearch-exit) 141 | ("," "Settings›" casual-isearch-settings-tmenu) 142 | (casual-lib-quit-all)]) 143 | 144 | (provide 'casual-isearch) 145 | ;;; casual-isearch.el ends here 146 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------