HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| dbb0d350 | 1 | ;;; align.el --- align text to a specific column, by regexp -*- lexical-binding:t -*- |
| 3c4c8064 | 2 | |
| ba318903 | 3 | ;; Copyright (C) 1999-2014 Free Software Foundation, Inc. |
| 3c4c8064 | 4 | |
| 9201cc28 | 5 | ;; Author: John Wiegley <johnw@gnu.org> |
| 012884e2 | 6 | ;; Maintainer: FSF |
| 3c4c8064 | 7 | ;; Keywords: convenience languages lisp |
| 3c4c8064 GM |
8 | |
| 9 | ;; This file is part of GNU Emacs. | |
| 10 | ||
| eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
| 3c4c8064 | 12 | ;; it under the terms of the GNU General Public License as published by |
| eb3fa2cf GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
| 14 | ;; (at your option) any later version. | |
| 3c4c8064 GM |
15 | |
| 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. | |
| 20 | ||
| 21 | ;; You should have received a copy of the GNU General Public License | |
| eb3fa2cf | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
| 3c4c8064 GM |
23 | |
| 24 | ;;; Commentary: | |
| 25 | ||
| 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; | |
| 38 | ||
| 39 | ;;; Usage: | |
| 40 | ||
| 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)) | |
| 54 | ||
| 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. | |
| 58 | ||
| 59 | ;;; Module Authors: | |
| 60 | ||
| 61 | ;; In order to incorporate align's functionality into your own | |
| 62 | ;; modules, there are only a few steps you have to follow. | |
| 63 | ||
| 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. | |
| 72 | ||
| 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 | |
| 865fe16f | 77 | ;; mode list, and then write your mode name into their init file, |
| 3c4c8064 GM |
78 | ;; causing the symbol already to be present the next time they load |
| 79 | ;; your package. | |
| 80 | ||
| 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. | |
| 105 | ||
| 106 | ;;; History: | |
| 107 | ||
| 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 | |
| fa463103 | 112 | ;; find a more robust, higher performing algorithm, 2.0 was born in late |
| 3c4c8064 GM |
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. | |
| 118 | ||
| 119 | ;;; Code: | |
| 120 | ||
| 121 | (defgroup align nil | |
| 122 | "Align text to a specific column, by regexp." | |
| 165b3a92 | 123 | :version "21.1" |
| 3c4c8064 GM |
124 | :group 'fill) |
| 125 | ||
| 126 | ;;; User Variables: | |
| 127 | ||
| 128 | (defcustom align-load-hook nil | |
| 9201cc28 | 129 | "Hook that gets run after the aligner has been loaded." |
| 3c4c8064 GM |
130 | :type 'hook |
| 131 | :group 'align) | |
| 132 | ||
| 133 | (defcustom align-indent-before-aligning nil | |
| 9201cc28 | 134 | "If non-nil, indent the marked region before aligning it." |
| 3c4c8064 GM |
135 | :type 'boolean |
| 136 | :group 'align) | |
| 137 | ||
| 138 | (defcustom align-default-spacing 1 | |
| 9201cc28 | 139 | "An integer that represents the default amount of padding to use. |
| 3c4c8064 GM |
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. | |
| ad9ae065 JB |
142 | Each alignment rule can optionally override both this variable and |
| 143 | `align-to-tab-stop'. See `align-rules-list'." | |
| 3c4c8064 GM |
144 | :type 'integer |
| 145 | :group 'align) | |
| 146 | ||
| 147 | (defcustom align-to-tab-stop 'indent-tabs-mode | |
| 9201cc28 | 148 | "If non-nil, alignments will always fall on a tab boundary. |
| 3c4c8064 GM |
149 | It may also be a symbol, whose value will be taken." |
| 150 | :type '(choice (const nil) symbol) | |
| 151 | :group 'align) | |
| 152 | ||
| 153 | (defcustom align-region-heuristic 500 | |
| 9201cc28 | 154 | "If non-nil, used as a heuristic by `align-current'. |
| 3c4c8064 GM |
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 | |
| ad9ae065 JB |
159 | values can mean slower performance in large files, although smaller |
| 160 | values may cause unexpected behavior at times." | |
| 3c4c8064 GM |
161 | :type 'integer |
| 162 | :group 'align) | |
| 163 | ||
| 164 | (defcustom align-highlight-change-face 'highlight | |
| 9201cc28 | 165 | "The face to highlight with if changes are necessary." |
| 3c4c8064 GM |
166 | :type 'face |
| 167 | :group 'align) | |
| 168 | ||
| 169 | (defcustom align-highlight-nochange-face 'secondary-selection | |
| 9201cc28 | 170 | "The face to highlight with if no changes are necessary." |
| 3c4c8064 GM |
171 | :type 'face |
| 172 | :group 'align) | |
| 173 | ||
| 174 | (defcustom align-large-region 10000 | |
| 9201cc28 | 175 | "If an integer, defines what constitutes a \"large\" region. |
| 6c01cfb6 | 176 | If nil, then no messages will ever be printed to the minibuffer." |
| 3c4c8064 GM |
177 | :type 'integer |
| 178 | :group 'align) | |
| 179 | ||
| 180 | (defcustom align-c++-modes '(c++-mode c-mode java-mode) | |
| 9201cc28 | 181 | "A list of modes whose syntax resembles C/C++." |
| 3c4c8064 GM |
182 | :type '(repeat symbol) |
| 183 | :group 'align) | |
| 184 | ||
| 185 | (defcustom align-perl-modes '(perl-mode cperl-mode) | |
| 6c01cfb6 | 186 | "A list of modes where Perl syntax is to be seen." |
| 3c4c8064 GM |
187 | :type '(repeat symbol) |
| 188 | :group 'align) | |
| 189 | ||
| 190 | (defcustom align-lisp-modes | |
| 191 | '(emacs-lisp-mode lisp-interaction-mode lisp-mode scheme-mode) | |
| 9201cc28 | 192 | "A list of modes whose syntax resembles Lisp." |
| 3c4c8064 GM |
193 | :type '(repeat symbol) |
| 194 | :group 'align) | |
| 195 | ||
| 196 | (defcustom align-tex-modes | |
| 197 | '(tex-mode plain-tex-mode latex-mode slitex-mode) | |
| 9201cc28 | 198 | "A list of modes whose syntax resembles TeX (and family)." |
| 3c4c8064 GM |
199 | :type '(repeat symbol) |
| 200 | :group 'align) | |
| 201 | ||
| 202 | (defcustom align-text-modes '(text-mode outline-mode) | |
| 9201cc28 | 203 | "A list of modes whose content is plain text." |
| 3c4c8064 GM |
204 | :type '(repeat symbol) |
| 205 | :group 'align) | |
| 206 | ||
| 3262f00d GM |
207 | (defcustom align-dq-string-modes |
| 208 | (append align-lisp-modes align-c++-modes align-perl-modes | |
| 209 | '(python-mode)) | |
| 9201cc28 | 210 | "A list of modes where double quoted strings should be excluded." |
| 3c4c8064 GM |
211 | :type '(repeat symbol) |
| 212 | :group 'align) | |
| 213 | ||
| 3262f00d GM |
214 | (defcustom align-sq-string-modes |
| 215 | (append align-perl-modes '(python-mode)) | |
| 9201cc28 | 216 | "A list of modes where single quoted strings should be excluded." |
| 3c4c8064 GM |
217 | :type '(repeat symbol) |
| 218 | :group 'align) | |
| 219 | ||
| 3262f00d GM |
220 | (defcustom align-open-comment-modes |
| 221 | (append align-lisp-modes align-c++-modes align-perl-modes | |
| 222 | '(python-mode makefile-mode)) | |
| 9201cc28 | 223 | "A list of modes with a single-line comment syntax. |
| 6c01cfb6 | 224 | These are comments as in Lisp, which have a beginning, but end with |
| 3c4c8064 GM |
225 | the line (i.e., `comment-end' is an empty string)." |
| 226 | :type '(repeat symbol) | |
| 227 | :group 'align) | |
| 228 | ||
| 229 | (defcustom align-region-separate "^\\s-*[{}]?\\s-*$" | |
| 9201cc28 | 230 | "Select the method by which alignment sections will be separated. |
| 3c4c8064 GM |
231 | If this is a symbol, that symbol's value will be used. |
| 232 | ||
| 233 | For the sake of clarification, consider the following example, which | |
| 234 | will be referred to in the descriptions below. | |
| 235 | ||
| 236 | int alpha = 1; /* one */ | |
| 237 | double beta = 2.0; | |
| 238 | long gamma; /* ten */ | |
| 239 | ||
| 240 | unsigned int delta = 1; /* one */ | |
| 241 | long double epsilon = 3.0; | |
| 242 | long long omega; /* ten */ | |
| 243 | ||
| 244 | The possible settings for `align-region-separate' are: | |
| 245 | ||
| 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: | |
| 250 | ||
| 251 | int alpha = 1; /* one */ | |
| 252 | double beta = 2.0; | |
| 253 | long gamma; /* ten */ | |
| 254 | ||
| 255 | unsigned int delta = 1; /* one */ | |
| 256 | long double epsilon; | |
| 257 | long long chi = 10; /* ten */ | |
| 258 | ||
| 259 | `group' Each contiguous set of lines where a specific alignment | |
| 260 | occurs is considered a section for that alignment rule. | |
| 6c01cfb6 JB |
261 | Note that each rule may have any entirely different set |
| 262 | of section divisions than another. | |
| 3c4c8064 GM |
263 | |
| 264 | int alpha = 1; /* one */ | |
| 265 | double beta = 2.0; | |
| 266 | long gamma; /* ten */ | |
| 267 | ||
| 268 | unsigned int delta = 1; /* one */ | |
| 269 | long double epsilon; | |
| 270 | long long chi = 10; /* ten */ | |
| 271 | ||
| 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. | |
| 275 | ||
| 276 | int alpha = 1; /* one */ | |
| 277 | double beta = 2.0; | |
| 278 | long gamma; /* ten */ | |
| 279 | ||
| 280 | unsigned int delta = 1; /* one */ | |
| 281 | long double epsilon; | |
| 282 | long long chi = 10; /* ten */ | |
| 283 | ||
| 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. | |
| 288 | ||
| 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 | |
| 6c01cfb6 | 294 | the preceding statement in C or Perl), `largest' is |
| 3c4c8064 GM |
295 | probably the better alternative. |
| 296 | ||
| 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 | |
| 6c01cfb6 JB |
303 | section found to be used as the common section for all |
| 304 | rules that occur there. | |
| 3c4c8064 GM |
305 | |
| 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. | |
| 310 | ||
| 311 | This method is intended for use in Lisp programs, and not | |
| 312 | by the user." | |
| 313 | :type '(choice | |
| 314 | (const :tag "Entire region is one section" entire) | |
| 315 | (const :tag "Align by contiguous groups" group) | |
| 316 | ; (const largest) | |
| 317 | (regexp :tag "Regexp defines section boundaries") | |
| 318 | (function :tag "Function defines section boundaries")) | |
| 319 | :group 'align) | |
| 320 | ||
| 321 | (put 'align-region-separate 'risky-local-variable t) | |
| 322 | ||
| 323 | (defvar align-rules-list-type | |
| 324 | '(repeat | |
| 325 | (cons | |
| 326 | :tag "Alignment rule" | |
| 327 | (symbol :tag "Title") | |
| 328 | (cons :tag "Required attributes" | |
| 329 | (cons :tag "Regexp" | |
| 330 | (const :tag "(Regular expression to match)" regexp) | |
| 331 | (choice :value "\\(\\s-+\\)" regexp function)) | |
| 332 | (repeat | |
| 333 | :tag "Optional attributes" | |
| 334 | (choice | |
| 335 | (cons :tag "Repeat" | |
| 336 | (const :tag "(Repeat this rule throughout line)" | |
| 337 | repeat) | |
| 338 | (boolean :value t)) | |
| 339 | (cons :tag "Paren group" | |
| 340 | (const :tag "(Parenthesis group to use)" group) | |
| 341 | (choice :value 2 | |
| 342 | integer (repeat integer))) | |
| 343 | (cons :tag "Modes" | |
| 344 | (const :tag "(Modes where this rule applies)" modes) | |
| 345 | (sexp :value (text-mode))) | |
| 346 | (cons :tag "Case-fold" | |
| 347 | (const :tag "(Should case be ignored for this rule)" | |
| 348 | case-fold) | |
| 349 | (boolean :value t)) | |
| 350 | (cons :tag "To Tab Stop" | |
| 351 | (const :tag "(Should rule align to tab stops)" | |
| 352 | tab-stop) | |
| 353 | (boolean :value nil)) | |
| 354 | (cons :tag "Valid" | |
| 355 | (const :tag "(Return non-nil if rule is valid)" | |
| 356 | valid) | |
| 357 | (function :value t)) | |
| 358 | (cons :tag "Run If" | |
| 359 | (const :tag "(Return non-nil if rule should run)" | |
| 360 | run-if) | |
| 361 | (function :value t)) | |
| 362 | (cons :tag "Column" | |
| 363 | (const :tag "(Column to fix alignment at)" column) | |
| 364 | (choice :value comment-column | |
| 365 | integer symbol)) | |
| 366 | (cons :tag "Spacing" | |
| 367 | (const :tag "(Amount of spacing to use)" spacing) | |
| 368 | (integer :value 1)) | |
| 369 | (cons :tag "Justify" | |
| 370 | (const :tag "(Should text be right justified)" | |
| 371 | justify) | |
| 372 | (boolean :value t)) | |
| 373 | ;; make sure this stays up-to-date with any changes | |
| 374 | ;; in `align-region-separate' | |
| 375 | (cons :tag "Separate" | |
| 376 | (const :tag "(Separation to use for this rule)" | |
| 377 | separate) | |
| 378 | (choice :value "^\\s-*$" | |
| 379 | (const entire) | |
| 380 | (const group) | |
| 381 | ; (const largest) | |
| 382 | regexp function))))))) | |
| 383 | "The `type' form for any `align-rules-list' variable.") | |
| 384 | ||
| 3c4c8064 GM |
385 | (defcustom align-rules-list |
| 386 | `((lisp-second-arg | |
| 387 | (regexp . "\\(^\\s-+[^( \t\n]\\|(\\(\\S-+\\)\\s-+\\)\\S-+\\(\\s-+\\)") | |
| 388 | (group . 3) | |
| 389 | (modes . align-lisp-modes) | |
| 390 | (run-if . ,(function (lambda () current-prefix-arg)))) | |
| 391 | ||
| 392 | (lisp-alist-dot | |
| 393 | (regexp . "\\(\\s-*\\)\\.\\(\\s-*\\)") | |
| 394 | (group . (1 2)) | |
| 395 | (modes . align-lisp-modes)) | |
| 396 | ||
| 397 | (open-comment | |
| 398 | (regexp . ,(function | |
| 399 | (lambda (end reverse) | |
| 400 | (funcall (if reverse 're-search-backward | |
| 401 | 're-search-forward) | |
| 402 | (concat "[^ \t\n\\\\]" | |
| 403 | (regexp-quote comment-start) | |
| 404 | "\\(.+\\)$") end t)))) | |
| 405 | (modes . align-open-comment-modes)) | |
| 406 | ||
| 407 | (c-macro-definition | |
| 408 | (regexp . "^\\s-*#\\s-*define\\s-+\\S-+\\(\\s-+\\)") | |
| 409 | (modes . align-c++-modes)) | |
| 410 | ||
| 411 | (c-variable-declaration | |
| 412 | (regexp . ,(concat "[*&0-9A-Za-z_]>?[&*]*\\(\\s-+[*&]*\\)" | |
| 413 | "[A-Za-z_][0-9A-Za-z:_]*\\s-*\\(\\()\\|" | |
| 414 | "=[^=\n].*\\|(.*)\\|\\(\\[.*\\]\\)*\\)?" | |
| 415 | "\\s-*[;,]\\|)\\s-*$\\)")) | |
| 416 | (group . 1) | |
| 417 | (modes . align-c++-modes) | |
| 418 | (justify . t) | |
| 419 | (valid | |
| 420 | . ,(function | |
| 421 | (lambda () | |
| 422 | (not (or (save-excursion | |
| 423 | (goto-char (match-beginning 1)) | |
| 424 | (backward-word 1) | |
| 425 | (looking-at | |
| 426 | "\\(goto\\|return\\|new\\|delete\\|throw\\)")) | |
| 427 | (if (and (boundp 'font-lock-mode) font-lock-mode) | |
| 3262f00d | 428 | (eq (get-text-property (point) 'face) |
| 3c4c8064 GM |
429 | 'font-lock-comment-face) |
| 430 | (eq (caar (c-guess-basic-syntax)) 'c)))))))) | |
| 431 | ||
| 432 | (c-assignment | |
| 433 | (regexp . ,(concat "[^-=!^&*+<>/| \t\n]\\(\\s-*[-=!^&*+<>/|]*\\)" | |
| 434 | "=\\(\\s-*\\)\\([^= \t\n]\\|$\\)")) | |
| 435 | (group . (1 2)) | |
| 436 | (modes . align-c++-modes) | |
| 437 | (justify . t) | |
| 438 | (tab-stop . nil)) | |
| 439 | ||
| 440 | (perl-assignment | |
| 441 | (regexp . ,(concat "[^=!^&*-+<>/| \t\n]\\(\\s-*\\)=[~>]?" | |
| 442 | "\\(\\s-*\\)\\([^>= \t\n]\\|$\\)")) | |
| 443 | (group . (1 2)) | |
| 444 | (modes . align-perl-modes) | |
| 445 | (tab-stop . nil)) | |
| 446 | ||
| 3262f00d GM |
447 | (python-assignment |
| 448 | (regexp . ,(concat "[^=!<> \t\n]\\(\\s-*\\)=" | |
| 449 | "\\(\\s-*\\)\\([^>= \t\n]\\|$\\)")) | |
| 450 | (group . (1 2)) | |
| 451 | (modes . '(python-mode)) | |
| 452 | (tab-stop . nil)) | |
| 453 | ||
| 3c4c8064 GM |
454 | (make-assignment |
| 455 | (regexp . "^\\s-*\\w+\\(\\s-*\\):?=\\(\\s-*\\)\\([^\t\n \\\\]\\|$\\)") | |
| 456 | (group . (1 2)) | |
| 457 | (modes . '(makefile-mode)) | |
| 458 | (tab-stop . nil)) | |
| 459 | ||
| 460 | (c-comma-delimiter | |
| 461 | (regexp . ",\\(\\s-*\\)[^/ \t\n]") | |
| 462 | (repeat . t) | |
| 463 | (modes . align-c++-modes) | |
| 464 | (run-if . ,(function (lambda () current-prefix-arg)))) | |
| 3ee9f6ac JW |
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)))))) | |
| 3c4c8064 GM |
472 | |
| 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. | |
| 3262f00d | 477 | (basic-comma-delimiter |
| 3c4c8064 GM |
478 | (regexp . ",\\(\\s-*\\)[^# \t\n]") |
| 479 | (repeat . t) | |
| 3262f00d | 480 | (modes . (append align-perl-modes '(python-mode))) |
| 3c4c8064 GM |
481 | (run-if . ,(function (lambda () current-prefix-arg)))) |
| 482 | ||
| 483 | (c++-comment | |
| 484 | (regexp . "\\(\\s-*\\)\\(//.*\\|/\\*.*\\*/\\s-*\\)$") | |
| 485 | (modes . align-c++-modes) | |
| 486 | (column . comment-column) | |
| 487 | (valid . ,(function | |
| 488 | (lambda () | |
| 489 | (save-excursion | |
| 490 | (goto-char (match-beginning 1)) | |
| 491 | (not (bolp))))))) | |
| 492 | ||
| 3c4c8064 GM |
493 | (c-chain-logic |
| 494 | (regexp . "\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)") | |
| 495 | (modes . align-c++-modes) | |
| 496 | (valid . ,(function | |
| 497 | (lambda () | |
| 498 | (save-excursion | |
| 499 | (goto-char (match-end 2)) | |
| 500 | (looking-at "\\s-*\\(/[*/]\\|$\\)")))))) | |
| 501 | ||
| 502 | (perl-chain-logic | |
| 503 | (regexp . "\\(\\s-*\\)\\(&&\\|||\\|\\<and\\>\\|\\<or\\>\\)") | |
| 504 | (modes . align-perl-modes) | |
| 505 | (valid . ,(function | |
| 506 | (lambda () | |
| 507 | (save-excursion | |
| 508 | (goto-char (match-end 2)) | |
| 509 | (looking-at "\\s-*\\(#\\|$\\)")))))) | |
| 510 | ||
| 3262f00d GM |
511 | (python-chain-logic |
| 512 | (regexp . "\\(\\s-*\\)\\(\\<and\\>\\|\\<or\\>\\)") | |
| 513 | (modes . '(python-mode)) | |
| 514 | (valid . ,(function | |
| 515 | (lambda () | |
| 516 | (save-excursion | |
| 517 | (goto-char (match-end 2)) | |
| 518 | (looking-at "\\s-*\\(#\\|$\\|\\\\\\)")))))) | |
| 519 | ||
| 520 | (c-macro-line-continuation | |
| 521 | (regexp . "\\(\\s-*\\)\\\\$") | |
| 522 | (modes . align-c++-modes) | |
| 523 | (column . c-backslash-column)) | |
| 3ee9f6ac JW |
524 | ; (valid |
| 525 | ; . ,(function | |
| 526 | ; (lambda () | |
| 527 | ; (memq (caar (c-guess-basic-syntax)) | |
| 528 | ; '(cpp-macro cpp-macro-cont)))))) | |
| 3262f00d GM |
529 | |
| 530 | (basic-line-continuation | |
| 531 | (regexp . "\\(\\s-*\\)\\\\$") | |
| 532 | (modes . '(python-mode makefile-mode))) | |
| 533 | ||
| 3c4c8064 GM |
534 | (tex-record-separator |
| 535 | (regexp . ,(function | |
| 536 | (lambda (end reverse) | |
| 537 | (align-match-tex-pattern "&" end reverse)))) | |
| 538 | (group . (1 2)) | |
| 539 | (modes . align-tex-modes) | |
| 540 | (repeat . t)) | |
| 541 | ||
| 542 | (tex-tabbing-separator | |
| 543 | (regexp . ,(function | |
| 544 | (lambda (end reverse) | |
| 545 | (align-match-tex-pattern "\\\\[=>]" end reverse)))) | |
| 546 | (group . (1 2)) | |
| 547 | (modes . align-tex-modes) | |
| 548 | (repeat . t) | |
| 549 | (run-if . ,(function | |
| 550 | (lambda () | |
| 551 | (eq major-mode 'latex-mode))))) | |
| 552 | ||
| 553 | (tex-record-break | |
| 554 | (regexp . "\\(\\s-*\\)\\\\\\\\") | |
| 555 | (modes . align-tex-modes)) | |
| 556 | ||
| 557 | ;; With a numeric prefix argument, or C-u, space delimited text | |
| 558 | ;; tables will be aligned. | |
| 559 | (text-column | |
| 5a8854dd | 560 | (regexp . "\\(^\\|\\S-\\)\\([ \t]+\\)\\(\\S-\\|$\\)") |
| 3c4c8064 GM |
561 | (group . 2) |
| 562 | (modes . align-text-modes) | |
| 563 | (repeat . t) | |
| 564 | (run-if . ,(function | |
| 565 | (lambda () | |
| 566 | (and current-prefix-arg | |
| 567 | (not (eq '- current-prefix-arg))))))) | |
| 568 | ||
| 569 | ;; With a negative prefix argument, lists of dollar figures will | |
| 570 | ;; be aligned. | |
| 571 | (text-dollar-figure | |
| 572 | (regexp . "\\$?\\(\\s-+[0-9]+\\)\\.") | |
| 573 | (modes . align-text-modes) | |
| 574 | (justify . t) | |
| 575 | (run-if . ,(function | |
| 576 | (lambda () | |
| 3ee9f6ac JW |
577 | (eq '- current-prefix-arg))))) |
| 578 | ||
| 579 | (css-declaration | |
| 580 | (regexp . "^\\s-*\\w+:\\(\\s-*\\).*;") | |
| 581 | (group . (1)) | |
| 582 | (modes . '(css-mode html-mode)))) | |
| 9201cc28 | 583 | "A list describing all of the available alignment rules. |
| 3c4c8064 GM |
584 | The format is: |
| 585 | ||
| 586 | ((TITLE | |
| 587 | (ATTRIBUTE . VALUE) ...) | |
| 588 | ...) | |
| 589 | ||
| 590 | The following attributes are meaningful: | |
| 591 | ||
| 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 | |
| 599 | that the \"alignment character\" (the character | |
| 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). | |
| 605 | ||
| 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 | |
| 610 | expressions (`\\\\(' and `\\\\)') (see the Emacs manual on | |
| 611 | the syntax of regular expressions for more info). | |
| 612 | ||
| 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. | |
| 618 | ||
| 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 | |
| 622 | the purposes of alignment. The \"alignment character\" is | |
| 623 | always the first character immediately following this | |
| 624 | parenthesis group. This attribute may also be a list of | |
| 6c01cfb6 JB |
625 | integers, in which case multiple alignment characters will |
| 626 | be aligned, with the list of integers identifying the | |
| 3c4c8064 GM |
627 | whitespace groups which precede them. The default for |
| 628 | this attribute is 1. | |
| 629 | ||
| 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. | |
| 634 | ||
| 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 | |
| 6c01cfb6 | 638 | that ignore case, such as Pascal for example). In that |
| c0faad25 GM |
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 | |
| 3c4c8064 GM |
642 | case by itself. |
| 643 | ||
| 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. | |
| 653 | ||
| 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. | |
| 657 | ||
| 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. | |
| 665 | ||
| 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. | |
| 672 | ||
| 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. | |
| 681 | ||
| 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. | |
| 693 | ||
| 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. | |
| 704 | ||
| 705 | `separate' Each rule can define its own section separator, which | |
| 706 | describes how to identify the separation of \"sections\" | |
| 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 | |
| 712 | :group 'align) | |
| 713 | ||
| 714 | (put 'align-rules-list 'risky-local-variable t) | |
| 715 | ||
| 716 | (defvar align-exclude-rules-list-type | |
| 717 | '(repeat | |
| 718 | (cons | |
| 719 | :tag "Exclusion rule" | |
| 720 | (symbol :tag "Title") | |
| 721 | (cons :tag "Required attributes" | |
| 722 | (cons :tag "Regexp" | |
| 723 | (const :tag "(Regular expression to match)" regexp) | |
| 724 | (choice :value "\\(\\s-+\\)" regexp function)) | |
| 725 | (repeat | |
| 726 | :tag "Optional attributes" | |
| 727 | (choice | |
| 728 | (cons :tag "Repeat" | |
| 729 | (const :tag "(Repeat this rule throughout line)" | |
| 730 | repeat) | |
| 731 | (boolean :value t)) | |
| 732 | (cons :tag "Paren group" | |
| 733 | (const :tag "(Parenthesis group to use)" group) | |
| 734 | (choice :value 2 | |
| 735 | integer (repeat integer))) | |
| 736 | (cons :tag "Modes" | |
| 737 | (const :tag "(Modes where this rule applies)" modes) | |
| 738 | (sexp :value (text-mode))) | |
| 739 | (cons :tag "Case-fold" | |
| 740 | (const :tag "(Should case be ignored for this rule)" | |
| 741 | case-fold) | |
| 742 | (boolean :value t))))))) | |
| 743 | "The `type' form for any `align-exclude-rules-list' variable.") | |
| 744 | ||
| 745 | (defcustom align-exclude-rules-list | |
| 746 | `((exc-dq-string | |
| 747 | (regexp . "\"\\([^\"\n]+\\)\"") | |
| 748 | (repeat . t) | |
| 749 | (modes . align-dq-string-modes)) | |
| 750 | ||
| 751 | (exc-sq-string | |
| 752 | (regexp . "'\\([^'\n]+\\)'") | |
| 753 | (repeat . t) | |
| 754 | (modes . align-sq-string-modes)) | |
| 755 | ||
| 756 | (exc-open-comment | |
| 757 | (regexp | |
| 758 | . ,(function | |
| 759 | (lambda (end reverse) | |
| 760 | (funcall (if reverse 're-search-backward | |
| 761 | 're-search-forward) | |
| 762 | (concat "[^ \t\n\\\\]" | |
| 763 | (regexp-quote comment-start) | |
| 764 | "\\(.+\\)$") end t)))) | |
| 765 | (modes . align-open-comment-modes)) | |
| 766 | ||
| 767 | (exc-c-comment | |
| 768 | (regexp . "/\\*\\(.+\\)\\*/") | |
| 769 | (repeat . t) | |
| 770 | (modes . align-c++-modes)) | |
| 771 | ||
| 772 | (exc-c-func-params | |
| 773 | (regexp . "(\\([^)\n]+\\))") | |
| 774 | (repeat . t) | |
| 775 | (modes . align-c++-modes)) | |
| 776 | ||
| 777 | (exc-c-macro | |
| 778 | (regexp . "^\\s-*#\\s-*\\(if\\w*\\|endif\\)\\(.*\\)$") | |
| 779 | (group . 2) | |
| 780 | (modes . align-c++-modes))) | |
| 9201cc28 | 781 | "A list describing text that should be excluded from alignment. |
| 3c4c8064 GM |
782 | See the documentation for `align-rules-list' for more info." |
| 783 | :type align-exclude-rules-list-type | |
| 784 | :group 'align) | |
| 785 | ||
| 786 | (put 'align-exclude-rules-list 'risky-local-variable t) | |
| 787 | ||
| 788 | ;;; Internal Variables: | |
| 789 | ||
| 790 | (defvar align-mode-rules-list nil | |
| 791 | "Alignment rules specific to the current major mode. | |
| 792 | See the variable `align-rules-list' for more details.") | |
| 793 | ||
| 794 | (make-variable-buffer-local 'align-mode-rules-list) | |
| 795 | ||
| 796 | (defvar align-mode-exclude-rules-list nil | |
| 797 | "Alignment exclusion rules specific to the current major mode. | |
| 798 | See the variable `align-exclude-rules-list' for more details.") | |
| 799 | ||
| 800 | (make-variable-buffer-local 'align-mode-exclude-rules-list) | |
| 801 | ||
| 802 | (defvar align-highlight-overlays nil | |
| 803 | "The current overlays highlighting the text matched by a rule.") | |
| 804 | ||
| 805 | ;; Sample extension rule set, for vhdl-mode. This should properly be | |
| 806 | ;; in vhdl-mode.el itself. | |
| 807 | ||
| 808 | (defcustom align-vhdl-rules-list | |
| 809 | `((vhdl-declaration | |
| 810 | (regexp . "\\(signal\\|variable\\|constant\\)\\(\\s-+\\)\\S-") | |
| 811 | (group . 2)) | |
| 812 | ||
| 813 | (vhdl-case | |
| 814 | (regexp . "\\(others\\|[^ \t\n=<]\\)\\(\\s-*\\)=>\\(\\s-*\\)\\S-") | |
| 815 | (group . (2 3)) | |
| 816 | (valid | |
| 817 | . ,(function | |
| 818 | (lambda () | |
| 819 | (not (string= (downcase (match-string 1)) | |
| 820 | "others")))))) | |
| 821 | ||
| 822 | (vhdl-colon | |
| 823 | (regexp . "[^ \t\n:]\\(\\s-*\\):\\(\\s-*\\)[^=\n]") | |
| 824 | (group . (1 2))) | |
| 825 | ||
| 826 | (direction | |
| 827 | (regexp . ":\\s-*\\(in\\|out\\|inout\\|buffer\\)\\(\\s-*\\)") | |
| 828 | (group . 2)) | |
| 829 | ||
| 830 | (sig-assign | |
| 831 | (regexp . "[^ \t\n=<]\\(\\s-*\\)<=\\(\\s-*\\)\\S-") | |
| 832 | (group . (1 2))) | |
| 833 | ||
| 834 | (var-assign | |
| 835 | (regexp . "[^ \t\n:]\\(\\s-*\\):=")) | |
| 836 | ||
| 837 | (use-entity | |
| 838 | (regexp . "\\(\\s-+\\)use\\s-+entity"))) | |
| 9201cc28 | 839 | "Alignment rules for `vhdl-mode'. See `align-rules-list' for more info." |
| 3c4c8064 GM |
840 | :type align-rules-list-type |
| 841 | :group 'align) | |
| 842 | ||
| 843 | (put 'align-vhdl-rules-list 'risky-local-variable t) | |
| 844 | ||
| 845 | (defun align-set-vhdl-rules () | |
| 846 | "Setup the `align-mode-rules-list' variable for `vhdl-mode'." | |
| 847 | (setq align-mode-rules-list align-vhdl-rules-list)) | |
| 848 | ||
| 849 | (add-hook 'vhdl-mode-hook 'align-set-vhdl-rules) | |
| 850 | ||
| 851 | (add-to-list 'align-dq-string-modes 'vhdl-mode) | |
| 852 | (add-to-list 'align-open-comment-modes 'vhdl-mode) | |
| 853 | ||
| 854 | ;;; User Functions: | |
| 855 | ||
| 856 | ;;;###autoload | |
| 857 | (defun align (beg end &optional separate rules exclude-rules) | |
| 858 | "Attempt to align a region based on a set of alignment rules. | |
| 859 | BEG and END mark the region. If BEG and END are specifically set to | |
| 860 | nil (this can only be done programmatically), the beginning and end of | |
| 861 | the current alignment section will be calculated based on the location | |
| 862 | of point, and the value of `align-region-separate' (or possibly each | |
| 863 | rule's `separate' attribute). | |
| 864 | ||
| 865 | If SEPARATE is non-nil, it overrides the value of | |
| 866 | `align-region-separate' for all rules, except those that have their | |
| 867 | `separate' attribute set. | |
| 868 | ||
| 869 | RULES and EXCLUDE-RULES, if either is non-nil, will replace the | |
| 870 | default rule lists defined in `align-rules-list' and | |
| 871 | `align-exclude-rules-list'. See `align-rules-list' for more details | |
| 872 | on the format of these lists." | |
| 873 | (interactive "r") | |
| 874 | (let ((separator | |
| 875 | (or separate | |
| ca7aae91 JW |
876 | (if (and (symbolp align-region-separate) |
| 877 | (boundp align-region-separate)) | |
| 3c4c8064 GM |
878 | (symbol-value align-region-separate) |
| 879 | align-region-separate) | |
| 880 | 'entire))) | |
| 881 | (if (not (or ;(eq separator 'largest) | |
| 882 | (and (functionp separator) | |
| 883 | (not (funcall separator nil nil))))) | |
| 884 | (align-region beg end separator | |
| 885 | (or rules align-mode-rules-list align-rules-list) | |
| 886 | (or exclude-rules align-mode-exclude-rules-list | |
| 887 | align-exclude-rules-list)) | |
| 888 | (let ((sec-first end) | |
| 889 | (sec-last beg)) | |
| 890 | (align-region beg end | |
| 891 | (or exclude-rules | |
| 892 | align-mode-exclude-rules-list | |
| 893 | align-exclude-rules-list) nil | |
| 894 | separator | |
| 895 | (function | |
| 896 | (lambda (b e mode) | |
| 897 | (when (and mode (listp mode)) | |
| 898 | (setq sec-first (min sec-first b) | |
| 899 | sec-last (max sec-last e)))))) | |
| 900 | (if (< sec-first sec-last) | |
| 901 | (align-region sec-first sec-last 'entire | |
| 902 | (or rules align-mode-rules-list align-rules-list) | |
| 903 | (or exclude-rules align-mode-exclude-rules-list | |
| 904 | align-exclude-rules-list))))))) | |
| 905 | ||
| 906 | ;;;###autoload | |
| 907 | (defun align-regexp (beg end regexp &optional group spacing repeat) | |
| 908 | "Align the current region using an ad-hoc rule read from the minibuffer. | |
| 8358a09d GM |
909 | BEG and END mark the limits of the region. Interactively, this function |
| 910 | prompts for the regular expression REGEXP to align with. | |
| 3c4c8064 GM |
911 | |
| 912 | For example, let's say you had a list of phone numbers, and wanted to | |
| 913 | align them so that the opening parentheses would line up: | |
| 914 | ||
| 915 | Fred (123) 456-7890 | |
| 916 | Alice (123) 456-7890 | |
| 917 | Mary-Anne (123) 456-7890 | |
| 918 | Joe (123) 456-7890 | |
| 919 | ||
| 920 | There is no predefined rule to handle this, but you could easily do it | |
| 8358a09d GM |
921 | using a REGEXP like \"(\". Interactively, all you would have to do is |
| 922 | to mark the region, call `align-regexp' and enter that regular expression. | |
| 923 | ||
| 924 | REGEXP must contain at least one parenthesized subexpression, typically | |
| 925 | whitespace of the form \"\\\\(\\\\s-*\\\\)\". In normal interactive use, | |
| 926 | this is automatically added to the start of your regular expression after | |
| 927 | you enter it. You only need to supply the characters to be lined up, and | |
| 928 | any preceding whitespace is replaced. | |
| 929 | ||
| 930 | If you specify a prefix argument (or use this function non-interactively), | |
| 931 | you must enter the full regular expression, including the subexpression. | |
| 932 | The function also then prompts for which subexpression parenthesis GROUP | |
| 933 | \(default 1) within REGEXP to modify, the amount of SPACING (default | |
| 934 | `align-default-spacing') to use, and whether or not to REPEAT the rule | |
| 935 | throughout the line. | |
| 936 | ||
| 937 | See `align-rules-list' for more information about these options. | |
| 938 | ||
| 939 | The non-interactive form of the previous example would look something like: | |
| 940 | \(align-regexp (point-min) (point-max) \"\\\\(\\\\s-*\\\\)(\") | |
| 941 | ||
| 942 | This function is a nothing more than a small wrapper that helps you | |
| 943 | construct a rule to pass to `align-region', which does the real work." | |
| 3c4c8064 GM |
944 | (interactive |
| 945 | (append | |
| cbf08c39 | 946 | (list (region-beginning) (region-end)) |
| 3c4c8064 GM |
947 | (if current-prefix-arg |
| 948 | (list (read-string "Complex align using regexp: " | |
| 949 | "\\(\\s-*\\)") | |
| 027a4b6b | 950 | (string-to-number |
| 3c4c8064 GM |
951 | (read-string |
| 952 | "Parenthesis group to modify (justify if negative): " "1")) | |
| 027a4b6b | 953 | (string-to-number |
| 3c4c8064 GM |
954 | (read-string "Amount of spacing (or column if negative): " |
| 955 | (number-to-string align-default-spacing))) | |
| 956 | (y-or-n-p "Repeat throughout line? ")) | |
| 957 | (list (concat "\\(\\s-*\\)" | |
| 958 | (read-string "Align regexp: ")) | |
| 959 | 1 align-default-spacing nil)))) | |
| 9130a2d6 GM |
960 | (or group (setq group 1)) |
| 961 | (or spacing (setq spacing align-default-spacing)) | |
| 3c4c8064 GM |
962 | (let ((rule |
| 963 | (list (list nil (cons 'regexp regexp) | |
| 964 | (cons 'group (abs group)) | |
| 965 | (if (< group 0) | |
| 966 | (cons 'justify t) | |
| 967 | (cons 'bogus nil)) | |
| 968 | (if (>= spacing 0) | |
| 969 | (cons 'spacing spacing) | |
| 970 | (cons 'column (abs spacing))) | |
| 971 | (cons 'repeat repeat))))) | |
| 972 | (align-region beg end 'entire rule nil nil))) | |
| 973 | ||
| 974 | ;;;###autoload | |
| 975 | (defun align-entire (beg end &optional rules exclude-rules) | |
| 976 | "Align the selected region as if it were one alignment section. | |
| 977 | BEG and END mark the extent of the region. If RULES or EXCLUDE-RULES | |
| 978 | is set to a list of rules (see `align-rules-list'), it can be used to | |
| 979 | override the default alignment rules that would have been used to | |
| 980 | align that section." | |
| 981 | (interactive "r") | |
| 982 | (align beg end 'entire rules exclude-rules)) | |
| 983 | ||
| 984 | ;;;###autoload | |
| 985 | (defun align-current (&optional rules exclude-rules) | |
| 986 | "Call `align' on the current alignment section. | |
| 987 | This function assumes you want to align only the current section, and | |
| 988 | so saves you from having to specify the region. If RULES or | |
| 989 | EXCLUDE-RULES is set to a list of rules (see `align-rules-list'), it | |
| 990 | can be used to override the default alignment rules that would have | |
| 991 | been used to align that section." | |
| 992 | (interactive) | |
| 993 | (align nil nil nil rules exclude-rules)) | |
| 994 | ||
| 995 | ;;;###autoload | |
| 996 | (defun align-highlight-rule (beg end title &optional rules exclude-rules) | |
| 997 | "Highlight the whitespace which a given rule would have modified. | |
| 998 | BEG and END mark the extent of the region. TITLE identifies the rule | |
| 999 | that should be highlighted. If RULES or EXCLUDE-RULES is set to a | |
| 1000 | list of rules (see `align-rules-list'), it can be used to override the | |
| 1001 | default alignment rules that would have been used to identify the text | |
| 1002 | to be colored." | |
| 1003 | (interactive | |
| cbf08c39 | 1004 | (list (region-beginning) (region-end) |
| 3c4c8064 GM |
1005 | (completing-read |
| 1006 | "Title of rule to highlight: " | |
| 1007 | (mapcar | |
| 1008 | (function | |
| 1009 | (lambda (rule) | |
| 1010 | (list (symbol-name (car rule))))) | |
| 1011 | (append (or align-mode-rules-list align-rules-list) | |
| 1012 | (or align-mode-exclude-rules-list | |
| 1013 | align-exclude-rules-list))) nil t))) | |
| 1014 | (let ((ex-rule (assq (intern title) | |
| 1015 | (or align-mode-exclude-rules-list | |
| 1016 | align-exclude-rules-list))) | |
| 1017 | face) | |
| 1018 | (align-unhighlight-rule) | |
| 1019 | (align-region | |
| 1020 | beg end 'entire | |
| 1021 | (or rules (if ex-rule | |
| 1022 | (or exclude-rules align-mode-exclude-rules-list | |
| 1023 | align-exclude-rules-list) | |
| 1024 | (or align-mode-rules-list align-rules-list))) | |
| 1025 | (unless ex-rule (or exclude-rules align-mode-exclude-rules-list | |
| 1026 | align-exclude-rules-list)) | |
| 1027 | (function | |
| 1028 | (lambda (b e mode) | |
| 1029 | (if (and mode (listp mode)) | |
| 1030 | (if (equal (symbol-name (car mode)) title) | |
| 1031 | (setq face (cons align-highlight-change-face | |
| 1032 | align-highlight-nochange-face)) | |
| 1033 | (setq face nil)) | |
| 1034 | (when face | |
| 1035 | (let ((overlay (make-overlay b e))) | |
| 1036 | (setq align-highlight-overlays | |
| 1037 | (cons overlay align-highlight-overlays)) | |
| 1038 | (overlay-put overlay 'face | |
| 1039 | (if mode | |
| 1040 | (car face) | |
| 1041 | (cdr face))))))))))) | |
| 1042 | ||
| 1043 | ;;;###autoload | |
| 1044 | (defun align-unhighlight-rule () | |
| 1045 | "Remove any highlighting that was added by `align-highlight-rule'." | |
| 1046 | (interactive) | |
| 1047 | (while align-highlight-overlays | |
| 1048 | (delete-overlay (car align-highlight-overlays)) | |
| 1049 | (setq align-highlight-overlays | |
| 1050 | (cdr align-highlight-overlays)))) | |
| 1051 | ||
| 6feeb380 JW |
1052 | ;;;###autoload |
| 1053 | (defun align-newline-and-indent () | |
| 1054 | "A replacement function for `newline-and-indent', aligning as it goes." | |
| 1055 | (interactive) | |
| ca7aae91 JW |
1056 | (let ((separate (or (if (and (symbolp align-region-separate) |
| 1057 | (boundp align-region-separate)) | |
| 6feeb380 JW |
1058 | (symbol-value align-region-separate) |
| 1059 | align-region-separate) | |
| 1060 | 'entire)) | |
| 1061 | (end (point))) | |
| 1062 | (call-interactively 'newline-and-indent) | |
| 1063 | (save-excursion | |
| 1064 | (forward-line -1) | |
| 1065 | (while (not (or (bobp) | |
| 1066 | (align-new-section-p (point) end separate))) | |
| 1067 | (forward-line -1)) | |
| 1068 | (align (point) end)))) | |
| 1069 | ||
| 3c4c8064 GM |
1070 | ;;; Internal Functions: |
| 1071 | ||
| 1072 | (defun align-match-tex-pattern (regexp end &optional reverse) | |
| 1073 | "Match REGEXP in TeX mode, counting backslashes appropriately. | |
| 1074 | END denotes the end of the region to be searched, while REVERSE, if | |
| 1075 | non-nil, indicates that the search should proceed backward from the | |
| 1076 | current position." | |
| 1077 | (let (result) | |
| 1078 | (while | |
| 1079 | (and (setq result | |
| 1080 | (funcall | |
| 1081 | (if reverse 're-search-backward | |
| 1082 | 're-search-forward) | |
| 1083 | (concat "\\(\\s-*\\)" regexp | |
| 1084 | "\\(\\s-*\\)") end t)) | |
| 1085 | (let ((pos (match-end 1)) | |
| 1086 | (count 0)) | |
| 1087 | (while (and (> pos (point-min)) | |
| 1088 | (eq (char-before pos) ?\\)) | |
| 1089 | (setq count (1+ count) pos (1- pos))) | |
| 1090 | (eq (mod count 2) 1)) | |
| 0aaf5bb0 | 1091 | (goto-char (match-beginning (if reverse 1 2))))) |
| 3c4c8064 GM |
1092 | result)) |
| 1093 | ||
| 1094 | (defun align-new-section-p (beg end separator) | |
| 1095 | "Is there a section divider between BEG and END? | |
| 1096 | SEPARATOR specifies how to look for the section divider. See the | |
| 1097 | documentation for `align-region-separate' for more details." | |
| 1098 | (cond ((or (not separator) | |
| 1099 | (eq separator 'entire)) | |
| 1100 | nil) | |
| 1101 | ((eq separator 'group) | |
| 1102 | (let ((amount 2)) | |
| 1103 | (save-excursion | |
| 1104 | (goto-char end) | |
| 1105 | (if (bolp) | |
| 1106 | (setq amount 1))) | |
| 1107 | (> (count-lines beg end) amount))) | |
| 1108 | ((stringp separator) | |
| 1109 | (save-excursion | |
| 1110 | (goto-char beg) | |
| 1111 | (re-search-forward separator end t))) | |
| 1112 | ((functionp separator) | |
| 1113 | (funcall separator beg end)) | |
| 1114 | ((listp separator) | |
| 1115 | (let ((seps separator) yes) | |
| 1116 | (while seps | |
| 1117 | (if (and (>= (car seps) beg) | |
| 1118 | (<= (car seps) end)) | |
| 1119 | (setq yes t seps nil) | |
| 1120 | (setq seps (cdr seps)))) | |
| 1121 | yes)))) | |
| 1122 | ||
| 06b60517 | 1123 | (defun align-adjust-col-for-rule (column _rule spacing tab-stop) |
| 3c4c8064 GM |
1124 | "Adjust COLUMN according to the given RULE. |
| 1125 | SPACING specifies how much spacing to use. | |
| 1126 | TAB-STOP specifies whether SPACING refers to tab-stop boundaries." | |
| 1127 | (unless spacing | |
| 1128 | (setq spacing align-default-spacing)) | |
| 1129 | (if (<= spacing 0) | |
| 1130 | column | |
| 1131 | (if (not tab-stop) | |
| 1132 | (+ column spacing) | |
| 1133 | (let ((stops tab-stop-list)) | |
| 1134 | (while stops | |
| 1135 | (if (and (> (car stops) column) | |
| 1136 | (= (setq spacing (1- spacing)) 0)) | |
| 1137 | (setq column (car stops) | |
| 1138 | stops nil) | |
| 1139 | (setq stops (cdr stops))))) | |
| 1140 | column))) | |
| 1141 | ||
| 1142 | (defsubst align-column (pos) | |
| 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." | |
| 1146 | (goto-char pos) | |
| 1147 | (current-column)) | |
| 1148 | ||
| 1149 | (defsubst align-regions (regions props rule func) | |
| 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." | |
| 1155 | (while regions | |
| 1156 | (save-excursion | |
| 1157 | (align-areas (car regions) (car props) rule func)) | |
| 1158 | (setq regions (cdr regions) | |
| 1159 | props (cdr props)))) | |
| 1160 | ||
| 1161 | (defun align-areas (areas props rule func) | |
| 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. | |
| 1168 | ||
| 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." | |
| 1171 | (let* ((column (cdr (assq 'column rule))) | |
| 1172 | (fixed (if (symbolp column) | |
| 1173 | (symbol-value column) | |
| 1174 | column)) | |
| 1175 | (justify (cdr (assq 'justify rule))) | |
| 1176 | (col (or fixed 0)) | |
| 1177 | (width 0) | |
| 06b60517 | 1178 | ecol change) |
| 3c4c8064 GM |
1179 | |
| 1180 | ;; Determine the alignment column. | |
| 1181 | (let ((a areas)) | |
| 1182 | (while a | |
| 1183 | (unless fixed | |
| 1184 | (setq col (max col (align-column (caar a))))) | |
| 1185 | (unless change | |
| 1186 | (goto-char (cdar a)) | |
| 1187 | (if ecol | |
| 3262f00d | 1188 | (if (/= ecol (current-column)) |
| 3c4c8064 GM |
1189 | (setq change t)) |
| 1190 | (setq ecol (current-column)))) | |
| 1191 | (when justify | |
| 1192 | (goto-char (caar a)) | |
| 1193 | (if (and (re-search-forward "\\s-*" (cdar a) t) | |
| 3262f00d | 1194 | (/= (point) (cdar a))) |
| 3c4c8064 GM |
1195 | (let ((bcol (current-column))) |
| 1196 | (setcdr (car a) (cons (point-marker) (cdar a))) | |
| 1197 | (goto-char (cdr (cdar a))) | |
| 1198 | (setq width (max width (- (current-column) bcol)))))) | |
| 1199 | (setq a (cdr a)))) | |
| 1200 | ||
| 1201 | (unless fixed | |
| 1202 | (setq col (+ (align-adjust-col-for-rule | |
| 1203 | col rule (car props) (cdr props)) width))) | |
| 1204 | ||
| 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. | |
| 1208 | ||
| 1209 | (unless change | |
| 3262f00d | 1210 | (setq change (and ecol (/= col ecol)))) |
| 3c4c8064 GM |
1211 | |
| 1212 | (when (or func change) | |
| 1213 | (while areas | |
| 1214 | (let ((area (car areas)) | |
| 1215 | (gocol col) cur) | |
| 1216 | (when area | |
| 1217 | (if func | |
| 40d70ecb CY |
1218 | (funcall func |
| 1219 | (marker-position (car area)) | |
| 1220 | (marker-position (cdr area)) | |
| 1221 | change) | |
| 3c4c8064 GM |
1222 | (if (not (and justify |
| 1223 | (consp (cdr area)))) | |
| 1224 | (goto-char (cdr area)) | |
| 1225 | (goto-char (cddr area)) | |
| 1226 | (let ((ecol (current-column))) | |
| 1227 | (goto-char (cadr area)) | |
| 1228 | (setq gocol (- col (- ecol (current-column)))))) | |
| 1229 | (setq cur (current-column)) | |
| 1230 | (cond ((< gocol 0) t) ; don't do anything | |
| 1231 | ((= cur gocol) t) ; don't need to | |
| 1232 | ((< cur gocol) ; just add space | |
| 14e32dd3 EZ |
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. | |
| 1240 | (delete-horizontal-space t) | |
| 3c4c8064 GM |
1241 | (indent-to gocol)) |
| 1242 | (t | |
| 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. | |
| 1247 | (let ((endcol (align-column | |
| 1248 | (if (and justify | |
| 1249 | (consp (cdr area))) | |
| 1250 | (cadr area) | |
| 1251 | (cdr area)))) | |
| 1252 | (abuts (<= gocol | |
| 1253 | (align-column (car area))))) | |
| 1254 | (if abuts | |
| 1255 | (goto-char (car area)) | |
| 1256 | (move-to-column gocol t)) | |
| 1257 | (let ((here (point))) | |
| 1258 | (move-to-column endcol t) | |
| 1259 | (delete-region here (point)) | |
| 1260 | (if abuts | |
| 1261 | (indent-to (align-adjust-col-for-rule | |
| 1262 | (current-column) rule | |
| 1263 | (car props) (cdr props))))))))))) | |
| 1264 | (setq areas (cdr areas)))))) | |
| 1265 | ||
| a1beca85 | 1266 | (defmacro align--set-marker (marker-var pos &optional type) |
| 58a70b94 GM |
1267 | "If MARKER-VAR is a marker, move it to position POS. |
| 1268 | Otherwise, create a new marker at position POS, with type TYPE." | |
| 1269 | `(if (markerp ,marker-var) | |
| a1beca85 SM |
1270 | (move-marker ,marker-var ,pos) |
| 1271 | (setq ,marker-var (copy-marker ,pos ,type)))) | |
| 1272 | ||
| 3c4c8064 GM |
1273 | (defun align-region (beg end separate rules exclude-rules |
| 1274 | &optional func) | |
| 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'). | |
| 1280 | ||
| 1281 | The region will be divided into separate alignment sections based on | |
| 1282 | the value of SEPARATE. | |
| 1283 | ||
| 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. | |
| 1288 | ||
| 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. | |
| 1296 | ||
| 1297 | The signature of FUNC should thus be: | |
| 1298 | ||
| 1299 | (defun my-align-function (beg end mode) | |
| 1300 | \"If MODE is a rule (a list), return t if BEG to END are to be searched. | |
| 1301 | Otherwise BEG to END will be a region of text that matches the rule's | |
| 1302 | definition, and MODE will be non-nil if any changes are necessary.\" | |
| 1303 | (unless (and mode (listp mode)) | |
| 1304 | (message \"Would have aligned from %d to %d...\" beg end))) | |
| 1305 | ||
| 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." | |
| 1310 | (let ((end-mark (and end (copy-marker end t))) | |
| 1311 | (real-beg beg) | |
| 3c4c8064 GM |
1312 | (report (and (not func) align-large-region beg end |
| 1313 | (>= (- end beg) align-large-region))) | |
| 1314 | (rule-index 1) | |
| dab7711b CY |
1315 | (rule-count (length rules)) |
| 1316 | markers) | |
| 3c4c8064 GM |
1317 | (if (and align-indent-before-aligning real-beg end-mark) |
| 1318 | (indent-region real-beg end-mark nil)) | |
| 1319 | (while rules | |
| 1320 | (let* ((rule (car rules)) | |
| 1321 | (run-if (assq 'run-if rule)) | |
| 1322 | (modes (assq 'modes rule))) | |
| 1323 | ;; unless the `run-if' form tells us not to, look for the | |
| 1324 | ;; rule.. | |
| 1325 | (unless (or (and modes (not (memq major-mode | |
| 1326 | (eval (cdr modes))))) | |
| 1327 | (and run-if (not (funcall (cdr run-if))))) | |
| dbb0d350 | 1328 | (let* ((case-fold-search case-fold-search) |
| 3c4c8064 GM |
1329 | (case-fold (assq 'case-fold rule)) |
| 1330 | (regexp (cdr (assq 'regexp rule))) | |
| 1331 | (regfunc (and (functionp regexp) regexp)) | |
| 1332 | (rulesep (assq 'separate rule)) | |
| 1333 | (thissep (if rulesep (cdr rulesep) separate)) | |
| 1334 | same (eol 0) | |
| 5fe82952 | 1335 | search-start |
| dab7711b | 1336 | groups group-c |
| 3c4c8064 GM |
1337 | spacing spacing-c |
| 1338 | tab-stop tab-stop-c | |
| 1339 | repeat repeat-c | |
| 1340 | valid valid-c | |
| 06b60517 | 1341 | first |
| 3c4c8064 | 1342 | regions index |
| dab7711b | 1343 | last-point |
| 3c4c8064 GM |
1344 | save-match-data |
| 1345 | exclude-p | |
| 1346 | align-props) | |
| 1347 | (save-excursion | |
| 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. | |
| 1353 | (if real-beg | |
| 1354 | (goto-char beg) | |
| 1355 | (if (or (not thissep) (eq thissep 'entire)) | |
| 1356 | (error "Cannot determine alignment region for '%s'" | |
| 1357 | (symbol-name (cdr (assq 'title rule))))) | |
| 1358 | (beginning-of-line) | |
| 1359 | (while (and (not (eobp)) | |
| 1360 | (looking-at "^\\s-*$")) | |
| 1361 | (forward-line)) | |
| 1362 | (let* ((here (point)) | |
| 1363 | (start here)) | |
| 1364 | (while (and here | |
| 1365 | (let ((terminus | |
| 1366 | (and align-region-heuristic | |
| 1367 | (- (point) | |
| 1368 | align-region-heuristic)))) | |
| 1369 | (if regfunc | |
| 1370 | (funcall regfunc terminus t) | |
| 1371 | (re-search-backward regexp | |
| 1372 | terminus t)))) | |
| 1373 | (if (align-new-section-p (point) here thissep) | |
| 1374 | (setq beg here | |
| 1375 | here nil) | |
| 1376 | (setq here (point)))) | |
| 1377 | (if (not here) | |
| 1378 | (goto-char beg)) | |
| 1379 | (beginning-of-line) | |
| 1380 | (setq beg (point)) | |
| 1381 | (goto-char start) | |
| 1382 | (setq here (point)) | |
| 1383 | (while (and here | |
| 1384 | (let ((terminus | |
| 1385 | (and align-region-heuristic | |
| 1386 | (+ (point) | |
| 1387 | align-region-heuristic)))) | |
| 1388 | (if regfunc | |
| 1389 | (funcall regfunc terminus nil) | |
| 1390 | (re-search-forward regexp terminus t)))) | |
| 1391 | (if (align-new-section-p here (point) thissep) | |
| 1392 | (setq end here | |
| 1393 | here nil) | |
| 1394 | (setq here (point)))) | |
| 1395 | (if (not here) | |
| 1396 | (goto-char end)) | |
| 1397 | (forward-line) | |
| a1beca85 SM |
1398 | (setq end (point)) |
| 1399 | (align--set-marker end-mark end t) | |
| 3c4c8064 GM |
1400 | (goto-char beg))) |
| 1401 | ||
| 1402 | ;; If we have a region to align, and `func' is set and | |
| 1403 | ;; reports back that the region is ok, then align it. | |
| 1404 | (when (or (not func) | |
| 1405 | (funcall func beg end rule)) | |
| dbb0d350 SM |
1406 | (let (rule-beg exclude-areas) |
| 1407 | ;; determine first of all where the exclusions | |
| 1408 | ;; lie in this region | |
| 1409 | (when exclude-rules | |
| 1410 | (align-region | |
| 1411 | beg end 'entire | |
| 1412 | exclude-rules nil | |
| 1413 | (lambda (b e mode) | |
| 1414 | (or (and mode (listp mode)) | |
| 1415 | (setq exclude-areas | |
| 1416 | (cons (cons b e) | |
| 1417 | exclude-areas))))) | |
| 1418 | (setq exclude-areas | |
| 1419 | (nreverse | |
| 1420 | (sort exclude-areas #'car-less-than-car)))) | |
| 1421 | ||
| 1422 | ;; set `case-fold-search' according to the | |
| 1423 | ;; (optional) `case-fold' property | |
| 1424 | (and case-fold | |
| 1425 | (setq case-fold-search (cdr case-fold))) | |
| 1426 | ||
| 1427 | ;; while we can find the rule in the alignment | |
| 1428 | ;; region.. | |
| 1429 | (while (and (< (point) end-mark) | |
| 1430 | (setq search-start (point)) | |
| 1431 | (if regfunc | |
| 1432 | (funcall regfunc end-mark nil) | |
| 1433 | (re-search-forward regexp | |
| 1434 | end-mark t))) | |
| 1435 | ||
| 1436 | ;; give the user some indication of where we | |
| 1437 | ;; are, if it's a very large region being | |
| 1438 | ;; aligned | |
| 1439 | (if report | |
| 1440 | (let ((symbol (car rule))) | |
| 1441 | (if (and symbol (symbolp symbol)) | |
| 1442 | (message | |
| 1443 | "Aligning `%s' (rule %d of %d) %d%%..." | |
| 1444 | (symbol-name symbol) rule-index rule-count | |
| 1445 | (/ (* (- (point) real-beg) 100) | |
| 1446 | (- end-mark real-beg))) | |
| 1447 | (message | |
| 1448 | "Aligning %d%%..." | |
| 1449 | (/ (* (- (point) real-beg) 100) | |
| 1450 | (- end-mark real-beg)))))) | |
| 1451 | ||
| 1452 | ;; if the search ended us on the beginning of | |
| 1453 | ;; the next line, move back to the end of the | |
| 1454 | ;; previous line. | |
| 1455 | (if (and (bolp) (> (point) search-start)) | |
| 1456 | (forward-char -1)) | |
| 1457 | ||
| 1458 | ;; lookup the `group' attribute the first time | |
| 1459 | ;; that we need it | |
| 1460 | (unless group-c | |
| 1461 | (setq groups (or (cdr (assq 'group rule)) 1)) | |
| 1462 | (unless (listp groups) | |
| 1463 | (setq groups (list groups))) | |
| 1464 | (setq first (car groups))) | |
| 1465 | ||
| 1466 | (unless spacing-c | |
| 1467 | (setq spacing (cdr (assq 'spacing rule)) | |
| 1468 | spacing-c t)) | |
| 1469 | ||
| 1470 | (unless tab-stop-c | |
| 1471 | (setq tab-stop | |
| 1472 | (let ((rule-ts (assq 'tab-stop rule))) | |
| 1473 | (cond (rule-ts | |
| 1474 | (cdr rule-ts)) | |
| 1475 | ((symbolp align-to-tab-stop) | |
| 1476 | (symbol-value align-to-tab-stop)) | |
| 1477 | (t | |
| 1478 | align-to-tab-stop))) | |
| 1479 | tab-stop-c t)) | |
| 1480 | ||
| 1481 | ;; test whether we have found a match on the same | |
| 1482 | ;; line as a previous match | |
| 1483 | (when (> (point) eol) | |
| 1484 | (setq same nil) | |
| 1485 | (align--set-marker eol (line-end-position))) | |
| 1486 | ||
| 1487 | ;; lookup the `repeat' attribute the first time | |
| 1488 | (or repeat-c | |
| 1489 | (setq repeat (cdr (assq 'repeat rule)) | |
| 1490 | repeat-c t)) | |
| 1491 | ||
| 1492 | ;; lookup the `valid' attribute the first time | |
| 1493 | (or valid-c | |
| 1494 | (setq valid (assq 'valid rule) | |
| 1495 | valid-c t)) | |
| 1496 | ||
| 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 | |
| 1501 | (setq rule-beg (match-beginning first) | |
| 1502 | save-match-data (match-data)) | |
| 1503 | ||
| 1504 | (or rule-beg | |
| 1505 | (error "No match for subexpression %s" first)) | |
| 1506 | ||
| 1507 | ;; unless the `valid' attribute is set, and tells | |
| 1508 | ;; us that the rule is not valid at this point in | |
| 1509 | ;; the code.. | |
| 1510 | (unless (and valid (not (funcall (cdr valid)))) | |
| 1511 | ||
| 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 | |
| 1516 | (when (and last-point | |
| 1517 | (align-new-section-p last-point rule-beg | |
| 1518 | thissep)) | |
| 1519 | (align-regions regions align-props rule func) | |
| 1520 | (setq regions nil) | |
| 1521 | (setq align-props nil)) | |
| 1522 | (align--set-marker last-point rule-beg t) | |
| 1523 | ||
| 1524 | ;; restore the match data | |
| 1525 | (set-match-data save-match-data) | |
| 1526 | ||
| 1527 | ;; check whether the region to be aligned | |
| 1528 | ;; straddles an exclusion area | |
| 1529 | (let ((excls exclude-areas)) | |
| 1530 | (setq exclude-p nil) | |
| 1531 | (while excls | |
| 1532 | (if (and (< (match-beginning (car groups)) | |
| 1533 | (cdar excls)) | |
| 1534 | (> (match-end (car (last groups))) | |
| 1535 | (caar excls))) | |
| 1536 | (setq exclude-p t | |
| 1537 | excls nil) | |
| 1538 | (setq excls (cdr excls))))) | |
| 1539 | ||
| 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) | |
| 1544 | (unless exclude-p | |
| 1545 | (dolist (g groups) | |
| 1546 | ;; We must use markers, since | |
| 1547 | ;; `align-areas' may modify the buffer. | |
| 1548 | ;; Avoid polluting the markers. | |
| 1549 | (let* ((group-beg (copy-marker | |
| 1550 | (match-beginning g) t)) | |
| 1551 | (group-end (copy-marker | |
| 1552 | (match-end g) t)) | |
| 1553 | (region (cons group-beg group-end)) | |
| 1554 | (props (cons (if (listp spacing) | |
| 1555 | (car spacing) | |
| 1556 | spacing) | |
| 1557 | (if (listp tab-stop) | |
| 1558 | (car tab-stop) | |
| 1559 | tab-stop)))) | |
| 1560 | (push group-beg markers) | |
| 1561 | (push group-end markers) | |
| 1562 | (setq index (if same (1+ index) 0)) | |
| 1563 | (cond | |
| 1564 | ((nth index regions) | |
| 1565 | (setcar (nthcdr index regions) | |
| 1566 | (cons region | |
| 1567 | (nth index regions)))) | |
| 1568 | (regions | |
| 1569 | (nconc regions | |
| 1570 | (list (list region))) | |
| 1571 | (nconc align-props (list props))) | |
| 1572 | (t | |
| 1573 | (setq regions | |
| 1574 | (list (list region))) | |
| 1575 | (setq align-props (list props))))) | |
| 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. | |
| 1581 | (if (listp spacing) | |
| 1582 | (setq spacing (cdr spacing))) | |
| 1583 | (if (listp tab-stop) | |
| 1584 | (setq tab-stop (cdr tab-stop))) | |
| 1585 | (setq same t)) | |
| 1586 | ||
| 1587 | ;; if `repeat' has not been set, move to | |
| 1588 | ;; the next line; don't bother searching | |
| 1589 | ;; anymore on this one | |
| 1590 | (if (and (not repeat) (not (bolp))) | |
| 1591 | (forward-line)) | |
| 1592 | ||
| 1593 | ;; if the search did not change point, | |
| 1594 | ;; move forward to avoid an infinite loop | |
| 1595 | (if (= (point) search-start) | |
| 1596 | (forward-char))))) | |
| 1597 | ||
| 1598 | ;; when they are no more matches for this rule, | |
| 1599 | ;; align whatever was left over | |
| 1600 | (if regions | |
| 1601 | (align-regions regions align-props rule func)))))))) | |
| 3c4c8064 GM |
1602 | (setq rules (cdr rules) |
| 1603 | rule-index (1+ rule-index))) | |
| dab7711b CY |
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). | |
| 1606 | (set-marker end-mark nil) | |
| 1607 | (dolist (m markers) | |
| 1608 | (set-marker m nil)) | |
| 3c4c8064 GM |
1609 | |
| 1610 | (if report | |
| 1611 | (message "Aligning...done")))) | |
| 1612 | ||
| 1613 | ;; Provide: | |
| 1614 | ||
| 1615 | (provide 'align) | |
| 1616 | ||
| 1617 | (run-hooks 'align-load-hook) | |
| 1618 | ||
| 1619 | ;;; align.el ends here |