| blob | 866aaadaf4dd380ff2662595d043182373d219dd |
1 ;;; align.el --- align text to a specific column, by regexp -*- lexical-binding:t -*-
3 ;; Copyright (C) 1999-2016 Free Software Foundation, Inc.
5 ;; Author: John Wiegley <johnw@gnu.org>
6 ;; Maintainer: emacs-devel@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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This mode allows you to align regions in a context-sensitive fashion.
27 ;; The classic use is to align assignments:
28 ;;
29 ;; int a = 1;
30 ;; short foo = 2;
31 ;; double blah = 4;
32 ;;
33 ;; becomes
34 ;;
35 ;; int a = 1;
36 ;; short foo = 2;
37 ;; double blah = 4;
39 ;;; Usage:
41 ;; There are several variables which define how certain "categories"
42 ;; of syntax are to be treated. These variables go by the name
43 ;; `align-CATEGORY-modes'. For example, "c++" is such a category.
44 ;; There are several rules which apply to c++, but since several other
45 ;; languages have a syntax similar to c++ (e.g., c, java, etc), these
46 ;; modes are treated as belonging to the same category.
47 ;;
48 ;; If you want to add a new mode under a certain category, just
49 ;; customize that list, or add the new mode manually. For example, to
50 ;; make jde-mode a c++ category mode, use this code in your .emacs
51 ;; file:
52 ;;
53 ;; (setq align-c++-modes (cons 'jde-mode align-c++-modes))
55 ;; In some programming modes, it's useful to have the aligner run only
56 ;; after indentation is performed. To achieve this, customize or set
57 ;; the variable `align-indent-before-aligning' to t.
59 ;;; Module Authors:
61 ;; In order to incorporate align's functionality into your own
62 ;; modules, there are only a few steps you have to follow.
64 ;; 1. Require or load in the align.el library.
65 ;;
66 ;; 2. Define your alignment and exclusion rules lists, either
67 ;; customizable or not.
68 ;;
69 ;; 3. In your mode function, set the variables
70 ;; `align-mode-rules-list' and `align-mode-exclude-rules-list'
71 ;; to your own rules lists.
73 ;; If there is any need to add your mode name to one of the
74 ;; align-?-modes variables (for example, `align-dq-string-modes'), use
75 ;; `add-to-list', or some similar function which checks first to see
76 ;; if the value is already there. Since the user may customize that
77 ;; mode list, and then write your mode name into their init file,
78 ;; causing the symbol already to be present the next time they load
79 ;; your package.
81 ;; Example:
82 ;;
83 ;; (require 'align)
84 ;;
85 ;; (defcustom my-align-rules-list
86 ;; '((my-rule
87 ;; (regexp . "Sample")))
88 ;; :type align-rules-list-type
89 ;; :group 'my-package)
90 ;;
91 ;; (put 'my-align-rules-list 'risky-local-variable t)
92 ;;
93 ;; (add-to-list 'align-dq-string-modes 'my-package-mode)
94 ;; (add-to-list 'align-open-comment-modes 'my-package-mode)
95 ;;
96 ;; (defun my-mode ()
97 ;; ...
98 ;; (setq align-mode-rules-list my-align-rules-list))
99 ;;
100 ;; Note that if you need to install your own exclusion rules, then you
101 ;; will also need to reproduce any double-quoted string, or open
102 ;; comment exclusion rules that are defined in the standard
103 ;; `align-exclude-rules-list'. At the moment there is no convenient
104 ;; way to mix both mode-local and global rules lists.
106 ;;; History:
108 ;; Version 1.0 was created in the earlier part of 1996, using a very
109 ;; simple algorithm that understand only basic regular expressions.
110 ;; Parts of the code were broken up and included in vhdl-mode.el
111 ;; around this time. After several comments from users, and a need to
112 ;; find a more robust, higher performing algorithm, 2.0 was born in late
113 ;; 1998. Many different approaches were taken (mostly due to the
114 ;; complexity of TeX tables), but finally a scheme was discovered
115 ;; which worked fairly well for most common usage cases. Development
116 ;; beyond version 2.8 is not planned, except for problems that users
117 ;; might encounter.
119 ;;; Code:
122 "Align text to a specific column, by regexp."
126 ;;; User Variables:
129 "Hook that gets run after the aligner has been loaded."
134 "If non-nil, indent the marked region before aligning it."
139 "An integer that represents the default amount of padding to use.
140 If `align-to-tab-stop' is non-nil, this will represent the number of
141 tab stops to use for alignment, rather than the number of spaces.
142 Each alignment rule can optionally override both this variable and
143 `align-to-tab-stop'. See `align-rules-list'."
148 "If non-nil, alignments will always fall on a tab boundary.
149 It may also be a symbol, whose value will be taken."
154 "If non-nil, used as a heuristic by `align-current'.
155 Since each alignment rule can possibly have its own set of alignment
156 sections (whenever `align-region-separate' is non-nil, and not a
157 string), this heuristic is used to determine how far before and after
158 point we should search in looking for a region separator. Larger
159 values can mean slower performance in large files, although smaller
160 values may cause unexpected behavior at times."
165 "The face to highlight with if changes are necessary."
170 "The face to highlight with if no changes are necessary."
176 If nil, then no messages will ever be printed to the minibuffer."
181 "A list of modes whose syntax resembles C/C++."
186 "A list of modes where Perl syntax is to be seen."
192 "A list of modes whose syntax resembles Lisp."
198 "A list of modes whose syntax resembles TeX (and family)."
203 "A list of modes whose content is plain text."
210 "A list of modes where double quoted strings should be excluded."
216 "A list of modes where single quoted strings should be excluded."
223 "A list of modes with a single-line comment syntax.
224 These are comments as in Lisp, which have a beginning, but end with
225 the line (i.e., `comment-end' is an empty string)."
230 "Select the method by which alignment sections will be separated.
231 If this is a symbol, that symbol's value will be used.
233 For the sake of clarification, consider the following example, which
234 will be referred to in the descriptions below.
236 int alpha = 1; /* one */
237 double beta = 2.0;
238 long gamma; /* ten */
240 unsigned int delta = 1; /* one */
241 long double epsilon = 3.0;
242 long long omega; /* ten */
244 The possible settings for `align-region-separate' are:
246 `entire' The entire region being aligned will be considered as a
247 single alignment section. Assuming that comments were not
248 being aligned to a particular column, the example would
249 become:
251 int alpha = 1; /* one */
252 double beta = 2.0;
253 long gamma; /* ten */
255 unsigned int delta = 1; /* one */
256 long double epsilon;
257 long long chi = 10; /* ten */
259 `group' Each contiguous set of lines where a specific alignment
260 occurs is considered a section for that alignment rule.
261 Note that each rule may have any entirely different set
262 of section divisions than another.
264 int alpha = 1; /* one */
265 double beta = 2.0;
266 long gamma; /* ten */
268 unsigned int delta = 1; /* one */
269 long double epsilon;
270 long long chi = 10; /* ten */
272 `largest' When contiguous rule sets overlap, the largest section
273 described will be taken as the alignment section for each
274 rule touched by that section.
276 int alpha = 1; /* one */
277 double beta = 2.0;
278 long gamma; /* ten */
280 unsigned int delta = 1; /* one */
281 long double epsilon;
282 long long chi = 10; /* ten */
284 NOTE: This option is not supported yet, due to algorithmic
285 issues which haven't been satisfactorily resolved. There
286 are ways to do it, but they're both ugly and resource
287 consumptive.
289 regexp A regular expression string which defines the section
290 divider. If the mode you're in has a consistent divider
291 between sections, the behavior will be very similar to
292 `largest', and faster. But if the mode does not use clear
293 separators (for example, if you collapse your braces onto
294 the preceding statement in C or Perl), `largest' is
295 probably the better alternative.
297 function A function that will be passed the beginning and ending
298 locations of the region in which to look for the section
299 separator. At the very beginning of the attempt to align,
300 both of these parameters will be nil, in which case the
301 function should return non-nil if it wants each rule to
302 define its own section, or nil if it wants the largest
303 section found to be used as the common section for all
304 rules that occur there.
306 list A list of markers within the buffer that represent where
307 the section dividers lie. Be certain to use markers! For
308 when the aligning begins, the ensuing contract/expanding of
309 whitespace will throw off any non-marker positions.
311 This method is intended for use in Lisp programs, and not
312 by the user."
316 ; (const largest)
337 repeat)
348 case-fold)
352 tab-stop)
356 valid)
360 run-if)
365 integer symbol))
371 justify)
373 ;; make sure this stays up-to-date with any changes
374 ;; in `align-region-separate'
377 separate)
381 ; (const largest)
382 regexp function)))))))
465 ; (valid
466 ; . ,(function
467 ; (lambda ()
468 ; (memq (caar (c-guess-basic-syntax))
469 ; '(brace-list-intro
470 ; brace-list-entry
471 ; brace-entry-open))))))
473 ;; With a prefix argument, comma delimiter will be aligned. Since
474 ;; perl-mode doesn't give us enough syntactic information (and we
475 ;; don't do our own parsing yet), this rule is too destructive to
476 ;; run normally.
524 ; (valid
525 ; . ,(function
526 ; (lambda ()
527 ; (memq (caar (c-guess-basic-syntax))
528 ; '(cpp-macro cpp-macro-cont))))))
557 ;; With a numeric prefix argument, or C-u, space delimited text
558 ;; tables will be aligned.
569 ;; With a negative prefix argument, lists of dollar figures will
570 ;; be aligned.
583 "A list describing all of the available alignment rules.
584 The format is:
586 ((TITLE
587 (ATTRIBUTE . VALUE) ...)
588 ...)
590 The following attributes are meaningful:
592 `regexp' This required attribute must be either a string describing
593 a regular expression, or a function (described below).
594 For every line within the section that this regular
595 expression matches, the given rule will be applied to that
596 line. The exclusion rules denote which part(s) of the
597 line should not be modified; the alignment rules cause the
598 identified whitespace group to be contracted/expanded such
600 immediately following the identified parenthesis group),
601 occurs in the same column for every line within the
602 alignment section (see `align-region-separate' for a
603 description of how the region is broken up into alignment
604 sections).
606 The `regexp' attribute describes how the text should be
607 treated. Within this regexp, there must be at least one
608 group of characters (typically whitespace) identified by
609 the special opening and closing parens used in regexp
611 the syntax of regular expressions for more info).
613 If `regexp' is a function, it will be called as a
614 replacement for `re-search-forward'. This means that it
615 should return nil if nothing is found to match the rule,
616 or it should set the match data appropriately, move point
617 to the end of the match, and return the value of point.
619 `group' For exclusion rules, the group identifies the range of
620 characters that should be ignored. For alignment rules,
621 these are the characters that will be deleted/expanded for
623 always the first character immediately following this
624 parenthesis group. This attribute may also be a list of
625 integers, in which case multiple alignment characters will
626 be aligned, with the list of integers identifying the
627 whitespace groups which precede them. The default for
628 this attribute is 1.
630 `modes' The `modes' attribute, if set, should name a list of
631 major modes -- or evaluate to such a value -- in which the
632 rule is valid. If not set, the rule will apply to all
633 modes.
635 `case-fold' If `regexp' is an ordinary regular expression string
636 containing alphabetic character, sometimes you may want
637 the search to proceed case-insensitively (for languages
638 that ignore case, such as Pascal for example). In that
639 case, set `case-fold' to a non-nil value, and the regular
640 expression search will ignore case. If `regexp' is set to
641 a function, that function must handle the job of ignoring
642 case by itself.
644 `tab-stop' If the `tab-stop' attribute is set, and non-nil, the
645 alignment character will always fall on a tab stop
646 (whether it uses tabs to get there or not depends on the
647 value of `indent-tabs-mode'). If the `tab-stop' attribute
648 is set to nil, tab stops will never be used. Otherwise,
649 the value of `align-to-tab-stop' determines whether or not
650 to align to a tab stop. The `tab-stop' attribute may also
651 be a list of t or nil values, corresponding to the number
652 of parenthesis groups specified by the `group' attribute.
654 `repeat' If the `repeat' attribute is present, and non-nil, the
655 rule will be applied to the line continuously until no
656 further matches are found.
658 `valid' If the `valid' attribute is set, it will be used to
659 determine whether the rule should be invoked. This form
660 is evaluated after the regular expression match has been
661 performed, so that it is possible to use the results of
662 that match to determine whether the alignment should be
663 performed. The buffer should not be modified during the
664 evaluation of this form.
666 `run-if' Like `valid', the `run-if' attribute tests whether the
667 rule should be run at all -- even before any searches are
668 done to determine if the rule applies to the alignment
669 region. This can save time, since `run-if' will only be
670 run once for each rule. If it returns nil, the rule will
671 not be attempted.
673 `column' For alignment rules, if the `column' attribute is set --
674 which must be an integer, or a symbol whose value is an
675 integer -- it will be used as the column in which to align
676 the alignment character. If the text on a particular line
677 happens to overrun that column, a single space character,
678 or tab stop (see `align-to-tab-stop') will be added
679 between the last text character and the alignment
680 character.
682 `spacing' Alignment rules may also override the amount of spacing
683 that would normally be used by providing a `spacing'
684 attribute. This must be an integer, or a list of integers
685 corresponding to the number of parenthesis groups matched
686 by the `group' attribute. If a list of value is used, and
687 any of those values is nil, `align-default-spacing' will
688 be used for that subgroup. See `align-default-spacing'
689 for more details on spacing, tab stops, and how to
690 indicate how much spacing should be used. If TAB-STOP is
691 present, it will override the value of `align-to-tab-stop'
692 for that rule.
694 `justify' It is possible with `regexp' and `group' to identify a
695 character group that contains more than just whitespace
696 characters. By default, any non-whitespace characters in
697 that group will also be deleted while aligning the
698 alignment character. However, if the `justify' attribute
699 is set to a non-nil value, only the initial whitespace
700 characters within that group will be deleted. This has
701 the effect of right-justifying the characters that remain,
702 and can be used for outdenting or just plain old right-
703 justification.
705 `separate' Each rule can define its own section separator, which
707 within the region to be aligned. Setting the `separate'
708 attribute overrides the value of `align-region-separate'
709 (see the documentation of that variable for possible
710 values), and any separation argument passed to `align'."
711 :type align-rules-list-type
730 repeat)
741 case-fold)
781 "A list describing text that should be excluded from alignment.
782 See the documentation for `align-rules-list' for more info."
783 :type align-exclude-rules-list-type
788 ;;; Internal Variables:
791 "Alignment rules specific to the current major mode.
797 "Alignment exclusion rules specific to the current major mode.
808 ;; Sample extension rule set, for vhdl-mode. This should properly be
809 ;; in vhdl-mode.el itself.
842 "Alignment rules for `vhdl-mode'. See `align-rules-list' for more info."
843 :type align-rules-list-type
849 "Setup the `align-mode-rules-list' variable for `vhdl-mode'."
857 ;;; User Functions:
859 ;;;###autoload
861 "Attempt to align a region based on a set of alignment rules.
862 BEG and END mark the region. If BEG and END are specifically set to
863 nil (this can only be done programmatically), the beginning and end of
864 the current alignment section will be calculated based on the location
865 of point, and the value of `align-region-separate' (or possibly each
866 rule's `separate' attribute).
868 If SEPARATE is non-nil, it overrides the value of
869 `align-region-separate' for all rules, except those that have their
870 `separate' attribute set.
872 RULES and EXCLUDE-RULES, if either is non-nil, will replace the
873 default rule lists defined in `align-rules-list' and
874 `align-exclude-rules-list'. See `align-rules-list' for more details
875 on the format of these lists."
882 align-region-separate)
890 align-exclude-rules-list))
894 separator
895 nil ; rules
897 align-mode-exclude-rules-list
898 align-exclude-rules-list)
907 align-exclude-rules-list)))))))
909 ;;;###autoload
911 "Align the current region using an ad-hoc rule read from the minibuffer.
912 BEG and END mark the limits of the region. Interactively, this function
913 prompts for the regular expression REGEXP to align with.
915 For example, let's say you had a list of phone numbers, and wanted to
916 align them so that the opening parentheses would line up:
918 Fred (123) 456-7890
919 Alice (123) 456-7890
920 Mary-Anne (123) 456-7890
921 Joe (123) 456-7890
923 There is no predefined rule to handle this, but you could easily do it
925 to mark the region, call `align-regexp' and enter that regular expression.
927 REGEXP must contain at least one parenthesized subexpression, typically
929 this is automatically added to the start of your regular expression after
930 you enter it. You only need to supply the characters to be lined up, and
931 any preceding whitespace is replaced.
933 If you specify a prefix argument (or use this function non-interactively),
934 you must enter the full regular expression, including the subexpression.
935 The function also then prompts for which subexpression parenthesis GROUP
936 \(default 1) within REGEXP to modify, the amount of SPACING (default
937 `align-default-spacing') to use, and whether or not to REPEAT the rule
938 throughout the line.
940 See `align-rules-list' for more information about these options.
942 The non-interactive form of the previous example would look something like:
945 This function is a nothing more than a small wrapper that helps you
946 construct a rule to pass to `align-region', which does the real work."
977 ;;;###autoload
979 "Align the selected region as if it were one alignment section.
980 BEG and END mark the extent of the region. If RULES or EXCLUDE-RULES
981 is set to a list of rules (see `align-rules-list'), it can be used to
982 override the default alignment rules that would have been used to
983 align that section."
987 ;;;###autoload
989 "Call `align' on the current alignment section.
990 This function assumes you want to align only the current section, and
991 so saves you from having to specify the region. If RULES or
992 EXCLUDE-RULES is set to a list of rules (see `align-rules-list'), it
993 can be used to override the default alignment rules that would have
994 been used to align that section."
998 ;;;###autoload
1000 "Highlight the whitespace which a given rule would have modified.
1001 BEG and END mark the extent of the region. TITLE identifies the rule
1002 that should be highlighted. If RULES or EXCLUDE-RULES is set to a
1003 list of rules (see `align-rules-list'), it can be used to override the
1004 default alignment rules that would have been used to identify the text
1005 to be colored."
1009 "Title of rule to highlight: "
1019 align-exclude-rules-list)))
1020 face)
1023 beg end 'entire
1026 align-exclude-rules-list)
1029 align-exclude-rules-list))
1035 align-highlight-nochange-face))
1046 ;;;###autoload
1048 "Remove any highlighting that was added by `align-highlight-rule'."
1055 ;;;###autoload
1057 "A replacement function for `newline-and-indent', aligning as it goes.
1058 The alignment is done by calling `align' on the region that was
1059 indented."
1064 align-region-separate)
1075 ;;; Internal Functions:
1078 "Match REGEXP in TeX mode, counting backslashes appropriately.
1079 END denotes the end of the region to be searched, while REVERSE, if
1080 non-nil, indicates that the search should proceed backward from the
1081 current position."
1097 result))
1100 "Is there a section divider between BEG and END?
1101 SEPARATOR specifies how to look for the section divider. See the
1102 documentation for `align-region-separate' for more details."
1105 nil)
1126 yes))))
1129 "Adjust COLUMN according to the given RULE.
1130 SPACING specifies how much spacing to use.
1131 TAB-STOP specifies whether SPACING refers to tab-stop boundaries."
1135 column
1140 column)))
1143 "Given a position in the buffer, state what column it's in.
1144 POS is the position whose column will be taken. Note that this
1145 function will change the location of point."
1150 "Align the regions specified in REGIONS, a list of cons cells.
1151 PROPS describes formatting features specific to the given regions.
1152 RULE specifies exactly how to perform the alignments.
1153 If FUNC is specified, it will be called with each region that would
1154 have been aligned, rather than modifying the text."
1162 "Given a list of AREAS and formatting PROPS, align according to RULE.
1163 AREAS should be a list of cons cells containing beginning and ending
1164 markers. This function sweeps through all of the beginning markers,
1165 finds out which one starts in the furthermost column, and then deletes
1166 and inserts text such that all of the ending markers occur in the same
1167 column.
1169 If FUNC is non-nil, it will be called for each text region that would
1170 have been aligned. No changes will be made to the buffer."
1174 column))
1178 ecol change)
1180 ;; Determine the alignment column.
1205 ;; Make all ending positions to occur in the goal column. Since
1206 ;; the whitespace to be modified was already deleted by
1207 ;; `align-region', all we have to do here is indent.
1221 change)
1233 ;; FIXME: It is stated above that "...the
1234 ;; whitespace to be modified was already
1235 ;; deleted by `align-region', all we have
1236 ;; to do here is indent." However, this
1237 ;; doesn't seem to be true, so we first
1238 ;; delete the whitespace to avoid tabs
1239 ;; after spaces.
1243 ;; This code works around an oddity in the
1244 ;; FORCE argument of `move-to-column', which
1245 ;; tends to screw up markers if there is any
1246 ;; tabbing.
1267 "If MARKER-VAR is a marker, move it to position POS.
1268 Otherwise, create a new marker at position POS, with type TYPE."
1275 "Align a region based on a given set of alignment rules.
1276 BEG and END specify the region to be aligned. Either may be nil, in
1277 which case the range will stop at the nearest section division (see
1278 `align-region-separate', and `align-region-heuristic' for more
1279 information').
1281 The region will be divided into separate alignment sections based on
1282 the value of SEPARATE.
1284 RULES and EXCLUDE-RULES are a pair of lists describing how to align
1285 the region, and which text areas within it should be excluded from
1286 alignment. See the `align-rules-list' for more information on the
1287 required format of these two lists.
1289 If FUNC is specified, no text will be modified. What `align-region'
1290 will do with the rules is to search for the alignment areas, as it
1291 regularly would, taking account for exclusions, and then call FUNC,
1292 first with the beginning and ending of the region to be aligned
1293 according to that rule (this can be different for each rule, if BEG
1294 and END were nil), and then with the beginning and ending of each
1295 text region that the rule would have applied to.
1297 The signature of FUNC should thus be:
1299 (defun my-align-function (beg end mode)
1301 Otherwise BEG to END will be a region of text that matches the rule's
1303 (unless (and mode (listp mode))
1306 This feature (of passing a FUNC) is used internally to locate the
1307 position of exclusion areas, but could also be used for any other
1308 purpose where you might want to know where the regions that the
1309 aligner would have dealt with are."
1316 markers)
1323 ;; unless the `run-if' form tells us not to, look for the
1324 ;; rule..
1335 search-start
1336 groups group-c
1337 spacing spacing-c
1338 tab-stop tab-stop-c
1339 repeat repeat-c
1340 valid valid-c
1341 first
1342 regions index
1343 last-point
1344 save-match-data
1345 exclude-p
1346 align-props)
1348 ;; if beg and end were not given, figure out what the
1349 ;; current alignment region should be. Depending on the
1350 ;; value of `align-region-separate' it's possible for
1351 ;; each rule to have its own definition of what that
1352 ;; current alignment section is.
1368 align-region-heuristic))))
1372 terminus t))))
1375 here nil)
1387 align-region-heuristic))))
1393 here nil)
1402 ;; If we have a region to align, and `func' is set and
1403 ;; reports back that the region is ok, then align it.
1407 ;; determine first of all where the exclusions
1408 ;; lie in this region
1411 beg end 'entire
1412 exclude-rules nil
1417 exclude-areas)))))
1422 ;; set `case-fold-search' according to the
1423 ;; (optional) `case-fold' property
1427 ;; while we can find the rule in the alignment
1428 ;; region..
1434 end-mark t)))
1436 ;; give the user some indication of where we
1437 ;; are, if it's a very large region being
1438 ;; aligned
1443 "Aligning `%s' (rule %d of %d) %d%%..."
1448 "Aligning %d%%..."
1452 ;; if the search ended us on the beginning of
1453 ;; the next line, move back to the end of the
1454 ;; previous line.
1458 ;; lookup the `group' attribute the first time
1459 ;; that we need it
1468 spacing-c t))
1478 align-to-tab-stop)))
1479 tab-stop-c t))
1481 ;; test whether we have found a match on the same
1482 ;; line as a previous match
1487 ;; lookup the `repeat' attribute the first time
1490 repeat-c t))
1492 ;; lookup the `valid' attribute the first time
1495 valid-c t))
1497 ;; remember the beginning position of this rule
1498 ;; match, and save the match-data, since either
1499 ;; the `valid' form, or the code that searches for
1500 ;; section separation, might alter it
1507 ;; unless the `valid' attribute is set, and tells
1508 ;; us that the rule is not valid at this point in
1509 ;; the code..
1512 ;; look to see if this match begins a new
1513 ;; section. If so, we should align what we've
1514 ;; collected so far, and then begin collecting
1515 ;; anew for the next alignment section
1518 thissep))
1524 ;; restore the match data
1527 ;; check whether the region to be aligned
1528 ;; straddles an exclusion area
1537 excls nil)
1540 ;; go through the parenthesis groups
1541 ;; matching whitespace to be contracted or
1542 ;; expanded (or possibly justified, if the
1543 ;; `justify' attribute was set)
1546 ;; We must use markers, since
1547 ;; `align-areas' may modify the buffer.
1548 ;; Avoid polluting the markers.
1556 spacing)
1559 tab-stop))))
1576 ;; If any further rule matches are found
1577 ;; before `eol', they are on the same
1578 ;; line as this one; this can only
1579 ;; happen if the `repeat' attribute is
1580 ;; non-nil.
1587 ;; if `repeat' has not been set, move to
1588 ;; the next line; don't bother searching
1589 ;; anymore on this one
1593 ;; if the search did not change point,
1594 ;; move forward to avoid an infinite loop
1598 ;; when they are no more matches for this rule,
1599 ;; align whatever was left over
1604 ;; This function can use a lot of temporary markers, so instead of
1605 ;; waiting for the next GC we delete them immediately (Bug#10047).
1613 ;; Provide:
1619 ;;; align.el ends here