Files Panel

When a file is selected, its name is highlighted in bold within the panel and the source code is displayed in the Editor. Diagnostic results are displayed in the Analysis Results/Diagnostics panel.

Each of the analyzed source files and header files in the project is displayed with a corresponding icon, which indicates whether analysis results are up to date (indicated by a green icon with a tick), out of date (indicated by a blue icon with a clock), or whether there is a parsing error (indicated by a red warning icon). Hovering over an 'out-of-date' file in the Files Panel displays a tooltip describing what analysis needs to be done and why.

The Active and Total column counts show the current and overall numbers of diagnostic messages found in each file, respectively. The Active count can differ from the Total count for either of the following reasons:

You can view the results from more than one file by using the following selection methods:

  • CTRL-Left_Click: select or deselect individual files or directories
  • SHIFT-Left_Click: select a range of files/directories.
  • Left_Click: select just one file/directory (and deselect all others).

Selecting a directory will automatically select all files within that directory and its subdirectories.

Deselecting a directory will deselect all files within that directory and its sub-directories.

It is the group of selected files that dictates the content of the Rule Groups and Message Levels panels. In order to migrate quickly to "parsing errors":

  1. Select the files of interest - this may be the top-level directories if the files are unknown.
  2. In the Message Levels tab, collapse the Warnings category - this brings the Errors category into view.
  3. Right-click on the required error message and select Show Only.
  4. The affected files are listed in the Analysis Results/Diagnostics panel.

Each selected file, or group of selected files, has an associated context menu, selected by right-clicking. The available options are as follows:

  • Analyze Selected File(s)
  • Clean Selected Files(s)
  • Open Preprocessed <file name>
  • Remove
  • Generate Report For Selected File(s)
  • Upload Selected Files To Dashboard
  • Upload Selected Files To Structure 101

The context menu for a directory displays the following additional items:

  • Expand All Below
  • Collapse All Below
  • Add File(s)

Tools such as RCMA can generate messages that do not belong in a single location in a particular source file. To display these messages there is a tree node named "CMA" (Cross-Module Analysis) in the Files panel. When the "CMA" node is selected, the messages are shown in the Analysis Results/Diagnostics panel (refer to Viewing and Filtering the Diagnostics).

The Raw Sources node displays any manually added raw source files, that is to say, preprocessed source files ending in .i. These are designed to be used for temporary analysis only, and are not maintained as part of the project. To add a raw source file:

  1. Select Analyze : Open Analysis Settings in the GUI and ensure that Generate Preprocessed Source for Analyzed Files is checked.
  2. Select Analyze : Analyze Raw Source File, and complete the resultant dialog as in the remaining steps.
  3. Select the language of the file that you wish to analyze.
  4. Click and, navigate to prqa/configs/<config_name>/output/_SOURCE_ROOT to select your .i file.
  5. Click OK to analyze the file.
  6. The Raw Sources node appears.

There are two context menu options available for raw source files.

  • Raw Source Analysis: This performs analysis on the selected raw source files.
  • Clean/Remove Selected File(s): This cleans the results of the selected raw source files and removes the files from the project tree.

At the bottom of the Files panel is the collapsible summary table. It gives summary diagnostics for a single selected file.

It contains fields for the Include Paths and Definitions used by the file. Once you click the Edit button on the right of one of the highlighted fields, a text window opens up so that you can specify the particular path or definition.

At the bottom of the summary table, there’s a Parent Attributes section. This section dynamically populates with fields relating to inherited data from higher level folders. In the same way, folders have their own summaries which can be edited.

The Files panel has two viewing modes that can be switched between via the sub-menu:

  • Helix QAC menu : Admin sub-menu : Manage GUI Settings

This action can also be performed from any context menu invoked on the panel. The first mode separates source and header files within the tree, placing all header files inside the Includes folder; the second mode will place the header files in the existing source tree structure. Header files located externally to the source structure, or the project root directories, are situated within the External Includes folder.