1 ;;; cc-menus.el --- imenu support for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Authors: 1998- Martin Stjernholm
6 ;; 1992-1999 Barry A. Warsaw
9 ;; 1985 Richard M. Stallman
10 ;; Maintainer: bug-cc-mode@gnu.org
11 ;; Created: 22-Apr-1997 (split from cc-mode.el)
12 ;; Keywords: c languages
15 ;; This file is part of GNU Emacs.
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 3 of the License, or
20 ;; (at your option) any later version.
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.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
36 (if (and (boundp 'byte-compile-dest-file)
37 (stringp byte-compile-dest-file))
38 (cons (file-name-directory byte-compile-dest-file) load-path)
40 (load "cc-bytecomp" nil t)))
44 ;; The things referenced in imenu, which we don't require.
45 (cc-bytecomp-defvar imenu-case-fold-search)
46 (cc-bytecomp-defvar imenu-generic-expression)
47 (cc-bytecomp-defvar imenu-create-index-function)
51 (defvar cc-imenu-c-prototype-macro-regexp nil
52 "RE matching macro names used to conditionally specify function prototypes.
59 #define _P(x) /*nothing*/
62 int main _P( (int argc, char *argv[]) )
64 A sample value might look like: `\\(_P\\|_PROTO\\)'.")
66 ;; *Warning for cc-mode developers*
68 ;; `cc-imenu-objc-generic-expression' elements depend on
69 ;; `cc-imenu-c++-generic-expression'. So if you change this
70 ;; expression, you need to change following variables,
71 ;; `cc-imenu-objc-generic-expression-*-index',
72 ;; too. `cc-imenu-objc-function' uses these *-index variables, in
73 ;; order to know where the each regexp *group \\(foobar\\)* elements
76 ;; *-index variables are initialized during `cc-imenu-objc-generic-expression'
80 (defvar cc-imenu-c++-generic-expression
82 ;; Try to match ::operator definitions first. Otherwise `X::operator new ()'
83 ;; will be incorrectly recognized as function `new ()' because the regexps
84 ;; work by backtracking from the end of the definition.
88 "[^" c-alnum "_:<>~]" ; match any non-identifier char
89 ; (note: this can be `\n')
91 "\\([" c-alnum "_:<>~]*::\\)?" ; match an operator
93 "\\(()\\|[^(]*\\)" ; special case for `()' operator
96 "[ \t]*([^)]*)[ \t]*[^ \t;]" ; followed by ws, arg list,
97 ; require something other than
98 ; a `;' after the (...) to
99 ; avoid prototypes. Can't
100 ; catch cases with () inside
101 ; the parentheses surrounding
102 ; the parameters. e.g.:
103 ; `int foo(int a=bar()) {...}'
105 ;; Special case to match a line like `main() {}'
106 ;; e.g. no return type, not even on the previous line.
110 "\\([" c-alpha "_][" c-alnum "_:<>~]*\\)" ; match function name
111 "[ \t]*(" ; see above, BUT
112 "[ \t]*\\([^ \t(*][^)]*\\)?)" ; the arg list must not start
113 "[ \t]*[^ \t;(]" ; with an asterisk or parentheses
115 ;; General function name regexp
118 "^\\<" ; line MUST start with word char
119 ;; \n added to prevent overflow in regexp matcher.
120 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-02/msg00021.html
121 "[^()\n]*" ; no parentheses before
122 "[^" c-alnum "_:<>~]" ; match any non-identifier char
123 "\\([" c-alpha "_][" c-alnum "_:<>~]*\\)" ; match function name
124 "\\([ \t\n]\\|\\\\\n\\)*(" ; see above, BUT the arg list
125 "\\([ \t\n]\\|\\\\\n\\)*" ; must not start
126 "\\([^ \t\n(*]" ; with an asterisk or parentheses
127 "[^()]*\\(([^()]*)[^()]*\\)*" ; Maybe function pointer arguments
129 "\\([ \t\n]\\|\\\\\n\\)*[^ \t\n;(]"
131 ;; Special case for definitions using phony prototype macros like:
132 ;; `int main _PROTO( (int argc,char *argv[]) )'.
133 ;; This case is only included if cc-imenu-c-prototype-macro-regexp is set.
134 ;; Only supported in c-code, so no `:<>~' chars in function name!
135 ,@(if cc-imenu-c-prototype-macro-regexp
138 "^\\<.*" ; line MUST start with word char
139 "[^" c-alnum "_]" ; match any non-identifier char
140 "\\([" c-alpha "_][" c-alnum "_]*\\)" ; match function name
141 "[ \t]*" ; whitespace before macro name
142 cc-imenu-c-prototype-macro-regexp
143 "[ \t]*(" ; ws followed by first paren.
144 "[ \t]*([^)]*)[ \t]*)[ \t]*[^ \t;]" ; see above
149 "^" ; beginning of line is required
150 "\\(template[ \t]*<[^>]+>[ \t]*\\)?" ; there may be a `template <...>'
151 "\\(class\\|struct\\)[ \t]+"
152 "\\(" ; the string we want to get
153 "[" c-alnum "_]+" ; class name
154 "\\(<[^>]+>\\)?" ; possibly explicitly specialized
156 "\\([ \t\n]\\|\\\\\n\\)*[:{]"
158 "Imenu generic expression for C++ mode. See `imenu-generic-expression'.")
160 (defvar cc-imenu-c-generic-expression
161 cc-imenu-c++-generic-expression
162 "Imenu generic expression for C mode. See `imenu-generic-expression'.")
165 ;; Auxiliary regexps for Java try to match their trailing whitespace where
166 ;; appropriate, but _not_ starting whitespace.
168 (defconst cc-imenu-java-ellipsis-regexp
173 (defun cc-imenu-java-build-type-args-regex (depth)
174 "Builds regexp for type arguments list with DEPTH allowed
175 nested angle brackets constructs."
178 "[][.," c-alnum "_? \t\n\r]+"
181 (cc-imenu-java-build-type-args-regex (1- depth))
183 (concat "[][.," c-alnum "_? \t\n\r]*"
187 (defconst cc-imenu-java-type-spec-regexp
189 ;; zero or more identifiers followed by a dot
191 "[" c-alpha "_][" c-alnum "_]*\\."
193 ;; a single mandatory identifier without a dot
194 "[" c-alpha "_][" c-alnum "_]*"
197 ;; (option 1) type arguments list which _may_ be followed with brackets
198 ;; and/or spaces, then optional variable arity
200 (cc-imenu-java-build-type-args-regex 3)
202 "\\(" cc-imenu-java-ellipsis-regexp "\\)?"
204 ;; (option 2) just brackets and/or spaces (there should be at least one),
205 ;; then optional variable arity
207 "\\(" cc-imenu-java-ellipsis-regexp "\\)?"
209 ;; (option 3) just variable arity
210 cc-imenu-java-ellipsis-regexp
213 (defconst cc-imenu-java-comment-regexp
217 ;; a traditional comment
226 ;; an end-of-line comment
232 ;; Comments are allowed before the argument, after any of the
233 ;; modifiers and after the identifier.
234 (defconst cc-imenu-java-method-arg-regexp
236 "\\(" cc-imenu-java-comment-regexp "\\)*"
237 ;; optional modifiers
239 ;; a modifier is either an annotation or "final"
243 ;; TODO support element-value pairs!
247 ;; a modifier ends with comments and/or ws
249 "\\(" cc-imenu-java-comment-regexp "\\)+"
252 "\\(" cc-imenu-java-comment-regexp "\\)*"
256 cc-imenu-java-type-spec-regexp
260 ;; optional comments and/or ws
262 "\\(" cc-imenu-java-comment-regexp "\\)*"
265 (defconst cc-imenu-java-generic-expression
268 cc-imenu-java-type-spec-regexp
269 "\\(" ; method name which gets captured
275 ;; An argument list that contains zero or more arguments.
280 "\\(" cc-imenu-java-method-arg-regexp ",[ \t\n\r]*\\)*"
281 cc-imenu-java-method-arg-regexp
284 "[.,_" c-alnum " \t\n\r]*" ; throws etc.
287 "Imenu generic expression for Java mode. See `imenu-generic-expression'.")
290 ;; Internal variables
291 (defvar cc-imenu-objc-generic-expression-noreturn-index nil)
292 (defvar cc-imenu-objc-generic-expression-general-func-index nil)
293 (defvar cc-imenu-objc-generic-expression-proto-index nil)
294 (defvar cc-imenu-objc-generic-expression-objc-base-index nil)
296 (defvar cc-imenu-objc-generic-expression
301 ;; > Special case to match a line like `main() {}'
302 ;; > e.g. no return type, not even on the previous line.
303 ;; Pick a token by (match-string 1)
304 (car (cdr (nth 1 cc-imenu-c++-generic-expression))) ; -> index += 2
305 (prog2 (setq cc-imenu-objc-generic-expression-noreturn-index 1) "")
307 ;; > General function name regexp
308 ;; Pick a token by (match-string 3)
309 (car (cdr (nth 2 cc-imenu-c++-generic-expression))) ; -> index += 6
310 (prog2 (setq cc-imenu-objc-generic-expression-general-func-index 3) "")
311 ;; > Special case for definitions using phony prototype macros like:
312 ;; > `int main _PROTO( (int argc,char *argv[]) )'.
313 ;; Pick a token by (match-string 8)
314 (if cc-imenu-c-prototype-macro-regexp
317 (car (cdr (nth 3 cc-imenu-c++-generic-expression))) ; -> index += 1
318 (prog2 (setq cc-imenu-objc-generic-expression-objc-base-index 10) "")
320 (prog2 (setq cc-imenu-objc-generic-expression-objc-base-index 9) "")
322 (prog2 (setq cc-imenu-objc-generic-expression-proto-index 9) "")
325 ;; Pick a token by (match-string 8 or 9)
328 "^[-+][:" c-alnum "()*_<>\n\t ]*[;{]" ; Methods
330 "^@interface[\t ]+[" c-alnum "_]+[\t ]*:"
332 "^@interface[\t ]+[" c-alnum "_]+[\t ]*([" c-alnum "_]+)"
334 ;; For NSObject, NSProxy and Object... They don't have super class.
335 "^@interface[\t ]+[" c-alnum "_]+[\t ]*.*$"
337 "^@implementation[\t ]+[" c-alnum "_]+[\t ]*([" c-alnum "_]+)"
339 "^@implementation[\t ]+[" c-alnum "_]+"
341 "^@protocol[\t ]+[" c-alnum "_]+" "\\)")
342 "Imenu generic expression for ObjC mode. See `imenu-generic-expression'.")
345 ;; Imenu support for objective-c uses functions.
346 (defsubst cc-imenu-objc-method-to-selector (method)
347 "Return the objc selector style string of METHOD.
349 - perform: (SEL)aSelector withObject: object1 withObject: object2; /* METHOD */
351 -perform:withObject:withObject:withObject: /* selector */"
352 (let ((return "") ; String to be returned
353 (p 0) ; Current scanning position in METHOD
354 (pmax (length method)) ;
355 char ; Current scanning target
356 (betweenparen 0) ; CHAR is in parentheses.
357 argreq ; An argument is required.
358 inargvar) ; position of CHAR is in an argument variable.
360 (setq char (aref method p)
363 ;; Is CHAR part of a objc token?
364 ((and (not inargvar) ; Ignore if CHAR is part of an argument variable.
365 (eq 0 betweenparen) ; Ignore if CHAR is in parentheses.
366 (or (and (<= ?a char) (<= char ?z))
367 (and (<= ?A char) (<= char ?Z))
368 (and (<= ?0 char) (<= char ?9))
373 (setq return (concat return (char-to-string char)))))
375 ((and inargvar (or (eq ?\ char) (eq ?\n char))
376 (setq inargvar nil)))
377 ;; Or a method separator?
378 ;; If a method separator, the next token will be an argument variable.
381 return (concat return (char-to-string char))))
382 ;; Or an open parentheses?
384 (setq betweenparen (1+ betweenparen)))
385 ;; Or a close parentheses?
387 (setq betweenparen (1- betweenparen)))))
390 (defun cc-imenu-objc-remove-white-space (str)
391 "Remove all spaces and tabs from STR."
397 (setq char (aref str p))
399 (if (or (= char ?\ ) (= char ?\t))
401 (setq return (concat return (char-to-string char)))))
404 (defun cc-imenu-objc-function ()
405 "Imenu support for Objective C mode."
409 ;; OBJC, Cnoreturn, Cgeneralfunc, Cproto are constants.
411 ;; *Warning for developers*
412 ;; These constants depend on `cc-imenu-c++-generic-expression'.
414 (OBJC cc-imenu-objc-generic-expression-objc-base-index)
415 ;; Special case to match a line like `main() {}'
416 (Cnoreturn cc-imenu-objc-generic-expression-noreturn-index)
417 ;; General function name regexp
418 (Cgeneralfunc cc-imenu-objc-generic-expression-general-func-index)
419 ;; Special case for definitions using phony prototype macros like:
420 (Cproto cc-imenu-objc-generic-expression-proto-index)
427 (intflen (length "@interface"))
428 (implen (length "@implementation"))
429 (prtlen (length "@protocol"))
432 ;; Does this emacs have buffer-substring-no-properties?
434 (if (fboundp 'buffer-substring-no-properties)
435 'buffer-substring-no-properties
437 (goto-char (point-max))
439 (while (re-search-backward cc-imenu-objc-generic-expression nil t)
440 (setq langnum (if (match-beginning OBJC)
443 ((match-beginning Cproto) Cproto)
444 ((match-beginning Cgeneralfunc) Cgeneralfunc)
445 ((match-beginning Cnoreturn) Cnoreturn))))
446 (setq str (funcall func (match-beginning langnum) (match-end langnum)))
452 ((not (eq langnum OBJC))
453 (setq clist (cons (cons str (match-beginning langnum)) clist)))
457 ;; An instance Method
458 ((eq (aref str 0) ?-)
459 (setq str (concat "-" (cc-imenu-objc-method-to-selector str)))
460 (setq methodlist (cons (cons str
461 (match-beginning langnum))
464 ((eq (aref str 0) ?+)
465 (setq str (concat "+" (cc-imenu-objc-method-to-selector str)))
466 (setq methodlist (cons (cons str
467 (match-beginning langnum))
469 ;; Interface or implementation or protocol
470 ((eq (aref str 0) ?@)
471 (setq classcount (1+ classcount))
473 ((and (> (length str) implen)
474 (string= (substring str 0 implen) "@implementation"))
475 (setq str (substring str implen)
476 str2 "@implementation"))
477 ((string= (substring str 0 intflen) "@interface")
478 (setq str (substring str intflen)
480 ((string= (substring str 0 prtlen) "@protocol")
481 (setq str (substring str prtlen)
483 (setq str (cc-imenu-objc-remove-white-space str))
484 (setq methodlist (cons (cons str2
485 (match-beginning langnum))
487 (setq toplist (cons (cons str methodlist) toplist)
490 ;; In this buffer, there is only one or zero @{interface|implementation|protocol}.
492 (let ((classname (car (car toplist)))
493 (p (cdr (car (cdr (car toplist)))))
495 (setq toplist (cons (cons classname p) (cdr (cdr (car toplist)))))
501 (setq last (cdr last)))
502 (setcdr last clist))))
503 ;; Add C lang tokens as a sub menu
505 (setq toplist (cons (cons "C" clist) toplist))))
510 ;(defvar cc-imenu-pike-generic-expression
512 ; FIXME: Please contribute one!
514 (defun cc-imenu-init (mode-generic-expression
515 &optional mode-create-index-function)
516 (setq imenu-generic-expression mode-generic-expression
517 imenu-case-fold-search nil)
518 (when mode-create-index-function
519 (setq imenu-create-index-function mode-create-index-function)))
522 (cc-provide 'cc-menus)
524 ;;; cc-menus.el ends here