Configuration Files

• Configuration Files in CodeSonar
• Configuration File Loading
• Understanding and Editing Configuration Files
• More Information

Configuration Files in CodeSonar

CodeSonar uses a set of configuration files to control aspects of the project build/analysis process. The following table summarizes the configuration file types.

projdir/P.conf

$CSONAR/codesonar/default_presets/

$CSONAR/codesonar/presets/PresetName.conf

$CSONAR/csurf/compiler_confs/C.A.L.S.conf
$CSONAR/csurf/compiler_confs/C.L.S.conf

projdir/P.C.L.S.conf
projdir/P.C.A.L.S.conf

Configuration Files Loaded

Configuration files are loaded in the build interval, the analyze interval, and by codesonar submit-results. The set of loaded configuration files depends on which of these contexts applies, and loading order is fixed.

• In the build interval, CodeSonar loads configuration files every time it recognizes a compilation unit in the CodeSonar-facing build.
• In the analyze interval, CodeSonar loads configuration files at the beginning of parse mode, then loads them again at the beginning of analysis mode.
• codesonar submit-results loads configuration files every time it is invoked. Note that the majority of configuration options are not relevant to codesonar submit-results and will not affect its behavior.

Which configuration files are loaded?

The following table shows which configuration files are loaded by the CodeSonar build/analysis and codesonar submit-results.

[*] If P.conf doesn't exist, CodeSonar generates it from $CSONAR/codesonar/template.conf.

[**] If the project-compiler configuration file doesn't exist, CodeSonar generates it as described as described above

Understanding and Editing Configuration Files

All configuration files contain internal documentation covering file format, usage guidelines, and the parameters used in the files.

The documentation for individual parameters has been incorporated into this manual:

• Compiler-Independent Configuration File Parameters (index) describes the parameters in the general template and general project configuration files. Some of these parameters are related to the build interval, others to the analyze interval.
• Compiler-Dependent Configuration File Parameters (index) describes the parameters in the compiler templates and project-compiler configuration files. These parameters generally specify aspects of type representation and layout for the target platform.

  Note that there is no point in adding settings for analysis-related parameters (such as WARNING_FILTER) to a compiler template or project-compiler configuration file, since these configuration files are not loaded during the analyze interval.

Any configuration file can be edited directly in your text editor: the configuration file header contains a thorough explanation of the file format and usage guidelines. In addition, you can edit the general project configuration file by clicking the Configuration File "Change..." button in the second screen of the Windows Build Wizard.

• Which configuration file(s) should you edit?
• Creating/Reverting a Configuration File
• Upgrading Configuration Files
• Multiple Definitions
• Changing Parameter Settings
• User-Defined Variables

Which configuration file(s) should you edit?

projdir/P.conf

$CSONAR/csurf/compiler_confs/C.L.S.conf

$CSONAR/csurf/compiler_confs/C.A.L.S.conf

projdir/P.C.L.S.conf

projdir/P.C.A.L.S.conf

$CSONAR/codesonar/presets/PresetName.conf

Creating/Reverting a Configuration File

Use the codesonar create-conf command to create new project configuration files or revert existing ones to their initial state.

This command creates a new general project configuration file for pfilesname by copying the general template to a file called pfilesname.conf in your working directory, commenting out all content.

If compilername is specified, it also creates new project-compiler configuration files by copying all compiler configuration file templates with names of the form compilername.L.S.conf to the corresponding pfilesname.compilername.L.S.conf.

Upgrading Configuration Files

To update your configuration files when you upgrade CodeSonar, see Upgrading Configuration Files.

Multiple Definitions

If a configuration file defines a parameter that has already been defined (in a previously-read file or earlier in the current file), CodeSonar processes it as follows.

• For SOURCE_PATTERN_REPLACEMENT, each new definition is appended to the existing list of definitions.
• For IGNORED_COMPILATIONS, each new definition is appended to the existing list of definitions.
• Otherwise, if the parameter is specified with +=, the definition is appended to the previous definition (except CFLAGS_PREPEND and EDG_FRONTEND_OPTIONS_PREPEND, for which it is prepended).
• Otherwise, the definition replaces any previous definition.

Changing Parameter Settings

You can change a parameter setting in multiple ways.

• Editing one of the configuration files used by the build/analysis.
• Changing the set of presets or additional configuration files specified for the build/analysis.
• Changing the set of default presets available to the build analysis, either by adding or removing default presets or by specifying -no-default-presets.
• Changing the order in which presets or additional configuration files are specified.

Between two base analyses of the same project. You can change all parameter settings.

Between incremental parent and incremental child analyses. You can change most parameter settings. Parameters whose settings should not be changed for incremental analyses are tagged as such in documentation and listed in the configuration parameter index.

Between two codesonar build invocations, or between codesonar build and codesonar analyze. You may need to change settings for compiler-dependent configuration file parameters, and for compiler-independent parameters that affect parsing: for example, you may need to change CFLAGS_APPEND/CFLAGS_PREPEND settings to specify different -D or -I flags, or adjust various parallelism settings to account for changes in machine availability. However, do not change settings for parameters that control information used by the analysis phase. Parameters whose settings should not be changed between stages of a single build/analysis are tagged as such in documentation and listed in the configuration parameter index.
If you are using any presets or other additional configuration files, do not change the set of files or the order in which they are specified. This includes default presets as well as presets explicitly included with -preset or loaded as extra configuration files with -conf-file.

When invoking codesonar submit-results to submit accumulated offline information. If you are using any presets or other additional configuration files, do not change the set of files or the order in which they are specified. This includes default presets as well as presets explicitly included with -preset or loaded as extra configuration files with -conf-file.

User-Defined Variables

You can define and use your own variables in configuration files. For example:

set MYVAR = aou
set MYVAR_PLUS = ${MYVAR}ee

# replaces aou with aouee in source code
SOURCE_PATTERN = s/${MYVAR}/${MYVAR_PLUS}/

set MYVAR += eeiou
# replaces aoueeiou with aouee in source code
SOURCE_PATTERN = s/${MYVAR}/${MYVAR_PLUS}/

Less-elegant uses of these variables are also possible. For example, consider the effect of changing the definition of TOGGLE from <nothing> to # in the following:

set TOGGLE =
${TOGGLE} SOURCE_PATTERN = s/abc/def/
${TOGGLE} SOURCE_PATTERN = s/efg/xyz/

More Information

The following sections contain further information about configuration files.