Basic Settings in New Project Wizard

# HG changeset patch # User fturovic # Date 1277310023 18000 # Node ID d9c69c1b932e1ba58b2e4043608020bed9c66fa8 # Parent 8f60724893dab94d08ec1d24d30dd6cc4ca4716b remove old images and add new one with revised pages diff -r 8f60724893da -r d9c69c1b932e core/com.nokia.carbide.cpp.doc.user/html/concepts/working_with_data.htm --- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/working_with_data.htm Wed Jun 23 11:17:17 2010 -0500 +++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/working_with_data.htm Wed Jun 23 11:20:23 2010 -0500 @@ -10,8 +10,7 @@

Working with Debugger Data

This section explains how to work with data that the Carbide.c++ debugger generates. The following windows show various types of debugger data.

System Browser Window view —shows individual processes and tasks that the debugger can control
Console view —shows messages generated during the debugging session

Console view —shows messages generated during the debugging session

Basic Settings in New Project Wizard

Basic Settings

- You can set some basic properties for the project in this page, like Application UID, Author and Copyright - notice for the project.

NOTE Fields appearing in window vary depending upon the type of project being created.

Name	Function
- - Application UID -	- - Specifies a 32-bit ID to identify the project.
- - Vendor ID -	- - Appears for projects that require a 32-bit unique ID to identify the vendor of the - executable. In versions of Symbian OS with platform security, a program can - read a VID at runtime to check that a binary comes from a particular source. In - most cases, the VID should be zero, meaning that source of the executable is - not required for any security checks. -
- - Author -	- - Specifies the name of the Author, who is creating this project. -
- - Copyright Notice -	- - Specifies the copyright notice to be added to the source code of the - project. -

NOTE Tooltips are available for the various fields. Simply hover the pointer over the field title to view the tooltip.

Related tasks

Creating New Projects - -

Basic Settings in New Project Wizard

Basic Settings

+ You can set some basic properties for the project in this page, like Application UID, Author and Copyright + notice for the project.

NOTE Fields appearing in window vary depending upon the type of project being created.

Name	Function
+ + Application UID +	+ + Specifies a 32-bit ID to identify the project.
+ + Vendor ID +	+ + Appears for projects that require a 32-bit unique ID to identify the vendor of the + executable. In versions of Symbian OS with platform security, a program can + read a VID at runtime to check that a binary comes from a particular source. In + most cases, the VID should be zero, meaning that source of the executable is + not required for any security checks. +
+ + Author +	+ + Specifies the name of the Author, who is creating this project. +
+ + Copyright Notice +	+ + Specifies the copyright notice to be added to the source code of the + project. +

NOTE Tooltips are available for the various fields. Simply hover the pointer over the field title to view the tooltip.

Related tasks

Creating New Projects + +

Indexer

The C/C++ Indexer uses the parser to create a database of source and header files that provide the basis for C/C++ search, navigation features and content assist. The goal of indexing is to record all named elements in a project's source code and store them with their related data. The indexer parses each source file in your project and updates related indexes. By indexing your files with the indexer, useful features such as code completion and fast file search can be used. It is also possible to specify different indexer settings for each project in your workspace.

If you choose to perform the Full C/C++ Indexer option the indexer will consume the CPU for some time, but you will gain more benefit from the process after it completes. - However, if you do not require the benefits of indexing your project, select the No Indexer option to speed up the process of building your project.

The indexer runs on a background thread and reacts to resource change events such as:

C/C++ project creation/deletion
Source files creation/deletion
File imports
Source file content changes

The global Indexer is accessed by selecting Window > Preferences > C/C++ > Indexer (figure 1). The sections outlined in red appear as part of the project level indexer.

NOTE You can also rebuild a project's index by selecting a project, then right-click and select the Rebuild Index menu item.

Figure 1 - Indexer Window in Preferences Panels

The project indexer is accessed by selecting a project in the Project Explorer or Symbian Project Navigator view and selecting Project > Properties > C/C++ General > Indexer (figure 2).

Figure 2 - Indexer Window in Project Properties

