-
Notifications
You must be signed in to change notification settings - Fork 0
/
mic-paren.el
1274 lines (1159 loc) · 53.7 KB
/
mic-paren.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
;;; mic-paren.el --- advanced highlighting of matching parentheses
;;; Copyright (C) 2008, 2012 Thien-Thi Nguyen
;;; Copyright (C) 1997 Mikael Sjödin ([email protected])
;; Version: 3.10
;; Released: 2012-07-16
;; Author: Mikael Sjödin ([email protected])
;; Klaus Berndl <[email protected]>
;; Jonathan Kotta <[email protected]>
;; Maintainer: ttn
;; Keywords: languages, faces, parenthesis, matching
;;
;; This program contains additional code by:
;; - Vinicius Jose Latorre <[email protected]>
;; - Steven L Baur <[email protected]>
;; - Klaus Berndl <[email protected]>
;; - ttn
;;
;; mic-paren.el is free software
;;
;; This file is *NOT* (yet?) part of GNU Emacs.
;;
;; This program 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, or (at your option)
;; any later version.
;;
;; This program 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:
;; ----------------------------------------------------------------------
;; Short Description:
;;
;; Load this file, activate it and Emacs will display highlighting on
;; whatever parenthesis (and paired delimiter if you like this) matches
;; the one before or after point. This is an extension to the paren.el
;; file distributed with Emacs. The default behaviour is similar to
;; paren.el but more sophisticated. Normally you can try all default
;; settings to enjoy mic-paren.
;;
;; Some examples to try in your ~/.emacs:
;;
;; (add-hook 'LaTeX-mode-hook
;; (function (lambda ()
;; (paren-toggle-matching-quoted-paren 1)
;; (paren-toggle-matching-paired-delimiter 1))))
;;
;; (add-hook 'c-mode-common-hook
;; (function (lambda ()
;; (paren-toggle-open-paren-context 1))))
;;
;; ----------------------------------------------------------------------
;; Installation:
;;
;; o Place this file in a directory in your `load-path' and byte-compile
;; it. If there are warnings, please report them to ttn.
;; o Put the following in your .emacs file:
;; (require 'mic-paren) ; loading
;; (paren-activate) ; activating
;; ;;; set here any of the customizable variables of mic-paren:
;; ;;; ...
;; o Restart your Emacs; mic-paren is now installed and activated!
;; o To list the possible customizations type `C-h f paren-activate' or
;; go to the customization group `mic-paren-matching'.
;;
;; ----------------------------------------------------------------------
;; Long Description:
;;
;; mic-paren.el is an extension and replacement to the packages paren.el
;; and stig-paren.el for Emacs. When mic-paren is active Emacs normal
;; parenthesis matching is deactivated. Instead parenthesis matching will
;; be performed as soon as the cursor is positioned at a parenthesis. The
;; matching parenthesis (or the entire structured expression between the
;; parentheses) is highlighted until the cursor is moved away from the
;; parenthesis. Features include:
;; o Both forward and backward parenthesis matching (simultaneously if
;; cursor is between two expressions).
;; o Indication of mismatched parentheses.
;; o Recognition of "escaped" (also often called "quoted") parentheses.
;; o Option to match "escaped" parens too, especially in (La)TeX-mode
;; (e.g., matches expressions like "\(foo bar\)" properly).
;; o Offers two functions as replacement for `forward-sexp' and
;; `backward-sexp' which handle properly quoted parens (s.a.). These
;; new functions can automatically be bounded to the original binding
;; of the standard `forward-sexp' and `backward-sexp' functions.
;; o Option to activate matching of paired delimiter (i.e., characters with
;; syntax '$'). This is useful for writing in LaTeX-mode for example.
;; o Option to select in which situations (always, never, if match, if
;; mismatch) the entire expression should be highlighted or only the
;; matching parenthesis.
;; o Message describing the match when the matching parenthesis is off-screen
;; (vertical and/or horizontal). Message contains either the linenumber or
;; the number of lines between the two matching parens. Option to select in
;; which cases this message should be displayed.
;; o Optional delayed highlighting (useful on slow systems),
;; o Functions to activate/deactivate mic-paren.el are provided.
;; o Numerous options to control the behaviour and appearance of
;; mic-paren.el.
;;
;; mic-paren.el was originally developed and tested under Emacs 19.28 -
;; 20.3. Since then, support for Emacs 19 and 20 has bit-rotted (not
;; dropped completely, but not tested against changes, either), and
;; will probably be removed without warning in a future version. This
;; version was developed and tested under Emacs 23.0.60 (wip). XEmacs
;; compatibility has been provided by Steven L Baur <[email protected]>.
;; Jan Dubois ([email protected]) provided help to get mic-paren to work in
;; OS/2.
;;
;; This file (and other wonderful stuff) can be obtained from
;; the Emacs Wiki: <http://www.emacswiki.org/>
;;
;; ----------------------------------------------------------------------
;; Available customizable options:
;; - `paren-priority'
;; - `paren-overlay-priority'
;; - `paren-sexp-mode'
;; - `paren-highlight-at-point'
;; - `paren-highlight-offscreen'
;; - `paren-display-message'
;; - `paren-message-linefeed-display'
;; - `paren-message-no-match'
;; - `paren-message-show-linenumber'
;; - `paren-message-truncate-lines'
;; - `paren-max-message-length'
;; - `paren-ding-unmatched'
;; - `paren-delay'
;; - `paren-dont-touch-blink'
;; - `paren-match-face'
;; - `paren-mismatch-face'
;; - `paren-no-match-paren'
;; - `paren-bind-modified-sexp-functions'
;; Available customizable faces:
;; - `paren-face-match'
;; - `paren-face-mismatch'
;; - `paren-face-no-match'
;; Available commands:
;; - `paren-activate'
;; - `paren-deactivate'
;; - `paren-toggle-matching-paired-delimiter'
;; - `paren-toggle-matching-quoted-paren'
;; - `paren-toggle-open-paren-context'
;; - `paren-forward-sexp'
;; - `paren-backward-sexp'
;; ----------------------------------------------------------------------
;;
;; IMPORTANT NOTES (important for people who have customized mic-paren
;; from within elisp):
;; - In version >= 3.3 the prefix "mic-" has been removed from the
;; command-names `mic-paren-forward-sexp' and `mic-paren-backward-sexp'.
;; Now all user-functions and -options begin with the prefix "paren-"
;; because this package should be a replacement of the other
;; paren-packages like paren.el and stig-paren.el!
;; - In version >= 3.2 the prefix "mic-" has been removed from the
;; command-names `mic-paren-toggle-matching-quoted-paren' and
;; `mic-paren-toggle-matching-paired-delimiter'.
;; - In versions >= 3.1 mic-paren is NOT auto-activated after loading.
;; - In versions >= 3.0 the variable `paren-face' has been renamed to
;; `paren-match-face'.
;;
;; ----------------------------------------------------------------------
;; Versions:
;; v3.10 + Added message-length clamping (var `paren-max-message-length').
;; Thanks to Jonathan Kotta.
;;
;; v3.9 + Fixed XEmacs bug in `define-mic-paren-nolog-message'.
;; Thanks to Sivaram Neelakantan.
;;
;; v3.8 + Maintainership (crassly) grabbed by ttn.
;; + License now GPLv3+.
;; + Byte-compiler warnings eliminated; if you see one, tell me!
;; + Dropped funcs: mic-char-bytes, mic-char-before.
;; + Docstrings, messages, comments revamped.
;;
;; v3.7 + Removed the message "You should be in LaTeX-mode!".
;; + Fixed a bug in `paren-toggle-matching-quoted-paren'.
;; + Fixed some misspellings in the comments and docs.
;;
;; v3.6 + Fixed a very small bug in `mic-paren-horizontal-pos-visible-p'.
;; + The informational messages like "Matches ... [+28]" which are
;; displayed if the matching paren is offscreen, do not longer
;; wasting the log.
;;
;; v3.5 + No mic-paren-messages are displayed if we are in isearch-mode.
;; + Matching quoted parens is switched on if entering a minibuffer.
;; This is useful for easier inserting regexps, e.g., with
;; `query-replace-regexp'. Now \(...\) will be highlighted
;; in the minibuffer.
;; + New option `paren-message-show-linenumber': You can determine
;; the computation of the offscreen-message-linenumber. Either the
;; number of lines between the two matching parens or the absolute
;; linenumber. (Thank you for the idea and a first implementation
;; to Eliyahu Barzilay <[email protected]>.)
;; + New option `paren-message-truncate-lines': If mic-paren messages
;; should be truncated or not (has only an effect in GNU Emacs 21).
;; (Thank you for the idea and a first implementation to Eliyahu
;; Barzilay <[email protected]>.)
;;
;; v3.4 + Corrected some bugs in the backward-compatibility for older
;; Emacsen. Thanks to Tetsuo Tsukamoto <[email protected]>.
;;
;; v3.3 + Now the priority of the paren-overlays can be customized
;; (option `paren-overlay-priority'). For a description of the
;; priority of an overlay see in the emacs-lisp-manual the node
;; "Overlays". This option is mainly useful for experienced
;; users which use many packages using overlays to perform their
;; tasks.
;; + Now you can determine what line-context will be displayed if
;; the matching open paren is offscreen. In functional
;; programming languages like lisp it is useful to display the
;; following line in the echo-area if the opening matching paren
;; has no preceding text in the same line.
;; But in procedural languages like C++ or Java it is convenient
;; to display the first previous non empty line in this case
;; instead of the following line. Look at the new variable
;; `paren-open-paren-context-backward' and the related toggling
;; function `paren-toggle-open-paren-context' for a detailed
;; description of this new feature.
;; + In addition to the previous described new feature you can
;; specify how a linefeed in the message (e.g., if the matching
;; paren is offscreen) is displayed. This is mainly because the
;; standard echo-area display of a linefeed (^J) is bad to read.
;; Look at the option `paren-message-linefeed-display'.
;; + Solved a little bug in the compatibility-code for Emacsen
;; not supporting current customize-feature.
;; + Removed the prefix "mic-" from the commands
;; `mic-paren-forward-sexp' and `mic-paren-backward-sexp'.
;; For an explanation look at comments for version v3.2.
;;
;; v3.2 + The prefix "mic-" has been removed from the commands
;; `mic-paren-toggle-matching-quoted-paren' and
;; `mic-paren-toggle-matching-paired-delimiter'. This is for
;; consistency. Now all user-variables, -faces and -commands
;; begin with the prefix "paren-" and all internal functions
;; and variables begin with the prefix "mic-paren-".
;; + Now you can exactly specify in which situations the whole
;; sexp should be highlighted (option `paren-sexp-mode'):
;; Always, never, if match or if mismatch. Tested with Gnus
;; Emacs >= 20.3.1 and XEmacs >= 21.1.
;;
;; v3.1 + From this version on mic-paren is not autoloaded. To
;; activate it you must call `paren-activate' (either in your
;; .emacs or manually with M-x). Therefore the variable
;; `paren-dont-activate-on-load' ise obsolet and has been
;; removed.
;; + Now mic-paren works also in older Emacsen without the
;; custom-feature. If the actual custom-library is provided
;; mic-paren use them and is full customizable otherwise normal
;; defvars are used for the options.
;; + Fix of a bug displaying a message if the matching paren is
;; horizontal out of view.
;; + All new features are now tested with XEmacs >= 21.1.6.
;;
;; v3.0 + Checking if matching paren is horizontally offscreen (in
;; case of horizontal scrolling). In that case the message is
;; displayed in the echo-area (anlogue to vertical offscreen).
;; In case of horizontal offscreen closing parenthesis the
;; displayed message is probably wider than the frame/window.
;; So you can only read the whole message if you are using a
;; package like mscroll.el (scrolling long messages) in GNU
;; Emacs.
;; + Now full customizable, means all user-options and -faces now
;; can be set with the custom-feature of Emacs. On the other
;; hand, this means this version of mic-paren only works with an
;; Emacs which provides the custom-package!
;; + In case of the matching paren is offscreen now the displayed
;; message contains the linenumber of the matching paren too.
;; This version is only tested with Gnu Emacs >= 20.4 and not with
;; any XEmacs!
;; Implemented by Klaus Berndl <[email protected]>.
;;
;; v2.3 No additional feature but replacing `char-bytes' and
;; `char-before' with `mic-char-bytes' and `mic-char-before' to
;; prevent a clash in the global-namespace. Now the new
;; features of v2.1 and v2.2 are also tested with XEmacs!
;;
;; v2.2 Adding the new feature for matching paired delimiter. Not
;; tested with XEmacs. Implemented by Klaus Berndl <[email protected]>
;;
;; v2.1 Adding the new feature for matching escaped parens too. Not
;; tested with XEmacs. Implemented by Klaus Berndl <[email protected]>.
;;
;; v2.0 Support for MULE and Emacs 20 multibyte characters added.
;; Inspired by the suggestion and code of Saito Takaaki
;; <[email protected]>.
;;
;; v1.9 Avoids multiple messages/dings when point has not moved. Thus,
;; mic-paren no longer overwrites messages in minibuffer. Inspired by
;; the suggestion and code of Barzilay Eliyahu <[email protected]>.
;;
;; v1.3.1 Some spelling corrected (from Vinicius Jose Latorre
;; <[email protected]> and Steven L Baur <[email protected]>).
;;
;; v1.3 Added code from Vinicius Jose Latorre <[email protected]> to
;; highlight unmatched parentheses (useful in minibuffer).
;;
;; v1.2.1 Fixed stuff to work with OS/2 emx-emacs:
;; - checks if `x-display-colour-p' is bound before calling it;
;; - changed how X/Lucid Emacs is detected.
;; Added automatic load of the timer-feature (plus variable to
;; disable the loading).
;;; Code:
(defvar mic-paren-version "3.10"
"Version of mic-paren.")
(eval-when-compile (require 'cl))
;;; ======================================================================
;; Compatibility stuff
;; BLOB to make custom stuff work even without customize
(eval-and-compile
(condition-case ()
(require 'custom)
(error nil))
(unless (fboundp 'defgroup)
(defmacro defgroup (&rest rest) nil))
(unless (fboundp 'defcustom)
(defmacro defcustom (sym val str &rest rest)
`(defvar ,sym ,val ,str)))
(unless (fboundp 'defface)
(defmacro defface (sym val str &rest rest)
`(defvar ,sym (make-face ',sym) ,str))))
;;; ======================================================================
;;; here begin the user options
(defgroup mic-paren-matching nil
"Enable advanced (un)matching of parens and expressions."
:prefix "paren-"
:group 'paren-matching)
(defcustom paren-priority 'both
"*Control behavior in a \"abutted close-open\" situation.
This occurs when point is between a closing and an opening
parenthesis, such as: (A B)(C D)
^
point
close -- highlight the parenthesis matching the close-parenthesis
before the point (highlight opening paren before A).
open -- highlight the parenthesis matching the open-parenthesis after
the point (highlight closing paren after D).
both -- highlight both parenthesis matching the parenthesis beside
the point (highlight opening before A and closing after D)."
:type '(choice (const :tag "Match close" close)
(const :tag "Match open" open)
(const :tag "Match both" both))
:group 'mic-paren-matching)
(defcustom paren-overlay-priority 999
"*Non-negative integer to specify paren overlay priority.
For details, see info node `(elisp) Overlays'.
Normally you don't want to change the default value!"
:set (function
(lambda (symbol value)
(set symbol (if (< value 0) (* -1 value) value))))
:initialize 'custom-initialize-default
:type 'integer
:group 'mic-paren-matching)
(defcustom paren-sexp-mode nil
"*Control in which situations the whole sexp should be highlighted.
This means the whole s-expression between the matching parentheses is
highlighted instead of only the matching/mismatching parenthesis.
t -- Always highlight the whole s-expression.
nil -- Never highlight the whole s-expression.
match -- Highlight the whole s-expression only if the parens match.
mismatch -- Highlight the whole s-expression only if the parens don't match."
:type '(choice (const :tag "Never sexp-mode" nil)
(const :tag "Always sexp-mode" t)
(const :tag "If match" match)
(const :tag "If mismatch" mismatch))
:group 'mic-paren-matching)
(defcustom paren-highlight-at-point t
"*Non-nil highlights both parens when point is after the close-paren.
If nil, only the open parenthesis is highlighted."
:type '(choice (const :tag "Highlight both" t)
(const :tag "Highlight open" nil))
:group 'mic-paren-matching)
(defcustom paren-highlight-offscreen nil
"*Non-nil enables highlighting text not visible in the current buffer.
This is useful if you regularly display the current buffer in
multiple windows or frames (e.g., if you use Follow mode, by
[email protected]). Note: this option may slow down your Emacs.
This variable is ignored (treated as non-nil) if you set
`paren-sexp-mode' to non-nil."
:type 'boolean
:group 'mic-paren-matching)
(defcustom paren-display-message 'only
"*Display message if matching parenthesis is off-screen.
Possible settings are:
always -- message is always displayed regardless if offscreen or not
only -- message is only displayed when matching is offscreen
never -- never a message is displayed."
:type '(choice (const :tag "Display always" always)
(const :tag "Display if offscreen" only)
(const :tag "No Message display" never))
:group 'mic-paren-matching)
(defcustom paren-message-linefeed-display " RET "
"*String for displaying a linefeed in the matching paren context message.
There are three predefined values:
- Displays linefeeds with \" RET \" in the message.
- Displays linefeeds with a SPACE in the message.
- Displays linefeeds in the standard-form, means with \"^J\".
But you can also specify any user-defined string for it.
For further explanations about message displaying look at
`paren-display-message'."
:type '(choice (const :tag "Display with \"RET\"" :value " RET ")
(const :tag "Display with a SPACE" :value " ")
(const :tag "Standard" :value "^J")
(string :tag "User defined"))
:group 'mic-paren-matching)
(defcustom paren-message-show-linenumber 'sexp
"*Determine the computation of the offscreen-message-linenumber.
If the matching paren is offscreen, then maybe a message with the
context of the matching paren and it's linenumber is displayed
\(depends on the setting in `paren-display-message'). Here the
computation of the linenumber can be determined:
sexp -- Display the number of lines between the matching parens. Then the
number of lines is displayed as negative number if the matching paren
is somewhere above. Otherwise the number has a positive sign.
absolute -- Display the absolute linenumber of the machting paren computed
from the beginning of the buffer."
:type '(choice (const :tag "Count accros sexp" sexp)
(const :tag "Absolute number" absolute))
:group 'mic-paren-matching)
(defcustom paren-message-no-match t
"*Display message if no matching parenthesis is found."
:type '(choice (const :tag "Display message" t)
(const :tag "No message" nil))
:group 'mic-paren-matching)
(defcustom paren-message-truncate-lines t
"*Non nil means truncate lines for all messages mic-paren can display.
This option has only an effect with GNU Emacs 21.x!"
:type 'boolean
:group 'mic-paren-matching)
(defcustom paren-max-message-length 0
"*If positive, the max length `mic-paren-nolog-message' should output.
The length is reduced by removing the middle section of the message.
A value of zero means do not modify the message."
:type 'integer
:group 'mic-paren-matching)
(defcustom paren-ding-unmatched nil
"*Non-nil means make noise in unmatched situations.
An unmatched situation occurs if the cursor is at an unmatched
parenthesis or no matching parenthesis is found.
Even if nil, typing an unmatched parenthesis produces a ding."
:type 'boolean
:group 'mic-paren-matching)
(defcustom paren-delay nil
"*This variable controls when highlighting is done.
The variable has different meaning in different versions of Emacs.
In Emacs 19.29 and below:
This variable is ignored.
In Emacs 19.30:
A value of nil will make highlighting happen immediately \(this may slow
down your Emacs if running on a slow system). Any non-nil value will
delay highlighting for the time specified by post-command-idle-delay.
In Emacs 19.31 and above:
A value of nil will make highlighting happen immediately \(this may slow
down your Emacs if running on a slow system). If not nil, the value
should be a number \(possible a floating point number if your Emacs
support floating point numbers). The number is the delay in seconds
before mic-paren performs highlighting.
If you change this variable when mic-paren is active you have to
re-activate \(with M-x paren-activate) mic-paren for the change to take
effect."
:type '(choice (number :tag "Delay time")
(const :tag "No delay" nil))
:group 'mic-paren-matching)
(defcustom paren-dont-touch-blink nil
"*Non-nil means not to change the value of `blink-matching-paren'.
This takes effect when mic-paren is activated or deactivated. If nil
mic-paren turns of blinking when activated and turns on blinking when
deactivated."
:type 'boolean
:group 'mic-paren-matching)
(defcustom paren-dont-load-timer (not (string-match "XEmacs\\|Lucid"
emacs-version))
"*Non-nil inhibits loading `timer'.
\(I have no idea why Emacs user ever want to set this to non-nil but I hate
packages which loads/activates stuff I don't want to use so I provide this
way to prevent the loading if someone doesn't want timers to be loaded.)"
:type 'boolean
:group 'mic-paren-matching)
(defcustom paren-bind-modified-sexp-functions t
"*Automatic binding of the new sexp-functions to the old bindings.
If non nil mic-paren checks at load-time the keybindings for the functions
`forward-sexp' and `backward-sexp' and binds the modified sexp-functions
`paren-forward-sexp' and `paren-backward-sexp' to exactly these
bindings if and only if matching quoted/escaped parens is turned on by
`paren-toggle-matching-quoted-paren'. These new bindings are done only
in a buffer-local keymap, therefore if you activate the quoted matching
only in some modes from within a hook only in these buffers the new
bindings are active and in all other not.
If you deactivate the quoted matching feature by
`paren-toggle-matching-quoted-paren' then `forward-sexp' and
`backward-sexp' will be bound again to their original key-bindings!"
:type 'boolean
:group 'mic-paren-matching)
;;; ------------------------------
;;; Faces
;;; ------------------------------
(defface paren-face-match
'((((class color)) (:background "turquoise"))
(t (:background "gray")))
"Mic-paren mode face used for a matching paren."
:group 'faces
:group 'mic-paren-matching)
(defface paren-face-mismatch
'((((class color)) (:foreground "white" :background "purple"))
(t (:reverse-video t)))
"Mic-paren mode face used for a mismatching paren."
:group 'faces
:group 'mic-paren-matching)
(defface paren-face-no-match
'((((class color)) (:foreground "black" :background "yellow"))
(t (:reverse-video t)))
"Mic-paren mode face used for an unmatched paren."
:group 'faces
:group 'mic-paren-matching)
(defcustom paren-match-face 'paren-face-match
"*Face to use for showing the matching parenthesis."
:type 'face
:group 'mic-paren-matching)
(defcustom paren-mismatch-face 'paren-face-mismatch
"*Face to use when highlighting a mismatched parenthesis."
:type 'face
:group 'mic-paren-matching)
(defcustom paren-no-match-face 'paren-face-no-match
"*Face to use when highlighting an unmatched parenthesis."
:type 'face
:group 'mic-paren-matching)
;;; End of User Options
;;; ======================================================================
;;; Below there are only variables and options which either should be not
;;; set directly but with toggle-functions or pure internal variables.
(defvar paren-match-quoted-paren nil
"*Non-nil enables matching properly quoted (or escaped) parens.
E.g., \"\\\(x-3y + z = 7\\\)\"\) in a TeX file. GNU Emacs can not match
quoted parens, so we must temporally deactivate the quoting until emacs
has done its sexp-parsing. Therefore emacs itself does not \(can not!\)
take into consideration if either both matched parens are quoted or none.
But nevertheless we do this! Only symmetric balanced parens are matched;
either both matching parens must be quoted or none, otherwise they we will
be highlighted as mismatched.
This package offers also two slightly modified versions of sexp traversal
functions: `paren-forward-sexp' and `paren-backward-sexp'. These versions
can also jump to escaped/quoted parens.
If this variable is not nil and `paren-bind-modified-sexp-functions' is
set to non nil, then `paren-toggle-matching-quoted-paren' will also toggle
the original binding of `forward-sexp' and `backward-sexp' between the
original functions and the modified equivalents.
Do NOT set this variable directly but use
`paren-toggle-matching-quoted-paren' to activate/deactivate/toggle this
feature! The best method is to do this in a mode hook, e.g.:
\(add-hook \'LaTeX-mode-hook
\(function \(lambda \(\)
\(paren-toggle-matching-quoted-paren 1\)\)\)\)")
(make-variable-buffer-local 'paren-match-quoted-paren)
(defvar paren-match-paired-delimiter nil
"*Non-nil enables matching of characters with syntax \"$\".
E.g., in LaTeX \"$...$\" is equivalent to \"\\(...\\)\".
Unlike to parens quoted/escaped paired delimiter will never match.
Do NOT set this variable directly but use
`paren-toggle-matching-paired-delimiter' to activate/deactivate/toggle
this feature! The best method is to do this in a mode hook, e.g.:
\(add-hook \'LaTeX-mode-hook
\(function \(lambda \(\)
\(paren-toggle-matching-paired-delimiter 1\)\)\)\)")
(make-variable-buffer-local 'paren-match-paired-delimiter)
(defvar paren-open-paren-context-backward nil
"*Controls which context of the matching open paren will be displayed.
This takes effect if the matching open paren is offscreen or
`paren-display-message' is `always' (see `paren-display-message')
and the matching open paren has no previous text in the same line.
Possible values:
nil -- Contents of the **next** not empty and not whitespace-line will be
displayed. This value is useful for example in functional programming
languages like (emacs)lisp.
not-nil -- Contents of the first **previous** not empty and not only
whitespace-line will be displayed. This value is useful for example in
procedural programming languages like C, C++, Java etc.
Lets take a look at a short example:
In languages like C++ we often have situations like
if \(i > VALUE\)
\{
// some code
\}
With a value non nil the displayed opening-brace context would be
\"if \(i > VALUE\)^J\{\" but with nil it would be \"\{^J // some code\"
which would be in C++ lesser useful as the non nil version.
\(The ^J stands for a newline in the buffer\).
Do NOT set this variable directly but use `paren-toggle-open-paren-context'
to change the value of this option! The best method is to do this in a
mode hook, e.g.:
\(add-hook \'c-common-mode-hook
\(function \(lambda \(\)
\(paren-toggle-open-paren-context 1\)\)\)\)")
(make-variable-buffer-local 'paren-open-paren-context-backward)
(defconst mic-paren-original-keybinding-of-sexp-functions
(list (car (where-is-internal 'forward-sexp))
(car (where-is-internal 'backward-sexp))))
;;; Compatibility.
;;; Try to make mic-paren work in different Emacs flavours.
;; XEmacs compatibility (mainly by Steven L Baur <[email protected]>).
(eval-and-compile
(if (string-match "\\(Lucid\\|XEmacs\\)" emacs-version)
(progn
(fset 'mic-make-overlay 'make-extent)
(fset 'mic-delete-overlay 'delete-extent)
(fset 'mic-overlay-put 'set-extent-property)
(fset 'mic-cancel-timer 'delete-itimer)
(fset 'mic-run-with-idle-timer 'start-itimer))
(fset 'mic-make-overlay 'make-overlay)
(fset 'mic-delete-overlay 'delete-overlay)
(fset 'mic-overlay-put 'overlay-put)
(fset 'mic-cancel-timer 'cancel-timer)
(fset 'mic-run-with-idle-timer 'run-with-idle-timer)))
(defun paren-clamp-string-maybe (str)
"Remove the middle of STR if it exceeds `paren-max-message-length'.
However, if STR is `nil' or `paren-max-message-length' is zero,
simply return STR."
(if (or (not str) (zerop paren-max-message-length))
str
(let ((len (string-width str)))
(if (<= len paren-max-message-length)
str
(let* ((sep "[...]")
(cut (ash (- paren-max-message-length
(string-width sep))
-1)))
(concat (substring str 0 cut)
sep
(substring str (- len cut))))))))
(eval-when-compile
(defmacro define-mic-paren-nolog-message (yes no)
`(defun mic-paren-nolog-message (&rest args)
"Work like `message' but without logging.
See variable `paren-max-message-length'."
(let ((msg (paren-clamp-string-maybe
(cond ((or (null args)
(null (car args)))
nil)
((null (cdr args))
(car args))
(t
(apply 'format args))))))
(if msg ,yes ,no)
msg))))
(eval-and-compile
(if (and (fboundp 'display-message)
(fboundp 'clear-message))
;; Some GNU Emacs versions need the `eval' so as to avoid saying:
;; > the following functions are not known to be defined:
;; > display-message, clear-message
(eval '(define-mic-paren-nolog-message
(display-message 'no-log msg)
(clear-message 'no-log)))
(define-mic-paren-nolog-message
(let (message-log-max) (message "%s" msg))
(message nil))))
;;; ======================================================================
;;; Pure Internal variables
(defvar mic-paren-overlays (vector (mic-make-overlay 1 1)
(mic-make-overlay 1 1)
(mic-make-overlay 1 1))
"Vector of of the form [BACKW POINT FOREW].
BACKW: Overlay for the open-paren which matches the close-paren
before point. When in sexp-mode this is the overlay for
the expression before point.
POINT: Overlay for the close-paren before point.
This is not used when is sexp-mode.
FOREW: Overlay for the close-paren which matches the open-paren
after point. When in sexp-mode this is the overlay for
the expression after point.")
(defvar mic-paren-idle-timer nil
"Idle-timer.
Used only in Emacs 19.31 and above (and if paren-delay is nil).")
(defvar mic-paren-previous-location [nil nil nil]
"Where point was the last time mic-paren performed some action.
This is is a vector of the form [POINT BUFFER WINDOW].")
;;; ======================================================================
;;; User Functions
;;;###autoload
(defun paren-activate ()
"Activate mic-paren parenthesis highlighting.
Note: This also deactivates the paren.el
and stig-paren.el packages if they are active!
The following options are available via the customize-feature:
`paren-priority'
`paren-overlay-priority'
`paren-sexp-mode'
`paren-highlight-at-point'
`paren-highlight-offscreen'
`paren-display-message'
`paren-message-linefeed-display'
`paren-message-no-match'
`paren-message-show-linenumber'
`paren-message-truncate-lines'
`paren-ding-unmatched'
`paren-delay'
`paren-dont-touch-blink'
`paren-match-face'
`paren-mismatch-face'
`paren-no-match-face'
`paren-bind-modified-sexp-functions'
The following options are settable via toggling functions \(look at the
documentation of these options for the names of these functions\):
`paren-match-quoted-paren'
`paren-match-paired-delimiter'
`paren-open-paren-context-backward'"
(interactive)
;; Deactivate mic-paren.el (to remove redundant hooks).
(paren-deactivate)
;; Deactivate paren.el if loaded.
(when (boundp 'post-command-idle-hook)
(remove-hook 'post-command-idle-hook 'show-paren-command-hook))
(remove-hook 'post-command-hook 'show-paren-command-hook)
(and (boundp 'show-paren-overlay)
show-paren-overlay
(mic-delete-overlay show-paren-overlay))
(and (boundp 'show-paren-overlay-1)
show-paren-overlay-1
(mic-delete-overlay show-paren-overlay-1))
;; Deactivate stig-paren.el if loaded.
(when (boundp 'post-command-idle-hook)
(remove-hook 'post-command-idle-hook 'stig-paren-command-hook))
(remove-hook 'post-command-hook 'stig-paren-command-hook)
(remove-hook 'post-command-hook 'stig-paren-safe-command-hook)
(remove-hook 'pre-command-hook 'stig-paren-delete-overlay)
;; Deactivate Emacs standard parenthesis blinking.
(or paren-dont-touch-blink
(setq blink-matching-paren nil))
(cond(
;; If timers are available use them
;; (Emacs 19.31 and above).
(featurep 'timer)
(if (numberp paren-delay)
(setq mic-paren-idle-timer
(mic-run-with-idle-timer paren-delay t
'mic-paren-command-idle-hook))
(add-hook 'post-command-hook 'mic-paren-command-hook)))
;; If the idle hook exists assume it is functioning and use it
;; (Emacs 19.30).
((and (boundp 'post-command-idle-hook)
(boundp 'post-command-idle-delay))
(if paren-delay
(add-hook 'post-command-idle-hook 'mic-paren-command-idle-hook)
(add-hook 'post-command-hook 'mic-paren-command-hook)))
;; Check if we (at least) have `post-comand-hook', and use it
;; (Emacs 19.29 and below).
((boundp 'post-command-hook)
(add-hook 'post-command-hook 'mic-paren-command-hook))
;; Not possible to install mic-paren hooks
(t (error "Cannot activate mic-paren in this Emacs version")))
;; We want matching quoted parens in the minibuffer to ease inserting
;; paren-expressions in a regexp.
(add-hook 'minibuffer-setup-hook
'mic-paren-minibuffer-setup-hook)
(add-hook 'minibuffer-exit-hook
'mic-paren-minibuffer-exit-hook))
;;;###autoload
(defun paren-deactivate ()
"Deactivate mic-paren parenthesis highlighting."
(interactive)
;; Deactivate (don't bother to check where/if mic-paren is acivte, just
;; delete all possible hooks and timers).
(when (boundp 'post-command-idle-hook)
(remove-hook 'post-command-idle-hook 'mic-paren-command-idle-hook))
(when mic-paren-idle-timer
(mic-cancel-timer mic-paren-idle-timer))
(remove-hook 'post-command-hook 'mic-paren-command-hook)
(remove-hook 'minibuffer-setup-hook
'mic-paren-minibuffer-setup-hook)
(remove-hook 'minibuffer-exit-hook
'mic-paren-minibuffer-exit-hook)
;; Remove any old highlight.
(mic-delete-overlay (aref mic-paren-overlays 0))
(mic-delete-overlay (aref mic-paren-overlays 1))
(mic-delete-overlay (aref mic-paren-overlays 2))
;; Reactivate Emacs standard parenthesis blinking.
(or paren-dont-touch-blink
(setq blink-matching-paren t)))
;;;###autoload
(defun paren-toggle-matching-paired-delimiter (arg &optional no-message)
"Toggle matching paired delimiter.
Force on with positive ARG. Use this in mode hooks to activate or
deactivate paired delimiter matching. If optional second argument
NO-MESSAGE is non-nil then don't display a message about the
current activation state of the paired-delimiter-matching feature."
(interactive "P")
(setq paren-match-paired-delimiter (if (numberp arg)
(> arg 0)
(not paren-match-paired-delimiter)))
(unless no-message
(message "Matching paired delimiter is %s"
(if paren-match-paired-delimiter
"ON"
"OFF"))))
;;;###autoload
(defun paren-toggle-matching-quoted-paren (arg &optional no-message)
"Toggle matching quoted parens.
Force on with positive ARG. Use this in mode hooks to activate or
deactivate quoted paren matching. If optional second argument
NO-MESSAGE is non-nil then don't display a message about the
current activation state of the quoted-paren-matching feature."
(interactive "P")
(setq paren-match-quoted-paren (if (numberp arg)
(> arg 0)
(not paren-match-quoted-paren)))
;; If matching quoted parens is active now bind the original binding
;; of forward-sexp and backward-sexp to the modified versions
;; `paren-forward-sexp' and `paren-backward-sexp'. If not, bind
;; it back to the original `forward-sexp' and `backward-sexp'.
(let ((f (car mic-paren-original-keybinding-of-sexp-functions))
(b (cadr mic-paren-original-keybinding-of-sexp-functions))
(funs (if paren-match-quoted-paren
'(paren-forward-sexp . paren-backward-sexp)
'(forward-sexp . backward-sexp))))
(when (and paren-bind-modified-sexp-functions b f)
(local-set-key f (car funs))
(local-set-key b (cdr funs))))
(unless no-message
(message "Matching quoted parens is %s"
(if paren-match-quoted-paren
"ON"
"OFF"))))
;;;###autoload
(defun paren-toggle-open-paren-context (arg)
"Toggle whether or not to determine context of the matching open-paren.
Force backward context with positive ARG. Use this in mode-hooks.
See `paren-open-paren-context-backward'."
(interactive "P")
(setq paren-open-paren-context-backward
(if (numberp arg)
(> arg 0)
(not paren-open-paren-context-backward))))
;;;###autoload
(defun paren-forward-sexp (&optional arg)
"Act like `forward-sexp' but also handle quoted parens.
See `paren-match-quoted-paren'."
(interactive "p")
(or arg (setq arg 1))
(let* ((uncharquote-diff (if (< arg 0) 2 1))
(match-check-diff (if (< arg 0) 1 2))
(charquote (mic-paren-uncharquote (- (point) uncharquote-diff)))
match-pos mismatch)
;; We must encapsulate this in condition-case so we regain control
;; after error and we can undo our unquoting if any done before!
(condition-case ()
(setq match-pos (scan-sexps (point) arg))
(error nil))
(mic-paren-recharquote charquote)
(if (not match-pos)
(buffer-end arg)
(setq mismatch (mic-paren-fcq-mismatch (- match-pos match-check-diff)
charquote))
(if mismatch
(forward-sexp arg)
(goto-char match-pos)))))
;;;###autoload
(defun paren-backward-sexp (&optional arg)
"Act like `backward-sexp' but also match quoted parens.
See `paren-match-quoted-paren'."
(interactive "p")
(or arg (setq arg 1))
(paren-forward-sexp (- arg)))
;;; ======================================================================
;;; Internal functions
(defun mic-paren-command-idle-hook ()
(condition-case paren-error
(mic-paren-highlight)
(error
(unless (window-minibuffer-p (selected-window))
(message "mic-paren caught error (please report): %s"
paren-error)))))
(defun mic-paren-command-hook ()
(or executing-kbd-macro
;; NB: This might cause trouble since the function is unreliable.
(input-pending-p)
(mic-paren-command-idle-hook)))
(defun mic-paren-minibuffer-setup-hook ()
(paren-toggle-matching-quoted-paren 1 t))
(defun mic-paren-minibuffer-exit-hook ()
(paren-toggle-matching-quoted-paren -1 t))
(defun mic-paren-fcq-mismatch (pos charquote)
(not (zerop (logxor (if (mic-paren-is-following-char-quoted pos) 1 0)
(if charquote 1 0)))))
(defun mic-paren-highlight ()
"Do everything: highlighting, dinging, messages, cleaning-up.
This is the main function of mic-paren."
;; Remove any old highlighting.
(mic-delete-overlay (aref mic-paren-overlays 0))
(mic-delete-overlay (aref mic-paren-overlays 1))
(mic-delete-overlay (aref mic-paren-overlays 2))
(let ((loc mic-paren-previous-location)
charquote two opos matched-paren mismatch face visible)
(flet ((highlight-p
(pos prio which)
(let ((fcq (mic-paren-is-following-char-quoted pos))
(right-prio (eq prio paren-priority))
(get-c-0 (if which 'preceding-char 'following-char))
(get-c-1 (if which 'following-char 'preceding-char)))
(or (and (eq (char-syntax (funcall get-c-0))
(if which ?\) ?\())
(not (and (eq (char-syntax (funcall get-c-1))
(if which ?\( ?\)))
right-prio))