Rename AttributePathExpandIterator to legacy

andreilitvin · andreilitvin · commit 8edc026435fe · 2025-01-07T09:41:18.000-05:00
diff --git a/src/app/AttributePathExpandIterator.cpp b/src/app/AttributePathExpandIterator.cpp
@@ -24,7 +24,7 @@ using namespace chip::app::DataModel;
 namespace chip {
 namespace app {
 
-AttributePathExpandIterator::AttributePathExpandIterator(DataModel::Provider * provider,
+AttributePathExpandIteratorLegacy::AttributePathExpandIteratorLegacy(DataModel::Provider * provider,
                                                          SingleLinkedListNode<AttributePathParams> * attributePath) :
     mDataModelProvider(provider), mpAttributePath(attributePath),
     mOutputPath(kInvalidEndpointId, kInvalidClusterId, kInvalidAttributeId)
@@ -37,7 +37,7 @@ AttributePathExpandIterator::AttributePathExpandIterator(DataModel::Provider * p
     Next();
 }
 
-bool AttributePathExpandIterator::IsValidAttributeId(AttributeId attributeId)
+bool AttributePathExpandIteratorLegacy::IsValidAttributeId(AttributeId attributeId)
 {
     switch (attributeId)
     {
@@ -53,7 +53,7 @@ bool AttributePathExpandIterator::IsValidAttributeId(AttributeId attributeId)
     return mDataModelProvider->GetAttributeInfo(attributePath).has_value();
 }
 
-std::optional<AttributeId> AttributePathExpandIterator::NextAttributeId()
+std::optional<AttributeId> AttributePathExpandIteratorLegacy::NextAttributeId()
 {
     if (mOutputPath.mAttributeId == kInvalidAttributeId)
     {
@@ -108,7 +108,7 @@ std::optional<AttributeId> AttributePathExpandIterator::NextAttributeId()
     return GlobalAttributesNotInMetadata[0];
 }
 
-std::optional<ClusterId> AttributePathExpandIterator::NextClusterId()
+std::optional<ClusterId> AttributePathExpandIteratorLegacy::NextClusterId()
 {
 
     if (mOutputPath.mClusterId == kInvalidClusterId)
@@ -135,7 +135,7 @@ std::optional<ClusterId> AttributePathExpandIterator::NextClusterId()
     return entry.IsValid() ? std::make_optional(entry.path.mClusterId) : std::nullopt;
 }
 
-std::optional<ClusterId> AttributePathExpandIterator::NextEndpointId()
+std::optional<ClusterId> AttributePathExpandIteratorLegacy::NextEndpointId()
 {
     if (mOutputPath.mEndpointId == kInvalidEndpointId)
     {
@@ -154,7 +154,7 @@ std::optional<ClusterId> AttributePathExpandIterator::NextEndpointId()
     return (ep.id != kInvalidEndpointId) ? std::make_optional(ep.id) : std::nullopt;
 }
 
-void AttributePathExpandIterator::ResetCurrentCluster()
+void AttributePathExpandIteratorLegacy::ResetCurrentCluster()
 {
     // If this is a null iterator, or the attribute id of current cluster info is not a wildcard attribute id, then this function
     // will do nothing, since we won't be expanding the wildcard attribute ids under a cluster.
@@ -165,7 +165,7 @@ void AttributePathExpandIterator::ResetCurrentCluster()
     mOutputPath.mExpanded    = true; // we know this is a wildcard attribute
     Next();
 }
-bool AttributePathExpandIterator::AdvanceOutputPath()
+bool AttributePathExpandIteratorLegacy::AdvanceOutputPath()
 {
     if (!mpAttributePath->mValue.IsWildcardPath())
     {
@@ -218,7 +218,7 @@ bool AttributePathExpandIterator::AdvanceOutputPath()
     }
 }
 
-bool AttributePathExpandIterator::Next()
+bool AttributePathExpandIteratorLegacy::Next()
 {
     while (mpAttributePath != nullptr)
     {
diff --git a/src/app/AttributePathExpandIterator.h b/src/app/AttributePathExpandIterator.h
@@ -184,10 +184,10 @@ class AttributePathExpandIterator2
  * TODO: The AttributePathParams may support a group id, the iterator should be able to call group data provider to expand the group
  * id.
  */
-class AttributePathExpandIterator
+class AttributePathExpandIteratorLegacy
 {
 public:
-    AttributePathExpandIterator(DataModel::Provider * provider, SingleLinkedListNode<AttributePathParams> * attributePath);
+    AttributePathExpandIteratorLegacy(DataModel::Provider * provider, SingleLinkedListNode<AttributePathParams> * attributePath);
 
     /**
      * Proceed the iterator to the next attribute path in the given cluster info.
@@ -218,7 +218,7 @@ class AttributePathExpandIterator
     /** Start iterating over the given `paths` */
     inline void ResetTo(SingleLinkedListNode<AttributePathParams> * paths)
     {
-        *this = AttributePathExpandIterator(mDataModelProvider, paths);
+        *this = AttributePathExpandIteratorLegacy(mDataModelProvider, paths);
     }
 
 private:
diff --git a/src/app/InteractionModelEngine.cpp b/src/app/InteractionModelEngine.cpp
@@ -582,7 +582,7 @@ CHIP_ERROR InteractionModelEngine::ParseAttributePaths(const Access::SubjectDesc
 
         if (paramsList.mValue.IsWildcardPath())
         {
-            AttributePathExpandIterator pathIterator(GetDataModelProvider(), &paramsList);
+            AttributePathExpandIteratorLegacy pathIterator(GetDataModelProvider(), &paramsList);
             ConcreteAttributePath readPath;
 
             // The definition of "valid path" is "path exists and ACL allows access". The "path exists" part is handled by
diff --git a/src/app/ReadHandler.h b/src/app/ReadHandler.h
@@ -407,7 +407,7 @@ class ReadHandler : public Messaging::ExchangeDelegate
     bool IsFabricFiltered() const { return mFlags.Has(ReadHandlerFlags::FabricFiltered); }
     CHIP_ERROR OnSubscribeRequest(Messaging::ExchangeContext * apExchangeContext, System::PacketBufferHandle && aPayload);
     void GetSubscriptionId(SubscriptionId & aSubscriptionId) const { aSubscriptionId = mSubscriptionId; }
-    AttributePathExpandIterator * GetAttributePathExpandIterator() { return &mAttributePathExpandIterator; }
+    AttributePathExpandIteratorLegacy * GetAttributePathExpandIterator() { return &mAttributePathExpandIterator; }
 
     /// @brief Notifies the read handler that a set of attribute paths has been marked dirty. This will schedule a reporting engine
     /// run if the change to the attribute path makes the ReadHandler reportable.
@@ -519,7 +519,7 @@ class ReadHandler : public Messaging::ExchangeDelegate
     /// @param aFlag Flag to clear
     void ClearStateFlag(ReadHandlerFlags aFlag);
 
-    AttributePathExpandIterator mAttributePathExpandIterator;
+    AttributePathExpandIteratorLegacy mAttributePathExpandIterator;
 
     // The current generation of the reporting engine dirty set the last time we were notified that a path we're interested in was
     // marked dirty.
diff --git a/src/app/tests/TestAttributePathExpandIterator.cpp b/src/app/tests/TestAttributePathExpandIterator.cpp
@@ -106,7 +106,7 @@ TEST(TestAttributePathExpandIterator, TestAllWildcard)
 
     size_t index = 0;
 
-    for (app::AttributePathExpandIterator iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
+    for (app::AttributePathExpandIteratorLegacy iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
          iter.Next())
     {
         ChipLogDetail(AppServer, "Visited Attribute: 0x%04X / " ChipLogFormatMEI " / " ChipLogFormatMEI, path.mEndpointId,
@@ -131,7 +131,7 @@ TEST(TestAttributePathExpandIterator, TestWildcardEndpoint)
 
     size_t index = 0;
 
-    for (app::AttributePathExpandIterator iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
+    for (app::AttributePathExpandIteratorLegacy iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
          iter.Next())
     {
         ChipLogDetail(AppServer, "Visited Attribute: 0x%04X / " ChipLogFormatMEI " / " ChipLogFormatMEI, path.mEndpointId,
@@ -159,7 +159,7 @@ TEST(TestAttributePathExpandIterator, TestWildcardCluster)
 
     size_t index = 0;
 
-    for (app::AttributePathExpandIterator iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
+    for (app::AttributePathExpandIteratorLegacy iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
          iter.Next())
     {
         ChipLogDetail(AppServer, "Visited Attribute: 0x%04X / " ChipLogFormatMEI " / " ChipLogFormatMEI, path.mEndpointId,
@@ -187,7 +187,7 @@ TEST(TestAttributePathExpandIterator, TestWildcardClusterGlobalAttributeNotInMet
 
     size_t index = 0;
 
-    for (app::AttributePathExpandIterator iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
+    for (app::AttributePathExpandIteratorLegacy iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
          iter.Next())
     {
         ChipLogDetail(AppServer, "Visited Attribute: 0x%04X / " ChipLogFormatMEI " / " ChipLogFormatMEI, path.mEndpointId,
@@ -219,7 +219,7 @@ TEST(TestAttributePathExpandIterator, TestWildcardAttribute)
 
     size_t index = 0;
 
-    for (app::AttributePathExpandIterator iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
+    for (app::AttributePathExpandIteratorLegacy iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
          iter.Next())
     {
         ChipLogDetail(AppServer, "Visited Attribute: 0x%04X / " ChipLogFormatMEI " / " ChipLogFormatMEI, path.mEndpointId,
@@ -245,7 +245,7 @@ TEST(TestAttributePathExpandIterator, TestNoWildcard)
 
     size_t index = 0;
 
-    for (app::AttributePathExpandIterator iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
+    for (app::AttributePathExpandIteratorLegacy iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo); iter.Get(path);
          iter.Next())
     {
         ChipLogDetail(AppServer, "Visited Attribute: 0x%04X / " ChipLogFormatMEI " / " ChipLogFormatMEI, path.mEndpointId,
@@ -360,7 +360,7 @@ TEST(TestAttributePathExpandIterator, TestMultipleClusInfo)
 
     size_t index = 0;
 
-    for (app::AttributePathExpandIterator iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo1);
+    for (app::AttributePathExpandIteratorLegacy iter(CodegenDataModelProviderInstance(nullptr /* delegate */), &clusInfo1);
          iter.Get(path); iter.Next())
     {
         ChipLogDetail(AppServer, "Visited Attribute: 0x%04X / " ChipLogFormatMEI " / " ChipLogFormatMEI, path.mEndpointId,

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ using namespace chip::app::DataModel;`
`24`	`24`	`namespace chip {`
`25`	`25`	`namespace app {`
`26`	`26`
`27`		`-AttributePathExpandIterator::AttributePathExpandIterator(DataModel::Provider * provider,`
	`27`	`+AttributePathExpandIteratorLegacy::AttributePathExpandIteratorLegacy(DataModel::Provider * provider,`
`28`	`28`	`SingleLinkedListNode<AttributePathParams> * attributePath) :`
`29`	`29`	`mDataModelProvider(provider), mpAttributePath(attributePath),`
`30`	`30`	`mOutputPath(kInvalidEndpointId, kInvalidClusterId, kInvalidAttributeId)`
`@@ -37,7 +37,7 @@ AttributePathExpandIterator::AttributePathExpandIterator(DataModel::Provider * p`
`37`	`37`	`Next();`
`38`	`38`	`}`
`39`	`39`
`40`		`-bool AttributePathExpandIterator::IsValidAttributeId(AttributeId attributeId)`
	`40`	`+bool AttributePathExpandIteratorLegacy::IsValidAttributeId(AttributeId attributeId)`
`41`	`41`	`{`
`42`	`42`	`switch (attributeId)`
`43`	`43`	`{`
`@@ -53,7 +53,7 @@ bool AttributePathExpandIterator::IsValidAttributeId(AttributeId attributeId)`
`53`	`53`	`return mDataModelProvider->GetAttributeInfo(attributePath).has_value();`
`54`	`54`	`}`
`55`	`55`
`56`		`-std::optional<AttributeId> AttributePathExpandIterator::NextAttributeId()`
	`56`	`+std::optional<AttributeId> AttributePathExpandIteratorLegacy::NextAttributeId()`
`57`	`57`	`{`
`58`	`58`	`if (mOutputPath.mAttributeId == kInvalidAttributeId)`
`59`	`59`	`{`
`@@ -108,7 +108,7 @@ std::optional<AttributeId> AttributePathExpandIterator::NextAttributeId()`
`108`	`108`	`return GlobalAttributesNotInMetadata[0];`
`109`	`109`	`}`
`110`	`110`
`111`		`-std::optional<ClusterId> AttributePathExpandIterator::NextClusterId()`
	`111`	`+std::optional<ClusterId> AttributePathExpandIteratorLegacy::NextClusterId()`
`112`	`112`	`{`
`113`	`113`
`114`	`114`	`if (mOutputPath.mClusterId == kInvalidClusterId)`
`@@ -135,7 +135,7 @@ std::optional<ClusterId> AttributePathExpandIterator::NextClusterId()`
`135`	`135`	`return entry.IsValid() ? std::make_optional(entry.path.mClusterId) : std::nullopt;`
`136`	`136`	`}`
`137`	`137`
`138`		`-std::optional<ClusterId> AttributePathExpandIterator::NextEndpointId()`
	`138`	`+std::optional<ClusterId> AttributePathExpandIteratorLegacy::NextEndpointId()`
`139`	`139`	`{`
`140`	`140`	`if (mOutputPath.mEndpointId == kInvalidEndpointId)`
`141`	`141`	`{`
`@@ -154,7 +154,7 @@ std::optional<ClusterId> AttributePathExpandIterator::NextEndpointId()`
`154`	`154`	`return (ep.id != kInvalidEndpointId) ? std::make_optional(ep.id) : std::nullopt;`
`155`	`155`	`}`
`156`	`156`
`157`		`-void AttributePathExpandIterator::ResetCurrentCluster()`
	`157`	`+void AttributePathExpandIteratorLegacy::ResetCurrentCluster()`
`158`	`158`	`{`
`159`	`159`	`// If this is a null iterator, or the attribute id of current cluster info is not a wildcard attribute id, then this function`
`160`	`160`	`// will do nothing, since we won't be expanding the wildcard attribute ids under a cluster.`
`@@ -165,7 +165,7 @@ void AttributePathExpandIterator::ResetCurrentCluster()`
`165`	`165`	`mOutputPath.mExpanded = true; // we know this is a wildcard attribute`
`166`	`166`	`Next();`
`167`	`167`	`}`
`168`		`-bool AttributePathExpandIterator::AdvanceOutputPath()`
	`168`	`+bool AttributePathExpandIteratorLegacy::AdvanceOutputPath()`
`169`	`169`	`{`
`170`	`170`	`if (!mpAttributePath->mValue.IsWildcardPath())`
`171`	`171`	`{`
`@@ -218,7 +218,7 @@ bool AttributePathExpandIterator::AdvanceOutputPath()`
`218`	`218`	`}`
`219`	`219`	`}`
`220`	`220`
`221`		`-bool AttributePathExpandIterator::Next()`
	`221`	`+bool AttributePathExpandIteratorLegacy::Next()`
`222`	`222`	`{`
`223`	`223`	`while (mpAttributePath != nullptr)`
`224`	`224`	`{`
Original file line number	Diff line number	Diff line change
`@@ -184,10 +184,10 @@ class AttributePathExpandIterator2`
`184`	`184`	`* TODO: The AttributePathParams may support a group id, the iterator should be able to call group data provider to expand the group`
`185`	`185`	`* id.`
`186`	`186`	`*/`
`187`		`-class AttributePathExpandIterator`
	`187`	`+class AttributePathExpandIteratorLegacy`
`188`	`188`	`{`
`189`	`189`	`public:`
`190`		`- AttributePathExpandIterator(DataModel::Provider * provider, SingleLinkedListNode<AttributePathParams> * attributePath);`
	`190`	`+ AttributePathExpandIteratorLegacy(DataModel::Provider * provider, SingleLinkedListNode<AttributePathParams> * attributePath);`
`191`	`191`
`192`	`192`	`/**`
`193`	`193`	`* Proceed the iterator to the next attribute path in the given cluster info.`
`@@ -218,7 +218,7 @@ class AttributePathExpandIterator`
`218`	`218`	/** Start iterating over the given `paths` */
`219`	`219`	`inline void ResetTo(SingleLinkedListNode<AttributePathParams> * paths)`
`220`	`220`	`{`
`221`		`- *this = AttributePathExpandIterator(mDataModelProvider, paths);`
	`221`	`+ *this = AttributePathExpandIteratorLegacy(mDataModelProvider, paths);`
`222`	`222`	`}`
`223`	`223`
`224`	`224`	`private:`
Original file line number	Diff line number	Diff line change
`@@ -582,7 +582,7 @@ CHIP_ERROR InteractionModelEngine::ParseAttributePaths(const Access::SubjectDesc`
`582`	`582`
`583`	`583`	`if (paramsList.mValue.IsWildcardPath())`
`584`	`584`	`{`
`585`		`- AttributePathExpandIterator pathIterator(GetDataModelProvider(), &paramsList);`
	`585`	`+ AttributePathExpandIteratorLegacy pathIterator(GetDataModelProvider(), &paramsList);`
`586`	`586`	`ConcreteAttributePath readPath;`
`587`	`587`
`588`	`588`	`// The definition of "valid path" is "path exists and ACL allows access". The "path exists" part is handled by`