1995-01-22 06:18:46 +00:00
|
|
|
;;; tempo.el --- Flexible template insertion
|
1996-01-14 07:34:30 +00:00
|
|
|
|
2005-08-06 22:13:43 +00:00
|
|
|
;; Copyright (C) 1994, 1995, 2002, 2003, 2004,
|
|
|
|
;; 2005 Free Software Foundation, Inc.
|
1994-05-02 05:16:59 +00:00
|
|
|
|
2002-02-16 12:48:37 +00:00
|
|
|
;; Author: David K}gedal <davidk@lysator.liu.se>
|
1994-05-02 05:16:59 +00:00
|
|
|
;; Created: 16 Feb 1994
|
1995-06-20 13:43:22 +00:00
|
|
|
;; K}gedal's last version number: 1.2.4
|
1994-05-02 05:16:59 +00:00
|
|
|
;; Keywords: extensions, languages, tools
|
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
;; GNU Emacs 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 2, or (at your option)
|
|
|
|
;; any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs 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
|
1996-01-14 07:34:30 +00:00
|
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
2005-07-04 23:32:44 +00:00
|
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
;; Boston, MA 02110-1301, USA.
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; This file provides a simple way to define powerful templates, or
|
|
|
|
;; macros, if you wish. It is mainly intended for, but not limited to,
|
|
|
|
;; other programmers to be used for creating shortcuts for editing
|
|
|
|
;; certain kind of documents. It was originally written to be used by
|
1995-04-03 22:23:51 +00:00
|
|
|
;; a HTML editing mode written by Nelson Minar <nelson@santafe.edu>,
|
|
|
|
;; and his html-helper-mode.el is probably the best example of how to
|
|
|
|
;; use this program.
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
;; A template is defined as a list of items to be inserted in the
|
|
|
|
;; current buffer at point. Some of the items can be simple strings,
|
|
|
|
;; while other can control formatting or define special points of
|
|
|
|
;; interest in the inserted text.
|
|
|
|
|
|
|
|
;; If a template defines a "point of interest" that point is inserted
|
|
|
|
;; in a buffer-local list of "points of interest" that the user can
|
|
|
|
;; jump between with the commands `tempo-backward-mark' and
|
|
|
|
;; `tempo-forward-mark'. If the template definer provides a prompt for
|
|
|
|
;; the point, and the variable `tempo-interactive' is non-nil, the
|
|
|
|
;; user will be prompted for a string to be inserted in the buffer,
|
|
|
|
;; using the minibuffer.
|
|
|
|
|
|
|
|
;; The template can also define one point to be replaced with the
|
|
|
|
;; current region if the template command is called with a prefix (or
|
|
|
|
;; a non-nil argument).
|
|
|
|
|
|
|
|
;; More flexible templates can be created by including lisp symbols,
|
2000-09-17 01:04:35 +00:00
|
|
|
;; which will be evaluated as variables, or lists, which will be
|
1994-05-02 05:16:59 +00:00
|
|
|
;; evaluated as lisp expressions.
|
|
|
|
|
|
|
|
;; See the documentation for tempo-define-template for the different
|
|
|
|
;; items that can be used to define a tempo template.
|
|
|
|
|
|
|
|
;; One of the more powerful features of tempo templates are automatic
|
|
|
|
;; completion. With every template can be assigned a special tag that
|
|
|
|
;; should be recognized by `tempo-complete-tag' and expanded to the
|
|
|
|
;; complete template. By default the tags are added to a global list
|
|
|
|
;; of template tags, and are matched against the last word before
|
|
|
|
;; point. But if you assign your tags to a specific list, you can also
|
|
|
|
;; specify another method for matching text in the buffer against the
|
|
|
|
;; tags. In the HTML mode, for instance, the tags are matched against
|
|
|
|
;; the text between the last `<' and point.
|
|
|
|
|
|
|
|
;; When defining a template named `foo', a symbol named
|
|
|
|
;; `tempo-template-foo' will be created whose value as a variable will
|
|
|
|
;; be the template definition, and its function value will be an
|
|
|
|
;; interactive function that inserts the template at the point.
|
|
|
|
|
|
|
|
;; The latest tempo.el distribution can be fetched from
|
|
|
|
;; ftp.lysator.liu.se in the directory /pub/emacs
|
|
|
|
|
1995-06-19 21:27:06 +00:00
|
|
|
;; There is also a WWW page at
|
|
|
|
;; http://www.lysator.liu.se/~davidk/elisp/ which has some information
|
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
;;; Known bugs:
|
|
|
|
|
|
|
|
;; If the 'o is the first element in a template, strange things can
|
|
|
|
;; happen when the template is inserted at the beginning of a
|
|
|
|
;; line. This is due to strange behaviour in open-line. But it should
|
|
|
|
;; be easily avoided.
|
|
|
|
|
|
|
|
;; The 'o tag is also a problem when including the region. This will
|
|
|
|
;; be looked into.
|
|
|
|
|
|
|
|
;; Clicking mouse-2 in the completion buffer gives strange results.
|
|
|
|
|
|
|
|
;; There is a bug in some emacs versions that prevents completion from
|
|
|
|
;; working. If it doesn't work for you, send me a note indicating your
|
|
|
|
;; emacs version and your problems.
|
|
|
|
|
1995-04-03 22:23:51 +00:00
|
|
|
;;; Contributors:
|
|
|
|
|
1996-01-04 23:49:34 +00:00
|
|
|
;; These people have given me important feedback and new ideas for
|
1995-04-03 22:23:51 +00:00
|
|
|
;; tempo.el. Thanks.
|
|
|
|
|
|
|
|
;; Nelson Minar <nelson@santafe.edu>
|
1999-08-16 04:04:27 +00:00
|
|
|
;; Richard Stallman <rms@gnu.org>
|
1995-04-03 22:23:51 +00:00
|
|
|
;; Lars Lindberg <Lars.Lindberg@sypro.cap.se>
|
|
|
|
;; Glen Whitney <Glen.Whitney@math.lsa.umich.edu>
|
|
|
|
|
1994-05-02 05:16:59 +00:00
|
|
|
;;; Code:
|
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
;;; User options
|
1994-05-02 05:16:59 +00:00
|
|
|
|
1998-03-07 18:19:38 +00:00
|
|
|
(defgroup tempo nil
|
|
|
|
"Flexible template insertion."
|
|
|
|
:prefix "tempo-"
|
|
|
|
:group 'tools)
|
|
|
|
|
|
|
|
(defcustom tempo-interactive nil
|
1994-05-02 05:16:59 +00:00
|
|
|
"*Prompt user for strings in templates.
|
|
|
|
If this variable is non-nil, `tempo-insert' prompts the
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
user for text to insert in the templates."
|
1998-03-07 18:19:38 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'tempo)
|
1994-05-02 05:16:59 +00:00
|
|
|
|
1998-03-07 18:19:38 +00:00
|
|
|
(defcustom tempo-insert-region nil
|
1994-05-08 21:11:37 +00:00
|
|
|
"*Automatically insert current region when there is a `r' in the template
|
2001-12-20 18:59:32 +00:00
|
|
|
If this variable is nil, `r' elements will be treated just like `p'
|
1994-05-08 21:11:37 +00:00
|
|
|
elements, unless the template function is given a prefix (or a non-nil
|
2005-06-10 14:07:27 +00:00
|
|
|
argument). If this variable is non-nil, the behavior is reversed.
|
1995-01-22 06:18:46 +00:00
|
|
|
|
1998-03-07 18:19:38 +00:00
|
|
|
In Transient Mark mode, this option is unused."
|
|
|
|
:type 'boolean
|
|
|
|
:group 'tempo)
|
1994-05-08 21:11:37 +00:00
|
|
|
|
1998-03-07 18:19:38 +00:00
|
|
|
(defcustom tempo-show-completion-buffer t
|
2001-12-20 18:59:32 +00:00
|
|
|
"*If non-nil, show a buffer with possible completions, when only
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
a partial completion can be found."
|
1998-03-07 18:19:38 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'tempo)
|
1994-05-08 21:11:37 +00:00
|
|
|
|
1998-03-07 18:19:38 +00:00
|
|
|
(defcustom tempo-leave-completion-buffer nil
|
2001-12-20 18:59:32 +00:00
|
|
|
"*If nil, a completion buffer generated by \\[tempo-complete-tag]
|
1998-03-07 18:19:38 +00:00
|
|
|
disappears at the next keypress; otherwise, it remains forever."
|
|
|
|
:type 'boolean
|
|
|
|
:group 'tempo)
|
1994-05-08 21:11:37 +00:00
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
;;; Internal variables
|
|
|
|
|
1994-05-02 05:16:59 +00:00
|
|
|
(defvar tempo-insert-string-functions nil
|
|
|
|
"List of functions to run when inserting a string.
|
1995-06-19 21:27:06 +00:00
|
|
|
Each function is called with a single arg, STRING and should return
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
another string. This could be used for making all strings upcase by
|
1995-06-19 21:27:06 +00:00
|
|
|
setting it to '(upcase), for example.")
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
(defvar tempo-tags nil
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
"An association list with tags and corresponding templates.")
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
(defvar tempo-local-tags '((tempo-tags . nil))
|
|
|
|
"A list of locally installed tag completion lists.
|
|
|
|
It is a association list where the car of every element is a symbol
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
whose variable value is a template list. The cdr part, if non-nil,
|
|
|
|
is a function or a regexp that defines the string to match. See the
|
1994-05-02 05:16:59 +00:00
|
|
|
documentation for the function `tempo-complete-tag' for more info.
|
|
|
|
|
|
|
|
`tempo-tags' is always in the last position in this list.")
|
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
(defvar tempo-collection nil
|
|
|
|
"A collection of all the tags defined for the current buffer.")
|
|
|
|
|
|
|
|
(defvar tempo-dirty-collection t
|
|
|
|
"Indicates if the tag collection needs to be rebuilt.")
|
|
|
|
|
1994-05-02 05:16:59 +00:00
|
|
|
(defvar tempo-marks nil
|
|
|
|
"A list of marks to jump to with `\\[tempo-forward-mark]' and `\\[tempo-backward-mark]'.")
|
|
|
|
|
2004-11-06 11:28:42 +00:00
|
|
|
(defvar tempo-match-finder "\\b\\([[:word:]]+\\)\\="
|
1995-01-22 06:18:46 +00:00
|
|
|
"The regexp or function used to find the string to match against tags.
|
|
|
|
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
If `tempo-match-finder' is a string, it should contain a regular
|
|
|
|
expression with at least one \\( \\) pair. When searching for tags,
|
1995-01-22 06:18:46 +00:00
|
|
|
`tempo-complete-tag' calls `re-search-backward' with this string, and
|
|
|
|
the string between the first \\( and \\) is used for matching against
|
|
|
|
each string in the tag list. If one is found, the whole text between
|
|
|
|
the first \\( and the point is replaced with the inserted template.
|
|
|
|
|
2004-11-06 14:49:45 +00:00
|
|
|
You will probably want to include \\=\\= at the end of the regexp to
|
1995-01-22 06:18:46 +00:00
|
|
|
make sure that the string is matched only against text adjacent to the
|
|
|
|
point.
|
|
|
|
|
|
|
|
If `tempo-match-finder' is a symbol, it should be a function that
|
|
|
|
returns a pair of the form (STRING . POS), where STRING is the string
|
|
|
|
used for matching and POS is the buffer position after which text
|
|
|
|
should be replaced with a template.")
|
|
|
|
|
|
|
|
(defvar tempo-user-elements nil
|
|
|
|
"Element handlers for user-defined elements.
|
|
|
|
A list of symbols which are bound to functions that take one argument.
|
1996-01-04 23:49:34 +00:00
|
|
|
This function should return something to be sent to `tempo-insert' if
|
2001-12-20 18:59:32 +00:00
|
|
|
it recognizes the argument, and nil otherwise.")
|
1994-05-02 05:16:59 +00:00
|
|
|
|
1994-05-08 21:11:37 +00:00
|
|
|
(defvar tempo-named-insertions nil
|
2001-12-20 18:59:32 +00:00
|
|
|
"Temporary storage for named insertions.")
|
1994-05-08 21:11:37 +00:00
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
(defvar tempo-region-start (make-marker)
|
2001-12-20 18:59:32 +00:00
|
|
|
"Region start when inserting around the region.")
|
1995-01-22 06:18:46 +00:00
|
|
|
|
|
|
|
(defvar tempo-region-stop (make-marker)
|
2001-12-20 18:59:32 +00:00
|
|
|
"Region stop when inserting around the region.")
|
1995-01-22 06:18:46 +00:00
|
|
|
|
1994-05-02 05:16:59 +00:00
|
|
|
;; Make some variables local to every buffer
|
|
|
|
|
|
|
|
(make-variable-buffer-local 'tempo-marks)
|
|
|
|
(make-variable-buffer-local 'tempo-local-tags)
|
1995-01-22 06:18:46 +00:00
|
|
|
(make-variable-buffer-local 'tempo-match-finder)
|
|
|
|
(make-variable-buffer-local 'tempo-collection)
|
|
|
|
(make-variable-buffer-local 'tempo-dirty-collection)
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
;;; Functions
|
|
|
|
|
|
|
|
;;
|
|
|
|
;; tempo-define-template
|
|
|
|
|
|
|
|
(defun tempo-define-template (name elements &optional tag documentation taglist)
|
|
|
|
"Define a template.
|
|
|
|
This function creates a template variable `tempo-template-NAME' and an
|
|
|
|
interactive function `tempo-template-NAME' that inserts the template
|
|
|
|
at the point. The created function is returned.
|
|
|
|
|
|
|
|
NAME is a string that contains the name of the template, ELEMENTS is a
|
|
|
|
list of elements in the template, TAG is the tag used for completion,
|
|
|
|
DOCUMENTATION is the documentation string for the insertion command
|
|
|
|
created, and TAGLIST (a symbol) is the tag list that TAG (if provided)
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
should be added to. If TAGLIST is nil and TAG is non-nil, TAG is
|
|
|
|
added to `tempo-tags'.
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
The elements in ELEMENTS can be of several types:
|
|
|
|
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
- A string: It is sent to the hooks in `tempo-insert-string-functions',
|
1994-05-02 05:16:59 +00:00
|
|
|
and the result is inserted.
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
- The symbol `p': This position is saved in `tempo-marks'.
|
|
|
|
- The symbol `r': If `tempo-insert' is called with ON-REGION non-nil
|
|
|
|
the current region is placed here. Otherwise it works like `p'.
|
|
|
|
- (p PROMPT <NAME> <NOINSERT>): If `tempo-interactive' is non-nil, the
|
2002-01-20 17:54:36 +00:00
|
|
|
user is prompted in the minibuffer with PROMPT for a string to be
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
inserted. If the optional parameter NAME is non-nil, the text is
|
|
|
|
saved for later insertion with the `s' tag. If there already is
|
1995-06-19 21:27:06 +00:00
|
|
|
something saved under NAME that value is used instead and no
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
prompting is made. If NOINSERT is provided and non-nil, nothing is
|
|
|
|
inserted, but text is still saved when a NAME is provided. For
|
|
|
|
clarity, the symbol `noinsert' should be used as argument.
|
|
|
|
- (P PROMPT <NAME> <NOINSERT>): Works just like the previous tag, but
|
|
|
|
forces `tempo-interactive' to be true.
|
|
|
|
- (r PROMPT <NAME> <NOINSERT>): Like the previous tag, but if
|
1995-06-19 21:27:06 +00:00
|
|
|
`tempo-interactive' is nil and `tempo-insert' is called with
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
ON-REGION non-nil, the current region is placed here. This usually
|
1995-06-19 21:27:06 +00:00
|
|
|
happens when you call the template function with a prefix argument.
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
- (s NAME): Inserts text previously read with the (p ..) construct.
|
|
|
|
Finds the insertion saved under NAME and inserts it. Acts like `p'
|
1994-05-08 21:11:37 +00:00
|
|
|
if tempo-interactive is nil.
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
- `&': If there is only whitespace between the line start and point,
|
|
|
|
nothing happens. Otherwise a newline is inserted.
|
|
|
|
- `%': If there is only whitespace between point and end of line,
|
|
|
|
nothing happens. Otherwise a newline is inserted.
|
|
|
|
- `n': Inserts a newline.
|
|
|
|
- `>': The line is indented using `indent-according-to-mode'. Note
|
|
|
|
that you often should place this item after the text you want on
|
|
|
|
the line.
|
|
|
|
- `r>': Like `r', but it also indents the region.
|
|
|
|
- `n>': Inserts a newline and indents line.
|
|
|
|
- `o': Like `%' but leaves the point before the newline.
|
|
|
|
- nil: It is ignored.
|
|
|
|
- Anything else: It is evaluated and the result is treated as an
|
|
|
|
element to be inserted. One additional tag is useful for these
|
|
|
|
cases. If an expression returns a list '(l foo bar), the elements
|
|
|
|
after `l' will be inserted according to the usual rules. This makes
|
1995-06-19 21:27:06 +00:00
|
|
|
it possible to return several elements from one expression."
|
1994-05-02 05:16:59 +00:00
|
|
|
(let* ((template-name (intern (concat "tempo-template-"
|
|
|
|
name)))
|
|
|
|
(command-name template-name))
|
|
|
|
(set template-name elements)
|
|
|
|
(fset command-name (list 'lambda (list '&optional 'arg)
|
2003-02-04 12:29:42 +00:00
|
|
|
(or documentation
|
1994-05-02 05:16:59 +00:00
|
|
|
(concat "Insert a " name "."))
|
|
|
|
(list 'interactive "*P")
|
|
|
|
(list 'tempo-insert-template (list 'quote
|
1994-05-08 21:11:37 +00:00
|
|
|
template-name)
|
|
|
|
(list 'if 'tempo-insert-region
|
|
|
|
(list 'not 'arg) 'arg))))
|
1994-05-02 05:16:59 +00:00
|
|
|
(and tag
|
|
|
|
(tempo-add-tag tag template-name taglist))
|
|
|
|
command-name))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-insert-template
|
|
|
|
|
|
|
|
(defun tempo-insert-template (template on-region)
|
|
|
|
"Insert a template.
|
|
|
|
TEMPLATE is the template to be inserted. If ON-REGION is non-nil the
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
`r' elements are replaced with the current region. In Transient Mark
|
1995-01-22 06:18:46 +00:00
|
|
|
mode, ON-REGION is ignored and assumed true if the region is active."
|
1995-06-19 21:27:06 +00:00
|
|
|
(unwind-protect
|
|
|
|
(progn
|
1995-06-20 13:43:22 +00:00
|
|
|
(if (or (and (boundp 'transient-mark-mode) ; For Emacs
|
1995-06-19 21:27:06 +00:00
|
|
|
transient-mark-mode
|
|
|
|
mark-active)
|
2005-07-16 17:06:34 +00:00
|
|
|
(if (featurep 'xemacs)
|
2005-07-22 18:44:45 +00:00
|
|
|
(and zmacs-regions (mark))))
|
1995-06-19 21:27:06 +00:00
|
|
|
(setq on-region t))
|
|
|
|
(and on-region
|
|
|
|
(set-marker tempo-region-start (min (mark) (point)))
|
|
|
|
(set-marker tempo-region-stop (max (mark) (point))))
|
|
|
|
(if on-region
|
|
|
|
(goto-char tempo-region-start))
|
|
|
|
(save-excursion
|
|
|
|
(tempo-insert-mark (point-marker))
|
|
|
|
(mapcar (function (lambda (elt)
|
|
|
|
(tempo-insert elt on-region)))
|
|
|
|
(symbol-value template))
|
|
|
|
(tempo-insert-mark (point-marker)))
|
|
|
|
(tempo-forward-mark))
|
|
|
|
(tempo-forget-insertions)
|
|
|
|
;; Should I check for zmacs here too???
|
|
|
|
(and (boundp 'transient-mark-mode)
|
|
|
|
transient-mark-mode
|
|
|
|
(deactivate-mark))))
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-insert
|
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
(defun tempo-insert (element on-region)
|
1994-05-02 05:16:59 +00:00
|
|
|
"Insert a template element.
|
1995-01-22 06:18:46 +00:00
|
|
|
Insert one element from a template. If ON-REGION is non-nil the `r'
|
|
|
|
elements are replaced with the current region.
|
|
|
|
|
|
|
|
See documentation for `tempo-define-template' for the kind of elements
|
|
|
|
possible."
|
1994-05-02 05:16:59 +00:00
|
|
|
(cond ((stringp element) (tempo-process-and-insert-string element))
|
1995-06-19 21:27:06 +00:00
|
|
|
((and (consp element)
|
|
|
|
(eq (car element) 'p)) (tempo-insert-prompt-compat
|
|
|
|
(cdr element)))
|
|
|
|
((and (consp element)
|
|
|
|
(eq (car element) 'P)) (let ((tempo-interactive t))
|
|
|
|
(tempo-insert-prompt-compat
|
|
|
|
(cdr element))))
|
|
|
|
;;; ((and (consp element)
|
|
|
|
;;; (eq (car element) 'v)) (tempo-save-named
|
|
|
|
;;; (nth 1 element)
|
|
|
|
;;; nil
|
|
|
|
;;; (nth 2 element)))
|
|
|
|
((and (consp element)
|
|
|
|
(eq (car element) 'r)) (if on-region
|
|
|
|
(goto-char tempo-region-stop)
|
|
|
|
(tempo-insert-prompt-compat
|
|
|
|
(cdr element))))
|
|
|
|
((and (consp element)
|
|
|
|
(eq (car element) 's)) (tempo-insert-named (car (cdr element))))
|
|
|
|
((and (consp element)
|
|
|
|
(eq (car element) 'l)) (mapcar (function
|
|
|
|
(lambda (elt)
|
|
|
|
(tempo-insert elt on-region)))
|
|
|
|
(cdr element)))
|
1994-05-02 05:16:59 +00:00
|
|
|
((eq element 'p) (tempo-insert-mark (point-marker)))
|
|
|
|
((eq element 'r) (if on-region
|
1995-01-22 06:18:46 +00:00
|
|
|
(goto-char tempo-region-stop)
|
1994-05-02 05:16:59 +00:00
|
|
|
(tempo-insert-mark (point-marker))))
|
1995-01-22 06:18:46 +00:00
|
|
|
((eq element 'r>) (if on-region
|
|
|
|
(progn
|
|
|
|
(goto-char tempo-region-stop)
|
|
|
|
(indent-region (mark) (point) nil))
|
|
|
|
(tempo-insert-mark (point-marker))))
|
1994-05-02 05:16:59 +00:00
|
|
|
((eq element '>) (indent-according-to-mode))
|
|
|
|
((eq element '&) (if (not (or (= (current-column) 0)
|
|
|
|
(save-excursion
|
|
|
|
(re-search-backward
|
|
|
|
"^\\s-*\\=" nil t))))
|
|
|
|
(insert "\n")))
|
|
|
|
((eq element '%) (if (not (or (eolp)
|
|
|
|
(save-excursion
|
|
|
|
(re-search-forward
|
|
|
|
"\\=\\s-*$" nil t))))
|
|
|
|
(insert "\n")))
|
|
|
|
((eq element 'n) (insert "\n"))
|
|
|
|
((eq element 'n>) (insert "\n") (indent-according-to-mode))
|
1995-01-22 06:18:46 +00:00
|
|
|
;; Bug: If the 'o is the first element in a template, strange
|
|
|
|
;; things can happen when the template is inserted at the
|
|
|
|
;; beginning of a line.
|
|
|
|
((eq element 'o) (if (not (or on-region
|
|
|
|
(eolp)
|
|
|
|
(save-excursion
|
|
|
|
(re-search-forward
|
|
|
|
"\\=\\s-*$" nil t))))
|
|
|
|
(open-line 1)))
|
1994-05-02 05:16:59 +00:00
|
|
|
((null element))
|
1995-01-22 06:18:46 +00:00
|
|
|
(t (tempo-insert (or (tempo-is-user-element element)
|
|
|
|
(eval element))
|
|
|
|
on-region))))
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-insert-prompt
|
|
|
|
|
1995-06-19 21:27:06 +00:00
|
|
|
(defun tempo-insert-prompt-compat (prompt)
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
"Compatibility hack for `tempo-insert-prompt'.
|
1995-06-19 21:27:06 +00:00
|
|
|
PROMPT can be either a prompt string, or a list of arguments to
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
`tempo-insert-prompt', or nil."
|
2001-12-20 18:59:32 +00:00
|
|
|
(if (consp prompt) ; not nil either
|
1995-06-19 21:27:06 +00:00
|
|
|
(apply 'tempo-insert-prompt prompt)
|
|
|
|
(tempo-insert-prompt prompt)))
|
|
|
|
|
|
|
|
(defun tempo-insert-prompt (prompt &optional save-name no-insert)
|
1994-05-02 05:16:59 +00:00
|
|
|
"Prompt for a text string and insert it in the current buffer.
|
|
|
|
If the variable `tempo-interactive' is non-nil the user is prompted
|
|
|
|
for a string in the minibuffer, which is then inserted in the current
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
buffer. If `tempo-interactive' is nil, the current point is placed on
|
1994-05-08 21:11:37 +00:00
|
|
|
`tempo-mark'.
|
1994-05-02 05:16:59 +00:00
|
|
|
|
1995-06-19 21:27:06 +00:00
|
|
|
PROMPT is the prompt string, SAVE-NAME is a name to save the inserted
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
text under. If the optional argument NO-INSERT is non-nil, no text is
|
|
|
|
inserted. This can be useful when there is a SAVE-NAME.
|
1995-06-19 21:27:06 +00:00
|
|
|
|
|
|
|
If there already is a value for SAVE-NAME, it is used and the user is
|
|
|
|
never prompted."
|
|
|
|
(let (insertion
|
|
|
|
(previous (and save-name
|
|
|
|
(tempo-lookup-named save-name))))
|
|
|
|
(cond
|
|
|
|
;; Insert previous value, unless no-insert is non-nil
|
|
|
|
((and previous
|
|
|
|
(not no-insert))
|
|
|
|
(tempo-insert-named save-name)) ; A double lookup here, but who
|
|
|
|
; cares
|
|
|
|
;; If no-insert is non-nil, don't insert the previous value. Just
|
|
|
|
;; keep it
|
|
|
|
(previous
|
|
|
|
nil)
|
|
|
|
;; No previous value. Prompt or insert mark
|
|
|
|
(tempo-interactive
|
|
|
|
(if (not (stringp prompt))
|
|
|
|
(error "tempo: The prompt (%s) is not a string" prompt))
|
|
|
|
(setq insertion (read-string prompt))
|
|
|
|
(or no-insert
|
|
|
|
(insert insertion))
|
|
|
|
(if save-name
|
|
|
|
(tempo-save-named save-name insertion)))
|
|
|
|
(t
|
|
|
|
(tempo-insert-mark (point-marker))))))
|
1994-05-02 05:16:59 +00:00
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-is-user-element
|
|
|
|
|
|
|
|
(defun tempo-is-user-element (element)
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
"Tries all the user-defined element handlers in `tempo-user-elements'."
|
1995-01-22 06:18:46 +00:00
|
|
|
;; Sigh... I need (some list)
|
|
|
|
(catch 'found
|
|
|
|
(mapcar (function (lambda (handler)
|
|
|
|
(let ((result (funcall handler element)))
|
|
|
|
(if result (throw 'found result)))))
|
|
|
|
tempo-user-elements)
|
|
|
|
(throw 'found nil)))
|
|
|
|
|
1994-05-08 21:11:37 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-forget-insertions
|
|
|
|
|
|
|
|
(defun tempo-forget-insertions ()
|
|
|
|
"Forget all the saved named insertions."
|
|
|
|
(setq tempo-named-insertions nil))
|
|
|
|
|
1995-06-19 21:27:06 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-save-named
|
|
|
|
|
|
|
|
(defun tempo-save-named (name data) ; Had an optional prompt for 'v
|
|
|
|
"Save some data for later insertion
|
|
|
|
The contents of DATA is saved under the name NAME.
|
|
|
|
|
|
|
|
The data can later be retrieved with `tempo-lookup-named'.
|
|
|
|
|
|
|
|
This function returns nil, so it can be used in a template without
|
|
|
|
inserting anything."
|
|
|
|
(setq tempo-named-insertions
|
|
|
|
(cons (cons name data)
|
|
|
|
tempo-named-insertions))
|
|
|
|
nil)
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-lookup-named
|
|
|
|
|
|
|
|
(defun tempo-lookup-named (name)
|
|
|
|
"Lookup some saved data under the name NAME.
|
|
|
|
Returns the data if NAME was found, and nil otherwise."
|
|
|
|
(cdr (assq name tempo-named-insertions)))
|
|
|
|
|
1994-05-08 21:11:37 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-insert-named
|
|
|
|
|
1995-04-03 22:23:51 +00:00
|
|
|
(defun tempo-insert-named (name)
|
|
|
|
"Insert the previous insertion saved under a named specified in NAME.
|
1995-06-19 21:27:06 +00:00
|
|
|
If there is no such name saved, a tempo mark is inserted.
|
|
|
|
|
|
|
|
Note that if the data is a string, it will not be run through the string
|
|
|
|
processor."
|
|
|
|
(let* ((insertion (tempo-lookup-named name)))
|
|
|
|
(cond ((null insertion)
|
|
|
|
(tempo-insert-mark (point-marker)))
|
|
|
|
((stringp insertion)
|
|
|
|
(insert insertion))
|
|
|
|
(t
|
|
|
|
(tempo-insert insertion nil)))))
|
|
|
|
|
1994-05-08 21:11:37 +00:00
|
|
|
|
1994-05-02 05:16:59 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-process-and-insert-string
|
|
|
|
|
|
|
|
(defun tempo-process-and-insert-string (string)
|
|
|
|
"Insert a string from a template.
|
|
|
|
Run a string through the preprocessors in `tempo-insert-string-functions'
|
|
|
|
and insert the results."
|
|
|
|
(cond ((null tempo-insert-string-functions)
|
|
|
|
nil)
|
|
|
|
((symbolp tempo-insert-string-functions)
|
|
|
|
(setq string
|
1995-04-03 22:23:51 +00:00
|
|
|
(funcall tempo-insert-string-functions string)))
|
1994-05-02 05:16:59 +00:00
|
|
|
((listp tempo-insert-string-functions)
|
2000-02-12 19:46:42 +00:00
|
|
|
(dolist (fn tempo-insert-string-functions)
|
1995-04-03 22:23:51 +00:00
|
|
|
(setq string (funcall fn string))))
|
1994-05-02 05:16:59 +00:00
|
|
|
(t
|
|
|
|
(error "Bogus value in tempo-insert-string-functions: %s"
|
|
|
|
tempo-insert-string-functions)))
|
|
|
|
(insert string))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-insert-mark
|
|
|
|
|
|
|
|
(defun tempo-insert-mark (mark)
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
"Insert a mark `tempo-marks' while keeping it sorted."
|
1994-05-02 05:16:59 +00:00
|
|
|
(cond ((null tempo-marks) (setq tempo-marks (list mark)))
|
|
|
|
((< mark (car tempo-marks)) (setq tempo-marks (cons mark tempo-marks)))
|
|
|
|
(t (let ((lp tempo-marks))
|
|
|
|
(while (and (cdr lp)
|
|
|
|
(<= (car (cdr lp)) mark))
|
|
|
|
(setq lp (cdr lp)))
|
|
|
|
(if (not (= mark (car lp)))
|
|
|
|
(setcdr lp (cons mark (cdr lp))))))))
|
2003-02-04 12:29:42 +00:00
|
|
|
|
1994-05-02 05:16:59 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-forward-mark
|
|
|
|
|
|
|
|
(defun tempo-forward-mark ()
|
|
|
|
"Jump to the next mark in `tempo-forward-mark-list'."
|
|
|
|
(interactive)
|
|
|
|
(let ((next-mark (catch 'found
|
|
|
|
(mapcar
|
|
|
|
(function
|
|
|
|
(lambda (mark)
|
|
|
|
(if (< (point) mark)
|
|
|
|
(throw 'found mark))))
|
|
|
|
tempo-marks)
|
|
|
|
;; return nil if not found
|
|
|
|
nil)))
|
|
|
|
(if next-mark
|
|
|
|
(goto-char next-mark))))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-backward-mark
|
|
|
|
|
|
|
|
(defun tempo-backward-mark ()
|
|
|
|
"Jump to the previous mark in `tempo-back-mark-list'."
|
|
|
|
(interactive)
|
|
|
|
(let ((prev-mark (catch 'found
|
|
|
|
(let (last)
|
|
|
|
(mapcar
|
|
|
|
(function
|
|
|
|
(lambda (mark)
|
|
|
|
(if (<= (point) mark)
|
|
|
|
(throw 'found last))
|
|
|
|
(setq last mark)))
|
|
|
|
tempo-marks)
|
|
|
|
last))))
|
|
|
|
(if prev-mark
|
|
|
|
(goto-char prev-mark))))
|
2003-02-04 12:29:42 +00:00
|
|
|
|
1994-05-02 05:16:59 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-add-tag
|
|
|
|
|
|
|
|
(defun tempo-add-tag (tag template &optional tag-list)
|
|
|
|
"Add a template tag.
|
|
|
|
Add the TAG, that should complete to TEMPLATE to the list in TAG-LIST,
|
|
|
|
or to `tempo-tags' if TAG-LIST is nil."
|
|
|
|
|
|
|
|
(interactive "sTag: \nCTemplate: ")
|
|
|
|
(if (null tag-list)
|
|
|
|
(setq tag-list 'tempo-tags))
|
|
|
|
(if (not (assoc tag (symbol-value tag-list)))
|
1995-01-22 06:18:46 +00:00
|
|
|
(set tag-list (cons (cons tag template) (symbol-value tag-list))))
|
|
|
|
(tempo-invalidate-collection))
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-use-tag-list
|
|
|
|
|
|
|
|
(defun tempo-use-tag-list (tag-list &optional completion-function)
|
|
|
|
"Install TAG-LIST to be used for template completion in the current buffer.
|
|
|
|
TAG-LIST is a symbol whose variable value is a tag list created with
|
1995-01-22 06:18:46 +00:00
|
|
|
`tempo-add-tag'.
|
1994-05-02 05:16:59 +00:00
|
|
|
|
1996-01-04 23:49:34 +00:00
|
|
|
COMPLETION-FUNCTION is an obsolete option for specifying an optional
|
1995-01-22 06:18:46 +00:00
|
|
|
function or string that is used by `\\[tempo-complete-tag]' to find a
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
string to match the tag against. It has the same definition as the
|
|
|
|
variable `tempo-match-finder'. In this version, supplying a
|
1995-01-22 06:18:46 +00:00
|
|
|
COMPLETION-FUNCTION just sets `tempo-match-finder' locally."
|
1994-05-02 05:16:59 +00:00
|
|
|
(let ((old (assq tag-list tempo-local-tags)))
|
|
|
|
(if old
|
|
|
|
(setcdr old completion-function)
|
|
|
|
(setq tempo-local-tags (cons (cons tag-list completion-function)
|
1995-01-22 06:18:46 +00:00
|
|
|
tempo-local-tags))))
|
|
|
|
(if completion-function
|
|
|
|
(setq tempo-match-finder completion-function))
|
|
|
|
(tempo-invalidate-collection))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-invalidate-collection
|
|
|
|
|
|
|
|
(defun tempo-invalidate-collection ()
|
|
|
|
"Marks the tag collection as obsolete.
|
|
|
|
Whenever it is needed again it will be rebuilt."
|
|
|
|
(setq tempo-dirty-collection t))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-build-collection
|
|
|
|
|
|
|
|
(defun tempo-build-collection ()
|
|
|
|
"Build a collection of all the tags and return it.
|
2001-12-20 18:59:32 +00:00
|
|
|
If `tempo-dirty-collection' is nil, the old collection is reused."
|
1995-04-05 19:32:55 +00:00
|
|
|
(prog1
|
|
|
|
(or (and (not tempo-dirty-collection)
|
|
|
|
tempo-collection)
|
|
|
|
(setq tempo-collection
|
|
|
|
(apply (function append)
|
|
|
|
(mapcar (function (lambda (tag-list)
|
1995-01-22 06:18:46 +00:00
|
|
|
; If the format for
|
|
|
|
; tempo-local-tags changes,
|
|
|
|
; change this
|
1995-04-05 19:32:55 +00:00
|
|
|
(eval (car tag-list))))
|
|
|
|
tempo-local-tags))))
|
|
|
|
(setq tempo-dirty-collection nil)))
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-find-match-string
|
|
|
|
|
|
|
|
(defun tempo-find-match-string (finder)
|
|
|
|
"Find a string to be matched against a tag list.
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
FINDER is a function or a string. Returns (STRING . POS), or nil
|
1995-04-03 22:23:51 +00:00
|
|
|
if no reasonable string is found."
|
1994-05-02 05:16:59 +00:00
|
|
|
(cond ((stringp finder)
|
1995-04-03 22:23:51 +00:00
|
|
|
(let (successful)
|
|
|
|
(save-excursion
|
|
|
|
(or (setq successful (re-search-backward finder nil t))
|
|
|
|
0))
|
|
|
|
(if successful
|
|
|
|
(cons (buffer-substring (match-beginning 1)
|
|
|
|
(match-end 1)) ; This seems to be a
|
|
|
|
; bug in emacs
|
|
|
|
(match-beginning 1))
|
|
|
|
nil)))
|
1994-05-02 05:16:59 +00:00
|
|
|
(t
|
|
|
|
(funcall finder))))
|
|
|
|
|
|
|
|
;;;
|
|
|
|
;;; tempo-complete-tag
|
|
|
|
|
|
|
|
(defun tempo-complete-tag (&optional silent)
|
1994-05-08 21:11:37 +00:00
|
|
|
"Look for a tag and expand it.
|
1995-04-03 22:23:51 +00:00
|
|
|
All the tags in the tag lists in `tempo-local-tags'
|
1995-04-05 19:32:55 +00:00
|
|
|
\(this includes `tempo-tags') are searched for a match for the text
|
1995-04-03 22:23:51 +00:00
|
|
|
before the point. The way the string to match for is determined can
|
(tempo-insert-prompt, tempo-interactive, tempo-show-completion-buffer,
tempo-tags, tempo-match-finder, tempo-insert-string-functions, tempo-local-tags,
tempo-define-template, tempo-insert-template, tempo-insert-prompt-compat,
tempo-is-user-element, tempo-insert-mark, tempo-find-match-string,
tempo-complete-tag): Fix typos in docstrings.
2005-07-21 10:33:36 +00:00
|
|
|
be altered with the variable `tempo-match-finder'. If
|
1995-04-03 22:23:51 +00:00
|
|
|
`tempo-match-finder' returns nil, then the results are the same as
|
|
|
|
no match at all.
|
1995-01-22 06:18:46 +00:00
|
|
|
|
|
|
|
If a single match is found, the corresponding template is expanded in
|
|
|
|
place of the matching string.
|
|
|
|
|
|
|
|
If a partial completion or no match at all is found, and SILENT is
|
2001-12-20 18:59:32 +00:00
|
|
|
non-nil, the function will give a signal.
|
1995-01-22 06:18:46 +00:00
|
|
|
|
|
|
|
If a partial completion is found and `tempo-show-completion-buffer' is
|
2001-12-20 18:59:32 +00:00
|
|
|
non-nil, a buffer containing possible completions is displayed."
|
1995-01-22 06:18:46 +00:00
|
|
|
|
|
|
|
;; This function may look like a hack, but this is how I want it to
|
|
|
|
;; work.
|
|
|
|
(interactive "*")
|
|
|
|
(let* ((collection (tempo-build-collection))
|
|
|
|
(match-info (tempo-find-match-string tempo-match-finder))
|
|
|
|
(match-string (car match-info))
|
|
|
|
(match-start (cdr match-info))
|
|
|
|
(exact (assoc match-string collection))
|
|
|
|
(compl (or (car exact)
|
1995-04-03 22:23:51 +00:00
|
|
|
(and match-info (try-completion match-string collection)))))
|
1995-01-22 06:18:46 +00:00
|
|
|
(if compl (delete-region match-start (point)))
|
1995-04-03 22:23:51 +00:00
|
|
|
(cond ((null match-info) (or silent (ding)))
|
|
|
|
((null compl) (or silent (ding)))
|
1995-01-22 06:18:46 +00:00
|
|
|
((eq compl t) (tempo-insert-template
|
|
|
|
(cdr (assoc match-string
|
|
|
|
collection))
|
|
|
|
nil))
|
|
|
|
(t (if (setq exact (assoc compl collection))
|
|
|
|
(tempo-insert-template (cdr exact) nil)
|
|
|
|
(insert compl)
|
|
|
|
(or silent (ding))
|
|
|
|
(if tempo-show-completion-buffer
|
|
|
|
(tempo-display-completions match-string
|
|
|
|
collection)))))))
|
1994-05-02 05:16:59 +00:00
|
|
|
|
|
|
|
|
1994-05-08 21:11:37 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-display-completions
|
|
|
|
|
|
|
|
(defun tempo-display-completions (string tag-list)
|
|
|
|
"Show a buffer containing possible completions for STRING."
|
|
|
|
(if tempo-leave-completion-buffer
|
|
|
|
(with-output-to-temp-buffer "*Completions*"
|
|
|
|
(display-completion-list
|
2005-10-16 09:31:48 +00:00
|
|
|
(all-completions string tag-list)
|
|
|
|
string))
|
1994-05-08 21:11:37 +00:00
|
|
|
(save-window-excursion
|
|
|
|
(with-output-to-temp-buffer "*Completions*"
|
|
|
|
(display-completion-list
|
2005-10-16 09:31:48 +00:00
|
|
|
(all-completions string tag-list)
|
|
|
|
string))
|
1994-05-08 21:11:37 +00:00
|
|
|
(sit-for 32767))))
|
|
|
|
|
1995-04-03 22:23:51 +00:00
|
|
|
;;;
|
|
|
|
;;; tempo-expand-if-complete
|
|
|
|
|
|
|
|
(defun tempo-expand-if-complete ()
|
|
|
|
"Expand the tag before point if it is complete.
|
|
|
|
Returns non-nil if an expansion was made and nil otherwise.
|
|
|
|
|
|
|
|
This could as an example be used in a command that is bound to the
|
|
|
|
space bar, and looks something like this:
|
|
|
|
|
2000-09-17 01:04:35 +00:00
|
|
|
\(defun tempo-space ()
|
1995-04-03 22:23:51 +00:00
|
|
|
(interactive \"*\")
|
|
|
|
(or (tempo-expand-if-complete)
|
|
|
|
(insert \" \")))"
|
|
|
|
|
|
|
|
(interactive "*")
|
|
|
|
(let* ((collection (tempo-build-collection))
|
|
|
|
(match-info (tempo-find-match-string tempo-match-finder))
|
|
|
|
(match-string (car match-info))
|
|
|
|
(match-start (cdr match-info))
|
|
|
|
(exact (assoc match-string collection)))
|
|
|
|
(if exact
|
|
|
|
(progn
|
|
|
|
(delete-region match-start (point))
|
|
|
|
(tempo-insert-template (cdr exact) nil)
|
|
|
|
t)
|
|
|
|
nil)))
|
|
|
|
|
1995-01-22 06:18:46 +00:00
|
|
|
(provide 'tempo)
|
|
|
|
|
2003-09-01 15:45:59 +00:00
|
|
|
;;; arch-tag: b3c0ee36-db3b-47bc-875f-091b4e27a063
|
1994-05-02 05:16:59 +00:00
|
|
|
;;; tempo.el ends here
|