Name	Function
Select indexer	Dropdown list of available index options. - - Fast C/C++ Indexer - Source files will be indexed and eat up a lot of CPU time and memory during the first generation of the indexer. This can take some time depending on the size of your project. Afterwards the indexer will only reindex the relevant parts you changed in your code and not the whole source tree. - Full C/C++ Indexer - Performs a complete parse of all source files and takes up the most amount of time to complete. - No Indexer - Project source files are not indexed, therefore search features will not work accurately and code completion will not be available. -
Apply indexer to all projects now	Select this option to apply the Fast C/C++ Indexer option to all projects in your current workspace.
Rebuild the index when changing to a different build configuration	Select this option to rescan and index the source files for the current project when you change the active build configuration. The index will be built based on the active build configuration. All macros and header files used to build the index will be taken from the active build configuration.
Build the index only for the build configuration specified in the project's indexer settings - - Build the index only for the specified build configuration	The indexer will only be run for the build configuration specified in the Indexer panel in the project's property settings. All macros and header files used to build the index will be taken from the specified configuration. - - NOTE This option appears in the project properties indexer panel. A dropdown list is provided to select a build configuration for the currently selected project.

Related concepts

Active Build Configuration

Related tasks

Indexer

If you choose to perform the Full C/C++ Indexer option the indexer will consume the CPU for some time, but you will gain more benefit from the process after it completes. + However, if you do not require the benefits of indexing your project, select the No Indexer option to speed up the process of building your project.

The indexer runs on a background thread and reacts to resource change events such as:

C/C++ project creation/deletion
Source files creation/deletion
File imports
Source file content changes

The global Indexer is accessed by selecting Window > Preferences > C/C++ > Indexer (figure 1). The sections outlined in red appear as part of the project level indexer.

NOTE You can also rebuild a project's index by selecting a project, then right-click and select the Rebuild Index menu item.

Indexer preference panel

Figure 1 - C/C++ Indexer in Preferences

The project indexer is accessed by selecting a project in the Project Explorer or Symbian Project Navigator view and selecting Project > Properties > C/C++ General > Indexer (figure 2).

Indexer properties panel

Figure 2 - Indexer panel in Properties for project_name

Name	Function
Select indexer	Dropdown list of available index options. + + Fast C/C++ Indexer - Source files will be indexed and eat up a lot of CPU time and memory during the first generation of the indexer. This can take some time depending on the size of your project. Afterwards the indexer will only reindex the relevant parts you changed in your code and not the whole source tree. + Full C/C++ Indexer - Performs a complete parse of all source files and takes up the most amount of time to complete. + No Indexer - Project source files are not indexed, therefore search features will not work accurately and code completion will not be available. +
Apply indexer to all projects now	Select this option to apply the Fast C/C++ Indexer option to all projects in your current workspace.
Rebuild the index when changing to a different build configuration	Select this option to rescan and index the source files for the current project when you change the active build configuration. The index will be built based on the active build configuration. All macros and header files used to build the index will be taken from the active build configuration.
Build the index only for the build configuration specified in the project's indexer settings + + Build the index only for the specified build configuration	The indexer will only be run for the build configuration specified in the Indexer panel in the project's property settings. All macros and header files used to build the index will be taken from the specified configuration. + + NOTE This option appears in the project properties indexer panel. A dropdown list is provided to select a build configuration for the currently selected project.

Related concepts

Active Build Configuration

Related tasks

Memory Rendering Options

You can configure the Memory Rendering pane to display data in the memory location in a variety of ways. The following options are visible on the context menu for the Memory Rendering pane.

You can configure the Memory Rendering pane to display data in the memory location in a variety of ways. The following options are visible on the context menu for the Memory Rendering pane.

Right-click to select an option shown in Table 1.

Table 1. Memory Rendering context menu options

Value pane (right) — Shows the current value of each corresponding expression. Double-click a value to change it.

Figure 1 shows the Expressions view.

Figure 1 - Expressions view

Table 1. Expressions view —items

Global Variables Window

The Global Variables window shows all global and static variables for each process that you debug. You can open separate Global Variables windows for each process in the same build target. Use the window to observe changes in variable values as the program executes.

