annotate lisp/skeleton.el @ 51122:e45cf4a107cd

*** empty log message ***
author Nick Roberts <nickrob@snap.net.nz>
date Wed, 21 May 2003 20:10:34 +0000
parents 49b8ab00fab0
children 13c3a6c789ba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
1 ;;; skeleton.el --- Lisp language extension for writing statement skeletons
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14006
diff changeset
2
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
3 ;; Copyright (C) 1993, 1994, 1995, 1996 by Free Software Foundation, Inc.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4
23869
8d2bb5d1416a Update comment.
Karl Heuer <kwzh@gnu.org>
parents: 17552
diff changeset
5 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 ;; Maintainer: FSF
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
7 ;; Keywords: extensions, abbrev, languages, tools
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; any later version.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14006
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14006
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14006
diff changeset
24 ;; Boston, MA 02111-1307, USA.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
28 ;; A very concise language extension for writing structured statement
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; skeleton insertion commands for programming language modes. This
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; originated in shell-script mode and was applied to ada-mode's
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;; commands which shrunk to one third. And these commands are now
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 ;; user configurable.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;;; Code:
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
36 ;; page 1: statement skeleton language definition & interpreter
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;; page 2: paired insertion
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 ;; page 3: mirror-mode, an example for setting up paired insertion
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
41 (defvar skeleton-transformation 'identity
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
42 "*If non-nil, function applied to literal strings before they are inserted.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 It should take strings and characters and return them transformed, or nil
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 which means no transformation.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 Typical examples might be `upcase' or `capitalize'.")
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 ; this should be a fourth argument to defvar
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 (put 'skeleton-transformation 'variable-interactive
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 "aTransformation function: ")
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
52 (defvar skeleton-autowrap t
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
53 "Controls wrapping behaviour of functions created with `define-skeleton'.
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
54 When the region is visible (due to `transient-mark-mode' or marking a region
50869
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
55 with the mouse) and this is non-nil and the function was called without an
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
56 explicit ARG, then the ARG defaults to -1, i.e. wrapping around the visible
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
57 region.
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
58
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
59 We will probably delete this variable in a future Emacs version
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
60 unless we get a substantial number of complaints about the auto-wrap
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
61 feature.")
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62
34838
10b89a04d05d (skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34836
diff changeset
63 (defvar skeleton-end-newline t
10b89a04d05d (skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34836
diff changeset
64 "If non-nil, make sure that the skeleton inserted ends with a newline.
10b89a04d05d (skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34836
diff changeset
65 This just influences the way the default `skeleton-end-hook' behaves.")
10b89a04d05d (skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34836
diff changeset
66
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
67 (defvar skeleton-end-hook
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
68 (lambda ()
34838
10b89a04d05d (skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34836
diff changeset
69 (or (eolp) (not skeleton-end-newline) (newline-and-indent)))
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
70 "Hook called at end of skeleton but before going to point of interest.
34838
10b89a04d05d (skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34836
diff changeset
71 By default this moves out anything following to next line,
10b89a04d05d (skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34836
diff changeset
72 unless `skeleton-end-newline' is set to nil.
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
73 The variables `v1' and `v2' are still set when calling this.")
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
74
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
75
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
76 ;;;###autoload
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
77 (defvar skeleton-filter 'identity
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
78 "Function for transforming a skeleton proxy's aliases' variable value.")
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
79
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
80 (defvar skeleton-untabify t
50869
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
81 "When non-nil untabifies when deleting backwards with element -ARG.")
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
82
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
83 (defvar skeleton-newline-indent-rigidly nil
50869
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
84 "When non-nil, indent rigidly under current line for element `\\n'.
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
85 Else use mode's `indent-line-function'.")
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
86
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
87 (defvar skeleton-further-elements ()
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
88 "A buffer-local varlist (see `let') of mode specific skeleton elements.
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
89 These variables are bound while interpreting a skeleton. Their value may
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
90 in turn be any valid skeleton element if they are themselves to be used as
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
91 skeleton elements.")
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
92 (make-variable-buffer-local 'skeleton-further-elements)
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
93
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
94
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 (defvar skeleton-subprompt
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 (substitute-command-keys
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 "RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]")
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
98 "*Replacement for %s in prompts of recursive subskeletons.")
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
101 (defvar skeleton-abbrev-cleanup nil
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
102 "Variable used to delete the character that led to abbrev expansion.")
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
103
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 (defvar skeleton-debug nil
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 "*If non-nil `define-skeleton' will override previous definition.")
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107
16768
5ff0874f1309 (skeleton-positions): Renamed from skeleton-marks.
Richard M. Stallman <rms@gnu.org>
parents: 16767
diff changeset
108 (defvar skeleton-positions nil
5ff0874f1309 (skeleton-positions): Renamed from skeleton-marks.
Richard M. Stallman <rms@gnu.org>
parents: 16767
diff changeset
109 "List of positions marked with @, after skeleton insertion.
5ff0874f1309 (skeleton-positions): Renamed from skeleton-marks.
Richard M. Stallman <rms@gnu.org>
parents: 16767
diff changeset
110 The list describes the most recent skeleton insertion, and its elements
5ff0874f1309 (skeleton-positions): Renamed from skeleton-marks.
Richard M. Stallman <rms@gnu.org>
parents: 16767
diff changeset
111 are integer buffer positions in the reverse order of the insertion order.")
16767
6d837bb21c55 (skeleton-marks): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 16427
diff changeset
112
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
113 ;; reduce the number of compiler warnings
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
114 (defvar skeleton)
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
115 (defvar skeleton-modified)
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
116 (defvar skeleton-point)
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
117 (defvar skeleton-regions)
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 ;;;###autoload
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
120 (defmacro define-skeleton (command documentation &rest skeleton)
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 "Define a user-configurable COMMAND that enters a statement skeleton.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 DOCUMENTATION is that of the command, while the variable of the same name,
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
123 which contains the skeleton, has a documentation to that effect.
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
124 INTERACTOR and ELEMENT ... are as defined under `skeleton-insert'."
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 (if skeleton-debug
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
126 (set command skeleton))
12862
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
127 `(progn
15544
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
128 (defun ,command (&optional str arg)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
129 ,(concat documentation
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
130 (if (string-match "\n\\>" documentation)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
131 "" "\n")
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
132 "\n"
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
133 "This is a skeleton command (see `skeleton-insert').
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
134 Normally the skeleton text is inserted at point, with nothing \"inside\".
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
135 If there is a highlighted region, the skeleton text is wrapped
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
136 around the region text.
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
137
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
138 A prefix argument ARG says to wrap the skeleton around the next ARG words.
17544
9ba1f7641826 (define-skeleton): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 17515
diff changeset
139 A prefix argument of -1 says to wrap around region, even if not highlighted.
15544
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
140 A prefix argument of zero says to wrap around zero words---that is, nothing.
17544
9ba1f7641826 (define-skeleton): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 17515
diff changeset
141 This is a way of overriding the use of a highlighted region.")
15544
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
142 (interactive "*P\nP")
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
143 (skeleton-proxy-new ',skeleton str arg))))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
144
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
145 ;;;###autoload
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
146 (defun skeleton-proxy-new (skeleton &optional str arg)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
147 "Insert skeleton defined by variable of same name (see `skeleton-insert').
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
148 Prefix ARG allows wrapping around words or regions (see `skeleton-insert').
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
149 If no ARG was given, but the region is visible, ARG defaults to -1 depending
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
150 on `skeleton-autowrap'. An ARG of M-0 will prevent this just for once.
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
151 This command can also be an abbrev expansion (3rd and 4th columns in
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
152 \\[edit-abbrevs] buffer: \"\" command-name).
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153
15544
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
154 When called as a function, optional first argument STR may also be a string
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
155 which will be the value of `str' whereas the skeleton's interactor is then
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
156 ignored."
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
157 (interactive "*P\nP")
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
158 (setq skeleton (funcall skeleton-filter skeleton))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
159 (if (not skeleton)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
160 (if (memq this-command '(self-insert-command
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
161 skeleton-pair-insert-maybe
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
162 expand-abbrev))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
163 (setq buffer-undo-list (primitive-undo 1 buffer-undo-list)))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
164 (skeleton-insert skeleton
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
165 (if (setq skeleton-abbrev-cleanup
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
166 (or (eq this-command 'self-insert-command)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
167 (eq this-command
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
168 'skeleton-pair-insert-maybe)))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
169 ()
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
170 ;; Pretend C-x a e passed its prefix arg to us
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
171 (if (or arg current-prefix-arg)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
172 (prefix-numeric-value (or arg
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
173 current-prefix-arg))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
174 (and skeleton-autowrap
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
175 (or (eq last-command 'mouse-drag-region)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
176 (and transient-mark-mode mark-active))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
177 -1)))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
178 (if (stringp str)
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
179 str))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
180 (and skeleton-abbrev-cleanup
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
181 (setq skeleton-abbrev-cleanup (point))
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
182 (add-hook 'post-command-hook 'skeleton-abbrev-cleanup nil t))))
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183
16427
3b9f64eb097b Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 15544
diff changeset
184 ;; This command isn't meant to be called, only its aliases with meaningful
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
185 ;; names are.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 ;;;###autoload
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
187 (defun skeleton-proxy (&optional str arg)
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
188 "Insert skeleton defined by variable of same name (see `skeleton-insert').
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
189 Prefix ARG allows wrapping around words or regions (see `skeleton-insert').
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
190 If no ARG was given, but the region is visible, ARG defaults to -1 depending
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
191 on `skeleton-autowrap'. An ARG of M-0 will prevent this just for once.
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
192 This command can also be an abbrev expansion (3rd and 4th columns in
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
193 \\[edit-abbrevs] buffer: \"\" command-name).
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
194
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
195 When called as a function, optional first argument STR may also be a string
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
196 which will be the value of `str' whereas the skeleton's interactor is then
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
197 ignored."
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
198 (interactive "*P\nP")
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
199 (let ((function (nth 1 (backtrace-frame 1))))
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
200 (if (eq function 'nth) ; uncompiled Lisp function
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
201 (setq function (nth 1 (backtrace-frame 5)))
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
202 (if (eq function 'byte-code) ; tracing byte-compiled function
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
203 (setq function (nth 1 (backtrace-frame 2)))))
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
204 (if (not (setq function (funcall skeleton-filter (symbol-value function))))
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
205 (if (memq this-command '(self-insert-command
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
206 skeleton-pair-insert-maybe
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
207 expand-abbrev))
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
208 (setq buffer-undo-list (primitive-undo 1 buffer-undo-list)))
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
209 (skeleton-insert function
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
210 (if (setq skeleton-abbrev-cleanup
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
211 (or (eq this-command 'self-insert-command)
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
212 (eq this-command
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
213 'skeleton-pair-insert-maybe)))
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
214 ()
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
215 ;; Pretend C-x a e passed its prefix arg to us
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
216 (if (or arg current-prefix-arg)
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
217 (prefix-numeric-value (or arg
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
218 current-prefix-arg))
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
219 (and skeleton-autowrap
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
220 (or (eq last-command 'mouse-drag-region)
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
221 (and transient-mark-mode mark-active))
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
222 -1)))
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
223 (if (stringp str)
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
224 str))
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
225 (and skeleton-abbrev-cleanup
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
226 (setq skeleton-abbrev-cleanup (point))
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
227 (add-hook 'post-command-hook 'skeleton-abbrev-cleanup nil t)))))
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
228
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
229
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
230 (defun skeleton-abbrev-cleanup (&rest list)
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
231 "Value for `post-command-hook' to remove char that expanded abbrev."
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
232 (if (integerp skeleton-abbrev-cleanup)
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
233 (progn
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
234 (delete-region skeleton-abbrev-cleanup (point))
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
235 (setq skeleton-abbrev-cleanup)
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
236 (remove-hook 'post-command-hook 'skeleton-abbrev-cleanup t))))
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
237
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
238
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
239 ;;;###autoload
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
240 (defun skeleton-insert (skeleton &optional regions str)
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
241 "Insert the complex statement skeleton SKELETON describes very concisely.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
243 With optional second argument REGIONS, wrap first interesting point
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
244 \(`_') in skeleton around next REGIONS words, if REGIONS is positive.
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
245 If REGIONS is negative, wrap REGIONS preceding interregions into first
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
246 REGIONS interesting positions \(successive `_'s) in skeleton.
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
247
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
248 An interregion is the stretch of text between two contiguous marked
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
249 points. If you marked A B C [] (where [] is the cursor) in
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
250 alphabetical order, the 3 interregions are simply the last 3 regions.
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
251 But if you marked B A [] C, the interregions are B-A, A-[], []-C.
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
252
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
253 The optional third argument STR, if specified, is the value for the
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
254 variable `str' within the skeleton. When this is non-nil, the
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
255 interactor gets ignored, and this should be a valid skeleton element.
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
256
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
257 SKELETON is made up as (INTERACTOR ELEMENT ...). INTERACTOR may be nil if
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
258 not needed, a prompt-string or an expression for complex read functions.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260 If ELEMENT is a string or a character it gets inserted (see also
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 `skeleton-transformation'). Other possibilities are:
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
263 \\n go to next line and indent according to mode
35879
1b871d9c3be4 Docstring fixes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35877
diff changeset
264 _ interesting point, interregion here
51087
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
265 - interesting point, no interregion interaction, overrides
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
266 interesting point set by _
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
267 > indent line (or interregion if > _) according to major mode
16768
5ff0874f1309 (skeleton-positions): Renamed from skeleton-marks.
Richard M. Stallman <rms@gnu.org>
parents: 16767
diff changeset
268 @ add position to `skeleton-positions'
36967
cebc3019a629 (skeleton-internal-list): Fix bogus logic.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35879
diff changeset
269 & do next ELEMENT iff previous moved point
cebc3019a629 (skeleton-internal-list): Fix bogus logic.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35879
diff changeset
270 | do next ELEMENT iff previous didn't move point
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
271 -num delete num preceding characters (see `skeleton-untabify')
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272 resume: skipped, continue here if quit is signaled
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 nil skipped
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
274
51087
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
275 After termination, point will be positioned at the last occurrence of -
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
276 or at the first occurrence of _ or at the end of the inserted text.
35879
1b871d9c3be4 Docstring fixes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35877
diff changeset
277
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
278 Further elements can be defined via `skeleton-further-elements'. ELEMENT may
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
279 itself be a SKELETON with an INTERACTOR. The user is prompted repeatedly for
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
280 different inputs. The SKELETON is processed as often as the user enters a
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
281 non-empty string. \\[keyboard-quit] terminates skeleton insertion, but
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
282 continues after `resume:' and positions at `_' if any. If INTERACTOR in such
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
283 a subskeleton is a prompt-string which contains a \".. %s ..\" it is
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
284 formatted with `skeleton-subprompt'. Such an INTERACTOR may also be a list of
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
285 strings with the subskeleton being repeated once for each string.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
287 Quoted Lisp expressions are evaluated for their side-effects.
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
288 Other Lisp expressions are evaluated and the value treated as above.
50869
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
289 Note that expressions may not return t since this implies an
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
290 endless loop. Modes can define other symbols by locally setting them
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
291 to any valid skeleton element. The following local variables are
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
292 available:
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
294 str first time: read a string according to INTERACTOR
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295 then: insert previously read string once more
50869
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
296 help help-form during interaction with the user or nil
12862
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
297 input initial input (string or cons with index) while reading str
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
298 v1, v2 local variables for memorizing anything you want
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
299
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
300 When done with skeleton, but before going back to `_'-point call
50869
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
301 `skeleton-end-hook' if that is non-nil."
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
302 (let ((skeleton-regions regions))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
303 (and skeleton-regions
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
304 (setq skeleton-regions
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
305 (if (> skeleton-regions 0)
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
306 (list (copy-marker (point) t)
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
307 (save-excursion (forward-word skeleton-regions)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
308 (point-marker)))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
309 (setq skeleton-regions (- skeleton-regions))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
310 ;; copy skeleton-regions - 1 elements from `mark-ring'
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
311 (let ((l1 (cons (mark-marker) mark-ring))
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
312 (l2 (list (copy-marker (point) t))))
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
313 (while (and l1 (> skeleton-regions 0))
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
314 (push (copy-marker (pop l1) t) l2)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
315 (setq skeleton-regions (1- skeleton-regions)))
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
316 (sort l2 '<))))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
317 (goto-char (car skeleton-regions))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
318 (setq skeleton-regions (cdr skeleton-regions)))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
319 (let ((beg (point))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
320 skeleton-modified skeleton-point resume: help input v1 v2)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
321 (setq skeleton-positions nil)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
322 (unwind-protect
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
323 (eval `(let ,skeleton-further-elements
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
324 (skeleton-internal-list skeleton str)))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
325 (run-hooks 'skeleton-end-hook)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
326 (sit-for 0)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
327 (or (pos-visible-in-window-p beg)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
328 (progn
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
329 (goto-char beg)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
330 (recenter 0)))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
331 (if skeleton-point
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
332 (goto-char skeleton-point))))))
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
333
17515
62b47fab94fd (skeleton-read): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 17490
diff changeset
334 (defun skeleton-read (prompt &optional initial-input recursive)
12862
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
335 "Function for reading a string from the minibuffer within skeletons.
17552
605bd9c63821 (skeleton-read): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 17544
diff changeset
336
605bd9c63821 (skeleton-read): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 17544
diff changeset
337 PROMPT must be a string or a form that evaluates to a string.
605bd9c63821 (skeleton-read): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 17544
diff changeset
338 It may contain a `%s' which will be replaced by `skeleton-subprompt'.
50869
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
339 If non-nil second arg INITIAL-INPUT or variable `input' is a string or
7d308602f619 (skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
parents: 49299
diff changeset
340 cons with index to insert before reading. If third arg RECURSIVE is non-nil
12862
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
341 i.e. we are handling the iterator of a subskeleton, returns empty string if
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
342 user didn't modify input.
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
343 While reading, the value of `minibuffer-help-form' is variable `help' if that
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
344 is non-nil or a default string."
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
345 (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help))
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
346 (if recursive "\
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 As long as you provide input you will insert another subskeleton.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 If you enter the empty string, the loop inserting subskeletons is
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 left, and the current one is removed as far as it has been entered.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352 If you quit, the current subskeleton is removed as far as it has been
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 entered. No more of the skeleton will be inserted, except maybe for a
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
354 syntactically necessary termination."
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
355 "\
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
356 You are inserting a skeleton. Standard text gets inserted into the buffer
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
357 automatically, and you are prompted to fill in the variable parts.")))
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
358 (eolp (eolp)))
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
359 ;; since Emacs doesn't show main window's cursor, do something noticeable
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
360 (or eolp
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
361 (open-line 1))
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
362 (unwind-protect
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
363 (setq prompt (if (stringp prompt)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
364 (read-string (format prompt skeleton-subprompt)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
365 (setq initial-input
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
366 (or initial-input
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
367 (symbol-value 'input))))
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
368 (eval prompt)))
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
369 (or eolp
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
370 (delete-char 1))))
12862
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
371 (if (and recursive
17490
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
372 (or (null prompt)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
373 (string= prompt "")
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
374 (equal prompt initial-input)
f0fc645756a3 (skeleton-insert): Rename the function's argument
Richard M. Stallman <rms@gnu.org>
parents: 16768
diff changeset
375 (equal prompt (car-safe initial-input))))
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 (signal 'quit t)
17515
62b47fab94fd (skeleton-read): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 17490
diff changeset
377 prompt))
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
379 (defun skeleton-internal-list (skeleton &optional str recursive)
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
380 (let* ((start (save-excursion (beginning-of-line) (point)))
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
381 (column (current-column))
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
382 (line (buffer-substring start (line-end-position)))
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
383 opoint)
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
384 (or str
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
385 (setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive))))
49299
c7f492d5cd47 (skeleton-internal-list, skeleton-internal-1):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45288
diff changeset
386 (when (and (eq (cadr skeleton) '\n) (not recursive)
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
387 (save-excursion (skip-chars-backward " \t") (bolp)))
36967
cebc3019a629 (skeleton-internal-list): Fix bogus logic.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35879
diff changeset
388 (setq skeleton (cons nil (cons '> (cddr skeleton)))))
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
389 (while (setq skeleton-modified (eq opoint (point))
12862
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
390 opoint (point)
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
391 skeleton (cdr skeleton))
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
392 (condition-case quit
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
393 (skeleton-internal-1 (car skeleton))
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
394 (quit
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
395 (if (eq (cdr quit) 'recursive)
12886
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
396 (setq recursive 'quit
4029ded28f9d (skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 12862
diff changeset
397 skeleton (memq 'resume: skeleton))
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
398 ;; Remove the subskeleton as far as it has been shown
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
399 ;; the subskeleton shouldn't have deleted outside current line.
13390
333a77bb4ae8 (skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents: 12886
diff changeset
400 (end-of-line)
12862
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
401 (delete-region start (point))
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
402 (insert line)
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
403 (move-to-column column)
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
404 (if (cdr quit)
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
405 (setq skeleton ()
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
406 recursive nil)
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
407 (signal 'quit 'recursive)))))))
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
408 ;; maybe continue loop or go on to next outer resume: section
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
409 (if (eq recursive 'quit)
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
410 (signal 'quit 'recursive)
9d994b0faaa3 (skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents: 12619
diff changeset
411 recursive))
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
413 (defun skeleton-internal-1 (element &optional literal)
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
414 (cond
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
415 ((char-or-string-p element)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
416 (if (and (integerp element) ; -num
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
417 (< element 0))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
418 (if skeleton-untabify
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
419 (backward-delete-char-untabify (- element))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
420 (delete-backward-char (- element)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
421 (insert (if (and skeleton-transformation
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
422 (not literal))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
423 (funcall skeleton-transformation element)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
424 element))))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
425 ((or (eq element '\n) ; actually (eq '\n 'n)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
426 ;; The sequence `> \n' is handled specially so as to indent the first
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
427 ;; line after inserting the newline (to get the proper indentation).
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
428 (and (eq element '>) (eq (nth 1 skeleton) '\n) (pop skeleton)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
429 (let ((pos (if (eq element '>) (point))))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
430 (cond
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
431 ((and skeleton-regions (eq (nth 1 skeleton) '_))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
432 (or (eolp) (newline))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
433 (if pos (save-excursion (goto-char pos) (indent-according-to-mode)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
434 (indent-region (line-beginning-position)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
435 (car skeleton-regions) nil))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
436 ;; \n as last element only inserts \n if not at eol.
49299
c7f492d5cd47 (skeleton-internal-list, skeleton-internal-1):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45288
diff changeset
437 ((and (null (cdr skeleton)) (not recursive) (eolp))
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
438 (if pos (indent-according-to-mode)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
439 (skeleton-newline-indent-rigidly
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
440 (let ((pt (point)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
441 (newline)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
442 (indent-to (save-excursion
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
443 (goto-char pt)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
444 (if pos (indent-according-to-mode))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
445 (current-indentation)))))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
446 (t (if pos (reindent-then-newline-and-indent)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
447 (newline)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
448 (indent-according-to-mode))))))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
449 ((eq element '>)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
450 (if (and skeleton-regions (eq (nth 1 skeleton) '_))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
451 (indent-region (line-beginning-position)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
452 (car skeleton-regions) nil)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
453 (indent-according-to-mode)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
454 ((eq element '_)
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
455 (if skeleton-regions
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
456 (progn
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
457 (goto-char (pop skeleton-regions))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
458 (and (<= (current-column) (current-indentation))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
459 (eq (nth 1 skeleton) '\n)
51087
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
460 (end-of-line 0)))
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
461 (or skeleton-point
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
462 (setq skeleton-point (point)))))
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
463 ((eq element '-)
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
464 (setq skeleton-point (point)))
7393
e4a565cee722 (mirror-mode): Commented out.
Richard M. Stallman <rms@gnu.org>
parents: 6463
diff changeset
465 ((eq element '&)
51087
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
466 (when skeleton-modified (pop skeleton)))
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
467 ((eq element '|)
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
468 (unless skeleton-modified (pop skeleton)))
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
469 ((eq element '@)
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
470 (push (point) skeleton-positions))
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
471 ((eq 'quote (car-safe element))
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
472 (eval (nth 1 element)))
49b8ab00fab0 (skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
parents: 50869
diff changeset
473 ((or (stringp (car-safe element))
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
474 (consp (car-safe element)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
475 (if (symbolp (car-safe (car element)))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
476 (while (skeleton-internal-list element nil t))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
477 (setq literal (car element))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
478 (while literal
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
479 (skeleton-internal-list element (car literal))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
480 (setq literal (cdr literal)))))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
481 ((null element))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
482 (t (skeleton-internal-1 (eval element) t))))
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
483
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
484 ;; Maybe belongs into simple.el or elsewhere
45288
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
485 ;; ;;;###autoload
984caedead68 (skeleton-transformation): Default to `identity'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38409
diff changeset
486 ;; (define-skeleton local-variables-section
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
487 ;; "Insert a local variables section. Use current comment syntax if any."
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
488 ;; (completing-read "Mode: " obarray
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
489 ;; (lambda (symbol)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
490 ;; (if (commandp symbol)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
491 ;; (string-match "-mode$" (symbol-name symbol))))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
492 ;; t)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
493 ;; '(save-excursion
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
494 ;; (if (re-search-forward page-delimiter nil t)
38409
153f1b1f2efd Emacs lisp coding convention fixes.
Pavel Janík <Pavel@Janik.cz>
parents: 36967
diff changeset
495 ;; (error "Not on last page")))
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
496 ;; comment-start "Local Variables:" comment-end \n
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
497 ;; comment-start "mode: " str
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
498 ;; & -5 | '(kill-line 0) & -1 | comment-end \n
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
499 ;; ( (completing-read (format "Variable, %s: " skeleton-subprompt)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
500 ;; obarray
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
501 ;; (lambda (symbol)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
502 ;; (or (eq symbol 'eval)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
503 ;; (user-variable-p symbol)))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
504 ;; t)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
505 ;; comment-start str ": "
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
506 ;; (read-from-minibuffer "Expression: " nil read-expression-map nil
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
507 ;; 'read-expression-history) | _
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
508 ;; comment-end \n)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
509 ;; resume:
15544
ef2b47c6c225 (skeleton-proxy-new): New function.
Richard M. Stallman <rms@gnu.org>
parents: 15506
diff changeset
510 ;; comment-start "End:" comment-end \n)
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
512 ;; Variables and command for automatically inserting pairs like () or "".
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
514 (defvar skeleton-pair nil
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 "*If this is nil pairing is turned off, no matter what else is set.
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
516 Otherwise modes with `skeleton-pair-insert-maybe' on some keys
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
517 will attempt to insert pairs of matching characters.")
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
520 (defvar skeleton-pair-on-word nil
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
521 "*If this is nil, paired insertion is inhibited before or inside a word.")
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523
36967
cebc3019a629 (skeleton-internal-list): Fix bogus logic.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35879
diff changeset
524 (defvar skeleton-pair-filter (lambda () nil)
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
525 "Attempt paired insertion if this function returns nil, before inserting.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 This allows for context-sensitive checking whether pairing is appropriate.")
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
529 (defvar skeleton-pair-alist ()
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
530 "An override alist of pairing partners matched against `last-command-char'.
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
531 Each alist element, which looks like (ELEMENT ...), is passed to
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
532 `skeleton-insert' with no interactor. Variable `str' does nothing.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533
12501
6c57be2d372f partly rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 7394
diff changeset
534 Elements might be (?` ?` _ \"''\"), (?\\( ? _ \" )\") or (?{ \\n > _ \\n ?} >).")
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 ;;;###autoload
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
538 (defun skeleton-pair-insert-maybe (arg)
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 "Insert the character you type ARG times.
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
541 With no ARG, if `skeleton-pair' is non-nil, pairing can occur. If the region
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
542 is visible the pair is wrapped around it depending on `skeleton-autowrap'.
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
543 Else, if `skeleton-pair-on-word' is non-nil or we are not before or inside a
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
544 word, and if `skeleton-pair-filter' returns nil, pairing is performed.
36967
cebc3019a629 (skeleton-internal-list): Fix bogus logic.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35879
diff changeset
545 Pairing is also prohibited if we are right after a quoting character
cebc3019a629 (skeleton-internal-list): Fix bogus logic.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35879
diff changeset
546 such as backslash.
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547
12619
9d4a4e914215 (local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 12501
diff changeset
548 If a match is found in `skeleton-pair-alist', that is inserted, else
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 the defaults are used. These are (), [], {}, <> and `' for the
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 symmetrical ones, and the same character twice for the others."
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 (interactive "*P")
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
552 (let ((mark (and skeleton-autowrap
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
553 (or (eq last-command 'mouse-drag-region)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
554 (and transient-mark-mode mark-active))))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
555 (skeleton-end-hook))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
556 (if (or arg
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
557 (not skeleton-pair)
36967
cebc3019a629 (skeleton-internal-list): Fix bogus logic.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 35879
diff changeset
558 (memq (char-syntax (preceding-char)) '(?\\ ?/))
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
559 (and (not mark)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
560 (or overwrite-mode
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
561 (if (not skeleton-pair-on-word) (looking-at "\\w"))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
562 (funcall skeleton-pair-filter))))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
563 (self-insert-command (prefix-numeric-value arg))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
564 (setq last-command-char (logand last-command-char 255))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
565 (or skeleton-abbrev-cleanup
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
566 (skeleton-insert
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
567 (cons nil (or (assq last-command-char skeleton-pair-alist)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
568 (assq last-command-char '((?( _ ?))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
569 (?[ _ ?])
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
570 (?{ _ ?})
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
571 (?< _ ?>)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
572 (?` _ ?')))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
573 `(,last-command-char _ ,last-command-char)))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
574 (if mark -1))))))
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
577 ;; A more serious example can be found in sh-script.el
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
578 ;;; (defun mirror-mode ()
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
579 ;; "This major mode is an amusing little example of paired insertion.
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
580 ;;All printable characters do a paired self insert, while the other commands
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
581 ;;work normally."
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
582 ;; (interactive)
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
583 ;; (kill-all-local-variables)
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
584 ;; (make-local-variable 'skeleton-pair)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
585 ;; (make-local-variable 'skeleton-pair-on-word)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
586 ;; (make-local-variable 'skeleton-pair-filter)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
587 ;; (make-local-variable 'skeleton-pair-alist)
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
588 ;; (setq major-mode 'mirror-mode
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
589 ;; mode-name "Mirror"
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
590 ;; skeleton-pair-on-word t
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
591 ;; ;; in the middle column insert one or none if odd window-width
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
592 ;; skeleton-pair-filter (lambda ()
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
593 ;; (if (>= (current-column)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
594 ;; (/ (window-width) 2))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
595 ;; ;; insert both on next line
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
596 ;; (next-line 1)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
597 ;; ;; insert one or both?
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
598 ;; (= (* 2 (1+ (current-column)))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
599 ;; (window-width))))
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
600 ;; ;; mirror these the other way round as well
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
601 ;; skeleton-pair-alist '((?) _ ?()
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
602 ;; (?] _ ?[)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
603 ;; (?} _ ?{)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
604 ;; (?> _ ?<)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
605 ;; (?/ _ ?\\)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
606 ;; (?\\ _ ?/)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
607 ;; (?` ?` _ "''")
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
608 ;; (?' ?' _ "``"))
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
609 ;; ;; in this mode we exceptionally ignore the user, else it's no fun
15506
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
610 ;; skeleton-pair t)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
611 ;; (let ((map (make-vector 256 'skeleton-pair-insert-maybe))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
612 ;; (i 0))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
613 ;; (use-local-map `(keymap ,map))
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
614 ;; (while (< i ? )
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
615 ;; (aset map i nil)
1a66dbb1a470 (local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
parents: 15489
diff changeset
616 ;; (aset map (+ i 128) nil)
15489
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
617 ;; (setq i (1+ i))))
5393431269db (skeleton-autowrap): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 15441
diff changeset
618 ;; (run-hooks 'mirror-mode-hook))
6463
380e8fcde9a2 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619
14724
4a757fa8b402 Add provide call.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
620 (provide 'skeleton)
4a757fa8b402 Add provide call.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
621
38409
153f1b1f2efd Emacs lisp coding convention fixes.
Pavel Janík <Pavel@Janik.cz>
parents: 36967
diff changeset
622 ;;; skeleton.el ends here