RuleWizard can automatically create rules that flag a given code pattern (see Creating a Rule Automatically). In this lesson, you will learn how to use the Auto-Create feature to create two rules:

Example 1 - Begin Class Names with an Upper Case Letter


Creating the Basic Rule Pattern

  1. Choose New> Rule from the menu bar. 
  2. Choose C,C++ from the Dictionary drop-down menu and enable the Auto-Create option.
  3. Enter the code pattern that you want the rule to identify and click OK.

    A graphical representation, as well as the source pattern, will be added to panel on the right-hand side.
  4. We want to make sure that the rule checks as many class names as possible. Right-click the Name node and choose Modify.
  5. Enter a pattern in the Regexp field to scan for all lowercase characters, i.e., ^[a-z].
  6. Click OK. Your rule will now report a violation if a class name begins with a lowercase letter.

Customizing the Output Message

We need to specify what to print when this rule is violated.

  1. Right-click the output arrow and choose Modify from the shortcut menu.
  2. Enter the message that you want the product to deliver when this rule is violated, e.g., A class name does not begin with a capital letter.
  3. Click OK to save the output message.

The rule is now functionally complete, but additional steps must be taken before it can be used.

Customizing Rule Properties

At a minimum, you must specify a rule ID and a rule header (name).

  1. Right-click an empty area in the GUI panel and choose Properties from the shortcut menu.
     
  2. Click the Properties tab and specify your rule properties (see Customizing Rule Properties for details)
     
  3. Click the Description tab and enter information about the rule. The description is part of the rule documentation.
  4. Click OK.

Saving and Enabling Your Rule

Before you can check your rule, you need to save and enable it as described in Saving and Enabling Rules.

Viewing Rule Documentation

Information about the rule will be included in RuleWizard’s Rules Documentation files. To view this documentation, click the View RuleDocs button in the toolbar. To refresh this documentation, click the Update RuleDocs button in the toolbar. These buttons are described in the Tool Bar chapter.


Example 2 - Begin Private Field Names With an Underscore


Creating the Basic Rule Pattern

  1. Choose New> Rule from the menu bar. 
  2. Choose C,C++ from the Dictionary drop-down menu and enable the Auto-Create option.

  3. Enter the code pattern that you want the rule to identify and click OK.

    In our example, there is a space between int and _i;. It should be typed exactly like this: int _i;

    A graphical representation, as well as the source pattern, will be added to panel on the right-hand side.

  4. We want to manually add permissions and restrict body variables. Right-click the Body node and choose Modify.
  5. Choose Declarations> Variables> Member Variable and click OK.
  6. Right-click the Body node again and choose Permission (M).
  7. Enable the private option when prompted and click OK.

The basic functionality of your rule is configured.

Modifying the Rule Pattern

  1. Because class name is irrelevant in the rule that you want to create, remove the rule node that looks for a class with a specific name. Right-click the top Name node containing the regular expression ^A$ and choose choose Edit> Delete.
  2. We also want the rule to find instances in which a private field does not begin with an underscore character. Right-click the Name node containing the regular expression ^_i$ and choose choose Modify from the shortcut menu.
  3. Enter _ (underscore character) in the Regexp field when prompted and enable the Negate option.
  4. Click OK.
  5. We want the rule to be independent of the field type. Double-click the Type node and choose the Type folder.
  6. Click OK. At this point, the rule is triggered when the static analysis tool finds classes that have at least one private member variable that do not begin with an underscore. But we need to move the output from the Class node to the Body> Member Variable node to enable the rule to trigger on member variables that do not begin with an underscore.
  7. Right-click the output arrow class beneath the Class node and choose Edit> Cut.
  8. Right-click the Body node and click Edit> Paste.

Customizing the Output Message

We need to specify what to print when this rule is violated.

  1. Right-click the output arrow and choose Modify from the shortcut menu.
  2. Enter the message that you want the product to deliver when this rule is violated, e.g., A private field’s name does not begin with an underscore character.
  3. Click OK to save the output message.

The rule is now functionally complete, but the rule properties must be set before it can be saved and enabled.

Customizing Rule Properties

At a minimum, you must specify a rule ID and a rule header (name).

  1. Right-click an empty area in the GUI panel and choose Properties from the shortcut menu.  
  2. Click the Properties tab and specify your rule properties (see Customizing Rule Properties for details) 
  3. Click the Description tab and enter information about the rule. The description is part of the rule documentation.
  4. Click OK.

Saving and Enabling Your Rule

Before you can check your rule, you need to save and enable it as described in Saving and Enabling Rules.

Viewing Rule Documentation

Information about the rule will be included in RuleWizard’s Rules Documentation files. To view this documentation, click the View RuleDocs button in the toolbar. To refresh this documentation, click the Update RuleDocs button in the toolbar. These buttons are described in the Tool Bar chapter.