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