Criterion rework

.travis.yml

@@ -47,6 +47,7 @@ after_success:
           --exclude "skeleton-subsystem"
           --exclude "test/test-subsystem"
           --exclude "bindings/c/Test.cpp"
+          --exclude "parameter/criterion/test/"
           --exclude "test/tokenizer"
           --gcov-options '\--long-file-names --preserve-paths'
 

CMakeLists.txt

@@ -36,7 +36,7 @@ endif(COMMAND cmake_policy)
 
 project(parameter-framework)
 
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror -Wall -Wextra")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror -Wall -Wextra -std=c++11")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)

README.md

@@ -1,7 +1,7 @@
 # parameter-framework
 
-[![Build Status](https://travis-ci.org/01org/parameter-framework.svg?branch=master)](https://travis-ci.org/01org/parameter-framework)
-[![Coverage Status](https://coveralls.io/repos/01org/parameter-framework/badge.svg?branch=master)](https://coveralls.io/r/01org/parameter-framework)
+[![Build Status](https://travis-ci.org/01org/parameter-framework.svg?branch=next)](https://travis-ci.org/01org/parameter-framework)
+[![Coverage Status](https://coveralls.io/repos/01org/parameter-framework/badge.svg?branch=next)](https://coveralls.io/r/01org/parameter-framework)
 
 ## Introduction
 

bindings/c/CMakeLists.txt

@@ -28,7 +28,9 @@
 
 add_library(cparameter SHARED ParameterFramework.cpp)
 
-include_directories("${PROJECT_SOURCE_DIR}/parameter/include")
+include_directories(
+    "${PROJECT_SOURCE_DIR}/parameter/criterion/include"
+    "${PROJECT_SOURCE_DIR}/parameter/include")
 
 install(FILES ParameterFramework.h
         DESTINATION "include/parameter/c")

bindings/c/ParameterFramework.cpp

@@ -41,11 +41,12 @@
 #include <cstdlib>
 
 using std::string;
+using core::selection::criterion::CriterionInterface;
 
 /** Rename long pfw types to short ones in pfw namespace. */
 namespace pfw
 {
-    typedef ISelectionCriterionInterface Criterion;
+    typedef CriterionInterface Criterion;
     typedef std::map<string, Criterion *> Criteria;
     typedef CParameterMgrPlatformConnector Pfw;
 }
@@ -105,15 +106,24 @@ class LogWrapper : public CParameterMgrPlatformConnector::ILogger
     LogWrapper() : mLogger() {}
     virtual ~LogWrapper() {}
 private:
-    virtual void log(bool bIsWarning, const string &strLog)
+    virtual void info(const string &msg)
+    {
+        log(pfwLogInfo, msg);
+    }
+
+    virtual void warning(const string &msg)
+    {
+        log(pfwLogWarning, msg);
+    }
+
+    void log(PfwLogLevel level, const string &strLog)
     {
         // A LogWrapper should NOT be register to the pfw (thus log called)
         // if logCb is NULL.
         assert(mLogger.logCb != NULL);
-        mLogger.logCb(mLogger.userCtx,
-                      bIsWarning ? pfwLogWarning : pfwLogInfo,
-                      strLog.c_str());
+        mLogger.logCb(mLogger.userCtx, level, strLog.c_str());
     }
+
     PfwLogger mLogger;
 };
 
@@ -178,10 +188,11 @@ bool PfwHandler::createCriteria(const PfwCriterion criteriaArray[], size_t crite
                                   "\" already exist");
         }
 
-        // Create criterion type
-        ISelectionCriterionTypeInterface *type =
-            pfw->createSelectionCriterionType(criterion.inclusive);
-        assert(type != NULL);
+        // Create criterion
+        CriterionInterface *newCriterion = (criterion.inclusive ?
+                pfw->createInclusiveCriterion(criterion.name) :
+                pfw->createExclusiveCriterion(criterion.name));
+        assert(newCriterion != NULL);
         // Add criterion values
         for (size_t valueIndex = 0; criterion.values[valueIndex] != NULL; ++valueIndex) {
             int value;
@@ -196,13 +207,14 @@ bool PfwHandler::createCriteria(const PfwCriterion criteriaArray[], size_t crite
                 value = valueIndex;
             }
             const char * valueName = criterion.values[valueIndex];
-            if(not type->addValuePair(value, valueName)) {
+            string error;
+            if(not newCriterion->addValuePair(value, valueName, error)) {
                 return status.failure("Could not add value " + string(valueName) +
-                                      " to criterion " + criterion.name);
+                                      " to criterion " + criterion.name + ": " + error);
             }
         }
-        // Create criterion and add it to the pfw
-        criteria[criterion.name] = pfw->createSelectionCriterion(criterion.name, type);
+        // Add new criterion to criteria list
+        criteria[criterion.name] = newCriterion;
     }
     return status.success();
 }

bindings/c/Test.cpp

@@ -329,6 +329,17 @@ TEST_CASE_METHOD(Test, "Parameter-framework c api use") {
                         REQUIRE(value == 3);
                     }
                 }
+                WHEN("Set a new value to a criterion without committing first") {
+                    const char *criterionName = criteria[0].name;
+                    REQUIRE_SUCCESS(pfwSetCriterion(pfw, criterionName, 0));
+                    THEN("A warning message should have been displayed") {
+                        INFO("Previous pfw log: \n" + logLines);
+                        size_t logPos = logLines.find("Warning: Selection criterion "
+                                                      "'inclusiveCrit' has been modified 1 time(s)"
+                                                      " without any configuration application");
+                        CHECK(logPos != std::string::npos);
+                    }
+                }
             }
             WHEN("Commit criteria without a pfw") {
                 REQUIRE(not pfwApplyConfigurations(NULL));

bindings/python/CMakeLists.txt

@@ -36,7 +36,9 @@ find_package(PythonInterp 2.7 REQUIRED)
 find_package(PythonLibs ${PYTHON_VERSION_STRING} EXACT REQUIRED)
 include_directories(${PYTHON_INCLUDE_DIRS})
 
-include_directories(${PROJECT_SOURCE_DIR}/parameter/include)
+include_directories(
+    ${PROJECT_SOURCE_DIR}/parameter/include
+    ${PROJECT_SOURCE_DIR}/parameter/criterion/include)
 
 set_property(SOURCE pfw.i PROPERTY CPLUSPLUS ON)
 set_property(SOURCE pfw.i PROPERTY SWIG_FLAGS "-Wall" "-Werror")

bindings/python/pfw.i

@@ -80,10 +80,14 @@ public:
 
     void setLogger(ILogger* pLogger);
 
-    ISelectionCriterionTypeInterface* createSelectionCriterionType(bool bIsInclusive);
-    ISelectionCriterionInterface* createSelectionCriterion(const std::string& strName,
-            const ISelectionCriterionTypeInterface* pSelectionCriterionType);
-    ISelectionCriterionInterface* getSelectionCriterion(const std::string& strName);
+    core::selection::criterion::CriterionInterface*
+    createExclusiveCriterion(const std::string& name);
+
+    core::selection::criterion::CriterionInterface*
+    createInclusiveCriterion(const std::string& name);
+
+    core::selection::criterion::CriterionInterface*
+    getSelectionCriterion(const std::string& name);
 
     // Configuration application
     void applyConfigurations();
@@ -182,43 +186,44 @@ public:
 class ILogger
 {
     public:
-        virtual void log(bool bIsWarning, const std::string& strLog) = 0;
+        virtual void info(const std::string& log) = 0;
+        virtual void warning(const std::string& log) = 0;
     protected:
         virtual ~ILogger() {}
 };
 %{
 typedef CParameterMgrFullConnector::ILogger ILogger;
 %}
 
-class ISelectionCriterionTypeInterface
+namespace core
+{
+namespace selection
+{
+namespace criterion
 {
-%{
-#include "SelectionCriterionTypeInterface.h"
-%}
-
-public:
-    virtual bool addValuePair(int iValue, const std::string& strValue) = 0;
-    virtual bool getNumericalValue(const std::string& strValue, int& iValue) const = 0;
-    virtual bool getLiteralValue(int iValue, std::string& strValue) const = 0;
-    virtual bool isTypeInclusive() const = 0;
-    virtual std::string getFormattedState(int iValue) const = 0;
-
-protected:
-    virtual ~ISelectionCriterionTypeInterface() {}
-};
 
-class ISelectionCriterionInterface
+class CriterionInterface
 {
 %{
-#include "SelectionCriterionInterface.h"
+#include <criterion/client/CriterionInterface.h>
 %}
 
 public:
     virtual void setCriterionState(int iState) = 0;
     virtual int getCriterionState() const = 0;
     virtual std::string getCriterionName() const = 0;
-    virtual const ISelectionCriterionTypeInterface* getCriterionType() const = 0;
+    virtual bool addValuePair(int numericalValue,
+                              const std::string& literalValue,
+                              std::string& error) = 0;
+    virtual bool getNumericalValue(const std::string& literalValue, int& numericalValue) const = 0;
+    virtual bool getLiteralValue(int numericalValue, std::string& literalValue) const = 0;
+    virtual std::string getFormattedState() const = 0;
+    virtual bool isInclusive() const = 0;
 
 protected:
-    virtual ~ISelectionCriterionInterface() {}
+    virtual ~CriterionInterface() {}
 };
+
+} /** criterion namespace */
+} /** selection namespace */
+} /** core namespace */

parameter/Android.mk

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2014, Intel Corporation
+# Copyright (c) 2011-2015, Intel Corporation
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -44,7 +44,6 @@ common_copy_headers := \
 common_src_files := \
         AreaConfiguration.cpp \
         ArrayParameter.cpp \
-        AutoLog.cpp \
         BaseParameter.cpp \
         BinarySerializableElement.cpp \
         BinaryStream.cpp \
@@ -129,6 +128,7 @@ common_cflags := \
 
 common_c_includes := \
     $(LOCAL_PATH)/include/ \
+    $(LOCAL_PATH)/log/include/ \
     $(LOCAL_PATH)/../utility/ \
     $(LOCAL_PATH)/../xmlserializer/ \
     $(LOCAL_PATH)/../remote-processor/
@@ -197,7 +197,10 @@ include $(CLEAR_VARS)
 LOCAL_MODULE := $(common_module)_includes
 LOCAL_MODULE_OWNER := intel
 
-LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)
+LOCAL_EXPORT_C_INCLUDE_DIRS := \
+    $(LOCAL_PATH) \
+    $(LOCAL_PATH)/log/include
+
 
 LOCAL_STATIC_LIBRARIES := \
     libxmlserializer \

parameter/AreaConfiguration.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2014, Intel Corporation
+ * Copyright (c) 2011-2015, Intel Corporation
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification,
@@ -54,14 +54,16 @@ void CAreaConfiguration::save(const CParameterBlackboard* pMainBlackboard)
 }
 
 // Apply data to current
