1 ;;; idle.el --- Schedule parsing tasks in idle time
3 ;; Copyright (C) 2003-2006, 2008-2012 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; Originally, `semantic-auto-parse-mode' handled refreshing the
26 ;; tags in a buffer in idle time. Other activities can be scheduled
27 ;; in idle time, all of which require up-to-date tag tables.
28 ;; Having a specialized idle time scheduler that first refreshes
29 ;; the tags buffer, and then enables other idle time tasks reduces
30 ;; the amount of work needed. Any specialized idle tasks need not
31 ;; ask for a fresh tags list.
33 ;; NOTE ON SEMANTIC_ANALYZE
35 ;; Some of the idle modes use the semantic analyzer. The analyzer
36 ;; automatically caches the created context, so it is shared amongst
37 ;; all idle modes that will need it.
40 (require 'semantic/ctxt)
41 (require 'semantic/format)
42 (require 'semantic/tag)
46 ;; For the semantic-find-tags-by-name macro.
47 (eval-when-compile (require 'semantic/find))
49 (defvar eldoc-last-message)
50 (declare-function eldoc-message "eldoc")
51 (declare-function semantic-analyze-interesting-tag "semantic/analyze")
52 (declare-function semantic-analyze-unsplit-name "semantic/analyze/fcn")
53 (declare-function semantic-complete-analyze-inline-idle "semantic/complete")
54 (declare-function semanticdb-deep-find-tags-by-name "semantic/db-find")
55 (declare-function semanticdb-save-all-db-idle "semantic/db")
56 (declare-function semanticdb-typecache-refresh-for-buffer "semantic/db-typecache")
57 (declare-function semantic-decorate-flush-pending-decorations
58 "semantic/decorate/mode")
59 (declare-function pulse-momentary-highlight-region "pulse")
60 (declare-function pulse-momentary-highlight-overlay "pulse")
61 (declare-function semantic-symref-hits-in-region "semantic/symref/filter")
65 ;;; TIMER RELATED FUNCTIONS
67 (defvar semantic-idle-scheduler-timer nil
68 "Timer used to schedule tasks in idle time.")
70 (defvar semantic-idle-scheduler-work-timer nil
71 "Timer used to schedule tasks in idle time that may take a while.")
73 (defcustom semantic-idle-scheduler-verbose-flag nil
74 "Non-nil means that the idle scheduler should provide debug messages.
75 Use this setting to debug idle activities."
79 (defcustom semantic-idle-scheduler-idle-time 1
80 "Time in seconds of idle before scheduling events.
81 This time should be short enough to ensure that idle-scheduler will be
82 run as soon as Emacs is idle."
85 :set (lambda (sym val)
87 (when (timerp semantic-idle-scheduler-timer)
88 (cancel-timer semantic-idle-scheduler-timer)
89 (setq semantic-idle-scheduler-timer nil)
90 (semantic-idle-scheduler-setup-timers))))
92 (defcustom semantic-idle-scheduler-work-idle-time 60
93 "Time in seconds of idle before scheduling big work.
94 This time should be long enough that once any big work is started, it is
95 unlikely the user would be ready to type again right away."
98 :set (lambda (sym val)
100 (when (timerp semantic-idle-scheduler-timer)
101 (cancel-timer semantic-idle-scheduler-timer)
102 (setq semantic-idle-scheduler-timer nil)
103 (semantic-idle-scheduler-setup-timers))))
105 (defun semantic-idle-scheduler-setup-timers ()
106 "Lazy initialization of the auto parse idle timer."
107 ;; REFRESH THIS FUNCTION for XEMACS FOIBLES
108 (or (timerp semantic-idle-scheduler-timer)
109 (setq semantic-idle-scheduler-timer
111 semantic-idle-scheduler-idle-time t
112 #'semantic-idle-scheduler-function)))
113 (or (timerp semantic-idle-scheduler-work-timer)
114 (setq semantic-idle-scheduler-work-timer
116 semantic-idle-scheduler-work-idle-time t
117 #'semantic-idle-scheduler-work-function)))
120 (defun semantic-idle-scheduler-kill-timer ()
121 "Kill the auto parse idle timer."
122 (if (timerp semantic-idle-scheduler-timer)
123 (cancel-timer semantic-idle-scheduler-timer))
124 (setq semantic-idle-scheduler-timer nil))
129 ;; The minor mode portion of this code just sets up the minor mode
130 ;; which does the initial scheduling of the idle timers.
133 (defcustom semantic-idle-scheduler-mode-hook nil
134 "Hook run at the end of the function `semantic-idle-scheduler-mode'."
138 (defvar semantic-idle-scheduler-mode nil
139 "Non-nil if idle-scheduler minor mode is enabled.
140 Use the command `semantic-idle-scheduler-mode' to change this variable.")
141 (make-variable-buffer-local 'semantic-idle-scheduler-mode)
143 (defcustom semantic-idle-scheduler-max-buffer-size 0
144 "*Maximum size in bytes of buffers where idle-scheduler is enabled.
145 If this value is less than or equal to 0, idle-scheduler is enabled in
146 all buffers regardless of their size."
150 (defsubst semantic-idle-scheduler-enabled-p ()
151 "Return non-nil if idle-scheduler is enabled for this buffer.
152 idle-scheduler is disabled when debugging or if the buffer size
153 exceeds the `semantic-idle-scheduler-max-buffer-size' threshold."
154 (let* ((remote-file? (when (stringp buffer-file-name) (file-remote-p buffer-file-name))))
155 (and semantic-idle-scheduler-mode
156 (not (and (boundp 'semantic-debug-enabled)
157 semantic-debug-enabled))
158 (not semantic-lex-debug)
159 ;; local file should exist on disk
160 ;; remote file should have active connection
161 (or (and (null remote-file?) (stringp buffer-file-name)
162 (file-exists-p buffer-file-name))
163 (and remote-file? (file-remote-p buffer-file-name nil t)))
164 (or (<= semantic-idle-scheduler-max-buffer-size 0)
165 (< (buffer-size) semantic-idle-scheduler-max-buffer-size)))))
168 (define-minor-mode semantic-idle-scheduler-mode
169 "Minor mode to auto parse buffer following a change.
170 When this mode is off, a buffer is only rescanned for tokens when
171 some command requests the list of available tokens. When idle-scheduler
172 is enabled, Emacs periodically checks to see if the buffer is out of
173 date, and reparses while the user is idle (not typing.)
175 With prefix argument ARG, turn on if positive, otherwise off. The
176 minor mode can be turned on only if semantic feature is available and
177 the current buffer was set up for parsing. Return non-nil if the
178 minor mode is enabled."
180 (if semantic-idle-scheduler-mode
181 (if (not (and (featurep 'semantic) (semantic-active-p)))
183 ;; Disable minor mode if semantic stuff not available
184 (setq semantic-idle-scheduler-mode nil)
185 (error "Buffer %s was not set up idle time scheduling"
187 (semantic-idle-scheduler-setup-timers))))
189 (semantic-add-minor-mode 'semantic-idle-scheduler-mode
192 ;;; SERVICES services
194 ;; These are services for managing idle services.
196 (defvar semantic-idle-scheduler-queue nil
197 "List of functions to execute during idle time.
198 These functions will be called in the current buffer after that
199 buffer has had its tags made up to date. These functions
200 will not be called if there are errors parsing the
203 (defun semantic-idle-scheduler-add (function)
204 "Schedule FUNCTION to occur during idle time."
205 (add-to-list 'semantic-idle-scheduler-queue function))
207 (defun semantic-idle-scheduler-remove (function)
208 "Unschedule FUNCTION to occur during idle time."
209 (setq semantic-idle-scheduler-queue
210 (delete function semantic-idle-scheduler-queue)))
214 (defun semantic-idle-core-handler ()
215 "Core idle function that handles reparsing.
216 And also manages services that depend on tag values."
217 (when semantic-idle-scheduler-verbose-flag
218 (message "IDLE: Core handler..."))
219 (semantic-exit-on-input 'idle-timer
220 (let* ((inhibit-quit nil)
221 (buffers (delq (current-buffer)
223 (mapcar #'(lambda (b)
224 (and (buffer-file-name b)
227 safe ;; This safe is not used, but could be.
230 (when (semantic-idle-scheduler-enabled-p)
232 ;; First, reparse the current buffer.
233 (setq mode major-mode
234 safe (semantic-safe "Idle Parse Error: %S"
235 ;(error "Goofy error 1")
236 (semantic-idle-scheduler-refresh-tags)
239 ;; Now loop over other buffers with same major mode, trying to
240 ;; update them as well. Stop on keypress.
242 (semantic-throw-on-input 'parsing-mode-buffers)
243 (with-current-buffer b
244 (if (eq major-mode mode)
245 (and (semantic-idle-scheduler-enabled-p)
246 (semantic-safe "Idle Parse Error: %S"
247 ;(error "Goofy error")
248 (semantic-idle-scheduler-refresh-tags)))
249 (push (current-buffer) others))))
250 (setq buffers others))
251 ;; If re-parse of current buffer completed, evaluate all other
252 ;; services. Stop on keypress.
254 ;; NOTE ON COMMENTED SAFE HERE
255 ;; We used to not execute the services if the buffer was
256 ;; unparsable. We now assume that they are lexically
257 ;; safe to do, because we have marked the buffer unparsable
258 ;; if there was a problem.
260 (dolist (service semantic-idle-scheduler-queue)
262 (semantic-throw-on-input 'idle-queue)
263 (when semantic-idle-scheduler-verbose-flag
264 (message "IDLE: execute service %s..." service))
265 (semantic-safe (format "Idle Service Error %s: %%S" service)
267 (when semantic-idle-scheduler-verbose-flag
268 (message "IDLE: execute service %s...done" service))
271 ;; Finally loop over remaining buffers, trying to update them as
272 ;; well. Stop on keypress.
275 (semantic-throw-on-input 'parsing-other-buffers)
276 (with-current-buffer b
277 (and (semantic-idle-scheduler-enabled-p)
278 (semantic-idle-scheduler-refresh-tags)))))
280 (when semantic-idle-scheduler-verbose-flag
281 (message "IDLE: Core handler...done")))
283 (defun semantic-debug-idle-function ()
284 "Run the Semantic idle function with debugging turned on."
286 (let ((debug-on-error t))
287 (semantic-idle-core-handler)
290 (defun semantic-idle-scheduler-function ()
291 "Function run when after `semantic-idle-scheduler-idle-time'.
292 This function will reparse the current buffer, and if successful,
293 call additional functions registered with the timer calls."
294 (when (zerop (recursion-depth))
295 (let ((debug-on-error nil))
296 (save-match-data (semantic-idle-core-handler))
302 ;; Unlike the shorter timer, the WORK timer will kick of tasks that
303 ;; may take a long time to complete.
304 (defcustom semantic-idle-work-parse-neighboring-files-flag nil
305 "*Non-nil means to parse files in the same dir as the current buffer.
306 Disable to prevent lots of excessive parsing in idle time."
310 (defcustom semantic-idle-work-update-headers-flag nil
311 "*Non-nil means to parse through header files in idle time.
312 Disable to prevent idle time parsing of many files. If completion
313 is called that work will be done then instead."
317 (defun semantic-idle-work-for-one-buffer (buffer)
318 "Do long-processing work for BUFFER.
319 Uses `semantic-safe' and returns the output.
320 Returns t if all processing succeeded."
321 (with-current-buffer buffer
324 (semantic-safe "Idle Work Parse Error: %S"
325 (semantic-idle-scheduler-refresh-tags)
328 ;; Option to disable this work.
329 semantic-idle-work-update-headers-flag
331 ;; Force all our include files to get read in so we
332 ;; are ready to provide good smart completion and idle
333 ;; summary information
334 (semantic-safe "Idle Work Including Error: %S"
335 ;; Get the include related path.
336 (when (and (featurep 'semantic/db) (semanticdb-minor-mode-p))
337 (require 'semantic/db-find)
338 (semanticdb-find-translate-path buffer nil)
342 ;; Pre-build the typecaches as needed.
343 (semantic-safe "Idle Work Typecaching Error: %S"
344 (when (featurep 'semantic/db-typecache)
345 (semanticdb-typecache-refresh-for-buffer buffer))
350 (defun semantic-idle-work-core-handler ()
351 "Core handler for idle work processing of long running tasks.
352 Visits Semantic controlled buffers, and makes sure all needed
353 include files have been parsed, and that the typecache is up to date.
354 Uses `semantic-idle-work-for-on-buffer' to do the work."
357 (semantic-exit-on-input 'idle-work-timer
358 (let* ((inhibit-quit nil)
359 (cb (current-buffer))
360 (buffers (delq (current-buffer)
362 (mapcar #'(lambda (b)
363 (and (buffer-file-name b)
367 ;; First, handle long tasks in the current buffer.
368 (when (semantic-idle-scheduler-enabled-p)
370 (setq safe (semantic-idle-work-for-one-buffer (current-buffer))
372 (when (not safe) (push (current-buffer) errbuf))
374 ;; Now loop over other buffers with same major mode, trying to
375 ;; update them as well. Stop on keypress.
377 (semantic-throw-on-input 'parsing-mode-buffers)
378 (with-current-buffer b
379 (when (semantic-idle-scheduler-enabled-p)
380 (and (semantic-idle-scheduler-enabled-p)
381 (unless (semantic-idle-work-for-one-buffer (current-buffer))
382 (push (current-buffer) errbuf)))
386 (when (and (featurep 'semantic/db) (semanticdb-minor-mode-p))
388 (semanticdb-save-all-db-idle)
390 ;; Parse up files near our active buffer
391 (when semantic-idle-work-parse-neighboring-files-flag
392 (semantic-safe "Idle Work Parse Neighboring Files: %S"
394 (semantic-idle-scheduler-work-parse-neighboring-files))
397 ;; Save everything... again
398 (semanticdb-save-all-db-idle)
401 ;; Done w/ processing
410 (format "done with 1 error in %s" (car errbuf)))
412 (format "done with errors in %d buffers."
413 (length errbuf)))))))
415 (defun semantic-debug-idle-work-function ()
416 "Run the Semantic idle work function with debugging turned on."
418 (let ((debug-on-error t))
419 (semantic-idle-work-core-handler)
422 (defun semantic-idle-scheduler-work-function ()
423 "Function run when after `semantic-idle-scheduler-work-idle-time'.
424 This routine handles difficult tasks that require a lot of parsing, such as
425 parsing all the header files used by our active sources, or building up complex
427 (when semantic-idle-scheduler-verbose-flag
428 (message "Long Work Idle Timer..."))
429 (let ((exit-type (save-match-data
430 (semantic-idle-work-core-handler))))
431 (when semantic-idle-scheduler-verbose-flag
432 (message "Long Work Idle Timer...%s" exit-type)))
435 (defun semantic-idle-scheduler-work-parse-neighboring-files ()
436 "Parse all the files in similar directories to buffers being edited."
437 ;; Let's check to see if EDE matters.
438 (let ((ede-auto-add-method 'never))
439 (dolist (a auto-mode-alist)
440 (when (eq (cdr a) major-mode)
441 (dolist (file (directory-files default-directory t (car a) t))
442 (semantic-throw-on-input 'parsing-mode-buffers)
444 (semanticdb-file-table-object file)
451 ;; Reparsing is installed as semantic idle service.
452 ;; This part ALWAYS happens, and other services occur
455 (defvar semantic-before-idle-scheduler-reparse-hook nil
456 "Hook run before option `semantic-idle-scheduler' begins parsing.
457 If any hook function throws an error, this variable is reset to nil.
458 This hook is not protected from lexical errors.")
460 (defvar semantic-after-idle-scheduler-reparse-hook nil
461 "Hook run after option `semantic-idle-scheduler' has parsed.
462 If any hook function throws an error, this variable is reset to nil.
463 This hook is not protected from lexical errors.")
465 (semantic-varalias-obsolete 'semantic-before-idle-scheduler-reparse-hooks
466 'semantic-before-idle-scheduler-reparse-hook "23.2")
467 (semantic-varalias-obsolete 'semantic-after-idle-scheduler-reparse-hooks
468 'semantic-after-idle-scheduler-reparse-hook "23.2")
470 (defun semantic-idle-scheduler-refresh-tags ()
471 "Refreshes the current buffer's tags.
472 This is called by `semantic-idle-scheduler-function' to update the
473 tags in the current buffer.
475 Return non-nil if the refresh was successful.
476 Return nil if there is some sort of syntax error preventing a full
479 Does nothing if the current buffer doesn't need reparsing."
482 ;; These checks actually occur in `semantic-fetch-tags', but if we
483 ;; do them here, then all the bovination hooks are not run, and
484 ;; we save lots of time.
486 ;; If the buffer was previously marked unparsable,
487 ;; then don't waste our time.
488 ((semantic-parse-tree-unparseable-p)
490 ;; The parse tree is already ok.
491 ((semantic-parse-tree-up-to-date-p)
494 ;; If the buffer might need a reparse and it is safe to do so,
496 (let* (;(semantic-working-type nil)
498 ;; (working-use-echo-area-p
499 ;; (not semantic-idle-scheduler-working-in-modeline-flag))
500 ;; (working-status-dynamic-type
501 ;; (if semantic-idle-scheduler-no-working-message
503 ;; working-status-dynamic-type))
504 ;; (working-status-percentage-type
505 ;; (if semantic-idle-scheduler-no-working-message
507 ;; working-status-percentage-type))
510 ;; Let people hook into this, but don't let them hose
513 (run-hooks 'semantic-before-idle-scheduler-reparse-hook)
514 (error (setq semantic-before-idle-scheduler-reparse-hook nil)))
517 ;; Perform the parsing.
519 (when semantic-idle-scheduler-verbose-flag
520 (message "IDLE: reparse %s..." (buffer-name)))
521 (when (semantic-lex-catch-errors idle-scheduler
522 (save-excursion (semantic-fetch-tags))
524 ;; If we are here, it is because the lexical step failed,
525 ;; probably due to unterminated lists or something like that.
527 ;; We do nothing, and just wait for the next idle timer
528 ;; to go off. In the meantime, remember this, and make sure
529 ;; no other idle services can get executed.
530 (setq lexically-safe nil))
531 (when semantic-idle-scheduler-verbose-flag
532 (message "IDLE: reparse %s...done" (buffer-name))))
533 ;; Let people hook into this, but don't let them hose
536 (run-hooks 'semantic-after-idle-scheduler-reparse-hook)
537 (error (setq semantic-after-idle-scheduler-reparse-hook nil))))
538 ;; Return if we are lexically safe (from prog1)
541 ;; After updating the tags, handle any pending decorations for this
543 (require 'semantic/decorate/mode)
544 (semantic-decorate-flush-pending-decorations (current-buffer))
550 ;; Idle Services are minor modes which enable or disable a services in
551 ;; the idle scheduler. Creating a new services only requires calling
552 ;; `semantic-create-idle-services' which does all the setup
553 ;; needed to create the minor mode that will enable or disable
554 ;; a services. The services must provide a single function.
556 ;; FIXME doc is incomplete.
557 (defmacro define-semantic-idle-service (name doc &rest forms)
558 "Create a new idle services with NAME.
559 DOC will be a documentation string describing FORMS.
560 FORMS will be called during idle time after the current buffer's
561 semantic tag information has been updated.
562 This routine creates the following functions and variables:"
563 (let ((global (intern (concat "global-" (symbol-name name) "-mode")))
564 (mode (intern (concat (symbol-name name) "-mode")))
565 (hook (intern (concat (symbol-name name) "-mode-hook")))
566 (map (intern (concat (symbol-name name) "-mode-map")))
567 (setup (intern (concat (symbol-name name) "-mode-setup")))
568 (func (intern (concat (symbol-name name) "-idle-function"))))
571 (define-minor-mode ,global
572 ,(concat "Toggle " (symbol-name global) ".
573 With ARG, turn the minor mode on if ARG is positive, off otherwise.
575 When this minor mode is enabled, `" (symbol-name mode) "' is
576 turned on in every Semantic-supported buffer.")
579 :group 'semantic-modes
580 :require 'semantic/idle
581 (semantic-toggle-minor-mode-globally
582 ',mode (if ,global 1 -1)))
584 ;; FIXME: Get rid of this when define-minor-mode does it for us.
586 ,(concat "Hook run at the end of function `" (symbol-name mode) "'.")
591 (let ((km (make-sparse-keymap)))
593 ,(concat "Keymap for `" (symbol-name mode) "'."))
595 (define-minor-mode ,mode
599 (if (not (and (featurep 'semantic) (semantic-active-p)))
601 ;; Disable minor mode if semantic stuff not available
603 (error "Buffer %s was not set up for parsing"
605 ;; Enable the mode mode
606 (semantic-idle-scheduler-add #',func))
607 ;; Disable the mode mode
608 (semantic-idle-scheduler-remove #',func)))
610 (semantic-add-minor-mode ',mode
611 "") ; idle schedulers are quiet?
614 ,(concat "Perform idle activity for the minor mode `"
615 (symbol-name mode) "'.")
617 (put 'define-semantic-idle-service 'lisp-indent-function 1)
618 (add-hook 'edebug-setup-hook
620 (def-edebug-spec define-semantic-idle-service
621 (&define name stringp def-body))))
625 ;; A mode similar to eldoc using semantic
626 (defcustom semantic-idle-truncate-long-summaries t
627 "Truncate summaries that are too long to fit in the minibuffer.
628 This can prevent minibuffer resizing in idle time."
632 (defcustom semantic-idle-summary-function
633 'semantic-format-tag-summarize-with-file
634 "Function to call when displaying tag information during idle time.
635 This function should take a single argument, a Semantic tag, and
636 return a string to display.
637 Some useful functions are found in `semantic-format-tag-functions'."
639 :type semantic-format-tag-custom-list)
641 (defsubst semantic-idle-summary-find-current-symbol-tag (sym)
642 "Search for a semantic tag with name SYM in database tables.
643 Return the tag found or nil if not found.
644 If semanticdb is not in use, use the current buffer only."
645 (car (if (and (featurep 'semantic/db)
646 semanticdb-current-database
647 (require 'semantic/db-find))
648 (cdar (semanticdb-deep-find-tags-by-name sym))
649 (semantic-deep-find-tags-by-name sym (current-buffer)))))
651 (defun semantic-idle-summary-current-symbol-info-brutish ()
652 "Return a string message describing the current context.
653 Gets a symbol with `semantic-ctxt-current-thing' and then
654 tries to find it with a deep targeted search."
655 ;; Try the current "thing".
656 (let ((sym (car (semantic-ctxt-current-thing))))
658 (semantic-idle-summary-find-current-symbol-tag sym))))
660 (defun semantic-idle-summary-current-symbol-keyword ()
661 "Return a string message describing the current symbol.
662 Returns a value only if it is a keyword."
663 ;; Try the current "thing".
664 (let ((sym (car (semantic-ctxt-current-thing))))
665 (if (and sym (semantic-lex-keyword-p sym))
666 (semantic-lex-keyword-get sym 'summary))))
668 (defun semantic-idle-summary-current-symbol-info-context ()
669 "Return a string message describing the current context.
670 Use the semantic analyzer to find the symbol information."
671 (let ((analysis (condition-case nil
672 (semantic-analyze-current-context (point))
675 (require 'semantic/analyze)
676 (semantic-analyze-interesting-tag analysis))))
678 (defun semantic-idle-summary-current-symbol-info-default ()
679 "Return a string message describing the current context.
680 This function will disable loading of previously unloaded files
681 by semanticdb as a time-saving measure."
682 (semanticdb-without-unloaded-file-searches
684 ;; use whichever has success first.
686 (semantic-idle-summary-current-symbol-keyword)
688 (semantic-idle-summary-current-symbol-info-context)
690 (semantic-idle-summary-current-symbol-info-brutish)
693 (defvar semantic-idle-summary-out-of-context-faces
695 font-lock-comment-face
696 font-lock-string-face
697 font-lock-doc-string-face ; XEmacs.
698 font-lock-doc-face ; Emacs 21 and later.
700 "List of font-lock faces that indicate a useless summary context.
701 Those are generally faces used to highlight comments.
703 It might be useful to override this variable to add comment faces
704 specific to a major mode. For example, in jde mode:
706 \(defvar-mode-local jde-mode semantic-idle-summary-out-of-context-faces
707 (append (default-value 'semantic-idle-summary-out-of-context-faces)
708 '(jde-java-font-lock-doc-tag-face
709 jde-java-font-lock-link-face
710 jde-java-font-lock-bold-face
711 jde-java-font-lock-underline-face
712 jde-java-font-lock-pre-face
713 jde-java-font-lock-code-face)))")
715 (defun semantic-idle-summary-useful-context-p ()
716 "Non-nil if we should show a summary based on context."
717 (if (and (boundp 'font-lock-mode)
719 (memq (get-text-property (point) 'face)
720 semantic-idle-summary-out-of-context-faces))
721 ;; The best I can think of at the moment is to disable
722 ;; in comments by detecting with font-lock.
726 (define-overloadable-function semantic-idle-summary-current-symbol-info ()
727 "Return a string message describing the current context.")
729 (make-obsolete-overload 'semantic-eldoc-current-symbol-info
730 'semantic-idle-summary-current-symbol-info
733 (defcustom semantic-idle-summary-mode-hook nil
734 "Hook run at the end of `semantic-idle-summary'."
738 (defun semantic-idle-summary-idle-function ()
739 "Display a tag summary of the lexical token under the cursor.
740 Call `semantic-idle-summary-current-symbol-info' for getting the
741 current tag to display information."
742 (or (eq major-mode 'emacs-lisp-mode)
743 (not (semantic-idle-summary-useful-context-p))
744 (let* ((found (semantic-idle-summary-current-symbol-info))
745 (str (cond ((stringp found) found)
746 ((semantic-tag-p found)
747 (funcall semantic-idle-summary-function
749 ;; Show the message with eldoc functions
750 (unless (and str (boundp 'eldoc-echo-area-use-multiline-p)
751 eldoc-echo-area-use-multiline-p)
752 (let ((w (1- (window-width (minibuffer-window)))))
753 (if (> (length str) w)
754 (setq str (substring str 0 w)))))
755 ;; I borrowed some bits from eldoc to shorten the
757 (when semantic-idle-truncate-long-summaries
758 (let ((ea-width (1- (window-width (minibuffer-window))))
759 (strlen (length str)))
760 (when (> strlen ea-width)
761 (setq str (substring str 0 ea-width)))))
763 (eldoc-message str))))
765 (define-minor-mode semantic-idle-summary-mode
766 "Toggle Semantic Idle Summary mode.
767 With ARG, turn Semantic Idle Summary mode on if ARG is positive,
770 When this minor mode is enabled, the echo area displays a summary
771 of the lexical token at point whenever Emacs is idle."
773 :group 'semantic-modes
774 (if semantic-idle-summary-mode
777 (unless (and (featurep 'semantic) (semantic-active-p))
778 ;; Disable minor mode if semantic stuff not available
779 (setq semantic-idle-summary-mode nil)
780 (error "Buffer %s was not set up for parsing"
783 (semantic-idle-scheduler-add 'semantic-idle-summary-idle-function)
784 (add-hook 'pre-command-hook 'semantic-idle-summary-refresh-echo-area t))
786 (semantic-idle-scheduler-remove 'semantic-idle-summary-idle-function)
787 (remove-hook 'pre-command-hook 'semantic-idle-summary-refresh-echo-area t)))
789 (defun semantic-idle-summary-refresh-echo-area ()
790 (and semantic-idle-summary-mode
792 (if (and (not executing-kbd-macro)
793 (not (and (boundp 'edebug-active) edebug-active))
794 (not cursor-in-echo-area)
795 (not (eq (selected-window) (minibuffer-window))))
796 (eldoc-message eldoc-last-message)
797 (setq eldoc-last-message nil))))
799 (semantic-add-minor-mode 'semantic-idle-summary-mode "")
801 (define-minor-mode global-semantic-idle-summary-mode
802 "Toggle Global Semantic Idle Summary mode.
803 With ARG, turn Global Semantic Idle Summary mode on if ARG is
804 positive, off otherwise.
806 When this minor mode is enabled, `semantic-idle-summary-mode' is
807 turned on in every Semantic-supported buffer."
810 :group 'semantic-modes
811 (semantic-toggle-minor-mode-globally
812 'semantic-idle-summary-mode
813 (if global-semantic-idle-summary-mode 1 -1)))
816 ;;; Current symbol highlight
818 ;; This mode will use context analysis to perform highlighting
819 ;; of all uses of the symbol that is under the cursor.
821 ;; This is to mimic the Eclipse tool of a similar nature.
822 (defvar semantic-idle-symbol-highlight-face 'region
823 "Face used for highlighting local symbols.")
825 (defun semantic-idle-symbol-maybe-highlight (tag)
826 "Perhaps add highlighting to the symbol represented by TAG.
827 TAG was found as the symbol under point. If it happens to be
828 visible, then highlight it."
830 (let* ((region (when (and (semantic-tag-p tag)
831 (semantic-tag-with-position-p tag))
832 (semantic-tag-overlay tag)))
833 (file (when (and (semantic-tag-p tag)
834 (semantic-tag-with-position-p tag))
835 (semantic-tag-file-name tag)))
836 (buffer (when file (get-file-buffer file)))
837 ;; We use pulse, but we don't want the flashy version,
838 ;; just the stable version.
841 (cond ((semantic-overlay-p region)
842 (with-current-buffer (semantic-overlay-buffer region)
843 (goto-char (semantic-overlay-start region))
844 (when (pos-visible-in-window-p
845 (point) (get-buffer-window (current-buffer) 'visible))
846 (if (< (semantic-overlay-end region) (point-at-eol))
847 (pulse-momentary-highlight-overlay
848 region semantic-idle-symbol-highlight-face)
850 (pulse-momentary-highlight-region
851 (semantic-overlay-start region)
853 semantic-idle-symbol-highlight-face)))
856 (let ((start (aref region 0))
857 (end (aref region 1)))
859 (when buffer (set-buffer buffer))
860 ;; As a vector, we have no filename. Perhaps it is a
862 (when (and (<= end (point-max))
863 (pos-visible-in-window-p
864 start (get-buffer-window (current-buffer) 'visible)))
866 (when (re-search-forward
867 (regexp-quote (semantic-tag-name tag))
869 ;; This is likely it, give it a try.
870 (pulse-momentary-highlight-region
871 start (if (<= end (point-at-eol)) end
873 semantic-idle-symbol-highlight-face)))
877 (define-semantic-idle-service semantic-idle-local-symbol-highlight
878 "Highlight the tag and symbol references of the symbol under point.
879 Call `semantic-analyze-current-context' to find the reference tag.
880 Call `semantic-symref-hits-in-region' to identify local references."
882 (when (semantic-idle-summary-useful-context-p)
884 (semanticdb-without-unloaded-file-searches
885 (semantic-analyze-current-context)))
886 (Hbounds (when ctxt (oref ctxt bounds)))
887 (target (when ctxt (car (reverse (oref ctxt prefix)))))
888 (tag (semantic-current-tag))
889 ;; We use pulse, but we don't want the flashy version,
890 ;; just the stable version.
893 ;; Highlight the original tag? Protect against problems.
895 (semantic-idle-symbol-maybe-highlight target)
897 ;; Identify all hits in this current tag.
898 (when (semantic-tag-p target)
899 (require 'semantic/symref/filter)
900 (semantic-symref-hits-in-region
901 target (lambda (start end prefix)
902 (when (/= start (car Hbounds))
903 (pulse-momentary-highlight-region
904 start end semantic-idle-symbol-highlight-face))
905 (semantic-throw-on-input 'symref-highlight)
907 (semantic-tag-start tag)
908 (semantic-tag-end tag)))
913 (define-minor-mode global-semantic-idle-scheduler-mode
914 "Toggle global use of option `semantic-idle-scheduler-mode'.
915 The idle scheduler will automatically reparse buffers in idle time,
916 and then schedule other jobs setup with `semantic-idle-scheduler-add'.
917 If ARG is positive or nil, enable, if it is negative, disable."
920 :group 'semantic-modes
921 ;; When turning off, disable other idle modes.
922 (when (null global-semantic-idle-scheduler-mode)
923 (global-semantic-idle-summary-mode -1)
924 (global-semantic-idle-local-symbol-highlight-mode -1)
925 (global-semantic-idle-completions-mode -1))
926 (semantic-toggle-minor-mode-globally
927 'semantic-idle-scheduler-mode
928 (if global-semantic-idle-scheduler-mode 1 -1)))
931 ;;; Completion Popup Mode
933 ;; This mode uses tooltips to display a (hopefully) short list of possible
934 ;; completions available for the text under point. It provides
935 ;; NO provision for actually filling in the values from those completions.
936 (defun semantic-idle-completions-end-of-symbol-p ()
937 "Return non-nil if the cursor is at the END of a symbol.
938 If the cursor is in the middle of a symbol, then we shouldn't be
939 doing fancy completions."
940 (not (looking-at "\\w\\|\\s_")))
942 (defun semantic-idle-completion-list-default ()
943 "Calculate and display a list of completions."
944 (when (and (semantic-idle-summary-useful-context-p)
945 (semantic-idle-completions-end-of-symbol-p))
946 ;; This mode can be fragile, hence don't raise errors, and only
947 ;; report problems if semantic-idle-scheduler-verbose-flag is
948 ;; non-nil. If something doesn't do what you expect, run the
949 ;; below command by hand instead.
951 (semanticdb-without-unloaded-file-searches
953 (semantic-complete-analyze-inline-idle)
956 (when semantic-idle-scheduler-verbose-flag
957 (message " %s" (error-message-string err)))))
960 (define-semantic-idle-service semantic-idle-completions
961 "Toggle Semantic Idle Completions mode.
962 With ARG, turn Semantic Idle Completions mode on if ARG is
963 positive, off otherwise.
965 This minor mode only takes effect if Semantic is active and
966 `semantic-idle-scheduler-mode' is enabled.
968 When enabled, Emacs displays a list of possible completions at
969 idle time. The method for displaying completions is given by
970 `semantic-complete-inline-analyzer-idle-displayor-class'; the
971 default is to show completions inline.
973 While a completion is displayed, RET accepts the completion; M-n
974 and M-p cycle through completion alternatives; TAB attempts to
975 complete as far as possible, and cycles if no additional
976 completion is possible; and any other command cancels the
979 \\{semantic-complete-inline-map}"
980 ;; Add the ability to override sometime.
981 (semantic-idle-completion-list-default))
984 ;;; Breadcrumbs for tag under point
986 ;; Service that displays a breadcrumbs indication of the tag under
987 ;; point and its parents in the header or mode line.
990 (defcustom semantic-idle-breadcrumbs-display-function
991 #'semantic-idle-breadcrumbs--display-in-header-line
992 "Function to display the tag under point in idle time.
993 This function should take a list of Semantic tags as its only
994 argument. The tags are sorted according to their nesting order,
995 starting with the outermost tag. The function should call
996 `semantic-idle-breadcrumbs-format-tag-list-function' to convert
997 the tag list into a string."
1000 (const :tag "Display in header line"
1001 semantic-idle-breadcrumbs--display-in-header-line)
1002 (const :tag "Display in mode line"
1003 semantic-idle-breadcrumbs--display-in-mode-line)
1004 (function :tag "Other function")))
1006 (defcustom semantic-idle-breadcrumbs-format-tag-list-function
1007 #'semantic-idle-breadcrumbs--format-linear
1008 "Function to format the list of tags containing point.
1009 This function should take a list of Semantic tags and an optional
1010 maximum length of the produced string as its arguments. The
1011 maximum length is a hint and can be ignored. When the maximum
1012 length is omitted, an unconstrained string should be
1013 produced. The tags are sorted according to their nesting order,
1014 starting with the outermost tag. Single tags should be formatted
1015 using `semantic-idle-breadcrumbs-format-tag-function' unless
1016 special formatting is required."
1019 (const :tag "Format tags as list, innermost last"
1020 semantic-idle-breadcrumbs--format-linear)
1021 (const :tag "Innermost tag with details, followed by remaining tags"
1022 semantic-idle-breadcrumbs--format-innermost-first)
1023 (function :tag "Other function")))
1025 (defcustom semantic-idle-breadcrumbs-format-tag-function
1026 #'semantic-format-tag-abbreviate
1027 "Function to call to format information about tags.
1028 This function should take a single argument, a Semantic tag, and
1029 return a string to display.
1030 Some useful functions are found in `semantic-format-tag-functions'."
1032 :type semantic-format-tag-custom-list)
1034 (defcustom semantic-idle-breadcrumbs-separator 'mode-specific
1035 "Specify how to separate tags in the breadcrumbs string.
1036 An arbitrary string or a mode-specific scope nesting
1037 string (like, for example, \"::\" in C++, or \".\" in Java) can
1041 (const :tag "Use mode specific separator"
1043 (string :tag "Specify separator string")))
1045 (defcustom semantic-idle-breadcrumbs-header-line-prefix
1046 semantic-stickyfunc-indent-string ;; TODO not optimal
1047 "String used to indent the breadcrumbs string.
1048 Customize this string to match the space used by scrollbars and
1053 (defvar semantic-idle-breadcrumbs-popup-menu nil
1054 "Menu used when a tag displayed by `semantic-idle-breadcrumbs-mode' is clicked.")
1056 (defun semantic-idle-breadcrumbs--popup-menu (event)
1057 "Popup a menu that displays things to do to the clicked tag.
1058 Argument EVENT describes the event that caused this function to
1061 (let ((old-window (selected-window))
1062 (window (semantic-event-window event)))
1063 (select-window window t)
1064 (semantic-popup-menu semantic-idle-breadcrumbs-popup-menu)
1065 (select-window old-window)))
1067 (defmacro semantic-idle-breadcrumbs--tag-function (function)
1068 "Return lambda expression calling FUNCTION when called from a popup."
1071 (let* ((old-window (selected-window))
1072 (window (semantic-event-window event))
1073 (column (car (nth 6 (nth 1 event)))) ;; TODO semantic-event-column?
1075 (select-window window t)
1077 (text-properties-at column header-line-format)
1080 (select-window old-window)))
1083 ;; TODO does this work for mode-line case?
1084 (defvar semantic-idle-breadcrumbs-popup-map
1085 (let ((map (make-sparse-keymap)))
1086 ;; mouse-1 goes to clicked tag
1088 [ header-line mouse-1 ]
1089 (semantic-idle-breadcrumbs--tag-function
1090 semantic-go-to-tag))
1091 ;; mouse-3 pops up a context menu
1093 [ header-line mouse-3 ]
1094 'semantic-idle-breadcrumbs--popup-menu)
1096 "Keymap for semantic idle breadcrumbs minor mode.")
1099 semantic-idle-breadcrumbs-popup-menu
1100 semantic-idle-breadcrumbs-popup-map
1101 "Semantic Breadcrumbs Mode Menu"
1107 (semantic-idle-breadcrumbs--tag-function
1110 :help "Jump to this tag"))
1111 ;; TODO these entries need minor changes (optional tag argument) in
1112 ;; senator-copy-tag etc
1113 ;; (semantic-menu-item
1116 ;; (semantic-idle-breadcrumbs--tag-function
1117 ;; senator-copy-tag)
1119 ;; :help "Copy this tag"))
1120 ;; (semantic-menu-item
1123 ;; (semantic-idle-breadcrumbs--tag-function
1124 ;; senator-kill-tag)
1126 ;; :help "Kill tag text to the kill ring, and copy the tag to
1128 ;; (semantic-menu-item
1130 ;; "Copy Tag to Register"
1131 ;; (semantic-idle-breadcrumbs--tag-function
1132 ;; senator-copy-tag-to-register)
1134 ;; :help "Copy this tag"))
1135 ;; (semantic-menu-item
1138 ;; (semantic-idle-breadcrumbs--tag-function
1139 ;; senator-narrow-to-defun)
1141 ;; :help "Narrow to the bounds of the current tag"))
1142 ;; (semantic-menu-item
1145 ;; (semantic-idle-breadcrumbs--tag-function
1146 ;; senator-fold-tag-toggle)
1149 ;; :selected '(let ((tag (semantic-current-tag)))
1150 ;; (and tag (semantic-tag-folded-p tag)))
1151 ;; :help "Fold the current tag to one line"))
1155 "About this Header Line"
1158 (describe-function 'semantic-idle-breadcrumbs-mode))
1160 :help "Display help about this header line."))
1164 (define-semantic-idle-service semantic-idle-breadcrumbs
1165 "Display breadcrumbs for the tag under point and its parents."
1166 (let* ((scope (semantic-calculate-scope))
1168 ;; If there is a scope, extract the tag and its
1170 (append (oref scope parents)
1171 (when (oref scope tag)
1172 (list (oref scope tag))))
1173 ;; Fall back to tags by overlay
1174 (semantic-find-tag-by-overlay))))
1175 ;; Display the tags.
1176 (funcall semantic-idle-breadcrumbs-display-function tag-list)))
1178 (defun semantic-idle-breadcrumbs--display-in-header-line (tag-list)
1179 "Display the tags in TAG-LIST in the header line of their buffer."
1180 (let ((width (- (nth 2 (window-edges))
1181 (nth 0 (window-edges)))))
1182 ;; Format TAG-LIST and put the formatted string into the header
1184 (setq header-line-format
1185 (replace-regexp-in-string ;; Since % is interpreted in the
1186 "\\(%\\)" "%\\1" ;; mode/header line format, we
1187 (concat ;; have to escape all occurrences.
1188 semantic-idle-breadcrumbs-header-line-prefix
1190 (semantic-idle-breadcrumbs--format-tag-list
1193 (length semantic-idle-breadcrumbs-header-line-prefix)))
1197 'font-lock-comment-face))))))
1199 ;; Update the header line.
1200 (force-mode-line-update))
1202 (defun semantic-idle-breadcrumbs--display-in-mode-line (tag-list)
1203 "Display the tags in TAG-LIST in the mode line of their buffer.
1204 TODO THIS FUNCTION DOES NOT WORK YET."
1206 (error "This function does not work yet")
1208 (let ((width (- (nth 2 (window-edges))
1209 (nth 0 (window-edges)))))
1210 (setq mode-line-format
1211 (replace-regexp-in-string ;; see comment in
1212 "\\(%\\)" "%\\1" ;; `semantic-idle-breadcrumbs--display-in-header-line'
1213 (semantic-idle-breadcrumbs--format-tag-list tag-list width))))
1215 (force-mode-line-update))
1217 (defun semantic-idle-breadcrumbs--format-tag-list (tag-list max-length)
1218 "Format TAG-LIST using configured functions respecting MAX-LENGTH.
1219 If the initial formatting result is longer than MAX-LENGTH, it is
1220 shortened at the beginning."
1221 ;; Format TAG-LIST using the configured formatting function.
1222 (let* ((complete-format (funcall
1223 semantic-idle-breadcrumbs-format-tag-list-function
1224 tag-list max-length))
1225 ;; Determine length of complete format.
1226 (complete-length (length complete-format)))
1227 ;; Shorten string if necessary.
1228 (if (<= complete-length max-length)
1233 (- complete-length (- max-length 4))))))
1236 (defun semantic-idle-breadcrumbs--format-linear
1237 (tag-list &optional max-length)
1238 "Format TAG-LIST as a linear list, starting with the outermost tag.
1239 MAX-LENGTH is not used."
1240 (require 'semantic/analyze/fcn)
1241 (let* ((format-pieces (mapcar
1242 #'semantic-idle-breadcrumbs--format-tag
1244 ;; Format tag list, putting configured separators between the
1246 (complete-format (cond
1247 ;; Mode specific separator.
1248 ((eq semantic-idle-breadcrumbs-separator
1250 (semantic-analyze-unsplit-name format-pieces))
1252 ;; Custom separator.
1253 ((stringp semantic-idle-breadcrumbs-separator)
1257 semantic-idle-breadcrumbs-separator)))))
1261 (defun semantic-idle-breadcrumbs--format-innermost-first
1262 (tag-list &optional max-length)
1263 "Format TAG-LIST placing the innermost tag first, separated from its parents.
1264 If MAX-LENGTH is non-nil, the innermost tag is shortened."
1265 (let* (;; Separate and format remaining tags. Calculate length of
1266 ;; resulting string.
1267 (rest-tags (butlast tag-list))
1268 (rest-format (if rest-tags
1271 (semantic-idle-breadcrumbs--format-linear
1274 (rest-length (length rest-format))
1275 ;; Format innermost tag and calculate length of resulting
1277 (inner-format (semantic-idle-breadcrumbs--format-tag
1278 (car (last tag-list))
1279 #'semantic-format-tag-prototype))
1280 (inner-length (length inner-format))
1281 ;; Calculate complete length and shorten string for innermost
1282 ;; tag if MAX-LENGTH is non-nil and the complete string is
1284 (complete-length (+ inner-length rest-length))
1285 (inner-short (if (and max-length
1286 (<= complete-length max-length))
1292 (- complete-length max-length)
1295 ;; Concat both parts.
1296 (concat inner-short rest-format))
1299 (defun semantic-idle-breadcrumbs--format-tag (tag &optional format-function)
1300 "Format TAG using the configured function or FORMAT-FUNCTION.
1301 This function also adds text properties for help-echo, mouse
1302 highlighting and a keymap."
1303 (let ((formatted (funcall
1305 semantic-idle-breadcrumbs-format-tag-function)
1307 (add-text-properties
1308 0 (length formatted)
1316 mouse-1: jump to tag
1317 mouse-3: popup context menu"
1318 (semantic-tag-name tag)
1319 (semantic-tag-class tag))
1323 semantic-idle-breadcrumbs-popup-map)
1328 (provide 'semantic/idle)
1331 ;; generated-autoload-file: "loaddefs.el"
1332 ;; generated-autoload-load-name: "semantic/idle"
1335 ;;; semantic/idle.el ends here