mirrored from git://git.sv.gnu.org/emacs.git
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
rx.el
1733 lines (1568 loc) · 69.2 KB
/
rx.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
;;; rx.el --- S-exp notation for regexps --*- lexical-binding: t -*-
;; Copyright (C) 2001-2024 Free Software Foundation, Inc.
;; 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:
;; This facility allows writing regexps in a sexp-based language
;; instead of strings. Regexps in the `rx' notation are easier to
;; read, write and maintain; they can be indented and commented in a
;; natural way, and are easily composed by program code.
;; The translation to string regexp is done by a macro and does not
;; incur any extra processing during run time. Example:
;;
;; (rx bos (or (not "^")
;; (seq "^" (or " *" "["))))
;;
;; => "\\`\\(?:[^^]\\|\\^\\(?: \\*\\|\\[\\)\\)"
;;
;; The notation is much influenced by and retains some compatibility with
;; Olin Shivers's SRE, with concessions to Emacs regexp peculiarities,
;; and the older Emacs package Sregex.
;;; Legacy syntax still accepted by rx:
;;
;; These are constructs from earlier rx and sregex implementations
;; that were mistakes, accidents or just not very good ideas in hindsight.
;; Obsolete: accepted but not documented
;;
;; Obsolete Preferred
;; --------------------------------------------------------
;; (not word-boundary) not-word-boundary
;; (not-syntax X) (not (syntax X))
;; not-wordchar (not wordchar)
;; (not-char ...) (not (any ...))
;; any nonl, not-newline
;; (repeat N FORM) (= N FORM)
;; (syntax CHARACTER) (syntax NAME)
;; (syntax CHAR-SYM) [1] (syntax NAME)
;; unibyte ascii
;; multibyte nonascii
;; --------------------------------------------------------
;; [1] where CHAR-SYM is a symbol with single-character name
;; Obsolescent: accepted and documented but discouraged
;;
;; Obsolescent Preferred
;; --------------------------------------------------------
;; (and ...) (seq ...), (: ...), (sequence ...)
;; anything anychar
;; minimal-match, maximal-match lazy ops: ??, *?, +?
;; FIXME: Prepare a phase-out by emitting compile-time warnings about
;; at least some of the legacy constructs above.
;;; Code:
;; The `rx--translate...' functions below return (REGEXP . PRECEDENCE),
;; where REGEXP is a list of string expressions that will be
;; concatenated into a regexp, and PRECEDENCE is one of
;;
;; t -- can be used as argument to postfix operators (eg. "a")
;; seq -- can be concatenated in sequence with other seq or higher (eg. "ab")
;; lseq -- can be concatenated to the left of rseq or higher (eg. "^a")
;; rseq -- can be concatenated to the right of lseq or higher (eg. "a$")
;; nil -- can only be used in alternatives (eg. "a\\|b")
;;
;; They form a lattice:
;;
;; t highest precedence
;; |
;; seq
;; / \
;; lseq rseq
;; \ /
;; nil lowest precedence
(defconst rx--char-classes
'((digit . digit)
(numeric . digit)
(num . digit)
(control . cntrl)
(cntrl . cntrl)
(hex-digit . xdigit)
(hex . xdigit)
(xdigit . xdigit)
(blank . blank)
(graphic . graph)
(graph . graph)
(printing . print)
(print . print)
(alphanumeric . alnum)
(alnum . alnum)
(letter . alpha)
(alphabetic . alpha)
(alpha . alpha)
(ascii . ascii)
(nonascii . nonascii)
(lower . lower)
(lower-case . lower)
(punctuation . punct)
(punct . punct)
(space . space)
(whitespace . space)
(white . space)
(upper . upper)
(upper-case . upper)
(word . word)
(wordchar . word)
(unibyte . unibyte)
(multibyte . multibyte))
"Alist mapping rx symbols to character classes.
Most of the names are from SRE.")
(defvar rx-constituents nil
"Alist of old-style rx extensions, for compatibility.
For new code, use `rx-define', `rx-let' or `rx-let-eval'.
Each element is (SYMBOL . DEF).
If DEF is a symbol, then SYMBOL is an alias of DEF.
If DEF is a string, then SYMBOL is a plain rx symbol defined as the
regexp string DEF.
If DEF is a list on the form (FUN MIN-ARGS MAX-ARGS PRED), then
SYMBOL is an rx form with at least MIN-ARGS and at most
MAX-ARGS arguments. If MAX-ARGS is nil, then there is no upper limit.
FUN is a function taking the entire rx form as single argument
and returning the translated regexp string.
If PRED is non-nil, it is a predicate that all actual arguments must
satisfy.")
(make-obsolete-variable
'rx-constituents
"use `rx-let', `rx-let-eval', or `rx-define' instead."
;; Effectively obsolete since Emacs 27 but only formally declared
;; obsolete in Emacs 30.
"30.1")
(defvar rx--local-definitions nil
"Alist of dynamic local rx definitions.
Each entry is:
(NAME DEF) -- NAME is an rx symbol defined as the rx form DEF.
(NAME ARGS DEF) -- NAME is an rx form with arglist ARGS, defined
as the rx form DEF (which can contain members of ARGS).")
(defsubst rx--lookup-def (name)
"Current definition of NAME: (DEF) or (ARGS DEF), or nil if none."
(or (cdr (assq name rx--local-definitions))
(get name 'rx-definition)))
(defun rx--expand-def-form (form)
"List FORM expanded (once) if a user-defined construct; otherwise nil."
(let ((op (car form)))
(and (symbolp op)
(let ((def (rx--lookup-def op)))
(and def
(if (cdr def)
(rx--expand-template op (cdr form) (nth 0 def) (nth 1 def))
(error "Not an `rx' form definition: %s" op)))))))
(defun rx--expand-def-symbol (symbol)
"SYM expanded (once) if a user-defined name; otherwise nil."
(let ((def (rx--lookup-def symbol)))
(and def
(if (cdr def)
(error "Not an `rx' symbol definition: %s" symbol)
(car def)))))
(defun rx--translate-symbol (sym)
"Translate an rx symbol. Return (REGEXP . PRECEDENCE)."
(pcase sym
;; Use `list' instead of a quoted list to wrap the strings here,
;; since the return value may be mutated.
((or 'nonl 'not-newline 'any) (cons (list ".") t))
((or 'anychar 'anything) (cons (list "[^z-a]") t))
('unmatchable (rx--empty))
((or 'bol 'line-start) (cons (list "^") 'lseq))
((or 'eol 'line-end) (cons (list "$") 'rseq))
((or 'bos 'string-start 'bot 'buffer-start) (cons (list "\\`") t))
((or 'eos 'string-end 'eot 'buffer-end) (cons (list "\\'") t))
('point (cons (list "\\=") t))
((or 'bow 'word-start) (cons (list "\\<") t))
((or 'eow 'word-end) (cons (list "\\>") t))
('word-boundary (cons (list "\\b") t))
('not-word-boundary (cons (list "\\B") t))
('symbol-start (cons (list "\\_<") t))
('symbol-end (cons (list "\\_>") t))
('not-wordchar (rx--translate '(not wordchar)))
(_
(cond
((let ((class (cdr (assq sym rx--char-classes))))
(and class (cons (list (concat "[[:" (symbol-name class) ":]]")) t))))
((let ((expanded (rx--expand-def-symbol sym)))
(and expanded (rx--translate expanded))))
;; For compatibility with old rx.
((let ((entry (assq sym rx-constituents)))
(and entry (rx--translate-compat-symbol-entry entry))))
(t (error "Unknown rx symbol `%s'" sym))))))
(defun rx--enclose (left-str rexp right-str)
"Bracket REXP by LEFT-STR and RIGHT-STR."
(append (list left-str) rexp (list right-str)))
(defun rx--bracket (rexp)
(rx--enclose "\\(?:" rexp "\\)"))
(defun rx--sequence (left right)
"Return the sequence (concatenation) of two translated items,
each on the form (REGEXP . PRECEDENCE), returning (REGEXP . PRECEDENCE)."
;; Concatenation rules:
;; seq ++ seq -> seq
;; lseq ++ seq -> lseq
;; seq ++ rseq -> rseq
;; lseq ++ rseq -> nil
(cond ((not (car left)) right)
((not (car right)) left)
(t
(let ((l (if (memq (cdr left) '(nil rseq))
(cons (rx--bracket (car left)) t)
left))
(r (if (memq (cdr right) '(nil lseq))
(cons (rx--bracket (car right)) t)
right)))
(cons (append (car l) (car r))
(if (eq (cdr l) 'lseq)
(if (eq (cdr r) 'rseq)
nil ; lseq ++ rseq
'lseq) ; lseq ++ seq
(if (eq (cdr r) 'rseq)
'rseq ; seq ++ rseq
'seq))))))) ; seq ++ seq
(defun rx--translate-seq (body)
"Translate a sequence of zero or more rx items.
Return (REGEXP . PRECEDENCE)."
(if body
(let* ((items (mapcar #'rx--translate body))
(result (car items)))
(dolist (item (cdr items))
(setq result (rx--sequence result item)))
result)
(cons nil 'seq)))
(defun rx--empty ()
"Regexp that never matches anything."
(cons (list regexp-unmatchable) 'seq))
;; `cl-every' replacement to avoid bootstrapping problems.
(defun rx--every (pred list)
"Whether PRED is true for every element of LIST."
(while (and list (funcall pred (car list)))
(setq list (cdr list)))
(null list))
(defun rx--foldl (f x l)
"(F (F (F X L0) L1) L2) ...
Left-fold the list L, starting with X, by the binary function F."
(while l
(setq x (funcall f x (car l)))
(setq l (cdr l)))
x)
;; FIXME: flatten nested `or' patterns when performing char-pattern combining.
;; The only reason for not flattening is to ensure regexp-opt processing
;; (which we do for entire `or' patterns, not subsequences), but we
;; obviously want to translate
;; (or "a" space (or "b" (+ nonl) word) "c")
;; -> (or (in "ab" space) (+ nonl) (in "c" word))
;; FIXME: normalise `seq', both the construct and implicit sequences,
;; so that they are flattened, adjacent strings concatenated, and
;; empty strings removed. That would give more opportunities for regexp-opt:
;; (or "a" (seq "ab" (seq "c" "d") "")) -> (or "a" "abcd")
;; FIXME: Since `rx--normalise-char-pattern' recurses through `or', `not' and
;; `intersection', we may end up normalising subtrees multiple times
;; which wastes time (but should be idempotent).
;; One way to avoid this is to aggressively normalise the entire tree
;; before translating anything at all, but we must then recurse through
;; all constructs and probably copy them.
;; Such normalisation could normalise synonyms, eliminate `minimal-match'
;; and `maximal-match' and convert affected `1+' to either `+' or `+?' etc.
;; We would also consolidate the user-def lookup, both modern and legacy,
;; in one place.
(defun rx--normalise-char-pattern (form)
"Normalize FORM as a pattern matching a single-character.
Characters become strings, `any' forms and character classes become
`rx--char-alt' forms, user-definitions and `eval' forms are expanded,
and `or', `not' and `intersection' forms are normalized recursively.
A `rx--char-alt' form is shaped (rx--char-alt INTERVALS . CLASSES)
where INTERVALS is a sorted list of disjoint nonadjacent intervals,
each a cons of characters, and CLASSES an unordered list of unique
name-normalised character classes."
(defvar rx--builtin-forms)
(defvar rx--builtin-symbols)
(cond ((consp form)
(let ((op (car form))
(body (cdr form)))
(cond ((memq op '(or |))
;; Normalise the constructor to `or' and the args recursively.
(cons 'or (mapcar #'rx--normalise-char-pattern body)))
;; Convert `any' forms and char classes now so that we
;; don't need to do it later on.
((memq op '(any in char))
(cons 'rx--char-alt (rx--parse-any body)))
((memq op '(not intersection))
(cons op (mapcar #'rx--normalise-char-pattern body)))
((eq op 'eval)
(rx--normalise-char-pattern (rx--expand-eval body)))
((memq op rx--builtin-forms) form)
((let ((expanded (rx--expand-def-form form)))
(and expanded
(rx--normalise-char-pattern expanded))))
(t form))))
;; FIXME: Should we expand legacy definitions from
;; `rx-constituents' here as well?
((symbolp form)
(cond ((let ((class (assq form rx--char-classes)))
(and class
`(rx--char-alt nil . (,(cdr class))))))
((memq form rx--builtin-symbols) form)
((let ((expanded (rx--expand-def-symbol form)))
(and expanded
(rx--normalise-char-pattern expanded))))
(t form)))
((characterp form)
(char-to-string form))
(t form)))
(defun rx--char-alt-union (a b)
"Union of the (INTERVALS . CLASSES) pairs A and B."
(let* ((a-cl (cdr a))
(b-cl (cdr b))
(classes (if (and a-cl b-cl)
(let ((acc a-cl))
(dolist (c b-cl)
(unless (memq c a-cl)
(push c acc)))
acc)
(or a-cl b-cl))))
(cons (rx--interval-set-union (car a) (car b)) classes)))
(defun rx--intersection-intervals (forms)
"Intersection of the normalised FORMS, as an interval set."
(rx--foldl #'rx--interval-set-intersection '((0 . #x3fffff))
(mapcar (lambda (x)
(let ((char (rx--reduce-to-char-alt x)))
(if (and char (null (cdr char)))
(car char)
(error "Cannot be used in rx intersection: %S"
(rx--human-readable x)))))
forms)))
(defun rx--reduce-to-char-alt (form)
"Transform FORM into (INTERVALS . CLASSES) or nil if not possible.
Process `or', `intersection' and `not'.
FORM must be normalised (from `rx--normalise-char-pattern')."
(cond
((stringp form)
(and (= (length form) 1)
(let ((c (aref form 0)))
(list (list (cons c c))))))
((consp form)
(let ((head (car form)))
(cond
;; FIXME: Transform `digit', `xdigit', `cntrl', `ascii', `nonascii'
;; to ranges? That would allow them to be negated and intersected.
((eq head 'rx--char-alt) (cdr form))
((eq head 'not)
(unless (= (length form) 2)
(error "rx `not' form takes exactly one argument"))
(let ((arg (rx--reduce-to-char-alt (cadr form))))
;; Only interval sets without classes are closed under complement.
(and arg (null (cdr arg))
(list (rx--interval-set-complement (car arg))))))
((eq head 'or)
(let ((args (cdr form)))
(let ((acc '(nil))) ; union identity
(while (and args
(let ((char (rx--reduce-to-char-alt (car args))))
(setq acc (and char (rx--char-alt-union acc char)))))
(setq args (cdr args)))
acc)))
((eq head 'intersection)
(list (rx--intersection-intervals (cdr form))))
)))
((memq form '(nonl not-newline any))
'(((0 . 9) (11 . #x3fffff))))
((memq form '(anychar anything))
'(((0 . #x3fffff))))
;; FIXME: A better handling of `unmatchable' would be:
;; * (seq ... unmatchable ...) -> unmatchable
;; * any or-pattern branch that is `unmatchable' is deleted
;; * (REPEAT unmatchable) -> "", if REPEAT accepts 0 repetitions
;; * (REPEAT unmatchable) -> unmatchable, otherwise
;; if it's worth the trouble (probably not).
((eq form 'unmatchable)
'(nil))
))
(defun rx--optimise-or-args (args)
"Optimise `or' arguments. Return a new rx form.
Each element of ARGS should have been normalised using
`rx--normalise-char-pattern'."
(if (null args)
;; No arguments.
'(rx--char-alt nil . nil) ; FIXME: not `unmatchable'?
;; Join consecutive single-char branches into a char alt where possible.
;; Ideally we should collect all single-char branches but that might
;; alter matching order in some cases.
(let ((branches nil)
(prev-char nil))
(while args
(let* ((item (car args))
(item-char (rx--reduce-to-char-alt item)))
(if item-char
(setq prev-char (if prev-char
(rx--char-alt-union prev-char item-char)
item-char))
(when prev-char
(push (cons 'rx--char-alt prev-char) branches)
(setq prev-char nil))
(push item branches)))
(setq args (cdr args)))
(when prev-char
(push (cons 'rx--char-alt prev-char) branches))
(if (cdr branches)
(cons 'or (nreverse branches))
(car branches)))))
(defun rx--all-string-branches-p (forms)
"Whether FORMS are all strings or `or' forms with the same property."
(rx--every (lambda (x) (or (stringp x)
(and (eq (car-safe x) 'or)
(rx--all-string-branches-p (cdr x)))))
forms))
(defun rx--collect-or-strings (forms)
"All strings from FORMS, which are strings or `or' forms."
(mapcan (lambda (form)
(if (stringp form)
(list form)
;; must be an `or' form
(rx--collect-or-strings (cdr form))))
forms))
;; TODO: Write a more general rx-level factoriser to replace
;; `regexp-opt' for our purposes. It would handle non-literals:
;;
;; (or "ab" (: "a" space) "bc" (: "b" (+ digit)))
;; -> (or (: "a" (in "b" space)) (: "b" (or "c" (+ digit))))
;;
;; As a minor side benefit we would get less useless bracketing.
;; The main problem is how to deal with matching order, which `regexp-opt'
;; alters in its own way.
(defun rx--translate-or (body)
"Translate an or-pattern of zero or more rx items.
Return (REGEXP . PRECEDENCE)."
(cond
((null body) ; No items: a never-matching regexp.
(rx--empty))
((null (cdr body)) ; Single item.
(rx--translate (car body)))
(t
(let ((args (mapcar #'rx--normalise-char-pattern body)))
(if (rx--all-string-branches-p args)
;; All branches are strings: use `regexp-opt'.
(cons (list (regexp-opt (rx--collect-or-strings args) nil))
t)
(let ((form (rx--optimise-or-args args)))
(if (eq (car-safe form) 'or)
(let ((branches (cdr form)))
(cons (append (car (rx--translate (car branches)))
(mapcan (lambda (item)
(cons "\\|" (car (rx--translate item))))
(cdr branches)))
nil))
(rx--translate form))))))))
(defun rx--string-to-intervals (str)
"Decode STR as intervals: A-Z becomes (?A . ?Z), and the single
character X becomes (?X . ?X). Return the intervals in a list."
;; We could just do string-to-multibyte on the string and work with
;; that instead of this `decode-char' workaround.
(let ((decode-char
(if (multibyte-string-p str)
#'identity
#'unibyte-char-to-multibyte))
(len (length str))
(i 0)
(intervals nil))
(while (< i len)
(cond ((and (< i (- len 2))
(= (aref str (1+ i)) ?-))
;; Range.
(let ((start (funcall decode-char (aref str i)))
(end (funcall decode-char (aref str (+ i 2)))))
(cond ((and (<= start #x7f) (>= end #x3fff80))
;; Ranges between ASCII and raw bytes are split to
;; avoid having them absorb Unicode characters
;; caught in-between.
(push (cons start #x7f) intervals)
(push (cons #x3fff80 end) intervals))
((<= start end)
(push (cons start end) intervals))
(t
(error "Invalid rx `any' range: %s"
(substring str i (+ i 3)))))
(setq i (+ i 3))))
(t
;; Single character.
(let ((char (funcall decode-char (aref str i))))
(push (cons char char) intervals))
(setq i (+ i 1)))))
intervals))
(defun rx--condense-intervals (intervals)
"Merge adjacent and overlapping intervals by mutation, preserving the order.
INTERVALS is a list of (START . END) with START ≤ END, sorted by START."
(let ((tail intervals)
d)
(while (setq d (cdr tail))
(if (>= (cdar tail) (1- (caar d)))
(progn
(setcdr (car tail) (max (cdar tail) (cdar d)))
(setcdr tail (cdr d)))
(setq tail d)))
intervals))
(defun rx--parse-any (body)
"Parse arguments of an (any ...) construct.
Return (INTERVALS . CLASSES), where INTERVALS is a sorted list of
disjoint nonadjacent intervals (each a cons of chars), and CLASSES
a list of named character classes in the order they occur in BODY."
(let ((classes nil)
(strings nil)
(conses nil))
;; Collect strings, conses and characters, and classes in separate bins.
(dolist (arg body)
(cond ((stringp arg)
(push arg strings))
((and (consp arg)
(characterp (car arg))
(characterp (cdr arg))
(<= (car arg) (cdr arg)))
;; Copy the cons, in case we need to modify it.
(push (cons (car arg) (cdr arg)) conses))
((characterp arg)
(push (cons arg arg) conses))
((and (symbolp arg)
(let ((class (cdr (assq arg rx--char-classes))))
(and class
(or (memq class classes)
(progn (push class classes) t))))))
(t (error "Invalid rx `any' argument: %s" arg))))
(cons (rx--condense-intervals
(sort (append conses
(mapcan #'rx--string-to-intervals strings))
#'car-less-than-car))
(nreverse classes))))
(defun rx--generate-alt (negated intervals classes)
"Generate a character alternative. Return (REGEXP . PRECEDENCE).
If NEGATED is non-nil, negate the result; INTERVALS is a sorted
list of disjoint intervals and CLASSES a list of named character
classes."
;; No, this is not pretty code. You try doing it in a way that is both
;; elegant and efficient. Or just one of the two. I dare you.
;; Detect whether the interval set is better described in
;; complemented form. This is not just a matter of aesthetics: any
;; range that straddles the char-raw boundary will be mutilated by the
;; regexp engine. Ranges from ASCII to raw bytes will exclude the
;; all non-ASCII non-raw bytes, and ranges from non-ASCII Unicode
;; to raw bytes are ignored.
(unless (or classes
;; Any interval set covering #x3fff7f should be negated.
(rx--every (lambda (iv) (not (<= (car iv) #x3fff7f (cdr iv))))
intervals))
(setq negated (not negated))
(setq intervals (rx--interval-set-complement intervals)))
(cond
;; Single character.
((and intervals (eq (caar intervals) (cdar intervals))
(null (cdr intervals))
(null classes))
(let ((ch (caar intervals)))
(if negated
(if (eq ch ?\n)
;; Single negated newline.
(rx--translate-symbol 'nonl)
;; Single negated character (other than newline).
(cons (list (string ?\[ ?^ ch ?\])) t))
;; Single literal character.
(cons (list (regexp-quote (char-to-string ch))) t))))
;; Empty set (or any char).
((and (null intervals) (null classes))
(if negated
(rx--translate-symbol 'anychar)
(rx--empty)))
;; More than one character, or at least one class.
(t
(let ((dash nil) (caret nil))
;; Move ] and range ]-x to the start.
(let ((rbrac-l (assq ?\] intervals)))
(when rbrac-l
(setq intervals (cons rbrac-l (remq rbrac-l intervals)))))
;; Split x-] and move the lone ] to the start.
(let ((rbrac-r (rassq ?\] intervals)))
(when (and rbrac-r (not (eq (car rbrac-r) ?\])))
(setcdr rbrac-r ?\\)
(setq intervals (cons '(?\] . ?\]) intervals))))
;; Split ,-- (which would end up as ,- otherwise).
(let ((dash-r (rassq ?- intervals)))
(when (eq (car dash-r) ?,)
(setcdr dash-r ?,)
(setq dash "-")))
;; Remove - (lone or at start of interval)
(let ((dash-l (assq ?- intervals)))
(when dash-l
(if (eq (cdr dash-l) ?-)
(setq intervals (remq dash-l intervals)) ; Remove lone -
(setcar dash-l ?.)) ; Reduce --x to .-x
(setq dash "-")))
;; Deal with leading ^ and range ^-x in non-negated set.
(when (and (eq (caar intervals) ?^)
(not negated))
(if (eq (cdar intervals) ?^)
;; single leading ^
(if (or (cdr intervals) classes)
;; something else to put before the ^
(progn
(setq intervals (cdr intervals)) ; remove lone ^
(setq caret "^")) ; put ^ (almost) last
;; nothing else but a lone -
(setq intervals (cons '(?- . ?-) intervals)) ; move - first
(setq dash nil))
;; split ^-x to _-x^
(setq intervals `((?_ . ,(cdar intervals)) (?^ . ?^)
. ,(cdr intervals)))))
(cons
(list
(concat
"["
(and negated "^")
(mapconcat (lambda (iv)
(cond ((eq (car iv) (cdr iv))
(char-to-string (car iv)))
((eq (1+ (car iv)) (cdr iv))
(string (car iv) (cdr iv)))
;; Ranges that go between normal chars and raw bytes
;; must be split to avoid being mutilated
;; by Emacs's regexp parser.
((<= (car iv) #x3fff7f (cdr iv))
(string (car iv) ?- #x3fff7f
#x3fff80 ?- (cdr iv)))
(t
(string (car iv) ?- (cdr iv)))))
intervals)
(mapconcat (lambda (cls) (format "[:%s:]" cls)) classes)
caret ; ^ or nothing
dash ; - or nothing
"]"))
t)))))
(defun rx--translate-char-alt (negated body)
"Translate a (rx--char-alt ...) construct. Return (REGEXP . PRECEDENCE).
If NEGATED, negate the sense."
(rx--generate-alt negated (car body) (cdr body)))
(defun rx--translate-any (negated body)
"Translate an (any ...) construct. Return (REGEXP . PRECEDENCE).
If NEGATED, negate the sense."
(let ((parsed (rx--parse-any body)))
(rx--generate-alt negated (car parsed) (cdr parsed))))
;; TODO: Consider turning `not' into a variadic operator, following SRE:
;; (not A B) = (not (or A B)) = (intersection (not A) (not B)), and
;; (not) = anychar.
;; Maybe allow singleton characters as arguments.
(defun rx--translate-not (negated body)
"Translate a (not ...) construct. Return (REGEXP . PRECEDENCE).
If NEGATED, negate the sense (thus making it positive)."
(unless (and body (null (cdr body)))
(error "rx `not' form takes exactly one argument"))
(let ((arg (rx--normalise-char-pattern (car body))))
(pcase arg
(`(not . ,args)
(rx--translate-not (not negated) args))
(`(syntax . ,args)
(rx--translate-syntax (not negated) args))
(`(category . ,args)
(rx--translate-category (not negated) args))
('word-boundary ; legacy syntax
(rx--translate-symbol (if negated 'word-boundary 'not-word-boundary)))
(_ (let ((char (rx--reduce-to-char-alt arg)))
(if char
(rx--generate-alt (not negated) (car char) (cdr char))
(error "Illegal argument to rx `not': %S"
(rx--human-readable arg))))))))
(defun rx--interval-set-complement (ivs)
"Complement of the interval set IVS."
(let ((compl nil)
(c 0))
(dolist (iv ivs)
(when (< c (car iv))
(push (cons c (1- (car iv))) compl))
(setq c (1+ (cdr iv))))
(when (< c (max-char))
(push (cons c (max-char)) compl))
(nreverse compl)))
(defun rx--interval-set-intersection (ivs-a ivs-b)
"Intersection of the interval sets IVS-A and IVS-B."
(let ((isect nil))
(while (and ivs-a ivs-b)
(let ((a (car ivs-a))
(b (car ivs-b)))
(cond
((< (cdr a) (car b)) (setq ivs-a (cdr ivs-a)))
((> (car a) (cdr b)) (setq ivs-b (cdr ivs-b)))
(t
(push (cons (max (car a) (car b))
(min (cdr a) (cdr b)))
isect)
(setq ivs-a (cdr ivs-a))
(setq ivs-b (cdr ivs-b))
(cond ((< (cdr a) (cdr b))
(push (cons (1+ (cdr a)) (cdr b))
ivs-b))
((> (cdr a) (cdr b))
(push (cons (1+ (cdr b)) (cdr a))
ivs-a)))))))
(nreverse isect)))
(defun rx--interval-set-union (ivs-a ivs-b)
"Union of the interval sets IVS-A and IVS-B."
(let ((union nil))
(while (and ivs-a ivs-b)
(let ((a (car ivs-a))
(b (car ivs-b)))
(cond
((< (1+ (cdr a)) (car b)) ; a before b, not adacent
(push a union)
(setq ivs-a (cdr ivs-a)))
((< (1+ (cdr b)) (car a)) ; b before a, not adacent
(push b union)
(setq ivs-b (cdr ivs-b)))
(t ; a and b adjacent or overlap
(setq ivs-a (cdr ivs-a))
(setq ivs-b (cdr ivs-b))
(if (< (cdr a) (cdr b))
(push (cons (min (car a) (car b))
(cdr b))
ivs-b)
(push (cons (min (car a) (car b))
(cdr a))
ivs-a))))))
(nconc (nreverse union) (or ivs-a ivs-b))))
(defun rx--human-readable (form)
"Turn FORM into something that is more human-readable, for error messages."
;; FIXME: Should we produce a string instead?
;; That way we wouldn't have problems with ? and ??, and we could escape
;; single chars.
;; We could steal `xr--rx-to-string' and just file off the serials.
(let ((recurse (lambda (op skip)
(cons op (append (take skip (cdr form))
(mapcar #'rx--human-readable
(nthcdr skip (cdr form))))))))
(pcase form
;; strings are more readable than numbers for single chars
((pred characterp) (char-to-string form))
;; resugar `rx--char-alt'
(`(rx--char-alt ((,c . ,c)) . nil)
(char-to-string form))
(`(rx--char-alt nil . (,class))
class)
;; TODO: render in complemented form if more readable that way?
(`(rx--char-alt ,ivs . ,classes)
(let ((strings (mapcan (lambda (iv)
(let ((beg (car iv))
(end (cdr iv)))
(cond
;; single char
((eq beg end)
(list (string beg)))
;; two chars
((eq end (1+ beg))
(list (string beg) (string end)))
;; first char is hyphen
((eq beg ?-)
(cons (string "-")
(if (eq end (+ ?- 2))
(list (string (1+ ?-) end))
(list (string (1+ ?-) ?- end)))))
;; other range
(t (list (string beg ?- end))))))
ivs)))
`(any ,@strings ,@classes)))
;; avoid numbers as ops
(`(? . ,_) (funcall recurse '\? 0))
(`(?? . ,_) (funcall recurse '\?? 0))
;; recurse on arguments
(`(repeat ,_ ,_) (funcall recurse (car form) 1))
(`(,(or '** 'repeat) . ,_) (funcall recurse (car form) 2))
(`(,(or '= '>= 'group-n 'submatch-n) . ,_) (funcall recurse (car form) 1))
(`(,(or 'backref 'syntax 'not-syntax 'category
'eval 'regex 'regexp 'literal)
. ,_)
form)
(`(,_ . ,_) (funcall recurse (car form) 0))
(_ form))))
(defun rx--translate-intersection (negated body)
"Translate an (intersection ...) construct. Return (REGEXP . PRECEDENCE).
If NEGATED, negate the sense."
(rx--generate-alt negated (rx--intersection-intervals
(mapcar #'rx--normalise-char-pattern body))
nil))
(defun rx--atomic-regexp (item)
"ITEM is (REGEXP . PRECEDENCE); return a regexp of precedence t."
(if (eq (cdr item) t)
(car item)
(rx--bracket (car item))))
(defun rx--translate-counted-repetition (min-count max-count body)
(let ((operand (rx--translate-seq body)))
(if (car operand)
(cons (append
(rx--atomic-regexp operand)
(list (concat "\\{"
(number-to-string min-count)
(cond ((null max-count) ",")
((< min-count max-count)
(concat "," (number-to-string max-count))))
"\\}")))
t)
operand)))
(defun rx--check-repeat-arg (name min-args body)
(unless (>= (length body) min-args)
(error "rx `%s' requires at least %d argument%s"
name min-args (if (= min-args 1) "" "s")))
;; There seems to be no reason to disallow zero counts.
(unless (natnump (car body))
(error "rx `%s' first argument must be nonnegative" name)))
(defun rx--translate-bounded-repetition (name body)
(let ((min-count (car body))
(max-count (cadr body))
(items (cddr body)))
(unless (and (natnump min-count)
(natnump max-count)
(<= min-count max-count))
(error "rx `%s' range error" name))
(rx--translate-counted-repetition min-count max-count items)))
(defun rx--translate-repeat (body)
(rx--check-repeat-arg 'repeat 2 body)
(if (= (length body) 2)
(rx--translate-counted-repetition (car body) (car body) (cdr body))
(rx--translate-bounded-repetition 'repeat body)))
(defun rx--translate-** (body)
(rx--check-repeat-arg '** 2 body)
(rx--translate-bounded-repetition '** body))
(defun rx--translate->= (body)
(rx--check-repeat-arg '>= 1 body)
(rx--translate-counted-repetition (car body) nil (cdr body)))
(defun rx--translate-= (body)
(rx--check-repeat-arg '= 1 body)
(rx--translate-counted-repetition (car body) (car body) (cdr body)))
(defvar rx--greedy t)
(defun rx--translate-rep (op-string greedy body)
"Translate a repetition; OP-STRING is one of \"*\", \"+\" or \"?\".
GREEDY is a boolean. Return (REGEXP . PRECEDENCE)."
(let ((operand (rx--translate-seq body)))
(if (car operand)
(cons (append (rx--atomic-regexp operand)
(list (concat op-string (unless greedy "?"))))
;; The result has precedence seq to avoid (? (* "a")) -> "a*?"
'seq)
operand)))
(defun rx--control-greedy (greedy body)
"Translate the sequence BODY with greediness GREEDY.
Return (REGEXP . PRECEDENCE)."
(let ((rx--greedy greedy))
(rx--translate-seq body)))
(defun rx--translate-group (body)
"Translate the `group' form. Return (REGEXP . PRECEDENCE)."
(cons (rx--enclose "\\("
(car (rx--translate-seq body))
"\\)")
t))
(defun rx--translate-group-n (body)
"Translate the `group-n' form. Return (REGEXP . PRECEDENCE)."
(unless (and (integerp (car body)) (> (car body) 0))
(error "rx `group-n' requires a positive number as first argument"))
(cons (rx--enclose (concat "\\(?" (number-to-string (car body)) ":")
(car (rx--translate-seq (cdr body)))
"\\)")
t))
(defun rx--translate-backref (body)
"Translate the `backref' form. Return (REGEXP . PRECEDENCE)."
(unless (and (= (length body) 1) (integerp (car body)) (<= 1 (car body) 9))
(error "rx `backref' requires an argument in the range 1..9"))
(cons (list "\\" (number-to-string (car body))) t))
(defconst rx--syntax-codes
'((whitespace . ?-) ; SPC also accepted
(punctuation . ?.)
(word . ?w) ; W also accepted
(symbol . ?_)
(open-parenthesis . ?\()
(close-parenthesis . ?\))
(expression-prefix . ?\')
(string-quote . ?\")
(paired-delimiter . ?$)
(escape . ?\\)
(character-quote . ?/)
(comment-start . ?<)
(comment-end . ?>)
(string-delimiter . ?|)
(comment-delimiter . ?!)))
(defun rx--translate-syntax (negated body)
"Translate the `syntax' form. Return (REGEXP . PRECEDENCE)."
(unless (and body (null (cdr body)))
(error "rx `syntax' form takes exactly one argument"))
(let* ((sym (car body))
(syntax (cdr (assq sym rx--syntax-codes))))
(unless syntax
(cond
;; Syntax character directly (sregex compatibility)
((and (characterp sym) (rassq sym rx--syntax-codes))
(setq syntax sym))
;; Syntax character as symbol (sregex compatibility)
((symbolp sym)
(let ((name (symbol-name sym)))
(when (= (length name) 1)
(let ((char (string-to-char name)))
(when (rassq char rx--syntax-codes)
(setq syntax char)))))))
(unless syntax
(error "Unknown rx syntax name `%s'" sym)))
;; Produce \w and \W instead of \sw and \Sw, for smaller size.
(cons (list (if (eq syntax ?w)
(string ?\\ (if negated ?W ?w))
(string ?\\ (if negated ?S ?s) syntax)))
t)))
(defconst rx--categories
'((space-for-indent . ?\s)
(base . ?.)
(consonant . ?0)
(base-vowel . ?1)