*** empty log message ***
[bpt/emacs.git] / lisp / skeleton.el
index aea5aa7..0b3fc82 100644 (file)
@@ -1,6 +1,7 @@
 ;;; skeleton.el --- Lisp language extension for writing statement skeletons
 
-;; Copyright (C) 1993, 1994, 1995, 1996, 2003 by Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 1995, 1996, 2002, 2003,
+;;   2004, 2005, 2006 Free Software Foundation, Inc.
 
 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
 ;; Maintainer: FSF
@@ -20,8 +21,8 @@
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
 
@@ -50,7 +51,7 @@ Typical examples might be `upcase' or `capitalize'.")
 
 
 (defvar skeleton-autowrap t
-  "Controls wrapping behaviour of functions created with `define-skeleton'.
+  "Controls wrapping behavior of functions created with `define-skeleton'.
 When the region is visible (due to `transient-mark-mode' or marking a region
 with the mouse) and this is non-nil and the function was called without an
 explicit ARG, then the ARG defaults to -1, i.e. wrapping around the visible
@@ -112,11 +113,16 @@ are integer buffer positions in the reverse order of the insertion order.")
 (defvar skeleton-point)
 (defvar skeleton-regions)
 
+(def-edebug-spec skeleton-edebug-spec
+  ([&or null stringp (stringp &rest stringp) [[&not atom] def-form]]
+   &rest &or "n" "_" "-" ">" "@" "&" "!" "resume:"
+   ("quote" def-form) skeleton-edebug-spec def-form))
 ;;;###autoload
 (defmacro define-skeleton (command documentation &rest skeleton)
   "Define a user-configurable COMMAND that enters a statement skeleton.
 DOCUMENTATION is that of the command.
 SKELETON is as defined under `skeleton-insert'."
+  (declare (debug (&define name stringp skeleton-edebug-spec)))
   (if skeleton-debug
       (set command skeleton))
   `(progn
@@ -149,7 +155,7 @@ on `skeleton-autowrap'.  An ARG of  M-0  will prevent this just for once.
 This command can also be an abbrev expansion (3rd and 4th columns in
 \\[edit-abbrevs]  buffer: \"\"  command-name).
 
-Optional first argument STR may also be a string which will be the value
+Optional second argument STR may also be a string which will be the value
 of `str' whereas the skeleton's interactor is then ignored."
   (skeleton-insert (funcall skeleton-filter skeleton)
                   ;; Pretend  C-x a e  passed its prefix arg to us
@@ -159,7 +165,12 @@ of `str' whereas the skeleton's interactor is then ignored."
                     (and skeleton-autowrap
                          (or (eq last-command 'mouse-drag-region)
                              (and transient-mark-mode mark-active))
-                         -1))
+                         ;; Deactivate the mark, in case one of the
+                         ;; elements of the skeleton is sensitive
+                         ;; to such situations (e.g. it is itself a
+                         ;; skeleton).
+                         (progn (deactivate-mark)
+                                -1)))
                   (if (stringp str)
                       str))
   ;; Return non-nil to tell expand-abbrev that expansion has happened.
@@ -399,10 +410,13 @@ automatically, and you are prompted to fill in the variable parts.")))
     (push (point) skeleton-positions))
    ((eq 'quote (car-safe element))
     (eval (nth 1 element)))
-   ((or (stringp (car-safe element))
-       (consp (car-safe element)))
+   ((and (consp element)
+        (or (stringp (car element)) (listp (car element))))
+    ;; Don't forget: `symbolp' is also true for nil.
     (if (symbolp (car-safe (car element)))
-       (while (skeleton-internal-list element nil t))
+       (while (and (skeleton-internal-list element nil t)
+                   ;; If the interactor is nil, don't infinite loop.
+                   (car element)))
       (setq literal (car element))
       (while literal
        (skeleton-internal-list element (car literal))
@@ -462,6 +476,12 @@ Each alist element, which looks like (ELEMENT ...), is passed to
 
 Elements might be (?` ?` _ \"''\"), (?\\( ?  _ \" )\") or (?{ \\n > _ \\n ?} >).")
 
+(defvar skeleton-pair-default-alist '((?( _ ?)) (?\))
+                                     (?[ _ ?]) (?\])
+                                     (?{ _ ?}) (?\})
+                                     (?< _ ?>) (?\>)
+                                     (?« _ ?») (?\»)
+                                     (?` _ ?')))
 
 ;;;###autoload
 (defun skeleton-pair-insert-maybe (arg)
@@ -478,28 +498,23 @@ If a match is found in `skeleton-pair-alist', that is inserted, else
 the defaults are used.  These are (), [], {}, <> and `' for the
 symmetrical ones, and the same character twice for the others."
   (interactive "*P")
-  (let ((mark (and skeleton-autowrap
-                  (or (eq last-command 'mouse-drag-region)
-                      (and transient-mark-mode mark-active))))
-       (skeleton-end-hook))
-    (if (or arg
-           (not skeleton-pair)
-           (memq (char-syntax (preceding-char)) '(?\\ ?/))
-           (and (not mark)
-                (or overwrite-mode
-                    (if (not skeleton-pair-on-word) (looking-at "\\w"))
-                    (funcall skeleton-pair-filter))))
-       (self-insert-command (prefix-numeric-value arg))
-      (setq last-command-char (logand last-command-char 255))
-      (skeleton-insert
-       (cons nil (or (assq last-command-char skeleton-pair-alist)
-                     (assq last-command-char '((?( _ ?))
-                                               (?[ _ ?])
-                                               (?{ _ ?})
-                                               (?< _ ?>)
-                                               (?` _ ?')))
-                     `(,last-command-char _ ,last-command-char)))
-       (if mark -1)))))
+  (if (or arg (not skeleton-pair))
+      (self-insert-command (prefix-numeric-value arg))
+    (let* ((mark (and skeleton-autowrap
+                     (or (eq last-command 'mouse-drag-region)
+                         (and transient-mark-mode mark-active))))
+          (skeleton-end-hook)
+          (char last-command-char)
+          (skeleton (or (assq char skeleton-pair-alist)
+                        (assq char skeleton-pair-default-alist)
+                        `(,char _ ,char))))
+      (if (or (memq (char-syntax (preceding-char)) '(?\\ ?/))
+             (and (not mark)
+                  (or overwrite-mode
+                      (if (not skeleton-pair-on-word) (looking-at "\\w"))
+                      (funcall skeleton-pair-filter))))
+         (self-insert-command (prefix-numeric-value arg))
+       (skeleton-insert (cons nil skeleton) (if mark -1))))))
 
 \f
 ;; A more serious example can be found in sh-script.el
@@ -543,8 +558,9 @@ symmetrical ones, and the same character twice for the others."
 ;;      (aset map i nil)
 ;;      (aset map (+ i 128) nil)
 ;;      (setq i (1+ i))))
-;;  (run-hooks 'mirror-mode-hook))
+;;  (run-mode-hooks 'mirror-mode-hook))
 
 (provide 'skeleton)
 
+;;; arch-tag: ccad7bd5-eb5d-40de-9ded-900197215c3e
 ;;; skeleton.el ends here