mirrored from git://git.sv.gnu.org/emacs.git
/
forms.el
2044 lines (1783 loc) · 67.2 KB
/
forms.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; forms.el --- Forms mode: edit a file as a form to fill in -*- lexical-binding: t; -*-
;; Copyright (C) 1991-2024 Free Software Foundation, Inc.
;; Author: Johan Vromans <jvromans@squirrel.nl>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Visit a file using a form. See etc/forms for examples.
;;
;; === Naming conventions
;;
;; The names of all variables and functions start with 'forms-'.
;; Names which start with 'forms--' are intended for internal use, and
;; should *NOT* be used from the outside.
;;
;; All variables are buffer-local, to enable multiple forms visits
;; simultaneously.
;; Variable `forms--mode-setup' is local to *ALL* buffers, for it
;; controls if forms-mode has been enabled in a buffer.
;;
;; === How it works ===
;;
;; Forms mode means visiting a data file which is supposed to consist
;; of records each containing a number of fields. The records are
;; separated by a newline, the fields are separated by a user-defined
;; field separator (default: TAB).
;; When shown, a record is transferred to an Emacs buffer and
;; presented using a user-defined form. One record is shown at a
;; time.
;;
;; Forms mode is a composite mode. It involves two files, and two
;; buffers.
;; The first file, called the control file, defines the name of the
;; data file and the forms format. This file buffer will be used to
;; present the forms.
;; The second file holds the actual data. The buffer of this file
;; will be buried, for it is never accessed directly.
;;
;; Forms mode is invoked using M-x `forms-find-file' control-file.
;; Alternatively `forms-find-file-other-window' can be used.
;;
;; You may also visit the control file, and switch to forms mode by hand
;; with M-x `forms-mode'.
;;
;; Automatic mode switching is supported if you specify
;; "-*- forms -*-" in the first line of the control file.
;;
;; The control file is visited, evaluated using `eval-buffer',
;; and should set at least the following variables:
;;
;; forms-file [string]
;; The name of the data file.
;;
;; forms-number-of-fields [integer]
;; The number of fields in each record.
;;
;; forms-format-list [list]
;; Formatting instructions.
;;
;; `forms-format-list' should be a list, each element containing
;;
;; - a string, e.g. "hello". The string is inserted in the forms
;; "as is".
;;
;; - an integer, denoting a field number.
;; The contents of this field are inserted at this point.
;; Fields are numbered starting with number one.
;;
;; - a function call, e.g. (insert "text").
;; This function call is dynamically evaluated and should return a
;; string. It should *NOT* have side-effects on the forms being
;; constructed. The current fields are available to the function
;; in the variable `forms-fields', they should *NOT* be modified.
;;
;; - a Lisp symbol, that must evaluate to one of the above.
;;
;; Optional variables which may be set in the control file:
;;
;; forms-field-sep [string, default TAB]
;; The field separator used to separate the
;; fields in the data file. It may be a string.
;;
;; forms-read-only [bool, default nil]
;; Non-nil means that the data file is visited
;; read-only (view mode) as opposed to edit mode.
;; If no write access to the data file is
;; possible, view mode is enforced.
;;
;; forms-check-number-of-fields [bool, default t]
;; If non-nil, a warning will be issued whenever
;; a record is found that does not have the number
;; of fields specified by `forms-number-of-fields'.
;;
;; forms-multi-line [string, default "^K"]
;; If non-null, the records of the data file may
;; contain fields that can span multiple lines in
;; the form.
;; This variable denotes the separator string
;; to be used for this purpose. Upon display, all
;; occurrences of this string are translated
;; to newlines. Upon storage they are translated
;; back to the separator string.
;;
;; forms-forms-scroll [bool, default nil]
;; Non-nil means: rebind locally the commands that
;; perform `scroll-up' or `scroll-down' to use
;; `forms-next-field' resp. `forms-prev-field'.
;;
;; forms-forms-jump [bool, default nil]
;; Non-nil means: rebind locally the commands
;; `beginning-of-buffer' and `end-of-buffer' to
;; perform, respectively, `forms-first-record' and
;; `forms-last-record' instead.
;;
;; forms-insert-after [bool, default nil]
;; Non-nil means: insertions of new records go after
;; current record, also initial position is at the
;; last record. The default is to insert before the
;; current record and the initial position is at the
;; first record.
;;
;; forms-read-file-filter [symbol, default nil]
;; If not nil: this should be the name of a
;; function that is called after the forms data file
;; has been read. It can be used to transform
;; the contents of the file into a format more suitable
;; for forms-mode processing.
;;
;; forms-write-file-filter [symbol, default nil]
;; If not nil: this should be the name of a
;; function that is called before the forms data file
;; is written (saved) to disk. It can be used to undo
;; the effects of `forms-read-file-filter', if any.
;;
;; forms-new-record-filter [symbol, default nil]
;; If not nil: this should be the name of a
;; function that is called when a new
;; record is created. It can be used to fill in
;; the new record with default fields, for example.
;;
;; forms-modified-record-filter [symbol, default nil]
;; If not nil: this should be the name of a
;; function that is called when a record has
;; been modified. It is called after the fields
;; are parsed. It can be used to register
;; modification dates, for example.
;;
;; forms-use-text-properties [bool, see text for default]
;; This variable controls if forms mode should use
;; text properties to protect the form text from being
;; modified (using text-property `read-only').
;; Also, the read-write fields are shown using a
;; distinct face, if possible.
;; The `intangible' text property is used to
;; prevent moving into read-only fields.
;; This variable defaults to t.
;; The default face to show read-write fields is
;; copied from face `region'.
;;
;; forms-ro-face [symbol, default 'default]
;; This is the face that is used to show
;; read-only text on the screen. If used, this
;; variable should be set to a symbol that is a
;; valid face.
;; E.g.
;; (make-face 'my-face)
;; (setq forms-ro-face 'my-face)
;;
;; forms-rw-face [symbol, default 'region]
;; This is the face that is used to show
;; read-write text on the screen.
;;
;; After evaluating the control file, its buffer is cleared and used
;; for further processing.
;; The data file (as designated by `forms-file') is visited in a buffer
;; `forms--file-buffer' which normally will not be shown.
;; Great malfunctioning may be expected if this file/buffer is modified
;; outside of this package while it is being visited!
;;
;; Normal operation is to transfer one line (record) from the data file,
;; split it into fields (into `forms--the-record-list'), and display it
;; using the specs in `forms-format-list'.
;; A format routine `forms--format' is built upon startup to format
;; the records according to `forms-format-list'.
;;
;; When a form is changed the record is updated as soon as this form
;; is left. The contents of the form are parsed using information
;; obtained from `forms-format-list', and the fields which are
;; deduced from the form are modified. Fields not shown on the forms
;; retain their original values. The newly formed record then
;; replaces the contents of the old record in `forms--file-buffer'.
;; A parse routine `forms--parser' is built upon startup to parse
;; the records.
;;
;; Two exit functions exist: `forms-exit' and `forms-exit-no-save'.
;; `forms-exit' saves the data to the file, if modified.
;; `forms-exit-no-save' does not. However, if `forms-exit-no-save'
;; is executed and the file buffer has been modified, Emacs will ask
;; questions anyway.
;;
;; Other functions provided by forms mode are:
;;
;; paging (forward, backward) by record
;; jumping (first, last, random number)
;; searching
;; creating and deleting records
;; reverting the form (NOT the file buffer)
;; switching edit <-> view mode v.v.
;; jumping from field to field
;;
;; As a documented side-effect: jumping to the last record in the
;; file (using forms-last-record) will adjust forms--total-records if
;; needed.
;;
;; The forms buffer can be in one of two modes: edit mode or view
;; mode. View mode is a read-only mode, whereby you cannot modify the
;; contents of the buffer.
;;
;; Edit mode commands:
;;
;; TAB forms-next-field
;; \C-c TAB forms-next-field
;; \C-c < forms-first-record
;; \C-c > forms-last-record
;; \C-c ? describe-mode
;; \C-c \C-k forms-delete-record
;; \C-c \C-q forms-toggle-read-only
;; \C-c \C-o forms-insert-record
;; \C-c \C-l forms-jump-record
;; \C-c \C-n forms-next-record
;; \C-c \C-p forms-prev-record
;; \C-c \C-r forms-search-backward
;; \C-c \C-s forms-search-forward
;; \C-c \C-x forms-exit
;;
;; Read-only mode commands:
;;
;; SPC forms-next-record
;; DEL forms-prev-record
;; ? describe-mode
;; \C-q forms-toggle-read-only
;; l forms-jump-record
;; n forms-next-record
;; p forms-prev-record
;; r forms-search-backward
;; s forms-search-forward
;; x forms-exit
;;
;; Of course, it is also possible to use the \C-c prefix to obtain the
;; same command keys as in edit mode.
;;
;; The following bindings are available, independent of the mode:
;;
;; [next] forms-next-record
;; [prior] forms-prev-record
;; [begin] forms-first-record
;; [end] forms-last-record
;; [S-TAB] forms-prev-field
;; [backtab] forms-prev-field
;;
;; For convenience, TAB is always bound to `forms-next-field', so you
;; don't need the C-c prefix for this command.
;;
;; As mentioned above (see `forms-forms-scroll' and `forms-forms-jump'),
;; the bindings of standard functions `scroll-up', `scroll-down',
;; `beginning-of-buffer' and `end-of-buffer' can be locally replaced with
;; forms mode functions next/prev record and first/last
;; record.
;;
;; `write-file-functions' is defined to save the actual data file
;; instead of the buffer data, `revert-buffer-function' is defined to
;; revert a forms to original.
;;; Code:
(defgroup forms nil
"Edit a file as a form to fill in."
:group 'data)
;;; Global variables and constants:
(defcustom forms-mode-hook nil
"Hook run upon entering Forms mode."
:type 'hook)
;;; Mandatory variables - must be set by evaluating the control file.
(defvar forms-file nil
"Name of the file holding the data.")
(defvar forms-format-list nil
"List of formatting specifications.")
(defvar forms-number-of-fields nil
"Number of fields per record.")
;;; Optional variables with default values.
(defcustom forms-check-number-of-fields t
"If non-nil, warn about records with wrong number of fields."
:type 'boolean)
(defvar forms-field-sep "\t"
"Field separator character (default TAB).")
(defvar forms-read-only nil
"Non-nil means: visit the file in view (read-only) mode.
This is set automatically if the file permissions don't let you write it.")
(defvar forms-multi-line "\C-k" "\
If not nil: use this character to separate multi-line fields (default C-k).")
(defcustom forms-forms-scroll nil
"Non-nil means replace scroll-up/down commands in Forms mode.
The replacement commands performs forms-next/prev-record."
:type 'boolean)
(defcustom forms-forms-jump nil
"Non-nil means redefine beginning/end-of-buffer in Forms mode.
The replacement commands performs forms-first/last-record."
:type 'boolean)
(defvar forms-read-file-filter nil
"The name of a function that is called after reading the data file.
This can be used to change the contents of the file to something more
suitable for forms processing.")
(defvar forms-write-file-filter nil
"The name of a function that is called before writing the data file.
This can be used to undo the effects of `forms-read-file-filter'.")
(defvar forms-new-record-filter nil
"The name of a function that is called when a new record is created.")
(defvar forms-modified-record-filter nil
"The name of a function that is called when a record has been modified.")
(defvar forms-fields nil
"List with fields of the current forms. First field has number 1.
This variable is for use by the filter routines only.
The contents may NOT be modified.")
(defcustom forms-use-text-properties t
"Non-nil means to use text properties."
:type 'boolean)
(defcustom forms-insert-after nil
"Non-nil means: inserts of new records go after current record.
Also, initial position is at last record."
:type 'boolean)
(defcustom forms-ro-face 'default
"The face (a symbol) that is used to display read-only text on the screen."
:type 'face)
(defcustom forms-rw-face 'region
"The face (a symbol) that is used to display read-write text on the screen."
:type 'face)
;;; Internal variables.
(defvar forms--file-buffer nil
"Buffer which holds the file data.")
(defvar forms--total-records 0
"Total number of records in the data file.")
(defvar forms--current-record 0
"Number of the record currently on the screen.")
(defvar forms-mode-map nil
"Keymap for form buffer.")
(defvar forms-mode-ro-map nil
"Keymap for form buffer in view mode.")
(defvar forms-mode-edit-map nil
"Keymap for form buffer in edit mode.")
(defvar forms--markers nil
"Field markers in the screen.")
(defvar forms--dyntexts nil
"Dynamic texts (resulting from function calls) on the screen.")
(defvar forms--the-record-list nil
"List of strings of the current record, as parsed from the file.")
(defvar forms--search-regexp nil
"Last regexp used by forms-search functions.")
(defvar forms--format nil
"Formatting routine.")
(defvar forms--parser nil
"Forms parser routine.")
(defvar-local forms--mode-setup nil
"To keep track of `forms-mode' being set-up.")
(defvar forms--dynamic-text nil
"Array that holds dynamic texts to insert between fields.")
(defvar forms--elements nil
"Array with the order in which the fields are displayed.")
(defvar forms--ro-face nil
"Face used to represent read-only data on the screen.")
(defvar forms--rw-face nil
"Face used to represent read-write data on the screen.")
(defvar read-file-filter) ; bound in forms--intuit-from-file
;; The code used to use `run-hooks' but in a way that's actually
;; incompatible with hooks (and with lexical scoping), so this function
;; approximates the actual behavior that `run-hooks' provided.
(defun forms--run-functions (functions)
(if (functionp functions)
(funcall functions)
(mapc #'funcall functions)))
;;;###autoload
(defun forms-mode (&optional primary)
;; FIXME: use define-derived-mode
"Major mode to visit files in a field-structured manner using a form.
Commands: Equivalent keys in read-only mode:
TAB forms-next-field TAB
C-c TAB forms-next-field
C-c < forms-first-record <
C-c > forms-last-record >
C-c ? describe-mode ?
C-c C-k forms-delete-record
C-c C-q forms-toggle-read-only q
C-c C-o forms-insert-record
C-c C-l forms-jump-record l
C-c C-n forms-next-record n
C-c C-p forms-prev-record p
C-c C-r forms-search-reverse r
C-c C-s forms-search-forward s
C-c C-x forms-exit x"
(interactive)
;; This is not a simple major mode, as usual. Therefore, forms-mode
;; takes an optional argument `primary' which is used for the
;; initial set-up. Normal use would leave `primary' to nil.
;; A global buffer-local variable `forms--mode-setup' has the same
;; effect but makes it possible to auto-invoke forms-mode using
;; `find-file'.
;; Note: although it seems logical to have `make-local-variable'
;; executed where the variable is first needed, I have deliberately
;; placed all calls in this function.
;; Primary set-up: evaluate buffer and check if the mandatory
;; variables have been set.
(if (or primary (not forms--mode-setup))
(progn
;;(message "forms: setting up...")
(kill-all-local-variables)
;; Make mandatory variables.
(make-local-variable 'forms-file)
(make-local-variable 'forms-number-of-fields)
(make-local-variable 'forms-format-list)
;; Make optional variables.
(make-local-variable 'forms-field-sep)
(make-local-variable 'forms-read-only)
(make-local-variable 'forms-multi-line)
(make-local-variable 'forms-forms-scroll)
(make-local-variable 'forms-forms-jump)
(make-local-variable 'forms-insert-after)
(make-local-variable 'forms-use-text-properties)
;; Make sure no filters exist.
(setq-local forms-read-file-filter nil)
(setq-local forms-write-file-filter nil)
(setq-local forms-new-record-filter nil)
(setq-local forms-modified-record-filter nil)
;; Setup faces to show read-only and read-write fields.
(make-local-variable 'forms-ro-face)
(make-local-variable 'forms-rw-face)
;; eval the buffer, should set variables
;;(message "forms: processing control file...")
;; If enable-local-eval is not set to t the user is asked first.
(if (or (eq enable-local-eval t)
(yes-or-no-p
(concat "Evaluate lisp code in buffer "
(buffer-name) " to display forms? ")))
(eval-buffer)
(error "`enable-local-eval' inhibits buffer evaluation"))
;; Check if the mandatory variables make sense.
(or forms-file
(error (concat "Forms control file error: "
"`forms-file' has not been set")))
;; Check forms-field-sep first, since it can be needed to
;; construct a default format list.
(or (stringp forms-field-sep)
(error (concat "Forms control file error: "
"`forms-field-sep' is not a string")))
(if forms-number-of-fields
(or (and (numberp forms-number-of-fields)
(> forms-number-of-fields 0))
(error (concat "Forms control file error: "
"`forms-number-of-fields' must be a number > 0")))
(or (null forms-format-list)
(error (concat "Forms control file error: "
"`forms-number-of-fields' has not been set"))))
(or forms-format-list
(forms--intuit-from-file))
(if forms-multi-line
(if (and (stringp forms-multi-line)
(eq (length forms-multi-line) 1))
(if (string= forms-multi-line forms-field-sep)
(error (concat "Forms control file error: "
"`forms-multi-line' is equal to `forms-field-sep'")))
(error (concat "Forms control file error: "
"`forms-multi-line' must be nil or a one-character string"))))
;; Validate and process forms-format-list.
;;(message "forms: pre-processing format list...")
(make-local-variable 'forms--elements)
(forms--process-format-list)
;; Build the formatter and parser.
;;(message "forms: building formatter...")
(make-local-variable 'forms--format)
(make-local-variable 'forms--markers)
(make-local-variable 'forms--dyntexts)
;;(message "forms: building parser...")
(forms--make-format)
(make-local-variable 'forms--parser)
(forms--make-parser)
;;(message "forms: building parser... done.")
;; Check if record filters are defined.
(if (and forms-new-record-filter
(not (functionp forms-new-record-filter)))
(error (concat "Forms control file error: "
"`forms-new-record-filter' is not a function")))
(if (and forms-modified-record-filter
(not (functionp forms-modified-record-filter)))
(error (concat "Forms control file error: "
"`forms-modified-record-filter' is not a function")))
;; The filters access the contents of the forms using `forms-fields'.
(make-local-variable 'forms-fields)
;; Dynamic text support.
(make-local-variable 'forms--dynamic-text)
;; Prevent accidental overwrite of the control file and auto-save.
;; We bind change-major-mode-with-file-name to nil to prevent
;; set-visited-file-name from calling set-auto-mode, which
;; might kill all local variables and set forms-file nil,
;; which will then barf in find-file-noselect below. This can
;; happen when the user sets the default major mode that is
;; different from the Fundamental mode.
(let (change-major-mode-with-file-name)
(set-visited-file-name nil))
;; Prepare this buffer for further processing.
(setq buffer-read-only nil)
(erase-buffer)
;;(message "forms: setting up... done.")
))
;; initialization done
(setq forms--mode-setup t)
;; Copy desired faces to the actual variables used by the forms formatter.
(make-local-variable 'forms--ro-face)
(make-local-variable 'forms--rw-face)
(if forms-read-only
(progn
(setq forms--ro-face forms-ro-face)
(setq forms--rw-face forms-ro-face))
(setq forms--ro-face forms-ro-face)
(setq forms--rw-face forms-rw-face))
;; Make more local variables.
(make-local-variable 'forms--file-buffer)
(make-local-variable 'forms--total-records)
(make-local-variable 'forms--current-record)
(make-local-variable 'forms--the-record-list)
(make-local-variable 'forms--search-regexp)
;; The keymaps are global, so multiple forms mode buffers can share them.
;;(make-local-variable 'forms-mode-map)
;;(make-local-variable 'forms-mode-ro-map)
;;(make-local-variable 'forms-mode-edit-map)
(if forms-mode-map ; already defined
nil
;;(message "forms: building keymap...")
(forms--mode-commands)
;;(message "forms: building keymap... done.")
)
;; set the major mode indicator
(setq major-mode 'forms-mode)
(setq mode-name "Forms")
(cursor-intangible-mode 1)
;; find the data file
(setq forms--file-buffer (find-file-noselect forms-file))
;; Pre-transform.
(let ((read-file-filter forms-read-file-filter)
(write-file-filter forms-write-file-filter))
(if read-file-filter
(with-current-buffer forms--file-buffer
(let ((inhibit-read-only t)
(file-modified (buffer-modified-p)))
(forms--run-functions read-file-filter)
(if (not file-modified) (set-buffer-modified-p nil)))
(if write-file-filter
(add-hook 'write-file-functions write-file-filter nil t)))
(if write-file-filter
(with-current-buffer forms--file-buffer
(add-hook 'write-file-functions write-file-filter nil t)))))
;; count the number of records, and set see if it may be modified
(let (ro)
(setq forms--total-records
(with-current-buffer forms--file-buffer
(prog1
(progn
;;(message "forms: counting records...")
(bury-buffer (current-buffer))
(setq ro buffer-read-only)
(count-lines (point-min) (point-max)))
;;(message "forms: counting records... done.")
)))
(if ro
(setq forms-read-only t)))
;;(message "forms: proceeding setup...")
;; Since we aren't really implementing a minor mode, we hack the mode line
;; directly to get the text " View " into forms-read-only form buffers. For
;; that reason, this variable must be buffer only.
(make-local-variable 'minor-mode-alist)
(setq minor-mode-alist (list (list 'forms-read-only " View")))
;;(message "forms: proceeding setup (keymaps)...")
(forms--set-keymaps)
;;(message "forms: proceeding setup (commands)...")
(forms--change-commands)
;;(message "forms: proceeding setup (buffer)...")
(set-buffer-modified-p nil)
(if (= forms--total-records 0)
;;(message "forms: proceeding setup (new file)...")
(progn
(insert
"GNU Emacs Forms Mode\n\n"
(if (file-exists-p forms-file)
(format-message
"No records available in file `%s'\n\n" forms-file)
(format-message
"Creating new file `%s'\nwith %d field%s per record\n\n"
forms-file forms-number-of-fields
(if (= 1 forms-number-of-fields) "" "s")))
"Use " (substitute-command-keys "\\[forms-insert-record]")
" to create new records.\n")
(setq forms--current-record 1)
(setq buffer-read-only t)
(set-buffer-modified-p nil))
;; setup the first (or current) record to show
(if (< forms--current-record 1)
(setq forms--current-record 1))
(forms-jump-record forms--current-record)
(if forms-insert-after
(forms-last-record)
(forms-first-record))
)
;; user customizing
;;(message "forms: proceeding setup (user hooks)...")
(run-mode-hooks 'forms-mode-hook 'forms-mode-hooks)
;;(message "forms: setting up... done.")
;; be helpful
(forms--help))
(defun forms--process-format-list ()
;; Validate `forms-format-list' and set some global variables.
;; Symbols in the list are evaluated, and consecutive strings are
;; concatenated.
;; Array `forms--elements' is constructed that contains the order
;; of the fields on the display. This array is used by
;; `forms--parser-using-text-properties' to extract the fields data
;; from the form on the screen.
;; Upon completion, `forms-format-list' is guaranteed correct, so
;; `forms--make-format' and `forms--make-parser' do not need to perform
;; any checks.
;; Verify that `forms-format-list' is not nil.
(or forms-format-list
(error (concat "Forms control file error: "
"`forms-format-list' has not been set")))
;; It must be a list.
(or (listp forms-format-list)
(error (concat "Forms control file error: "
"`forms-format-list' is not a list")))
;; Assume every field is painted once.
;; `forms--elements' will grow if needed.
(setq forms--elements (make-vector forms-number-of-fields nil))
(let ((the-list forms-format-list) ; the list of format elements
(prev-item nil)
(field-num 0)) ; highest field number
(setq forms-format-list nil) ; gonna rebuild
(while the-list
(let ((el (car-safe the-list))
(rem (cdr-safe the-list)))
;; If it is a symbol, eval it first.
(if (and (symbolp el)
(boundp el))
(setq el (symbol-value el)))
(cond
;; Try string ...
((stringp el)
(if (stringp prev-item) ; try to concatenate strings
(setq prev-item (concat prev-item el))
(if prev-item
(setq forms-format-list
(append forms-format-list (list prev-item) nil)))
(setq prev-item el)))
;; Try numeric ...
((numberp el)
;; Validate range.
(if (or (<= el 0)
(> el forms-number-of-fields))
(error (concat "Forms format error: "
"field number %d out of range 1..%d")
el forms-number-of-fields))
;; Store forms order.
(if (>= field-num (length forms--elements))
(setq forms--elements (vconcat forms--elements (1- el)))
(aset forms--elements field-num (1- el)))
(setq field-num (1+ field-num))
(if prev-item
(setq forms-format-list
(append forms-format-list (list prev-item) nil)))
(setq prev-item el))
;; Try function ...
((listp el)
;; Validate.
(or (fboundp (car-safe el))
(error (concat "Forms format error: "
"%S is not a function")
(car-safe el)))
;; Shift.
(if prev-item
(setq forms-format-list
(append forms-format-list (list prev-item) nil)))
(setq prev-item el))
;; else
(t
(error (concat "Forms format error: "
"invalid element %S")
el)))
;; Advance to next element of the list.
(setq the-list rem)))
;; Append last item.
(if prev-item
(progn
(setq forms-format-list
(append forms-format-list (list prev-item) nil))
;; Append a newline if the last item is a field.
;; This prevents parsing problems.
;; Also it makes it possible to insert an empty last field.
(if (numberp prev-item)
(setq forms-format-list
(append forms-format-list (list "\n") nil))))))
(forms--debug 'forms-format-list
'forms--elements))
;; Special treatment for read-only segments.
;;
;; If text is inserted between two read-only segments, there seems to
;; be no way to give the newly inserted text the RW face.
;; To solve this, read-only segments get the `insert-in-front-hooks'
;; property set with a function that temporarily switches the
;; properties of the first character of the segment to the RW face, so
;; the new text gets the right face. The `post-command-hook' is
;; used to restore the original properties.
(defvar forms--iif-start nil
"Record start of modification command.")
(defvar forms--iif-properties nil
"Original properties of the character being overridden.")
(defun forms--iif-hook (_begin _end)
"`insert-in-front-hooks' function for read-only segments."
;; Note start location. By making it a marker that points one
;; character beyond the actual location, it is guaranteed to move
;; correctly if text is inserted.
(or forms--iif-start
(setq forms--iif-start (copy-marker (1+ (point)))))
;; Check if there is special treatment required.
(if (or (<= forms--iif-start 2)
(get-text-property (- forms--iif-start 2)
'read-only))
(progn
;; Fetch current properties.
(setq forms--iif-properties
(text-properties-at (1- forms--iif-start)))
;; Replace them.
(let ((inhibit-read-only t))
(set-text-properties
(1- forms--iif-start) forms--iif-start
(list 'face forms--rw-face 'front-sticky '(face))))
;; Enable `post-command-hook' to restore the properties.
(add-hook 'post-command-hook #'forms--iif-post-command-hook))
;; No action needed. Clear marker.
(setq forms--iif-start nil)))
(defun forms--iif-post-command-hook ()
"`post-command-hook' function for read-only segments."
;; Disable `post-command-hook'.
(remove-hook 'post-command-hook #'forms--iif-post-command-hook)
;; Restore properties.
(if forms--iif-start
(let ((inhibit-read-only t))
(set-text-properties
(1- forms--iif-start) forms--iif-start
forms--iif-properties)))
;; Cleanup.
(setq forms--iif-start nil))
(defvar forms--marker)
(defvar forms--dyntext)
(defun forms--make-format ()
"Generate `forms--format' using the information in `forms-format-list'."
;; The real work is done using a mapcar of `forms--make-format-elt' on
;; `forms-format-list'.
;; This function sets up the necessary environment, and decides
;; which function to mapcar.
(let ((forms--marker 0)
(forms--dyntext 0))
(setq
forms--format
(if forms-use-text-properties
`(lambda (arg)
(let ((inhibit-read-only t))
,@(apply #'append
(mapcar #'forms--make-format-elt-using-text-properties
forms-format-list))
;; Prevent insertion before the first text.
,@(if (numberp (car forms-format-list))
nil
'((add-text-properties (point-min) (1+ (point-min))
'(front-sticky (read-only cursor-intangible)))))
;; Prevent insertion after the last text.
(remove-text-properties (1- (point)) (point)
'(rear-nonsticky nil)))
(setq forms--iif-start nil))
`(lambda (arg)
,@(apply #'append
(mapcar #'forms--make-format-elt forms-format-list)))))
;; We have tallied the number of markers and dynamic texts,
;; so we can allocate the arrays now.
(setq forms--markers (make-vector forms--marker nil))
(setq forms--dyntexts (make-vector forms--dyntext nil)))
(forms--debug 'forms--format))
(defun forms--make-format-elt-using-text-properties (el)
"Helper routine to generate format function."
;; The format routine `forms--format' will look like
;;
;; ;; preamble
;; (lambda (arg)
;; (let ((inhibit-read-only t))
;;
;; ;; A string, e.g. "text: ".
;; (set-text-properties
;; (point)
;; (progn (insert "text: ") (point))
;; (list 'face forms--ro-face
;; 'read-only 1
;; 'insert-in-front-hooks 'forms--iif-hook
;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
;;
;; ;; A field, e.g. 6.
;; (let ((here (point)))
;; (aset forms--markers 0 (point-marker))
;; (insert (elt arg 5))
;; (or (= (point) here)
;; (set-text-properties
;; here (point)
;; (list 'face forms--rw-face
;; 'front-sticky '(face))))
;;
;; ;; Another string, e.g. "\nmore text: ".
;; (set-text-properties
;; (point)
;; (progn (insert "\nmore text: ") (point))
;; (list 'face forms--ro-face
;; 'read-only 2
;; 'insert-in-front-hooks 'forms--iif-hook
;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
;;
;; ;; A function, e.g. (tocol 40).
;; (set-text-properties
;; (point)
;; (progn
;; (insert (aset forms--dyntexts 0 (tocol 40)))
;; (point))
;; (list 'face forms--ro-face
;; 'read-only 2
;; 'insert-in-front-hooks 'forms--iif-hook
;; 'rear-nonsticky '(read-only face insert-in-front-hooks)))
;;
;; ;; Prevent insertion before the first text.
;; (add-text-properties (point-min) (1+ (point-min))
;; '(front-sticky (read-only))))))
;; ;; Prevent insertion after the last text.
;; (remove-text-properties (1- (point)) (point)
;; '(rear-nonsticky nil)))
;;
;; ;; wrap up
;; (setq forms--iif-start nil)
;; ))
(cond
((stringp el)
`((set-text-properties
(point) ; start at point
(progn ; until after insertion
(insert ,el)
(point))
(list 'face forms--ro-face ; read-only appearance
'read-only ,@(list (1+ forms--marker))
'cursor-intangible ,@(list (1+ forms--marker))
'insert-in-front-hooks '(forms--iif-hook)
'rear-nonsticky '(face read-only insert-in-front-hooks
cursor-intangible)))))