| blob | a384b7c508049fedec75eae96ec0c5cb435be6c5 |
1 ;;; align.el --- align text to a specific column, by regexp
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: John Wiegley <johnw@gnu.org>
7 ;; Maintainer: FSF
8 ;; Keywords: convenience languages lisp
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This mode allows you to align regions in a context-sensitive fashion.
28 ;; The classic use is to align assignments:
29 ;;
30 ;; int a = 1;
31 ;; short foo = 2;
32 ;; double blah = 4;
33 ;;
34 ;; becomes
35 ;;
36 ;; int a = 1;
37 ;; short foo = 2;
38 ;; double blah = 4;
40 ;;; Usage:
42 ;; There are several variables which define how certain "categories"
43 ;; of syntax are to be treated. These variables go by the name
44 ;; `align-CATEGORY-modes'. For example, "c++" is such a category.
45 ;; There are several rules which apply to c++, but since several other
46 ;; languages have a syntax similar to c++ (e.g., c, java, etc), these
47 ;; modes are treated as belonging to the same category.
48 ;;
49 ;; If you want to add a new mode under a certain category, just
50 ;; customize that list, or add the new mode manually. For example, to
51 ;; make jde-mode a c++ category mode, use this code in your .emacs
52 ;; file:
53 ;;
54 ;; (setq align-c++-modes (cons 'jde-mode align-c++-modes))
56 ;; In some programming modes, it's useful to have the aligner run only
57 ;; after indentation is performed. To achieve this, customize or set
58 ;; the variable `align-indent-before-aligning' to t.
60 ;;; Module Authors:
62 ;; In order to incorporate align's functionality into your own
63 ;; modules, there are only a few steps you have to follow.
65 ;; 1. Require or load in the align.el library.
66 ;;
67 ;; 2. Define your alignment and exclusion rules lists, either
68 ;; customizable or not.
69 ;;
70 ;; 3. In your mode function, set the variables
71 ;; `align-mode-rules-list' and `align-mode-exclude-rules-list'
72 ;; to your own rules lists.
74 ;; If there is any need to add your mode name to one of the
75 ;; align-?-modes variables (for example, `align-dq-string-modes'), use
76 ;; `add-to-list', or some similar function which checks first to see
77 ;; if the value is already there. Since the user may customize that
78 ;; mode list, and then write your mode name into their .emacs file,
79 ;; causing the symbol already to be present the next time they load
80 ;; your package.
82 ;; Example:
83 ;;
84 ;; (require 'align)
85 ;;
86 ;; (defcustom my-align-rules-list
87 ;; '((my-rule
88 ;; (regexp . "Sample")))
89 ;; :type align-rules-list-type
90 ;; :group 'my-package)
91 ;;
92 ;; (put 'my-align-rules-list 'risky-local-variable t)
93 ;;
94 ;; (add-to-list 'align-dq-string-modes 'my-package-mode)
95 ;; (add-to-list 'align-open-comment-modes 'my-package-mode)
96 ;;
97 ;; (defun my-mode ()
98 ;; ...
99 ;; (setq align-mode-rules-list my-align-rules-list))
100 ;;
101 ;; Note that if you need to install your own exclusion rules, then you
102 ;; will also need to reproduce any double-quoted string, or open
103 ;; comment exclusion rules that are defined in the standard
104 ;; `align-exclude-rules-list'. At the moment there is no convenient
105 ;; way to mix both mode-local and global rules lists.
107 ;;; History:
109 ;; Version 1.0 was created in the earlier part of 1996, using a very
110 ;; simple algorithm that understand only basic regular expressions.
111 ;; Parts of the code were broken up and included in vhdl-mode.el
112 ;; around this time. After several comments from users, and a need to
113 ;; find a more robust, performant algorithm, 2.0 was born in late
114 ;; 1998. Many different approaches were taken (mostly due to the
115 ;; complexity of TeX tables), but finally a scheme was discovered
116 ;; which worked fairly well for most common usage cases. Development
117 ;; beyond version 2.8 is not planned, except for problems that users
118 ;; might encounter.
120 ;;; Code:
123 "Align text to a specific column, by regexp."
127 ;;; User Variables:
130 "*Hook that gets run after the aligner has been loaded."
135 "*If non-nil, indent the marked region before aligning it."
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
144 `align-mode-alist'."
149 "*If non-nil, alignments will always fall on a tab boundary.
150 It may also be a symbol, whose value will be taken."
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."
166 "*The face to highlight with if changes are necessary."
171 "*The face to highlight with if no changes are necessary."
177 If nil,then no messages will ever be printed to the minibuffer."
182 "*A list of modes whose syntax resembles C/C++."
187 "*A list of modes where perl syntax is to be seen."
193 "*A list of modes whose syntax resembles Lisp."
199 "*A list of modes whose syntax resembles TeX (and family)."
204 "*A list of modes whose content is plain text."
211 "*A list of modes where double quoted strings should be excluded."
217 "*A list of modes where single quoted strings should be excluded."
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)."
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 */
238 double beta = 2.0;
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
250 become:
252 int alpha = 1; /* one */
253 double beta = 2.0;
254 long gamma; /* ten */
256 unsigned int delta = 1; /* one */
257 long double epsilon;
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 */
266 double beta = 2.0;
267 long gamma; /* ten */
269 unsigned int delta = 1; /* one */
270 long double epsilon;
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 */
278 double beta = 2.0;
279 long gamma; /* ten */
281 unsigned int delta = 1; /* one */
282 long double epsilon;
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
288 consumptive.
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
305 that occur there.
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
313 by the user."
317 ; (const largest)
338 repeat)
349 case-fold)
353 tab-stop)
357 valid)
361 run-if)
366 integer symbol))
372 justify)
374 ;; make sure this stays up-to-date with any changes
375 ;; in `align-region-separate'
378 separate)
382 ; (const largest)
383 regexp function)))))))
466 ; (valid
467 ; . ,(function
468 ; (lambda ()
469 ; (memq (caar (c-guess-basic-syntax))
470 ; '(brace-list-intro
471 ; brace-list-entry
472 ; brace-entry-open))))))
474 ;; With a prefix argument, comma delimiter will be aligned. Since
475 ;; perl-mode doesn't give us enough syntactic information (and we
476 ;; don't do our own parsing yet), this rule is too destructive to
477 ;; run normally.
525 ; (valid
526 ; . ,(function
527 ; (lambda ()
528 ; (memq (caar (c-guess-basic-syntax))
529 ; '(cpp-macro cpp-macro-cont))))))
558 ;; With a numeric prefix argument, or C-u, space delimited text
559 ;; tables will be aligned.
570 ;; With a negative prefix argument, lists of dollar figures will
571 ;; be aligned.
584 "*A list describing all of the available alignment rules.
585 The format is:
587 ((TITLE
588 (ATTRIBUTE . VALUE) ...)
589 ...)
591 The following attributes are meaningful:
593 `regexp' This required attribute must be either a string describing
594 a regular expression, or a function (described below).
595 For every line within the section that this regular
596 expression matches, the given rule will be applied to that
597 line. The exclusion rules denote which part(s) of the
598 line should not be modified; the alignment rules cause the
599 identified whitespace group to be contracted/expanded such
601 immediately following the identified parenthesis group),
602 occurs in the same column for every line within the
603 alignment section (see `align-region-separate' for a
604 description of how the region is broken up into alignment
605 sections).
607 The `regexp' attribute describes how the text should be
608 treated. Within this regexp, there must be at least one
609 group of characters (typically whitespace) identified by
610 the special opening and closing parens used in regexp
612 the syntax of regular expressions for more info).
614 If `regexp' is a function, it will be called as a
615 replacement for `re-search-forward'. This means that it
616 should return nil if nothing is found to match the rule,
617 or it should set the match data appropriately, move point
618 to the end of the match, and return the value of point.
620 `group' For exclusion rules, the group identifies the range of
621 characters that should be ignored. For alignment rules,
622 these are the characters that will be deleted/expanded for
624 always the first character immediately following this
625 parenthesis group. This attribute may also be a list of
626 integer, in which case multiple alignment characters will
627 be aligned, with the list of integer identifying the
628 whitespace groups which precede them. The default for
629 this attribute is 1.
631 `modes' The `modes' attribute, if set, should name a list of
632 major modes -- or evaluate to such a value -- in which the
633 rule is valid. If not set, the rule will apply to all
634 modes.
636 `case-fold' If `regexp' is an ordinary regular expression string
637 containing alphabetic character, sometimes you may want
638 the search to proceed case-insensitively (for languages
639 that ignore case, such as pascal for example). In that
640 case, set `case-fold' to a non-nil value, and the regular
641 expression search will ignore case. If `regexp' is set to
642 a function, that function must handle the job of ignoring
643 case by itself.
645 `tab-stop' If the `tab-stop' attribute is set, and non-nil, the
646 alignment character will always fall on a tab stop
647 (whether it uses tabs to get there or not depends on the
648 value of `indent-tabs-mode'). If the `tab-stop' attribute
649 is set to nil, tab stops will never be used. Otherwise,
650 the value of `align-to-tab-stop' determines whether or not
651 to align to a tab stop. The `tab-stop' attribute may also
652 be a list of t or nil values, corresponding to the number
653 of parenthesis groups specified by the `group' attribute.
655 `repeat' If the `repeat' attribute is present, and non-nil, the
656 rule will be applied to the line continuously until no
657 further matches are found.
659 `valid' If the `valid' attribute is set, it will be used to
660 determine whether the rule should be invoked. This form
661 is evaluated after the regular expression match has been
662 performed, so that it is possible to use the results of
663 that match to determine whether the alignment should be
664 performed. The buffer should not be modified during the
665 evaluation of this form.
667 `run-if' Like `valid', the `run-if' attribute tests whether the
668 rule should be run at all -- even before any searches are
669 done to determine if the rule applies to the alignment
670 region. This can save time, since `run-if' will only be
671 run once for each rule. If it returns nil, the rule will
672 not be attempted.
674 `column' For alignment rules, if the `column' attribute is set --
675 which must be an integer, or a symbol whose value is an
676 integer -- it will be used as the column in which to align
677 the alignment character. If the text on a particular line
678 happens to overrun that column, a single space character,
679 or tab stop (see `align-to-tab-stop') will be added
680 between the last text character and the alignment
681 character.
683 `spacing' Alignment rules may also override the amount of spacing
684 that would normally be used by providing a `spacing'
685 attribute. This must be an integer, or a list of integers
686 corresponding to the number of parenthesis groups matched
687 by the `group' attribute. If a list of value is used, and
688 any of those values is nil, `align-default-spacing' will
689 be used for that subgroup. See `align-default-spacing'
690 for more details on spacing, tab stops, and how to
691 indicate how much spacing should be used. If TAB-STOP is
692 present, it will override the value of `align-to-tab-stop'
693 for that rule.
695 `justify' It is possible with `regexp' and `group' to identify a
696 character group that contains more than just whitespace
697 characters. By default, any non-whitespace characters in
698 that group will also be deleted while aligning the
699 alignment character. However, if the `justify' attribute
700 is set to a non-nil value, only the initial whitespace
701 characters within that group will be deleted. This has
702 the effect of right-justifying the characters that remain,
703 and can be used for outdenting or just plain old right-
704 justification.
706 `separate' Each rule can define its own section separator, which
708 within the region to be aligned. Setting the `separate'
709 attribute overrides the value of `align-region-separate'
710 (see the documentation of that variable for possible
711 values), and any separation argument passed to `align'."
712 :type align-rules-list-type
731 repeat)
742 case-fold)
782 "*A list describing text that should be excluded from alignment.
783 See the documentation for `align-rules-list' for more info."
784 :type align-exclude-rules-list-type
789 ;;; Internal Variables:
792 "Alignment rules specific to the current major mode.
798 "Alignment exclusion rules specific to the current major mode.
806 ;; Sample extension rule set, for vhdl-mode. This should properly be
807 ;; in vhdl-mode.el itself.
840 "*Alignment rules for `vhdl-mode'. See `align-rules-list' for more info."
841 :type align-rules-list-type
847 "Setup the `align-mode-rules-list' variable for `vhdl-mode'."
855 ;;; User Functions:
857 ;;;###autoload
859 "Attempt to align a region based on a set of alignment rules.
860 BEG and END mark the region. If BEG and END are specifically set to
861 nil (this can only be done programmatically), the beginning and end of
862 the current alignment section will be calculated based on the location
863 of point, and the value of `align-region-separate' (or possibly each
864 rule's `separate' attribute).
866 If SEPARATE is non-nil, it overrides the value of
867 `align-region-separate' for all rules, except those that have their
868 `separate' attribute set.
870 RULES and EXCLUDE-RULES, if either is non-nil, will replace the
871 default rule lists defined in `align-rules-list' and
872 `align-exclude-rules-list'. See `align-rules-list' for more details
873 on the format of these lists."
880 align-region-separate)
888 align-exclude-rules-list))
893 align-mode-exclude-rules-list
894 align-exclude-rules-list) nil
895 separator
905 align-exclude-rules-list)))))))
907 ;;;###autoload
909 "Align the current region using an ad-hoc rule read from the minibuffer.
910 BEG and END mark the limits of the region. This function will prompt
911 for the REGEXP to align with. If no prefix arg was specified, you
912 only need to supply the characters to be lined up and any preceding
913 whitespace is replaced. If a prefix arg was specified, the full
914 regexp with parenthesized whitespace should be supplied; it will also
915 prompt for which parenthesis GROUP within REGEXP to modify, the amount
916 of SPACING to use, and whether or not to REPEAT the rule throughout
917 the line. See `align-rules-list' for more information about these
918 options.
920 For example, let's say you had a list of phone numbers, and wanted to
921 align them so that the opening parentheses would line up:
923 Fred (123) 456-7890
924 Alice (123) 456-7890
925 Mary-Anne (123) 456-7890
926 Joe (123) 456-7890
928 There is no predefined rule to handle this, but you could easily do it
930 region, call `align-regexp' and type in that regular expression."
959 ;;;###autoload
961 "Align the selected region as if it were one alignment section.
962 BEG and END mark the extent of the region. If RULES or EXCLUDE-RULES
963 is set to a list of rules (see `align-rules-list'), it can be used to
964 override the default alignment rules that would have been used to
965 align that section."
969 ;;;###autoload
971 "Call `align' on the current alignment section.
972 This function assumes you want to align only the current section, and
973 so saves you from having to specify the region. If RULES or
974 EXCLUDE-RULES is set to a list of rules (see `align-rules-list'), it
975 can be used to override the default alignment rules that would have
976 been used to align that section."
980 ;;;###autoload
982 "Highlight the whitespace which a given rule would have modified.
983 BEG and END mark the extent of the region. TITLE identifies the rule
984 that should be highlighted. If RULES or EXCLUDE-RULES is set to a
985 list of rules (see `align-rules-list'), it can be used to override the
986 default alignment rules that would have been used to identify the text
987 to be colored."
991 "Title of rule to highlight: "
1001 align-exclude-rules-list)))
1002 face)
1005 beg end 'entire
1008 align-exclude-rules-list)
1011 align-exclude-rules-list))
1017 align-highlight-nochange-face))
1028 ;;;###autoload
1030 "Remove any highlighting that was added by `align-highlight-rule'."
1037 ;;;###autoload
1039 "A replacement function for `newline-and-indent', aligning as it goes."
1044 align-region-separate)
1055 ;;; Internal Functions:
1058 "Match REGEXP in TeX mode, counting backslashes appropriately.
1059 END denotes the end of the region to be searched, while REVERSE, if
1060 non-nil, indicates that the search should proceed backward from the
1061 current position."
1077 result))
1080 "Is there a section divider between BEG and END?
1081 SEPARATOR specifies how to look for the section divider. See the
1082 documentation for `align-region-separate' for more details."
1085 nil)
1106 yes))))
1109 "Adjust COLUMN according to the given RULE.
1110 SPACING specifies how much spacing to use.
1111 TAB-STOP specifies whether SPACING refers to tab-stop boundaries."
1115 column
1123 stops nil)
1125 column)))
1128 "Given a position in the buffer, state what column it's in.
1129 POS is the position whose column will be taken. Note that this
1130 function will change the location of point."
1135 "Align the regions specified in REGIONS, a list of cons cells.
1136 PROPS describes formatting features specific to the given regions.
1137 RULE specifies exactly how to perform the alignments.
1138 If FUNC is specified, it will be called with each region that would
1139 have been aligned, rather than modifying the text."
1147 "Given a list of AREAS and formatting PROPS, align according to RULE.
1148 AREAS should be a list of cons cells containing beginning and ending
1149 markers. This function sweeps through all of the beginning markers,
1150 finds out which one starts in the furthermost column, and then deletes
1151 and inserts text such that all of the ending markers occur in the same
1152 column.
1154 If FUNC is non-nil, it will be called for each text region that would
1155 have been aligned. No changes will be made to the buffer."
1159 column))
1163 ecol change look)
1165 ;; Determine the alignment column.
1190 ;; Make all ending positions to occur in the goal column. Since
1191 ;; the whitespace to be modified was already deleted by
1192 ;; `align-region', all we have to do here is indent.
1215 ;; FIXME: It is stated above that "...the
1216 ;; whitespace to be modified was already
1217 ;; deleted by `align-region', all we have
1218 ;; to do here is indent." However, this
1219 ;; doesn't seem to be true, so we first
1220 ;; delete the whitespace to avoid tabs
1221 ;; after spaces.
1225 ;; This code works around an oddity in the
1226 ;; FORCE argument of `move-to-column', which
1227 ;; tends to screw up markers if there is any
1228 ;; tabbing.
1250 "Align a region based on a given set of alignment rules.
1251 BEG and END specify the region to be aligned. Either may be nil, in
1252 which case the range will stop at the nearest section division (see
1253 `align-region-separate', and `align-region-heuristic' for more
1254 information').
1256 The region will be divided into separate alignment sections based on
1257 the value of SEPARATE.
1259 RULES and EXCLUDE-RULES are a pair of lists describing how to align
1260 the region, and which text areas within it should be excluded from
1261 alignment. See the `align-rules-list' for more information on the
1262 required format of these two lists.
1264 If FUNC is specified, no text will be modified. What `align-region'
1265 will do with the rules is to search for the alignment areas, as it
1266 regularly would, taking account for exclusions, and then call FUNC,
1267 first with the beginning and ending of the region to be aligned
1268 according to that rule (this can be different for each rule, if BEG
1269 and END were nil), and then with the beginning and ending of each
1270 text region that the rule would have applied to.
1272 The signature of FUNC should thus be:
1274 (defun my-align-function (beg end mode)
1276 Otherwise BEG to END will be a region of text that matches the rule's
1278 (unless (and mode (listp mode))
1281 This feature (of passing a FUNC) is used internally to locate the
1282 position of exclusion areas, but could also be used for any other
1283 purpose where you might want to know where the regions that the
1284 aligner would have dealt with are."
1298 ;; unless the `run-if' form tells us not to, look for the
1299 ;; rule..
1310 group group-c
1311 spacing spacing-c
1312 tab-stop tab-stop-c
1313 repeat repeat-c
1314 valid valid-c
1315 pos-list first
1316 regions index
1317 last-point b e
1318 save-match-data
1319 exclude-p
1320 align-props)
1322 ;; if beg and end were not given, figure out what the
1323 ;; current alignment region should be. Depending on the
1324 ;; value of `align-region-separate' it's possible for
1325 ;; each rule to have its own definition of what that
1326 ;; current alignment section is.
1342 align-region-heuristic))))
1346 terminus t))))
1349 here nil)
1361 align-region-heuristic))))
1367 here nil)
1376 ;; If we have a region to align, and `func' is set and
1377 ;; reports back that the region is ok, then align it.
1382 ;; determine first of all where the exclusions
1383 ;; lie in this region
1385 ;; guard against a problem with recursion and
1386 ;; dynamic binding vs. lexical binding, since
1387 ;; the call to `align-region' below will
1388 ;; re-enter this function, and rebind
1389 ;; `exclude-areas'
1392 nil)
1394 beg end 'entire
1395 exclude-rules nil
1407 ;; set `case-fold-search' according to the
1408 ;; (optional) `case-fold' property
1412 ;; while we can find the rule in the alignment
1413 ;; region..
1418 end-mark t)))
1420 ;; give the user some indication of where we
1421 ;; are, if it's a very large region being
1422 ;; aligned
1427 "Aligning `%s' (rule %d of %d) %d%%..."
1432 "Aligning %d%%..."
1436 ;; if the search ended us on the beginning of
1437 ;; the next line, move back to the end of the
1438 ;; previous line.
1442 ;; lookup the `group' attribute the first time
1443 ;; that we need it
1453 spacing-c t))
1462 align-to-tab-stop)))
1463 tab-stop-c t))
1465 ;; test whether we have found a match on the same
1466 ;; line as a previous match
1473 ;; lookup the `repeat' attribute the first time
1476 repeat-c t))
1478 ;; lookup the `valid' attribute the first time
1481 valid-c t))
1483 ;; remember the beginning position of this rule
1484 ;; match, and save the match-data, since either
1485 ;; the `valid' form, or the code that searches for
1486 ;; section separation, might alter it
1490 ;; unless the `valid' attribute is set, and tells
1491 ;; us that the rule is not valid at this point in
1492 ;; the code..
1495 ;; look to see if this match begins a new
1496 ;; section. If so, we should align what we've
1497 ;; collected so far, and then begin collecting
1498 ;; anew for the next alignment section
1501 thissep))
1504 rule func)
1506 regions nil
1507 align-props nil))
1510 ;; restore the match data
1513 ;; check whether the region to be aligned
1514 ;; straddles an exclusion area
1523 excls nil)
1526 ;; go through the list of parenthesis groups
1527 ;; matching whitespace text to be
1528 ;; contracted/expanded (or possibly
1529 ;; justified, if the `justify' attribute was
1530 ;; set)
1535 ;; we have to use markers, since
1536 ;; `align-areas' may modify the buffer
1541 ;; record this text region for alignment
1547 spacing)
1550 tab-stop))))
1564 ;; if any further rule matches are
1565 ;; found before `eol', then they are
1566 ;; on the same line as this one; this
1567 ;; can only happen if the `repeat'
1568 ;; attribute is non-nil
1575 ;; if `repeat' has not been set, move to
1576 ;; the next line; don't bother searching
1577 ;; anymore on this one
1581 ;; when they are no more matches for this rule,
1582 ;; align whatever was left over
1593 ;; Provide:
1599 ;; arch-tag: ef79cccf-1db8-4888-a8a1-d7ce2d1532f7
1600 ;;; align.el ends here