Ctags Source Navigator

This is a Far Manager plugin for browsing source code indexed by Ctags utility.

Useful links

• Plugin Homepage
• Far PlugRing
• Discussion Thread

Features

• Jump to name declaration
• Code completion
• Searching name in entire repository
• Searching name in currently edited file
• Search and open files by name
• Remember your most visited names and files
• Listing class members
• Source code browsing history
• Creating Ctags database for selected repository root
• Reindexing single file or repository.
• Hotkeys macro

What's new

2.1.0.92

• Opening a repository in "Manage Repositories" menu moves you to last visited directory #93
• Navigation history is reworked. "Go back" and "Go forward" options become more convinient #94
• Plugin become more stable. Fixed bugs: #95, #96, #97

2.1.0.86

• Implemented indexing current file (#79)
• Most visited tags goes on top of each menu (#87, #88, #90). This behaviour may be disabled: F11->Ctags Source Navigator->Plugin configuration->Recent tags in the first place
• Plugin become more convinient. Check out renewed "Manage repositories" menu where you can see loaded repositories history, go to repositories and make any repository permanent
• Plugin become a bit faster. Fixed slow search of short names (#85)
• Plugin become more stable. Fixed bugs: #77, #83, #84, #86, #89

2.1.0.68

• Plugin become more stable. Fixed bugs: #70, #71, #75

Installation

1. Download latest release from release page
2. Extract downloaded archive to FarManager/Plugins folder
3. Install hotkeys macro by copying ctags_hotkeys.lua script to %FARPROFILE%\Macros\scripts folder:

   copy ctags_hotkeys.lua "%FARPROFILE%\Macros\scripts"
   

   After copying hotkeys macro restart Far Manager

Use custom ctags utility

You may either install Universal Ctags, Exuberant Ctags or use ctags utility from Cygwin project. Go to F9->Options->Plugins configuration->Ctags Source Navigator, put the full path to ctags.exe in 'Path to ctags.exe' edit box, press OK button.

BTW if you are Lua developer check out Yet Another Lua TAgs

It easily integrates with the plugin. Just download latest release, unzip it and put full path to ctags_wrapper.bat script located in <unpacked_release_folder>\yalta\ctags_wrapper.bat to 'Path to ctags.exe' in plugin configuration menu.

Usage

1. Navigate to source code in not indexed files

You may use the plugin in an opened file even if it is not indexed by ctags utility. Plugin will automatically index currently edited file and let you search names in it

2. Index your repository

If you want to search names and files in entire repository you should index it with the ctags utility. Use ctags plugin to do this: goto your repository folder, navigate cursor to folder you want to index by ctags or navigate to top folder ("..") if you want to index entire repository folder. Press F11->Ctags Source Navigator->Index selected directory. Tags file will be created inside selected folder and all symbols will be automatically loaded in plugin. If you already have a repository indexed by ctags you may load index file ('tags') to tell the plugin that you want to browse this repository. Do either:

• Do not do anything: on attempt to search a name plugin will suggest to load one of the 'tags' files found in parent directories.
• Navigate cursor to the 'tags' file, and just press Enter.
• Navigate cursor to the 'tags' file, press F11->Ctags Source Navigator->Load tags file (the most boring way to load tags).
• Load recently opened 'tags' file. Press F11->Ctags Source Navigator->Load from history and select your tags file.

Now plugin 'knows' about symbols in your repository and you can browse it's source code and lookup names in it.

3. Permanent repositories

By default plugin does not allow to search names from places that are not belong to a certain repository. However this behaviour may be changed by making a repository permanent. Navigate to a repository folder and press F11->Ctags Source Navigator->Add permanent repository. Plugin will suggest you to select one of the tags files which corresponds to a selected repository. To unload permanent repository open menu F11->Ctags Source Navigator->Manage repositories, select permanent repository and then press Ctrl+Del.

4. Go to declaration/definition (Ctrl+F)

Open a file inside your repository folder, navigate to a name you want to search definition/declaration of. Press F11->Ctags Source Navigator->Go to and plugin will automatically move the cursor to declaration of that name. If a name has multiple declarations (e.g. in C++ definition of a name is also a name declaration) plugin will suggest to load one of the declaration

5. Open include file (Ctrl+F)

Open a file inside your repository folder, set cursor to an include file inside angle brackets or to any quoted file path. Press F11->Ctags Source Navigator->Go to and plugin will open the file

6. Autocomplete name (Ctrl+Space)

Start typing name in editor and then press F11->Ctags Source Navigator->Complete symbol

7. Return cursor to previous position (Ctrl+G)

Press F11->Ctags Source Navigator->Go back to return cursor to previous position

8. Return to current position from previous position (Ctrl+D)

If you moved the cursor to a previous position by using "Go Back" option you may return the cursor back. To do this press F11->Ctags Source Navigator->Go forward

9. List all class members

Set cursor on class name and then press F11->Ctags Source Navigator->Class members

10. Search names defined in current file (Ctrl+Shift+X)

Press F11->Ctags Source Navigator->Search name in opened file and begin typing (or insert by Ctrl+V or Shift+Ins) a name you want to search.

11. Search names defined in entire repository (Ctrl+Shift+T)

This option works in plugin main menu and in editor menu. Press F11->Ctags Source Navigator->Search name in entire repository and begin typing (or insert by Ctrl+V or Shift+Ins) a name you want to search.

12. Search indexed file (Ctrl+Shift+R)

This feature is available from main and editor menu: press F11->Ctags Source Navigator->Search file by name and begin typing a file name you want to open. You may specify a partial path to file with a filename to filter search result by location: tests\tags_cache\main.cpp. You may also specify a line number after a colon symbol like my_file.h:1234

14. Filter results in any select menu (Tab - new filter, Esc - return to previous filter, Ctrl+Z - close menu)

You may filter any results and even filter your filtered results in any select menu. Press Tab to begin new filter, Esc or Backspace to return to previous filter and Ctrl+Z to close menu. Regular expressions are supported.

15. Reindex your repository

You may reindex your repository if current code database is outdated. Press F11->Ctags Source Navigator->Reindex repository in main menu or in editor menu and then plugin will suggest you to select one of the tags files which you may reindex. If something goes wrong while reindexing (e.g. reindexing is canceled) plugin will rollback on old tags file.

Default macro hotkeys (available if installed)

Editor hotkeys:

• Go to - Ctrl+F
• Complete name - Ctrl+Space
• Go back - Ctrl+G
• Go forward - Ctrl+D
• Search name in opened file - Ctrl+Shift+X
• Search name in entire repository - Ctrl+Shift+T
• Search file by name - Ctrl+Shift+R

Main menu hotkeys:

• Search name in entire repository - Ctrl+Shift+T
• Search file by name - Ctrl+Shift+R

Contribute

If you have an idea of a cool new feature or you have found a bug please create an issue. Mark this repository with a star if you like the plugin

Source code

The code of this plugin is based on source code of original Ctags Source Navigator plugin. It was planed just to port it for Far3 API however a lot of important bugs were fixed, some functionality reworked, new features were added (and there will be more features!) so I decided to become a maintainer of this project. Thanks to author of the original Ctags Source Navigator plugin whose name is Konstantin Stupnik.