Allow ArrayLength attribute in Component tags

Numerical parameters as well as ParameterBlocks can have an "ArrayLength"
attribute that instantiate as many identical parameters or parameter blocks.

This is now also possible for Component instances (not types). When used, a
ParameterBlock is created with the name of the arrayed Component and as many
Components will be created with their names being "0", "1", "2", ...

    *** Use with caution! ***

You shouldn't define any context or instantiation mapping at or below the level
of the "arrayed" component. This also concerns the Component's type (since the
Component will inherit its type's mapping).

In other words, only use "ArrayLength" on components that do not have any
mapping and which content does not have any mapping either.

DO:

<ComponentType Name="MyType">
    <IntegerParameter Name="some_int" Size="8"/>
    <FixedPointParameter Name="some_fp" Size="8" Integral="1" Fractional="6"/>
</ComponentType>
<InstanceDefinition>
    <Component Type="MyType" ArrayLength="2"/>
</InstanceDefinition>

DON'T:

<ComponentType Name="MyType" Mapping="Ctx1:foo" Extends="SomeTypeWithMapping">
    <IntegerParameter Name="some_int" Size="8" Mapping="Instance:1"/>
    <FixedPointParameter Name="some_fp" Size="8" Integral="1" Fractional="6" Mapping="Instance:2"/>
</ComponentType>
<InstanceDefinition>
    <Component Type="MyType" ArrayLength="2" Mapping="Ctx2:bar"/>
</InstanceDefinition>

Signed-off-by: David Wagner <[email protected]>

Author: dawagner

parameter/ComponentInstance.cpp

@@ -31,6 +31,7 @@
 #include "ComponentLibrary.h"
 #include "ComponentType.h"
 #include "Component.h"
+#include "ParameterBlock.h" // for "array" instantiation
 #include "XmlParameterSerializingContext.h"
 
 #define base CTypeElement
@@ -110,12 +111,33 @@ bool CComponentInstance::fromXml(const CXmlElement& xmlElement, CXmlSerializingC
 
 CInstanceConfigurableElement* CComponentInstance::doInstantiate() const
 {
-    return new CComponent(getName(), this);
+    if (isScalar()) {
+        return new CComponent(getName(), this);
+    } else {
+        return new CParameterBlock(getName(), this);
+    }
 }
 
 void CComponentInstance::populate(CElement* pElement) const
 {
-    base::populate(pElement);
+    size_t arrayLength = getArrayLength();
+
+    if (arrayLength != 0) {
+
+        // Create child elements
+        for (size_t child = 0; child < arrayLength; child++) {
+
+            CComponent* pChildComponent = new CComponent(std::to_string(child), this);
 
-    _pComponentType->populate(static_cast<CComponent*>(pElement));
+            pElement->addChild(pChildComponent);
+
+            base::populate(pChildComponent);
+
+            _pComponentType->populate(pChildComponent);
+        }
+    } else {
+        base::populate(pElement);
+
+        _pComponentType->populate(static_cast<CComponent*>(pElement));
+    }
 }

schemas/Parameter.xsd

@@ -10,6 +10,7 @@
 	</xs:attributeGroup>
 	<xs:complexType name="ComponentInstance">
 		<xs:attributeGroup ref="TypedNameable"/>
+		<xs:attributeGroup ref="ArrayLengthAttribute"/>
 		<xs:attribute name="Mapping" use="optional"/>
 	</xs:complexType>
 	<xs:simpleType name="SizeType">

test/functional-tests/Handle.cpp

@@ -102,7 +102,6 @@ struct AllParamsPF : public ParameterFramework
                            nodeDesc("ParameterBlock", "parameter_block_array",
                                     getBasicParams(), "ArrayLength='2'") +
                            nodeDesc("Component", "component_scalar", "", "Type='component_type'") +
-                           // Test that ArrayLength have no effect on components
                            nodeDesc("Component", "component_array", "",
                                     "Type='component_type' ArrayLength='2'");
         return config;
@@ -220,10 +219,12 @@ SCENARIO_METHOD(AllParamsPF, "Export component", "[handler][structure][xml]")
 
 SCENARIO_METHOD(AllParamsPF, "Export component array", "[handler][structure][xml]")
 {
-    string expected = rootNode("ParameterBlock", "Name='component_array' "
-                                                 "Description='description_component_array'",
-                               // component array are the same as non array for now
-                               getBasicParams());
+    string expected = rootNode("ParameterBlock",
+                               "Name='component_array' Description='description_component_array'",
+                               nodeDesc("ParameterBlock", "0", getBasicParams(), "",
+                                        "description_component_array") +
+                               nodeDesc("ParameterBlock", "1", getBasicParams(), "",
+                                        "description_component_array"));
     checkStructure("/test/test/component_array", expected);
 }
 
@@ -239,7 +240,12 @@ SCENARIO_METHOD(AllParamsPF, "Export all parameters", "[handler][structure][xml]
                                         "description_parameter_block_array")) +
                            // Components should be exported as parameterBlock
                            nodeDesc("ParameterBlock", "component_scalar", getBasicParams()) +
-                           nodeDesc("ParameterBlock", "component_array", getBasicParams());
+                           nodeDesc("ParameterBlock", "component_array",
+                                   nodeDesc("ParameterBlock", "0", getBasicParams(), "",
+                                        // description is inherited from array
+                                        "description_component_array") +
+                                   nodeDesc("ParameterBlock", "1", getBasicParams(), "",
+                                        "description_component_array"));
 
     WHEN("Exporting subsystem") {
         string expected = rootNode("Subsystem", "Name='test'", paramExpected);
@@ -274,7 +280,9 @@ struct SettingsTestPF : public AllParamsPF
                         parameterBlockNode("0", settings) +
                         parameterBlockNode("1", settings)) +
                     parameterBlockNode("component_scalar", settings) +
-                    parameterBlockNode("component_array", settings);
+                    parameterBlockNode("component_array",
+                        parameterBlockNode("0", settings) +
+                        parameterBlockNode("1", settings));
 
         return rootNode("SystemClass", "Name='test'" ,
                         node("Subsystem", "test", settings, ""));
@@ -283,7 +291,9 @@ struct SettingsTestPF : public AllParamsPF
     static string fullBytesSettings(const string &basicSettings)
     {
         string fullSettings;
-        for (size_t i = 0; i < 6; ++i) {
+        // We have the "basic params" repeated 7 times across the test
+        // structure
+        for (size_t i = 0; i < 7; ++i) {
             fullSettings += basicSettings;
         }
         return fullSettings;