X-Git-Url: https://git.hcoop.net/bpt/emacs.git/blobdiff_plain/a9d358fb753d3d762e1bb25d05f5d3dc0eb985c4..19fef52afe66b7ee87a6a24fa3ff567eeca6ae17:/lisp/forms.el

diff --git a/lisp/forms.el b/lisp/forms.el
index df683ae136..975b030ad5 100644
--- a/lisp/forms.el
+++ b/lisp/forms.el
@@ -1,6 +1,6 @@
 ;;; forms.el --- Forms mode: edit a file as a form to fill in
 
-;; Copyright (C) 1991, 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1991, 1994, 1995, 1996, 1997, 2003 Free Software Foundation, Inc.
 
 ;; Author: Johan Vromans <jvromans@squirrel.nl>
 
@@ -54,11 +54,11 @@
 ;; The second file holds the actual data.  The buffer of this file
 ;; will be buried, for it is never accessed directly.
 ;;
-;; Forms mode is invoked using M-x forms-find-file control-file .
+;; Forms mode is invoked using M-x `forms-find-file' control-file.
 ;; Alternatively `forms-find-file-other-window' can be used.
 ;;
 ;; You may also visit the control file, and switch to forms mode by hand
-;; with M-x forms-mode .
+;; with M-x `forms-mode'.
 ;;
 ;; Automatic mode switching is supported if you specify 
 ;; "-*- forms -*-" in the first line of the control file.
@@ -110,14 +110,14 @@
 ;;			of fields specified by `forms-number-of-fields'.
 ;;
 ;;	forms-multi-line			[string, default "^K"]
-;;			If non-null the records of the data file may
+;;			If non-null, the records of the data file may
 ;;			contain fields that can span multiple lines in
 ;;			the form.
-;;			This variable denotes the separator character
+;;			This variable denotes the separator string
 ;;			to be used for this purpose.  Upon display, all
-;;			occurrences of this character are translated
+;;			occurrences of this string are translated
 ;;			to newlines.  Upon storage they are translated
-;;			back to the separator character.
+;;			back to the separator string.
 ;;
 ;;	forms-forms-scroll			[bool, default nil]
 ;;			Non-nil means: rebind locally the commands that
@@ -125,12 +125,17 @@
 ;;			`forms-next-field' resp. `forms-prev-field'.
 ;;
 ;;	forms-forms-jump			[bool, default nil]
-;;			Non-nil means: rebind locally the commands that
+;;			Non-nil means: rebind locally the commands
+;;			`beginning-of-buffer' and `end-of-buffer' to
+;;			perform, respectively, `forms-first-record' and
+;;			`forms-last-record' instead.
 ;;
 ;;	forms-insert-after			[bool, default nil]
-;;			Non-nil means: inserts of new records go after
-;;			current record, also initial position is at last
-;;			record.
+;;			Non-nil means: insertions of new records go after
+;;			current record, also initial position is at the
+;;			last record.  The default is to insert before the
+;;			current record and the initial position is at the
+;;			first record.
 ;;
 ;;	forms-read-file-filter			[symbol, default nil]
 ;;			If not nil: this should be the name of a 
