Make sure binary operators are const to fix C++20

mspang · mspang · commit cee1b2771b1b · 2024-04-17T15:46:15.000-04:00
Fix errors of the form

../../src/system/tests/TestSystemPacketBuffer.cpp:1063:72: error: C++20 says that these are ambiguous, even though the second is reversed: [-Werror]
 1063 |                             NL_TEST_ASSERT(inSuite, config_1.handle == original_handle_1);
      |                                                                        ^~~~~~~~~~~~~~~~~
../../third_party/nlunit-test/repo/src/nlunit-test.h:366:15: note: in definition of macro ‘NL_TEST_ASSERT’
  366 |         if (!(inCondition))                             \
      |               ^~~~~~~~~~~
../../src/system/SystemPacketBuffer.h:690:10: note: candidate 1: ‘bool chip::System::PacketBufferHandle::operator==(const chip::System::PacketBufferHandle&amp;)’
  690 |     bool operator==(const PacketBufferHandle &amp; aOther) { return mBuffer == aOther.mBuffer; }
      |          ^~~~~~~~
../../src/system/SystemPacketBuffer.h:690:10: note: candidate 2: ‘bool chip::System::PacketBufferHandle::operator==(const chip::System::PacketBufferHandle&amp;)’ (reversed)
../../src/system/SystemPacketBuffer.h:690:10: note: try making the operator a ‘const’ member function

when compiling with cpp_standard="gnu++20" by making sure comparators
are const members.
diff --git a/examples/tv-casting-app/tv-casting-common/include/TargetVideoPlayerInfo.h b/examples/tv-casting-app/tv-casting-common/include/TargetVideoPlayerInfo.h
@@ -72,7 +72,7 @@ class TargetVideoPlayerInfo
 public:
     TargetVideoPlayerInfo() {}
 
-    bool operator==(const TargetVideoPlayerInfo & other) { return this->mNodeId == other.mNodeId; }
+    bool operator==(const TargetVideoPlayerInfo & other) const { return this->mNodeId == other.mNodeId; }
 
     bool IsInitialized() { return mInitialized; }
     void Reset();
diff --git a/src/app/ConcreteAttributePath.h b/src/app/ConcreteAttributePath.h
@@ -142,7 +142,7 @@ struct ConcreteDataAttributePath : public ConcreteAttributePath
                         ChipLogValueMEI(mClusterId), ChipLogValueMEI(mAttributeId));
     }
 
-    bool MatchesConcreteAttributePath(const ConcreteAttributePath & aOther) { return ConcreteAttributePath::operator==(aOther); }
+    bool MatchesConcreteAttributePath(const ConcreteAttributePath & aOther) const { return ConcreteAttributePath::operator==(aOther); }
 
     bool operator==(const ConcreteDataAttributePath & aOther) const
     {
diff --git a/src/app/clusters/bindings/PendingNotificationMap.h b/src/app/clusters/bindings/PendingNotificationMap.h
@@ -88,9 +88,9 @@ class PendingNotificationMap
             return *this;
         }
 
-        bool operator!=(const Iterator & rhs) { return mIndex != rhs.mIndex; }
+        bool operator!=(const Iterator & rhs) const { return mIndex != rhs.mIndex; }
 
-        bool operator==(const Iterator & rhs) { return mIndex == rhs.mIndex; }
+        bool operator==(const Iterator & rhs) const { return mIndex == rhs.mIndex; }
 
     private:
         PendingNotificationMap * mMap;
diff --git a/src/app/clusters/scenes-server/SceneTable.h b/src/app/clusters/scenes-server/SceneTable.h
@@ -149,7 +149,7 @@ class SceneTable
 
         bool IsValid() { return (mSceneId != kUndefinedSceneId); }
 
-        bool operator==(const SceneStorageId & other) { return (mGroupId == other.mGroupId && mSceneId == other.mSceneId); }
+        bool operator==(const SceneStorageId & other) const { return (mGroupId == other.mGroupId && mSceneId == other.mSceneId); }
     };
 
     /// @brief struct used to store data held in a scene