Figure 1 shows the Global Variables window.

Figure 1 Global Variables window

Table 1 Global Variables window—items

Item	Explanation
File	Lists source files that declare global or static variables. Click a source file to view its static variables. Click Global Variables to view all global variables declared in the program.
Variables	Lists variables according to the file selected in the File pane. Double-click a variable to display it in a separate Variable window.

Opening the Global Variables Window

Use the Global Variables window to display global variables declared in a program or static variables declared in source files that comprise the program.

To open the Global Variables window, select View > Global Variables or Window > Global Variables Window.

Viewing Global Variables for Different Processes

You can open a separate Global Variables window for each process that the same parent application creates.

To open the Global Variables window for a particular process, follow these steps:

Click Project > Debug.

A debugging session starts.

In the Thread window toolbar, use the Process list box to specify the process that has the global variables that you want to examine.
Click View > Global Variables or Window > Global Variables Window.

Repeat these steps for each process that has global variables that you want to examine.

ArrayWindow

Array Window

The Array window allows manipulation of a contiguous block of memory, displayed as an array of elements. The window lists array contents sequentially, starting at -element 0.

The Array window title shows the base address bound to the array. The base address can bind to an address, a variable, or a register. An array bound to a local variable closes after the routine that defines the variable returns to the calling routine.

For array elements cast as structured types, a hierarchical control appears to the left of each element. Use these hierarchical controls to expand or collapse the display of each element’s contents.

Figure 1 shows an Array window. Table 1 explains the items in the window.

Figure 1 Array window

Table 1 Array window—items

Item	Icon	Explanation
Hierarchical control		Click to collapse the view of the information pane.
Bind To		Select the base address of the array: Address, Variable, or Register.
Array size		Enter the number of elements to display in the Array window.
Struct Member		Select a specific member to show in each element, or show all members.
Element		Shows the array elements in a hierarchical list.
Value		Shows the value of each array element.
Location		Shows the address in memory of each array element.

Opening an Array Window

Use the View Array command to manipulate a memory block in an Array window.

Select the array that you want to view.
Select Data > View Array.

A new Array window appears.

TIP Drag and drop a register or variable name into an Array window to set the base address. Use the View Memory As command to interpret memory displayed in an Array window as a different type.

Alternatively, use a contextual menu to open an Array window, as explained in Table 2.

Table 2 Opening an Array window by using a context menu

On this host…	Do this…
Windows	Right-click the array and select View Array.
Solaris	Click and hold on the array, then select View Array.
Linux	Click and hold on the array, then select View Array.

Memory View

Use the Memory view to inspect and change process memory. You can address memory using expressions such as:

0x0847d3c
(&y)+1024
*ptr
FNname + 1

You can configure your output to display traditional, hexadecimal, ascii and/or signed/unsigned decimal. You can also set the size of the rendering columns.

CAUTION Arbitrarily changing memory contents could degrade the stability of the IDE, another program, or the operating system itself. Understand the consequences of manipulating memory.

Figure 1 shows the Memory view.

Figure 2 - Memory view showing a memory rendering in traditional format

Table 1 Memory view—items

Item	Icon	Explanation
New Memory View		Click to add a new Memory monitor view.
Pin Memory Monitor		Pin memory view.
Refresh		Click to refresh the memory display.
Toggle Memory Monitors Pane		Toggles the current Memory monitors view between showing only a Memory Monitor pane and a Memory Monitor and Memory Rendering pane.
Toggle Split Pane		Alternately shows and hides the Memory Rendering pane.
Link Memory Monitor Panes		Enable to synchronize the current selection between the rendering of the same memory monitor .
Switch Memory Monitor		If different memory monitor views have been added, select from list of memory monitor views.
Add Memory Monitor / Add Rendering		Add a new memory address or variable to the Memory Monitors pane, or add a new rendering to the Memory Rendering pane.
Remove Memory Monitor / Remove Rendering		Remove the selected memory address or variable from the Memory Monitors pane, or remove the selected rendering from the Memory Rendering pane.
Remove All		Remove all memory monitors or renderings from the associated pane.

