| blob | 0fdfee6d2057181454288ca33fa6461f7f623c34 |
1 ;;; em-alias --- creation and management of command aliases
3 ;; Copyright (C) 1999, 2000 Free Software Foundation
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
10 ;; any later version.
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 ;; Boston, MA 02111-1307, USA.
27 "Command aliases allow for easy definition of alternate commands."
32 ;;; Commentary:
34 ;; Command aliases greatly simplify the definition of new commands.
35 ;; They exist as an alternative to alias functions, which are
36 ;; otherwise quite superior, being more flexible and natural to the
37 ;; Emacs Lisp environment (if somewhat trickier to define; [Alias
38 ;; functions]).
39 ;;
40 ;;;_* Creating aliases
41 ;;
42 ;; The user interface is simple: type 'alias' followed by the command
43 ;; name followed by the definition. Argument references are made
44 ;; using '$1', '$2', etc., or '$*'. For example:
45 ;;
46 ;; alias ll 'ls -l $*'
47 ;;
48 ;; This will cause the command 'll NEWS' to be replaced by 'ls -l
49 ;; NEWS'. This is then passed back to the command parser for
50 ;; reparsing.{Only the command text specified in the alias definition
51 ;; will be reparsed. Argument references (such as '$*') are handled
52 ;; using variable values, which means that the expansion will not be
53 ;; reparsed, but used directly.}
54 ;;
55 ;; To delete an alias, specify its name without a definition:
56 ;;
57 ;; alias ll
58 ;;
59 ;; Aliases are written to disk immediately after being defined or
60 ;; deleted. The filename in which they are kept is defined by the
61 ;; following variable:
64 "*The file in which aliases are kept.
65 Whenever an alias is defined by the user, using the `alias' command,
66 it will be written to this file. Thus, alias definitions (and
67 deletions) are always permanent. This approach was chosen for the
68 sake of simplicity, since that's pretty much the only benefit to be
69 gained by using this module."
73 ;;;
74 ;; The format of this file is quite basic. It specifies the alias
75 ;; definitions in almost exactly the same way that the user entered
76 ;; them, minus any argument quoting (since interpolation is not done
77 ;; when the file is read). Hence, it is possible to add new aliases
78 ;; to the alias file directly, using a text editor rather than the
79 ;; `alias' command. Or, this method can be used for editing aliases
80 ;; that have already defined.
81 ;;
82 ;; Here is an example of a few different aliases, and they would
83 ;; appear in the aliases file:
84 ;;
85 ;; alias clean rm -fr **/.#*~
86 ;; alias commit cvs commit -m changes $*
87 ;; alias ll ls -l $*
88 ;; alias info (info)
89 ;; alias reindex glimpseindex -o ~/Mail
90 ;; alias compact for i in ~/Mail/**/*~*.bz2(Lk+50) { bzip2 -9v $i }
91 ;;
92 ;;;_* Auto-correction of bad commands
93 ;;
94 ;; When a user enters the same unknown command many times during a
95 ;; session, it is likely that they are experiencing a spelling
96 ;; difficulty associated with a certain command. To combat this,
97 ;; Eshell will offer to automatically define an alias for that
98 ;; mispelled command, once a given tolerance threshold has been
99 ;; reached.
102 "*The number of failed commands to ignore before creating an alias."
107 ;;;
108 ;; Whenever the same bad command name is encountered this many times,
109 ;; the user will be prompted in the minibuffer to provide an alias
110 ;; name. An alias definition will then be created which will result
111 ;; in an equal call to the correct name. In this way, Eshell
112 ;; gradually learns about the commands that the user mistypes
113 ;; frequently, and will automatically correct them!
114 ;;
115 ;; Note that a '$*' is automatically appended at the end of the alias
116 ;; definition, so that entering it is unnecessary when specifying the
117 ;; corrected command name.
119 ;;; Code:
122 "*A hook that gets run when `eshell-alias' is loaded."
127 "A list of command aliases currently defined by the user.
128 Each element of this alias is a list of the form:
130 (NAME DEFINITION)
132 Where NAME is the textual name of the alias, and DEFINITION is the
133 command string to replace that command with.
135 Note: this list should not be modified in your '.emacs' file. Rather,
136 any desired alias definitions should be declared using the `alias'
137 command, which will automatically write them to the file named by
146 "Initialize the alias handling code."
155 "Define an ALIAS in the user's alias list using DEFINITION."
162 eshell-command-aliases-list))
174 nil)
177 "Completion function for Eshell's `alias' command."
181 "Read in an aliases list from `eshell-aliases-file'."
194 eshell-command-aliases-list)))
196 eshell-command-aliases-list))))))
199 "Write out the current aliases into `eshell-aliases-file'."
207 "Check whether NAME is aliased. Return the alias if there is one."
213 "If COMMAND has an alias definition, call that instead using ARGS."
220 'let
229 eshell-prevent-alias-expansion))))
233 "Find all possible completions for NAME.
234 These are all the command aliases which begin with NAME."
239 completions))
242 "If the user repeatedly a bad command NAME, make an alias for them."
258 'let
267 eshell-prevent-alias-expansion))))
270 ;;; em-alias.el ends here