@@ -235,7 +235,7 @@ class SceneTable
         SceneTableEntry(SceneStorageId id) : mStorageId(id) {}
         SceneTableEntry(const SceneStorageId id, const SceneData data) : mStorageId(id), mStorageData(data) {}
 
-        bool operator==(const SceneTableEntry & other)
+        bool operator==(const SceneTableEntry & other) const
         {
             return (mStorageId == other.mStorageId && mStorageData == other.mStorageData);
         }
diff --git a/src/credentials/FabricTable.h b/src/credentials/FabricTable.h
@@ -298,7 +298,7 @@ class ConstFabricIterator
         return GetCurrent();
     }
 
-    bool operator==(const ConstFabricIterator & other)
+    bool operator==(const ConstFabricIterator & other) const
     {
         if (IsAtEnd())
         {
@@ -308,7 +308,7 @@ class ConstFabricIterator
         // Pending entry does not participate in finding this.
         return (mStart == other.mStart) && (mIndex == other.mIndex) && (mMaxSize == other.mMaxSize);
     }
-    bool operator!=(const ConstFabricIterator & other) { return !(*this == other); }
+    bool operator!=(const ConstFabricIterator & other) const { return !(*this == other); }
 
     bool IsAtEnd() const { return (mIndex == mMaxSize); }
 
diff --git a/src/credentials/GroupDataProvider.h b/src/credentials/GroupDataProvider.h
@@ -72,7 +72,7 @@ class GroupDataProvider
                 Platform::CopyString(name, groupName);
             }
         }
-        bool operator==(const GroupInfo & other)
+        bool operator==(const GroupInfo & other) const
         {
             return (this->group_id == other.group_id) && !strncmp(this->name, other.name, kGroupNameMax);
         }
@@ -151,7 +151,7 @@ class GroupDataProvider
         // Number of keys present
         uint8_t num_keys_used = 0;
 
-        bool operator==(const KeySet & other)
+        bool operator==(const KeySet & other) const
         {
             VerifyOrReturnError(this->policy == other.policy && this->num_keys_used == other.num_keys_used, false);
             return !memcmp(this->epoch_keys, other.epoch_keys, this->num_keys_used * sizeof(EpochKey));
diff --git a/src/setup_payload/SetupPayload.cpp b/src/setup_payload/SetupPayload.cpp
@@ -146,7 +146,7 @@ bool PayloadContents::CheckPayloadCommonConstraints() const
     return true;
 }
 