Each memory monitor rendering pane can be configured independently. Right-click in the Renderings pane to see the rendering options available. The options presented in the context menu may differ if you have not chosen the Traditional rendering view (Figure 2).

Figure 2 - Rendering pane options

Related tasks

Memory View

Use the Memory view to inspect and change process memory. You can address memory using expressions such as:

0x0847d3c
(&y)+1024
*ptr
FNname + 1

You can configure your output to display traditional, hexadecimal, ascii and/or signed/unsigned decimal. You can also set the size of the rendering columns.

CAUTION Arbitrarily changing memory contents could degrade the stability of the IDE, another program, or the operating system itself. Understand the consequences of manipulating memory.

Figure 1 shows the Memory view.

Memory view

Figure 2 - Memory view showing a memory rendering in traditional format

Table 1 Memory view—items

Item	Icon	Explanation
New Memory View		Click to add a new Memory monitor view.
Pin Memory Monitor		Pin memory view.
Toggle Memory Monitors Pane		Toggles the current Memory monitors view between showing only a Memory Monitor pane and a Memory Monitor and Memory Rendering pane.
Toggle Split Pane		Alternately shows and hides the Memory Rendering pane.
Link Memory Monitor Panes		Enable to synchronize the current selection between the rendering of the same memory monitor .
Switch Memory Monitor		If different memory monitor views have been added, select from list of memory monitor views.
Add Memory Monitor / Add Rendering		Add a new memory address or variable to the Memory Monitors pane, or add a new rendering to the Memory Rendering pane.
Remove Memory Monitor / Remove Rendering		Remove the selected memory address or variable from the Memory Monitors pane, or remove the selected rendering from the Memory Rendering pane.
Remove All		Remove all memory monitors or renderings from the associated pane.

Figure 2 - Rendering pane options

Related tasks

Registers Details Window

The Register Details window (Windows OS) lets you view detailed information about individual bits of registers from 2 bits to 32 bits in size. This window shows information for both system registers and memory-mapped registers. To open the Register Details window, click View > Register Details or Window > Register Details Window.

The Register Details window has fields that describe the register, its bitfields, and the values of those bitfields. XML files in the Registers folder of your Carbide installation provide the information that appears in the window. The Registers folder is inside the Support folder. The Support folder is inside the Plugins folder of your Carbide installation.

Figure 1 shows the Register Details window. Table 1 explains items in the window.

Figure 1 Register Details window
-

Table 1. Register Details window—items

Item	Icon	Explanation
Description File text box		Enter the name or full path to the XML file for the register you want to view, or click the Browse button to open a dialog box that you can use to specify the file.
Register Name		Shows the name of the register depicted in the window.
Address text box		Enter the starting address of the register values that you want to see in the Register Display. - An error message appears if you enter an invalid starting address.
Format list box		Specify the data format for bit values in the Register Display: - - Binary - Character - Decimal - Unsigned Decimal - Hexadeccimal - Default—have the IDE determine the best format -
Register Display		Shows a depiction of the register that you specify in the Description File text box, including individual register bits and their values.
Bitfield Name list box		Specify a bitfield to highlight in the Register Display. The Description portion of the window reflects available information for the bitfield. - Select None to have the Description portion of the window reflect information for the entire register and not a bitfield in that register.
Bit Value text box		Shows the current value of the bits in the Bitfield Name list box, according to the format that you specify in the Format list box. - Click the spin buttons to increment or decrement the current value, or enter a new value in the text box. - Changing the value changes only the Register Display. You must click the Write button to write the new value to the register itself.
Bit Value Modifier list box		Specify a new value for the selected bitfield, or view a brief explanation of specific bitfield values. - Changing the value changes only the Register Display. You must click the Write button to write the new value to the register.
Description		Shows a description of the register or a selected bitfield in the register. - Use the Description File text box to specify the register. - Use the Text View list box to view specific register information, such as register descriptions, bitfield descriptions, and register details.
Revert button		Click to change a modified value in the Register Display to its original value. - If you clicked the Write button to write a new value to the register, you cannot revert that value.
Read button		Click to have the Register Display reflect current bit values from the register itself.
Write button		Click to write the bit values in the Register Display to the register. - After you write new values to the register, you cannot revert them.
Reset Value button		Click to restore the default value for the selected bitfield. - The IDE disables this button if the selected bitfield does not have a default value.
Text View list box		Use to specify information that appears in the Description portion of the window.

