;; 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 ===
;; 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
+;; 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:
;;
;;
;; - 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:
;; 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
;; 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
;; 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
;; contents of the buffer.
;;
;; Edit mode commands:
-;;
+;;
;; TAB forms-next-field
;; \C-c TAB forms-next-field
;; \C-c < forms-first-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
;; 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
(provide 'forms) ;;; official
(provide 'forms-mode) ;;; for compatibility
-(defconst forms-version (substring "$Revision: 2.43 $" 11 -2)
+(defconst forms-version (substring "$Revision: 2.44 $" 11 -2)
"The version number of forms-mode (as string). The complete RCS id is:
- $Id: forms.el,v 2.43 2002/05/18 08:04:49 pj Exp $")
+ $Id: forms.el,v 2.44 2003/01/12 20:47:48 schwab Exp $")
(defcustom forms-mode-hooks nil
"Hook run upon entering Forms mode."
(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.")
(defcustom forms-use-text-properties t
(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
(defvar forms--rw-face nil
"Face used to represent read-write data on the screen.")
\f
-;;;###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 TAB forms-next-field
C-c < forms-first-record <
C-c > forms-last-record >
C-c ? describe-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
;;(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)
;; Check if the mandatory variables make sense.
(or forms-file
- (error (concat "Forms control file error: "
+ (error (concat "Forms control file error: "
"`forms-file' has not been set")))
;; Check forms-field-sep first, since it can be needed to
(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: "
+ (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"))))
(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)
(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")
;; 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
(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
(setq prev-item el)))
;; Try numeric ...
- ((numberp el)
+ ((numberp el)
;; Validate range.
(if (or (<= el 0)
(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)))))
'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))))
;; 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)))
(let ((forms--marker 0)
(forms--dyntext 0))
- (setq
+ (setq
forms--format
- (if forms-use-text-properties
+ (if forms-use-text-properties
`(lambda (arg)
(let ((inhibit-read-only t))
,@(apply 'append
;; (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
;; (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))))
(cond
((stringp el)
-
- `((set-text-properties
+
+ `((set-text-properties
(point) ; start at point
(progn ; until after insertion
(insert ,el)
'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
+ (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
+ (set-text-properties
here (point)
(list 'face forms--rw-face
'front-sticky '(face)))))))
`((set-text-properties
(point)
(progn
- (insert (aset forms--dyntexts
+ (insert (aset forms--dyntexts
,(prog1 forms--dyntext
(setq forms--dyntext (1+ forms--dyntext)))
,el))
;; (insert (aset forms--dyntexts 0 (tocol 40)))
;; ... )
- (cond
+ (cond
((stringp el)
`((insert ,el)))
((numberp el)
(let (here)
(goto-char (point-min))
,@(apply 'append
- (mapcar
- 'forms--make-parser-elt
+ (mapcar
+ 'forms--make-parser-elt
(append forms-format-list (list nil)))))))))
(forms--debug 'forms--parser))
(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))
;; (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))
;; (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)))
(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)
(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 ()
(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 [S-tab] 'forms-prev-field)
(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))
"")))))
"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.
(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))
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)))))
(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."
(open-line 1)
(insert the-record)
(beginning-of-line))
-
+
(setq forms--current-record ln))
(setq forms--total-records (1+ forms--total-records))
(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
(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
(set-buffer forms--file-buffer)
(let ((inhibit-read-only t))
;; Write file hooks are run via local-write-file-hooks.
- ;; (if write-file-filter
- ;; (save-excursion
+ ;; (if write-file-filter
+ ;; (save-excursion
;; (run-hooks 'write-file-filter)))
;; If they have a write-file-filter, force the buffer to be
(setq ret (concat ret (prin1-to-string vel) "\n")))
(setq ret (concat ret "<unbound>" "\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*"))
HCoop / bpt / emacs.git / blobdiff