1 ;;; cc-menus.el --- imenu support for CC Mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 1998- Martin Stjernholm
8 ;; 1992-1999 Barry A. Warsaw
9 ;; 1987 Dave Detlefs and Stewart Clamen
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Version: See cc-mode.el
14 ;; Keywords: c languages oop
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software; you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation; either version 3, or (at your option)
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with this program; see the file COPYING. If not, write to
30 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
31 ;; Boston, MA 02110-1301, USA.
39 (if (and (boundp 'byte-compile-dest-file)
40 (stringp byte-compile-dest-file))
41 (cons (file-name-directory byte-compile-dest-file) load-path)
43 (load "cc-bytecomp" nil t)))
47 ;; The things referenced in imenu, which we don't require.
48 (cc-bytecomp-defvar imenu-case-fold-search)
49 (cc-bytecomp-defvar imenu-generic-expression)
50 (cc-bytecomp-defvar imenu-create-index-function)
51 (cc-bytecomp-defun imenu-progress-message)
55 (defvar cc-imenu-c-prototype-macro-regexp nil
56 "RE matching macro names used to conditionally specify function prototypes.
63 #define _P(x) /*nothing*/
66 int main _P( (int argc, char *argv[]) )
68 A sample value might look like: `\\(_P\\|_PROTO\\)'.")
70 (defvar cc-imenu-c++-generic-expression
72 ;; Try to match ::operator definitions first. Otherwise `X::operator new ()'
73 ;; will be incorrectly recognised as function `new ()' because the regexps
74 ;; work by backtracking from the end of the definition.
78 "[^" c-alnum "_:<>~]" ; match any non-identifier char
79 ; (note: this can be `\n')
81 "\\([" c-alnum "_:<>~]*::\\)?" ; match an operator
83 "\\(()\\|[^(]*\\)" ; special case for `()' operator
86 "[ \t]*([^)]*)[ \t]*[^ \t;]" ; followed by ws, arg list,
87 ; require something other than
88 ; a `;' after the (...) to
89 ; avoid prototypes. Can't
90 ; catch cases with () inside
91 ; the parentheses surrounding
92 ; the parameters. e.g.:
93 ; `int foo(int a=bar()) {...}'
95 ;; Special case to match a line like `main() {}'
96 ;; e.g. no return type, not even on the previous line.
100 "\\([" c-alpha "_][" c-alnum "_:<>~]*\\)" ; match function name
101 "[ \t]*(" ; see above, BUT
102 "[ \t]*\\([^ \t(*][^)]*\\)?)" ; the arg list must not start
103 "[ \t]*[^ \t;(]" ; with an asterisk or parentheses
105 ;; General function name regexp
108 "^\\<" ; line MUST start with word char
109 ;; \n added to prevent overflow in regexp matcher.
110 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-02/msg00021.html
111 "[^()\n]*" ; no parentheses before
112 "[^" c-alnum "_:<>~]" ; match any non-identifier char
113 "\\([" c-alpha "_][" c-alnum "_:<>~]*\\)" ; match function name
114 "\\([ \t\n]\\|\\\\\n\\)*(" ; see above, BUT the arg list
115 "\\([ \t\n]\\|\\\\\n\\)*\\([^ \t\n(*][^)]*\\)?)" ; must not start
116 "\\([ \t\n]\\|\\\\\n\\)*[^ \t\n;(]" ; with an asterisk or parentheses
118 ;; Special case for definitions using phony prototype macros like:
119 ;; `int main _PROTO( (int argc,char *argv[]) )'.
120 ;; This case is only included if cc-imenu-c-prototype-macro-regexp is set.
121 ;; Only supported in c-code, so no `:<>~' chars in function name!
122 ,@(if cc-imenu-c-prototype-macro-regexp
125 "^\\<.*" ; line MUST start with word char
126 "[^" c-alnum "_]" ; match any non-identifier char
127 "\\([" c-alpha "_][" c-alnum "_]*\\)" ; match function name
128 "[ \t]*" ; whitespace before macro name
129 cc-imenu-c-prototype-macro-regexp
130 "[ \t]*(" ; ws followed by first paren.
131 "[ \t]*([^)]*)[ \t]*)[ \t]*[^ \t;]" ; see above
136 "^" ; beginning of line is required
137 "\\(template[ \t]*<[^>]+>[ \t]*\\)?" ; there may be a `template <...>'
138 "\\(class\\|struct\\)[ \t]+"
139 "\\(" ; the string we want to get
140 "[" c-alnum "_]+" ; class name
141 "\\(<[^>]+>\\)?" ; possibly explicitly specialized
143 "\\([ \t\n]\\|\\\\\n\\)*[:{]"
145 "Imenu generic expression for C++ mode. See `imenu-generic-expression'.")
147 (defvar cc-imenu-c-generic-expression
148 cc-imenu-c++-generic-expression
149 "Imenu generic expression for C mode. See `imenu-generic-expression'.")
151 (defvar cc-imenu-java-generic-expression
154 "[" c-alpha "_][\]\[." c-alnum "_]+[ \t\n\r]+" ; type spec
155 "\\([" c-alpha "_][" c-alnum "_]+\\)" ; method name
157 ;; An argument list that is either empty or contains at least
158 ;; two identifiers with only space between them. This avoids
159 ;; matching e.g. "else if (foo)".
160 (concat "([ \t\n\r]*"
161 "\\([\]\[.," c-alnum "_]+"
163 "[\]\[.," c-alnum "_]"
164 "[\]\[.," c-alnum "_ \t\n\r]*"
166 "[.," c-alnum "_ \t\n\r]*"
169 "Imenu generic expression for Java mode. See `imenu-generic-expression'.")
171 ;; *Warning for cc-mode developers*
173 ;; `cc-imenu-objc-generic-expression' elements depend on
174 ;; `cc-imenu-c++-generic-expression'. So if you change this
175 ;; expression, you need to change following variables,
176 ;; `cc-imenu-objc-generic-expression-*-index',
177 ;; too. `cc-imenu-objc-function' uses these *-index variables, in
178 ;; order to know where the each regexp *group \\(foobar\\)* elements
181 ;; *-index variables are initialized during `cc-imenu-objc-generic-expression'
182 ;; being initialized.
185 ;; Internal variables
186 (defvar cc-imenu-objc-generic-expression-noreturn-index nil)
187 (defvar cc-imenu-objc-generic-expression-general-func-index nil)
188 (defvar cc-imenu-objc-generic-expression-proto-index nil)
189 (defvar cc-imenu-objc-generic-expression-objc-base-index nil)
191 (defvar cc-imenu-objc-generic-expression
196 ;; > Special case to match a line like `main() {}'
197 ;; > e.g. no return type, not even on the previous line.
198 ;; Pick a token by (match-string 1)
199 (car (cdr (nth 1 cc-imenu-c++-generic-expression))) ; -> index += 2
200 (prog2 (setq cc-imenu-objc-generic-expression-noreturn-index 1) "")
202 ;; > General function name regexp
203 ;; Pick a token by (match-string 3)
204 (car (cdr (nth 2 cc-imenu-c++-generic-expression))) ; -> index += 5
205 (prog2 (setq cc-imenu-objc-generic-expression-general-func-index 3) "")
206 ;; > Special case for definitions using phony prototype macros like:
207 ;; > `int main _PROTO( (int argc,char *argv[]) )'.
208 ;; Pick a token by (match-string 8)
209 (if cc-imenu-c-prototype-macro-regexp
212 (car (cdr (nth 3 cc-imenu-c++-generic-expression))) ; -> index += 1
213 (prog2 (setq cc-imenu-objc-generic-expression-objc-base-index 9) "")
215 (prog2 (setq cc-imenu-objc-generic-expression-objc-base-index 8) "")
217 (prog2 (setq cc-imenu-objc-generic-expression-proto-index 8) "")
220 ;; Pick a token by (match-string 8 or 9)
223 "^[-+][:" c-alnum "()*_<>\n\t ]*[;{]" ; Methods
225 "^@interface[\t ]+[" c-alnum "_]+[\t ]*:"
227 "^@interface[\t ]+[" c-alnum "_]+[\t ]*([" c-alnum "_]+)"
229 ;; For NSObject, NSProxy and Object... They don't have super class.
230 "^@interface[\t ]+[" c-alnum "_]+[\t ]*.*$"
232 "^@implementation[\t ]+[" c-alnum "_]+[\t ]*([" c-alnum "_]+)"
234 "^@implementation[\t ]+[" c-alnum "_]+"
236 "^@protocol[\t ]+[" c-alnum "_]+" "\\)")
237 "Imenu generic expression for ObjC mode. See `imenu-generic-expression'.")
240 ;; Imenu support for objective-c uses functions.
241 (defsubst cc-imenu-objc-method-to-selector (method)
242 "Return the objc selector style string of METHOD.
244 - perform: (SEL)aSelector withObject: object1 withObject: object2; /* METHOD */
246 -perform:withObject:withObject:withObject: /* selector */"
247 (let ((return "") ; String to be returned
248 (p 0) ; Current scanning position in METHOD
249 (pmax (length method)) ;
250 char ; Current scanning target
251 (betweenparen 0) ; CHAR is in parentheses.
252 argreq ; An argument is required.
253 inargvar) ; position of CHAR is in an argument variable.
255 (setq char (aref method p)
258 ;; Is CHAR part of a objc token?
259 ((and (not inargvar) ; Ignore if CHAR is part of an argument variable.
260 (eq 0 betweenparen) ; Ignore if CHAR is in parentheses.
261 (or (and (<= ?a char) (<= char ?z))
262 (and (<= ?A char) (<= char ?Z))
263 (and (<= ?0 char) (<= char ?9))
268 (setq return (concat return (char-to-string char)))))
270 ((and inargvar (or (eq ?\ char) (eq ?\n char))
271 (setq inargvar nil)))
272 ;; Or a method separator?
273 ;; If a method separator, the next token will be an argument variable.
276 return (concat return (char-to-string char))))
277 ;; Or an open parentheses?
279 (setq betweenparen (1+ betweenparen)))
280 ;; Or a close parentheses?
282 (setq betweenparen (1- betweenparen)))))
285 (defun cc-imenu-objc-remove-white-space (str)
286 "Remove all spaces and tabs from STR."
292 (setq char (aref str p))
294 (if (or (= char ?\ ) (= char ?\t))
296 (setq return (concat return (char-to-string char)))))
299 (defun cc-imenu-objc-function ()
300 "imenu supports for objc-mode."
304 ;; OBJC, Cnoreturn, Cgeneralfunc, Cproto are constants.
306 ;; *Warning for developers*
307 ;; These constants depend on `cc-imenu-c++-generic-expression'.
309 (OBJC cc-imenu-objc-generic-expression-objc-base-index)
310 ;; Special case to match a line like `main() {}'
311 (Cnoreturn cc-imenu-objc-generic-expression-noreturn-index)
312 ;; General function name regexp
313 (Cgeneralfunc cc-imenu-objc-generic-expression-general-func-index)
314 ;; Special case for definitions using phony prototype macros like:
315 (Cproto cc-imenu-objc-generic-expression-proto-index)
323 (intflen (length "@interface"))
324 (implen (length "@implementation"))
325 (prtlen (length "@protocol"))
328 ;; Does this emacs has buffer-substring-no-properties?
330 (if (fboundp 'buffer-substring-no-properties)
331 'buffer-substring-no-properties
333 (goto-char (point-max))
334 (imenu-progress-message stupid 0)
336 (while (re-search-backward cc-imenu-objc-generic-expression nil t)
337 (imenu-progress-message stupid)
338 (setq langnum (if (match-beginning OBJC)
341 ((match-beginning Cproto) Cproto)
342 ((match-beginning Cgeneralfunc) Cgeneralfunc)
343 ((match-beginning Cnoreturn) Cnoreturn))))
344 (setq str (funcall func (match-beginning langnum) (match-end langnum)))
350 ((not (eq langnum OBJC))
351 (setq clist (cons (cons str (match-beginning langnum)) clist)))
355 ;; An instance Method
356 ((eq (aref str 0) ?-)
357 (setq str (concat "-" (cc-imenu-objc-method-to-selector str)))
358 (setq methodlist (cons (cons str
359 (match-beginning langnum))
362 ((eq (aref str 0) ?+)
363 (setq str (concat "+" (cc-imenu-objc-method-to-selector str)))
364 (setq methodlist (cons (cons str
365 (match-beginning langnum))
367 ;; Interface or implementation or protocol
368 ((eq (aref str 0) ?@)
369 (setq classcount (1+ classcount))
371 ((and (> (length str) implen)
372 (string= (substring str 0 implen) "@implementation"))
373 (setq str (substring str implen)
374 str2 "@implementation"))
375 ((string= (substring str 0 intflen) "@interface")
376 (setq str (substring str intflen)
378 ((string= (substring str 0 prtlen) "@protocol")
379 (setq str (substring str prtlen)
381 (setq str (cc-imenu-objc-remove-white-space str))
382 (setq methodlist (cons (cons str2
383 (match-beginning langnum))
385 (setq toplist (cons nil (cons (cons str
386 methodlist) toplist))
389 (imenu-progress-message stupid 100)
390 (if (eq (car toplist) nil)
391 (setq toplist (cdr toplist)))
393 ;; In this buffer, there is only one or zero @{interface|implementation|protocol}.
395 (let ((classname (car (car toplist)))
396 (p (cdr (car (cdr (car toplist)))))
398 (setq toplist (cons (cons classname p) (cdr (cdr (car toplist)))))
404 (setq last (cdr last)))
405 (setcdr last clist))))
406 ;; Add C lang tokens as a sub menu
408 (setq toplist (cons (cons "C" clist) toplist))))
413 ;(defvar cc-imenu-pike-generic-expression
415 ; FIXME: Please contribute one!
417 (defun cc-imenu-init (mode-generic-expression
418 &optional mode-create-index-function)
419 (setq imenu-generic-expression mode-generic-expression
420 imenu-case-fold-search nil)
421 (when mode-create-index-function
422 (setq imenu-create-index-function mode-create-index-function)))
425 (cc-provide 'cc-menus)
427 ;;; arch-tag: f6b60933-91f0-4145-ab44-70ca6d1b919b
428 ;;; cc-menus.el ends here