@@ -166,14 +171,14 @@
 ;;			distinct face, if possible.
 ;;			As of emacs 19.29, the `intangible' text property
 ;;			is used to prevent moving into read-only fields.
-;;			This variable defaults to t if running Emacs 19
-;;			with text properties.
+;;			This variable defaults to t if running Emacs 19 or
+;;			later with text properties.
 ;;			The default face to show read-write fields is
 ;;			copied from face `region'.
 ;;
 ;;	forms-ro-face 				[symbol, default 'default]
 ;;			This is the face that is used to show
-;;			read-only text on the screen.If used, this
+;;			read-only text on the screen.  If used, this
 ;;			variable should be set to a symbol that is a
 ;;			valid face.
 ;;			E.g.
@@ -187,7 +192,7 @@
 ;; After evaluating the control file, its buffer is cleared and used
 ;; for further processing.
 ;; The data file (as designated by `forms-file') is visited in a buffer
-;; `forms--file-buffer' which will not normally be shown.
+;; `forms--file-buffer' which normally will not be shown.
 ;; Great malfunctioning may be expected if this file/buffer is modified
 ;; outside of this package while it is being visited!
 ;;
@@ -208,7 +213,7 @@
 ;;
 ;; Two exit functions exist: `forms-exit' and `forms-exit-no-save'.
 ;; `forms-exit' saves the data to the file, if modified.
-;; `forms-exit-no-save` does not.  However, if `forms-exit-no-save'
+;; `forms-exit-no-save' does not.  However, if `forms-exit-no-save'
 ;; is executed and the file buffer has been modified, Emacs will ask
 ;; questions anyway.
 ;;
@@ -222,12 +227,12 @@
 ;;	switching edit <-> view mode v.v.
 ;;	jumping from field to field
 ;;
-;; As an documented side-effect: jumping to the last record in the
+;; As a documented side-effect: jumping to the last record in the
 ;; file (using forms-last-record) will adjust forms--total-records if
 ;; needed.
 ;;
-;; The forms buffer can be in on eof two modes: edit mode or view
-;; mode.  View mode is a read-only mode, you cannot modify the
+;; The forms buffer can be in one of two modes: edit mode or view
+;; mode.  View mode is a read-only mode, whereby you cannot modify the
 ;; contents of the buffer.
 ;;
 ;; Edit mode commands:
@@ -252,7 +257,7 @@
 ;; SPC 	 forms-next-record
 ;; DEL	 forms-prev-record
 ;; ?	 describe-mode
-;; \C-q forms-toggle-read-only
+;; \C-q  forms-toggle-read-only
 ;; l	 forms-jump-record
 ;; n	 forms-next-record
 ;; p	 forms-prev-record
@@ -270,18 +275,18 @@
 ;; [begin]	  forms-first-record
 ;; [end]	  forms-last-record
 ;; [S-TAB]	  forms-prev-field
-;; [backtab] forms-prev-field
+;; [backtab]	  forms-prev-field
 ;;
 ;; For convenience, TAB is always bound to `forms-next-field', so you
 ;; don't need the C-c prefix for this command.
 ;;
-;; As mentioned above (see `forms-forms-scroll' and `forms-forms-jump')
+;; As mentioned above (see `forms-forms-scroll' and `forms-forms-jump'),
 ;; the bindings of standard functions `scroll-up', `scroll-down',
 ;; `beginning-of-buffer' and `end-of-buffer' can be locally replaced with
 ;; forms mode functions next/prev record and first/last
 ;; record.
 ;;
-;; `local-write-file hook' is defined to save the actual data file
+;; `local-write-file-hooks' is defined to save the actual data file
 ;; instead of the buffer data, `revert-file-hook' is defined to
 ;; revert a forms to original.
 
@@ -296,15 +301,15 @@
 (provide 'forms)			;;; official
 (provide 'forms-mode)			;;; for compatibility
 
-(defconst forms-version (substring "$Revision: 2.36 $" 11 -2)
+(defconst forms-version (substring "$Revision: 2.43 $" 11 -2)
   "The version number of forms-mode (as string).  The complete RCS id is:
 
-  $Id: forms.el,v 2.36 1998/10/06 23:19:46 kwzh Exp rms $")
+  $Id: forms.el,v 2.43 2002/05/18 08:04:49 pj Exp $")
 
 (defcustom forms-mode-hooks nil
-  "Hook functions to be run upon entering Forms mode."
+  "Hook run upon entering Forms mode."
   :group 'forms
-  :type 'function)
+  :type 'hook)
 
 ;;; Mandatory variables - must be set by evaluating the control file.
 
@@ -711,11 +716,11 @@ Commands:                        Equivalent keys in read-only mode:
     (if (< forms--current-record 1)
 	(setq forms--current-record 1))
     (forms-jump-record forms--current-record)
-    )
 
-  (if forms-insert-after
-      (forms-last-record)
-    (forms-first-record))
+    (if forms-insert-after
+	(forms-last-record)
+      (forms-first-record))
+    )
 
   ;; user customising
   ;;(message "forms: proceeding setup (user hooks)...")
@@ -918,23 +923,23 @@ Commands:                        Equivalent keys in read-only mode:
     (setq 
      forms--format
      (if forms-use-text-properties 
-	 (` (lambda (arg)
-	      (let ((inhibit-read-only t))
-		(,@ (apply 'append
-			   (mapcar 'forms--make-format-elt-using-text-properties
-				   forms-format-list)))
-		;; Prevent insertion before the first text.
-		(,@ (if (numberp (car forms-format-list))
-			nil
-		      '((add-text-properties (point-min) (1+ (point-min))
-					     '(front-sticky (read-only intangible))))))
-		;; Prevent insertion after the last text.
-		(remove-text-properties (1- (point)) (point)
-					'(rear-nonsticky)))
-	      (setq forms--iif-start nil)))
-       (` (lambda (arg)
-	    (,@ (apply 'append
-		       (mapcar 'forms--make-format-elt forms-format-list)))))))
+	 `(lambda (arg)
+	    (let ((inhibit-read-only t))
+	      ,@(apply 'append
+		       (mapcar 'forms--make-format-elt-using-text-properties
+			       forms-format-list))
+	      ;; Prevent insertion before the first text.
+	      ,@(if (numberp (car forms-format-list))
+		    nil
+		  '((add-text-properties (point-min) (1+ (point-min))
+					 '(front-sticky (read-only intangible)))))
+	      ;; Prevent insertion after the last text.
+	      (remove-text-properties (1- (point)) (point)
+				      '(rear-nonsticky)))
+	    (setq forms--iif-start nil))
+       `(lambda (arg)
+	  ,@(apply 'append
+		   (mapcar 'forms--make-format-elt forms-format-list)))))
 
     ;; We have tallied the number of markers and dynamic texts,
     ;; so we can allocate the arrays now.
@@ -1004,46 +1009,46 @@ Commands:                        Equivalent keys in read-only mode:
   (cond
    ((stringp el)
     
-    (` ((set-text-properties 
-	 (point)			; start at point
-	 (progn				; until after insertion
-	   (insert (, el))
-	   (point))
-	 (list 'face forms--ro-face	; read-only appearance
-	       'read-only (,@ (list (1+ forms--marker)))
-	       'intangible t
-	       'insert-in-front-hooks '(forms--iif-hook)
-	       'rear-nonsticky '(face read-only insert-in-front-hooks
-				 intangible))))))
+    `((set-text-properties 
+       (point)				; start at point
+       (progn				; until after insertion
+	 (insert ,el)
+	 (point))
+       (list 'face forms--ro-face	; read-only appearance
+	     'read-only ,@(list (1+ forms--marker))
+	     'intangible ,@(list (1+ forms--marker))
+	     'insert-in-front-hooks '(forms--iif-hook)
+	     'rear-nonsticky '(face read-only insert-in-front-hooks
+				    intangible)))))
     
    ((numberp el)
-    (` ((let ((here (point)))
-	  (aset forms--markers 
-		(, (prog1 forms--marker
-		     (setq forms--marker (1+ forms--marker))))
-		(point-marker))
-	  (insert (elt arg (, (1- el))))
-	  (or (= (point) here)
-	      (set-text-properties 
-	       here (point)
-	       (list 'face forms--rw-face
-		     'front-sticky '(face))))))))
+    `((let ((here (point)))
+	(aset forms--markers 
+	      ,(prog1 forms--marker
+		 (setq forms--marker (1+ forms--marker)))
+	      (point-marker))
+	(insert (elt arg ,(1- el)))
+	(or (= (point) here)
+	    (set-text-properties 
+	     here (point)
+	     (list 'face forms--rw-face
+		   'front-sticky '(face)))))))
 
    ((listp el)
-    (` ((set-text-properties
-	 (point)
-	 (progn
-	   (insert (aset forms--dyntexts 
-			 (, (prog1 forms--dyntext
-			      (setq forms--dyntext (1+ forms--dyntext))))
-			 (, el)))
-	   (point))
-	 (list 'face forms--ro-face
-	       'read-only (,@ (list (1+ forms--marker)))
-	       'intangible t
-	       'insert-in-front-hooks '(forms--iif-hook)
-	       'rear-nonsticky '(read-only face insert-in-front-hooks
-				 intangible))))))
+    `((set-text-properties
+       (point)
+       (progn
+	 (insert (aset forms--dyntexts 
+		       ,(prog1 forms--dyntext
+			  (setq forms--dyntext (1+ forms--dyntext)))
+		       ,el))
+	 (point))
+       (list 'face forms--ro-face
+	     'read-only ,@(list (1+ forms--marker))
+	     'intangible ,@(list (1+ forms--marker))
+	     'insert-in-front-hooks '(forms--iif-hook)
+	     'rear-nonsticky '(read-only face insert-in-front-hooks
+					 intangible)))))
 
    ;; end of cond
    ))
@@ -1068,15 +1073,15 @@ Commands:                        Equivalent keys in read-only mode:
 
   (cond 
    ((stringp el)
-    (` ((insert (, el)))))
+    `((insert ,el)))
    ((numberp el)
     (prog1
-	(` ((aset forms--markers (, forms--marker) (point-marker))
-	    (insert (elt arg (, (1- el))))))
+	`((aset forms--markers ,forms--marker (point-marker))
+	  (insert (elt arg ,(1- el))))
       (setq forms--marker (1+ forms--marker))))
    ((listp el)
     (prog1
-	(` ((insert (aset forms--dyntexts (, forms--dyntext) (, el)))))
+	`((insert (aset forms--dyntexts ,forms--dyntext ,el)))
       (setq forms--dyntext (1+ forms--dyntext))))))
 
 (defvar forms--field)
@@ -1101,13 +1106,13 @@ Commands:                        Equivalent keys in read-only mode:
 
        ;; Note: we add a nil element to the list passed to `mapcar',
        ;; see `forms--make-parser-elt' for details.
-       (` (lambda nil
-	    (let (here)
-	      (goto-char (point-min))
-	      (,@ (apply 'append
-			 (mapcar 
-			  'forms--make-parser-elt 
-			  (append forms-format-list (list nil)))))))))))
+       `(lambda nil
+	  (let (here)
+	    (goto-char (point-min))
+	    ,@(apply 'append
+		     (mapcar 
+		      'forms--make-parser-elt 
+		      (append forms-format-list (list nil)))))))))
 
   (forms--debug 'forms--parser))
 
@@ -1166,15 +1171,15 @@ Commands:                        Equivalent keys in read-only mode:
    ((stringp el)
     (prog1
 	(if forms--field
-	    (` ((setq here (point))
-		(if (not (search-forward (, el) nil t nil))
-		    (error "Parse error: cannot find `%s'" (, el)))
-		(aset forms--recordv (, (1- forms--field))
-		      (buffer-substring-no-properties here
-					(- (point) (, (length el)))))))
-	  (` ((if (not (looking-at (, (regexp-quote el))))
-		  (error "Parse error: not looking at `%s'" (, el)))
-	      (forward-char (, (length el))))))
+	    `((setq here (point))
+	      (if (not (search-forward ,el nil t nil))
+		  (error "Parse error: cannot find `%s'" ,el))
+	      (aset forms--recordv ,(1- forms--field)
+		    (buffer-substring-no-properties here
+						    (- (point) ,(length el)))))
+	  `((if (not (looking-at ,(regexp-quote el)))
+		(error "Parse error: not looking at `%s'" ,el))
+	    (forward-char ,(length el))))
       (setq forms--seen-text t)
       (setq forms--field nil)))
    ((numberp el)
@@ -1185,22 +1190,22 @@ Commands:                        Equivalent keys in read-only mode:
       nil))
    ((null el)
     (if forms--field
-	(` ((aset forms--recordv (, (1- forms--field))
-		  (buffer-substring-no-properties (point) (point-max)))))))
+	`((aset forms--recordv ,(1- forms--field)
+		(buffer-substring-no-properties (point) (point-max))))))
    ((listp el)
     (prog1
 	(if forms--field
-	    (` ((let ((here (point))
-		      (forms--dyntext (aref forms--dyntexts (, forms--dyntext))))
-		  (if (not (search-forward forms--dyntext nil t nil))
-		      (error "Parse error: cannot find `%s'" forms--dyntext))
-		  (aset forms--recordv (, (1- forms--field))
-			(buffer-substring-no-properties here
-					  (- (point) (length forms--dyntext)))))))
-	  (` ((let ((forms--dyntext (aref forms--dyntexts (, forms--dyntext))))
-		(if (not (looking-at (regexp-quote forms--dyntext)))
-		    (error "Parse error: not looking at `%s'" forms--dyntext))
-		(forward-char (length forms--dyntext))))))
+	    `((let ((here (point))
+		    (forms--dyntext (aref forms--dyntexts ,forms--dyntext)))
+		(if (not (search-forward forms--dyntext nil t nil))
+		    (error "Parse error: cannot find `%s'" forms--dyntext))
+		(aset forms--recordv ,(1- forms--field)
+		      (buffer-substring-no-properties here
+						      (- (point) (length forms--dyntext))))))
+	  `((let ((forms--dyntext (aref forms--dyntexts ,forms--dyntext)))
+	      (if (not (looking-at (regexp-quote forms--dyntext)))
+		  (error "Parse error: not looking at `%s'" forms--dyntext))
+	      (forward-char (length forms--dyntext)))))
       (setq forms--dyntext (1+ forms--dyntext))
       (setq forms--seen-text t)
       (setq forms--field nil)))
