Function: semantic-highlight-func-mode

semantic-highlight-func-mode is an autoloaded, interactive and byte-compiled function defined in util-modes.el.gz.

Signature

(semantic-highlight-func-mode &optional ARG)

Documentation

Minor mode to highlight the first line of the current tag.

Enables/disables making the current function's first line light up. A function (or other tag class specified by semantic-stickyfunc-sticky-classes) is highlighted, meaning the first line which describes the rest of the construct.

This is a minor mode. If called interactively, toggle the Semantic-Highlight-Func 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-highlight-func-mode(var)/semantic-highlight-func-mode(fun).

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

See semantic-stickyfunc-mode(var)/semantic-stickyfunc-mode(fun) for putting a function in the header line. This mode recycles the stickyfunc configuration classes list.

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/util-modes.el.gz
;;;###autoload
(define-minor-mode semantic-highlight-func-mode
  "Minor mode to highlight the first line of the current tag.
Enables/disables making the current function's first line light up.
A function (or other tag class specified by
`semantic-stickyfunc-sticky-classes') is highlighted, meaning the
first line which describes the rest of the construct.

See `semantic-stickyfunc-mode' for putting a function in the
header line.  This mode recycles the stickyfunc configuration
classes list.

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 ;; Don't need indicator.  It's quite visible.
  (if semantic-highlight-func-mode
      (progn
	(unless (and (featurep 'semantic) (semantic-active-p))
	  ;; Disable minor mode if semantic stuff not available
	  (setq semantic-highlight-func-mode nil)
	  (error "Buffer %s was not set up for parsing" (buffer-name)))
	;; Setup our hook
	(add-hook 'post-command-hook
                  #'semantic-highlight-func-highlight-current-tag nil t))
    ;; Disable highlight func mode
    (remove-hook 'post-command-hook
                 #'semantic-highlight-func-highlight-current-tag t)
    (semantic-highlight-func-highlight-current-tag t)))