├── misc ├── .nosearch ├── flx-ido-demo.el └── flx-helm-demo.el ├── .gitignore ├── Cask ├── .travis.yml ├── Makefile ├── tests ├── run-test.el └── flx-test.el ├── README.md ├── flx-ido.el ├── flx.el └── LICENSE /misc/.nosearch: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | *~ 3 | \#*# 4 | -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (development 5 | (depends-on "async")) 6 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: emacs-lisp 2 | before_install: 3 | - if [ "$EMACS" = 'emacs-snapshot' ]; then 4 | sudo add-apt-repository -y ppa:cassou/emacs && 5 | sudo apt-get update -qq && 6 | sudo apt-get install -qq 7 | emacs-snapshot-el emacs-snapshot-gtk emacs-snapshot; 8 | fi 9 | - if [ "$EMACS" = 'emacs24' ]; then 10 | sudo add-apt-repository -y ppa:cassou/emacs && 11 | sudo apt-get update -qq && 12 | sudo apt-get install -qq 13 | emacs24 emacs24-el emacs24-common-non-dfsg; 14 | fi 15 | - curl -fsSL https://raw.githubusercontent.com/cask/cask/master/go | python 16 | - pwd 17 | - ~/.cask/bin/cask 18 | 19 | env: 20 | - EMACS=emacs24 TAGS="--tags ~@requires-e24-3" 21 | - EMACS=emacs-snapshot TAGS="" 22 | script: 23 | make travis-ci EMACS=$EMACS 24 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMACS=emacs 2 | EMACS23=emacs23 3 | EMACS-OPTIONS= 4 | 5 | ELS = flx.el 6 | ELS += flx-ido.el 7 | TEST_ELCS = $(wildcard tests/*.elc) 8 | 9 | ELCS = $(ELS:.el=.elc) 10 | 11 | .PHONY: test test-nw travis-ci show-version before-test clean 12 | 13 | all: $(ELCS) 14 | 15 | clean: 16 | $(RM) $(ELCS) $(TEST_ELCS) 17 | 18 | show-version: 19 | echo "*** Emacs version ***" 20 | echo "EMACS = `which ${EMACS}`" 21 | ${EMACS} --version 22 | 23 | install-ert: 24 | emacs --batch -L "${PWD}/lib/ert/lisp/emacs-lisp" --eval "(require 'ert)" || ( git clone git://github.com/ohler/ert.git lib/ert && cd lib/ert && git checkout 00aef6e43 ) 25 | 26 | 27 | before-test: show-version install-ert 28 | 29 | test: before-test 30 | ${EMACS} -Q -L . -l tests/run-test.el 31 | 32 | test-nw: before-test 33 | ${EMACS} -Q -nw -L . -l tests/run-test.el 34 | 35 | travis-ci: before-test 36 | echo ${EMACS-OPTIONS} 37 | ${EMACS} -batch -Q -l tests/run-test.el 38 | 39 | %.elc: %.el 40 | ${EMACS} -batch -Q -L . -f batch-byte-compile $< 41 | -------------------------------------------------------------------------------- /misc/flx-ido-demo.el: -------------------------------------------------------------------------------- 1 | ;; Copyright © 2013-2022 Le Wang -*- lexical-binding: t; -*- 2 | 3 | ;; This file is NOT part of GNU Emacs. 4 | 5 | ;; This program is free software; you can redistribute it and/or modify 6 | ;; it under the terms of the GNU General Public License as published by 7 | ;; the Free Software Foundation, either version 3 of the License, or 8 | ;; (at your option) any later version. 9 | 10 | ;; This program is distributed in the hope that it will be useful, 11 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | ;; GNU General Public License for more details. 14 | 15 | ;; You should have received a copy of the GNU General Public License 16 | ;; along with this program. If not, see . 17 | 18 | (require 'flx-ido) 19 | (require 'flx-test-list) 20 | 21 | (setq ido-enable-flex-matching t 22 | flx-ido-use t) 23 | 24 | (defun flx-ido-demo () 25 | (interactive) 26 | (require 'flx-test-list) 27 | (ido-completing-read ": " foo-list)) 28 | 29 | (defun flx-ido-big-demo (max) 30 | (interactive "P") 31 | (setq max (or max 32 | most-positive-fixnum)) 33 | (let* ((names (loop for i in (ucs-names) 34 | for stop below max 35 | collect (car i))) 36 | (names-length (length names))) 37 | (ido-completing-read (format "ucs (%s total): " names-length) 38 | names))) 39 | 40 | (provide 'flx-ido-demo) 41 | -------------------------------------------------------------------------------- /tests/run-test.el: -------------------------------------------------------------------------------- 1 | ;; Copyright © 2013-2022 Le Wang 2 | 3 | ;; This file is NOT part of GNU Emacs. 4 | 5 | ;; This program is free software; you can redistribute it and/or modify 6 | ;; it under the terms of the GNU General Public License as published by 7 | ;; the Free Software Foundation, either version 3 of the License, or 8 | ;; (at your option) any later version. 9 | 10 | ;; This program is distributed in the hope that it will be useful, 11 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | ;; GNU General Public License for more details. 14 | 15 | ;; You should have received a copy of the GNU General Public License 16 | ;; along with this program. If not, see . 17 | 18 | ;; Usage: 19 | ;; 20 | ;; emacs -Q -l tests/run-test.el # interactive mode 21 | ;; emacs -batch -Q -l tests/run-test.el # batch mode 22 | 23 | 24 | ;; Utils 25 | (defun flx-test-join-path (path &rest rest) 26 | "Join a list of PATHS with appropriate separator (such as /). 27 | 28 | \(fn &rest paths)" 29 | (if rest 30 | (concat (file-name-as-directory path) (apply 'flx-test-join-path rest)) 31 | path)) 32 | 33 | (defvar flx-test-dir (file-name-directory load-file-name)) 34 | (defvar flx-root-dir (file-name-as-directory (expand-file-name ".." flx-test-dir))) 35 | 36 | 37 | ;; Setup `load-path' 38 | (mapc (lambda (p) (add-to-list 'load-path p)) 39 | (list flx-test-dir 40 | flx-root-dir)) 41 | 42 | 43 | ;; Cask 44 | (setq package-user-dir 45 | (expand-file-name (format ".cask/%s/elpa" emacs-version) flx-root-dir)) 46 | (package-initialize) 47 | 48 | 49 | 50 | ;; Use ERT from github when this Emacs does not have it 51 | (unless (locate-library "ert") 52 | (add-to-list 53 | 'load-path 54 | (flx-test-join-path flx-root-dir "lib" "ert" "lisp" "emacs-lisp")) 55 | (require 'ert-batch) 56 | (require 'ert-ui)) 57 | 58 | 59 | ;; Load tests 60 | (load "flx-test") 61 | 62 | 63 | ;; Run tests 64 | (if noninteractive 65 | (ert-run-tests-batch-and-exit) 66 | (ert t)) 67 | -------------------------------------------------------------------------------- /misc/flx-helm-demo.el: -------------------------------------------------------------------------------- 1 | ;; Copyright © 2013-2022 Le Wang -*- lexical-binding: t; -*- 2 | 3 | ;; This file is NOT part of GNU Emacs. 4 | 5 | ;; This program is free software; you can redistribute it and/or modify 6 | ;; it under the terms of the GNU General Public License as published by 7 | ;; the Free Software Foundation, either version 3 of the License, or 8 | ;; (at your option) any later version. 9 | 10 | ;; This program is distributed in the hope that it will be useful, 11 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | ;; GNU General Public License for more details. 14 | 15 | ;; You should have received a copy of the GNU General Public License 16 | ;; along with this program. If not, see . 17 | 18 | (require 'flx) 19 | (require 'flx-test-list) 20 | 21 | (defun flx-helm-candidate-transformer (candidates) 22 | "We score candidate and add the score info for later use. 23 | 24 | The score info we add here is later removed with another filter." 25 | (if (zerop (length helm-pattern)) 26 | candidates 27 | (let* ((mp-3-patterns (helm-mp-3-get-patterns helm-pattern)) 28 | (flx-pattern (cdar mp-3-patterns)) 29 | (patterns (cons (cons 'identity 30 | (mapconcat 31 | #'regexp-quote 32 | (split-string flx-pattern "" t) 33 | ".*")) 34 | (cdr mp-3-patterns))) 35 | res) 36 | (setq res (loop for candidate in candidates 37 | for matched = (loop for (predicate . regexp) in patterns 38 | always (funcall predicate (string-match regexp (helm-candidate-get-display candidate)))) 39 | if matched 40 | collect (let ((score (flx-score candidate flx-pattern flx-file-cache))) 41 | (unless (consp candidate) 42 | (setq candidate (cons (copy-sequence candidate) candidate))) 43 | (setcdr candidate (cons (cdr candidate) score)) 44 | candidate))) 45 | (setq res (sort res 46 | (lambda (a b) 47 | (> (caddr a) (caddr b))))) 48 | (loop for item in res 49 | for index from 0 50 | for score = (cddr item) 51 | do (progn 52 | ;; highlight first 20 matches 53 | (when (and (< index 20) (> (car score) 0)) 54 | (setcar item (flx-propertize (car item) score 'add-score))) 55 | (setcdr item (cadr item)))) 56 | res))) 57 | 58 | (defun flx-helm-test-candidates () 59 | foo-list) 60 | 61 | (setq flx-helm-candidate-list-test 62 | '((name . "flx candidate-list-test") 63 | (candidates . flx-helm-test-candidates) 64 | (candidate-transformer flx-helm-candidate-transformer) 65 | (volatile) 66 | (match-strict identity) 67 | )) 68 | 69 | 70 | (defun flx-helm-demo () 71 | (interactive) 72 | (helm :sources '(flx-helm-candidate-list-test))) 73 | 74 | 75 | (setq flx-helm-no-flx 76 | '((name . "flx no flx") 77 | (candidates . flx-helm-test-candidates) 78 | (volatile) 79 | )) 80 | 81 | (defun flx-helm-no-flx () 82 | "Test Helm's volatile performance without flx." 83 | (interactive) 84 | (helm :sources '(flx-helm-no-flx))) 85 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/lewang/flx.png)](http://travis-ci.org/lewang/flx) 2 | [![MELPA](https://melpa.org/packages/flx-badge.svg)](https://melpa.org/#/flx) 3 | [![MELPA Stable](https://stable.melpa.org/packages/flx-badge.svg)](https://stable.melpa.org/#/flx) 4 | 5 | ## Status 6 | 7 | This project is more than a year old now. Lots of bugs have been worked out. 8 | 9 | It appears some people use it on a regular basis. 10 | 11 | ## Screencast 12 | 13 | [Screencast showing rationale and ido workflow][] 14 | 15 | ## Installation 16 | 17 | ### Manual 18 | 19 | Just drop all `.el` files somewhere on your `load-path`. Here's an 20 | example using the folder `~/.emacs.d/vendor`: 21 | 22 | ```lisp 23 | (add-to-list 'load-path "~/emacs.d/vendor") 24 | ``` 25 | 26 | ### Package Repositories 27 | 28 | Available packages: 29 | 30 | - `flx` - matching engine 31 | - `flx-ido` - ido interface for flx 32 | 33 | Install `flx-ido` will pull in `flx` as a dependency. 34 | 35 | 36 | #### [MELPA](http://melpa.milkbox.net) 37 | 38 | If you're an Emacs 24 user or you have a recent version of `package.el` you 39 | can install `flx-ido` from MELPA. 40 | 41 | This version will always be up-to-date. 42 | 43 | #### [Marmalade](http://marmalade-repo.org/) 44 | 45 | `flx-ido` is also available on the Marmalade `package.el` repository. 46 | 47 | ### Emacs Prelude 48 | 49 | `flx-ido` is part of the 50 | [Emacs Prelude](https://github.com/bbatsov/prelude). If you're a Prelude 51 | user - `flx-ido` is already properly configured and ready for 52 | action. 53 | 54 | ### Debian and Ubuntu 55 | 56 | Users of Debian 9 or Ubuntu 16.04 or later may simply `apt-get install 57 | elpa-flx`. 58 | 59 | ## Usage 60 | 61 | The sorting algorithm is a balance between word beginnings (abbreviation) and 62 | contiguous matches (substring). 63 | 64 | The longer the substring match, the higher it scores. This maps well to how 65 | we think about matching. 66 | 67 | In general, it's better form queries with only lowercase characters so 68 | the sorting algorithm can do something smart. 69 | 70 | For example, if you have these files: 71 | 72 | projects/clojure-mode/clojure-mode.el 73 | projects/prelude/core/prelude-mode.el 74 | 75 | If the search term was *pre-mode*, you might expect "prelude-mode.el" to rank 76 | higher. However because the substring match "re-mode" is so long, 77 | "clojure-mode.el" actually scores higher. 78 | 79 | **Here, using *premode* would give the expected order.** Notice that the 80 | "-" actually prevents the algorithm from helping you. 81 | 82 | ### uppercase letters 83 | 84 | Flx always folds lowercase letters to match uppercase. However, you can use uppercase letters for force flx to only match uppercase. 85 | 86 | This is similar to Emacs' case-folding. The difference is mixing in uppercase letters **does not disable** folding. 87 | 88 | ### completing file names 89 | 90 | Matches within the basepath score higher. 91 | 92 | ## ido support 93 | 94 | Add this to your init file and *flx* match will be enabled for ido. 95 | 96 | ```lisp 97 | (require 'flx-ido) 98 | (ido-mode 1) 99 | (ido-everywhere 1) 100 | (flx-ido-mode 1) 101 | ;; disable ido faces to see flx highlights. 102 | (setq ido-enable-flex-matching t) 103 | (setq ido-use-faces nil) 104 | ``` 105 | 106 | If you don't want to use the `flx`'s highlights you can turn them off like this: 107 | 108 | ```lisp 109 | (setq flx-ido-use-faces nil) 110 | ``` 111 | 112 | ### Flx uses a complex matching heuristics which can be slow for large collections 113 | 114 | Customize `flx-ido-threshold` to change the collection size above which flx 115 | will revert to flex matching. 116 | 117 | As soon as the collection is narrowed below `flx-ido-threshold`, flx will 118 | kick in again. 119 | 120 | As a point of reference for a 2.3 GHz quad-core i7 processor, a value of 121 | `10000` still provides a reasonable completion experience. 122 | 123 | 124 | ## Helm support 125 | 126 | [Helm][] is not supported yet. There is a demo showing how it could work, but I'm 127 | still working through how to integrate it into helm. 128 | 129 | The Helm demo shows the score of the top 20 matches. 130 | 131 | ## Memory Usage 132 | 133 | The `flx` algorithm willingly sacrifices memory usage for speed. 134 | 135 | For 10k file names, about 10 MB of memory will be used to speed up future 136 | matching. This memory is never released to keep the match speed fast. 137 | 138 | So far with modern computers, this feels like a reasonable design decision. 139 | 140 | It may change in future. 141 | 142 | ## GC Optimization 143 | 144 | Emacs's garbage collector is fairly primitive stop the world type. GC time can 145 | contribute significantly to the run-time of computation that allocates and 146 | frees a lot of memory. 147 | 148 | Consider the following example: 149 | 150 | ```lisp 151 | (defun uuid () 152 | (format "%08x-%08x-%08x-%08x" 153 | (random (expt 16 4)) 154 | (random (expt 16 4)) 155 | (random (expt 16 4)) 156 | (random (expt 16 4)))) 157 | 158 | (benchmark-run 1 159 | (let ((cache (flx-make-filename-cache))) 160 | (dolist (i (number-sequence 0 10000)) 161 | (flx-process-cache (uuid) cache)))) 162 | ;;; ⇒ (0.899678 9 0.33650300000000044) 163 | ``` 164 | 165 | This means that roughly 30% of time is spent just doing garbage-collection. 166 | 167 | `flx` can benefit significantly from garbage collection tuning. 168 | 169 | By default Emacs will initiate GC every 0.76 MB allocated (`gc-cons-threshold` 170 | == 800000). If we increase this to 20 MB (`gc-cons-threshold` == 20000000) 171 | we get: 172 | 173 | ```lisp 174 | (benchmark-run 1 175 | (setq gc-cons-threshold 20000000) 176 | (let ((cache (flx-make-filename-cache))) 177 | (dolist (i (number-sequence 0 10000)) 178 | (flx-process-cache (uuid) cache)))) 179 | ;;; ⇒ (0.62035 1 0.05461100000000041) 180 | ``` 181 | 182 | So if you have a modern machine, I encourage you to add the following: 183 | 184 | ```lisp 185 | (setq gc-cons-threshold 20000000) 186 | ``` 187 | 188 | to your init file. 189 | 190 | 191 | [Screencast showing rationale and ido workflow]: http://www.youtube.com/watch?v=_swuJ1RuMgk 192 | [Helm]: https://github.com/emacs-helm/helm 193 | -------------------------------------------------------------------------------- /flx-ido.el: -------------------------------------------------------------------------------- 1 | ;;; flx-ido.el --- flx integration for ido -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright © 2013, 2015 Le Wang 4 | 5 | ;; Author: Le Wang 6 | ;; Maintainer: Le Wang 7 | ;; Description: flx integration for ido 8 | ;; Created: Sun Apr 21 20:38:36 2013 (+0800) 9 | ;; Version: 0.6.2 10 | ;; URL: https://github.com/lewang/flx 11 | ;; Package-Requires: ((flx "0.1") (cl-lib "0.3")) 12 | 13 | ;; This file is NOT part of GNU Emacs. 14 | 15 | ;;; License 16 | 17 | ;; This program is free software; you can redistribute it and/or modify 18 | ;; it under the terms of the GNU General Public License as published by 19 | ;; the Free Software Foundation, either version 3 of the License, or 20 | ;; (at your option) any later version. 21 | ;; 22 | ;; This program is distributed in the hope that it will be useful, 23 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 24 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 25 | ;; GNU General Public License for more details. 26 | ;; 27 | ;; You should have received a copy of the GNU General Public License 28 | ;; along with this program. If not, see . 29 | 30 | ;;; Commentary: 31 | 32 | ;; This package provides a more powerful alternative to `ido-mode''s 33 | ;; built-in flex matching. 34 | 35 | ;;; Acknowledgments 36 | 37 | ;; Scott Frazer's blog entry 38 | ;; http://scottfrazersblog.blogspot.com.au/2009/12/emacs-better-ido-flex-matching.html 39 | ;; provided a lot of inspiration. 40 | ;; 41 | ;; ido-hacks was helpful for ido optimization and fontification ideas 42 | 43 | ;;; Installation: 44 | 45 | ;; Add the following code to your init file: 46 | ;; 47 | ;; (require 'flx-ido) 48 | ;; (ido-mode 1) 49 | ;; (ido-everywhere 1) 50 | ;; (flx-ido-mode 1) 51 | ;; ;; disable ido faces to see flx highlights. 52 | ;; (setq ido-enable-flex-matching t) 53 | ;; (setq ido-use-faces nil) 54 | 55 | ;;; Code: 56 | 57 | (require 'ido) 58 | (require 'flx) 59 | 60 | (eval-when-compile 61 | (defvar ido-cur-item)) 62 | 63 | (defcustom flx-ido-threshold 6000 64 | "Threshold for activating flx algorithm. 65 | 66 | Flx will not kick in until collection is filtered below this 67 | size with idos' default \"flex\" algorithm." 68 | :type 'integer 69 | :group 'ido) 70 | 71 | 72 | (defcustom flx-ido-use-faces t 73 | "Use `flx-highlight-face' to indicate characters contributing to best score." 74 | :type 'boolean 75 | :group 'ido) 76 | 77 | (unless (fboundp 'delete-consecutive-dups) 78 | (defun delete-consecutive-dups (list &optional circular) 79 | "Destructively remove `equal' consecutive duplicates from LIST. 80 | First and last elements are considered consecutive if CIRCULAR is 81 | non-nil." 82 | (let ((tail list) last) 83 | (while (consp tail) 84 | (if (equal (car tail) (cadr tail)) 85 | (setcdr tail (cddr tail)) 86 | (setq last (car tail) 87 | tail (cdr tail)))) 88 | (if (and circular 89 | (cdr list) 90 | (equal last (car list))) 91 | (nbutlast list) 92 | list)))) 93 | 94 | (defvar flx-ido-narrowed-matches-hash (make-hash-table :test 'equal) 95 | "Key is a query string. Value is a list of narrowed matches.") 96 | 97 | (defvar flx-ido-debug nil) 98 | 99 | (defun flx-ido-debug (&rest args) 100 | "Debugging util function. 101 | ARGS passed to message." 102 | (when flx-ido-debug 103 | (apply 'message args))) 104 | 105 | (defun flx-ido-is-prefix-match (str prefix) 106 | "Return t if STR starts with PREFIX." 107 | (when (and str prefix) 108 | (let ((length (length prefix))) 109 | (eq t (compare-strings prefix 0 length 110 | str 0 length))))) 111 | 112 | (defun flx-ido-narrowed (query items) 113 | "Get the value from `flx-ido-narrowed-matches-hash' with the 114 | longest prefix match." 115 | (flx-ido-debug "flx-ido-narrowed saw %s items" (length items)) 116 | (if (zerop (length query)) 117 | (list t (nreverse items)) 118 | (let ((query-key (flx-ido-key-for-query query)) 119 | best-match 120 | exact 121 | res) 122 | (cl-loop for key being the hash-key of flx-ido-narrowed-matches-hash 123 | do (when (and (>= (length query-key) (length key)) 124 | (flx-ido-is-prefix-match query-key key) 125 | (or (null best-match) 126 | (> (length key) (length best-match)))) 127 | (setq best-match key) 128 | (when (= (length key) 129 | (length query-key)) 130 | (setq exact t) 131 | (cl-return)))) 132 | (setq res (cond (exact 133 | (gethash best-match flx-ido-narrowed-matches-hash)) 134 | (best-match 135 | (flx-ido-undecorate (gethash best-match flx-ido-narrowed-matches-hash))) 136 | (t 137 | (flx-ido-undecorate items)))) 138 | (list exact res)))) 139 | 140 | (defun flx-ido-undecorate (strings) 141 | "Remove decorations from STRINGS." 142 | (flx-ido-decorate strings t)) 143 | 144 | 145 | (defun flx-ido-decorate (things &optional clear) 146 | "Add ido text properties to THINGS. 147 | If CLEAR is specified, clear them instead." 148 | (if flx-ido-use-faces 149 | (let ((decorate-count (min ido-max-prospects 150 | (length things)))) 151 | (nconc 152 | (cl-loop for thing in things 153 | for i from 0 below decorate-count 154 | collect (if clear 155 | (flx-propertize thing nil) 156 | (flx-propertize (car thing) (cdr thing)))) 157 | (if clear 158 | (nthcdr decorate-count things) 159 | (mapcar 'car (nthcdr decorate-count things))))) 160 | (if clear 161 | things 162 | (mapcar 'car things)))) 163 | 164 | (defun flx-ido-match-internal (query items) 165 | "Match QUERY against ITEMS using flx scores. 166 | 167 | If filtered item count is still greater than `flx-ido-threshold', then use flex." 168 | (flx-ido-debug "flx-ido-match-internal saw %s items" (length items)) 169 | (let ((flex-result (flx-flex-match query items))) 170 | (flx-ido-debug "flex result count: %s" (length flex-result)) 171 | (if (< (length flex-result) flx-ido-threshold) 172 | (let* ((matches (cl-loop for item in flex-result 173 | for string = (ido-name item) 174 | for score = (flx-score string query flx-file-cache) 175 | if score 176 | collect (cons item score) 177 | into matches 178 | finally return matches))) 179 | (flx-ido-decorate (delete-consecutive-dups 180 | (sort matches 181 | (lambda (x y) (> (cadr x) (cadr y)))) 182 | t))) 183 | flex-result))) 184 | 185 | (defun flx-ido-key-for-query (query) 186 | "Canonicalize QUERY to form key." 187 | (concat ido-current-directory query)) 188 | 189 | (defun flx-ido-cache (query items) 190 | "Possibly insert items into cache." 191 | (if (memq ido-cur-item '(file dir)) 192 | items 193 | (puthash (flx-ido-key-for-query query) items flx-ido-narrowed-matches-hash))) 194 | 195 | (defun flx-ido-reset () 196 | "Clean up flx variables between ido sessions." 197 | (clrhash flx-ido-narrowed-matches-hash)) 198 | 199 | (defun flx-ido-match (query items) 200 | "Better sorting for flx ido matching." 201 | (cl-destructuring-bind (exact res-items) 202 | (flx-ido-narrowed query items) 203 | (flx-ido-debug "exact: %s\nbefore hash count %s " exact (hash-table-count flx-ido-narrowed-matches-hash)) 204 | (flx-ido-cache query (if exact 205 | res-items 206 | (flx-ido-match-internal query res-items))))) 207 | 208 | (defun flx-ido-query-to-regexp (query) 209 | "Convert QUERY to flx style case folding regexp." 210 | (let* ((breakdown-str (mapcar (lambda (c) 211 | (apply 'string c (when (= (downcase c) c) 212 | (list (upcase c))))) 213 | query)) 214 | (re (concat (format "[%s]" (nth 0 breakdown-str)) 215 | (mapconcat (lambda (c) 216 | (format "[^%s]*[%s]" c c)) 217 | (cdr breakdown-str) "")))) 218 | re)) 219 | 220 | (defun flx-flex-match (query items) 221 | "Reimplement ido's flex matching. 222 | Our implementation always uses flex and doesn't care about substring matches." 223 | (if (zerop (length query)) 224 | items 225 | (let* ((case-fold-search nil) 226 | (re (flx-ido-query-to-regexp query)) 227 | matches) 228 | (mapc 229 | (lambda (item) 230 | (let ((name (ido-name item))) 231 | (if (string-match re name) 232 | (setq matches (cons item matches))))) 233 | items) 234 | (delete-consecutive-dups (nreverse matches) t)))) 235 | 236 | ;;;###autoload 237 | (define-minor-mode flx-ido-mode 238 | "Toggle flx ido mode" 239 | :init-value nil 240 | :lighter "" 241 | :group 'ido 242 | :global t) 243 | 244 | (defadvice ido-exit-minibuffer (around flx-ido-reset activate) 245 | "Remove flx properties after." 246 | (let* ((obj (car ido-matches)) 247 | (str (if (consp obj) 248 | (car obj) 249 | obj))) 250 | (when (and flx-ido-mode str) 251 | (remove-text-properties 0 (length str) 252 | '(face flx-highlight-face) str)) 253 | (flx-ido-reset)) 254 | 255 | ad-do-it) 256 | 257 | (defadvice ido-read-internal (before flx-ido-reset activate) 258 | "Clear flx narrowed hash beforehand." 259 | (when flx-ido-mode 260 | (flx-ido-reset))) 261 | 262 | (defadvice ido-restrict-to-matches (before flx-ido-reset activate) 263 | "Clear flx narrowed hash." 264 | (when flx-ido-mode 265 | (flx-ido-reset))) 266 | 267 | (defadvice ido-set-matches-1 (around flx-ido-set-matches-1 activate compile) 268 | "Choose between the regular ido-set-matches-1 and flx-ido-match" 269 | (if (not flx-ido-mode) 270 | ad-do-it 271 | (let* ((query ido-text) 272 | (original-items (ad-get-arg 0))) 273 | (flx-ido-debug "query: %s" query) 274 | (flx-ido-debug "id-set-matches-1 sees %s items" (length original-items)) 275 | (setq ad-return-value (flx-ido-match query original-items))) 276 | (flx-ido-debug "id-set-matches-1 returning %s items starting with %s " (length ad-return-value) (car ad-return-value)))) 277 | 278 | (defadvice ido-kill-buffer-at-head (before flx-ido-reset activate) 279 | "Keep up with modification as required." 280 | (when flx-ido-mode 281 | ;; if not at EOB, query text is deleted. 282 | (when (eobp) 283 | (flx-ido-reset)))) 284 | 285 | (add-hook 'ido-minibuffer-setup-hook 'flx-ido-reset nil) 286 | 287 | (provide 'flx-ido) 288 | 289 | ;;; flx-ido.el ends here 290 | -------------------------------------------------------------------------------- /tests/flx-test.el: -------------------------------------------------------------------------------- 1 | ;;; flx-test.el --- flx ert unit tests 2 | 3 | ;; Copyright © 2013 Le Wang 4 | 5 | ;; Author: Le Wang 6 | ;; Maintainer: Le Wang 7 | ;; Description: fuzzy matching with good sorting 8 | ;; Created: Tue Apr 16 23:32:32 2013 (+0800) 9 | ;; URL: https://github.com/lewang/flx 10 | 11 | ;; This file is NOT part of GNU Emacs. 12 | 13 | ;;; License 14 | 15 | ;; This program is free software; you can redistribute it and/or modify 16 | ;; it under the terms of the GNU General Public License as published by 17 | ;; the Free Software Foundation, either version 3 of the License, or 18 | ;; (at your option) any later version. 19 | ;; 20 | ;; This program is distributed in the hope that it will be useful, 21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | ;; GNU General Public License for more details. 24 | ;; 25 | ;; You should have received a copy of the GNU General Public License 26 | ;; along with this program. If not, see . 27 | 28 | ;;; Commentary: 29 | 30 | ;;; Code: 31 | 32 | (require 'ert) 33 | (require 'async) 34 | (require 'flx) 35 | 36 | (ert-deftest flx-test-sanity () 37 | "sanity check." 38 | (should (= 1 1))) 39 | 40 | (ert-deftest flx-get-hash-for-string () 41 | (let ((h (flx-get-hash-for-string "aab" 'flx-get-heatmap-str))) 42 | (should (equal '(0 1) (gethash ?a h) )) 43 | (should (equal '(2) (gethash ?b h))) 44 | (should (= 3 (hash-table-count h))))) 45 | 46 | (ert-deftest flx-get-hash-mixed-case () 47 | (let ((h (flx-get-hash-for-string "aAb" 'flx-get-heatmap-str))) 48 | (should (equal '(0 1) (gethash ?a h) )) 49 | (should (equal '(1) (gethash ?A h) )) 50 | (should (equal '(2) (gethash ?b h))) 51 | ;; upper case appears twice 52 | (should (= 4 (hash-table-count h))))) 53 | 54 | (ert-deftest flx-boundary-p () 55 | (should (flx-boundary-p ?/ ?a)) 56 | (should (flx-boundary-p nil ?a)) 57 | (should-not (flx-boundary-p ?a ?/)) 58 | (should (flx-boundary-p ?/ ?A)) 59 | (should (flx-boundary-p ?a ?A))) 60 | 61 | (ert-deftest flx-capital-p () 62 | (should (flx-capital-p ?A)) 63 | (should (flx-capital-p ?Z)) 64 | (should (flx-capital-p ?Д)) 65 | (should-not (flx-capital-p ?_)) 66 | (should-not (flx-capital-p ?a)) 67 | (should-not (flx-capital-p ?д))) 68 | 69 | (ert-deftest flx-word-p () 70 | (should (flx-word-p ?a)) 71 | (should (flx-word-p ?A)) 72 | (should-not (flx-word-p ?_))) 73 | 74 | (ert-deftest flx-inc-vec () 75 | "roll and unroll should be bring back original score" 76 | (let ((vec (vector 1 2 3))) 77 | (should (equal (vector 2 3 4) (flx-inc-vec vec))))) 78 | 79 | (ert-deftest flx-get-heatmap-vector-basic () 80 | "see worksheet for derivation" 81 | (let ((res (flx-get-heatmap-file "__abcab"))) 82 | (should (equal res [84 81 78 -8 -9 -10 -10]))) 83 | (let ((res (flx-get-heatmap-file "ab_cde-fghi"))) 84 | (should (equal res [82 -4 -5 79 -7 -8 -9 76 -10 -11 -11]))) 85 | (let ((res (flx-get-heatmap-file "xyz/ab_cde-fghi"))) 86 | (should (equal res [43 -43 -44 -45 78 -8 -9 75 -11 -12 -13 72 -14 -15 -15]))) 87 | (let ((res (flx-get-heatmap-file "ab_cde-fghi/x"))) 88 | (should (equal res [43 -43 -44 40 -46 -47 -48 37 -49 -50 -51 -52 81]))) 89 | (let ((res (flx-get-heatmap-file "1/ab_cde-fghi/x"))) 90 | (should (equal res [41 -45 39 -47 -48 36 -50 -51 -52 33 -53 -54 -55 -56 80]))) 91 | (let ((res (flx-get-heatmap-file "ab_cd/ef/g_h/i"))) 92 | (should (equal res [39 -47 -48 36 -50 -51 37 -49 -50 38 -48 35 -51 79]))) 93 | (let ((res (flx-get-heatmap-file "a/b/c/d/e/f/g/h/i/j/k"))) 94 | (should (equal res [25 -61 23 -63 24 -62 25 -61 26 -60 27 -59 28 -58 29 -57 30 -56 31 -55 72]))) 95 | (let ((res (flx-get-heatmap-file "a/cd.ef"))) 96 | (should (equal res [43 -43 79 -7 -8 31 -9])))) 97 | 98 | 99 | (ert-deftest flx-score-basic () 100 | "basic scoring -- matches get number, non-matches get nil" 101 | ;; matches 102 | (mapc (lambda (str) 103 | (should (flx-score str "a" (flx-make-filename-cache)))) 104 | '("a" 105 | "ba" 106 | "ab" 107 | ".a" 108 | "aaaa" 109 | "foo.bra" 110 | "a/foo" 111 | "b/a/foo" 112 | "b/.a/foo" 113 | "b/.a./foo")) 114 | ;; empty string should not match anything 115 | (mapc (lambda (str) 116 | (should-not (flx-score str "" (flx-make-filename-cache)))) 117 | '("" 118 | "zz" 119 | ".")) 120 | ;; non-matches 121 | (mapc (lambda (str) 122 | (should-not (flx-score str "a" (flx-make-filename-cache)))) 123 | '("" 124 | "zz" 125 | "."))) 126 | 127 | 128 | (ert-deftest flx-score-capital () 129 | "QUERY should not be downcased." 130 | (should-not (flx-score "abc" "A" (flx-make-filename-cache)))) 131 | 132 | (ert-deftest flx-score-string () 133 | "score as string" 134 | (let ((string-as-path-score (flx-score "a/b" "a" (flx-make-string-cache))) 135 | (string-score (flx-score "a_b" "a" (flx-make-string-cache)))) 136 | (should (= (car string-as-path-score) 137 | (car string-score))))) 138 | 139 | 140 | (ert-deftest flx-basename-order () 141 | "index of match matters" 142 | (let* ((query "a") 143 | (higher (flx-score "a_b_c" query (flx-make-filename-cache))) 144 | (lower (flx-score "b_a_c" query (flx-make-filename-cache)))) 145 | (should (> (car higher) (car lower))))) 146 | 147 | (ert-deftest flx-basename-lead-separators () 148 | "leading word separators should be penalized" 149 | (let* ((query "a") 150 | (higher (flx-score "ab" query (flx-make-filename-cache))) 151 | (lower (flx-score "_ab" query (flx-make-filename-cache)))) 152 | (should (> (car higher) (car lower))))) 153 | 154 | 155 | (ert-deftest flx-entire-match-1 () 156 | "whole match is preferred" 157 | (let* ((query "a") 158 | (higher (flx-score "a" query (flx-make-filename-cache))) 159 | (lower (flx-score "ab" query (flx-make-filename-cache)))) 160 | (should (> (car higher) (car lower))))) 161 | 162 | ;;;;;;;;;;;;;; 163 | ;; advanced ;; 164 | ;;;;;;;;;;;;;; 165 | 166 | (ert-deftest flx-filename-non-anchored-substring-yields-better () 167 | "Preferring to match beginning-of-word can lead to wrong answers. 168 | 169 | In this case, the match with more contiguous characters is better." 170 | (let* ((query "abcd") 171 | (higher (flx-score "f a fbcd/fabcd/z" query (flx-make-filename-cache))) 172 | (lower (flx-score "f a fbcd/z" query (flx-make-filename-cache)))) 173 | (should (> (car higher) (car lower))))) 174 | 175 | 176 | 177 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 178 | ;; imported from Command-t tests ;; 179 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 180 | 181 | 182 | (ert-deftest flx-imported-prioritizes-matches-with-more-matching-characters () 183 | (let* ((str "foobar") 184 | (higher (flx-score str "fbar" (flx-make-filename-cache))) 185 | (lower (flx-score str "fb" (flx-make-filename-cache)))) 186 | (should (> (car higher) (car lower))))) 187 | 188 | (ert-deftest flx-imported-prioritizes-shorter-paths-over-longer-ones () 189 | (let* ((query "art") 190 | (higher (flx-score "articles.rb" query (flx-make-filename-cache))) 191 | (lower (flx-score "articles_controller_spec.rb" query (flx-make-filename-cache)))) 192 | (should (> (car higher) (car lower))))) 193 | 194 | 195 | ;;; I've had to modify these test heavily, every assertion Command-t 196 | ;;; makes, we've gone the opposite way. :) 197 | ;;; 198 | ;;; We strongly prefer basename matches, where as they do not. 199 | 200 | (ert-deftest flx-imported-prioritizes-matches-after-/ () 201 | (let ((query "b")) 202 | (let ((higher (flx-score "foo/bar" query (flx-make-filename-cache))) 203 | (lower (flx-score "foobar" query (flx-make-filename-cache)))) 204 | (should (> (car higher) (car lower)))) 205 | (let ((higher (flx-score "foo/bar" query (flx-make-filename-cache))) 206 | (lower (flx-score "foo9bar" query (flx-make-filename-cache)))) 207 | (should (> (car higher) (car lower)))) 208 | (let ((higher (flx-score "foo/bar" query (flx-make-filename-cache))) 209 | (lower (flx-score "foo.bar" query (flx-make-filename-cache)))) 210 | (should (> (car higher) (car lower)))))) 211 | 212 | 213 | 214 | (ert-deftest flx-imported-prioritizes-matches-after-- () 215 | (let ((query "b")) 216 | (let ((higher (flx-score "foo-bar" query (flx-make-filename-cache))) 217 | (lower (flx-score "foobar" query (flx-make-filename-cache)))) 218 | (should (> (car higher) (car lower)))) 219 | (let ((higher (flx-score "foo-bar" query (flx-make-filename-cache))) 220 | (lower (flx-score "foo.bar" query (flx-make-filename-cache)))) 221 | (should (> (car higher) (car lower)))))) 222 | 223 | (ert-deftest flx-imported-prioritizes-matches-after-_ () 224 | (let ((query "b")) 225 | (let ((higher (flx-score "foo_bar" query (flx-make-filename-cache))) 226 | (lower (flx-score "foobar" query (flx-make-filename-cache)))) 227 | (should (> (car higher) (car lower)))) 228 | (let ((higher (flx-score "foo_bar" query (flx-make-filename-cache))) 229 | (lower (flx-score "foo.bar" query (flx-make-filename-cache)))) 230 | (should (> (car higher) (car lower)))))) 231 | 232 | (ert-deftest flx-imported-prioritizes-matches-after-space () 233 | (let ((query "b")) 234 | (let ((higher (flx-score "foo bar" query (flx-make-filename-cache))) 235 | (lower (flx-score "foobar" query (flx-make-filename-cache)))) 236 | (should (> (car higher) (car lower)))) 237 | (let ((higher (flx-score "foo bar" query (flx-make-filename-cache))) 238 | (lower (flx-score "foo.bar" query (flx-make-filename-cache)))) 239 | (should (> (car higher) (car lower)))))) 240 | 241 | (ert-deftest flx-imported-prioritizes-matches-after-periods () 242 | (let ((query "b")) 243 | (let ((higher (flx-score "foo.bar" query (flx-make-filename-cache))) 244 | (lower (flx-score "foobar" query (flx-make-filename-cache)))) 245 | (should (> (car higher) (car lower)))))) 246 | 247 | (ert-deftest flx-imported-prioritizes-matching-capitals-following-lowercase () 248 | (let ((query "b")) 249 | (let ((higher (flx-score "fooBar" query (flx-make-filename-cache))) 250 | (lower (flx-score "foobar" query (flx-make-filename-cache)))) 251 | (should (> (car higher) (car lower)))))) 252 | 253 | (ert-deftest prioritizes-matches-earlier-in-the-string () 254 | (let ((query "b")) 255 | (let ((higher (flx-score "**b*****" query (flx-make-filename-cache))) 256 | (lower (flx-score "******b*" query (flx-make-filename-cache)))) 257 | (should (> (car higher) (car lower)))))) 258 | 259 | 260 | (ert-deftest flx-imported-prioritizes-matches-closer-to-previous-matches () 261 | (let ((query "bc")) 262 | (let ((higher (flx-score "**bc****" query (flx-make-filename-cache))) 263 | (lower (flx-score "**b***c*" query (flx-make-filename-cache)))) 264 | (should (> (car higher) (car lower)))))) 265 | 266 | 267 | (ert-deftest flx-imported-scores-alternative-matches-of-same-path-differently () 268 | (let ((query "artcon")) 269 | (let ((higher (flx-score "***/***********/art*****_con*******.**" query (flx-make-filename-cache))) 270 | (lower (flx-score "a**/****r******/**t*c***_*on*******.**" query (flx-make-filename-cache)))) 271 | (should (> (car higher) (car lower)))))) 272 | 273 | (ert-deftest flx-imported-provides-intuitive-results-for-artcon-and-articles_controller () 274 | (let ((query "artcon")) 275 | (let ((higher (flx-score "app/controllers/articles_controller.rb" query (flx-make-filename-cache))) 276 | (lower (flx-score "app/controllers/heartbeat_controller.rb" query (flx-make-filename-cache)))) 277 | (should (> (car higher) (car lower)))))) 278 | 279 | (ert-deftest flx-imported-provides-intuitive-results-for-aca-and-a/c/articles_controller () 280 | (let ((query "aca")) 281 | (let ((lower (flx-score "app/controllers/heartbeat_controller.rb" query (flx-make-filename-cache))) 282 | (higher (flx-score "app/controllers/articles_controller.rb" query (flx-make-filename-cache))) 283 | (best (flx-score "a**/c**********/a******************.**" query (flx-make-filename-cache)))) 284 | (should (> (car higher) (car lower))) 285 | ;; our best is a higher score than higher because we penalize higher for 286 | ;; having one more word. 287 | (should (> (car best) (car higher)))))) 288 | 289 | 290 | (ert-deftest flx-imported-provides-intuitive-results-for-d-and-doc/command-t.txt () 291 | (let ((query "d")) 292 | (let ((lower (flx-score "TODO" query (flx-make-filename-cache))) 293 | (higher (flx-score "doc/command-t.txt" query (flx-make-filename-cache)))) 294 | (should (> (car higher) (car lower)))))) 295 | 296 | (ert-deftest flx-imported-provides-intuitive-results-for-do-and-doc/command-t.txt () 297 | (let ((query "do")) 298 | ;; This test is flipped around, because we consider capitals to always be 299 | ;; word starters, and we very heavily favor basepath matches. 300 | (let ((higher (flx-score "doc/command-t.txt" query (flx-make-filename-cache))) 301 | (lower (flx-score "TODO" query (flx-make-filename-cache)))) 302 | (should (> (car higher) (car lower)))))) 303 | 304 | 305 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 306 | ;; new features (not in ST2) ;; 307 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 308 | 309 | (ert-deftest flx-entire-match-3 () 310 | "when entire string is match, it should overpower acronym matches" 311 | (let* ((query "rss") 312 | (higher (flx-score "rss" query (flx-make-filename-cache))) 313 | (lower (flx-score "rff-sff-sff" query (flx-make-filename-cache)))) 314 | (should (> (car higher) (car lower))))) 315 | 316 | (ert-deftest flx-entire-match-5 () 317 | "when entire string is match, 4 letters is the cutoff when 318 | substring can overpower abbreviation." 319 | (let* ((query "rssss") 320 | (higher (flx-score "rssss" query (flx-make-filename-cache))) 321 | (lower (flx-score "rff-sff-sff-sff-sff" query (flx-make-filename-cache)))) 322 | (should (> (car higher) (car lower))))) 323 | 324 | (ert-deftest flx-capital-runs () 325 | "Runs of capital letters should be considered one word." 326 | (let* ((query "ab") 327 | (score1 (flx-score "AFFB" query (flx-make-filename-cache))) 328 | (score2 (flx-score "affb" query (flx-make-filename-cache)))) 329 | (should (= (car score1) (car score2))))) 330 | 331 | 332 | (ert-deftest flx-basepath-is-last-segment () 333 | "For a path like \"bar/foo/\" the basename should be foo" 334 | (let* ((query "def") 335 | (higher (flx-score "defuns/" query (flx-make-filename-cache))) 336 | (lower (flx-score "sane-defaults.el" query (flx-make-filename-cache)))) 337 | (should (> (car higher) (car lower))))) 338 | 339 | (ert-deftest flx-case-fold () 340 | "Lower case can match lower or upper case, but upper case can only match upper case." 341 | (let* ((query "def") 342 | (lower-folds (flx-score "Defuns/" query (flx-make-filename-cache)))) 343 | (should lower-folds)) 344 | (let* ((query "Def") 345 | (upper-no-folds (flx-score "defuns/" query (flx-make-filename-cache)))) 346 | (should (not upper-no-folds)))) 347 | 348 | 349 | ;;; perf 350 | 351 | (ert-deftest flx-prune-search-space-optimizations () 352 | "Make sure optimizations that prune bad paths early are working." 353 | (let ((future (async-start 354 | `(lambda () 355 | ,(async-inject-variables "\\`load-path\\'") 356 | (require 'flx) 357 | (flx-score "~/foo/bar/blah.elllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllllll" "lllllllllllllllllllllllllllllllll" (flx-make-filename-cache))) 358 | nil)) 359 | result) 360 | (with-timeout (1 (kill-process future) ) 361 | (while (not result) ;; while process is running 362 | (sit-for .2) 363 | (when (async-ready future) 364 | (setq result (async-get future))))) 365 | (should result))) 366 | 367 | 368 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 369 | ;;; flx-test.el ends here 370 | -------------------------------------------------------------------------------- /flx.el: -------------------------------------------------------------------------------- 1 | ;;; flx.el --- fuzzy matching with good sorting -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright © 2013, 2015 Le Wang 4 | 5 | ;; Author: Le Wang 6 | ;; Maintainer: Le Wang 7 | ;; Description: fuzzy matching with good sorting 8 | ;; Created: Wed Apr 17 01:01:41 2013 (+0800) 9 | ;; Version: 0.6.2 10 | ;; Package-Requires: ((cl-lib "0.3")) 11 | ;; URL: https://github.com/lewang/flx 12 | 13 | ;; This file is NOT part of GNU Emacs. 14 | 15 | ;;; License 16 | 17 | ;; This program is free software; you can redistribute it and/or modify 18 | ;; it under the terms of the GNU General Public License as published by 19 | ;; the Free Software Foundation, either version 3 of the License, or 20 | ;; (at your option) any later version. 21 | ;; 22 | ;; This program is distributed in the hope that it will be useful, 23 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 24 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 25 | ;; GNU General Public License for more details. 26 | ;; 27 | ;; You should have received a copy of the GNU General Public License 28 | ;; along with this program. If not, see . 29 | 30 | ;;; Commentary: 31 | 32 | ;; This package provides fuzzy completion matching with good sorting. 33 | 34 | ;; The sorting algorithm is a balance between word beginnings 35 | ;; (abbreviation) and contiguous matches (substring). 36 | 37 | ;; The longer the substring match, the higher it scores. This maps 38 | ;; well to how we think about matching. 39 | 40 | ;; In general, it's better form queries with only lowercase characters 41 | ;; so the sorting algorithm can do something smart. 42 | 43 | ;;; Implementation notes 44 | ;; 45 | ;; Use defsubst instead of defun. 46 | ;; 47 | ;; * Using bitmaps to check for matches worked out to be SLOWER than 48 | ;; just scanning the string and using `flx-get-matches'. 49 | ;; 50 | ;; * Consing causes GC, which can often slowdown Emacs more than the 51 | ;; benefits of an optimization. 52 | 53 | ;;; Acknowledgments 54 | 55 | ;; Scott Frazer's blog entry http://scottfrazersblog.blogspot.com.au/2009/12/emacs-better-ido-flex-matching.html 56 | ;; provided a lot of inspiration. 57 | ;; ido-hacks was helpful for ido optimization. 58 | 59 | ;;; Code: 60 | 61 | (require 'cl-lib) 62 | 63 | (defgroup flx nil 64 | "Fuzzy matching with good sorting." 65 | :group 'convenience 66 | :prefix "flx-") 67 | 68 | (defcustom flx-word-separators '(?\ ?- ?_ ?: ?. ?/ ?\\) 69 | "List of characters that act as word separators in flx." 70 | :type '(repeat character) 71 | :group 'flx) 72 | 73 | (defface flx-highlight-face 74 | '((t (:inherit font-lock-variable-name-face :bold t :underline t))) 75 | "Face used by flx for highlighting flx match characters." 76 | :group 'flx) 77 | 78 | ;; Do we need more word separators than ST? 79 | (defsubst flx-word-p (char) 80 | "Check if CHAR is a word character." 81 | (and char 82 | (not (memq char flx-word-separators)))) 83 | 84 | (defsubst flx-capital-p (char) 85 | "Check if CHAR is an uppercase character." 86 | (and char 87 | (flx-word-p char) 88 | (= char (upcase char)))) 89 | 90 | (defsubst flx-boundary-p (last-char char) 91 | "Check if LAST-CHAR is the end of a word and CHAR the start of the next. 92 | 93 | This function is camel-case aware." 94 | (or (null last-char) 95 | (and (not (flx-capital-p last-char)) 96 | (flx-capital-p char)) 97 | (and (not (flx-word-p last-char)) 98 | (flx-word-p char)))) 99 | 100 | (defsubst flx-inc-vec (vec &optional inc beg end) 101 | "Increment each element in VEC between BEG and END by INC. 102 | INC defaults to 1. BEG defaults to 0 and is inclusive. 103 | END is not inclusive and defaults to the length of VEC." 104 | (or inc 105 | (setq inc 1)) 106 | (or beg 107 | (setq beg 0)) 108 | (or end 109 | (setq end (length vec))) 110 | (while (< beg end) 111 | (cl-incf (aref vec beg) inc) 112 | (cl-incf beg)) 113 | vec) 114 | 115 | (defun flx-get-hash-for-string (str heatmap-func) 116 | "Return hash-table for string where keys are characters. 117 | Value is a sorted list of indexes for character occurrences." 118 | (let* ((res (make-hash-table :test 'eq :size 32)) 119 | (str-len (length str)) 120 | down-char) 121 | (cl-loop for index from (1- str-len) downto 0 122 | for char = (aref str index) 123 | do (progn 124 | ;; simulate `case-fold-search' 125 | (if (flx-capital-p char) 126 | (progn 127 | (push index (gethash char res)) 128 | (setq down-char (downcase char))) 129 | (setq down-char char)) 130 | (push index (gethash down-char res)))) 131 | (puthash 'heatmap (funcall heatmap-func str) res) 132 | res)) 133 | 134 | ;; So we store one fixnum per character. Is this too memory inefficient? 135 | (defun flx-get-heatmap-str (str &optional group-separator) 136 | "Generate the heatmap vector of string. 137 | 138 | See documentation for logic." 139 | (let* ((str-len (length str)) 140 | (str-last-index (1- str-len)) 141 | ;; ++++ base 142 | (scores (make-vector str-len -35)) 143 | (penalty-lead ?.) 144 | (groups-alist (list (list -1 0)))) 145 | ;; ++++ final char bonus 146 | (cl-incf (aref scores str-last-index) 1) 147 | ;; Establish baseline mapping 148 | (cl-loop for char across str 149 | for index from 0 150 | with last-char = nil 151 | with group-word-count = 0 152 | do (progn 153 | (let ((effective-last-char 154 | ;; before we find any words, all separaters are 155 | ;; considered words of length 1. This is so "foo/__ab" 156 | ;; gets penalized compared to "foo/ab". 157 | (if (zerop group-word-count) nil last-char))) 158 | (when (flx-boundary-p effective-last-char char) 159 | (setcdr (cdar groups-alist) 160 | (cons index (cl-cddar groups-alist)))) 161 | (when (and (not (flx-word-p last-char)) 162 | (flx-word-p char)) 163 | (cl-incf group-word-count))) 164 | ;; ++++ -45 penalize extension 165 | (when (eq last-char penalty-lead) 166 | (cl-incf (aref scores index) -45)) 167 | (when (eq group-separator char) 168 | (setcar (cdar groups-alist) group-word-count) 169 | (setq group-word-count 0) 170 | (push (nconc (list index group-word-count)) groups-alist)) 171 | (if (= index str-last-index) 172 | (setcar (cdar groups-alist) group-word-count) 173 | (setq last-char char)))) 174 | (let* ((group-count (length groups-alist)) 175 | (separator-count (1- group-count))) 176 | ;; ++++ slash group-count penalty 177 | (unless (zerop separator-count) 178 | (flx-inc-vec scores (* -2 group-count))) 179 | ;; score each group further 180 | (cl-loop for group in groups-alist 181 | for index from separator-count downto 0 182 | with last-group-limit = nil 183 | with basepath-found = nil 184 | do (let ((group-start (car group)) 185 | (word-count (cadr group)) 186 | ;; this is the number of effective word groups 187 | (words-length (length (cddr group))) 188 | basepath-p) 189 | (when (and (not (zerop words-length)) 190 | (not basepath-found)) 191 | (setq basepath-found t) 192 | (setq basepath-p t)) 193 | (let (num) 194 | (setq num 195 | (if basepath-p 196 | (+ 35 197 | ;; ++++ basepath separator-count boosts 198 | (if (> separator-count 1) 199 | (1- separator-count) 200 | 0) 201 | ;; ++++ basepath word count penalty 202 | (- word-count)) 203 | ;; ++++ non-basepath penalties 204 | (if (= index 0) 205 | -3 206 | (+ -5 (1- index))))) 207 | (flx-inc-vec scores num (1+ group-start) last-group-limit)) 208 | (cl-loop for word in (cddr group) 209 | for word-index from (1- words-length) downto 0 210 | with last-word = (or last-group-limit 211 | str-len) 212 | do (progn 213 | (cl-incf (aref scores word) 214 | ;; ++++ beg word bonus AND 215 | 85) 216 | (cl-loop for index from word below last-word 217 | for char-i from 0 218 | do (cl-incf (aref scores index) 219 | (- 220 | ;; ++++ word order penalty 221 | (* -3 word-index) 222 | ;; ++++ char order penalty 223 | char-i))) 224 | (setq last-word word))) 225 | (setq last-group-limit (1+ group-start))))) 226 | scores)) 227 | 228 | (defun flx-get-heatmap-file (filename) 229 | "Return heatmap vector for filename." 230 | (flx-get-heatmap-str filename ?/)) 231 | 232 | 233 | (defsubst flx-bigger-sublist (sorted-list val) 234 | "Return sublist bigger than VAL from sorted SORTED-LIST. 235 | 236 | If VAL is nil, return entire list." 237 | (if val 238 | (cl-loop for sub on sorted-list 239 | do (when (> (car sub) val) 240 | (cl-return sub))) 241 | sorted-list)) 242 | 243 | (defun flx-make-filename-cache () 244 | "Return cache hashtable appropriate for storing filenames." 245 | (flx-make-string-cache 'flx-get-heatmap-file)) 246 | 247 | (defun flx-make-string-cache (&optional heat-func) 248 | "Return cache hashtable appropriate for storing strings." 249 | (let ((hash (make-hash-table :test 'equal 250 | :size 4096))) 251 | (puthash 'heatmap-func (or heat-func 'flx-get-heatmap-str) hash) 252 | hash)) 253 | 254 | (defun flx-process-cache (str cache) 255 | "Get calculated heatmap from cache, add it if necessary." 256 | (let ((res (when cache 257 | (gethash str cache)))) 258 | (or res 259 | (progn 260 | (setq res (flx-get-hash-for-string 261 | str 262 | (or (and cache (gethash 'heatmap-func cache)) 263 | 'flx-get-heatmap-str))) 264 | (when cache 265 | (puthash str res cache)) 266 | res)))) 267 | 268 | (defun flx-find-best-match (str-info 269 | heatmap 270 | greater-than 271 | query 272 | query-length 273 | q-index 274 | match-cache) 275 | "Recursively compute the best match for a string, passed as STR-INFO and 276 | HEATMAP, according to QUERY. 277 | 278 | This function uses MATCH-CACHE to memoize its return values. 279 | For other parameters, see `flx-score'" 280 | 281 | ;; Here, we use a simple N'ary hashing scheme 282 | ;; You could use (/ hash-key query-length) to get greater-than 283 | ;; Or, (mod hash-key query-length) to get q-index 284 | ;; We use this instead of a cons key for the sake of efficiency 285 | (let* ((hash-key (+ q-index 286 | (* (or greater-than 0) 287 | query-length))) 288 | (hash-value (gethash hash-key match-cache))) 289 | (if hash-value 290 | ;; Here, we use the value 'no-match to distinguish a cache miss 291 | ;; from a nil (i.e. non-matching) return value 292 | (if (eq hash-value 'no-match) 293 | nil 294 | hash-value) 295 | (let ((indexes (flx-bigger-sublist 296 | (gethash (aref query q-index) str-info) 297 | greater-than)) 298 | (match) 299 | (temp-score) 300 | (best-score most-negative-fixnum)) 301 | 302 | ;; Matches are of the form: 303 | ;; ((match_indexes) . (score . contiguous-count)) 304 | (if (>= q-index (1- query-length)) 305 | ;; At the tail end of the recursion, simply 306 | ;; generate all possible matches with their scores 307 | ;; and return the list to parent. 308 | (setq match (mapcar (lambda (index) 309 | (cons (list index) 310 | (cons (aref heatmap index) 0))) 311 | indexes)) 312 | (dolist (index indexes) 313 | (dolist (elem (flx-find-best-match str-info 314 | heatmap 315 | index 316 | query 317 | query-length 318 | (1+ q-index) 319 | match-cache)) 320 | (setq temp-score 321 | (if (= (1- (caar elem)) index) 322 | (+ (cadr elem) 323 | (aref heatmap index) 324 | 325 | ;; boost contiguous matches 326 | (* (min (cddr elem) 327 | 3) 328 | 15) 329 | 60) 330 | (+ (cadr elem) 331 | (aref heatmap index)))) 332 | 333 | ;; We only care about the optimal match, so only 334 | ;; forward the match with the best score to parent 335 | (when (> temp-score best-score) 336 | (setq best-score temp-score 337 | match (list (cons (cons index (car elem)) 338 | (cons temp-score 339 | (if (= (1- (caar elem)) 340 | index) 341 | (1+ (cddr elem)) 342 | 0))))))))) 343 | 344 | ;; Calls are cached to avoid exponential time complexity 345 | (puthash hash-key 346 | (if match match 'no-match) 347 | match-cache) 348 | match)))) 349 | 350 | (defun flx-score (str query &optional cache) 351 | "Return best score matching QUERY against STR." 352 | (unless (or (zerop (length query)) 353 | (zerop (length str))) 354 | (let* 355 | ((str-info (flx-process-cache str cache)) 356 | (heatmap (gethash 'heatmap str-info)) 357 | (query-length (length query)) 358 | (full-match-boost (and (< 1 query-length) 359 | (< query-length 5))) 360 | 361 | ;; Raise recursion limit 362 | (max-lisp-eval-depth 5000) 363 | 364 | ;; Dynamic Programming table for memoizing flx-find-best-match 365 | (match-cache (make-hash-table :test 'eql :size 10)) 366 | 367 | (optimal-match (flx-find-best-match str-info 368 | heatmap 369 | nil 370 | query 371 | query-length 372 | 0 373 | match-cache))) 374 | ;; Postprocess candidate 375 | (and optimal-match 376 | (cons 377 | ;; This is the computed score, adjusted to boost the scores 378 | ;; of exact matches. 379 | (if (and full-match-boost 380 | (= (length (caar optimal-match)) 381 | (length str))) 382 | (+ (cl-cadar optimal-match) 10000) 383 | (cl-cadar optimal-match)) 384 | 385 | ;; This is the list of match positions 386 | (caar optimal-match)))))) 387 | 388 | (defun flx-propertize (obj score &optional add-score) 389 | "Return propertized copy of obj according to score. 390 | 391 | SCORE of nil means to clear the properties." 392 | (let ((block-started (cadr score)) 393 | (last-char nil) 394 | (str (if (consp obj) 395 | (substring-no-properties (car obj)) 396 | (substring-no-properties obj)))) 397 | 398 | (when score 399 | (dolist (char (cdr score)) 400 | (when (and last-char 401 | (not (= (1+ last-char) char))) 402 | (put-text-property block-started (1+ last-char) 403 | 'face 'flx-highlight-face str) 404 | (setq block-started char)) 405 | (setq last-char char)) 406 | (put-text-property block-started (1+ last-char) 407 | 'face 'flx-highlight-face str) 408 | (when add-score 409 | (setq str (format "%s [%s]" str (car score))))) 410 | (if (consp obj) 411 | (cons str (cdr obj)) 412 | str))) 413 | 414 | 415 | 416 | (defvar flx-file-cache nil 417 | "Cached heatmap info about strings.") 418 | 419 | ;; Reset value on every file load. 420 | (setq flx-file-cache (flx-make-filename-cache)) 421 | 422 | (defvar flx-strings-cache nil 423 | "Cached heatmap info about filenames.") 424 | 425 | ;; Reset value on every file load. 426 | (setq flx-strings-cache (flx-make-string-cache)) 427 | 428 | 429 | (provide 'flx) 430 | 431 | ;; Local Variables: 432 | ;; indent-tabs-mode: nil 433 | ;; End: 434 | ;;; flx.el ends here 435 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------