The code browser requires Exuberant C Tags version 5.5 or later. You can find it at http://ctags.sourceforge.net. NOTE: The standard ctags program found on many systems is NOT sufficient!!!
The path of the ctags program needs to be
set in the Plugin Options for the Code Browser plugin. A typical choice on
Unix-like systems is /usr/local/bin/ctags
, and on windows
systems c:\Apps\ctags51\ctags.exe
.
Once the ctags path is set, the code browser plugin will parse a file whenever a buffer displaying the file is selected, or when the current buffer is saved. Please note that only the file on disk is parsed, not the in-memory contents of the buffer.
Simply click on any function, variable declaration etc. displayed in the code browser, and the buffer will be positioned accordingly. As regular expressions are used, code browser will be able to find definitions even in modified files as long as the line on which the definition occured was not changed. Tooltips show the contents of the line, which depending on language and style may include more information.
Right-clicking on any function, variable declaration etc. will bring up a context menu with these choices:
Insert at Caret: Inserts the selected term in the current text view.
Hypersearch: Perform a hypersearch with this term.
Copy to pasteboard: Copies the selected term to the paste board.
Append to pasteboard: Appends the selected term to the pasteboard.
The Options menu button above the Code Browser section lets you select a few options:
Auto-parse: When checked, buffers are parsed automatically when saved or when you switch to another buffer. When un-checked, buffers will only be parsed when you click on the Parse button. That can be helpful when you work with extremely large files, where parsing requires some time.
Sort: When checked, all listed tags will be sorted.
Auto-unfold: When checked, any section in the code you jump to will be unfolded automatically.
Auto-close dock: After selecting a tag the dock is automatically closed