Clean up the "subclasses must implement this" machinery in MTRDevice.

We had a lot of copy/paste that we can factor out.

Author: bzbarsky-apple

src/darwin/Framework/CHIP/MTRDevice.mm

@@ -55,6 +55,18 @@
 // Disabling pending crashes
 #define ENABLE_CONNECTIVITY_MONITORING 0
 
+#ifdef DEBUG
+#define MTR_REQUIRE_SUBCLASS_IMPL_PASTED(message) \
+    MTR_LOG_ERROR(message);                       \
+    NSAssert(NO, @message)
+#else // DEBUG
+#debug MTR_REQUIRE_SUBCLASS_IMPL_PASTED(message) \
+    MTR_LOG_ERROR(message)
+#endif // DEBUG
+
+#define MTR_REQUIRE_SUBCLASS_IMPL(selectorString) \
+    MTR_REQUIRE_SUBCLASS_IMPL_PASTED("MTRDevice " selectorString " must be handled by subclasses")
+
 @implementation MTRDeviceDelegateInfo
 - (instancetype)initWithDelegate:(id<MTRDeviceDelegate>)delegate queue:(dispatch_queue_t)queue interestedPathsForAttributes:(NSArray * _Nullable)interestedPathsForAttributes interestedPathsForEvents:(NSArray * _Nullable)interestedPathsForEvents
 {
@@ -1248,12 +1260,7 @@ - (NSUInteger)unitTestNonnullDelegateCount
                                                             attributeID:(NSNumber *)attributeID
                                                                  params:(MTRReadParams * _Nullable)params
 {
-#define MTRDeviceErrorStr "MTRDevice readAttributeWithEndpointID:clusterID:attributeID:params: must be handled by subclasses"
-    MTR_LOG_ERROR(MTRDeviceErrorStr);
-#ifdef DEBUG
-    NSAssert(NO, @MTRDeviceErrorStr);
-#endif // DEBUG
-#undef MTRDeviceErrorStr
+    MTR_REQUIRE_SUBCLASS_IMPL("readAttributeWithEndpointID:clusterID:attributeID:params:");
     return nil;
 }
 
@@ -1264,22 +1271,12 @@ - (void)writeAttributeWithEndpointID:(NSNumber *)endpointID
                expectedValueInterval:(NSNumber *)expectedValueInterval
                    timedWriteTimeout:(NSNumber * _Nullable)timeout
 {
-#define MTRDeviceErrorStr "MTRDevice writeAttributeWithEndpointID:clusterID:attributeID:value:expectedValueInterval:timedWriteTimeout: must be handled by subclasses"
-    MTR_LOG_ERROR(MTRDeviceErrorStr);
-#ifdef DEBUG
-    NSAssert(NO, @MTRDeviceErrorStr);
-#endif // DEBUG
-#undef MTRDeviceErrorStr
+    MTR_REQUIRE_SUBCLASS_IMPL("writeAttributeWithEndpointID:clusterID:attributeID:value:expectedValueInterval:timedWriteTimeout:");
 }
 
 - (NSArray<NSDictionary<NSString *, id> *> *)readAttributePaths:(NSArray<MTRAttributeRequestPath *> *)attributePaths
 {
-#define MTRDeviceErrorStr "MTRDevice readAttributePaths: must be handled by subclasses"
-    MTR_LOG_ERROR(MTRDeviceErrorStr);
-#ifdef DEBUG
-    NSAssert(NO, @MTRDeviceErrorStr);
-#endif // DEBUG
-#undef MTRDeviceErrorStr
+    MTR_REQUIRE_SUBCLASS_IMPL("readAttributePaths:");
     return [NSArray array];
 }
 
@@ -1362,12 +1359,7 @@ - (void)_invokeCommandWithEndpointID:(NSNumber *)endpointID
                                queue:(dispatch_queue_t)queue
                           completion:(MTRDeviceResponseHandler)completion
 {
-#define MTRDeviceErrorStr "MTRDevice _invokeCommandWithEndpointID: must be handled by subclasses"
-    MTR_LOG_ERROR(MTRDeviceErrorStr);
-#ifdef DEBUG
-    NSAssert(NO, @MTRDeviceErrorStr);
-#endif // DEBUG
-#undef MTRDeviceErrorStr
+    MTR_REQUIRE_SUBCLASS_IMPL("_invokeCommandWithEndpointID:clusterID:commandID:commandFields:expectedValues:expectedValueInterval:timedInvokeTimeout:serverSideProcessingTimeout:queue:completion:");
 }
 
 - (void)_invokeKnownCommandWithEndpointID:(NSNumber *)endpointID
@@ -1476,12 +1468,7 @@ - (NSDictionary *)_dataValueWithoutDataVersion:(NSDictionary *)attributeValue
 
 - (NSArray<NSDictionary<NSString *, id> *> *)getAllAttributesReport
 {
-#define MTRDeviceErrorStr "MTRDevice getAllAttributesReport must be handled by subclasses that support it"
-    MTR_LOG_ERROR(MTRDeviceErrorStr);
-#ifdef DEBUG
-    NSAssert(NO, @MTRDeviceErrorStr);
-#endif // DEBUG
-#undef MTRDeviceErrorStr
+    MTR_REQUIRE_SUBCLASS_IMPL("getAllAttributesReport");
     return nil;
 }