Commit | Line | Data |
---|---|---|
d3d82e7b CY |
1 | ;;; semantic.el --- Semantic buffer evaluator. |
2 | ||
73b0cd50 | 3 | ;; Copyright (C) 1999-2011 Free Software Foundation, Inc. |
d3d82e7b CY |
4 | |
5 | ;; Author: Eric M. Ludlam <zappo@gnu.org> | |
dd9af436 CY |
6 | ;; Keywords: syntax tools |
7 | ;; Version: 2.0 | |
d3d82e7b CY |
8 | |
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software: you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
13 | ;; the Free Software Foundation, either version 3 of the License, or | |
14 | ;; (at your option) any later version. | |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. | |
23 | ||
24 | ;;; Commentary: | |
25 | ;; | |
26 | ;; API for providing the semantic content of a buffer. | |
27 | ;; | |
bd770592 | 28 | ;; The Semantic API provides an interface to a series of different parser |
d3d82e7b CY |
29 | ;; implementations. Each parser outputs a parse tree in a similar format |
30 | ;; designed to handle typical functional and object oriented languages. | |
bd770592 CY |
31 | ;; |
32 | ;; To enable Semantic, turn on `semantic-mode', a global minor mode | |
33 | ;; (M-x semantic-mode RET, or "Source Code Parsers" from the Tools | |
34 | ;; menu). To enable it at startup, put (semantic-mode 1) in your init | |
35 | ;; file. | |
d3d82e7b | 36 | |
715f35a5 | 37 | (require 'cedet) |
9d389824 CY |
38 | (require 'semantic/tag) |
39 | (require 'semantic/lex) | |
d3d82e7b | 40 | |
dd9af436 | 41 | (defvar semantic-version "2.0" |
00999a2e CY |
42 | "Current version of Semantic.") |
43 | ||
d3d82e7b | 44 | (declare-function inversion-test "inversion") |
17e1f4bc | 45 | (declare-function semanticdb-load-ebrowse-caches "semantic/db-ebrowse") |
d3d82e7b CY |
46 | |
47 | (defun semantic-require-version (major minor &optional beta) | |
db9e401b | 48 | "Non-nil if this version of Semantic does not satisfy a specific version. |
d3d82e7b CY |
49 | Arguments can be: |
50 | ||
51 | (MAJOR MINOR &optional BETA) | |
52 | ||
53 | Values MAJOR and MINOR must be integers. BETA can be an integer, or | |
54 | excluded if a released version is required. | |
55 | ||
56 | It is assumed that if the current version is newer than that specified, | |
57 | everything passes. Exceptions occur when known incompatibilities are | |
58 | introduced." | |
59 | (require 'inversion) | |
60 | (inversion-test 'semantic | |
61 | (concat major "." minor | |
62 | (when beta (concat "beta" beta))))) | |
63 | ||
64 | (defgroup semantic nil | |
65 | "Parser Generator and parser framework." | |
ff90f4b0 | 66 | :group 'tools) |
d3d82e7b CY |
67 | |
68 | (defgroup semantic-faces nil | |
69 | "Faces used for Semantic enabled tools." | |
70 | :group 'semantic) | |
71 | ||
9d389824 | 72 | (require 'semantic/fw) |
d3d82e7b CY |
73 | |
74 | ;;; Code: | |
75 | ;; | |
76 | ||
77 | ;;; Variables and Configuration | |
78 | ;; | |
79 | (defvar semantic--parse-table nil | |
80 | "Variable that defines how to parse top level items in a buffer. | |
81 | This variable is for internal use only, and its content depends on the | |
82 | external parser used.") | |
83 | (make-variable-buffer-local 'semantic--parse-table) | |
84 | (semantic-varalias-obsolete 'semantic-toplevel-bovine-table | |
eefa91db | 85 | 'semantic--parse-table "23.2") |
d3d82e7b CY |
86 | |
87 | (defvar semantic-symbol->name-assoc-list | |
88 | '((type . "Types") | |
89 | (variable . "Variables") | |
90 | (function . "Functions") | |
91 | (include . "Dependencies") | |
92 | (package . "Provides")) | |
93 | "Association between symbols returned, and a string. | |
94 | The string is used to represent a group of objects of the given type. | |
95 | It is sometimes useful for a language to use a different string | |
96 | in place of the default, even though that language will still | |
97 | return a symbol. For example, Java return's includes, but the | |
98 | string can be replaced with `Imports'.") | |
99 | (make-variable-buffer-local 'semantic-symbol->name-assoc-list) | |
100 | ||
101 | (defvar semantic-symbol->name-assoc-list-for-type-parts nil | |
102 | "Like `semantic-symbol->name-assoc-list' for type parts. | |
103 | Some tags that have children (see `semantic-tag-children-compatibility') | |
104 | will want to define the names of classes of tags differently than at | |
105 | the top level. For example, in C++, a Function may be called a | |
106 | Method. In addition, there may be new types of tags that exist only | |
107 | in classes, such as protection labels.") | |
108 | (make-variable-buffer-local 'semantic-symbol->name-assoc-list-for-type-parts) | |
109 | ||
110 | (defvar semantic-case-fold nil | |
111 | "Value for `case-fold-search' when parsing.") | |
112 | (make-variable-buffer-local 'semantic-case-fold) | |
113 | ||
114 | (defvar semantic-expand-nonterminal nil | |
115 | "Function to call for each nonterminal production. | |
116 | Return a list of non-terminals derived from the first argument, or nil | |
117 | if it does not need to be expanded. | |
118 | Languages with compound definitions should use this function to expand | |
119 | from one compound symbol into several. For example, in C the definition | |
120 | int a, b; | |
121 | is easily parsed into one tag. This function should take this | |
122 | compound tag and turn it into two tags, one for A, and the other for B.") | |
123 | (make-variable-buffer-local 'semantic-expand-nonterminal) | |
124 | ||
125 | (defvar semantic--buffer-cache nil | |
126 | "A cache of the fully parsed buffer. | |
127 | If no significant changes have been made (based on the state) then | |
128 | this is returned instead of re-parsing the buffer. | |
129 | ||
130 | DO NOT USE THIS VARIABLE IN PROGRAMS. | |
131 | ||
132 | If you need a tag list, use `semantic-fetch-tags'. If you need the | |
db9e401b | 133 | cached values for some reason, chances are you can add a hook to |
d3d82e7b CY |
134 | `semantic-after-toplevel-cache-change-hook'.") |
135 | (make-variable-buffer-local 'semantic--buffer-cache) | |
136 | (semantic-varalias-obsolete 'semantic-toplevel-bovine-cache | |
eefa91db | 137 | 'semantic--buffer-cache "23.2") |
d3d82e7b CY |
138 | |
139 | (defvar semantic-unmatched-syntax-cache nil | |
140 | "A cached copy of unmatched syntax tokens.") | |
141 | (make-variable-buffer-local 'semantic-unmatched-syntax-cache) | |
142 | ||
143 | (defvar semantic-unmatched-syntax-cache-check nil | |
db9e401b | 144 | "Non-nil if the unmatched syntax cache is out of date. |
d3d82e7b CY |
145 | This is tracked with `semantic-change-function'.") |
146 | (make-variable-buffer-local 'semantic-unmatched-syntax-cache-check) | |
147 | ||
148 | (defvar semantic-edits-are-safe nil | |
149 | "When non-nil, modifications do not require a reparse. | |
150 | This prevents tags from being marked dirty, and it prevents top level | |
151 | edits from causing a cache check. | |
152 | Use this when writing programs that could cause a full reparse, but | |
153 | will not change the tag structure, such as adding or updating | |
154 | `top-level' comments.") | |
155 | ||
156 | (defvar semantic-unmatched-syntax-hook nil | |
db9e401b | 157 | "Hooks run when Semantic detects syntax not matched in a grammar. |
d3d82e7b CY |
158 | Each individual piece of syntax (such as a symbol or punctuation |
159 | character) is called with this hook when it doesn't match in the | |
160 | grammar, and multiple unmatched syntax elements are not grouped | |
db9e401b JB |
161 | together. Each hook is called with one argument, which is a list |
162 | of syntax tokens created by the semantic lexer. Use the functions | |
d3d82e7b | 163 | `semantic-lex-token-start', `semantic-lex-token-end' and |
db9e401b JB |
164 | `semantic-lex-token-text' to get information about these tokens. |
165 | The current buffer is the buffer these tokens are derived from.") | |
d3d82e7b CY |
166 | |
167 | (defvar semantic--before-fetch-tags-hook nil | |
db9e401b | 168 | "Hooks run before a buffer is parsed for tags. |
d3d82e7b CY |
169 | It is called before any request for tags is made via the function |
170 | `semantic-fetch-tags' by an application. | |
171 | If any hook returns a nil value, the cached value is returned | |
172 | immediately, even if it is empty.") | |
173 | (semantic-varalias-obsolete 'semantic-before-toplevel-bovination-hook | |
eefa91db | 174 | 'semantic--before-fetch-tags-hook "23.2") |
d3d82e7b CY |
175 | |
176 | (defvar semantic-after-toplevel-bovinate-hook nil | |
177 | "Hooks run after a toplevel parse. | |
178 | It is not run if the toplevel parse command is called, and buffer does | |
179 | not need to be fully reparsed. | |
180 | For language specific hooks, make sure you define this as a local hook. | |
181 | ||
182 | This hook should not be used any more. | |
183 | Use `semantic-after-toplevel-cache-change-hook' instead.") | |
e6e267fc | 184 | (make-obsolete-variable 'semantic-after-toplevel-bovinate-hook nil "23.2") |
d3d82e7b CY |
185 | |
186 | (defvar semantic-after-toplevel-cache-change-hook nil | |
187 | "Hooks run after the buffer tag list has changed. | |
188 | This list will change when a buffer is reparsed, or when the tag list | |
189 | in a buffer is cleared. It is *NOT* called if the current tag list is | |
190 | partially reparsed. | |
191 | ||
192 | Hook functions must take one argument, which is the new list of tags | |
193 | associated with this buffer. | |
194 | ||
195 | For language specific hooks, make sure you define this as a local hook.") | |
196 | ||
197 | (defvar semantic-before-toplevel-cache-flush-hook nil | |
198 | "Hooks run before the toplevel tag cache is flushed. | |
199 | For language specific hooks, make sure you define this as a local | |
200 | hook. This hook is called before a corresponding | |
201 | `semantic-after-toplevel-cache-change-hook' which is also called | |
202 | during a flush when the cache is given a new value of nil.") | |
203 | ||
204 | (defcustom semantic-dump-parse nil | |
205 | "When non-nil, dump parsing information." | |
206 | :group 'semantic | |
207 | :type 'boolean) | |
208 | ||
209 | (defvar semantic-parser-name "LL" | |
210 | "Optional name of the parser used to parse input stream.") | |
211 | (make-variable-buffer-local 'semantic-parser-name) | |
8bf997ef CY |
212 | |
213 | (defvar semantic--completion-cache nil | |
214 | "Internal variable used by `semantic-complete-symbol'.") | |
215 | (make-variable-buffer-local 'semantic--completion-cache) | |
d3d82e7b CY |
216 | \f |
217 | ;;; Parse tree state management API | |
218 | ;; | |
219 | (defvar semantic-parse-tree-state 'needs-rebuild | |
220 | "State of the current parse tree.") | |
221 | (make-variable-buffer-local 'semantic-parse-tree-state) | |
222 | ||
223 | (defmacro semantic-parse-tree-unparseable () | |
224 | "Indicate that the current buffer is unparseable. | |
225 | It is also true that the parse tree will need either updating or | |
226 | a rebuild. This state will be changed when the user edits the buffer." | |
227 | `(setq semantic-parse-tree-state 'unparseable)) | |
228 | ||
229 | (defmacro semantic-parse-tree-unparseable-p () | |
230 | "Return non-nil if the current buffer has been marked unparseable." | |
231 | `(eq semantic-parse-tree-state 'unparseable)) | |
232 | ||
233 | (defmacro semantic-parse-tree-set-needs-update () | |
234 | "Indicate that the current parse tree needs to be updated. | |
235 | The parse tree can be updated by `semantic-parse-changes'." | |
236 | `(setq semantic-parse-tree-state 'needs-update)) | |
237 | ||
238 | (defmacro semantic-parse-tree-needs-update-p () | |
239 | "Return non-nil if the current parse tree needs to be updated." | |
240 | `(eq semantic-parse-tree-state 'needs-update)) | |
241 | ||
242 | (defmacro semantic-parse-tree-set-needs-rebuild () | |
243 | "Indicate that the current parse tree needs to be rebuilt. | |
244 | The parse tree must be rebuilt by `semantic-parse-region'." | |
245 | `(setq semantic-parse-tree-state 'needs-rebuild)) | |
246 | ||
247 | (defmacro semantic-parse-tree-needs-rebuild-p () | |
248 | "Return non-nil if the current parse tree needs to be rebuilt." | |
249 | `(eq semantic-parse-tree-state 'needs-rebuild)) | |
250 | ||
251 | (defmacro semantic-parse-tree-set-up-to-date () | |
252 | "Indicate that the current parse tree is up to date." | |
253 | `(setq semantic-parse-tree-state nil)) | |
254 | ||
255 | (defmacro semantic-parse-tree-up-to-date-p () | |
256 | "Return non-nil if the current parse tree is up to date." | |
257 | `(null semantic-parse-tree-state)) | |
258 | ||
259 | ;;; Interfacing with the system | |
260 | ;; | |
261 | (defcustom semantic-inhibit-functions nil | |
262 | "List of functions to call with no arguments before Semantic is setup. | |
263 | If any of these functions returns non-nil, the current buffer is not | |
264 | setup to use Semantic." | |
265 | :group 'semantic | |
266 | :type 'hook) | |
267 | ||
82481502 | 268 | (defcustom semantic-new-buffer-setup-functions |
52bee098 | 269 | '((c-mode . semantic-default-c-setup) |
82481502 CY |
270 | (c++-mode . semantic-default-c-setup) |
271 | (html-mode . semantic-default-html-setup) | |
52bee098 CY |
272 | (java-mode . wisent-java-default-setup) |
273 | (js-mode . wisent-javascript-setup-parser) | |
274 | (python-mode . wisent-python-default-setup) | |
275 | (scheme-mode . semantic-default-scheme-setup) | |
82481502 CY |
276 | (srecode-template-mode . srecode-template-setup-parser) |
277 | (makefile-automake-mode . semantic-default-make-setup) | |
278 | (makefile-gmake-mode . semantic-default-make-setup) | |
279 | (makefile-makepp-mode . semantic-default-make-setup) | |
280 | (makefile-bsdmake-mode . semantic-default-make-setup) | |
281 | (makefile-imake-mode . semantic-default-make-setup) | |
282 | (makefile-mode . semantic-default-make-setup)) | |
283 | "Alist of functions to call to set up Semantic parsing in the buffer. | |
284 | Each element has the form (MODE . FN), where MODE is a value of | |
285 | `major-mode' for the buffer and FN is the corresponding function | |
286 | to call, with no arguments, to set up the parser. | |
287 | ||
288 | These functions are called by `semantic-new-buffer-fcn', before | |
289 | `semantic-inhibit-functions'." | |
290 | :group 'semantic | |
291 | :type '(alist :key-type symbol :value-type function)) | |
292 | ||
b82525f2 CY |
293 | (defvar semantic-init-hook nil |
294 | "Hook run when a buffer is initialized with a parsing table.") | |
d3d82e7b | 295 | |
b82525f2 CY |
296 | (defvar semantic-init-mode-hook nil |
297 | "Hook run when a buffer of a particular mode is initialized.") | |
298 | (make-variable-buffer-local 'semantic-init-mode-hook) | |
d3d82e7b | 299 | |
b82525f2 CY |
300 | (defvar semantic-init-db-hook nil |
301 | "Hook run when a buffer is initialized with a parsing table for DBs. | |
d3d82e7b CY |
302 | This hook is for database functions which intend to swap in a tag table. |
303 | This guarantees that the DB will go before other modes that require | |
304 | a parse of the buffer.") | |
305 | ||
1ac9ebc8 | 306 | (semantic-varalias-obsolete 'semantic-init-hooks |
eefa91db | 307 | 'semantic-init-hook "23.2") |
1ac9ebc8 | 308 | (semantic-varalias-obsolete 'semantic-init-mode-hooks |
eefa91db | 309 | 'semantic-init-mode-hook "23.2") |
1ac9ebc8 | 310 | (semantic-varalias-obsolete 'semantic-init-db-hooks |
eefa91db | 311 | 'semantic-init-db-hook "23.2") |
b82525f2 | 312 | |
d3d82e7b | 313 | (defvar semantic-new-buffer-fcn-was-run nil |
db9e401b | 314 | "Non-nil after `semantic-new-buffer-fcn' has been executed.") |
d3d82e7b CY |
315 | (make-variable-buffer-local 'semantic-new-buffer-fcn-was-run) |
316 | ||
317 | (defsubst semantic-active-p () | |
318 | "Return non-nil if the current buffer was set up for parsing." | |
319 | semantic-new-buffer-fcn-was-run) | |
320 | ||
321 | (defsubst semantic--umatched-syntax-needs-refresh-p () | |
322 | "Return non-nil if the unmatched syntax cache needs a refresh. | |
db9e401b | 323 | That is, if it is dirty or if the current parse tree isn't up to date." |
d3d82e7b CY |
324 | (or semantic-unmatched-syntax-cache-check |
325 | (not (semantic-parse-tree-up-to-date-p)))) | |
326 | ||
327 | (defun semantic-new-buffer-fcn () | |
328 | "Setup the current buffer to use Semantic. | |
329 | If the major mode is ready for Semantic, and no | |
330 | `semantic-inhibit-functions' disabled it, the current buffer is setup | |
331 | to use Semantic, and `semantic-init-hook' is run." | |
82481502 CY |
332 | ;; In upstream Semantic, the parser setup functions are called from |
333 | ;; mode hooks. In the version bundled with Emacs, we do it here. | |
334 | (let ((entry (assq major-mode semantic-new-buffer-setup-functions))) | |
335 | (when entry | |
336 | (funcall (cdr entry)))) | |
d3d82e7b CY |
337 | ;; Do stuff if semantic was activated by a mode hook in this buffer, |
338 | ;; and not afterwards disabled. | |
339 | (when (and semantic--parse-table | |
340 | (not (semantic-active-p)) | |
341 | (not (run-hook-with-args-until-success | |
342 | 'semantic-inhibit-functions))) | |
343 | ;; Make sure that if this buffer is cloned, our tags and overlays | |
344 | ;; don't go along for the ride. | |
345 | (add-hook 'clone-indirect-buffer-hook 'semantic-clear-toplevel-cache | |
346 | nil t) | |
347 | ;; Specify that this function has done it's work. At this point | |
348 | ;; we can consider that semantic is active in this buffer. | |
349 | (setq semantic-new-buffer-fcn-was-run t) | |
350 | ;; Here are some buffer local variables we can initialize ourselves | |
351 | ;; of a mode does not choose to do so. | |
352 | (semantic-lex-init) | |
353 | ;; Force this buffer to have its cache refreshed. | |
354 | (semantic-clear-toplevel-cache) | |
355 | ;; Call DB hooks before regular init hooks | |
b82525f2 | 356 | (run-hooks 'semantic-init-db-hook) |
d3d82e7b | 357 | ;; Set up semantic modes |
b82525f2 | 358 | (run-hooks 'semantic-init-hook) |
d3d82e7b | 359 | ;; Set up major-mode specific semantic modes |
b82525f2 | 360 | (run-hooks 'semantic-init-mode-hook))) |
d3d82e7b CY |
361 | |
362 | (defun semantic-fetch-tags-fast () | |
363 | "For use in a hook. When only a partial reparse is needed, reparse." | |
364 | (condition-case nil | |
365 | (if (semantic-parse-tree-needs-update-p) | |
366 | (semantic-fetch-tags)) | |
367 | (error nil)) | |
368 | semantic--buffer-cache) | |
d3d82e7b CY |
369 | \f |
370 | ;;; Parsing Commands | |
371 | ;; | |
372 | (eval-when-compile | |
373 | (condition-case nil (require 'pp) (error nil))) | |
374 | ||
375 | (defvar semantic-edebug nil | |
376 | "When non-nil, activate the interactive parsing debugger. | |
377 | Do not set this yourself. Call `semantic-debug'.") | |
378 | ||
379 | (defun semantic-elapsed-time (start end) | |
db9e401b | 380 | "Copied from elp.el. Was `elp-elapsed-time'. |
d3d82e7b CY |
381 | Argument START and END bound the time being calculated." |
382 | (+ (* (- (car end) (car start)) 65536.0) | |
383 | (- (car (cdr end)) (car (cdr start))) | |
384 | (/ (- (car (cdr (cdr end))) (car (cdr (cdr start)))) 1000000.0))) | |
385 | ||
386 | (defun bovinate (&optional clear) | |
387 | "Parse the current buffer. Show output in a temp buffer. | |
388 | Optional argument CLEAR will clear the cache before parsing. | |
389 | If CLEAR is negative, it will do a full reparse, and also not display | |
390 | the output buffer." | |
391 | (interactive "P") | |
392 | (if clear (semantic-clear-toplevel-cache)) | |
393 | (if (eq clear '-) (setq clear -1)) | |
394 | (let* ((start (current-time)) | |
395 | (out (semantic-fetch-tags)) | |
396 | (end (current-time))) | |
397 | (message "Retrieving tags took %.2f seconds." | |
398 | (semantic-elapsed-time start end)) | |
399 | (when (or (null clear) (not (listp clear))) | |
400 | (pop-to-buffer "*Parser Output*") | |
401 | (require 'pp) | |
402 | (erase-buffer) | |
403 | (insert (pp-to-string out)) | |
404 | (goto-char (point-min))))) | |
405 | \f | |
406 | ;;; Functions of the parser plug-in API | |
407 | ;; | |
408 | ;; Overload these functions to create new types of parsers. | |
409 | ;; | |
410 | (define-overloadable-function semantic-parse-stream (stream nonterminal) | |
411 | "Parse STREAM, starting at the first NONTERMINAL rule. | |
412 | For bovine and wisent based parsers, STREAM is from the output of | |
db9e401b | 413 | `semantic-lex', and NONTERMINAL is a rule in the appropriate language |
d3d82e7b CY |
414 | specific rules file. |
415 | The default parser table used for bovine or wisent based parsers is | |
416 | `semantic--parse-table'. | |
417 | ||
418 | Must return a list: (STREAM TAGS) where STREAM is the unused elements | |
db9e401b JB |
419 | from STREAM, and TAGS is the list of semantic tags found; usually only |
420 | one tag is returned with the exception of compound statements.") | |
d3d82e7b CY |
421 | |
422 | (define-overloadable-function semantic-parse-changes () | |
423 | "Reparse changes in the current buffer. | |
424 | The list of changes are tracked as a series of overlays in the buffer. | |
425 | When overloading this function, use `semantic-changes-in-region' to | |
426 | analyze.") | |
427 | ||
428 | (define-overloadable-function semantic-parse-region | |
429 | (start end &optional nonterminal depth returnonerror) | |
430 | "Parse the area between START and END, and return any tags found. | |
431 | If END needs to be extended due to a lexical token being too large, it | |
432 | will be silently ignored. | |
433 | ||
434 | Optional arguments: | |
435 | NONTERMINAL is the rule to start parsing at. | |
db9e401b | 436 | DEPTH specifies the lexical depth to descend for parser that use |
d3d82e7b CY |
437 | lexical analysis as their first step. |
438 | RETURNONERROR specifies that parsing should stop on the first | |
439 | unmatched syntax encountered. When nil, parsing skips the syntax, | |
440 | adding it to the unmatched syntax cache. | |
441 | ||
442 | Must return a list of semantic tags wich have been cooked | |
443 | \(repositioned properly) but which DO NOT HAVE OVERLAYS associated | |
444 | with them. When overloading this function, use `semantic--tag-expand' | |
445 | to cook raw tags.") | |
446 | ||
447 | (defun semantic-parse-region-default | |
448 | (start end &optional nonterminal depth returnonerror) | |
449 | "Parse the area between START and END, and return any tags found. | |
db9e401b JB |
450 | If END needs to be extended due to a lexical token being too large, |
451 | it will be silently ignored. | |
d3d82e7b CY |
452 | Optional arguments: |
453 | NONTERMINAL is the rule to start parsing at if it is known. | |
454 | DEPTH specifies the lexical depth to scan. | |
455 | RETURNONERROR specifies that parsing should end when encountering | |
456 | unterminated syntax." | |
457 | (when (or (null semantic--parse-table) (eq semantic--parse-table t)) | |
458 | ;; If there is no table, or it was set to t, then we are here by | |
459 | ;; some other mistake. Do not throw an error deep in the parser. | |
460 | (error "No support found to parse buffer %S" (buffer-name))) | |
461 | (save-restriction | |
462 | (widen) | |
463 | (when (or (< end start) (> end (point-max))) | |
464 | (error "Invalid parse region bounds %S, %S" start end)) | |
465 | (nreverse | |
466 | (semantic-repeat-parse-whole-stream | |
467 | (or (cdr (assq start semantic-lex-block-streams)) | |
468 | (semantic-lex start end depth)) | |
469 | nonterminal returnonerror)))) | |
470 | \f | |
471 | ;;; Parsing functions | |
472 | ;; | |
473 | (defun semantic-set-unmatched-syntax-cache (unmatched-syntax) | |
474 | "Set the unmatched syntax cache. | |
475 | Argument UNMATCHED-SYNTAX is the syntax to set into the cache." | |
476 | ;; This function is not actually called by the main parse loop. | |
477 | ;; This is intended for use by semanticdb. | |
478 | (setq semantic-unmatched-syntax-cache unmatched-syntax | |
479 | semantic-unmatched-syntax-cache-check nil) | |
480 | ;; Refresh the display of unmatched syntax tokens if enabled | |
481 | (run-hook-with-args 'semantic-unmatched-syntax-hook | |
482 | semantic-unmatched-syntax-cache)) | |
483 | ||
484 | (defun semantic-clear-unmatched-syntax-cache () | |
485 | "Clear the cache of unmatched syntax tokens." | |
486 | (setq semantic-unmatched-syntax-cache nil | |
487 | semantic-unmatched-syntax-cache-check t)) | |
488 | ||
489 | (defun semantic-unmatched-syntax-tokens () | |
490 | "Return the list of unmatched syntax tokens." | |
491 | ;; If the cache need refresh then do a full re-parse. | |
492 | (if (semantic--umatched-syntax-needs-refresh-p) | |
493 | ;; To avoid a recursive call, temporarily disable | |
494 | ;; `semantic-unmatched-syntax-hook'. | |
495 | (let (semantic-unmatched-syntax-hook) | |
496 | (condition-case nil | |
497 | (progn | |
498 | (semantic-clear-toplevel-cache) | |
499 | (semantic-fetch-tags)) | |
500 | (quit | |
501 | (message "semantic-unmatched-syntax-tokens:\ | |
502 | parsing of buffer canceled")) | |
503 | ))) | |
504 | semantic-unmatched-syntax-cache) | |
505 | ||
506 | (defun semantic-clear-toplevel-cache () | |
507 | "Clear the toplevel tag cache for the current buffer. | |
508 | Clearing the cache will force a complete reparse next time a tag list | |
509 | is requested." | |
510 | (interactive) | |
511 | (run-hooks 'semantic-before-toplevel-cache-flush-hook) | |
512 | (setq semantic--buffer-cache nil) | |
513 | (semantic-clear-unmatched-syntax-cache) | |
514 | (semantic-clear-parser-warnings) | |
515 | ;; Nuke all semantic overlays. This is faster than deleting based | |
516 | ;; on our data structure. | |
517 | (let ((l (semantic-overlay-lists))) | |
518 | (mapc 'semantic-delete-overlay-maybe (car l)) | |
519 | (mapc 'semantic-delete-overlay-maybe (cdr l)) | |
520 | ) | |
521 | (semantic-parse-tree-set-needs-rebuild) | |
522 | ;; Remove this hook which tracks if a buffer is up to date or not. | |
523 | (remove-hook 'after-change-functions 'semantic-change-function t) | |
524 | ;; Old model. Delete someday. | |
525 | ;;(run-hooks 'semantic-after-toplevel-bovinate-hook) | |
526 | ||
527 | (run-hook-with-args 'semantic-after-toplevel-cache-change-hook | |
528 | semantic--buffer-cache) | |
8bf997ef CY |
529 | |
530 | (setq semantic--completion-cache nil)) | |
d3d82e7b CY |
531 | |
532 | (defvar semantic-bovinate-nonterminal-check-obarray) | |
533 | ||
534 | (defun semantic--set-buffer-cache (tagtable) | |
db9e401b | 535 | "Set the toplevel tag cache to TAGTABLE." |
d3d82e7b | 536 | (setq semantic--buffer-cache tagtable |
06511291 CY |
537 | semantic-unmatched-syntax-cache-check nil) |
538 | ;; This is specific to the bovine parser. | |
539 | (set (make-local-variable 'semantic-bovinate-nonterminal-check-obarray) | |
540 | nil) | |
d3d82e7b CY |
541 | (semantic-parse-tree-set-up-to-date) |
542 | (semantic-make-local-hook 'after-change-functions) | |
543 | (add-hook 'after-change-functions 'semantic-change-function nil t) | |
544 | (run-hook-with-args 'semantic-after-toplevel-cache-change-hook | |
545 | semantic--buffer-cache) | |
8bf997ef | 546 | (setq semantic--completion-cache nil) |
d3d82e7b CY |
547 | ;; Refresh the display of unmatched syntax tokens if enabled |
548 | (run-hook-with-args 'semantic-unmatched-syntax-hook | |
549 | semantic-unmatched-syntax-cache) | |
550 | ;; Old Semantic 1.3 hook API. Maybe useful forever? | |
551 | (run-hooks 'semantic-after-toplevel-bovinate-hook) | |
552 | ) | |
553 | ||
554 | (defvar semantic-working-type 'percent | |
555 | "*The type of working message to use when parsing. | |
556 | 'percent means we are doing a linear parse through the buffer. | |
557 | 'dynamic means we are reparsing specific tags.") | |
558 | (semantic-varalias-obsolete 'semantic-bovination-working-type | |
eefa91db | 559 | 'semantic-working-type "23.2") |
d3d82e7b CY |
560 | |
561 | (defvar semantic-minimum-working-buffer-size (* 1024 5) | |
562 | "*The minimum size of a buffer before working messages are displayed. | |
db9e401b | 563 | Buffers smaller than this will parse silently. |
bd2afec2 | 564 | Buffers larger than this will display the working progress bar.") |
d3d82e7b CY |
565 | |
566 | (defsubst semantic-parser-working-message (&optional arg) | |
567 | "Return the message string displayed while parsing. | |
568 | If optional argument ARG is non-nil it is appended to the message | |
569 | string." | |
17e1f4bc CY |
570 | (concat "Parsing" |
571 | (if arg (format " %s" arg)) | |
572 | (if semantic-parser-name (format " (%s)" semantic-parser-name)) | |
573 | "...")) | |
d3d82e7b CY |
574 | \f |
575 | ;;; Application Parser Entry Points | |
576 | ;; | |
577 | ;; The best way to call the parser from programs is via | |
578 | ;; `semantic-fetch-tags'. This, in turn, uses other internal | |
579 | ;; API functions which plug-in parsers can take advantage of. | |
580 | ||
581 | (defun semantic-fetch-tags () | |
582 | "Fetch semantic tags from the current buffer. | |
583 | If the buffer cache is up to date, return that. | |
584 | If the buffer cache is out of date, attempt an incremental reparse. | |
585 | If the buffer has not been parsed before, or if the incremental reparse | |
586 | fails, then parse the entire buffer. | |
bd2afec2 | 587 | If a lexical error had been previously discovered and the buffer |
d3d82e7b CY |
588 | was marked unparseable, then do nothing, and return the cache." |
589 | (and | |
590 | ;; Is this a semantic enabled buffer? | |
591 | (semantic-active-p) | |
592 | ;; Application hooks say the buffer is safe for parsing | |
593 | (run-hook-with-args-until-failure | |
594 | 'semantic-before-toplevel-bovination-hook) | |
595 | (run-hook-with-args-until-failure | |
596 | 'semantic--before-fetch-tags-hook) | |
597 | ;; If the buffer was previously marked unparseable, | |
598 | ;; then don't waste our time. | |
599 | (not (semantic-parse-tree-unparseable-p)) | |
600 | ;; The parse tree actually needs to be refreshed | |
601 | (not (semantic-parse-tree-up-to-date-p)) | |
602 | ;; So do it! | |
603 | (let* ((gc-cons-threshold (max gc-cons-threshold 10000000)) | |
604 | (semantic-lex-block-streams nil) | |
605 | (res nil)) | |
606 | (garbage-collect) | |
607 | (cond | |
608 | ||
609 | ;;;; Try the incremental parser to do a fast update. | |
610 | ((semantic-parse-tree-needs-update-p) | |
611 | (setq res (semantic-parse-changes)) | |
612 | (if (semantic-parse-tree-needs-rebuild-p) | |
613 | ;; If the partial reparse fails, jump to a full reparse. | |
614 | (semantic-fetch-tags) | |
615 | ;; Clear the cache of unmatched syntax tokens | |
616 | ;; | |
617 | ;; NOTE TO SELF: | |
618 | ;; | |
619 | ;; Move this into the incremental parser. This is a bug. | |
620 | ;; | |
621 | (semantic-clear-unmatched-syntax-cache) | |
622 | (run-hook-with-args ;; Let hooks know the updated tags | |
623 | 'semantic-after-partial-cache-change-hook res)) | |
8bf997ef | 624 | (setq semantic--completion-cache nil)) |
d3d82e7b CY |
625 | |
626 | ;;;; Parse the whole system. | |
627 | ((semantic-parse-tree-needs-rebuild-p) | |
d3d82e7b CY |
628 | ;; Use Emacs' built-in progress-reporter |
629 | (let ((semantic--progress-reporter | |
630 | (and (>= (point-max) semantic-minimum-working-buffer-size) | |
631 | (eq semantic-working-type 'percent) | |
632 | (make-progress-reporter | |
633 | (semantic-parser-working-message (buffer-name)) | |
634 | 0 100)))) | |
635 | (setq res (semantic-parse-region (point-min) (point-max))) | |
59aec83e CY |
636 | (if semantic--progress-reporter |
637 | (progress-reporter-done semantic--progress-reporter))) | |
d3d82e7b CY |
638 | |
639 | ;; Clear the caches when we see there were no errors. | |
640 | ;; But preserve the unmatched syntax cache and warnings! | |
641 | (let (semantic-unmatched-syntax-cache | |
642 | semantic-unmatched-syntax-cache-check | |
643 | semantic-parser-warnings) | |
644 | (semantic-clear-toplevel-cache)) | |
645 | ;; Set up the new overlays | |
646 | (semantic--tag-link-list-to-buffer res) | |
647 | ;; Set up the cache with the new results | |
648 | (semantic--set-buffer-cache res) | |
649 | )))) | |
650 | ||
651 | ;; Always return the current parse tree. | |
652 | semantic--buffer-cache) | |
653 | ||
654 | (defun semantic-refresh-tags-safe () | |
db9e401b | 655 | "Refresh the current buffer's tags safely. |
d3d82e7b CY |
656 | |
657 | Return non-nil if the refresh was successful. | |
658 | Return nil if there is some sort of syntax error preventing a reparse. | |
659 | ||
660 | Does nothing if the current buffer doesn't need reparsing." | |
661 | ||
662 | ;; These checks actually occur in `semantic-fetch-tags', but if we | |
663 | ;; do them here, then all the bovination hooks are not run, and | |
664 | ;; we save lots of time. | |
665 | (cond | |
666 | ;; If the buffer was previously marked unparseable, | |
667 | ;; then don't waste our time. | |
668 | ((semantic-parse-tree-unparseable-p) | |
669 | nil) | |
670 | ;; The parse tree is already ok. | |
671 | ((semantic-parse-tree-up-to-date-p) | |
672 | t) | |
673 | (t | |
674 | (let* ((inhibit-quit nil) | |
675 | (lexically-safe t) | |
676 | ) | |
677 | ||
678 | (unwind-protect | |
679 | ;; Perform the parsing. | |
680 | (progn | |
681 | (when (semantic-lex-catch-errors safe-refresh | |
682 | (save-excursion (semantic-fetch-tags)) | |
683 | nil) | |
684 | ;; If we are here, it is because the lexical step failed, | |
685 | ;; proably due to unterminated lists or something like that. | |
686 | ||
687 | ;; We do nothing, and just wait for the next idle timer | |
688 | ;; to go off. In the meantime, remember this, and make sure | |
689 | ;; no other idle services can get executed. | |
690 | (setq lexically-safe nil)) | |
691 | ) | |
692 | ) | |
693 | ;; Return if we are lexically safe | |
694 | lexically-safe)))) | |
695 | ||
696 | (defun semantic-bovinate-toplevel (&optional ignored) | |
db9e401b | 697 | "Backward compatibility function." |
d3d82e7b | 698 | (semantic-fetch-tags)) |
e6e267fc | 699 | (make-obsolete 'semantic-bovinate-toplevel 'semantic-fetch-tags "23.2") |
d3d82e7b CY |
700 | |
701 | ;; Another approach is to let Emacs call the parser on idle time, when | |
702 | ;; needed, use `semantic-fetch-available-tags' to only retrieve | |
703 | ;; available tags, and setup the `semantic-after-*-hook' hooks to | |
704 | ;; synchronize with new tags when they become available. | |
705 | ||
706 | (defsubst semantic-fetch-available-tags () | |
707 | "Fetch available semantic tags from the current buffer. | |
708 | That is, return tags currently in the cache without parsing the | |
709 | current buffer. | |
710 | Parse operations happen asynchronously when needed on Emacs idle time. | |
711 | Use the `semantic-after-toplevel-cache-change-hook' and | |
712 | `semantic-after-partial-cache-change-hook' hooks to synchronize with | |
713 | new tags when they become available." | |
714 | semantic--buffer-cache) | |
715 | \f | |
716 | ;;; Iterative parser helper function | |
717 | ;; | |
718 | ;; Iterative parsers are better than rule-based iterative functions | |
719 | ;; in that they can handle obscure errors more cleanly. | |
720 | ;; | |
721 | ;; `semantic-repeat-parse-whole-stream' abstracts this action for | |
722 | ;; other parser centric routines. | |
723 | ;; | |
724 | (defun semantic-repeat-parse-whole-stream | |
725 | (stream nonterm &optional returnonerror) | |
726 | "Iteratively parse the entire stream STREAM starting with NONTERM. | |
727 | Optional argument RETURNONERROR indicates that the parser should exit | |
728 | with the current results on a parse error. | |
729 | This function returns semantic tags without overlays." | |
730 | (let ((result nil) | |
731 | (case-fold-search semantic-case-fold) | |
732 | nontermsym tag) | |
733 | (while stream | |
734 | (setq nontermsym (semantic-parse-stream stream nonterm) | |
735 | tag (car (cdr nontermsym))) | |
736 | (if (not nontermsym) | |
737 | (error "Parse error @ %d" (car (cdr (car stream))))) | |
738 | (if (eq (car nontermsym) stream) | |
739 | (error "Parser error: Infinite loop?")) | |
740 | (if tag | |
741 | (if (car tag) | |
742 | (setq tag (mapcar | |
743 | #'(lambda (tag) | |
744 | ;; Set the 'reparse-symbol property to | |
745 | ;; NONTERM unless it was already setup | |
746 | ;; by a tag expander | |
747 | (or (semantic--tag-get-property | |
748 | tag 'reparse-symbol) | |
749 | (semantic--tag-put-property | |
750 | tag 'reparse-symbol nonterm)) | |
751 | tag) | |
752 | (semantic--tag-expand tag)) | |
753 | result (append tag result)) | |
754 | ;; No error in this case, a purposeful nil means don't | |
755 | ;; store anything. | |
756 | ) | |
757 | (if returnonerror | |
758 | (setq stream nil) | |
759 | ;; The current item in the stream didn't match, so add it to | |
760 | ;; the list of syntax items which didn't match. | |
761 | (setq semantic-unmatched-syntax-cache | |
762 | (cons (car stream) semantic-unmatched-syntax-cache)) | |
763 | )) | |
764 | ;; Designated to ignore. | |
765 | (setq stream (car nontermsym)) | |
766 | (if stream | |
d3d82e7b CY |
767 | ;; Use Emacs' built-in progress reporter: |
768 | (and (boundp 'semantic--progress-reporter) | |
769 | semantic--progress-reporter | |
aa8724ae | 770 | (eq semantic-working-type 'percent) |
d3d82e7b CY |
771 | (progress-reporter-update |
772 | semantic--progress-reporter | |
773 | (/ (* 100 (semantic-lex-token-start (car stream))) | |
774 | (point-max)))))) | |
775 | result)) | |
776 | \f | |
777 | ;;; Parsing Warnings: | |
778 | ;; | |
779 | ;; Parsing a buffer may result in non-critical things that we should | |
780 | ;; alert the user to without interrupting the normal flow. | |
781 | ;; | |
782 | ;; Any parser can use this API to provide a list of warnings during a | |
783 | ;; parse which a user may want to investigate. | |
784 | (defvar semantic-parser-warnings nil | |
785 | "A list of parser warnings since the last full reparse.") | |
786 | (make-variable-buffer-local 'semantic-parser-warnings) | |
787 | ||
788 | (defun semantic-clear-parser-warnings () | |
789 | "Clear the current list of parser warnings for this buffer." | |
790 | (setq semantic-parser-warnings nil)) | |
791 | ||
792 | (defun semantic-push-parser-warning (warning start end) | |
793 | "Add a parser WARNING that covers text from START to END." | |
794 | (setq semantic-parser-warnings | |
795 | (cons (cons warning (cons start end)) | |
796 | semantic-parser-warnings))) | |
797 | ||
798 | (defun semantic-dump-parser-warnings () | |
799 | "Dump any parser warnings." | |
800 | (interactive) | |
801 | (if semantic-parser-warnings | |
802 | (let ((pw semantic-parser-warnings)) | |
803 | (pop-to-buffer "*Parser Warnings*") | |
804 | (require 'pp) | |
805 | (erase-buffer) | |
806 | (insert (pp-to-string pw)) | |
807 | (goto-char (point-min))) | |
808 | (message "No parser warnings."))) | |
809 | ||
810 | ||
811 | \f | |
812 | ;;; Compatibility: | |
813 | ;; | |
814 | ;; Semantic 1.x parser action helper functions, used by some parsers. | |
815 | ;; Please move away from these functions, and try using semantic 2.x | |
816 | ;; interfaces instead. | |
817 | ;; | |
818 | (defsubst semantic-bovinate-region-until-error | |
819 | (start end nonterm &optional depth) | |
820 | "NOTE: Use `semantic-parse-region' instead. | |
821 | ||
822 | Bovinate between START and END starting with NONTERM. | |
823 | Optional DEPTH specifies how many levels of parenthesis to enter. | |
824 | This command will parse until an error is encountered, and return | |
825 | the list of everything found until that moment. | |
826 | This is meant for finding variable definitions at the beginning of | |
827 | code blocks in methods. If `bovine-inner-scope' can also support | |
828 | commands, use `semantic-bovinate-from-nonterminal-full'." | |
829 | (semantic-parse-region start end nonterm depth t)) | |
830 | (make-obsolete 'semantic-bovinate-region-until-error | |
e6e267fc | 831 | 'semantic-parse-region "23.2") |
d3d82e7b CY |
832 | |
833 | (defsubst semantic-bovinate-from-nonterminal | |
834 | (start end nonterm &optional depth length) | |
835 | "Bovinate from within a nonterminal lambda from START to END. | |
836 | Argument NONTERM is the nonterminal symbol to start with. | |
837 | Optional argument DEPTH is the depth of lists to dive into. When used | |
838 | in a `lambda' of a MATCH-LIST, there is no need to include a START and | |
839 | END part. | |
840 | Optional argument LENGTH specifies we are only interested in LENGTH | |
841 | tokens." | |
842 | (car-safe (cdr (semantic-parse-stream | |
843 | (semantic-lex start end (or depth 1) length) | |
844 | nonterm)))) | |
845 | ||
846 | (defsubst semantic-bovinate-from-nonterminal-full | |
847 | (start end nonterm &optional depth) | |
848 | "NOTE: Use `semantic-parse-region' instead. | |
849 | ||
850 | Bovinate from within a nonterminal lambda from START to END. | |
851 | Iterates until all the space between START and END is exhausted. | |
852 | Argument NONTERM is the nonterminal symbol to start with. | |
853 | If NONTERM is nil, use `bovine-block-toplevel'. | |
854 | Optional argument DEPTH is the depth of lists to dive into. | |
855 | When used in a `lambda' of a MATCH-LIST, there is no need to include | |
856 | a START and END part." | |
857 | (semantic-parse-region start end nonterm (or depth 1))) | |
858 | (make-obsolete 'semantic-bovinate-from-nonterminal-full | |
e6e267fc | 859 | 'semantic-parse-region "23.2") |
d3d82e7b | 860 | |
b82525f2 CY |
861 | ;;; User interface |
862 | ||
8bf997ef CY |
863 | (defun semantic-force-refresh () |
864 | "Force a full refresh of the current buffer's tags. | |
865 | Throw away all the old tags, and recreate the tag database." | |
866 | (interactive) | |
867 | (semantic-clear-toplevel-cache) | |
715f35a5 CY |
868 | (semantic-fetch-tags) |
869 | (message "Buffer reparsed.")) | |
8bf997ef CY |
870 | |
871 | (defvar semantic-mode-map | |
715f35a5 | 872 | (let ((map (make-sparse-keymap))) |
8bf997ef | 873 | ;; Key bindings: |
8bf997ef CY |
874 | ;; (define-key km "f" 'senator-search-set-tag-class-filter) |
875 | ;; (define-key km "i" 'senator-isearch-toggle-semantic-mode) | |
876 | (define-key map "\C-c,j" 'semantic-complete-jump-local) | |
877 | (define-key map "\C-c,J" 'semantic-complete-jump) | |
dd9af436 | 878 | (define-key map "\C-c,m" 'semantic-complete-jump-local-members) |
8bf997ef CY |
879 | (define-key map "\C-c,g" 'semantic-symref-symbol) |
880 | (define-key map "\C-c,G" 'semantic-symref) | |
881 | (define-key map "\C-c,p" 'senator-previous-tag) | |
882 | (define-key map "\C-c,n" 'senator-next-tag) | |
883 | (define-key map "\C-c,u" 'senator-go-to-up-reference) | |
884 | (define-key map "\C-c, " 'semantic-complete-analyze-inline) | |
885 | (define-key map "\C-c,\C-w" 'senator-kill-tag) | |
886 | (define-key map "\C-c,\M-w" 'senator-copy-tag) | |
887 | (define-key map "\C-c,\C-y" 'senator-yank-tag) | |
888 | (define-key map "\C-c,r" 'senator-copy-tag-to-register) | |
dd9af436 | 889 | (define-key map "\C-c,," 'semantic-force-refresh) |
8bf997ef CY |
890 | (define-key map [?\C-c ?, up] 'senator-transpose-tags-up) |
891 | (define-key map [?\C-c ?, down] 'senator-transpose-tags-down) | |
892 | (define-key map "\C-c,l" 'semantic-analyze-possible-completions) | |
715f35a5 CY |
893 | ;; This hack avoids showing the CEDET menu twice if ede-minor-mode |
894 | ;; and Semantic are both enabled. Is there a better way? | |
895 | (define-key map [menu-bar cedet-menu] | |
896 | (list 'menu-item "Development" cedet-menu-map | |
897 | :enable (quote (not (bound-and-true-p global-ede-mode))))) | |
8bf997ef CY |
898 | ;; (define-key km "-" 'senator-fold-tag) |
899 | ;; (define-key km "+" 'senator-unfold-tag) | |
900 | map)) | |
901 | ||
715f35a5 CY |
902 | ;; Activate the Semantic items in cedet-menu-map |
903 | (let ((navigate-menu (make-sparse-keymap "Navigate Tags")) | |
904 | (edit-menu (make-sparse-keymap "Edit Tags"))) | |
905 | ||
906 | ;; Edit Tags submenu: | |
907 | (define-key edit-menu [semantic-analyze-possible-completions] | |
908 | '(menu-item "List Completions" semantic-analyze-possible-completions | |
909 | :help "Display a list of completions for the tag at point")) | |
910 | (define-key edit-menu [semantic-complete-analyze-inline] | |
911 | '(menu-item "Complete Tag Inline" semantic-complete-analyze-inline | |
912 | :help "Display inline completion for the tag at point")) | |
913 | (define-key edit-menu [semantic-completion-separator] | |
914 | '("--")) | |
915 | (define-key edit-menu [senator-transpose-tags-down] | |
916 | '(menu-item "Transpose Tags Down" senator-transpose-tags-down | |
917 | :active (semantic-current-tag) | |
918 | :help "Transpose the current tag and the next tag")) | |
919 | (define-key edit-menu [senator-transpose-tags-up] | |
920 | '(menu-item "Transpose Tags Up" senator-transpose-tags-up | |
921 | :active (semantic-current-tag) | |
922 | :help "Transpose the current tag and the previous tag")) | |
923 | (define-key edit-menu [semantic-edit-separator] | |
924 | '("--")) | |
925 | (define-key edit-menu [senator-yank-tag] | |
926 | '(menu-item "Yank Tag" senator-yank-tag | |
927 | :active (not (ring-empty-p senator-tag-ring)) | |
928 | :help "Yank the head of the tag ring into the buffer")) | |
929 | (define-key edit-menu [senator-copy-tag-to-register] | |
930 | '(menu-item "Copy Tag To Register" senator-copy-tag-to-register | |
931 | :active (semantic-current-tag) | |
932 | :help "Yank the head of the tag ring into the buffer")) | |
933 | (define-key edit-menu [senator-copy-tag] | |
934 | '(menu-item "Copy Tag" senator-copy-tag | |
935 | :active (semantic-current-tag) | |
936 | :help "Copy the current tag to the tag ring")) | |
937 | (define-key edit-menu [senator-kill-tag] | |
938 | '(menu-item "Kill Tag" senator-kill-tag | |
939 | :active (semantic-current-tag) | |
940 | :help "Kill the current tag, and copy it to the tag ring")) | |
941 | ||
942 | ;; Navigate Tags submenu: | |
943 | (define-key navigate-menu [senator-narrow-to-defun] | |
944 | '(menu-item "Narrow to Tag" senator-narrow-to-defun | |
945 | :active (semantic-current-tag) | |
946 | :help "Narrow the buffer to the bounds of the current tag")) | |
947 | (define-key navigate-menu [semantic-narrow-to-defun-separator] | |
948 | '("--")) | |
949 | (define-key navigate-menu [semantic-symref-symbol] | |
950 | '(menu-item "Find Tag References..." semantic-symref-symbol | |
951 | :help "Read a tag and list the references to it")) | |
952 | (define-key navigate-menu [semantic-complete-jump] | |
953 | '(menu-item "Find Tag Globally..." semantic-complete-jump | |
954 | :help "Read a tag name and find it in the current project")) | |
dd9af436 CY |
955 | (define-key navigate-menu [semantic-complete-jump-local-members] |
956 | '(menu-item "Find Local Members ..." semantic-complete-jump-local-members | |
957 | :help "Read a tag name and find a local member with that name")) | |
715f35a5 CY |
958 | (define-key navigate-menu [semantic-complete-jump-local] |
959 | '(menu-item "Find Tag in This Buffer..." semantic-complete-jump-local | |
960 | :help "Read a tag name and find it in this buffer")) | |
961 | (define-key navigate-menu [semantic-navigation-separator] | |
962 | '("--")) | |
963 | (define-key navigate-menu [senator-go-to-up-reference] | |
964 | '(menu-item "Parent Tag" senator-go-to-up-reference | |
965 | :help "Navigate up one reference by tag.")) | |
966 | (define-key navigate-menu [senator-next-tag] | |
967 | '(menu-item "Next Tag" senator-next-tag | |
968 | :help "Go to the next tag")) | |
969 | (define-key navigate-menu [senator-previous-tag] | |
970 | '(menu-item "Previous Tag" senator-previous-tag | |
971 | :help "Go to the previous tag")) | |
972 | ||
973 | ;; Top level menu items: | |
974 | (define-key cedet-menu-map [semantic-force-refresh] | |
975 | '(menu-item "Reparse Buffer" semantic-force-refresh | |
a2095e2e CY |
976 | :help "Force a full reparse of the current buffer." |
977 | :visible semantic-mode)) | |
715f35a5 | 978 | (define-key cedet-menu-map [semantic-edit-menu] |
a2095e2e CY |
979 | `(menu-item "Edit Tags" ,edit-menu |
980 | :visible semantic-mode)) | |
715f35a5 | 981 | (define-key cedet-menu-map [navigate-menu] |
a2095e2e CY |
982 | `(menu-item "Navigate Tags" ,navigate-menu |
983 | :visible semantic-mode)) | |
715f35a5 CY |
984 | (define-key cedet-menu-map [semantic-options-separator] |
985 | '("--")) | |
986 | (define-key cedet-menu-map [global-semantic-highlight-func-mode] | |
a2095e2e CY |
987 | '(menu-item "Highlight Current Function" global-semantic-highlight-func-mode |
988 | :help "Highlight the tag at point" | |
989 | :visible semantic-mode | |
990 | :button (:toggle . global-semantic-highlight-func-mode))) | |
715f35a5 | 991 | (define-key cedet-menu-map [global-semantic-decoration-mode] |
a2095e2e CY |
992 | '(menu-item "Decorate Tags" global-semantic-decoration-mode |
993 | :help "Decorate tags based on tag attributes" | |
994 | :visible semantic-mode | |
995 | :button (:toggle . (bound-and-true-p | |
996 | global-semantic-decoration-mode)))) | |
715f35a5 | 997 | (define-key cedet-menu-map [global-semantic-idle-completions-mode] |
a2095e2e CY |
998 | '(menu-item "Show Tag Completions" global-semantic-idle-completions-mode |
999 | :help "Show tag completions when idle" | |
1000 | :visible semantic-mode | |
725bff06 | 1001 | :enable global-semantic-idle-scheduler-mode |
a2095e2e | 1002 | :button (:toggle . global-semantic-idle-completions-mode))) |
715f35a5 | 1003 | (define-key cedet-menu-map [global-semantic-idle-summary-mode] |
a2095e2e CY |
1004 | '(menu-item "Show Tag Summaries" global-semantic-idle-summary-mode |
1005 | :help "Show tag summaries when idle" | |
1006 | :visible semantic-mode | |
725bff06 | 1007 | :enable global-semantic-idle-scheduler-mode |
a2095e2e | 1008 | :button (:toggle . global-semantic-idle-summary-mode))) |
715f35a5 | 1009 | (define-key cedet-menu-map [global-semantic-idle-scheduler-mode] |
a2095e2e CY |
1010 | '(menu-item "Reparse When Idle" global-semantic-idle-scheduler-mode |
1011 | :help "Keep a buffer's parse tree up to date when idle" | |
1012 | :visible semantic-mode | |
725bff06 CY |
1013 | :button (:toggle . global-semantic-idle-scheduler-mode))) |
1014 | (define-key cedet-menu-map [global-semanticdb-minor-mode] | |
1015 | '(menu-item "Semantic Database" global-semanticdb-minor-mode | |
1016 | :help "Store tag information in a database" | |
1017 | :visible semantic-mode | |
1018 | :button (:toggle . global-semanticdb-minor-mode)))) | |
715f35a5 | 1019 | |
b82525f2 | 1020 | ;; The `semantic-mode' command, in conjuction with the |
715f35a5 | 1021 | ;; `semantic-default-submodes' variable, toggles Semantic's various |
4963739e | 1022 | ;; auxiliary minor modes. |
b82525f2 CY |
1023 | |
1024 | (defvar semantic-load-system-cache-loaded nil | |
db9e401b | 1025 | "Non-nil when the Semantic system caches have been loaded. |
b82525f2 CY |
1026 | Prevent this load system from loading files in twice.") |
1027 | ||
1028 | (defconst semantic-submode-list | |
1029 | '(global-semantic-highlight-func-mode | |
1030 | global-semantic-decoration-mode | |
1031 | global-semantic-stickyfunc-mode | |
1032 | global-semantic-idle-completions-mode | |
1033 | global-semantic-idle-scheduler-mode | |
1034 | global-semanticdb-minor-mode | |
1035 | global-semantic-idle-summary-mode | |
1036 | global-semantic-mru-bookmark-mode) | |
bd2afec2 | 1037 | "List of auxiliary minor modes in the Semantic package.") |
b82525f2 CY |
1038 | |
1039 | ;;;###autoload | |
1040 | (defcustom semantic-default-submodes | |
1041 | '(global-semantic-idle-scheduler-mode global-semanticdb-minor-mode) | |
bd2afec2 | 1042 | "List of auxiliary Semantic minor modes enabled by `semantic-mode'. |
b82525f2 CY |
1043 | The possible elements of this list include the following: |
1044 | ||
725bff06 CY |
1045 | `global-semanticdb-minor-mode' - Maintain tag database. |
1046 | `global-semantic-idle-scheduler-mode' - Reparse buffer when idle. | |
1047 | `global-semantic-idle-summary-mode' - Show summary of tag at point. | |
1048 | `global-semantic-idle-completions-mode' - Show completions when idle. | |
1049 | `global-semantic-decoration-mode' - Additional tag decorations. | |
1050 | `global-semantic-highlight-func-mode' - Highlight the current tag. | |
1051 | `global-semantic-stickyfunc-mode' - Show current fun in header line. | |
1052 | `global-semantic-mru-bookmark-mode' - Provide `switch-to-buffer'-like | |
db9e401b | 1053 | keybinding for tag names." |
b82525f2 CY |
1054 | :group 'semantic |
1055 | :type `(set ,@(mapcar (lambda (c) (list 'const c)) | |
1056 | semantic-submode-list))) | |
1057 | ||
1058 | ;;;###autoload | |
1059 | (define-minor-mode semantic-mode | |
1060 | "Toggle Semantic mode. | |
1061 | With ARG, turn Semantic mode on if ARG is positive, off otherwise. | |
1062 | ||
1063 | In Semantic mode, Emacs parses the buffers you visit for their | |
1064 | semantic content. This information is used by a variety of | |
4963739e | 1065 | auxiliary minor modes, listed in `semantic-default-submodes'; |
b82525f2 | 1066 | all the minor modes in this list are also enabled when you enable |
8bf997ef CY |
1067 | Semantic mode. |
1068 | ||
1069 | \\{semantic-mode-map}" | |
1070 | :global t | |
b82525f2 CY |
1071 | :group 'semantic |
1072 | (if semantic-mode | |
1073 | ;; Turn on Semantic mode | |
1074 | (progn | |
4963739e | 1075 | ;; Enable all the global auxiliary minor modes in |
8bf997ef | 1076 | ;; `semantic-submode-list'. |
b82525f2 CY |
1077 | (dolist (mode semantic-submode-list) |
1078 | (if (memq mode semantic-default-submodes) | |
1079 | (funcall mode 1))) | |
1080 | (unless semantic-load-system-cache-loaded | |
1081 | (setq semantic-load-system-cache-loaded t) | |
1082 | (when (and (boundp 'semanticdb-default-system-save-directory) | |
1083 | (stringp semanticdb-default-system-save-directory) | |
1084 | (file-exists-p semanticdb-default-system-save-directory)) | |
17e1f4bc | 1085 | (require 'semantic/db-ebrowse) |
b82525f2 | 1086 | (semanticdb-load-ebrowse-caches))) |
d436f538 | 1087 | (add-hook 'mode-local-init-hook 'semantic-new-buffer-fcn) |
dd9af436 CY |
1088 | ;; Add semantic-ia-complete-symbol to |
1089 | ;; completion-at-point-functions, so that it is run from | |
1090 | ;; M-TAB. | |
1091 | (add-hook 'completion-at-point-functions | |
1092 | 'semantic-completion-at-point-function) | |
ebf5c4f5 CY |
1093 | (if global-ede-mode |
1094 | (define-key cedet-menu-map [cedet-menu-separator] '("--"))) | |
d436f538 CY |
1095 | (dolist (b (buffer-list)) |
1096 | (with-current-buffer b | |
1097 | (semantic-new-buffer-fcn)))) | |
b82525f2 CY |
1098 | ;; Disable all Semantic features. |
1099 | (remove-hook 'mode-local-init-hook 'semantic-new-buffer-fcn) | |
dd9af436 CY |
1100 | (remove-hook 'completion-at-point-functions |
1101 | 'semantic-completion-at-point-function) | |
ebf5c4f5 CY |
1102 | (define-key cedet-menu-map [cedet-menu-separator] nil) |
1103 | (define-key cedet-menu-map [semantic-options-separator] nil) | |
b82525f2 | 1104 | ;; FIXME: handle semanticdb-load-ebrowse-caches |
b82525f2 CY |
1105 | (dolist (mode semantic-submode-list) |
1106 | (if (and (boundp mode) (eval mode)) | |
1107 | (funcall mode -1))))) | |
1108 | ||
dd9af436 CY |
1109 | (defun semantic-completion-at-point-function () |
1110 | 'semantic-ia-complete-symbol) | |
1111 | ||
af7b5a91 CY |
1112 | ;;; Autoload some functions that are not in semantic/loaddefs |
1113 | ||
1114 | (autoload 'global-semantic-idle-completions-mode "semantic/idle" | |
1115 | "Toggle global use of `semantic-idle-completions-mode'. | |
1116 | If ARG is positive, enable, if it is negative, disable. | |
1117 | If ARG is nil, then toggle." t nil) | |
1118 | ||
1119 | (autoload 'semantic-idle-completions-mode "semantic/idle" | |
1120 | "Display a list of possible completions in a tooltip. | |
1121 | ||
1122 | This is a minor mode which performs actions during idle time. | |
1123 | With prefix argument ARG, turn on if positive, otherwise off. The | |
1124 | minor mode can be turned on only if semantic feature is available and | |
1125 | the current buffer was set up for parsing. Return non-nil if the | |
1126 | minor mode is enabled." t nil) | |
1127 | ||
1128 | (autoload 'global-semantic-idle-summary-mode "semantic/idle" | |
1129 | "Toggle global use of `semantic-idle-summary-mode'. | |
1130 | If ARG is positive, enable, if it is negative, disable. | |
1131 | If ARG is nil, then toggle." t nil) | |
1132 | ||
1133 | (autoload 'semantic-idle-summary-mode "semantic/idle" | |
1134 | "Display a tag summary of the lexical token under the cursor. | |
1135 | Call `semantic-idle-summary-current-symbol-info' for getting the | |
1136 | current tag to display information. | |
1137 | ||
1138 | This is a minor mode which performs actions during idle time. | |
1139 | With prefix argument ARG, turn on if positive, otherwise off. The | |
1140 | minor mode can be turned on only if semantic feature is available and | |
1141 | the current buffer was set up for parsing. Return non-nil if the | |
1142 | minor mode is enabled." t nil) | |
b82525f2 | 1143 | |
e6e267fc CY |
1144 | (autoload 'srecode-template-setup-parser "srecode/srecode-template" |
1145 | "Set up buffer for parsing SRecode template files." t nil) | |
1146 | ||
d3d82e7b CY |
1147 | (provide 'semantic) |
1148 | ||
d3d82e7b CY |
1149 | ;; Semantic-util is a part of the semantic API. Include it last |
1150 | ;; because it depends on semantic. | |
9d389824 | 1151 | (require 'semantic/util) |
a60f2e7b | 1152 | |
b82525f2 CY |
1153 | ;; (require 'semantic/load) |
1154 | ||
a60f2e7b | 1155 | ;;; semantic.el ends here |