*** empty log message ***
[emacs.git] / lisp / forms.el
blob27a9da381335c192db4357695243497b7a6dcb91
1 ;;; forms.el --- Forms mode: edit a file as a form to fill in
3 ;; Copyright (C) 1991, 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Johan Vromans <jvromans@squirrel.nl>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
24 ;;; Commentary:
26 ;; Visit a file using a form.
28 ;; === Naming conventions
30 ;; The names of all variables and functions start with 'forms-'.
31 ;; Names which start with 'forms--' are intended for internal use, and
32 ;; should *NOT* be used from the outside.
34 ;; All variables are buffer-local, to enable multiple forms visits
35 ;; simultaneously.
36 ;; Variable `forms--mode-setup' is local to *ALL* buffers, for it
37 ;; controls if forms-mode has been enabled in a buffer.
39 ;; === How it works ===
41 ;; Forms mode means visiting a data file which is supposed to consist
42 ;; of records each containing a number of fields. The records are
43 ;; separated by a newline, the fields are separated by a user-defined
44 ;; field separator (default: TAB).
45 ;; When shown, a record is transferred to an Emacs buffer and
46 ;; presented using a user-defined form. One record is shown at a
47 ;; time.
49 ;; Forms mode is a composite mode. It involves two files, and two
50 ;; buffers.
51 ;; The first file, called the control file, defines the name of the
52 ;; data file and the forms format. This file buffer will be used to
53 ;; present the forms.
54 ;; The second file holds the actual data. The buffer of this file
55 ;; will be buried, for it is never accessed directly.
57 ;; Forms mode is invoked using M-x `forms-find-file' control-file.
58 ;; Alternatively `forms-find-file-other-window' can be used.
60 ;; You may also visit the control file, and switch to forms mode by hand
61 ;; with M-x `forms-mode'.
63 ;; Automatic mode switching is supported if you specify
64 ;; "-*- forms -*-" in the first line of the control file.
65 ;;
66 ;; The control file is visited, evaluated using `eval-current-buffer',
67 ;; and should set at least the following variables:
69 ;; forms-file [string]
70 ;; The name of the data file.
72 ;; forms-number-of-fields [integer]
73 ;; The number of fields in each record.
75 ;; forms-format-list [list]
76 ;; Formatting instructions.
78 ;; `forms-format-list' should be a list, each element containing
80 ;; - a string, e.g. "hello". The string is inserted in the forms
81 ;; "as is".
82 ;;
83 ;; - an integer, denoting a field number.
84 ;; The contents of this field are inserted at this point.
85 ;; Fields are numbered starting with number one.
86 ;;
87 ;; - a function call, e.g. (insert "text").
88 ;; This function call is dynamically evaluated and should return a
89 ;; string. It should *NOT* have side-effects on the forms being
90 ;; constructed. The current fields are available to the function
91 ;; in the variable `forms-fields', they should *NOT* be modified.
92 ;;
93 ;; - a lisp symbol, that must evaluate to one of the above.
95 ;; Optional variables which may be set in the control file:
97 ;; forms-field-sep [string, default TAB]
98 ;; The field separator used to separate the
99 ;; fields in the data file. It may be a string.
101 ;; forms-read-only [bool, default nil]
102 ;; Non-nil means that the data file is visited
103 ;; read-only (view mode) as opposed to edit mode.
104 ;; If no write access to the data file is
105 ;; possible, view mode is enforced.
107 ;; forms-check-number-of-fields [bool, default t]
108 ;; If non-nil, a warning will be issued whenever
109 ;; a record is found that does not have the number
110 ;; of fields specified by `forms-number-of-fields'.
112 ;; forms-multi-line [string, default "^K"]
113 ;; If non-null, the records of the data file may
114 ;; contain fields that can span multiple lines in
115 ;; the form.
116 ;; This variable denotes the separator string
117 ;; to be used for this purpose. Upon display, all
118 ;; occurrences of this string are translated
119 ;; to newlines. Upon storage they are translated
120 ;; back to the separator string.
122 ;; forms-forms-scroll [bool, default nil]
123 ;; Non-nil means: rebind locally the commands that
124 ;; perform `scroll-up' or `scroll-down' to use
125 ;; `forms-next-field' resp. `forms-prev-field'.
127 ;; forms-forms-jump [bool, default nil]
128 ;; Non-nil means: rebind locally the commands
129 ;; `beginning-of-buffer' and `end-of-buffer' to
130 ;; perform, respectively, `forms-first-record' and
131 ;; `forms-last-record' instead.
133 ;; forms-insert-after [bool, default nil]
134 ;; Non-nil means: insertions of new records go after
135 ;; current record, also initial position is at the
136 ;; last record. The default is to insert before the
137 ;; current record and the initial position is at the
138 ;; first record.
140 ;; forms-read-file-filter [symbol, default nil]
141 ;; If not nil: this should be the name of a
142 ;; function that is called after the forms data file
143 ;; has been read. It can be used to transform
144 ;; the contents of the file into a format more suitable
145 ;; for forms-mode processing.
147 ;; forms-write-file-filter [symbol, default nil]
148 ;; If not nil: this should be the name of a
149 ;; function that is called before the forms data file
150 ;; is written (saved) to disk. It can be used to undo
151 ;; the effects of `forms-read-file-filter', if any.
153 ;; forms-new-record-filter [symbol, default nil]
154 ;; If not nil: this should be the name of a
155 ;; function that is called when a new
156 ;; record is created. It can be used to fill in
157 ;; the new record with default fields, for example.
159 ;; forms-modified-record-filter [symbol, default nil]
160 ;; If not nil: this should be the name of a
161 ;; function that is called when a record has
162 ;; been modified. It is called after the fields
163 ;; are parsed. It can be used to register
164 ;; modification dates, for example.
166 ;; forms-use-text-properties [bool, see text for default]
167 ;; This variable controls if forms mode should use
168 ;; text properties to protect the form text from being
169 ;; modified (using text-property `read-only').
170 ;; Also, the read-write fields are shown using a
171 ;; distinct face, if possible.
172 ;; As of emacs 19.29, the `intangible' text property
173 ;; is used to prevent moving into read-only fields.
174 ;; This variable defaults to t if running Emacs 19 or
175 ;; later with text properties.
176 ;; The default face to show read-write fields is
177 ;; copied from face `region'.
179 ;; forms-ro-face [symbol, default 'default]
180 ;; This is the face that is used to show
181 ;; read-only text on the screen. If used, this
182 ;; variable should be set to a symbol that is a
183 ;; valid face.
184 ;; E.g.
185 ;; (make-face 'my-face)
186 ;; (setq forms-ro-face 'my-face)
188 ;; forms-rw-face [symbol, default 'region]
189 ;; This is the face that is used to show
190 ;; read-write text on the screen.
192 ;; After evaluating the control file, its buffer is cleared and used
193 ;; for further processing.
194 ;; The data file (as designated by `forms-file') is visited in a buffer
195 ;; `forms--file-buffer' which normally will not be shown.
196 ;; Great malfunctioning may be expected if this file/buffer is modified
197 ;; outside of this package while it is being visited!
199 ;; Normal operation is to transfer one line (record) from the data file,
200 ;; split it into fields (into `forms--the-record-list'), and display it
201 ;; using the specs in `forms-format-list'.
202 ;; A format routine `forms--format' is built upon startup to format
203 ;; the records according to `forms-format-list'.
205 ;; When a form is changed the record is updated as soon as this form
206 ;; is left. The contents of the form are parsed using information
207 ;; obtained from `forms-format-list', and the fields which are
208 ;; deduced from the form are modified. Fields not shown on the forms
209 ;; retain their original values. The newly formed record then
210 ;; replaces the contents of the old record in `forms--file-buffer'.
211 ;; A parse routine `forms--parser' is built upon startup to parse
212 ;; the records.
214 ;; Two exit functions exist: `forms-exit' and `forms-exit-no-save'.
215 ;; `forms-exit' saves the data to the file, if modified.
216 ;; `forms-exit-no-save' does not. However, if `forms-exit-no-save'
217 ;; is executed and the file buffer has been modified, Emacs will ask
218 ;; questions anyway.
220 ;; Other functions provided by forms mode are:
222 ;; paging (forward, backward) by record
223 ;; jumping (first, last, random number)
224 ;; searching
225 ;; creating and deleting records
226 ;; reverting the form (NOT the file buffer)
227 ;; switching edit <-> view mode v.v.
228 ;; jumping from field to field
230 ;; As a documented side-effect: jumping to the last record in the
231 ;; file (using forms-last-record) will adjust forms--total-records if
232 ;; needed.
234 ;; The forms buffer can be in one of two modes: edit mode or view
235 ;; mode. View mode is a read-only mode, whereby you cannot modify the
236 ;; contents of the buffer.
238 ;; Edit mode commands:
240 ;; TAB forms-next-field
241 ;; \C-c TAB forms-next-field
242 ;; \C-c < forms-first-record
243 ;; \C-c > forms-last-record
244 ;; \C-c ? describe-mode
245 ;; \C-c \C-k forms-delete-record
246 ;; \C-c \C-q forms-toggle-read-only
247 ;; \C-c \C-o forms-insert-record
248 ;; \C-c \C-l forms-jump-record
249 ;; \C-c \C-n forms-next-record
250 ;; \C-c \C-p forms-prev-record
251 ;; \C-c \C-r forms-search-backward
252 ;; \C-c \C-s forms-search-forward
253 ;; \C-c \C-x forms-exit
255 ;; Read-only mode commands:
257 ;; SPC forms-next-record
258 ;; DEL forms-prev-record
259 ;; ? describe-mode
260 ;; \C-q forms-toggle-read-only
261 ;; l forms-jump-record
262 ;; n forms-next-record
263 ;; p forms-prev-record
264 ;; r forms-search-backward
265 ;; s forms-search-forward
266 ;; x forms-exit
268 ;; Of course, it is also possible to use the \C-c prefix to obtain the
269 ;; same command keys as in edit mode.
271 ;; The following bindings are available, independent of the mode:
273 ;; [next] forms-next-record
274 ;; [prior] forms-prev-record
275 ;; [begin] forms-first-record
276 ;; [end] forms-last-record
277 ;; [S-TAB] forms-prev-field
278 ;; [backtab] forms-prev-field
280 ;; For convenience, TAB is always bound to `forms-next-field', so you
281 ;; don't need the C-c prefix for this command.
283 ;; As mentioned above (see `forms-forms-scroll' and `forms-forms-jump'),
284 ;; the bindings of standard functions `scroll-up', `scroll-down',
285 ;; `beginning-of-buffer' and `end-of-buffer' can be locally replaced with
286 ;; forms mode functions next/prev record and first/last
287 ;; record.
289 ;; `local-write-file-hooks' is defined to save the actual data file
290 ;; instead of the buffer data, `revert-file-hook' is defined to
291 ;; revert a forms to original.
293 ;;; Code:
295 (defgroup forms nil
296 "Edit a file as a form to fill in."
297 :group 'data)
299 ;;; Global variables and constants:
301 (provide 'forms) ;;; official
302 (provide 'forms-mode) ;;; for compatibility
304 (defconst forms-version (substring "$Revision: 2.40 $" 11 -2)
305 "The version number of forms-mode (as string). The complete RCS id is:
307 $Id: forms.el,v 2.40 1999/11/13 22:05:56 gerd Exp $")
309 (defcustom forms-mode-hooks nil
310 "Hook run upon entering Forms mode."
311 :group 'forms
312 :type 'hook)
314 ;;; Mandatory variables - must be set by evaluating the control file.
316 (defvar forms-file nil
317 "Name of the file holding the data.")
319 (defvar forms-format-list nil
320 "List of formatting specifications.")
322 (defvar forms-number-of-fields nil
323 "Number of fields per record.")
325 ;;; Optional variables with default values.
327 (defcustom forms-check-number-of-fields t
328 "*If non-nil, warn about records with wrong number of fields."
329 :group 'forms
330 :type 'boolean)
332 (defvar forms-field-sep "\t"
333 "Field separator character (default TAB).")
335 (defvar forms-read-only nil
336 "Non-nil means: visit the file in view (read-only) mode.
337 This is set automatically if the file permissions don't let you write it.")
339 (defvar forms-multi-line "\C-k" "\
340 If not nil: use this character to separate multi-line fields (default C-k).")
342 (defcustom forms-forms-scroll nil
343 "*Non-nil means replace scroll-up/down commands in Forms mode.
344 The replacement commands performs forms-next/prev-record."
345 :group 'forms
346 :type 'boolean)
348 (defcustom forms-forms-jump nil
349 "*Non-nil means redefine beginning/end-of-buffer in Forms mode.
350 The replacement commands performs forms-first/last-record."
351 :group 'forms
352 :type 'boolean)
354 (defvar forms-read-file-filter nil
355 "The name of a function that is called after reading the data file.
356 This can be used to change the contents of the file to something more
357 suitable for forms processing.")
359 (defvar forms-write-file-filter nil
360 "The name of a function that is called before writing the data file.
361 This can be used to undo the effects of `form-read-file-hook'.")
363 (defvar forms-new-record-filter nil
364 "The name of a function that is called when a new record is created.")
366 (defvar forms-modified-record-filter nil
367 "The name of a function that is called when a record has been modified.")
369 (defvar forms-fields nil
370 "List with fields of the current forms. First field has number 1.
371 This variable is for use by the filter routines only.
372 The contents may NOT be modified.")
374 (defcustom forms-use-text-properties t
375 "*Non-nil means: use text properties.
376 Defaults to t if this Emacs is capable of handling text properties."
377 :group 'forms
378 :type 'boolean)
380 (defcustom forms-insert-after nil
381 "*Non-nil means: inserts of new records go after current record.
382 Also, initial position is at last record."
383 :group 'forms
384 :type 'boolean)
386 (defcustom forms-ro-face 'default
387 "The face (a symbol) that is used to display read-only text on the screen."
388 :group 'forms
389 :type 'face)
391 (defcustom forms-rw-face 'region
392 "The face (a symbol) that is used to display read-write text on the screen."
393 :group 'forms
394 :type 'face)
396 ;;; Internal variables.
398 (defvar forms--file-buffer nil
399 "Buffer which holds the file data")
401 (defvar forms--total-records 0
402 "Total number of records in the data file.")
404 (defvar forms--current-record 0
405 "Number of the record currently on the screen.")
407 (defvar forms-mode-map nil
408 "Keymap for form buffer.")
409 (defvar forms-mode-ro-map nil
410 "Keymap for form buffer in view mode.")
411 (defvar forms-mode-edit-map nil
412 "Keymap for form buffer in edit mode.")
414 (defvar forms--markers nil
415 "Field markers in the screen.")
417 (defvar forms--dyntexts nil
418 "Dynamic texts (resulting from function calls) on the screen.")
420 (defvar forms--the-record-list nil
421 "List of strings of the current record, as parsed from the file.")
423 (defvar forms--search-regexp nil
424 "Last regexp used by forms-search functions.")
426 (defvar forms--format nil
427 "Formatting routine.")
429 (defvar forms--parser nil
430 "Forms parser routine.")
432 (defvar forms--mode-setup nil
433 "To keep track of forms-mode being set-up.")
434 (make-variable-buffer-local 'forms--mode-setup)
436 (defvar forms--dynamic-text nil
437 "Array that holds dynamic texts to insert between fields.")
439 (defvar forms--elements nil
440 "Array with the order in which the fields are displayed.")
442 (defvar forms--ro-face nil
443 "Face used to represent read-only data on the screen.")
445 (defvar forms--rw-face nil
446 "Face used to represent read-write data on the screen.")
448 ;;;###autoload
449 (defun forms-mode (&optional primary)
450 "Major mode to visit files in a field-structured manner using a form.
452 Commands: Equivalent keys in read-only mode:
453 TAB forms-next-field TAB
454 C-c TAB forms-next-field
455 C-c < forms-first-record <
456 C-c > forms-last-record >
457 C-c ? describe-mode ?
458 C-c C-k forms-delete-record
459 C-c C-q forms-toggle-read-only q
460 C-c C-o forms-insert-record
461 C-c C-l forms-jump-record l
462 C-c C-n forms-next-record n
463 C-c C-p forms-prev-record p
464 C-c C-r forms-search-reverse r
465 C-c C-s forms-search-forward s
466 C-c C-x forms-exit x
468 (interactive)
470 ;; This is not a simple major mode, as usual. Therefore, forms-mode
471 ;; takes an optional argument `primary' which is used for the
472 ;; initial set-up. Normal use would leave `primary' to nil.
473 ;; A global buffer-local variable `forms--mode-setup' has the same
474 ;; effect but makes it possible to auto-invoke forms-mode using
475 ;; `find-file'.
476 ;; Note: although it seems logical to have `make-local-variable'
477 ;; executed where the variable is first needed, I have deliberately
478 ;; placed all calls in this function.
480 ;; Primary set-up: evaluate buffer and check if the mandatory
481 ;; variables have been set.
482 (if (or primary (not forms--mode-setup))
483 (progn
484 ;;(message "forms: setting up...")
485 (kill-all-local-variables)
487 ;; Make mandatory variables.
488 (make-local-variable 'forms-file)
489 (make-local-variable 'forms-number-of-fields)
490 (make-local-variable 'forms-format-list)
492 ;; Make optional variables.
493 (make-local-variable 'forms-field-sep)
494 (make-local-variable 'forms-read-only)
495 (make-local-variable 'forms-multi-line)
496 (make-local-variable 'forms-forms-scroll)
497 (make-local-variable 'forms-forms-jump)
498 (make-local-variable 'forms-insert-after)
499 (make-local-variable 'forms-use-text-properties)
501 ;; Filter functions.
502 (make-local-variable 'forms-read-file-filter)
503 (make-local-variable 'forms-write-file-filter)
504 (make-local-variable 'forms-new-record-filter)
505 (make-local-variable 'forms-modified-record-filter)
507 ;; Make sure no filters exist.
508 (setq forms-read-file-filter nil)
509 (setq forms-write-file-filter nil)
510 (setq forms-new-record-filter nil)
511 (setq forms-modified-record-filter nil)
513 ;; If running Emacs 19 under X, setup faces to show read-only and
514 ;; read-write fields.
515 (if (fboundp 'make-face)
516 (progn
517 (make-local-variable 'forms-ro-face)
518 (make-local-variable 'forms-rw-face)))
520 ;; eval the buffer, should set variables
521 ;;(message "forms: processing control file...")
522 ;; If enable-local-eval is not set to t the user is asked first.
523 (if (or (eq enable-local-eval t)
524 (yes-or-no-p
525 (concat "Evaluate lisp code in buffer "
526 (buffer-name) " to display forms ")))
527 (eval-current-buffer)
528 (error "`enable-local-eval' inhibits buffer evaluation"))
530 ;; Check if the mandatory variables make sense.
531 (or forms-file
532 (error (concat "Forms control file error: "
533 "`forms-file' has not been set")))
535 ;; Check forms-field-sep first, since it can be needed to
536 ;; construct a default format list.
537 (or (stringp forms-field-sep)
538 (error (concat "Forms control file error: "
539 "`forms-field-sep' is not a string")))
541 (if forms-number-of-fields
542 (or (and (numberp forms-number-of-fields)
543 (> forms-number-of-fields 0))
544 (error (concat "Forms control file error: "
545 "`forms-number-of-fields' must be a number > 0")))
546 (or (null forms-format-list)
547 (error (concat "Forms control file error: "
548 "`forms-number-of-fields' has not been set"))))
550 (or forms-format-list
551 (forms--intuit-from-file))
553 (if forms-multi-line
554 (if (and (stringp forms-multi-line)
555 (eq (length forms-multi-line) 1))
556 (if (string= forms-multi-line forms-field-sep)
557 (error (concat "Forms control file error: "
558 "`forms-multi-line' is equal to 'forms-field-sep'")))
559 (error (concat "Forms control file error: "
560 "`forms-multi-line' must be nil or a one-character string"))))
561 (or (fboundp 'set-text-properties)
562 (setq forms-use-text-properties nil))
564 ;; Validate and process forms-format-list.
565 ;;(message "forms: pre-processing format list...")
566 (make-local-variable 'forms--elements)
567 (forms--process-format-list)
569 ;; Build the formatter and parser.
570 ;;(message "forms: building formatter...")
571 (make-local-variable 'forms--format)
572 (make-local-variable 'forms--markers)
573 (make-local-variable 'forms--dyntexts)
574 ;;(message "forms: building parser...")
575 (forms--make-format)
576 (make-local-variable 'forms--parser)
577 (forms--make-parser)
578 ;;(message "forms: building parser... done.")
580 ;; Check if record filters are defined.
581 (if (and forms-new-record-filter
582 (not (fboundp forms-new-record-filter)))
583 (error (concat "Forms control file error: "
584 "`forms-new-record-filter' is not a function")))
586 (if (and forms-modified-record-filter
587 (not (fboundp forms-modified-record-filter)))
588 (error (concat "Forms control file error: "
589 "`forms-modified-record-filter' is not a function")))
591 ;; The filters acces the contents of the forms using `forms-fields'.
592 (make-local-variable 'forms-fields)
594 ;; Dynamic text support.
595 (make-local-variable 'forms--dynamic-text)
597 ;; Prevent accidental overwrite of the control file and auto-save.
598 (set-visited-file-name nil)
600 ;; Prepare this buffer for further processing.
601 (setq buffer-read-only nil)
602 (erase-buffer)
604 ;;(message "forms: setting up... done.")
607 ;; initialization done
608 (setq forms--mode-setup t)
610 ;; Copy desired faces to the actual variables used by the forms formatter.
611 (if (fboundp 'make-face)
612 (progn
613 (make-local-variable 'forms--ro-face)
614 (make-local-variable 'forms--rw-face)
615 (if forms-read-only
616 (progn
617 (setq forms--ro-face forms-ro-face)
618 (setq forms--rw-face forms-ro-face))
619 (setq forms--ro-face forms-ro-face)
620 (setq forms--rw-face forms-rw-face))))
622 ;; Make more local variables.
623 (make-local-variable 'forms--file-buffer)
624 (make-local-variable 'forms--total-records)
625 (make-local-variable 'forms--current-record)
626 (make-local-variable 'forms--the-record-list)
627 (make-local-variable 'forms--search-regexp)
629 ; The keymaps are global, so multiple forms mode buffers can share them.
630 ;(make-local-variable 'forms-mode-map)
631 ;(make-local-variable 'forms-mode-ro-map)
632 ;(make-local-variable 'forms-mode-edit-map)
633 (if forms-mode-map ; already defined
635 ;;(message "forms: building keymap...")
636 (forms--mode-commands)
637 ;;(message "forms: building keymap... done.")
640 ;; set the major mode indicator
641 (setq major-mode 'forms-mode)
642 (setq mode-name "Forms")
644 ;; find the data file
645 (setq forms--file-buffer (find-file-noselect forms-file))
647 ;; Pre-transform.
648 (let ((read-file-filter forms-read-file-filter)
649 (write-file-filter forms-write-file-filter))
650 (if read-file-filter
651 (save-excursion
652 (set-buffer forms--file-buffer)
653 (let ((inhibit-read-only t)
654 (file-modified (buffer-modified-p)))
655 (run-hooks 'read-file-filter)
656 (if (not file-modified) (set-buffer-modified-p nil)))
657 (if write-file-filter
658 (progn
659 (make-variable-buffer-local 'local-write-file-hooks)
660 (setq local-write-file-hooks (list write-file-filter)))))
661 (if write-file-filter
662 (save-excursion
663 (set-buffer forms--file-buffer)
664 (make-variable-buffer-local 'local-write-file-hooks)
665 (setq local-write-file-hooks (list write-file-filter))))))
667 ;; count the number of records, and set see if it may be modified
668 (let (ro)
669 (setq forms--total-records
670 (save-excursion
671 (prog1
672 (progn
673 ;;(message "forms: counting records...")
674 (set-buffer forms--file-buffer)
675 (bury-buffer (current-buffer))
676 (setq ro buffer-read-only)
677 (count-lines (point-min) (point-max)))
678 ;;(message "forms: counting records... done.")
680 (if ro
681 (setq forms-read-only t)))
683 ;;(message "forms: proceeding setup...")
685 ;; Since we aren't really implementing a minor mode, we hack the modeline
686 ;; directly to get the text " View " into forms-read-only form buffers. For
687 ;; that reason, this variable must be buffer only.
688 (make-local-variable 'minor-mode-alist)
689 (setq minor-mode-alist (list (list 'forms-read-only " View")))
691 ;;(message "forms: proceeding setup (keymaps)...")
692 (forms--set-keymaps)
693 ;;(message "forms: proceeding setup (commands)...")
694 (forms--change-commands)
696 ;;(message "forms: proceeding setup (buffer)...")
697 (set-buffer-modified-p nil)
699 (if (= forms--total-records 0)
700 ;;(message "forms: proceeding setup (new file)...")
701 (progn
702 (insert
703 "GNU Emacs Forms Mode version " forms-version "\n\n"
704 (if (file-exists-p forms-file)
705 (concat "No records available in file `" forms-file "'\n\n")
706 (format "Creating new file `%s'\nwith %d field%s per record\n\n"
707 forms-file forms-number-of-fields
708 (if (= 1 forms-number-of-fields) "" "s")))
709 "Use " (substitute-command-keys "\\[forms-insert-record]")
710 " to create new records.\n")
711 (setq forms--current-record 1)
712 (setq buffer-read-only t)
713 (set-buffer-modified-p nil))
715 ;; setup the first (or current) record to show
716 (if (< forms--current-record 1)
717 (setq forms--current-record 1))
718 (forms-jump-record forms--current-record)
720 (if forms-insert-after
721 (forms-last-record)
722 (forms-first-record))
725 ;; user customising
726 ;;(message "forms: proceeding setup (user hooks)...")
727 (run-hooks 'forms-mode-hooks)
728 ;;(message "forms: setting up... done.")
730 ;; be helpful
731 (forms--help)
734 (defun forms--process-format-list ()
735 ;; Validate `forms-format-list' and set some global variables.
736 ;; Symbols in the list are evaluated, and consecutive strings are
737 ;; concatenated.
738 ;; Array `forms--elements' is constructed that contains the order
739 ;; of the fields on the display. This array is used by
740 ;; `forms--parser-using-text-properties' to extract the fields data
741 ;; from the form on the screen.
742 ;; Upon completion, `forms-format-list' is guaranteed correct, so
743 ;; `forms--make-format' and `forms--make-parser' do not need to perform
744 ;; any checks.
746 ;; Verify that `forms-format-list' is not nil.
747 (or forms-format-list
748 (error (concat "Forms control file error: "
749 "`forms-format-list' has not been set")))
750 ;; It must be a list.
751 (or (listp forms-format-list)
752 (error (concat "Forms control file error: "
753 "`forms-format-list' is not a list")))
755 ;; Assume every field is painted once.
756 ;; `forms--elements' will grow if needed.
757 (setq forms--elements (make-vector forms-number-of-fields nil))
759 (let ((the-list forms-format-list) ; the list of format elements
760 (this-item 0) ; element in list
761 (prev-item nil)
762 (field-num 0)) ; highest field number
764 (setq forms-format-list nil) ; gonna rebuild
766 (while the-list
768 (let ((el (car-safe the-list))
769 (rem (cdr-safe the-list)))
771 ;; If it is a symbol, eval it first.
772 (if (and (symbolp el)
773 (boundp el))
774 (setq el (eval el)))
776 (cond
778 ;; Try string ...
779 ((stringp el)
780 (if (stringp prev-item) ; try to concatenate strings
781 (setq prev-item (concat prev-item el))
782 (if prev-item
783 (setq forms-format-list
784 (append forms-format-list (list prev-item) nil)))
785 (setq prev-item el)))
787 ;; Try numeric ...
788 ((numberp el)
790 ;; Validate range.
791 (if (or (<= el 0)
792 (> el forms-number-of-fields))
793 (error (concat "Forms format error: "
794 "field number %d out of range 1..%d")
795 el forms-number-of-fields))
797 ;; Store forms order.
798 (if (>= field-num (length forms--elements))
799 (setq forms--elements (vconcat forms--elements (1- el)))
800 (aset forms--elements field-num (1- el)))
801 (setq field-num (1+ field-num))
803 (if prev-item
804 (setq forms-format-list
805 (append forms-format-list (list prev-item) nil)))
806 (setq prev-item el))
808 ;; Try function ...
809 ((listp el)
811 ;; Validate.
812 (or (fboundp (car-safe el))
813 (error (concat "Forms format error: "
814 "%S is not a function")
815 (car-safe el)))
817 ;; Shift.
818 (if prev-item
819 (setq forms-format-list
820 (append forms-format-list (list prev-item) nil)))
821 (setq prev-item el))
823 ;; else
825 (error (concat "Forms format error: "
826 "invalid element %S")
827 el)))
829 ;; Advance to next element of the list.
830 (setq the-list rem)))
832 ;; Append last item.
833 (if prev-item
834 (progn
835 (setq forms-format-list
836 (append forms-format-list (list prev-item) nil))
837 ;; Append a newline if the last item is a field.
838 ;; This prevents parsing problems.
839 ;; Also it makes it possible to insert an empty last field.
840 (if (numberp prev-item)
841 (setq forms-format-list
842 (append forms-format-list (list "\n") nil))))))
844 (forms--debug 'forms-format-list
845 'forms--elements))
847 ;; Special treatment for read-only segments.
849 ;; If text is inserted between two read-only segments, there seems to
850 ;; be no way to give the newly inserted text the RW face.
851 ;; To solve this, read-only segments get the `insert-in-front-hooks'
852 ;; property set with a function that temporarily switches the
853 ;; properties of the first character of the segment to the RW face, so
854 ;; the new text gets the right face. The `post-command-hook' is
855 ;; used to restore the original properties.
857 (defvar forms--iif-start nil
858 "Record start of modification command.")
859 (defvar forms--iif-properties nil
860 "Original properties of the character being overridden.")
862 (defun forms--iif-hook (begin end)
863 "`insert-in-front-hooks' function for read-only segments."
865 ;; Note start location. By making it a marker that points one
866 ;; character beyond the actual location, it is guaranteed to move
867 ;; correctly if text is inserted.
868 (or forms--iif-start
869 (setq forms--iif-start (copy-marker (1+ (point)))))
871 ;; Check if there is special treatment required.
872 (if (or (<= forms--iif-start 2)
873 (get-text-property (- forms--iif-start 2)
874 'read-only))
875 (progn
876 ;; Fetch current properties.
877 (setq forms--iif-properties
878 (text-properties-at (1- forms--iif-start)))
880 ;; Replace them.
881 (let ((inhibit-read-only t))
882 (set-text-properties
883 (1- forms--iif-start) forms--iif-start
884 (list 'face forms--rw-face 'front-sticky '(face))))
886 ;; Enable `post-command-hook' to restore the properties.
887 (setq post-command-hook
888 (append (list 'forms--iif-post-command-hook) post-command-hook)))
890 ;; No action needed. Clear marker.
891 (setq forms--iif-start nil)))
893 (defun forms--iif-post-command-hook ()
894 "`post-command-hook' function for read-only segments."
896 ;; Disable `post-command-hook'.
897 (setq post-command-hook
898 (delq 'forms--iif-hook-post-command-hook post-command-hook))
900 ;; Restore properties.
901 (if forms--iif-start
902 (let ((inhibit-read-only t))
903 (set-text-properties
904 (1- forms--iif-start) forms--iif-start
905 forms--iif-properties)))
907 ;; Cleanup.
908 (setq forms--iif-start nil))
910 (defvar forms--marker)
911 (defvar forms--dyntext)
913 (defun forms--make-format ()
914 "Generate `forms--format' using the information in `forms-format-list'."
916 ;; The real work is done using a mapcar of `forms--make-format-elt' on
917 ;; `forms-format-list'.
918 ;; This function sets up the necessary environment, and decides
919 ;; which function to mapcar.
921 (let ((forms--marker 0)
922 (forms--dyntext 0))
923 (setq
924 forms--format
925 (if forms-use-text-properties
926 `(lambda (arg)
927 (let ((inhibit-read-only t))
928 ,@(apply 'append
929 (mapcar 'forms--make-format-elt-using-text-properties
930 forms-format-list))
931 ;; Prevent insertion before the first text.
932 ,@(if (numberp (car forms-format-list))
934 '((add-text-properties (point-min) (1+ (point-min))
935 '(front-sticky (read-only intangible)))))
936 ;; Prevent insertion after the last text.
937 (remove-text-properties (1- (point)) (point)
938 '(rear-nonsticky)))
939 (setq forms--iif-start nil))
940 `(lambda (arg)
941 ,@(apply 'append
942 (mapcar 'forms--make-format-elt forms-format-list)))))
944 ;; We have tallied the number of markers and dynamic texts,
945 ;; so we can allocate the arrays now.
946 (setq forms--markers (make-vector forms--marker nil))
947 (setq forms--dyntexts (make-vector forms--dyntext nil)))
948 (forms--debug 'forms--format))
950 (defun forms--make-format-elt-using-text-properties (el)
951 "Helper routine to generate format function."
953 ;; The format routine `forms--format' will look like
955 ;; ;; preamble
956 ;; (lambda (arg)
957 ;; (let ((inhibit-read-only t))
959 ;; ;; A string, e.g. "text: ".
960 ;; (set-text-properties
961 ;; (point)
962 ;; (progn (insert "text: ") (point))
963 ;; (list 'face forms--ro-face
964 ;; 'read-only 1
965 ;; 'insert-in-front-hooks 'forms--iif-hook
966 ;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
968 ;; ;; A field, e.g. 6.
969 ;; (let ((here (point)))
970 ;; (aset forms--markers 0 (point-marker))
971 ;; (insert (elt arg 5))
972 ;; (or (= (point) here)
973 ;; (set-text-properties
974 ;; here (point)
975 ;; (list 'face forms--rw-face
976 ;; 'front-sticky '(face))))
978 ;; ;; Another string, e.g. "\nmore text: ".
979 ;; (set-text-properties
980 ;; (point)
981 ;; (progn (insert "\nmore text: ") (point))
982 ;; (list 'face forms--ro-face
983 ;; 'read-only 2
984 ;; 'insert-in-front-hooks 'forms--iif-hook
985 ;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
987 ;; ;; A function, e.g. (tocol 40).
988 ;; (set-text-properties
989 ;; (point)
990 ;; (progn
991 ;; (insert (aset forms--dyntexts 0 (tocol 40)))
992 ;; (point))
993 ;; (list 'face forms--ro-face
994 ;; 'read-only 2
995 ;; 'insert-in-front-hooks 'forms--iif-hook
996 ;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
998 ;; ;; Prevent insertion before the first text.
999 ;; (add-text-properties (point-min) (1+ (point-min))
1000 ;; '(front-sticky (read-only))))))
1001 ;; ;; Prevent insertion after the last text.
1002 ;; (remove-text-properties (1- (point)) (point)
1003 ;; '(rear-nonsticky)))
1005 ;; ;; wrap up
1006 ;; (setq forms--iif-start nil)
1007 ;; ))
1009 (cond
1010 ((stringp el)
1012 `((set-text-properties
1013 (point) ; start at point
1014 (progn ; until after insertion
1015 (insert ,el)
1016 (point))
1017 (list 'face forms--ro-face ; read-only appearance
1018 'read-only ,@(list (1+ forms--marker))
1019 'intangible ,@(list (1+ forms--marker))
1020 'insert-in-front-hooks '(forms--iif-hook)
1021 'rear-nonsticky '(face read-only insert-in-front-hooks
1022 intangible)))))
1024 ((numberp el)
1025 `((let ((here (point)))
1026 (aset forms--markers
1027 ,(prog1 forms--marker
1028 (setq forms--marker (1+ forms--marker)))
1029 (point-marker))
1030 (insert (elt arg ,(1- el)))
1031 (or (= (point) here)
1032 (set-text-properties
1033 here (point)
1034 (list 'face forms--rw-face
1035 'front-sticky '(face)))))))
1037 ((listp el)
1038 `((set-text-properties
1039 (point)
1040 (progn
1041 (insert (aset forms--dyntexts
1042 ,(prog1 forms--dyntext
1043 (setq forms--dyntext (1+ forms--dyntext)))
1044 ,el))
1045 (point))
1046 (list 'face forms--ro-face
1047 'read-only ,@(list (1+ forms--marker))
1048 'intangible ,@(list (1+ forms--marker))
1049 'insert-in-front-hooks '(forms--iif-hook)
1050 'rear-nonsticky '(read-only face insert-in-front-hooks
1051 intangible)))))
1053 ;; end of cond
1056 (defun forms--make-format-elt (el)
1057 "Helper routine to generate format function."
1059 ;; If we're not using text properties, the format routine
1060 ;; `forms--format' will look like
1062 ;; (lambda (arg)
1063 ;; ;; a string, e.g. "text: "
1064 ;; (insert "text: ")
1065 ;; ;; a field, e.g. 6
1066 ;; (aset forms--markers 0 (point-marker))
1067 ;; (insert (elt arg 5))
1068 ;; ;; another string, e.g. "\nmore text: "
1069 ;; (insert "\nmore text: ")
1070 ;; ;; a function, e.g. (tocol 40)
1071 ;; (insert (aset forms--dyntexts 0 (tocol 40)))
1072 ;; ... )
1074 (cond
1075 ((stringp el)
1076 `((insert ,el)))
1077 ((numberp el)
1078 (prog1
1079 `((aset forms--markers ,forms--marker (point-marker))
1080 (insert (elt arg ,(1- el))))
1081 (setq forms--marker (1+ forms--marker))))
1082 ((listp el)
1083 (prog1
1084 `((insert (aset forms--dyntexts ,forms--dyntext ,el)))
1085 (setq forms--dyntext (1+ forms--dyntext))))))
1087 (defvar forms--field)
1088 (defvar forms--recordv)
1089 (defvar forms--seen-text)
1091 (defun forms--make-parser ()
1092 "Generate `forms--parser' from the information in `forms-format-list'."
1094 ;; If we can use text properties, we simply set it to
1095 ;; `forms--parser-using-text-properties'.
1096 ;; Otherwise, the function is constructed using a mapcar of
1097 ;; `forms--make-parser-elt on `forms-format-list'.
1099 (setq
1100 forms--parser
1101 (if forms-use-text-properties
1102 (function forms--parser-using-text-properties)
1103 (let ((forms--field nil)
1104 (forms--seen-text nil)
1105 (forms--dyntext 0))
1107 ;; Note: we add a nil element to the list passed to `mapcar',
1108 ;; see `forms--make-parser-elt' for details.
1109 `(lambda nil
1110 (let (here)
1111 (goto-char (point-min))
1112 ,@(apply 'append
1113 (mapcar
1114 'forms--make-parser-elt
1115 (append forms-format-list (list nil)))))))))
1117 (forms--debug 'forms--parser))
1119 (defun forms--parser-using-text-properties ()
1120 "Extract field info from forms when using text properties."
1122 ;; Using text properties, we can simply jump to the markers, and
1123 ;; extract the information up to the following read-only segment.
1125 (let ((i 0)
1126 here there)
1127 (while (< i (length forms--markers))
1128 (goto-char (setq here (aref forms--markers i)))
1129 (if (get-text-property here 'read-only)
1130 (aset forms--recordv (aref forms--elements i) nil)
1131 (if (setq there
1132 (next-single-property-change here 'read-only))
1133 (aset forms--recordv (aref forms--elements i)
1134 (buffer-substring-no-properties here there))
1135 (aset forms--recordv (aref forms--elements i)
1136 (buffer-substring-no-properties here (point-max)))))
1137 (setq i (1+ i)))))
1139 (defun forms--make-parser-elt (el)
1140 "Helper routine to generate forms parser function."
1142 ;; The parse routine will look like:
1144 ;; (lambda nil
1145 ;; (let (here)
1146 ;; (goto-char (point-min))
1148 ;; ;; "text: "
1149 ;; (if (not (looking-at "text: "))
1150 ;; (error "Parse error: cannot find \"text: \""))
1151 ;; (forward-char 6) ; past "text: "
1153 ;; ;; 6
1154 ;; ;; "\nmore text: "
1155 ;; (setq here (point))
1156 ;; (if (not (search-forward "\nmore text: " nil t nil))
1157 ;; (error "Parse error: cannot find \"\\nmore text: \""))
1158 ;; (aset forms--recordv 5 (buffer-substring-no-properties here (- (point) 12)))
1160 ;; ;; (tocol 40)
1161 ;; (let ((forms--dyntext (car-safe forms--dynamic-text)))
1162 ;; (if (not (looking-at (regexp-quote forms--dyntext)))
1163 ;; (error "Parse error: not looking at \"%s\"" forms--dyntext))
1164 ;; (forward-char (length forms--dyntext))
1165 ;; (setq forms--dynamic-text (cdr-safe forms--dynamic-text)))
1166 ;; ...
1167 ;; ;; final flush (due to terminator sentinel, see below)
1168 ;; (aset forms--recordv 7 (buffer-substring-no-properties (point) (point-max)))
1170 (cond
1171 ((stringp el)
1172 (prog1
1173 (if forms--field
1174 `((setq here (point))
1175 (if (not (search-forward ,el nil t nil))
1176 (error "Parse error: cannot find `%s'" ,el))
1177 (aset forms--recordv ,(1- forms--field)
1178 (buffer-substring-no-properties here
1179 (- (point) ,(length el)))))
1180 `((if (not (looking-at ,(regexp-quote el)))
1181 (error "Parse error: not looking at `%s'" ,el))
1182 (forward-char ,(length el))))
1183 (setq forms--seen-text t)
1184 (setq forms--field nil)))
1185 ((numberp el)
1186 (if forms--field
1187 (error "Cannot parse adjacent fields %d and %d"
1188 forms--field el)
1189 (setq forms--field el)
1190 nil))
1191 ((null el)
1192 (if forms--field
1193 `((aset forms--recordv ,(1- forms--field)
1194 (buffer-substring-no-properties (point) (point-max))))))
1195 ((listp el)
1196 (prog1
1197 (if forms--field
1198 `((let ((here (point))
1199 (forms--dyntext (aref forms--dyntexts ,forms--dyntext)))
1200 (if (not (search-forward forms--dyntext nil t nil))
1201 (error "Parse error: cannot find `%s'" forms--dyntext))
1202 (aset forms--recordv ,(1- forms--field)
1203 (buffer-substring-no-properties here
1204 (- (point) (length forms--dyntext))))))
1205 `((let ((forms--dyntext (aref forms--dyntexts ,forms--dyntext)))
1206 (if (not (looking-at (regexp-quote forms--dyntext)))
1207 (error "Parse error: not looking at `%s'" forms--dyntext))
1208 (forward-char (length forms--dyntext)))))
1209 (setq forms--dyntext (1+ forms--dyntext))
1210 (setq forms--seen-text t)
1211 (setq forms--field nil)))
1214 (defun forms--intuit-from-file ()
1215 "Get number of fields and a default form using the data file."
1217 ;; If `forms-number-of-fields' is not set, get it from the data file.
1218 (if (null forms-number-of-fields)
1220 ;; Need a file to do this.
1221 (if (not (file-exists-p forms-file))
1222 (error "Need existing file or explicit 'forms-number-of-records'.")
1224 ;; Visit the file and extract the first record.
1225 (setq forms--file-buffer (find-file-noselect forms-file))
1226 (let ((read-file-filter forms-read-file-filter)
1227 (the-record))
1228 (setq the-record
1229 (save-excursion
1230 (set-buffer forms--file-buffer)
1231 (let ((inhibit-read-only t))
1232 (run-hooks 'read-file-filter))
1233 (goto-char (point-min))
1234 (forms--get-record)))
1236 ;; This may be overkill, but try to avoid interference with
1237 ;; the normal processing.
1238 (kill-buffer forms--file-buffer)
1240 ;; Count the number of fields in `the-record'.
1241 (let (the-result
1242 (start-pos 0)
1243 found-pos
1244 (field-sep-length (length forms-field-sep)))
1245 (setq forms-number-of-fields 1)
1246 (while (setq found-pos
1247 (string-match forms-field-sep the-record start-pos))
1248 (progn
1249 (setq forms-number-of-fields (1+ forms-number-of-fields))
1250 (setq start-pos (+ field-sep-length found-pos))))))))
1252 ;; Construct default format list.
1253 (setq forms-format-list (list "Forms file \"" forms-file "\".\n\n"))
1254 (let ((i 0))
1255 (while (<= (setq i (1+ i)) forms-number-of-fields)
1256 (setq forms-format-list
1257 (append forms-format-list
1258 (list (format "%4d: " i) i "\n"))))))
1260 (defun forms--set-keymaps ()
1261 "Set the keymaps used in this mode."
1263 (use-local-map (if forms-read-only
1264 forms-mode-ro-map
1265 forms-mode-edit-map)))
1267 (defun forms--mode-commands ()
1268 "Fill the Forms mode keymaps."
1270 ;; `forms-mode-map' is always accessible via \C-c prefix.
1271 (setq forms-mode-map (make-keymap))
1272 (define-key forms-mode-map "\t" 'forms-next-field)
1273 (define-key forms-mode-map "\C-k" 'forms-delete-record)
1274 (define-key forms-mode-map "\C-q" 'forms-toggle-read-only)
1275 (define-key forms-mode-map "\C-o" 'forms-insert-record)
1276 (define-key forms-mode-map "\C-l" 'forms-jump-record)
1277 (define-key forms-mode-map "\C-n" 'forms-next-record)
1278 (define-key forms-mode-map "\C-p" 'forms-prev-record)
1279 (define-key forms-mode-map "\C-r" 'forms-search-backward)
1280 (define-key forms-mode-map "\C-s" 'forms-search-forward)
1281 (define-key forms-mode-map "\C-x" 'forms-exit)
1282 (define-key forms-mode-map "<" 'forms-first-record)
1283 (define-key forms-mode-map ">" 'forms-last-record)
1284 (define-key forms-mode-map "\C-?" 'forms-prev-record)
1286 ;; `forms-mode-ro-map' replaces the local map when in read-only mode.
1287 (setq forms-mode-ro-map (make-keymap))
1288 (suppress-keymap forms-mode-ro-map)
1289 (define-key forms-mode-ro-map "\C-c" forms-mode-map)
1290 (define-key forms-mode-ro-map "\t" 'forms-next-field)
1291 (define-key forms-mode-ro-map "q" 'forms-toggle-read-only)
1292 (define-key forms-mode-ro-map "l" 'forms-jump-record)
1293 (define-key forms-mode-ro-map "n" 'forms-next-record)
1294 (define-key forms-mode-ro-map "p" 'forms-prev-record)
1295 (define-key forms-mode-ro-map "r" 'forms-search-backward)
1296 (define-key forms-mode-ro-map "s" 'forms-search-forward)
1297 (define-key forms-mode-ro-map "x" 'forms-exit)
1298 (define-key forms-mode-ro-map "<" 'forms-first-record)
1299 (define-key forms-mode-ro-map ">" 'forms-last-record)
1300 (define-key forms-mode-ro-map "?" 'describe-mode)
1301 (define-key forms-mode-ro-map " " 'forms-next-record)
1302 (forms--mode-commands1 forms-mode-ro-map)
1303 (forms--mode-menu-ro forms-mode-ro-map)
1305 ;; This is the normal, local map.
1306 (setq forms-mode-edit-map (make-keymap))
1307 (define-key forms-mode-edit-map "\t" 'forms-next-field)
1308 (define-key forms-mode-edit-map "\C-c" forms-mode-map)
1309 (forms--mode-commands1 forms-mode-edit-map)
1310 (forms--mode-menu-edit forms-mode-edit-map)
1313 (defun forms--mode-menu-ro (map)
1314 ;;; Menu initialisation
1315 ; (define-key map [menu-bar] (make-sparse-keymap))
1316 (define-key map [menu-bar forms]
1317 (cons "Forms" (make-sparse-keymap "Forms")))
1318 (define-key map [menu-bar forms menu-forms-exit]
1319 '("Exit Forms Mode" . forms-exit))
1320 (define-key map [menu-bar forms menu-forms-sep1]
1321 '("----"))
1322 (define-key map [menu-bar forms menu-forms-save]
1323 '("Save Data" . forms-save-buffer))
1324 (define-key map [menu-bar forms menu-forms-print]
1325 '("Print Data" . forms-print))
1326 (define-key map [menu-bar forms menu-forms-describe]
1327 '("Describe Mode" . describe-mode))
1328 (define-key map [menu-bar forms menu-forms-toggle-ro]
1329 '("Toggle View/Edit" . forms-toggle-read-only))
1330 (define-key map [menu-bar forms menu-forms-jump-record]
1331 '("Jump" . forms-jump-record))
1332 (define-key map [menu-bar forms menu-forms-search-backward]
1333 '("Search Backward" . forms-search-backward))
1334 (define-key map [menu-bar forms menu-forms-search-forward]
1335 '("Search Forward" . forms-search-forward))
1336 (define-key map [menu-bar forms menu-forms-delete-record]
1337 '("Delete" . forms-delete-record))
1338 (define-key map [menu-bar forms menu-forms-insert-record]
1339 '("Insert" . forms-insert-record))
1340 (define-key map [menu-bar forms menu-forms-sep2]
1341 '("----"))
1342 (define-key map [menu-bar forms menu-forms-last-record]
1343 '("Last Record" . forms-last-record))
1344 (define-key map [menu-bar forms menu-forms-first-record]
1345 '("First Record" . forms-first-record))
1346 (define-key map [menu-bar forms menu-forms-prev-record]
1347 '("Previous Record" . forms-prev-record))
1348 (define-key map [menu-bar forms menu-forms-next-record]
1349 '("Next Record" . forms-next-record))
1350 (define-key map [menu-bar forms menu-forms-sep3]
1351 '("----"))
1352 (define-key map [menu-bar forms menu-forms-prev-field]
1353 '("Previous Field" . forms-prev-field))
1354 (define-key map [menu-bar forms menu-forms-next-field]
1355 '("Next Field" . forms-next-field))
1356 (put 'forms-insert-record 'menu-enable '(not forms-read-only))
1357 (put 'forms-delete-record 'menu-enable '(not forms-read-only))
1359 (defun forms--mode-menu-edit (map)
1360 ;;; Menu initialisation
1361 ; (define-key map [menu-bar] (make-sparse-keymap))
1362 (define-key map [menu-bar forms]
1363 (cons "Forms" (make-sparse-keymap "Forms")))
1364 (define-key map [menu-bar forms menu-forms-edit--exit]
1365 '("Exit" . forms-exit))
1366 (define-key map [menu-bar forms menu-forms-edit-sep1]
1367 '("----"))
1368 (define-key map [menu-bar forms menu-forms-edit-save]
1369 '("Save Data" . forms-save-buffer))
1370 (define-key map [menu-bar forms menu-forms-edit-print]
1371 '("Print Data" . forms-print))
1372 (define-key map [menu-bar forms menu-forms-edit-describe]
1373 '("Describe Mode" . describe-mode))
1374 (define-key map [menu-bar forms menu-forms-edit-toggle-ro]
1375 '("Toggle View/Edit" . forms-toggle-read-only))
1376 (define-key map [menu-bar forms menu-forms-edit-jump-record]
1377 '("Jump" . forms-jump-record))
1378 (define-key map [menu-bar forms menu-forms-edit-search-backward]
1379 '("Search Backward" . forms-search-backward))
1380 (define-key map [menu-bar forms menu-forms-edit-search-forward]
1381 '("Search Forward" . forms-search-forward))
1382 (define-key map [menu-bar forms menu-forms-edit-delete-record]
1383 '("Delete" . forms-delete-record))
1384 (define-key map [menu-bar forms menu-forms-edit-insert-record]
1385 '("Insert" . forms-insert-record))
1386 (define-key map [menu-bar forms menu-forms-edit-sep2]
1387 '("----"))
1388 (define-key map [menu-bar forms menu-forms-edit-last-record]
1389 '("Last Record" . forms-last-record))
1390 (define-key map [menu-bar forms menu-forms-edit-first-record]
1391 '("First Record" . forms-first-record))
1392 (define-key map [menu-bar forms menu-forms-edit-prev-record]
1393 '("Previous Record" . forms-prev-record))
1394 (define-key map [menu-bar forms menu-forms-edit-next-record]
1395 '("Next Record" . forms-next-record))
1396 (define-key map [menu-bar forms menu-forms-edit-sep3]
1397 '("----"))
1398 (define-key map [menu-bar forms menu-forms-edit-prev-field]
1399 '("Previous Field" . forms-prev-field))
1400 (define-key map [menu-bar forms menu-forms-edit-next-field]
1401 '("Next Field" . forms-next-field))
1402 (put 'forms-insert-record 'menu-enable '(not forms-read-only))
1403 (put 'forms-delete-record 'menu-enable '(not forms-read-only))
1406 (defun forms--mode-commands1 (map)
1407 "Helper routine to define keys."
1408 (define-key map [TAB] 'forms-next-field)
1409 (define-key map [S-tab] 'forms-prev-field)
1410 (define-key map [next] 'forms-next-record)
1411 (define-key map [prior] 'forms-prev-record)
1412 (define-key map [begin] 'forms-first-record)
1413 (define-key map [last] 'forms-last-record)
1414 (define-key map [backtab] 'forms-prev-field)
1417 ;;; Changed functions
1419 (defun forms--change-commands ()
1420 "Localize some commands for Forms mode."
1422 ;; scroll-down -> forms-prev-record
1423 ;; scroll-up -> forms-next-record
1424 (if forms-forms-scroll
1425 (progn
1426 (substitute-key-definition 'scroll-up 'forms-next-record
1427 (current-local-map)
1428 (current-global-map))
1429 (substitute-key-definition 'scroll-down 'forms-prev-record
1430 (current-local-map)
1431 (current-global-map))))
1433 ;; beginning-of-buffer -> forms-first-record
1434 ;; end-of-buffer -> forms-end-record
1435 (if forms-forms-jump
1436 (progn
1437 (substitute-key-definition 'beginning-of-buffer 'forms-first-record
1438 (current-local-map)
1439 (current-global-map))
1440 (substitute-key-definition 'end-of-buffer 'forms-last-record
1441 (current-local-map)
1442 (current-global-map))))
1444 ;; Save buffer
1445 (local-set-key "\C-x\C-s" 'forms-save-buffer)
1447 ;; We have our own revert function - use it.
1448 (make-local-variable 'revert-buffer-function)
1449 (setq revert-buffer-function 'forms--revert-buffer)
1453 (defun forms--help ()
1454 "Initial help for Forms mode."
1455 (message "%s" (substitute-command-keys (concat
1456 "\\[forms-next-record]:next"
1457 " \\[forms-prev-record]:prev"
1458 " \\[forms-first-record]:first"
1459 " \\[forms-last-record]:last"
1460 " \\[describe-mode]:help"))))
1462 (defun forms--trans (subj arg rep)
1463 "Translate in SUBJ all chars ARG into char REP. ARG and REP should
1464 be single-char strings."
1465 (let ((i 0)
1466 (x (length subj))
1467 (re (regexp-quote arg))
1468 (k (string-to-char rep)))
1469 (while (setq i (string-match re subj i))
1470 (aset subj i k)
1471 (setq i (1+ i)))))
1473 (defun forms--exit (query &optional save)
1474 "Internal exit from forms mode function."
1476 (let ((buf (buffer-name forms--file-buffer)))
1477 (forms--checkmod)
1478 (if (and save
1479 (buffer-modified-p forms--file-buffer))
1480 (forms-save-buffer))
1481 (save-excursion
1482 (set-buffer forms--file-buffer)
1483 (delete-auto-save-file-if-necessary)
1484 (kill-buffer (current-buffer)))
1485 (if (get-buffer buf) ; not killed???
1486 (if save
1487 (error "Problem saving buffer %s" (buffer-name buf)))
1488 (delete-auto-save-file-if-necessary)
1489 (kill-buffer (current-buffer)))))
1491 (defun forms--get-record ()
1492 "Fetch the current record from the file buffer."
1494 ;; This function is executed in the context of the `forms--file-buffer'.
1496 (or (bolp)
1497 (beginning-of-line nil))
1498 (let ((here (point)))
1499 (prog2
1500 (end-of-line)
1501 (buffer-substring-no-properties here (point))
1502 (goto-char here))))
1504 (defun forms--show-record (the-record)
1505 "Format THE-RECORD and display it in the current buffer."
1507 ;; Split the-record.
1508 (let (the-result
1509 (start-pos 0)
1510 found-pos
1511 (field-sep-length (length forms-field-sep)))
1512 (if forms-multi-line
1513 (forms--trans the-record forms-multi-line "\n"))
1514 ;; Add an extra separator (makes splitting easy).
1515 (setq the-record (concat the-record forms-field-sep))
1516 (while (setq found-pos (string-match forms-field-sep the-record start-pos))
1517 (let ((ent (substring the-record start-pos found-pos)))
1518 (setq the-result
1519 (append the-result (list ent)))
1520 (setq start-pos (+ field-sep-length found-pos))))
1521 (setq forms--the-record-list the-result))
1523 (setq buffer-read-only nil)
1524 (if forms-use-text-properties
1525 (let ((inhibit-read-only t))
1526 (set-text-properties (point-min) (point-max) nil)))
1527 (erase-buffer)
1529 ;; Verify the number of fields, extend forms--the-record-list if needed.
1530 (if (= (length forms--the-record-list) forms-number-of-fields)
1532 (if (null forms-check-number-of-fields)
1534 (message "Warning: this record has %d fields instead of %d"
1535 (length forms--the-record-list) forms-number-of-fields))
1536 (if (< (length forms--the-record-list) forms-number-of-fields)
1537 (setq forms--the-record-list
1538 (append forms--the-record-list
1539 (make-list
1540 (- forms-number-of-fields
1541 (length forms--the-record-list))
1542 "")))))
1544 ;; Call the formatter function.
1545 (setq forms-fields (append (list nil) forms--the-record-list nil))
1546 (funcall forms--format forms--the-record-list)
1548 ;; Prepare.
1549 (goto-char (point-min))
1550 (set-buffer-modified-p nil)
1551 (setq buffer-read-only forms-read-only)
1552 (setq mode-line-process
1553 (concat " " (int-to-string forms--current-record)
1554 "/" (int-to-string forms--total-records))))
1556 (defun forms--parse-form ()
1557 "Parse contents of form into list of strings."
1558 ;; The contents of the form are parsed, and a new list of strings
1559 ;; is constructed.
1560 ;; A vector with the strings from the original record is
1561 ;; constructed, which is updated with the new contents. Therefore
1562 ;; fields which were not in the form are not modified.
1563 ;; Finally, the vector is transformed into a list for further processing.
1565 (let (forms--recordv)
1567 ;; Build the vector.
1568 (setq forms--recordv (vconcat forms--the-record-list))
1570 ;; Parse the form and update the vector.
1571 (let ((forms--dynamic-text forms--dynamic-text))
1572 (funcall forms--parser))
1574 (if forms-modified-record-filter
1575 ;; As a service to the user, we add a zeroth element so she
1576 ;; can use the same indices as in the forms definition.
1577 (let ((the-fields (vconcat [nil] forms--recordv)))
1578 (setq the-fields (funcall forms-modified-record-filter the-fields))
1579 (cdr (append the-fields nil)))
1581 ;; Transform to a list and return.
1582 (append forms--recordv nil))))
1584 (defun forms--update ()
1585 "Update current record with contents of form.
1586 As a side effect: sets `forms--the-record-list'."
1588 (if forms-read-only
1589 (error "Buffer is read-only"))
1591 (let (the-record)
1592 ;; Build new record.
1593 (setq forms--the-record-list (forms--parse-form))
1594 (setq the-record
1595 (mapconcat 'identity forms--the-record-list forms-field-sep))
1597 (if (string-match (regexp-quote forms-field-sep)
1598 (mapconcat 'identity forms--the-record-list ""))
1599 (error "Field separator occurs in record - update refused"))
1601 ;; Handle multi-line fields, if allowed.
1602 (if forms-multi-line
1603 (forms--trans the-record "\n" forms-multi-line))
1605 ;; A final sanity check before updating.
1606 (if (string-match "\n" the-record)
1607 (error "Multi-line fields in this record - update refused"))
1609 (save-excursion
1610 (set-buffer forms--file-buffer)
1611 ;; Use delete-region instead of kill-region, to avoid
1612 ;; adding junk to the kill-ring.
1613 (delete-region (save-excursion (beginning-of-line) (point))
1614 (save-excursion (end-of-line) (point)))
1615 (insert the-record)
1616 (beginning-of-line))))
1618 (defun forms--checkmod ()
1619 "Check if this form has been modified, and call forms--update if so."
1620 (if (buffer-modified-p nil)
1621 (let ((here (point)))
1622 (forms--update)
1623 (set-buffer-modified-p nil)
1624 (goto-char here))))
1626 ;;; Start and exit
1628 ;;;###autoload
1629 (defun forms-find-file (fn)
1630 "Visit a file in Forms mode."
1631 (interactive "fForms file: ")
1632 (let ((enable-local-eval t)
1633 (enable-local-variables t))
1634 (find-file-read-only fn)
1635 (or forms--mode-setup (forms-mode t))))
1637 ;;;###autoload
1638 (defun forms-find-file-other-window (fn)
1639 "Visit a file in Forms mode in other window."
1640 (interactive "fFbrowse file in other window: ")
1641 (let ((enable-local-eval t)
1642 (enable-local-variables t))
1643 (find-file-other-window fn)
1644 (or forms--mode-setup (forms-mode t))))
1646 (defun forms-exit (query)
1647 "Normal exit from Forms mode. Modified buffers are saved."
1648 (interactive "P")
1649 (forms--exit query t))
1651 (defun forms-exit-no-save (query)
1652 "Exit from Forms mode without saving buffers."
1653 (interactive "P")
1654 (forms--exit query nil))
1656 ;;; Navigating commands
1658 (defun forms-next-record (arg)
1659 "Advance to the ARGth following record."
1660 (interactive "P")
1661 (forms-jump-record (+ forms--current-record (prefix-numeric-value arg)) t))
1663 (defun forms-prev-record (arg)
1664 "Advance to the ARGth previous record."
1665 (interactive "P")
1666 (forms-jump-record (- forms--current-record (prefix-numeric-value arg)) t))
1668 (defun forms-jump-record (arg &optional relative)
1669 "Jump to a random record."
1670 (interactive "NRecord number: ")
1672 ;; Verify that the record number is within range.
1673 (if (or (> arg forms--total-records)
1674 (<= arg 0))
1675 (error
1676 ;; Don't give the message if just paging.
1677 (if (not relative)
1678 (message "Record number %d out of range 1..%d"
1679 arg forms--total-records)
1680 "")))
1682 ;; Flush.
1683 (forms--checkmod)
1685 ;; Calculate displacement.
1686 (let ((disp (- arg forms--current-record))
1687 (cur forms--current-record))
1689 ;; `forms--show-record' needs it now.
1690 (setq forms--current-record arg)
1692 ;; Get the record and show it.
1693 (forms--show-record
1694 (save-excursion
1695 (set-buffer forms--file-buffer)
1696 (beginning-of-line)
1698 ;; Move, and adjust the amount if needed (shouldn't happen).
1699 (if relative
1700 (if (zerop disp)
1702 (setq cur (+ cur disp (- (forward-line disp)))))
1703 (setq cur (+ cur disp (- (goto-line arg)))))
1705 (forms--get-record)))
1707 ;; This shouldn't happen.
1708 (if (/= forms--current-record cur)
1709 (progn
1710 (setq forms--current-record cur)
1711 (error "Stuck at record %d" cur)))))
1713 (defun forms-first-record ()
1714 "Jump to first record."
1715 (interactive)
1716 (forms-jump-record 1))
1718 (defun forms-last-record ()
1719 "Jump to last record.
1720 As a side effect: re-calculates the number of records in the data file."
1721 (interactive)
1722 (let
1723 ((numrec
1724 (save-excursion
1725 (set-buffer forms--file-buffer)
1726 (count-lines (point-min) (point-max)))))
1727 (if (= numrec forms--total-records)
1729 (setq forms--total-records numrec)
1730 (message "Warning: number of records changed to %d" forms--total-records)))
1731 (forms-jump-record forms--total-records))
1733 ;;; Other commands
1735 (defun forms-toggle-read-only (arg)
1736 "Toggles read-only mode of a forms mode buffer.
1737 With an argument, enables read-only mode if the argument is positive.
1738 Otherwise enables edit mode if the visited file is writable."
1740 (interactive "P")
1742 (if (if arg
1743 ;; Negative arg means switch it off.
1744 (<= (prefix-numeric-value arg) 0)
1745 ;; No arg means toggle.
1746 forms-read-only)
1748 ;; Enable edit mode, if possible.
1749 (let ((ro forms-read-only))
1750 (if (save-excursion
1751 (set-buffer forms--file-buffer)
1752 buffer-read-only)
1753 (progn
1754 (setq forms-read-only t)
1755 (message "No write access to `%s'" forms-file))
1756 (setq forms-read-only nil))
1757 (if (equal ro forms-read-only)
1759 (forms-mode)))
1761 ;; Enable view mode.
1762 (if forms-read-only
1764 (forms--checkmod) ; sync
1765 (setq forms-read-only t)
1766 (forms-mode))))
1768 ;; Sample:
1769 ;; (defun my-new-record-filter (the-fields)
1770 ;; ;; numbers are relative to 1
1771 ;; (aset the-fields 4 (current-time-string))
1772 ;; (aset the-fields 6 (user-login-name))
1773 ;; the-list)
1774 ;; (setq forms-new-record-filter 'my-new-record-filter)
1776 (defun forms-insert-record (arg)
1777 "Create a new record before the current one.
1778 With ARG: store the record after the current one.
1779 If `forms-new-record-filter' contains the name of a function,
1780 it is called to fill (some of) the fields with default values.
1781 If `forms-insert-after is non-nil, the default behavior is to insert
1782 after the current record."
1784 (interactive "P")
1786 (if forms-read-only
1787 (error ""))
1789 (let (ln the-list the-record)
1791 (if (or (and arg forms-insert-after)
1792 (and (not arg) (not forms-insert-after)))
1793 (setq ln forms--current-record)
1794 (setq ln (1+ forms--current-record)))
1796 (forms--checkmod)
1797 (if forms-new-record-filter
1798 ;; As a service to the user, we add a zeroth element so she
1799 ;; can use the same indices as in the forms definition.
1800 (let ((the-fields (make-vector (1+ forms-number-of-fields) "")))
1801 (setq the-fields (funcall forms-new-record-filter the-fields))
1802 (setq the-list (cdr (append the-fields nil))))
1803 (setq the-list (make-list forms-number-of-fields "")))
1805 (setq the-record
1806 (mapconcat
1807 'identity
1808 the-list
1809 forms-field-sep))
1811 (save-excursion
1812 (set-buffer forms--file-buffer)
1813 (goto-line ln)
1814 (open-line 1)
1815 (insert the-record)
1816 (beginning-of-line))
1818 (setq forms--current-record ln))
1820 (setq forms--total-records (1+ forms--total-records))
1821 (forms-jump-record forms--current-record))
1823 (defun forms-delete-record (arg)
1824 "Deletes a record. With a prefix argument: don't ask."
1825 (interactive "P")
1827 (if forms-read-only
1828 (error ""))
1830 (forms--checkmod)
1831 (if (or arg
1832 (y-or-n-p "Really delete this record? "))
1833 (let ((ln forms--current-record))
1834 (save-excursion
1835 (set-buffer forms--file-buffer)
1836 (goto-line ln)
1837 ;; Use delete-region instead of kill-region, to avoid
1838 ;; adding junk to the kill-ring.
1839 (delete-region (progn (beginning-of-line) (point))
1840 (progn (beginning-of-line 2) (point))))
1841 (setq forms--total-records (1- forms--total-records))
1842 (if (> forms--current-record forms--total-records)
1843 (setq forms--current-record forms--total-records))
1844 (forms-jump-record forms--current-record)))
1845 (message ""))
1847 (defun forms-search-forward (regexp)
1848 "Search forward for record containing REGEXP."
1849 (interactive
1850 (list (read-string (concat "Search forward for"
1851 (if forms--search-regexp
1852 (concat " ("
1853 forms--search-regexp
1854 ")"))
1855 ": "))))
1856 (if (equal "" regexp)
1857 (setq regexp forms--search-regexp))
1858 (forms--checkmod)
1860 (let (the-line the-record here
1861 (fld-sep forms-field-sep))
1862 (save-excursion
1863 (set-buffer forms--file-buffer)
1864 (end-of-line)
1865 (setq here (point))
1866 (if (or (re-search-forward regexp nil t)
1867 (and (> here (point-min))
1868 (progn
1869 (goto-char (point-min))
1870 (re-search-forward regexp here t))))
1871 (progn
1872 (setq the-record (forms--get-record))
1873 (setq the-line (1+ (count-lines (point-min) (point))))
1874 (if (< (point) here)
1875 (message "Wrapped")))
1876 (goto-char here)
1877 (error "Search failed: %s" regexp)))
1878 (setq forms--current-record the-line)
1879 (forms--show-record the-record))
1880 (re-search-forward regexp nil t)
1881 (setq forms--search-regexp regexp))
1883 (defun forms-search-backward (regexp)
1884 "Search backward for record containing REGEXP."
1885 (interactive
1886 (list (read-string (concat "Search backward for"
1887 (if forms--search-regexp
1888 (concat " ("
1889 forms--search-regexp
1890 ")"))
1891 ": "))))
1892 (if (equal "" regexp)
1893 (setq regexp forms--search-regexp))
1894 (forms--checkmod)
1896 (let (the-line the-record here
1897 (fld-sep forms-field-sep))
1898 (save-excursion
1899 (set-buffer forms--file-buffer)
1900 (beginning-of-line)
1901 (setq here (point))
1902 (if (or (re-search-backward regexp nil t)
1903 (and (< (point) (point-max))
1904 (progn
1905 (goto-char (point-max))
1906 (re-search-backward regexp here t))))
1907 (progn
1908 (setq the-record (forms--get-record))
1909 (setq the-line (1+ (count-lines (point-min) (point))))
1910 (if (> (point) here)
1911 (message "Wrapped")))
1912 (goto-char here)
1913 (error "Search failed: %s" regexp)))
1914 (setq forms--current-record the-line)
1915 (forms--show-record the-record))
1916 (re-search-forward regexp nil t)
1917 (setq forms--search-regexp regexp))
1919 (defun forms-save-buffer (&optional args)
1920 "Forms mode replacement for save-buffer.
1921 It saves the data buffer instead of the forms buffer.
1922 Calls `forms-write-file-filter' before, and `forms-read-file-filter'
1923 after writing out the data."
1924 (interactive "p")
1925 (forms--checkmod)
1926 (let ((write-file-filter forms-write-file-filter)
1927 (read-file-filter forms-read-file-filter)
1928 (cur forms--current-record))
1929 (save-excursion
1930 (set-buffer forms--file-buffer)
1931 (let ((inhibit-read-only t))
1932 ;; Write file hooks are run via local-write-file-hooks.
1933 ;; (if write-file-filter
1934 ;; (save-excursion
1935 ;; (run-hooks 'write-file-filter)))
1937 ;; If they have a write-file-filter, force the buffer to be
1938 ;; saved even if it doesn't seem to be changed. First, they
1939 ;; might have changed the write-file-filter; and second, if
1940 ;; save-buffer does nothing, write-file-filter won't get run,
1941 ;; and then read-file-filter will be mightily confused.
1942 (or (null write-file-filter)
1943 (set-buffer-modified-p t))
1944 (save-buffer args)
1945 (if read-file-filter
1946 (save-excursion
1947 (run-hooks 'read-file-filter)))
1948 (set-buffer-modified-p nil)))
1949 ;; Make sure we end up with the same record number as we started.
1950 ;; Since read-file-filter may perform arbitrary transformations on
1951 ;; the data buffer contents, save-excursion is not enough.
1952 (forms-jump-record cur))
1955 (defun forms--revert-buffer (&optional arg noconfirm)
1956 "Reverts current form to un-modified."
1957 (interactive "P")
1958 (if (or noconfirm
1959 (yes-or-no-p "Revert form to unmodified? "))
1960 (progn
1961 (set-buffer-modified-p nil)
1962 (forms-jump-record forms--current-record))))
1964 (defun forms-next-field (arg)
1965 "Jump to ARG-th next field."
1966 (interactive "p")
1968 (let ((i 0)
1969 (here (point))
1970 there
1971 (cnt 0)
1972 (inhibit-point-motion-hooks t))
1974 (if (zerop arg)
1975 (setq cnt 1)
1976 (setq cnt (+ cnt arg)))
1978 (if (catch 'done
1979 (while (< i (length forms--markers))
1980 (if (or (null (setq there (aref forms--markers i)))
1981 (<= there here))
1983 (if (<= (setq cnt (1- cnt)) 0)
1984 (progn
1985 (goto-char there)
1986 (throw 'done t))))
1987 (setq i (1+ i))))
1989 (goto-char (aref forms--markers 0)))))
1991 (defun forms-prev-field (arg)
1992 "Jump to ARG-th previous field."
1993 (interactive "p")
1995 (let ((i (length forms--markers))
1996 (here (point))
1997 there
1998 (cnt 0)
1999 (inhibit-point-motion-hooks t))
2001 (if (zerop arg)
2002 (setq cnt 1)
2003 (setq cnt (+ cnt arg)))
2005 (if (catch 'done
2006 (while (> i 0)
2007 (setq i ( 1- i))
2008 (if (or (null (setq there (aref forms--markers i)))
2009 (>= there here))
2011 (if (<= (setq cnt (1- cnt)) 0)
2012 (progn
2013 (goto-char there)
2014 (throw 'done t))))))
2016 (goto-char (aref forms--markers (1- (length forms--markers)))))))
2018 (defun forms-print ()
2019 "Send the records to the printer with 'print-buffer', one record per page."
2020 (interactive)
2021 (let ((inhibit-read-only t)
2022 (save-record forms--current-record)
2023 (total-nb-records forms--total-records)
2024 (nb-record 1)
2025 (record nil))
2026 (while (<= nb-record forms--total-records)
2027 (forms-jump-record nb-record)
2028 (setq record (buffer-string))
2029 (save-excursion
2030 (set-buffer (get-buffer-create "*forms-print*"))
2031 (goto-char (buffer-end 1))
2032 (insert record)
2033 (setq buffer-read-only nil)
2034 (if (< nb-record total-nb-records)
2035 (insert "\n\f\n")))
2036 (setq nb-record (1+ nb-record)))
2037 (save-excursion
2038 (set-buffer "*forms-print*")
2039 (print-buffer)
2040 (set-buffer-modified-p nil)
2041 (kill-buffer (current-buffer)))
2042 (forms-jump-record save-record)))
2045 ;;; Special service
2047 (defun forms-enumerate (the-fields)
2048 "Take a quoted list of symbols, and set their values to sequential numbers.
2049 The first symbol gets number 1, the second 2 and so on.
2050 It returns the highest number.
2052 Usage: (setq forms-number-of-fields
2053 (forms-enumerate
2054 '(field1 field2 field2 ...)))"
2056 (let ((the-index 0))
2057 (while the-fields
2058 (setq the-index (1+ the-index))
2059 (let ((el (car-safe the-fields)))
2060 (setq the-fields (cdr-safe the-fields))
2061 (set el the-index)))
2062 the-index))
2064 ;;; Debugging
2066 (defvar forms--debug nil
2067 "*Enables forms-mode debugging if not nil.")
2069 (defun forms--debug (&rest args)
2070 "Internal debugging routine."
2071 (if forms--debug
2072 (let ((ret nil))
2073 (while args
2074 (let ((el (car-safe args)))
2075 (setq args (cdr-safe args))
2076 (if (stringp el)
2077 (setq ret (concat ret el))
2078 (setq ret (concat ret (prin1-to-string el) " = "))
2079 (if (boundp el)
2080 (let ((vel (eval el)))
2081 (setq ret (concat ret (prin1-to-string vel) "\n")))
2082 (setq ret (concat ret "<unbound>" "\n")))
2083 (if (fboundp el)
2084 (setq ret (concat ret (prin1-to-string (symbol-function el))
2085 "\n"))))))
2086 (save-excursion
2087 (set-buffer (get-buffer-create "*forms-mode debug*"))
2088 (if (zerop (buffer-size))
2089 (emacs-lisp-mode))
2090 (goto-char (point-max))
2091 (insert ret)))))
2093 ;;; forms.el ends here.