Description File

Enter in this text box the name of the register that you want to see in the Register Display of the Register Details window. Alternatively, enter the full path to the register description file on your computer, or click the Browse button to open a dialog box that lets you specify the register description file. The text box is not case sensitive.

After you enter a name or path, the debugger searches for a matching register description file in the Registers folder of your Carbide installation and the project access paths. If the debugger finds a matching file, the Register Display updates the information in the Register Details window. If the debugger does not find a matching name, an error message appears.

For example, to view the contents of the Opcode register, you can:

type Opcode in the Description File text box and press Enter or Return, or
type the full path to the opcode.xml file in the Registers folder and press Enter or Return.

The debugger matches your entry with the opcode.xml file in the Registers folder. The Register Display in the Register Details window updates its information to show Opcode register details.

The debugger also updates the Register Display to show the current values in the register. If the debugger fails to update the display, an error message appears.

Register Display

This display shows the current contents of 32 bits of register data, starting at the address that you specify in the Address text box. The data appears according to the format that you specify in the Format list box.

The Register Display groups the 32 bits of data into register bitfields. Clicking one of the bits selects its associated bitfield. Additional information about the bitfield, such as its name and permissions, appears in the Description portion of the Register Details window.

Text View

Use this list box to change the information that appears in the Description portion of the Register Details window:

Auto—select to have the IDE determine which information to display in the window
Register Description—select to show information about the entire register, such as the name of the register itself and the meaning of its contents
Bitfield Description—select to show information about the selected bitfield in the Register Display, such as the name of the bitfield and its access permissions
Register Details—select to show in-depth information about the current register, such as its name, its bit values, and bit-value explanations
-

Signals View

Signals view

Signals View

The Signals view of the Debug perspective lets you view the signals defined on the selected debug target and how the debugger handles each one.

NOTE Currently Carbide.c++ does not support this CDT feature.

Figure 1 shows the Signals view.

Signals view

The Signals view of the Debug perspective lets you view the signals defined on the selected debug target and how the debugger handles each one. Figure 1 shows the Signals view.

Figure 1 - Signals view

Table 1 Signals view—items

System Browser View

The System Browser view shows system level information about processes executing on various machines, like the host computer or the hardware under debugger control. The view shows this information:

running processes
tasks for selected processes
some hidden processes

Click on the expand icon for a process to view all tasks assigned to the selected process. Processes under debugger control appear in bold. Double-click a task to open it in a new Thread window, or choose the task name and click the Stack Crawl View button.

Table 1 explains items in the window.

NOTE If the System Browser view does not show processes for a specific machine, you will need to start a debugging session for that machine. For example, you might need to debug a project that runs on external hardware in order to see executing processes for that hardware.

Table 1 System Browser view—items

Item	Icon	Explanation
Attach to Process		Click to have the debugger control the selected process.
Stack Crawl view		Click to open a Thread window for the selected process.
Refresh		This icon indicates that information for selected item is periodically updated. Click this icon to toggle between refresh and no refresh.
No Refresh		This icon indicates that information is not updated for the selected item.
Expand		Click to expand a process and list related tasks.

Related concepts

Preferences

Figure 1 - Build workspace preferences page

The following options are available in both the global Build preference panel and the project Properties > Carbide.c++ > Carbide Project Settings panel.

The following options are available in both the global Build preference panel and the project Properties > Carbide.c++ > Project Settings panel.

Table 1 Build Preferences —items

sbsv1 tab

Figure 2 - SBSv1 tab

Table 2 Symbian Build System v1 tab

If not enabled, the Symbian OS command line build system handles all dependency tracking by generating the dependency information in the makefiles. Because it does this for all project files, regardless of the number of changes, it can result in a performance penalty. A single edit in a MMP file forces a complete regeneration of the makefile dependency information for all project files.

