Changeset 89:ac4d46e44550 in finroc_plugins_parameters

Timestamp:

27.04.2020 05:53:49 (2 years ago)

Author:

Max Reichardt <mreichardt@…>

Branch:

17.03

Phase:

public

Message:

Revises implementation of tParameterInfo. It now supports managing and retaining parameter settings from multiple origins.

Location:

internal

Files:

• tParameterInfo.cpp (modified) (10 diffs)
• tParameterInfo.h (modified) (8 diffs)

internal/tParameterInfo.cpp

@@ -75 +75 @@
 static rrlib::rtti::tDataType<tParameterInfo> cTYPE;
 
+namespace
+{
+
+const std::string cEMPTY_STRING;
+
+}
+
 //----------------------------------------------------------------------
 // Implementation
 //----------------------------------------------------------------------
 
-tParameterInfo::tParameterInfo() :
-  config_entry(),
-  entry_set_from_finstruct(false),
-  command_line_option(),
-  finstruct_default()
+tParameterInfo::tParameterInfo()
 {}
 
 #ifdef _LIB_RRLIB_XML_PRESENT_
-void tParameterInfo::Deserialize(const rrlib::xml::tNode& node, bool finstruct_context, bool include_commmand_line)
-{
+void tParameterInfo::Deserialize(const rrlib::xml::tNode& node, bool high_precedence, bool include_commmand_line, tOrigin* origin)
+{
+  std::string config_entry = "";
   if (node.HasAttribute("config"))
   {
     config_entry = node.GetStringAttribute("config");
-    entry_set_from_finstruct = finstruct_context;
-  }
-  else
-  {
-    config_entry = "";
-  }
+  }
+  Set(tSettingType::CONFIG_ENTRY, origin, high_precedence, config_entry, false);
+
   if (include_commmand_line)
   {
+    std::string command_line_option = "";
     if (node.HasAttribute("cmdline"))
     {
       command_line_option = node.GetStringAttribute("cmdline");
     }
-    else
-    {
-      command_line_option = "";
-    }
-  }
+    Set(tSettingType::COMMAND_LINE_OPTION, origin, high_precedence, command_line_option, false);
+  }
+  std::string finstruct_default = "";
   if (node.HasAttribute("default"))
   {
     finstruct_default = node.GetStringAttribute("default");
   }
-  else
-  {
-    finstruct_default = "";
-  }
+  Set(tSettingType::FINSTRUCT_DEFAULT, origin, high_precedence, finstruct_default, false);
 }
 #endif
+
+const std::string& tParameterInfo::GetSetting(tSettingType type) const
+{
+  const tSetting* low_precedence_setting = nullptr;
+  const tSetting* high_precedence_setting = nullptr;
+  for (auto & setting : settings)
+  {
+    if (setting.type == type)
+    {
+      (setting.high_precedence ? high_precedence_setting : low_precedence_setting) = &setting;
+    }
+  }
+  return high_precedence_setting ? high_precedence_setting->value : (low_precedence_setting ? low_precedence_setting->value : cEMPTY_STRING);
+}
+
+const std::string& tParameterInfo::GetSetting(tSettingType type, bool high_precedence, tOrigin* origin) const
+{
+  for (auto & setting : settings)
+  {
+    if (setting.type == type && setting.high_precedence == high_precedence && setting.origin == origin)
+    {
+      return setting.value;
+    }
+  }
+  return cEMPTY_STRING;
+}
+
+bool tParameterInfo::IsConfigEntrySetFromFinstruct() const
+{
+  for (auto & setting : settings)
+  {
+    if (setting.type == tSettingType::CONFIG_ENTRY && setting.high_precedence)
+    {
+      return true;
+    }
+  }
+  return false;
+}
 
 bool tParameterInfo::IsFinstructableGroupResponsibleForConfigFileConnections(const core::tFrameworkElement& finstructable_group, const core::tFrameworkElement& ap)
