4.1 Opening the Configuration Editor
The Configuration Editor can be opened in multiple ways:
- From the GUI using the Open button on the Configuration tab.
- By calling monkeyproof.cc4m.openConfigurationFile(configFile); where configFile is an optional input: the configuration file to edit and activate. If left out, the currently active configuration file is opened.
-
By clicking one of the links in a Code Checker for MATLAB report:
- In the Metadata section, the Open button next to the configuration file path.
- At a check’s information, the Open check configuration link. If the check is not yet configured, you will be prompted to add it to your configuration file so that you can edit it.
- In the parameter information table of a check, the Open link. If the parameter is not yet configured, you will be prompted to add it to your configuration file so that it can be edited.
As the Configuration Editor opens, the active configuration file is validated against a Schema file. If it succeeds, you will see an interface as shown in Figure 4.1↓. If the Schema validation fails, you will see a message describing why it fails. The configuration file can not be loaded and you will have to either open another configuration file, or edit the current configuration file in a text editor and try to open it in the Configuration Editor again.
After successfully opening your file, you will see the following things:
- The full path of the currently opened configuration file.
- The editable description of the configuration file.
-
A list of Code Checker for MATLAB checks and reports with for each check/report the following information:
- Rule identifier
- Description
- Name
- Whether or not they are enabled.
If you already have an opened Configuration Editor in the current MATLAB session, the actions listed above will simply bring the window forward. Remark: In MATLAB R2017b, minimized Configuration Editor windows will remain minimized when one of these actions are performed. Resizing the application may not work properly for MATLAB R2017b. Maximizing the window makes sure all controls are at least accessible.