Explanation
Clean level	Clean level	Specifies the level of clean to perform on project files. The levels include: Level 0 (abld clean) - removes all the intermediate files created during compilation, and all the executables and import libraries created by the linker Level 1 (abld reallyclean) - performs a clean operation, but also removes all exported files and makefiles Level 2 (abld reallyclean, bldmake clean) - performs a reallyclean operation and then removes all files created by bldmake - -
Manage dependency tracking (improves build speed)	Manage dependency tracking (improves build speed)	Enable to have Carbide manage the dependency tracking for source and resource files. Carbide does this by separating out the generation of dependency information from the makefile and managing the entire process. All builds now can quickly compare whether new dependency information is required due to changes in a source file and only build those that need updating. - If not enabled, the Symbian OS command line build system handles all dependency tracking by generating the dependency information in the makefiles. Because it does this for all project files, regardless of the number of changes, it can result in a performance penalty. A single edit in a MMP file forces a complete regeneration of the makefile dependency information for all project files. -
Show a dialog to modify build actions when modified MMPs are detected	Enable to have Carbide ask before starting a build what action to take when modified files are detected. When disabled, do not show a dialog but use the default action listed below. -	Show a dialog to modify build actions when modified MMPs are detected	Enable to have Carbide ask before starting a build what action to take when modified files are detected. When disabled, do not show a dialog but use the default action listed below.
Default action to take when mmp files are modified	Default action to take when mmp files are modified	Defines the default action Carbide should execute when it detects modified MMP files and the option above is disabled: None Link Only Compile and Link - -
Do not offer to track dependencies for projects build on command-line

sbsv2 tab

Figure 3 - SBSv2 tab

Table 3 Symbian Build System v2 tab

Related references

Carbide.c++ preferences

The -Carbide.c++ panel in the Preferences window provides an option to keep your projects updated when you add or create files. Figure 1 shows the Carbide.c++ preference panel.

Preferences

Carbide.c++ preference panel

Figure 1 - Carbide.c++ preferences page

Table 1 Carbide.c++ Preferences —items

Code Styles preferences

Carbide supports the use of code styles in projects via the C/C++ Code Style preference panel. Use a code style profile to set specific smart typing features, like indentation, tabs or spaces, and many more options. There are several preset code styles like GNU, while Carbide supplies these profiles:

Carbide supports the use of code styles in projects via the C/C++ Code Style preference panel. Use a code style profile to set specific smart typing features, like indentation, tabs or spaces, and many more options. There are several built-in code styles like GNU, Whitesmith, and others, while Carbide supplies these additional styles:

Symbian OS — settings are based on the Symbian OS C++ coding standards PDF
S60 — settings are based on the S60 Platform: C++ Coding Conventions
Symbian OS — settings are based on the Symbian OS C++ coding standards
S60 — settings are based on the C++ Developer's Library > C++ Coding Conventions
Qt — settings for Qt projects

Setting a code style sets it for the entire workspace. When a new file is created the currently selected code style rules are applied as you edit the file. You can apply a set of rules to a previously created source file by opening it in an editor view, then right-clicking and choosing Source > Format (CTRL+SHIFT+F).

Figure 1 - Code Style preference panel

Related references

Code Style preferences
Open an editor view with the source file you want to reformat
Right-click and choose Source > Format (CTRL+SHIFT+F)

Figure 1 -Selecting Source > Format from an editor view

Figure 1 -Selecting Source > Format from within an editor view

Related references

Code Styles preferences

Setting the Workspace Code Style

You can set the default code style for a workspace using the Code Style preference panel. Once set, the specified code style is applied to all new files and projects created in the workspace. To update a source file already in the workspace, see Reformatting a Source File.

Figure 1 -Select a profile from the Select a profile list

You can also create your own profiles based on the one's included with Carbide. Simply click Edit and change the options presented in the Profile <profile_name> window that appears.

To set the workspace code style

diff -r 8f60724893da -r d9c69c1b932e core/com.nokia.carbide.cpp.doc.user/html/tasks/images/menu_reformat_source_file.png Binary file core/com.nokia.carbide.cpp.doc.user/html/tasks/images/menu_reformat_source_file.png has changed