@@ -134 +169 @@
     {
       // command line option
+      auto& command_line_option = GetCommandLineOption();
       if (command_line_option.length() > 0)
       {
@@ -168 +204 @@
       // config file entry
       tConfigFile* cf = tConfigFile::Find(*ann);
-      if (cf != NULL && config_entry.length() > 0)
+      auto& config_entry = GetConfigEntry();
+      if (cf && config_entry.length() > 0)
       {
         std::string full_config_entry = tConfigNode::GetFullConfigEntry(*ann, config_entry);
@@ -204 +241 @@
 
       // finstruct default
+      auto& finstruct_default = GetFinstructDefault();
       if (finstruct_default.length() > 0)
       {
@@ -251 +289 @@
 {
   core::tAbstractPort* ann = GetAnnotated<core::tAbstractPort>();
-  if (ann == NULL || (!ann->IsReady()))
+  if ((!ann) || (!ann->IsReady()))
   {
     return;
   }
   tConfigFile* cf = tConfigFile::Find(*ann);
+  auto& config_entry = GetConfigEntry();
   bool has_entry = cf->HasEntry(config_entry);
   if (data_ports::IsDataFlowType(ann->GetDataType()))
@@ -277 +316 @@
 
 #ifdef _LIB_RRLIB_XML_PRESENT_
-void tParameterInfo::Serialize(rrlib::xml::tNode & node, bool finstruct_context, bool include_command_line) const
+void tParameterInfo::Serialize(rrlib::xml::tNode& node, bool high_precedence, bool include_command_line, tOrigin* origin) const
 {
   assert(!(node.HasAttribute("default") || node.HasAttribute("cmdline") || node.HasAttribute("config")));
-  if (config_entry.length() > 0 && (entry_set_from_finstruct || (!finstruct_context)))
+  auto config_entry = GetSetting(tSettingType::CONFIG_ENTRY, high_precedence, origin);
+  if (config_entry.length())
   {
     node.SetAttribute("config", config_entry);
@@ -286 +326 @@
   if (include_command_line)
   {
-    if (command_line_option.length() > 0)
+    auto command_line_option = GetSetting(tSettingType::COMMAND_LINE_OPTION, high_precedence, origin);
+    if (command_line_option.length())
     {
       node.SetAttribute("cmdline", command_line_option);
     }
   }
+  auto finstruct_default = GetSetting(tSettingType::FINSTRUCT_DEFAULT, high_precedence, origin);
   if (finstruct_default.length() > 0)
   {
@@ -298 +340 @@
 #endif
 
-void tParameterInfo::SetConfigEntry(const std::string & config_entry, bool finstruct_set)
-{
-  if (this->config_entry.compare(config_entry) != 0)
-  {
-    this->config_entry = config_entry;
-    this->entry_set_from_finstruct = finstruct_set;
+bool tParameterInfo::Set(tSettingType type, tOrigin* origin, bool high_precedence, const std::string& value, bool load_on_change)
+{
+  auto existing_setting = settings.end();
+  for (auto it = settings.begin(); it != settings.end(); ++it)
+  {
+    if (it->type == type && it->origin == origin && it->high_precedence == high_precedence)
+    {
+      existing_setting = it;
+      break;
+    }
+  }
+
+  bool reload = false;
+  bool changed = false;
+  if (existing_setting != settings.end())
+  {
+    if (value.empty())
+    {
+      settings.erase(existing_setting);
+      changed = true;
+    }
+    else if (existing_setting->value != value)
+    {
+      existing_setting->value = value;
+      reload = true;
+    }
+  }
+  else if (!value.empty())
+  {
+    tSetting new_setting = { type, origin, high_precedence, value };
+    settings.push_back(new_setting);
+  }
+  changed |= reload;
+
+  if (load_on_change && reload)
+  {
     try
     {
@@ -313 +385 @@
     }
   }
+
+  return changed;
 }
 
@@ -327 +401 @@
 rrlib::serialization::tInputStream& operator >> (rrlib::serialization::tInputStream & stream, tParameterInfo & parameter_info)
 {
-  parameter_info.entry_set_from_finstruct = stream.ReadBoolean();
-  std::string config_entry_tmp = stream.ReadString();
-  std::string command_line_option_tmp = stream.ReadString();
-  std::string finstruct_default_tmp = stream.ReadString();
-  bool same = config_entry_tmp.compare(parameter_info.GetConfigEntry()) == 0 &&
-              command_line_option_tmp.compare(parameter_info.GetCommandLineOption()) == 0 &&
-              finstruct_default_tmp.compare(parameter_info.GetFinstructDefault()) == 0;
-  parameter_info.config_entry = config_entry_tmp;
-  parameter_info.command_line_option = command_line_option_tmp;
-  parameter_info.finstruct_default = finstruct_default_tmp;
-
-  if (!same)
+  bool entry_set_from_finstruct = stream.ReadBoolean();
+  std::string config_entry = stream.ReadString();
+  std::string command_line_option = stream.ReadString();
+  std::string finstruct_default = stream.ReadString();
+  bool changed = parameter_info.Set(tParameterInfo::tSettingType::CONFIG_ENTRY, nullptr, entry_set_from_finstruct, config_entry, false);
+  changed |= parameter_info.Set(tParameterInfo::tSettingType::COMMAND_LINE_OPTION, nullptr, true, command_line_option, false);
+  changed |= parameter_info.Set(tParameterInfo::tSettingType::FINSTRUCT_DEFAULT, nullptr, true, finstruct_default, false);
+
+  if (changed)
   {
     try

internal/tParameterInfo.h

@@ -78 +78 @@
 public:
 
+  typedef core::tFrameworkElement tOrigin;
+
+  enum class tSettingType : uint8_t
+  {
+    CONFIG_ENTRY,         // Place in Configuration tree, this parameter is configured from (nodes are separated with '/')  (starting with '/' => absolute link - otherwise relative)
+    COMMAND_LINE_OPTION,  // Command line option to set this parameter (set by outer-most finstructable group)
+    FINSTRUCT_DEFAULT     // Default value set in finstruct (optional)
+  };
+
+  struct tSetting
+  {
+    tSettingType type;
+    tOrigin* origin;
+    bool high_precedence; // Entry with higher precedence than entries without this flag (typically true for finstructed entries)
+    std::string value;
+  };
+
+
   tParameterInfo();
 
 #ifdef _LIB_RRLIB_XML_PRESENT_
-  void Deserialize(const rrlib::xml::tNode& node, bool finstruct_context, bool include_commmand_line);
+  void Deserialize(const rrlib::xml::tNode& node, bool high_precedence, bool include_commmand_line, tOrigin* origin);
 #endif
 
@@ -88 +106 @@
    * (set by outer-most finstructable group)
    */
-  std::string GetCommandLineOption() const
-  {
-    return command_line_option;
+  inline const std::string& GetCommandLineOption() const
+  {
+    return GetSetting(tSettingType::COMMAND_LINE_OPTION);
   }
 
@@ -96 +114 @@
    * \return Place in Configuration tree, this parameter is configured from (nodes are separated with dots)
    */
-  inline std::string GetConfigEntry() const
-  {
-    return config_entry;
+  inline const std::string& GetConfigEntry() const
+  {
+    return GetSetting(tSettingType::CONFIG_ENTRY);
   }
 
@@ -105 +123 @@
    * (set by finstructable group responsible for connecting this parameter to attribute tree)
    */
-  std::string GetFinstructDefault() const
-  {
-    return finstruct_default;
-  }
-
-  /*!
-   * \return Does parameter have any non-default info relevant for finstructed group?
-   */
-  bool HasNonDefaultFinstructInfo()
-  {
-    return (config_entry.length() > 0 && entry_set_from_finstruct) || command_line_option.length() > 0 || finstruct_default.length() > 0;
+  inline const std::string& GetFinstructDefault() const
+  {
+    return GetSetting(tSettingType::FINSTRUCT_DEFAULT);
   }
 
@@ -121 +131 @@
    * \return Is config entry set from finstruct/xml?
    */
-  bool IsConfigEntrySetFromFinstruct() const
-  {
-    return entry_set_from_finstruct;
-  }
+  bool IsConfigEntrySetFromFinstruct() const;
 
   /*!
@@ -137 +144 @@
   /*!
    * load value from configuration file
-   */
-  inline void LoadValue()
-  {
-    LoadValue(false);
-  }
-
-  /*!
-   * load value from configuration file
    *
-   * \param ignore ready flag?
-   */
-  void LoadValue(bool ignore_ready);
+   * \param ignore_ready Ignore ready flag?
+   */
+  void LoadValue(bool ignore_ready = false);
 
   /*!
@@ -157 +156 @@
 
 #ifdef _LIB_RRLIB_XML_PRESENT_
-  void Serialize(rrlib::xml::tNode& node, bool finstruct_context, bool include_command_line) const;
+  void Serialize(rrlib::xml::tNode& node, bool high_precedence, bool include_command_line, tOrigin* origin) const;
 #endif
 
   /*!
-   * \param commandLineOption Command line option to set this parameter
+   * \param command_line_option Command line option to set this parameter
+   * \param high_precedence Entry with higher precedence than entries without this flag
+   * \param origin Optional origin for entry
    * (set by outer-most finstructable group)
    */
-  void SetCommandLineOption(const std::string& command_line_option)
-  {
-    this->command_line_option = command_line_option;
-  }
-
-  /*!
-   * (loads value from configuration file, if is exists
+  void SetCommandLineOption(const std::string& command_line_option, bool high_precedence = false, tOrigin* origin = nullptr)
+  {
+    Set(tSettingType::COMMAND_LINE_OPTION, origin, high_precedence, command_line_option, false);
+  }
+
+  /*!
+   * (loads value from configuration file, if is exists)
    *
    * \param config_entry New Place in Configuration tree, this parameter is configured from (nodes are separated with dots)
    * \param finstruct_set Is config entry set from finstruct?
-   */
-  void SetConfigEntry(const std::string& config_entry, bool finstruct_set = false);
-
-  /*!
-   * \param finstructDefault Default value set in finstruct.
+   * \param origin Optional origin for entry
+   */
+  void SetConfigEntry(const std::string& config_entry, bool finstruct_set = false, tOrigin* origin = nullptr)
+  {
+    Set(tSettingType::CONFIG_ENTRY, origin, finstruct_set, config_entry, true);
+  }
+
+  /*!
+   * \param finstruct_default Default value set in finstruct.
+   * \param high_precedence Entry with higher precedence than entries without this flag
+   * \param origin Optional origin for entry
    * (set by finstructable group responsible for connecting this parameter to attribute tree)
    */
-  void SetFinstructDefault(const std::string& finstruct_default)
-  {
-    this->finstruct_default = finstruct_default;
+  void SetFinstructDefault(const std::string& finstruct_default, bool high_precedence = false, tOrigin* origin = nullptr)
+  {
+    Set(tSettingType::FINSTRUCT_DEFAULT, origin, high_precedence, finstruct_default, true);
+  }
+
+  /*!
+   * \return All current settings for this parameter
+   */
+  const std::vector<tSetting>& Settings() const
+  {
+    return settings;
   }
 
@@ -194 +209 @@
   friend rrlib::serialization::tInputStream& operator >> (rrlib::serialization::tInputStream& stream, tParameterInfo& parameter_info);
 
-  /*!
-   * Place in Configuration tree, this parameter is configured from (nodes are separated with '/')
-   * (starting with '/' => absolute link - otherwise relative)
-   */
-  std::string config_entry;
-
-  /*! Was config entry set from finstruct? */
-  bool entry_set_from_finstruct;
-
-  /*!
-   * Command line option to set this parameter
-   * (set by outer-most finstructable group)
-   */
-  std::string command_line_option;
-
-  /*!
-   * Default value set in finstruct (optional)
-   * (set by finstructable group responsible for connecting this parameter to attribute tree)
-   */
-  std::string finstruct_default;
-
-
+  std::vector<tSetting> settings;
+
+  const std::string& GetSetting(tSettingType type) const;
+  const std::string& GetSetting(tSettingType type, bool high_precedence, tOrigin* origin) const;
   virtual void OnInitialization() override;
+  bool Set(tSettingType type, tOrigin* origin, bool high_precedence, const std::string& value, bool load_on_change);
 };