-bool PayloadContents::operator==(PayloadContents & input) const
+bool PayloadContents::operator==(const PayloadContents & input) const
 {
     return (this->version == input.version && this->vendorID == input.vendorID && this->productID == input.productID &&
             this->commissioningFlow == input.commissioningFlow && this->rendezvousInformation == input.rendezvousInformation &&
@@ -257,10 +257,11 @@ CHIP_ERROR SetupPayload::addOptionalExtensionData(const OptionalQRCodeInfoExtens
     return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR SetupPayload::getOptionalVendorData(uint8_t tag, OptionalQRCodeInfo & info)
+CHIP_ERROR SetupPayload::getOptionalVendorData(uint8_t tag, OptionalQRCodeInfo & info) const
 {
-    VerifyOrReturnError(optionalVendorData.find(tag) != optionalVendorData.end(), CHIP_ERROR_KEY_NOT_FOUND);
-    info = optionalVendorData[tag];
+    const auto it = optionalVendorData.find(tag);
+    VerifyOrReturnError(it != optionalVendorData.end(), CHIP_ERROR_KEY_NOT_FOUND);
+    info = it->second;
 
     return CHIP_NO_ERROR;
 }
@@ -273,7 +274,7 @@ CHIP_ERROR SetupPayload::getOptionalExtensionData(uint8_t tag, OptionalQRCodeInf
     return CHIP_NO_ERROR;
 }
 
-optionalQRCodeInfoType SetupPayload::getNumericTypeFor(uint8_t tag)
+optionalQRCodeInfoType SetupPayload::getNumericTypeFor(uint8_t tag) const
 {
     optionalQRCodeInfoType elemType = optionalQRCodeInfoTypeUnknown;
 
@@ -289,7 +290,7 @@ optionalQRCodeInfoType SetupPayload::getNumericTypeFor(uint8_t tag)
     return elemType;
 }
 
-std::vector<OptionalQRCodeInfoExtension> SetupPayload::getAllOptionalExtensionData()
+std::vector<OptionalQRCodeInfoExtension> SetupPayload::getAllOptionalExtensionData() const
 {
     std::vector<OptionalQRCodeInfoExtension> returnedOptionalInfo;
     for (auto & entry : optionalExtensionData)
@@ -299,7 +300,7 @@ std::vector<OptionalQRCodeInfoExtension> SetupPayload::getAllOptionalExtensionDa
     return returnedOptionalInfo;
 }
 
-bool SetupPayload::operator==(SetupPayload & input)
+bool SetupPayload::operator==(const SetupPayload & input) const
 {
     std::vector<OptionalQRCodeInfo> inputOptionalVendorData;
     std::vector<OptionalQRCodeInfoExtension> inputOptionalExtensionData;
diff --git a/src/setup_payload/SetupPayload.h b/src/setup_payload/SetupPayload.h
@@ -130,7 +130,7 @@ struct PayloadContents
 
     bool isValidQRCodePayload() const;
     bool isValidManualCode() const;
-    bool operator==(PayloadContents & input) const;
+    bool operator==(const PayloadContents & input) const;
 
     static bool IsValidSetupPIN(uint32_t setupPIN);
 
@@ -233,7 +233,7 @@ class SetupPayload : public PayloadContents
      **/
     CHIP_ERROR removeSerialNumber();
 
-    bool operator==(SetupPayload & input);
+    bool operator==(const SetupPayload & input) const;
 
 private:
     std::map<uint8_t, OptionalQRCodeInfo> optionalVendorData;
@@ -267,14 +267,14 @@ class SetupPayload : public PayloadContents
      * @brief A function to retrieve the vector of CHIPQRCodeInfo infos
      * @return Returns a vector of CHIPQRCodeInfos
      **/
-    std::vector<OptionalQRCodeInfoExtension> getAllOptionalExtensionData();
+    std::vector<OptionalQRCodeInfoExtension> getAllOptionalExtensionData() const;
 
     /** @brief A function to retrieve an optional QR Code info vendor object
      * @param tag 7 bit [0-127] tag number
      * @param info retrieved OptionalQRCodeInfo object
      * @return Returns a CHIP_ERROR_KEY_NOT_FOUND on error, CHIP_NO_ERROR otherwise
      **/
-    CHIP_ERROR getOptionalVendorData(uint8_t tag, OptionalQRCodeInfo & info);
+    CHIP_ERROR getOptionalVendorData(uint8_t tag, OptionalQRCodeInfo & info) const;
 
     /** @brief A function to retrieve an optional QR Code info extended object
      * @param tag 8 bit [128-255] tag number
@@ -287,7 +287,7 @@ class SetupPayload : public PayloadContents
      * @param tag 8 bit [0-255] tag number
      * @return Returns an optionalQRCodeInfoType value
      **/
-    optionalQRCodeInfoType getNumericTypeFor(uint8_t tag);
+    optionalQRCodeInfoType getNumericTypeFor(uint8_t tag) const;
 };
 
 } // namespace chip
diff --git a/src/system/SystemPacketBuffer.h b/src/system/SystemPacketBuffer.h
@@ -687,7 +687,7 @@ class DLL_EXPORT PacketBufferHandle
 
     PacketBuffer * Get() const { return mBuffer; }
 
-    bool operator==(const PacketBufferHandle & aOther) { return mBuffer == aOther.mBuffer; }
+    bool operator==(const PacketBufferHandle & aOther) const { return mBuffer == aOther.mBuffer; }
 
 #if CHIP_SYSTEM_PACKETBUFFER_HAS_RIGHTSIZE
     void InternalRightSize();

Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ struct ConcreteDataAttributePath : public ConcreteAttributePath`
`142`	`142`	`ChipLogValueMEI(mClusterId), ChipLogValueMEI(mAttributeId));`
`143`	`143`	`}`
`144`	`144`
`145`		`- bool MatchesConcreteAttributePath(const ConcreteAttributePath & aOther) { return ConcreteAttributePath::operator==(aOther); }`
	`145`	`+ bool MatchesConcreteAttributePath(const ConcreteAttributePath & aOther) const { return ConcreteAttributePath::operator==(aOther); }`
`146`	`146`
`147`	`147`	`bool operator==(const ConcreteDataAttributePath & aOther) const`
`148`	`148`	`{`
Original file line number	Diff line number	Diff line change
`@@ -88,9 +88,9 @@ class PendingNotificationMap`
`88`	`88`	`return *this;`
`89`	`89`	`}`
`90`	`90`
`91`		`- bool operator!=(const Iterator & rhs) { return mIndex != rhs.mIndex; }`
	`91`	`+ bool operator!=(const Iterator & rhs) const { return mIndex != rhs.mIndex; }`
`92`	`92`
`93`		`- bool operator==(const Iterator & rhs) { return mIndex == rhs.mIndex; }`
	`93`	`+ bool operator==(const Iterator & rhs) const { return mIndex == rhs.mIndex; }`
`94`	`94`
`95`	`95`	`private:`
`96`	`96`	`PendingNotificationMap * mMap;`
Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ class SceneTable`
`149`	`149`
`150`	`150`	`bool IsValid() { return (mSceneId != kUndefinedSceneId); }`
`151`	`151`
`152`		`- bool operator==(const SceneStorageId & other) { return (mGroupId == other.mGroupId && mSceneId == other.mSceneId); }`
	`152`	`+ bool operator==(const SceneStorageId & other) const { return (mGroupId == other.mGroupId && mSceneId == other.mSceneId); }`
