]> code.delx.au - gnu-emacs/blob - lisp/progmodes/cc-vars.el
Update copyright notice.
[gnu-emacs] / lisp / progmodes / cc-vars.el
1 ;;; cc-vars.el --- user customization variables for CC Mode
2
3 ;; Copyright (C) 1985,1987,1992-2001 Free Software Foundation, Inc.
4
5 ;; Authors: 2000- Martin Stjernholm
6 ;; 1998-1999 Barry A. Warsaw and Martin Stjernholm
7 ;; 1992-1997 Barry A. Warsaw
8 ;; 1987 Dave Detlefs and Stewart Clamen
9 ;; 1985 Richard M. Stallman
10 ;; Maintainer: bug-cc-mode@gnu.org
11 ;; Created: 22-Apr-1997 (split from cc-mode.el)
12 ;; Version: See cc-mode.el
13 ;; Keywords: c languages oop
14
15 ;; This file is part of GNU Emacs.
16
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; any later version.
21
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
26
27 ;; 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
29 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
30 ;; Boston, MA 02111-1307, USA.
31
32 ;;; Commentary:
33
34 ;;; Code:
35
36 (eval-when-compile
37 (let ((load-path
38 (if (and (boundp 'byte-compile-dest-file)
39 (stringp byte-compile-dest-file))
40 (cons (file-name-directory byte-compile-dest-file) load-path)
41 load-path)))
42 (require 'cc-bytecomp)))
43
44 (cc-require 'cc-defs)
45
46 ;; Silence the compiler.
47 (cc-bytecomp-defun get-char-table) ; XEmacs 20+
48 (cc-bytecomp-defun char-table-range) ; Emacs 19+
49 (cc-bytecomp-defun char-table-p) ; Emacs 19+, XEmacs 20+
50
51 ;; Pull in custom if it exists and is recent enough (the one in Emacs
52 ;; 19.34 isn't).
53 (eval
54 (cc-eval-when-compile
55 (condition-case nil
56 (progn
57 (require 'custom)
58 (or (fboundp 'defcustom) (error ""))
59 (require 'wid-edit)
60 '(progn ; Compile in the require's.
61 (require 'custom)
62 (require 'wid-edit)))
63 (error
64 (message "Warning: Compiling without Customize support \
65 since a (good enough) custom library wasn't found")
66 (cc-bytecomp-defmacro define-widget (name class doc &rest args))
67 (cc-bytecomp-defmacro defcustom (symbol value doc &rest args)
68 `(defvar ,symbol ,value ,doc))
69 (cc-bytecomp-defmacro custom-declare-variable (symbol value doc
70 &rest args)
71 `(defvar ,(eval symbol) ,(eval value) ,doc))
72 nil))))
73
74 (cc-eval-when-compile
75 ;; Need the function form of `backquote', which isn't standardized
76 ;; between Emacsen. It's called `bq-process' in XEmacs, and
77 ;; `backquote-process' in Emacs. `backquote-process' returns a
78 ;; slightly more convoluted form, so let `bq-process' be the norm.
79 (if (fboundp 'backquote-process)
80 (cc-bytecomp-defmacro bq-process (form)
81 `(cdr (backquote-process ,form)))))
82
83 \f
84 ;;; Helpers
85
86 ;; This widget will show up in newer versions of the Custom library
87 (or (get 'other 'widget-type)
88 (define-widget 'other 'sexp
89 "Matches everything, but doesn't let the user edit the value.
90 Useful as last item in a `choice' widget."
91 :tag "Other"
92 :format "%t%n"
93 :value 'other))
94
95 (define-widget 'c-const-symbol 'item
96 "An uneditable lisp symbol."
97 :value nil
98 :tag "Symbol"
99 :format "%t: %v\n%d"
100 :match (lambda (widget value) (symbolp value))
101 :value-to-internal
102 (lambda (widget value)
103 (let ((s (if (symbolp value)
104 (symbol-name value)
105 value))
106 (l (widget-get widget :size)))
107 (if l
108 (setq s (concat s (make-string (- l (length s)) ?\ ))))
109 s))
110 :value-to-external
111 (lambda (widget value)
112 (if (stringp value)
113 (intern (progn
114 (string-match "\\`[^ ]*" value)
115 (match-string 0 value)))
116 value)))
117
118 (define-widget 'c-integer-or-nil 'sexp
119 "An integer or the value nil."
120 :value nil
121 :tag "Optional integer"
122 :match (lambda (widget value) (or (integerp value) (null value))))
123
124 (defvar c-style-variables
125 '(c-basic-offset c-comment-only-line-offset c-indent-comment-alist
126 c-indent-comments-syntactically-p c-block-comment-prefix
127 c-comment-prefix-regexp c-cleanup-list c-hanging-braces-alist
128 c-hanging-colons-alist c-hanging-semi&comma-criteria c-backslash-column
129 c-backslash-max-column c-special-indent-hook c-label-minimum-indentation
130 c-offsets-alist)
131 "List of the style variables.")
132
133 (defvar c-fallback-style nil)
134
135 (defsubst c-set-stylevar-fallback (name val)
136 (put name 'c-stylevar-fallback val)
137 (setq c-fallback-style (cons (cons name val) c-fallback-style)))
138
139 (defmacro defcustom-c-stylevar (name val doc &rest args)
140 "Defines a style variable."
141 `(let ((-value- ,val))
142 (c-set-stylevar-fallback ',name -value-)
143 (custom-declare-variable
144 ',name ''set-from-style
145 ,(concat doc "
146
147 This is a style variable. Apart from the valid values described
148 above, it can be set to the symbol `set-from-style'. In that case, it
149 takes its value from the style system (see `c-default-style' and
150 `c-style-alist') when a CC Mode buffer is initialized. Otherwise,
151 the value set here overrides the style system (there is a variable
152 `c-old-style-variable-behavior' that changes this, though).")
153 ,@(plist-put
154 args ':type
155 `(` (radio
156 (const :tag "Use style settings"
157 set-from-style)
158 ,(, (let ((type (eval (plist-get args ':type))))
159 (unless (consp type)
160 (setq type (list type)))
161 (unless (c-safe (plist-get (cdr type) ':value))
162 (setcdr type (append '(:value (, -value-))
163 (cdr type))))
164 (unless (c-safe (plist-get (cdr type) ':tag))
165 (setcdr type (append '(:tag "Override style settings")
166 (cdr type))))
167 (bq-process type)))))))))
168
169 (defun c-valid-offset (offset)
170 "Return non-nil iff OFFSET is a valid offset for a syntactic symbol.
171 See `c-offsets-alist'."
172 (or (eq offset '+)
173 (eq offset '-)
174 (eq offset '++)
175 (eq offset '--)
176 (eq offset '*)
177 (eq offset '/)
178 (integerp offset)
179 (functionp offset)
180 (and (symbolp offset)
181 (or (boundp offset)
182 (fboundp offset)))
183 (and (vectorp offset)
184 (= (length offset) 1)
185 (integerp (elt offset 0)))
186 (progn
187 (while (and (consp offset)
188 (c-valid-offset (car offset)))
189 (setq offset (cdr offset)))
190 (null offset))))
191
192
193 \f
194 ;;; User variables
195
196 (defcustom c-strict-syntax-p nil
197 "*If non-nil, all syntactic symbols must be found in `c-offsets-alist'.
198 If the syntactic symbol for a particular line does not match a symbol
199 in the offsets alist, or if no non-nil offset value can be determined
200 for a symbol, an error is generated, otherwise no error is reported
201 and the syntactic symbol is ignored.
202
203 This variable is considered obsolete; it doesn't work well with lineup
204 functions that return nil to support the feature of using lists on
205 syntactic symbols in `c-offsets-alist'. Please keep it set to nil."
206 :type 'boolean
207 :group 'c)
208
209 (defcustom c-echo-syntactic-information-p nil
210 "*If non-nil, syntactic info is echoed when the line is indented."
211 :type 'boolean
212 :group 'c)
213
214 (defcustom c-report-syntactic-errors nil
215 "*If non-nil, certain syntactic errors are reported with a ding
216 and a message, for example when an \"else\" is indented for which
217 there's no corresponding \"if\".
218
219 Note however that CC Mode doesn't make any special effort to check for
220 syntactic errors; that's the job of the compiler. The reason it can
221 report cases like the one above is that it can't find the correct
222 anchoring position to indent the line in that case."
223 :type 'boolean
224 :group 'c)
225
226 (defcustom-c-stylevar c-basic-offset 4
227 "*Amount of basic offset used by + and - symbols in `c-offsets-alist'.
228 Also used as the indentation step when `c-syntactic-indentation' is
229 nil."
230 :type 'integer
231 :group 'c)
232
233 (defcustom c-tab-always-indent t
234 "*Controls the operation of the TAB key.
235 If t, hitting TAB always just indents the current line. If nil,
236 hitting TAB indents the current line if point is at the left margin or
237 in the line's indentation, otherwise it insert a `real' tab character
238 \(see note\). If the symbol `other', then tab is inserted only within
239 literals -- defined as comments and strings -- and inside preprocessor
240 directives, but the line is always reindented.
241
242 Note: The value of `indent-tabs-mode' will determine whether a real
243 tab character will be inserted, or the equivalent number of spaces.
244 When inserting a tab, actually the function stored in the variable
245 `c-insert-tab-function' is called.
246
247 Note: indentation of lines containing only comments is also controlled
248 by the `c-comment-only-line-offset' variable."
249 :type '(radio
250 (const :tag "TAB key always indents, never inserts TAB" t)
251 (const :tag "TAB key indents in left margin, otherwise inserts TAB" nil)
252 (other :tag "TAB key inserts TAB in literals, otherwise indents" other))
253 :group 'c)
254
255 (defcustom c-insert-tab-function 'insert-tab
256 "*Function used when inserting a tab for \\[c-indent-command].
257 Only used when `c-tab-always-indent' indicates a `real' tab character
258 should be inserted. Value must be a function taking no arguments."
259 :type 'function
260 :group 'c)
261
262 (defcustom c-syntactic-indentation t
263 "*Whether the indentation should be controlled by the syntactic context.
264
265 If t, the indentation functions indent according to the syntactic
266 context, using the style settings specified by `c-offsets-alist'.
267
268 If nil, every line is just indented to the same level as the previous
269 one, and the \\[c-indent-command] command adjusts the indentation in
270 steps specified by `c-basic-offset'. The indentation style has no
271 effect in this mode, nor any of the indentation associated variables,
272 e.g. `c-special-indent-hook'."
273 :type 'boolean
274 :group 'c)
275
276 (defcustom c-syntactic-indentation-in-macros t
277 "*Enable syntactic analysis inside macros.
278 If this is nil, all lines inside macro definitions are analyzed as
279 `cpp-macro-cont'. Otherwise they are analyzed syntactically, just
280 like normal code, and `cpp-define-intro' is used to create the
281 additional indentation of the bodies of \"#define\" macros.
282
283 Having this enabled simplifies editing of large multiline macros, but
284 it might complicate editing if CC Mode doesn't recognize the context
285 of the macro content. The default context inside the macro is the
286 same as the top level, so if it contains \"bare\" statements they
287 might be indented wrongly, although there are special cases that
288 handles this in most cases. If this problem occurs, it's usually
289 countered easily by surrounding the statements by a block \(or even
290 better with the \"do { ... } while \(0)\" trick)."
291 :type 'boolean
292 :group 'c)
293
294 (defcustom-c-stylevar c-comment-only-line-offset 0
295 "*Extra offset for line which contains only the start of a comment.
296 Can contain an integer or a cons cell of the form:
297
298 (NON-ANCHORED-OFFSET . ANCHORED-OFFSET)
299
300 Where NON-ANCHORED-OFFSET is the amount of offset given to
301 non-column-zero anchored comment-only lines, and ANCHORED-OFFSET is
302 the amount of offset to give column-zero anchored comment-only lines.
303 Just an integer as value is equivalent to (<val> . -1000).
304
305 Note that this variable only has effect when the `c-lineup-comment'
306 lineup function is used on the `comment-intro' syntactic symbol (the
307 default)."
308 :type '(choice (integer :tag "Non-anchored offset" 0)
309 (cons :tag "Non-anchored & anchored offset"
310 :value (0 . 0)
311 (integer :tag "Non-anchored offset")
312 (integer :tag "Anchored offset")))
313 :group 'c)
314
315 (defcustom-c-stylevar c-indent-comment-alist
316 '((anchored-comment . (column . 0))
317 (end-block . (space . 1))
318 (cpp-end-block . (space . 2)))
319 "*Specifies how \\[indent-for-comment] calculates the comment start column.
320 This is an association list that contains entries of the form:
321
322 (LINE-TYPE . INDENT-SPEC)
323
324 LINE-TYPE specifies a type of line as described below, and INDENT-SPEC
325 says what \\[indent-for-comment] should do when used on that type of line.
326
327 The recognized values for LINE-TYPE are:
328
329 empty-line -- The line is empty.
330 anchored-comment -- The line contains a comment that starts in column 0.
331 end-block -- The line contains a solitary block closing brace.
332 cpp-end-block -- The line contains a preprocessor directive that
333 closes a block, i.e. either \"#endif\" or \"#else\".
334 other -- The line does not match any other entry
335 currently on the list.
336
337 An INDENT-SPEC is a cons cell of the form:
338
339 (ACTION . VALUE)
340
341 ACTION says how \\[indent-for-comment] should align the comment, and
342 VALUE is interpreted depending on ACTION. ACTION can be any of the
343 following:
344
345 space -- Put VALUE spaces between the end of the line and the start
346 of the comment.
347 column -- Start the comment at the column VALUE. If the line is
348 longer than that, the comment is preceded by a single
349 space. If VALUE is nil, `comment-column' is used.
350 align -- Align the comment with one on the previous line, if there
351 is any. If the line is too long, the comment is preceded
352 by a single space. If there isn't a comment start on the
353 previous line, the behavior is specified by VALUE, which
354 in turn is interpreted as an INDENT-SPEC.
355
356 If a LINE-TYPE is missing, then \\[indent-for-comment] indents the comment
357 according to `comment-column'.
358
359 Note that a non-nil value on `c-indent-comments-syntactically-p'
360 overrides this variable, so empty lines are indentented syntactically
361 in that case, i.e. as if \\[c-indent-command] was used instead."
362 :type
363 (let ((space '(cons :tag "space"
364 :format "%v"
365 :value (space . 1)
366 (const :format "space " space)
367 (integer :format "%v")))
368 (column '(cons :tag "column"
369 :format "%v"
370 (const :format "column " column)
371 (c-integer-or-nil :format "%v"))))
372 `(set ,@(mapcar
373 (lambda (elt)
374 `(cons :format "%v"
375 (c-const-symbol :format "%v: "
376 :size 20
377 :value ,elt)
378 (choice
379 :format "%[Choice%] %v"
380 :value (column . nil)
381 ,space
382 ,column
383 (cons :tag "align"
384 :format "%v"
385 (const :format "align " align)
386 (choice
387 :format "%[Choice%] %v"
388 :value (column . nil)
389 ,space
390 ,column)))))
391 '(empty-line anchored-comment end-block cpp-end-block other))))
392 :group 'c)
393
394 (defcustom-c-stylevar c-indent-comments-syntactically-p nil
395 "*Specifies how \\[indent-for-comment] should handle comment-only lines.
396 When this variable is non-nil, comment-only lines are indented
397 according to syntactic analysis via `c-offsets-alist'. Otherwise, the
398 comment is indented as if it was preceded by code. Note that this
399 variable does not affect how the normal line indentation treats
400 comment-only lines."
401 :type 'boolean
402 :group 'c)
403
404 (make-obsolete-variable 'c-comment-continuation-stars
405 'c-block-comment-prefix)
406
407 ;; Although c-comment-continuation-stars is obsolete, we look at it in
408 ;; some places in CC Mode anyway, so make the compiler ignore it
409 ;; during our compilation.
410 (cc-bytecomp-obsolete-var c-comment-continuation-stars)
411 (cc-bytecomp-defvar c-comment-continuation-stars)
412
413 (defcustom-c-stylevar c-block-comment-prefix
414 (if (boundp 'c-comment-continuation-stars)
415 c-comment-continuation-stars
416 "* ")
417 "*Specifies the line prefix of continued C-style block comments.
418 You should set this variable to the literal string that gets inserted
419 at the front of continued block style comment lines. This should
420 either be the empty string, or some characters without preceding
421 spaces. To adjust the alignment under the comment starter, put an
422 appropriate value on the `c' syntactic symbol (see the
423 `c-offsets-alist' variable).
424
425 It's only used when a one-line block comment is broken into two or
426 more lines for the first time; otherwise the appropriate prefix is
427 adapted from the comment. This variable is not used for C++ line
428 style comments."
429 :type 'string
430 :group 'c)
431
432 (defcustom-c-stylevar c-comment-prefix-regexp
433 '((pike-mode . "//+!?\\|\\**")
434 (other . "//+\\|\\**"))
435 "*Regexp to match the line prefix inside comments.
436 This regexp is used to recognize the fill prefix inside comments for
437 correct paragraph filling and other things.
438
439 If this variable is a string, it will be used in all CC Mode major
440 modes. It can also be an association list, to associate specific
441 regexps to specific major modes. The symbol for the major mode is
442 looked up in the association list, and its value is used as the line
443 prefix regexp. If it's not found, then the symbol `other' is looked
444 up and its value is used instead.
445
446 The regexp should match the prefix used in both C++ style line
447 comments and C style block comments, but it does not need to match a
448 block comment starter. In other words, it should at least match
449 \"//\" for line comments and the string in `c-block-comment-prefix',
450 which is sometimes inserted by CC Mode inside block comments. It
451 should not match any surrounding whitespace.
452
453 Note that CC Mode uses this variable to set many other variables that
454 handles the paragraph filling. That's done at mode initialization or
455 when you switch to a style which sets this variable. Thus, if you
456 change it in some other way, e.g. interactively in a CC Mode buffer,
457 you will need to do \\[c-mode] (or whatever mode you're currently
458 using) to reinitialize.
459
460 Note also that when CC Mode starts up, the other variables are
461 modified before the mode hooks are run. If you change this variable
462 in a mode hook, you can call `c-setup-paragraph-variables' afterwards
463 to redo it."
464 :type '(radio
465 (regexp :tag "Regexp for all modes")
466 (list
467 :tag "Mode-specific regexps"
468 (set
469 :inline t :format "%v"
470 (cons :format "%v"
471 (const :format "C " c-mode) (regexp :format "%v"))
472 (cons :format "%v"
473 (const :format "C++ " c++-mode) (regexp :format "%v"))
474 (cons :format "%v"
475 (const :format "ObjC " objc-mode) (regexp :format "%v"))
476 (cons :format "%v"
477 (const :format "Java " java-mode) (regexp :format "%v"))
478 (cons :format "%v"
479 (const :format "IDL " idl-mode) (regexp :format "%v"))
480 (cons :format "%v"
481 (const :format "Pike " pike-mode) (regexp :format "%v")))
482 (cons :format " %v"
483 (const :format "Other " other) (regexp :format "%v"))))
484 :group 'c)
485
486 (defcustom c-ignore-auto-fill '(string cpp code)
487 "*List of contexts in which automatic filling never occurs.
488 If Auto Fill mode is active, it will be temporarily disabled if point
489 is in any context on this list. It's e.g. useful to enable Auto Fill
490 in comments only, but not in strings or normal code. The valid
491 contexts are:
492
493 string -- inside a string or character literal
494 c -- inside a C style block comment
495 c++ -- inside a C++ style line comment
496 cpp -- inside a preprocessor directive
497 code -- anywhere else, i.e. in normal code"
498 :type '(set
499 (const :tag "String literals" string)
500 (const :tag "C style block comments" c)
501 (const :tag "C++ style line comments" c++)
502 (const :tag "Preprocessor directives" cpp)
503 (const :tag "Normal code" code))
504 :group 'c)
505
506 (defcustom-c-stylevar c-cleanup-list '(scope-operator)
507 "*List of various C/C++/ObjC constructs to \"clean up\".
508 The following clean ups only take place when the auto-newline feature
509 is turned on, as evidenced by the `/a' or `/ah' appearing next to the
510 mode name:
511
512 brace-else-brace -- Clean up \"} else {\" constructs by placing
513 entire construct on a single line. This clean
514 up only takes place when there is nothing but
515 white space between the braces and the `else'.
516 Clean up occurs when the open brace after the
517 `else' is typed.
518 brace-elseif-brace -- Similar to brace-else-brace, but clean up
519 \"} else if (...) {\" constructs. Clean up
520 occurs after the open parenthesis and the open
521 brace.
522 brace-catch-brace -- Similar to brace-elseif-brace, but clean up
523 \"} catch (...) {\" constructs.
524 empty-defun-braces -- Clean up empty defun braces by placing the
525 braces on the same line. Clean up occurs when
526 the defun closing brace is typed.
527 defun-close-semi -- Clean up the terminating semi-colon on defuns
528 by placing the semi-colon on the same line as
529 the closing brace. Clean up occurs when the
530 semi-colon is typed.
531 list-close-comma -- Clean up commas following braces in array
532 and aggregate initializers. Clean up occurs
533 when the comma is typed.
534 scope-operator -- Clean up double colons which may designate
535 a C++ scope operator split across multiple
536 lines. Note that certain C++ constructs can
537 generate ambiguous situations. This clean up
538 only takes place when there is nothing but
539 whitespace between colons. Clean up occurs
540 when the second colon is typed.
541
542 The following clean ups always take place when they are on this list,
543 regardless of the auto-newline feature, since they typically don't
544 involve auto-newline inserted newlines:
545
546 space-before-funcall -- Insert exactly one space before the opening
547 parenthesis of a function call. Clean up
548 occurs when the opening parenthesis is typed.
549 compact-empty-funcall -- Clean up any space before the function call
550 opening parenthesis if and only if the
551 argument list is empty. This is typically
552 useful together with `space-before-funcall' to
553 get the style \"foo (bar)\" and \"foo()\".
554 Clean up occurs when the closing parenthesis
555 is typed."
556 :type '(set
557 (const :tag "Put \"} else {\" on one line"
558 brace-else-brace)
559 (const :tag "Put \"} else if (...) {\" on one line"
560 brace-elseif-brace)
561 (const :tag "Put \"} catch (...) {\" on one line"
562 brace-catch-brace)
563 (const :tag "Put empty defun braces on one line"
564 empty-defun-braces)
565 (const :tag "Put \"};\" ending defuns on one line"
566 defun-close-semi)
567 (const :tag "Put \"},\" in aggregates on one line"
568 list-close-comma)
569 (const :tag "Put C++ style \"::\" on one line"
570 scope-operator)
571 (const :tag "Put a space before funcall parens, e.g. \"foo (bar)\""
572 space-before-funcall)
573 (const :tag "Remove space before empty funcalls, e.g. \"foo()\""
574 compact-empty-funcall))
575 :group 'c)
576
577 (defcustom-c-stylevar c-hanging-braces-alist '((brace-list-open)
578 (brace-entry-open)
579 (substatement-open after)
580 (block-close . c-snug-do-while)
581 (extern-lang-open after)
582 (inexpr-class-open after)
583 (inexpr-class-close before))
584 "*Controls the insertion of newlines before and after braces
585 when the auto-newline feature is active. This variable contains an
586 association list with elements of the following form:
587 \(SYNTACTIC-SYMBOL . ACTION).
588
589 When a brace (either opening or closing) is inserted, the syntactic
590 context it defines is looked up in this list, and if found, the
591 associated ACTION is used to determine where newlines are inserted.
592 If the context is not found, the default is to insert a newline both
593 before and after the brace.
594
595 SYNTACTIC-SYMBOL can be any of: defun-open, defun-close, class-open,
596 class-close, inline-open, inline-close, block-open, block-close,
597 substatement-open, statement-case-open, extern-lang-open,
598 extern-lang-close, brace-list-open, brace-list-close,
599 brace-list-intro, brace-entry-open, namespace-open, namespace-close,
600 inexpr-class-open, or inexpr-class-close. See `c-offsets-alist' for
601 details, except for inexpr-class-open and inexpr-class-close, which
602 doesn't have any corresponding symbols there. Those two symbols are
603 used for the opening and closing braces, respectively, of anonymous
604 inner classes in Java.
605
606 ACTION can be either a function symbol or a list containing any
607 combination of the symbols `before' or `after'. If the list is empty,
608 no newlines are inserted either before or after the brace.
609
610 When ACTION is a function symbol, the function is called with a two
611 arguments: the syntactic symbol for the brace and the buffer position
612 at which the brace was inserted. The function must return a list as
613 described in the preceding paragraph. Note that during the call to
614 the function, the variable `c-syntactic-context' is set to the entire
615 syntactic context for the brace line."
616 :type
617 `(set ,@(mapcar
618 (lambda (elt)
619 `(cons :format "%v"
620 (c-const-symbol :format "%v: "
621 :size 20
622 :value ,elt)
623 (choice :format "%[Choice%] %v"
624 :value (before after)
625 (set :menu-tag "Before/after"
626 :format "Newline %v brace\n"
627 (const :format "%v, " before)
628 (const :format "%v" after))
629 (function :menu-tag "Function"
630 :format "Run function: %v"
631 :value c-))))
632 '(defun-open defun-close
633 class-open class-close
634 inline-open inline-close
635 block-open block-close
636 substatement-open statement-case-open
637 extern-lang-open extern-lang-close
638 brace-list-open brace-list-close
639 brace-list-intro brace-entry-open
640 namespace-open namespace-close
641 inexpr-class-open inexpr-class-close)))
642 :group 'c)
643
644 (defcustom-c-stylevar c-hanging-colons-alist nil
645 "*Controls the insertion of newlines before and after certain colons.
646 This variable contains an association list with elements of the
647 following form: (SYNTACTIC-SYMBOL . ACTION).
648
649 SYNTACTIC-SYMBOL can be any of: case-label, label, access-label,
650 member-init-intro, or inher-intro.
651
652 See the variable `c-hanging-braces-alist' for the semantics of this
653 variable. Note however that making ACTION a function symbol is
654 currently not supported for this variable."
655 :type
656 `(set ,@(mapcar
657 (lambda (elt)
658 `(cons :format "%v"
659 (c-const-symbol :format "%v: "
660 :size 20
661 :value ,elt)
662 (set :format "Newline %v brace\n"
663 (const :format "%v, " before)
664 (const :format "%v" after))))
665 '(case-label label access-label member-init-intro inher-intro)))
666 :group 'c)
667
668 (defcustom-c-stylevar c-hanging-semi&comma-criteria
669 '(c-semi&comma-inside-parenlist)
670 "*List of functions that decide whether to insert a newline or not.
671 The functions in this list are called, in order, whenever the
672 auto-newline minor mode is activated (as evidenced by a `/a' or `/ah'
673 string in the mode line), and a semicolon or comma is typed (see
674 `c-electric-semi&comma'). Each function in this list is called with
675 no arguments, and should return one of the following values:
676
677 nil -- no determination made, continue checking
678 'stop -- do not insert a newline, and stop checking
679 (anything else) -- insert a newline, and stop checking
680
681 If every function in the list is called with no determination made,
682 then no newline is inserted."
683 :type '(repeat function)
684 :group 'c)
685
686 (defcustom-c-stylevar c-backslash-column 48
687 "*Minimum alignment column for line continuation backslashes.
688 This is used by the functions that automatically insert or align the
689 line continuation backslashes in multiline macros. If any line in the
690 macro exceeds this column then the next tab stop from that line is
691 used as alignment column instead."
692 :type 'integer
693 :group 'c)
694
695 (defcustom-c-stylevar c-backslash-max-column 72
696 "*Maximum alignment column for line continuation backslashes.
697 This is used by the functions that automatically insert or align the
698 line continuation backslashes in multiline macros. If any line in the
699 macro exceeds this column then the backslashes for the other lines
700 will be aligned at this column."
701 :type 'integer
702 :group 'c)
703
704 (defcustom c-auto-align-backslashes t
705 "*Align automatically inserted line continuation backslashes.
706 When line continuation backslashes are inserted automatically for line
707 breaks in multiline macros, e.g. by \\[c-context-line-break], they are
708 aligned with the other backslashes in the same macro if this flag is
709 set. Otherwise the inserted backslashes are preceded by a single
710 space."
711 :type 'boolean
712 :group 'c)
713
714 (defcustom c-backspace-function 'backward-delete-char-untabify
715 "*Function called by `c-electric-backspace' when deleting backwards."
716 :type 'function
717 :group 'c)
718
719 (defcustom c-delete-function 'delete-char
720 "*Function called by `c-electric-delete' when deleting forwards."
721 :type 'function
722 :group 'c)
723
724 (defcustom c-electric-pound-behavior nil
725 "*List of behaviors for electric pound insertion.
726 Only currently supported behavior is `alignleft'."
727 :type '(set (const alignleft))
728 :group 'c)
729
730 (defcustom c-special-indent-hook nil
731 "*Hook for user defined special indentation adjustments.
732 This hook gets called after a line is indented by the mode."
733 :type 'hook
734 :group 'c)
735
736 (defcustom-c-stylevar c-label-minimum-indentation 1
737 "*Minimum indentation for lines inside of top-level constructs.
738 This variable typically only affects code using the `gnu' style, which
739 mandates a minimum of one space in front of every line inside
740 top-level constructs. Specifically, the function
741 `c-gnu-impose-minimum' on your `c-special-indent-hook' is what
742 enforces this."
743 :type 'integer
744 :group 'c)
745
746 (defcustom c-progress-interval 5
747 "*Interval used to update progress status during long re-indentation.
748 If a number, percentage complete gets updated after each interval of
749 that many seconds. To inhibit all messages during indentation, set
750 this variable to nil."
751 :type 'integer
752 :group 'c)
753
754 (defcustom c-default-style '((java-mode . "java") (other . "gnu"))
755 "*Style which gets installed by default when a file is visited.
756
757 The value of this variable can be any style defined in
758 `c-style-alist', including styles you add. The value can also be an
759 association list of major mode symbols to style names.
760
761 When the value is a string, all CC Mode major modes will install this
762 style by default.
763
764 When the value is an alist, the major mode symbol is looked up in it
765 and the associated style is installed. If the major mode is not
766 listed in the alist, then the symbol `other' is looked up in it, and
767 if found, the style in that entry is used. If `other' is not found in
768 the alist, then \"gnu\" style is used.
769
770 The default style gets installed before your mode hooks run, so you
771 can always override the use of `c-default-style' by making calls to
772 `c-set-style' in the appropriate mode hook."
773 :type '(radio
774 (string :tag "Style in all modes")
775 (set :tag "Mode-specific styles"
776 (cons :format "%v"
777 (const :format "C " c-mode) (string :format "%v"))
778 (cons :format "%v"
779 (const :format "C++ " c++-mode) (string :format "%v"))
780 (cons :format "%v"
781 (const :format "ObjC " objc-mode) (string :format "%v"))
782 (cons :format "%v"
783 (const :format "Java " java-mode) (string :format "%v"))
784 (cons :format "%v"
785 (const :format "IDL " idl-mode) (string :format "%v"))
786 (cons :format "%v"
787 (const :format "Pike " pike-mode) (string :format "%v"))
788 (cons :format "%v"
789 (const :format "Other " other) (string :format "%v"))))
790 :group 'c)
791
792 ;; *) At the start of a statement or declaration means in more detail:
793 ;; At the closest preceding statement/declaration that starts at boi
794 ;; and doesn't have a label or comment at that position. If there's
795 ;; no such statement within the same block, then back up to the
796 ;; surrounding block or statement, add the appropriate
797 ;; statement-block-intro, defun-block-intro or substatement syntax
798 ;; symbol and continue searching.
799 (c-set-stylevar-fallback 'c-offsets-alist
800 '((string . c-lineup-dont-change)
801 ;; Relpos: Beg of previous line.
802 (c . c-lineup-C-comments)
803 ;; Relpos: Beg of the comment.
804 (defun-open . 0)
805 ;; Relpos: When inside a class: Boi at the func decl start.
806 ;; When at top level: Bol at the func decl start. When inside
807 ;; a code block (only possible in Pike): At the func decl
808 ;; start(*).
809 (defun-close . 0)
810 ;; Relpos: At the defun block open if it's at boi, otherwise
811 ;; boi at the func decl start.
812 (defun-block-intro . +)
813 ;; Relpos: At the block open(*).
814 (class-open . 0)
815 ;; Relpos: Boi at the class decl start.
816 (class-close . 0)
817 ;; Relpos: Boi at the class decl start.
818 (inline-open . +)
819 ;; Relpos: None for functions (inclass got the relpos then),
820 ;; boi at the lambda start for lambdas.
821 (inline-close . 0)
822 ;; Relpos: Inexpr functions: At the lambda block open if it's
823 ;; at boi, else at the statement(*) at boi of the start of the
824 ;; lambda construct. Otherwise: At the inline block open if
825 ;; it's at boi, otherwise boi at the func decl start.
826 (func-decl-cont . +)
827 ;; Relpos: Boi at the func decl start.
828 (knr-argdecl-intro . +)
829 ;; Relpos: Boi at the topmost intro line.
830 (knr-argdecl . 0)
831 ;; Relpos: At the beginning of the first K&R argdecl.
832 (topmost-intro . 0)
833 ;; Relpos: Bol at the last line of previous construct.
834 (topmost-intro-cont . c-lineup-topmost-intro-cont)
835 ;; Relpos: Boi at the topmost intro line.
836 (member-init-intro . +)
837 ;; Relpos: Boi at the func decl arglist open.
838 (member-init-cont . c-lineup-multi-inher)
839 ;; Relpos: Beg of the first member init.
840 (inher-intro . +)
841 ;; Relpos: Boi at the class decl start.
842 (inher-cont . c-lineup-multi-inher)
843 ;; Relpos: Java: At the implements/extends keyword start.
844 ;; Otherwise: At the inher start colon, or boi at the class
845 ;; decl start if the first inherit clause hangs and it's not a
846 ;; func-local inherit clause (when does that occur?).
847 (block-open . 0)
848 ;; Relpos: Inexpr statement: At the statement(*) at boi of the
849 ;; start of the inexpr construct. Otherwise: None.
850 (block-close . 0)
851 ;; Relpos: Inexpr statement: At the inexpr block open if it's
852 ;; at boi, else at the statement(*) at boi of the start of the
853 ;; inexpr construct. Block hanging on a case/default label: At
854 ;; the closest preceding label that starts at boi. Otherwise:
855 ;; At the block open(*).
856 (brace-list-open . 0)
857 ;; Relpos: Boi at the brace list decl start, but a starting
858 ;; "typedef" token is ignored.
859 (brace-list-close . 0)
860 ;; Relpos: At the brace list decl start(*).
861 (brace-list-intro . +)
862 ;; Relpos: At the brace list decl start(*).
863 (brace-list-entry . 0)
864 ;; Relpos: At the first non-ws char after the open paren if the
865 ;; first token is on the same line, otherwise boi at that
866 ;; token.
867 (brace-entry-open . 0)
868 ;; Relpos: Same as brace-list-entry.
869 (statement . 0)
870 ;; Relpos: After a `;' in the condition clause of a for
871 ;; statement: At the first token after the starting paren.
872 ;; Otherwise: At the preceding statement(*).
873 (statement-cont . +)
874 ;; Relpos: After the first token in the condition clause of a
875 ;; for statement: At the first token after the starting paren.
876 ;; Otherwise: At the containing statement(*).
877 (statement-block-intro . +)
878 ;; Relpos: In inexpr statement block: At the inexpr block open
879 ;; if it's at boi, else at the statement(*) at boi of the start
880 ;; of the inexpr construct. In a block hanging on a
881 ;; case/default label: At the closest preceding label that
882 ;; starts at boi. Otherwise: At the start of the containing
883 ;; block(*).
884 (statement-case-intro . +)
885 ;; Relpos: At the case/default label(*).
886 (statement-case-open . 0)
887 ;; Relpos: At the case/default label(*).
888 (substatement . +)
889 ;; Relpos: At the containing statement(*).
890 (substatement-open . +)
891 ;; Relpos: At the containing statement(*).
892 (substatement-label . 2)
893 ;; Relpos: At the containing statement(*).
894 (case-label . 0)
895 ;; Relpos: At the start of the switch block(*).
896 (access-label . -)
897 ;; Relpos: Same as inclass.
898 (label . 2)
899 ;; Relpos: At the start of the containing block(*).
900 (do-while-closure . 0)
901 ;; Relpos: At the corresponding while statement(*).
902 (else-clause . 0)
903 ;; Relpos: At the corresponding if statement(*).
904 (catch-clause . 0)
905 ;; Relpos: At the previous try or catch statement clause(*).
906 (comment-intro . (c-lineup-knr-region-comment c-lineup-comment))
907 ;; Relpos: None.
908 (arglist-intro . +)
909 ;; Relpos: Boi at the open paren, or at the first non-ws after
910 ;; the open paren of the surrounding sexp, whichever is later.
911 (arglist-cont . (c-lineup-gcc-asm-reg 0))
912 ;; Relpos: At the first token after the open paren.
913 (arglist-cont-nonempty . (c-lineup-gcc-asm-reg c-lineup-arglist))
914 ;; Relpos: Boi at the open paren, or at the first non-ws after
915 ;; the open paren of the surrounding sexp, whichever is later.
916 (arglist-close . +)
917 ;; Relpos: Boi at the open paren, or at the first non-ws after
918 ;; the open paren of the surrounding sexp, whichever is later.
919 (stream-op . c-lineup-streamop)
920 ;; Relpos: Boi at the first stream op in the statement.
921 (inclass . +)
922 ;; Relpos: At the class open brace if it's at boi, otherwise
923 ;; boi at the class decl start.
924 (cpp-macro . [0])
925 ;; Relpos: None.
926 (cpp-macro-cont . +)
927 ;; Relpos: At the macro start (always at boi).
928 (cpp-define-intro . (c-lineup-cpp-define +))
929 ;; Relpos: None.
930 (friend . 0)
931 ;; Relpos: None.
932 (objc-method-intro . [0])
933 ;; Relpos: Boi.
934 (objc-method-args-cont . c-lineup-ObjC-method-args)
935 ;; Relpos: At the method start (always at boi).
936 (objc-method-call-cont . c-lineup-ObjC-method-call)
937 ;; Relpos: At the open bracket.
938 (extern-lang-open . 0)
939 ;; Relpos: Boi at the extern keyword.
940 (extern-lang-close . 0)
941 ;; Relpos: Boi at the corresponding extern keyword.
942 (inextern-lang . +)
943 ;; Relpos: At the extern block open brace if it's at boi,
944 ;; otherwise boi at the extern keyword.
945 (namespace-open . 0)
946 ;; Relpos: Boi at the namespace keyword.
947 (namespace-close . 0)
948 ;; Relpos: Boi at the corresponding namespace keyword.
949 (innamespace . +)
950 ;; Relpos: At the namespace block open brace if it's at boi,
951 ;; otherwise boi at the namespace keyword.
952 (template-args-cont . (c-lineup-template-args +))
953 ;; Relpos: Boi at the decl start. This might be changed; the
954 ;; logical position is clearly the opening '<'.
955 (inlambda . c-lineup-inexpr-block)
956 ;; Relpos: None.
957 (lambda-intro-cont . +)
958 ;; Relpos: Boi at the lambda start.
959 (inexpr-statement . +)
960 ;; Relpos: None.
961 (inexpr-class . +)
962 ;; Relpos: None.
963 ))
964 (defcustom c-offsets-alist nil
965 "Association list of syntactic element symbols and indentation offsets.
966 As described below, each cons cell in this list has the form:
967
968 (SYNTACTIC-SYMBOL . OFFSET)
969
970 When a line is indented, CC Mode first determines the syntactic
971 context of it by generating a list of symbols called syntactic
972 elements. This list can contain more than one syntactic element and
973 the global variable `c-syntactic-context' contains the context list
974 for the line being indented. Each element in this list is actually a
975 cons cell of the syntactic symbol and a buffer position. This buffer
976 position is called the relative indent point for the line. Some
977 syntactic symbols may not have a relative indent point associated with
978 them.
979
980 After the syntactic context list for a line is generated, CC Mode
981 calculates the absolute indentation for the line by looking at each
982 syntactic element in the list. It compares the syntactic element
983 against the SYNTACTIC-SYMBOL's in `c-offsets-alist'. When it finds a
984 match, it adds the OFFSET to the column of the relative indent point.
985 The sum of this calculation for each element in the syntactic list is
986 the absolute offset for line being indented.
987
988 If the syntactic element does not match any in the `c-offsets-alist',
989 the element is ignored.
990
991 If OFFSET is nil, the syntactic element is ignored in the offset
992 calculation.
993
994 If OFFSET is an integer, it's added to the relative indent.
995
996 If OFFSET is one of the symbols `+', `-', `++', `--', `*', or `/', a
997 positive or negative multiple of `c-basic-offset' is added; 1, -1, 2,
998 -2, 0.5, and -0.5, respectively.
999
1000 If OFFSET is a vector, it's first element, which must be an integer,
1001 is used as an absolute indentation column. This overrides all
1002 relative offsets. If there are several syntactic elements which
1003 evaluates to absolute indentation columns, the first one takes
1004 precedence. You can see in which order CC Mode combines the syntactic
1005 elements in a certain context by using \\[c-show-syntactic-information] on the line.
1006
1007 If OFFSET is a function, it's called with a single argument
1008 containing the cons of the syntactic element symbol and the relative
1009 indent point. The return value from the function is then
1010 reinterpreted as an OFFSET value.
1011
1012 If OFFSET is a list, it's recursively evaluated using the semantics
1013 described above. The first element of the list to return a non-nil
1014 value succeeds. If none of the elements returns a non-nil value, the
1015 syntactic element is ignored.
1016
1017 `c-offsets-alist' is a style variable. This means that the offsets on
1018 this variable are normally taken from the style system in CC Mode
1019 \(see `c-default-style' and `c-style-alist'). However, any offsets
1020 put explicitly on this list will override the style system when a CC
1021 Mode buffer is initialized \(there is a variable
1022 `c-old-style-variable-behavior' that changes this, though).
1023
1024 Here is the current list of valid syntactic element symbols:
1025
1026 string -- Inside multi-line string.
1027 c -- Inside a multi-line C style block comment.
1028 defun-open -- Brace that opens a function definition.
1029 defun-close -- Brace that closes a function definition.
1030 defun-block-intro -- The first line in a top-level defun.
1031 class-open -- Brace that opens a class definition.
1032 class-close -- Brace that closes a class definition.
1033 inline-open -- Brace that opens an in-class inline method.
1034 inline-close -- Brace that closes an in-class inline method.
1035 func-decl-cont -- The region between a function definition's
1036 argument list and the function opening brace
1037 (excluding K&R argument declarations). In C, you
1038 cannot put anything but whitespace and comments
1039 between them; in C++ and Java, throws declarations
1040 and other things can appear in this context.
1041 knr-argdecl-intro -- First line of a K&R C argument declaration.
1042 knr-argdecl -- Subsequent lines in a K&R C argument declaration.
1043 topmost-intro -- The first line in a topmost construct definition.
1044 topmost-intro-cont -- Topmost definition continuation lines.
1045 member-init-intro -- First line in a member initialization list.
1046 member-init-cont -- Subsequent member initialization list lines.
1047 inher-intro -- First line of a multiple inheritance list.
1048 inher-cont -- Subsequent multiple inheritance lines.
1049 block-open -- Statement block open brace.
1050 block-close -- Statement block close brace.
1051 brace-list-open -- Open brace of an enum or static array list.
1052 brace-list-close -- Close brace of an enum or static array list.
1053 brace-list-intro -- First line in an enum or static array list.
1054 brace-list-entry -- Subsequent lines in an enum or static array list.
1055 brace-entry-open -- Subsequent lines in an enum or static array
1056 list that start with an open brace.
1057 statement -- A C (or like) statement.
1058 statement-cont -- A continuation of a C (or like) statement.
1059 statement-block-intro -- The first line in a new statement block.
1060 statement-case-intro -- The first line in a case \"block\".
1061 statement-case-open -- The first line in a case block starting with brace.
1062 substatement -- The first line after an if/while/for/do/else.
1063 substatement-open -- The brace that opens a substatement block.
1064 substatement-label -- Labelled line after an if/while/for/do/else.
1065 case-label -- A \"case\" or \"default\" label.
1066 access-label -- C++ private/protected/public access label.
1067 label -- Any ordinary label.
1068 do-while-closure -- The \"while\" that ends a do/while construct.
1069 else-clause -- The \"else\" of an if/else construct.
1070 catch-clause -- The \"catch\" or \"finally\" of a try/catch construct.
1071 comment-intro -- A line containing only a comment introduction.
1072 arglist-intro -- The first line in an argument list.
1073 arglist-cont -- Subsequent argument list lines when no
1074 arguments follow on the same line as the
1075 arglist opening paren.
1076 arglist-cont-nonempty -- Subsequent argument list lines when at
1077 least one argument follows on the same
1078 line as the arglist opening paren.
1079 arglist-close -- The solo close paren of an argument list.
1080 stream-op -- Lines continuing a stream operator construct.
1081 inclass -- The construct is nested inside a class definition.
1082 Used together with e.g. `topmost-intro'.
1083 cpp-macro -- The start of a C preprocessor macro definition.
1084 cpp-macro-cont -- Inside a multi-line C preprocessor macro definition.
1085 friend -- A C++ friend declaration.
1086 objc-method-intro -- The first line of an Objective-C method definition.
1087 objc-method-args-cont -- Lines continuing an Objective-C method definition.
1088 objc-method-call-cont -- Lines continuing an Objective-C method call.
1089 extern-lang-open -- Brace that opens an external language block.
1090 extern-lang-close -- Brace that closes an external language block.
1091 inextern-lang -- Analogous to the `inclass' syntactic symbol,
1092 but used inside extern constructs.
1093 namespace-open -- Brace that opens a C++ namespace block.
1094 namespace-close -- Brace that closes a C++ namespace block.
1095 innamespace -- Analogous to the `inextern-lang' syntactic
1096 symbol, but used inside C++ namespace constructs.
1097 template-args-cont -- C++ template argument list continuations.
1098 inlambda -- In the header or body of a lambda function.
1099 lambda-intro-cont -- Continuation of the header of a lambda function.
1100 inexpr-statement -- The statement is inside an expression.
1101 inexpr-class -- The class is inside an expression. Used e.g. for
1102 Java anonymous classes."
1103 :type
1104 `(set :format "%{%t%}:
1105 Override style setting
1106 | Syntax Offset
1107 %v"
1108 ,@(mapcar
1109 (lambda (elt)
1110 `(cons :format "%v"
1111 :value ,elt
1112 (c-const-symbol :format "%v: "
1113 :size 25)
1114 (sexp :format "%v"
1115 :validate
1116 (lambda (widget)
1117 (unless (c-valid-offset (widget-value widget))
1118 (widget-put widget :error "Invalid offset")
1119 widget)))))
1120 (get 'c-offsets-alist 'c-stylevar-fallback)))
1121 :group 'c)
1122
1123 (defcustom c-style-variables-are-local-p t
1124 "*Whether style variables should be buffer local by default.
1125 If non-nil, then all indentation style related variables will be made
1126 buffer local by default. If nil, they will remain global. Variables
1127 are made buffer local when this file is loaded, and once buffer
1128 localized, they cannot be made global again.
1129
1130 The list of variables to buffer localize are:
1131 c-offsets-alist
1132 c-basic-offset
1133 c-comment-only-line-offset
1134 c-block-comment-prefix
1135 c-comment-prefix-regexp
1136 c-cleanup-list
1137 c-hanging-braces-alist
1138 c-hanging-colons-alist
1139 c-hanging-semi&comma-criteria
1140 c-backslash-column
1141 c-label-minimum-indentation
1142 c-special-indent-hook
1143 c-indentation-style"
1144 :type 'boolean
1145 :group 'c)
1146
1147 (defcustom c-mode-hook nil
1148 "*Hook called by `c-mode'."
1149 :type 'hook
1150 :group 'c)
1151
1152 (defcustom c++-mode-hook nil
1153 "*Hook called by `c++-mode'."
1154 :type 'hook
1155 :group 'c)
1156
1157 (defcustom objc-mode-hook nil
1158 "*Hook called by `objc-mode'."
1159 :type 'hook
1160 :group 'c)
1161
1162 (defcustom java-mode-hook nil
1163 "*Hook called by `java-mode'."
1164 :type 'hook
1165 :group 'c)
1166
1167 (defcustom idl-mode-hook nil
1168 "*Hook called by `idl-mode'."
1169 :type 'hook
1170 :group 'c)
1171
1172 (defcustom pike-mode-hook nil
1173 "*Hook called by `pike-mode'."
1174 :type 'hook
1175 :group 'c)
1176
1177 (defcustom c-mode-common-hook nil
1178 "*Hook called by all CC Mode modes for common initializations."
1179 :type '(hook :format "%{CC Mode Common Hook%}:\n%v")
1180 :group 'c)
1181
1182 (defcustom c-initialization-hook nil
1183 "*Hook called when the CC Mode package gets initialized.
1184 This hook is only run once per Emacs session and can be used as a
1185 `load-hook' or in place of using `eval-after-load'."
1186 :type 'hook
1187 :group 'c)
1188
1189 (defcustom c-enable-xemacs-performance-kludge-p nil
1190 "*Enables a XEmacs only hack that may improve speed for some coding styles.
1191 For styles that hang top-level opening braces (as is common with JDK
1192 Java coding styles) this can improve performance between 3 and 60
1193 times for core indentation functions (e.g. `c-parse-state'). For
1194 styles that conform to the Emacs recommendation of putting these
1195 braces in column zero, this can degrade performance about as much.
1196 This variable only has effect in XEmacs."
1197 :type 'boolean
1198 :group 'c)
1199
1200 (defvar c-old-style-variable-behavior nil
1201 "*Enables the old style variable behavior when non-nil.
1202
1203 Normally the values of the style variables will override the style
1204 settings specified by the variables `c-default-style' and
1205 `c-style-alist'. However, in CC Mode 5.25 and earlier, it was the
1206 other way around, meaning that changes made to the style variables
1207 from e.g. Customize would not take effect unless special precautions
1208 were taken. That was confusing, especially for novice users.
1209
1210 It's believed that despite this change, the new behavior will still
1211 produce the same results for most old CC Mode configurations, since
1212 all style variables are per default set in a special non-override
1213 state. Set this variable only if your configuration has stopped
1214 working due to this change.")
1215
1216
1217 \f
1218 ;; Non-customizable variables, still part of the interface to CC Mode
1219 (defvar c-file-style nil
1220 "Variable interface for setting style via File Local Variables.
1221 In a file's Local Variable section, you can set this variable to a
1222 string suitable for `c-set-style'. When the file is visited, CC Mode
1223 will set the style of the file to this value automatically.
1224
1225 Note that file style settings are applied before file offset settings
1226 as designated in the variable `c-file-offsets'.")
1227 (make-variable-buffer-local 'c-file-style)
1228
1229 (defvar c-file-offsets nil
1230 "Variable interface for setting offsets via File Local Variables.
1231 In a file's Local Variable section, you can set this variable to an
1232 association list similar to the values allowed in `c-offsets-alist'.
1233 When the file is visited, CC Mode will institute these offset settings
1234 automatically.
1235
1236 Note that file offset settings are applied after file style settings
1237 as designated in the variable `c-file-style'.")
1238 (make-variable-buffer-local 'c-file-offsets)
1239
1240 (defvar c-syntactic-context nil
1241 "Variable containing syntactic analysis list during indentation.
1242 This is always bound dynamically. It should never be set statically
1243 \(e.g. with `setq').")
1244
1245 (defvar c-indentation-style nil
1246 "Name of the currently installed style.
1247 Don't change this directly; call `c-set-style' instead.")
1248
1249 (defvar c-current-comment-prefix nil
1250 "The current comment prefix regexp.
1251 Set from `c-comment-prefix-regexp' at mode initialization.")
1252 (make-variable-buffer-local 'c-current-comment-prefix)
1253
1254 (defvar c-buffer-is-cc-mode nil
1255 "Non-nil for all buffers with a major mode derived from CC Mode.
1256 Otherwise, this variable is nil. I.e. this variable is non-nil for
1257 `c-mode', `c++-mode', `objc-mode', `java-mode', `idl-mode',
1258 `pike-mode', and any other non-CC Mode mode that calls
1259 `c-initialize-cc-mode' (e.g. `awk-mode'). The value is the mode
1260 symbol itself (i.e. `c-mode' etc) of the original CC Mode mode, or
1261 just t if it's not known.")
1262 (make-variable-buffer-local 'c-buffer-is-cc-mode)
1263
1264 ;; Have to make `c-buffer-is-cc-mode' permanently local so that it
1265 ;; survives the initialization of the derived mode.
1266 (put 'c-buffer-is-cc-mode 'permanent-local t)
1267
1268 \f
1269 ;; Figure out what features this Emacs has
1270 ;;;###autoload
1271 (defconst c-emacs-features
1272 (let ((infodock-p (boundp 'infodock-version))
1273 (comments
1274 ;; XEmacs 19 and beyond use 8-bit modify-syntax-entry flags.
1275 ;; Emacs 19 uses a 1-bit flag. We will have to set up our
1276 ;; syntax tables differently to handle this.
1277 (let ((table (copy-syntax-table))
1278 entry)
1279 (modify-syntax-entry ?a ". 12345678" table)
1280 (cond
1281 ;; XEmacs 19, and beyond Emacs 19.34
1282 ((arrayp table)
1283 (setq entry (aref table ?a))
1284 ;; In Emacs, table entries are cons cells
1285 (if (consp entry) (setq entry (car entry))))
1286 ;; XEmacs 20
1287 ((fboundp 'get-char-table) (setq entry (get-char-table ?a table)))
1288 ;; before and including Emacs 19.34
1289 ((and (fboundp 'char-table-p)
1290 (char-table-p table))
1291 (setq entry (car (char-table-range table [?a]))))
1292 ;; incompatible
1293 (t (error "CC Mode is incompatible with this version of Emacs")))
1294 (if (= (logand (lsh entry -16) 255) 255)
1295 '8-bit
1296 '1-bit))))
1297 (if infodock-p
1298 (list comments 'infodock)
1299 (list comments)))
1300 "A list of features extant in the Emacs you are using.
1301 There are many flavors of Emacs out there, each with different
1302 features supporting those needed by CC Mode. Here's the current
1303 supported list, along with the values for this variable:
1304
1305 XEmacs 19, 20, 21: (8-bit)
1306 Emacs 19, 20: (1-bit)
1307
1308 Infodock (based on XEmacs) has an additional symbol on this list:
1309 `infodock'.")
1310
1311 \f
1312 (cc-provide 'cc-vars)
1313
1314 ;;; cc-vars.el ends here