X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/38bd9da2df4b7702bc74a3fbb64a5af8afe98c21..4532ac55a9f3f87863a4eb658845afa525fef410:/lisp/forms.el diff --git a/lisp/forms.el b/lisp/forms.el index ccca6d396d..24133d2225 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 @@ -31,9 +31,9 @@ ;; Names which start with 'forms--' are intended for internal use, and ;; should *NOT* be used from the outside. ;; -;; All variables are buffer-local, to enable multiple forms visits +;; All variables are buffer-local, to enable multiple forms visits ;; simultaneously. -;; Variable `forms--mode-setup' is local to *ALL* buffers, for it +;; Variable `forms--mode-setup' is local to *ALL* buffers, for it ;; controls if forms-mode has been enabled in a buffer. ;; ;; === How it works === @@ -54,15 +54,15 @@ ;; 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 +;; Automatic mode switching is supported if you specify ;; "-*- forms -*-" in the first line of the control file. -;; +;; ;; The control file is visited, evaluated using `eval-current-buffer', ;; and should set at least the following variables: ;; @@ -79,17 +79,17 @@ ;; ;; - a string, e.g. "hello". The string is inserted in the forms ;; "as is". -;; +;; ;; - an integer, denoting a field number. ;; The contents of this field are inserted at this point. ;; Fields are numbered starting with number one. -;; +;; ;; - a function call, e.g. (insert "text"). ;; This function call is dynamically evaluated and should return a ;; string. It should *NOT* have side-effects on the forms being ;; constructed. The current fields are available to the function ;; in the variable `forms-fields', they should *NOT* be modified. -;; +;; ;; - a lisp symbol, that must evaluate to one of the above. ;; ;; Optional variables which may be set in the control file: @@ -102,7 +102,7 @@ ;; Non-nil means that the data file is visited ;; read-only (view mode) as opposed to edit mode. ;; If no write access to the data file is -;; possible, view mode is enforced. +;; possible, view mode is enforced. ;; ;; forms-check-number-of-fields [bool, default t] ;; If non-nil, a warning will be issued whenever @@ -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,34 +125,39 @@ ;; `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 +;; If not nil: this should be the name of a ;; function that is called after the forms data file ;; has been read. It can be used to transform ;; the contents of the file into a format more suitable ;; for forms-mode processing. ;; ;; forms-write-file-filter [symbol, default nil] -;; If not nil: this should be the name of a +;; If not nil: this should be the name of a ;; function that is called before the forms data file ;; is written (saved) to disk. It can be used to undo ;; the effects of `forms-read-file-filter', if any. ;; ;; forms-new-record-filter [symbol, default nil] -;; If not nil: this should be the name of a +;; If not nil: this should be the name of a ;; function that is called when a new ;; record is created. It can be used to fill in ;; the new record with default fields, for example. ;; ;; forms-modified-record-filter [symbol, default nil] -;; If not nil: this should be the name of a +;; If not nil: this should be the name of a ;; function that is called when a record has ;; been modified. It is called after the fields ;; are parsed. It can be used to register @@ -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,14 +192,14 @@ ;; 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! ;; ;; Normal operation is to transfer one line (record) from the data file, ;; split it into fields (into `forms--the-record-list'), and display it ;; using the specs in `forms-format-list'. -;; A format routine `forms--format' is built upon startup to format +;; A format routine `forms--format' is built upon startup to format ;; the records according to `forms-format-list'. ;; ;; When a form is changed the record is updated as soon as this form @@ -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,16 +227,16 @@ ;; 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: -;; +;; ;; TAB forms-next-field ;; \C-c TAB forms-next-field ;; \C-c < forms-first-record @@ -246,59 +251,65 @@ ;; \C-c \C-r forms-search-backward ;; \C-c \C-s forms-search-forward ;; \C-c \C-x forms-exit -;; +;; ;; Read-only mode commands: -;; +;; ;; 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 ;; r forms-search-backward ;; s forms-search-forward ;; x forms-exit -;; +;; ;; Of course, it is also possible to use the \C-c prefix to obtain the ;; same command keys as in edit mode. -;; -;; The following bindings are available, independent of the mode: -;; +;; +;; The following bindings are available, independent of the mode: +;; ;; [next] forms-next-record ;; [prior] forms-prev-record ;; [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 +;; `write-file-functions' 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.29 $" 11 -2) +(defconst forms-version (substring "$Revision: 2.46 $" 11 -2) "The version number of forms-mode (as string). The complete RCS id is: - $Id: forms.el,v 2.29 1996/03/01 21:13:01 jvromans Exp kwzh $") + $Id: forms.el,v 2.46 2003/05/23 12:48:06 rms Exp $") -(defvar forms-mode-hooks nil - "Hook functions to be run upon entering Forms mode.") +(defcustom forms-mode-hooks nil + "Hook run upon entering Forms mode." + :group 'forms + :type 'hook) ;;; Mandatory variables - must be set by evaluating the control file. @@ -313,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. @@ -341,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,22 +368,30 @@ This can be used to undo the effects of form-read-file-hook.") (defvar forms-fields nil "List with fields of the current forms. First field has number 1. -This variable is for use by the filter routines only. +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.") +(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) -(defvar forms-insert-after nil +(defcustom forms-insert-after nil "*Non-nil means: inserts of new records go after current record. -Also, initial position is at last record.") - -(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.") +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. @@ -392,7 +417,7 @@ Also, initial position is at last record.") (defvar forms--dyntexts nil "Dynamic texts (resulting from function calls) on the screen.") -(defvar forms--the-record-list nil +(defvar forms--the-record-list nil "List of strings of the current record, as parsed from the file.") (defvar forms--search-regexp nil @@ -420,25 +445,25 @@ Also, initial position is at last record.") (defvar forms--rw-face nil "Face used to represent read-write data on the screen.") -;;;###autoload +;;;###autoload (defun forms-mode (&optional primary) "Major mode to visit files in a field-structured manner using a form. 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) @@ -485,7 +510,7 @@ Commands: Equivalent keys in read-only mode: (setq forms-new-record-filter nil) (setq forms-modified-record-filter nil) - ;; If running Emacs 19 under X, setup faces to show read-only and + ;; If running Emacs 19 under X, setup faces to show read-only and ;; read-write fields. (if (fboundp 'make-face) (progn @@ -496,7 +521,7 @@ Commands: Equivalent keys in read-only mode: ;;(message "forms: processing control file...") ;; If enable-local-eval is not set to t the user is asked first. (if (or (eq enable-local-eval t) - (yes-or-no-p + (yes-or-no-p (concat "Evaluate lisp code in buffer " (buffer-name) " to display forms "))) (eval-current-buffer) @@ -504,23 +529,23 @@ 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"))) + (error (concat "Forms control file error: " + "`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)) @@ -529,13 +554,13 @@ Commands: Equivalent keys in read-only mode: (if (and (stringp forms-multi-line) (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'"))) + (error (concat "Forms control file error: " + "`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) @@ -556,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) @@ -569,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. @@ -631,13 +656,13 @@ Commands: Equivalent keys in read-only mode: (if (not file-modified) (set-buffer-modified-p nil))) (if write-file-filter (progn - (make-variable-buffer-local 'local-write-file-hooks) - (setq local-write-file-hooks (list write-file-filter))))) + (make-local-variable 'write-file-functions) + (setq write-file-functions (list write-file-filter))))) (if write-file-filter (save-excursion (set-buffer forms--file-buffer) - (make-variable-buffer-local 'local-write-file-hooks) - (setq local-write-file-hooks (list write-file-filter)))))) + (make-local-variable 'write-file-functions) + (setq write-file-functions (list write-file-filter)))))) ;; count the number of records, and set see if it may be modified (let (ro) @@ -674,7 +699,7 @@ Commands: Equivalent keys in read-only mode: (if (= forms--total-records 0) ;;(message "forms: proceeding setup (new file)...") (progn - (insert + (insert "GNU Emacs Forms Mode version " forms-version "\n\n" (if (file-exists-p forms-file) (concat "No records available in file `" forms-file "'\n\n") @@ -691,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)...") @@ -711,7 +736,7 @@ Commands: Equivalent keys in read-only mode: ;; Symbols in the list are evaluated, and consecutive strings are ;; concatenated. ;; Array `forms--elements' is constructed that contains the order - ;; of the fields on the display. This array is used by + ;; of the fields on the display. This array is used by ;; `forms--parser-using-text-properties' to extract the fields data ;; from the form on the screen. ;; Upon completion, `forms-format-list' is guaranteed correct, so @@ -721,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. @@ -734,7 +759,7 @@ Commands: Equivalent keys in read-only mode: (let ((the-list forms-format-list) ; the list of format elements (this-item 0) ; element in list (prev-item nil) - (field-num 0)) ; highest field number + (field-num 0)) ; highest field number (setq forms-format-list nil) ; gonna rebuild @@ -760,7 +785,7 @@ Commands: Equivalent keys in read-only mode: (setq prev-item el))) ;; Try numeric ... - ((numberp el) + ((numberp el) ;; Validate range. (if (or (<= el 0) @@ -786,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. @@ -837,8 +862,8 @@ Commands: Equivalent keys in read-only mode: (defun forms--iif-hook (begin end) "`insert-in-front-hooks' function for read-only segments." - ;; Note start location. By making it a marker that points one - ;; character beyond the actual location, it is guaranteed to move + ;; Note start location. By making it a marker that points one + ;; character beyond the actual location, it is guaranteed to move ;; correctly if text is inserted. (or forms--iif-start (setq forms--iif-start (copy-marker (1+ (point))))) @@ -849,12 +874,12 @@ Commands: Equivalent keys in read-only mode: 'read-only)) (progn ;; Fetch current properties. - (setq forms--iif-properties + (setq forms--iif-properties (text-properties-at (1- forms--iif-start))) ;; Replace them. (let ((inhibit-read-only t)) - (set-text-properties + (set-text-properties (1- forms--iif-start) forms--iif-start (list 'face forms--rw-face 'front-sticky '(face)))) @@ -875,7 +900,7 @@ Commands: Equivalent keys in read-only mode: ;; Restore properties. (if forms--iif-start (let ((inhibit-read-only t)) - (set-text-properties + (set-text-properties (1- forms--iif-start) forms--iif-start forms--iif-properties))) @@ -895,26 +920,26 @@ Commands: Equivalent keys in read-only mode: (let ((forms--marker 0) (forms--dyntext 0)) - (setq + (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))))))) + (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))))) ;; We have tallied the number of markers and dynamic texts, ;; so we can allocate the arrays now. @@ -932,9 +957,9 @@ Commands: Equivalent keys in read-only mode: ;; (let ((inhibit-read-only t)) ;; ;; ;; A string, e.g. "text: ". - ;; (set-text-properties + ;; (set-text-properties ;; (point) - ;; (progn (insert "text: ") (point)) + ;; (progn (insert "text: ") (point)) ;; (list 'face forms--ro-face ;; 'read-only 1 ;; 'insert-in-front-hooks 'forms--iif-hook @@ -945,7 +970,7 @@ Commands: Equivalent keys in read-only mode: ;; (aset forms--markers 0 (point-marker)) ;; (insert (elt arg 5)) ;; (or (= (point) here) - ;; (set-text-properties + ;; (set-text-properties ;; here (point) ;; (list 'face forms--rw-face ;; 'front-sticky '(face)))) @@ -983,47 +1008,47 @@ 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 )) @@ -1046,17 +1071,17 @@ Commands: Equivalent keys in read-only mode: ;; (insert (aset forms--dyntexts 0 (tocol 40))) ;; ... ) - (cond + (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) @@ -1081,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)) @@ -1103,7 +1128,7 @@ Commands: Equivalent keys in read-only mode: (goto-char (setq here (aref forms--markers i))) (if (get-text-property here 'read-only) (aset forms--recordv (aref forms--elements i) nil) - (if (setq there + (if (setq there (next-single-property-change here 'read-only)) (aset forms--recordv (aref forms--elements i) (buffer-substring-no-properties here there)) @@ -1119,12 +1144,12 @@ Commands: Equivalent keys in read-only mode: ;; (lambda nil ;; (let (here) ;; (goto-char (point-min)) - ;; + ;; ;; ;; "text: " ;; (if (not (looking-at "text: ")) ;; (error "Parse error: cannot find \"text: \"")) ;; (forward-char 6) ; past "text: " - ;; + ;; ;; ;; 6 ;; ;; "\nmore text: " ;; (setq here (point)) @@ -1138,7 +1163,7 @@ Commands: Equivalent keys in read-only mode: ;; (error "Parse error: not looking at \"%s\"" forms--dyntext)) ;; (forward-char (length forms--dyntext)) ;; (setq forms--dynamic-text (cdr-safe forms--dynamic-text))) - ;; ... + ;; ... ;; ;; final flush (due to terminator sentinel, see below) ;; (aset forms--recordv 7 (buffer-substring-no-properties (point) (point-max))) @@ -1146,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) @@ -1165,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))) @@ -1194,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)) @@ -1208,7 +1233,7 @@ Commands: Equivalent keys in read-only mode: (goto-char (point-min)) (forms--get-record))) - ;; This may be overkill, but try to avoid interference with + ;; This may be overkill, but try to avoid interference with ;; the normal processing. (kill-buffer forms--file-buffer) @@ -1235,8 +1260,8 @@ Commands: Equivalent keys in read-only mode: (defun forms--set-keymaps () "Set the keymaps used in this mode." - (use-local-map (if forms-read-only - forms-mode-ro-map + (use-local-map (if forms-read-only + forms-mode-ro-map forms-mode-edit-map))) (defun forms--mode-commands () @@ -1262,7 +1287,6 @@ Commands: Equivalent keys in read-only mode: (setq forms-mode-ro-map (make-keymap)) (suppress-keymap forms-mode-ro-map) (define-key forms-mode-ro-map "\C-c" forms-mode-map) - (define-key forms-mode-ro-map "\t" 'forms-next-field) (define-key forms-mode-ro-map "q" 'forms-toggle-read-only) (define-key forms-mode-ro-map "l" 'forms-jump-record) (define-key forms-mode-ro-map "n" 'forms-next-record) @@ -1279,7 +1303,6 @@ Commands: Equivalent keys in read-only mode: ;; This is the normal, local map. (setq forms-mode-edit-map (make-keymap)) - (define-key forms-mode-edit-map "\t" 'forms-next-field) (define-key forms-mode-edit-map "\C-c" forms-mode-map) (forms--mode-commands1 forms-mode-edit-map) (forms--mode-menu-edit forms-mode-edit-map) @@ -1378,9 +1401,9 @@ Commands: Equivalent keys in read-only mode: (put 'forms-delete-record 'menu-enable '(not forms-read-only)) ) -(defun forms--mode-commands1 (map) +(defun forms--mode-commands1 (map) "Helper routine to define keys." - (define-key map [TAB] 'forms-next-field) + (define-key map "\t" 'forms-next-field) (define-key map [S-tab] 'forms-prev-field) (define-key map [next] 'forms-next-record) (define-key map [prior] 'forms-prev-record) @@ -1398,23 +1421,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) @@ -1509,10 +1524,10 @@ Commands: Equivalent keys in read-only mode: (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) - (setq forms--the-record-list + (setq forms--the-record-list (append forms--the-record-list - (make-list - (- forms-number-of-fields + (make-list + (- forms-number-of-fields (length forms--the-record-list)) ""))))) @@ -1525,13 +1540,14 @@ 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." ;; The contents of the form are parsed, and a new list of strings ;; is constructed. - ;; A vector with the strings from the original record is + ;; A vector with the strings from the original record is ;; constructed, which is updated with the new contents. Therefore ;; fields which were not in the form are not modified. ;; Finally, the vector is transformed into a list for further processing. @@ -1567,11 +1583,11 @@ As a side effect: sets `forms--the-record-list'." (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)) @@ -1674,7 +1690,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))) @@ -1694,7 +1711,7 @@ As a side effect: sets `forms--the-record-list'." As a side effect: re-calculates the number of records in the data file." (interactive) (let - ((numrec + ((numrec (save-excursion (set-buffer forms--file-buffer) (count-lines (point-min) (point-max))))) @@ -1750,7 +1767,7 @@ Otherwise enables edit mode if the visited file is writable." (defun forms-insert-record (arg) "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, +If `forms-new-record-filter' contains the name of a function, 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." @@ -1784,11 +1801,12 @@ 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)) - + (setq forms--current-record ln)) (setq forms--total-records (1+ forms--total-records)) @@ -1807,7 +1825,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)) @@ -1820,8 +1839,8 @@ after the current record." (defun forms-search-forward (regexp) "Search forward for record containing REGEXP." - (interactive - (list (read-string (concat "Search forward for" + (interactive + (list (read-string (concat "Search forward for" (if forms--search-regexp (concat " (" forms--search-regexp @@ -1833,27 +1852,31 @@ after the current record." (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) "Search backward for record containing REGEXP." - (interactive - (list (read-string (concat "Search backward for" + (interactive + (list (read-string (concat "Search backward for" (if forms--search-regexp (concat " (" forms--search-regexp @@ -1865,21 +1888,25 @@ after the current record." (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) @@ -1890,18 +1917,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)) - (if write-file-filter - (save-excursion - (run-hooks 'write-file-filter))) + ;; 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 (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) @@ -1972,6 +2013,7 @@ after 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) @@ -1982,7 +2024,7 @@ after 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 @@ -2032,7 +2074,7 @@ Usage: (setq forms-number-of-fields (setq ret (concat ret (prin1-to-string vel) "\n"))) (setq ret (concat ret "" "\n"))) (if (fboundp el) - (setq ret (concat ret (prin1-to-string (symbol-function el)) + (setq ret (concat ret (prin1-to-string (symbol-function el)) "\n")))))) (save-excursion (set-buffer (get-buffer-create "*forms-mode debug*")) @@ -2041,4 +2083,4 @@ Usage: (setq forms-number-of-fields (goto-char (point-max)) (insert ret))))) -;;; forms.el ends here. +;;; forms.el ends here