C Mode: Fix mis-fontification of macro invocation as function declaration
[emacs.git] / lisp / forms.el
blobb068352e6ebb23baac04548617a78fcdcfd9b516
1 ;;; forms.el --- Forms mode: edit a file as a form to fill in
3 ;; Copyright (C) 1991, 1994-1997, 2001-2016 Free Software Foundation,
4 ;; Inc.
6 ;; Author: Johan Vromans <jvromans@squirrel.nl>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Visit a file using a form. See etc/forms for examples.
27 ;; === Naming conventions
29 ;; The names of all variables and functions start with 'forms-'.
30 ;; Names which start with 'forms--' are intended for internal use, and
31 ;; should *NOT* be used from the outside.
33 ;; All variables are buffer-local, to enable multiple forms visits
34 ;; simultaneously.
35 ;; Variable `forms--mode-setup' is local to *ALL* buffers, for it
36 ;; controls if forms-mode has been enabled in a buffer.
38 ;; === How it works ===
40 ;; Forms mode means visiting a data file which is supposed to consist
41 ;; of records each containing a number of fields. The records are
42 ;; separated by a newline, the fields are separated by a user-defined
43 ;; field separator (default: TAB).
44 ;; When shown, a record is transferred to an Emacs buffer and
45 ;; presented using a user-defined form. One record is shown at a
46 ;; time.
48 ;; Forms mode is a composite mode. It involves two files, and two
49 ;; buffers.
50 ;; The first file, called the control file, defines the name of the
51 ;; data file and the forms format. This file buffer will be used to
52 ;; present the forms.
53 ;; The second file holds the actual data. The buffer of this file
54 ;; will be buried, for it is never accessed directly.
56 ;; Forms mode is invoked using M-x `forms-find-file' control-file.
57 ;; Alternatively `forms-find-file-other-window' can be used.
59 ;; You may also visit the control file, and switch to forms mode by hand
60 ;; with M-x `forms-mode'.
62 ;; Automatic mode switching is supported if you specify
63 ;; "-*- forms -*-" in the first line of the control file.
65 ;; The control file is visited, evaluated using `eval-buffer',
66 ;; and should set at least the following variables:
68 ;; forms-file [string]
69 ;; The name of the data file.
71 ;; forms-number-of-fields [integer]
72 ;; The number of fields in each record.
74 ;; forms-format-list [list]
75 ;; Formatting instructions.
77 ;; `forms-format-list' should be a list, each element containing
79 ;; - a string, e.g. "hello". The string is inserted in the forms
80 ;; "as is".
82 ;; - an integer, denoting a field number.
83 ;; The contents of this field are inserted at this point.
84 ;; Fields are numbered starting with number one.
86 ;; - a function call, e.g. (insert "text").
87 ;; This function call is dynamically evaluated and should return a
88 ;; string. It should *NOT* have side-effects on the forms being
89 ;; constructed. The current fields are available to the function
90 ;; in the variable `forms-fields', they should *NOT* be modified.
92 ;; - a lisp symbol, that must evaluate to one of the above.
94 ;; Optional variables which may be set in the control file:
96 ;; forms-field-sep [string, default TAB]
97 ;; The field separator used to separate the
98 ;; fields in the data file. It may be a string.
100 ;; forms-read-only [bool, default nil]
101 ;; Non-nil means that the data file is visited
102 ;; read-only (view mode) as opposed to edit mode.
103 ;; If no write access to the data file is
104 ;; possible, view mode is enforced.
106 ;; forms-check-number-of-fields [bool, default t]
107 ;; If non-nil, a warning will be issued whenever
108 ;; a record is found that does not have the number
109 ;; of fields specified by `forms-number-of-fields'.
111 ;; forms-multi-line [string, default "^K"]
112 ;; If non-null, the records of the data file may
113 ;; contain fields that can span multiple lines in
114 ;; the form.
115 ;; This variable denotes the separator string
116 ;; to be used for this purpose. Upon display, all
117 ;; occurrences of this string are translated
118 ;; to newlines. Upon storage they are translated
119 ;; back to the separator string.
121 ;; forms-forms-scroll [bool, default nil]
122 ;; Non-nil means: rebind locally the commands that
123 ;; perform `scroll-up' or `scroll-down' to use
124 ;; `forms-next-field' resp. `forms-prev-field'.
126 ;; forms-forms-jump [bool, default nil]
127 ;; Non-nil means: rebind locally the commands
128 ;; `beginning-of-buffer' and `end-of-buffer' to
129 ;; perform, respectively, `forms-first-record' and
130 ;; `forms-last-record' instead.
132 ;; forms-insert-after [bool, default nil]
133 ;; Non-nil means: insertions of new records go after
134 ;; current record, also initial position is at the
135 ;; last record. The default is to insert before the
136 ;; current record and the initial position is at the
137 ;; first record.
139 ;; forms-read-file-filter [symbol, default nil]
140 ;; If not nil: this should be the name of a
141 ;; function that is called after the forms data file
142 ;; has been read. It can be used to transform
143 ;; the contents of the file into a format more suitable
144 ;; for forms-mode processing.
146 ;; forms-write-file-filter [symbol, default nil]
147 ;; If not nil: this should be the name of a
148 ;; function that is called before the forms data file
149 ;; is written (saved) to disk. It can be used to undo
150 ;; the effects of `forms-read-file-filter', if any.
152 ;; forms-new-record-filter [symbol, default nil]
153 ;; If not nil: this should be the name of a
154 ;; function that is called when a new
155 ;; record is created. It can be used to fill in
156 ;; the new record with default fields, for example.
158 ;; forms-modified-record-filter [symbol, default nil]
159 ;; If not nil: this should be the name of a
160 ;; function that is called when a record has
161 ;; been modified. It is called after the fields
162 ;; are parsed. It can be used to register
163 ;; modification dates, for example.
165 ;; forms-use-text-properties [bool, see text for default]
166 ;; This variable controls if forms mode should use
167 ;; text properties to protect the form text from being
168 ;; modified (using text-property `read-only').
169 ;; Also, the read-write fields are shown using a
170 ;; distinct face, if possible.
171 ;; As of emacs 19.29, the `intangible' text property
172 ;; is used to prevent moving into read-only fields.
173 ;; This variable defaults to t if running Emacs 19 or
174 ;; later with text properties.
175 ;; The default face to show read-write fields is
176 ;; copied from face `region'.
178 ;; forms-ro-face [symbol, default 'default]
179 ;; This is the face that is used to show
180 ;; read-only text on the screen. If used, this
181 ;; variable should be set to a symbol that is a
182 ;; valid face.
183 ;; E.g.
184 ;; (make-face 'my-face)
185 ;; (setq forms-ro-face 'my-face)
187 ;; forms-rw-face [symbol, default 'region]
188 ;; This is the face that is used to show
189 ;; read-write text on the screen.
191 ;; After evaluating the control file, its buffer is cleared and used
192 ;; for further processing.
193 ;; The data file (as designated by `forms-file') is visited in a buffer
194 ;; `forms--file-buffer' which normally will not be shown.
195 ;; Great malfunctioning may be expected if this file/buffer is modified
196 ;; outside of this package while it is being visited!
198 ;; Normal operation is to transfer one line (record) from the data file,
199 ;; split it into fields (into `forms--the-record-list'), and display it
200 ;; using the specs in `forms-format-list'.
201 ;; A format routine `forms--format' is built upon startup to format
202 ;; the records according to `forms-format-list'.
204 ;; When a form is changed the record is updated as soon as this form
205 ;; is left. The contents of the form are parsed using information
206 ;; obtained from `forms-format-list', and the fields which are
207 ;; deduced from the form are modified. Fields not shown on the forms
208 ;; retain their original values. The newly formed record then
209 ;; replaces the contents of the old record in `forms--file-buffer'.
210 ;; A parse routine `forms--parser' is built upon startup to parse
211 ;; the records.
213 ;; Two exit functions exist: `forms-exit' and `forms-exit-no-save'.
214 ;; `forms-exit' saves the data to the file, if modified.
215 ;; `forms-exit-no-save' does not. However, if `forms-exit-no-save'
216 ;; is executed and the file buffer has been modified, Emacs will ask
217 ;; questions anyway.
219 ;; Other functions provided by forms mode are:
221 ;; paging (forward, backward) by record
222 ;; jumping (first, last, random number)
223 ;; searching
224 ;; creating and deleting records
225 ;; reverting the form (NOT the file buffer)
226 ;; switching edit <-> view mode v.v.
227 ;; jumping from field to field
229 ;; As a documented side-effect: jumping to the last record in the
230 ;; file (using forms-last-record) will adjust forms--total-records if
231 ;; needed.
233 ;; The forms buffer can be in one of two modes: edit mode or view
234 ;; mode. View mode is a read-only mode, whereby you cannot modify the
235 ;; contents of the buffer.
237 ;; Edit mode commands:
239 ;; TAB forms-next-field
240 ;; \C-c TAB forms-next-field
241 ;; \C-c < forms-first-record
242 ;; \C-c > forms-last-record
243 ;; \C-c ? describe-mode
244 ;; \C-c \C-k forms-delete-record
245 ;; \C-c \C-q forms-toggle-read-only
246 ;; \C-c \C-o forms-insert-record
247 ;; \C-c \C-l forms-jump-record
248 ;; \C-c \C-n forms-next-record
249 ;; \C-c \C-p forms-prev-record
250 ;; \C-c \C-r forms-search-backward
251 ;; \C-c \C-s forms-search-forward
252 ;; \C-c \C-x forms-exit
254 ;; Read-only mode commands:
256 ;; SPC forms-next-record
257 ;; DEL forms-prev-record
258 ;; ? describe-mode
259 ;; \C-q forms-toggle-read-only
260 ;; l forms-jump-record
261 ;; n forms-next-record
262 ;; p forms-prev-record
263 ;; r forms-search-backward
264 ;; s forms-search-forward
265 ;; x forms-exit
267 ;; Of course, it is also possible to use the \C-c prefix to obtain the
268 ;; same command keys as in edit mode.
270 ;; The following bindings are available, independent of the mode:
272 ;; [next] forms-next-record
273 ;; [prior] forms-prev-record
274 ;; [begin] forms-first-record
275 ;; [end] forms-last-record
276 ;; [S-TAB] forms-prev-field
277 ;; [backtab] forms-prev-field
279 ;; For convenience, TAB is always bound to `forms-next-field', so you
280 ;; don't need the C-c prefix for this command.
282 ;; As mentioned above (see `forms-forms-scroll' and `forms-forms-jump'),
283 ;; the bindings of standard functions `scroll-up', `scroll-down',
284 ;; `beginning-of-buffer' and `end-of-buffer' can be locally replaced with
285 ;; forms mode functions next/prev record and first/last
286 ;; record.
288 ;; `write-file-functions' is defined to save the actual data file
289 ;; instead of the buffer data, `revert-file-hook' is defined to
290 ;; revert a forms to original.
292 ;;; Code:
294 (defgroup forms nil
295 "Edit a file as a form to fill in."
296 :group 'data)
298 ;;; Global variables and constants:
300 (defcustom forms-mode-hook nil
301 "Hook run upon entering Forms mode."
302 :group 'forms
303 :type 'hook)
305 ;;; Mandatory variables - must be set by evaluating the control file.
307 (defvar forms-file nil
308 "Name of the file holding the data.")
310 (defvar forms-format-list nil
311 "List of formatting specifications.")
313 (defvar forms-number-of-fields nil
314 "Number of fields per record.")
316 ;;; Optional variables with default values.
318 (defcustom forms-check-number-of-fields t
319 "If non-nil, warn about records with wrong number of fields."
320 :group 'forms
321 :type 'boolean)
323 (defvar forms-field-sep "\t"
324 "Field separator character (default TAB).")
326 (defvar forms-read-only nil
327 "Non-nil means: visit the file in view (read-only) mode.
328 This is set automatically if the file permissions don't let you write it.")
330 (defvar forms-multi-line "\C-k" "\
331 If not nil: use this character to separate multi-line fields (default C-k).")
333 (defcustom forms-forms-scroll nil
334 "Non-nil means replace scroll-up/down commands in Forms mode.
335 The replacement commands performs forms-next/prev-record."
336 :group 'forms
337 :type 'boolean)
339 (defcustom forms-forms-jump nil
340 "Non-nil means redefine beginning/end-of-buffer in Forms mode.
341 The replacement commands performs forms-first/last-record."
342 :group 'forms
343 :type 'boolean)
345 (defvar forms-read-file-filter nil
346 "The name of a function that is called after reading the data file.
347 This can be used to change the contents of the file to something more
348 suitable for forms processing.")
350 (defvar forms-write-file-filter nil
351 "The name of a function that is called before writing the data file.
352 This can be used to undo the effects of `form-read-file-hook'.")
354 (defvar forms-new-record-filter nil
355 "The name of a function that is called when a new record is created.")
357 (defvar forms-modified-record-filter nil
358 "The name of a function that is called when a record has been modified.")
360 (defvar forms-fields nil
361 "List with fields of the current forms. First field has number 1.
362 This variable is for use by the filter routines only.
363 The contents may NOT be modified.")
365 (defcustom forms-use-text-properties t
366 "Non-nil means: use text properties.
367 Defaults to t if this Emacs is capable of handling text properties."
368 :group 'forms
369 :type 'boolean)
371 (defcustom forms-insert-after nil
372 "Non-nil means: inserts of new records go after current record.
373 Also, initial position is at last record."
374 :group 'forms
375 :type 'boolean)
377 (defcustom forms-ro-face 'default
378 "The face (a symbol) that is used to display read-only text on the screen."
379 :group 'forms
380 :type 'face)
382 (defcustom forms-rw-face 'region
383 "The face (a symbol) that is used to display read-write text on the screen."
384 :group 'forms
385 :type 'face)
387 ;;; Internal variables.
389 (defvar forms--file-buffer nil
390 "Buffer which holds the file data")
392 (defvar forms--total-records 0
393 "Total number of records in the data file.")
395 (defvar forms--current-record 0
396 "Number of the record currently on the screen.")
398 (defvar forms-mode-map nil
399 "Keymap for form buffer.")
400 (defvar forms-mode-ro-map nil
401 "Keymap for form buffer in view mode.")
402 (defvar forms-mode-edit-map nil
403 "Keymap for form buffer in edit mode.")
405 (defvar forms--markers nil
406 "Field markers in the screen.")
408 (defvar forms--dyntexts nil
409 "Dynamic texts (resulting from function calls) on the screen.")
411 (defvar forms--the-record-list nil
412 "List of strings of the current record, as parsed from the file.")
414 (defvar forms--search-regexp nil
415 "Last regexp used by forms-search functions.")
417 (defvar forms--format nil
418 "Formatting routine.")
420 (defvar forms--parser nil
421 "Forms parser routine.")
423 (defvar forms--mode-setup nil
424 "To keep track of forms-mode being set-up.")
425 (make-variable-buffer-local 'forms--mode-setup)
427 (defvar forms--dynamic-text nil
428 "Array that holds dynamic texts to insert between fields.")
430 (defvar forms--elements nil
431 "Array with the order in which the fields are displayed.")
433 (defvar forms--ro-face nil
434 "Face used to represent read-only data on the screen.")
436 (defvar forms--rw-face nil
437 "Face used to represent read-write data on the screen.")
439 (defvar read-file-filter) ; bound in forms--intuit-from-file
441 ;;;###autoload
442 (defun forms-mode (&optional primary)
443 ;; FIXME: use define-derived-mode
444 "Major mode to visit files in a field-structured manner using a form.
446 Commands: Equivalent keys in read-only mode:
447 TAB forms-next-field TAB
448 C-c TAB forms-next-field
449 C-c < forms-first-record <
450 C-c > forms-last-record >
451 C-c ? describe-mode ?
452 C-c C-k forms-delete-record
453 C-c C-q forms-toggle-read-only q
454 C-c C-o forms-insert-record
455 C-c C-l forms-jump-record l
456 C-c C-n forms-next-record n
457 C-c C-p forms-prev-record p
458 C-c C-r forms-search-reverse r
459 C-c C-s forms-search-forward s
460 C-c C-x forms-exit x
462 (interactive)
464 ;; This is not a simple major mode, as usual. Therefore, forms-mode
465 ;; takes an optional argument `primary' which is used for the
466 ;; initial set-up. Normal use would leave `primary' to nil.
467 ;; A global buffer-local variable `forms--mode-setup' has the same
468 ;; effect but makes it possible to auto-invoke forms-mode using
469 ;; `find-file'.
470 ;; Note: although it seems logical to have `make-local-variable'
471 ;; executed where the variable is first needed, I have deliberately
472 ;; placed all calls in this function.
474 ;; Primary set-up: evaluate buffer and check if the mandatory
475 ;; variables have been set.
476 (if (or primary (not forms--mode-setup))
477 (progn
478 ;;(message "forms: setting up...")
479 (kill-all-local-variables)
481 ;; Make mandatory variables.
482 (make-local-variable 'forms-file)
483 (make-local-variable 'forms-number-of-fields)
484 (make-local-variable 'forms-format-list)
486 ;; Make optional variables.
487 (make-local-variable 'forms-field-sep)
488 (make-local-variable 'forms-read-only)
489 (make-local-variable 'forms-multi-line)
490 (make-local-variable 'forms-forms-scroll)
491 (make-local-variable 'forms-forms-jump)
492 (make-local-variable 'forms-insert-after)
493 (make-local-variable 'forms-use-text-properties)
495 ;; Filter functions.
496 (make-local-variable 'forms-read-file-filter)
497 (make-local-variable 'forms-write-file-filter)
498 (make-local-variable 'forms-new-record-filter)
499 (make-local-variable 'forms-modified-record-filter)
501 ;; Make sure no filters exist.
502 (setq forms-read-file-filter nil)
503 (setq forms-write-file-filter nil)
504 (setq forms-new-record-filter nil)
505 (setq forms-modified-record-filter nil)
507 ;; If running Emacs 19 under X, setup faces to show read-only and
508 ;; read-write fields.
509 (if (fboundp 'make-face)
510 (progn
511 (make-local-variable 'forms-ro-face)
512 (make-local-variable 'forms-rw-face)))
514 ;; eval the buffer, should set variables
515 ;;(message "forms: processing control file...")
516 ;; If enable-local-eval is not set to t the user is asked first.
517 (if (or (eq enable-local-eval t)
518 (yes-or-no-p
519 (concat "Evaluate lisp code in buffer "
520 (buffer-name) " to display forms? ")))
521 (eval-buffer)
522 (error "`enable-local-eval' inhibits buffer evaluation"))
524 ;; Check if the mandatory variables make sense.
525 (or forms-file
526 (error (concat "Forms control file error: "
527 "`forms-file' has not been set")))
529 ;; Check forms-field-sep first, since it can be needed to
530 ;; construct a default format list.
531 (or (stringp forms-field-sep)
532 (error (concat "Forms control file error: "
533 "`forms-field-sep' is not a string")))
535 (if forms-number-of-fields
536 (or (and (numberp forms-number-of-fields)
537 (> forms-number-of-fields 0))
538 (error (concat "Forms control file error: "
539 "`forms-number-of-fields' must be a number > 0")))
540 (or (null forms-format-list)
541 (error (concat "Forms control file error: "
542 "`forms-number-of-fields' has not been set"))))
544 (or forms-format-list
545 (forms--intuit-from-file))
547 (if forms-multi-line
548 (if (and (stringp forms-multi-line)
549 (eq (length forms-multi-line) 1))
550 (if (string= forms-multi-line forms-field-sep)
551 (error (concat "Forms control file error: "
552 "`forms-multi-line' is equal to `forms-field-sep'")))
553 (error (concat "Forms control file error: "
554 "`forms-multi-line' must be nil or a one-character string"))))
555 (or (fboundp 'set-text-properties)
556 (setq forms-use-text-properties nil))
558 ;; Validate and process forms-format-list.
559 ;;(message "forms: pre-processing format list...")
560 (make-local-variable 'forms--elements)
561 (forms--process-format-list)
563 ;; Build the formatter and parser.
564 ;;(message "forms: building formatter...")
565 (make-local-variable 'forms--format)
566 (make-local-variable 'forms--markers)
567 (make-local-variable 'forms--dyntexts)
568 ;;(message "forms: building parser...")
569 (forms--make-format)
570 (make-local-variable 'forms--parser)
571 (forms--make-parser)
572 ;;(message "forms: building parser... done.")
574 ;; Check if record filters are defined.
575 (if (and forms-new-record-filter
576 (not (fboundp forms-new-record-filter)))
577 (error (concat "Forms control file error: "
578 "`forms-new-record-filter' is not a function")))
580 (if (and forms-modified-record-filter
581 (not (fboundp forms-modified-record-filter)))
582 (error (concat "Forms control file error: "
583 "`forms-modified-record-filter' is not a function")))
585 ;; The filters access the contents of the forms using `forms-fields'.
586 (make-local-variable 'forms-fields)
588 ;; Dynamic text support.
589 (make-local-variable 'forms--dynamic-text)
591 ;; Prevent accidental overwrite of the control file and auto-save.
592 ;; We bind change-major-mode-with-file-name to nil to prevent
593 ;; set-visited-file-name from calling set-auto-mode, which
594 ;; might kill all local variables and set forms-file nil,
595 ;; which will then barf in find-file-noselect below. This can
596 ;; happen when the user sets the default major mode that is
597 ;; different from the Fundamental mode.
598 (let (change-major-mode-with-file-name)
599 (set-visited-file-name nil))
601 ;; Prepare this buffer for further processing.
602 (setq buffer-read-only nil)
603 (erase-buffer)
605 ;;(message "forms: setting up... done.")
608 ;; initialization done
609 (setq forms--mode-setup t)
611 ;; Copy desired faces to the actual variables used by the forms formatter.
612 (if (fboundp 'make-face)
613 (progn
614 (make-local-variable 'forms--ro-face)
615 (make-local-variable 'forms--rw-face)
616 (if forms-read-only
617 (progn
618 (setq forms--ro-face forms-ro-face)
619 (setq forms--rw-face forms-ro-face))
620 (setq forms--ro-face forms-ro-face)
621 (setq forms--rw-face forms-rw-face))))
623 ;; Make more local variables.
624 (make-local-variable 'forms--file-buffer)
625 (make-local-variable 'forms--total-records)
626 (make-local-variable 'forms--current-record)
627 (make-local-variable 'forms--the-record-list)
628 (make-local-variable 'forms--search-regexp)
630 ; The keymaps are global, so multiple forms mode buffers can share them.
631 ;(make-local-variable 'forms-mode-map)
632 ;(make-local-variable 'forms-mode-ro-map)
633 ;(make-local-variable 'forms-mode-edit-map)
634 (if forms-mode-map ; already defined
636 ;;(message "forms: building keymap...")
637 (forms--mode-commands)
638 ;;(message "forms: building keymap... done.")
641 ;; set the major mode indicator
642 (setq major-mode 'forms-mode)
643 (setq mode-name "Forms")
645 (cursor-intangible-mode 1)
647 ;; find the data file
648 (setq forms--file-buffer (find-file-noselect forms-file))
650 ;; Pre-transform.
651 (let ((read-file-filter forms-read-file-filter)
652 (write-file-filter forms-write-file-filter))
653 (if read-file-filter
654 (with-current-buffer forms--file-buffer
655 (let ((inhibit-read-only t)
656 (file-modified (buffer-modified-p)))
657 (mapc #'funcall read-file-filter)
658 (if (not file-modified) (set-buffer-modified-p nil)))
659 (if write-file-filter
660 (add-hook 'write-file-functions write-file-filter nil t)))
661 (if write-file-filter
662 (with-current-buffer forms--file-buffer
663 (add-hook 'write-file-functions write-file-filter nil t)))))
665 ;; count the number of records, and set see if it may be modified
666 (let (ro)
667 (setq forms--total-records
668 (with-current-buffer forms--file-buffer
669 (prog1
670 (progn
671 ;;(message "forms: counting records...")
672 (bury-buffer (current-buffer))
673 (setq ro buffer-read-only)
674 (count-lines (point-min) (point-max)))
675 ;;(message "forms: counting records... done.")
677 (if ro
678 (setq forms-read-only t)))
680 ;;(message "forms: proceeding setup...")
682 ;; Since we aren't really implementing a minor mode, we hack the mode line
683 ;; directly to get the text " View " into forms-read-only form buffers. For
684 ;; that reason, this variable must be buffer only.
685 (make-local-variable 'minor-mode-alist)
686 (setq minor-mode-alist (list (list 'forms-read-only " View")))
688 ;;(message "forms: proceeding setup (keymaps)...")
689 (forms--set-keymaps)
690 ;;(message "forms: proceeding setup (commands)...")
691 (forms--change-commands)
693 ;;(message "forms: proceeding setup (buffer)...")
694 (set-buffer-modified-p nil)
696 (if (= forms--total-records 0)
697 ;;(message "forms: proceeding setup (new file)...")
698 (progn
699 (insert
700 "GNU Emacs Forms Mode\n\n"
701 (if (file-exists-p forms-file)
702 (format-message
703 "No records available in file `%s'\n\n" forms-file)
704 (format-message
705 "Creating new file `%s'\nwith %d field%s per record\n\n"
706 forms-file forms-number-of-fields
707 (if (= 1 forms-number-of-fields) "" "s")))
708 "Use " (substitute-command-keys "\\[forms-insert-record]")
709 " to create new records.\n")
710 (setq forms--current-record 1)
711 (setq buffer-read-only t)
712 (set-buffer-modified-p nil))
714 ;; setup the first (or current) record to show
715 (if (< forms--current-record 1)
716 (setq forms--current-record 1))
717 (forms-jump-record forms--current-record)
719 (if forms-insert-after
720 (forms-last-record)
721 (forms-first-record))
724 ;; user customizing
725 ;;(message "forms: proceeding setup (user hooks)...")
726 (run-mode-hooks 'forms-mode-hook 'forms-mode-hooks)
727 ;;(message "forms: setting up... done.")
729 ;; be helpful
730 (forms--help)
733 (defun forms--process-format-list ()
734 ;; Validate `forms-format-list' and set some global variables.
735 ;; Symbols in the list are evaluated, and consecutive strings are
736 ;; concatenated.
737 ;; Array `forms--elements' is constructed that contains the order
738 ;; of the fields on the display. This array is used by
739 ;; `forms--parser-using-text-properties' to extract the fields data
740 ;; from the form on the screen.
741 ;; Upon completion, `forms-format-list' is guaranteed correct, so
742 ;; `forms--make-format' and `forms--make-parser' do not need to perform
743 ;; any checks.
745 ;; Verify that `forms-format-list' is not nil.
746 (or forms-format-list
747 (error (concat "Forms control file error: "
748 "`forms-format-list' has not been set")))
749 ;; It must be a list.
750 (or (listp forms-format-list)
751 (error (concat "Forms control file error: "
752 "`forms-format-list' is not a list")))
754 ;; Assume every field is painted once.
755 ;; `forms--elements' will grow if needed.
756 (setq forms--elements (make-vector forms-number-of-fields nil))
758 (let ((the-list forms-format-list) ; the list of format elements
759 (prev-item nil)
760 (field-num 0)) ; highest field number
762 (setq forms-format-list nil) ; gonna rebuild
764 (while the-list
766 (let ((el (car-safe the-list))
767 (rem (cdr-safe the-list)))
769 ;; If it is a symbol, eval it first.
770 (if (and (symbolp el)
771 (boundp el))
772 (setq el (eval el)))
774 (cond
776 ;; Try string ...
777 ((stringp el)
778 (if (stringp prev-item) ; try to concatenate strings
779 (setq prev-item (concat prev-item el))
780 (if prev-item
781 (setq forms-format-list
782 (append forms-format-list (list prev-item) nil)))
783 (setq prev-item el)))
785 ;; Try numeric ...
786 ((numberp el)
788 ;; Validate range.
789 (if (or (<= el 0)
790 (> el forms-number-of-fields))
791 (error (concat "Forms format error: "
792 "field number %d out of range 1..%d")
793 el forms-number-of-fields))
795 ;; Store forms order.
796 (if (>= field-num (length forms--elements))
797 (setq forms--elements (vconcat forms--elements (1- el)))
798 (aset forms--elements field-num (1- el)))
799 (setq field-num (1+ field-num))
801 (if prev-item
802 (setq forms-format-list
803 (append forms-format-list (list prev-item) nil)))
804 (setq prev-item el))
806 ;; Try function ...
807 ((listp el)
809 ;; Validate.
810 (or (fboundp (car-safe el))
811 (error (concat "Forms format error: "
812 "%S is not a function")
813 (car-safe el)))
815 ;; Shift.
816 (if prev-item
817 (setq forms-format-list
818 (append forms-format-list (list prev-item) nil)))
819 (setq prev-item el))
821 ;; else
823 (error (concat "Forms format error: "
824 "invalid element %S")
825 el)))
827 ;; Advance to next element of the list.
828 (setq the-list rem)))
830 ;; Append last item.
831 (if prev-item
832 (progn
833 (setq forms-format-list
834 (append forms-format-list (list prev-item) nil))
835 ;; Append a newline if the last item is a field.
836 ;; This prevents parsing problems.
837 ;; Also it makes it possible to insert an empty last field.
838 (if (numberp prev-item)
839 (setq forms-format-list
840 (append forms-format-list (list "\n") nil))))))
842 (forms--debug 'forms-format-list
843 'forms--elements))
845 ;; Special treatment for read-only segments.
847 ;; If text is inserted between two read-only segments, there seems to
848 ;; be no way to give the newly inserted text the RW face.
849 ;; To solve this, read-only segments get the `insert-in-front-hooks'
850 ;; property set with a function that temporarily switches the
851 ;; properties of the first character of the segment to the RW face, so
852 ;; the new text gets the right face. The `post-command-hook' is
853 ;; used to restore the original properties.
855 (defvar forms--iif-start nil
856 "Record start of modification command.")
857 (defvar forms--iif-properties nil
858 "Original properties of the character being overridden.")
860 (defun forms--iif-hook (_begin _end)
861 "`insert-in-front-hooks' function for read-only segments."
863 ;; Note start location. By making it a marker that points one
864 ;; character beyond the actual location, it is guaranteed to move
865 ;; correctly if text is inserted.
866 (or forms--iif-start
867 (setq forms--iif-start (copy-marker (1+ (point)))))
869 ;; Check if there is special treatment required.
870 (if (or (<= forms--iif-start 2)
871 (get-text-property (- forms--iif-start 2)
872 'read-only))
873 (progn
874 ;; Fetch current properties.
875 (setq forms--iif-properties
876 (text-properties-at (1- forms--iif-start)))
878 ;; Replace them.
879 (let ((inhibit-read-only t))
880 (set-text-properties
881 (1- forms--iif-start) forms--iif-start
882 (list 'face forms--rw-face 'front-sticky '(face))))
884 ;; Enable `post-command-hook' to restore the properties.
885 (setq post-command-hook
886 (append (list 'forms--iif-post-command-hook) post-command-hook)))
888 ;; No action needed. Clear marker.
889 (setq forms--iif-start nil)))
891 (defun forms--iif-post-command-hook ()
892 "`post-command-hook' function for read-only segments."
894 ;; Disable `post-command-hook'.
895 (setq post-command-hook
896 (delq 'forms--iif-hook-post-command-hook post-command-hook))
898 ;; Restore properties.
899 (if forms--iif-start
900 (let ((inhibit-read-only t))
901 (set-text-properties
902 (1- forms--iif-start) forms--iif-start
903 forms--iif-properties)))
905 ;; Cleanup.
906 (setq forms--iif-start nil))
908 (defvar forms--marker)
909 (defvar forms--dyntext)
911 (defun forms--make-format ()
912 "Generate `forms--format' using the information in `forms-format-list'."
914 ;; The real work is done using a mapcar of `forms--make-format-elt' on
915 ;; `forms-format-list'.
916 ;; This function sets up the necessary environment, and decides
917 ;; which function to mapcar.
919 (let ((forms--marker 0)
920 (forms--dyntext 0))
921 (setq
922 forms--format
923 (if forms-use-text-properties
924 `(lambda (arg)
925 (let ((inhibit-read-only t))
926 ,@(apply 'append
927 (mapcar #'forms--make-format-elt-using-text-properties
928 forms-format-list))
929 ;; Prevent insertion before the first text.
930 ,@(if (numberp (car forms-format-list))
932 '((add-text-properties (point-min) (1+ (point-min))
933 '(front-sticky (read-only cursor-intangible)))))
934 ;; Prevent insertion after the last text.
935 (remove-text-properties (1- (point)) (point)
936 '(rear-nonsticky)))
937 (setq forms--iif-start nil))
938 `(lambda (arg)
939 ,@(apply 'append
940 (mapcar #'forms--make-format-elt forms-format-list)))))
942 ;; We have tallied the number of markers and dynamic texts,
943 ;; so we can allocate the arrays now.
944 (setq forms--markers (make-vector forms--marker nil))
945 (setq forms--dyntexts (make-vector forms--dyntext nil)))
946 (forms--debug 'forms--format))
948 (defun forms--make-format-elt-using-text-properties (el)
949 "Helper routine to generate format function."
951 ;; The format routine `forms--format' will look like
953 ;; ;; preamble
954 ;; (lambda (arg)
955 ;; (let ((inhibit-read-only t))
957 ;; ;; A string, e.g. "text: ".
958 ;; (set-text-properties
959 ;; (point)
960 ;; (progn (insert "text: ") (point))
961 ;; (list 'face forms--ro-face
962 ;; 'read-only 1
963 ;; 'insert-in-front-hooks 'forms--iif-hook
964 ;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
966 ;; ;; A field, e.g. 6.
967 ;; (let ((here (point)))
968 ;; (aset forms--markers 0 (point-marker))
969 ;; (insert (elt arg 5))
970 ;; (or (= (point) here)
971 ;; (set-text-properties
972 ;; here (point)
973 ;; (list 'face forms--rw-face
974 ;; 'front-sticky '(face))))
976 ;; ;; Another string, e.g. "\nmore text: ".
977 ;; (set-text-properties
978 ;; (point)
979 ;; (progn (insert "\nmore text: ") (point))
980 ;; (list 'face forms--ro-face
981 ;; 'read-only 2
982 ;; 'insert-in-front-hooks 'forms--iif-hook
983 ;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
985 ;; ;; A function, e.g. (tocol 40).
986 ;; (set-text-properties
987 ;; (point)
988 ;; (progn
989 ;; (insert (aset forms--dyntexts 0 (tocol 40)))
990 ;; (point))
991 ;; (list 'face forms--ro-face
992 ;; 'read-only 2
993 ;; 'insert-in-front-hooks 'forms--iif-hook
994 ;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
996 ;; ;; Prevent insertion before the first text.
997 ;; (add-text-properties (point-min) (1+ (point-min))
998 ;; '(front-sticky (read-only))))))
999 ;; ;; Prevent insertion after the last text.
1000 ;; (remove-text-properties (1- (point)) (point)
1001 ;; '(rear-nonsticky)))
1003 ;; ;; wrap up
1004 ;; (setq forms--iif-start nil)
1005 ;; ))
1007 (cond
1008 ((stringp el)
1010 `((set-text-properties
1011 (point) ; start at point
1012 (progn ; until after insertion
1013 (insert ,el)
1014 (point))
1015 (list 'face forms--ro-face ; read-only appearance
1016 'read-only ,@(list (1+ forms--marker))
1017 'cursor-intangible ,@(list (1+ forms--marker))
1018 'insert-in-front-hooks '(forms--iif-hook)
1019 'rear-nonsticky '(face read-only insert-in-front-hooks
1020 cursor-intangible)))))
1022 ((numberp el)
1023 `((let ((here (point)))
1024 (aset forms--markers
1025 ,(prog1 forms--marker
1026 (setq forms--marker (1+ forms--marker)))
1027 (point-marker))
1028 (insert (elt arg ,(1- el)))
1029 (or (= (point) here)
1030 (set-text-properties
1031 here (point)
1032 (list 'face forms--rw-face
1033 'front-sticky '(face)))))))
1035 ((listp el)
1036 `((set-text-properties
1037 (point)
1038 (progn
1039 (insert (aset forms--dyntexts
1040 ,(prog1 forms--dyntext
1041 (setq forms--dyntext (1+ forms--dyntext)))
1042 ,el))
1043 (point))
1044 (list 'face forms--ro-face
1045 'read-only ,@(list (1+ forms--marker))
1046 'cursor-intangible ,@(list (1+ forms--marker))
1047 'insert-in-front-hooks '(forms--iif-hook)
1048 'rear-nonsticky '(read-only face insert-in-front-hooks
1049 cursor-intangible)))))
1051 ;; end of cond
1054 (defun forms--make-format-elt (el)
1055 "Helper routine to generate format function."
1057 ;; If we're not using text properties, the format routine
1058 ;; `forms--format' will look like
1060 ;; (lambda (arg)
1061 ;; ;; a string, e.g. "text: "
1062 ;; (insert "text: ")
1063 ;; ;; a field, e.g. 6
1064 ;; (aset forms--markers 0 (point-marker))
1065 ;; (insert (elt arg 5))
1066 ;; ;; another string, e.g. "\nmore text: "
1067 ;; (insert "\nmore text: ")
1068 ;; ;; a function, e.g. (tocol 40)
1069 ;; (insert (aset forms--dyntexts 0 (tocol 40)))
1070 ;; ... )
1072 (cond
1073 ((stringp el)
1074 `((insert ,el)))
1075 ((numberp el)
1076 (prog1
1077 `((aset forms--markers ,forms--marker (point-marker))
1078 (insert (elt arg ,(1- el))))
1079 (setq forms--marker (1+ forms--marker))))
1080 ((listp el)
1081 (prog1
1082 `((insert (aset forms--dyntexts ,forms--dyntext ,el)))
1083 (setq forms--dyntext (1+ forms--dyntext))))))
1085 (defvar forms--field)
1086 (defvar forms--recordv)
1087 (defvar forms--seen-text)
1089 (defun forms--make-parser ()
1090 "Generate `forms--parser' from the information in `forms-format-list'."
1092 ;; If we can use text properties, we simply set it to
1093 ;; `forms--parser-using-text-properties'.
1094 ;; Otherwise, the function is constructed using a mapcar of
1095 ;; `forms--make-parser-elt on `forms-format-list'.
1097 (setq
1098 forms--parser
1099 (if forms-use-text-properties
1100 (function forms--parser-using-text-properties)
1101 (let ((forms--field nil)
1102 (forms--seen-text nil)
1103 (forms--dyntext 0))
1105 ;; Note: we add a nil element to the list passed to `mapcar',
1106 ;; see `forms--make-parser-elt' for details.
1107 `(lambda nil
1108 (let (here)
1109 (goto-char (point-min))
1110 ,@(apply 'append
1111 (mapcar
1112 #'forms--make-parser-elt
1113 (append forms-format-list (list nil)))))))))
1115 (forms--debug 'forms--parser))
1117 (defun forms--parser-using-text-properties ()
1118 "Extract field info from forms when using text properties."
1120 ;; Using text properties, we can simply jump to the markers, and
1121 ;; extract the information up to the following read-only segment.
1123 (let ((i 0)
1124 here there)
1125 (while (< i (length forms--markers))
1126 (goto-char (setq here (aref forms--markers i)))
1127 (if (get-text-property here 'read-only)
1128 (aset forms--recordv (aref forms--elements i) nil)
1129 (if (setq there
1130 (next-single-property-change here 'read-only))
1131 (aset forms--recordv (aref forms--elements i)
1132 (buffer-substring-no-properties here there))
1133 (aset forms--recordv (aref forms--elements i)
1134 (buffer-substring-no-properties here (point-max)))))
1135 (setq i (1+ i)))))
1137 (defun forms--make-parser-elt (el)
1138 "Helper routine to generate forms parser function."
1140 ;; The parse routine will look like:
1142 ;; (lambda nil
1143 ;; (let (here)
1144 ;; (goto-char (point-min))
1146 ;; ;; "text: "
1147 ;; (if (not (looking-at "text: "))
1148 ;; (error "Parse error: cannot find \"text: \""))
1149 ;; (forward-char 6) ; past "text: "
1151 ;; ;; 6
1152 ;; ;; "\nmore text: "
1153 ;; (setq here (point))
1154 ;; (if (not (search-forward "\nmore text: " nil t nil))
1155 ;; (error "Parse error: cannot find \"\\nmore text: \""))
1156 ;; (aset forms--recordv 5 (buffer-substring-no-properties here (- (point) 12)))
1158 ;; ;; (tocol 40)
1159 ;; (let ((forms--dyntext (car-safe forms--dynamic-text)))
1160 ;; (if (not (looking-at (regexp-quote forms--dyntext)))
1161 ;; (error "Parse error: not looking at \"%s\"" forms--dyntext))
1162 ;; (forward-char (length forms--dyntext))
1163 ;; (setq forms--dynamic-text (cdr-safe forms--dynamic-text)))
1164 ;; ...
1165 ;; ;; final flush (due to terminator sentinel, see below)
1166 ;; (aset forms--recordv 7 (buffer-substring-no-properties (point) (point-max)))
1168 (cond
1169 ((stringp el)
1170 (prog1
1171 (if forms--field
1172 `((setq here (point))
1173 (if (not (search-forward ,el nil t nil))
1174 (error "Parse error: cannot find `%s'" ,el))
1175 (aset forms--recordv ,(1- forms--field)
1176 (buffer-substring-no-properties here
1177 (- (point) ,(length el)))))
1178 `((if (not (looking-at ,(regexp-quote el)))
1179 (error "Parse error: not looking at `%s'" ,el))
1180 (forward-char ,(length el))))
1181 (setq forms--seen-text t)
1182 (setq forms--field nil)))
1183 ((numberp el)
1184 (if forms--field
1185 (error "Cannot parse adjacent fields %d and %d"
1186 forms--field el)
1187 (setq forms--field el)
1188 nil))
1189 ((null el)
1190 (if forms--field
1191 `((aset forms--recordv ,(1- forms--field)
1192 (buffer-substring-no-properties (point) (point-max))))))
1193 ((listp el)
1194 (prog1
1195 (if forms--field
1196 `((let ((here (point))
1197 (forms--dyntext (aref forms--dyntexts ,forms--dyntext)))
1198 (if (not (search-forward forms--dyntext nil t nil))
1199 (error "Parse error: cannot find `%s'" forms--dyntext))
1200 (aset forms--recordv ,(1- forms--field)
1201 (buffer-substring-no-properties here
1202 (- (point) (length forms--dyntext))))))
1203 `((let ((forms--dyntext (aref forms--dyntexts ,forms--dyntext)))
1204 (if (not (looking-at (regexp-quote forms--dyntext)))
1205 (error "Parse error: not looking at `%s'" forms--dyntext))
1206 (forward-char (length forms--dyntext)))))
1207 (setq forms--dyntext (1+ forms--dyntext))
1208 (setq forms--seen-text t)
1209 (setq forms--field nil)))
1212 (defun forms--intuit-from-file ()
1213 "Get number of fields and a default form using the data file."
1215 ;; If `forms-number-of-fields' is not set, get it from the data file.
1216 (if (null forms-number-of-fields)
1218 ;; Need a file to do this.
1219 (if (not (file-exists-p forms-file))
1220 (error "Need existing file or explicit `forms-number-of-fields'")
1222 ;; Visit the file and extract the first record.
1223 (setq forms--file-buffer (find-file-noselect forms-file))
1224 (let ((read-file-filter forms-read-file-filter)
1225 (the-record))
1226 (setq the-record
1227 (with-current-buffer forms--file-buffer
1228 (let ((inhibit-read-only t))
1229 (run-hooks 'read-file-filter))
1230 (goto-char (point-min))
1231 (forms--get-record)))
1233 ;; This may be overkill, but try to avoid interference with
1234 ;; the normal processing.
1235 (kill-buffer forms--file-buffer)
1237 ;; Count the number of fields in `the-record'.
1238 (let ((start-pos 0)
1239 found-pos
1240 (field-sep-length (length forms-field-sep)))
1241 (setq forms-number-of-fields 1)
1242 (while (setq found-pos
1243 (string-match forms-field-sep the-record start-pos))
1244 (progn
1245 (setq forms-number-of-fields (1+ forms-number-of-fields))
1246 (setq start-pos (+ field-sep-length found-pos))))))))
1248 ;; Construct default format list.
1249 (setq forms-format-list (list "Forms file \"" forms-file "\".\n\n"))
1250 (let ((i 0))
1251 (while (<= (setq i (1+ i)) forms-number-of-fields)
1252 (setq forms-format-list
1253 (append forms-format-list
1254 (list (format "%4d: " i) i "\n"))))))
1256 (defun forms--set-keymaps ()
1257 "Set the keymaps used in this mode."
1259 (use-local-map (if forms-read-only
1260 forms-mode-ro-map
1261 forms-mode-edit-map)))
1263 (defun forms--mode-commands ()
1264 "Fill the Forms mode keymaps."
1266 ;; `forms-mode-map' is always accessible via \C-c prefix.
1267 (setq forms-mode-map (make-keymap))
1268 (define-key forms-mode-map "\t" 'forms-next-field)
1269 (define-key forms-mode-map "\C-k" 'forms-delete-record)
1270 (define-key forms-mode-map "\C-q" 'forms-toggle-read-only)
1271 (define-key forms-mode-map "\C-o" 'forms-insert-record)
1272 (define-key forms-mode-map "\C-l" 'forms-jump-record)
1273 (define-key forms-mode-map "\C-n" 'forms-next-record)
1274 (define-key forms-mode-map "\C-p" 'forms-prev-record)
1275 (define-key forms-mode-map "\C-r" 'forms-search-backward)
1276 (define-key forms-mode-map "\C-s" 'forms-search-forward)
1277 (define-key forms-mode-map "\C-x" 'forms-exit)
1278 (define-key forms-mode-map "<" 'forms-first-record)
1279 (define-key forms-mode-map ">" 'forms-last-record)
1280 (define-key forms-mode-map "\C-?" 'forms-prev-record)
1282 ;; `forms-mode-ro-map' replaces the local map when in read-only mode.
1283 (setq forms-mode-ro-map (make-keymap))
1284 (suppress-keymap forms-mode-ro-map)
1285 (define-key forms-mode-ro-map "\C-c" forms-mode-map)
1286 (define-key forms-mode-ro-map "q" 'forms-toggle-read-only)
1287 (define-key forms-mode-ro-map "l" 'forms-jump-record)
1288 (define-key forms-mode-ro-map "n" 'forms-next-record)
1289 (define-key forms-mode-ro-map "p" 'forms-prev-record)
1290 (define-key forms-mode-ro-map "r" 'forms-search-backward)
1291 (define-key forms-mode-ro-map "s" 'forms-search-forward)
1292 (define-key forms-mode-ro-map "x" 'forms-exit)
1293 (define-key forms-mode-ro-map "<" 'forms-first-record)
1294 (define-key forms-mode-ro-map ">" 'forms-last-record)
1295 (define-key forms-mode-ro-map "?" 'describe-mode)
1296 (define-key forms-mode-ro-map " " 'forms-next-record)
1297 (forms--mode-commands1 forms-mode-ro-map)
1298 (forms--mode-menu-ro forms-mode-ro-map)
1300 ;; This is the normal, local map.
1301 (setq forms-mode-edit-map (make-keymap))
1302 (define-key forms-mode-edit-map "\C-c" forms-mode-map)
1303 (forms--mode-commands1 forms-mode-edit-map)
1304 (forms--mode-menu-edit forms-mode-edit-map)
1307 (defun forms--mode-menu-ro (map)
1308 ;;; Menu initialization
1309 ; (define-key map [menu-bar] (make-sparse-keymap))
1310 (define-key map [menu-bar forms]
1311 (cons "Forms" (make-sparse-keymap "Forms")))
1312 (define-key map [menu-bar forms menu-forms-exit]
1313 '("Exit Forms Mode" . forms-exit))
1314 (define-key map [menu-bar forms menu-forms-sep1]
1315 '("----"))
1316 (define-key map [menu-bar forms menu-forms-save]
1317 '("Save Data" . forms-save-buffer))
1318 (define-key map [menu-bar forms menu-forms-print]
1319 '("Print Data" . forms-print))
1320 (define-key map [menu-bar forms menu-forms-describe]
1321 '("Describe Mode" . describe-mode))
1322 (define-key map [menu-bar forms menu-forms-toggle-ro]
1323 '("Toggle View/Edit" . forms-toggle-read-only))
1324 (define-key map [menu-bar forms menu-forms-jump-record]
1325 '("Jump" . forms-jump-record))
1326 (define-key map [menu-bar forms menu-forms-search-backward]
1327 '("Search Backward" . forms-search-backward))
1328 (define-key map [menu-bar forms menu-forms-search-forward]
1329 '("Search Forward" . forms-search-forward))
1330 (define-key map [menu-bar forms menu-forms-delete-record]
1331 '("Delete" . forms-delete-record))
1332 (define-key map [menu-bar forms menu-forms-insert-record]
1333 '("Insert" . forms-insert-record))
1334 (define-key map [menu-bar forms menu-forms-sep2]
1335 '("----"))
1336 (define-key map [menu-bar forms menu-forms-last-record]
1337 '("Last Record" . forms-last-record))
1338 (define-key map [menu-bar forms menu-forms-first-record]
1339 '("First Record" . forms-first-record))
1340 (define-key map [menu-bar forms menu-forms-prev-record]
1341 '("Previous Record" . forms-prev-record))
1342 (define-key map [menu-bar forms menu-forms-next-record]
1343 '("Next Record" . forms-next-record))
1344 (define-key map [menu-bar forms menu-forms-sep3]
1345 '("----"))
1346 (define-key map [menu-bar forms menu-forms-prev-field]
1347 '("Previous Field" . forms-prev-field))
1348 (define-key map [menu-bar forms menu-forms-next-field]
1349 '("Next Field" . forms-next-field))
1350 (put 'forms-insert-record 'menu-enable '(not forms-read-only))
1351 (put 'forms-delete-record 'menu-enable '(not forms-read-only))
1353 (defun forms--mode-menu-edit (map)
1354 ;;; Menu initialization
1355 ; (define-key map [menu-bar] (make-sparse-keymap))
1356 (define-key map [menu-bar forms]
1357 (cons "Forms" (make-sparse-keymap "Forms")))
1358 (define-key map [menu-bar forms menu-forms-edit--exit]
1359 '("Exit" . forms-exit))
1360 (define-key map [menu-bar forms menu-forms-edit-sep1]
1361 '("----"))
1362 (define-key map [menu-bar forms menu-forms-edit-save]
1363 '("Save Data" . forms-save-buffer))
1364 (define-key map [menu-bar forms menu-forms-edit-print]
1365 '("Print Data" . forms-print))
1366 (define-key map [menu-bar forms menu-forms-edit-describe]
1367 '("Describe Mode" . describe-mode))
1368 (define-key map [menu-bar forms menu-forms-edit-toggle-ro]
1369 '("Toggle View/Edit" . forms-toggle-read-only))
1370 (define-key map [menu-bar forms menu-forms-edit-jump-record]
1371 '("Jump" . forms-jump-record))
1372 (define-key map [menu-bar forms menu-forms-edit-search-backward]
1373 '("Search Backward" . forms-search-backward))
1374 (define-key map [menu-bar forms menu-forms-edit-search-forward]
1375 '("Search Forward" . forms-search-forward))
1376 (define-key map [menu-bar forms menu-forms-edit-delete-record]
1377 '("Delete" . forms-delete-record))
1378 (define-key map [menu-bar forms menu-forms-edit-insert-record]
1379 '("Insert" . forms-insert-record))
1380 (define-key map [menu-bar forms menu-forms-edit-sep2]
1381 '("----"))
1382 (define-key map [menu-bar forms menu-forms-edit-last-record]
1383 '("Last Record" . forms-last-record))
1384 (define-key map [menu-bar forms menu-forms-edit-first-record]
1385 '("First Record" . forms-first-record))
1386 (define-key map [menu-bar forms menu-forms-edit-prev-record]
1387 '("Previous Record" . forms-prev-record))
1388 (define-key map [menu-bar forms menu-forms-edit-next-record]
1389 '("Next Record" . forms-next-record))
1390 (define-key map [menu-bar forms menu-forms-edit-sep3]
1391 '("----"))
1392 (define-key map [menu-bar forms menu-forms-edit-prev-field]
1393 '("Previous Field" . forms-prev-field))
1394 (define-key map [menu-bar forms menu-forms-edit-next-field]
1395 '("Next Field" . forms-next-field))
1396 (put 'forms-insert-record 'menu-enable '(not forms-read-only))
1397 (put 'forms-delete-record 'menu-enable '(not forms-read-only))
1400 (defun forms--mode-commands1 (map)
1401 "Helper routine to define keys."
1402 (define-key map "\t" 'forms-next-field)
1403 (define-key map [S-tab] 'forms-prev-field)
1404 (define-key map [next] 'forms-next-record)
1405 (define-key map [prior] 'forms-prev-record)
1406 (define-key map [begin] 'forms-first-record)
1407 (define-key map [last] 'forms-last-record)
1408 (define-key map [backtab] 'forms-prev-field)
1411 ;;; Changed functions
1413 (defun forms--change-commands ()
1414 "Localize some commands for Forms mode."
1416 ;; scroll-down -> forms-prev-record
1417 ;; scroll-up -> forms-next-record
1418 (if forms-forms-scroll
1419 (progn
1420 (local-set-key [remap scroll-up] 'forms-next-record)
1421 (local-set-key [remap scroll-down] 'forms-prev-record)
1422 (local-set-key [remap scroll-up-command] 'forms-next-record)
1423 (local-set-key [remap scroll-down-command] 'forms-prev-record)))
1425 ;; beginning-of-buffer -> forms-first-record
1426 ;; end-of-buffer -> forms-end-record
1427 (if forms-forms-jump
1428 (progn
1429 (local-set-key [remap beginning-of-buffer] 'forms-first-record)
1430 (local-set-key [remap end-of-buffer] 'forms-last-record)))
1432 ;; Save buffer
1433 (local-set-key "\C-x\C-s" 'forms-save-buffer)
1435 ;; We have our own revert function - use it.
1436 (make-local-variable 'revert-buffer-function)
1437 (setq revert-buffer-function 'forms--revert-buffer)
1441 (defun forms--help ()
1442 "Initial help for Forms mode."
1443 (message "%s" (substitute-command-keys (concat
1444 "\\[forms-next-record]:next"
1445 " \\[forms-prev-record]:prev"
1446 " \\[forms-first-record]:first"
1447 " \\[forms-last-record]:last"
1448 " \\[describe-mode]:help"))))
1450 (defun forms--trans (subj arg rep)
1451 "Translate in SUBJ all chars ARG into char REP. ARG and REP should
1452 be single-char strings."
1453 (let ((i 0)
1454 (re (regexp-quote arg))
1455 (k (string-to-char rep)))
1456 (while (setq i (string-match re subj i))
1457 (aset subj i k)
1458 (setq i (1+ i)))))
1460 (defun forms--exit (&optional save)
1461 "Internal exit from forms mode function."
1463 (let ((buf (buffer-name forms--file-buffer)))
1464 (forms--checkmod)
1465 (if (and save
1466 (buffer-modified-p forms--file-buffer))
1467 (forms-save-buffer))
1468 (with-current-buffer forms--file-buffer
1469 (delete-auto-save-file-if-necessary)
1470 (kill-buffer (current-buffer)))
1471 (if (get-buffer buf) ; not killed???
1472 (if save
1473 (error "Problem saving buffer %s" (buffer-name buf)))
1474 (delete-auto-save-file-if-necessary)
1475 (kill-buffer (current-buffer)))))
1477 (defun forms--get-record ()
1478 "Fetch the current record from the file buffer."
1480 ;; This function is executed in the context of the `forms--file-buffer'.
1482 (or (bolp)
1483 (beginning-of-line nil))
1484 (let ((here (point)))
1485 (prog2
1486 (end-of-line)
1487 (buffer-substring-no-properties here (point))
1488 (goto-char here))))
1490 (defun forms--show-record (the-record)
1491 "Format THE-RECORD and display it in the current buffer."
1493 ;; Split the-record.
1494 (let (the-result
1495 (start-pos 0)
1496 found-pos
1497 (field-sep-length (length forms-field-sep)))
1498 (if forms-multi-line
1499 (forms--trans the-record forms-multi-line "\n"))
1500 ;; Add an extra separator (makes splitting easy).
1501 (setq the-record (concat the-record forms-field-sep))
1502 (while (setq found-pos (string-match forms-field-sep the-record start-pos))
1503 (let ((ent (substring the-record start-pos found-pos)))
1504 (setq the-result
1505 (append the-result (list ent)))
1506 (setq start-pos (+ field-sep-length found-pos))))
1507 (setq forms--the-record-list the-result))
1509 (setq buffer-read-only nil)
1510 (if forms-use-text-properties
1511 (let ((inhibit-read-only t))
1512 (set-text-properties (point-min) (point-max) nil)))
1513 (erase-buffer)
1515 ;; Verify the number of fields, extend forms--the-record-list if needed.
1516 (if (= (length forms--the-record-list) forms-number-of-fields)
1518 (if (null forms-check-number-of-fields)
1520 (message "Warning: this record has %d fields instead of %d"
1521 (length forms--the-record-list) forms-number-of-fields))
1522 (if (< (length forms--the-record-list) forms-number-of-fields)
1523 (setq forms--the-record-list
1524 (append forms--the-record-list
1525 (make-list
1526 (- forms-number-of-fields
1527 (length forms--the-record-list))
1528 "")))))
1530 ;; Call the formatter function.
1531 (setq forms-fields (append (list nil) forms--the-record-list nil))
1532 (funcall forms--format forms--the-record-list)
1534 ;; Prepare.
1535 (goto-char (point-min))
1536 (set-buffer-modified-p nil)
1537 (setq buffer-read-only forms-read-only)
1538 (setq mode-line-process
1539 (concat " " (int-to-string forms--current-record)
1540 "/" (int-to-string forms--total-records))))
1542 (defun forms--parse-form ()
1543 "Parse contents of form into list of strings."
1544 ;; The contents of the form are parsed, and a new list of strings
1545 ;; is constructed.
1546 ;; A vector with the strings from the original record is
1547 ;; constructed, which is updated with the new contents. Therefore
1548 ;; fields which were not in the form are not modified.
1549 ;; Finally, the vector is transformed into a list for further processing.
1551 (let (forms--recordv)
1553 ;; Build the vector.
1554 (setq forms--recordv (vconcat forms--the-record-list))
1556 ;; Parse the form and update the vector.
1557 (let ((forms--dynamic-text forms--dynamic-text))
1558 (funcall forms--parser))
1560 (if forms-modified-record-filter
1561 ;; As a service to the user, we add a zeroth element so she
1562 ;; can use the same indices as in the forms definition.
1563 (let ((the-fields (vconcat [nil] forms--recordv)))
1564 (setq the-fields (funcall forms-modified-record-filter the-fields))
1565 (cdr (append the-fields nil)))
1567 ;; Transform to a list and return.
1568 (append forms--recordv nil))))
1570 (defun forms--update ()
1571 "Update current record with contents of form.
1572 As a side effect: sets `forms--the-record-list'."
1574 (if forms-read-only
1575 (error "Buffer is read-only"))
1577 (let (the-record)
1578 ;; Build new record.
1579 (setq forms--the-record-list (forms--parse-form))
1580 (setq the-record
1581 (mapconcat #'identity forms--the-record-list forms-field-sep))
1583 (if (string-match-p (regexp-quote forms-field-sep)
1584 (mapconcat #'identity forms--the-record-list ""))
1585 (error "Field separator occurs in record - update refused"))
1587 ;; Handle multi-line fields, if allowed.
1588 (if forms-multi-line
1589 (forms--trans the-record "\n" forms-multi-line))
1591 ;; A final sanity check before updating.
1592 (if (string-match-p "\n" the-record)
1593 (error "Multi-line fields in this record - update refused"))
1595 (with-current-buffer forms--file-buffer
1596 ;; Use delete-region instead of kill-region, to avoid
1597 ;; adding junk to the kill-ring.
1598 (delete-region (line-beginning-position) (line-end-position))
1599 (insert the-record)
1600 (beginning-of-line))))
1602 (defun forms--checkmod ()
1603 "Check if this form has been modified, and call forms--update if so."
1604 (if (buffer-modified-p nil)
1605 (let ((here (point)))
1606 (forms--update)
1607 (set-buffer-modified-p nil)
1608 (goto-char here))))
1610 ;;; Start and exit
1612 ;;;###autoload
1613 (defun forms-find-file (fn)
1614 "Visit a file in Forms mode."
1615 (interactive "fForms file: ")
1616 (let ((enable-local-eval t)
1617 (enable-local-variables t))
1618 (find-file-read-only fn)
1619 (or forms--mode-setup (forms-mode t))))
1621 ;;;###autoload
1622 (defun forms-find-file-other-window (fn)
1623 "Visit a file in Forms mode in other window."
1624 (interactive "fFbrowse file in other window: ")
1625 (let ((enable-local-eval t)
1626 (enable-local-variables t))
1627 (find-file-other-window fn)
1628 (or forms--mode-setup (forms-mode t))))
1630 (defun forms-exit ()
1631 "Normal exit from Forms mode. Modified buffers are saved."
1632 (interactive)
1633 (forms--exit t))
1635 (defun forms-exit-no-save ()
1636 "Exit from Forms mode without saving buffers."
1637 (interactive)
1638 (forms--exit nil))
1640 ;;; Navigating commands
1642 (defun forms-next-record (arg)
1643 "Advance to the ARGth following record."
1644 (interactive "P")
1645 (forms-jump-record (+ forms--current-record (prefix-numeric-value arg)) t))
1647 (defun forms-prev-record (arg)
1648 "Advance to the ARGth previous record."
1649 (interactive "P")
1650 (forms-jump-record (- forms--current-record (prefix-numeric-value arg)) t))
1652 (defun forms--goto-record (rn &optional current)
1653 "Goto record number RN.
1654 If CURRENT is provided, it specifies the current record and can be used
1655 to speed up access to RN. Returns the number of records missing, if any."
1656 (if current
1657 (forward-line (- rn current))
1658 ;; goto-line does not do what we want when the buffer is narrowed.
1659 (goto-char (point-min))
1660 (forward-line (1- rn))))
1662 (defun forms-jump-record (arg &optional relative)
1663 "Jump to a random record."
1664 (interactive "NRecord number: ")
1666 ;; Verify that the record number is within range.
1667 (if (or (> arg forms--total-records)
1668 (<= arg 0))
1669 (error
1670 ;; Don't give the message if just paging.
1671 (if (not relative)
1672 (message "Record number %d out of range 1..%d"
1673 arg forms--total-records)
1674 "")))
1676 ;; Flush.
1677 (forms--checkmod)
1679 ;; Calculate displacement.
1680 (let ((cur forms--current-record))
1682 ;; `forms--show-record' needs it now.
1683 (setq forms--current-record arg)
1685 ;; Get the record and show it.
1686 (forms--show-record
1687 (with-current-buffer forms--file-buffer
1688 (beginning-of-line)
1690 ;; Move, and adjust the amount if needed (shouldn't happen).
1691 (setq cur (- arg (forms--goto-record arg (if relative cur))))
1693 (forms--get-record)))
1695 ;; This shouldn't happen.
1696 (if (/= forms--current-record cur)
1697 (progn
1698 (setq forms--current-record cur)
1699 (error "Stuck at record %d" cur)))))
1701 (defun forms-first-record ()
1702 "Jump to first record."
1703 (interactive)
1704 (forms-jump-record 1))
1706 (defun forms-last-record ()
1707 "Jump to last record.
1708 As a side effect: re-calculates the number of records in the data file."
1709 (interactive)
1710 (let
1711 ((numrec
1712 (with-current-buffer forms--file-buffer
1713 (count-lines (point-min) (point-max)))))
1714 (if (= numrec forms--total-records)
1716 (setq forms--total-records numrec)
1717 (message "Warning: number of records changed to %d" forms--total-records)))
1718 (forms-jump-record forms--total-records))
1720 ;;; Other commands
1722 (defun forms-toggle-read-only (arg)
1723 "Toggles read-only mode of a forms mode buffer.
1724 With an argument, enables read-only mode if the argument is positive.
1725 Otherwise enables edit mode if the visited file is writable."
1727 (interactive "P")
1729 (if (if arg
1730 ;; Negative arg means switch it off.
1731 (<= (prefix-numeric-value arg) 0)
1732 ;; No arg means toggle.
1733 forms-read-only)
1735 ;; Enable edit mode, if possible.
1736 (let ((ro forms-read-only))
1737 (if (with-current-buffer forms--file-buffer
1738 buffer-read-only)
1739 (progn
1740 (setq forms-read-only t)
1741 (message "No write access to `%s'" forms-file))
1742 (setq forms-read-only nil))
1743 (if (equal ro forms-read-only)
1745 (forms-mode)))
1747 ;; Enable view mode.
1748 (if forms-read-only
1750 (forms--checkmod) ; sync
1751 (setq forms-read-only t)
1752 (forms-mode))))
1754 ;; Sample:
1755 ;; (defun my-new-record-filter (the-fields)
1756 ;; ;; numbers are relative to 1
1757 ;; (aset the-fields 4 (current-time-string))
1758 ;; (aset the-fields 6 (user-login-name))
1759 ;; the-list)
1760 ;; (setq forms-new-record-filter 'my-new-record-filter)
1762 (defun forms-insert-record (arg)
1763 "Create a new record before the current one.
1764 With ARG: store the record after the current one.
1765 If `forms-new-record-filter' contains the name of a function,
1766 it is called to fill (some of) the fields with default values.
1767 If `forms-insert-after' is non-nil, the default behavior is to insert
1768 after the current record."
1770 (interactive "P")
1772 (if forms-read-only
1773 (error ""))
1775 (let (ln the-list the-record)
1777 (if (or (and arg forms-insert-after)
1778 (and (not arg) (not forms-insert-after)))
1779 (setq ln forms--current-record)
1780 (setq ln (1+ forms--current-record)))
1782 (forms--checkmod)
1783 (if forms-new-record-filter
1784 ;; As a service to the user, we add a zeroth element so she
1785 ;; can use the same indices as in the forms definition.
1786 (let ((the-fields (make-vector (1+ forms-number-of-fields) "")))
1787 (setq the-fields (funcall forms-new-record-filter the-fields))
1788 (setq the-list (cdr (append the-fields nil))))
1789 (setq the-list (make-list forms-number-of-fields "")))
1791 (setq the-record (mapconcat #'identity the-list forms-field-sep))
1793 (with-current-buffer forms--file-buffer
1794 (forms--goto-record ln)
1795 (open-line 1)
1796 (insert the-record)
1797 (beginning-of-line))
1799 (setq forms--current-record ln))
1801 (setq forms--total-records (1+ forms--total-records))
1802 (forms-jump-record forms--current-record))
1804 (defun forms-delete-record (arg)
1805 "Deletes a record. With a prefix argument: don't ask."
1806 (interactive "P")
1808 (if forms-read-only
1809 (error ""))
1811 (forms--checkmod)
1812 (if (or arg
1813 (y-or-n-p "Really delete this record? "))
1814 (let ((ln forms--current-record))
1815 (with-current-buffer forms--file-buffer
1816 (forms--goto-record ln)
1817 ;; Use delete-region instead of kill-region, to avoid
1818 ;; adding junk to the kill-ring.
1819 (delete-region (progn (beginning-of-line) (point))
1820 (progn (beginning-of-line 2) (point))))
1821 (setq forms--total-records (1- forms--total-records))
1822 (if (> forms--current-record forms--total-records)
1823 (setq forms--current-record forms--total-records))
1824 (forms-jump-record forms--current-record)))
1825 (message ""))
1827 (defun forms-search-forward (regexp)
1828 "Search forward for record containing REGEXP."
1829 (interactive
1830 (list (read-string (concat "Search forward for"
1831 (if forms--search-regexp
1832 (concat " ("
1833 forms--search-regexp
1834 ")"))
1835 ": "))))
1836 (if (equal "" regexp)
1837 (setq regexp forms--search-regexp))
1838 (forms--checkmod)
1840 (let (the-line the-record here)
1841 (with-current-buffer forms--file-buffer
1842 (end-of-line)
1843 (setq here (point))
1844 (if (or (re-search-forward regexp nil t)
1845 (and (> here (point-min))
1846 (progn
1847 (goto-char (point-min))
1848 (re-search-forward regexp here t))))
1849 (progn
1850 (setq the-record (forms--get-record))
1851 (setq the-line (1+ (count-lines (point-min) (point))))
1852 (if (< (point) here)
1853 (message "Wrapped")))
1854 (goto-char here)
1855 (error "Search failed: %s" regexp)))
1856 (setq forms--current-record the-line)
1857 (forms--show-record the-record))
1858 (re-search-forward regexp nil t)
1859 (setq forms--search-regexp regexp))
1861 (defun forms-search-backward (regexp)
1862 "Search backward for record containing REGEXP."
1863 (interactive
1864 (list (read-string (concat "Search backward for"
1865 (if forms--search-regexp
1866 (concat " ("
1867 forms--search-regexp
1868 ")"))
1869 ": "))))
1870 (if (equal "" regexp)
1871 (setq regexp forms--search-regexp))
1872 (forms--checkmod)
1874 (let (the-line the-record here)
1875 (with-current-buffer forms--file-buffer
1876 (beginning-of-line)
1877 (setq here (point))
1878 (if (or (re-search-backward regexp nil t)
1879 (and (< (point) (point-max))
1880 (progn
1881 (goto-char (point-max))
1882 (re-search-backward regexp here t))))
1883 (progn
1884 (setq the-record (forms--get-record))
1885 (setq the-line (1+ (count-lines (point-min) (point))))
1886 (if (> (point) here)
1887 (message "Wrapped")))
1888 (goto-char here)
1889 (error "Search failed: %s" regexp)))
1890 (setq forms--current-record the-line)
1891 (forms--show-record the-record))
1892 (re-search-forward regexp nil t)
1893 (setq forms--search-regexp regexp))
1895 (defun forms-save-buffer (&optional args)
1896 "Forms mode replacement for save-buffer.
1897 It saves the data buffer instead of the forms buffer.
1898 Calls `forms-write-file-filter' before, and `forms-read-file-filter'
1899 after writing out the data."
1900 (interactive "p")
1901 (forms--checkmod)
1902 (let ((write-file-filter forms-write-file-filter)
1903 (read-file-filter forms-read-file-filter)
1904 (cur forms--current-record))
1905 (with-current-buffer forms--file-buffer
1906 (let ((inhibit-read-only t))
1907 ;; Write file hooks are run via write-file-functions.
1908 ;; (if write-file-filter
1909 ;; (save-excursion
1910 ;; (run-hooks 'write-file-filter)))
1912 ;; If they have a write-file-filter, force the buffer to be
1913 ;; saved even if it doesn't seem to be changed. First, they
1914 ;; might have changed the write-file-filter; and second, if
1915 ;; save-buffer does nothing, write-file-filter won't get run,
1916 ;; and then read-file-filter will be mightily confused.
1917 (or (null write-file-filter)
1918 (set-buffer-modified-p t))
1919 (save-buffer args)
1920 (if read-file-filter
1921 (save-excursion
1922 (run-hooks 'read-file-filter)))
1923 (set-buffer-modified-p nil)))
1924 ;; Make sure we end up with the same record number as we started.
1925 ;; Since read-file-filter may perform arbitrary transformations on
1926 ;; the data buffer contents, save-excursion is not enough.
1927 (forms-jump-record cur))
1930 (defun forms--revert-buffer (&optional _arg noconfirm)
1931 "Reverts current form to un-modified."
1932 (interactive "P")
1933 (if (or noconfirm
1934 (yes-or-no-p "Revert form to unmodified? "))
1935 (progn
1936 (set-buffer-modified-p nil)
1937 (forms-jump-record forms--current-record))))
1939 (defun forms-next-field (arg)
1940 "Jump to ARG-th next field."
1941 (interactive "p")
1943 (let ((i 0)
1944 (here (point))
1945 there
1946 (cnt 0)
1947 (inhibit-point-motion-hooks t))
1949 (if (zerop arg)
1950 (setq cnt 1)
1951 (setq cnt (+ cnt arg)))
1953 (if (catch 'done
1954 (while (< i (length forms--markers))
1955 (if (or (null (setq there (aref forms--markers i)))
1956 (<= there here))
1958 (if (<= (setq cnt (1- cnt)) 0)
1959 (progn
1960 (goto-char there)
1961 (throw 'done t))))
1962 (setq i (1+ i))))
1964 (goto-char (aref forms--markers 0)))))
1966 (defun forms-prev-field (arg)
1967 "Jump to ARG-th previous field."
1968 (interactive "p")
1970 (let ((i (length forms--markers))
1971 (here (point))
1972 there
1973 (cnt 0)
1974 (inhibit-point-motion-hooks t))
1976 (if (zerop arg)
1977 (setq cnt 1)
1978 (setq cnt (+ cnt arg)))
1980 (if (catch 'done
1981 (while (> i 0)
1982 (setq i ( 1- i))
1983 (if (or (null (setq there (aref forms--markers i)))
1984 (>= there here))
1986 (if (<= (setq cnt (1- cnt)) 0)
1987 (progn
1988 (goto-char there)
1989 (throw 'done t))))))
1991 (goto-char (aref forms--markers (1- (length forms--markers)))))))
1993 (defun forms-print ()
1994 "Send the records to the printer with `print-buffer', one record per page."
1995 (interactive)
1996 (let ((inhibit-read-only t)
1997 (save-record forms--current-record)
1998 (total-nb-records forms--total-records)
1999 (nb-record 1)
2000 (record nil))
2001 (while (<= nb-record forms--total-records)
2002 (forms-jump-record nb-record)
2003 (setq record (buffer-string))
2004 (with-current-buffer (get-buffer-create "*forms-print*")
2005 (goto-char (buffer-end 1))
2006 (insert record)
2007 (setq buffer-read-only nil)
2008 (if (< nb-record total-nb-records)
2009 (insert "\n\f\n")))
2010 (setq nb-record (1+ nb-record)))
2011 (with-current-buffer "*forms-print*"
2012 (print-buffer)
2013 (set-buffer-modified-p nil)
2014 (kill-buffer (current-buffer)))
2015 (forms-jump-record save-record)))
2018 ;;; Special service
2020 (defun forms-enumerate (the-fields)
2021 "Take a quoted list of symbols, and set their values to sequential numbers.
2022 The first symbol gets number 1, the second 2 and so on.
2023 It returns the highest number.
2025 Usage: (setq forms-number-of-fields
2026 (forms-enumerate
2027 '(field1 field2 field2 ...)))"
2029 (let ((the-index 0))
2030 (while the-fields
2031 (setq the-index (1+ the-index))
2032 (let ((el (car-safe the-fields)))
2033 (setq the-fields (cdr-safe the-fields))
2034 (set el the-index)))
2035 the-index))
2037 ;;; Debugging
2039 (defcustom forms--debug nil
2040 "If non-nil, enable Forms mode debugging."
2041 :type 'boolean
2042 :group 'forms)
2044 (defun forms--debug (&rest args)
2045 "Internal debugging routine."
2046 (if forms--debug
2047 (let ((ret nil))
2048 (while args
2049 (let ((el (car-safe args)))
2050 (setq args (cdr-safe args))
2051 (if (stringp el)
2052 (setq ret (concat ret el))
2053 (setq ret (concat ret (prin1-to-string el) " = "))
2054 (if (boundp el)
2055 (let ((vel (eval el)))
2056 (setq ret (concat ret (prin1-to-string vel) "\n")))
2057 (setq ret (concat ret "<unbound>" "\n")))
2058 (if (fboundp el)
2059 (setq ret (concat ret (prin1-to-string (symbol-function el))
2060 "\n"))))))
2061 (with-current-buffer (get-buffer-create "*forms-mode debug*")
2062 (if (zerop (buffer-size))
2063 (emacs-lisp-mode))
2064 (goto-char (point-max))
2065 (insert ret)))))
2067 (provide 'forms-mode) ; for compatibility
2068 (provide 'forms)
2069 ;;; forms.el ends here