QUICK START GUIDE

This short introduction will briefly guide you through the project setup and the user interface of Sourcetrail. The bullet point lists will tell you what to do:

Short description

Sourcetrail is an interactive source explorer that simplifies navigation in existing source code. Sourcetrail's aim is to give answers to all your questions about your source code. Sourcetrail first indexes your code and gathers data about its structure and then provides you a simple interface consisting of three interactive views, each playing a key role in getting information:

• Search: Use the search field to quickly find and select indexed symbols in your source code. The autocompletion box will instantly provide an overview of all matching results throughout your codebase.
• Graph: The graph displays the structure of your source code. It focuses on the currently selected symbol and directly shows all incoming and outgoing dependencies to other symbols.
• Code: The Code view displays all source locations of the currently selected symbol in a list of code snippets. Clicking on a different source location allows you to change the selection and dig deeper.

Sourcetrail currently supports the languages C/C++ and Java. Much of the UI design is therefore based on these languages and might change as soon as other languages are supported. For more information have a look at supported languages.

Starting up Sourcetrail

Once you installed Sourcetrail successfully you are ready to run the application.

Start Window

On every start of Sourcetrail you are shown the Start Window. It allows for creating new projects or opening existing ones. As long as you haven't unlocked Sourcetrail with a valid license key it is running in Trial mode.

License Key Window

The Enter License Window allows you to enter enter the license key you received via e-mail after purchasing your Sourcetrail license.

Start Window

After entering the license key you are redirected to the Start Window again. Now you can create your own project.

Creating a Project

When creating a new Sourcetrail project you will use the project setup wizard. This wizard splits the setup process into several subsequent steps. Depending on your projects structure and the used build system there are different types for project setup. Choosing the right setup method is important and can make the setup process a lot easier.

Choosing the right project setup

There are different types of setup for each supported programming language. It is currently not possible to create a mixed language project, except for mixed C & C++ projects via a Compilation Database. We will extend to multi-language projects in the future.

Project setup for C/C++

The project setup types for C & C++ are the same.

Are you using CMake or Make?

If you are using CMake or Make as build environment you can export a clang JSON Compilaton Database as compile_commands.json file. A Compilation Database holds all information necessary for building the project, such as source files, include paths and compiler flags. Having a Compilation Database makes project setup within Sourcetrail a lot easier. We recommend using this approach if possible.

Exporting a Compilation Database:

• From CMake by defining the CMAKE_EXPORT_COMPILE_COMMANDS flag. (not supported on for Visual Studio CMake generators)
• For Make projects use Bear. Bear generates a compile_commands.json file during a simulated build process. Bear has been tested on FreeBSD, GNU/Linux and OS X.

If you managed to export a compile_commands.json file, then please continue at Create a project from Compilation Database and come back after you finished creating the project.

Are you using Visual Studio?

If you are using Visual Studio you can continue at Project creation from Visual Studio and export a Compilation Database with our Visual Studio Plugin.

Create empty

If none of the above options apply to your project then please continue at Create an Empty C/C++ Project and come back here as soon as the project is created.

Project setup for Java

Are you using Maven?

If you are using Maven you can continue at Project creation from Maven to automatically setup your project using your Maven configuration.

Create empty If you do not have your project configured using Maven then please continue at Create an Empty Java Project and come back here as soon as the project is created.

Source Indexing

After the project is created, Sourcetrail will ask you whether you want to start indexing. Click Start and wait for the indexing to finish, which might take a little while. The Indexing Dialog and the status bar will give you information about the progress. Otherwise the UI will be empty. Sourcetrail indexes all named symbols and their relationships throughout the provided source files.

After indexing has finished, Sourcetrail will show an overview of all indexed symbols in the graph view and some statistics in the code view.

If the indexing yielded errors, the status view will be shown with a list of errors. You can click on the errors label on the right side of the status bar or on one of the errors in the table to see their location.

UI Intro

As already mentioned Sourcetrail's user interface is split into three main views. Their arrangement can be changed however you wish, you can even detach them from the main window and put them on different screens (see Window Widgets).

The three views show information about the currently selected symbol. The search field provides the name, the graph visualization shows its relationships to other symbols and the code view displays all locations the symbol gets referenced throughout the codebase.

Search Field

The search field allows for easy access to all indexed symbols. Use it to find all the classes and functions you wish to investigate. Apart from that is also holds the UI buttons for navigating back & forward as well as refreshing.

When entering a search query the autocompletion popup will provide you with a concise list of all matching symbols. Note that Sourcetrail uses a fuzzy matching algorithm, that allows you to skip characters while entering a query.

Graph Visualization

The graph visualization displays the currently selected symbol in an active state and all other symbols it shares relationships with. The visualization is made up of nodes and edges.

• Nodes: All named symbols in your source code will be displayed as different nodes, such as functions, classes or files. Nodes with members (like classes) can be expanded to show all their contents, the number at the expansion arrow shows how many members are hidden. Clicking a node will activate it and update all the views to the new selection. Dragging a node can be used to change its position.
• Edges: The relationships between the symbols are displayed as different edges, such as type use, function call or file include. Sometimes edges get bundled together and are displayed as an aggregation edge that shows a number of how many edges it contains. Clicking an edge will highlight its source location in the code view.

Colors:

The different node and edge types are also displayed using different colors. The default color scheme uses this convention:

Color	Node	Edge
gray	types and classes	type use
yellow	functions and methods	calls
blue	variables and fields	variable access

Hatching:

Nodes displayed with a striped hatching, are nodes that were used within your indexed source files, but were not defined. Clicking them shows all locations where they are used, without providing their declaration.

Code View

The code view displays all locations of the currently active symbol within the indexed source files. It does not allow for editing the source code. Syntax highlighting is used to increase readability. Source locations that are surrounded by a box when hovered can be clicked to activate the respective symbol. Active source locations are highlighted.

The source locations are displayed as code snippets, containing the line of interest and extra lines added to the top and bottom to give information about its context. Code snippets are then bundled together into files.

Note: A file can be selected as active symbol by clicking its name in the title bar. By clicking the icons on the right hand side of the title bar, the file can switch between 3 different states:

• Minimized: The file does not show any content
  
• Snippets: The file displays the snippets containing active locations separated by lines.
  
• Maximized: The whole content of the file is visible.
  

For more information please have a look at Code View Files.

Start exploring!