@@ -1214,7 +1219,7 @@ Commands:                        Equivalent keys in read-only mode:
 
       ;; Need a file to do this.
       (if (not (file-exists-p forms-file))
-	  (error "Need existing file or explicit 'forms-number-of-records'.")
+	  (error "Need existing file or explicit 'forms-number-of-records'")
 
 	;; Visit the file and extract the first record.
 	(setq forms--file-buffer (find-file-noselect forms-file))
@@ -1418,23 +1423,15 @@ Commands:                        Equivalent keys in read-only mode:
   ;; scroll-up -> forms-next-record
   (if forms-forms-scroll
       (progn
-	(substitute-key-definition 'scroll-up 'forms-next-record
-				   (current-local-map)
-				   (current-global-map))
-	(substitute-key-definition 'scroll-down 'forms-prev-record
-				   (current-local-map)
-				   (current-global-map))))
+	(local-set-key [remap scroll-up] 'forms-next-record)
+	(local-set-key [remap scroll-down] 'forms-prev-record)))
   ;;
   ;; beginning-of-buffer -> forms-first-record
   ;; end-of-buffer -> forms-end-record
   (if forms-forms-jump
       (progn
-	(substitute-key-definition 'beginning-of-buffer 'forms-first-record
-				   (current-local-map)
-				   (current-global-map))
-	(substitute-key-definition 'end-of-buffer 'forms-last-record
-				   (current-local-map)
-				   (current-global-map))))
+	(local-set-key [remap beginning-of-buffer] 'forms-first-record)
+	(local-set-key [remap end-of-buffer] 'forms-last-record)))
   ;;
   ;; Save buffer
   (local-set-key "\C-x\C-s" 'forms-save-buffer)
@@ -1695,7 +1692,8 @@ As a side effect: sets `forms--the-record-list'."
 	   (if (zerop disp)
 	       nil
 	     (setq cur (+ cur disp (- (forward-line disp)))))
-	 (setq cur (+ cur disp (- (goto-line arg)))))
+	 (goto-char (point-min))
+	 (setq cur (+ cur disp (- (forward-line (1- arg))))))
 
        (forms--get-record)))
 
@@ -1805,7 +1803,8 @@ after the current record."
 
     (save-excursion
       (set-buffer forms--file-buffer)
-      (goto-line ln)
+      (goto-char (point-min))
+      (forward-line (1- ln))
       (open-line 1)
       (insert the-record)
       (beginning-of-line))
@@ -1828,7 +1827,8 @@ after the current record."
       (let ((ln forms--current-record))
 	(save-excursion
 	  (set-buffer forms--file-buffer)
-	  (goto-line ln)
+	  (goto-char (point-min))
+	  (forward-line (1- ln))
 	  ;; Use delete-region instead of kill-region, to avoid
 	  ;; adding junk to the kill-ring.
 	  (delete-region (progn (beginning-of-line) (point))
@@ -1919,19 +1919,32 @@ after writing out the data."
   (interactive "p")
   (forms--checkmod)
   (let ((write-file-filter forms-write-file-filter)
-	(read-file-filter forms-read-file-filter))
+	(read-file-filter forms-read-file-filter)
+	(cur forms--current-record))
     (save-excursion
       (set-buffer forms--file-buffer)
       (let ((inhibit-read-only t))
 	;; Write file hooks are run via local-write-file-hooks.
 	;; (if write-file-filter 
 	;;  (save-excursion 
-	;;   (run-hooks 'write-file-filter))) 
+	;;   (run-hooks 'write-file-filter)))
+
+	;; If they have a write-file-filter, force the buffer to be
+	;; saved even if it doesn't seem to be changed.  First, they
+	;; might have changed the write-file-filter; and second, if
+	;; save-buffer does nothing, write-file-filter won't get run,
+	;; and then read-file-filter will be mightily confused.
+	(or (null write-file-filter)
+	    (set-buffer-modified-p t))
 	(save-buffer args)
 	(if read-file-filter
 	   (save-excursion
 	     (run-hooks 'read-file-filter)))
-	(set-buffer-modified-p nil))))
+	(set-buffer-modified-p nil)))
+    ;; Make sure we end up with the same record number as we started.
+    ;; Since read-file-filter may perform arbitrary transformations on
+    ;; the data buffer contents, save-excursion is not enough.
+    (forms-jump-record cur))
   t)
 
 (defun forms--revert-buffer (&optional arg noconfirm)
@@ -2072,4 +2085,4 @@ Usage: (setq forms-number-of-fields
 	  (goto-char (point-max))
 	  (insert ret)))))
 
-;;; forms.el ends here.
+;;; forms.el ends here