This group contains settings for the directories-buffer in the ECB:
Add path of a file to
ecb-source-path
if not already contained. This is done during the auto. windows synchronization which happens if a file is opened not via the file/directory-browser of ECB. In such a situation ECB adds the path of the new file auto. toecb-source-path
at least temporally for the current Emacs session. This option defines two things:
- Should only the root-part (which means for Unix-like systems always '/' and for windows-like systems the drive) of the new file be added as source-path to
ecb-source-path
or the whole directory-part?- Should this path be added for future sessions too?
The value of this option is a cons-cell where the car is a boolean for 1. and the cdr is a boolean for 2.
A value of not nil for the car (1.) is reasonably if a user often opens files not via the ECB-browser which are not located in any of the paths of
ecb-source-path
because then only one path for each drive (windows) or the root-path (Unix) is added to the directory buffer of ECB.
Automatically expand the directory tree to the current source file. There are three options:
best
: Expand the best-matching source-pathfirst
: Expand the first matching source-pathnil
: Do not automatically expand the directory tree.
Cache contents of directories.
This can be useful if
ecb-source-path
contains directories with many files and subdirs, especially if these directories are mounted net-drives (“many” means here something > 500, dependent of the speed of the net-connection and the machine). For these directories actualizing the sources- and/or directories- buffer of ECB (if displayed in current layout!) can slow down dramatically so a caching increases speed a lot.The value of this option is a list where each element is a cons-cell and looks like:
(<dir-regexp> . <filenumber threshold>) with
<dir-regexp>:
- Regular expression a directory must match to be cached.
<filenumber threshold>:
- Number of directory contents must exceed this number.
A directory will only be cached if and only if the directory-name matches at least one rexexp of this option and its content-number exceeds the related threshold AND the directory-name matches NOT any regexp of
ecb-cache-directory-contents-not
!The cache entry for a certain directory will be refreshed and actualized only by using the POWER-click (see
ecb-primary-secondary-mouse-buttons
) in the directories-buffer of ECB (see Using the mouse).Examples:
A value of
(("/usr/home/john_smith/bigdir*" . 1000))
means the contents of every subdirectory of the home-directory of John Smith will be cached if the directory contains more than 1000 entries and its name begins with “bigdir”.A value of
((".*" . 1000))
caches every directory which has more than 1000 entries.A value of
((".*" . 0))
caches every directory regardless of the number of entries."Please note: If you want your home-dir being cached then you MUST NOT use “~” because ECB tries always to match full path-names!
Do not cache the contents of certain directories. The value of this option is a list where the each element is a regular expression a directory must match if it should not being cached.
If a directory-name matches at least one of the regexps of this option the directory-contents will never being cached. See
ecb-cache-directory-contents
to see when a directory will be cached.This option can be useful when normally all directories with a certain amount of content (files and subdirs) should be cached but some special directories not. This can be achieved by:
- Setting
ecb-cache-directory-contents
to ((“.*” . 500)): Caches all directories with more then 500 entries- Setting
ecb-cache-directory-contents-not
to a value which matches these directories which should not being cached (e.g. (“/usr/home/john_smith”) excludes the HOME-directory of John Smith from being cached).Please note: If you want your home-dir exclude from being cached then you MUST NOT use “~” because ECB tries always to match full path-names!
Local hook running after the creation of the directories-buffer. Every function of this hook is called once without arguments direct after creating the directories-buffer of ECB and it's local key-map. So for example a function could be added which performs calls of
local-set-key
to define new keybindings only for the directories-buffer of ECB.The following keys must not be rebind in the directories-buffer: F2, F3 and F4
Name of the ECB directory buffer. Because it is not a normal buffer for editing you should enclose the name with stars, e.g. “ *ECB Directories*”.
If it is necessary for you you can get emacs-lisp access to the buffer-object of the ECB-directory-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!
Function which re-sorts the menu-entries of the directories buffer.
If a function then this function is called to re-arrange the menu-entries of the combined menu-entries of the user-menu-extensions of
ecb-directories-menu-user-extension
and the built-in-menuecb-directories-menu
. If nil then no special sorting will be done and the user-extensions are placed in front of the built-in-entries.The function get one argument, a list of menu-entries. For the format of this argument see
ecb-directories-menu-user-extension
. The function must return a new list in the same format. Of course this function can not only re-arrange the entries but also delete entries or add new entries.
Static user extensions for the popup-menu of the directories buffer. Value is a list of elements of the following type: Each element defines a new menu-entry and is either:
- Menu-command: A list containing two sub-elements, whereas the first is the function (a function symbol) being called if the menu-entry is selected and the second is the name of the menu-entry.
- Separator: A one-element-list and the element is the string “—”: Then a non-selectable menu-separator is displayed.
- Submenu: A list where the first element is the title of the submenu displayed in the main-menu and all other elements are either menu-commands (see 1) or separators (see 2) or another submenu (see c). This allows deep nested menu-submenu-structures. Currently a level of 4 is allowed but in general there could be an infinite depth of nesting but it makes no sense - if possible at all - to define infinite nested defcustom-types. So there is a limit of 4 levels but tis is not a hard limit: Just increase the value of the
ecb-max-submenu-depth
BEFORE first loading ECB!The function of a menu-command must follow the following guidelines: Such a function must be defined with the macro
tree-buffer-defpopup-command
! This macro defines a new popup-command whereas the newly defined command gets one argument NODE. See the docstring oftree-buffer-defpopup-command
for further details.Example for the definition of such a menu-function:
(tree-buffer-defpopup-command ecb-my-special-dir-popup-function "Prints the name of the directory of the node under point." (let ((node-data=dir (tree-node-get-data node))) (message ``Dir under node: %s'' node-data=dir)))Per default the static user-extensions are added at the beginning of the built-in menu-entries of
ecb-directories-menu
but the whole menu can be re-arranged withecb-directories-menu-sorter
.These menu-extensions are static. A dynamic menu-extension can be achieved via
ecb-directories-menu-user-extension-function
.
Dynamic user extensions for the popup-menu of the directories buffer. A function which has to return a list in the same format like the option
ecb-directories-menu-user-extension
. This function is called when the user opens the popup-menu for the directories buffer.Per default the dynamic user-extensions are added in front of the static extensions of
ecb-directories-menu-user-extension
but the whole menu can be re-arranged withecb-directories-menu-sorter
.
Automatically display current default-directory after activating ECB.
If a file-buffer is displayed in the current active edit-window then ECB synchronizes its tree-buffers to this file-buffer - at least if the option
ecb-window-sync
it not nil. So for this situationecb-display-default-dir-after-start
takes no effect but this option is for the case if no file-buffer is displayed in the edit-window after startup:If true then ECB selects autom. the current default-directory after activation even if no file-buffer is displayed in the current active edit-window. This is useful if ECB is autom. activated after startup of Emacs and Emacs is started without a file-argument. So the directory from which the startup has performed is auto. selected in the ECB-directories buffer and the ECB-sources buffer displays the contents of this directory.
Directories that should not be included in the directories list. The value of this variable should be a list of regular expression.
ECB does this so directories are displayed as empty in the directories-buffer even without user-interaction (i.e. in previous ECB-versions the emptyness of a directory has been first checked when the user has clicked onto a directory). ECB optimizes this check as best as possible but if a directory contains a lot of subdirectories which contain in turn a lot of entries, then expanding such a directory or selecting it takes of course more time as without this check - at least at the first time (all following selects of a directory uses the cached information if its subdirectories are empty or not). Therefore this feature can be switched of via this option."
Paths where to find code sources. Each path can have an optional alias that is used as it's display name. If no alias is set, the path is used as display name.
If true then uses speedbar for directories, sources or methods. This means that speedbar is integrated in the ECB-frame and is displayed in that window normally displaying the standard ECB-directories-buffer, ECB-sources-buffer or ECB-methods-buffer.
This option takes effect in all layouts which contain either a directory window, a sources window or a method window.
This option can have four valid values:
nil
: Do not use speedbar (default)dir
: Use speedbar instead of the standard directories-buffersource
: Use speedbar instead of the standard sources-buffermethod
: Use speedbar instead of the standard methods-bufferNote: For directories and sources a similar effect and usability is available by setting this option to
nil
(ormethod
) and settingecb-show-sources-in-directories-buffer
to notnil
, because this combination displays also directories and sources in one window.
ecb-use-speedbar-instead-native-tree-buffer
is for people who like the speedbar way handling directories and source-files or methods and want it in conjunction with ECB.