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