After reading this quick guide, you know the basics of Sourcetrail's user interface and you are able to start exploring your codebase. Sourcetrail will allow you to see your source code from a whole new perspective, by giving you a concise overview of its parts and a faster way of drilling down to its internals, while always maintaining the connection to the implementation details of the actual source code.

For more detailed information please have a look at the much more extensive instruction manual below.

If you have feedback for us, please don't hesitate and let us know by writing to support@sourcetrail.com, we'd be glad to hear from you.

The Sourcetrail team wishes you a good start with our product, lots of saved time, increased productivity and much cleaner code.

INTRODUCTION

About this document

This document is the official documentation of Sourcetrail and explains everything you need to know about working with it.

If you have questions not answered by this document, please write us an e-mail to support@sourcetrail.com.

Supported Languages

C

C support is powered by Clang 3.9. If you have a problem loading C code, please have a look at Clang language compatibility or report a bug at our bug tracker.

C++

C++ support is powered by Clang 3.9. For more Information please visit Clang C++ Status. If you have a problem loading C++ code, please have a look at Clang language compatibility or report a bug at our bug tracker.

Java

Sourcetrail includes Java 8 support which is powered by JavaParser and JavaSymbolSolver. Java support still has some minor issues. If you encounter any of these issues, please let us know by providing a minimal example at our bug tracker.

FAQ

INSTALLATION

On Windows

Download and open the zip file and extract its contents into a temporary folder of your choice. Run the setup.exe and go through the wizard. You can now launch Sourcetrail from your start menu.

On Mac

Download and open the Sourcetrail.dmg file and drag Sourcetrail.app into the applications folder. You can now launch Sourcetrail from your Applications.

On Linux

Download Sourcetrail.tar.gz file and extract it. To start Sourcetrail run the Sourcetrail.sh script. Sourcetrail creates a folder ~/.config/sourcetrail at the first run, this is the folder for Sourcetrail settings. To Install Sourcetrail run the setup/install.sh Script with sudo, it will install Sourcetrail to /opt/sourcetrail and create /usr/bin/sourcetrail symlink.

Data folder

The data folder holds certain files that are used by Sourcetrail to run the program. After following the installation instructions the data folder should be located in the following locations on your platform.

Platform	Location
Windows	C:/Users/You/AppData/Local/Coati Software/Sourcetrail (used for dynamic data and settings) install_directory/Coati Software/Sourcetrail/data (used for static app data)
Mac	~/Library/Application Support/Sourcetrail
Linux	~/.config/sourcetrail

Finding System Header Locations

On Windows

These files usually ship with your compiler. For the Visual Studio IDE the system headers can be found at:

<path_to_visual_studio>/VC/include/

If you don't use the Visual Studio IDE you can also try to find your system headers in a subdirectory of:

C:/Program Files (x86)/Windows Kits/

On Mac

Run this command in your terminal:

gcc -x c++ -v -E /dev/null

You will find the header search paths your compiler uses in the output between these two lines:

#include <...> search starts here:
.
.
.
End of search list.

On Linux

gcc -x c++ -v -E /dev/null

or

clang -x c++ -v -E /dev/null

You will find the header search paths your compiler uses in the output between these two lines:

#include <...> search starts here:
.
.
.
End of search list.

Finding Java Runtime Library Location

The current version of Sourcetrail requires an installation of the Java 8 runtime environment to index any Java project. Make sure that Sourcetrail and your JRE share the same kind or architecture (a 32 bit Sourcetrail requires a 32 bit JRE). To locate the required library file, please refer to the applicable description below.

On Windows

The Java Runtime Library (called jvm.dll) can be found inside of your JRE install folder and looks like this:

<path_to_jre>/bin/client/jvm.dll

On Mac

The Java Runtime Library (called libjli.dylib) can be found inside of your JRE install folder. Run the following command in your terminal to find the location of your default Java installation:

/usr/libexec/java_home

This should give you a path looking like this:

/Library/Java/JavaVirtualMachines/<jdk_version>/Contents/Home

The "libjli.dylib" should be available at:

/Library/Java/JavaVirtualMachines/<jdk_version>/Contents/Home/jre/lib/jli/libjvm.dylib

Insert the full path to libjli.dylib into the Java Path setting in the Preferences Window.

On Linux

The Java Runtime Library (called libjvm.so) can be found inside of your JRE install folder and looks like this:

<path_to_jre>/lib/<arch>/server/libjvm.so

USER INTERFACE

Main Window

Widget Windows

Sourcetrail's three views are organized into Widgets Windows, which can be freely arranged within the Main Window or detached from it. Each Widget Window has a title bar displaying its name and 2 buttons for closing the Widget Window and for detaching it from the Main Window.

Interactions:

• Drag the Widget Window at the title bar to rearrange it within the Main Window, detach it or attach it again.
• Press the "x" icon to close the Widget Window. They can be reopened from the View Menu.
• Press the "□" icon to detach the Widget Window from the Main Window.

Statusbar

The Statusbar is located on the bottom of the Main Window and is used to convey information about Sourcetrail's status and currently running processes to the user.

If indexing yielded errors the status bar will display their count on the right side.

Interactions:

• Click on the error count to display the error locations in the Code View.

Windows

Start Window

On every start of Sourcetrail you are shown the start window. It allows for creating new projects or opening existing ones.

Interactions:

• Clicking New Project will lead you to Project Setup.
• Clicking Open Project will let you open an existing Sourcetrail project by choosing from a file dialog.
• Clicking on one of the Recent Projects will open this project. The list shows a maximum of 7 items ordered by recent first.
• Pressing ESC will close the window.

Path List Box

The Path List Box is a user interface element that is used within the Preferences Window and the Project Setup Wizard. It allows for entering a list of file and directory paths.

If you want to use environment variables you can use either of the following notations.

${VARIABLE_NAME} or %VARIABLE_NAME%

Interactions:

• Click the "+" icon to add a new path line.
• Click the "-" icon to remove a selected path line.
• Click a path line to select it.
• Enter the path by typing on your keyboard
• Click "..." within the path line to open a file dialog for choosing a file or directory path.
• Directly add multiple paths into the box by dropping elements from your filesystem.
• Click the pen icon in the bottom right corner to edit the list as plain text.

Plain Text Editing

By pressing the pen icon in the bottom right corner you can open the plain text edition dialog. It allows you to edit the whole list within a text field. Each line will be one list item.

Interactions:

