Red Hat Docs > Manuals > EDK Manuals > |
![]() |
The following documentation provides the basics about working with the Embedded DevKit's IDE, Source-Navigator. This documentation assumes that you have already configured your embedded environment; if you haven't, see Setting Up for Embedded Work, Creating a Target Filesystem Image, Configuring and Building the Kernel, and Setting Up Targets.
With Source-Navigator, there are essentially five steps to building your project:
The Source-Navigator database stores all information about file names, symbol elements, and symbol relationships (functions and global variables are examples of symbols). The minimum requirements for building source code include specifying which source files should be included, the path to the directory in which the build should be stored, the linking rules used, the debugging and optimization flags used, and included paths.To create a project, see Creating a New Project. For more information about using Source-Navigator, see User's Guide from Source-Navigator's Help menu. After you understand how the interface components work, see Developing for Embedded Systems.
For help with new concepts and terms, see Glossary.
The following tutorial explains how to create a new project, while introducing you to working with Source-Navigator.
The first time you launch Source-Navigator, an initial "splash screen" appears and then an empty Projects window opens (Projects window).
The Auto-Create Project dialog appears (see Auto-Create Project dialog). Auto-Create Project is a quick way to start a new project if all your project's source files already reside in a single directory (or a small number of directories) and if you want all the files from that directory in your project. After you create a project, you will see it listed in the Projects window.
In the following tutorial, you will use existing source code and create the c++_demo.proj project.
After creating a project, the Symbol Browser opens. The Symbol Browser provides a view of the symbols within the project. Symbols refer to variables, labels, and procedures in a program. Typically, every global function and variable in a C program will have a symbol with which it associates. Sort a list in the Symbol Browser by symbol type or by a text string. Type it into the Pattern: field (see Symbol Browser for the files for the c++_demo project). If you click on the icon to the left of the file or symbol name, you can expand the list view to a tree view of the file or symbol. If you double-click on a file or symbol name, the Editor opens. If you select a symbol in the source code, the selected file opens at the location of the symbol.
For the other browser windows, menus and buttons accessible from Source-Navigator along with descriptions of their functionality, see User's Guide from Source-Navigator's Help menu for more details and the following documentation.
The Symbol Browser window has browser buttons (see Browser buttons and its accompanying descriptions) and filter buttons (see Filter buttons and its accompanying descriptions).
Use the Project Editor to create a new project, to add files or directories to an existing project, or to delete files or directories from an existing project. With the Project Editor, you can perform the following functions.
To open the Project Editor from the Symbol Browser, use File -> Project Editor. Project Editor shows the Project Editor with a source file selected (in Project Editor, Agent.h).
See Source-Navigator's Help menu for more information on the Project Editor.
Items in the project database are hyperlinked in the Editor (Using the Editor). When you double-click on a symbol anywhere within a project, the Editor displays the location of that selected symbol in your source code.
The Symbol Accelerator combo-box allows you to navigate quickly through the code. With the Editor open, the Symbol Accelerator lists all of the symbols either within the open file or within the entire project. When other browsers are open, the Symbol Accelerator lists the components relative to that browser.
Use the Source-Navigator view tabs to have a different view of a selected symbol. For instance, if a class name is highlighted, and you select the Xref tab, you see a tree view of the inheritance line of that class. To combine multiple browsers into a single window, use the following steps.
With this combined browser view, you can examine the code syntax in the Editor pane, and understand the project-wide context of the class in the Cross-Reference Browser pane.
The Cross-Reference Browser helps you to understand complex source code by showing the Refers-to and Referred-by relationships between symbols in a project, using their respective buttons (see Buttons that help show cross-referencing relationships).
Buttons that help show cross-referencing relationships
You can traverse the tree and expand or collapse the elements within the tree, using the following procedure.