1 ;;; cc-styles.el --- support for styles in CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2017 Free Software Foundation, Inc.
5 ;; Authors: 2004- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
37 (if (and (boundp 'byte-compile-dest-file
)
38 (stringp byte-compile-dest-file
))
39 (cons (file-name-directory byte-compile-dest-file
) load-path
)
41 (load "cc-bytecomp" nil t
)))
45 (cc-require 'cc-align
)
46 ;; cc-align is only indirectly required: Styles added with
47 ;; `c-add-style' often contains references to functions defined there.
49 ;; Silence the compiler.
50 (cc-bytecomp-defun c-guess-basic-syntax)
51 (cc-bytecomp-defvar adaptive-fill-first-line-regexp
) ; Emacs
57 (c-comment-only-line-offset .
(0 .
0))
58 (c-hanging-braces-alist .
((substatement-open before after
)
59 (arglist-cont-nonempty)))
60 (c-offsets-alist .
((statement-block-intro .
+)
61 (knr-argdecl-intro .
5)
62 (substatement-open .
+)
63 (substatement-label .
0)
65 (statement-case-open .
+)
67 (arglist-intro . c-lineup-arglist-intro-after-paren
)
68 (arglist-close . c-lineup-arglist
)
71 (brace-list-intro . c-lineup-arglist-intro-after-paren
)
73 .
(first c-lineup-topmost-intro-cont
74 c-lineup-gnu-DEFUN-intro-cont
))))
75 (c-special-indent-hook . c-gnu-impose-minimum
)
76 (c-block-comment-prefix .
""))
80 (c-comment-only-line-offset .
0)
81 (c-offsets-alist .
((statement-block-intro .
+)
82 (knr-argdecl-intro .
0)
83 (substatement-open .
0)
84 (substatement-label .
0)
86 (statement-cont .
+))))
90 (c-comment-only-line-offset .
0)
91 (c-offsets-alist .
((statement-block-intro .
+)
92 (knr-argdecl-intro .
+)
93 (substatement-open .
0)
94 (substatement-label .
0)
102 (c-comment-only-line-offset .
0)
103 (c-offsets-alist .
((statement-block-intro .
+)
104 (substatement-open .
0)
105 (substatement-label .
0)
107 (statement-cont .
+))))
111 (c-comment-only-line-offset .
0)
112 ;; It's obvious that the CC Mode way of choosing anchor positions
113 ;; doesn't fit this style at all. :P
114 (c-offsets-alist .
((defun-open .
+)
115 (defun-close . c-lineup-whitesmith-in-block
)
116 (defun-block-intro .
(add c-lineup-whitesmith-in-block
117 c-indent-multi-line-block
))
121 (inline-close . c-lineup-whitesmith-in-block
)
122 (knr-argdecl-intro .
+)
123 (block-open .
0) ; Get indentation from `statement' instead.
124 (block-close . c-lineup-whitesmith-in-block
)
125 (brace-list-open .
+)
126 (brace-list-close . c-lineup-whitesmith-in-block
)
127 (brace-list-intro .
(add c-lineup-whitesmith-in-block
128 c-indent-multi-line-block
))
129 (brace-list-entry .
(add c-lineup-after-whitesmith-blocks
130 c-indent-multi-line-block
))
131 (brace-entry-open .
(add c-lineup-after-whitesmith-blocks
132 c-indent-multi-line-block
))
133 (statement .
(add c-lineup-after-whitesmith-blocks
134 c-indent-multi-line-block
))
135 (statement-block-intro .
(add c-lineup-whitesmith-in-block
136 c-indent-multi-line-block
))
137 (substatement-open .
+)
138 (substatement-label .
+)
140 (arglist-intro .
(add c-lineup-whitesmith-in-block
141 c-indent-multi-line-block
))
142 (arglist-cont .
(add c-lineup-after-whitesmith-blocks
143 c-indent-multi-line-block
))
144 (arglist-cont-nonempty .
(add c-lineup-whitesmith-in-block
145 c-indent-multi-line-block
))
146 (arglist-close . c-lineup-whitesmith-in-block
)
147 (inclass . c-lineup-whitesmith-in-block
)
148 (extern-lang-open .
+)
151 (composition-open .
+)
152 (extern-lang-close .
+)
153 (namespace-close .
+)
155 (composition-close .
+)
156 (inextern-lang . c-lineup-whitesmith-in-block
)
157 (innamespace . c-lineup-whitesmith-in-block
)
158 (inmodule . c-lineup-whitesmith-in-block
)
159 (incomposition . c-lineup-whitesmith-in-block
)
160 (inexpr-class .
0))))
164 (c-comment-only-line-offset .
0)
165 (c-hanging-braces-alist .
((substatement-open before after
)
166 (arglist-cont-nonempty)))
167 (c-offsets-alist .
((topmost-intro .
0)
169 (substatement-open .
0)
176 (c-comment-only-line-offset .
0)
177 (c-hanging-braces-alist .
((brace-list-open)
179 (substatement-open after
)
180 (block-close . c-snug-do-while
)
181 (arglist-cont-nonempty)))
182 (c-cleanup-list .
(brace-else-brace))
183 (c-offsets-alist .
((statement-block-intro .
+)
184 (knr-argdecl-intro .
0)
185 (substatement-open .
0)
186 (substatement-label .
0)
188 (statement-cont .
+))))
191 (indent-tabs-mode . t
)
194 (c-offsets-alist .
((substatement-open .
0)
197 (knr-argdecl-intro .
+)))
198 (c-hanging-braces-alist .
((brace-list-open)
202 (substatement-open after
)
203 (block-close . c-snug-do-while
)
204 (arglist-cont-nonempty)))
205 (c-block-comment-prefix .
""))
209 (c-comment-only-line-offset .
(0 .
0))
210 ;; the following preserves Javadoc starter lines
211 (c-offsets-alist .
((inline-open .
0)
212 (topmost-intro-cont .
+)
213 (statement-block-intro .
+)
214 (knr-argdecl-intro .
5)
215 (substatement-open .
+)
216 (substatement-label .
+)
218 (statement-case-open .
+)
220 (arglist-intro . c-lineup-arglist-intro-after-paren
)
221 (arglist-close . c-lineup-arglist
)
223 (inher-cont . c-lineup-java-inher
)
224 (func-decl-cont . c-lineup-java-throws
))))
226 ;; awk style exists primarily for auto-newline settings. Otherwise it's
227 ;; pretty much like k&r.
230 (c-comment-only-line-offset .
0)
231 (c-hanging-braces-alist .
((defun-open after
)
232 (defun-close . c-snug-1line-defun-close
)
233 (substatement-open after
)
234 (block-close . c-snug-do-while
)
235 (arglist-cont-nonempty)))
236 (c-hanging-semi&comma-criteria . nil
)
237 (c-cleanup-list . nil
) ; You might want one-liner-defun here.
238 (c-offsets-alist .
((statement-block-intro .
+)
239 (substatement-open .
0)
240 (statement-cont .
+))))
243 "Styles of indentation.
244 Elements of this alist are of the form:
246 (STYLE-STRING [BASE-STYLE] (VARIABLE . VALUE) [(VARIABLE . VALUE) ...])
248 where STYLE-STRING is a short descriptive string used to select a
249 style, VARIABLE is any Emacs variable, and VALUE is the intended value
250 for that variable when using the selected style.
252 Optional BASE-STYLE if present, is a string and must follow
253 STYLE-STRING. BASE-STYLE names a style that this style inherits from.
254 By default, all styles inherit from the \"user\" style, which is
255 computed at run time. Style loops generate errors.
257 Two variables are treated specially. When VARIABLE is
258 `c-offsets-alist', the VALUE is a list containing elements of the
261 (SYNTACTIC-SYMBOL . OFFSET)
263 as described in `c-offsets-alist'. These are passed directly to
264 `c-set-offset' so there is no need to set every syntactic symbol in
265 your style, only those that are different from the default.
267 When VARIABLE is `c-special-indent-hook', its VALUE is added to
268 `c-special-indent-hook' using `add-hook'. If VALUE is a list, each
269 element of the list is added with `add-hook'.
271 Do not change this variable directly. Use the function `c-add-style'
272 to add new styles or modify existing styles (it is not a good idea to
273 modify existing styles -- you should create a new style that inherits
274 the existing style).")
277 ;; Functions that manipulate styles
278 (defun c-set-style-1 (conscell dont-override
)
279 ;; Set the style for one variable
280 (let ((attr (car conscell
))
281 (val (cdr conscell
)))
283 ;; first special variable
284 ((eq attr
'c-offsets-alist
)
285 (let ((offsets (cond ((eq dont-override t
)
288 (default-value 'c-offsets-alist
)))))
289 (mapcar (lambda (langentry)
290 (let ((langelem (car langentry
))
291 (offset (cdr langentry
)))
292 (unless (assq langelem offsets
)
293 (c-set-offset langelem offset
))))
295 ;; second special variable
296 ((eq attr
'c-special-indent-hook
)
297 ;; Maybe we should ignore dont-override here and always add new
299 (unless (cond ((eq dont-override t
)
300 c-special-indent-hook
)
302 (default-value 'c-special-indent-hook
)))
304 (mapcar (lambda (func)
305 (add-hook 'c-special-indent-hook func t t
))
307 (add-hook 'c-special-indent-hook val t t
))))
308 ;; all other variables
309 (t (when (or (not dont-override
)
310 (not (memq attr c-style-variables
))
311 (eq (if (eq dont-override t
)
313 (default-value attr
))
316 ;; Must update a number of other variables if
317 ;; c-comment-prefix-regexp is set.
318 (if (eq attr
'c-comment-prefix-regexp
)
319 (c-setup-paragraph-variables)))))))
321 (defun c-get-style-variables (style basestyles
)
322 ;; Return all variables in a style by resolving inheritances.
324 (copy-alist c-fallback-style
)
325 (let ((vars (cdr (or (assoc (downcase style
) c-style-alist
)
326 (assoc (upcase style
) c-style-alist
)
327 (assoc style c-style-alist
)
329 (c-benign-error "Undefined style: %s" style
)
331 (let ((base (and (stringp (car-safe vars
))
333 (downcase (car vars
))
334 (setq vars
(cdr vars
))))))
335 (if (memq base basestyles
)
336 (c-benign-error "Style loop detected: %s in %s" base basestyles
)
337 (nconc (c-get-style-variables base
(cons base basestyles
))
338 (copy-alist vars
)))))))
340 (defvar c-set-style-history nil
)
343 (defun c-set-style (stylename &optional dont-override
)
344 "Set the current buffer to use the style STYLENAME.
345 STYLENAME, a string, must be an existing CC Mode style - These are contained
346 in the variable `c-style-alist'.
348 The variable `c-indentation-style' will get set to STYLENAME.
350 \"Setting the style\" is done by setting CC Mode's \"style variables\" to the
351 values indicated by the pertinent entry in `c-style-alist'. Other variables
354 If DONT-OVERRIDE is neither nil nor t, style variables whose default values
355 have been set (more precisely, whose default values are not the symbol
356 `set-from-style') will not be changed. This avoids overriding global settings
357 done in your init file. It is useful to call c-set-style from a mode hook
360 If DONT-OVERRIDE is t, style variables that already have values (i.e., whose
361 values are not the symbol `set-from-style') will not be overridden. CC Mode
362 calls c-set-style internally in this way whilst initializing a buffer; if
363 cc-set-style is called like this from anywhere else, it will usually behave as
366 (list (let ((completion-ignore-case t
)
367 (prompt (format "Which %s indentation style? "
369 (completing-read prompt c-style-alist nil t nil
371 c-indentation-style
))))
372 (or c-buffer-is-cc-mode
373 (error "Buffer %s is not a CC Mode buffer (c-set-style)" (buffer-name)))
374 (or (stringp stylename
)
375 (error "Argument to c-set-style was not a string"))
376 (c-initialize-builtin-style)
377 (let ((vars (c-get-style-variables stylename nil
)))
378 (unless dont-override
379 ;; Since we always add to c-special-indent-hook we must reset it
380 ;; first, or else the hooks from the preceding style will
381 ;; remain. This is not necessary for c-offsets-alist, since
382 ;; c-get-style-variables contains every valid offset type in the
384 (setq c-special-indent-hook
385 (default-value 'c-special-indent-hook
)))
387 (c-set-style-1 elem dont-override
))
388 ;; Need to go through the variables backwards when we
389 ;; don't override any settings.
390 (if (eq dont-override t
) (nreverse vars
) vars
)))
391 (setq c-indentation-style stylename
)
392 (c-keep-region-active))
395 (defun c-add-style (style description
&optional set-p
)
396 "Adds a style to `c-style-alist', or updates an existing one.
397 STYLE is a string identifying the style to add or update. DESCRIPTION
398 is an association list describing the style and must be of the form:
400 ([BASESTYLE] (VARIABLE . VALUE) [(VARIABLE . VALUE) ...])
402 See the variable `c-style-alist' for the semantics of BASESTYLE,
403 VARIABLE and VALUE. This function also sets the current style to
404 STYLE using `c-set-style' if the optional SET-P flag is non-nil."
406 (let ((stylename (completing-read "Style to add: " c-style-alist
407 nil nil nil
'c-set-style-history
))
408 (descr (eval-minibuffer "Style description: ")))
409 (list stylename descr
410 (y-or-n-p "Set the style too? "))))
411 (setq style
(downcase style
))
412 (let ((s (assoc style c-style-alist
)))
414 (setcdr s
(copy-alist description
)) ; replace
415 (setq c-style-alist
(cons (cons style description
) c-style-alist
))))
416 (and set-p
(c-set-style style
)))
419 (defvar c-read-offset-history nil
)
421 (defun c-read-offset (langelem)
422 ;; read new offset value for LANGELEM from minibuffer. return a
424 (let* ((oldoff (cdr-safe (or (assq langelem c-offsets-alist
)
425 (assq langelem
(get 'c-offsets-alist
426 'c-stylevar-fallback
)))))
427 (symname (symbol-name langelem
))
428 (defstr (format "(default %s): " oldoff
))
429 (errmsg (concat "Offset must be int, func, var, vector, list, "
430 "or [+,-,++,--,*,/] "
432 (prompt (concat symname
" offset " defstr
))
433 (keymap (make-sparse-keymap))
434 (minibuffer-completion-table obarray
)
435 (minibuffer-completion-predicate 'fboundp
)
437 ;; In principle completing-read is used here, but SPC is unbound
438 ;; to make it less annoying to enter lists.
439 (set-keymap-parent keymap minibuffer-local-completion-map
)
440 (define-key keymap
" " 'self-insert-command
)
442 (setq input
(read-from-minibuffer prompt nil keymap t
443 'c-read-offset-history
444 (format "%s" oldoff
)))
445 (if (c-valid-offset input
)
447 ;; error, but don't signal one, keep trying
448 ;; to read an input value
450 (setq prompt errmsg
)))
454 (defun c-set-offset (symbol offset
&optional ignored
)
455 "Change the value of a syntactic element symbol in `c-offsets-alist'.
456 SYMBOL is the syntactic element symbol to change and OFFSET is the new
457 offset for that syntactic element. The optional argument is not used
458 and exists only for compatibility reasons."
461 (intern (completing-read
462 (concat "Syntactic symbol to change"
463 (if current-prefix-arg
" or add" "")
467 (cons (format "%s" (car langelem
)) nil
))
468 (get 'c-offsets-alist
'c-stylevar-fallback
))
469 nil
(not current-prefix-arg
)
470 ;; initial contents tries to be the last element
471 ;; on the syntactic analysis list for the current
473 (and c-buffer-is-cc-mode
475 ((syntax (c-guess-basic-syntax))
476 (len (length syntax
))
477 (ic (format "%s" (car (nth (1- len
) syntax
)))))
480 (offset (c-read-offset langelem
)))
481 (list langelem offset current-prefix-arg
)))
482 ;; sanity check offset
483 (if (c-valid-offset offset
)
484 (let ((entry (assq symbol c-offsets-alist
)))
486 (setcdr entry offset
)
487 (if (assq symbol
(get 'c-offsets-alist
'c-stylevar-fallback
))
488 (setq c-offsets-alist
(cons (cons symbol offset
)
490 (c-benign-error "%s is not a valid syntactic symbol" symbol
))))
491 (c-benign-error "Invalid indentation setting for symbol %s: %S"
493 (c-keep-region-active))
496 (defun c-setup-paragraph-variables ()
497 "Fix things up for paragraph recognition and filling inside comments and
498 strings by incorporating the values of `c-comment-prefix-regexp',
499 `sentence-end', `paragraph-start' and `paragraph-separate' in the relevant
503 (or c-buffer-is-cc-mode
504 (error "Buffer %s is not a CC Mode buffer (c-setup-paragraph-variables)"
506 ;; Set up the values for use in comments.
507 (setq c-current-comment-prefix
508 (if (listp c-comment-prefix-regexp
)
509 (cdr-safe (or (assoc major-mode c-comment-prefix-regexp
)
510 (assoc 'other c-comment-prefix-regexp
)))
511 c-comment-prefix-regexp
))
513 (let* ((empty-is-prefix (string-match c-current-comment-prefix
""))
514 (nonws-comment-line-prefix
515 (concat "\\(" c-current-comment-prefix
"\\)[ \t]*"))
516 (comment-line-prefix (concat "[ \t]*" nonws-comment-line-prefix
))
517 (blank-or-comment-line-prefix
519 (if empty-is-prefix
"" "\\(")
520 nonws-comment-line-prefix
521 (if empty-is-prefix
"" "\\)?"))))
523 (setq paragraph-start
(concat blank-or-comment-line-prefix
527 paragraph-separate
(concat blank-or-comment-line-prefix
531 paragraph-ignore-fill-prefix t
534 (concat comment-line-prefix
535 (if (default-value 'adaptive-fill-regexp
)
537 (default-value 'adaptive-fill-regexp
)
541 (when (boundp 'adaptive-fill-first-line-regexp
)
542 ;; XEmacs adaptive fill mode doesn't have this.
543 (set (make-local-variable 'adaptive-fill-first-line-regexp
)
544 (concat "\\`" comment-line-prefix
545 ;; Maybe we should incorporate the old value here,
546 ;; but then we have to do all sorts of kludges to
547 ;; deal with the \` and \' it probably contains.
550 ;; Set up the values for use in strings. These are the default
551 ;; paragraph-start/separate values, enhanced to accept escaped EOLs as
552 ;; whitespace. Used in c-beginning/end-of-sentence-in-string in cc-cmds.
553 (setq c-string-par-start
554 ;;(concat "\\(" (default-value 'paragraph-start) "\\)\\|[ \t]*\\\\$"))
556 (setq c-string-par-separate
557 ;;(concat "\\(" (default-value 'paragraph-separate) "\\)\\|[ \t]*\\\\$"))
559 (setq c-sentence-end-with-esc-eol
560 (concat "\\(\\(" (c-default-value-sentence-end) "\\)"
561 ;; N.B.: "$" would be invalid when not enclosed like "\\($\\)".
562 "\\|" "[.?!][]\"')}]* ?\\\\\\($\\)[ \t\n]*"
566 ;; Helper for setting up Filladapt mode. It's not used by CC Mode itself.
568 (cc-bytecomp-defvar filladapt-token-table
)
569 (cc-bytecomp-defvar filladapt-token-match-table
)
570 (cc-bytecomp-defvar filladapt-token-conversion-table
)
572 (defun c-setup-filladapt ()
573 "Convenience function to configure Kyle E. Jones' Filladapt mode for
574 CC Mode by making sure the proper entries are present on
575 `filladapt-token-table', `filladapt-token-match-table', and
576 `filladapt-token-conversion-table'. This is intended to be used on
577 `c-mode-common-hook' or similar."
578 ;; This function is intended to be used explicitly by the end user
581 ;; The default configuration already handles C++ comments, but we
582 ;; need to add handling of C block comments. A new filladapt token
583 ;; `c-comment' is added for that.
585 (setq p filladapt-token-table
)
586 (while (and p
(not (eq (car-safe (cdr-safe (car-safe p
))) 'c-comment
)))
587 (setq p
(cdr-safe p
)))
589 (setcar (car p
) c-current-comment-prefix
)
590 (setq filladapt-token-table
591 (append (list (car filladapt-token-table
)
592 (list c-current-comment-prefix
'c-comment
))
593 (cdr filladapt-token-table
)))))
594 (unless (assq 'c-comment filladapt-token-match-table
)
595 (setq filladapt-token-match-table
596 (append '((c-comment c-comment
))
597 filladapt-token-match-table
)))
598 (unless (assq 'c-comment filladapt-token-conversion-table
)
599 (setq filladapt-token-conversion-table
600 (append '((c-comment . exact
))
601 filladapt-token-conversion-table
))))
604 (defun c-initialize-builtin-style ()
605 ;; Dynamically append the default value of most variables. This is
606 ;; crucial because future c-set-style calls will always reset the
607 ;; variables first to the `cc-mode' style before instituting the new
608 ;; style. Only do this once!
609 (unless (get 'c-initialize-builtin-style
'is-run
)
610 (put 'c-initialize-builtin-style
'is-run t
)
611 ;;(c-initialize-cc-mode)
612 (unless (assoc "user" c-style-alist
)
613 (let ((vars c-style-variables
) var val uservars
)
616 val
(symbol-value var
)
618 (cond ((eq var
'c-offsets-alist
)
620 (setq uservars
(cons (cons 'c-offsets-alist val
)
622 ((not (eq val
'set-from-style
))
623 (setq uservars
(cons (cons var val
)
625 (c-add-style "user" uservars
)))
626 (unless (assoc "cc-mode" c-style-alist
)
627 (c-add-style "cc-mode" '("user")))
628 (if c-style-variables-are-local-p
629 (c-make-styles-buffer-local))))
631 (defun c-make-styles-buffer-local (&optional this-buf-only-p
)
632 "Make all CC Mode style variables buffer local.
633 If `this-buf-only-p' is non-nil, the style variables will be made
634 buffer local only in the current buffer. Otherwise they'll be made
635 permanently buffer local in any buffer that changes their values.
637 The buffer localness of the style variables are normally controlled
638 with the variable `c-style-variables-are-local-p', so there's seldom
639 any reason to call this function directly."
642 (let ((func (if this-buf-only-p
644 'make-variable-buffer-local
))
645 (varsyms (cons 'c-indentation-style
(copy-alist c-style-variables
))))
646 (delq 'c-special-indent-hook varsyms
)
648 ;; Hooks must be handled specially
650 (if (featurep 'xemacs
) (make-local-hook 'c-special-indent-hook
))
651 (with-no-warnings (make-variable-buffer-local 'c-special-indent-hook
))
652 (setq c-style-variables-are-local-p t
))
655 (defun cc-choose-style-for-mode (mode default-style
)
656 "Return suitable style for MODE from DEFAULT-STYLE.
657 DEFAULT-STYLE has the same format as `c-default-style'."
658 (if (stringp default-style
)
660 (or (cdr (assq mode default-style
))
661 (cdr (assq 'other default-style
))
666 (cc-provide 'cc-styles
)
669 ;; indent-tabs-mode: t
672 ;;; cc-styles.el ends here