X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/2996d9f84805e1b0c128f5e90dbfcf3a21af2117..36ad23ecb54ed700756a4ebbe95f4e3fe01ae244:/lisp/forms.el diff --git a/lisp/forms.el b/lisp/forms.el index c8b2234484..aa0582c918 100644 --- a/lisp/forms.el +++ b/lisp/forms.el @@ -1,7 +1,8 @@ -;;; forms.el -- Forms mode: edit a file as a form to fill in. -;;; Copyright (C) 1991, 1994, 1995 Free Software Foundation, Inc. +;;; forms.el --- Forms mode: edit a file as a form to fill in -;; Author: Johan Vromans +;; Copyright (C) 1991, 1994, 1995, 1996, 1997, 2003 Free Software Foundation, Inc. + +;; Author: Johan Vromans ;; This file is part of GNU Emacs. @@ -16,279 +17,294 @@ ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs; see the file COPYING. If not, write to -;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. +;; along with GNU Emacs; see the file COPYING. If not, write to the +;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, +;; Boston, MA 02111-1307, USA. ;;; Commentary: -;;; Visit a file using a form. -;;; -;;; === Naming conventions -;;; -;;; The names of all variables and functions start with 'forms-'. -;;; 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 -;;; simultaneously. -;;; Variable `forms--mode-setup' is local to *ALL* buffers, for it -;;; controls if forms-mode has been enabled in a buffer. -;;; -;;; === How it works === -;;; -;;; Forms mode means visiting a data file which is supposed to consist -;;; of records each containing a number of fields. The records are -;;; separated by a newline, the fields are separated by a user-defined -;;; field separater (default: TAB). -;;; When shown, a record is transferred to an Emacs buffer and -;;; presented using a user-defined form. One record is shown at a -;;; time. -;;; -;;; Forms mode is a composite mode. It involves two files, and two -;;; buffers. -;;; The first file, called the control file, defines the name of the -;;; data file and the forms format. This file buffer will be used to -;;; present the forms. -;;; 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 . -;;; Alternativily `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 . -;;; -;;; 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: -;;; -;;; forms-file [string] -;;; The name of the data file. -;;; -;;; forms-number-of-fields [integer] -;;; The number of fields in each record. -;;; -;;; forms-format-list [list] -;;; Formatting instructions. -;;; -;;; `forms-format-list' should be a list, each element containing -;;; -;;; - 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: -;;; -;;; forms-field-sep [string, default TAB] -;;; The field separator used to separate the -;;; fields in the data file. It may be a string. -;;; -;;; forms-read-only [bool, default nil] -;;; 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. -;;; -;;; forms-multi-line [string, default "^K"] -;;; 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 -;;; to be used for this purpose. Upon display, all -;;; occurrencies of this character are translated -;;; to newlines. Upon storage they are translated -;;; back to the separator character. -;;; -;;; forms-forms-scroll [bool, default nil] -;;; Non-nil means: rebind locally the commands that -;;; perform `scroll-up' or `scroll-down' to use -;;; `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'. -;;; -;;; forms-read-file-filter [symbol, default nil] -;;; 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 -;;; 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 -;;; 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 -;;; function that is called when a record has -;;; been modified. It is called after the fields -;;; are parsed. It can be used to register -;;; modification dates, for example. -;;; -;;; forms-use-text-properties [bool, see text for default] -;;; This variable controls if forms mode should use -;;; text properties to protect the form text from being -;;; modified (using text-property `read-only'). -;;; Also, the read-write fields are shown using a -;;; 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. -;;; 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 -;;; variable should be set to a symbol that is a -;;; valid face. -;;; E.g. -;;; (make-face 'my-face) -;;; (setq forms-ro-face 'my-face) -;;; -;;; forms-rw-face [symbol, default 'region] -;;; This is the face that is used to show -;;; read-write text on the screen. -;;; -;;; 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. -;;; 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 -;;; the records according to `forms-format-list'. -;;; -;;; When a form is changed the record is updated as soon as this form -;;; is left. The contents of the form are parsed using information -;;; obtained from `forms-format-list', and the fields which are -;;; deduced from the form are modified. Fields not shown on the forms -;;; retain their origional values. The newly formed record then -;;; replaces the contents of the old record in `forms--file-buffer'. -;;; A parse routine `forms--parser' is built upon startup to parse -;;; the records. -;;; -;;; 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' -;;; is executed and the file buffer has been modified, Emacs will ask -;;; questions anyway. -;;; -;;; Other functions provided by forms mode are: -;;; -;;; paging (forward, backward) by record -;;; jumping (first, last, random number) -;;; searching -;;; creating and deleting records -;;; reverting the form (NOT the file buffer) -;;; switching edit <-> view mode v.v. -;;; jumping from field to field -;;; -;;; As an 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 -;;; contents of the buffer. -;;; -;;; Edit mode commands: -;;; -;;; TAB forms-next-field -;;; \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 -;;; \C-c \C-o forms-insert-record -;;; \C-c \C-l forms-jump-record -;;; \C-c \C-n forms-next-record -;;; \C-c \C-p forms-prev-record -;;; \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 -;;; 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: -;;; -;;; [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 -;;; -;;; 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') -;;; 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 -;;; instead of the buffer data, `revert-file-hook' is defined to -;;; revert a forms to original. +;; Visit a file using a form. +;; +;; === Naming conventions +;; +;; The names of all variables and functions start with 'forms-'. +;; 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 +;; simultaneously. +;; Variable `forms--mode-setup' is local to *ALL* buffers, for it +;; controls if forms-mode has been enabled in a buffer. +;; +;; === How it works === +;; +;; Forms mode means visiting a data file which is supposed to consist +;; of records each containing a number of fields. The records are +;; separated by a newline, the fields are separated by a user-defined +;; field separator (default: TAB). +;; When shown, a record is transferred to an Emacs buffer and +;; presented using a user-defined form. One record is shown at a +;; time. +;; +;; Forms mode is a composite mode. It involves two files, and two +;; buffers. +;; The first file, called the control file, defines the name of the +;; data file and the forms format. This file buffer will be used to +;; present the forms. +;; 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. +;; 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'. +;; +;; 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: +;; +;; forms-file [string] +;; The name of the data file. +;; +;; forms-number-of-fields [integer] +;; The number of fields in each record. +;; +;; forms-format-list [list] +;; Formatting instructions. +;; +;; `forms-format-list' should be a list, each element containing +;; +;; - 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: +;; +;; forms-field-sep [string, default TAB] +;; The field separator used to separate the +;; fields in the data file. It may be a string. +;; +;; forms-read-only [bool, default nil] +;; 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. +;; +;; 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 +;; contain fields that can span multiple lines in +;; the form. +;; This variable denotes the separator string +;; to be used for this purpose. Upon display, all +;; occurrences of this string are translated +;; to newlines. Upon storage they are translated +;; back to the separator string. +;; +;; forms-forms-scroll [bool, default nil] +;; Non-nil means: rebind locally the commands that +;; perform `scroll-up' or `scroll-down' to use +;; `forms-next-field' resp. `forms-prev-field'. +;; +;; forms-forms-jump [bool, default nil] +;; 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 +;; 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 +;; 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 +;; 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 +;; function that is called when a record has +;; been modified. It is called after the fields +;; are parsed. It can be used to register +;; modification dates, for example. +;; +;; forms-use-text-properties [bool, see text for default] +;; This variable controls if forms mode should use +;; text properties to protect the form text from being +;; modified (using text-property `read-only'). +;; Also, the read-write fields are shown using a +;; 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 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 +;; variable should be set to a symbol that is a +;; valid face. +;; E.g. +;; (make-face 'my-face) +;; (setq forms-ro-face 'my-face) +;; +;; forms-rw-face [symbol, default 'region] +;; This is the face that is used to show +;; read-write text on the screen. +;; +;; 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 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 +;; the records according to `forms-format-list'. +;; +;; When a form is changed the record is updated as soon as this form +;; is left. The contents of the form are parsed using information +;; obtained from `forms-format-list', and the fields which are +;; deduced from the form are modified. Fields not shown on the forms +;; retain their original values. The newly formed record then +;; replaces the contents of the old record in `forms--file-buffer'. +;; A parse routine `forms--parser' is built upon startup to parse +;; the records. +;; +;; 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' +;; is executed and the file buffer has been modified, Emacs will ask +;; questions anyway. +;; +;; Other functions provided by forms mode are: +;; +;; paging (forward, backward) by record +;; jumping (first, last, random number) +;; searching +;; creating and deleting records +;; reverting the form (NOT the file buffer) +;; switching edit <-> view mode v.v. +;; jumping from field to field +;; +;; 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 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 +;; \C-c > forms-last-record +;; \C-c ? describe-mode +;; \C-c \C-k forms-delete-record +;; \C-c \C-q forms-toggle-read-only +;; \C-c \C-o forms-insert-record +;; \C-c \C-l forms-jump-record +;; \C-c \C-n forms-next-record +;; \C-c \C-p forms-prev-record +;; \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 +;; 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: +;; +;; [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 +;; +;; 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'), +;; 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. +;; +;; `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.14 $" 11 -2) - "The version number of forms-mode (as string). The complete RCS id is: - - $Id: forms.el,v 2.14 1995/04/16 14:02:14 jv Exp $") - -(defvar forms-mode-hooks nil - "Hook functions to be run upon entering Forms mode.") +(defcustom forms-mode-hook nil + "Hook run upon entering Forms mode." + :group 'forms + :type 'hook) ;;; Mandatory variables - must be set by evaluating the control file. @@ -303,23 +319,32 @@ ;;; Optional variables with default values. +(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. @@ -328,7 +353,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.") @@ -338,18 +363,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.") - -(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. @@ -375,7 +412,7 @@ Defaults to t if this emacs is capable of handling text properties.") (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 @@ -403,25 +440,25 @@ Defaults to t if this emacs is capable of handling text properties.") (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) @@ -453,6 +490,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. @@ -467,7 +505,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 @@ -478,7 +516,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) @@ -486,23 +524,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)) @@ -511,15 +549,16 @@ 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) (forms--process-format-list) ;; Build the formatter and parser. @@ -527,7 +566,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) @@ -538,12 +576,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) @@ -551,7 +589,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. @@ -605,30 +643,24 @@ Commands: Equivalent keys in read-only mode: (let ((read-file-filter forms-read-file-filter) (write-file-filter forms-write-file-filter)) (if read-file-filter - (save-excursion - (set-buffer forms--file-buffer) + (with-current-buffer forms--file-buffer (let ((inhibit-read-only t) (file-modified (buffer-modified-p))) (run-hooks 'read-file-filter) (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))))) + (add-hook 'write-file-functions write-file-filter nil t))) (if write-file-filter - (save-excursion - (set-buffer forms--file-buffer) - (make-variable-buffer-local 'local-write-file-hooks) - (setq local-write-file-hooks write-file-filter))))) + (with-current-buffer forms--file-buffer + (add-hook 'write-file-functions write-file-filter nil t))))) ;; count the number of records, and set see if it may be modified (let (ro) (setq forms--total-records - (save-excursion + (with-current-buffer forms--file-buffer (prog1 (progn ;;(message "forms: counting records...") - (set-buffer forms--file-buffer) (bury-buffer (current-buffer)) (setq ro buffer-read-only) (count-lines (point-min) (point-max))) @@ -656,11 +688,11 @@ Commands: Equivalent keys in read-only mode: (if (= forms--total-records 0) ;;(message "forms: proceeding setup (new file)...") (progn - (insert - "GNU Emacs Forms Mode version " forms-version "\n\n" + (insert + "GNU Emacs Forms Mode\n\n" (if (file-exists-p forms-file) - (concat "No records available in file \"" forms-file "\".\n\n") - (format "Creating new file \"%s\"\nwith %d field%s per record.\n\n" + (concat "No records available in file `" forms-file "'\n\n") + (format "Creating new file `%s'\nwith %d field%s per record\n\n" forms-file forms-number-of-fields (if (= 1 forms-number-of-fields) "" "s"))) "Use " (substitute-command-keys "\\[forms-insert-record]") @@ -673,11 +705,15 @@ 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 ;;(message "forms: proceeding setup (user hooks)...") - (run-hooks 'forms-mode-hooks) + (run-hooks 'forms-mode-hook 'forms-mode-hooks) ;;(message "forms: setting up... done.") ;; be helpful @@ -689,30 +725,29 @@ 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 garanteed correct, so + ;; Upon completion, `forms-format-list' is guaranteed correct, so ;; `forms--make-format' and `forms--make-parser' do not need to perform ;; any checks. ;; 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. (setq forms--elements (make-vector forms-number-of-fields nil)) (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 @@ -738,7 +773,7 @@ Commands: Equivalent keys in read-only mode: (setq prev-item el))) ;; Try numeric ... - ((numberp el) + ((numberp el) ;; Validate range. (if (or (<= el 0) @@ -748,7 +783,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)) @@ -764,8 +799,8 @@ Commands: Equivalent keys in read-only mode: ;; Validate. (or (fboundp (car-safe el)) (error (concat "Forms format error: " - "not a function " - (prin1-to-string (car-safe el))))) + "%S is not a function") + (car-safe el))) ;; Shift. (if prev-item @@ -776,8 +811,8 @@ Commands: Equivalent keys in read-only mode: ;; else (t (error (concat "Forms format error: " - "invalid element " - (prin1-to-string el))))) + "invalid element %S") + el))) ;; Advance to next element of the list. (setq the-list rem))) @@ -799,13 +834,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.") @@ -815,8 +850,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))))) @@ -827,12 +862,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)))) @@ -853,7 +888,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))) @@ -873,26 +908,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. @@ -910,9 +945,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 @@ -923,7 +958,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)))) @@ -961,47 +996,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 )) @@ -1024,17 +1059,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) @@ -1059,13 +1094,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)) @@ -1081,12 +1116,12 @@ 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 here there)) + (buffer-substring-no-properties here there)) (aset forms--recordv (aref forms--elements i) - (buffer-substring here (point-max))))) + (buffer-substring-no-properties here (point-max))))) (setq i (1+ i))))) (defun forms--make-parser-elt (el) @@ -1097,18 +1132,18 @@ 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)) ;; (if (not (search-forward "\nmore text: " nil t nil)) ;; (error "Parse error: cannot find \"\\nmore text: \"")) - ;; (aset forms--recordv 5 (buffer-substring here (- (point) 12))) + ;; (aset forms--recordv 5 (buffer-substring-no-properties here (- (point) 12))) ;; ;; ;; (tocol 40) ;; (let ((forms--dyntext (car-safe forms--dynamic-text))) @@ -1116,23 +1151,23 @@ 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 (point) (point-max))) + ;; (aset forms--recordv 7 (buffer-substring-no-properties (point) (point-max))) (cond ((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 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) @@ -1143,22 +1178,22 @@ Commands: Equivalent keys in read-only mode: nil)) ((null el) (if forms--field - (` ((aset forms--recordv (, (1- forms--field)) - (buffer-substring (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 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))) @@ -1172,27 +1207,25 @@ 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)) (let ((read-file-filter forms-read-file-filter) (the-record)) (setq the-record - (save-excursion - (set-buffer forms--file-buffer) + (with-current-buffer forms--file-buffer (let ((inhibit-read-only t)) (run-hooks 'read-file-filter)) (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) ;; Count the number of fields in `the-record'. - (let (the-result - (start-pos 0) + (let ((start-pos 0) found-pos (field-sep-length (length forms-field-sep))) (setq forms-number-of-fields 1) @@ -1213,8 +1246,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 () @@ -1234,14 +1267,12 @@ Commands: Equivalent keys in read-only mode: (define-key forms-mode-map "\C-x" 'forms-exit) (define-key forms-mode-map "<" 'forms-first-record) (define-key forms-mode-map ">" 'forms-last-record) - (define-key forms-mode-map "?" 'describe-mode) (define-key forms-mode-map "\C-?" 'forms-prev-record) ;; `forms-mode-ro-map' replaces the local map when 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) @@ -1258,7 +1289,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) @@ -1270,23 +1300,23 @@ 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] - '("Save data" . forms-save-buffer)) + '("Save Data" . forms-save-buffer)) (define-key map [menu-bar forms menu-forms-print] - '("Print data" . forms-print)) + '("Print Data" . forms-print)) (define-key map [menu-bar forms menu-forms-describe] - '("Describe mode" . describe-mode)) + '("Describe Mode" . describe-mode)) (define-key map [menu-bar forms menu-forms-toggle-ro] '("Toggle View/Edit" . forms-toggle-read-only)) (define-key map [menu-bar forms menu-forms-jump-record] '("Jump" . forms-jump-record)) (define-key map [menu-bar forms menu-forms-search-backward] - '("Search backward" . forms-search-backward)) + '("Search Backward" . forms-search-backward)) (define-key map [menu-bar forms menu-forms-search-forward] - '("Search forward" . forms-search-forward)) + '("Search Forward" . forms-search-forward)) (define-key map [menu-bar forms menu-forms-delete-record] '("Delete" . forms-delete-record)) (define-key map [menu-bar forms menu-forms-insert-record] @@ -1294,19 +1324,19 @@ Commands: Equivalent keys in read-only mode: (define-key map [menu-bar forms menu-forms-sep2] '("----")) (define-key map [menu-bar forms menu-forms-last-record] - '("Last record" . forms-last-record)) + '("Last Record" . forms-last-record)) (define-key map [menu-bar forms menu-forms-first-record] - '("First record" . forms-first-record)) + '("First Record" . forms-first-record)) (define-key map [menu-bar forms menu-forms-prev-record] - '("Previous record" . forms-prev-record)) + '("Previous Record" . forms-prev-record)) (define-key map [menu-bar forms menu-forms-next-record] - '("Next record" . forms-next-record)) + '("Next Record" . forms-next-record)) (define-key map [menu-bar forms menu-forms-sep3] '("----")) (define-key map [menu-bar forms menu-forms-prev-field] - '("Previous field" . forms-prev-field)) + '("Previous Field" . forms-prev-field)) (define-key map [menu-bar forms menu-forms-next-field] - '("Next field" . forms-next-field)) + '("Next Field" . forms-next-field)) (put 'forms-insert-record 'menu-enable '(not forms-read-only)) (put 'forms-delete-record 'menu-enable '(not forms-read-only)) ) @@ -1320,19 +1350,19 @@ Commands: Equivalent keys in read-only mode: (define-key map [menu-bar forms menu-forms-edit-sep1] '("----")) (define-key map [menu-bar forms menu-forms-edit-save] - '("Save data" . forms-save-buffer)) + '("Save Data" . forms-save-buffer)) (define-key map [menu-bar forms menu-forms-edit-print] - '("Print data" . forms-print)) + '("Print Data" . forms-print)) (define-key map [menu-bar forms menu-forms-edit-describe] - '("Describe mode" . describe-mode)) + '("Describe Mode" . describe-mode)) (define-key map [menu-bar forms menu-forms-edit-toggle-ro] '("Toggle View/Edit" . forms-toggle-read-only)) (define-key map [menu-bar forms menu-forms-edit-jump-record] '("Jump" . forms-jump-record)) (define-key map [menu-bar forms menu-forms-edit-search-backward] - '("Search backward" . forms-search-backward)) + '("Search Backward" . forms-search-backward)) (define-key map [menu-bar forms menu-forms-edit-search-forward] - '("Search forward" . forms-search-forward)) + '("Search Forward" . forms-search-forward)) (define-key map [menu-bar forms menu-forms-edit-delete-record] '("Delete" . forms-delete-record)) (define-key map [menu-bar forms menu-forms-edit-insert-record] @@ -1340,26 +1370,26 @@ Commands: Equivalent keys in read-only mode: (define-key map [menu-bar forms menu-forms-edit-sep2] '("----")) (define-key map [menu-bar forms menu-forms-edit-last-record] - '("Last record" . forms-last-record)) + '("Last Record" . forms-last-record)) (define-key map [menu-bar forms menu-forms-edit-first-record] - '("First record" . forms-first-record)) + '("First Record" . forms-first-record)) (define-key map [menu-bar forms menu-forms-edit-prev-record] - '("Previous record" . forms-prev-record)) + '("Previous Record" . forms-prev-record)) (define-key map [menu-bar forms menu-forms-edit-next-record] - '("Next record" . forms-next-record)) + '("Next Record" . forms-next-record)) (define-key map [menu-bar forms menu-forms-edit-sep3] '("----")) (define-key map [menu-bar forms menu-forms-edit-prev-field] - '("Previous field" . forms-prev-field)) + '("Previous Field" . forms-prev-field)) (define-key map [menu-bar forms menu-forms-edit-next-field] - '("Next field" . forms-next-field)) + '("Next Field" . forms-next-field)) (put 'forms-insert-record 'menu-enable '(not forms-read-only)) (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) @@ -1377,23 +1407,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) @@ -1406,7 +1428,7 @@ Commands: Equivalent keys in read-only mode: (defun forms--help () "Initial help for Forms mode." - (message (substitute-command-keys (concat + (message "%s" (substitute-command-keys (concat "\\[forms-next-record]:next" " \\[forms-prev-record]:prev" " \\[forms-first-record]:first" @@ -1417,14 +1439,13 @@ Commands: Equivalent keys in read-only mode: "Translate in SUBJ all chars ARG into char REP. ARG and REP should be single-char strings." (let ((i 0) - (x (length subj)) (re (regexp-quote arg)) (k (string-to-char rep))) (while (setq i (string-match re subj i)) (aset subj i k) (setq i (1+ i))))) -(defun forms--exit (query &optional save) +(defun forms--exit (&optional save) "Internal exit from forms mode function." (let ((buf (buffer-name forms--file-buffer))) @@ -1432,15 +1453,12 @@ Commands: Equivalent keys in read-only mode: (if (and save (buffer-modified-p forms--file-buffer)) (forms-save-buffer)) - (save-excursion - (set-buffer forms--file-buffer) + (with-current-buffer forms--file-buffer (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))))) @@ -1454,7 +1472,7 @@ Commands: Equivalent keys in read-only mode: (let ((here (point))) (prog2 (end-of-line) - (buffer-substring here (point)) + (buffer-substring-no-properties here (point)) (goto-char here)))) (defun forms--show-record (the-record) @@ -1485,14 +1503,15 @@ Commands: Equivalent keys in read-only mode: ;; Verify the number of fields, extend forms--the-record-list if needed. (if (= (length forms--the-record-list) forms-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 (null forms-check-number-of-fields) + nil + (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)) ""))))) @@ -1505,13 +1524,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. @@ -1540,38 +1560,32 @@ 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)) + (error "Buffer is read-only")) - (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)) + (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!")) + (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)) + ;; 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)))))) + (with-current-buffer forms--file-buffer + ;; Use delete-region instead of kill-region, to avoid + ;; adding junk to the kill-ring. + (delete-region (line-beginning-position) (line-end-position)) + (insert the-record) + (beginning-of-line)))) (defun forms--checkmod () "Check if this form has been modified, and call forms--update if so." @@ -1601,15 +1615,15 @@ As a side effect: sets `forms--the-record-list'." (find-file-other-window fn) (or forms--mode-setup (forms-mode t)))) -(defun forms-exit (query) +(defun forms-exit () "Normal exit from Forms mode. Modified buffers are saved." - (interactive "P") - (forms--exit query t)) + (interactive) + (forms--exit t)) -(defun forms-exit-no-save (query) +(defun forms-exit-no-save () "Exit from Forms mode without saving buffers." - (interactive "P") - (forms--exit query nil)) + (interactive) + (forms--exit nil)) ;;; Navigating commands @@ -1623,6 +1637,16 @@ As a side effect: sets `forms--the-record-list'." (interactive "P") (forms-jump-record (- forms--current-record (prefix-numeric-value arg)) t)) +(defun forms--goto-record (rn &optional current) + "Goto record number RN. +If CURRENT is provided, it specifies the current record and can be used +to speed up access to RN. Returns the number of records missing, if any." + (if current + (forward-line (- rn current)) + ;; goto-line does not do what we want when the buffer is narrowed. + (goto-char (point-min)) + (forward-line (1- rn)))) + (defun forms-jump-record (arg &optional relative) "Jump to a random record." (interactive "NRecord number: ") @@ -1630,45 +1654,37 @@ 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 ((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 + (with-current-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). + (setq cur (- arg (forms--goto-record arg (if relative cur)))) - (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." @@ -1680,13 +1696,11 @@ 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 - (save-excursion - (set-buffer forms--file-buffer) + ((numrec + (with-current-buffer forms--file-buffer (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)) @@ -1696,7 +1710,7 @@ As a side effect: re-calculates the number of records in the data file." (defun forms-toggle-read-only (arg) "Toggles read-only mode of a forms mode buffer. With an argument, enables read-only mode if the argument is positive. -Otherwise enables edit mode if the visited file is writeable." +Otherwise enables edit mode if the visited file is writable." (interactive "P") @@ -1708,13 +1722,11 @@ Otherwise enables edit mode if the visited file is writeable." ;; Enable edit mode, if possible. (let ((ro forms-read-only)) - (if (save-excursion - (set-buffer forms--file-buffer) + (if (with-current-buffer forms--file-buffer 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 @@ -1738,16 +1750,22 @@ Otherwise enables edit mode if the visited file is writeable." (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, -it is called to fill (some of) the fields with default values." +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." (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 @@ -1764,13 +1782,12 @@ it is called to fill (some of) the fields with default values." the-list forms-field-sep)) - (save-excursion - (set-buffer forms--file-buffer) - (goto-line ln) + (with-current-buffer forms--file-buffer + (forms--goto-record ln) (open-line 1) (insert the-record) (beginning-of-line)) - + (setq forms--current-record ln)) (setq forms--total-records (1+ forms--total-records)) @@ -1787,9 +1804,8 @@ it is called to fill (some of) the fields with default values." (if (or arg (y-or-n-p "Really delete this record? ")) (let ((ln forms--current-record)) - (save-excursion - (set-buffer forms--file-buffer) - (goto-line ln) + (with-current-buffer forms--file-buffer + (forms--goto-record ln) ;; Use delete-region instead of kill-region, to avoid ;; adding junk to the kill-ring. (delete-region (progn (beginning-of-line) (point)) @@ -1802,8 +1818,8 @@ it is called to fill (some of) the fields with default values." (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 @@ -1813,29 +1829,31 @@ it is called to fill (some of) the fields with default values." (setq regexp forms--search-regexp)) (forms--checkmod) - (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 (concat "\"" regexp "\" not found.")) - nil) + (let (the-line the-record here) + (with-current-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 @@ -1845,39 +1863,60 @@ it is called to fill (some of) the fields with default values." (setq regexp forms--search-regexp)) (forms--checkmod) - (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 (concat "\"" regexp "\" not found.")) - nil) + (let (the-line the-record here) + (with-current-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)) - (save-excursion - (set-buffer forms--file-buffer) + (let ((write-file-filter forms-write-file-filter) + (read-file-filter forms-read-file-filter) + (cur forms--current-record)) + (with-current-buffer forms--file-buffer (let ((inhibit-read-only t)) + ;; Write file hooks are run via write-file-functions. + ;; (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) @@ -1948,21 +1987,20 @@ 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) (forms-jump-record nb-record) (setq record (buffer-string)) - (save-excursion - (set-buffer (get-buffer-create "*forms-print*")) + (with-current-buffer (get-buffer-create "*forms-print*") (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 - (set-buffer "*forms-print*") + (with-current-buffer "*forms-print*" (print-buffer) (set-buffer-modified-p nil) (kill-buffer (current-buffer))) @@ -1974,7 +2012,7 @@ Calls `forms-write-file-filter' before writing out the data." (defun forms-enumerate (the-fields) "Take a quoted list of symbols, and set their values to sequential numbers. The first symbol gets number 1, the second 2 and so on. -It returns the higest number. +It returns the highest number. Usage: (setq forms-number-of-fields (forms-enumerate @@ -2008,13 +2046,13 @@ 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*")) + (with-current-buffer (get-buffer-create "*forms-mode debug*") (if (zerop (buffer-size)) (emacs-lisp-mode)) (goto-char (point-max)) (insert ret))))) -;;; forms.el ends here. +;;; arch-tag: 4a6695c7-d47a-4a21-809b-5cec7f8ec7a1 +;;; forms.el ends here