• Add and remove list items through keyboard interaction.
• Click Cancel to cancel plain text editing.
• Click Save to save your changes to the list.

Preferences Window

The Preferences window lets you define settings for all projects. You can open the Preferences from the menu via Edit/Preferences.

Setting	Description
Font face	Define the font face used throughout the UI
Font size	Set the font size used throughout the UI. It can also be changed with the actions in the View Menu
Tab width	Define the space width of tabs in the code view.
Color scheme	Choose which color scheme Sourcetrail should display. The color schemes are located in data/color_schemes/
Animations	Define if animations are used within the user interface.
Logging	Ticking this box enables logging to console and to a log file. This option is disabled by default to speed up Sourcetrail. If you encounter problems while running Sourcetrail, we recommend to enable this option so you have somewhere to start looking for a cause.
Indexer Logging	When enabled Sourcetrail will log detailed information during indexing. This log data can help us fix issues.
Scroll Speed	Define a multiplyer for the default scroll speed. Values smaller than 1 slow down scrolling while values greater than 1 increase the scroll speed.
Graph Zoom	Switch the default mouse wheel behavior in the graph between scrolling and zooming.
Indexer threads	Define how many parallel threads are used during indexing. Setting this value to 0 will cause Sourcetrail to detect the number of available CPU cores and use as many threads for indexing.
Multi process C/C++ indexing	Enable C/C++ indexer threads to run in a different process. This prevents the application from crashing due to unforseen exceptions while indexing.
Sourcetrail Port	Port number that Sourcetrail uses to listen for incoming messages from plugins.
Plugin Port	Port number that Sourcetrail sends outgoing messages to.
Java Path	If you want to use Sourcetrail on Java source code, please specify a path to your Java 8 runtime library. Please keep in mind that a 32 bit Sourcetrail requires a 32 bit version of Java while a 64 bit Sourcetrail requires a 64 bit Java to be working correctly. You can either use the button below for automatic detection or add the path manually. For instructions on how to find your Java runtime path see Finding Java Runtime Library Location.
JVM Maximum Memory	Specify the maximum amount of memory that should be allocated by the indexer's JVM. A value of -1 ignores this setting.
Maven Path	Only required for indexing projects using Maven. Provide the location of your installed Maven executable. You can also use the auto detection.
Global Include Paths	Set header search paths that are used for all of your projects (e.g. std headers). An option for automatic detection of these paths is available for Clang, GCC and the Visual Studio compiler. For instructions on how to add paths manually see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations.
Global Framework Search Paths	Mac only. Define the search paths for .framework files for all of your projects. An option for automatic detection of these paths is available for Clang and GCC. For instructions on how to add paths see Path List Box.

Project Setup Wizard

The Project Setup Wizard consists of a sequence of windows that let you create a new Sourcetrail project. After selecting the programming language for your project Sourcetrail offers several ways for you to provide all the required information.

Interactions:

• Select the language used in code project.
• Selecting a project type will determine how you enter all the required information.
• Clicking Cancel or pressing ESC will close the window.
• Clicking Next will take you to the next step of the setup process.

Create an Empty C/C++ Project

This is the way to go if you just have some source files you want to index. In case you have a build instructions file, you might want to check out one of the other options for project setup described below.

Project Meta Data

In the first step you need to enter meta information about the project.

Setting	Description
Sourcetrail Project Name	The name of the project. This will also be the name of the .srctrlprj file generated by Sourcetrail.
Sourcetrail Project Location	Choose the location of the project file from the dialog.
Standard	Select the language standard that should be used for indexing your project. Usually the most recent language standard is preselected here. (See Language Support)

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Indexed Paths

Provide the paths that contain your project's files. Sourcetrail will index all the source and header files in the specified paths, including subdirectories.

Setting	Description
Indexed Paths	Specify one or multiple locations that contain all the source and header files that you want to index with Sourcetrail. (For instructions on how to add paths see Path List Box.)
Source File Extensions	Define the valid extensions for source files including the dot e.g. .cpp

Interactions:

• Clicking show files will display a list of all the files Sourcetrail will index with the current settings.
• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Include Paths

Sourcetrail needs you to specify all the include paths the indexed source and header files rely on. The include paths are those paths your project's #include directives are relative to. If your project requires additional includes to compile (e.g. Boost for C++, etc.), please specify their location here.

Additionally you can also specify Global Include Paths, which will be used by all your projects. These are usually the paths to system headers, which can also be auto detected by choosing a compiler below and pressing detect.

Setting	Description
Include Paths	These paths are used to find the files specified by #include directives. (For instructions on how to add paths see Path List Box.)
Lazy Include Search (deprecated)	(Only visible in projects created before Sourcetrail 0.11) When checked Sourcetrail also looks for included files within the project paths and all their subdirectories. Use this option if you are not familiar with the project to save yourself from figuring the projects include paths. Warning: When activated indexing speed is slower.
Global Include Paths	These Header Search Paths will be used in all your projects. (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations)

Interactions:

• Selecting a compiler from the dropdown list below and pressing detect will automatically detect system include search paths used by this compiler and add them to the Global Include Paths.
• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Framework Search Paths (Mac only)

Sourcetrail needs you to specify the locations of .framework files, your indexed source and header files rely on.

Additionally you can also specify Global Framework Search Paths, which will be used by all your projects. They can also be auto detected by choosing a compiler below and pressing detect.

Setting	Description
Framework Search Paths	These paths are used to find .framework files used by your project. (For instructions on how to add paths see Path List Box.)
Global Framework Search Paths	These Framework Search Paths will be used in all your projects. (For instructions on how to add paths see Path List Box. For instructions on how to find the system header paths see Finding System Header Locations)

Interactions:

• Selecting a compiler from the dropdown list below and pressing detect will automatically detect system header search paths used by this compiler and add them to the Global Header Search Paths.
• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Advanced Settings

In this dialog you can enter additional settings. You can add compiler flags or defines that will be used when indexing and you can exclude certain paths or files from indexing.

