| blob | 7e0da7084865f6ebab08c1bfebea26555d2b41c0 |
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, or (at your option)
15 ;; 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; This mode allows you to align regions in a context-sensitive fashion.
30 ;; The classic use is to align assignments:
31 ;;
32 ;; int a = 1;
33 ;; short foo = 2;
34 ;; double blah = 4;
35 ;;
36 ;; becomes
37 ;;
38 ;; int a = 1;
39 ;; short foo = 2;
40 ;; double blah = 4;
42 ;;; Usage:
44 ;; There are several variables which define how certain "categories"
45 ;; of syntax are to be treated. These variables go by the name
46 ;; `align-CATEGORY-modes'. For example, "c++" is such a category.
47 ;; There are several rules which apply to c++, but since several other
48 ;; languages have a syntax similar to c++ (e.g., c, java, etc), these
49 ;; modes are treated as belonging to the same category.
50 ;;
51 ;; If you want to add a new mode under a certain category, just
52 ;; customize that list, or add the new mode manually. For example, to
53 ;; make jde-mode a c++ category mode, use this code in your .emacs
54 ;; file:
55 ;;
56 ;; (setq align-c++-modes (cons 'jde-mode align-c++-modes))
58 ;; In some programming modes, it's useful to have the aligner run only
59 ;; after indentation is performed. To achieve this, customize or set
60 ;; the variable `align-indent-before-aligning' to t.
62 ;;; Module Authors:
64 ;; In order to incorporate align's functionality into your own
65 ;; modules, there are only a few steps you have to follow.
67 ;; 1. Require or load in the align.el library.
68 ;;
69 ;; 2. Define your alignment and exclusion rules lists, either
70 ;; customizable or not.
71 ;;
72 ;; 3. In your mode function, set the variables
73 ;; `align-mode-rules-list' and `align-mode-exclude-rules-list'
74 ;; to your own rules lists.
76 ;; If there is any need to add your mode name to one of the
77 ;; align-?-modes variables (for example, `align-dq-string-modes'), use
78 ;; `add-to-list', or some similar function which checks first to see
79 ;; if the value is already there. Since the user may customize that
80 ;; mode list, and then write your mode name into their .emacs file,
81 ;; causing the symbol already to be present the next time they load
82 ;; your package.
84 ;; Example:
85 ;;
86 ;; (require 'align)
87 ;;
88 ;; (defcustom my-align-rules-list
89 ;; '((my-rule
90 ;; (regexp . "Sample")))
91 ;; :type align-rules-list-type
92 ;; :group 'my-package)
93 ;;
94 ;; (put 'my-align-rules-list 'risky-local-variable t)
95 ;;
96 ;; (add-to-list 'align-dq-string-modes 'my-package-mode)
97 ;; (add-to-list 'align-open-comment-modes 'my-package-mode)
98 ;;
99 ;; (defun my-mode ()
100 ;; ...
101 ;; (setq align-mode-rules-list my-align-rules-list))
102 ;;
103 ;; Note that if you need to install your own exclusion rules, then you
104 ;; will also need to reproduce any double-quoted string, or open
105 ;; comment exclusion rules that are defined in the standard
106 ;; `align-exclude-rules-list'. At the moment there is no convenient
107 ;; way to mix both mode-local and global rules lists.
109 ;;; History:
111 ;; Version 1.0 was created in the earlier part of 1996, using a very
112 ;; simple algorithm that understand only basic regular expressions.
113 ;; Parts of the code were broken up and included in vhdl-mode.el
114 ;; around this time. After several comments from users, and a need to
115 ;; find a more robust, performant algorithm, 2.0 was born in late
116 ;; 1998. Many different approaches were taken (mostly due to the
117 ;; complexity of TeX tables), but finally a scheme was discovered
118 ;; which worked fairly well for most common usage cases. Development
119 ;; beyond version 2.8 is not planned, except for problems that users
120 ;; might encounter.
122 ;;; Code:
125 "Align text to a specific column, by regexp."
129 ;;; User Variables:
132 "*Hook that gets run after the aligner has been loaded."
137 "*If non-nil, indent the marked region before aligning it."
142 "*An integer that represents the default amount of padding to use.
143 If `align-to-tab-stop' is non-nil, this will represent the number of
144 tab stops to use for alignment, rather than the number of spaces.
145 Each alignment rule can optionally override both this variable. See
146 `align-mode-alist'."
151 "*If non-nil, alignments will always fall on a tab boundary.
152 It may also be a symbol, whose value will be taken."
157 "*If non-nil, used as a heuristic by `align-current'.
158 Since each alignment rule can possibly have its own set of alignment
159 sections (whenever `align-region-separate' is non-nil, and not a
160 string), this heuristic is used to determine how far before and after
161 point we should search in looking for a region separator. Larger
162 values can mean slower perform in large files, although smaller values
163 may cause unexpected behavior at times."
168 "*The face to highlight with if changes are necessary."
173 "*The face to highlight with if no changes are necessary."
179 If nil,then no messages will ever be printed to the minibuffer."
184 "*A list of modes whose syntax resembles C/C++."
189 "*A list of modes where perl syntax is to be seen."
195 "*A list of modes whose syntax resembles Lisp."
201 "*A list of modes whose syntax resembles TeX (and family)."
206 "*A list of modes whose content is plain text."
213 "*A list of modes where double quoted strings should be excluded."
219 "*A list of modes where single quoted strings should be excluded."
226 "*A list of modes with a single-line comment syntax.
227 These are comments as in Lisp, which have a beginning but, end with
228 the line (i.e., `comment-end' is an empty string)."
233 "*Select the method by which alignment sections will be separated.
234 If this is a symbol, that symbol's value will be used.
236 For the sake of clarification, consider the following example, which
237 will be referred to in the descriptions below.
239 int alpha = 1; /* one */
240 double beta = 2.0;
241 long gamma; /* ten */
243 unsigned int delta = 1; /* one */
244 long double epsilon = 3.0;
245 long long omega; /* ten */
247 The possible settings for `align-region-separate' are:
249 `entire' The entire region being aligned will be considered as a
250 single alignment section. Assuming that comments were not
251 being aligned to a particular column, the example would
252 become:
254 int alpha = 1; /* one */
255 double beta = 2.0;
256 long gamma; /* ten */
258 unsigned int delta = 1; /* one */
259 long double epsilon;
260 long long chi = 10; /* ten */
262 `group' Each contiguous set of lines where a specific alignment
263 occurs is considered a section for that alignment rule.
264 Note that each rule will may have any entirely different
265 set of section divisions than another.
267 int alpha = 1; /* one */
268 double beta = 2.0;
269 long gamma; /* ten */
271 unsigned int delta = 1; /* one */
272 long double epsilon;
273 long long chi = 10; /* ten */
275 `largest' When contiguous rule sets overlap, the largest section
276 described will be taken as the alignment section for each
277 rule touched by that section.
279 int alpha = 1; /* one */
280 double beta = 2.0;
281 long gamma; /* ten */
283 unsigned int delta = 1; /* one */
284 long double epsilon;
285 long long chi = 10; /* ten */
287 NOTE: This option is not supported yet, due to algorithmic
288 issues which haven't been satisfactorily resolved. There
289 are ways to do it, but they're both ugly and resource
290 consumptive.
292 regexp A regular expression string which defines the section
293 divider. If the mode you're in has a consistent divider
294 between sections, the behavior will be very similar to
295 `largest', and faster. But if the mode does not use clear
296 separators (for example, if you collapse your braces onto
297 the preceding statement in C or perl), `largest' is
298 probably the better alternative.
300 function A function that will be passed the beginning and ending
301 locations of the region in which to look for the section
302 separator. At the very beginning of the attempt to align,
303 both of these parameters will be nil, in which case the
304 function should return non-nil if it wants each rule to
305 define its own section, or nil if it wants the largest
306 section found to be used as the common section for all rules
307 that occur there.
309 list A list of markers within the buffer that represent where
310 the section dividers lie. Be certain to use markers! For
311 when the aligning begins, the ensuing contract/expanding of
312 whitespace will throw off any non-marker positions.
314 This method is intended for use in Lisp programs, and not
315 by the user."
319 ; (const largest)
340 repeat)
351 case-fold)
355 tab-stop)
359 valid)
363 run-if)
368 integer symbol))
374 justify)
376 ;; make sure this stays up-to-date with any changes
377 ;; in `align-region-separate'
380 separate)
384 ; (const largest)
385 regexp function)))))))
468 ; (valid
469 ; . ,(function
470 ; (lambda ()
471 ; (memq (caar (c-guess-basic-syntax))
472 ; '(brace-list-intro
473 ; brace-list-entry
474 ; brace-entry-open))))))
476 ;; With a prefix argument, comma delimiter will be aligned. Since
477 ;; perl-mode doesn't give us enough syntactic information (and we
478 ;; don't do our own parsing yet), this rule is too destructive to
479 ;; run normally.
527 ; (valid
528 ; . ,(function
529 ; (lambda ()
530 ; (memq (caar (c-guess-basic-syntax))
531 ; '(cpp-macro cpp-macro-cont))))))
560 ;; With a numeric prefix argument, or C-u, space delimited text
561 ;; tables will be aligned.
572 ;; With a negative prefix argument, lists of dollar figures will
573 ;; be aligned.
586 "*A list describing all of the available alignment rules.
587 The format is:
589 ((TITLE
590 (ATTRIBUTE . VALUE) ...)
591 ...)
593 The following attributes are meaningful:
595 `regexp' This required attribute must be either a string describing
596 a regular expression, or a function (described below).
597 For every line within the section that this regular
598 expression matches, the given rule will be applied to that
599 line. The exclusion rules denote which part(s) of the
600 line should not be modified; the alignment rules cause the
601 identified whitespace group to be contracted/expanded such
603 immediately following the identified parenthesis group),
604 occurs in the same column for every line within the
605 alignment section (see `align-region-separate' for a
606 description of how the region is broken up into alignment
607 sections).
609 The `regexp' attribute describes how the text should be
610 treated. Within this regexp, there must be at least one
611 group of characters (typically whitespace) identified by
612 the special opening and closing parens used in regexp
614 the syntax of regular expressions for more info).
616 If `regexp' is a function, it will be called as a
617 replacement for `re-search-forward'. This means that it
618 should return nil if nothing is found to match the rule,
619 or it should set the match data appropriately, move point
620 to the end of the match, and return the value of point.
622 `group' For exclusion rules, the group identifies the range of
623 characters that should be ignored. For alignment rules,
624 these are the characters that will be deleted/expanded for
626 always the first character immediately following this
627 parenthesis group. This attribute may also be a list of
628 integer, in which case multiple alignment characters will
629 be aligned, with the list of integer identifying the
630 whitespace groups which precede them. The default for
631 this attribute is 1.
633 `modes' The `modes' attribute, if set, should name a list of
634 major modes -- or evaluate to such a value -- in which the
635 rule is valid. If not set, the rule will apply to all
636 modes.
638 `case-fold' If `regexp' is an ordinary regular expression string
639 containing alphabetic character, sometimes you may want
640 the search to proceed case-insensitively (for languages
641 that ignore case, such as pascal for example). In that
642 case, set `case-fold' to a non-nil value, and the regular
643 expression search will ignore case. If `regexp' is set to
644 a function, that function must handle the job of ignoring
645 case by itself.
647 `tab-stop' If the `tab-stop' attribute is set, and non-nil, the
648 alignment character will always fall on a tab stop
649 (whether it uses tabs to get there or not depends on the
650 value of `indent-tabs-mode'). If the `tab-stop' attribute
651 is set to nil, tab stops will never be used. Otherwise,
652 the value of `align-to-tab-stop' determines whether or not
653 to align to a tab stop. The `tab-stop' attribute may also
654 be a list of t or nil values, corresponding to the number
655 of parenthesis groups specified by the `group' attribute.
657 `repeat' If the `repeat' attribute is present, and non-nil, the
658 rule will be applied to the line continuously until no
659 further matches are found.
661 `valid' If the `valid' attribute is set, it will be used to
662 determine whether the rule should be invoked. This form
663 is evaluated after the regular expression match has been
664 performed, so that it is possible to use the results of
665 that match to determine whether the alignment should be
666 performed. The buffer should not be modified during the
667 evaluation of this form.
669 `run-if' Like `valid', the `run-if' attribute tests whether the
670 rule should be run at all -- even before any searches are
671 done to determine if the rule applies to the alignment
672 region. This can save time, since `run-if' will only be
673 run once for each rule. If it returns nil, the rule will
674 not be attempted.
676 `column' For alignment rules, if the `column' attribute is set --
677 which must be an integer, or a symbol whose value is an
678 integer -- it will be used as the column in which to align
679 the alignment character. If the text on a particular line
680 happens to overrun that column, a single space character,
681 or tab stop (see `align-to-tab-stop') will be added
682 between the last text character and the alignment
683 character.
685 `spacing' Alignment rules may also override the amount of spacing
686 that would normally be used by providing a `spacing'
687 attribute. This must be an integer, or a list of integers
688 corresponding to the number of parenthesis groups matched
689 by the `group' attribute. If a list of value is used, and
690 any of those values is nil, `align-default-spacing' will
691 be used for that subgroup. See `align-default-spacing'
692 for more details on spacing, tab stops, and how to
693 indicate how much spacing should be used. If TAB-STOP is
694 present, it will override the value of `align-to-tab-stop'
695 for that rule.
697 `justify' It is possible with `regexp' and `group' to identify a
698 character group that contains more than just whitespace
699 characters. By default, any non-whitespace characters in
700 that group will also be deleted while aligning the
701 alignment character. However, if the `justify' attribute
702 is set to a non-nil value, only the initial whitespace
703 characters within that group will be deleted. This has
704 the effect of right-justifying the characters that remain,
705 and can be used for outdenting or just plain old right-
706 justification.
708 `separate' Each rule can define its own section separator, which
710 within the region to be aligned. Setting the `separate'
711 attribute overrides the value of `align-region-separate'
712 (see the documentation of that variable for possible
713 values), and any separation argument passed to `align'."
714 :type align-rules-list-type
733 repeat)
744 case-fold)
784 "*A list describing text that should be excluded from alignment.
785 See the documentation for `align-rules-list' for more info."
786 :type align-exclude-rules-list-type
791 ;;; Internal Variables:
794 "Alignment rules specific to the current major mode.
800 "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))
895 align-mode-exclude-rules-list
896 align-exclude-rules-list) nil
897 separator
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. This function will prompt
913 for the REGEXP to align with. If no prefix arg was specified, you
914 only need to supply the characters to be lined up and any preceding
915 whitespace is replaced. If a prefix arg was specified, the full
916 regexp with parenthesized whitespace should be supplied; it will also
917 prompt for which parenthesis GROUP within REGEXP to modify, the amount
918 of SPACING to use, and whether or not to REPEAT the rule throughout
919 the line. See `align-rules-list' for more information about these
920 options.
922 For example, let's say you had a list of phone numbers, and wanted to
923 align them so that the opening parentheses would line up:
925 Fred (123) 456-7890
926 Alice (123) 456-7890
927 Mary-Anne (123) 456-7890
928 Joe (123) 456-7890
930 There is no predefined rule to handle this, but you could easily do it
932 region, call `align-regexp' and type in that regular expression."
961 ;;;###autoload
963 "Align the selected region as if it were one alignment section.
964 BEG and END mark the extent of the region. If RULES or EXCLUDE-RULES
965 is set to a list of rules (see `align-rules-list'), it can be used to
966 override the default alignment rules that would have been used to
967 align that section."
971 ;;;###autoload
973 "Call `align' on the current alignment section.
974 This function assumes you want to align only the current section, and
975 so saves you from having to specify the region. If RULES or
976 EXCLUDE-RULES is set to a list of rules (see `align-rules-list'), it
977 can be used to override the default alignment rules that would have
978 been used to align that section."
982 ;;;###autoload
984 "Highlight the whitespace which a given rule would have modified.
985 BEG and END mark the extent of the region. TITLE identifies the rule
986 that should be highlighted. If RULES or EXCLUDE-RULES is set to a
987 list of rules (see `align-rules-list'), it can be used to override the
988 default alignment rules that would have been used to identify the text
989 to be colored."
993 "Title of rule to highlight: "
1003 align-exclude-rules-list)))
1004 face)
1007 beg end 'entire
1010 align-exclude-rules-list)
1013 align-exclude-rules-list))
1019 align-highlight-nochange-face))
1030 ;;;###autoload
1032 "Remove any highlighting that was added by `align-highlight-rule'."
1039 ;;;###autoload
1041 "A replacement function for `newline-and-indent', aligning as it goes."
1046 align-region-separate)
1057 ;;; Internal Functions:
1060 "Match REGEXP in TeX mode, counting backslashes appropriately.
1061 END denotes the end of the region to be searched, while REVERSE, if
1062 non-nil, indicates that the search should proceed backward from the
1063 current position."
1079 result))
1082 "Is there a section divider between BEG and END?
1083 SEPARATOR specifies how to look for the section divider. See the
1084 documentation for `align-region-separate' for more details."
1087 nil)
1108 yes))))
1111 "Adjust COLUMN according to the given RULE.
1112 SPACING specifies how much spacing to use.
1113 TAB-STOP specifies whether SPACING refers to tab-stop boundaries."
1117 column
1125 stops nil)
1127 column)))
1130 "Given a position in the buffer, state what column it's in.
1131 POS is the position whose column will be taken. Note that this
1132 function will change the location of point."
1137 "Align the regions specified in REGIONS, a list of cons cells.
1138 PROPS describes formatting features specific to the given regions.
1139 RULE specifies exactly how to perform the alignments.
1140 If FUNC is specified, it will be called with each region that would
1141 have been aligned, rather than modifying the text."
1149 "Given a list of AREAS and formatting PROPS, align according to RULE.
1150 AREAS should be a list of cons cells containing beginning and ending
1151 markers. This function sweeps through all of the beginning markers,
1152 finds out which one starts in the furthermost column, and then deletes
1153 and inserts text such that all of the ending markers occur in the same
1154 column.
1156 If FUNC is non-nil, it will be called for each text region that would
1157 have been aligned. No changes will be made to the buffer."
1161 column))
1165 ecol change look)
1167 ;; Determine the alignment column.
1192 ;; Make all ending positions to occur in the goal column. Since
1193 ;; the whitespace to be modified was already deleted by
1194 ;; `align-region', all we have to do here is indent.
1217 ;; FIXME: It is stated above that "...the
1218 ;; whitespace to be modified was already
1219 ;; deleted by `align-region', all we have
1220 ;; to do here is indent." However, this
1221 ;; doesn't seem to be true, so we first
1222 ;; delete the whitespace to avoid tabs
1223 ;; after spaces.
1227 ;; This code works around an oddity in the
1228 ;; FORCE argument of `move-to-column', which
1229 ;; tends to screw up markers if there is any
1230 ;; tabbing.
1252 "Align a region based on a given set of alignment rules.
1253 BEG and END specify the region to be aligned. Either may be nil, in
1254 which case the range will stop at the nearest section division (see
1255 `align-region-separate', and `align-region-heuristic' for more
1256 information').
1258 The region will be divided into separate alignment sections based on
1259 the value of SEPARATE.
1261 RULES and EXCLUDE-RULES are a pair of lists describing how to align
1262 the region, and which text areas within it should be excluded from
1263 alignment. See the `align-rules-list' for more information on the
1264 required format of these two lists.
1266 If FUNC is specified, no text will be modified. What `align-region'
1267 will do with the rules is to search for the alignment areas, as it
1268 regularly would, taking account for exclusions, and then call FUNC,
1269 first with the beginning and ending of the region to be aligned
1270 according to that rule (this can be different for each rule, if BEG
1271 and END were nil), and then with the beginning and ending of each
1272 text region that the rule would have applied to.
1274 The signature of FUNC should thus be:
1276 (defun my-align-function (beg end mode)
1278 Otherwise BEG to END will be a region of text that matches the rule's
1280 (unless (and mode (listp mode))
1283 This feature (of passing a FUNC) is used internally to locate the
1284 position of exclusion areas, but could also be used for any other
1285 purpose where you might want to know where the regions that the
1286 aligner would have dealt with are."
1300 ;; unless the `run-if' form tells us not to, look for the
1301 ;; rule..
1312 group group-c
1313 spacing spacing-c
1314 tab-stop tab-stop-c
1315 repeat repeat-c
1316 valid valid-c
1317 pos-list first
1318 regions index
1319 last-point b e
1320 save-match-data
1321 exclude-p
1322 align-props)
1324 ;; if beg and end were not given, figure out what the
1325 ;; current alignment region should be. Depending on the
1326 ;; value of `align-region-separate' it's possible for
1327 ;; each rule to have its own definition of what that
1328 ;; current alignment section is.
1344 align-region-heuristic))))
1348 terminus t))))
1351 here nil)
1363 align-region-heuristic))))
1369 here nil)
1378 ;; If we have a region to align, and `func' is set and
1379 ;; reports back that the region is ok, then align it.
1384 ;; determine first of all where the exclusions
1385 ;; lie in this region
1387 ;; guard against a problem with recursion and
1388 ;; dynamic binding vs. lexical binding, since
1389 ;; the call to `align-region' below will
1390 ;; re-enter this function, and rebind
1391 ;; `exclude-areas'
1394 nil)
1396 beg end 'entire
1397 exclude-rules nil
1409 ;; set `case-fold-search' according to the
1410 ;; (optional) `case-fold' property
1414 ;; while we can find the rule in the alignment
1415 ;; region..
1420 end-mark t)))
1422 ;; give the user some indication of where we
1423 ;; are, if it's a very large region being
1424 ;; aligned
1429 "Aligning `%s' (rule %d of %d) %d%%..."
1434 "Aligning %d%%..."
1438 ;; if the search ended us on the beginning of
1439 ;; the next line, move back to the end of the
1440 ;; previous line.
1444 ;; lookup the `group' attribute the first time
1445 ;; that we need it
1455 spacing-c t))
1464 align-to-tab-stop)))
1465 tab-stop-c t))
1467 ;; test whether we have found a match on the same
1468 ;; line as a previous match
1475 ;; lookup the `repeat' attribute the first time
1478 repeat-c t))
1480 ;; lookup the `valid' attribute the first time
1483 valid-c t))
1485 ;; remember the beginning position of this rule
1486 ;; match, and save the match-data, since either
1487 ;; the `valid' form, or the code that searches for
1488 ;; section separation, might alter it
1492 ;; unless the `valid' attribute is set, and tells
1493 ;; us that the rule is not valid at this point in
1494 ;; the code..
1497 ;; look to see if this match begins a new
1498 ;; section. If so, we should align what we've
1499 ;; collected so far, and then begin collecting
1500 ;; anew for the next alignment section
1503 thissep))
1506 rule func)
1508 regions nil
1509 align-props nil))
1512 ;; restore the match data
1515 ;; check whether the region to be aligned
1516 ;; straddles an exclusion area
1525 excls nil)
1528 ;; go through the list of parenthesis groups
1529 ;; matching whitespace text to be
1530 ;; contracted/expanded (or possibly
1531 ;; justified, if the `justify' attribute was
1532 ;; set)
1537 ;; we have to use markers, since
1538 ;; `align-areas' may modify the buffer
1543 ;; record this text region for alignment
1549 spacing)
1552 tab-stop))))
1566 ;; if any further rule matches are
1567 ;; found before `eol', then they are
1568 ;; on the same line as this one; this
1569 ;; can only happen if the `repeat'
1570 ;; attribute is non-nil
1577 ;; if `repeat' has not been set, move to
1578 ;; the next line; don't bother searching
1579 ;; anymore on this one
1583 ;; when they are no more matches for this rule,
1584 ;; align whatever was left over
1595 ;; Provide:
1601 ;; arch-tag: ef79cccf-1db8-4888-a8a1-d7ce2d1532f7
1602 ;;; align.el ends here