AUTOSAR C++14 Rule M9-3-3

If a member function can be made static then it shall be made static, otherwise if it can be made const then it shall be made const

Description

Rule Definition

If a member function can be made static then it shall be made static, otherwise if it can be made const then it shall be made const.

Rationale

const member functions cannot modify the data members of the class. static member function cannot modify the nonstatic data members of the class. If a member function does not need to modify the nonstatic data members of the class, limit their access to data by declaring the member functions as const or static. Such declaration clearly expresses and enforces the design intent. That is, if you inadvertently attempt to modify a data member through a const member function, the compiler catches the error. Without the const declaration, this kind of inadvertent error might lead to bugs that are difficult to find or debug.

Polyspace Implementation

The checker performs these checks in this order:

1. The checker first checks if a class member function accesses a data member of the class. Functions that do not access data members can be declared static.

2. The checker then checks functions that access data members to determine if the function modifies any of the data members. Functions that do not modify data members can be declared const.

A violation on a const member function means that the function does not access a data member of the class and can be declared static.

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

Explicitly Restrict Access for Member Functions that Do Not Modify Data Members

#include<cstdint>
void Connector(void);
class A
{
public:
	int16_t foo ( ) // Noncompliant 
	{
		return m_i;
	}
	int16_t foo2 ( ) // Noncompliant 
	{
		Connector();// Might have side-effect
		return m_i;
	}
	int16_t foo3 ( ) // Noncompliant
	{
		return m_s;
	}
	int16_t inc_m ( ) // Compliant 
	{
		return ++m_i;
	}
	int16_t& getref()//Noncompliant 
	{
		return m_i_ref; 
	}
private:
	int16_t m_i;
	static int16_t m_s;
	int16_t& m_i_ref;
};

In this example, Polyspace flags the functions foo, foo2, foo3, and getref as noncompliant.

• The functions foo and foo3 do not modify any nonstatic data members. Because their data access is not explicitly restricted by declaring them as const, Polyspace flags these functions. To fix these defects, declare foo and foo3 as const.

• The function foo2 does not explicitly modify any of the data members. Because it is not declared as const, Polyspace flags the function. foo2 calls the global function Connector, which might have side effects. Do not declare foo2 as a const function. In C++11 or later, const member functions are expected to be thread-safe, but foo2 might not be thread-safe because of the side effects of Connector. To avoid data races, keep foo2 as a nonconst function. Justify the defect by using review information or code comments.

• The function getref does not modify any data members. Because it is not declared as const, Polyspace flags it. Declaring getref as const resolves this defect, but that is not enough to restrict write access of getref because it returns a nonconst reference to m_i_ref. To restrict getref from modifying m_i_ref, the return type of getref must also be const.

Check Information

Group: Classes

Category: Required, Automated

Version History

Introduced in R2019a

R2024b: Improved detection of class member functions as candidates for const-qualification

The rule checker no longer requires const-qualification for member functions that return a reference to any of these:

• An element of an array data member.

• A member of a struct data member.

For example, in this code, the member functions of the class MyClass are compliant.

#include <iostream>
#include <string>

struct MyStruct {
    int id;
    std::string name;
};

class MyClass {
private:
    MyStruct myStruct;
    int myArray[10];

public:
    // Constructor to initialize struct and array
    MyClass(int id, const std::string& name, const int arr[10]) {
        myStruct.id = id;
        myStruct.name = name;
        for (int i = 0; i < 10; ++i) {
            myArray[i] = arr[i];
        }
    }

    // Function to return a reference to an element of the array
    int& getArrayElement(int index) { // Compliant
        if (index < 0 || index >= 10) {
            throw std::out_of_range("Index out of range");
        }
        return myArray[index];
    }

    // Function to return a reference to the struct's id member
    int& getStructId() { // Compliant
        return myStruct.id;
    }

    // Function to return a reference to the struct's name member
    std::string& getStructName() { // Compliant
        return myStruct.name;
    }
};

R2024a: Improved detection of class member functions as candidates for const-qualification

The rule checker no longer requires const-qualification for member functions that performs one of these:

• Modifies a data member by reference in a range-based for loop. For example, the member function Bar::clearFoo() accesses the array fooList by using a range-based for loop. Polyspace no longer considers the member function a candidate for const-qualification.

  #include <array>
  
  constexpr size_t MAX_FOO{ 10U };
  
  struct Foo
  {
      bool isFoo{};
  };
  
  class Bar
  {
    public:
      
      void clearFoo();
  
    private:
      std::array<Foo, MAX_FOO> fooList{};
  };
  
  
  
  void Bar::clearFoo()    // Not const - compliant
  {
      for (Foo& i : fooList) {}
  }

• Calls a function that modifies a data member using a data member. For example, the member function myFunc() calls the function myclass::collection::func() by using the data member myCol. Because the function myclass::collection::func() modifies a data member, Polyspace no longer consider myFunc() a candidate for const-qualification.

  class myClass
  {
  public:
  	struct collection {
  		//...
  		const char **data;
  		void func(const char **) ;
  	};
  
  	myClass::collection *getCol();
  
  	void myFunc(const char **);
  
  private:
  	collection myCol;
  };
  void myClass::collection::func(const char **foo) {
  	data = foo;
  }
  void myClass::myFunc(const char **foo)
  {
  	(&myCol)->func(foo);
  }

R2023a: Improved detection of class member functions as candidates for const-qualification

The rule checker no longer requires const-qualification for a member function if the function passes a data member to a constructor that might possibly modify the data member. For instance, in this example:

• The member function TestClass::Test1() passes a data member mMutex to a constructor that takes non-const references (there is no constructor overload that takes const references). Therefore, this member function is not a candidate for const-qualification.

• The member function TestClass::Test2() passes the same data member mMutex to a constructor that takes const references. Therefore, this member function is a candidate for const-qualification.

class Item {
};

class Lock1
{
public:
    Lock1(Item& i);
};

class Lock2
{
public:
    Lock2(Item& i);
    Lock2(const Item& i);
};

class TestClass
{
public:
    void Test1() 
    {
        Lock1 lk{mMutex};
    }
    void Test2()        
    {
        Lock2 lk{mMutex};
    }
private:
    Item mMutex;
};