-bool CAreaConfiguration::restore(CParameterBlackboard* pMainBlackboard, bool bSync, std::list<std::string>* plstrError) const
+bool CAreaConfiguration::restore(CParameterBlackboard* pMainBlackboard,
+                                 bool bSync,
+                                 core::Results* errors) const
 {
     assert(_bValid);
 
     copyTo(pMainBlackboard, _pConfigurableElement->getOffset());
 
     // Synchronize if required
-    return !bSync || _pSyncerSet->sync(*pMainBlackboard, false, plstrError);
+    return !bSync || _pSyncerSet->sync(*pMainBlackboard, false, errors);
 }
 
 // Ensure validity

parameter/AreaConfiguration.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2014, Intel Corporation
+ * Copyright (c) 2011-2015, Intel Corporation
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification,
@@ -32,6 +32,7 @@
 #include "ParameterBlackboard.h"
 #include "BinaryStream.h"
 #include "SyncerSet.h"
+#include "Results.h"
 
 class CConfigurableElement;
 class CXmlElement;
@@ -48,8 +49,14 @@ class CAreaConfiguration
     // Save data from current
     void save(const CParameterBlackboard* pMainBlackboard);
 
-    // Apply data to current
-    bool restore(CParameterBlackboard* pMainBlackboard, bool bSync, std::list<std::string>* plstrError) const;
+    /** Restore the configuration area
+     *
+     * @param[in] pMainBlackboard the application main blackboard
+     * @param[in] bSync indicates if a synchronisation has to be done
+     * @param[out] errors, errors encountered during restoration
+     * @return true if success false otherwise
+     */
+    bool restore(CParameterBlackboard* pMainBlackboard, bool bSync, core::Results* errors) const;
 
     // Ensure validity
     void validate(const CParameterBlackboard* pMainBlackboard);

parameter/ArrayParameter.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2014, Intel Corporation
+ * Copyright (c) 2011-2015, Intel Corporation
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification,
@@ -34,6 +34,7 @@
 #include "ParameterAccessContext.h"
 #include "ConfigurationAccessContext.h"
 #include "ParameterBlackboard.h"
+#include "Utility.h"
 #include <assert.h>
 
 #define base CParameter
@@ -62,7 +63,7 @@ void CArrayParameter::showProperties(string& strResult) const
 
     // Array length
     strResult += "Array length: ";
-    strResult += toString(getArrayLength());
+    strResult += CUtility::toString(getArrayLength());
     strResult += "\n";
 }
 
@@ -281,7 +282,8 @@ bool CArrayParameter::setValues(uint32_t uiStartIndex, uint32_t uiBaseOffset, co
         if (!doSetValue(astrValues[uiValueIndex], uiOffset, parameterAccessContext)) {
 
             // Append parameter path to error
-            parameterAccessContext.appendToError(" " + getPath() + "/" + toString(uiValueIndex + uiStartIndex));
+            parameterAccessContext.appendToError(" " + getPath() + "/" +
+                                                 CUtility::toString(uiValueIndex + uiStartIndex));
 
             return false;
         }