Setting	Description
Compiler Flags	Define compiler flags used during indexing including the dash (e.g. use -D RELEASE to add a #define for RELEASE). (For instructions on how to add paths see Path List Box.)
Exclude Paths	Exclude Paths define the files and directories that will be left out from indexing. (For instructions on how to add paths see Path List Box.)

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Create a C/C++ Project from Compilation Database

If you are using CMake you can export compile commands by defining the CMAKE_EXPORT_COMPILE_COMMANDS flag and then use the exportet .json file for Sourcetrail project setup.

For non-CMake projects you can use Bear. Bear generates a .json file during the simulated build process. Bear has been tested on FreeBSD, GNU/Linux and OS X.

Compilation Database Meta Data

In the first step you need to enter meta information about the project and define the compilation database.

Setting	Description
Sourcetrail Project Name	The name of the project. This will also be the name of the .srctrlprj file generated by Sourcetrail.
Sourcetrail Project Location	Choose the location of the project file from the dialog.
Compilation Database	Select the compilation database .json for the project. Sourcetrail will index the project based on the compile commands in this file. If the compilation database changes you can Refresh Sourcetrail to the new files.

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Compilation Database Headers

In the next step you can see which source files are in the compilation database and define the locations of the corresponding header files.

Header files will only be indexed if they are included in one of the source files.

Setting	Description
Indexed Header Paths	Specify one or multiple locations that contain the header files to the source files defined in the compilation database. (For instructions on how to add paths see Path List Box.)

Interactions:

• Clicking show source files will show you a list of all source files in the compilation database.
• Clicking Select From Include Paths will display a dialog showing a list of all the Include Paths used within the Compilation Database. You can select paths and all headers that are included within these paths will also get indexed.
• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process.

Create a C/C++ Project from Visual Studio Solution

If you are using Visual Studio you can export a Compilation Database with out Visual Studio Plugin and use it to create a project with Sourcetrail.

Interactions:

• Clicking Create CDB will communicate to the Visual Studio Plugin that a project should be exported as Compilation Database. Please have a look at the Visual Studio Plugin for more details on the steps within Visual Studio.

Create an Empty Java Project

Choose this option if you want to use Sourcetrail on a Java code base.

Project Meta Data

In the first step you need to enter meta information about the project.

Setting	Description
Sourcetrail Project Name	The name of the project. This will also be the name of the .srctrlprj file generated by Sourcetrail.
Sourcetrail Project Location	Choose the location of the project file from the dialog.
Standard	Select the language standard that should be used for indexing your project. We currently only support Java 8

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Indexed Paths

In this step you provide all the information Sourcetrail needs to know about your code base.

Setting	Description
Indexed Paths	Provide the root path of your Java project. This is the path where all your package names are relative to. You may provide multiple paths here. For an example this may be required if your project's source code resides in one location but generated source files are kept at a different location.
Class Path	Add one entry per jar file that is required for the project to compile. You can also add the root path of the class files your project depends on, or add a mixture if you have class files for some of the dependencies and jar files for the rest of them.

Advanced Settings

In this dialog you can enter additional settings. You can define source file extentions and you can exclude certain paths or files from indexing.

Setting	Description
Source File Extensions	Define extensions for source files including the dot e.g. .cpp or .java
Exclude Paths	Exclude Paths define the files and directories that will be left out from indexing. (For instructions on how to add paths see Path List Box.)

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Create a Java Project from your Maven Configuration

If you are using a Maven configuration to manage and build your project use this approach to create a Sourcetrail project.

Maven Project Meta Data

In the first step you need to enter meta information about the project.

Setting	Description
Sourcetrail Project Name	The name of the project. This will also be the name of the .srctrlprj file generated by Sourcetrail.
Sourcetrail Project Location	Choose the location of the project file from the dialog.
Standard	Select the language standard that should be used for indexing your project. We currently only support Java 8

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Maven Project Indexed Paths

In the first step you need to enter meta information about the project.

Setting	Description
Maven Project File	The path to the pom file in the root folder of your Maven project.
Should Index Tests	This checkbox indicates whether or not Sourcetrail indexes the test code that is part of your Maven project.
Intermediate Dependencies Directory	Directory where Sourcetrail stores all of the project's .jar dependencies.

Interactions:

• Clicking show source files will show you a list of all source files that have been detected in the Maven project. If Should Index Tests is checked this list also includes the test source files.
• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process.

Advanced Settings

In this dialog you can enter additional settings. You can define source file extentions and you can exclude certain paths or files from indexing.

Setting	Description
Source File Extensions	Define extensions for source files including the dot e.g. .cpp or .java
Exclude Paths	Exclude Paths define the files and directories that will be left out from indexing. (For instructions on how to add paths see Path List Box.)

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Next will take you to the next step of the setup process.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

New Project Summary

This window appears at the end of the Project Setup Wizard to summarize all the information entered before. It is the same as the Edit Project Window.

Interactions:

• Clicking Cancel or pressing ESC will close the window and abort the setup process.
• Clicking Create will check your inputs, save the new project file and start indexing the source files.
• Clicking Previous will take you to the previous step of the setup process. All the information you entered will be saved.

Edit Project Window

This window displays all the information relevant for your Sourcetrail project. Please have a look at the Project Setup Wizard for descriptions on each setting.

Interactions:

• Clicking Cancel or pressing ESC will close the dialog with no changes made.
• Clicking Save will check your inputs, save the new project file and inform you whether you need to re-index your project.

Enter License Window

The Enter License Window appears on your first start of Sourcetrail and is used to enter and check your Sourcetrail license key.

Interactions:

• Copy and Paste your license key from your "Sourcetrail 0 License Key" e-mail into the textfield. The key should be formated as shown by the placeholder text.
• Clicking Activate will check if your license key is valid and close the window. Otherwise an error message will be displayed.

Indexing Dialogs

These dialogs will be used while Sourcetrail indexes your project. The whole user interface will be frozen as long as these dialogs are visible.

Start Indexing Dialog

This dialog displays the number of files for indexing and clearing before indexing starts.

Interactions:

• Checking full refresh will re-index the whole projects.
• Clicking Cancel will abort indexing.
• Clicking Start will start the file clearing and indexing.

Progress Dialog

This dialog shows that Sourcetrail is currently doing processing that can't be interrupted.

Indexing Dialog

This dialog shows the indexing progress of your project, by displaying the number of already indexed files, the last file that was started indexing, the number of errors and a progress estimate in percent.

Interactions:

• Clicking Stop or pressing ESC will interrupt indexing. Sourcetrail will still wait for the already running indexer threads to finish. You can continue indexing later by refreshing.

Finished Indexing Dialog

This dialog is shown after indexing finished, giving you information about indexed files, duration and errors.

Interactions:

• Clicking OK will close the dialog and allow you to interact with the main window again.

Menu

Project

• New Project
  • Shortcut: New Project
  • Opens the New Project Dialog to define a new project and loads it after creation.
• Open Project
  • Shortcut: Open Project
  • Opens a file dialog to choose an existing Sourcetrail project file from your system's hard drive.
• Recent Projects
  • Opens a submenu to choose recent opened Sourcetrail projects.
• Edit Project
  • Opens the Edit Project Window prefilled with your project settings and allows for changing them.
• Exit
  • Quits Sourcetrail.

Edit

• Back
  • Shortcut: Back
  • Undoes the last navigation action.
• Forward
  • Shortcut: Forward
  • Redoes an undone navigation action.
• Refresh
  • Shortcut: Refresh
  • Refresh will check all indexed source files for updates and reindex the ones that changed and their depending ones.
• Full Refresh
  • Shortcut: Full Refresh
  • Full Refresh will reindex the whole project.
• Find Symbol
  • Shortcut: Find Symbol
  • This option will put the focus into the search field, so you can start typing your search query. Alternatively you can click the search field.
• Find Text
  • Shortcut: Find Text
  • This option will put the focus into the search field and start a new full text search query
• Code Reference Next
  • Shortcut: Code Reference Next
  • Use this option to iterate to the next source location of the active symbol in the code view.
• Code Reference Previous
  • Shortcut: Code Reference Previous
  • Use this option to iterate to the previous source location of the active symbol in the code view.
• To overview
  • Shortcut: To overview
  • This option will display the overview of the project.
• Preferences
  • Shortcut: Preferences
  • Opens the Preferences Window.

View

• Show Title Bars
  • Toggle the visibility of the bars above each Window Widget.
• Search Window
  • Toggle the visibility of the Search Window. This can also be done by closing the Search Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Graph Window
  • Toggle the visibility of the Graph Window. This can also be done by closing the Graph Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Code Window
  • Toggle the visibility of the Code Window. This can also be done by closing the Code Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Status Window
  • Toggle the visibility of the Status Window. This can also be done by closing the Status Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Larger Font
  • Shortcut: Larger Font
  • Increase the font size within the Main Window's user interface.
• Smaller Font
  • Shortcut: Smaller Font
  • Decrease the font size within the Main Window's user interface.
• Reset font size
  • Shortcut: Reset font size
  • Resets the font size to the original size.
• Reset window layout
  • Resets all the dock widgets to their original layout.

Bookmarks

• Bookmark Active Symbol
  • Shortcut: Bookmark Active Symbol
  • Opens the Bookmark Creator dialog create a new bookmark.
• Bookmark Manager
  • Shortcut: Bookmark Manager
  • Opens the Bookmark Manager dialog for viewing all bookmarks.

Help

• About
  • Shows copyright information about Sourcetrail.
• Keyboard Shortcuts
  • Shows table of keyboard shortcuts for Sourcetrail.
• Documentation
  • Opens the documentation of Sourcetrail in your web browser by URL.
• Bug Tracker
  • Opens Sourcetrail's bug tracker in your web browser by URL.
• 3rd Party Licences
  • Documents which third party licences Sourcetrail is using.
• Enter License...
  • Opens the Enter License Window.
• Show Data Folder
  • Opens the file explorer showing the data folder.
• Show Log Folder
  • Opens the file explorer in the directory data/logs where all log files are saved to. You can enable file logging in the Preferences Window.

Shortcuts

Shortcut	Windows	Mac OS X	Linux
Preferences	Ctrl + ,	Cmd + ,	Ctrl + ,
New Project	Ctrl + N	Cmd + N	Ctrl + N
Open Project	Ctrl + O	Cmd + O	Ctrl + O
Close Window	Alt + F4	Cmd + W	Ctrl + W
Hide Window		Cmd + H
Refresh	F5	Cmd + R	F5
Full Refresh	Shift + F5	Cmd + Shift + R	Shift + F5
Back	Ctrl + Z / Backspace	Cmd + Z / Backspace	Ctrl + Z / Backspace
Forward	Ctrl + Shift + Z	Cmd + Shift + Z	Ctrl + Shift + Z
Find Symbol	Ctrl + F	Cmd + F	Ctrl + F
Find Text	Ctrl + Shift + F	Cmd + Shift + F	Ctrl + Shift + F
Code Reference Next	Ctrl + G	Cmd + G	Ctrl + G
Code Reference Previous	Ctrl + Shift + G	Cmd + Shift + G	Ctrl + Shift + G
To overview	Ctrl + Home	Cmd + Home / Cmd + Up	Ctrl + Home
Larger Font	Ctrl + +	Cmd + +	Ctrl + +
Smaller Font	Ctrl + -	Cmd + -	Ctrl + -
Reset Font Size	Ctrl + 0	Cmd + 0	Ctrl + 0
Bookmark Active Symbol	Ctrl + D	Cmd + D	Ctrl + D
Bookmark Manager	Ctrl + B	Cmd + B	Ctrl + B

Graph View

The graph view visualizes the currently selected symbol and all its relationships to other symbols as an interactive graph visualization. You can also display whole call graphs, inheritance chains or include trees by using the toolbar in the top left. Read more about at Depth Graph.

Interactions:

Panning:

• Drag the background area with the mouse.
• Scroll left-right and up-down on the mouse pad.
• Use the keys W A S D.

Zooming:

• Press the + and - buttons in the lower left corner.
• Hold Ctrl/Cmd and scroll with mouse wheel or mouse pad.
• Press Shift + W or Shift + S.
• Press 0 to reset zoom.

Nodes

Colors are corresponding to the default color scheme.

Node Type	Image
File
Macro
Namespace & Package
Class & Struct: Display their members nested, and separated by access type: public, protected, private. By default only members with edges are shown. The arrow icon allows to expand and collapse them. The number tells how many nodes are hidden.
Type & Template Parameter
Typedef
Variable & Field
Function & Method
Enum
Non-indexed: Nodes that were not defined within the indexed files are shown with hatched background.
Bundle: A bundle node combines multiple nodes to reduce the size of the graph visualization. The name describes what kind of nodes are bundled. The number tells how many nodes are bundled.

Interactions:

• Click a node to activate it.
• Drag a node to change its position.
• Click the arrow icon in class nodes to expand and collapse it.
• Click a bundle node to expand it.
• Hover a node to see a tooltip that displays the node’s type.

Edges

Colors are corresponding to the default color scheme.

Edge Type	Image
File Include
Type Use
Variable Use
Function Call
Inheritance
Method Override
Template Parameter Use & Template Argument Use
Aggregation: Bundles multiple edges between the child nodes of the 2 nodes. The thickness gives an impression of how many edges are bundled. Hover the edge to get the number of bundled edges.

Interactions:

• Click an edge to see its location in the Code View.
• Click an aggregation edge to activate all its corresponding edges.
• Hover an edge to see a tooltip that displays the edge’s type.

Depth Graph

Using the toolbar in the top left you can display whole call graphs, inheritance chains or include trees for the currently active symbol if the right symbol type is currently active.

Interactions:

• Click the arrow button to expand/collapse the Depth Graph controls.
• Click the Depth Graph buttons to show a graph or depending/dependent nodes.
• Change the slider position to change the maximum depth of the graph. Moving it to the top will use infinite depth.
• Click on a node to activate it.
• Click on an edge to show it's source location in the Code View.

Code View

The code view displays the corresponding source code of the currently selected symbols. The code view has two modes. In list mode it contains a list of one or more files. In single file mode it shows one full source file at a time.

Interactions:

• Look at the different refernces of the currently active symbol with the 2 buttons in the upper left corner.
• Switch between Snippet List and Single File mode with the 2 buttons in the upper right corner.
• Scroll up and down to see the different source files.

Snippet List Mode

In this mode the Code View will provide all references of the currently active symbol at once. The top most snippet will show the definition of the symbol if available.

Files

Each file has a title bar with the file's name and buttons to change its display state. There are 3 different states:

• Minimized: The file does not show its content.
  
• Snippets: The file displays the snippets containing active locations separated by lines.
  
• Maximized: The whole content of the file is visible.
  

Interactions:

• Hover the title to see the full file path.
• Click the title to activate the file's corresponding node.
• Click one of the three icons on the right to change the display state of the file.

Snippets

A code snippet contains the lines of interest for the currently active symbol surrounded by some more lines to provide some context. Other symbols that were indexed by Sourcetrail are framed by a box when hovered. Here Sourcetrail distinguishes between local symbols and symbols that can be related to any other part of the code base. In case the snippet is part of a class, function or namespace, an additional line at the top of the snippet provides information about the snippet’s context (e.g. the surrounding scope).

Interactions:

• Click the top line to show the whole scope around the snippet.
• Click a boxed symbol to activate it.
• Click a boxed local symbol to highlight all its usages in the visible code.

Single File Mode

In single file mode you will only every have one file visible at a time. The first file shown is usually the file containing the definition of the active snippet if available. Other than that the user interface is the same as in Snippet List Mode.

Search View

The Search View contains the search field and some other related user interface elements.

Back & Forward

The left Backward button lets you undo your last navigation actions (see Back) and the right Forward button lets you redo your undone navigation actions again (see Forward). Both buttons are only enabled when the respective actions are available at the moment.

Interactions:

• Hover the buttons to see a tool tip.
• Press the buttons to execute the respective action.

Refresh

The refresh button allows you to refresh the current project and reindex all updated, added and removed files. To reindex the whole project choose the Force Refresh option from the Edit Menu.

Interactions:

• Hover the buttons to see a tooltip.
• Press the refresh button to refresh the project.

Overview Button

Show the overview screen, which gives a summary of the loaded project. The overview screen is shown after the project was loaded. Alternatively use the shortcut To overview.

Interactions:

• Press the overview button to show the project overview.

Search Bar

The search bar allows you to enter search requests to find one of Sourcetrail's indexed symbols. It doesn't allow for full text searching across all files so far. The search field allows for most text editing interactions common to text fields. When typing your request the Autocompletion Popup will show you search results matching to your entered string.

Interactions:

• Focus the search field by clicking it or using the Find Symbol action.
• Enter your search request by typing on your keyboard.
• By pressing enter or clicking on the search icon on the right you send your request.
• The search field allows for most interactions known from other text fields such as moving the cursor, copy&paste and text selection.

Autocompletion Popup

The Autocompletion Popup displays all Nodes matching your search request within all indexed symbols. The match results are determined by a fuzzy matching algorithm, that allows you to skip characters. The popup shows which characters in the words are matching and displays their corresponding node color. The node type is displayed on the right.

Interactions:

• Use the up and down arrow keys to switch between search results.
• Pressing tab or clicking on the search result will insert it into the search field.
• Pressing enter will select the search result and send the search request.

Keywords

Additionally the search view provides specific keywords that select a certein group of symbols.

keyword	effect
overview	Shows an overview of all indexed symbols in the graph view and some statistics in the code view.
error	Shows all errors in the code view.

Full text search

Search for a certain string in all indexed files by putting ? at the front of your search query. The default full text search is case-insensitive, use ?? to search case-sensitive.

Interactions:

• Start a query with ? or use the Find Text action to do a case-insensitive full text serach.
• Start a query with ?? to do a case-sensitive full text search.

Bookmarking Buttons

The Bookmark Active Symbol button on the left opens the Bookmark Creator to create a new bookmark. The Bookmark Manager button on the right is used to display the Bookmark Manager for activating and editing your bookmarks.

Interactions:

• Hover the buttons to see a tool tip.
• Press the buttons to execute the respective action.

Bookmark Creator

Use the Bookmark Creator to create or edit bookmarks.

Setting	Description
Name	The name of the bookmark. Initially the name of the node or edge is used.
Comment	Add an optional comment to the bookmark.
Category	Add the bookmark to a certain category. Bookmarks with the same category are grouped together in the Bookmark Manager.

Interactions:

• Press Cancel to close without changes.
• Press Create/Save to save the bookmark or apply the changes.

Bookmark Manager

Use the Bookmark Manager to view and activate your bookmarks. Bookmarks are displayed as lines below their respective category. If a bookmark does not have a category it will be placed within the default category. The buttons for removing/editing categories or bookmarks are only visible when hovering the respective line. Bookmark information is stored within a separate .srctrlbm file next to your .srctrlprj project file.

Interactions:

• Activate bookmarks by clicking on the name.
• Open/Collapse the bookmark comment by clicking within the bookmark line.
• Click the Edit button to change the contents of the bookmark.
• Click the Delete button at a bookmark to remove the bookmark.
• Open/Collapse categories by clicking in their line.
• Click the Delete button at a category to remove the category and all bookmarks within.
• Change the Show filter to switch between display of nodes and/or edges.
• Change the Sorting to change the order of bookmarks within their categories.

Status View

This view provides different tabs with information about your project. This view is hidden by default.

Interactions:

• Click on the titles on top to switch between tabs.

Status Tab

This table gives some information about status updates while running Sourcetrail. It can be helpful to figure out why something does not the way it's expected to.

Interactions:

• Double click on a table cell to select the text for copy&paste.
• Use the checkboxes below to filter the shown messages by type.

Errors Tab

This list shows errors occured durring indexing.

The following information is provided:

• Error message
• File
• Line number
• Indexed (if the file is within the indexed files)

Interactions:

• Click on a error line to see the location of the error in the Code View.
• Double click on a table cell to select the text for copy&paste.
• Use the checkboxes below to filter the shown errors by certain criteria.

CODE EDITOR PLUGINS

In order to make Sourcetrail the perfect partner for your development workflow you can connect Sourcetrail with different code editors. You can find the plugins in Sourcetrail's download package located in the folder /ide_plugins. Have a look at the following list of supported code editors to find out what editors are currently supported.

We are eager to expand the range of supported editors, so if you can't find a plugin for the code editor you are using, please let us know by writing to support@sourcetrail.com.

The plugins are Opensource and available on github.

Supported Editors:

• Atom
• CLion
• Eclipse
• Emacs
• Sublime Text 2
• Sublime Text 3
• Vim
• Visual Studio 2012
• Visual Studio 2013
• Visual Studio 2015

The communication between Sourcetrail and the code editor is achieved using a local TCP connection. Sourcetrail uses the port 6667 to listen for incoming messages. Outgoing messages will be sent to the port 6666. The port numbers can be edited in the Preferences Window.

Outgoing messages are in the form:

moveCursor>>absolute/file_path>>line_number>>column_number<EOM>

Incoming messages are in the form:

setActiveToken>>absolute/file_path>>line_number>>column_number<EOM>

From Sourcetrail

If you want your editor to open a file at a specific location from within Sourcetrail, you can achieve this by either selecting the option Set IDE Cursor from the right-click menu in the Code View or by simply clicking into a line in the Code View while holding down the Ctrl or Cmd key.

To Sourcetrail

By using a Sourcetrail plugin for your code editor, you can select a location within a source file and Sourcetrail will show you all symbols found at this location. Please have look at the list below to see which plugins are currently available and how they are used.

Atom

Repo

https://github.com/CoatiSoftware/atom-sourcetrail

Installation

1. In Atom go to Settings with Edit -> Preferences or Ctrl + ,
2. Go to Install and search for sourcetrail
3. Install atom-sourcetrail

Use

To start the Tcp Server got Packages -> Sourcetrail -> Start Server

To send a location to Sourcetrail, place the cursor and right-click and select Send location to Sourcetrail or Packages -> Sourcetrail -> Send location to Sourcetrail

Clion/IntelliJ

Repo

https://github.com/CoatiSoftware/idea-sourcetrail

Installation

1. Go to File -> Settings
2. Plugins -> Browser Repositories
3. Search for sourcetrail
4. Install idea-sourcetrail
Use

If you want IntelliJ/CLion to activate a certain element in Sourcetrail, right-click that element to bring up the context menu and choose the “Sent Location” option.



Eclipse

Repo

https://github.com/CoatiSoftware/eSourcetrail

Installation
• Updatesite:
  1. In Eclipse go in the menu to Help -> Install new Software...
  2. Add the Sourcetrail Updatesite
  • type https://CoatiSoftware.github.io/eSourcetrail/updatesite into the Work with: field
  • or press Add... and add the address above
  3. Select all and finish the next step.
  4. Eclipse needs to restart and can now communicate with Eclipse.
• Manually:
  1. Download this eSourcetrail-gh-pages.zip and unzip it.
  2. In Eclipse go in the menu to Help -> Install new Software...
  3. Click the Add... Button
  4. Click the Local... Button select the updatesite folder in the unzipped folder
  5. Select all and finish the next step.
  6. Eclipse needs to restart and can now communicate with Eclipse.
Use

If you want Eclipse to activate a certain element in Sourcetrail, right-click that element to bring up the context menu and choose the “Set active Token” option.



Emacs

Repo

https://github.com/CoatiSoftware/emacs-sourcetrail

Installation
• Manuelly
1. Download the sourcetrail.el from https://github.com/CoatiSoftware/emacs-sourcetrail
2. In Emacs press M + x and type in package-install-file
3. Type in the path to the downloaded sourcetrail.el file
• Melpa
1. Add Melpa to your package-archives
2. Press M + x and type list-packages
3. Search for sourcetrail and mark sourcetrail with i then press x and the confirm with yes
Use

If you want Emacs to activate a certain element in Sourcetrail, set your cursor to that element and M + x and type in sourcetrail-send-location.

To get Location from Sourcetrail the sourcetrail-mode need to be active. To active the sourcetrail-mode press M + x and type in sourcetrail-mode

Qt Creator

Repo

https://github.com/CoatiSoftware/qtc-sourcetrail

Installation
1. Download the plugin for your system from here.
2. Copy the files into the plugin folder where the QtCreator is installed(eg. /usr/lib/qtcreator/plugins)
   • the plugin path can be found at Help -> System Information... -> PluginsPath
Use

If you want QtCreator to activate a certain element in Sourcetrail, click a location to place the cursor, right-click to bring up the context menu and choose the “Sourcetrail - Set active Token” option. Please note that the position of the cursor will be sent to Sourcetrail and not the position you opened the context menu at.

Sublime Text

Repo

https://github.com/CoatiSoftware/sublime-sourcetrail

Installation
• Manually
1. To install the Sourcetrail plugin for Sublime Text copy the SourcetrailPlugin folder located in your ide_plugins/sublime_text to your SublimeText/Packages folder
2. restart Sublime
• Package Controll
1. If you dont have Package Controll for Sublime go to https://packagecontrol.io and install it
2. Open Command Pallete with Ctrl + Shift + P
3. Select Package Controll: Install Package
4. Install sourcetrail
Use

If you want Sublime to activate a certain element in Sourcetrail, click a location to place the cursor, right-click to bring up the context menu and choose the “Sourcetrail - Set active Token” option. Please note that the position of the cursor will be sent to Sourcetrail and not the position you opened the context menu at.



Vim

Repo

https://github.com/CoatiSoftware/vim-sourcetrail

Installation

Please visit the vim-sourcetrail repository on Github for details.

Use

If you want Vim to activate a certain element in Sourcetrail, go to the code location and use :SourcetrailActivateToken, now Sourcetrail should display your the chosen location.

Use:help sourcetrail.txt get get more information about the plugin

Visual Studio

Installation

To install the Sourcetrail plugin for Visual Studio 2012, 2013 or 2015, just execute the corresponding vsix file located in your ide_plugins/visual_studio.

Use

If you want Visual Studio to activate a certain element in Sourcetrail, right-click that element to bring up the context menu and choose the “Set active Token” option.


Create Compilation Database (Beta)

You can create a compilation database (CDB) from your VS solution. Sourcetrail projects can be created from CDBs. This feature will replace solution parsing as implemented in current Sourcetrail versions. The workflow from VS to Sourcetrail will be automated in the future. As of now CDBs have to be loaded manually in Sourcetrail.

The CDB wizard is located in the Sourcetrail section in the VS menu bar. Note that the option is only useable if a solution containing at least one C/C++ project is loaded.



In the CDB wizard you can select projects you want to include in the CDB as well as the desired build target platform and configuration and a number of other options.



Option	Description
Select Projects	The list of C/C++ projects in your solution. Check all projects you want to be included in the CDB.
De/Select All	Will select all projects if at least one project is not selected. If all projects are selected they will all be unselected.
Configuration	A dropdown list of the available build configurations. The selected configuration determines include paths and compile flags for the CDB.
Platform	A dropdown list of the available target platforms. The selected platform determines include paths and compile flags for the CDB.
Browse	Opens a folder browser to select the directory where the CDB will be created in. By default it is the directory of your solution. Instead of using the folder browser you can also paste a path into the adjacent text field.
CDB Name	This is the name for the CDB file. By default it is the same name as your solution.
C Standard	A dropdown list of all C standards supported by Sourcetrail. If your projects contain C files select the appropriate standard. Note that we aim to automate this selection in the future.
Cancel	Aborts the process and closes the wizard.
Create	Creates the CDB using the specified options. Note that at least one project has to be selected to start creating.

Once the CDB was successfully created it can be found in the specified target directory. From this CDB you can create a Sourcetrail project as described above.

Settings

Network settings and logging options can be changed in the plugin's Tools/Options entry.




Option	Description
Sourcetrail Port	The port on which Sourcetrail will receive messages. Note that this must match the port setting in Sourcetrail itself.
VS Port	The port on which Visual Studio will receive messages. Note that this must match the port setting in Sourcetrail itself.
File Logging	Enable log output for the plugin. Additionaly to the output file, log messages will also be displayed in VS'
Log Obfuscation	Obfuscate project- and file names as well as directories in the log output. Note that already logged data will not be obfuscated retroactively. A dictionary, mapping obfuscated names to original names, will be created in a seperate file.
Thread Count	The number of threads used during CDB creation

Logging

The plugin offers optional file logging. Should you ever have problems with the plugin we recommend to turn logging on. This will help to pinpoint and resolve the issue faster.

Logs will be created in ..\AppData\Local\Coati Software\Plugins\VS folder. A new log file will be created every time you restart VS and logging is enabled.



Note that the logs will include project- and file names as well as directories specific to your project. If you wish to keep this informatin secret you can use log obfuscation.

Project- and file names as well as directories will be replaced by an alphanumeric sequence. The sequence has the form a0, b0, c0,..., a1, b1, c1,.... Note that after switching on obfuscation, already logged data will not be obfuscated retroactively. No log files will be send to Coati Software automatically. You can check any file you may want to send us for sensible information before sending it.

A dictionary, mapping obfuscated names to original names, will be created in your log folder if log obfuscation is switched on. When during the support process we refer to project items by their obfuscated name you can still make sense of it. Do not send the dictionary to anybody else.

Lastly, log messages are also displayed in the VS output window. This is tied to file logging and is not en- or disabled separately.



IDE Communication Protocol

Sourcetrail's IDE plugins communicate with Sourcetrail via sockets, using TCP. Sourcetrail implements a number of messages to provide an interface for the plugins.

This chapter explains the general structure of those messages, followed by a list of possible message types.

Message Structure

The basic structure of the messages used by Sourcetrail plugins consists of a prefix to identify the message type, followed by no, one, or multiple parameters and ends with an 'end-of-message' token. Parameters and tokens are seperated by a 'divider' token.

Name	Token	Description
messageType	see below	A string that determines how the message will be interpreted by Sourcetrail or the plugin
divider	>>	Seperates the tokens of the message
parameter	see below	Typically an integer or string
endOfMessage	<EOM>	Helps to determine the end of a message

Messages have the following form:

messageType<<parameter<<...<<parameter<EOM>

Message Types

Sourcetrail does implement a number of message types that can be used by Sourcetrail plugins. In the following is a list of the messages that Sourcetrail may send to plugins and messages that may be sent by a plugin to Sourcetrail.

Note that you can chose which messages you want to implement. Sourcetrail will not make problems if you chose to ignore certain messages.

Incoming messages

These messages may be received by a plugin.

Message	Parameters	Description
moveCursor	fileLocation: string row: integer column: integer	Set the cursor of your editor or IDE to the given file location. Note that fileLocation is the absolute path and name of the target file.
createCDB		Sourcetrail may send this message to prompt your plugin to create a Compilation Database (CDB). Once the CDB is ready you may want to respond with a createCDBProject message.
ping		Sourcetrail may send a ping to determine if anybody is listening. Respond with a ping message yourself. Sourcetrail will not respond to this message.

Outgoing messages

Your plugin may send these messages to Sourcetrail.

Message	Parameters	Description
setActiveToken	fileLocation: string row: integer column: integer	Tells Sourcetrail to shift focus to the token located at the given position. Note that fileLocation is the absolute path and name of the target file.
createCDBProject	cdbPath: string headerPaths: string	If your plugin can provide a Compilation Database this message can prompt Sourcetrail to import it and display an appropriate dialog for the user. headerPaths is a list of the base project's header include paths. Seperate the single paths using the divider token. You can add as many paths as you need.
ping		Your plugin may send this message to Sourcetrail to tell it it's listening.

Coati Software OG
Jakob-Haringer-Straße 1/127
5020 Salzburg
Austria

Contact
coati.io
mail@coati.io