23.7.35 Misnamed_Identifiers

Flag the declaration of each identifier that does not have a suffix corresponding to the kind of entity being declared. The following declarations are checked:

• type declarations
• subtype declarations
• constant declarations (but not number declarations)
• package renaming declarations (but not generic package renaming declarations)

This rule may have parameters. When used without parameters, the rule enforces the following checks:

• type-defining names end with _T, unless the type is an access type, in which case the suffix must be _A
• constant names end with _C
• names defining package renamings end with _R

Defining identifiers from incomplete type declarations are never flagged.

For a private type declaration (including private extensions), the defining identifier from the private type declaration is checked against the type suffix (even if the corresponding full declaration is an access type declaration), and the defining identifier from the corresponding full type declaration is not checked.

For a deferred constant, the defining name in the corresponding full constant declaration is not checked.

Defining names of formal types are not checked.

The rule may have the following parameters:

• For the +R option:

  Default

  Sets the default listed above for all the names to be checked.
  

  Type_Suffix=string

  Specifies the suffix for a type name.
  

  Access_Suffix=string

  Specifies the suffix for an access type name. If this parameter is set, it overrides for access types the suffix set by the Type_Suffix parameter. For access types, string may have the following format: suffix1(suffix2). That means that an access type name should have the suffix1 suffix except for the case when the designated type is also an access type, in this case the type name should have the suffix1 & suffix2 suffix.
  

  Class_Access_Suffix=string

  Specifies the suffix for the name of an access type that points to some class-wide type. If this parameter is set, it overrides for such access types the suffix set by the Type_Suffix or Access_Suffix parameter.
  

  Class_Subtype_Suffix=string

  Specifies the suffix for the name of a subtype that denotes a class-wide type.
  

  Constant_Suffix=string

  Specifies the suffix for a constant name.
  

  Renaming_Suffix=string

  Specifies the suffix for a package renaming name.

• For the -R option:

  All_Suffixes

  Remove all the suffixes specified for the identifier suffix checks, whether by default or as specified by other rule parameters. All the checks for this rule are disabled as a result.
  

  Type_Suffix

  Removes the suffix specified for types. This disables checks for types but does not disable any other checks for this rule (including the check for access type names if Access_Suffix is set).
  

  Access_Suffix

  Removes the suffix specified for access types. This disables checks for access type names but does not disable any other checks for this rule. If Type_Suffix is set, access type names are checked as ordinary type names.
  

  Class_Access_Suffix

  Removes the suffix specified for access types pointing to class-wide type. This disables specific checks for names of access types pointing to class-wide types but does not disable any other checks for this rule. If Type_Suffix is set, access type names are checked as ordinary type names. If Access_Suffix is set, these access types are checked as any other access type name.
  

  Class_Subtype_Suffix=string

  Removes the suffix specified for subtype names. This disables checks for subtype names but does not disable any other checks for this rule.
  

  Constant_Suffix

  Removes the suffix specified for constants. This disables checks for constant names but does not disable any other checks for this rule.
  

  Renaming_Suffix

  Removes the suffix specified for package renamings. This disables checks for package renamings but does not disable any other checks for this rule.

If more than one parameter is used, parameters must be separated by commas.

If more than one option is specified for the gnatcheck invocation, a new option overrides the previous one(s).

The +RMisnamed_Identifiers option (with no parameter) enables checks for all the name suffixes specified by previous options used for this rule.

The -RMisnamed_Identifiers option (with no parameter) disables all the checks but keeps all the suffixes specified by previous options used for this rule.

The string value must be a valid suffix for an Ada identifier (after trimming all the leading and trailing space characters, if any). Parameters are not case sensitive, except the string part.

If any error is detected in a rule parameter, the parameter is ignored. In such a case the options that are set for the rule are not specified.