cc-styles.el 21.4 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; cc-styles.el --- support for styles in CC Mode

Gerd Moellmann's avatar
Gerd Moellmann committed
3
;; Copyright (C) 1985,1987,1992-2001 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

5 6
;; Authors:    2000- Martin Stjernholm
;;	       1998-1999 Barry A. Warsaw and Martin Stjernholm
Barry A. Warsaw's avatar
Barry A. Warsaw committed
7
;;             1992-1997 Barry A. Warsaw
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9
;;             1987 Dave Detlefs and Stewart Clamen
;;             1985 Richard M. Stallman
Barry A. Warsaw's avatar
Barry A. Warsaw committed
10
;; Maintainer: bug-cc-mode@gnu.org
Richard M. Stallman's avatar
Richard M. Stallman committed
11
;; Created:    22-Apr-1997 (split from cc-mode.el)
Karl Heuer's avatar
Karl Heuer committed
12
;; Version:    See cc-mode.el
Richard M. Stallman's avatar
Richard M. Stallman committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
;; Keywords:   c languages oop

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
28
;; along with GNU Emacs; see the file COPYING.  If not, write to
Gerd Moellmann's avatar
Gerd Moellmann committed
29
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Richard M. Stallman's avatar
Richard M. Stallman committed
30 31
;; Boston, MA 02111-1307, USA.

32 33 34 35
;;; Commentary:

;;; Code:

