Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: REM Cost Reform

...

In this noncompliant code example, two enumerators of type Color are assigned explicit values. It may not be obvious to the programmer that yellow and indigo have been declared to be identical values (6), as are green and violet (7). Probably the least dangerous error that can result from such a definition is attempting to use the enumerators as labels of a switch statement. Because all labels in a switch statement are required to be unique, the following code violates this semantic constraint and is required to be diagnosed by a conforming compiler:

Code Block
bgColor#FFCCCC
langc
enum Color { red=4, orange, yellow, green, blue, indigo=6, violet };

const char* color_name(enum Color col) {
  switch (col) {
  case red: return "red";
  case orange: return "orange";
  case yellow: return "yellow";
  case green: return "green";
  case blue: return "blue";
  case indigo: return "indigo";   //* errorError: duplicate label (yellow) */
  case violet: return "violet";   //* errorError: duplicate label (green) */
  }
}

Compliant Solution

To prevent the error discussed of the noncompliant code example, enumeration type declarations must take one of the following forms:

  • provide Provide no explicit integer assignments, as in this example:
Code Block
bgColor#ccccff
langc
enum Color { red, orange, yellow, green, blue, indigo, violet };
  • assign Assign a value to the first member only (the rest are then sequential), as in this example:
Code Block
bgColor#ccccff
langc
enum Color { red=4, orange, yellow, green, blue, indigo, violet };
  • assign Assign a value to all members so any equivalence is explicit, as in this example:

...

It is also advisable to provide a comment explaining why multiple enumeration type members are being assigned the same value so that future maintainers do not mistakenly identify this form as an error.

Of these three options, the first, "provide providing no explicit integer assignments ," is the simplest and consequently the preferred approach unless the first enumerator must have a nonzero value.

Exceptions

Anchor
INT09-EX1
INT09-EX1

INT09-C-EX1: In cases where defining an enumeration with two or more enumerators with the same value is intended, the constant expression used to define the value of the duplicate enumerator should reference the enumerator rather than the original enumerators enumerator's value. This practice makes the intent clear to both human readers of the code and automated code analysis tools that detect violations of this guideline and would diagnose them otherwise. Note, however, that it does not make it possible to use such enumerators in contexts where unique values are required (such as in a switch statement, as discussed earlier).

...

Failing to ensure that constants within an enumeration have unique values can result in unexpected results.

Recommendation

Severity

Likelihood

Remediation Cost

Detectable

Repairable

Priority

Level

INT09-C

low

Low

Probable

probable

Yes

medium

No

P4

L3

Automated Detection

Tool

Version

Checker

Description

Astrée
Include Page
Astrée_V
Astrée_V
enum-implicit-valueFully checked
Axivion Bauhaus Suite

Include Page
Axivion Bauhaus Suite_V
Axivion Bauhaus Suite_V

CertC-INT09
CodeSonar
Include Page
CodeSonar_V
CodeSonar_V
LANG.STRUCT.INIT.ENUMInconsistent Enumerator Initialization
Compass/ROSE

 

 

 




ECLAIR

Include Page
ECLAIR_V
ECLAIR_V

CC2.INT09

Fully implemented

Helix QAC

Include Page
Helix QAC_V
Helix QAC_V

C0724
Klocwork
Include Page
Klocwork_V
Klocwork_V
MISRA.ENUM.IMPLICIT.VAL.NON_UNIQUE.2012
LDRA tool suite
Include Page
LDRA_V
LDRA_V

85 S, 630 S

Fully implemented

PRQA QA-C Include PagePRQA_VPRQA_V

0722
0723

Parasoft C/C++test
Include Page
Parasoft_V
Parasoft_V

CERT_C-INT09-a

In an enumerator list, the "=" construct shall not be used to explicitly initialise members other than the first, unless all items are explicitly initialised

PC-lint Plus

Include Page
PC-lint Plus_V
PC-lint Plus_V

488, 9148

Partially supported

Polyspace Bug Finder

Include Page
Polyspace Bug Finder_V
Polyspace Bug Finder_V

CERT C: Rec. INT09-C

Checks for situations where enumeration constants map to same value (rec. fully covered)

RuleChecker
Include Page
RuleChecker_V
RuleChecker_V
enum-implicit-valueFully checked
Fully implemented

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

Related Guidelines

...


...

Image Modified Image Modified Image Modified