`153`	`153`	`};`
`154`	`154`
`155`	`155`	`/// @brief struct used to store data held in a scene`
`@@ -235,7 +235,7 @@ class SceneTable`
`235`	`235`	`SceneTableEntry(SceneStorageId id) : mStorageId(id) {}`
`236`	`236`	`SceneTableEntry(const SceneStorageId id, const SceneData data) : mStorageId(id), mStorageData(data) {}`
`237`	`237`
`238`		`- bool operator==(const SceneTableEntry & other)`
	`238`	`+ bool operator==(const SceneTableEntry & other) const`
`239`	`239`	`{`
`240`	`240`	`return (mStorageId == other.mStorageId && mStorageData == other.mStorageData);`
`241`	`241`	`}`
Original file line number	Diff line number	Diff line change
`@@ -298,7 +298,7 @@ class ConstFabricIterator`
`298`	`298`	`return GetCurrent();`
`299`	`299`	`}`
`300`	`300`
`301`		`- bool operator==(const ConstFabricIterator & other)`
	`301`	`+ bool operator==(const ConstFabricIterator & other) const`
`302`	`302`	`{`
`303`	`303`	`if (IsAtEnd())`
`304`	`304`	`{`
`@@ -308,7 +308,7 @@ class ConstFabricIterator`
`308`	`308`	`// Pending entry does not participate in finding this.`
`309`	`309`	`return (mStart == other.mStart) && (mIndex == other.mIndex) && (mMaxSize == other.mMaxSize);`
`310`	`310`	`}`
`311`		`- bool operator!=(const ConstFabricIterator & other) { return !(*this == other); }`
	`311`	`+ bool operator!=(const ConstFabricIterator & other) const { return !(*this == other); }`
`312`	`312`
`313`	`313`	`bool IsAtEnd() const { return (mIndex == mMaxSize); }`
`314`	`314`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ class GroupDataProvider`
`72`	`72`	`Platform::CopyString(name, groupName);`
`73`	`73`	`}`
`74`	`74`	`}`
`75`		`- bool operator==(const GroupInfo & other)`
	`75`	`+ bool operator==(const GroupInfo & other) const`
`76`	`76`	`{`
`77`	`77`	`return (this->group_id == other.group_id) && !strncmp(this->name, other.name, kGroupNameMax);`
`78`	`78`	`}`
`@@ -151,7 +151,7 @@ class GroupDataProvider`
`151`	`151`	`// Number of keys present`
`152`	`152`	`uint8_t num_keys_used = 0;`
`153`	`153`
`154`		`- bool operator==(const KeySet & other)`
	`154`	`+ bool operator==(const KeySet & other) const`
