forked from agomezl/simp-isar-mode
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathunicode-tokens.el
1559 lines (1366 loc) · 59.2 KB
/
unicode-tokens.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
;;; unicode-tokens.el --- Support for control and symbol tokens
;;
;; Copyright(C) 2008-2010 David Aspinall / LFCS Edinburgh
;; Author: David Aspinall <[email protected]>
;; License: GPL (GNU GENERAL PUBLIC LICENSE)
;;
;; $Id$
;;
;; This 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 2, or (at your option)
;; any later version.
;; This software 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; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;;
;; This is a replacement for X-Symbol for Proof General.
;;
;; Functions to display tokens that represent Unicode characters and
;; control code sequences for changing the layout. Tokens are useful
;; for programs that do not understand a Unicode encoding.
;;
;; Desirable improvements/enhancements
;;
;; -- insert tokens via numeric code (extra format string), cf HTML
;; -- simplify: unify region and control settings?
;; -- simplify/optimise property handling
;; -- support multiple modes with mode-local configs at once
;;
;;; Code:
;;
(require 'quail)
;; Emacs <24 compatibility
(when (and (fboundp 'flet)
(not (get 'flet 'byte-obsolete-info)))
(defalias 'cl-flet 'flet))
;;
;; Customizable user options
;;
(defgroup unicode-tokens-options nil
"User options for Unicode Tokens mode."
:group 'faces
:prefix "unicode-tokens-")
(defcustom unicode-tokens-add-help-echo t
"If non-nil, add mouse hover (or minibuffer messages) to show tokens."
:type 'boolean
:group 'unicode-tokens-options)
(defun unicode-tokens-toggle-add-help-echo ()
(interactive)
(customize-set-variable 'unicode-tokens-add-help-echo
(not unicode-tokens-add-help-echo))
;; NB: approximate, should refontify all...
(font-lock-flush))
;;
;; Variables that should be set by client modes
;;
;; Each variable may be set directly or indirectly; see
;; `unicode-tokens-copy-configuration-variables' below.
;;
(defvar unicode-tokens-token-symbol-map nil
"Mapping of token names to compositions.
A list, each element of which is a list
(TOKNAME COMPOSITION FONTSYMB ...)
A composition is typically a single Unicode character string, but
can be more complex: see documentation of `compose-region'.
TOKNAMEs may be repeated. The first one with a usable
composition according to `unicode-tokens-usable-composition',
if any.
The sequence of FONTSYMB are optional. Each FONTSYMB is a symbol
indicating a set of additional text properties, looked up in
`unicode-tokens-fontsymb-properties'.
By default, tokens are displayed in `unicode-tokens-symbol-font-face'.")
(defvar unicode-tokens-token-format "%s"
"Format string for formatting token a name into a token.
Will be regexp quoted for matching. Not used for matching if
`unicode-tokens-token-variant-format-regexp' is set.
Also used to format shortcuts.")
(defvar unicode-tokens-token-variant-format-regexp nil
"A regular expression which matches a token variant.
Will not be regexp quoted, and will be formatted with
a nested regexp that matches any token.
An example would be: \\\\(%s\\\\)\\\\(:?\\w+\\\\)
which matches plain token strings optionally followed by a colon
and variant name. Once set, (match-string 1) should be
the name of the token whereas (match-string 0) matches
the longer text, if any.
If set, this variable is used instead of `unicode-tokens-token-format'.")
(defvar unicode-tokens-shortcut-alist nil
"An alist of keyboard shortcuts to unicode strings.
The alist is added to the input mode for tokens.
The shortcuts are only used for input convenience; no reverse
mapping back to shortucts is performed. Behaviour is like abbrev.")
(defvar unicode-tokens-shortcut-replacement-alist nil
"Overrides `unicode-tokens-shortcut-alist' for `unicode-tokens-replace-shortcuts'.")
;;
;; Variables that may optionally be set in client modes
;;
(defvar unicode-tokens-control-region-format-regexp nil
"A regexp for control regions, with up to two %s placeholders.
When fomatted with arguments START END, results in a regexp
that matches a control region. There should be three delimited
subexpressions: (match-string 1) and (match-string 3) are hidden,
and (match-string 2) has the display control applied.")
(defvar unicode-tokens-control-char-format-regexp nil
"A format string for control characters, possibly with a %s placeholder.
When fomatted with arguments STRING, results in a regexp
that matches a control character sequence. There should be two
delimited subexpressions: (match-string 1) is hidden
and (match-string 2) has the display control applied.")
(defvar unicode-tokens-control-regions nil
"A list of control regions.")
(defvar unicode-tokens-control-characters nil
"A list of control characters.")
(defvar unicode-tokens-control-char-format nil
"A format string for inserting a control character sequence.")
(defvar unicode-tokens-control-region-format-start nil
"A format string for begining a control region sequence.")
(defvar unicode-tokens-control-region-format-end nil
"A format string for ending a control region sequence.")
(defvar unicode-tokens-tokens-customizable-variables nil
"A list of lists (NAME VAR) of variables for a customize submenu.")
;;
;; A list of the above variables
;;
(defconst unicode-tokens-configuration-variables
'(token-symbol-map
token-format
token-variant-format-regexp
shortcut-alist
shortcut-replacement-alist
control-region-format-regexp
control-region-format-start
control-region-format-end
control-char-format-regexp
control-char-format
control-regions
control-characters
tokens-customizable-variables))
(defun unicode-tokens-config (sym)
"Construct the symbol name `unicode-tokens-SYM'."
(intern (concat "unicode-tokens-" (symbol-name sym))))
(defun unicode-tokens-config-var (sym)
"Construct the symbol name `unicode-tokens-SYM-variable'."
(intern (concat "unicode-tokens-" (symbol-name sym) "-variable")))
(dolist (sym unicode-tokens-configuration-variables)
(lambda (sym)
(eval `(defvar ,(unicode-tokens-config-var sym)
nil
,(format
"Name of a variable used to configure %s.\nValue should be a symbol."
(symbol-name (unicode-tokens-config sym)))))))
(defun unicode-tokens-copy-configuration-variables ()
"Initialise the configuration variables by copying from variable names.
Each configuration variable may be set directly or indirectly by client;
modes an indirect setting is made by this function from a variable named
<setting>-variable, e.g., unicode-tokens-token-symbol-map
will be initialised from unicode-tokens-token-symbol-map-variable,
if it is bound; it should be the name of a variable."
(dolist (sym unicode-tokens-configuration-variables)
(let ((var (unicode-tokens-config-var sym)))
(if (and (boundp var) (not (null (symbol-value var))))
(set (unicode-tokens-config sym)
(symbol-value (symbol-value
(unicode-tokens-config-var sym)))))))
(unless unicode-tokens-shortcut-replacement-alist
(setq unicode-tokens-shortcut-replacement-alist
unicode-tokens-shortcut-alist))
(unless unicode-tokens-tokens-customizable-variables
(setq unicode-tokens-tokens-customizable-variables
(list
(list "Token Map"
(symbol-value (unicode-tokens-config-var 'token-symbol-map)))
(list "Shortcut List"
(symbol-value (unicode-tokens-config-var 'shortcut-alist)))))))
;;
;; Variables set in the mode
;;
(defvar unicode-tokens-token-list nil
"List of usable token names in order from `unicode-tokens-token-symbol-map'.")
(defvar unicode-tokens-hash-table nil
"Hash table mapping token names (strings) to composition and properties.")
(defvar unicode-tokens-token-match-regexp nil
"Regular expression used by font-lock to match known tokens.
The match should span the whole token; (match-string 1) should
span the token name, if that is shorter.
The value is calculated by `unicode-tokens-calculate-token-match'.")
(defvar unicode-tokens-uchar-hash-table nil
"Hash table mapping unicode strings to symbolic token names.
This is used for an approximate reverse mapping, see `unicode-tokens-paste'.")
(defvar unicode-tokens-uchar-regexp nil
"Regular expression matching converted tokens.
This is used for an approximate reverse mapping, see `unicode-tokens-paste'.")
;;
;; Faces
;;
(defgroup unicode-tokens-faces nil
"The faces used in Unicode Tokens mode."
:group 'faces)
;;
;; This is a fallback for when fontconfig is not used/available.
;;
;; NB: even with fontconfig, name aliasing has undesirable effects
;; (e.g., can end up with version of font without anti-aliasing)
;;
(defconst unicode-tokens-font-family-alternatives
'(("STIXGeneral"
"DejaVu Sans Mono" "DejaVuLGC Sans Mono"
"Lucida Grande" "Lucida Sans Unicode" "Apple Symbols")
("Script"
"Lucida Calligraphy" "URW Chancery L" "Zapf Chancery")
("Fraktur"
"Lucida Blackletter" "Isabella" "URW Bookman L")))
(if (boundp 'face-font-family-alternatives)
(custom-set-default
'face-font-family-alternatives
(append face-font-family-alternatives
unicode-tokens-font-family-alternatives)))
(defface unicode-tokens-symbol-font-face
'((t :family "STIXGeneral")) ;; best, but needs installation/config
; '((t :family "DejaVu Sans Mono")) ;; more reliable default on Ubuntu
"The default font used for symbols. Only :family and :slant attributes are used."
:group 'unicode-tokens-faces)
;; (defface unicode-tokens-large-symbol-font-face
;; '((t :family "STIXSizeThreeSym"))
;; "The font used for large symbols."
;; :group 'unicode-tokens-faces)
(defface unicode-tokens-script-font-face
'((t :family "URW Chancery L" :slant italic))
"Script font face."
:group 'unicode-tokens-faces)
(defface unicode-tokens-fraktur-font-face
'((t :family "Fraktur"))
"Fraktur font face."
:group 'unicode-tokens-faces)
(defface unicode-tokens-serif-font-face
'((t :family "Times New Roman"))
"Serif (roman) font face."
:group 'unicode-tokens-faces)
(defface unicode-tokens-sans-font-face
'((t :family "Sans"))
"Sans serif font face."
:group 'unicode-tokens-faces)
(defface unicode-tokens-highlight-face
'((((min-colors 88) (background dark))
(:background "yellow1" :foreground "black"))
(((background dark)) (:background "yellow" :foreground "black"))
(((min-colors 88)) (:background "yellow1"))
(t (:background "yellow")))
"Face used for highlighting in Unicode tokens."
:group 'unicode-tokens-faces)
(defconst unicode-tokens-fonts
'(symbol script fraktur serif sans) ; large-symbol
"A list of the faces used for setting fonts for Unicode Tokens.")
;;
;; Standard text properties used to build fontification
;;
(defconst unicode-tokens-fontsymb-properties
`((sub "Lower" ,(if (display-graphic-p)
'(display (raise -0.4))
'(face (:width ultra-condensed :height 0.8 :slant reverse-italic :foreground "LightSalmon4"))))
(sup "Raise" ,(if (display-graphic-p)
'(display (raise 0.4))
'(face (:width ultra-condensed :height 0.8 :slant italic :foreground "LightSalmon4")))) ;;(display (raise 0.4))
(bold "Bold" (face (:weight bold)))
(italic "Italic" (face (:slant italic)))
(big "Bigger" (face (:height 1.5)))
(small "Smaller" (face (:height 0.75)))
(underline "Underline" (face (:underline t)))
(overline "Overline" (face (:overline t)))
;; NB: symbols for fonts need to be as in unicode-tokens-fonts
(script "Script font" (face unicode-tokens-script-font-face))
(frakt "Frakt font" (face unicode-tokens-fraktur-font-face))
(serif "Serif font" (face unicode-tokens-serif-font-face))
(sans "Sans font" (face unicode-tokens-sans-font-face))
; (large-symbol "Large Symbol font"
; (face unicode-tokens-large-symbol-font-face))
(keyword "Keyword face" (face font-lock-keyword-face))
(function "Function name face" (face font-lock-function-name-face))
(type "Type face" (face font-lock-type-face))
(preprocessor "Preprocessor face" (face font-lock-preprocessor-face))
(doc "Documentation face" (face font-lock-preprocessor-face))
(builtin "Builtin face" (face font-lock-builtin-face))
(tacticals "Tacticals face" (face proof-tacticals-name-face)))
"Association list mapping a symbol to a name and list of text properties.
Used in `unicode-tokens-token-symbol-map', `unicode-tokens-control-regions',
and `unicode-tokens-control-characters'.
Several symbols can be used at once, in `unicode-tokens-token-symbol-map'.")
(define-widget 'unicode-tokens-token-symbol-map 'lazy
"Type for customize variables used to set `unicode-tokens-token-symbol-map'."
:offset 4
:tag "Token symbol map"
:type
;; TODO: improve this so customize editing is more pleasant.
(list 'repeat :tag "Map entries"
(append
'(list :tag "Mapping"
(string :tag "Token name")
(sexp :tag "Composition"))
(list (append
'(set :tag "Text property styles" :inline t)
(mapcar (lambda (fsp)
(list 'const :tag
(cadr fsp) (car fsp)))
unicode-tokens-fontsymb-properties))))))
(define-widget 'unicode-tokens-shortcut-alist 'lazy
"Type for customize variables used to set `unicode-tokens-shortcut-alist'."
:offset 4
:tag "Shortcut list"
:type '(repeat :tag "Shortcut list"
(cons (string :tag "Shortcut sequence")
(string :tag "Buffer string"))))
;;
;; Calculating font-lock-keywords
;;
(defconst unicode-tokens-font-lock-extra-managed-props
'(composition help-echo display invisible)
"Value for `font-lock-extra-managed-props' here.")
(defun unicode-tokens-font-lock-keywords ()
"Calculate and return value for `font-lock-keywords'.
This function also initialises the important tables for the mode."
;; Credit to Stefan Monnier for much slimmer original version
(let ((hash (make-hash-table :test 'equal))
(ucharhash (make-hash-table :test 'equal))
toks uchars)
(dolist (x unicode-tokens-token-symbol-map)
(let ((tok (car x))
(comp (cadr x)))
(when (unicode-tokens-usable-composition comp)
(unless (gethash tok hash)
(puthash tok (cdr x) hash)
(push tok toks)
(if (stringp comp) ;; reverse map only for string comps
(unless (or (gethash comp ucharhash)
;; ignore plain chars for reverse map
(string-match "[a-zA-Z0-9]+" comp))
(push comp uchars)
(puthash comp tok ucharhash)))))))
(when toks
(setq unicode-tokens-hash-table hash)
(setq unicode-tokens-uchar-hash-table ucharhash)
(setq unicode-tokens-uchar-regexp (regexp-opt uchars))
(setq unicode-tokens-token-match-regexp
(unicode-tokens-calculate-token-match toks))
(setq unicode-tokens-token-list (nreverse toks))
(cons
`(,unicode-tokens-token-match-regexp
(0 (unicode-tokens-help-echo) prepend)
(0 (unicode-tokens-font-lock-compose-symbol 1) prepend))
(unicode-tokens-control-font-lock-keywords)))))
(defun unicode-tokens-calculate-token-match (toks)
"Calculate value for `unicode-tokens-token-match-regexp'."
; (with-syntax-table (standard-syntax-table)
;; hairy logic based on Coq-style vs Isabelle-style configs
(if (string= "" (format unicode-tokens-token-format ""))
;; no special token format, parse separate words/symbols
(let* ((tokextra (cl-remove "^\\(?:\\sw\\|\\s_\\)+$" toks :test 'string-match))
(toksymbwrd (cl-set-difference toks tokextra))
;; indentifier that are not pure words
(toksymb (cl-remove "^\\(?:\\sw\\)+$" toksymbwrd :test 'string-match))
;; pure words
(tokwrd (cl-set-difference toksymbwrd toksymb))
(idorop
(concat "\\(\\_<"
(regexp-opt toksymb)
"\\_>\\|\\(?:\\<"
(regexp-opt tokwrd)
"\\>\\)\\|\\(?:\\B"
(regexp-opt tokextra)
"\\B\\)\\)")))
(if unicode-tokens-token-variant-format-regexp
(format unicode-tokens-token-variant-format-regexp
idorop)
idorop))
;; otherwise, assumption is that token syntax delimits tokens
(if unicode-tokens-token-variant-format-regexp
(format unicode-tokens-token-variant-format-regexp
(regexp-opt toks))
(regexp-opt (mapcar (lambda (tok)
(format unicode-tokens-token-format tok))
toks)))));)
(defun unicode-tokens-usable-composition (comp)
"Return non-nil if the composition COMP seems to be usable.
The check is with `char-displayable-p'."
(cond
((stringp comp)
(cl-reduce (lambda (x y) (and x (char-displayable-p y)))
comp
:initial-value t))
((characterp comp)
(char-displayable-p comp))
(comp ;; assume any other non-null is OK
t)))
(defun unicode-tokens-help-echo ()
"Return a help-echo text property to display the contents of match string."
(if unicode-tokens-add-help-echo
(list 'face nil 'help-echo (match-string 0))))
(defvar unicode-tokens-show-symbols nil
"Non-nil to reveal symbol (composed) tokens instead of compositions.")
(defun unicode-tokens-interpret-composition (comp)
"Turn the composition string COMP into an argument for `compose-region'."
(cond
((and (stringp comp) (= 1 (length comp)))
comp)
((stringp comp)
;; change a longer string into a sequence placing glyphs left-to-right.
(let ((chars (nreverse (string-to-list comp)))
(sep '(5 . 3))
res)
(while chars
(setq res (cons (car chars) res))
(if (setq chars (cdr chars))
(setq res (cons sep res))))
res))
(t
comp)))
(defun unicode-tokens-font-lock-compose-symbol (match)
"Compose a sequence of chars into a symbol.
Regexp match data number MATCH selects the token name, while match
number 1 matches the text to be replaced.
Token name from MATCH is searched for in `unicode-tokens-hash-table'.
The face property is set to the :family and :slant attriubutes taken from
`unicode-tokens-symbol-font-face'."
(let* ((start (match-beginning 0))
(end (match-end 0))
(compps (gethash (match-string match)
unicode-tokens-hash-table))
(propsyms (cdr-safe compps))
(comp (car-safe compps)))
(if (and comp (not unicode-tokens-show-symbols))
(compose-region start end
(unicode-tokens-interpret-composition comp)))
(if propsyms
(let ((props (unicode-tokens-symbs-to-props propsyms)))
(while props
(font-lock-append-text-property start end
(car props) (cadr props))
(setq props (cddr props)))))
(unless (or unicode-tokens-show-symbols
(cl-intersection unicode-tokens-fonts propsyms))
(font-lock-append-text-property
start end 'face
;; just use family and slant to enhance merging with other faces
(list :family
(face-attribute 'unicode-tokens-symbol-font-face :family)))
(if (face-attribute 'unicode-tokens-symbol-font-face :slant)
(font-lock-append-text-property
start end 'face
(list :slant
(face-attribute 'unicode-tokens-symbol-font-face :slant))))
)
;; [returning face property here seems to have no effect?]
nil))
(defun unicode-tokens-prepend-text-properties-in-match (props matchno)
(let ((start (match-beginning matchno))
(end (match-end matchno)))
(while props
(unicode-tokens-prepend-text-property start end
(car props) (cadr props))
(setq props (cddr props)))
nil))
;; this is adapted from font-lock-prepend-text-property, which
;; currently fails to merge property values for 'face property properly.
;; e.g., it makes (:slant italic (:weight bold font-lock-string-face))
;; rather than (:slant italic :weight bold font-lock-string-face)
;;
(defun unicode-tokens-prepend-text-property (start end prop value &optional object)
"Prepend to one property of the text from START to END.
Arguments PROP and VALUE specify the property and value to append to the value
already in place. The resulting property values are always lists.
Optional argument OBJECT is the string or buffer containing the text."
(let ((val (if (listp value) value (list value))) next prev)
(while (/= start end)
(setq next (next-single-property-change start prop object end)
prev (get-text-property start prop object))
;; Canonicalize old forms of face property.
(and (memq prop '(face font-lock-face))
(listp prev)
(or (keywordp (car prev))
(memq (car prev) '(foreground-color background-color)))
(setq prev (list prev)))
(setq prev (if (listp prev) prev (list prev)))
;; hack to flatten erroneously nested face property lists
(if (and (memq prop '(face font-lock-face))
(listp (car prev)) (null (cdr prev)))
(setq prev (car prev)))
(put-text-property start next prop
(append prev val)
object)
(setq start next))))
(defun unicode-tokens-show-symbols (&optional arg)
"Toggle variable `unicode-tokens-show-symbols'. With ARG, turn on iff positive."
(interactive "P")
(setq unicode-tokens-show-symbols
(if (null arg) (not unicode-tokens-show-symbols)
(> (prefix-numeric-value arg) 0)))
(font-lock-ensure))
(defun unicode-tokens-symbs-to-props (symbs &optional facenil)
"Turn the property name list SYMBS into a list of text properties.
Symbols are looked up in `unicode-tokens-fontsymb-properties'.
Optional argument FACENIL means set the face property to nil, unless 'face is in the property list."
(let (props ps)
(dolist (s symbs)
(setq ps (cdr-safe
(cdr-safe (assoc s unicode-tokens-fontsymb-properties))))
(dolist (p ps)
(setq props (append p props))))
(if (and facenil
(not (memq 'face props)))
(setq props (append '(face nil) props)))
props))
;;
;; Control tokens: as "characters" CTRL <stuff>
;; and regions BEGINCTRL <stuff> ENDCTRL
;;
(defvar unicode-tokens-show-controls nil
"Non-nil supresses hiding of control tokens.")
(defun unicode-tokens-show-controls (&optional arg)
"Toggle variable `unicode-tokens-show-controls'. With ARG, turn on iff positive."
(interactive "P")
(setq unicode-tokens-show-controls
(if (null arg) (not unicode-tokens-show-controls)
(> (prefix-numeric-value arg) 0)))
(when unicode-tokens-show-controls
(remove-from-invisibility-spec 'unicode-tokens-show-controls))
(when (not unicode-tokens-show-controls)
(add-to-invisibility-spec 'unicode-tokens-show-controls))
(redraw-display))
(defun unicode-tokens-control-char (name s &rest props)
`(,(format unicode-tokens-control-char-format-regexp (regexp-quote s))
(1 '(face nil invisible unicode-tokens-show-controls) prepend)
;; simpler but buggy with font-lock-prepend-text-property:
;; (2 ',(unicode-tokens-symbs-to-props props t) prepend)
(2 (unicode-tokens-prepend-text-properties-in-match
',(unicode-tokens-symbs-to-props props t) 2) prepend)
))
(defun unicode-tokens-control-region (name start end &rest props)
`(,(format unicode-tokens-control-region-format-regexp
(regexp-quote start) (regexp-quote end))
(1 '(face nil invisible unicode-tokens-show-controls) prepend)
;; simpler but buggy with font-lock-prepend-text-property:
;; (2 ',(unicode-tokens-symbs-to-props props t) prepend)
(2 (unicode-tokens-prepend-text-properties-in-match
',(unicode-tokens-symbs-to-props props t) 2) prepend)
(3 '(face nil invisible unicode-tokens-show-controls) prepend)
))
(defun unicode-tokens-control-font-lock-keywords ()
(append
(mapcar (lambda (args) (apply 'unicode-tokens-control-char args))
unicode-tokens-control-characters)
(mapcar (lambda (args) (apply 'unicode-tokens-control-region args))
unicode-tokens-control-regions)))
;;
;; Shortcuts for typing, using quail
;;
(defvar unicode-tokens-use-shortcuts t
"Non-nil means use `unicode-tokens-shortcut-alist' if set.")
(defun unicode-tokens-use-shortcuts (&optional arg)
"Toggle variable `unicode-tokens-use-shortcuts'. With ARG, turn on iff positive."
(interactive "P")
(setq unicode-tokens-use-shortcuts
(if (null arg) (not unicode-tokens-use-shortcuts)
(> (prefix-numeric-value arg) 0)))
(if unicode-tokens-use-shortcuts
(set-input-method "Unicode tokens")
(set-input-method nil)))
(quail-define-package
"Unicode tokens" "UTF-8" "u" t
"Input method for tokens or unicode characters, application specific short-cuts"
nil t nil nil nil nil nil ; max shortest, could try t
nil nil nil t)
(defun unicode-tokens-map-ordering (s1 s2)
"Ordering on (car S1, car S2): order longer strings first."
(>= (length (car s1)) (length (car s2))))
; core dump caused when quail active, but not by quail.
;(defun unicode-tokens-shortcut-will-crash-emacs (ustring)
; "Work around a nasty Emacs bug that causes a core dump."
; (> 1 (length ustring)))
(defun unicode-tokens-quail-define-rules ()
"Define the token and shortcut input rules.
Calculated from `unicode-tokens-token-name-alist' and
`unicode-tokens-shortcut-alist'."
(let ((unicode-tokens-quail-define-rules
(list 'quail-define-rules)))
(let ((ulist (cl-copy-list unicode-tokens-shortcut-alist))
ustring shortcut)
(setq ulist (sort ulist 'unicode-tokens-map-ordering))
(while ulist
(setq shortcut (caar ulist))
(setq ustring (cdar ulist))
(nconc unicode-tokens-quail-define-rules
(list (list shortcut
(vector ustring))))
(setq ulist (cdr ulist))))
(eval unicode-tokens-quail-define-rules)))
;;
;; User-level functions
;;
(defun unicode-tokens-insert-token (tok)
"Insert symbolic token named TOK, giving a message."
(interactive (list (completing-read
"Insert token: "
unicode-tokens-hash-table)))
(let ((ins (format unicode-tokens-token-format tok)))
(insert ins)
(message "Inserted %s" ins)))
(defun unicode-tokens-annotate-region (name)
"Annotate region with region markup tokens for scheme NAME.
Available annotations chosen from `unicode-tokens-control-regions'."
(interactive (let ((completion-ignore-case t))
(list (completing-read
"Annotate region with: "
unicode-tokens-control-regions nil
'requirematch))))
(cl-assert (assoc name unicode-tokens-control-regions))
(let* ((entry (assoc name unicode-tokens-control-regions))
(beg (region-beginning))
(end (region-end))
(begtok
(format unicode-tokens-control-region-format-start (nth 1 entry)))
(endtok
(format unicode-tokens-control-region-format-end (nth 2 entry))))
(when (> beg end)
(setq beg end)
(setq end (region-beginning)))
(goto-char beg)
(insert begtok)
(goto-char (+ end (- (point) beg)))
(insert endtok)))
(defun unicode-tokens-insert-control (name)
"Insert a control symbol sequence. NAME is from `unicode-tokens-control-characters'."
(interactive (list (completing-read
"Insert control symbol: "
unicode-tokens-control-characters
nil 'requirematch)))
(cl-assert (assoc name unicode-tokens-control-characters))
(insert (format unicode-tokens-control-char-format
(cadr (assoc name unicode-tokens-control-characters)))))
(defun unicode-tokens-insert-uchar-as-token (char)
"Insert CHAR as a symbolic token, if possible."
(let ((tok (gethash char unicode-tokens-uchar-hash-table)))
(when tok
(unicode-tokens-insert-token tok))))
(defun unicode-tokens-delete-token-near-point ()
"Delete the token near point; try first before point, then after."
(interactive)
(if (or
(re-search-backward unicode-tokens-token-match-regexp
(save-excursion
(beginning-of-line) (point)) t)
(re-search-forward unicode-tokens-token-match-regexp
(save-excursion
(end-of-line) (point)) t))
(kill-region (match-beginning 0) (match-end 0))))
(defun unicode-tokens-delete-backward-char (&optional arg)
"Delete the last ARG visually presented characters.
This accounts for tokens having a single character presentation
but multiple characters in the underlying buffer."
(interactive "p")
(if arg
(while (> arg 0)
(unicode-tokens-delete-backward-1)
(setq arg (1- arg)))
(unicode-tokens-delete-backward-1)))
(defun unicode-tokens-delete-char (&optional arg)
"Delete the next ARG visually presented characters.
This accounts for tokens having a single character presentation
but multiple characters in the underlying buffer."
(interactive "p")
(if arg
(while (> arg 0)
(unicode-tokens-delete-1)
(setq arg (1- arg)))
(unicode-tokens-delete-1)))
(defun unicode-tokens-delete-backward-1 ()
"Delete the last visually presented character.
This accounts for tokens having a single character presentation
but multiple characters in the underlying buffer."
(let (tokst tokend)
(save-match-data
(save-excursion
(setq tokst
(re-search-backward unicode-tokens-token-match-regexp
(save-excursion
(beginning-of-line) (point)) t))
(setq tokend (match-end 0))))
;(message "End is: %d and point is: %d" tokend (point))
(if (and tokst (= (point) tokend))
(delete-region tokst tokend)
(delete-char -1))))
(defun unicode-tokens-delete-1 ()
"Delete the following visually presented character.
This accounts for tokens having a single character presentation
but multiple characters in the underlying buffer."
(let (tokend)
(save-match-data
(save-excursion
(if (looking-at unicode-tokens-token-match-regexp)
(setq tokend (match-end 0)))))
(if tokend
(delete-region (point) tokend)
(delete-char 1))))
;; TODO: behaviour with unknown tokens not good. Should
;; use separate regexp for matching tokens known or not known.
(defun unicode-tokens-prev-token ()
"Return the token before point, matching with `unicode-tokens-token-match-regexp'."
(let ((match (re-search-backward unicode-tokens-token-match-regexp
(save-excursion
(beginning-of-line 0) (point)) t)))
(if match
(match-string 1))))
(defun unicode-tokens-rotate-token-forward (&optional n)
"Rotate the token before point by N steps in the table."
(interactive "p")
(if (> (point) (point-min))
(save-match-data
(let ((pos (point))
(token (unicode-tokens-prev-token)))
(when (not token)
(goto-char (point))
(error "Cannot find token before point"))
(when token
(let* ((tokennumber
(cl-search (list token) unicode-tokens-token-list :test 'equal))
(numtoks
(hash-table-count unicode-tokens-hash-table))
(newtok
(if tokennumber
(nth (mod (+ tokennumber (or n 1)) numtoks)
unicode-tokens-token-list))))
(when newtok
(delete-region (match-beginning 0) (match-end 0))
(insert (format unicode-tokens-token-format newtok)))
(when (not newtok)
;; FIXME: currently impossible case
(message "Token not in tables: %s" token))))))))
(defun unicode-tokens-rotate-token-backward (&optional n)
"Rotate the token before point, by -N steps in the token list."
(interactive "p")
(unicode-tokens-rotate-token-forward (if n (- n) -1)))
(defun unicode-tokens-replace-shortcut-match (&rest ignore)
"Subroutine for `unicode-tokens-replace-shortcuts'."
(let* ((match (match-string-no-properties 0))
(repl (if match
(cdr-safe
(assoc match unicode-tokens-shortcut-replacement-alist)))))
(if repl (regexp-quote repl))))
;; handy for legacy Isabelle files, probably not useful in general.
(defun unicode-tokens-replace-shortcuts ()
"Query-replace shortcuts in the buffer with compositions they expand to.
Starts from point."
(interactive)
(let ((shortcut-regexp
(regexp-opt (mapcar 'car unicode-tokens-shortcut-replacement-alist))))
;; override the display of the regexp because it's huge!
;; (doesn't help with C-h: need way to programmatically show string)
(cl-flet ((query-replace-descr (str)
(if (eq str shortcut-regexp) "shortcut" str)))
(perform-replace shortcut-regexp
(cons 'unicode-tokens-replace-shortcut-match nil)
t t nil))))
(defun unicode-tokens-replace-unicode-match (&rest ignore)
"Subroutine for `unicode-tokens-replace-unicode'."
(let* ((useq (match-string-no-properties 0))
(token (gethash useq unicode-tokens-uchar-hash-table)))
(if token (regexp-quote
(format unicode-tokens-token-format token)))))
(defun unicode-tokens-replace-unicode ()
"Query-replace unicode sequences in the buffer with tokens having same appearance.
Starts from point."
(interactive)
(let ((uchar-regexp unicode-tokens-uchar-regexp))
;; override the display of the regexp because it's huge!
;; (doesn't help with C-h: need way to programmatically show string)
(cl-flet ((query-replace-descr (str) (if (eq str uchar-regexp)
"unicode presentation" str)))
(perform-replace uchar-regexp
(cons 'unicode-tokens-replace-unicode-match nil)
t t nil))))
;;
;; Token and shortcut tables
;;
(defun unicode-tokens-copy-token (tokname)
"Copy the token TOKNAME into the kill ring."
(interactive "s")
(kill-new
(format unicode-tokens-token-format tokname)
(eq last-command 'unicode-tokens-copy-token)))
(define-button-type 'unicode-tokens-list
'help-echo "mouse-2, RET: copy this character"
'face nil
'action #'(lambda (button)
(unicode-tokens-copy-token (button-get button 'unicode-token))))
(defun unicode-tokens-list-tokens ()
"Show a buffer of all tokens."
(interactive)
(with-output-to-temp-buffer "*Unicode Tokens List*"
(with-current-buffer standard-output
(make-local-variable 'unicode-tokens-show-symbols)
(setq unicode-tokens-show-symbols nil)
(unicode-tokens-mode)
(setq tab-width 7)
(insert "Hover to see token. Mouse-2 or RET to copy into kill ring.\n")
(let ((count 10)
(toks unicode-tokens-token-list)
tok)
;; display in originally given order
(while (or (/= 1 (mod count 10)) toks)
(unless (null toks)
(setq tok (car toks)))
(if (/= 0 (mod count 10))
(insert "\t")
(insert "\n")
(unless (null toks)
(insert (format "%4d. " (/ count 10))))
(if (= 0 (mod count 20))
(overlay-put (make-overlay
(save-excursion
(forward-line -1) (point))
(point))
'face
'header-line))
(insert " "))
(cl-incf count)
(if (null toks)
(insert " ")
(insert-text-button
(format unicode-tokens-token-format tok)
:type 'unicode-tokens-list
'unicode-token tok)
(setq toks (cdr toks))))))))
(defun unicode-tokens-list-shortcuts ()
"Show a buffer of all the shortcuts available."
(interactive)
(with-output-to-temp-buffer "*Unicode Tokens Shortcuts*"
(with-current-buffer standard-output
(make-local-variable 'unicode-tokens-show-symbols)
(setq unicode-tokens-show-symbols nil)
(unicode-tokens-mode)
(let (grey start)
(dolist (short unicode-tokens-shortcut-alist)
(setq start (point))
(insert "Typing " (car short) "\tinserts \t"
(cdr short) "\n")
(if (setq grey (not grey))
(overlay-put (make-overlay start (point))
'face
'header-line)))))))
(defalias 'unicode-tokens-list-unicode-chars 'unicode-chars-list-chars)
(defun unicode-tokens-encode-in-temp-buffer (str fn)
"Call FN on encoded version of STR."
(with-temp-buffer
(insert str)
(goto-char (point-min))
(while (re-search-forward unicode-tokens-token-match-regexp nil t)
;; TODO: interpret more exotic compositions here
(let* ((tstart (match-beginning 0))
(tend (match-end 0))
(comp (car-safe
(gethash (match-string 1)
unicode-tokens-hash-table))))
(when comp
(delete-region tstart tend)
;; TODO: improve this: interpret vector, strip tabs
(insert comp)))) ;; gross approximation to compose-region
(funcall fn (point-min) (point-max))))
(defun unicode-tokens-encode (beg end)
"Return a unicode encoded version of the presentation in region BEG..END."
(unicode-tokens-encode-in-temp-buffer
(buffer-substring-no-properties beg end) 'buffer-substring))
;;;###autoload
(defun unicode-tokens-encode-str (str)
"Return a unicode encoded version presentation of STR."
(unicode-tokens-encode-in-temp-buffer str 'buffer-substring))