Variable: align-rules-list
align-rules-list is a customizable variable defined in align.el.gz.
Value
Large value
((lisp-second-arg
(regexp . "\\(^\\s-+[^( \n]\\|(\\(\\S-+\\)\\s-+\\)\\S-+\\(\\s-+\\)")
(group . 3)
(modes . align-lisp-modes)
(run-if .
#[0 "\207"
[current-prefix-arg]
1]))
(lisp-alist-dot
(regexp . "\\(\\s-*\\)\\.\\(\\s-*\\)")
(group 1 2)
(modes . align-lisp-modes))
(open-comment
(regexp .
#[514 "\211\203�\301\202 �\302\303\304!\305Q\306#\207"
[comment-start re-search-backward re-search-forward "[^ \n\\]" regexp-quote "\\(.+\\)$" t]
6 "\n\n(fn END REVERSE)"])
(modes . align-open-comment-modes))
(c-macro-definition
(regexp . "^\\s-*#\\s-*define\\s-+\\S-+\\(\\s-+\\)")
(modes . align-c++-modes))
(c-variable-declaration
(regexp . "[*&0-9A-Za-z_]>?[][&*]*\\(\\s-+[*&]*\\)[A-Za-z_][][0-9A-Za-z:_]*\\s-*\\(\\()\\|=[^=\n].*\\|(.*)\\|\\(\\[.*\\]\\)*\\)\\s-*[;,]\\|)\\s-*$\\)")
(group . 1)
(modes . align-c++-modes)
(justify . t)
(valid .
#[0 "\212\301\224b\210\302v\210\303\304!)\206\"�\203 �\305`\306\"\307=\202\"�\310 @@\311=?\207"
[font-lock-mode 1 -1 looking-at "\\(goto\\|return\\|new\\|delete\\|throw\\)" get-text-property face font-lock-comment-face c-guess-basic-syntax c]
3]))
(c-assignment
(regexp . "[^-=!^&*+<>/| \n]\\(\\s-*[-=!^&*+<>/|]*\\)=\\(\\s-*\\)\\([^= \n]\\|$\\)")
(group 1 2)
(modes . align-c++-modes)
(justify . t)
(tab-stop))
(perl-assignment
(regexp . "[^=!^&*+<>/| \n-]\\(\\s-*\\)=[~>]?\\(\\s-*\\)\\([^>= \n]\\|$\\)")
(group 1 2)
(modes . align-perl-modes)
(tab-stop))
(python-assignment
(regexp . "[^=!<> \n]\\(\\s-*\\)=\\(\\s-*\\)\\([^>= \n]\\|$\\)")
(group 1 2)
(modes quote
(python-mode))
(tab-stop))
(make-assignment
(regexp . "^\\s-*\\w+\\(\\s-*\\):?=\\(\\s-*\\)\\([^ \n \\]\\|$\\)")
(group 1 2)
(modes quote
(makefile-mode))
(tab-stop))
(c-comma-delimiter
(regexp . ",\\(\\s-*\\)[^/ \n]")
(repeat . t)
(modes . align-c++-modes)
(run-if .
#[0 "\207"
[current-prefix-arg]
1]))
(basic-comma-delimiter
(regexp . ",\\(\\s-*\\)[^# \n]")
(repeat . t)
(modes append align-perl-modes
'(python-mode))
(run-if .
#[0 "\207"
[current-prefix-arg]
1]))
(c++-comment
(regexp . "\\(\\s-*\\)\\(//.*\\|/\\*.*\\*/\\s-*\\)$")
(modes . align-c++-modes)
(column . comment-column)
(valid .
#[0 "\212\300\224b\210n)?\207"
[1]
1]))
(c-chain-logic
(regexp . "\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
(modes . align-c++-modes)
(valid .
#[0 "\212\300\225b\210\301\302!)\207"
[2 looking-at "\\s-*\\(/[*/]\\|$\\)"]
2]))
(perl-chain-logic
(regexp . "\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
(modes . align-perl-modes)
(valid .
#[0 "\212\300\225b\210\301\302!)\207"
[2 looking-at "\\s-*\\(#\\|$\\)"]
2]))
(python-chain-logic
(regexp . "\\(\\s-*\\)\\(\\<and\\>\\|\\<or\\>\\)")
(modes quote
(python-mode))
(valid .
#[0 "\212\300\225b\210\301\302!)\207"
[2 looking-at "\\s-*\\(#\\|$\\|\\\\\\)"]
2]))
(c-macro-line-continuation
(regexp . "\\(\\s-*\\)\\\\$")
(modes . align-c++-modes)
(column . c-backslash-column))
(basic-line-continuation
(regexp . "\\(\\s-*\\)\\\\$")
(modes quote
(python-mode makefile-mode)))
(tex-record-separator
(regexp .
#[514 "\300\301#\207"
[align-match-tex-pattern "&"]
6 "\n\n(fn END REVERSE)"])
(group 1 2)
(modes . align-tex-modes)
(repeat . t))
(tex-tabbing-separator
(regexp .
#[514 "\300\301#\207"
[align-match-tex-pattern "\\\\[=>]"]
6 "\n\n(fn END REVERSE)"])
(group 1 2)
(modes . align-tex-modes)
(repeat . t)
(run-if .
#[0 "\301=\207"
[major-mode latex-mode]
2]))
(tex-record-break
(regexp . "\\(\\s-*\\)\\\\\\\\")
(modes . align-tex-modes))
(text-column
(regexp . "\\(^\\|\\S-\\)\\([ ]+\\)\\(\\S-\\|$\\)")
(group . 2)
(modes . align-text-modes)
(repeat . t)
(run-if .
#[0 "\205�\301=?\207"
[current-prefix-arg -]
2]))
(text-dollar-figure
(regexp . "\\$?\\(\\s-+[0-9]+\\)\\.")
(modes . align-text-modes)
(justify . t)
(run-if .
#[0 "\301=\207"
[current-prefix-arg -]
2]))
(css-declaration
(regexp . "^\\s-*\\(?:\\w-?\\)+:\\(\\s-*\\).*;")
(group 1)
(modes quote
(css-mode html-mode))))
Documentation
A list describing all of the available alignment rules.
The format is:
((TITLE
(ATTRIBUTE . VALUE) ...)
...)
The following attributes are meaningful:
regexp This required attribute must be either a string describing
a regular expression, or a function (described below).
For every line within the section that this regular
expression matches, the given rule will be applied to that
line. The exclusion rules denote which part(s) of the
line should not be modified; the alignment rules cause the
identified whitespace group to be contracted/expanded such
that the "alignment character" (the character
immediately following the identified parenthesis group),
occurs in the same column for every line within the
alignment section (see align-region-separate for a
description of how the region is broken up into alignment
sections).
The regexp attribute describes how the text should be
treated. Within this regexp, there must be at least one
group of characters (typically whitespace) identified by
the special opening and closing parens used in regexp
expressions (\\( and \\)) (see the Emacs manual on
the syntax of regular expressions for more info).
If regexp is a function, it will be called as a
replacement for re-search-forward. This means that it
should return nil if nothing is found to match the rule,
or it should set the match data appropriately, move point
to the end of the match, and return the value of point.
group For exclusion rules, the group identifies the range of
characters that should be ignored. For alignment rules,
these are the characters that will be deleted/expanded for
the purposes of alignment. The "alignment character" is
always the first character immediately following this
parenthesis group. This attribute may also be a list of
integers, in which case multiple alignment characters will
be aligned, with the list of integers identifying the
whitespace groups which precede them. The default for
this attribute is 1.
modes The modes attribute, if set, should name a list of
major modes -- or evaluate to such a value -- in which the
rule is valid. If not set, the rule will apply to all
modes.
case-fold If regexp is an ordinary regular expression string
containing alphabetic character, sometimes you may want
the search to proceed case-insensitively (for languages
that ignore case, such as Pascal for example). In that
case, set case-fold to a non-nil value, and the regular
expression search will ignore case. If regexp is set to
a function, that function must handle the job of ignoring
case by itself.
tab-stop If the tab-stop attribute is set, and non-nil, the
alignment character will always fall on a tab stop
(whether it uses tabs to get there or not depends on the
value of indent-tabs-mode). If the tab-stop attribute
is set to nil, tab stops will never be used. Otherwise,
the value of align-to-tab-stop determines whether or not
to align to a tab stop. The tab-stop attribute may also
be a list of t or nil values, corresponding to the number
of parenthesis groups specified by the group attribute.
repeat If the repeat attribute is present, and non-nil, the
rule will be applied to the line continuously until no
further matches are found.
valid If the valid attribute is set, it will be used to
determine whether the rule should be invoked. This form
is evaluated after the regular expression match has been
performed, so that it is possible to use the results of
that match to determine whether the alignment should be
performed. The buffer should not be modified during the
evaluation of this form.
run-if Like valid, the run-if attribute tests whether the
rule should be run at all -- even before any searches are
done to determine if the rule applies to the alignment
region. This can save time, since run-if will only be
run once for each rule. If it returns nil, the rule will
not be attempted.
column For alignment rules, if the column attribute is set --
which must be an integer, or a symbol whose value is an
integer -- it will be used as the column in which to align
the alignment character. If the text on a particular line
happens to overrun that column, a single space character,
or tab stop (see align-to-tab-stop) will be added
between the last text character and the alignment
character.
spacing Alignment rules may also override the amount of spacing
that would normally be used by providing a spacing
attribute. This must be an integer, or a list of integers
corresponding to the number of parenthesis groups matched
by the group attribute. If a list of value is used, and
any of those values is nil, align-default-spacing will
be used for that subgroup. See align-default-spacing
for more details on spacing, tab stops, and how to
indicate how much spacing should be used. If TAB-STOP is
present, it will override the value of align-to-tab-stop
for that rule.
justify It is possible with regexp and group to identify a
character group that contains more than just whitespace
characters. By default, any non-whitespace characters in
that group will also be deleted while aligning the
alignment character. However, if the justify attribute
is set to a non-nil value, only the initial whitespace
characters within that group will be deleted. This has
the effect of right-justifying the characters that remain,
and can be used for outdenting or just plain old right-
justification.
separate Each rule can define its own section separator, which
describes how to identify the separation of "sections"
within the region to be aligned. Setting the separate
attribute overrides the value of align-region-separate
(see the documentation of that variable for possible
values), and any separation argument passed to align.
Source Code
;; Defined in /usr/src/emacs/lisp/align.el.gz
(defcustom align-rules-list
`((lisp-second-arg
(regexp . "\\(^\\s-+[^( \t\n]\\|(\\(\\S-+\\)\\s-+\\)\\S-+\\(\\s-+\\)")
(group . 3)
(modes . align-lisp-modes)
(run-if . ,(lambda () current-prefix-arg)))
(lisp-alist-dot
(regexp . "\\(\\s-*\\)\\.\\(\\s-*\\)")
(group . (1 2))
(modes . align-lisp-modes))
(open-comment
(regexp . ,(lambda (end reverse)
(funcall (if reverse 're-search-backward
're-search-forward)
(concat "[^ \t\n\\]"
(regexp-quote comment-start)
"\\(.+\\)$") end t)))
(modes . align-open-comment-modes))
(c-macro-definition
(regexp . "^\\s-*#\\s-*define\\s-+\\S-+\\(\\s-+\\)")
(modes . align-c++-modes))
(c-variable-declaration
(regexp . ,(concat "[*&0-9A-Za-z_]>?[][&*]*\\(\\s-+[*&]*\\)"
"[A-Za-z_][][0-9A-Za-z:_]*\\s-*\\(\\()\\|"
"=[^=\n].*\\|(.*)\\|\\(\\[.*\\]\\)*\\)"
"\\s-*[;,]\\|)\\s-*$\\)"))
(group . 1)
(modes . align-c++-modes)
(justify . t)
(valid
. ,(lambda ()
(not (or (save-excursion
(goto-char (match-beginning 1))
(backward-word 1)
(looking-at
"\\(goto\\|return\\|new\\|delete\\|throw\\)"))
(if font-lock-mode
(eq (get-text-property (point) 'face)
'font-lock-comment-face)
(eq (caar (c-guess-basic-syntax)) 'c)))))))
(c-assignment
(regexp . ,(concat "[^-=!^&*+<>/| \t\n]\\(\\s-*[-=!^&*+<>/|]*\\)"
"=\\(\\s-*\\)\\([^= \t\n]\\|$\\)"))
(group . (1 2))
(modes . align-c++-modes)
(justify . t)
(tab-stop . nil))
(perl-assignment
(regexp . ,(concat "[^=!^&*+<>/| \t\n-]\\(\\s-*\\)=[~>]?"
"\\(\\s-*\\)\\([^>= \t\n]\\|$\\)"))
(group . (1 2))
(modes . align-perl-modes)
(tab-stop . nil))
(python-assignment
(regexp . ,(concat "[^=!<> \t\n]\\(\\s-*\\)="
"\\(\\s-*\\)\\([^>= \t\n]\\|$\\)"))
(group . (1 2))
(modes . '(python-mode))
(tab-stop . nil))
(make-assignment
(regexp . "^\\s-*\\w+\\(\\s-*\\):?=\\(\\s-*\\)\\([^\t\n \\]\\|$\\)")
(group . (1 2))
(modes . '(makefile-mode))
(tab-stop . nil))
(c-comma-delimiter
(regexp . ",\\(\\s-*\\)[^/ \t\n]")
(repeat . t)
(modes . align-c++-modes)
(run-if . ,(lambda () current-prefix-arg)))
; (valid
; . ,(lambda ()
; (memq (caar (c-guess-basic-syntax))
; '(brace-list-intro
; brace-list-entry
; brace-entry-open)))))
;; With a prefix argument, comma delimiter will be aligned. Since
;; perl-mode doesn't give us enough syntactic information (and we
;; don't do our own parsing yet), this rule is too destructive to
;; run normally.
(basic-comma-delimiter
(regexp . ",\\(\\s-*\\)[^# \t\n]")
(repeat . t)
(modes . (append align-perl-modes '(python-mode)))
(run-if . ,(lambda () current-prefix-arg)))
(c++-comment
(regexp . "\\(\\s-*\\)\\(//.*\\|/\\*.*\\*/\\s-*\\)$")
(modes . align-c++-modes)
(column . comment-column)
(valid . ,(lambda ()
(save-excursion
(goto-char (match-beginning 1))
(not (bolp))))))
(c-chain-logic
(regexp . "\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
(modes . align-c++-modes)
(valid . ,(lambda ()
(save-excursion
(goto-char (match-end 2))
(looking-at "\\s-*\\(/[*/]\\|$\\)")))))
(perl-chain-logic
(regexp . "\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)")
(modes . align-perl-modes)
(valid . ,(lambda ()
(save-excursion
(goto-char (match-end 2))
(looking-at "\\s-*\\(#\\|$\\)")))))
(python-chain-logic
(regexp . "\\(\\s-*\\)\\(\\<and\\>\\|\\<or\\>\\)")
(modes . '(python-mode))
(valid . ,(lambda ()
(save-excursion
(goto-char (match-end 2))
(looking-at "\\s-*\\(#\\|$\\|\\\\\\)")))))
(c-macro-line-continuation
(regexp . "\\(\\s-*\\)\\\\$")
(modes . align-c++-modes)
(column . c-backslash-column))
; (valid
; . ,(lambda ()
; (memq (caar (c-guess-basic-syntax))
; '(cpp-macro cpp-macro-cont)))))
(basic-line-continuation
(regexp . "\\(\\s-*\\)\\\\$")
(modes . '(python-mode makefile-mode)))
(tex-record-separator
(regexp . ,(lambda (end reverse)
(align-match-tex-pattern "&" end reverse)))
(group . (1 2))
(modes . align-tex-modes)
(repeat . t))
(tex-tabbing-separator
(regexp . ,(lambda (end reverse)
(align-match-tex-pattern "\\\\[=>]" end reverse)))
(group . (1 2))
(modes . align-tex-modes)
(repeat . t)
(run-if . ,(lambda ()
(eq major-mode 'latex-mode))))
(tex-record-break
(regexp . "\\(\\s-*\\)\\\\\\\\")
(modes . align-tex-modes))
;; With a numeric prefix argument, or C-u, space delimited text
;; tables will be aligned.
(text-column
(regexp . "\\(^\\|\\S-\\)\\([ \t]+\\)\\(\\S-\\|$\\)")
(group . 2)
(modes . align-text-modes)
(repeat . t)
(run-if . ,(lambda ()
(and current-prefix-arg
(not (eq '- current-prefix-arg))))))
;; With a negative prefix argument, lists of dollar figures will
;; be aligned.
(text-dollar-figure
(regexp . "\\$?\\(\\s-+[0-9]+\\)\\.")
(modes . align-text-modes)
(justify . t)
(run-if . ,(lambda ()
(eq '- current-prefix-arg))))
(css-declaration
(regexp . "^\\s-*\\(?:\\w-?\\)+:\\(\\s-*\\).*;")
(group . (1))
(modes . '(css-mode html-mode))))
"A list describing all of the available alignment rules.
The format is:
((TITLE
(ATTRIBUTE . VALUE) ...)
...)
The following attributes are meaningful:
`regexp' This required attribute must be either a string describing
a regular expression, or a function (described below).
For every line within the section that this regular
expression matches, the given rule will be applied to that
line. The exclusion rules denote which part(s) of the
line should not be modified; the alignment rules cause the
identified whitespace group to be contracted/expanded such
that the \"alignment character\" (the character
immediately following the identified parenthesis group),
occurs in the same column for every line within the
alignment section (see `align-region-separate' for a
description of how the region is broken up into alignment
sections).
The `regexp' attribute describes how the text should be
treated. Within this regexp, there must be at least one
group of characters (typically whitespace) identified by
the special opening and closing parens used in regexp
expressions (`\\\\(' and `\\\\)') (see the Emacs manual on
the syntax of regular expressions for more info).
If `regexp' is a function, it will be called as a
replacement for `re-search-forward'. This means that it
should return nil if nothing is found to match the rule,
or it should set the match data appropriately, move point
to the end of the match, and return the value of point.
`group' For exclusion rules, the group identifies the range of
characters that should be ignored. For alignment rules,
these are the characters that will be deleted/expanded for
the purposes of alignment. The \"alignment character\" is
always the first character immediately following this
parenthesis group. This attribute may also be a list of
integers, in which case multiple alignment characters will
be aligned, with the list of integers identifying the
whitespace groups which precede them. The default for
this attribute is 1.
`modes' The `modes' attribute, if set, should name a list of
major modes -- or evaluate to such a value -- in which the
rule is valid. If not set, the rule will apply to all
modes.
`case-fold' If `regexp' is an ordinary regular expression string
containing alphabetic character, sometimes you may want
the search to proceed case-insensitively (for languages
that ignore case, such as Pascal for example). In that
case, set `case-fold' to a non-nil value, and the regular
expression search will ignore case. If `regexp' is set to
a function, that function must handle the job of ignoring
case by itself.
`tab-stop' If the `tab-stop' attribute is set, and non-nil, the
alignment character will always fall on a tab stop
(whether it uses tabs to get there or not depends on the
value of `indent-tabs-mode'). If the `tab-stop' attribute
is set to nil, tab stops will never be used. Otherwise,
the value of `align-to-tab-stop' determines whether or not
to align to a tab stop. The `tab-stop' attribute may also
be a list of t or nil values, corresponding to the number
of parenthesis groups specified by the `group' attribute.
`repeat' If the `repeat' attribute is present, and non-nil, the
rule will be applied to the line continuously until no
further matches are found.
`valid' If the `valid' attribute is set, it will be used to
determine whether the rule should be invoked. This form
is evaluated after the regular expression match has been
performed, so that it is possible to use the results of
that match to determine whether the alignment should be
performed. The buffer should not be modified during the
evaluation of this form.
`run-if' Like `valid', the `run-if' attribute tests whether the
rule should be run at all -- even before any searches are
done to determine if the rule applies to the alignment
region. This can save time, since `run-if' will only be
run once for each rule. If it returns nil, the rule will
not be attempted.
`column' For alignment rules, if the `column' attribute is set --
which must be an integer, or a symbol whose value is an
integer -- it will be used as the column in which to align
the alignment character. If the text on a particular line
happens to overrun that column, a single space character,
or tab stop (see `align-to-tab-stop') will be added
between the last text character and the alignment
character.
`spacing' Alignment rules may also override the amount of spacing
that would normally be used by providing a `spacing'
attribute. This must be an integer, or a list of integers
corresponding to the number of parenthesis groups matched
by the `group' attribute. If a list of value is used, and
any of those values is nil, `align-default-spacing' will
be used for that subgroup. See `align-default-spacing'
for more details on spacing, tab stops, and how to
indicate how much spacing should be used. If TAB-STOP is
present, it will override the value of `align-to-tab-stop'
for that rule.
`justify' It is possible with `regexp' and `group' to identify a
character group that contains more than just whitespace
characters. By default, any non-whitespace characters in
that group will also be deleted while aligning the
alignment character. However, if the `justify' attribute
is set to a non-nil value, only the initial whitespace
characters within that group will be deleted. This has
the effect of right-justifying the characters that remain,
and can be used for outdenting or just plain old right-
justification.
`separate' Each rule can define its own section separator, which
describes how to identify the separation of \"sections\"
within the region to be aligned. Setting the `separate'
attribute overrides the value of `align-region-separate'
(see the documentation of that variable for possible
values), and any separation argument passed to `align'."
:type align-rules-list-type
:group 'align)