1 ;;; align --- align text to a specific column, by regexp
3 ;; Copyright (C) 1999, 2000 Free Sofware Foundation
5 ;; Author: John Wiegley <johnw@gnu.org>
6 ;; Keywords: convenience languages lisp
7 ;; X-URL: http://www.emacs.org/~johnw/emacs.html
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., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, 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."
129 (defcustom align-load-hook nil
130 "*Hook that gets run after the aligner has been loaded."
134 (defcustom align-indent-before-aligning nil
135 "*If non-nil, indent the marked region before aligning it."
139 (defcustom align-default-spacing
1
140 "*An integer that represents the default amount of padding to use.
141 If `align-to-tab-stop' is non-nil, this will represent the number of
142 tab stops to use for alignment, rather than the number of spaces.
143 Each alignment rule can optionally override both this variable. See
148 (defcustom align-to-tab-stop
'indent-tabs-mode
149 "*If non-nil, alignments will always fall on a tab boundary.
150 It may also be a symbol, whose value will be taken."
151 :type
'(choice (const nil
) symbol
)
154 (defcustom align-region-heuristic
500
155 "*If non-nil, used as a heuristic by `align-current'.
156 Since each alignment rule can possibly have its own set of alignment
157 sections (whenever `align-region-separate' is non-nil, and not a
158 string), this heuristic is used to determine how far before and after
159 point we should search in looking for a region separator. Larger
160 values can mean slower perform in large files, although smaller values
161 may cause unexpected behavior at times."
165 (defcustom align-highlight-change-face
'highlight
166 "*The face to highlight with if changes are necessary."
170 (defcustom align-highlight-nochange-face
'secondary-selection
171 "*The face to highlight with if no changes are necessary."
175 (defcustom align-large-region
10000
176 "*If an integer, defines what constitutes a \"large\" region.
177 If nil,then no messages will ever be printed to the minibuffer."
181 (defcustom align-c
++-modes
'(c++-mode c-mode java-mode
)
182 "*A list of modes whose syntax resembles C/C++."
183 :type
'(repeat symbol
)
186 (defcustom align-perl-modes
'(perl-mode cperl-mode
)
187 "*A list of modes where perl syntax is to be seen."
188 :type
'(repeat symbol
)
191 (defcustom align-lisp-modes
192 '(emacs-lisp-mode lisp-interaction-mode lisp-mode scheme-mode
)
193 "*A list of modes whose syntax resembles Lisp."
194 :type
'(repeat symbol
)
197 (defcustom align-tex-modes
198 '(tex-mode plain-tex-mode latex-mode slitex-mode
)
199 "*A list of modes whose syntax resembles TeX (and family)."
200 :type
'(repeat symbol
)
203 (defcustom align-text-modes
'(text-mode outline-mode
)
204 "*A list of modes whose content is plain text."
205 :type
'(repeat symbol
)
208 (defcustom align-dq-string-modes
(append align-lisp-modes
211 "*A list of modes where double quoted strings should be excluded."
212 :type
'(repeat symbol
)
215 (defcustom align-sq-string-modes align-perl-modes
216 "*A list of modes where single quoted strings should be excluded."
217 :type
'(repeat symbol
)
220 (defcustom align-open-comment-modes
(append align-lisp-modes
224 "*A list of modes with a single-line comment syntax.
225 These are comments as in Lisp, which have a beginning but, end with
226 the line (i.e., `comment-end' is an empty string)."
227 :type
'(repeat symbol
)
230 (defcustom align-region-separate
"^\\s-*[{}]?\\s-*$"
231 "*Select the method by which alignment sections will be separated.
232 If this is a symbol, that symbol's value will be used.
234 For the sake of clarification, consider the following example, which
235 will be referred to in the descriptions below.
237 int alpha = 1; /* one */
239 long gamma; /* ten */
241 unsigned int delta = 1; /* one */
242 long double epsilon = 3.0;
243 long long omega; /* ten */
245 The possible settings for `align-region-separate' are:
247 `entire' The entire region being aligned will be considered as a
248 single alignment section. Assuming that comments were not
249 being aligned to a particular column, the example would
252 int alpha = 1; /* one */
254 long gamma; /* ten */
256 unsigned int delta = 1; /* one */
258 long long chi = 10; /* ten */
260 `group' Each contiguous set of lines where a specific alignment
261 occurs is considered a section for that alignment rule.
262 Note that each rule will may have any entirely different
263 set of section divisions than another.
265 int alpha = 1; /* one */
267 long gamma; /* ten */
269 unsigned int delta = 1; /* one */
271 long long chi = 10; /* ten */
273 `largest' When contiguous rule sets overlap, the largest section
274 described will be taken as the alignment section for each
275 rule touched by that section.
277 int alpha = 1; /* one */
279 long gamma; /* ten */
281 unsigned int delta = 1; /* one */
283 long long chi = 10; /* ten */
285 NOTE: This option is not supported yet, due to algorithmic
286 issues which haven't been satisfactorily resolved. There
287 are ways to do it, but they're both ugly and resource
290 regexp A regular expression string which defines the section
291 divider. If the mode you're in has a consistent divider
292 between sections, the behavior will be very similar to
293 `largest', and faster. But if the mode does not use clear
294 separators (for example, if you collapse your braces onto
295 the preceding statement in C or perl), `largest' is
296 probably the better alternative.
298 function A function that will be passed the beginning and ending
299 locations of the region in which to look for the section
300 separator. At the very beginning of the attempt to align,
301 both of these parameters will be nil, in which case the
302 function should return non-nil if it wants each rule to
303 define its own section, or nil if it wants the largest
304 section found to be used as the common section for all rules
307 list A list of markers within the buffer that represent where
308 the section dividers lie. Be certain to use markers! For
309 when the aligning begins, the ensuing contract/expanding of
310 whitespace will throw off any non-marker positions.
312 This method is intended for use in Lisp programs, and not
315 (const :tag
"Entire region is one section" entire
)
316 (const :tag
"Align by contiguous groups" group
)
318 (regexp :tag
"Regexp defines section boundaries")
319 (function :tag
"Function defines section boundaries"))
322 (put 'align-region-separate
'risky-local-variable t
)
324 (defvar align-rules-list-type
327 :tag
"Alignment rule"
328 (symbol :tag
"Title")
329 (cons :tag
"Required attributes"
331 (const :tag
"(Regular expression to match)" regexp
)
332 (choice :value
"\\(\\s-+\\)" regexp function
))
334 :tag
"Optional attributes"
337 (const :tag
"(Repeat this rule throughout line)"
340 (cons :tag
"Paren group"
341 (const :tag
"(Parenthesis group to use)" group
)
343 integer
(repeat integer
)))
345 (const :tag
"(Modes where this rule applies)" modes
)
346 (sexp :value
(text-mode)))
347 (cons :tag
"Case-fold"
348 (const :tag
"(Should case be ignored for this rule)"
351 (cons :tag
"To Tab Stop"
352 (const :tag
"(Should rule align to tab stops)"
354 (boolean :value nil
))
356 (const :tag
"(Return non-nil if rule is valid)"
360 (const :tag
"(Return non-nil if rule should run)"
364 (const :tag
"(Column to fix alignment at)" column
)
365 (choice :value comment-column
368 (const :tag
"(Amount of spacing to use)" spacing
)
371 (const :tag
"(Should text be right justified)"
374 ;; make sure this stays up-to-date with any changes
375 ;; in `align-region-separate'
376 (cons :tag
"Separate"
377 (const :tag
"(Separation to use for this rule)"
379 (choice :value
"^\\s-*$"
383 regexp function
)))))))
384 "The `type' form for any `align-rules-list' variable.")
386 (unless (functionp 'c-guess-basic-syntax
)
387 (autoload 'c-guess-basic-syntax
"cc-engine"))
389 (defcustom align-rules-list
391 (regexp .
"\\(^\\s-+[^( \t\n]\\|(\\(\\S-+\\)\\s-+\\)\\S-+\\(\\s-+\\)")
393 (modes . align-lisp-modes
)
394 (run-if .
,(function (lambda () current-prefix-arg
))))
397 (regexp .
"\\(\\s-*\\)\\.\\(\\s-*\\)")
399 (modes . align-lisp-modes
))
403 (lambda (end reverse
)
404 (funcall (if reverse
're-search-backward
406 (concat "[^ \t\n\\\\]"
407 (regexp-quote comment-start
)
408 "\\(.+\\)$") end t
))))
409 (modes . align-open-comment-modes
))
412 (regexp .
"^\\s-*#\\s-*define\\s-+\\S-+\\(\\s-+\\)")
413 (modes . align-c
++-modes
))
415 (c-variable-declaration
416 (regexp .
,(concat "[*&0-9A-Za-z_]>?[&*]*\\(\\s-+[*&]*\\)"
417 "[A-Za-z_][0-9A-Za-z:_]*\\s-*\\(\\()\\|"
418 "=[^=\n].*\\|(.*)\\|\\(\\[.*\\]\\)*\\)?"
419 "\\s-*[;,]\\|)\\s-*$\\)"))
421 (modes . align-c
++-modes
)
426 (not (or (save-excursion
427 (goto-char (match-beginning 1))
430 "\\(goto\\|return\\|new\\|delete\\|throw\\)"))
431 (if (and (boundp 'font-lock-mode
) font-lock-mode
)
432 (eq (cadr (memq 'face
(text-properties-at (point))))
433 'font-lock-comment-face
)
434 (eq (caar (c-guess-basic-syntax)) 'c
))))))))
437 (regexp .
,(concat "[^-=!^&*+<>/| \t\n]\\(\\s-*[-=!^&*+<>/|]*\\)"
438 "=\\(\\s-*\\)\\([^= \t\n]\\|$\\)"))
440 (modes . align-c
++-modes
)
445 (regexp .
,(concat "[^=!^&*-+<>/| \t\n]\\(\\s-*\\)=[~>]?"
446 "\\(\\s-*\\)\\([^>= \t\n]\\|$\\)"))
448 (modes . align-perl-modes
)
452 (regexp .
"^\\s-*\\w+\\(\\s-*\\):?=\\(\\s-*\\)\\([^\t\n \\\\]\\|$\\)")
454 (modes .
'(makefile-mode))
458 (regexp .
",\\(\\s-*\\)[^/ \t\n]")
460 (modes . align-c
++-modes
)
461 (run-if .
,(function (lambda () current-prefix-arg
))))
465 ; (memq (caar (c-guess-basic-syntax))
468 ; brace-entry-open))))))
470 ;; With a prefix argument, comma delimiter will be aligned. Since
471 ;; perl-mode doesn't give us enough syntactic information (and we
472 ;; don't do our own parsing yet), this rule is too destructive to
474 (perl-comma-delimiter
475 (regexp .
",\\(\\s-*\\)[^# \t\n]")
477 (modes . align-perl-modes
)
478 (run-if .
,(function (lambda () current-prefix-arg
))))
481 (regexp .
"\\(\\s-*\\)\\(//.*\\|/\\*.*\\*/\\s-*\\)$")
482 (modes . align-c
++-modes
)
483 (column . comment-column
)
487 (goto-char (match-beginning 1))
490 (c-macro-line-continuation
491 (regexp .
"\\(\\s-*\\)\\\\$")
492 (modes .
(append align-c
++-modes
'(makefile-mode)))
493 (column . c-backslash-column
))
497 ; (memq (caar (c-guess-basic-syntax))
498 ; '(cpp-macro cpp-macro-cont))))))
501 (regexp .
"\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
502 (modes . align-c
++-modes
)
506 (goto-char (match-end 2))
507 (looking-at "\\s-*\\(/[*/]\\|$\\)"))))))
510 (regexp .
"\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
511 (modes . align-perl-modes
)
515 (goto-char (match-end 2))
516 (looking-at "\\s-*\\(#\\|$\\)"))))))
518 (tex-record-separator
520 (lambda (end reverse
)
521 (align-match-tex-pattern "&" end reverse
))))
523 (modes . align-tex-modes
)
526 (tex-tabbing-separator
528 (lambda (end reverse
)
529 (align-match-tex-pattern "\\\\[=>]" end reverse
))))
531 (modes . align-tex-modes
)
535 (eq major-mode
'latex-mode
)))))
538 (regexp .
"\\(\\s-*\\)\\\\\\\\")
539 (modes . align-tex-modes
))
541 ;; With a numeric prefix argument, or C-u, space delimited text
542 ;; tables will be aligned.
544 (regexp .
"\\(^\\|\\S-\\)\\(\\s-+\\)\\(\\S-\\|$\\)")
546 (modes . align-text-modes
)
550 (and current-prefix-arg
551 (not (eq '- current-prefix-arg
)))))))
553 ;; With a negative prefix argument, lists of dollar figures will
556 (regexp .
"\\$?\\(\\s-+[0-9]+\\)\\.")
557 (modes . align-text-modes
)
561 (eq '- current-prefix-arg
))))))
562 "*An list describing all of the available alignment rules.
566 (ATTRIBUTE . VALUE) ...)
569 The following attributes are meaningful:
571 `regexp' This required attribute must be either a string describing
572 a regular expression, or a function (described below).
573 For every line within the section that this regular
574 expression matches, the given rule will be applied to that
575 line. The exclusion rules denote which part(s) of the
576 line should not be modified; the alignment rules cause the
577 identified whitespace group to be contracted/expanded such
578 that the \"alignment character\" (the character
579 immediately following the identified parenthesis group),
580 occurs in the same column for every line within the
581 alignment section (see `align-region-separate' for a
582 description of how the region is broken up into alignment
585 The `regexp' attribute describes how the text should be
586 treated. Within this regexp, there must be at least one
587 group of characters (typically whitespace) identified by
588 the special opening and closing parens used in regexp
589 expressions (`\\\\(' and `\\\\)') (see the Emacs manual on
590 the syntax of regular expressions for more info).
592 If `regexp' is a function, it will be called as a
593 replacement for `re-search-forward'. This means that it
594 should return nil if nothing is found to match the rule,
595 or it should set the match data appropriately, move point
596 to the end of the match, and return the value of point.
598 `group' For exclusion rules, the group identifies the range of
599 characters that should be ignored. For alignment rules,
600 these are the characters that will be deleted/expanded for
601 the purposes of alignment. The \"alignment character\" is
602 always the first character immediately following this
603 parenthesis group. This attribute may also be a list of
604 integer, in which case multiple alignment characters will
605 be aligned, with the list of integer identifying the
606 whitespace groups which precede them. The default for
609 `modes' The `modes' attribute, if set, should name a list of
610 major modes -- or evaluate to such a value -- in which the
611 rule is valid. If not set, the rule will apply to all
614 `case-fold' If `regexp' is an ordinary regular expression string
615 containing alphabetic character, sometimes you may want
616 the search to proceed case-insensitively (for languages
617 that ignore case, such as pascal for example). In that
618 case, set `case-fold' to nil, and the regular expression
619 search will ignore case. If `regexp' is set to a
620 function, that function must handle the job of ignoring
623 `tab-stop' If the `tab-stop' attribute is set, and non-nil, the
624 alignment character will always fall on a tab stop
625 (whether it uses tabs to get there or not depends on the
626 value of `indent-tabs-mode'). If the `tab-stop' attribute
627 is set to nil, tab stops will never be used. Otherwise,
628 the value of `align-to-tab-stop' determines whether or not
629 to align to a tab stop. The `tab-stop' attribute may also
630 be a list of t or nil values, corresponding to the number
631 of parenthesis groups specified by the `group' attribute.
633 `repeat' If the `repeat' attribute is present, and non-nil, the
634 rule will be applied to the line continuously until no
635 further matches are found.
637 `valid' If the `valid' attribute is set, it will be used to
638 determine whether the rule should be invoked. This form
639 is evaluated after the regular expression match has been
640 performed, so that it is possible to use the results of
641 that match to determine whether the alignment should be
642 performed. The buffer should not be modified during the
643 evaluation of this form.
645 `run-if' Like `valid', the `run-if' attribute tests whether the
646 rule should be run at all -- even before any searches are
647 done to determine if the rule applies to the alignment
648 region. This can save time, since `run-if' will only be
649 run once for each rule. If it returns nil, the rule will
652 `column' For alignment rules, if the `column' attribute is set --
653 which must be an integer, or a symbol whose value is an
654 integer -- it will be used as the column in which to align
655 the alignment character. If the text on a particular line
656 happens to overrun that column, a single space character,
657 or tab stop (see `align-to-tab-stop') will be added
658 between the last text character and the alignment
661 `spacing' Alignment rules may also override the amount of spacing
662 that would normally be used by providing a `spacing'
663 attribute. This must be an integer, or a list of integers
664 corresponding to the number of parenthesis groups matched
665 by the `group' attribute. If a list of value is used, and
666 any of those values is nil, `align-default-spacing' will
667 be used for that subgroup. See `align-default-spacing'
668 for more details on spacing, tab stops, and how to
669 indicate how much spacing should be used. If TAB-STOP is
670 present, it will override the value of `align-to-tab-stop'
673 `justify' It is possible with `regexp' and `group' to identify a
674 character group that contains more than just whitespace
675 characters. By default, any non-whitespace characters in
676 that group will also be deleted while aligning the
677 alignment character. However, if the `justify' attribute
678 is set to a non-nil value, only the initial whitespace
679 characters within that group will be deleted. This has
680 the effect of right-justifying the characters that remain,
681 and can be used for outdenting or just plain old right-
684 `separate' Each rule can define its own section separator, which
685 describes how to identify the separation of \"sections\"
686 within the region to be aligned. Setting the `separate'
687 attribute overrides the value of `align-region-separate'
688 (see the documentation of that variable for possible
689 values), and any separation argument passed to `align'."
690 :type align-rules-list-type
693 (put 'align-rules-list
'risky-local-variable t
)
695 (defvar align-exclude-rules-list-type
698 :tag
"Exclusion rule"
699 (symbol :tag
"Title")
700 (cons :tag
"Required attributes"
702 (const :tag
"(Regular expression to match)" regexp
)
703 (choice :value
"\\(\\s-+\\)" regexp function
))
705 :tag
"Optional attributes"
708 (const :tag
"(Repeat this rule throughout line)"
711 (cons :tag
"Paren group"
712 (const :tag
"(Parenthesis group to use)" group
)
714 integer
(repeat integer
)))
716 (const :tag
"(Modes where this rule applies)" modes
)
717 (sexp :value
(text-mode)))
718 (cons :tag
"Case-fold"
719 (const :tag
"(Should case be ignored for this rule)"
721 (boolean :value t
)))))))
722 "The `type' form for any `align-exclude-rules-list' variable.")
724 (defcustom align-exclude-rules-list
726 (regexp .
"\"\\([^\"\n]+\\)\"")
728 (modes . align-dq-string-modes
))
731 (regexp .
"'\\([^'\n]+\\)'")
733 (modes . align-sq-string-modes
))
738 (lambda (end reverse
)
739 (funcall (if reverse
're-search-backward
741 (concat "[^ \t\n\\\\]"
742 (regexp-quote comment-start
)
743 "\\(.+\\)$") end t
))))
744 (modes . align-open-comment-modes
))
747 (regexp .
"/\\*\\(.+\\)\\*/")
749 (modes . align-c
++-modes
))
752 (regexp .
"(\\([^)\n]+\\))")
754 (modes . align-c
++-modes
))
757 (regexp .
"^\\s-*#\\s-*\\(if\\w*\\|endif\\)\\(.*\\)$")
759 (modes . align-c
++-modes
)))
760 "*An list describing text that should be excluded from alignment.
761 See the documentation for `align-rules-list' for more info."
762 :type align-exclude-rules-list-type
765 (put 'align-exclude-rules-list
'risky-local-variable t
)
767 ;;; Internal Variables:
769 (defvar align-mode-rules-list nil
770 "Alignment rules specific to the current major mode.
771 See the variable `align-rules-list' for more details.")
773 (make-variable-buffer-local 'align-mode-rules-list
)
775 (defvar align-mode-exclude-rules-list nil
776 "Alignment exclusion rules specific to the current major mode.
777 See the variable `align-exclude-rules-list' for more details.")
779 (make-variable-buffer-local 'align-mode-exclude-rules-list
)
781 (defvar align-highlight-overlays nil
782 "The current overlays highlighting the text matched by a rule.")
784 ;; Sample extension rule set, for vhdl-mode. This should properly be
785 ;; in vhdl-mode.el itself.
787 (defcustom align-vhdl-rules-list
789 (regexp .
"\\(signal\\|variable\\|constant\\)\\(\\s-+\\)\\S-")
793 (regexp .
"\\(others\\|[^ \t\n=<]\\)\\(\\s-*\\)=>\\(\\s-*\\)\\S-")
798 (not (string= (downcase (match-string 1))
802 (regexp .
"[^ \t\n:]\\(\\s-*\\):\\(\\s-*\\)[^=\n]")
806 (regexp .
":\\s-*\\(in\\|out\\|inout\\|buffer\\)\\(\\s-*\\)")
810 (regexp .
"[^ \t\n=<]\\(\\s-*\\)<=\\(\\s-*\\)\\S-")
814 (regexp .
"[^ \t\n:]\\(\\s-*\\):="))
817 (regexp .
"\\(\\s-+\\)use\\s-+entity")))
818 "*Alignment rules for `vhdl-mode'. See `align-rules-list' for more info."
819 :type align-rules-list-type
822 (put 'align-vhdl-rules-list
'risky-local-variable t
)
824 (defun align-set-vhdl-rules ()
825 "Setup the `align-mode-rules-list' variable for `vhdl-mode'."
826 (setq align-mode-rules-list align-vhdl-rules-list
))
828 (add-hook 'vhdl-mode-hook
'align-set-vhdl-rules
)
830 (add-to-list 'align-dq-string-modes
'vhdl-mode
)
831 (add-to-list 'align-open-comment-modes
'vhdl-mode
)
836 (defun align (beg end
&optional separate rules exclude-rules
)
837 "Attempt to align a region based on a set of alignment rules.
838 BEG and END mark the region. If BEG and END are specifically set to
839 nil (this can only be done programmatically), the beginning and end of
840 the current alignment section will be calculated based on the location
841 of point, and the value of `align-region-separate' (or possibly each
842 rule's `separate' attribute).
844 If SEPARATE is non-nil, it overrides the value of
845 `align-region-separate' for all rules, except those that have their
846 `separate' attribute set.
848 RULES and EXCLUDE-RULES, if either is non-nil, will replace the
849 default rule lists defined in `align-rules-list' and
850 `align-exclude-rules-list'. See `align-rules-list' for more details
851 on the format of these lists."
855 (if (symbolp align-region-separate
)
856 (symbol-value align-region-separate
)
857 align-region-separate
)
859 (if (not (or ;(eq separator 'largest)
860 (and (functionp separator
)
861 (not (funcall separator nil nil
)))))
862 (align-region beg end separator
863 (or rules align-mode-rules-list align-rules-list
)
864 (or exclude-rules align-mode-exclude-rules-list
865 align-exclude-rules-list
))
866 (let ((sec-first end
)
868 (align-region beg end
870 align-mode-exclude-rules-list
871 align-exclude-rules-list
) nil
875 (when (and mode
(listp mode
))
876 (setq sec-first
(min sec-first b
)
877 sec-last
(max sec-last e
))))))
878 (if (< sec-first sec-last
)
879 (align-region sec-first sec-last
'entire
880 (or rules align-mode-rules-list align-rules-list
)
881 (or exclude-rules align-mode-exclude-rules-list
882 align-exclude-rules-list
)))))))
885 (defun align-regexp (beg end regexp
&optional group spacing repeat
)
886 "Align the current region using an ad-hoc rule read from the minibuffer.
887 BEG and END mark the limits of the region. This function will prompt
888 for the REGEXP to align with. If no prefix arg was specified, you
889 only need to supply the characters to be lined up and any preceding
890 whitespace is replaced. If a prefix arg was specified, the full
891 regexp with parenthesized whitespace should be supplied; it will also
892 prompt for which parenthesis GROUP within REGEXP to modify, the amount
893 of SPACING to use, and whether or not to REPEAT the rule throughout
894 the line. See `align-rules-list' for more information about these
897 For example, let's say you had a list of phone numbers, and wanted to
898 align them so that the opening parentheses would line up:
902 Mary-Anne (123) 456-7890
905 There is no predefined rule to handle this, but you could easily do it
906 using a REGEXP like \"(\". All you would have to do is to mark the
907 region, call `align-regexp' and type in that regular expression."
910 (list (min (point) (mark))
911 (max (point) (mark)))
912 (if current-prefix-arg
913 (list (read-string "Complex align using regexp: "
917 "Parenthesis group to modify (justify if negative): " "1"))
919 (read-string "Amount of spacing (or column if negative): "
920 (number-to-string align-default-spacing
)))
921 (y-or-n-p "Repeat throughout line? "))
922 (list (concat "\\(\\s-*\\)"
923 (read-string "Align regexp: "))
924 1 align-default-spacing nil
))))
926 (list (list nil
(cons 'regexp regexp
)
927 (cons 'group
(abs group
))
932 (cons 'spacing spacing
)
933 (cons 'column
(abs spacing
)))
934 (cons 'repeat repeat
)))))
935 (align-region beg end
'entire rule nil nil
)))
938 (defun align-entire (beg end
&optional rules exclude-rules
)
939 "Align the selected region as if it were one alignment section.
940 BEG and END mark the extent of the region. If RULES or EXCLUDE-RULES
941 is set to a list of rules (see `align-rules-list'), it can be used to
942 override the default alignment rules that would have been used to
945 (align beg end
'entire rules exclude-rules
))
948 (defun align-current (&optional rules exclude-rules
)
949 "Call `align' on the current alignment section.
950 This function assumes you want to align only the current section, and
951 so saves you from having to specify the region. If RULES or
952 EXCLUDE-RULES is set to a list of rules (see `align-rules-list'), it
953 can be used to override the default alignment rules that would have
954 been used to align that section."
956 (align nil nil nil rules exclude-rules
))
959 (defun align-highlight-rule (beg end title
&optional rules exclude-rules
)
960 "Highlight the whitespace which a given rule would have modified.
961 BEG and END mark the extent of the region. TITLE identifies the rule
962 that should be highlighted. If RULES or EXCLUDE-RULES is set to a
963 list of rules (see `align-rules-list'), it can be used to override the
964 default alignment rules that would have been used to identify the text
967 (list (min (mark) (point))
970 "Title of rule to highlight: "
974 (list (symbol-name (car rule
)))))
975 (append (or align-mode-rules-list align-rules-list
)
976 (or align-mode-exclude-rules-list
977 align-exclude-rules-list
))) nil t
)))
978 (let ((ex-rule (assq (intern title
)
979 (or align-mode-exclude-rules-list
980 align-exclude-rules-list
)))
982 (align-unhighlight-rule)
985 (or rules
(if ex-rule
986 (or exclude-rules align-mode-exclude-rules-list
987 align-exclude-rules-list
)
988 (or align-mode-rules-list align-rules-list
)))
989 (unless ex-rule
(or exclude-rules align-mode-exclude-rules-list
990 align-exclude-rules-list
))
993 (if (and mode
(listp mode
))
994 (if (equal (symbol-name (car mode
)) title
)
995 (setq face
(cons align-highlight-change-face
996 align-highlight-nochange-face
))
999 (let ((overlay (make-overlay b e
)))
1000 (setq align-highlight-overlays
1001 (cons overlay align-highlight-overlays
))
1002 (overlay-put overlay
'face
1005 (cdr face
)))))))))))
1008 (defun align-unhighlight-rule ()
1009 "Remove any highlighting that was added by `align-highlight-rule'."
1011 (while align-highlight-overlays
1012 (delete-overlay (car align-highlight-overlays
))
1013 (setq align-highlight-overlays
1014 (cdr align-highlight-overlays
))))
1016 ;;; Internal Functions:
1018 (defun align-match-tex-pattern (regexp end
&optional reverse
)
1019 "Match REGEXP in TeX mode, counting backslashes appropriately.
1020 END denotes the end of the region to be searched, while REVERSE, if
1021 non-nil, indicates that the search should proceed backward from the
1027 (if reverse
're-search-backward
1029 (concat "\\(\\s-*\\)" regexp
1030 "\\(\\s-*\\)") end t
))
1031 (let ((pos (match-end 1))
1033 (while (and (> pos
(point-min))
1034 (eq (char-before pos
) ?
\\))
1035 (setq count
(1+ count
) pos
(1- pos
)))
1036 (eq (mod count
2) 1))
1037 (goto-char (match-beginning 2))))
1040 (defun align-new-section-p (beg end separator
)
1041 "Is there a section divider between BEG and END?
1042 SEPARATOR specifies how to look for the section divider. See the
1043 documentation for `align-region-separate' for more details."
1044 (cond ((or (not separator
)
1045 (eq separator
'entire
))
1047 ((eq separator
'group
)
1053 (> (count-lines beg end
) amount
)))
1054 ((stringp separator
)
1057 (re-search-forward separator end t
)))
1058 ((functionp separator
)
1059 (funcall separator beg end
))
1061 (let ((seps separator
) yes
)
1063 (if (and (>= (car seps
) beg
)
1064 (<= (car seps
) end
))
1065 (setq yes t seps nil
)
1066 (setq seps
(cdr seps
))))
1069 (defun align-adjust-col-for-rule (column rule spacing tab-stop
)
1070 "Adjust COLUMN according to the given RULE.
1071 SPACING specifies how much spacing to use.
1072 TAB-STOP specifies whether SPACING refers to tab-stop boundaries."
1074 (setq spacing align-default-spacing
))
1079 (let ((stops tab-stop-list
))
1081 (if (and (> (car stops
) column
)
1082 (= (setq spacing
(1- spacing
)) 0))
1083 (setq column
(car stops
)
1085 (setq stops
(cdr stops
)))))
1088 (defsubst align-column
(pos)
1089 "Given a position in the buffer, state what column it's in.
1090 POS is the position whose column will be taken. Note that this
1091 function will change the location of point."
1095 (defsubst align-regions
(regions props rule func
)
1096 "Align the regions specified in REGIONS, a list of cons cells.
1097 PROPS describes formatting features specific to the given regions.
1098 RULE specifies exactly how to perform the alignments.
1099 If FUNC is specified, it will be called with each region that would
1100 have been aligned, rather than modifying the text."
1103 (align-areas (car regions
) (car props
) rule func
))
1104 (setq regions
(cdr regions
)
1105 props
(cdr props
))))
1107 (defun align-areas (areas props rule func
)
1108 "Given a list of AREAS and formatting PROPS, align according to RULE.
1109 AREAS should be a list of cons cells containing beginning and ending
1110 markers. This function sweeps through all of the beginning markers,
1111 finds out which one starts in the furthermost column, and then deletes
1112 and inserts text such that all of the ending markers occur in the same
1115 If FUNC is non-nil, it will be called for each text region that would
1116 have been aligned. No changes will be made to the buffer."
1117 (let* ((column (cdr (assq 'column rule
)))
1118 (fixed (if (symbolp column
)
1119 (symbol-value column
)
1121 (justify (cdr (assq 'justify rule
)))
1126 ;; Determine the alignment column.
1130 (setq col
(max col
(align-column (caar a
)))))
1132 (goto-char (cdar a
))
1134 (if (not (= ecol
(current-column)))
1136 (setq ecol
(current-column))))
1138 (goto-char (caar a
))
1139 (if (and (re-search-forward "\\s-*" (cdar a
) t
)
1140 (not (= (point) (cdar a
))))
1141 (let ((bcol (current-column)))
1142 (setcdr (car a
) (cons (point-marker) (cdar a
)))
1143 (goto-char (cdr (cdar a
)))
1144 (setq width
(max width
(- (current-column) bcol
))))))
1148 (setq col
(+ (align-adjust-col-for-rule
1149 col rule
(car props
) (cdr props
)) width
)))
1151 ;; Make all ending positions to occur in the goal column. Since
1152 ;; the whitespace to be modified was already deleted by
1153 ;; `align-region', all we have to do here is indent.
1156 (setq change
(and ecol
(not (= col ecol
)))))
1158 (when (or func change
)
1160 (let ((area (car areas
))
1164 (funcall func
(car area
) (cdr area
) change
)
1165 (if (not (and justify
1166 (consp (cdr area
))))
1167 (goto-char (cdr area
))
1168 (goto-char (cddr area
))
1169 (let ((ecol (current-column)))
1170 (goto-char (cadr area
))
1171 (setq gocol
(- col
(- ecol
(current-column))))))
1172 (setq cur
(current-column))
1173 (cond ((< gocol
0) t
) ; don't do anything
1174 ((= cur gocol
) t
) ; don't need to
1175 ((< cur gocol
) ; just add space
1178 ;; This code works around an oddity in the
1179 ;; FORCE argument of `move-to-column', which
1180 ;; tends to screw up markers if there is any
1182 (let ((endcol (align-column
1188 (align-column (car area
)))))
1190 (goto-char (car area
))
1191 (move-to-column gocol t
))
1192 (let ((here (point)))
1193 (move-to-column endcol t
)
1194 (delete-region here
(point))
1196 (indent-to (align-adjust-col-for-rule
1197 (current-column) rule
1198 (car props
) (cdr props
)))))))))))
1199 (setq areas
(cdr areas
))))))
1201 (defun align-region (beg end separate rules exclude-rules
1203 "Align a region based on a given set of alignment rules.
1204 BEG and END specify the region to be aligned. Either may be nil, in
1205 which case the range will stop at the nearest section division (see
1206 `align-region-separate', and `align-region-heuristic' for more
1209 The region will be divided into separate alignment sections based on
1210 the value of SEPARATE.
1212 RULES and EXCLUDE-RULES are a pair of lists describing how to align
1213 the region, and which text areas within it should be excluded from
1214 alignment. See the `align-rules-list' for more information on the
1215 required format of these two lists.
1217 If FUNC is specified, no text will be modified. What `align-region'
1218 will do with the rules is to search for the alignment areas, as it
1219 regularly would, taking account for exclusions, and then call FUNC,
1220 first with the beginning and ending of the region to be aligned
1221 according to that rule (this can be different for each rule, if BEG
1222 and END were nil), and then with the beginning and ending of each
1223 text region that the rule would have applied to.
1225 The signature of FUNC should thus be:
1227 (defun my-align-function (beg end mode)
1228 \"If MODE is a rule (a list), return t if BEG to END are to be searched.
1229 Otherwise BEG to END will be a region of text that matches the rule's
1230 definition, and MODE will be non-nil if any changes are necessary.\"
1231 (unless (and mode (listp mode))
1232 (message \"Would have aligned from %d to %d...\" beg end)))
1234 This feature (of passing a FUNC) is used internally to locate the
1235 position of exclusion areas, but could also be used for any other
1236 purpose where you might want to know where the regions that the
1237 aligner would have dealt with are."
1238 (let ((end-mark (and end
(copy-marker end t
)))
1241 (report (and (not func
) align-large-region beg end
1242 (>= (- end beg
) align-large-region
)))
1244 (rule-count (length rules
)))
1245 (if (and align-indent-before-aligning real-beg end-mark
)
1246 (indent-region real-beg end-mark nil
))
1248 (let* ((rule (car rules
))
1249 (run-if (assq 'run-if rule
))
1250 (modes (assq 'modes rule
)))
1251 ;; unless the `run-if' form tells us not to, look for the
1253 (unless (or (and modes
(not (memq major-mode
1254 (eval (cdr modes
)))))
1255 (and run-if
(not (funcall (cdr run-if
)))))
1256 (let* ((current-case-fold case-fold-search
)
1257 (case-fold (assq 'case-fold rule
))
1258 (regexp (cdr (assq 'regexp rule
)))
1259 (regfunc (and (functionp regexp
) regexp
))
1260 (rulesep (assq 'separate rule
))
1261 (thissep (if rulesep
(cdr rulesep
) separate
))
1275 ;; if beg and end were not given, figure out what the
1276 ;; current alignment region should be. Depending on the
1277 ;; value of `align-region-separate' it's possible for
1278 ;; each rule to have its own definition of what that
1279 ;; current alignment section is.
1282 (if (or (not thissep
) (eq thissep
'entire
))
1283 (error "Cannot determine alignment region for '%s'"
1284 (symbol-name (cdr (assq 'title rule
)))))
1286 (while (and (not (eobp))
1287 (looking-at "^\\s-*$"))
1289 (let* ((here (point))
1293 (and align-region-heuristic
1295 align-region-heuristic
))))
1297 (funcall regfunc terminus t
)
1298 (re-search-backward regexp
1300 (if (align-new-section-p (point) here thissep
)
1303 (setq here
(point))))
1312 (and align-region-heuristic
1314 align-region-heuristic
))))
1316 (funcall regfunc terminus nil
)
1317 (re-search-forward regexp terminus t
))))
1318 (if (align-new-section-p here
(point) thissep
)
1321 (setq here
(point))))
1326 end-mark
(copy-marker end t
))
1329 ;; If we have a region to align, and `func' is set and
1330 ;; reports back that the region is ok, then align it.
1331 (when (or (not func
)
1332 (funcall func beg end rule
))
1334 (let (exclude-areas)
1335 ;; determine first of all where the exclusions
1336 ;; lie in this region
1338 ;; guard against a problem with recursion and
1339 ;; dynamic binding vs. lexical binding, since
1340 ;; the call to `align-region' below will
1341 ;; re-enter this function, and rebind
1343 (set (setq exclude-areas
1344 (make-symbol "align-exclude-areas"))
1350 (or (and mode
(listp mode
))
1351 (set (quote ,exclude-areas
)
1355 (sort (symbol-value exclude-areas
)
1358 (>= (car l
) (car r
)))))))
1360 ;; set `case-fold-search' according to the
1361 ;; (optional) `case-fold' property
1363 (setq case-fold-search
(cdr case-fold
)))
1365 ;; while we can find the rule in the alignment
1367 (while (and (< (point) end-mark
)
1369 (funcall regfunc end-mark nil
)
1370 (re-search-forward regexp
1373 ;; give the user some indication of where we
1374 ;; are, if it's a very large region being
1378 "Aligning `%s' [rule %d of %d] (%d%%)..."
1379 (symbol-name (car rule
))
1380 rule-index rule-count
1381 (/ (* (- (point) real-beg
) 100)
1382 (- end-mark real-beg
))))
1384 ;; if the search ended us on the beginning of
1385 ;; the next line, move back to the end of the
1390 ;; lookup the `group' attribute the first time
1393 (setq group
(or (cdr (assq 'group rule
)) 1))
1395 (setq first
(car group
))
1396 (setq first group group
(list group
)))
1400 (setq spacing
(cdr (assq 'spacing rule
))
1405 (let ((rule-ts (assq 'tab-stop rule
)))
1408 (if (symbolp align-to-tab-stop
)
1409 (symbol-value align-to-tab-stop
)
1410 align-to-tab-stop
)))
1413 ;; test whether we have found a match on the same
1414 ;; line as a previous match
1421 ;; lookup the `repeat' attribute the first time
1423 (setq repeat
(cdr (assq 'repeat rule
))
1426 ;; lookup the `valid' attribute the first time
1428 (setq valid
(assq 'valid rule
)
1431 ;; remember the beginning position of this rule
1432 ;; match, and save the match-data, since either
1433 ;; the `valid' form, or the code that searches for
1434 ;; section separation, might alter it
1435 (setq b
(match-beginning first
)
1436 save-match-data
(match-data))
1438 ;; unless the `valid' attribute is set, and tells
1439 ;; us that the rule is not valid at this point in
1441 (unless (and valid
(not (funcall (cdr valid
))))
1443 ;; look to see if this match begins a new
1444 ;; section. If so, we should align what we've
1445 ;; collected so far, and then begin collecting
1446 ;; anew for the next alignment section
1448 (align-new-section-p last-point b
1451 (align-regions regions align-props
1453 (setq last-point
(copy-marker b t
)
1456 (setq last-point
(copy-marker b t
)))
1458 ;; restore the match data
1459 (set-match-data save-match-data
)
1461 ;; check whether the region to be aligned
1462 ;; straddles an exclusion area
1463 (let ((excls exclude-areas
))
1464 (setq exclude-p nil
)
1466 (if (and (< (match-beginning (car group
))
1468 (> (match-end (car (last group
)))
1472 (setq excls
(cdr excls
)))))
1474 ;; go through the list of parenthesis groups
1475 ;; matching whitespace text to be
1476 ;; contracted/expanded (or possibly
1477 ;; justified, if the `justify' attribute was
1483 ;; we have to use markers, since
1484 ;; `align-areas' may modify the buffer
1485 (setq b
(copy-marker
1486 (match-beginning (car g
)) t
)
1487 e
(copy-marker (match-end (car g
)) t
))
1489 ;; record this text region for alignment
1490 (setq index
(if same
(1+ index
) 0))
1491 (let ((region (cons b e
))
1496 (if (listp tab-stop
)
1499 (if (nth index regions
)
1500 (setcar (nthcdr index regions
)
1502 (nth index regions
)))
1506 (list (list region
)))
1507 (nconc align-props
(list props
)))
1509 (list (list region
)))
1510 (setq align-props
(list props
)))))
1512 ;; if any further rule matches are
1513 ;; found before `eol', then they are
1514 ;; on the same line as this one; this
1515 ;; can only happen if the `repeat'
1516 ;; attribute is non-nil
1518 (setq spacing
(cdr spacing
)))
1519 (if (listp tab-stop
)
1520 (setq tab-stop
(cdr tab-stop
)))
1521 (setq same t g
(cdr g
))))
1523 ;; if `repeat' has not been set, move to
1524 ;; the next line; don't bother searching
1525 ;; anymore on this one
1526 (if (and (not repeat
) (not (bolp)))
1529 ;; when they are no more matches for this rule,
1530 ;; align whatever was left over
1532 (align-regions regions align-props rule func
)))
1534 (setq case-fold-search current-case-fold
)))))))
1535 (setq rules
(cdr rules
)
1536 rule-index
(1+ rule-index
)))
1539 (message "Aligning...done"))))
1545 (run-hooks 'align-load-hook
)
1547 ;;; align.el ends here