File: which-func.el.html
This package prints name of function where your current point is
located in mode line. It assumes that you work with the imenu
package and imenu--index-alist is up to date.
KNOWN BUGS
----------
Really this package shows not "function where the current point is
located now", but "nearest function which defined above the current
point". So if your current point is located after the end of
function FOO but before the beginning of function BAR, FOO will be
displayed in the mode line.
- If two windows display the same buffer, both windows
show the same which-func information.
TODO LIST
---------
1. Dependence on imenu package should be removed. Separate
function determination mechanism should be used to determine the end
of a function as well as the beginning of a function.
2. This package should be realized with the help of overlay
properties instead of the imenu--index-alist variable.
Defined variables (13)
which-func-cleanup-function | Function to transform a string before displaying it in the mode line. |
which-func-format | Format for displaying the function in the mode line. |
which-func-functions | List of functions for ‘which-function’ to call with no arguments. |
which-func-imenu-joiner-function | Function to join together multiple levels of imenu nomenclature. |
which-func-keymap | Keymap to display on mode line which-func. |
which-func-maxout | Don’t automatically compute the Imenu menu if buffer is this big or bigger. |
which-func-mode | Non-nil means display current function name in mode line. |
which-func-modes | List of major modes for which Which Function mode should be used. |
which-func-non-auto-modes | List of major modes where Which Function mode is inactive till Imenu is used. |
which-func-unknown | String to display in the mode line when current function is unknown. |
which-function-imenu-failed | Locally t in a buffer if ‘imenu--make-index-alist’ found nothing there. |
which-function-mode | Non-nil if Which-Function mode is enabled. |
which-function-mode-hook | Hook run after entering or leaving ‘which-function-mode’. |
Defined functions (7)
which-func-ff-hook | () |
which-func-mode | (&optional ARG) |
which-func-update | () |
which-func-update-1 | (WINDOW) |
which-func-update-ediff-windows | () |
which-function | () |
which-function-mode | (&optional ARG) |
Defined faces (1)
which-func | Face used to highlight mode line function names. |