Merge pull request #293 from krocard/add-get-set-elementXML-commands

Add get and set element xml commands

Get command returns current element values (from main blackboard)
in XML format.

Set command allows assigning a configurable element's settings directly in XML.
Notes:
  - Tuning mode must be on
  - In case of failure, all the subelements that have been successfully
    written along the access keep their new value

Author: krocard

parameter/ArrayParameter.cpp

@@ -67,35 +67,6 @@ void CArrayParameter::showProperties(string& strResult) const
     strResult += "\n";
 }
 
-// XML configuration settings parsing
-bool CArrayParameter::serializeXmlSettings(CXmlElement& xmlConfigurationSettingsElementContent, CConfigurationAccessContext& configurationAccessContext) const
-{
-    // Check for value space
-    handleValueSpaceAttribute(xmlConfigurationSettingsElementContent, configurationAccessContext);
-
-    // Handle access
-    if (!configurationAccessContext.serializeOut()) {
-
-        // Actually set values to blackboard
-        if (!setValues(0, configurationAccessContext.getBaseOffset(), xmlConfigurationSettingsElementContent.getTextContent(), configurationAccessContext)) {
-
-            return false;
-        }
-    } else {
-
-        // Get string value
-        string strValue = getValues(
-                configurationAccessContext.getBaseOffset(), // Whole array requested
-                configurationAccessContext);
-
-        // Populate value into xml text node
-        xmlConfigurationSettingsElementContent.setTextContent(strValue);
-    }
-
-    // Done
-    return true;
-}
-
 // User set/get
 bool CArrayParameter::accessValue(CPathNavigator& pathNavigator, string& strValue, bool bSet, CParameterAccessContext& parameterAccessContext) const
 {
@@ -115,8 +86,8 @@ bool CArrayParameter::accessValue(CPathNavigator& pathNavigator, string& strValu
         }
 
         // Actually set values
-        if (!setValues(index, parameterAccessContext.getBaseOffset(), strValue, parameterAccessContext)) {
-
+        if (!setValues(index, getOffset() - parameterAccessContext.getBaseOffset(),
+                       strValue, parameterAccessContext)) {
             return false;
         }
 
@@ -131,17 +102,32 @@ bool CArrayParameter::accessValue(CPathNavigator& pathNavigator, string& strValu
         if (index == (size_t)-1) {
 
             // Whole array requested
-            strValue = getValues(parameterAccessContext.getBaseOffset(), parameterAccessContext);
+            strValue = getValues(getOffset() - parameterAccessContext.getBaseOffset(), parameterAccessContext);
 
         } else {
             // Scalar requested
-            doGetValue(strValue, getOffset() + index * getSize(), parameterAccessContext);
+            CParameter::doGetValue(strValue, getOffset() + index * getSize(), parameterAccessContext);
         }
     }
 
     return true;
 }
 
+/// Actual parameter access
+// String access
+bool CArrayParameter::doSetValue(const string& value, size_t offset,
+                                 CParameterAccessContext& parameterAccessContext) const
+{
+    return setValues(0, offset, value, parameterAccessContext);
+}
+
+void CArrayParameter::doGetValue(string& value, size_t offset,
+                                 CParameterAccessContext& parameterAccessContext) const
+{
+    // Whole array requested
+    value = getValues(offset, parameterAccessContext);
+}
+
 // Boolean
 bool CArrayParameter::access(std::vector<bool>& abValues, bool bSet, CParameterAccessContext& parameterAccessContext) const
 {
@@ -250,7 +236,7 @@ bool CArrayParameter::getIndex(CPathNavigator& pathNavigator, size_t& index, CPa
 }
 
 // Common set value processing
-bool CArrayParameter::setValues(size_t uiStartIndex, size_t baseOffset, const string& strValue, CParameterAccessContext& parameterAccessContext) const
+bool CArrayParameter::setValues(size_t uiStartIndex, size_t offset, const string& strValue, CParameterAccessContext& parameterAccessContext) const
 {
     // Deal with value(s)
     Tokenizer tok(strValue, Tokenizer::defaultDelimiters + ",");
@@ -270,11 +256,11 @@ bool CArrayParameter::setValues(size_t uiStartIndex, size_t baseOffset, const st
     // Process
     size_t valueIndex;
     size_t size = getSize();
-    size_t offset = getOffset() + uiStartIndex * size - baseOffset;
+    size_t startOffset = offset + uiStartIndex * size;
 
     for (valueIndex = 0; valueIndex < nbValues; valueIndex++) {
 
-        if (!doSetValue(astrValues[valueIndex], offset, parameterAccessContext)) {
+        if (!doSet(astrValues[valueIndex], startOffset, parameterAccessContext)) {
 
             // Append parameter path to error
             parameterAccessContext.appendToError(" " + getPath() + "/" +
@@ -289,10 +275,9 @@ bool CArrayParameter::setValues(size_t uiStartIndex, size_t baseOffset, const st
 }
 
 // Common get value processing
-string CArrayParameter::getValues(size_t baseOffset, CParameterAccessContext& parameterAccessContext) const
+string CArrayParameter::getValues(size_t offset, CParameterAccessContext& parameterAccessContext) const
 {
     size_t size = getSize();
-    size_t offset = getOffset() - baseOffset;
     size_t arrayLength = getArrayLength();
 
     string output;
@@ -302,7 +287,7 @@ string CArrayParameter::getValues(size_t baseOffset, CParameterAccessContext& pa
     for (size_t valueIndex = 0; valueIndex < arrayLength; valueIndex++) {
         string strReadValue;
 
-        doGetValue(strReadValue, offset, parameterAccessContext);
+        doGet(strReadValue, offset, parameterAccessContext);
 
         if (!bFirst) {
 

parameter/ArrayParameter.h

@@ -39,9 +39,6 @@ class CArrayParameter : public CParameter
     // Instantiation, allocation
     virtual size_t getFootPrint() const;
 
-    // XML configuration settings parsing
-    virtual bool serializeXmlSettings(CXmlElement& xmlConfigurationSettingsElementContent, CConfigurationAccessContext& configurationAccessContext) const;
-
     /// Value access
     using CBaseParameter::access;
     bool access(std::vector<bool>& abValues, bool bSet,
@@ -67,13 +64,24 @@ class CArrayParameter : public CParameter
     // Array length
     size_t getArrayLength() const;
     // Common set value processing
-    bool setValues(size_t uiStartIndex, size_t baseOffset, const std::string& strValue, CParameterAccessContext& parameterAccessContext) const;
+    bool setValues(size_t uiStartIndex, size_t offset, const std::string& strValue, CParameterAccessContext& parameterAccessContext) const;
     // Log / get values common
     std::string getValues(size_t baseOffset, CParameterAccessContext& parameterAccessContext) const;
     std::string logValue(CParameterAccessContext &context) const override;
     // Index retrieval from user set/get request
     bool getIndex(CPathNavigator& pathNavigator, size_t& index, CParameterAccessContext& parameterAccessContext) const;
 
+    /** Access whole array.
+     *
+     * @param[in] offset Offset of the array in the context blackboard.
+     * @{
+     */
+    bool doSetValue(const std::string& strValue, size_t offset,
+                    CParameterAccessContext& parameterAccessContext) const override;
+    void doGetValue(std::string& strValue, size_t offset,
+                    CParameterAccessContext& parameterAccessContext) const override;
+    /** @} */
+
     /// Value access
     // Generic Access
     template <typename type>

parameter/BaseParameter.cpp

@@ -174,7 +174,7 @@ bool CBaseParameter::accessValue(CPathNavigator& pathNavigator, string& strValue
     return access(strValue, bSet, parameterAccessContext);
 }
 
-void CBaseParameter::toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const
+void CBaseParameter::structureToXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const
 {
 
     // Delegate to type element

parameter/BaseParameter.h

@@ -72,8 +72,7 @@ class CBaseParameter : public CInstanceConfigurableElement
     bool access(std::string& strValue, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     virtual bool access(std::vector<std::string>& astrValues, bool bSet, CParameterAccessContext& parameterAccessContext) const;
 
-    // From IXmlSource
-    virtual void toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const;
+    void structureToXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const override final;
 
 protected:
     // Parameter Access

parameter/ConfigurableElement.cpp

@@ -36,6 +36,7 @@
 #include "AreaConfiguration.h"
 #include "Iterator.hpp"
 #include "Utility.h"
+#include "XmlParameterSerializingContext.h"
 #include <assert.h>
 
 #define base CElement
@@ -48,6 +49,37 @@ CConfigurableElement::~CConfigurableElement()
 {
 }
 
+bool CConfigurableElement::fromXml(const CXmlElement &xmlElement,
+                                   CXmlSerializingContext &serializingContext)
+{
+    auto &context = static_cast<CXmlParameterSerializingContext &>(serializingContext);
+    auto &accessContext = context.getAccessContext();
+
+    if (accessContext.serializeSettings()) {
+        // As serialization and deserialisation are handled through the *same* function
+        // the (de)serialize object can not be const in `serializeXmlSettings` signature.
+        // As a result a const_cast is unavoidable :(.
+        // Fixme: split serializeXmlSettings in two functions (in and out) to avoid the `const_cast`
+        return serializeXmlSettings(const_cast<CXmlElement&>(xmlElement),
+                                    static_cast<CConfigurationAccessContext &>(accessContext));
+    }
+    return structureFromXml(xmlElement, serializingContext);
+}
+
+void CConfigurableElement::toXml(CXmlElement &xmlElement,
+                                 CXmlSerializingContext &serializingContext) const
+{
+    auto &context = static_cast<CXmlParameterSerializingContext &>(serializingContext);
+    auto &accessContext = context.getAccessContext();
+    if (accessContext.serializeSettings()) {
+
+        serializeXmlSettings(xmlElement, static_cast<CConfigurationAccessContext &>(accessContext));
+    } else {
+
+        structureToXml(xmlElement, serializingContext);
+    }
+}
+
 // XML configuration settings parsing
 bool CConfigurableElement::serializeXmlSettings(CXmlElement& xmlConfigurationSettingsElementContent, CConfigurationAccessContext& configurationAccessContext) const
 {

parameter/ConfigurableElement.h

@@ -145,6 +145,36 @@ class PARAMETER_EXPORT CConfigurableElement : public CElement
 
     // XML configuration settings parsing
     virtual bool serializeXmlSettings(CXmlElement& xmlConfigurationSettingsElementContent, CConfigurationAccessContext& configurationAccessContext) const;
+
+    bool fromXml(const CXmlElement &xmlElement,
+                         CXmlSerializingContext &serializingContext) override final;
+
+    void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const override final;
+
+    /** Deserialize the structure from xml. */
+    virtual bool structureFromXml(const CXmlElement &xmlElement, CXmlSerializingContext &serializingContext)
+    {
+        // Forward to Element::fromXml.
+        // This is unfortunate as Element::fromXml will call back
+        // fromXml on each children.
+        // Thus on each non leaf node of the tree, the code will test if
+        // the setting or the structure are to be serialized.
+        // This test could be avoided by several ways including:
+        //  - split 2 roles fromXml in two function
+        //    1) construct the elements
+        //    2) recursive call on children
+        //  - dispatch in with a virtual method. This would not not remove
+        //    the branching rather hide it behind a virtual method override.
+        return CElement::fromXml(xmlElement, serializingContext);
+    }
+
+    /** Serialize the structure to xml. */
+    virtual void structureToXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const
+    {
+        // See structureFromXml implementation comment.
+        CElement::toXml(xmlElement, serializingContext);
+    }
+
 protected:
     // Syncer (me or ascendant)
     virtual ISyncer* getSyncer() const;

parameter/ConfigurationAccessContext.cpp

@@ -33,6 +33,16 @@
 
 using std::string;
 
+CConfigurationAccessContext::CConfigurationAccessContext(std::string& strError,
+                                                         CParameterBlackboard* pParameterBlackboard,
+                                                         bool bValueSpaceIsRaw,
+                                                         bool bOutputRawFormatIsHex,
+                                                         bool bSerializeOut) :
+    base(strError, pParameterBlackboard, bValueSpaceIsRaw, bOutputRawFormatIsHex),
+    _bSerializeOut(bSerializeOut)
+{
+}
+
 CConfigurationAccessContext::CConfigurationAccessContext(string& strError, bool bSerializeOut) :
     base(strError),
     _bSerializeOut(bSerializeOut)

parameter/ConfigurationAccessContext.h

@@ -36,11 +36,19 @@
 class CConfigurationAccessContext : public CParameterAccessContext
 {
 public:
+    CConfigurationAccessContext(std::string& strError,
+                                CParameterBlackboard* pParameterBlackboard,
+                                bool bValueSpaceIsRaw,
+                                bool bOutputRawFormatIsHex,
+                                bool bSerializeOut);
+
     CConfigurationAccessContext(std::string& strError, bool bSerializeOut);
 
     // Serialization direction
     bool serializeOut() const;
 
+    bool serializeSettings() const override final { return true; }
+
 private:
     // Serialization direction
     bool _bSerializeOut;

parameter/InstanceConfigurableElement.cpp

@@ -217,9 +217,10 @@ bool CInstanceConfigurableElement::checkPathExhausted(CPathNavigator& pathNaviga
     return true;
 }
 
-void CInstanceConfigurableElement::toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const
+void CInstanceConfigurableElement::structureToXml(CXmlElement &xmlElement,
+                                                  CXmlSerializingContext &serializingContext) const
 {
-    base::toXml(xmlElement, serializingContext);
+    base::structureToXml(xmlElement, serializingContext);
     // Since Description belongs to the Type of Element, delegate it to the type element.
     getTypeElement()->setXmlDescriptionAttribute(xmlElement);
 }

parameter/InstanceConfigurableElement.h

@@ -105,7 +105,7 @@ class PARAMETER_EXPORT CInstanceConfigurableElement : public CConfigurableElemen
     virtual void getListOfElementsWithMapping(std::list<const CConfigurableElement*>&
                                                configurableElementPath) const;
 
-    virtual void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const;
+    virtual void structureToXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const;
 
 protected:
     // Syncer