Function: semantic-idle-scheduler-mode

semantic-idle-scheduler-mode is an interactive and byte-compiled function defined in idle.el.gz.

Signature

(semantic-idle-scheduler-mode &optional ARG)

Documentation

Minor mode to auto parse buffer following a change.

When this mode is off, a buffer is only rescanned for tokens when some command requests the list of available tokens. When idle-scheduler is enabled, Emacs periodically checks to see if the buffer is out of date, and reparses while the user is idle (not typing.)

This is a minor mode. If called interactively, toggle the Semantic-Idle-Scheduler mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate semantic-idle-scheduler-mode(var)/semantic-idle-scheduler-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

The minor mode can be turned on only if semantic feature is available and the current buffer was set up for parsing. Return non-nil if the minor mode is enabled.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/cedet/semantic/idle.el.gz
;;;###autoload
(define-minor-mode semantic-idle-scheduler-mode
  "Minor mode to auto parse buffer following a change.
When this mode is off, a buffer is only rescanned for tokens when
some command requests the list of available tokens.  When idle-scheduler
is enabled, Emacs periodically checks to see if the buffer is out of
date, and reparses while the user is idle (not typing.)

The minor mode can be turned on only if semantic feature is
available and the current buffer was set up for parsing.  Return
non-nil if the minor mode is enabled."
  :lighter nil
  (if semantic-idle-scheduler-mode
      (if (not (and (featurep 'semantic) (semantic-active-p)))
          (progn
            ;; Disable minor mode if semantic stuff not available
            (setq semantic-idle-scheduler-mode nil)
            (error "Buffer %s was not set up idle time scheduling"
                   (buffer-name)))
        (semantic-idle-scheduler-setup-timers))))