X-Git-Url: https://git.hcoop.net/bpt/emacs.git/blobdiff_plain/5cc7f7d64f63a0a27998443b29bcf8f864802fbd..4e7428f6fd0a01d77e3ad78c54849358839aeb6f:/lisp/forms.el diff --git a/lisp/forms.el b/lisp/forms.el index aa20ecd561..226474c5c0 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 Free Software Foundation, Inc. +;; Copyright (C) 1991, 1994, 1995, 1996, 1997 Free Software Foundation, Inc. ;; Author: Johan Vromans @@ -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. @@ -104,20 +104,20 @@ ;; If no write access to the data file is ;; possible, view mode is enforced. ;; -;; forms-check-number-of-fields [bool, default t] -;; If non-nil, a warning will be issued whenever -;; a record is found that does not have the number -;; of fields specified by `forms-number-of-fields'. +;; forms-check-number-of-fields [bool, default t] +;; If non-nil, a warning will be issued whenever +;; a record is found that does not have the number +;; 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,9 +125,17 @@ ;; `forms-next-field' resp. `forms-prev-field'. ;; ;; forms-forms-jump [bool, default nil] -;; Non-nil means: rebind locally the commands that -;; perform `beginning-of-buffer' or `end-of-buffer' -;; to perform `forms-first-field' resp. `forms-last-field'. +;; 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: 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 @@ -163,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. @@ -184,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! ;; @@ -205,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. ;; @@ -219,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: @@ -249,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 @@ -267,35 +275,41 @@ ;; [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. ;;; Code: +(defgroup forms nil + "Edit a file as a form to fill in." + :group 'data) + ;;; Global variables and constants: (provide 'forms) ;;; official (provide 'forms-mode) ;;; for compatibility -(defconst forms-version (substring "$Revision: 2.27 $" 11 -2) +(defconst forms-version (substring "$Revision: 2.39 $" 11 -2) "The version number of forms-mode (as string). The complete RCS id is: - $Id: forms.el,v 2.27 1996/01/25 06:16:34 kwzh Exp kwzh $") + $Id: forms.el,v 2.39 1999/05/31 08:34:19 eliz Exp $") -(defvar forms-mode-hooks nil - "Hook functions to be run upon entering Forms mode.") +(defcustom forms-mode-hooks nil + "Hook functions to be run upon entering Forms mode." + :group 'forms + :type 'function) ;;; Mandatory variables - must be set by evaluating the control file. @@ -310,26 +324,32 @@ ;;; Optional variables with default values. -(defvar forms-check-number-of-fields t - "*If non-nil, warn about records with wrong number of fields.") +(defcustom forms-check-number-of-fields t + "*If non-nil, warn about records with wrong number of fields." + :group 'forms + :type 'boolean) (defvar forms-field-sep "\t" "Field separator character (default TAB).") (defvar forms-read-only nil "Non-nil means: visit the file in view (read-only) mode. -\(Defaults to the write access on the data file).") +This is set automatically if the file permissions don't let you write it.") -(defvar forms-multi-line "\C-k" - "If not nil: use this character to separate multi-line fields (default C-k).") +(defvar forms-multi-line "\C-k" "\ +If not nil: use this character to separate multi-line fields (default C-k).") -(defvar forms-forms-scroll nil +(defcustom forms-forms-scroll nil "*Non-nil means replace scroll-up/down commands in Forms mode. -The replacement commands performs forms-next/prev-record.") +The replacement commands performs forms-next/prev-record." + :group 'forms + :type 'boolean) -(defvar forms-forms-jump nil +(defcustom forms-forms-jump nil "*Non-nil means redefine beginning/end-of-buffer in Forms mode. -The replacement commands performs forms-first/last-record.") +The replacement commands performs forms-first/last-record." + :group 'forms + :type 'boolean) (defvar forms-read-file-filter nil "The name of a function that is called after reading the data file. @@ -338,7 +358,7 @@ suitable for forms processing.") (defvar forms-write-file-filter nil "The name of a function that is called before writing the data file. -This can be used to undo the effects of form-read-file-hook.") +This can be used to undo the effects of `form-read-file-hook'.") (defvar forms-new-record-filter nil "The name of a function that is called when a new record is created.") @@ -351,15 +371,27 @@ This can be used to undo the effects of form-read-file-hook.") This variable is for use by the filter routines only. The contents may NOT be modified.") -(defvar forms-use-text-properties (fboundp 'set-text-properties) - "*Non-nil means: use emacs-19 text properties. -Defaults to t if this emacs is capable of handling text properties.") - -(defvar forms-ro-face 'default - "The face (a symbol) that is used to display read-only text on the screen.") - -(defvar forms-rw-face 'region - "The face (a symbol) that is used to display read-write text on the screen.") +(defcustom forms-use-text-properties t + "*Non-nil means: use text properties. +Defaults to t if this Emacs is capable of handling text properties." + :group 'forms + :type 'boolean) + +(defcustom forms-insert-after nil + "*Non-nil means: inserts of new records go after current record. +Also, initial position is at last record." + :group 'forms + :type 'boolean) + +(defcustom forms-ro-face 'default + "The face (a symbol) that is used to display read-only text on the screen." + :group 'forms + :type 'face) + +(defcustom forms-rw-face 'region + "The face (a symbol) that is used to display read-write text on the screen." + :group 'forms + :type 'face) ;;; Internal variables. @@ -419,19 +451,19 @@ Defaults to t if this emacs is capable of handling text properties.") Commands: Equivalent keys in read-only mode: TAB forms-next-field TAB - \\C-c TAB forms-next-field - \\C-c < forms-first-record < - \\C-c > forms-last-record > - \\C-c ? describe-mode ? - \\C-c \\C-k forms-delete-record - \\C-c \\C-q forms-toggle-read-only q - \\C-c \\C-o forms-insert-record - \\C-c \\C-l forms-jump-record l - \\C-c \\C-n forms-next-record n - \\C-c \\C-p forms-prev-record p - \\C-c \\C-r forms-search-reverse r - \\C-c \\C-s forms-search-forward s - \\C-c \\C-x forms-exit x + C-c TAB forms-next-field + C-c < forms-first-record < + C-c > forms-last-record > + C-c ? describe-mode ? + C-c C-k forms-delete-record + C-c C-q forms-toggle-read-only q + C-c C-o forms-insert-record + C-c C-l forms-jump-record l + C-c C-n forms-next-record n + C-c C-p forms-prev-record p + C-c C-r forms-search-reverse r + C-c C-s forms-search-forward s + C-c C-x forms-exit x " (interactive) @@ -463,6 +495,7 @@ Commands: Equivalent keys in read-only mode: (make-local-variable 'forms-multi-line) (make-local-variable 'forms-forms-scroll) (make-local-variable 'forms-forms-jump) + (make-local-variable 'forms-insert-after) (make-local-variable 'forms-use-text-properties) ;; Filter functions. @@ -497,22 +530,22 @@ Commands: Equivalent keys in read-only mode: ;; Check if the mandatory variables make sense. (or forms-file (error (concat "Forms control file error: " - "'forms-file' has not been set"))) + "`forms-file' has not been set"))) ;; Check forms-field-sep first, since it can be needed to ;; construct a default format list. (or (stringp forms-field-sep) (error (concat "Forms control file error: " - "'forms-field-sep' is not a string"))) + "`forms-field-sep' is not a string"))) (if forms-number-of-fields (or (and (numberp forms-number-of-fields) (> forms-number-of-fields 0)) (error (concat "Forms control file error: " - "'forms-number-of-fields' must be a number > 0"))) + "`forms-number-of-fields' must be a number > 0"))) (or (null forms-format-list) (error (concat "Forms control file error: " - "'forms-number-of-fields' has not been set")))) + "`forms-number-of-fields' has not been set")))) (or forms-format-list (forms--intuit-from-file)) @@ -522,14 +555,15 @@ Commands: Equivalent keys in read-only mode: (eq (length forms-multi-line) 1)) (if (string= forms-multi-line forms-field-sep) (error (concat "Forms control file error: " - "'forms-multi-line' is equal to 'forms-field-sep'"))) + "`forms-multi-line' is equal to 'forms-field-sep'"))) (error (concat "Forms control file error: " - "'forms-multi-line' must be nil or a one-character string")))) + "`forms-multi-line' must be nil or a one-character string")))) (or (fboundp 'set-text-properties) (setq forms-use-text-properties nil)) ;; Validate and process forms-format-list. ;;(message "forms: pre-processing format list...") + (make-local-variable 'forms--elements) (forms--process-format-list) ;; Build the formatter and parser. @@ -537,7 +571,6 @@ Commands: Equivalent keys in read-only mode: (make-local-variable 'forms--format) (make-local-variable 'forms--markers) (make-local-variable 'forms--dyntexts) - (make-local-variable 'forms--elements) ;;(message "forms: building parser...") (forms--make-format) (make-local-variable 'forms--parser) @@ -548,12 +581,12 @@ Commands: Equivalent keys in read-only mode: (if (and forms-new-record-filter (not (fboundp forms-new-record-filter))) (error (concat "Forms control file error: " - "'forms-new-record-filter' is not a function"))) + "`forms-new-record-filter' is not a function"))) (if (and forms-modified-record-filter (not (fboundp forms-modified-record-filter))) (error (concat "Forms control file error: " - "'forms-modified-record-filter' is not a function"))) + "`forms-modified-record-filter' is not a function"))) ;; The filters acces the contents of the forms using `forms-fields'. (make-local-variable 'forms-fields) @@ -561,7 +594,7 @@ Commands: Equivalent keys in read-only mode: ;; Dynamic text support. (make-local-variable 'forms--dynamic-text) - ;; Prevent accidental overwrite of the control file and autosave. + ;; Prevent accidental overwrite of the control file and auto-save. (set-visited-file-name nil) ;; Prepare this buffer for further processing. @@ -683,6 +716,10 @@ 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)) ) ;; user customising @@ -709,11 +746,11 @@ Commands: Equivalent keys in read-only mode: ;; Verify that `forms-format-list' is not nil. (or forms-format-list (error (concat "Forms control file error: " - "'forms-format-list' has not been set"))) + "`forms-format-list' has not been set"))) ;; It must be a list. (or (listp forms-format-list) (error (concat "Forms control file error: " - "'forms-format-list' is not a list"))) + "`forms-format-list' is not a list"))) ;; Assume every field is painted once. ;; `forms--elements' will grow if needed. @@ -758,7 +795,7 @@ Commands: Equivalent keys in read-only mode: el forms-number-of-fields)) ;; Store forms order. - (if (> field-num (length forms--elements)) + (if (>= field-num (length forms--elements)) (setq forms--elements (vconcat forms--elements (1- el))) (aset forms--elements field-num (1- el))) (setq field-num (1+ field-num)) @@ -774,7 +811,7 @@ Commands: Equivalent keys in read-only mode: ;; Validate. (or (fboundp (car-safe el)) (error (concat "Forms format error: " - "not a function %S") + "%S is not a function") (car-safe el))) ;; Shift. @@ -809,13 +846,13 @@ Commands: Equivalent keys in read-only mode: ;; Special treatment for read-only segments. ;; -;; If text is inserted between two read-only segments, it inherits the -;; read-only properties. This is not what we want. +;; If text is inserted between two read-only segments, there seems to +;; be no way to give the newly inserted text the RW face. ;; To solve this, read-only segments get the `insert-in-front-hooks' -;; property set with a function that temporarily switches the properties -;; of the first character of the segment to read-write, so the new -;; text gets the right properties. -;; The `post-command-hook' is used to restore the original properties. +;; property set with a function that temporarily switches the +;; properties of the first character of the segment to the RW face, so +;; the new text gets the right face. The `post-command-hook' is +;; used to restore the original properties. (defvar forms--iif-start nil "Record start of modification command.") @@ -886,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. @@ -972,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 )) @@ -1036,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) @@ -1069,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)) @@ -1134,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) @@ -1153,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))) @@ -1279,7 +1316,7 @@ Commands: Equivalent keys in read-only mode: (define-key map [menu-bar forms] (cons "Forms" (make-sparse-keymap "Forms"))) (define-key map [menu-bar forms menu-forms-exit] - '("Exit" . forms-exit)) + '("Exit Forms Mode" . forms-exit)) (define-key map [menu-bar forms menu-forms-sep1] '("----")) (define-key map [menu-bar forms menu-forms-save] @@ -1446,10 +1483,8 @@ Commands: Equivalent keys in read-only mode: (delete-auto-save-file-if-necessary) (kill-buffer (current-buffer))) (if (get-buffer buf) ; not killed??? - (if save - (progn - (beep) - (message "Problem saving buffers?"))) + (if save + (error "Problem saving buffer %s" (buffer-name buf))) (delete-auto-save-file-if-necessary) (kill-buffer (current-buffer))))) @@ -1496,7 +1531,6 @@ Commands: Equivalent keys in read-only mode: nil (if (null forms-check-number-of-fields) nil - (beep) (message "Warning: this record has %d fields instead of %d" (length forms--the-record-list) forms-number-of-fields)) (if (< (length forms--the-record-list) forms-number-of-fields) @@ -1516,7 +1550,8 @@ Commands: Equivalent keys in read-only mode: (set-buffer-modified-p nil) (setq buffer-read-only forms-read-only) (setq mode-line-process - (concat " " forms--current-record "/" forms--total-records))) + (concat " " (int-to-string forms--current-record) + "/" (int-to-string forms--total-records)))) (defun forms--parse-form () "Parse contents of form into list of strings." @@ -1551,38 +1586,34 @@ Commands: Equivalent keys in read-only mode: As a side effect: sets `forms--the-record-list'." (if forms-read-only - (progn - (message "Read-only buffer!") - (beep)) - - (let (the-record) - ;; Build new record. - (setq forms--the-record-list (forms--parse-form)) - (setq the-record - (mapconcat 'identity forms--the-record-list forms-field-sep)) + (error "Buffer is read-only")) - (if (string-match (regexp-quote forms-field-sep) - (mapconcat 'identity forms--the-record-list "")) - (error "Field separator occurs in record - update refused!")) - - ;; Handle multi-line fields, if allowed. - (if forms-multi-line - (forms--trans the-record "\n" forms-multi-line)) + (let (the-record) + ;; Build new record. + (setq forms--the-record-list (forms--parse-form)) + (setq the-record + (mapconcat 'identity forms--the-record-list forms-field-sep)) + + (if (string-match (regexp-quote forms-field-sep) + (mapconcat 'identity forms--the-record-list "")) + (error "Field separator occurs in record - update refused")) + + ;; Handle multi-line fields, if allowed. + (if forms-multi-line + (forms--trans the-record "\n" forms-multi-line)) - ;; A final sanity check before updating. - (if (string-match "\n" the-record) - (progn - (message "Multi-line fields in this record - update refused!") - (beep)) + ;; A final sanity check before updating. + (if (string-match "\n" the-record) + (error "Multi-line fields in this record - update refused")) - (save-excursion - (set-buffer forms--file-buffer) - ;; Use delete-region instead of kill-region, to avoid - ;; adding junk to the kill-ring. - (delete-region (save-excursion (beginning-of-line) (point)) - (save-excursion (end-of-line) (point))) - (insert the-record) - (beginning-of-line)))))) + (save-excursion + (set-buffer forms--file-buffer) + ;; Use delete-region instead of kill-region, to avoid + ;; adding junk to the kill-ring. + (delete-region (save-excursion (beginning-of-line) (point)) + (save-excursion (end-of-line) (point))) + (insert the-record) + (beginning-of-line)))) (defun forms--checkmod () "Check if this form has been modified, and call forms--update if so." @@ -1641,45 +1672,43 @@ As a side effect: sets `forms--the-record-list'." ;; Verify that the record number is within range. (if (or (> arg forms--total-records) (<= arg 0)) - (progn - (beep) + (error ;; Don't give the message if just paging. (if (not relative) (message "Record number %d out of range 1..%d" - arg forms--total-records)) - ) + arg forms--total-records) + ""))) - ;; Flush. - (forms--checkmod) + ;; Flush. + (forms--checkmod) - ;; Calculate displacement. - (let ((disp (- arg forms--current-record)) - (cur forms--current-record)) + ;; Calculate displacement. + (let ((disp (- arg forms--current-record)) + (cur forms--current-record)) - ;; `forms--show-record' needs it now. - (setq forms--current-record arg) + ;; `forms--show-record' needs it now. + (setq forms--current-record arg) - ;; Get the record and show it. - (forms--show-record - (save-excursion - (set-buffer forms--file-buffer) - (beginning-of-line) + ;; Get the record and show it. + (forms--show-record + (save-excursion + (set-buffer forms--file-buffer) + (beginning-of-line) - ;; Move, and adjust the amount if needed (shouldn't happen). - (if relative - (if (zerop disp) - nil - (setq cur (+ cur disp (- (forward-line disp))))) - (setq cur (+ cur disp (- (goto-line arg))))) + ;; Move, and adjust the amount if needed (shouldn't happen). + (if relative + (if (zerop disp) + nil + (setq cur (+ cur disp (- (forward-line disp))))) + (setq cur (+ cur disp (- (goto-line arg))))) - (forms--get-record))) + (forms--get-record))) - ;; This shouldn't happen. - (if (/= forms--current-record cur) - (progn - (setq forms--current-record cur) - (beep) - (message "Stuck at record %d" cur)))))) + ;; This shouldn't happen. + (if (/= forms--current-record cur) + (progn + (setq forms--current-record cur) + (error "Stuck at record %d" cur))))) (defun forms-first-record () "Jump to first record." @@ -1697,7 +1726,6 @@ As a side effect: re-calculates the number of records in the data file." (count-lines (point-min) (point-max))))) (if (= numrec forms--total-records) nil - (beep) (setq forms--total-records numrec) (message "Warning: number of records changed to %d" forms--total-records))) (forms-jump-record forms--total-records)) @@ -1724,8 +1752,7 @@ Otherwise enables edit mode if the visited file is writable." buffer-read-only) (progn (setq forms-read-only t) - (message "No write access to `%s'" forms-file) - (beep)) + (message "No write access to `%s'" forms-file)) (setq forms-read-only nil)) (if (equal ro forms-read-only) nil @@ -1750,15 +1777,21 @@ Otherwise enables edit mode if the visited file is writable." "Create a new record before the current one. With ARG: store the record after the current one. If `forms-new-record-filter' contains the name of a function, -it is called to fill (some of) the fields with default values." +it is called to fill (some of) the fields with default values. +If `forms-insert-after is non-nil, the default behavior is to insert +after the current record." (interactive "P") (if forms-read-only (error "")) - (let ((ln (if arg (1+ forms--current-record) forms--current-record)) - the-list the-record) + (let (ln the-list the-record) + + (if (or (and arg forms-insert-after) + (and (not arg) (not forms-insert-after))) + (setq ln forms--current-record) + (setq ln (1+ forms--current-record))) (forms--checkmod) (if forms-new-record-filter @@ -1826,21 +1859,25 @@ it is called to fill (some of) the fields with default values." (let (the-line the-record here (fld-sep forms-field-sep)) - (if (save-excursion - (set-buffer forms--file-buffer) - (setq here (point)) - (end-of-line) - (if (null (re-search-forward regexp nil t)) - (progn - (goto-char here) - (message "\"%s\" not found" regexp) - nil) + (save-excursion + (set-buffer forms--file-buffer) + (end-of-line) + (setq here (point)) + (if (or (re-search-forward regexp nil t) + (and (> here (point-min)) + (progn + (goto-char (point-min)) + (re-search-forward regexp here t)))) + (progn (setq the-record (forms--get-record)) - (setq the-line (1+ (count-lines (point-min) (point)))))) - (progn - (setq forms--current-record the-line) - (forms--show-record the-record) - (re-search-forward regexp nil t)))) + (setq the-line (1+ (count-lines (point-min) (point)))) + (if (< (point) here) + (message "Wrapped"))) + (goto-char here) + (error "Search failed: %s" regexp))) + (setq forms--current-record the-line) + (forms--show-record the-record)) + (re-search-forward regexp nil t) (setq forms--search-regexp regexp)) (defun forms-search-backward (regexp) @@ -1858,37 +1895,61 @@ it is called to fill (some of) the fields with default values." (let (the-line the-record here (fld-sep forms-field-sep)) - (if (save-excursion - (set-buffer forms--file-buffer) - (setq here (point)) - (beginning-of-line) - (if (null (re-search-backward regexp nil t)) - (progn - (goto-char here) - (message "\"%s\" not found" regexp) - nil) + (save-excursion + (set-buffer forms--file-buffer) + (beginning-of-line) + (setq here (point)) + (if (or (re-search-backward regexp nil t) + (and (< (point) (point-max)) + (progn + (goto-char (point-max)) + (re-search-backward regexp here t)))) + (progn (setq the-record (forms--get-record)) - (setq the-line (1+ (count-lines (point-min) (point)))))) - (progn - (setq forms--current-record the-line) - (forms--show-record the-record) - (re-search-forward regexp nil t)))) + (setq the-line (1+ (count-lines (point-min) (point)))) + (if (> (point) here) + (message "Wrapped"))) + (goto-char here) + (error "Search failed: %s" regexp))) + (setq forms--current-record the-line) + (forms--show-record the-record)) + (re-search-forward regexp nil t) (setq forms--search-regexp regexp)) (defun forms-save-buffer (&optional args) "Forms mode replacement for save-buffer. It saves the data buffer instead of the forms buffer. -Calls `forms-write-file-filter' before writing out the data." +Calls `forms-write-file-filter' before, and `forms-read-file-filter' +after writing out the data." (interactive "p") (forms--checkmod) - (let ((read-file-filter forms-read-file-filter)) + (let ((write-file-filter forms-write-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))) + + ;; 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 - (run-hooks 'read-file-filter)) - (set-buffer-modified-p nil)))) + (save-excursion + (run-hooks 'read-file-filter))) + (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) @@ -1959,6 +2020,7 @@ Calls `forms-write-file-filter' before writing out the data." (interactive) (let ((inhibit-read-only t) (save-record forms--current-record) + (total-nb-records forms--total-records) (nb-record 1) (record nil)) (while (<= nb-record forms--total-records) @@ -1969,7 +2031,7 @@ Calls `forms-write-file-filter' before writing out the data." (goto-char (buffer-end 1)) (insert record) (setq buffer-read-only nil) - (if (< nb-record forms--total-records) + (if (< nb-record total-nb-records) (insert "\n \n"))) (setq nb-record (1+ nb-record))) (save-excursion