1 ;;; align.el --- align text to a specific column, by regexp
3 ;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
4 ;; 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: John Wiegley <johnw@gnu.org>
7 ;; Keywords: convenience languages lisp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; This mode allows you to align regions in a context-sensitive fashion.
29 ;; The classic use is to align assignments:
43 ;; There are several variables which define how certain "categories"
44 ;; of syntax are to be treated. These variables go by the name
45 ;; `align-CATEGORY-modes'. For example, "c++" is such a category.
46 ;; There are several rules which apply to c++, but since several other
47 ;; languages have a syntax similar to c++ (e.g., c, java, etc), these
48 ;; modes are treated as belonging to the same category.
50 ;; If you want to add a new mode under a certain category, just
51 ;; customize that list, or add the new mode manually. For example, to
52 ;; make jde-mode a c++ category mode, use this code in your .emacs
55 ;; (setq align-c++-modes (cons 'jde-mode align-c++-modes))
57 ;; In some programming modes, it's useful to have the aligner run only
58 ;; after indentation is performed. To achieve this, customize or set
59 ;; the variable `align-indent-before-aligning' to t.
63 ;; In order to incorporate align's functionality into your own
64 ;; modules, there are only a few steps you have to follow.
66 ;; 1. Require or load in the align.el library.
68 ;; 2. Define your alignment and exclusion rules lists, either
69 ;; customizable or not.
71 ;; 3. In your mode function, set the variables
72 ;; `align-mode-rules-list' and `align-mode-exclude-rules-list'
73 ;; to your own rules lists.
75 ;; If there is any need to add your mode name to one of the
76 ;; align-?-modes variables (for example, `align-dq-string-modes'), use
77 ;; `add-to-list', or some similar function which checks first to see
78 ;; if the value is already there. Since the user may customize that
79 ;; mode list, and then write your mode name into their .emacs file,
80 ;; causing the symbol already to be present the next time they load
87 ;; (defcustom my-align-rules-list
89 ;; (regexp . "Sample")))
90 ;; :type align-rules-list-type
91 ;; :group 'my-package)
93 ;; (put 'my-align-rules-list 'risky-local-variable t)
95 ;; (add-to-list 'align-dq-string-modes 'my-package-mode)
96 ;; (add-to-list 'align-open-comment-modes 'my-package-mode)
100 ;; (setq align-mode-rules-list my-align-rules-list))
102 ;; Note that if you need to install your own exclusion rules, then you
103 ;; will also need to reproduce any double-quoted string, or open
104 ;; comment exclusion rules that are defined in the standard
105 ;; `align-exclude-rules-list'. At the moment there is no convenient
106 ;; way to mix both mode-local and global rules lists.
110 ;; Version 1.0 was created in the earlier part of 1996, using a very
111 ;; simple algorithm that understand only basic regular expressions.
112 ;; Parts of the code were broken up and included in vhdl-mode.el
113 ;; around this time. After several comments from users, and a need to
114 ;; find a more robust, performant algorithm, 2.0 was born in late
115 ;; 1998. Many different approaches were taken (mostly due to the
116 ;; complexity of TeX tables), but finally a scheme was discovered
117 ;; which worked fairly well for most common usage cases. Development
118 ;; beyond version 2.8 is not planned, except for problems that users
124 "Align text to a specific column, by regexp."
130 (defcustom align-load-hook nil
131 "*Hook that gets run after the aligner has been loaded."
135 (defcustom align-indent-before-aligning nil
136 "*If non-nil, indent the marked region before aligning it."
140 (defcustom align-default-spacing
1
141 "*An integer that represents the default amount of padding to use.
142 If `align-to-tab-stop' is non-nil, this will represent the number of
143 tab stops to use for alignment, rather than the number of spaces.
144 Each alignment rule can optionally override both this variable. See
149 (defcustom align-to-tab-stop
'indent-tabs-mode
150 "*If non-nil, alignments will always fall on a tab boundary.
151 It may also be a symbol, whose value will be taken."
152 :type
'(choice (const nil
) symbol
)
155 (defcustom align-region-heuristic
500
156 "*If non-nil, used as a heuristic by `align-current'.
157 Since each alignment rule can possibly have its own set of alignment
158 sections (whenever `align-region-separate' is non-nil, and not a
159 string), this heuristic is used to determine how far before and after
160 point we should search in looking for a region separator. Larger
161 values can mean slower perform in large files, although smaller values
162 may cause unexpected behavior at times."
166 (defcustom align-highlight-change-face
'highlight
167 "*The face to highlight with if changes are necessary."
171 (defcustom align-highlight-nochange-face
'secondary-selection
172 "*The face to highlight with if no changes are necessary."
176 (defcustom align-large-region
10000
177 "*If an integer, defines what constitutes a \"large\" region.
178 If nil,then no messages will ever be printed to the minibuffer."
182 (defcustom align-c
++-modes
'(c++-mode c-mode java-mode
)
183 "*A list of modes whose syntax resembles C/C++."
184 :type
'(repeat symbol
)
187 (defcustom align-perl-modes
'(perl-mode cperl-mode
)
188 "*A list of modes where perl syntax is to be seen."
189 :type
'(repeat symbol
)
192 (defcustom align-lisp-modes
193 '(emacs-lisp-mode lisp-interaction-mode lisp-mode scheme-mode
)
194 "*A list of modes whose syntax resembles Lisp."
195 :type
'(repeat symbol
)
198 (defcustom align-tex-modes
199 '(tex-mode plain-tex-mode latex-mode slitex-mode
)
200 "*A list of modes whose syntax resembles TeX (and family)."
201 :type
'(repeat symbol
)
204 (defcustom align-text-modes
'(text-mode outline-mode
)
205 "*A list of modes whose content is plain text."
206 :type
'(repeat symbol
)
209 (defcustom align-dq-string-modes
210 (append align-lisp-modes align-c
++-modes align-perl-modes
212 "*A list of modes where double quoted strings should be excluded."
213 :type
'(repeat symbol
)
216 (defcustom align-sq-string-modes
217 (append align-perl-modes
'(python-mode))
218 "*A list of modes where single quoted strings should be excluded."
219 :type
'(repeat symbol
)
222 (defcustom align-open-comment-modes
223 (append align-lisp-modes align-c
++-modes align-perl-modes
224 '(python-mode makefile-mode
))
225 "*A list of modes with a single-line comment syntax.
226 These are comments as in Lisp, which have a beginning but, end with
227 the line (i.e., `comment-end' is an empty string)."
228 :type
'(repeat symbol
)
231 (defcustom align-region-separate
"^\\s-*[{}]?\\s-*$"
232 "*Select the method by which alignment sections will be separated.
233 If this is a symbol, that symbol's value will be used.
235 For the sake of clarification, consider the following example, which
236 will be referred to in the descriptions below.
238 int alpha = 1; /* one */
240 long gamma; /* ten */
242 unsigned int delta = 1; /* one */
243 long double epsilon = 3.0;
244 long long omega; /* ten */
246 The possible settings for `align-region-separate' are:
248 `entire' The entire region being aligned will be considered as a
249 single alignment section. Assuming that comments were not
250 being aligned to a particular column, the example would
253 int alpha = 1; /* one */
255 long gamma; /* ten */
257 unsigned int delta = 1; /* one */
259 long long chi = 10; /* ten */
261 `group' Each contiguous set of lines where a specific alignment
262 occurs is considered a section for that alignment rule.
263 Note that each rule will may have any entirely different
264 set of section divisions than another.
266 int alpha = 1; /* one */
268 long gamma; /* ten */
270 unsigned int delta = 1; /* one */
272 long long chi = 10; /* ten */
274 `largest' When contiguous rule sets overlap, the largest section
275 described will be taken as the alignment section for each
276 rule touched by that section.
278 int alpha = 1; /* one */
280 long gamma; /* ten */
282 unsigned int delta = 1; /* one */
284 long long chi = 10; /* ten */
286 NOTE: This option is not supported yet, due to algorithmic
287 issues which haven't been satisfactorily resolved. There
288 are ways to do it, but they're both ugly and resource
291 regexp A regular expression string which defines the section
292 divider. If the mode you're in has a consistent divider
293 between sections, the behavior will be very similar to
294 `largest', and faster. But if the mode does not use clear
295 separators (for example, if you collapse your braces onto
296 the preceding statement in C or perl), `largest' is
297 probably the better alternative.
299 function A function that will be passed the beginning and ending
300 locations of the region in which to look for the section
301 separator. At the very beginning of the attempt to align,
302 both of these parameters will be nil, in which case the
303 function should return non-nil if it wants each rule to
304 define its own section, or nil if it wants the largest
305 section found to be used as the common section for all rules
308 list A list of markers within the buffer that represent where
309 the section dividers lie. Be certain to use markers! For
310 when the aligning begins, the ensuing contract/expanding of
311 whitespace will throw off any non-marker positions.
313 This method is intended for use in Lisp programs, and not
316 (const :tag
"Entire region is one section" entire
)
317 (const :tag
"Align by contiguous groups" group
)
319 (regexp :tag
"Regexp defines section boundaries")
320 (function :tag
"Function defines section boundaries"))
323 (put 'align-region-separate
'risky-local-variable t
)
325 (defvar align-rules-list-type
328 :tag
"Alignment rule"
329 (symbol :tag
"Title")
330 (cons :tag
"Required attributes"
332 (const :tag
"(Regular expression to match)" regexp
)
333 (choice :value
"\\(\\s-+\\)" regexp function
))
335 :tag
"Optional attributes"
338 (const :tag
"(Repeat this rule throughout line)"
341 (cons :tag
"Paren group"
342 (const :tag
"(Parenthesis group to use)" group
)
344 integer
(repeat integer
)))
346 (const :tag
"(Modes where this rule applies)" modes
)
347 (sexp :value
(text-mode)))
348 (cons :tag
"Case-fold"
349 (const :tag
"(Should case be ignored for this rule)"
352 (cons :tag
"To Tab Stop"
353 (const :tag
"(Should rule align to tab stops)"
355 (boolean :value nil
))
357 (const :tag
"(Return non-nil if rule is valid)"
361 (const :tag
"(Return non-nil if rule should run)"
365 (const :tag
"(Column to fix alignment at)" column
)
366 (choice :value comment-column
369 (const :tag
"(Amount of spacing to use)" spacing
)
372 (const :tag
"(Should text be right justified)"
375 ;; make sure this stays up-to-date with any changes
376 ;; in `align-region-separate'
377 (cons :tag
"Separate"
378 (const :tag
"(Separation to use for this rule)"
380 (choice :value
"^\\s-*$"
384 regexp function
)))))))
385 "The `type' form for any `align-rules-list' variable.")
387 (defcustom align-rules-list
389 (regexp .
"\\(^\\s-+[^( \t\n]\\|(\\(\\S-+\\)\\s-+\\)\\S-+\\(\\s-+\\)")
391 (modes . align-lisp-modes
)
392 (run-if .
,(function (lambda () current-prefix-arg
))))
395 (regexp .
"\\(\\s-*\\)\\.\\(\\s-*\\)")
397 (modes . align-lisp-modes
))
401 (lambda (end reverse
)
402 (funcall (if reverse
're-search-backward
404 (concat "[^ \t\n\\\\]"
405 (regexp-quote comment-start
)
406 "\\(.+\\)$") end t
))))
407 (modes . align-open-comment-modes
))
410 (regexp .
"^\\s-*#\\s-*define\\s-+\\S-+\\(\\s-+\\)")
411 (modes . align-c
++-modes
))
413 (c-variable-declaration
414 (regexp .
,(concat "[*&0-9A-Za-z_]>?[&*]*\\(\\s-+[*&]*\\)"
415 "[A-Za-z_][0-9A-Za-z:_]*\\s-*\\(\\()\\|"
416 "=[^=\n].*\\|(.*)\\|\\(\\[.*\\]\\)*\\)?"
417 "\\s-*[;,]\\|)\\s-*$\\)"))
419 (modes . align-c
++-modes
)
424 (not (or (save-excursion
425 (goto-char (match-beginning 1))
428 "\\(goto\\|return\\|new\\|delete\\|throw\\)"))
429 (if (and (boundp 'font-lock-mode
) font-lock-mode
)
430 (eq (get-text-property (point) 'face
)
431 'font-lock-comment-face
)
432 (eq (caar (c-guess-basic-syntax)) 'c
))))))))
435 (regexp .
,(concat "[^-=!^&*+<>/| \t\n]\\(\\s-*[-=!^&*+<>/|]*\\)"
436 "=\\(\\s-*\\)\\([^= \t\n]\\|$\\)"))
438 (modes . align-c
++-modes
)
443 (regexp .
,(concat "[^=!^&*-+<>/| \t\n]\\(\\s-*\\)=[~>]?"
444 "\\(\\s-*\\)\\([^>= \t\n]\\|$\\)"))
446 (modes . align-perl-modes
)
450 (regexp .
,(concat "[^=!<> \t\n]\\(\\s-*\\)="
451 "\\(\\s-*\\)\\([^>= \t\n]\\|$\\)"))
453 (modes .
'(python-mode))
457 (regexp .
"^\\s-*\\w+\\(\\s-*\\):?=\\(\\s-*\\)\\([^\t\n \\\\]\\|$\\)")
459 (modes .
'(makefile-mode))
463 (regexp .
",\\(\\s-*\\)[^/ \t\n]")
465 (modes . align-c
++-modes
)
466 (run-if .
,(function (lambda () current-prefix-arg
))))
470 ; (memq (caar (c-guess-basic-syntax))
473 ; brace-entry-open))))))
475 ;; With a prefix argument, comma delimiter will be aligned. Since
476 ;; perl-mode doesn't give us enough syntactic information (and we
477 ;; don't do our own parsing yet), this rule is too destructive to
479 (basic-comma-delimiter
480 (regexp .
",\\(\\s-*\\)[^# \t\n]")
482 (modes .
(append align-perl-modes
'(python-mode)))
483 (run-if .
,(function (lambda () current-prefix-arg
))))
486 (regexp .
"\\(\\s-*\\)\\(//.*\\|/\\*.*\\*/\\s-*\\)$")
487 (modes . align-c
++-modes
)
488 (column . comment-column
)
492 (goto-char (match-beginning 1))
496 (regexp .
"\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
497 (modes . align-c
++-modes
)
501 (goto-char (match-end 2))
502 (looking-at "\\s-*\\(/[*/]\\|$\\)"))))))
505 (regexp .
"\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
506 (modes . align-perl-modes
)
510 (goto-char (match-end 2))
511 (looking-at "\\s-*\\(#\\|$\\)"))))))
514 (regexp .
"\\(\\s-*\\)\\(\\<and\\>\\|\\<or\\>\\)")
515 (modes .
'(python-mode))
519 (goto-char (match-end 2))
520 (looking-at "\\s-*\\(#\\|$\\|\\\\\\)"))))))
522 (c-macro-line-continuation
523 (regexp .
"\\(\\s-*\\)\\\\$")
524 (modes . align-c
++-modes
)
525 (column . c-backslash-column
))
529 ; (memq (caar (c-guess-basic-syntax))
530 ; '(cpp-macro cpp-macro-cont))))))
532 (basic-line-continuation
533 (regexp .
"\\(\\s-*\\)\\\\$")
534 (modes .
'(python-mode makefile-mode
)))
536 (tex-record-separator
538 (lambda (end reverse
)
539 (align-match-tex-pattern "&" end reverse
))))
541 (modes . align-tex-modes
)
544 (tex-tabbing-separator
546 (lambda (end reverse
)
547 (align-match-tex-pattern "\\\\[=>]" end reverse
))))
549 (modes . align-tex-modes
)
553 (eq major-mode
'latex-mode
)))))
556 (regexp .
"\\(\\s-*\\)\\\\\\\\")
557 (modes . align-tex-modes
))
559 ;; With a numeric prefix argument, or C-u, space delimited text
560 ;; tables will be aligned.
562 (regexp .
"\\(^\\|\\S-\\)\\([ \t]+\\)\\(\\S-\\|$\\)")
564 (modes . align-text-modes
)
568 (and current-prefix-arg
569 (not (eq '- current-prefix-arg
)))))))
571 ;; With a negative prefix argument, lists of dollar figures will
574 (regexp .
"\\$?\\(\\s-+[0-9]+\\)\\.")
575 (modes . align-text-modes
)
579 (eq '- current-prefix-arg
)))))
582 (regexp .
"^\\s-*\\w+:\\(\\s-*\\).*;")
584 (modes .
'(css-mode html-mode
))))
585 "*A list describing all of the available alignment rules.
589 (ATTRIBUTE . VALUE) ...)
592 The following attributes are meaningful:
594 `regexp' This required attribute must be either a string describing
595 a regular expression, or a function (described below).
596 For every line within the section that this regular
597 expression matches, the given rule will be applied to that
598 line. The exclusion rules denote which part(s) of the
599 line should not be modified; the alignment rules cause the
600 identified whitespace group to be contracted/expanded such
601 that the \"alignment character\" (the character
602 immediately following the identified parenthesis group),
603 occurs in the same column for every line within the
604 alignment section (see `align-region-separate' for a
605 description of how the region is broken up into alignment
608 The `regexp' attribute describes how the text should be
609 treated. Within this regexp, there must be at least one
610 group of characters (typically whitespace) identified by
611 the special opening and closing parens used in regexp
612 expressions (`\\\\(' and `\\\\)') (see the Emacs manual on
613 the syntax of regular expressions for more info).
615 If `regexp' is a function, it will be called as a
616 replacement for `re-search-forward'. This means that it
617 should return nil if nothing is found to match the rule,
618 or it should set the match data appropriately, move point
619 to the end of the match, and return the value of point.
621 `group' For exclusion rules, the group identifies the range of
622 characters that should be ignored. For alignment rules,
623 these are the characters that will be deleted/expanded for
624 the purposes of alignment. The \"alignment character\" is
625 always the first character immediately following this
626 parenthesis group. This attribute may also be a list of
627 integer, in which case multiple alignment characters will
628 be aligned, with the list of integer identifying the
629 whitespace groups which precede them. The default for
632 `modes' The `modes' attribute, if set, should name a list of
633 major modes -- or evaluate to such a value -- in which the
634 rule is valid. If not set, the rule will apply to all
637 `case-fold' If `regexp' is an ordinary regular expression string
638 containing alphabetic character, sometimes you may want
639 the search to proceed case-insensitively (for languages
640 that ignore case, such as pascal for example). In that
641 case, set `case-fold' to a non-nil value, and the regular
642 expression search will ignore case. If `regexp' is set to
643 a function, that function must handle the job of ignoring
646 `tab-stop' If the `tab-stop' attribute is set, and non-nil, the
647 alignment character will always fall on a tab stop
648 (whether it uses tabs to get there or not depends on the
649 value of `indent-tabs-mode'). If the `tab-stop' attribute
650 is set to nil, tab stops will never be used. Otherwise,
651 the value of `align-to-tab-stop' determines whether or not
652 to align to a tab stop. The `tab-stop' attribute may also
653 be a list of t or nil values, corresponding to the number
654 of parenthesis groups specified by the `group' attribute.
656 `repeat' If the `repeat' attribute is present, and non-nil, the
657 rule will be applied to the line continuously until no
658 further matches are found.
660 `valid' If the `valid' attribute is set, it will be used to
661 determine whether the rule should be invoked. This form
662 is evaluated after the regular expression match has been
663 performed, so that it is possible to use the results of
664 that match to determine whether the alignment should be
665 performed. The buffer should not be modified during the
666 evaluation of this form.
668 `run-if' Like `valid', the `run-if' attribute tests whether the
669 rule should be run at all -- even before any searches are
670 done to determine if the rule applies to the alignment
671 region. This can save time, since `run-if' will only be
672 run once for each rule. If it returns nil, the rule will
675 `column' For alignment rules, if the `column' attribute is set --
676 which must be an integer, or a symbol whose value is an
677 integer -- it will be used as the column in which to align
678 the alignment character. If the text on a particular line
679 happens to overrun that column, a single space character,
680 or tab stop (see `align-to-tab-stop') will be added
681 between the last text character and the alignment
684 `spacing' Alignment rules may also override the amount of spacing
685 that would normally be used by providing a `spacing'
686 attribute. This must be an integer, or a list of integers
687 corresponding to the number of parenthesis groups matched
688 by the `group' attribute. If a list of value is used, and
689 any of those values is nil, `align-default-spacing' will
690 be used for that subgroup. See `align-default-spacing'
691 for more details on spacing, tab stops, and how to
692 indicate how much spacing should be used. If TAB-STOP is
693 present, it will override the value of `align-to-tab-stop'
696 `justify' It is possible with `regexp' and `group' to identify a
697 character group that contains more than just whitespace
698 characters. By default, any non-whitespace characters in
699 that group will also be deleted while aligning the
700 alignment character. However, if the `justify' attribute
701 is set to a non-nil value, only the initial whitespace
702 characters within that group will be deleted. This has
703 the effect of right-justifying the characters that remain,
704 and can be used for outdenting or just plain old right-
707 `separate' Each rule can define its own section separator, which
708 describes how to identify the separation of \"sections\"
709 within the region to be aligned. Setting the `separate'
710 attribute overrides the value of `align-region-separate'
711 (see the documentation of that variable for possible
712 values), and any separation argument passed to `align'."
713 :type align-rules-list-type
716 (put 'align-rules-list
'risky-local-variable t
)
718 (defvar align-exclude-rules-list-type
721 :tag
"Exclusion rule"
722 (symbol :tag
"Title")
723 (cons :tag
"Required attributes"
725 (const :tag
"(Regular expression to match)" regexp
)
726 (choice :value
"\\(\\s-+\\)" regexp function
))
728 :tag
"Optional attributes"
731 (const :tag
"(Repeat this rule throughout line)"
734 (cons :tag
"Paren group"
735 (const :tag
"(Parenthesis group to use)" group
)
737 integer
(repeat integer
)))
739 (const :tag
"(Modes where this rule applies)" modes
)
740 (sexp :value
(text-mode)))
741 (cons :tag
"Case-fold"
742 (const :tag
"(Should case be ignored for this rule)"
744 (boolean :value t
)))))))
745 "The `type' form for any `align-exclude-rules-list' variable.")
747 (defcustom align-exclude-rules-list
749 (regexp .
"\"\\([^\"\n]+\\)\"")
751 (modes . align-dq-string-modes
))
754 (regexp .
"'\\([^'\n]+\\)'")
756 (modes . align-sq-string-modes
))
761 (lambda (end reverse
)
762 (funcall (if reverse
're-search-backward
764 (concat "[^ \t\n\\\\]"
765 (regexp-quote comment-start
)
766 "\\(.+\\)$") end t
))))
767 (modes . align-open-comment-modes
))
770 (regexp .
"/\\*\\(.+\\)\\*/")
772 (modes . align-c
++-modes
))
775 (regexp .
"(\\([^)\n]+\\))")
777 (modes . align-c
++-modes
))
780 (regexp .
"^\\s-*#\\s-*\\(if\\w*\\|endif\\)\\(.*\\)$")
782 (modes . align-c
++-modes
)))
783 "*A list describing text that should be excluded from alignment.
784 See the documentation for `align-rules-list' for more info."
785 :type align-exclude-rules-list-type
788 (put 'align-exclude-rules-list
'risky-local-variable t
)
790 ;;; Internal Variables:
792 (defvar align-mode-rules-list nil
793 "Alignment rules specific to the current major mode.
794 See the variable `align-rules-list' for more details.")
796 (make-variable-buffer-local 'align-mode-rules-list
)
798 (defvar align-mode-exclude-rules-list nil
799 "Alignment exclusion rules specific to the current major mode.
800 See the variable `align-exclude-rules-list' for more details.")
802 (make-variable-buffer-local 'align-mode-exclude-rules-list
)
804 (defvar align-highlight-overlays nil
805 "The current overlays highlighting the text matched by a rule.")
807 ;; Sample extension rule set, for vhdl-mode. This should properly be
808 ;; in vhdl-mode.el itself.
810 (defcustom align-vhdl-rules-list
812 (regexp .
"\\(signal\\|variable\\|constant\\)\\(\\s-+\\)\\S-")
816 (regexp .
"\\(others\\|[^ \t\n=<]\\)\\(\\s-*\\)=>\\(\\s-*\\)\\S-")
821 (not (string= (downcase (match-string 1))
825 (regexp .
"[^ \t\n:]\\(\\s-*\\):\\(\\s-*\\)[^=\n]")
829 (regexp .
":\\s-*\\(in\\|out\\|inout\\|buffer\\)\\(\\s-*\\)")
833 (regexp .
"[^ \t\n=<]\\(\\s-*\\)<=\\(\\s-*\\)\\S-")
837 (regexp .
"[^ \t\n:]\\(\\s-*\\):="))
840 (regexp .
"\\(\\s-+\\)use\\s-+entity")))
841 "*Alignment rules for `vhdl-mode'. See `align-rules-list' for more info."
842 :type align-rules-list-type
845 (put 'align-vhdl-rules-list
'risky-local-variable t
)
847 (defun align-set-vhdl-rules ()
848 "Setup the `align-mode-rules-list' variable for `vhdl-mode'."
849 (setq align-mode-rules-list align-vhdl-rules-list
))
851 (add-hook 'vhdl-mode-hook
'align-set-vhdl-rules
)
853 (add-to-list 'align-dq-string-modes
'vhdl-mode
)
854 (add-to-list 'align-open-comment-modes
'vhdl-mode
)
859 (defun align (beg end
&optional separate rules exclude-rules
)
860 "Attempt to align a region based on a set of alignment rules.
861 BEG and END mark the region. If BEG and END are specifically set to
862 nil (this can only be done programmatically), the beginning and end of
863 the current alignment section will be calculated based on the location
864 of point, and the value of `align-region-separate' (or possibly each
865 rule's `separate' attribute).
867 If SEPARATE is non-nil, it overrides the value of
868 `align-region-separate' for all rules, except those that have their
869 `separate' attribute set.
871 RULES and EXCLUDE-RULES, if either is non-nil, will replace the
872 default rule lists defined in `align-rules-list' and
873 `align-exclude-rules-list'. See `align-rules-list' for more details
874 on the format of these lists."
878 (if (and (symbolp align-region-separate
)
879 (boundp align-region-separate
))
880 (symbol-value align-region-separate
)
881 align-region-separate
)
883 (if (not (or ;(eq separator 'largest)
884 (and (functionp separator
)
885 (not (funcall separator nil nil
)))))
886 (align-region beg end separator
887 (or rules align-mode-rules-list align-rules-list
)
888 (or exclude-rules align-mode-exclude-rules-list
889 align-exclude-rules-list
))
890 (let ((sec-first end
)
892 (align-region beg end
894 align-mode-exclude-rules-list
895 align-exclude-rules-list
) nil
899 (when (and mode
(listp mode
))
900 (setq sec-first
(min sec-first b
)
901 sec-last
(max sec-last e
))))))
902 (if (< sec-first sec-last
)
903 (align-region sec-first sec-last
'entire
904 (or rules align-mode-rules-list align-rules-list
)
905 (or exclude-rules align-mode-exclude-rules-list
906 align-exclude-rules-list
)))))))
909 (defun align-regexp (beg end regexp
&optional group spacing repeat
)
910 "Align the current region using an ad-hoc rule read from the minibuffer.
911 BEG and END mark the limits of the region. This function will prompt
912 for the REGEXP to align with. If no prefix arg was specified, you
913 only need to supply the characters to be lined up and any preceding
914 whitespace is replaced. If a prefix arg was specified, the full
915 regexp with parenthesized whitespace should be supplied; it will also
916 prompt for which parenthesis GROUP within REGEXP to modify, the amount
917 of SPACING to use, and whether or not to REPEAT the rule throughout
918 the line. See `align-rules-list' for more information about these
921 For example, let's say you had a list of phone numbers, and wanted to
922 align them so that the opening parentheses would line up:
926 Mary-Anne (123) 456-7890
929 There is no predefined rule to handle this, but you could easily do it
930 using a REGEXP like \"(\". All you would have to do is to mark the
931 region, call `align-regexp' and type in that regular expression."
934 (list (region-beginning) (region-end))
935 (if current-prefix-arg
936 (list (read-string "Complex align using regexp: "
940 "Parenthesis group to modify (justify if negative): " "1"))
942 (read-string "Amount of spacing (or column if negative): "
943 (number-to-string align-default-spacing
)))
944 (y-or-n-p "Repeat throughout line? "))
945 (list (concat "\\(\\s-*\\)"
946 (read-string "Align regexp: "))
947 1 align-default-spacing nil
))))
949 (list (list nil
(cons 'regexp regexp
)
950 (cons 'group
(abs group
))
955 (cons 'spacing spacing
)
956 (cons 'column
(abs spacing
)))
957 (cons 'repeat repeat
)))))
958 (align-region beg end
'entire rule nil nil
)))
961 (defun align-entire (beg end
&optional rules exclude-rules
)
962 "Align the selected region as if it were one alignment section.
963 BEG and END mark the extent of the region. If RULES or EXCLUDE-RULES
964 is set to a list of rules (see `align-rules-list'), it can be used to
965 override the default alignment rules that would have been used to
968 (align beg end
'entire rules exclude-rules
))
971 (defun align-current (&optional rules exclude-rules
)
972 "Call `align' on the current alignment section.
973 This function assumes you want to align only the current section, and
974 so saves you from having to specify the region. If RULES or
975 EXCLUDE-RULES is set to a list of rules (see `align-rules-list'), it
976 can be used to override the default alignment rules that would have
977 been used to align that section."
979 (align nil nil nil rules exclude-rules
))
982 (defun align-highlight-rule (beg end title
&optional rules exclude-rules
)
983 "Highlight the whitespace which a given rule would have modified.
984 BEG and END mark the extent of the region. TITLE identifies the rule
985 that should be highlighted. If RULES or EXCLUDE-RULES is set to a
986 list of rules (see `align-rules-list'), it can be used to override the
987 default alignment rules that would have been used to identify the text
990 (list (region-beginning) (region-end)
992 "Title of rule to highlight: "
996 (list (symbol-name (car rule
)))))
997 (append (or align-mode-rules-list align-rules-list
)
998 (or align-mode-exclude-rules-list
999 align-exclude-rules-list
))) nil t
)))
1000 (let ((ex-rule (assq (intern title
)
1001 (or align-mode-exclude-rules-list
1002 align-exclude-rules-list
)))
1004 (align-unhighlight-rule)
1007 (or rules
(if ex-rule
1008 (or exclude-rules align-mode-exclude-rules-list
1009 align-exclude-rules-list
)
1010 (or align-mode-rules-list align-rules-list
)))
1011 (unless ex-rule
(or exclude-rules align-mode-exclude-rules-list
1012 align-exclude-rules-list
))
1015 (if (and mode
(listp mode
))
1016 (if (equal (symbol-name (car mode
)) title
)
1017 (setq face
(cons align-highlight-change-face
1018 align-highlight-nochange-face
))
1021 (let ((overlay (make-overlay b e
)))
1022 (setq align-highlight-overlays
1023 (cons overlay align-highlight-overlays
))
1024 (overlay-put overlay
'face
1027 (cdr face
)))))))))))
1030 (defun align-unhighlight-rule ()
1031 "Remove any highlighting that was added by `align-highlight-rule'."
1033 (while align-highlight-overlays
1034 (delete-overlay (car align-highlight-overlays
))
1035 (setq align-highlight-overlays
1036 (cdr align-highlight-overlays
))))
1039 (defun align-newline-and-indent ()
1040 "A replacement function for `newline-and-indent', aligning as it goes."
1042 (let ((separate (or (if (and (symbolp align-region-separate
)
1043 (boundp align-region-separate
))
1044 (symbol-value align-region-separate
)
1045 align-region-separate
)
1048 (call-interactively 'newline-and-indent
)
1051 (while (not (or (bobp)
1052 (align-new-section-p (point) end separate
)))
1054 (align (point) end
))))
1056 ;;; Internal Functions:
1058 (defun align-match-tex-pattern (regexp end
&optional reverse
)
1059 "Match REGEXP in TeX mode, counting backslashes appropriately.
1060 END denotes the end of the region to be searched, while REVERSE, if
1061 non-nil, indicates that the search should proceed backward from the
1067 (if reverse
're-search-backward
1069 (concat "\\(\\s-*\\)" regexp
1070 "\\(\\s-*\\)") end t
))
1071 (let ((pos (match-end 1))
1073 (while (and (> pos
(point-min))
1074 (eq (char-before pos
) ?
\\))
1075 (setq count
(1+ count
) pos
(1- pos
)))
1076 (eq (mod count
2) 1))
1077 (goto-char (match-beginning 2))))
1080 (defun align-new-section-p (beg end separator
)
1081 "Is there a section divider between BEG and END?
1082 SEPARATOR specifies how to look for the section divider. See the
1083 documentation for `align-region-separate' for more details."
1084 (cond ((or (not separator
)
1085 (eq separator
'entire
))
1087 ((eq separator
'group
)
1093 (> (count-lines beg end
) amount
)))
1094 ((stringp separator
)
1097 (re-search-forward separator end t
)))
1098 ((functionp separator
)
1099 (funcall separator beg end
))
1101 (let ((seps separator
) yes
)
1103 (if (and (>= (car seps
) beg
)
1104 (<= (car seps
) end
))
1105 (setq yes t seps nil
)
1106 (setq seps
(cdr seps
))))
1109 (defun align-adjust-col-for-rule (column rule spacing tab-stop
)
1110 "Adjust COLUMN according to the given RULE.
1111 SPACING specifies how much spacing to use.
1112 TAB-STOP specifies whether SPACING refers to tab-stop boundaries."
1114 (setq spacing align-default-spacing
))
1119 (let ((stops tab-stop-list
))
1121 (if (and (> (car stops
) column
)
1122 (= (setq spacing
(1- spacing
)) 0))
1123 (setq column
(car stops
)
1125 (setq stops
(cdr stops
)))))
1128 (defsubst align-column
(pos)
1129 "Given a position in the buffer, state what column it's in.
1130 POS is the position whose column will be taken. Note that this
1131 function will change the location of point."
1135 (defsubst align-regions
(regions props rule func
)
1136 "Align the regions specified in REGIONS, a list of cons cells.
1137 PROPS describes formatting features specific to the given regions.
1138 RULE specifies exactly how to perform the alignments.
1139 If FUNC is specified, it will be called with each region that would
1140 have been aligned, rather than modifying the text."
1143 (align-areas (car regions
) (car props
) rule func
))
1144 (setq regions
(cdr regions
)
1145 props
(cdr props
))))
1147 (defun align-areas (areas props rule func
)
1148 "Given a list of AREAS and formatting PROPS, align according to RULE.
1149 AREAS should be a list of cons cells containing beginning and ending
1150 markers. This function sweeps through all of the beginning markers,
1151 finds out which one starts in the furthermost column, and then deletes
1152 and inserts text such that all of the ending markers occur in the same
1155 If FUNC is non-nil, it will be called for each text region that would
1156 have been aligned. No changes will be made to the buffer."
1157 (let* ((column (cdr (assq 'column rule
)))
1158 (fixed (if (symbolp column
)
1159 (symbol-value column
)
1161 (justify (cdr (assq 'justify rule
)))
1166 ;; Determine the alignment column.
1170 (setq col
(max col
(align-column (caar a
)))))
1172 (goto-char (cdar a
))
1174 (if (/= ecol
(current-column))
1176 (setq ecol
(current-column))))
1178 (goto-char (caar a
))
1179 (if (and (re-search-forward "\\s-*" (cdar a
) t
)
1180 (/= (point) (cdar a
)))
1181 (let ((bcol (current-column)))
1182 (setcdr (car a
) (cons (point-marker) (cdar a
)))
1183 (goto-char (cdr (cdar a
)))
1184 (setq width
(max width
(- (current-column) bcol
))))))
1188 (setq col
(+ (align-adjust-col-for-rule
1189 col rule
(car props
) (cdr props
)) width
)))
1191 ;; Make all ending positions to occur in the goal column. Since
1192 ;; the whitespace to be modified was already deleted by
1193 ;; `align-region', all we have to do here is indent.
1196 (setq change
(and ecol
(/= col ecol
))))
1198 (when (or func change
)
1200 (let ((area (car areas
))
1204 (funcall func
(car area
) (cdr area
) change
)
1205 (if (not (and justify
1206 (consp (cdr area
))))
1207 (goto-char (cdr area
))
1208 (goto-char (cddr area
))
1209 (let ((ecol (current-column)))
1210 (goto-char (cadr area
))
1211 (setq gocol
(- col
(- ecol
(current-column))))))
1212 (setq cur
(current-column))
1213 (cond ((< gocol
0) t
) ; don't do anything
1214 ((= cur gocol
) t
) ; don't need to
1215 ((< cur gocol
) ; just add space
1216 ;; FIXME: It is stated above that "...the
1217 ;; whitespace to be modified was already
1218 ;; deleted by `align-region', all we have
1219 ;; to do here is indent." However, this
1220 ;; doesn't seem to be true, so we first
1221 ;; delete the whitespace to avoid tabs
1223 (delete-horizontal-space t
)
1226 ;; This code works around an oddity in the
1227 ;; FORCE argument of `move-to-column', which
1228 ;; tends to screw up markers if there is any
1230 (let ((endcol (align-column
1236 (align-column (car area
)))))
1238 (goto-char (car area
))
1239 (move-to-column gocol t
))
1240 (let ((here (point)))
1241 (move-to-column endcol t
)
1242 (delete-region here
(point))
1244 (indent-to (align-adjust-col-for-rule
1245 (current-column) rule
1246 (car props
) (cdr props
)))))))))))
1247 (setq areas
(cdr areas
))))))
1249 (defun align-region (beg end separate rules exclude-rules
1251 "Align a region based on a given set of alignment rules.
1252 BEG and END specify the region to be aligned. Either may be nil, in
1253 which case the range will stop at the nearest section division (see
1254 `align-region-separate', and `align-region-heuristic' for more
1257 The region will be divided into separate alignment sections based on
1258 the value of SEPARATE.
1260 RULES and EXCLUDE-RULES are a pair of lists describing how to align
1261 the region, and which text areas within it should be excluded from
1262 alignment. See the `align-rules-list' for more information on the
1263 required format of these two lists.
1265 If FUNC is specified, no text will be modified. What `align-region'
1266 will do with the rules is to search for the alignment areas, as it
1267 regularly would, taking account for exclusions, and then call FUNC,
1268 first with the beginning and ending of the region to be aligned
1269 according to that rule (this can be different for each rule, if BEG
1270 and END were nil), and then with the beginning and ending of each
1271 text region that the rule would have applied to.
1273 The signature of FUNC should thus be:
1275 (defun my-align-function (beg end mode)
1276 \"If MODE is a rule (a list), return t if BEG to END are to be searched.
1277 Otherwise BEG to END will be a region of text that matches the rule's
1278 definition, and MODE will be non-nil if any changes are necessary.\"
1279 (unless (and mode (listp mode))
1280 (message \"Would have aligned from %d to %d...\" beg end)))
1282 This feature (of passing a FUNC) is used internally to locate the
1283 position of exclusion areas, but could also be used for any other
1284 purpose where you might want to know where the regions that the
1285 aligner would have dealt with are."
1286 (let ((end-mark (and end
(copy-marker end t
)))
1289 (report (and (not func
) align-large-region beg end
1290 (>= (- end beg
) align-large-region
)))
1292 (rule-count (length rules
)))
1293 (if (and align-indent-before-aligning real-beg end-mark
)
1294 (indent-region real-beg end-mark nil
))
1296 (let* ((rule (car rules
))
1297 (run-if (assq 'run-if rule
))
1298 (modes (assq 'modes rule
)))
1299 ;; unless the `run-if' form tells us not to, look for the
1301 (unless (or (and modes
(not (memq major-mode
1302 (eval (cdr modes
)))))
1303 (and run-if
(not (funcall (cdr run-if
)))))
1304 (let* ((current-case-fold case-fold-search
)
1305 (case-fold (assq 'case-fold rule
))
1306 (regexp (cdr (assq 'regexp rule
)))
1307 (regfunc (and (functionp regexp
) regexp
))
1308 (rulesep (assq 'separate rule
))
1309 (thissep (if rulesep
(cdr rulesep
) separate
))
1323 ;; if beg and end were not given, figure out what the
1324 ;; current alignment region should be. Depending on the
1325 ;; value of `align-region-separate' it's possible for
1326 ;; each rule to have its own definition of what that
1327 ;; current alignment section is.
1330 (if (or (not thissep
) (eq thissep
'entire
))
1331 (error "Cannot determine alignment region for '%s'"
1332 (symbol-name (cdr (assq 'title rule
)))))
1334 (while (and (not (eobp))
1335 (looking-at "^\\s-*$"))
1337 (let* ((here (point))
1341 (and align-region-heuristic
1343 align-region-heuristic
))))
1345 (funcall regfunc terminus t
)
1346 (re-search-backward regexp
1348 (if (align-new-section-p (point) here thissep
)
1351 (setq here
(point))))
1360 (and align-region-heuristic
1362 align-region-heuristic
))))
1364 (funcall regfunc terminus nil
)
1365 (re-search-forward regexp terminus t
))))
1366 (if (align-new-section-p here
(point) thissep
)
1369 (setq here
(point))))
1374 end-mark
(copy-marker end t
))
1377 ;; If we have a region to align, and `func' is set and
1378 ;; reports back that the region is ok, then align it.
1379 (when (or (not func
)
1380 (funcall func beg end rule
))
1382 (let (exclude-areas)
1383 ;; determine first of all where the exclusions
1384 ;; lie in this region
1386 ;; guard against a problem with recursion and
1387 ;; dynamic binding vs. lexical binding, since
1388 ;; the call to `align-region' below will
1389 ;; re-enter this function, and rebind
1391 (set (setq exclude-areas
1392 (make-symbol "align-exclude-areas"))
1398 (or (and mode
(listp mode
))
1399 (set (quote ,exclude-areas
)
1403 (sort (symbol-value exclude-areas
)
1406 (>= (car l
) (car r
)))))))
1408 ;; set `case-fold-search' according to the
1409 ;; (optional) `case-fold' property
1411 (setq case-fold-search
(cdr case-fold
)))
1413 ;; while we can find the rule in the alignment
1415 (while (and (< (point) end-mark
)
1417 (funcall regfunc end-mark nil
)
1418 (re-search-forward regexp
1421 ;; give the user some indication of where we
1422 ;; are, if it's a very large region being
1425 (let ((symbol (car rule
)))
1426 (if (and symbol
(symbolp symbol
))
1428 "Aligning `%s' (rule %d of %d) %d%%..."
1429 (symbol-name symbol
) rule-index rule-count
1430 (/ (* (- (point) real-beg
) 100)
1431 (- end-mark real-beg
)))
1434 (/ (* (- (point) real-beg
) 100)
1435 (- end-mark real-beg
))))))
1437 ;; if the search ended us on the beginning of
1438 ;; the next line, move back to the end of the
1443 ;; lookup the `group' attribute the first time
1446 (setq group
(or (cdr (assq 'group rule
)) 1))
1448 (setq first
(car group
))
1449 (setq first group group
(list group
)))
1453 (setq spacing
(cdr (assq 'spacing rule
))
1458 (let ((rule-ts (assq 'tab-stop rule
)))
1461 (if (symbolp align-to-tab-stop
)
1462 (symbol-value align-to-tab-stop
)
1463 align-to-tab-stop
)))
1466 ;; test whether we have found a match on the same
1467 ;; line as a previous match
1474 ;; lookup the `repeat' attribute the first time
1476 (setq repeat
(cdr (assq 'repeat rule
))
1479 ;; lookup the `valid' attribute the first time
1481 (setq valid
(assq 'valid rule
)
1484 ;; remember the beginning position of this rule
1485 ;; match, and save the match-data, since either
1486 ;; the `valid' form, or the code that searches for
1487 ;; section separation, might alter it
1488 (setq b
(match-beginning first
)
1489 save-match-data
(match-data))
1491 ;; unless the `valid' attribute is set, and tells
1492 ;; us that the rule is not valid at this point in
1494 (unless (and valid
(not (funcall (cdr valid
))))
1496 ;; look to see if this match begins a new
1497 ;; section. If so, we should align what we've
1498 ;; collected so far, and then begin collecting
1499 ;; anew for the next alignment section
1501 (align-new-section-p last-point b
1504 (align-regions regions align-props
1506 (setq last-point
(copy-marker b t
)
1509 (setq last-point
(copy-marker b t
)))
1511 ;; restore the match data
1512 (set-match-data save-match-data
)
1514 ;; check whether the region to be aligned
1515 ;; straddles an exclusion area
1516 (let ((excls exclude-areas
))
1517 (setq exclude-p nil
)
1519 (if (and (< (match-beginning (car group
))
1521 (> (match-end (car (last group
)))
1525 (setq excls
(cdr excls
)))))
1527 ;; go through the list of parenthesis groups
1528 ;; matching whitespace text to be
1529 ;; contracted/expanded (or possibly
1530 ;; justified, if the `justify' attribute was
1536 ;; we have to use markers, since
1537 ;; `align-areas' may modify the buffer
1538 (setq b
(copy-marker
1539 (match-beginning (car g
)) t
)
1540 e
(copy-marker (match-end (car g
)) t
))
1542 ;; record this text region for alignment
1543 (setq index
(if same
(1+ index
) 0))
1544 (let ((region (cons b e
))
1549 (if (listp tab-stop
)
1552 (if (nth index regions
)
1553 (setcar (nthcdr index regions
)
1555 (nth index regions
)))
1559 (list (list region
)))
1560 (nconc align-props
(list props
)))
1562 (list (list region
)))
1563 (setq align-props
(list props
)))))
1565 ;; if any further rule matches are
1566 ;; found before `eol', then they are
1567 ;; on the same line as this one; this
1568 ;; can only happen if the `repeat'
1569 ;; attribute is non-nil
1571 (setq spacing
(cdr spacing
)))
1572 (if (listp tab-stop
)
1573 (setq tab-stop
(cdr tab-stop
)))
1574 (setq same t g
(cdr g
))))
1576 ;; if `repeat' has not been set, move to
1577 ;; the next line; don't bother searching
1578 ;; anymore on this one
1579 (if (and (not repeat
) (not (bolp)))
1582 ;; when they are no more matches for this rule,
1583 ;; align whatever was left over
1585 (align-regions regions align-props rule func
)))
1587 (setq case-fold-search current-case-fold
)))))))
1588 (setq rules
(cdr rules
)
1589 rule-index
(1+ rule-index
)))
1592 (message "Aligning...done"))))
1598 (run-hooks 'align-load-hook
)
1600 ;;; arch-tag: ef79cccf-1db8-4888-a8a1-d7ce2d1532f7
1601 ;;; align.el ends here