Barry A. Warsaw's avatar
Barry A. Warsaw committed
36
(eval-when-compile
Gerd Moellmann's avatar
Gerd Moellmann committed
37
  (let ((load-path
Gerd Moellmann's avatar
Gerd Moellmann committed
38 39 40
	 (if (and (boundp 'byte-compile-dest-file)
		  (stringp byte-compile-dest-file))
	     (cons (file-name-directory byte-compile-dest-file) load-path)
Gerd Moellmann's avatar
Gerd Moellmann committed
41
	   load-path)))
Gerd Moellmann's avatar
Gerd Moellmann committed
42
    (require 'cc-bytecomp)))
Gerd Moellmann's avatar
Gerd Moellmann committed
43

Gerd Moellmann's avatar
Gerd Moellmann committed
44
(cc-require 'cc-defs)
45
(cc-require 'cc-langs)
Gerd Moellmann's avatar
Gerd Moellmann committed
46
(cc-require 'cc-vars)
47 48 49 50 51 52
(cc-require 'cc-align)
;; cc-align is only indirectly required: Styles added with
;; `c-add-style' often contains references to functions defined there.

;; Silence the compiler.
(cc-bytecomp-defvar adaptive-fill-first-line-regexp) ; Emacs
Barry A. Warsaw's avatar
Barry A. Warsaw committed
53

Richard M. Stallman's avatar
Richard M. Stallman committed
54

Barry A. Warsaw's avatar
Barry A. Warsaw committed
55
;; Warning: don't eval-defun this constant or you'll break style inheritance.
Richard M. Stallman's avatar
Richard M. Stallman committed
56 57 58 59 60 61 62
(defconst c-style-alist
  '(("gnu"
     (c-basic-offset . 2)
     (c-comment-only-line-offset . (0 . 0))
     (c-offsets-alist . ((statement-block-intro . +)
			 (knr-argdecl-intro . 5)
			 (substatement-open . +)
63
			 (substatement-label . 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
64 65 66 67 68
			 (label . 0)
			 (statement-case-open . +)
			 (statement-cont . +)
			 (arglist-intro . c-lineup-arglist-intro-after-paren)
			 (arglist-close . c-lineup-arglist)
Barry A. Warsaw's avatar
Barry A. Warsaw committed
69
			 (inline-open . 0)
70
			 (brace-list-open . +)
Richard M. Stallman's avatar
Richard M. Stallman committed
71 72
			 ))
     (c-special-indent-hook . c-gnu-impose-minimum)
Gerd Moellmann's avatar
Gerd Moellmann committed
73
     (c-block-comment-prefix . "")
Richard M. Stallman's avatar
Richard M. Stallman committed
74 75 76 77 78 79 80
     )
    ("k&r"
     (c-basic-offset . 5)
     (c-comment-only-line-offset . 0)
     (c-offsets-alist . ((statement-block-intro . +)
			 (knr-argdecl-intro . 0)
			 (substatement-open . 0)
81
			 (substatement-label . 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
82 83 84 85 86
			 (label . 0)
			 (statement-cont . +)
			 ))
     )
    ("bsd"
87
     (c-basic-offset . 8)
Richard M. Stallman's avatar
Richard M. Stallman committed
88 89 90 91
     (c-comment-only-line-offset . 0)
     (c-offsets-alist . ((statement-block-intro . +)
			 (knr-argdecl-intro . +)
			 (substatement-open . 0)
92
			 (substatement-label . 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
93 94
			 (label . 0)
			 (statement-cont . +)
Gerd Moellmann's avatar
Gerd Moellmann committed
95 96
			 (inline-open . 0)
			 (inexpr-class . 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
97 98 99 100 101 102 103
			 ))
     )
    ("stroustrup"
     (c-basic-offset . 4)
     (c-comment-only-line-offset . 0)
     (c-offsets-alist . ((statement-block-intro . +)
			 (substatement-open . 0)
104
			 (substatement-label . 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
105 106 107 108 109 110 111
			 (label . 0)
			 (statement-cont . +)
			 ))
     )
    ("whitesmith"
     (c-basic-offset . 4)
     (c-comment-only-line-offset . 0)
Gerd Moellmann's avatar
Gerd Moellmann committed
112
     (c-offsets-alist . ((knr-argdecl-intro . +)
Richard M. Stallman's avatar
Richard M. Stallman committed
113 114
			 (label . 0)
			 (statement-cont . +)
Gerd Moellmann's avatar
Gerd Moellmann committed
115
			 (substatement-open . +)
116
			 (substatement-label . +)
Gerd Moellmann's avatar
Gerd Moellmann committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
			 (block-open . +)
			 (statement-block-intro . c-lineup-whitesmith-in-block)
			 (block-close . c-lineup-whitesmith-in-block)
			 (inline-open . +)
			 (defun-open . +)
			 (defun-block-intro . c-lineup-whitesmith-in-block)
			 (defun-close . c-lineup-whitesmith-in-block)
			 (brace-list-open . +)
			 (brace-list-intro . c-lineup-whitesmith-in-block)
			 (brace-entry-open . c-indent-multi-line-block)
			 (brace-list-close . c-lineup-whitesmith-in-block)
			 (class-open . +)
			 (inclass . c-lineup-whitesmith-in-block)
			 (class-close . +)
			 (inexpr-class . 0)
			 (extern-lang-open . +)
			 (inextern-lang . c-lineup-whitesmith-in-block)
			 (extern-lang-close . +)
			 (namespace-open . +)
			 (innamespace . c-lineup-whitesmith-in-block)
			 (namespace-close . +)
Richard M. Stallman's avatar
Richard M. Stallman committed
138 139 140 141 142 143 144
			 ))
     )
    ("ellemtel"
     (c-basic-offset . 3)
     (c-comment-only-line-offset . 0)
     (c-hanging-braces-alist     . ((substatement-open before after)))
     (c-offsets-alist . ((topmost-intro        . 0)
145
			 (substatement         . +)
Richard M. Stallman's avatar
Richard M. Stallman committed
146 147 148 149 150 151 152 153 154 155 156
			 (substatement-open    . 0)
                         (case-label           . +)
                         (access-label         . -)
                         (inclass              . ++)
                         (inline-open          . 0)
                         ))
     )
    ("linux"
     (c-basic-offset  . 8)
     (c-comment-only-line-offset . 0)
     (c-hanging-braces-alist . ((brace-list-open)
Barry A. Warsaw's avatar
Barry A. Warsaw committed
157
				(brace-entry-open)
Richard M. Stallman's avatar
Richard M. Stallman committed
158 159 160 161 162 163
				(substatement-open after)
				(block-close . c-snug-do-while)))
     (c-cleanup-list . (brace-else-brace))
     (c-offsets-alist . ((statement-block-intro . +)
			 (knr-argdecl-intro     . 0)
			 (substatement-open     . 0)
164
			 (substatement-label    . 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
165 166 167 168 169 170
			 (label                 . 0)
			 (statement-cont        . +)
			 ))
     )
    ("python"
     (indent-tabs-mode . t)
Gerd Moellmann's avatar
Gerd Moellmann committed
171
     (fill-column      . 78)
Richard M. Stallman's avatar
Richard M. Stallman committed
172 173
     (c-basic-offset   . 8)
     (c-offsets-alist  . ((substatement-open . 0)
174 175 176
			  (inextern-lang . 0)
			  (arglist-intro . +)
			  (knr-argdecl-intro . +)
Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179 180
			  ))
     (c-hanging-braces-alist . ((brace-list-open)
				(brace-list-intro)
				(brace-list-close)
Barry A. Warsaw's avatar
Barry A. Warsaw committed
181
				(brace-entry-open)
Richard M. Stallman's avatar
Richard M. Stallman committed
182 183 184
				(substatement-open after)
				(block-close . c-snug-do-while)
				))
Gerd Moellmann's avatar
Gerd Moellmann committed
185
     (c-block-comment-prefix . "")
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187
     )
    ("java"
188
     (c-basic-offset . 4)
Richard M. Stallman's avatar
Richard M. Stallman committed
189
     (c-comment-only-line-offset . (0 . 0))
190
     ;; the following preserves Javadoc starter lines
191 192
     (c-offsets-alist . ((inline-open . 0)
			 (topmost-intro-cont    . +)
Richard M. Stallman's avatar
Richard M. Stallman committed
193 194
			 (statement-block-intro . +)
 			 (knr-argdecl-intro     . 5)
195 196
			 (substatement-open     . +)
			 (substatement-label    . +)
Gerd Moellmann's avatar
Gerd Moellmann committed
197
 			 (label                 . +)
Richard M. Stallman's avatar
Richard M. Stallman committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
 			 (statement-case-open   . +)
 			 (statement-cont        . +)
 			 (arglist-intro  . c-lineup-arglist-intro-after-paren)
 			 (arglist-close  . c-lineup-arglist)
 			 (access-label   . 0)
			 (inher-cont     . c-lineup-java-inher)
			 (func-decl-cont . c-lineup-java-throws)
			 ))
     )
    )
  "Styles of indentation.
Elements of this alist are of the form:

  (STYLE-STRING [BASE-STYLE] (VARIABLE . VALUE) [(VARIABLE . VALUE) ...])

where STYLE-STRING is a short descriptive string used to select a
style, VARIABLE is any Emacs variable, and VALUE is the intended value
for that variable when using the selected style.

Optional BASE-STYLE if present, is a string and must follow
STYLE-STRING.  BASE-STYLE names a style that this style inherits from.
Gerd Moellmann's avatar
Gerd Moellmann committed
219
By default, all styles inherit from the \"user\" style, which is
Richard M. Stallman's avatar
Richard M. Stallman committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
computed at run time.  Style loops generate errors.

Two variables are treated specially.  When VARIABLE is
`c-offsets-alist', the VALUE is a list containing elements of the
form:

  (SYNTACTIC-SYMBOL . OFFSET)

as described in `c-offsets-alist'.  These are passed directly to
`c-set-offset' so there is no need to set every syntactic symbol in
your style, only those that are different from the default.

When VARIABLE is `c-special-indent-hook', its VALUE is added to
`c-special-indent-hook' using `add-hook'.  If VALUE is a list, each
element of the list is added with `add-hook'.

Do not change this variable directly.  Use the function `c-add-style'
to add new styles or modify existing styles (it is not a good idea to
modify existing styles -- you should create a new style that inherits
the existing style.")


;; Functions that manipulate styles
Gerd Moellmann's avatar
Gerd Moellmann committed
243
(defun c-set-style-1 (conscell dont-override)
Richard M. Stallman's avatar
Richard M. Stallman committed
244 245 246 247 248 249
  ;; Set the style for one variable
  (let ((attr (car conscell))
	(val  (cdr conscell)))
    (cond
     ;; first special variable
     ((eq attr 'c-offsets-alist)
250 251 252 253 254 255 256 257 258 259
      (let ((offsets (cond ((eq dont-override t)
			    c-offsets-alist)
			   (dont-override
			    (default-value 'c-offsets-alist)))))
	(mapcar (lambda (langentry)
		  (let ((langelem (car langentry))
			(offset (cdr langentry)))
		    (unless (assq langelem offsets)
		      (c-set-offset langelem offset))))
		val)))
Richard M. Stallman's avatar
Richard M. Stallman committed
260 261
     ;; second special variable
     ((eq attr 'c-special-indent-hook)
262 263 264 265 266 267
      ;; Maybe we should ignore dont-override here and always add new
      ;; hooks?
      (unless (cond ((eq dont-override t)
		     c-special-indent-hook)
		    (dont-override
		     (default-value 'c-special-indent-hook)))
Gerd Moellmann's avatar
Gerd Moellmann committed
268
	(if (listp val)
269 270 271 272
	    (mapcar (lambda (func)
		      (add-hook 'c-special-indent-hook func t t))
		    val)
	  (add-hook 'c-special-indent-hook val t t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
273
     ;; all other variables
274 275
     (t (when (or (not dont-override)
		  (not (memq attr c-style-variables))
276 277 278 279
		  (eq (if (eq dont-override t)
			  (symbol-value attr)
			(default-value attr))
		      'set-from-style))
280 281 282 283 284
	  (set attr val)
	  ;; Must update a number of other variables if
	  ;; c-comment-prefix-regexp is set.
	  (if (eq attr 'c-comment-prefix-regexp)
	      (c-setup-paragraph-variables)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
285

Gerd Moellmann's avatar
Gerd Moellmann committed
286 287
(defun c-get-style-variables (style basestyles)
  ;; Return all variables in a style by resolving inheritances.
288 289 290 291 292 293 294 295 296 297 298 299
  (if (not style)
      (copy-alist c-fallback-style)
    (let ((vars (cdr (or (assoc (downcase style) c-style-alist)
			 (assoc (upcase style) c-style-alist)
			 (assoc style c-style-alist)
			 (progn
			   (c-benign-error "Undefined style: %s" style)
			   nil)))))
      (let ((base (and (stringp (car-safe vars))
		       (prog1
			   (downcase (car vars))
			 (setq vars (cdr vars))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
300
	(if (memq base basestyles)
301 302 303
	    (c-benign-error "Style loop detected: %s in %s" base basestyles)
	  (nconc (c-get-style-variables base (cons base basestyles))
		 (copy-alist vars)))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
304

Richard M. Stallman's avatar
Richard M. Stallman committed
305 306 307
(defvar c-set-style-history nil)

;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
308
(defun c-set-style (stylename &optional dont-override)
Richard M. Stallman's avatar
Richard M. Stallman committed
309 310 311 312 313 314
  "Set CC Mode variables to use one of several different indentation styles.
STYLENAME is a string representing the desired style from the list of
styles described in the variable `c-style-alist'.  See that variable
for details of setting up styles.

The variable `c-indentation-style' always contains the buffer's current
Gerd Moellmann's avatar
Gerd Moellmann committed
315 316
style name.

317 318
If the optional argument DONT-OVERRIDE is t, no style variables that
already have values will be overridden.  I.e. in the case of
Gerd Moellmann's avatar
Gerd Moellmann committed
319 320 321 322
`c-offsets-alist', syntactic symbols will only be added, and in the
case of all other style variables, only those set to `set-from-style'
will be reassigned.

323 324 325 326 327 328 329 330 331 332 333
If DONT-OVERRIDE is neither nil nor t, only those style variables that
have default (i.e. non-buffer local) values will keep their settings
while the rest will be overridden.  This is useful to avoid overriding
global settings done in ~/.emacs when setting a style from a mode hook
\(providing the style variables are buffer local, which is the
default).

Obviously, setting DONT-OVERRIDE to t is useful mainly when the
initial style is chosen for a CC Mode buffer by a major mode.  Since
that is done internally by CC Mode, it typically won't have any effect
when used elsewhere."
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
  (interactive
   (list (let ((completion-ignore-case t)
	       (prompt (format "Which %s indentation style? "
			       mode-name)))
	   (condition-case nil
	       ;; The default argument is preferred over
	       ;; initial-contents, but it only exists in Emacs >= 20
	       ;; and XEmacs >= 21.
	       (completing-read prompt c-style-alist nil t nil
				'c-set-style-history
				c-indentation-style)
	     (wrong-number-of-arguments
	      ;; If the call above failed, we fall back to the old way
	      ;; of specifying the default value.
	      (completing-read prompt c-style-alist nil t
			       (cons c-indentation-style 0)
			       'c-set-style-history))))))
351
  (c-initialize-builtin-style)
Gerd Moellmann's avatar
Gerd Moellmann committed
352
  (let ((vars (c-get-style-variables stylename nil)))
353 354 355 356 357 358 359 360
    (unless dont-override
      ;; Since we always add to c-special-indent-hook we must reset it
      ;; first, or else the hooks from the preceding style will
      ;; remain.  This is not necessary for c-offsets-alist, since
      ;; c-get-style-variables contains every valid offset type in the
      ;; fallback entry.
      (setq c-special-indent-hook
	    (default-value 'c-special-indent-hook)))
Gerd Moellmann's avatar
Gerd Moellmann committed
361 362 363
    (mapcar (lambda (elem)
	      (c-set-style-1 elem dont-override))
	    ;; Need to go through the variables backwards when we
364 365
	    ;; don't override any settings.
	    (if (eq dont-override t) (nreverse vars) vars)))
Richard M. Stallman's avatar
Richard M. Stallman committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
  (setq c-indentation-style stylename)
  (c-keep-region-active))

;;;###autoload
(defun c-add-style (style descrip &optional set-p)
  "Adds a style to `c-style-alist', or updates an existing one.
STYLE is a string identifying the style to add or update.  DESCRIP is
an association list describing the style and must be of the form:

  ([BASESTYLE] (VARIABLE . VALUE) [(VARIABLE . VALUE) ...])

See the variable `c-style-alist' for the semantics of BASESTYLE,
VARIABLE and VALUE.  This function also sets the current style to
STYLE using `c-set-style' if the optional SET-P flag is non-nil."
  (interactive
   (let ((stylename (completing-read "Style to add: " c-style-alist
				     nil nil nil 'c-set-style-history))
	 (description (eval-minibuffer "Style description: ")))
     (list stylename description
	   (y-or-n-p "Set the style too? "))))
  (setq style (downcase style))
  (let ((s (assoc style c-style-alist)))
    (if s
	(setcdr s (copy-alist descrip))	; replace
      (setq c-style-alist (cons (cons style descrip) c-style-alist))))
  (and set-p (c-set-style style)))


(defvar c-read-offset-history nil)

(defun c-read-offset (langelem)
  ;; read new offset value for LANGELEM from minibuffer. return a
  ;; legal value only
Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401
  (let* ((oldoff  (cdr-safe (or (assq langelem c-offsets-alist)
				(assq langelem (get 'c-offsets-alist
						    'c-stylevar-fallback)))))
Barry A. Warsaw's avatar
Barry A. Warsaw committed
402 403
	 (symname (symbol-name langelem))
	 (defstr  (format "(default %s): " oldoff))
Gerd Moellmann's avatar
Gerd Moellmann committed
404
	 (errmsg  (concat "Offset must be int, func, var, vector, list, "
Barry A. Warsaw's avatar
Barry A. Warsaw committed
405 406 407
			  "or [+,-,++,--,*,/] "
			  defstr))
	 (prompt (concat symname " offset " defstr))
408 409 410 411 412 413 414 415
	 (keymap (make-sparse-keymap))
	 (minibuffer-completion-table obarray)
	 (minibuffer-completion-predicate 'fboundp)
	 offset input)
    ;; In principle completing-read is used here, but SPC is unbound
    ;; to make it less annoying to enter lists.
    (set-keymap-parent keymap minibuffer-local-completion-map)
    (define-key keymap " " 'self-insert-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
416
    (while (not offset)
417 418 419 420 421 422 423 424 425
      (setq input (read-from-minibuffer prompt nil keymap t
					'c-read-offset-history
					(format "%s" oldoff)))
      (if (c-valid-offset input)
	  (setq offset input)
	;; error, but don't signal one, keep trying
	;; to read an input value
	(ding)
	(setq prompt errmsg)))
Richard M. Stallman's avatar
Richard M. Stallman committed
426 427
    offset))

428
;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
429
(defun c-set-offset (symbol offset &optional ignored)
Richard M. Stallman's avatar
Richard M. Stallman committed
430 431
  "Change the value of a syntactic element symbol in `c-offsets-alist'.
SYMBOL is the syntactic element symbol to change and OFFSET is the new
Gerd Moellmann's avatar
Gerd Moellmann committed
432 433
offset for that syntactic element.  The optional argument is not used
and exists only for compatibility reasons."
Richard M. Stallman's avatar
Richard M. Stallman committed
434 435 436 437 438 439 440 441 442
  (interactive
   (let* ((langelem
	   (intern (completing-read
		    (concat "Syntactic symbol to change"
			    (if current-prefix-arg " or add" "")
			    ": ")
		    (mapcar
		     #'(lambda (langelem)
			 (cons (format "%s" (car langelem)) nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
443
		     (get 'c-offsets-alist 'c-stylevar-fallback))
Richard M. Stallman's avatar
Richard M. Stallman committed
444 445 446 447
		    nil (not current-prefix-arg)
		    ;; initial contents tries to be the last element
		    ;; on the syntactic analysis list for the current
		    ;; line
448 449 450 451 452
		    (and c-buffer-is-cc-mode
			 (let* ((syntax (c-guess-basic-syntax))
				(len (length syntax))
				(ic (format "%s" (car (nth (1- len) syntax)))))
			   (cons ic 0)))
Richard M. Stallman's avatar
Richard M. Stallman committed
453 454 455 456
		    )))
	  (offset (c-read-offset langelem)))
     (list langelem offset current-prefix-arg)))
  ;; sanity check offset
457 458 459 460 461 462 463 464 465 466
  (if (c-valid-offset offset)
      (let ((entry (assq symbol c-offsets-alist)))
	(if entry
	    (setcdr entry offset)
	  (if (assq symbol (get 'c-offsets-alist 'c-stylevar-fallback))
	      (setq c-offsets-alist (cons (cons symbol offset)
					  c-offsets-alist))
	    (c-benign-error "%s is not a valid syntactic symbol" symbol))))
    (c-benign-error "Invalid indentation setting for symbol %s: %s"
		    symbol offset))
Richard M. Stallman's avatar
Richard M. Stallman committed
467 468
  (c-keep-region-active))

469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

(defun c-setup-paragraph-variables ()
  "Fix things up for paragraph recognition and filling inside comments by
incorporating the value of `c-comment-prefix-regexp' in the relevant
variables."
  (setq c-current-comment-prefix
	(if (listp c-comment-prefix-regexp)
	    (cdr-safe (or (assoc major-mode c-comment-prefix-regexp)
			  (assoc 'other c-comment-prefix-regexp)))
	  c-comment-prefix-regexp))
  (let ((comment-line-prefix
	 (concat "[ \t]*\\(" c-current-comment-prefix "\\)[ \t]*")))
    (setq paragraph-start (concat comment-line-prefix
				  (c-lang-var paragraph-start)
				  "\\|"
				  page-delimiter)
	  paragraph-separate (concat comment-line-prefix
				     (c-lang-var paragraph-separate)
				     "\\|"
				     page-delimiter)
	  paragraph-ignore-fill-prefix t
	  adaptive-fill-mode t
	  adaptive-fill-regexp
	  (concat comment-line-prefix
		  (if (default-value 'adaptive-fill-regexp)
		      (concat "\\("
			      (default-value 'adaptive-fill-regexp)
			      "\\)")
		    "")))
    (when (boundp 'adaptive-fill-first-line-regexp)
      ;; XEmacs (20.x) adaptive fill mode doesn't have this.
      (make-local-variable 'adaptive-fill-first-line-regexp)
      (setq adaptive-fill-first-line-regexp
	    (concat "\\`" comment-line-prefix
		    ;; Maybe we should incorporate the old value here,
		    ;; but then we have to do all sorts of kludges to
		    ;; deal with the \` and \' it probably contains.
		    "\\'")))))


;; Helper for setting up Filladapt mode.  It's not used by CC Mode itself.

(cc-bytecomp-defvar filladapt-token-table)
(cc-bytecomp-defvar filladapt-token-match-table)
(cc-bytecomp-defvar filladapt-token-conversion-table)

(defun c-setup-filladapt ()
  "Convenience function to configure Kyle E. Jones' Filladapt mode for
CC Mode by making sure the proper entries are present on
`filladapt-token-table', `filladapt-token-match-table', and
`filladapt-token-conversion-table'.  This is intended to be used on
`c-mode-common-hook' or similar."
  ;; This function is intended to be used explicitly by the end user
  ;; only.
  ;;
  ;; The default configuration already handles C++ comments, but we
  ;; need to add handling of C block comments.  A new filladapt token
  ;; `c-comment' is added for that.
  (let (p)
    (setq p filladapt-token-table)
    (while (and p (not (eq (car-safe (cdr-safe (car-safe p))) 'c-comment)))
      (setq p (cdr-safe p)))
    (if p
	(setcar (car p) c-current-comment-prefix)
      (setq filladapt-token-table
	    (append (list (car filladapt-token-table)
			  (list c-current-comment-prefix 'c-comment))
		    (cdr filladapt-token-table)))))
  (unless (assq 'c-comment filladapt-token-match-table)
    (setq filladapt-token-match-table
	  (append '((c-comment c-comment))
		  filladapt-token-match-table)))
  (unless (assq 'c-comment filladapt-token-conversion-table)
    (setq filladapt-token-conversion-table
	  (append '((c-comment . exact))
		  filladapt-token-conversion-table))))
Barry A. Warsaw's avatar
Barry A. Warsaw committed
545

Gerd Moellmann's avatar
Gerd Moellmann committed
546

Richard M. Stallman's avatar
Richard M. Stallman committed
547 548 549 550 551
(defun c-initialize-builtin-style ()
  ;; Dynamically append the default value of most variables. This is
  ;; crucial because future c-set-style calls will always reset the
  ;; variables first to the `cc-mode' style before instituting the new
  ;; style.  Only do this once!
Barry A. Warsaw's avatar
Barry A. Warsaw committed
552 553
  (unless (get 'c-initialize-builtin-style 'is-run)
    (put 'c-initialize-builtin-style 'is-run t)
Gerd Moellmann's avatar
Gerd Moellmann committed
554
    ;;(c-initialize-cc-mode)
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
    (unless (assoc "user" c-style-alist)
      (let ((vars c-style-variables) var val uservars)
	(while vars
	  (setq var (car vars)
		val (symbol-value var)
		vars (cdr vars))
	  (cond ((eq var 'c-offsets-alist)
		 (or (null val)
		     (setq uservars (cons (cons 'c-offsets-alist val)
					  uservars))))
		((not (eq val 'set-from-style))
		 (setq uservars (cons (cons var val)
				      uservars)))))
	(c-add-style "user" uservars)))
    (unless (assoc "cc-mode" c-style-alist)
      (c-add-style "cc-mode" '("user")))
Barry A. Warsaw's avatar
Barry A. Warsaw committed
571 572
    (if c-style-variables-are-local-p
	(c-make-styles-buffer-local))))
573

574
(defun c-make-styles-buffer-local (&optional this-buf-only-p)
Richard M. Stallman's avatar
Richard M. Stallman committed
575
  "Make all CC Mode style variables buffer local.
Gerd Moellmann's avatar
Gerd Moellmann committed
576 577 578
If you edit primarily one style of C (or C++, Objective-C, Java, etc)
code, you probably want style variables to be global.  This is the
default.
Richard M. Stallman's avatar
Richard M. Stallman committed
579

Gerd Moellmann's avatar
Gerd Moellmann committed
580 581
If you edit many different styles of C (or C++, Objective-C, Java,
etc) at the same time, you probably want the CC Mode style variables
582
to be buffer local.  If you do, it's advisable to set any CC Mode
Gerd Moellmann's avatar
Gerd Moellmann committed
583 584
style variables in a hook function (e.g. off of `c-mode-common-hook'),
instead of at the top level of your ~/.emacs file.
Richard M. Stallman's avatar
Richard M. Stallman committed
585 586 587 588 589

This function makes all the CC Mode style variables buffer local.
Call it after CC Mode is loaded into your Emacs environment.
Conversely, set the variable `c-style-variables-are-local-p' to t in
your .emacs file, before CC Mode is loaded, and this function will be
590 591 592 593
automatically called when CC Mode is loaded.

Optional argument, when non-nil, means use `make-local-variable'
instead of `make-variable-buffer-local'."
Richard M. Stallman's avatar
Richard M. Stallman committed
594
  ;; style variables
595 596 597
  (let ((func (if this-buf-only-p
		  'make-local-variable
		'make-variable-buffer-local))
Gerd Moellmann's avatar
Gerd Moellmann committed
598 599
	(varsyms (cons 'c-indentation-style (copy-alist c-style-variables))))
    (delq 'c-special-indent-hook varsyms)
600 601 602 603
    (mapcar func varsyms)
    ;; Hooks must be handled specially
    (if this-buf-only-p
	(make-local-hook 'c-special-indent-hook)
Gerd Moellmann's avatar
Gerd Moellmann committed
604 605
      (make-variable-buffer-local 'c-special-indent-hook)
      (setq c-style-variables-are-local-p t))
606 607
    ))

Richard M. Stallman's avatar
Richard M. Stallman committed
608 609


Gerd Moellmann's avatar
Gerd Moellmann committed
610
(cc-provide 'cc-styles)
611

Richard M. Stallman's avatar
Richard M. Stallman committed
612
;;; cc-styles.el ends here