13337
|
1 ;;; forms.el --- Forms mode: edit a file as a form to fill in
|
|
2
|
74442
|
3 ;; Copyright (C) 1991, 1994, 1995, 1996, 1997, 2001, 2002, 2003,
|
79721
|
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
|
307
|
5
|
13317
|
6 ;; Author: Johan Vromans <jvromans@squirrel.nl>
|
3697
|
7
|
|
8 ;; This file is part of GNU Emacs.
|
276
|
9
|
94678
|
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
|
3697
|
11 ;; it under the terms of the GNU General Public License as published by
|
94678
|
12 ;; the Free Software Foundation, either version 3 of the License, or
|
|
13 ;; (at your option) any later version.
|
276
|
14
|
3697
|
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.
|
307
|
19
|
3697
|
20 ;; You should have received a copy of the GNU General Public License
|
94678
|
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
3697
|
22
|
|
23 ;;; Commentary:
|
276
|
24
|
94359
|
25 ;; Visit a file using a form. See forms-d2.el for examples.
|
14169
|
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 ;;
|
49588
|
33 ;; All variables are buffer-local, to enable multiple forms visits
|
14169
|
34 ;; simultaneously.
|
49588
|
35 ;; Variable `forms--mode-setup' is local to *ALL* buffers, for it
|
14169
|
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 ;;
|
24655
|
56 ;; Forms mode is invoked using M-x `forms-find-file' control-file.
|
14169
|
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
|
24655
|
60 ;; with M-x `forms-mode'.
|
14169
|
61 ;;
|
49588
|
62 ;; Automatic mode switching is supported if you specify
|
14169
|
63 ;; "-*- forms -*-" in the first line of the control file.
|
49588
|
64 ;;
|
62459
|
65 ;; The control file is visited, evaluated using `eval-buffer',
|
14169
|
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".
|
49588
|
81 ;;
|
14169
|
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.
|
49588
|
85 ;;
|
14169
|
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.
|
49588
|
91 ;;
|
14169
|
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
|
49588
|
104 ;; possible, view mode is enforced.
|
14169
|
105 ;;
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
106 ;; forms-check-number-of-fields [bool, default t]
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
107 ;; If non-nil, a warning will be issued whenever
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
108 ;; a record is found that does not have the number
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
109 ;; of fields specified by `forms-number-of-fields'.
|
14169
|
110 ;;
|
|
111 ;; forms-multi-line [string, default "^K"]
|
24655
|
112 ;; If non-null, the records of the data file may
|
14169
|
113 ;; contain fields that can span multiple lines in
|
|
114 ;; the form.
|
24655
|
115 ;; This variable denotes the separator string
|
14169
|
116 ;; to be used for this purpose. Upon display, all
|
24655
|
117 ;; occurrences of this string are translated
|
14169
|
118 ;; to newlines. Upon storage they are translated
|
24655
|
119 ;; back to the separator string.
|
14169
|
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]
|
24655
|
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.
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
131 ;;
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
132 ;; forms-insert-after [bool, default nil]
|
24655
|
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.
|
14169
|
138 ;;
|
|
139 ;; forms-read-file-filter [symbol, default nil]
|
49588
|
140 ;; If not nil: this should be the name of a
|
14169
|
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]
|
49588
|
147 ;; If not nil: this should be the name of a
|
14169
|
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]
|
49588
|
153 ;; If not nil: this should be the name of a
|
14169
|
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]
|
49588
|
159 ;; If not nil: this should be the name of a
|
14169
|
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.
|
24655
|
173 ;; This variable defaults to t if running Emacs 19 or
|
|
174 ;; later with text properties.
|
14169
|
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
|
24655
|
180 ;; read-only text on the screen. If used, this
|
14169
|
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
|
24655
|
194 ;; `forms--file-buffer' which normally will not be shown.
|
14169
|
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'.
|
49588
|
201 ;; A format routine `forms--format' is built upon startup to format
|
14169
|
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.
|
24655
|
215 ;; `forms-exit-no-save' does not. However, if `forms-exit-no-save'
|
14169
|
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 ;;
|
24655
|
229 ;; As a documented side-effect: jumping to the last record in the
|
14169
|
230 ;; file (using forms-last-record) will adjust forms--total-records if
|
|
231 ;; needed.
|
|
232 ;;
|
24655
|
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
|
14169
|
235 ;; contents of the buffer.
|
|
236 ;;
|
|
237 ;; Edit mode commands:
|
49588
|
238 ;;
|
14169
|
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
|
49588
|
253 ;;
|
14169
|
254 ;; Read-only mode commands:
|
49588
|
255 ;;
|
14169
|
256 ;; SPC forms-next-record
|
|
257 ;; DEL forms-prev-record
|
|
258 ;; ? describe-mode
|
24655
|
259 ;; \C-q forms-toggle-read-only
|
14169
|
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
|
49588
|
266 ;;
|
14169
|
267 ;; Of course, it is also possible to use the \C-c prefix to obtain the
|
|
268 ;; same command keys as in edit mode.
|
49588
|
269 ;;
|
|
270 ;; The following bindings are available, independent of the mode:
|
|
271 ;;
|
14169
|
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
|
24655
|
277 ;; [backtab] forms-prev-field
|
14169
|
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 ;;
|
24655
|
282 ;; As mentioned above (see `forms-forms-scroll' and `forms-forms-jump'),
|
14169
|
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 ;;
|
51282
933251fe83b1
(forms-mode): Use write-file-functions instead of local-write-file-hooks.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
288 ;; `write-file-functions' is defined to save the actual data file
|
14169
|
289 ;; instead of the buffer data, `revert-file-hook' is defined to
|
|
290 ;; revert a forms to original.
|
3697
|
291
|
|
292 ;;; Code:
|
|
293
|
19429
|
294 (defgroup forms nil
|
|
295 "Edit a file as a form to fill in."
|
|
296 :group 'data)
|
|
297
|
4121
|
298 ;;; Global variables and constants:
|
276
|
299
|
3697
|
300 (provide 'forms) ;;; official
|
|
301 (provide 'forms-mode) ;;; for compatibility
|
|
302
|
51325
|
303 (defcustom forms-mode-hook nil
|
35968
|
304 "Hook run upon entering Forms mode."
|
19429
|
305 :group 'forms
|
35968
|
306 :type 'hook)
|
3697
|
307
|
4121
|
308 ;;; Mandatory variables - must be set by evaluating the control file.
|
276
|
309
|
|
310 (defvar forms-file nil
|
307
|
311 "Name of the file holding the data.")
|
276
|
312
|
|
313 (defvar forms-format-list nil
|
307
|
314 "List of formatting specifications.")
|
276
|
315
|
|
316 (defvar forms-number-of-fields nil
|
|
317 "Number of fields per record.")
|
3697
|
318
|
4121
|
319 ;;; Optional variables with default values.
|
276
|
320
|
19429
|
321 (defcustom forms-check-number-of-fields t
|
|
322 "*If non-nil, warn about records with wrong number of fields."
|
|
323 :group 'forms
|
|
324 :type 'boolean)
|
12847
|
325
|
276
|
326 (defvar forms-field-sep "\t"
|
3697
|
327 "Field separator character (default TAB).")
|
276
|
328
|
19565
|
329 (defvar forms-read-only nil
|
|
330 "Non-nil means: visit the file in view (read-only) mode.
|
19586
|
331 This is set automatically if the file permissions don't let you write it.")
|
276
|
332
|
19429
|
333 (defvar forms-multi-line "\C-k" "\
|
|
334 If not nil: use this character to separate multi-line fields (default C-k).")
|
276
|
335
|
19429
|
336 (defcustom forms-forms-scroll nil
|
3828
|
337 "*Non-nil means replace scroll-up/down commands in Forms mode.
|
19429
|
338 The replacement commands performs forms-next/prev-record."
|
|
339 :group 'forms
|
|
340 :type 'boolean)
|
276
|
341
|
19429
|
342 (defcustom forms-forms-jump nil
|
3828
|
343 "*Non-nil means redefine beginning/end-of-buffer in Forms mode.
|
19429
|
344 The replacement commands performs forms-first/last-record."
|
|
345 :group 'forms
|
|
346 :type 'boolean)
|
4121
|
347
|
8344
|
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.
|
19429
|
355 This can be used to undo the effects of `form-read-file-hook'.")
|
8344
|
356
|
4121
|
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.
|
49588
|
365 This variable is for use by the filter routines only.
|
4121
|
366 The contents may NOT be modified.")
|
|
367
|
19429
|
368 (defcustom forms-use-text-properties t
|
|
369 "*Non-nil means: use text properties.
|
|
370 Defaults to t if this Emacs is capable of handling text properties."
|
|
371 :group 'forms
|
|
372 :type 'boolean)
|
4121
|
373
|
19429
|
374 (defcustom forms-insert-after nil
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
375 "*Non-nil means: inserts of new records go after current record.
|
19429
|
376 Also, initial position is at last record."
|
|
377 :group 'forms
|
|
378 :type 'boolean)
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
379
|
19429
|
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)
|
4121
|
384
|
19429
|
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)
|
3697
|
389
|
276
|
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
|
4790
|
401 (defvar forms-mode-map nil
|
276
|
402 "Keymap for form buffer.")
|
4790
|
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.")
|
276
|
407
|
|
408 (defvar forms--markers nil
|
|
409 "Field markers in the screen.")
|
|
410
|
4121
|
411 (defvar forms--dyntexts nil
|
|
412 "Dynamic texts (resulting from function calls) on the screen.")
|
276
|
413
|
49588
|
414 (defvar forms--the-record-list nil
|
276
|
415 "List of strings of the current record, as parsed from the file.")
|
|
416
|
|
417 (defvar forms--search-regexp nil
|
10346
|
418 "Last regexp used by forms-search functions.")
|
276
|
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
|
4121
|
427 "To keep track of forms-mode being set-up.")
|
276
|
428 (make-variable-buffer-local 'forms--mode-setup)
|
|
429
|
307
|
430 (defvar forms--dynamic-text nil
|
4121
|
431 "Array that holds dynamic texts to insert between fields.")
|
307
|
432
|
4121
|
433 (defvar forms--elements nil
|
|
434 "Array with the order in which the fields are displayed.")
|
307
|
435
|
4121
|
436 (defvar forms--ro-face nil
|
|
437 "Face used to represent read-only data on the screen.")
|
3697
|
438
|
4121
|
439 (defvar forms--rw-face nil
|
|
440 "Face used to represent read-write data on the screen.")
|
3697
|
441
|
49588
|
442 ;;;###autoload
|
276
|
443 (defun forms-mode (&optional primary)
|
|
444 "Major mode to visit files in a field-structured manner using a form.
|
|
445
|
4790
|
446 Commands: Equivalent keys in read-only mode:
|
|
447 TAB forms-next-field TAB
|
49588
|
448 C-c TAB forms-next-field
|
22770
|
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
|
4790
|
461 "
|
|
462 (interactive)
|
276
|
463
|
4121
|
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
|
276
|
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
|
4121
|
478 ;;(message "forms: setting up...")
|
276
|
479 (kill-all-local-variables)
|
|
480
|
4121
|
481 ;; Make mandatory variables.
|
276
|
482 (make-local-variable 'forms-file)
|
|
483 (make-local-variable 'forms-number-of-fields)
|
|
484 (make-local-variable 'forms-format-list)
|
|
485
|
4121
|
486 ;; Make optional variables.
|
276
|
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)
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
492 (make-local-variable 'forms-insert-after)
|
4121
|
493 (make-local-variable 'forms-use-text-properties)
|
8344
|
494
|
|
495 ;; Filter functions.
|
|
496 (make-local-variable 'forms-read-file-filter)
|
|
497 (make-local-variable 'forms-write-file-filter)
|
4790
|
498 (make-local-variable 'forms-new-record-filter)
|
|
499 (make-local-variable 'forms-modified-record-filter)
|
4121
|
500
|
|
501 ;; Make sure no filters exist.
|
8344
|
502 (setq forms-read-file-filter nil)
|
|
503 (setq forms-write-file-filter nil)
|
4790
|
504 (setq forms-new-record-filter nil)
|
|
505 (setq forms-modified-record-filter nil)
|
4121
|
506
|
49588
|
507 ;; If running Emacs 19 under X, setup faces to show read-only and
|
4121
|
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)))
|
276
|
513
|
|
514 ;; eval the buffer, should set variables
|
4121
|
515 ;;(message "forms: processing control file...")
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
516 ;; If enable-local-eval is not set to t the user is asked first.
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
517 (if (or (eq enable-local-eval t)
|
49588
|
518 (yes-or-no-p
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
519 (concat "Evaluate lisp code in buffer "
|
65689
|
520 (buffer-name) " to display forms? ")))
|
62459
|
521 (eval-buffer)
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
522 (error "`enable-local-eval' inhibits buffer evaluation"))
|
276
|
523
|
8344
|
524 ;; Check if the mandatory variables make sense.
|
276
|
525 (or forms-file
|
49588
|
526 (error (concat "Forms control file error: "
|
18223
|
527 "`forms-file' has not been set")))
|
8344
|
528
|
|
529 ;; Check forms-field-sep first, since it can be needed to
|
|
530 ;; construct a default format list.
|
4790
|
531 (or (stringp forms-field-sep)
|
|
532 (error (concat "Forms control file error: "
|
18223
|
533 "`forms-field-sep' is not a string")))
|
8344
|
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: "
|
18223
|
539 "`forms-number-of-fields' must be a number > 0")))
|
8344
|
540 (or (null forms-format-list)
|
|
541 (error (concat "Forms control file error: "
|
18223
|
542 "`forms-number-of-fields' has not been set"))))
|
8344
|
543
|
|
544 (or forms-format-list
|
|
545 (forms--intuit-from-file))
|
|
546
|
276
|
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)
|
49588
|
551 (error (concat "Forms control file error: "
|
63400
00398c07d65c
(forms--intuit-from-file): Fix reference to `forms-number-of-fields' in error message.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
552 "`forms-multi-line' is equal to `forms-field-sep'")))
|
4790
|
553 (error (concat "Forms control file error: "
|
18223
|
554 "`forms-multi-line' must be nil or a one-character string"))))
|
4121
|
555 (or (fboundp 'set-text-properties)
|
|
556 (setq forms-use-text-properties nil))
|
49588
|
557
|
4121
|
558 ;; Validate and process forms-format-list.
|
|
559 ;;(message "forms: pre-processing format list...")
|
18215
|
560 (make-local-variable 'forms--elements)
|
276
|
561 (forms--process-format-list)
|
|
562
|
4121
|
563 ;; Build the formatter and parser.
|
|
564 ;;(message "forms: building formatter...")
|
276
|
565 (make-local-variable 'forms--format)
|
4121
|
566 (make-local-variable 'forms--markers)
|
|
567 (make-local-variable 'forms--dyntexts)
|
|
568 ;;(message "forms: building parser...")
|
276
|
569 (forms--make-format)
|
|
570 (make-local-variable 'forms--parser)
|
|
571 (forms--make-parser)
|
4121
|
572 ;;(message "forms: building parser... done.")
|
276
|
573
|
4121
|
574 ;; Check if record filters are defined.
|
4790
|
575 (if (and forms-new-record-filter
|
|
576 (not (fboundp forms-new-record-filter)))
|
|
577 (error (concat "Forms control file error: "
|
18223
|
578 "`forms-new-record-filter' is not a function")))
|
4790
|
579
|
|
580 (if (and forms-modified-record-filter
|
|
581 (not (fboundp forms-modified-record-filter)))
|
|
582 (error (concat "Forms control file error: "
|
18223
|
583 "`forms-modified-record-filter' is not a function")))
|
276
|
584
|
4121
|
585 ;; The filters acces the contents of the forms using `forms-fields'.
|
307
|
586 (make-local-variable 'forms-fields)
|
276
|
587
|
4121
|
588 ;; Dynamic text support.
|
|
589 (make-local-variable 'forms--dynamic-text)
|
276
|
590
|
23382
|
591 ;; Prevent accidental overwrite of the control file and auto-save.
|
7381
9e7dd6d12e1f
(forms-mode): Set visited file name to nil to prevent overwrite and autosave.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
592 (set-visited-file-name nil)
|
276
|
593
|
4121
|
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
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
601 ;; initialization done
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
602 (setq forms--mode-setup t)
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
603
|
4121
|
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))))
|
276
|
615
|
3941
|
616 ;; Make more local variables.
|
276
|
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)
|
4121
|
621 (make-local-variable 'forms--search-regexp)
|
276
|
622
|
4790
|
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)
|
276
|
627 (if forms-mode-map ; already defined
|
|
628 nil
|
4121
|
629 ;;(message "forms: building keymap...")
|
4790
|
630 (forms--mode-commands)
|
4121
|
631 ;;(message "forms: building keymap... done.")
|
|
632 )
|
276
|
633
|
6561
|
634 ;; set the major mode indicator
|
|
635 (setq major-mode 'forms-mode)
|
|
636 (setq mode-name "Forms")
|
|
637
|
276
|
638 ;; find the data file
|
|
639 (setq forms--file-buffer (find-file-noselect forms-file))
|
|
640
|
8344
|
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
|
51325
|
645 (with-current-buffer forms--file-buffer
|
10346
|
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)))
|
8344
|
650 (if write-file-filter
|
51325
|
651 (add-hook 'write-file-functions write-file-filter nil t)))
|
8344
|
652 (if write-file-filter
|
51325
|
653 (with-current-buffer forms--file-buffer
|
|
654 (add-hook 'write-file-functions write-file-filter nil t)))))
|
8344
|
655
|
276
|
656 ;; count the number of records, and set see if it may be modified
|
|
657 (let (ro)
|
|
658 (setq forms--total-records
|
51325
|
659 (with-current-buffer forms--file-buffer
|
4121
|
660 (prog1
|
|
661 (progn
|
|
662 ;;(message "forms: counting records...")
|
|
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 )))
|
276
|
668 (if ro
|
|
669 (setq forms-read-only t)))
|
|
670
|
4121
|
671 ;;(message "forms: proceeding setup...")
|
4867
|
672
|
|
673 ;; Since we aren't really implementing a minor mode, we hack the modeline
|
|
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
|
4121
|
679 ;;(message "forms: proceeding setup (keymaps)...")
|
276
|
680 (forms--set-keymaps)
|
4121
|
681 ;;(message "forms: proceeding setup (commands)...")
|
3827
|
682 (forms--change-commands)
|
276
|
683
|
4121
|
684 ;;(message "forms: proceeding setup (buffer)...")
|
276
|
685 (set-buffer-modified-p nil)
|
|
686
|
8344
|
687 (if (= forms--total-records 0)
|
|
688 ;;(message "forms: proceeding setup (new file)...")
|
|
689 (progn
|
49588
|
690 (insert
|
54770
|
691 "GNU Emacs Forms Mode\n\n"
|
8344
|
692 (if (file-exists-p forms-file)
|
14356
|
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"
|
8344
|
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)
|
24655
|
707
|
|
708 (if forms-insert-after
|
|
709 (forms-last-record)
|
|
710 (forms-first-record))
|
8344
|
711 )
|
276
|
712
|
|
713 ;; user customising
|
4121
|
714 ;;(message "forms: proceeding setup (user hooks)...")
|
62728
|
715 (run-mode-hooks 'forms-mode-hook 'forms-mode-hooks)
|
4121
|
716 ;;(message "forms: setting up... done.")
|
276
|
717
|
|
718 ;; be helpful
|
|
719 (forms--help)
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
720 )
|
3697
|
721
|
4121
|
722 (defun forms--process-format-list ()
|
|
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
|
49588
|
727 ;; of the fields on the display. This array is used by
|
4121
|
728 ;; `forms--parser-using-text-properties' to extract the fields data
|
|
729 ;; from the form on the screen.
|
13984
|
730 ;; Upon completion, `forms-format-list' is guaranteed correct, so
|
4121
|
731 ;; `forms--make-format' and `forms--make-parser' do not need to perform
|
|
732 ;; any checks.
|
276
|
733
|
4121
|
734 ;; Verify that `forms-format-list' is not nil.
|
276
|
735 (or forms-format-list
|
4790
|
736 (error (concat "Forms control file error: "
|
18223
|
737 "`forms-format-list' has not been set")))
|
4121
|
738 ;; It must be a list.
|
276
|
739 (or (listp forms-format-list)
|
4790
|
740 (error (concat "Forms control file error: "
|
18223
|
741 "`forms-format-list' is not a list")))
|
276
|
742
|
4121
|
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))
|
276
|
746
|
|
747 (let ((the-list forms-format-list) ; the list of format elements
|
4121
|
748 (prev-item nil)
|
49588
|
749 (field-num 0)) ; highest field number
|
276
|
750
|
307
|
751 (setq forms-format-list nil) ; gonna rebuild
|
|
752
|
276
|
753 (while the-list
|
|
754
|
|
755 (let ((el (car-safe the-list))
|
|
756 (rem (cdr-safe the-list)))
|
|
757
|
4121
|
758 ;; If it is a symbol, eval it first.
|
307
|
759 (if (and (symbolp el)
|
|
760 (boundp el))
|
|
761 (setq el (eval el)))
|
|
762
|
276
|
763 (cond
|
|
764
|
4121
|
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 ...
|
49588
|
775 ((numberp el)
|
276
|
776
|
4121
|
777 ;; Validate range.
|
276
|
778 (if (or (<= el 0)
|
|
779 (> el forms-number-of-fields))
|
4790
|
780 (error (concat "Forms format error: "
|
|
781 "field number %d out of range 1..%d")
|
|
782 el forms-number-of-fields))
|
276
|
783
|
4121
|
784 ;; Store forms order.
|
18215
|
785 (if (>= field-num (length forms--elements))
|
4121
|
786 (setq forms--elements (vconcat forms--elements (1- el)))
|
|
787 (aset forms--elements field-num (1- el)))
|
|
788 (setq field-num (1+ field-num))
|
276
|
789
|
4121
|
790 (if prev-item
|
|
791 (setq forms-format-list
|
4723
|
792 (append forms-format-list (list prev-item) nil)))
|
4121
|
793 (setq prev-item el))
|
|
794
|
|
795 ;; Try function ...
|
307
|
796 ((listp el)
|
4121
|
797
|
|
798 ;; Validate.
|
307
|
799 (or (fboundp (car-safe el))
|
4790
|
800 (error (concat "Forms format error: "
|
18223
|
801 "%S is not a function")
|
14421
|
802 (car-safe el)))
|
4121
|
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))
|
307
|
809
|
276
|
810 ;; else
|
|
811 (t
|
4790
|
812 (error (concat "Forms format error: "
|
14421
|
813 "invalid element %S")
|
|
814 el)))
|
276
|
815
|
4121
|
816 ;; Advance to next element of the list.
|
|
817 (setq the-list rem)))
|
307
|
818
|
4121
|
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.
|
4723
|
825 ;; This prevents parsing problems.
|
4121
|
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))))))
|
307
|
830
|
4121
|
831 (forms--debug 'forms-format-list
|
|
832 'forms--elements))
|
3697
|
833
|
4121
|
834 ;; Special treatment for read-only segments.
|
|
835 ;;
|
18215
|
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.
|
4723
|
838 ;; To solve this, read-only segments get the `insert-in-front-hooks'
|
18215
|
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.
|
4121
|
843
|
4723
|
844 (defvar forms--iif-start nil
|
4121
|
845 "Record start of modification command.")
|
4723
|
846 (defvar forms--iif-properties nil
|
4121
|
847 "Original properties of the character being overridden.")
|
|
848
|
4723
|
849 (defun forms--iif-hook (begin end)
|
|
850 "`insert-in-front-hooks' function for read-only segments."
|
4121
|
851
|
49588
|
852 ;; Note start location. By making it a marker that points one
|
|
853 ;; character beyond the actual location, it is guaranteed to move
|
4723
|
854 ;; correctly if text is inserted.
|
|
855 (or forms--iif-start
|
|
856 (setq forms--iif-start (copy-marker (1+ (point)))))
|
4121
|
857
|
4723
|
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.
|
49588
|
864 (setq forms--iif-properties
|
4723
|
865 (text-properties-at (1- forms--iif-start)))
|
4121
|
866
|
4723
|
867 ;; Replace them.
|
|
868 (let ((inhibit-read-only t))
|
49588
|
869 (set-text-properties
|
4723
|
870 (1- forms--iif-start) forms--iif-start
|
|
871 (list 'face forms--rw-face 'front-sticky '(face))))
|
4121
|
872
|
4723
|
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)))
|
4121
|
876
|
4723
|
877 ;; No action needed. Clear marker.
|
|
878 (setq forms--iif-start nil)))
|
|
879
|
|
880 (defun forms--iif-post-command-hook ()
|
|
881 "`post-command-hook' function for read-only segments."
|
4121
|
882
|
|
883 ;; Disable `post-command-hook'.
|
|
884 (setq post-command-hook
|
4723
|
885 (delq 'forms--iif-hook-post-command-hook post-command-hook))
|
4121
|
886
|
|
887 ;; Restore properties.
|
4723
|
888 (if forms--iif-start
|
4121
|
889 (let ((inhibit-read-only t))
|
49588
|
890 (set-text-properties
|
4723
|
891 (1- forms--iif-start) forms--iif-start
|
|
892 forms--iif-properties)))
|
4121
|
893
|
|
894 ;; Cleanup.
|
4723
|
895 (setq forms--iif-start nil))
|
4121
|
896
|
|
897 (defvar forms--marker)
|
|
898 (defvar forms--dyntext)
|
276
|
899
|
|
900 (defun forms--make-format ()
|
4121
|
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))
|
49588
|
910 (setq
|
4121
|
911 forms--format
|
49588
|
912 (if forms-use-text-properties
|
26436
|
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)))))
|
4121
|
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)))
|
307
|
935 (forms--debug 'forms--format))
|
276
|
936
|
4121
|
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))
|
|
945 ;;
|
4723
|
946 ;; ;; A string, e.g. "text: ".
|
49588
|
947 ;; (set-text-properties
|
4121
|
948 ;; (point)
|
49588
|
949 ;; (progn (insert "text: ") (point))
|
4723
|
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)))
|
4121
|
954 ;;
|
4723
|
955 ;; ;; A field, e.g. 6.
|
4121
|
956 ;; (let ((here (point)))
|
|
957 ;; (aset forms--markers 0 (point-marker))
|
|
958 ;; (insert (elt arg 5))
|
|
959 ;; (or (= (point) here)
|
49588
|
960 ;; (set-text-properties
|
4121
|
961 ;; here (point)
|
4723
|
962 ;; (list 'face forms--rw-face
|
|
963 ;; 'front-sticky '(face))))
|
4121
|
964 ;;
|
4723
|
965 ;; ;; Another string, e.g. "\nmore text: ".
|
4121
|
966 ;; (set-text-properties
|
|
967 ;; (point)
|
|
968 ;; (progn (insert "\nmore text: ") (point))
|
|
969 ;; (list 'face forms--ro-face
|
4723
|
970 ;; 'read-only 2
|
|
971 ;; 'insert-in-front-hooks 'forms--iif-hook
|
|
972 ;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
|
4121
|
973 ;;
|
4723
|
974 ;; ;; A function, e.g. (tocol 40).
|
4121
|
975 ;; (set-text-properties
|
|
976 ;; (point)
|
|
977 ;; (progn
|
|
978 ;; (insert (aset forms--dyntexts 0 (tocol 40)))
|
|
979 ;; (point))
|
|
980 ;; (list 'face forms--ro-face
|
4723
|
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)))
|
4121
|
991 ;;
|
|
992 ;; ;; wrap up
|
4723
|
993 ;; (setq forms--iif-start nil)
|
4121
|
994 ;; ))
|
|
995
|
|
996 (cond
|
|
997 ((stringp el)
|
49588
|
998
|
|
999 `((set-text-properties
|
26436
|
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)))))
|
49588
|
1010
|
4121
|
1011 ((numberp el)
|
26436
|
1012 `((let ((here (point)))
|
49588
|
1013 (aset forms--markers
|
26436
|
1014 ,(prog1 forms--marker
|
|
1015 (setq forms--marker (1+ forms--marker)))
|
|
1016 (point-marker))
|
|
1017 (insert (elt arg ,(1- el)))
|
|
1018 (or (= (point) here)
|
49588
|
1019 (set-text-properties
|
26436
|
1020 here (point)
|
|
1021 (list 'face forms--rw-face
|
|
1022 'front-sticky '(face)))))))
|
4121
|
1023
|
|
1024 ((listp el)
|
26436
|
1025 `((set-text-properties
|
|
1026 (point)
|
|
1027 (progn
|
49588
|
1028 (insert (aset forms--dyntexts
|
26436
|
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)))))
|
4121
|
1039
|
|
1040 ;; end of cond
|
|
1041 ))
|
276
|
1042
|
|
1043 (defun forms--make-format-elt (el)
|
4121
|
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
|
49588
|
1061 (cond
|
3697
|
1062 ((stringp el)
|
26436
|
1063 `((insert ,el)))
|
3697
|
1064 ((numberp el)
|
|
1065 (prog1
|
26436
|
1066 `((aset forms--markers ,forms--marker (point-marker))
|
|
1067 (insert (elt arg ,(1- el))))
|
4121
|
1068 (setq forms--marker (1+ forms--marker))))
|
3697
|
1069 ((listp el)
|
|
1070 (prog1
|
26436
|
1071 `((insert (aset forms--dyntexts ,forms--dyntext ,el)))
|
4121
|
1072 (setq forms--dyntext (1+ forms--dyntext))))))
|
3697
|
1073
|
4121
|
1074 (defvar forms--field)
|
|
1075 (defvar forms--recordv)
|
|
1076 (defvar forms--seen-text)
|
276
|
1077
|
|
1078 (defun forms--make-parser ()
|
4121
|
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.
|
26436
|
1096 `(lambda nil
|
|
1097 (let (here)
|
|
1098 (goto-char (point-min))
|
|
1099 ,@(apply 'append
|
49588
|
1100 (mapcar
|
|
1101 'forms--make-parser-elt
|
26436
|
1102 (append forms-format-list (list nil)))))))))
|
4121
|
1103
|
307
|
1104 (forms--debug 'forms--parser))
|
276
|
1105
|
4121
|
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)
|
49588
|
1118 (if (setq there
|
4121
|
1119 (next-single-property-change here 'read-only))
|
|
1120 (aset forms--recordv (aref forms--elements i)
|
13569
438ebe3b6f8d
Use `buffer-substring-no-properties' instead of `buffer-substring' to
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1121 (buffer-substring-no-properties here there))
|
4121
|
1122 (aset forms--recordv (aref forms--elements i)
|
13569
438ebe3b6f8d
Use `buffer-substring-no-properties' instead of `buffer-substring' to
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1123 (buffer-substring-no-properties here (point-max)))))
|
4121
|
1124 (setq i (1+ i)))))
|
276
|
1125
|
|
1126 (defun forms--make-parser-elt (el)
|
4121
|
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))
|
49588
|
1134 ;;
|
4121
|
1135 ;; ;; "text: "
|
|
1136 ;; (if (not (looking-at "text: "))
|
|
1137 ;; (error "Parse error: cannot find \"text: \""))
|
|
1138 ;; (forward-char 6) ; past "text: "
|
49588
|
1139 ;;
|
4121
|
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: \""))
|
13569
438ebe3b6f8d
Use `buffer-substring-no-properties' instead of `buffer-substring' to
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1145 ;; (aset forms--recordv 5 (buffer-substring-no-properties here (- (point) 12)))
|
4121
|
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)))
|
49588
|
1153 ;; ...
|
4121
|
1154 ;; ;; final flush (due to terminator sentinel, see below)
|
13569
438ebe3b6f8d
Use `buffer-substring-no-properties' instead of `buffer-substring' to
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1155 ;; (aset forms--recordv 7 (buffer-substring-no-properties (point) (point-max)))
|
4121
|
1156
|
307
|
1157 (cond
|
|
1158 ((stringp el)
|
|
1159 (prog1
|
4121
|
1160 (if forms--field
|
26436
|
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))))
|
4121
|
1170 (setq forms--seen-text t)
|
|
1171 (setq forms--field nil)))
|
307
|
1172 ((numberp el)
|
4121
|
1173 (if forms--field
|
307
|
1174 (error "Cannot parse adjacent fields %d and %d"
|
4121
|
1175 forms--field el)
|
|
1176 (setq forms--field el)
|
307
|
1177 nil))
|
|
1178 ((null el)
|
4121
|
1179 (if forms--field
|
26436
|
1180 `((aset forms--recordv ,(1- forms--field)
|
|
1181 (buffer-substring-no-properties (point) (point-max))))))
|
307
|
1182 ((listp el)
|
|
1183 (prog1
|
4121
|
1184 (if forms--field
|
26436
|
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)))))
|
4121
|
1196 (setq forms--dyntext (1+ forms--dyntext))
|
|
1197 (setq forms--seen-text t)
|
|
1198 (setq forms--field nil)))
|
307
|
1199 ))
|
3697
|
1200
|
8344
|
1201 (defun forms--intuit-from-file ()
|
|
1202 "Get number of fields and a default form using the data file."
|
|
1203
|
|
1204 ;; If `forms-number-of-fields' is not set, get it from the data file.
|
|
1205 (if (null forms-number-of-fields)
|
|
1206
|
|
1207 ;; Need a file to do this.
|
|
1208 (if (not (file-exists-p forms-file))
|
63400
00398c07d65c
(forms--intuit-from-file): Fix reference to `forms-number-of-fields' in error message.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
1209 (error "Need existing file or explicit `forms-number-of-fields'")
|
8344
|
1210
|
|
1211 ;; Visit the file and extract the first record.
|
|
1212 (setq forms--file-buffer (find-file-noselect forms-file))
|
|
1213 (let ((read-file-filter forms-read-file-filter)
|
|
1214 (the-record))
|
|
1215 (setq the-record
|
51325
|
1216 (with-current-buffer forms--file-buffer
|
8344
|
1217 (let ((inhibit-read-only t))
|
|
1218 (run-hooks 'read-file-filter))
|
|
1219 (goto-char (point-min))
|
|
1220 (forms--get-record)))
|
|
1221
|
49588
|
1222 ;; This may be overkill, but try to avoid interference with
|
8344
|
1223 ;; the normal processing.
|
|
1224 (kill-buffer forms--file-buffer)
|
|
1225
|
|
1226 ;; Count the number of fields in `the-record'.
|
51325
|
1227 (let ((start-pos 0)
|
8344
|
1228 found-pos
|
|
1229 (field-sep-length (length forms-field-sep)))
|
|
1230 (setq forms-number-of-fields 1)
|
|
1231 (while (setq found-pos
|
|
1232 (string-match forms-field-sep the-record start-pos))
|
|
1233 (progn
|
|
1234 (setq forms-number-of-fields (1+ forms-number-of-fields))
|
|
1235 (setq start-pos (+ field-sep-length found-pos))))))))
|
|
1236
|
|
1237 ;; Construct default format list.
|
|
1238 (setq forms-format-list (list "Forms file \"" forms-file "\".\n\n"))
|
|
1239 (let ((i 0))
|
|
1240 (while (<= (setq i (1+ i)) forms-number-of-fields)
|
|
1241 (setq forms-format-list
|
|
1242 (append forms-format-list
|
|
1243 (list (format "%4d: " i) i "\n"))))))
|
|
1244
|
276
|
1245 (defun forms--set-keymaps ()
|
|
1246 "Set the keymaps used in this mode."
|
|
1247
|
49588
|
1248 (use-local-map (if forms-read-only
|
|
1249 forms-mode-ro-map
|
4790
|
1250 forms-mode-edit-map)))
|
|
1251
|
|
1252 (defun forms--mode-commands ()
|
|
1253 "Fill the Forms mode keymaps."
|
276
|
1254
|
4790
|
1255 ;; `forms-mode-map' is always accessible via \C-c prefix.
|
|
1256 (setq forms-mode-map (make-keymap))
|
|
1257 (define-key forms-mode-map "\t" 'forms-next-field)
|
|
1258 (define-key forms-mode-map "\C-k" 'forms-delete-record)
|
|
1259 (define-key forms-mode-map "\C-q" 'forms-toggle-read-only)
|
|
1260 (define-key forms-mode-map "\C-o" 'forms-insert-record)
|
|
1261 (define-key forms-mode-map "\C-l" 'forms-jump-record)
|
|
1262 (define-key forms-mode-map "\C-n" 'forms-next-record)
|
|
1263 (define-key forms-mode-map "\C-p" 'forms-prev-record)
|
10346
|
1264 (define-key forms-mode-map "\C-r" 'forms-search-backward)
|
|
1265 (define-key forms-mode-map "\C-s" 'forms-search-forward)
|
4790
|
1266 (define-key forms-mode-map "\C-x" 'forms-exit)
|
|
1267 (define-key forms-mode-map "<" 'forms-first-record)
|
|
1268 (define-key forms-mode-map ">" 'forms-last-record)
|
|
1269 (define-key forms-mode-map "\C-?" 'forms-prev-record)
|
4121
|
1270
|
4790
|
1271 ;; `forms-mode-ro-map' replaces the local map when in read-only mode.
|
|
1272 (setq forms-mode-ro-map (make-keymap))
|
|
1273 (suppress-keymap forms-mode-ro-map)
|
|
1274 (define-key forms-mode-ro-map "\C-c" forms-mode-map)
|
|
1275 (define-key forms-mode-ro-map "q" 'forms-toggle-read-only)
|
|
1276 (define-key forms-mode-ro-map "l" 'forms-jump-record)
|
|
1277 (define-key forms-mode-ro-map "n" 'forms-next-record)
|
|
1278 (define-key forms-mode-ro-map "p" 'forms-prev-record)
|
10346
|
1279 (define-key forms-mode-ro-map "r" 'forms-search-backward)
|
|
1280 (define-key forms-mode-ro-map "s" 'forms-search-forward)
|
4790
|
1281 (define-key forms-mode-ro-map "x" 'forms-exit)
|
|
1282 (define-key forms-mode-ro-map "<" 'forms-first-record)
|
|
1283 (define-key forms-mode-ro-map ">" 'forms-last-record)
|
|
1284 (define-key forms-mode-ro-map "?" 'describe-mode)
|
|
1285 (define-key forms-mode-ro-map " " 'forms-next-record)
|
|
1286 (forms--mode-commands1 forms-mode-ro-map)
|
10346
|
1287 (forms--mode-menu-ro forms-mode-ro-map)
|
4790
|
1288
|
|
1289 ;; This is the normal, local map.
|
|
1290 (setq forms-mode-edit-map (make-keymap))
|
|
1291 (define-key forms-mode-edit-map "\C-c" forms-mode-map)
|
|
1292 (forms--mode-commands1 forms-mode-edit-map)
|
10346
|
1293 (forms--mode-menu-edit forms-mode-edit-map)
|
4790
|
1294 )
|
|
1295
|
10346
|
1296 (defun forms--mode-menu-ro (map)
|
|
1297 ;;; Menu initialisation
|
|
1298 ; (define-key map [menu-bar] (make-sparse-keymap))
|
|
1299 (define-key map [menu-bar forms]
|
|
1300 (cons "Forms" (make-sparse-keymap "Forms")))
|
|
1301 (define-key map [menu-bar forms menu-forms-exit]
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1302 '("Exit Forms Mode" . forms-exit))
|
10346
|
1303 (define-key map [menu-bar forms menu-forms-sep1]
|
|
1304 '("----"))
|
|
1305 (define-key map [menu-bar forms menu-forms-save]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1306 '("Save Data" . forms-save-buffer))
|
10346
|
1307 (define-key map [menu-bar forms menu-forms-print]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1308 '("Print Data" . forms-print))
|
10346
|
1309 (define-key map [menu-bar forms menu-forms-describe]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1310 '("Describe Mode" . describe-mode))
|
10346
|
1311 (define-key map [menu-bar forms menu-forms-toggle-ro]
|
|
1312 '("Toggle View/Edit" . forms-toggle-read-only))
|
|
1313 (define-key map [menu-bar forms menu-forms-jump-record]
|
|
1314 '("Jump" . forms-jump-record))
|
|
1315 (define-key map [menu-bar forms menu-forms-search-backward]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1316 '("Search Backward" . forms-search-backward))
|
10346
|
1317 (define-key map [menu-bar forms menu-forms-search-forward]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1318 '("Search Forward" . forms-search-forward))
|
10346
|
1319 (define-key map [menu-bar forms menu-forms-delete-record]
|
|
1320 '("Delete" . forms-delete-record))
|
|
1321 (define-key map [menu-bar forms menu-forms-insert-record]
|
|
1322 '("Insert" . forms-insert-record))
|
|
1323 (define-key map [menu-bar forms menu-forms-sep2]
|
|
1324 '("----"))
|
|
1325 (define-key map [menu-bar forms menu-forms-last-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1326 '("Last Record" . forms-last-record))
|
10346
|
1327 (define-key map [menu-bar forms menu-forms-first-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1328 '("First Record" . forms-first-record))
|
10346
|
1329 (define-key map [menu-bar forms menu-forms-prev-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1330 '("Previous Record" . forms-prev-record))
|
10346
|
1331 (define-key map [menu-bar forms menu-forms-next-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1332 '("Next Record" . forms-next-record))
|
10346
|
1333 (define-key map [menu-bar forms menu-forms-sep3]
|
|
1334 '("----"))
|
|
1335 (define-key map [menu-bar forms menu-forms-prev-field]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1336 '("Previous Field" . forms-prev-field))
|
10346
|
1337 (define-key map [menu-bar forms menu-forms-next-field]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1338 '("Next Field" . forms-next-field))
|
10346
|
1339 (put 'forms-insert-record 'menu-enable '(not forms-read-only))
|
|
1340 (put 'forms-delete-record 'menu-enable '(not forms-read-only))
|
|
1341 )
|
|
1342 (defun forms--mode-menu-edit (map)
|
|
1343 ;;; Menu initialisation
|
|
1344 ; (define-key map [menu-bar] (make-sparse-keymap))
|
|
1345 (define-key map [menu-bar forms]
|
|
1346 (cons "Forms" (make-sparse-keymap "Forms")))
|
|
1347 (define-key map [menu-bar forms menu-forms-edit--exit]
|
|
1348 '("Exit" . forms-exit))
|
|
1349 (define-key map [menu-bar forms menu-forms-edit-sep1]
|
|
1350 '("----"))
|
|
1351 (define-key map [menu-bar forms menu-forms-edit-save]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1352 '("Save Data" . forms-save-buffer))
|
10346
|
1353 (define-key map [menu-bar forms menu-forms-edit-print]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1354 '("Print Data" . forms-print))
|
10346
|
1355 (define-key map [menu-bar forms menu-forms-edit-describe]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1356 '("Describe Mode" . describe-mode))
|
10346
|
1357 (define-key map [menu-bar forms menu-forms-edit-toggle-ro]
|
|
1358 '("Toggle View/Edit" . forms-toggle-read-only))
|
|
1359 (define-key map [menu-bar forms menu-forms-edit-jump-record]
|
|
1360 '("Jump" . forms-jump-record))
|
|
1361 (define-key map [menu-bar forms menu-forms-edit-search-backward]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1362 '("Search Backward" . forms-search-backward))
|
10346
|
1363 (define-key map [menu-bar forms menu-forms-edit-search-forward]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1364 '("Search Forward" . forms-search-forward))
|
10346
|
1365 (define-key map [menu-bar forms menu-forms-edit-delete-record]
|
|
1366 '("Delete" . forms-delete-record))
|
|
1367 (define-key map [menu-bar forms menu-forms-edit-insert-record]
|
|
1368 '("Insert" . forms-insert-record))
|
|
1369 (define-key map [menu-bar forms menu-forms-edit-sep2]
|
|
1370 '("----"))
|
|
1371 (define-key map [menu-bar forms menu-forms-edit-last-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1372 '("Last Record" . forms-last-record))
|
10346
|
1373 (define-key map [menu-bar forms menu-forms-edit-first-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1374 '("First Record" . forms-first-record))
|
10346
|
1375 (define-key map [menu-bar forms menu-forms-edit-prev-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1376 '("Previous Record" . forms-prev-record))
|
10346
|
1377 (define-key map [menu-bar forms menu-forms-edit-next-record]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1378 '("Next Record" . forms-next-record))
|
10346
|
1379 (define-key map [menu-bar forms menu-forms-edit-sep3]
|
|
1380 '("----"))
|
|
1381 (define-key map [menu-bar forms menu-forms-edit-prev-field]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1382 '("Previous Field" . forms-prev-field))
|
10346
|
1383 (define-key map [menu-bar forms menu-forms-edit-next-field]
|
12031
a59559009d7e
(forms--mode-menu-ro, forms--mode-menu-edit): Fix capitalization in menu bar.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1384 '("Next Field" . forms-next-field))
|
10346
|
1385 (put 'forms-insert-record 'menu-enable '(not forms-read-only))
|
|
1386 (put 'forms-delete-record 'menu-enable '(not forms-read-only))
|
|
1387 )
|
|
1388
|
49588
|
1389 (defun forms--mode-commands1 (map)
|
4790
|
1390 "Helper routine to define keys."
|
51160
|
1391 (define-key map "\t" 'forms-next-field)
|
4790
|
1392 (define-key map [S-tab] 'forms-prev-field)
|
|
1393 (define-key map [next] 'forms-next-record)
|
|
1394 (define-key map [prior] 'forms-prev-record)
|
|
1395 (define-key map [begin] 'forms-first-record)
|
|
1396 (define-key map [last] 'forms-last-record)
|
|
1397 (define-key map [backtab] 'forms-prev-field)
|
276
|
1398 )
|
3697
|
1399
|
276
|
1400 ;;; Changed functions
|
|
1401
|
|
1402 (defun forms--change-commands ()
|
3941
|
1403 "Localize some commands for Forms mode."
|
4121
|
1404
|
276
|
1405 ;; scroll-down -> forms-prev-record
|
|
1406 ;; scroll-up -> forms-next-record
|
3828
|
1407 (if forms-forms-scroll
|
|
1408 (progn
|
49169
|
1409 (local-set-key [remap scroll-up] 'forms-next-record)
|
|
1410 (local-set-key [remap scroll-down] 'forms-prev-record)))
|
276
|
1411 ;;
|
|
1412 ;; beginning-of-buffer -> forms-first-record
|
|
1413 ;; end-of-buffer -> forms-end-record
|
3828
|
1414 (if forms-forms-jump
|
|
1415 (progn
|
49169
|
1416 (local-set-key [remap beginning-of-buffer] 'forms-first-record)
|
|
1417 (local-set-key [remap end-of-buffer] 'forms-last-record)))
|
276
|
1418 ;;
|
8344
|
1419 ;; Save buffer
|
|
1420 (local-set-key "\C-x\C-s" 'forms-save-buffer)
|
|
1421 ;;
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1422 ;; We have our own revert function - use it.
|
4790
|
1423 (make-local-variable 'revert-buffer-function)
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1424 (setq revert-buffer-function 'forms--revert-buffer)
|
4790
|
1425
|
|
1426 t)
|
276
|
1427
|
|
1428 (defun forms--help ()
|
3941
|
1429 "Initial help for Forms mode."
|
14315
ab041898078d
(forms--help, forms-search-forward, forms-search-backward): Pass proper format string to message.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
1430 (message "%s" (substitute-command-keys (concat
|
4790
|
1431 "\\[forms-next-record]:next"
|
|
1432 " \\[forms-prev-record]:prev"
|
|
1433 " \\[forms-first-record]:first"
|
|
1434 " \\[forms-last-record]:last"
|
|
1435 " \\[describe-mode]:help"))))
|
276
|
1436
|
|
1437 (defun forms--trans (subj arg rep)
|
3941
|
1438 "Translate in SUBJ all chars ARG into char REP. ARG and REP should
|
276
|
1439 be single-char strings."
|
|
1440 (let ((i 0)
|
|
1441 (re (regexp-quote arg))
|
|
1442 (k (string-to-char rep)))
|
|
1443 (while (setq i (string-match re subj i))
|
|
1444 (aset subj i k)
|
|
1445 (setq i (1+ i)))))
|
|
1446
|
51325
|
1447 (defun forms--exit (&optional save)
|
4121
|
1448 "Internal exit from forms mode function."
|
|
1449
|
276
|
1450 (let ((buf (buffer-name forms--file-buffer)))
|
|
1451 (forms--checkmod)
|
|
1452 (if (and save
|
|
1453 (buffer-modified-p forms--file-buffer))
|
8344
|
1454 (forms-save-buffer))
|
51325
|
1455 (with-current-buffer forms--file-buffer
|
276
|
1456 (delete-auto-save-file-if-necessary)
|
|
1457 (kill-buffer (current-buffer)))
|
|
1458 (if (get-buffer buf) ; not killed???
|
18215
|
1459 (if save
|
|
1460 (error "Problem saving buffer %s" (buffer-name buf)))
|
276
|
1461 (delete-auto-save-file-if-necessary)
|
|
1462 (kill-buffer (current-buffer)))))
|
|
1463
|
|
1464 (defun forms--get-record ()
|
|
1465 "Fetch the current record from the file buffer."
|
4121
|
1466
|
|
1467 ;; This function is executed in the context of the `forms--file-buffer'.
|
|
1468
|
276
|
1469 (or (bolp)
|
|
1470 (beginning-of-line nil))
|
|
1471 (let ((here (point)))
|
|
1472 (prog2
|
|
1473 (end-of-line)
|
13569
438ebe3b6f8d
Use `buffer-substring-no-properties' instead of `buffer-substring' to
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1474 (buffer-substring-no-properties here (point))
|
276
|
1475 (goto-char here))))
|
|
1476
|
|
1477 (defun forms--show-record (the-record)
|
3941
|
1478 "Format THE-RECORD and display it in the current buffer."
|
276
|
1479
|
4121
|
1480 ;; Split the-record.
|
276
|
1481 (let (the-result
|
|
1482 (start-pos 0)
|
|
1483 found-pos
|
|
1484 (field-sep-length (length forms-field-sep)))
|
|
1485 (if forms-multi-line
|
|
1486 (forms--trans the-record forms-multi-line "\n"))
|
4121
|
1487 ;; Add an extra separator (makes splitting easy).
|
276
|
1488 (setq the-record (concat the-record forms-field-sep))
|
|
1489 (while (setq found-pos (string-match forms-field-sep the-record start-pos))
|
|
1490 (let ((ent (substring the-record start-pos found-pos)))
|
|
1491 (setq the-result
|
|
1492 (append the-result (list ent)))
|
|
1493 (setq start-pos (+ field-sep-length found-pos))))
|
|
1494 (setq forms--the-record-list the-result))
|
|
1495
|
|
1496 (setq buffer-read-only nil)
|
4121
|
1497 (if forms-use-text-properties
|
|
1498 (let ((inhibit-read-only t))
|
|
1499 (set-text-properties (point-min) (point-max) nil)))
|
276
|
1500 (erase-buffer)
|
|
1501
|
4121
|
1502 ;; Verify the number of fields, extend forms--the-record-list if needed.
|
276
|
1503 (if (= (length forms--the-record-list) forms-number-of-fields)
|
|
1504 nil
|
12847
|
1505 (if (null forms-check-number-of-fields)
|
|
1506 nil
|
|
1507 (message "Warning: this record has %d fields instead of %d"
|
|
1508 (length forms--the-record-list) forms-number-of-fields))
|
276
|
1509 (if (< (length forms--the-record-list) forms-number-of-fields)
|
49588
|
1510 (setq forms--the-record-list
|
276
|
1511 (append forms--the-record-list
|
49588
|
1512 (make-list
|
|
1513 (- forms-number-of-fields
|
276
|
1514 (length forms--the-record-list))
|
|
1515 "")))))
|
|
1516
|
4121
|
1517 ;; Call the formatter function.
|
307
|
1518 (setq forms-fields (append (list nil) forms--the-record-list nil))
|
276
|
1519 (funcall forms--format forms--the-record-list)
|
|
1520
|
4121
|
1521 ;; Prepare.
|
276
|
1522 (goto-char (point-min))
|
|
1523 (set-buffer-modified-p nil)
|
|
1524 (setq buffer-read-only forms-read-only)
|
|
1525 (setq mode-line-process
|
24077
|
1526 (concat " " (int-to-string forms--current-record)
|
|
1527 "/" (int-to-string forms--total-records))))
|
276
|
1528
|
|
1529 (defun forms--parse-form ()
|
|
1530 "Parse contents of form into list of strings."
|
|
1531 ;; The contents of the form are parsed, and a new list of strings
|
|
1532 ;; is constructed.
|
49588
|
1533 ;; A vector with the strings from the original record is
|
3941
|
1534 ;; constructed, which is updated with the new contents. Therefore
|
276
|
1535 ;; fields which were not in the form are not modified.
|
|
1536 ;; Finally, the vector is transformed into a list for further processing.
|
|
1537
|
4121
|
1538 (let (forms--recordv)
|
276
|
1539
|
4121
|
1540 ;; Build the vector.
|
|
1541 (setq forms--recordv (vconcat forms--the-record-list))
|
276
|
1542
|
4121
|
1543 ;; Parse the form and update the vector.
|
307
|
1544 (let ((forms--dynamic-text forms--dynamic-text))
|
|
1545 (funcall forms--parser))
|
276
|
1546
|
4790
|
1547 (if forms-modified-record-filter
|
307
|
1548 ;; As a service to the user, we add a zeroth element so she
|
|
1549 ;; can use the same indices as in the forms definition.
|
4121
|
1550 (let ((the-fields (vconcat [nil] forms--recordv)))
|
4790
|
1551 (setq the-fields (funcall forms-modified-record-filter the-fields))
|
307
|
1552 (cdr (append the-fields nil)))
|
|
1553
|
4121
|
1554 ;; Transform to a list and return.
|
|
1555 (append forms--recordv nil))))
|
276
|
1556
|
|
1557 (defun forms--update ()
|
3941
|
1558 "Update current record with contents of form.
|
4121
|
1559 As a side effect: sets `forms--the-record-list'."
|
3941
|
1560
|
276
|
1561 (if forms-read-only
|
18215
|
1562 (error "Buffer is read-only"))
|
8344
|
1563
|
18215
|
1564 (let (the-record)
|
|
1565 ;; Build new record.
|
|
1566 (setq forms--the-record-list (forms--parse-form))
|
|
1567 (setq the-record
|
|
1568 (mapconcat 'identity forms--the-record-list forms-field-sep))
|
49588
|
1569
|
18215
|
1570 (if (string-match (regexp-quote forms-field-sep)
|
|
1571 (mapconcat 'identity forms--the-record-list ""))
|
|
1572 (error "Field separator occurs in record - update refused"))
|
49588
|
1573
|
18215
|
1574 ;; Handle multi-line fields, if allowed.
|
|
1575 (if forms-multi-line
|
|
1576 (forms--trans the-record "\n" forms-multi-line))
|
276
|
1577
|
18215
|
1578 ;; A final sanity check before updating.
|
|
1579 (if (string-match "\n" the-record)
|
|
1580 (error "Multi-line fields in this record - update refused"))
|
276
|
1581
|
51325
|
1582 (with-current-buffer forms--file-buffer
|
18215
|
1583 ;; Use delete-region instead of kill-region, to avoid
|
|
1584 ;; adding junk to the kill-ring.
|
51325
|
1585 (delete-region (line-beginning-position) (line-end-position))
|
18215
|
1586 (insert the-record)
|
|
1587 (beginning-of-line))))
|
276
|
1588
|
|
1589 (defun forms--checkmod ()
|
|
1590 "Check if this form has been modified, and call forms--update if so."
|
|
1591 (if (buffer-modified-p nil)
|
|
1592 (let ((here (point)))
|
|
1593 (forms--update)
|
|
1594 (set-buffer-modified-p nil)
|
|
1595 (goto-char here))))
|
3697
|
1596
|
276
|
1597 ;;; Start and exit
|
3941
|
1598
|
|
1599 ;;;###autoload
|
276
|
1600 (defun forms-find-file (fn)
|
3941
|
1601 "Visit a file in Forms mode."
|
276
|
1602 (interactive "fForms file: ")
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1603 (let ((enable-local-eval t)
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1604 (enable-local-variables t))
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1605 (find-file-read-only fn)
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1606 (or forms--mode-setup (forms-mode t))))
|
276
|
1607
|
3941
|
1608 ;;;###autoload
|
276
|
1609 (defun forms-find-file-other-window (fn)
|
3941
|
1610 "Visit a file in Forms mode in other window."
|
276
|
1611 (interactive "fFbrowse file in other window: ")
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1612 (let ((enable-local-eval t)
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1613 (enable-local-variables t))
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1614 (find-file-other-window fn)
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1615 (or forms--mode-setup (forms-mode t))))
|
276
|
1616
|
51325
|
1617 (defun forms-exit ()
|
3941
|
1618 "Normal exit from Forms mode. Modified buffers are saved."
|
51325
|
1619 (interactive)
|
|
1620 (forms--exit t))
|
276
|
1621
|
51325
|
1622 (defun forms-exit-no-save ()
|
3941
|
1623 "Exit from Forms mode without saving buffers."
|
51325
|
1624 (interactive)
|
|
1625 (forms--exit nil))
|
3697
|
1626
|
276
|
1627 ;;; Navigating commands
|
|
1628
|
|
1629 (defun forms-next-record (arg)
|
|
1630 "Advance to the ARGth following record."
|
|
1631 (interactive "P")
|
|
1632 (forms-jump-record (+ forms--current-record (prefix-numeric-value arg)) t))
|
|
1633
|
|
1634 (defun forms-prev-record (arg)
|
|
1635 "Advance to the ARGth previous record."
|
|
1636 (interactive "P")
|
|
1637 (forms-jump-record (- forms--current-record (prefix-numeric-value arg)) t))
|
|
1638
|
51325
|
1639 (defun forms--goto-record (rn &optional current)
|
|
1640 "Goto record number RN.
|
|
1641 If CURRENT is provided, it specifies the current record and can be used
|
|
1642 to speed up access to RN. Returns the number of records missing, if any."
|
|
1643 (if current
|
|
1644 (forward-line (- rn current))
|
|
1645 ;; goto-line does not do what we want when the buffer is narrowed.
|
|
1646 (goto-char (point-min))
|
|
1647 (forward-line (1- rn))))
|
|
1648
|
276
|
1649 (defun forms-jump-record (arg &optional relative)
|
|
1650 "Jump to a random record."
|
|
1651 (interactive "NRecord number: ")
|
|
1652
|
4121
|
1653 ;; Verify that the record number is within range.
|
276
|
1654 (if (or (> arg forms--total-records)
|
|
1655 (<= arg 0))
|
18215
|
1656 (error
|
4121
|
1657 ;; Don't give the message if just paging.
|
276
|
1658 (if (not relative)
|
|
1659 (message "Record number %d out of range 1..%d"
|
18215
|
1660 arg forms--total-records)
|
|
1661 "")))
|
276
|
1662
|
18215
|
1663 ;; Flush.
|
|
1664 (forms--checkmod)
|
276
|
1665
|
18215
|
1666 ;; Calculate displacement.
|
51325
|
1667 (let ((cur forms--current-record))
|
276
|
1668
|
18215
|
1669 ;; `forms--show-record' needs it now.
|
|
1670 (setq forms--current-record arg)
|
276
|
1671
|
18215
|
1672 ;; Get the record and show it.
|
|
1673 (forms--show-record
|
51325
|
1674 (with-current-buffer forms--file-buffer
|
18215
|
1675 (beginning-of-line)
|
276
|
1676
|
18215
|
1677 ;; Move, and adjust the amount if needed (shouldn't happen).
|
51325
|
1678 (setq cur (- arg (forms--goto-record arg (if relative cur))))
|
276
|
1679
|
18215
|
1680 (forms--get-record)))
|
276
|
1681
|
18215
|
1682 ;; This shouldn't happen.
|
|
1683 (if (/= forms--current-record cur)
|
|
1684 (progn
|
|
1685 (setq forms--current-record cur)
|
|
1686 (error "Stuck at record %d" cur)))))
|
276
|
1687
|
|
1688 (defun forms-first-record ()
|
|
1689 "Jump to first record."
|
|
1690 (interactive)
|
|
1691 (forms-jump-record 1))
|
|
1692
|
|
1693 (defun forms-last-record ()
|
3941
|
1694 "Jump to last record.
|
|
1695 As a side effect: re-calculates the number of records in the data file."
|
276
|
1696 (interactive)
|
|
1697 (let
|
49588
|
1698 ((numrec
|
51325
|
1699 (with-current-buffer forms--file-buffer
|
276
|
1700 (count-lines (point-min) (point-max)))))
|
|
1701 (if (= numrec forms--total-records)
|
|
1702 nil
|
|
1703 (setq forms--total-records numrec)
|
4790
|
1704 (message "Warning: number of records changed to %d" forms--total-records)))
|
276
|
1705 (forms-jump-record forms--total-records))
|
3697
|
1706
|
276
|
1707 ;;; Other commands
|
3941
|
1708
|
4790
|
1709 (defun forms-toggle-read-only (arg)
|
|
1710 "Toggles read-only mode of a forms mode buffer.
|
|
1711 With an argument, enables read-only mode if the argument is positive.
|
13984
|
1712 Otherwise enables edit mode if the visited file is writable."
|
4790
|
1713
|
|
1714 (interactive "P")
|
|
1715
|
|
1716 (if (if arg
|
|
1717 ;; Negative arg means switch it off.
|
|
1718 (<= (prefix-numeric-value arg) 0)
|
|
1719 ;; No arg means toggle.
|
|
1720 forms-read-only)
|
276
|
1721
|
4790
|
1722 ;; Enable edit mode, if possible.
|
|
1723 (let ((ro forms-read-only))
|
51325
|
1724 (if (with-current-buffer forms--file-buffer
|
4790
|
1725 buffer-read-only)
|
|
1726 (progn
|
|
1727 (setq forms-read-only t)
|
18215
|
1728 (message "No write access to `%s'" forms-file))
|
4790
|
1729 (setq forms-read-only nil))
|
|
1730 (if (equal ro forms-read-only)
|
|
1731 nil
|
|
1732 (forms-mode)))
|
|
1733
|
|
1734 ;; Enable view mode.
|
|
1735 (if forms-read-only
|
276
|
1736 nil
|
4790
|
1737 (forms--checkmod) ; sync
|
|
1738 (setq forms-read-only t)
|
276
|
1739 (forms-mode))))
|
|
1740
|
|
1741 ;; Sample:
|
307
|
1742 ;; (defun my-new-record-filter (the-fields)
|
276
|
1743 ;; ;; numbers are relative to 1
|
|
1744 ;; (aset the-fields 4 (current-time-string))
|
|
1745 ;; (aset the-fields 6 (user-login-name))
|
|
1746 ;; the-list)
|
307
|
1747 ;; (setq forms-new-record-filter 'my-new-record-filter)
|
276
|
1748
|
|
1749 (defun forms-insert-record (arg)
|
3941
|
1750 "Create a new record before the current one.
|
|
1751 With ARG: store the record after the current one.
|
49588
|
1752 If `forms-new-record-filter' contains the name of a function,
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1753 it is called to fill (some of) the fields with default values.
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1754 If `forms-insert-after is non-nil, the default behavior is to insert
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1755 after the current record."
|
276
|
1756
|
|
1757 (interactive "P")
|
|
1758
|
4790
|
1759 (if forms-read-only
|
|
1760 (error ""))
|
|
1761
|
14732
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1762 (let (ln the-list the-record)
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1763
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1764 (if (or (and arg forms-insert-after)
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1765 (and (not arg) (not forms-insert-after)))
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1766 (setq ln forms--current-record)
|
6bd77cce44a6
(forms-insert-after): New variable. Non-nil means: inserts of new
Johan Vromans <jvromans@squirrel.nl>
diff
changeset
|
1767 (setq ln (1+ forms--current-record)))
|
276
|
1768
|
|
1769 (forms--checkmod)
|
4790
|
1770 (if forms-new-record-filter
|
276
|
1771 ;; As a service to the user, we add a zeroth element so she
|
|
1772 ;; can use the same indices as in the forms definition.
|
|
1773 (let ((the-fields (make-vector (1+ forms-number-of-fields) "")))
|
4790
|
1774 (setq the-fields (funcall forms-new-record-filter the-fields))
|
276
|
1775 (setq the-list (cdr (append the-fields nil))))
|
|
1776 (setq the-list (make-list forms-number-of-fields "")))
|
|
1777
|
|
1778 (setq the-record
|
|
1779 (mapconcat
|
|
1780 'identity
|
|
1781 the-list
|
|
1782 forms-field-sep))
|
|
1783
|
51325
|
1784 (with-current-buffer forms--file-buffer
|
|
1785 (forms--goto-record ln)
|
276
|
1786 (open-line 1)
|
|
1787 (insert the-record)
|
|
1788 (beginning-of-line))
|
49588
|
1789
|
276
|
1790 (setq forms--current-record ln))
|
|
1791
|
|
1792 (setq forms--total-records (1+ forms--total-records))
|
|
1793 (forms-jump-record forms--current-record))
|
|
1794
|
|
1795 (defun forms-delete-record (arg)
|
3941
|
1796 "Deletes a record. With a prefix argument: don't ask."
|
276
|
1797 (interactive "P")
|
4790
|
1798
|
|
1799 (if forms-read-only
|
|
1800 (error ""))
|
|
1801
|
276
|
1802 (forms--checkmod)
|
|
1803 (if (or arg
|
|
1804 (y-or-n-p "Really delete this record? "))
|
|
1805 (let ((ln forms--current-record))
|
51325
|
1806 (with-current-buffer forms--file-buffer
|
|
1807 (forms--goto-record ln)
|
4723
|
1808 ;; Use delete-region instead of kill-region, to avoid
|
|
1809 ;; adding junk to the kill-ring.
|
8272
|
1810 (delete-region (progn (beginning-of-line) (point))
|
|
1811 (progn (beginning-of-line 2) (point))))
|
276
|
1812 (setq forms--total-records (1- forms--total-records))
|
|
1813 (if (> forms--current-record forms--total-records)
|
|
1814 (setq forms--current-record forms--total-records))
|
|
1815 (forms-jump-record forms--current-record)))
|
|
1816 (message ""))
|
|
1817
|
10346
|
1818 (defun forms-search-forward (regexp)
|
|
1819 "Search forward for record containing REGEXP."
|
49588
|
1820 (interactive
|
|
1821 (list (read-string (concat "Search forward for"
|
276
|
1822 (if forms--search-regexp
|
|
1823 (concat " ("
|
|
1824 forms--search-regexp
|
|
1825 ")"))
|
|
1826 ": "))))
|
|
1827 (if (equal "" regexp)
|
|
1828 (setq regexp forms--search-regexp))
|
|
1829 (forms--checkmod)
|
|
1830
|
51325
|
1831 (let (the-line the-record here)
|
|
1832 (with-current-buffer forms--file-buffer
|
18223
|
1833 (end-of-line)
|
|
1834 (setq here (point))
|
|
1835 (if (or (re-search-forward regexp nil t)
|
|
1836 (and (> here (point-min))
|
|
1837 (progn
|
|
1838 (goto-char (point-min))
|
|
1839 (re-search-forward regexp here t))))
|
|
1840 (progn
|
276
|
1841 (setq the-record (forms--get-record))
|
18223
|
1842 (setq the-line (1+ (count-lines (point-min) (point))))
|
|
1843 (if (< (point) here)
|
|
1844 (message "Wrapped")))
|
|
1845 (goto-char here)
|
|
1846 (error "Search failed: %s" regexp)))
|
|
1847 (setq forms--current-record the-line)
|
|
1848 (forms--show-record the-record))
|
|
1849 (re-search-forward regexp nil t)
|
276
|
1850 (setq forms--search-regexp regexp))
|
|
1851
|
10346
|
1852 (defun forms-search-backward (regexp)
|
|
1853 "Search backward for record containing REGEXP."
|
49588
|
1854 (interactive
|
|
1855 (list (read-string (concat "Search backward for"
|
10346
|
1856 (if forms--search-regexp
|
|
1857 (concat " ("
|
|
1858 forms--search-regexp
|
|
1859 ")"))
|
|
1860 ": "))))
|
|
1861 (if (equal "" regexp)
|
|
1862 (setq regexp forms--search-regexp))
|
|
1863 (forms--checkmod)
|
|
1864
|
51325
|
1865 (let (the-line the-record here)
|
|
1866 (with-current-buffer forms--file-buffer
|
18223
|
1867 (beginning-of-line)
|
|
1868 (setq here (point))
|
|
1869 (if (or (re-search-backward regexp nil t)
|
|
1870 (and (< (point) (point-max))
|
|
1871 (progn
|
|
1872 (goto-char (point-max))
|
|
1873 (re-search-backward regexp here t))))
|
|
1874 (progn
|
10346
|
1875 (setq the-record (forms--get-record))
|
18223
|
1876 (setq the-line (1+ (count-lines (point-min) (point))))
|
|
1877 (if (> (point) here)
|
|
1878 (message "Wrapped")))
|
|
1879 (goto-char here)
|
|
1880 (error "Search failed: %s" regexp)))
|
|
1881 (setq forms--current-record the-line)
|
|
1882 (forms--show-record the-record))
|
|
1883 (re-search-forward regexp nil t)
|
10346
|
1884 (setq forms--search-regexp regexp))
|
|
1885
|
8344
|
1886 (defun forms-save-buffer (&optional args)
|
|
1887 "Forms mode replacement for save-buffer.
|
|
1888 It saves the data buffer instead of the forms buffer.
|
18215
|
1889 Calls `forms-write-file-filter' before, and `forms-read-file-filter'
|
|
1890 after writing out the data."
|
8344
|
1891 (interactive "p")
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1892 (forms--checkmod)
|
18215
|
1893 (let ((write-file-filter forms-write-file-filter)
|
24794
|
1894 (read-file-filter forms-read-file-filter)
|
|
1895 (cur forms--current-record))
|
51325
|
1896 (with-current-buffer forms--file-buffer
|
8344
|
1897 (let ((inhibit-read-only t))
|
51325
|
1898 ;; Write file hooks are run via write-file-functions.
|
49588
|
1899 ;; (if write-file-filter
|
|
1900 ;; (save-excursion
|
24794
|
1901 ;; (run-hooks 'write-file-filter)))
|
|
1902
|
|
1903 ;; If they have a write-file-filter, force the buffer to be
|
|
1904 ;; saved even if it doesn't seem to be changed. First, they
|
|
1905 ;; might have changed the write-file-filter; and second, if
|
|
1906 ;; save-buffer does nothing, write-file-filter won't get run,
|
|
1907 ;; and then read-file-filter will be mightily confused.
|
|
1908 (or (null write-file-filter)
|
|
1909 (set-buffer-modified-p t))
|
8344
|
1910 (save-buffer args)
|
|
1911 (if read-file-filter
|
18215
|
1912 (save-excursion
|
|
1913 (run-hooks 'read-file-filter)))
|
24794
|
1914 (set-buffer-modified-p nil)))
|
|
1915 ;; Make sure we end up with the same record number as we started.
|
|
1916 ;; Since read-file-filter may perform arbitrary transformations on
|
|
1917 ;; the data buffer contents, save-excursion is not enough.
|
|
1918 (forms-jump-record cur))
|
7863
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1919 t)
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1920
|
c4adb7401604
(forms-mode): Plug security hole by disabling `eval-buffer' unless
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
1921 (defun forms--revert-buffer (&optional arg noconfirm)
|
276
|
1922 "Reverts current form to un-modified."
|
|
1923 (interactive "P")
|
|
1924 (if (or noconfirm
|
|
1925 (yes-or-no-p "Revert form to unmodified? "))
|
|
1926 (progn
|
|
1927 (set-buffer-modified-p nil)
|
|
1928 (forms-jump-record forms--current-record))))
|
|
1929
|
|
1930 (defun forms-next-field (arg)
|
|
1931 "Jump to ARG-th next field."
|
|
1932 (interactive "p")
|
|
1933
|
|
1934 (let ((i 0)
|
|
1935 (here (point))
|
|
1936 there
|
11557
|
1937 (cnt 0)
|
|
1938 (inhibit-point-motion-hooks t))
|
276
|
1939
|
|
1940 (if (zerop arg)
|
|
1941 (setq cnt 1)
|
|
1942 (setq cnt (+ cnt arg)))
|
|
1943
|
|
1944 (if (catch 'done
|
4121
|
1945 (while (< i (length forms--markers))
|
276
|
1946 (if (or (null (setq there (aref forms--markers i)))
|
|
1947 (<= there here))
|
|
1948 nil
|
|
1949 (if (<= (setq cnt (1- cnt)) 0)
|
|
1950 (progn
|
|
1951 (goto-char there)
|
|
1952 (throw 'done t))))
|
|
1953 (setq i (1+ i))))
|
|
1954 nil
|
|
1955 (goto-char (aref forms--markers 0)))))
|
307
|
1956
|
4790
|
1957 (defun forms-prev-field (arg)
|
|
1958 "Jump to ARG-th previous field."
|
|
1959 (interactive "p")
|
|
1960
|
|
1961 (let ((i (length forms--markers))
|
|
1962 (here (point))
|
|
1963 there
|
11557
|
1964 (cnt 0)
|
|
1965 (inhibit-point-motion-hooks t))
|
4790
|
1966
|
|
1967 (if (zerop arg)
|
|
1968 (setq cnt 1)
|
|
1969 (setq cnt (+ cnt arg)))
|
|
1970
|
|
1971 (if (catch 'done
|
|
1972 (while (> i 0)
|
|
1973 (setq i ( 1- i))
|
|
1974 (if (or (null (setq there (aref forms--markers i)))
|
|
1975 (>= there here))
|
|
1976 nil
|
|
1977 (if (<= (setq cnt (1- cnt)) 0)
|
|
1978 (progn
|
|
1979 (goto-char there)
|
|
1980 (throw 'done t))))))
|
|
1981 nil
|
|
1982 (goto-char (aref forms--markers (1- (length forms--markers)))))))
|
10346
|
1983
|
|
1984 (defun forms-print ()
|
63400
00398c07d65c
(forms--intuit-from-file): Fix reference to `forms-number-of-fields' in error message.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
1985 "Send the records to the printer with `print-buffer', one record per page."
|
10346
|
1986 (interactive)
|
|
1987 (let ((inhibit-read-only t)
|
|
1988 (save-record forms--current-record)
|
24077
|
1989 (total-nb-records forms--total-records)
|
10346
|
1990 (nb-record 1)
|
|
1991 (record nil))
|
|
1992 (while (<= nb-record forms--total-records)
|
|
1993 (forms-jump-record nb-record)
|
|
1994 (setq record (buffer-string))
|
51325
|
1995 (with-current-buffer (get-buffer-create "*forms-print*")
|
10346
|
1996 (goto-char (buffer-end 1))
|
|
1997 (insert record)
|
|
1998 (setq buffer-read-only nil)
|
24077
|
1999 (if (< nb-record total-nb-records)
|
10346
|
2000 (insert "\n\n")))
|
|
2001 (setq nb-record (1+ nb-record)))
|
51325
|
2002 (with-current-buffer "*forms-print*"
|
10346
|
2003 (print-buffer)
|
|
2004 (set-buffer-modified-p nil)
|
|
2005 (kill-buffer (current-buffer)))
|
|
2006 (forms-jump-record save-record)))
|
|
2007
|
307
|
2008 ;;;
|
|
2009 ;;; Special service
|
|
2010 ;;;
|
|
2011 (defun forms-enumerate (the-fields)
|
3941
|
2012 "Take a quoted list of symbols, and set their values to sequential numbers.
|
|
2013 The first symbol gets number 1, the second 2 and so on.
|
13984
|
2014 It returns the highest number.
|
307
|
2015
|
|
2016 Usage: (setq forms-number-of-fields
|
|
2017 (forms-enumerate
|
|
2018 '(field1 field2 field2 ...)))"
|
|
2019
|
|
2020 (let ((the-index 0))
|
|
2021 (while the-fields
|
|
2022 (setq the-index (1+ the-index))
|
|
2023 (let ((el (car-safe the-fields)))
|
|
2024 (setq the-fields (cdr-safe the-fields))
|
|
2025 (set el the-index)))
|
|
2026 the-index))
|
3697
|
2027
|
307
|
2028 ;;; Debugging
|
3941
|
2029
|
307
|
2030 (defvar forms--debug nil
|
|
2031 "*Enables forms-mode debugging if not nil.")
|
|
2032
|
|
2033 (defun forms--debug (&rest args)
|
3941
|
2034 "Internal debugging routine."
|
307
|
2035 (if forms--debug
|
|
2036 (let ((ret nil))
|
|
2037 (while args
|
|
2038 (let ((el (car-safe args)))
|
|
2039 (setq args (cdr-safe args))
|
|
2040 (if (stringp el)
|
|
2041 (setq ret (concat ret el))
|
|
2042 (setq ret (concat ret (prin1-to-string el) " = "))
|
|
2043 (if (boundp el)
|
|
2044 (let ((vel (eval el)))
|
|
2045 (setq ret (concat ret (prin1-to-string vel) "\n")))
|
|
2046 (setq ret (concat ret "<unbound>" "\n")))
|
|
2047 (if (fboundp el)
|
49588
|
2048 (setq ret (concat ret (prin1-to-string (symbol-function el))
|
307
|
2049 "\n"))))))
|
51325
|
2050 (with-current-buffer (get-buffer-create "*forms-mode debug*")
|
4121
|
2051 (if (zerop (buffer-size))
|
|
2052 (emacs-lisp-mode))
|
307
|
2053 (goto-char (point-max))
|
|
2054 (insert ret)))))
|
|
2055
|
93975
|
2056 ;; arch-tag: 4a6695c7-d47a-4a21-809b-5cec7f8ec7a1
|
38436
|
2057 ;;; forms.el ends here
|