AUTOSAR C++14 Rule A5-1-1

Literal values shall not be used apart from type initialization, otherwise symbolic names shall be used instead

Description

Rule Definition

Literal values shall not be used apart from type initialization, otherwise symbolic names shall be used instead.

Rationale

Improve the readability and maintainability of code by using symbolic names. Literal constants do not clearly indicate what the constant represents

Polyspace Implementation

Polyspace^® flags the use of literal values other than those with the data type char in expressions and case clauses of a switch statement.

Polyspace does not flag the use of literal values in logging mechanisms.

Polyspace does not flag the use of literal values '0' and '1' in expressions, as they are often part of the logic of the code. For instance, '0' represents a NULL pointer.

Troubleshooting

If you expect a rule violation but Polyspace does not report it, see Diagnose Why Coding Standard Violations Do Not Appear as Expected.

Examples

expand all

Avoid Using Literal Values

double foo(void){
	constexpr int speedLimit = 65;
	constexpr double coeff = 0.2;
	int flag{0};
	int negOne{-1};
	//... 
	return (flag)?speedLimit*coeff*negOne + 35 //Noncompliant
			: speedLimit*coeff*negOne - 35; //Noncompliant
}

double bar(void){
	constexpr int speedLimit = 65;
	constexpr double coeff = 0.2;
	int flag{0};
	int negOne{-1};
	int addedValue = 35;
	return (flag)?speedLimit*coeff*negOne + addedValue //Compliant
			: speedLimit*coeff*negOne - addedValue; //Compliant
}

In this example, Polyspace flags the use of literal values in the return expression of foo. In bar, the return expression uses symbolic names, which makes code more readable. The use of literals to initiate objects does not violate this rule.

Check Information

Group: Expressions

Category: Required, Partially automated

Version History

Introduced in R2019a

expand all

R2023b: Checker correctly handles declarations using `enum` values

The rule checker no longer reports a violation when you use an enum value in a declaration. For instance, in this code snippet, the use of enum value Medium to initialize myArray is compliant.

namespace enumArray
{
        enum Size
        {
                Small = 5,
                Medium = 10,
                Large = 15
        };

        template <typename T, int N>
        class Array
        {
        public:
                Array() = default;
                // Define accessor functions
        };
};

int main()
{
    using myArray =
        enumArray::Array<int,
                         static_cast<int>(enumArray::Size::Medium)>; // Compliant
        return 0;
}

Previously, Polyspace reported a violation when using an enum value in a declaration.

R2022b: Checker correctly handles range-based `for` loops

The rule checker no longer reports a violation on range-based for loops. For instance:

for (auto & l_Button : m_pButtonArray) //Compliant
    {
        l_Button = new SelectionButton(this);
    }

Previously, the rule checker reported a violation on range-based for loops that did not use literal values.

AUTOSAR C++14 Rule A5-1-1

Description

Rule Definition

Rationale

Polyspace Implementation

Troubleshooting

Examples

Avoid Using Literal Values

Check Information

Version History

R2023b: Checker correctly handles declarations using `enum` values

R2022b: Checker correctly handles range-based `for` loops

See Also

Topics

AUTOSAR C++14 Rule A5-1-1

Description

Rule Definition

Rationale

Polyspace Implementation

Troubleshooting

Examples

Avoid Using Literal Values

Check Information

Version History

R2023b: Checker correctly handles declarations using enum values

R2022b: Checker correctly handles range-based for loops

See Also

Topics

R2023b: Checker correctly handles declarations using `enum` values

R2022b: Checker correctly handles range-based `for` loops