ecb-symboldef - ECB - the Emacs Code Browser
Description: ECB - the Emacs Code Browser

Next: ecb-layout, Previous: ecb-analyse, Up: Customizable options

#### 7.3.8 Group ecb-analyse

— User Option: symboldef-buffer-name

> Name of the ECB-symbol-definition buffer. Because it is not a normal buffer for editing you should enclose the name with stars, e.g. “*ECB Symboldefinition*”.

> If it is necessary for you you can get emacs-lisp access to the buffer-object of the ECB-symbol-definition-buffer by this name, e.g. by a call of `set-buffer`.

> Changes for this option at runtime will take affect only after deactivating and then activating ECB again!

— User Option: symboldef-buffer-sync

> Synchronize the symboldef buffer automatically with current edit buffer.

> If `always` then the synchronization takes place always a buffer changes in the edit window, if nil then never. If a list of major-modes then only if the `major-mode` of the new buffer belongs NOT to this list.

> If the special value `basic` is set then ECB uses the setting of the option `ecb-basic-buffer-sync`.

> IMPORTANT NOTE: Every time the synchronization is done the hook `ecb-symboldef-buffer-sync-hook` is evaluated.

— User Option: symboldef-buffer-sync-delay

> Time Emacs must be idle before the symboldef-buffer is synchronized. Synchronizing is done with the current source displayed in the edit window. If nil then there is no delay, means synchronization takes place immediately. A small value of about 0.25 seconds saves CPU resources and you get even though almost the same effect as if you set no delay.

> If the special value 'basic is set then ECB uses the setting of the option `ecb-basic-buffer-sync-delay`.

— User Option: symboldef-buffer-sync-hook

> ook run at the end of the function `ecb-symboldef-buffer-sync`. See documentation of `ecb-symboldef-buffer-sync` for conditions when synchronization takes place and so in turn these hooks are evaluated.

> Preconditions for such a hook:

> - Current buffer is the buffer of the currently selected edit-window.
> - The symboldef-buffer is displayed in a visible window of the ecb-frame (so no check for visibilty of the symboldef-buffer in the ecb-frame is necessary in a hook function)

> Postcondition for such a hook: Point must stay in the same edit-window as before evaluating the hook.

> Important note: If the option `ecb-symboldef-buffer-sync` is not nil the function `ecb-symboldef-buffer-sync` is running either every time Emacs is idle or even after every command (see `ecb-symboldef-buffer-sync-delay`). So if the symboldef-buffer is displayed in a window of the ecb-frame (see preconditions above) these hooks can be really called very often! Therefore each function of this hook should/must check in an efficient way at beginning if its task have to be really performed and then do them only if really necessary! Otherwise performance of Emacs could slow down dramatically!

— User Option: symboldef-find-functions

> Funtions to find the definition for current symbol under point. This functionality is set on a major-mode base, i.e. for every major-mode a different setting can be used. The value of this option is a list of cons-cells:

> - The car is either a major-mode symbol or the special symbol 'default which means if no setting for a certain major-mode is defined then the cdr of the 'default cons-cell is used.
> - The car is a function intended to find the definition of a certain symbol for files of this major-mode. Such a function will be called with two arguments, the first is the symbol-name as string for which the definition should be displayed and the second the current edit-buffer as buffer-object, i.e. the current buffer of the current edit-window. The function will be called with the special ecb-symbol-definition-buffer as current buffer whereas this buffer is empty. The function has to insert everything necessary to display the symbol-definition and is also responsible to format the displayed text. The buffer-local variable `fill-column is already preset to the window-width of the special ecb-window minus 1. The function is responsible to set the buffer-local variable `truncate-lines` appropriate. The function can either return nil or a string which will be integrated in the modeline-display of this ecb-window.

> There are two prefined functions `ecb-symboldef-find-lisp-doc` and `ecb-symboldef-find-definition` whereas the latter on is used a default find-function.

— User Option: symboldef-minimum-symbol-length

> Minimum length a symbol must have so its definition or doc is displayed.