paced-1.1.1/ 0000755 0001752 0001753 00000000000 13236276726 011235 5 ustar elpa elpa paced-1.1.1/Project.ede 0000644 0001752 0001753 00000003361 13232054655 013314 0 ustar elpa elpa ;; Object ede-proj-project
;; Copyright (C) 2017-2018 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see .
;; EDE Project Files are auto generated: Do Not Edit
(ede-proj-project "ede-proj-project"
:file "Project.ede"
:name "paced"
:targets
(list
(ede-proj-target-elisp "ede-proj-target-elisp"
:name "compile"
:path ""
:source '("paced.el" "paced-async.el")
:aux-packages '("async" "paced"))
(ede-proj-target-elisp-autoloads "ede-proj-target-elisp-autoloads"
:name "autoloads"
:path ""
:source '("paced.el" "paced-async.el")
:autoload-file "paced-autoloads.el")
(ede-proj-target-makefile-miscelaneous "ede-proj-target-makefile-miscelaneous"
:name "check"
:path ""
:source '("paced-tests.el" "test.mk" "test-files/first.txt" "test-files/second.cpp" "test-files/third.org")
:partofall nil
:submakefile "test.mk")
(ede-proj-target-aux "ede-proj-target-aux"
:name "extra"
:path ""
:source '("paced.org")))
:web-site-url "https://savannah.nongnu.org/projects/paced-el"
:configuration-variables nil)
paced-1.1.1/paced-async.el 0000644 0001752 0001753 00000010011 13236276454 013735 0 ustar elpa elpa ;;; paced-async.el --- Support for asynchronous population -*- lexical-binding: t; -*-
;; Copyright (C) 2017-2018 Free Software Foundation, Inc.
;; Author: Ian Dunn
;; Maintainer: Ian Dunn
;; Keywords: convenience, completion
;; Package-Requires: ((emacs "25.1") (async "1.9.1"))
;; URL: https://savannah.nongnu.org/projects/paced-el/
;; Version: 1.1.1
;; Created: 22 Jan 2017
;; Modified: 05 Feb 2018
;; This file is part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free Software
;; Foundation; either version 3, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
;; details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see .
;;; Commentary:
;; Population can be a slow task. The more files from which you want to
;; populate a dictionary, the longer repopulation is going to take.
;; This extension to paced takes advantage of John Wiegley's async package to
;; repopulate a dictionary asynchronously.
;;; Code:
(require 'paced)
(require 'async)
(eval-when-compile (require 'subr-x))
(defcustom paced-async-load-file (locate-user-emacs-file "paced-async.el")
"File to load with user-specific population settings.
This may contain commands required for running each dictionary's
population commmands, or load additional files."
:group 'paced
:type 'file)
(cl-defmethod paced-dictionary-repopulate-async ((dictionary paced-dictionary))
"Repopulate DICTIONARY asynchronously.
Note that DICTIONARY isn't modified directly by this process, but
the updated dictionary is loaded when repopulation completes.
Therefore, you can continue using it without issue during
repopulation.
Side note: All dictionaries are reloaded when this function
finishes, so temporary changes to any dictionaries will be lost
as a result."
(let* ((variables '("load-path" ;; Find libraries, including paced
;; Settings
"paced-thing-at-point-constituent"
"paced-dictionary-directory"
;; The load file itself
"paced-async-load-file"))
(inject-string (concat "^\\("
(mapconcat 'identity variables "\\|")
"\\)$")))
(message "Repopulating dictionary %s" (paced-dictionary-name dictionary))
(async-start
`(lambda ()
;; Inject the environment to get `load-path' and user settings
,(async-inject-variables inject-string)
;; Require paced and load the async settings file
(require 'paced)
(load-file paced-async-load-file)
;; Repopulate and save the dictionary
(paced-dictionary-repopulate ,dictionary)
(paced-dictionary-save ,dictionary))
(lambda (_result)
(message "Finished repopulating dictionary")
(paced-load-all-dictionaries)))))
;;;###autoload
(defun paced-repopulate-named-dictionary-async (key)
"Repopulate dictionary named KEY from its population commands, asynchronously.
Population commands are stored in the field of the same name.
Note that this will empty the dictionary's contents."
(interactive
(list (paced-read-dictionary)))
(paced-operate-on-named-dictionary key
(paced-dictionary-repopulate-async dict)))
;;;###autoload
(defun paced-repopulate-current-dictionary-async ()
"Repopulate current dictionary from its population commands, asynchronously.
Population commands are stored in the field of the same name.
Note that this will empty the dictionary's contents."
(interactive)
(paced-operate-on-current-dictionary
(paced-dictionary-repopulate-async dict)))
(provide 'paced-async)
;;; paced-async.el ends here
paced-1.1.1/.elpaignore 0000644 0001752 0001753 00000000066 13213056546 013354 0 ustar elpa elpa Project.ede
Makefile
test.mk
test-files
paced-tests.el paced-1.1.1/.bzrignore 0000644 0001752 0001753 00000000153 13213056546 013225 0 ustar elpa elpa *.elc
*~
paced-autoloads.el
Makefile
.deps
test-files/paced-dictionary-case-sensitive
paced.html
paced.texi paced-1.1.1/paced.el 0000644 0001752 0001753 00000140631 13236276454 012636 0 ustar elpa elpa ;;; paced.el --- Predictive Abbreviation Completion and Expansion using Dictionaries -*- lexical-binding: t; -*-
;; Copyright (C) 2017-2018 Free Software Foundation, Inc.
;; Author: Ian Dunn
;; Maintainer: Ian Dunn
;; Keywords: convenience, completion
;; Package-Requires: ((emacs "25.1") (async "1.9.1"))
;; URL: https://savannah.nongnu.org/projects/paced-el/
;; Version: 1.1.1
;; Created: 22 Jan 2017
;; Modified: 05 Feb 2018
;; This file is part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free Software
;; Foundation; either version 3, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
;; details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see .
;;; Commentary:
;; Paced (Predictive Abbreviation Completion and Expansion using Dictionaries)
;; scans a group of files (determined by "population commands") to construct a
;; usage table (dictionary). Words (or symbols) are sorted by their usage, and
;; may be later presented to the user for completion. A dictionary can then be
;; saved to a file, to be loaded later.
;; Population commands determine how a dictionary should be filled with words or
;; symbols. A dictionary may have multiple population commands, and population
;; may be performed asynchronously. Once population is finished, the contents
;; are sorted, with more commonly used words at the front. Dictionaries may be
;; edited through EIEIO's customize-object interface.
;; Completion is done through `completion-at-point'. The dictionary to use for
;; completion can be customized.
;;; Code:
(eval-when-compile (require 'subr-x))
(require 'thingatpt)
(require 'map)
(require 'eieio-base)
(require 'rx)
;; Compatibility for Emacs < 26.1
(unless (fboundp 'if-let*)
(defalias 'if-let* 'if-let))
(unless (fboundp 'when-let*)
(defalias 'when-let* 'when-let))
(defgroup paced nil
"Predictive Abbreviation Completion and Expansion using Dictionaries"
:group 'convenience)
(defcustom paced-thing-at-point-constituent 'symbol
"Symbol defining THING which function `paced-mode' works on.
This symbol should be understandable by
`bounds-of-thing-at-point'. This symbol defines what function `paced-mode'
considers to be the basic unit of expansion. If if it set to `symbol',
for example, \"paced-mode\" would be offered as an expansion, while
if it is set to `word' \"paced\" and \"mode\" would be offered."
:group 'paced
:type 'symbol
:options '(symbol word))
(defcustom paced-completion-ignore-case t
"Non-nil to ignore case when completing.
Note that this does not affect dictionary population."
:group 'paced
:type 'boolean)
(defcustom paced-dictionary-directory (locate-user-emacs-file "paced-dictionaries/")
"Directory in which the dictionaries are saved.
This is only used in `paced-load-all-dictionaries', so it's up to
the user whether to save dictionaries here."
:group 'paced
:type 'directory)
(defcustom paced-dictionary-directory-whitelist-regexp ".*"
"Regexp to match when reading from the dictionary directory.
Any files that match this regexp will be loaded by
`paced-load-all-dictionaries'."
:group 'paced
:type 'regexp)
(defcustom paced-dictionary-directory-blacklist-regexp "$^"
"Regexp to match for files NOT to load with `paced-load-all-dictionaries'.
This is the string \"$^\" by default, which matches nothing, thus
allowing all files."
:group 'paced
:type 'regexp)
(defcustom paced-load-all-dictionaries-recursively nil
"Whether to recursively load all files with `paced-load-all-dictionaries'."
:group 'paced
:type 'boolean)
(defcustom paced-repopulate-saves-dictionary t
"Whether to save a dictionary after repopulation."
:group 'paced
:type 'boolean)
(defcustom paced-populate-warn-about-reset t
"Whether to warn the user about resetting a dictionary when repopulating."
:group 'paced
:type 'boolean)
(defcustom paced-point-in-thing-at-point-for-exclusion 'beginning
"Symbol to indicate from where exclusion should occur.
If 'beginning, exclusion is checked at the beginning of the thing
at point. If 'end, exclusion is checked at the end of the thing
at point.
See `paced-excluded-p' and `paced-exclude-function' for more
information on exclusion."
:group 'paced
:type 'symbol
:options '(beginning end))
(defcustom paced-character-limit 0
"Character limit for including things in paced.
If set to 0, impose no limit. Otherwise, include words whose
length is less than or equal to the value."
:group 'paced
:type 'number)
(defun paced--default-dictionary-sort-func (usage-hash)
"Default dictionary sort function.
Sort hash-table USAGE-HASH by the weights (values) in the table."
;; Unfortunately, there's no way to sort a hash-table, so we first convert it
;; into an alist, and sort that.
(let ((seq (map-into usage-hash 'list)))
(setq seq
(seq-sort
(pcase-lambda (`(_ . ,usage-lhs)
`(_ . ,usage-rhs))
(> usage-lhs usage-rhs))
seq))
(map-into seq 'hash-table)))
(defclass paced-dictionary (eieio-named eieio-persistent)
((object-name :initarg :object-name
:documentation "Symbol to use to refer to this dictionary.")
(usage-hash :initarg :usage-hash
:initform (make-hash-table :test #'equal)
:type hash-table
:documentation "Stores the usage data for this dictionary.
This is a hash table, mapping a word to the times it has been used.")
(population-commands
:initarg :population-commands
:initform nil
:type (list-of paced-population-command)
:custom (repeat (object :objectcreatefcn paced-new-population-command-custom))
:label "Population Commands"
:documentation "Commands to use when populating this dictionary.
Each entry is a `paced-population-command'.")
(file-header-line :type string
:allocation :class
:initform ";; Paced Dictionary"
:documentation
"Header line for the save file.
This is used with the `object-write' method.")
(case-handling :initarg :case-handling
:initform downcase
:type (member downcase upcase preserve downcase-first upcase-first mixed-case)
:custom (choice (const :tag "Downcase All Words" downcase)
(const :tag "Upcase All Words" upcase)
(const :tag "Preserve Case" preserve)
(const :tag "Downcase Just the First Letter" downcase-first)
(const :tag "Upcase Just the First Letter" upcase-first)
(const :tag "Preserve Case on Mixed-Case Words" mixed-case))
:label "Case Handling"
:documentation "How case should be handled during population.
It can be one of the following:
* downcase Downcase every word
* upcase Upcase every word
* preserve Preserve case
* downcase-first Downcase the first letter of each word, leave the rest the same
* upcase-first Upcase the first letter of each word, leave the rest the same
* mixed-case Preserve case on mixed-case words; single-case words
are downcased. See `paced-mixed-case-word-p' for an
explanation of how \"mixed-case\" is defined.")
(updated :initarg :updated
:initform nil
:type boolean
:documentation "Non-nil if this dictionary has been updated since it was last saved.")
(default-population-properties
:initarg :default-population-properties
:initform nil
:type list
:label "Default Properties"
:custom (alist :tag "Properties" :key-type variable :value-type sexp)
:documentation "Default properties for population commands.
Each element is of the form (VAR VALUE). Each VAR will be set to
VALUE during population for this dictionary.
Properties set in the individual population commands will
override settings here.
Some suggested variables for this are `paced-exclude-function'
and `paced-thing-at-point-constituent'.")
(sort-method :initarg :sort-method
:initform 'paced--default-dictionary-sort-func
:type function
:label "Sort Method"
:custom function
:documentation "Method by which this dictionary should sort its usage table.
This should be a function of one argument, the usage-hash slot,
and return a sorted hash-table.
This defaults to `paced--default-dictionary-sort-func'."))
"Paced dictionary.")
(defvar paced--registered-dictionaries (make-hash-table :test 'equal)
"Internal list of registered dictionaries.
Do not edit this list manually. Use `paced-make-dictionary'
instead.")
(defun paced-reset-registered-dictionaries ()
"Reset the registered dictionary list.
WARNING: This will result in the loss of all dictionaries. Only
do this if you know what you're doing, or are under the
supervision of someone who does."
(interactive)
(when (yes-or-no-p
"Warning: This will result in loss of all dictionaries. Continue?")
(setq paced--registered-dictionaries (make-hash-table :test 'equal))))
(defsubst paced-named-dictionary (key)
"Return a registered dictionary with name KEY.
If none exists, return nil."
(map-elt paced--registered-dictionaries key nil))
(defsubst paced-dictionary-names ()
"Get the names of the registered dictionaries."
(map-keys paced--registered-dictionaries))
(defsubst paced-read-dictionary ()
"Read the name of a registered dictionary."
(completing-read "Dictionary: " (map-keys paced--registered-dictionaries)))
(defsubst paced-dictionary-key-registered-p (key)
"Return non-nil if a dictionary with name KEY has been registered."
(map-contains-key paced--registered-dictionaries key))
(defvar paced-throw-error-on-no-registered t
"Whether to throw an error when a named dictionary can't be found.")
(defmacro paced-operate-on-named-dictionary (name &rest form)
"Run FORM on the dictionary with name NAME, bound to `dict'.
If no dictionary named NAME exists, throw an error."
(declare (indent 1))
`(if-let* ((dict (paced-named-dictionary ,name)))
(progn ,@form)
(when paced-throw-error-on-no-registered
(error "No paced dictionary called '%s' has been registered" ,name))))
(cl-defmethod paced-dictionary-register ((dict paced-dictionary))
"Registered dictionary DICT."
(map-put paced--registered-dictionaries (oref dict object-name) dict))
(defsubst paced--ensure-dictionary-directory ()
"Ensure that `paced-dictionary-directory' exists."
(make-directory paced-dictionary-directory t))
(defun paced-make-dictionary (name filename case-handling)
"Make a paced dictionary called NAME.
NAME is a string used to identify the new dictionary.
If a paced dictionary is already registered with name NAME, then
it is replaced with a new, empty one.
FILENAME is a file in which to store the new dictionary.
CASE-HANDLING is a symbol that denotes how to handle case during
population. See the case-handling slot of class
`paced-dictionary' for details.
Return value is the new dictionary."
(let ((new-dict (paced-dictionary
:object-name name
:file filename
:case-handling case-handling)))
(paced-dictionary-register new-dict)
new-dict))
(defun paced-create-new-dictionary (name file)
"Create a new dictionary called NAME.
FILE is the file in which to store the new dictionary.
Once named, the dictionary can be edited through the EIEIO
customization interface."
(declare (interactive-only paced-make-dictionary))
(interactive (list (read-string "Name: ")
(read-file-name "Storage File: " paced-dictionary-directory)))
(let ((new-dict (paced-dictionary :object-name name
:file file)))
(customize-object new-dict)))
(cl-defmethod paced-dictionary-name ((obj paced-dictionary))
"Return the name of dictionary OBJ."
(oref obj object-name))
;;; Current Dictionary
(defcustom paced-global-dictionary-enable-alist nil
"List that determines which dictionaries should be active.
Each entry has the form (CONDITION . DICT-KEY), where CONDITION
is one of the following forms:
- A mode name, such as `org-mode' or `text-mode', indicating that
the named dictionary should be active in any mode derived from
that mode.
- A symbol, in which case the named dictionary is active whenever
the value of that symbol is non-nil.
- A function symbol, in which case the function is called with no
arguments to determine if the given dictionary should be
enabled. If the function returns non-nil the dictionary is enabled.
- A lambda function, in which case it is called with no
arguments, and if it returns non-nil, the dictionary is
enabled.
- The form (or CONDITION1 CONDITION2 ...), which enables the
given dictionary if any of the conditions are met.
- The form (and CONDITION1 CONDITION2 ...), which enables the
given dictionary if all of the conditions are met.
No matter what this list indicates, dictionaries will not be
enabled unless `paced-mode' is active."
:group 'paced
:type '(alist :key-type sexp :value-type string))
(define-obsolete-variable-alias 'paced-global-dict-enable-alist
'paced-global-dictionary-enable-alist
"1.1")
(defvar-local paced-local-dictionary-enable-alist nil
"Local enable list.
Has the same form as and takes priority over
`paced-global-dictionary-enable-alist'.")
(define-obsolete-variable-alias 'paced-local-dict-enable-alist
'paced-local-dictionary-enable-alist
"1.1")
(defun paced-dictionary-enable-list ()
"Return the combination of the local and global enable-alists.
See `paced-local-dictionary-enable-alist' and
`paced-global-dictionary-enable-alist' for more information."
(append paced-local-dictionary-enable-alist
paced-global-dictionary-enable-alist))
(define-obsolete-function-alias 'paced-dict-enable-list
'paced-dictionary-enable-list
"1.1")
(defun paced-mode-symbol-p (sym)
"Return non-nil if SYM is a mode symbol."
(string-match-p (rx "-mode" string-end) (symbol-name sym)))
(defun paced-test-dictionary-enable-condition (condition)
"Determines if CONDITION passes in the current buffer.
See `paced-global-dictionary-enable-alist' for an explanation."
(pcase condition
((and (pred symbolp)
(pred paced-mode-symbol-p))
(derived-mode-p condition))
((and (pred symbolp)
(pred boundp))
(symbol-value condition))
((and (pred symbolp)
(pred fboundp))
(funcall condition))
((pred functionp)
(funcall condition))
(`(or . ,rest)
(seq-some 'paced-test-dictionary-enable-condition rest))
(`(and . ,rest)
(seq-every-p 'paced-test-dictionary-enable-condition rest))))
(defun paced-current-dictionary ()
"Determine the current dictionary.
Returns nil if no dictionary should be enabled.
If a dictionary is found in the list that doesn't exist, it will
be skipped.
See `paced-global-dictionary-enable-alist' or
`paced-local-dictionary-enable-alist' for how to set the current
dictionary conditions."
(let ((conditions (paced-dictionary-enable-list))
(dictionary))
(while (and conditions
(not dictionary))
(pcase-let* ((`(,condition . ,dict) (pop conditions)))
(when (and (paced-dictionary-key-registered-p dict)
(paced-test-dictionary-enable-condition condition))
(setq dictionary dict))))
(when dictionary
(paced-named-dictionary dictionary))))
(defvar paced-throw-error-on-no-current nil
"Whether to throw an error when no current dictionary can be
found.")
(defmacro paced-operate-on-current-dictionary (&rest form)
"Run FORM with the current dictionary bound to `dict'.
If no dictionary can be found for the buffer, throw an error. To
suppress the error, set `paced-throw-error-on-no-current' to
nil."
`(if-let* ((dict (paced-current-dictionary)))
(progn ,@form)
(when paced-throw-error-on-no-current
(user-error "No dictionary found for current buffer"))))
;;; Saving and Loading
(cl-defmethod paced-dictionary-save ((dict paced-dictionary) &optional force)
"Save dictionary DICT according to its filename.
If FORCE is non-nil, ignore the `updated' flag in DICT and save
it anyway."
(when (or force (oref dict updated))
(eieio-persistent-save dict))
(oset dict updated nil))
(defun paced-save-named-dictionary (key force)
"Save dictionary named KEY.
If FORCE is non-nil (given with a prefix arg), forcibly save the
dictionary if found."
(declare (interactive-only paced-dictionary-save))
(interactive (list (paced-read-dictionary) current-prefix-arg))
(paced-operate-on-named-dictionary key
(paced-dictionary-save dict force)))
(defun paced-save-current-dictionary (force)
"Save the dictionary for the current buffer.
For how the current dictionary is determined, see
`paced-current-dictionary'."
(interactive "P")
(paced-operate-on-current-dictionary
(paced-dictionary-save dict force)))
(defun paced-load-dictionary-from-file (file)
"Load dictionary from FILE."
(interactive
(list (read-file-name "Dictionary File: " paced-dictionary-directory)))
(when-let* ((new-dict (eieio-persistent-read file 'paced-dictionary)))
(paced-dictionary-register new-dict)))
(defun paced-save-all-dictionaries (&optional force)
"Save all registered dictionaries."
(interactive "P")
(map-apply
(lambda (_ dict)
(paced-dictionary-save dict force))
paced--registered-dictionaries))
;;;###autoload
(defun paced-load-all-dictionaries ()
"Load all dictionaries in `paced-dictionary-directory'."
(interactive)
(message "Loading all dictionaries from %s" paced-dictionary-directory)
(paced--ensure-dictionary-directory)
(let ((files-to-load
(if paced-load-all-dictionaries-recursively
(directory-files-recursively paced-dictionary-directory
paced-dictionary-directory-whitelist-regexp)
(directory-files paced-dictionary-directory t
paced-dictionary-directory-whitelist-regexp))))
(dolist (dict-file files-to-load)
(when (and (file-regular-p dict-file)
(not (string-match-p paced-dictionary-directory-blacklist-regexp dict-file)))
(paced-load-dictionary-from-file dict-file)))))
(cl-defmethod eieio-done-customizing ((dict paced-dictionary))
(paced-dictionary-register dict)
(paced--ensure-dictionary-directory)
(paced-dictionary-save dict t))
;;; Handling of Thing at Point
(defun paced-bounds-of-thing-at-point ()
"Get the bounds of the thing at point."
(bounds-of-thing-at-point paced-thing-at-point-constituent))
(defun paced-thing-at-point ()
"Return the current thing at point.
The thing is determined by `paced-thing-at-point-constituent'.
Text properties are excluded."
(when-let* ((bounds (paced-bounds-of-thing-at-point)))
(buffer-substring-no-properties
(car bounds) (cdr bounds))))
(defun paced-forward-thing (&optional number)
"Move forward NUMBER things.
Things is based on `paced-thing-at-point-constituent'."
(interactive "p")
(forward-thing paced-thing-at-point-constituent number))
(defun paced-goto-beginning-of-thing-at-point ()
"Move to the start of the current thing at point.
Thing is based on `paced-thing-at-point-constituent'."
(goto-char (car (paced-bounds-of-thing-at-point))))
(defun paced-goto-end-of-thing-at-point ()
"Move to the end of the current thing at point.
Thing is based on `paced-thing-at-point-constituent'."
(goto-char (cdr (paced-bounds-of-thing-at-point))))
;;; Character Limits
(defun paced-length-of-thing-at-point ()
"Return the length, in characters, of the current thing at point."
(length (paced-thing-at-point)))
(defun paced-thing-meets-limit-p ()
"Return non-nil if the current thing at point meets the limit requirement.
The limit requirement is set with `paced-character-limit'."
(or (eq paced-character-limit 0)
(<= (paced-length-of-thing-at-point) paced-character-limit)))
;;; Exclusion
(defvar-local paced-exclude-function (lambda () nil)
"Local predicate to determine if thing at point should be excluded.
This should be a function of no arguments that returns non-nil if
the current thing-at-point should be excluded from paced
dictionaries. Exclusion is checked from the start or the end of
the current thing, depending on `paced-point-in-thing-at-point-for-exclusion'.
Point returns to its original position after the function is
called.
By default, this allows everything.
A useful function for this is `paced-in-comment-p'.")
(defun paced-in-comment-p (&optional pos)
"Return non-nil if POS is in a comment.
If POS is not specified, defaults to `point'."
(nth 8 (syntax-ppss (or pos (point)))))
(defun paced-excluded-p ()
"Return non-nil to exclude current thing at point.
See `paced-exclude-function' for more.
Exclusion can be performed from either the beginning or end of
the thing at point. See
`paced-point-in-thing-at-point-for-exclusion' for how to set
this.
This also handles character limits set by
`paced-character-limit'."
(or (not (paced-thing-meets-limit-p))
(save-excursion
(pcase paced-point-in-thing-at-point-for-exclusion
(`beginning
(paced-goto-beginning-of-thing-at-point))
(`end
(paced-goto-end-of-thing-at-point)))
(funcall paced-exclude-function))))
;;; Case Handling
(defun paced-mixed-case-word-p (word)
"Return non-nil if WORD is mixed-case.
A mixed-case word is one with both uppercase and lowercase
letters, but ignoring the first letter if it's uppercase. This
is due to assuming the first letter is unimportant, as per
sentence starting."
;; Mixed case would typically be an uppercase letter followed by a lowercase
;; letter, or a lowercase letter followed by an uppercase letter. Since we're
;; ignoring the first letter of a word if it's uppercase, we need to check for
;; two distinct uppercase letters, followed by a lowercase letter.
(let ((case-fold-search nil)) ;; Case is important
(string-match-p (rx (or (and lower upper) ;; lower followed by upper
;; Two distinct uppercase letters, as in HAs
(and upper upper lower)))
word)))
(defun paced--handle-word-case (case-handling word)
"Process WORD based on CASE-HANDLING.
This is a separate function only for testing; use
`paced-dictionary-process-word' instead."
(pcase case-handling
(`preserve word)
(`downcase (downcase word))
(`upcase (upcase word))
(`downcase-first
;; Downcase the first letter
(concat (downcase (substring word 0 1))
(substring word 1)))
;; Upcase the first letter
(`upcase-first
(concat (upcase (substring word 0 1))
(substring word 1)))
(`mixed-case
(if (paced-mixed-case-word-p word) word (downcase word)))))
(cl-defmethod paced-dictionary-process-word ((dict paced-dictionary) word)
"Return WORD, modified based on DICT's case handling."
(paced--handle-word-case (oref dict case-handling) word))
;;; Population
(defvar-local paced--current-source nil
"The source from which a dictionary is being populated.
This is used internally to inform the user of the current source,
since population mostly uses temporary buffers.")
(cl-defmethod paced-dictionary-add-word ((dict paced-dictionary) word)
"Add WORD to paced dictionary DICT."
(let ((new-word (paced-dictionary-process-word dict word)))
;; Use the full name here to silence the byte-compiler
(cl-incf (map-elt (oref dict usage-hash) new-word 0))
(oset dict updated t)))
(defun paced-add-word-to-current-dictionary (word)
"Add WORD to the current dictionary.
For how the current dictionary is determined, see
`paced-current-dictionary'."
(paced-operate-on-current-dictionary
(paced-dictionary-add-word dict word)))
(cl-defmethod paced-dictionary-populate-from-buffer ((dict paced-dictionary) &optional buffer)
"Repopulate DICT from BUFFER.
If BUFFER is nil, use the current one."
(with-current-buffer (or buffer (current-buffer))
(save-excursion
(goto-char (point-min))
(let* ((reporter-string
(concat (format "Populating dictionary %s" (paced-dictionary-name dict))
(when paced--current-source (format " from %s"
paced--current-source))
"..."))
(reporter (make-progress-reporter reporter-string 0 100)))
(while (paced-forward-thing)
(progress-reporter-do-update
reporter
(floor (* 100.0 (/ (float (point)) (point-max)))))
(unless (paced-excluded-p)
(paced-dictionary-add-word dict (paced-thing-at-point))))
(progress-reporter-done reporter)))))
(defun paced-populate-current-dictionary-from-buffer (&optional buffer)
"Populate the current dictionary from BUFFER.
This means add a usage of each included thing in BUFFER.
BUFFER is either the name of a buffer, or the buffer itself. If
not given, use the current buffer.
In order to only populate the dictionary from a region,
`paced-populate-current-dictionary-from-region'.
Note that this doesn't add the buffer to the dictionary's
population commands, so if it is later repopulated using
`paced-dictionary-repopulate' or
`paced-repopulate-named-dictionary', anything added with this
command will be lost.
In order to make changes permanent, use
`paced-add-buffer-file-to-dictionary'.
For how the current dictionary is determined, see
`paced-current-dictionary'."
(interactive "b")
(paced-operate-on-current-dictionary
(paced-dictionary-populate-from-buffer dict buffer)))
(define-obsolete-function-alias 'paced-populate-buffer-dictionary
'paced-populate-current-dictionary-from-buffer
"1.1")
(defun paced-populate-named-dictionary-from-buffer (name &optional buffer)
"Populate the dictionary named NAME from BUFFER.
This means add a usage of each included thing in BUFFER.
BUFFER is either the name of a buffer, or the buffer itself. If
not given, use the current buffer.
In order to only populate the dictionary from a region,
`paced-populate-current-dictionary-from-region'.
Note that this doesn't add the buffer to the dictionary's
population commands, so if it is later repopulated using
`paced-dictionary-repopulate' or
`paced-repopulate-named-dictionary', anything added with this
command will be lost.
In order to make changes permanent, use
`paced-add-buffer-file-to-dictionary'.
For how the current dictionary is determined, see
`paced-current-dictionary'."
(interactive
(list (paced-read-dictionary) (read-buffer "Buffer: " nil t)))
(paced-operate-on-named-dictionary name
(paced-dictionary-populate-from-buffer dict buffer)))
(cl-defmethod paced-dictionary-populate-from-region ((dict paced-dictionary) start end)
"Populate DICT from the region in the current buffer between START and END.
Note that this doesn't add the current buffer to DICT's
population commands, so if DICT is later repopulated using
`paced-dictionary-repopulate' or
`paced-repopulate-named-dictionary', anything added with this
command will be lost."
(save-restriction
(narrow-to-region start end)
(paced-dictionary-populate-from-buffer dict)))
(defun paced-populate-current-dictionary-from-region (start end)
"Populate the current dictionary from the region START to END.
Note that this doesn't add the current buffer to the dictionary's
population commands, so if it is later repopulated using
`paced-dictionary-repopulate' or
`paced-repopulate-named-dictionary', anything added with this
command will be lost."
(interactive "r")
(paced-operate-on-current-dictionary
(paced-dictionary-populate-from-region dict start end)))
(define-obsolete-function-alias 'paced-populate-from-region
'paced-populate-current-dictionary-from-region
"1.1")
(defun paced-add-current-thing-to-dictionary ()
"Add the current thing at point to the current dictionary.
No check is done to determine if the current thing should be
excluded.
Note that this doesn't add anything to the dictionary's
population commands, so if it is later repopulated using
`paced-dictionary-repopulate' or
`paced-repopulate-named-dictionary', anything added with this
command will be lost."
(interactive)
(paced-operate-on-current-dictionary
(paced-dictionary-add-word dict (paced-thing-at-point))))
;;; Dictionary Reset
(cl-defmethod paced-dictionary-reset ((dict paced-dictionary))
"Reset the usage-hash of paced-dictionary DICT."
(oset dict usage-hash (oref-default dict usage-hash)))
(defun paced-reset-named-dictionary (key)
"Reset the paced dictionary with key KEY."
(declare (interactive-only paced-dictionary-reset))
(interactive
(list (paced-read-dictionary)))
(paced-operate-on-named-dictionary key
(paced-dictionary-reset dict)))
(defun paced-reset-current-dictionary ()
"Reset the current dictionary.
For how the current dictionary is determined, see
`paced-current-dictionary'."
(interactive)
(paced-operate-on-current-dictionary
(paced-dictionary-reset dict)))
;;; Dictionary Sorting
(cl-defmethod paced-dictionary-sort ((dict paced-dictionary))
"Sort the words in dictionary DICT by usage."
(oset dict usage-hash
(funcall (oref dict sort-method)
(oref dict usage-hash))))
(defun paced-sort-named-dictionary (key)
"Sort the paced dictionary with key KEY."
(declare (interactive-only paced-dictionary-sort))
(interactive (list (paced-read-dictionary)))
(paced-operate-on-named-dictionary key
(paced-dictionary-sort dict)))
(defun paced-sort-current-dictionary ()
"Sort the current paced dictionary.
For how the current dictionary is determined, see
`paced-current-dictionary'."
(interactive)
(paced-operate-on-current-dictionary
(paced-dictionary-sort dict)))
;;; The Minor Mode
(define-minor-mode paced-mode
"Toggle paced mode.
This adds `paced-completion-at-point' to
`completion-at-point-functions'."
:init-value nil
:lighter " paced"
:group 'paced
(if paced-mode
(add-hook 'completion-at-point-functions 'paced-completion-at-point 'append 'local)
(remove-hook 'completion-at-point-functions 'paced-completion-at-point 'local)))
(define-globalized-minor-mode global-paced-mode paced-mode paced-mode
:group 'paced)
;;; Completion
(cl-defmethod paced-dictionary-fix-completion-case ((dict paced-dictionary) prefix completions)
"Account for case differences in the prefix by prepending PREFIX to COMPLETIONS.
The specific case differences should mirror those handled by
case-handling in `paced-dictionary-process-word'."
;; Anything we changed during population, we want to maintain that part of the
;; prefix during completion.
(if (not (listp completions))
;; If completions is not a list, it's likely 't', in which
;; case just return the original prefix.
(list prefix)
(pcase (oref dict case-handling)
(`preserve completions)
((or `downcase `upcase)
;; Changed entire word, so maintain entire prefix
(let ((prefix-length (length prefix)))
(mapcar
(lambda (completion)
(when (stringp completion)
(concat prefix (substring-no-properties completion prefix-length))))
completions)))
((or `downcase-first `upcase-first)
;; Only changed the first letter, so maintain just one letter of the
;; original prefix
(let ((prefix-length 1))
(mapcar
(lambda (completion)
(when (stringp completion)
(concat (substring prefix 0 prefix-length)
(substring-no-properties completion prefix-length))))
completions)))
(`mixed-case
;; Only change prefix on single-case completion options
(let ((prefix-length (length prefix)))
(mapcar
(lambda (completion)
(when (stringp completion)
(if (paced-mixed-case-word-p completion)
completion
(concat (substring prefix 0 prefix-length)
(substring-no-properties completion prefix-length)))))
completions))))))
(cl-defmethod paced-dictionary-completions ((dict paced-dictionary) prefix action &optional pred)
"Get the completions for PREFIX in DICT.
ACTION is a completion action, one of 'nil, 't, or 'lambda. See
Info node `(elisp)Programmed Completion' for an explanation of
each of them.
PRED is a predicate to supply to completion, and will return
non-nil if the completion option should be allowed.
Case handling is handled here; any part of a word that was
modified by `paced-dictionary-process-word' will be replaced with
the prefix before completions are returned."
(let* ((completion-ignore-case paced-completion-ignore-case)
(usage-hash (oref dict usage-hash))
completions)
(pcase action
(`nil
(setq completions (try-completion prefix usage-hash pred)))
(`t
(setq completions (all-completions prefix usage-hash pred)))
(`lambda
(setq completions (test-completion prefix usage-hash pred))))
(paced-dictionary-fix-completion-case dict prefix completions)))
(defun paced-completion-table-function (string pred action)
"Completion table function for paced dictionaries."
(let* ((completion-ignore-case paced-completion-ignore-case))
(pcase action
((or `nil `t `lambda)
;; Intentionally don't throw an error here, so as not to disrupt
;; completion.
(when-let* ((dict (paced-current-dictionary)))
(paced-dictionary-completions dict string action pred)))
(`(boundaries . _) nil)
(`metadata
`(metadata . ((category . paced)
(annotation-function . nil)
(display-sort-function . identity)
(cycle-sort-function . identity)))))))
(defcustom paced-auto-update-p nil
"Whether to update from completions.
This only works for an existing entry."
:group 'paced
:type 'boolean)
(defun paced-completion-auto-update (word status)
"Automatically update the current dictionary with WORD depending on STATUS.
This should only be called from `paced-completion-at-point'."
(cl-case status
(sole
;; We're done with completion, but the user may still be typing.
;; Therefore, don't add it.
)
(exact
;; Might not be the entire completion, so don't add it.
)
(finished
;; We know there's a current dictionary, since this should only be called
;; from `paced-completion-at-point'.
(when paced-auto-update-p
(paced-add-word-to-current-dictionary word)))))
(defun paced-completion-at-point ()
"Function for `completion-at-point-functions' to get the paced completions."
;; Don't expand unless we're in a buffer with paced-mode enabled.
(when (and paced-mode)
(when-let* ((bounds (paced-bounds-of-thing-at-point)))
(list (car bounds) (cdr bounds) 'paced-completion-table-function
:exit-function 'paced-completion-auto-update
:exclusive 'no))))
;;; Repopulation
(defun paced--insert-file-contents (file)
"Insert the contents of FILE into the current buffer.
Unlike `insert-file-contents', this handles mode hooks, which
paced requires for repopulation (syntax tables, exclude functions, etc.).
Returns nil if FILE doesn't exist."
(if (not (file-exists-p file))
(progn (message "Paced couldn't find file %s" file) nil)
(insert-file-contents file)
(let ((buffer-file-name file))
(after-find-file))
t))
(defclass paced-population-command ()
((props :initarg :props
:initform nil
:type list
:label "Properties"
:custom (alist :tag "Options" :key-type variable :value-type sexp)
:documentation "A list of variables to set during population.
Each element is of the form (VAR VALUE).
Some suggested variables for this are `paced-exclude-function'
and `paced-thing-at-point-constituent'.")))
(defun paced-merge-properties (&rest props)
"Merge the properties in PROPS to a single form understood by `let'.
PROPS is a list of alists, each mapping a variable to a value for
that variable
The maps in the end of PROPS take precedence over the beginning."
(let ((merged-map (apply 'map-merge 'list props)))
(map-apply (lambda (var val) (list var val)) merged-map)))
(cl-defmethod paced-dictionary-prepare-properties ((dict paced-dictionary)
(cmd paced-population-command))
"Merge the properties of DICT and CMD into a single form understood by `let'.
Properties in CMD take precedence over those in DICT."
(paced-merge-properties (oref dict default-population-properties)
(oref cmd props)))
(cl-defgeneric paced-population-command-source-list ((_cmd paced-population-command)))
(cl-defgeneric paced-population-command-setup-buffer ((_cmd paced-population-command) _source)
"Prepare a temporary buffer with SOURCE.
Return non-nil if setup was successful and population can continue.")
(cl-defmethod paced-population-command-populate-dictionary ((dict paced-dictionary) (cmd paced-population-command))
"Populate DICT from CMD."
(let ((sources (paced-population-command-source-list cmd))
;; Turn props into a form understood by `let'.
(props (paced-dictionary-prepare-properties dict cmd)))
(dolist (source sources)
(with-temp-buffer
;; If pre is nil, continue.
;; Otherwise, continue if pre returns non-nil
;; This allows users to specify conditions under which repopulation
;; should be disabled.
(let ((paced--current-source source))
(when (paced-population-command-setup-buffer cmd source)
(eval (macroexp-let* props `(paced-dictionary-populate-from-buffer ,dict)))))))))
(defclass paced-file-population-command (paced-population-command)
((file :initarg :file
:initform ""
:type string
:label "File"
:custom (file :tag "File")
:documentation "File from which to populate."))
"Populates a dictionary from all words in a single file.")
(cl-defmethod paced-population-command-source-list ((cmd paced-file-population-command))
(list (oref cmd file)))
(cl-defmethod paced-population-command-setup-buffer ((_cmd paced-file-population-command) source)
(paced--insert-file-contents source))
(defclass paced-buffer-population-command (paced-population-command)
((buffer :initarg :buffer
:initform ""
:type string
:label "Buffer"
:custom (string :tag "Buffer")
:documentation "Name of the buffer from which to populate."))
"Populates a dictionary from all words in a given buffer.
That buffer must be a string, and must exist during population.")
(cl-defmethod paced-population-command-source-list ((cmd paced-buffer-population-command))
(list (oref cmd buffer)))
(cl-defmethod paced-population-command-setup-buffer ((_cmd paced-buffer-population-command) source)
(cond
((not (stringp source))
(message "Paced buffer populator got an invalid argument: %s" source)
nil)
((not (get-buffer source))
(message "Paced buffer populator got a buffer that doesn't exist: %s" source)
nil)
(t
(set-buffer source))))
(defclass paced-file-function-population-command (paced-population-command)
((file :initarg :file
:initform ""
:type string
:label "File"
:custom (file :tag "File")
:documentation "File from which to populate.")
(setup-func :initarg :setup-func
:initform (lambda () t)
:type function
:label "Setup Function"
:custom (function :tag "Setup Function")
:documentation "Additional setup function."))
"Populate from a given file, using a setup function.
That function is called with no arguments, with a temporary
buffer containing the file's contents, and must return non-nil if
population may continue.")
(cl-defmethod paced-population-command-source-list ((cmd paced-file-function-population-command))
(list (oref cmd file)))
(cl-defmethod paced-population-command-setup-buffer ((cmd paced-file-function-population-command) source)
(and (paced--insert-file-contents source)
(funcall (oref cmd setup-func))))
(defclass paced-directory-regexp-population-command (paced-population-command)
((directory :initarg :directory
:initform ""
:type string
:label "Directory"
:custom (directory :tag "Directory")
:documentation "Directory to search for files from which to populate.")
(regexp :initarg :regexp
:initform ".*"
:type string
:label "File Regexp"
:custom (string :tag "File Regexp")
:documentation "Regular expression to match files.")
(recursive :initarg :recursive
:initform t
:type boolean
:label "Recursive"
:custom boolean
:documentation "Whether to search through the directory recursively."))
"Population command to populate from files in a directory that
match a regular expression.")
(cl-defmethod paced-population-command-source-list ((cmd paced-directory-regexp-population-command))
(with-slots (directory regexp recursive) cmd
(if recursive
(directory-files-recursively directory regexp)
(directory-files directory t regexp))))
(cl-defmethod paced-population-command-setup-buffer ((_cmd paced-directory-regexp-population-command) source)
(paced--insert-file-contents source))
(defclass paced-file-list-population-command (paced-population-command)
((generator :initarg :generator
:initform (lambda () nil)
:type function
:label "Generator"
:custom (function :tag "Generator")
:documentation "Function of no arguments that returns a list of files."))
"Populate a dictionary from a list of files.")
(cl-defmethod paced-population-command-source-list ((cmd paced-file-list-population-command))
(funcall (oref cmd generator)))
(cl-defmethod paced-population-command-setup-buffer ((_cmd paced-file-list-population-command) source)
(paced--insert-file-contents source))
(defun paced-new-population-command-custom ()
"Prompt for a population command type and creates a new command of that type."
(let* ((type (completing-read "Command Type: "
(eieio-class-children 'paced-population-command))))
(funcall (intern type))))
(cl-defmethod paced-dictionary-repopulate ((dict paced-dictionary))
"Repopulate dictionary DICT from its population commands.
Population commands are stored in the field of the same name.
Note that this will empty the dictionary's contents before
repopulating it."
;; Empty the dictionary
(paced-dictionary-reset dict)
(dolist (cmd (oref dict population-commands))
(paced-population-command-populate-dictionary dict cmd))
(paced-dictionary-sort dict)
(when paced-repopulate-saves-dictionary
(paced-dictionary-save dict)))
(defun paced-repopulate-named-dictionary (key)
"Repopulate dictionary named KEY from its population commands.
Population commands are stored in the field of the same name.
Note that this will empty the dictionary's contents before
repopulating it. If `paced-populate-warn-about-reset' is
non-nil, confirmation will be requested before continuing."
(interactive
(list (paced-read-dictionary)))
(paced-operate-on-named-dictionary key
(when (or (not paced-populate-warn-about-reset)
(y-or-n-p "Warning: Repopulating dictionary will reset it. Continue?"))
(paced-dictionary-repopulate dict))))
(defun paced-repopulate-current-dictionary ()
"Repopulate the current dictionary.
Note that this will empty the dictionary's contents before
repopulating it. If `paced-populate-warn-about-reset' is
non-nil, confirmation will be requested before continuing."
(interactive)
(paced-operate-on-current-dictionary
(when (or (not paced-populate-warn-about-reset)
(y-or-n-p "Warning: Repopulating dictionary will reset it. Continue?"))
(paced-dictionary-repopulate dict))))
(cl-defmethod paced-dictionary-add-population-command ((dict paced-dictionary)
(cmd paced-population-command))
"Add population command CMD to dictionary DICT."
(cl-pushnew cmd (oref dict population-commands) :test 'equal))
(defun paced-add-buffer-file-to-dictionary (&optional buffer)
"Populate the current dictionary of BUFFER with BUFFER.
The file corresponding to BUFFER is then added to the current
dictionary's population commands.
Custom settings for the populator, such as the exclude function,
must be set with `paced-edit-named-dictionary' or
`paced-edit-current-dictionary'."
(interactive)
(with-current-buffer (or buffer (current-buffer))
(unless (buffer-file-name)
(user-error "paced-add-buffer-file-to-dictionary called inside a non-file buffer."))
(paced-operate-on-current-dictionary
(let* ((file-name (buffer-file-name))
(cmd (paced-file-population-command :file file-name)))
(paced-dictionary-populate-from-buffer dict buffer)
(paced-dictionary-add-population-command dict cmd)))))
;;; Edit a Dictionary
(cl-defmethod paced-dictionary-edit ((dict paced-dictionary))
"Edit paced-dictionary DICT."
(customize-object dict))
(defun paced-edit-named-dictionary (name)
"Edit the paced-dictionary named NAME."
(declare (interactive-only paced-dictionary-edit))
(interactive (list (paced-read-dictionary)))
(paced-operate-on-named-dictionary name
(paced-dictionary-edit dict)))
(defun paced-edit-current-dictionary ()
"Edit the current paced dictionary.
For how the current dictionary is determined, see
`paced-current-dictionary'."
(interactive)
(paced-operate-on-current-dictionary
(paced-dictionary-edit dict)))
;;; Print a Dictionary in a Dedicated Buffer
(defvar-local paced-tabulated-list-dictionary nil
"Dictionary printed in a tabulated list buffer.")
(cl-defmethod paced-dictionary-length-of-longest-word ((dict paced-dictionary))
"Return the length of the longest word in DICT."
(seq-max
(map-apply
(lambda (key _value)
(length key))
(oref dict usage-hash))))
(cl-defmethod paced-dictionary-tabulated-list-entries ((dict paced-dictionary))
"Create a value for `tabulated-list-entries' from DICT."
(map-apply
(lambda (key value)
(list key (vector key (number-to-string value))))
(oref dict usage-hash)))
(defun paced-tabulated-list-revert ()
"Revert a `tabulated-list-mode' buffer from its dictionary."
(let* ((dict paced-tabulated-list-dictionary)
(longest-length (paced-dictionary-length-of-longest-word dict)))
(setq tabulated-list-format
(vector `("Word" ,longest-length t . (:right-align t))
`("Count" 10 t)))
(setq tabulated-list-entries (paced-dictionary-tabulated-list-entries dict))))
(cl-defmethod paced-dictionary-print ((dict paced-dictionary))
"Print the contents of DICT in a dedicated buffer."
(let* ((buffer-name (format "*Paced Dictionary - %s*" (paced-dictionary-name dict)))
(buffer (get-buffer-create buffer-name)))
(with-current-buffer buffer
(tabulated-list-mode)
(setq paced-tabulated-list-dictionary dict)
(paced-tabulated-list-revert)
(tabulated-list-init-header)
(tabulated-list-print))
(display-buffer buffer)))
(defun paced-print-current-dictionary ()
"Print the contents of the current dictionary in a dedicated buffer."
(interactive)
(paced-operate-on-current-dictionary
(paced-dictionary-print)))
(defun paced-print-named-dictionary (name)
"Print the contents of the dictionary with name NAME."
(declare (interactive-only paced-dictionary-print))
(interactive (list (paced-read-dictionary)))
(paced-operate-on-named-dictionary name
(paced-dictionary-print name)))
(declare-function lm-report-bug "lisp-mnt" (topic))
(defun paced-submit-bug-report (topic)
"Report a bug with topic TOPIC."
(interactive "sTopic: ")
(require 'lisp-mnt)
(let* ((src-file (locate-library "paced.el" t))
(src-buf-live (find-buffer-visiting src-file))
(src-buf (find-file-noselect src-file)))
(with-current-buffer src-buf
(lm-report-bug topic))
;; Kill the buffer if it wasn't live
(unless src-buf-live
(kill-buffer src-buf))))
(provide 'paced)
;;; paced.el ends here
paced-1.1.1/test.mk 0000644 0001752 0001753 00000001646 13235701354 012541 0 ustar elpa elpa # Copyright (C) 2017-2018 Free Software Foundation, Inc.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
# EDE only allows arbitrary code from an external makefile, so this is how we've
# got to do testing.
test: compile
@$(EMACS) \
$(EMACSFLAGS) \
-L "." \
-l "ert" \
-l "paced-tests.el" \
-f ert-run-tests-batch-and-exit
include Makefile
paced-1.1.1/ChangeLog 0000644 0001752 0001753 00000001071 13236276616 013004 0 ustar elpa elpa 2018-02-05 Ian Dunn
Merge commit '47ad7156de07301a7cb77e067713be3e6979fa75'
2018-02-04 Ian Dunn
Merge commit '463d752d4703af93ea86df8f07b244e8fc851617'
2018-01-23 Ian Dunn
Merge commit '50ee379c866e02dc0c36bb4bf45dd5b4cab0e90d'
2017-12-09 Ian Dunn
Add 'packages/paced/' from commit
'223809ea68c8d86aef2b61a946d61497125ba250'
git-subtree-dir: packages/paced git-subtree-mainline:
0775e8c12f66a193365716ca6415be36cf7388ef git-subtree-split:
223809ea68c8d86aef2b61a946d61497125ba250
paced-1.1.1/COPYING 0000644 0001752 0001753 00000104513 13213056546 012263 0 ustar elpa elpa GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
paced-1.1.1/paced.org 0000644 0001752 0001753 00000064034 13236276454 013027 0 ustar elpa elpa #+TITLE: Paced
#+AUTHOR: Ian Dunn
#+EMAIL: dunni@gnu.org
#+DATE: {{{modification-time}}}
#+STARTUP: overview
#+STARTUP: indent
#+TODO: FIXME | FIXED
#+OPTIONS: toc:2 num:nil timestamp:nil \n:nil |:t ':t email:t
#+OPTIONS: *:t <:t d:nil todo:nil pri:nil tags:not-in-toc
#+TEXINFO_DIR_CATEGORY: Emacs
#+TEXINFO_DIR_TITLE: Paced: (paced)
#+TEXINFO_DIR_DESC: Predictive Abbreviation Completion and Expansion using Dictionaries
* Copying
Copyright (C) 2017-2018 Free Software Foundation, Inc.
#+BEGIN_QUOTE
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
#+END_QUOTE
* Introduction
:PROPERTIES:
:DESCRIPTION: Brief Introduction to paced
:END:
Paced (Predictive Abbreviation Completion and Expansion using Dictionaries)
scans a group of files (determined by "population commands") to construct a
usage table (dictionary). Words (or symbols) are sorted by their usage, and may
be later presented to the user for completion. A dictionary can then be saved
to a file, to be loaded later.
Population commands determine how a dictionary should be filled with words or
symbols. A dictionary may have multiple population commands, and population may
be performed asynchronously. Once population is finished, the contents are
sorted, with more commonly used words at the front. Dictionaries may be edited
through EIEIO's customize-object interface.
Completion is done through ~completion-at-point~. The dictionary to use for
completion can be customized.
** Similar Packages
:PROPERTIES:
:DESCRIPTION: Packages with similar goals
:END:
There are a few Emacs packages that have similar goals to paced, and provided
some of the inspiration and motivation behind it.
*** pabbrev
The [[https://github.com/phillord/pabbrev][pabbrev]] package by Phillip Lord automatically scans text of the current
buffer while Emacs is idle and presents the user with the most common
completions.
One of the major downsides to pabbrev is that the data it collects doesn't
persist between Emacs sessions. For a few files that are always open, such as
org agenda files, pabbrev works great. If you want to train it from a few files
that aren't always open, you'll have to open each file and retrain pabbrev from
that file. And you'll have to do this every time you restart Emacs.
It keeps up-to-date usage and prefix hashes of all buffers of the same mode, and
scanning, or "scavenging", blends seamlessly into the background. Completion is
just a hash table lookup, so it can handle completion in microseconds. There's
also no setup required; it will start working right away. The downside to this
is that dictionaries aren't flexible; each dictionary corresponds to a major
mode, and there's no way to change that.
*** predictive
The [[https://www.dr-qubit.org/predictive.html][predictive]] package by Toby Cubitt scans text of the current buffer on user
command. The usage data is stored in a dictionary, which can then be saved to a
disk. Extensions are provided to ~completion-at-point~, or predictive's built-in
frontend can be used. It has a safety precaution where it only adds existing
words to a dictionary, unless the user allows this. This is to avoid adding
typos to a dictionary.
Completion was also done intelligently, grouping commonly used words together
and optionally suggesting shorter words before longer words.
While the frontend and backend are separate, the frontend is required to
populate a dictionary. There is no way to exclude part of the buffer's text
from dictionary population. The safety precaution predictive has where it only
adds a word to a dictionary if it already exists was tedious, since I didn't
need it to do that.
** Installation
:PROPERTIES:
:DESCRIPTION: How to install paced
:END:
*Requirements*
| Emacs | 25.1 |
| async | 1.9.1 |
Paced may be installed from source, or from GNU ELPA.
From ELPA:
#+begin_example
M-x package-install RET paced RET
#+end_example
From Source:
#+begin_src shell
bzr branch https://bzr.savannah.gnu.org/r/paced-el paced
#+end_src
After installing from source, add the following to your init file (typically .emacs):
#+BEGIN_SRC emacs-lisp
(add-to-list 'load-path "/full/path/to/paced/")
(require 'paced)
#+END_SRC
However you install paced, you must also make sure dictionaries are loaded on
startup:
#+begin_src emacs-lisp
(paced-load-all-dictionaries)
#+end_src
** Basic Setup
:PROPERTIES:
:DESCRIPTION: The simplest setup
:END:
Paced needn't have a lot of setup to run. In fact, the simplest setup is as
follows:
1. Create a new dictionary, "Default" (See [[#dictionary_creation][Creating a Dictionary]])
2. Set ~paced-global-dictionary-enable-alist~ to ~((t . "Default"))~ (See [[#selective_dictionaries][Selective Dictionaries]])
3. Run ~M-x global-paced-mode~
4. To add a file to the dictionary, use ~M-x paced-add-buffer-file-to-dictionary~
This will create a default dictionary and populate it from buffers you specify.
* Dictionaries
:PROPERTIES:
:DESCRIPTION: Paced's bread and butter
:END:
** Creating a Dictionary
:PROPERTIES:
:DESCRIPTION: First steps
:CUSTOM_ID: dictionary_creation
:END:
Now that you've got paced installed, it's time to create a new dictionary.
#+begin_example
M-x paced-create-new-dictionary RET DICTIONARY_NAME RET DICTIONARY_FILE RET
#+end_example
Let's explain those two arguments:
First, you've got DICTIONARY_NAME. This is a string that will be used to
reference the new dictionary. We recommend something short, like 'new-dict',
'my-dict', 'writing', etc.
Next is the file where the dictionary will be stored. This is typically stored
in ~paced-dictionary-directory~, from which all dictionaries will be loaded with
~paced-load-all-dictionaries~ (more on that later). For now, it's important to
know that ~paced-load-all-dictionaries~ is the easiest way to load dictionaries
when paced is loaded.
After you've run the above command, you will be taken to the customization
buffer. This is where you can set population commands.
** Editing a Dictionary
:PROPERTIES:
:DESCRIPTION: How to edit your new dictionary
:END:
In order to edit a dictionary, paced provides ~paced-edit-named-dictionary~ and
~paced-edit-current-dictionary~.
The edit buffer provides the options to change the population commands, case
handling, dictionary storage name, and sort method. Each of these is
documented in the edit buffer.
** Selective Dictionaries
:PROPERTIES:
:DESCRIPTION: Enabling certain dictionaries under certain conditions
:CUSTOM_ID: selective_dictionaries
:END:
Paced provides a mechanism called the "enable list", that allows a user to
enable certain dictionaries for completion given certain conditions.
There are two enable lists: a global (~paced-global-dictionary-enable-alist~)
and local (~paced-local-dictionary-enable-alist~) one. They both work the same,
with the local one taking precedence. Each entry in the list has a condition
and a key.
The conditions are one of the following:
- A mode name, such as ~org-mode~ or ~text-mode~, indicating that the named
dictionary should be active in any mode derived from that mode.
- A symbol, in which case the named dictionary is active whenever the value of
that symbol is non-nil. This includes the symbol ~t~.
- A function symbol, in which case the function is called with no arguments to
determine if the given dictionary should be enabled. If the function returns
non-nil the dictionary is enabled.
- A lambda function, in which case it is called with no arguments, and if it
returns non-nil, the dictionary is enabled.
- The form (or CONDITION1 CONDITION2 ...), which enables the given dictionary if
any of the conditions are met.
- The form (and CONDITION1 CONDITION2 ...), which enables the given dictionary
if all of the conditions are met.
Remember that paced-mode must be active for completion to occur. Neither list
will activate it, just determine which dictionary is active.
The key is the dictionary name you set during dictionary creation.
** Dictionary Files
:PROPERTIES:
:DESCRIPTION: Loading and Saving the Dictionaries
:END:
Paced provides ~paced-load-all-dictionaries~ to load all dictionaries in
~paced-dictionary-directory~. Paced determines which dictionaries to load based
on two variables: ~paced-dictionary-directory-whitelist-regexp~ and
~paced-dictionary-directory-blacklist-regexp~. Paced can also be told to search
recursively by setting ~paced-load-all-dictionaries-recursively~ to t. All four
of these variables may be set using Emacs's customization interface.
An individual dictionary file may also be loaded:
#+begin_example
M-x paced-load-dictionary-from-file RET /path/to/file RET
#+end_example
Once a file has been modified, it may then be saved:
#+begin_example
M-x paced-save-named-dictionary RET dictionary name RET
#+end_example
Or, all dictionaries may be saved:
#+begin_example
M-x paced-save-all-dictionaries RET
#+end_example
Dictionaries may also be automatically saved whenever changed by setting
~paced-repopulate-saves-dictionary~ to t. Population is covered in the next
section.
** Printing a Dictionary
:PROPERTIES:
:DESCRIPTION: Seeing the contents of a dictionary
:END:
Paced allows a user to print the contents of a dictionary to a buffer. Uses for
this might be to tweak population commands or exclude functions, or to simply
make sure a dictionary is populating correctly.
To use this feature, run:
#+begin_example
M-x paced-print-named-dictionary RET NAME-OF-DICTIONARY RET
#+end_example
Or for the current dictionary:
#+begin_example
M-x paced-print-current-dictionary RET
#+end_example
* Population Commands
:PROPERTIES:
:DESCRIPTION: The good stuff
:END:
Part of the beauty of paced is the ease of reconstructing a dictionary. When
you've got a bunch of files from which you want to populate your dictionary,
it'd be a pain to go to each of them and say "populate from this one, next,
populate from this one, next".
Instead, paced provides population commands. Each dictionary has one or more
population commands it uses to recreate its contents, run in order during
population.
In order to trigger population, run the following:
#+begin_example
M-x paced-repopulate-named-dictionary RET DICTIONARY-NAME RET
#+end_example
** Built-in Commands
:PROPERTIES:
:DESCRIPTION: Basics
:END:
There are five built-in population commands:
- file :: Populates a dictionary from all words in a given file
- buffer :: Populates a dictionary from all words in a given buffer, which must
exist during population
- file-function :: Like the file command, but allows a custom setup function.
This function is called with no arguments in a temporary
buffer containing the file's contents, and must return
non-nil if population may continue.
- directory-regexp :: Populates from all files in a directory that match the
given regexp. Also optionally allows recursion.
- file-list :: Populates from all files returned by a generator function.
** Properties
:PROPERTIES:
:DESCRIPTION: Tweaking the defaults
:END:
When setting the population commands of a dictionary, one may also set certain
properties. Each property is a variable binding, bound while the population
command runs.
A few variables are of note here:
- paced-exclude-function :: Function of no arguments that returns non-nil if the
thing at point should be excluded from population.
- paced-thing-at-point-constituent :: Symbol defining thing on which population
works. Typically set to either 'symbol or 'word.
- paced-character-limit :: Maximum length of a thing to include it in a
dictionary. If set to 0 (default), no limit is imposed.
For convenience, properties that are intended for all population commands of a
given dictionary may be set in the dictionary itself. In the event of a
conflict, population command properties take precedence over dictionary
properties.
** Custom Commands
:PROPERTIES:
:DESCRIPTION: Defining new population commands
:END:
Since the population commands all derive from paced-population-command, it's
possible to add additional commands.
As an example, let's make a population command that populates a dictionary from
a file like so:
#+begin_example
alpha 5
beta 7
gamma 21
delta 54
epsilon 2
#+end_example
We want to make a population command that takes a file like this, with word in
one column and weight in the other, and add it to a dictionary.
There are two ways to approach this, but we're going to start with the basic one.
We need to define two functions: paced-population-command-source-list and
paced-population-command-setup-buffer. The first returns a list of sources from
which to populate, and the second sets up a temporary buffer based on those
sources.
For our command, we want to return the specified file, and replicate each word
by the amount given.
Inheriting from ~paced-file-population-command~ gives us the source list and file
slot for free.
#+begin_src emacs-lisp
(defclass paced-weight-file-population-command (paced-file-population-command))
#+end_src
Now, we need to set up the buffer to replicate the words.
#+begin_src emacs-lisp
(cl-defmethod paced-population-command-setup-buffer ((cmd paced-weight-file-population-command) source)
;; Use the built-in `paced--insert-file-contents' to insert contents.
(paced--insert-file-contents source)
;; Jump to the start of the buffer
(goto-char (point-min))
;; Search for lines with the form WORD WEIGHT
(while (re-search-forward (rx line-start ;; Start of line
(submatch (one-or-more (not (syntax whitespace)))) ;; Our word
(syntax whitespace) ;; Space between word and weight
(submatch (one-or-more (any digit))) ;; Weight
line-end) ;; End of line
nil t)
(let* ((word (match-string 1))
(weight (string-to-number (match-string 2)))
;; Repeat WORD WEIGHT times
(new-text (string-join (make-list weight word) " ")))
;; Replace the matched text with our repeated word
(replace-match new-text))))
#+end_src
That's all there is to it. When you go to edit a dictionary, the "weight-file"
population command will automatically be added as an option for a population
command.
The even easier way to do this would've been to use
~paced-file-function-population-command~, but it doesn't make for a good example
in this case.
** Asynchronous Population
:PROPERTIES:
:DESCRIPTION: Populating without blocking
:END:
A common problem is that population can take a long time. Some of us populate
dictionaries from org agenda files, which can get pretty big.
To solve this, paced uses the [[https://github.com/jwiegley/emacs-async][async]] package. Setup is seamless; just stick
whatever code you need in ~~/.emacs.d/paced-async.el~, and use one of the two
population commands:
A named dictionary:
#+begin_example
M-x paced-repopulate-named-dictionary-async RET NAME RET
#+end_example
Or the current dictionary:
#+begin_example
M-x paced-repopulate-current-dictionary-async RET
#+end_example
A few things to note about this:
1. Dictionaries will be automatically saved by this method after population
2. Asynchronous population doesn't change anything until after population is
finished, so a user may continue to use their dictionary while population is
happening. This also means that multiple populations may run in parallel
without interfering with one another.
3. Because async runs population in a separate Emacs process, any custom code
required for population must be in paced-async.el. This includes additional
population command types, but doesn't include the following variables:
- load-path
- paced-thing-at-point-constituent
- paced-async-load-file
* Example Setups
:PROPERTIES:
:DESCRIPTION: Some examples
:END:
** Org Agenda Files
As some of us record everything about our lives in our agenda files, it might be
helpful to have a dictionary tuned to ourselves.
We use a file-list command that returns the agenda files, and an exclude command
to block out all of Org's extra features such as source code and drawers.
The generator for file-list is easy:
#+begin_src emacs-lisp
(lambda nil org-agenda-files)
#+end_src
Done.
Now, the exclude command, which sits inside the properties option. This can be
added to ~paced-async.el~:
#+begin_src emacs-lisp
(require 'org)
(defun org-at-tag-p ()
(let* ((p (point)))
;; Ignore errors from `org-get-tags-string'.
(ignore-errors
;; Checks the match string for a tag heading, setting match-string 1 to the
;; tags. Also sets match-beginning and match-end.
(org-get-tags-string)
(when (match-string 1)
(<= (match-beginning 1) p (match-end 1))))))
(defun org-paced-exclude ()
(or
;; Drawers
(org-between-regexps-p org-drawer-regexp ":END:") ;; Doesn't catch END
(org-in-regexp ":END:") ;; but this does
(org-at-tag-p) ;; tags
(org-at-comment-p) ;; comments
(org-in-regexp org-any-link-re) ;; links
(org-in-block-p '("src" "quote" "verse")) ;; blocks
(org-at-planning-p) ;; deadline, etc.
(org-at-table-p) ;; tables
))
#+end_src
As explained earlier, this can be put inside properties in the customize buffer as such:
#+begin_example
Properties :
[INS] [DEL] Variable: paced-exclude-function
Lisp expression: 'org-paced-exclude
#+end_example
And you're done. See how easy that was?
** Project Files
Now we get to the interesting one. There are tons of ways to collect project
files in Emacs, so we're going to stick with one for now, being Emacs's built-in
VC package.
#+begin_src emacs-lisp
(defun vc-paced-find-project-files (path-to-project-root)
"Use VC to collect all version-controlled files."
(let ((file-list))
(vc-file-tree-walk path-to-project-root (lambda (f) (push f file-list)))
file-list))
#+end_src
We'd then need to use the following for our file-list generator:
#+begin_example
Generator : (lambda nil (vc-paced-find-project-files "/home/me/programming/paced"))
#+end_example
Now, we (probably) don't want commented code to get in our way, so we'll use a
small function for excluding those:
#+begin_src emacs-lisp
(defun paced-at-comment-p ()
(nth 8 (syntax-ppss)))
#+end_src
Use that for paced-exclude-function, and you're done. We can't necessarily
recommend this for any programming language, as there are dedicated solutions
for almost everything, but it makes an excellent fallback.
** Markdown Files
Another common request is markdown files. In order for this to work, you'll need to install ~markdown-mode~:
#+begin_example
M-x package-install RET markdown-mode RET
#+end_example
After that, add the following to your ~paced-async.el~ file:
#+begin_src emacs-lisp
(require 'markdown-mode)
(defun paced-markdown-exclude-p ()
"Taken from `markdown-flyspell-check-word-p'."
;; Exclude anything markdown mode thinks flyspell should skip.
(or
;; Ignore code blocks
(markdown-code-block-at-point-p)
(markdown-inline-code-at-point-p)
;; Ignore comments
(markdown-in-comment-p)
;; Ignore special text
(let ((faces (get-text-property (point) 'face)))
(if (listp faces)
(or (memq 'markdown-reference-face faces)
(memq 'markdown-markup-face faces)
(memq 'markdown-plain-url-face faces)
(memq 'markdown-inline-code-face faces)
(memq 'markdown-url-face faces))
(memq faces '(markdown-reference-face
markdown-markup-face
markdown-plain-url-face
markdown-inline-code-face
markdown-url-face))))))
#+end_src
That excludes anything that the developers of markdown-mode felt should be
excluded from flyspell.
Set this as your exclude function in your dictionary's settings, then add each
markdown file by hand.
** Repopulating Dictionary After Saving
This is a common request, although with the power of async, it's an easy one to
fulfill. This will repopulate the current buffer's dictionary every time you
save a file with a dictionary. This may seem daunting, but the dictionary will
remain usable during population, and multiple populations won't interfere with
one another.
#+begin_src emacs-lisp
;; Repopulate the current dictionary after saving
(add-hook 'after-save-hook 'paced-repopulate-current-dictionary-async)
#+end_src
Add that to your .emacs file, and paced will take it from there.
If you decide that's too much, do the following:
#+begin_example
M-: (remove-hook 'after-save-hook 'paced-repopulate-current-dictionary-async) RET
#+end_example
** Repopulating Dictionary After Spellchecking the Buffer
Another request, although much trickier to do. This one involves using Emacs's
advice mechanism:
#+begin_src emacs-lisp
(define-advice ispell-pdict-save (:after (&optional _no-query _force-save) paced-populate)
;; Repopulate the current dictionary after running spell check
(paced-repopulate-current-dictionary-async))
#+end_src
If you decide this isn't for you, do the following to revert the changes:
#+begin_example
M-: (advice-remove #'ispell-pdict-save #'ispell-pdict-save@paced-populate) RET
#+end_example
* Contributing
:PROPERTIES:
:DESCRIPTION: I wanna help!
:CUSTOM_ID: contributing
:END:
We are all happy for any help you may provide.
First, check out the source code on Savannah: https://savannah.nongnu.org/projects/paced-el
#+BEGIN_SRC shell
bzr branch https://bzr.savannah.gnu.org/r/paced-el/ paced
#+END_SRC
Build the Makefile with EDE:
1. Open any file from paced (See [[#ede][Working with EDE]] if you encounter "Corrupt object on disk" error)
2. Run ~C-c . C~ or ~M-x ede-compile-project~
** Bugs
:PROPERTIES:
:CUSTOM_ID: bugs
:DESCRIPTION: Submitting bug reports
:END:
There are two ways to submit bug reports:
1. Using the bug tracker at Savannah
2. Sending an email using ~paced-submit-bug-report~
When submitting a bug report, be sure to include a description of the dictionary
or population command that caused the problem, with as much detail as possible.
** Development
:PROPERTIES:
:CUSTOM_ID: development
:DESCRIPTION: Helping with development
:END:
If you're new to bazaar, we recommend using Emacs's built-in VC package. It
eases the overhead of dealing with a brand new VCS with a few standard commands.
For more information, see the info page on it (In Emacs, this is
C-h r m Introduction to VC RET).
To contribute with bazaar, you can do the following:
#+begin_src shell
# Hack away and make your changes
$ bzr commit -m "Changes I've made"
$ bzr send -o file-name.txt
#+end_src
Then, use ~paced-submit-bug-report~ and attach "file-name.txt". We can then merge
that into the main development branch.
There are a few rules to follow:
- New population commands should be named paced-POPULATION-COMMAND-TYPE-population-command
- Run 'make check' to verify that your mods don't break anything
- Avoid additional or altered dependencies if at all possible
- Dictionary commands come in threes ("the operation triad"):
1. paced-dictionary-OPERATION, a cl-defmethod which performs OPERATION on a dictionary
2. paced-OPERATION-on-named-dictionary, an interactive only function that prompts
for a dictionary name and performs OPERATION on that dictionary:
#+begin_src emacs-lisp
(interactive (list (paced-read-dictionary)))
(paced-ensure-registered name)
(paced-dictionary-OPERATION (paced-named-dictionary name))
#+end_src
3. paced-OPERATION-on-current-dictionary, an interactive function that
performs OPERATION on the current dictionary
#+begin_src emacs-lisp
(interactive)
(paced-dictionary-OPERATION (paced-current-dictionary-or-die))
#+end_src
** Documentation
:PROPERTIES:
:CUSTOM_ID: docs
:DESCRIPTION: Improving the documentation
:END:
Documentation is always helpful to us. Please be sure to do the following after
making any changes:
1. Update the info page in the repository with ~C-c C-e i i~
2. If you're updating the HTML documentation, switch to a theme that can easily
be read on a white background; we recommend the "adwaita" theme
** Working with EDE
:PROPERTIES:
:CUSTOM_ID: ede
:DESCRIPTION: And all its quirks
:END:
EDE can be a little finicky at times, but we feel the benefits, namely package
dependency handling and Makefile generation, outweigh the costs.
One of the issues that many will likely encounter is the error "Corrupt file on
disk". This is most often due to EDE not loading all its subprojects as needed.
If you find yourself dealing with this error often, place the following in your
.emacs file:
#+begin_src emacs-lisp
;; Target types needed for working with paced
(require 'ede/proj-elisp)
(require 'ede/proj-aux)
(require 'ede/proj-misc)
#+end_src
These are the three target types that paced uses: elisp for compilation and
autoloads; aux for auxiliary files such as documentation; and misc for tests.
When creating a new file, EDE will ask if you want to add it to a target.
Consult with one of the paced devs for guidance, but usually selecting "none"
and letting one of us handle it is a good way to go.
* Changelog
:PROPERTIES:
:DESCRIPTION: List of changes by version
:END:
** 1.1.1
- Fixed bug with asynchronous population throwing an error on no dictionary
- Set ~paced-throw-error-on-no-current~ to nil by default
** 1.1
- Cleaned up the code to reflect the "operation triad"
- -OP, OP-on-named, OP-on-current
- Retained backwards compatibility by obsoleting a bunch of functions, but didn't remove any of them
- Also removed the use of dict- in global variables and functions
- Added the ability to print the contents of a dictionary in a separate buffer
- Added the option to limit the words added during population by size
- Various documentation improvements
** 1.0.1
Bug fix release
- Save dictionaries right after they're created
- Added "force" parameter to save functions
** 1.0
Initial release.
paced-1.1.1/paced.info 0000644 0001752 0001753 00000100621 13236276454 013164 0 ustar elpa elpa This is paced.info, produced by makeinfo version 6.5 from paced.texi.
INFO-DIR-SECTION Emacs
START-INFO-DIR-ENTRY
* Paced: (paced). Predictive Abbreviation Completion and Expansion using Dictionaries.
END-INFO-DIR-ENTRY
File: paced.info, Node: Top, Next: Copying, Up: (dir)
Paced
*****
* Menu:
* Copying::
* Introduction:: Brief Introduction to paced
* Dictionaries:: Paced’s bread and butter
* Population Commands:: The good stuff
* Example Setups:: Some examples
* Contributing:: I wanna help!
* Changelog:: List of changes by version
— The Detailed Node Listing —
Introduction
* Similar Packages:: Packages with similar goals
* Installation:: How to install paced
* Basic Setup:: The simplest setup
Similar Packages
* pabbrev::
* predictive::
Dictionaries
* Creating a Dictionary:: First steps
* Editing a Dictionary:: How to edit your new dictionary
* Selective Dictionaries:: Enabling certain dictionaries under certain conditions
* Dictionary Files:: Loading and Saving the Dictionaries
* Printing a Dictionary:: Seeing the contents of a dictionary
Population Commands
* Built-in Commands:: Basics
* Properties:: Tweaking the defaults
* Custom Commands:: Defining new population commands
* Asynchronous Population:: Populating without blocking
Example Setups
* Org Agenda Files::
* Project Files::
* Markdown Files::
* Repopulating Dictionary After Saving::
* Repopulating Dictionary After Spellchecking the Buffer::
Contributing
* Bugs:: Submitting bug reports
* Development:: Helping with development
* Documentation:: Improving the documentation
* Working with EDE:: And all its quirks
Changelog
* 1.1.1: 111.
* 1.1: 11.
* 1.0.1: 101.
* 1.0: 10.
File: paced.info, Node: Copying, Next: Introduction, Prev: Top, Up: Top
Copying
*******
Copyright (C) 2017-2018 Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see
.
File: paced.info, Node: Introduction, Next: Dictionaries, Prev: Copying, Up: Top
Introduction
************
Paced (Predictive Abbreviation Completion and Expansion using
Dictionaries) scans a group of files (determined by “population
commands”) to construct a usage table (dictionary). Words (or symbols)
are sorted by their usage, and may be later presented to the user for
completion. A dictionary can then be saved to a file, to be loaded
later.
Population commands determine how a dictionary should be filled with
words or symbols. A dictionary may have multiple population commands,
and population may be performed asynchronously. Once population is
finished, the contents are sorted, with more commonly used words at the
front. Dictionaries may be edited through EIEIO’s customize-object
interface.
Completion is done through ‘completion-at-point’. The dictionary to
use for completion can be customized.
* Menu:
* Similar Packages:: Packages with similar goals
* Installation:: How to install paced
* Basic Setup:: The simplest setup
File: paced.info, Node: Similar Packages, Next: Installation, Up: Introduction
Similar Packages
================
There are a few Emacs packages that have similar goals to paced, and
provided some of the inspiration and motivation behind it.
* Menu:
* pabbrev::
* predictive::
File: paced.info, Node: pabbrev, Next: predictive, Up: Similar Packages
pabbrev
-------
The pabbrev (https://github.com/phillord/pabbrev) package by Phillip
Lord automatically scans text of the current buffer while Emacs is idle
and presents the user with the most common completions.
One of the major downsides to pabbrev is that the data it collects
doesn’t persist between Emacs sessions. For a few files that are always
open, such as org agenda files, pabbrev works great. If you want to
train it from a few files that aren’t always open, you’ll have to open
each file and retrain pabbrev from that file. And you’ll have to do
this every time you restart Emacs.
It keeps up-to-date usage and prefix hashes of all buffers of the
same mode, and scanning, or “scavenging”, blends seamlessly into the
background. Completion is just a hash table lookup, so it can handle
completion in microseconds. There’s also no setup required; it will
start working right away. The downside to this is that dictionaries
aren’t flexible; each dictionary corresponds to a major mode, and
there’s no way to change that.
File: paced.info, Node: predictive, Prev: pabbrev, Up: Similar Packages
predictive
----------
The predictive (https://www.dr-qubit.org/predictive.html) package by
Toby Cubitt scans text of the current buffer on user command. The usage
data is stored in a dictionary, which can then be saved to a disk.
Extensions are provided to ‘completion-at-point’, or predictive’s
built-in frontend can be used. It has a safety precaution where it only
adds existing words to a dictionary, unless the user allows this. This
is to avoid adding typos to a dictionary.
Completion was also done intelligently, grouping commonly used words
together and optionally suggesting shorter words before longer words.
While the frontend and backend are separate, the frontend is required
to populate a dictionary. There is no way to exclude part of the
buffer’s text from dictionary population. The safety precaution
predictive has where it only adds a word to a dictionary if it already
exists was tedious, since I didn’t need it to do that.
File: paced.info, Node: Installation, Next: Basic Setup, Prev: Similar Packages, Up: Introduction
Installation
============
*Requirements*
Emacs 25.1
async 1.9.1
Paced may be installed from source, or from GNU ELPA.
From ELPA:
M-x package-install RET paced RET
From Source:
bzr branch https://bzr.savannah.gnu.org/r/paced-el paced
After installing from source, add the following to your init file
(typically .emacs):
(add-to-list 'load-path "/full/path/to/paced/")
(require 'paced)
However you install paced, you must also make sure dictionaries are
loaded on startup:
(paced-load-all-dictionaries)
File: paced.info, Node: Basic Setup, Prev: Installation, Up: Introduction
Basic Setup
===========
Paced needn’t have a lot of setup to run. In fact, the simplest setup
is as follows:
1. Create a new dictionary, “Default” (See *note Creating a
Dictionary::)
2. Set ‘paced-global-dictionary-enable-alist’ to ‘((t . "Default"))’
(See *note Selective Dictionaries::)
3. Run ‘M-x global-paced-mode’
4. To add a file to the dictionary, use ‘M-x
paced-add-buffer-file-to-dictionary’
This will create a default dictionary and populate it from buffers
you specify.
File: paced.info, Node: Dictionaries, Next: Population Commands, Prev: Introduction, Up: Top
Dictionaries
************
* Menu:
* Creating a Dictionary:: First steps
* Editing a Dictionary:: How to edit your new dictionary
* Selective Dictionaries:: Enabling certain dictionaries under certain conditions
* Dictionary Files:: Loading and Saving the Dictionaries
* Printing a Dictionary:: Seeing the contents of a dictionary
File: paced.info, Node: Creating a Dictionary, Next: Editing a Dictionary, Up: Dictionaries
Creating a Dictionary
=====================
Now that you’ve got paced installed, it’s time to create a new
dictionary.
M-x paced-create-new-dictionary RET DICTIONARY_NAME RET DICTIONARY_FILE RET
Let’s explain those two arguments:
First, you’ve got DICTIONARY_NAME. This is a string that will be used
to reference the new dictionary. We recommend something short, like
’new-dict’, ’my-dict’, ’writing’, etc.
Next is the file where the dictionary will be stored. This is
typically stored in ‘paced-dictionary-directory’, from which all
dictionaries will be loaded with ‘paced-load-all-dictionaries’ (more on
that later). For now, it’s important to know that
‘paced-load-all-dictionaries’ is the easiest way to load dictionaries
when paced is loaded.
After you’ve run the above command, you will be taken to the
customization buffer. This is where you can set population commands.
File: paced.info, Node: Editing a Dictionary, Next: Selective Dictionaries, Prev: Creating a Dictionary, Up: Dictionaries
Editing a Dictionary
====================
In order to edit a dictionary, paced provides
‘paced-edit-named-dictionary’ and ‘paced-edit-current-dictionary’.
The edit buffer provides the options to change the population
commands, case handling, dictionary storage name, and sort method. Each
of these is documented in the edit buffer.
File: paced.info, Node: Selective Dictionaries, Next: Dictionary Files, Prev: Editing a Dictionary, Up: Dictionaries
Selective Dictionaries
======================
Paced provides a mechanism called the “enable list”, that allows a user
to enable certain dictionaries for completion given certain conditions.
There are two enable lists: a global
(‘paced-global-dictionary-enable-alist’) and local
(‘paced-local-dictionary-enable-alist’) one. They both work the same,
with the local one taking precedence. Each entry in the list has a
condition and a key.
The conditions are one of the following:
• A mode name, such as ‘org-mode’ or ‘text-mode’, indicating that the
named dictionary should be active in any mode derived from that
mode.
• A symbol, in which case the named dictionary is active whenever the
value of that symbol is non-nil. This includes the symbol ‘t’.
• A function symbol, in which case the function is called with no
arguments to determine if the given dictionary should be enabled.
If the function returns non-nil the dictionary is enabled.
• A lambda function, in which case it is called with no arguments,
and if it returns non-nil, the dictionary is enabled.
• The form (or CONDITION1 CONDITION2 ...), which enables the given
dictionary if any of the conditions are met.
• The form (and CONDITION1 CONDITION2 ...), which enables the given
dictionary if all of the conditions are met.
Remember that paced-mode must be active for completion to occur.
Neither list will activate it, just determine which dictionary is
active.
The key is the dictionary name you set during dictionary creation.
File: paced.info, Node: Dictionary Files, Next: Printing a Dictionary, Prev: Selective Dictionaries, Up: Dictionaries
Dictionary Files
================
Paced provides ‘paced-load-all-dictionaries’ to load all dictionaries in
‘paced-dictionary-directory’. Paced determines which dictionaries to
load based on two variables:
‘paced-dictionary-directory-whitelist-regexp’ and
‘paced-dictionary-directory-blacklist-regexp’. Paced can also be told
to search recursively by setting
‘paced-load-all-dictionaries-recursively’ to t. All four of these
variables may be set using Emacs’s customization interface.
An individual dictionary file may also be loaded:
M-x paced-load-dictionary-from-file RET /path/to/file RET
Once a file has been modified, it may then be saved:
M-x paced-save-named-dictionary RET dictionary name RET
Or, all dictionaries may be saved:
M-x paced-save-all-dictionaries RET
Dictionaries may also be automatically saved whenever changed by
setting ‘paced-repopulate-saves-dictionary’ to t. Population is covered
in the next section.
File: paced.info, Node: Printing a Dictionary, Prev: Dictionary Files, Up: Dictionaries
Printing a Dictionary
=====================
Paced allows a user to print the contents of a dictionary to a buffer.
Uses for this might be to tweak population commands or exclude
functions, or to simply make sure a dictionary is populating correctly.
To use this feature, run:
M-x paced-print-named-dictionary RET NAME-OF-DICTIONARY RET
Or for the current dictionary:
M-x paced-print-current-dictionary RET
File: paced.info, Node: Population Commands, Next: Example Setups, Prev: Dictionaries, Up: Top
Population Commands
*******************
Part of the beauty of paced is the ease of reconstructing a dictionary.
When you’ve got a bunch of files from which you want to populate your
dictionary, it’d be a pain to go to each of them and say “populate from
this one, next, populate from this one, next”.
Instead, paced provides population commands. Each dictionary has one
or more population commands it uses to recreate its contents, run in
order during population.
In order to trigger population, run the following:
M-x paced-repopulate-named-dictionary RET DICTIONARY-NAME RET
* Menu:
* Built-in Commands:: Basics
* Properties:: Tweaking the defaults
* Custom Commands:: Defining new population commands
* Asynchronous Population:: Populating without blocking
File: paced.info, Node: Built-in Commands, Next: Properties, Up: Population Commands
Built-in Commands
=================
There are five built-in population commands:
file
Populates a dictionary from all words in a given file
buffer
Populates a dictionary from all words in a given buffer, which must
exist during population
file-function
Like the file command, but allows a custom setup function. This
function is called with no arguments in a temporary buffer
containing the file’s contents, and must return non-nil if
population may continue.
directory-regexp
Populates from all files in a directory that match the given
regexp. Also optionally allows recursion.
file-list
Populates from all files returned by a generator function.
File: paced.info, Node: Properties, Next: Custom Commands, Prev: Built-in Commands, Up: Population Commands
Properties
==========
When setting the population commands of a dictionary, one may also set
certain properties. Each property is a variable binding, bound while
the population command runs.
A few variables are of note here:
paced-exclude-function
Function of no arguments that returns non-nil if the thing at point
should be excluded from population.
paced-thing-at-point-constituent
Symbol defining thing on which population works. Typically set to
either ’symbol or ’word.
paced-character-limit
Maximum length of a thing to include it in a dictionary. If set to
0 (default), no limit is imposed.
For convenience, properties that are intended for all population
commands of a given dictionary may be set in the dictionary itself. In
the event of a conflict, population command properties take precedence
over dictionary properties.
File: paced.info, Node: Custom Commands, Next: Asynchronous Population, Prev: Properties, Up: Population Commands
Custom Commands
===============
Since the population commands all derive from paced-population-command,
it’s possible to add additional commands.
As an example, let’s make a population command that populates a
dictionary from a file like so:
alpha 5
beta 7
gamma 21
delta 54
epsilon 2
We want to make a population command that takes a file like this,
with word in one column and weight in the other, and add it to a
dictionary.
There are two ways to approach this, but we’re going to start with
the basic one.
We need to define two functions: paced-population-command-source-list
and paced-population-command-setup-buffer. The first returns a list of
sources from which to populate, and the second sets up a temporary
buffer based on those sources.
For our command, we want to return the specified file, and replicate
each word by the amount given.
Inheriting from ‘paced-file-population-command’ gives us the source
list and file slot for free.
(defclass paced-weight-file-population-command (paced-file-population-command))
Now, we need to set up the buffer to replicate the words.
(cl-defmethod paced-population-command-setup-buffer ((cmd paced-weight-file-population-command) source)
;; Use the built-in `paced--insert-file-contents' to insert contents.
(paced--insert-file-contents source)
;; Jump to the start of the buffer
(goto-char (point-min))
;; Search for lines with the form WORD WEIGHT
(while (re-search-forward (rx line-start ;; Start of line
(submatch (one-or-more (not (syntax whitespace)))) ;; Our word
(syntax whitespace) ;; Space between word and weight
(submatch (one-or-more (any digit))) ;; Weight
line-end) ;; End of line
nil t)
(let* ((word (match-string 1))
(weight (string-to-number (match-string 2)))
;; Repeat WORD WEIGHT times
(new-text (string-join (make-list weight word) " ")))
;; Replace the matched text with our repeated word
(replace-match new-text))))
That’s all there is to it. When you go to edit a dictionary, the
“weight-file” population command will automatically be added as an
option for a population command.
The even easier way to do this would’ve been to use
‘paced-file-function-population-command’, but it doesn’t make for a good
example in this case.
File: paced.info, Node: Asynchronous Population, Prev: Custom Commands, Up: Population Commands
Asynchronous Population
=======================
A common problem is that population can take a long time. Some of us
populate dictionaries from org agenda files, which can get pretty big.
To solve this, paced uses the async
(https://github.com/jwiegley/emacs-async) package. Setup is seamless;
just stick whatever code you need in ‘~/.emacs.d/paced-async.el’, and
use one of the two population commands:
A named dictionary:
M-x paced-repopulate-named-dictionary-async RET NAME RET
Or the current dictionary:
M-x paced-repopulate-current-dictionary-async RET
A few things to note about this:
1. Dictionaries will be automatically saved by this method after
population
2. Asynchronous population doesn’t change anything until after
population is finished, so a user may continue to use their
dictionary while population is happening. This also means that
multiple populations may run in parallel without interfering with
one another.
3. Because async runs population in a separate Emacs process, any
custom code required for population must be in paced-async.el.
This includes additional population command types, but doesn’t
include the following variables:
• load-path
• paced-thing-at-point-constituent
• paced-async-load-file
File: paced.info, Node: Example Setups, Next: Contributing, Prev: Population Commands, Up: Top
Example Setups
**************
* Menu:
* Org Agenda Files::
* Project Files::
* Markdown Files::
* Repopulating Dictionary After Saving::
* Repopulating Dictionary After Spellchecking the Buffer::
File: paced.info, Node: Org Agenda Files, Next: Project Files, Up: Example Setups
Org Agenda Files
================
As some of us record everything about our lives in our agenda files, it
might be helpful to have a dictionary tuned to ourselves.
We use a file-list command that returns the agenda files, and an
exclude command to block out all of Org’s extra features such as source
code and drawers.
The generator for file-list is easy:
(lambda nil org-agenda-files)
Done.
Now, the exclude command, which sits inside the properties option.
This can be added to ‘paced-async.el’:
(require 'org)
(defun org-at-tag-p ()
(let* ((p (point)))
;; Ignore errors from `org-get-tags-string'.
(ignore-errors
;; Checks the match string for a tag heading, setting match-string 1 to the
;; tags. Also sets match-beginning and match-end.
(org-get-tags-string)
(when (match-string 1)
(<= (match-beginning 1) p (match-end 1))))))
(defun org-paced-exclude ()
(or
;; Drawers
(org-between-regexps-p org-drawer-regexp ":END:") ;; Doesn't catch END
(org-in-regexp ":END:") ;; but this does
(org-at-tag-p) ;; tags
(org-at-comment-p) ;; comments
(org-in-regexp org-any-link-re) ;; links
(org-in-block-p '("src" "quote" "verse")) ;; blocks
(org-at-planning-p) ;; deadline, etc.
(org-at-table-p) ;; tables
))
As explained earlier, this can be put inside properties in the
customize buffer as such:
Properties :
[INS] [DEL] Variable: paced-exclude-function
Lisp expression: 'org-paced-exclude
And you’re done. See how easy that was?
File: paced.info, Node: Project Files, Next: Markdown Files, Prev: Org Agenda Files, Up: Example Setups
Project Files
=============
Now we get to the interesting one. There are tons of ways to collect
project files in Emacs, so we’re going to stick with one for now, being
Emacs’s built-in VC package.
(defun vc-paced-find-project-files (path-to-project-root)
"Use VC to collect all version-controlled files."
(let ((file-list))
(vc-file-tree-walk path-to-project-root (lambda (f) (push f file-list)))
file-list))
We’d then need to use the following for our file-list generator:
Generator : (lambda nil (vc-paced-find-project-files "/home/me/programming/paced"))
Now, we (probably) don’t want commented code to get in our way, so
we’ll use a small function for excluding those:
(defun paced-at-comment-p ()
(nth 8 (syntax-ppss)))
Use that for paced-exclude-function, and you’re done. We can’t
necessarily recommend this for any programming language, as there are
dedicated solutions for almost everything, but it makes an excellent
fallback.
File: paced.info, Node: Markdown Files, Next: Repopulating Dictionary After Saving, Prev: Project Files, Up: Example Setups
Markdown Files
==============
Another common request is markdown files. In order for this to work,
you’ll need to install ‘markdown-mode’:
M-x package-install RET markdown-mode RET
After that, add the following to your ‘paced-async.el’ file:
(require 'markdown-mode)
(defun paced-markdown-exclude-p ()
"Taken from `markdown-flyspell-check-word-p'."
;; Exclude anything markdown mode thinks flyspell should skip.
(or
;; Ignore code blocks
(markdown-code-block-at-point-p)
(markdown-inline-code-at-point-p)
;; Ignore comments
(markdown-in-comment-p)
;; Ignore special text
(let ((faces (get-text-property (point) 'face)))
(if (listp faces)
(or (memq 'markdown-reference-face faces)
(memq 'markdown-markup-face faces)
(memq 'markdown-plain-url-face faces)
(memq 'markdown-inline-code-face faces)
(memq 'markdown-url-face faces))
(memq faces '(markdown-reference-face
markdown-markup-face
markdown-plain-url-face
markdown-inline-code-face
markdown-url-face))))))
That excludes anything that the developers of markdown-mode felt
should be excluded from flyspell.
Set this as your exclude function in your dictionary’s settings, then
add each markdown file by hand.
File: paced.info, Node: Repopulating Dictionary After Saving, Next: Repopulating Dictionary After Spellchecking the Buffer, Prev: Markdown Files, Up: Example Setups
Repopulating Dictionary After Saving
====================================
This is a common request, although with the power of async, it’s an easy
one to fulfill. This will repopulate the current buffer’s dictionary
every time you save a file with a dictionary. This may seem daunting,
but the dictionary will remain usable during population, and multiple
populations won’t interfere with one another.
;; Repopulate the current dictionary after saving
(add-hook 'after-save-hook 'paced-repopulate-current-dictionary-async)
Add that to your .emacs file, and paced will take it from there.
If you decide that’s too much, do the following:
M-: (remove-hook 'after-save-hook 'paced-repopulate-current-dictionary-async) RET
File: paced.info, Node: Repopulating Dictionary After Spellchecking the Buffer, Prev: Repopulating Dictionary After Saving, Up: Example Setups
Repopulating Dictionary After Spellchecking the Buffer
======================================================
Another request, although much trickier to do. This one involves using
Emacs’s advice mechanism:
(define-advice ispell-pdict-save (:after (&optional _no-query _force-save) paced-populate)
;; Repopulate the current dictionary after running spell check
(paced-repopulate-current-dictionary-async))
If you decide this isn’t for you, do the following to revert the
changes:
M-: (advice-remove #'ispell-pdict-save #'ispell-pdict-save@paced-populate) RET
File: paced.info, Node: Contributing, Next: Changelog, Prev: Example Setups, Up: Top
Contributing
************
We are all happy for any help you may provide.
First, check out the source code on Savannah:
bzr branch https://bzr.savannah.gnu.org/r/paced-el/ paced
Build the Makefile with EDE:
1. Open any file from paced (See *note Working with EDE:: if you
encounter “Corrupt object on disk” error)
2. Run ‘C-c . C’ or ‘M-x ede-compile-project’
* Menu:
* Bugs:: Submitting bug reports
* Development:: Helping with development
* Documentation:: Improving the documentation
* Working with EDE:: And all its quirks
File: paced.info, Node: Bugs, Next: Development, Up: Contributing
Bugs
====
There are two ways to submit bug reports:
1. Using the bug tracker at Savannah
2. Sending an email using ‘paced-submit-bug-report’
When submitting a bug report, be sure to include a description of the
dictionary or population command that caused the problem, with as much
detail as possible.
File: paced.info, Node: Development, Next: Documentation, Prev: Bugs, Up: Contributing
Development
===========
If you’re new to bazaar, we recommend using Emacs’s built-in VC package.
It eases the overhead of dealing with a brand new VCS with a few
standard commands. For more information, see the info page on it (In
Emacs, this is C-h r m Introduction to VC RET).
To contribute with bazaar, you can do the following:
# Hack away and make your changes
$ bzr commit -m "Changes I've made"
$ bzr send -o file-name.txt
Then, use ‘paced-submit-bug-report’ and attach “file-name.txt”. We
can then merge that into the main development branch.
There are a few rules to follow:
• New population commands should be named
paced-POPULATION-COMMAND-TYPE-population-command
• Run ’make check’ to verify that your mods don’t break anything
• Avoid additional or altered dependencies if at all possible
• Dictionary commands come in threes (“the operation triad”):
1. paced-dictionary-OPERATION, a cl-defmethod which performs
OPERATION on a dictionary
2. paced-OPERATION-on-named-dictionary, an interactive only
function that prompts for a dictionary name and performs
OPERATION on that dictionary:
(interactive (list (paced-read-dictionary)))
(paced-ensure-registered name)
(paced-dictionary-OPERATION (paced-named-dictionary name))
3. paced-OPERATION-on-current-dictionary, an interactive function
that performs OPERATION on the current dictionary
(interactive)
(paced-dictionary-OPERATION (paced-current-dictionary-or-die))
File: paced.info, Node: Documentation, Next: Working with EDE, Prev: Development, Up: Contributing
Documentation
=============
Documentation is always helpful to us. Please be sure to do the
following after making any changes:
1. Update the info page in the repository with ‘C-c C-e i i’
2. If you’re updating the HTML documentation, switch to a theme that
can easily be read on a white background; we recommend the
“adwaita” theme
File: paced.info, Node: Working with EDE, Prev: Documentation, Up: Contributing
Working with EDE
================
EDE can be a little finicky at times, but we feel the benefits, namely
package dependency handling and Makefile generation, outweigh the costs.
One of the issues that many will likely encounter is the error
“Corrupt file on disk”. This is most often due to EDE not loading all
its subprojects as needed. If you find yourself dealing with this error
often, place the following in your .emacs file:
;; Target types needed for working with paced
(require 'ede/proj-elisp)
(require 'ede/proj-aux)
(require 'ede/proj-misc)
These are the three target types that paced uses: elisp for
compilation and autoloads; aux for auxiliary files such as
documentation; and misc for tests.
When creating a new file, EDE will ask if you want to add it to a
target. Consult with one of the paced devs for guidance, but usually
selecting “none” and letting one of us handle it is a good way to go.
File: paced.info, Node: Changelog, Prev: Contributing, Up: Top
Changelog
*********
* Menu:
* 1.1.1: 111.
* 1.1: 11.
* 1.0.1: 101.
* 1.0: 10.
File: paced.info, Node: 111, Next: 11, Up: Changelog
1.1.1
=====
• Fixed bug with asynchronous population throwing an error on no
dictionary
• Set ‘paced-throw-error-on-no-current’ to nil by default
File: paced.info, Node: 11, Next: 101, Prev: 111, Up: Changelog
1.1
===
• Cleaned up the code to reflect the “operation triad”
• -OP, OP-on-named, OP-on-current
• Retained backwards compatibility by obsoleting a bunch of
functions, but didn’t remove any of them
• Also removed the use of dict- in global variables and
functions
• Added the ability to print the contents of a dictionary in a
separate buffer
• Added the option to limit the words added during population by size
• Various documentation improvements
File: paced.info, Node: 101, Next: 10, Prev: 11, Up: Changelog
1.0.1
=====
Bug fix release
• Save dictionaries right after they’re created
• Added “force” parameter to save functions
File: paced.info, Node: 10, Prev: 101, Up: Changelog
1.0
===
Initial release.
Tag Table:
Node: Top228
Node: Copying1985
Node: Introduction2804
Node: Similar Packages3924
Node: pabbrev4210
Node: predictive5353
Node: Installation6401
Node: Basic Setup7063
Node: Dictionaries7678
Node: Creating a Dictionary8151
Node: Editing a Dictionary9191
Node: Selective Dictionaries9667
Node: Dictionary Files11405
Node: Printing a Dictionary12526
Node: Population Commands13048
Node: Built-in Commands13984
Node: Properties14781
Node: Custom Commands15779
Node: Asynchronous Population18506
Node: Example Setups19955
Node: Org Agenda Files20256
Node: Project Files22016
Node: Markdown Files23152
Node: Repopulating Dictionary After Saving24777
Node: Repopulating Dictionary After Spellchecking the Buffer25705
Node: Contributing26450
Node: Bugs27224
Node: Development27613
Node: Documentation29374
Node: Working with EDE29841
Node: Changelog30884
Node: 11131034
Node: 1131261
Node: 10131868
Node: 1032076
End Tag Table
Local Variables:
coding: utf-8
End:
paced-1.1.1/paced-pkg.el 0000644 0001752 0001753 00000000426 13236276726 013414 0 ustar elpa elpa ;; Generated package description from paced.el
(define-package "paced" "1.1.1" "Predictive Abbreviation Completion and Expansion using Dictionaries" '((emacs "25.1") (async "1.9.1")) :url "https://savannah.nongnu.org/projects/paced-el/" :keywords '("convenience" "completion"))
paced-1.1.1/dir 0000644 0001752 0001753 00000001254 13213056546 011727 0 ustar elpa elpa This is the file .../info/dir, which contains the
topmost node of the Info hierarchy, called (dir)Top.
The first time you invoke Info you start off looking at this node.
File: dir, Node: Top This is the top of the INFO tree
This (the Directory node) gives a menu of major topics.
Typing "q" exits, "H" lists all Info commands, "d" returns here,
"h" gives a primer for first-timers,
"mEmacs" visits the Emacs manual, etc.
In Emacs, you can click mouse button 2 on a menu item or cross reference
to select it.
* Menu:
Emacs
* Paced: (paced). Predictive Abbreviation Completion and
Expansion using Dictionaries.
paced-1.1.1/paced-tests.el 0000644 0001752 0001753 00000061442 13235701354 013767 0 ustar elpa elpa ;;; paced-tests.el --- Tests for paced -*- lexical-binding: t; -*-
;; Copyright (C) 2017-2018 Free Software Foundation, Inc.
;; Author: Ian Dunn
;; Maintainer: Ian Dunn
;; Keywords: convenience, completion
;; Package-Requires: ((emacs "25.1") (async "1.9.1"))
;; URL: https://savannah.nongnu.org/projects/paced-el/
;; Version: 1.1
;; Created: 22 Jan 2017
;; Modified: 04 Feb 2018
;; This file is part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free Software
;; Foundation; either version 3, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
;; details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see .
;;; Commentary:
;;; Code:
(require 'paced)
(require 'ert)
(defconst paced-test-dir
(expand-file-name "test-files" (file-name-directory (or load-file-name buffer-file-name))))
(defsubst paced-test-file (base-name)
(expand-file-name base-name paced-test-dir))
(defconst paced-first-test-file (paced-test-file "first.txt"))
(defconst paced-second-test-file (paced-test-file "second.cpp"))
(defconst paced-third-test-file (paced-test-file "third.org"))
(defconst paced-test-dict-save-file (paced-test-file "paced-dictionary-case-sensitive"))
(defconst paced-test-default-registered-map (make-hash-table :test 'equal))
(ert-deftest paced-handle-word-case ()
(let* ((word "EiEiO"))
(should (string-equal (paced--handle-word-case 'preserve word) "EiEiO"))
(should (string-equal (paced--handle-word-case 'downcase word) "eieio"))
(should (string-equal (paced--handle-word-case 'upcase word) "EIEIO"))
(should (string-equal (paced--handle-word-case 'downcase-first word) "eiEiO"))
(should (string-equal (paced--handle-word-case 'upcase-first word) "EiEiO"))
(should (string-equal (paced--handle-word-case 'mixed-case word) "EiEiO"))))
(ert-deftest paced-mixed-case-word ()
(should-not (paced-mixed-case-word-p "HAS"))
(should (paced-mixed-case-word-p "HAs"))
(should (paced-mixed-case-word-p "HaS"))
(should-not (paced-mixed-case-word-p "Has"))
(should (paced-mixed-case-word-p "hAS"))
(should (paced-mixed-case-word-p "hAs"))
(should (paced-mixed-case-word-p "haS"))
(should-not (paced-mixed-case-word-p "has")))
(ert-deftest paced-create-dictionary ()
;; Delete the old save file
(when (file-exists-p paced-test-dict-save-file)
(delete-file paced-test-dict-save-file))
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(new-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (= (map-length paced--registered-dictionaries) 1))
(should (paced-dictionary-p new-dict))
(oset new-dict updated t) ;; Mark it as updated so it saves
(paced-dictionary-save new-dict)
(should (file-exists-p paced-test-dict-save-file)))
(let* ((paced--registered-dictionaries paced-test-default-registered-map))
;; Now verify that we can load it again
(paced-load-dictionary-from-file paced-test-dict-save-file)
(should (= (map-length paced--registered-dictionaries) 1))
(should (map-contains-key paced--registered-dictionaries "test-dict-case"))
(should (paced-dictionary-p (paced-named-dictionary "test-dict-case")))))
(defvar paced-test-enable-symbol nil)
(ert-deftest paced-enable-list-symbol ()
"Test case for `paced-dictionary-enable-alist' being an arbitrary symbol."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((paced-test-enable-symbol . "test-dict-case")))
(new-buffer (find-file-noselect paced-first-test-file)))
(paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)
(with-current-buffer new-buffer
(setq paced-test-enable-symbol nil)
(should-not (paced-current-dictionary))
(setq-local paced-test-enable-symbol t)
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case")))
(kill-buffer new-buffer)))
(ert-deftest paced-enable-list-mode ()
"Test case for `paced-dictionary-enable-alist' being a mode symbol."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(buffer-one (find-file-noselect paced-first-test-file))
(buffer-two (find-file-noselect paced-second-test-file)))
(paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)
(with-current-buffer buffer-two
(should-not (paced-current-dictionary)))
(kill-buffer buffer-two)
(with-current-buffer buffer-one
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case")))
(kill-buffer buffer-one)))
(defun paced-test-function-symbol ()
paced-test-enable-symbol)
(ert-deftest paced-enable-list-function-symbol ()
"Test case for `paced-dictionary-enable-alist' being a function symbol."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((paced-test-function-symbol . "test-dict-case")))
(buffer-one (find-file-noselect paced-first-test-file)))
(paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)
(with-current-buffer buffer-one
(setq-local paced-test-enable-symbol nil)
(should-not (paced-current-dictionary))
(setq-local paced-test-enable-symbol t)
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case")))
(kill-buffer buffer-one)))
(ert-deftest paced-enable-list-lambda-function ()
"Test case for `paced-dictionary-enable-alist' being a lambda form."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '(((lambda nil paced-test-enable-symbol) . "test-dict-case")))
(buffer-one (find-file-noselect paced-first-test-file)))
(paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)
(with-current-buffer buffer-one
(setq-local paced-test-enable-symbol nil)
(should-not (paced-current-dictionary))
(setq-local paced-test-enable-symbol t)
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case")))
(kill-buffer buffer-one)))
(ert-deftest paced-enable-list-and-form ()
"Test case for `paced-dictionary-enable-alist' being an 'and' form."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '(((and text-mode paced-test-enable-symbol) . "test-dict-case")))
(buffer-one (find-file-noselect paced-first-test-file))
(buffer-two (find-file-noselect paced-second-test-file)))
(paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)
(with-current-buffer buffer-two
(setq-local paced-test-enable-symbol nil)
(should-not (paced-current-dictionary))
(setq-local paced-test-enable-symbol t)
(should-not (paced-current-dictionary)))
(kill-buffer buffer-two)
(with-current-buffer buffer-one
(setq-local paced-test-enable-symbol nil)
(should-not (paced-current-dictionary))
(setq-local paced-test-enable-symbol t)
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case")))
(kill-buffer buffer-one)))
(ert-deftest paced-enable-list-or-form ()
"Test case for `paced-dictionary-enable-alist' being an 'or' form."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '(((or text-mode paced-test-enable-symbol) . "test-dict-case")))
(buffer-one (find-file-noselect paced-first-test-file))
(buffer-two (find-file-noselect paced-second-test-file)))
(paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)
(with-current-buffer buffer-two
(setq-local paced-test-enable-symbol nil)
(should-not (paced-current-dictionary))
(setq-local paced-test-enable-symbol t)
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case")))
(kill-buffer buffer-two)
(with-current-buffer buffer-one
(setq-local paced-test-enable-symbol nil)
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case"))
(setq-local paced-test-enable-symbol t)
(should (paced-dictionary-p (paced-current-dictionary)))
(should (string-equal (paced-dictionary-name (paced-current-dictionary)) "test-dict-case")))
(kill-buffer buffer-one)))
(ert-deftest paced-populate-file ()
"Test case for single file populator."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd (paced-file-population-command :file paced-first-test-file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 4))
(should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three" "four")))
(should (eq (map-elt usage-hash "one") 1))
(should (eq (map-elt usage-hash "two") 2))
(should (eq (map-elt usage-hash "three") 3))
(should (eq (map-elt usage-hash "four") 4)))))
(ert-deftest paced-populate-buffer ()
"Test case for single buffer populator."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(buffer "first.txt")
(buffer-one (find-file-noselect paced-first-test-file))
(cmd (paced-buffer-population-command :buffer buffer))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 4))
(should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three" "four")))
(should (eq (map-elt usage-hash "one") 1))
(should (eq (map-elt usage-hash "two") 2))
(should (eq (map-elt usage-hash "three") 3))
(should (eq (map-elt usage-hash "four") 4)))
(kill-buffer buffer-one)))
(ert-deftest paced-populate-file-function ()
"Test case for file-function populator."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(pre-func (lambda () (insert (buffer-string)) t))
(cmd (paced-file-function-population-command :file paced-first-test-file
:setup-func pre-func))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 4))
(should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three" "four")))
(should (eq (map-elt usage-hash "one") 2))
(should (eq (map-elt usage-hash "two") 4))
(should (eq (map-elt usage-hash "three") 6))
(should (eq (map-elt usage-hash "four") 8)))))
(ert-deftest paced-populate-directory-regexp ()
"Test case for directory-regexp populator."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd (paced-directory-regexp-population-command :directory paced-test-dir
:regexp ".*\\.txt"
:recursive t))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 4))
(should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three" "four")))
(should (eq (map-elt usage-hash "one") 1))
(should (eq (map-elt usage-hash "two") 2))
(should (eq (map-elt usage-hash "three") 3))
(should (eq (map-elt usage-hash "four") 4)))))
(ert-deftest paced-populate-file-list ()
"Test case for file-list populator."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(file-list (lambda () `(,paced-first-test-file)))
(cmd (paced-file-list-population-command :generator file-list))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 4))
(should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three" "four")))
(should (eq (map-elt usage-hash "one") 1))
(should (eq (map-elt usage-hash "two") 2))
(should (eq (map-elt usage-hash "three") 3))
(should (eq (map-elt usage-hash "four") 4)))))
(ert-deftest paced-multiple-population-commands ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd1 (paced-file-population-command :file paced-first-test-file))
(cmd2 (paced-file-population-command :file paced-third-test-file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd1 cmd2))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 7))
(should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three" "four" "five" "six" "seven")))
(should (eq (map-elt usage-hash "one") 1))
(should (eq (map-elt usage-hash "two") 2))
(should (eq (map-elt usage-hash "three") 3))
(should (eq (map-elt usage-hash "four") 4))
(should (eq (map-elt usage-hash "five") 5))
(should (eq (map-elt usage-hash "six") 3))
(should (eq (map-elt usage-hash "seven") 1)))))
(ert-deftest paced-populator-settings ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(exclude-command (lambda nil (nth 8 (syntax-ppss)))) ;; exclude comments
(cmd1 (paced-file-population-command :file paced-first-test-file))
(cmd2 (paced-file-population-command :file paced-second-test-file
:props `((paced-exclude-function quote ,exclude-command))))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd1 cmd2))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 4))
(should (seq-set-equal-p (map-keys usage-hash) '("one" "two" "three" "four")))
(should (eq (map-elt usage-hash "one") 1))
(should (eq (map-elt usage-hash "two") 2))
(should (eq (map-elt usage-hash "three") 3))
(should (eq (map-elt usage-hash "four") 4)))))
(ert-deftest paced-populate-sort-order ()
"Test case for sorting after population."
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd (paced-file-population-command :file paced-first-test-file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (eq (map-length usage-hash) 4))
(should (equal (map-keys usage-hash) '("four" "three" "two" "one")))
(should (eq (map-elt usage-hash "one") 1))
(should (eq (map-elt usage-hash "two") 2))
(should (eq (map-elt usage-hash "three") 3))
(should (eq (map-elt usage-hash "four") 4)))))
(ert-deftest paced-populate-non-existent-file ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(file "first.txt")
(cmd (paced-file-population-command :file file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (map-empty-p usage-hash)))))
(ert-deftest paced-populate-non-existent-buffer ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(buffer "first.txt")
(cmd (paced-buffer-population-command :buffer buffer))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((usage-hash (oref test-dict usage-hash)))
(should (map-empty-p usage-hash)))))
(ert-deftest paced-completions-try-completion ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd (paced-file-population-command :file paced-first-test-file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((completions (paced-dictionary-completions test-dict "o" nil)))
(should (equal completions '("o"))))))
(ert-deftest paced-completions-try-completion-mixed-case ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd (paced-file-population-command :file paced-first-test-file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'mixed-case)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(let ((completions (paced-dictionary-completions test-dict "o" nil)))
(should (equal completions '("o"))))))
(ert-deftest paced-completions-all-completions ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd (paced-file-population-command :file paced-first-test-file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(should (equal (paced-dictionary-completions test-dict "o" t)
'("one")))
(should (equal (paced-dictionary-completions test-dict "on" t)
'("one")))
(should (equal (paced-dictionary-completions test-dict "t" t)
'("three" "two")))
(should (equal (paced-dictionary-completions test-dict "v" t)
nil))))
(ert-deftest paced-completions-test-completion ()
(let* ((paced--registered-dictionaries paced-test-default-registered-map)
(paced-global-dictionary-enable-alist '((text-mode . "test-dict-case")))
(cmd (paced-file-population-command :file paced-first-test-file))
(test-dict (paced-make-dictionary "test-dict-case"
paced-test-dict-save-file
'downcase)))
(should (paced-dictionary-p test-dict))
(oset test-dict population-commands (list cmd))
(paced-dictionary-repopulate test-dict)
(should (paced-dictionary-completions test-dict "one" 'lambda))
(should-not (paced-dictionary-completions test-dict "o" 'lambda))))
(ert-deftest paced-merge-properties ()
(let* ((prop-list-1 '((a . "abc") (b . "xyz")))
(prop-list-2 '((a . "def") (c . "ghi")))
(prop-list-3 nil)
(merged-1 (paced-merge-properties prop-list-1 prop-list-2))
(merged-2 (paced-merge-properties prop-list-3 prop-list-2)))
(should (equal (map-elt merged-1 'a) '("def")))
(should (equal (map-elt merged-1 'b) '("xyz")))
(should (equal (map-elt merged-1 'c) '("ghi")))
(should (equal (map-elt merged-2 'a) '("def")))
(should (equal (map-elt merged-2 'c) '("ghi")))))
(ert-deftest paced-beginning-end-of-thing-at-point ()
"Test exclusion and `paced-point-in-thing-at-point-for-exclusion'."
(let* ((paced-exclude-function (lambda () (looking-at-p "one")))
(buffer-one (find-file-noselect paced-first-test-file)))
(with-current-buffer buffer-one
(goto-char (point-min))
(should (equal (paced-thing-at-point) "one"))
(let ((paced-point-in-thing-at-point-for-exclusion 'beginning))
(should (paced-excluded-p)))
(paced-forward-thing)
(should (equal (paced-thing-at-point) "one"))
(let ((paced-point-in-thing-at-point-for-exclusion 'end))
(should-not (paced-excluded-p))))))
(ert-deftest paced-character-limit ()
"Test character limit."
(let* ((paced-exclude-function (lambda () nil))
(buffer-one (find-file-noselect paced-first-test-file)))
(with-current-buffer buffer-one
(goto-char (point-min))
(should (equal (paced-thing-at-point) "one"))
(let* ((paced-character-limit 0))
(should-not (paced-excluded-p)))
(let* ((paced-character-limit 1))
(should (paced-excluded-p)))
(let* ((paced-character-limit 3))
(should-not (paced-excluded-p))))))
(provide 'paced-tests)
;;; paced-tests.el ends here
paced-1.1.1/test-files/ 0000755 0001752 0001753 00000000000 13213056546 013303 5 ustar elpa elpa paced-1.1.1/test-files/second.cpp 0000644 0001752 0001753 00000000062 13213056546 015260 0 ustar elpa elpa // empty file that doesn't inherit from text mode
paced-1.1.1/test-files/first.txt 0000644 0001752 0001753 00000000062 13213056546 015171 0 ustar elpa elpa one two three four two three four three four four
paced-1.1.1/test-files/third.org 0000644 0001752 0001753 00000000053 13213056546 015124 0 ustar elpa elpa five five five five five six six seven six