`155`	`155`	`{`
`156`	`156`	`VerifyOrReturnError(this->policy == other.policy && this->num_keys_used == other.num_keys_used, false);`
`157`	`157`	`return !memcmp(this->epoch_keys, other.epoch_keys, this->num_keys_used * sizeof(EpochKey));`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ bool PayloadContents::CheckPayloadCommonConstraints() const`
`146`	`146`	`return true;`
`147`	`147`	`}`
`148`	`148`
`149`		`-bool PayloadContents::operator==(PayloadContents & input) const`
	`149`	`+bool PayloadContents::operator==(const PayloadContents & input) const`
`150`	`150`	`{`
`151`	`151`	`return (this->version == input.version && this->vendorID == input.vendorID && this->productID == input.productID &&`
`152`	`152`	`this->commissioningFlow == input.commissioningFlow && this->rendezvousInformation == input.rendezvousInformation &&`
`@@ -257,10 +257,11 @@ CHIP_ERROR SetupPayload::addOptionalExtensionData(const OptionalQRCodeInfoExtens`
`257`	`257`	`return CHIP_NO_ERROR;`
`258`	`258`	`}`
`259`	`259`
`260`		`-CHIP_ERROR SetupPayload::getOptionalVendorData(uint8_t tag, OptionalQRCodeInfo & info)`
	`260`	`+CHIP_ERROR SetupPayload::getOptionalVendorData(uint8_t tag, OptionalQRCodeInfo & info) const`
`261`	`261`	`{`
`262`		`- VerifyOrReturnError(optionalVendorData.find(tag) != optionalVendorData.end(), CHIP_ERROR_KEY_NOT_FOUND);`
`263`		`- info = optionalVendorData[tag];`
	`262`	`+ const auto it = optionalVendorData.find(tag);`
	`263`	`+ VerifyOrReturnError(it != optionalVendorData.end(), CHIP_ERROR_KEY_NOT_FOUND);`
	`264`	`+ info = it->second;`
`264`	`265`
`265`	`266`	`return CHIP_NO_ERROR;`
`266`	`267`	`}`
`@@ -273,7 +274,7 @@ CHIP_ERROR SetupPayload::getOptionalExtensionData(uint8_t tag, OptionalQRCodeInf`
`273`	`274`	`return CHIP_NO_ERROR;`
`274`	`275`	`}`
`275`	`276`
`276`		`-optionalQRCodeInfoType SetupPayload::getNumericTypeFor(uint8_t tag)`
	`277`	`+optionalQRCodeInfoType SetupPayload::getNumericTypeFor(uint8_t tag) const`
`277`	`278`	`{`
`278`	`279`	`optionalQRCodeInfoType elemType = optionalQRCodeInfoTypeUnknown;`
`279`	`280`
`@@ -289,7 +290,7 @@ optionalQRCodeInfoType SetupPayload::getNumericTypeFor(uint8_t tag)`
`289`	`290`	`return elemType;`
`290`	`291`	`}`
`291`	`292`
`292`		`-std::vector<OptionalQRCodeInfoExtension> SetupPayload::getAllOptionalExtensionData()`
	`293`	`+std::vector<OptionalQRCodeInfoExtension> SetupPayload::getAllOptionalExtensionData() const`
`293`	`294`	`{`
`294`	`295`	`std::vector<OptionalQRCodeInfoExtension> returnedOptionalInfo;`
`295`	`296`	`for (auto & entry : optionalExtensionData)`
`@@ -299,7 +300,7 @@ std::vector<OptionalQRCodeInfoExtension> SetupPayload::getAllOptionalExtensionDa`
`299`	`300`	`return returnedOptionalInfo;`
`300`	`301`	`}`
`301`	`302`
`302`		`-bool SetupPayload::operator==(SetupPayload & input)`
	`303`	`+bool SetupPayload::operator==(const SetupPayload & input) const`
`303`	`304`	`{`
`304`	`305`	`std::vector<OptionalQRCodeInfo> inputOptionalVendorData;`
`305`	`306`	`std::vector<OptionalQRCodeInfoExtension> inputOptionalExtensionData;`