[config] Implementation of new configuration management

CMakePresets.json

@@ -89,6 +89,7 @@
         "HAS_CURL": "ON",
         "HAS_FTXUI": "ON",
         "BUILD_APPS": "ON",
+        "BUILD_SAMPLES": "ON",
         "ECAL_THIRDPARTY_BUILD_FINEFTP": "ON",
         "ECAL_THIRDPARTY_BUILD_FTXUI": "ON",
         "ECAL_THIRDPARTY_BUILD_SPDLOG": "ON",

app/mon/mon_gui/src/ecalmon.cpp

@@ -93,8 +93,8 @@ Ecalmon::Ecalmon(QWidget *parent)
   network_mode_warning_icon_->setPixmap(warning_icon);
   network_mode_warning_icon_->setVisible(false);
 
-  bool network_mode = eCAL::Config::IsNetworkEnabled();
-  int multicast_ttl = eCAL::Config::GetUdpMulticastTtl();
+  bool network_mode = eCAL::Config::GetCurrentConfig()->transport_layer_options.network_enabled;
+  int multicast_ttl = eCAL::Config::GetCurrentConfig()->transport_layer_options.mc_options.ttl;
 
   if (network_mode)
   {

app/mon/mon_gui/src/widgets/ecalmon_tree_widget/topic_widget.cpp

@@ -187,9 +187,9 @@ void TopicWidget::loadRegExpLists()
 
   QString exclude_string;
   QString include_string;
-  exclude_string = QString::fromStdString(eCAL::Config::GetMonitoringFilterExcludeList()); //ini.GetValue(MON_SECTION_S, MON_FILTER_EXCL_S);
+  exclude_string = QString::fromStdString(eCAL::Config::GetCurrentConfig()->monitoring_options.filter_excl);
 
-  include_string = QString::fromStdString(eCAL::Config::GetMonitoringFilterIncludeList()); //ini.GetValue(MON_SECTION_S, MON_FILTER_INCL_S);
+  include_string = QString::fromStdString(eCAL::Config::GetCurrentConfig()->monitoring_options.filter_incl);
 
 
   // The ecal.ini defines a very strange regex format: A filter consists of

app/mon/mon_tui/src/tui/viewmodel/command_line.hpp

@@ -115,7 +115,7 @@ class CommandLineViewModel : public ViewModel
   {
     using namespace std::placeholders;
 
-    network_mode = eCAL::Config::IsNetworkEnabled() ? "cloud" : "local";
+    network_mode = eCAL::Config::GetCurrentConfig()->transport_layer_options.network_enabled ? "cloud" : "local";
     is_polling_time = true;
     time_updater = std::thread(std::bind(&CommandLineViewModel::UpdateCurrentEcalTime, this));
 

app/rec/rec_client_core/src/job/record_job.cpp

@@ -21,6 +21,7 @@
 
 #include <ecal_utils/filesystem.h>
 #include <ecal_utils/ecal_utils.h>
+#include <ecal/ecal_config.h>
 
 #include "hdf5_writer_thread.h"
 
@@ -170,7 +171,7 @@ namespace eCAL
 #undef CopyFile
 #endif // CopyFile
         {
-          std::string ecal_ini_original_path = eCAL::Config::GetLoadedEcalIniPath();
+          std::string ecal_ini_original_path = Config::GetCurrentConfig()->loaded_ecal_ini_file;
 
           if (ecal_ini_original_path.empty())
           {

app/sys/sys_gui/src/widgets/import_from_cloud_widget/import_from_cloud_widget.cpp

@@ -927,8 +927,8 @@ void ImportFromCloudWidget::loadExcludeTasksFilter()
   QFile default_cfg_file(default_cfg_file_path.c_str());
   if (default_cfg_file.exists())
   {
-    std::regex reg(eCAL::Config::GetEcalSysFilterExcludeList(), std::regex::icase);
-    exclude_tasks_regex_valid_ = !eCAL::Config::GetEcalSysFilterExcludeList().empty();
+    std::regex reg(eCAL::Config::GetCurrentConfig()->application_options.sys_options.filter_excl, std::regex::icase);
+    exclude_tasks_regex_valid_ = !eCAL::Config::GetCurrentConfig()->application_options.sys_options.filter_excl.empty();
     exclude_tasks_regex_ = reg;
   }
 }

ecal/core/CMakeLists.txt

@@ -66,10 +66,11 @@ endif()
 # config
 ######################################
 set(ecal_config_src
-    src/config/ecal_config.cpp
     src/config/ecal_config_reader.cpp
     src/config/ecal_config_reader.h
     src/config/ecal_config_reader_hlp.h
+    src/config/ecal_config_initializer.cpp
+    src/types/ecal_custom_data_types.cpp
 )
 
 ######################################
@@ -475,7 +476,6 @@ set(ecal_header_cmn
     include/ecal/ecal.h
     include/ecal/ecal_callback.h
     include/ecal/ecal_client.h
-    include/ecal/ecal_config.h
     include/ecal/ecal_core.h
     include/ecal/ecal_deprecate.h
     include/ecal/ecal_init.h
@@ -495,6 +495,7 @@ set(ecal_header_cmn
     include/ecal/ecal_tlayer.h
     include/ecal/ecal_types.h
     include/ecal/ecal_util.h
+    include/ecal/types/ecal_config_types.h
 )
 
 set(ecal_header_cimpl

ecal/core/cfg/ecal.ini

@@ -178,13 +178,13 @@ filter_excl                        = ^eCALSysClient$|^eCALSysGUI$|^eCALSys$
 ; shm_monitoring_enabled           = false                         Enable distribution of monitoring/registration information via shared memory
 ; shm_monitoring_domain            = ecal_monitoring               Domain name for shared memory based monitoring/registration
 ; shm_monitoring_queue_size        = 1024                          Queue size of monitoring/registration events
-; network_monitoring_disabled      = false                         Disable distribution of monitoring/registration information via network
+; network_monitoring_enabled       = true                          Enable distribution of monitoring/registration information via network
 ;
 ; drop_out_of_order_messages       = false                         Enable dropping of payload messages that arrive out of order
 ; --------------------------------------------------
 [experimental]
 shm_monitoring_enabled             = false
 shm_monitoring_domain              = ecal_mon
 shm_monitoring_queue_size          = 1024
-network_monitoring_disabled        = false
+network_monitoring_enabled         = true
 drop_out_of_order_messages         = false

ecal/core/include/ecal/ecal.h

@@ -42,3 +42,4 @@
 #include <ecal/ecal_timer.h>
 #include <ecal/ecal_tlayer.h>
 #include <ecal/ecal_util.h>
+#include <ecal/types/ecal_config_types.h>

ecal/core/include/ecal/ecal_config.h

@@ -16,13 +16,15 @@
  *
  * ========================= eCAL LICENSE =================================
 */
-
+// TODO PG: Remove, deprecated
 #pragma once
 
 #include <cstddef>
 #include <ecal/ecal_log_level.h>
 #include <ecal/ecal_os.h>
 #include <ecal/ecal_tlayer.h>
+#include <ecal/ecal_log_level.h>
+#include "ecal/types/ecal_config_types.h"
 
 #include <string>
 
@@ -31,11 +33,11 @@ namespace eCAL
 {
   namespace Config
   {
-    enum class UdpConfigVersion
-    {
-      V1 = 1, // Legacy
-      V2 = 2
-    };
+    // enum class UdpConfigVersion
+    // {
+    //   V1 = 1, // Legacy
+    //   V2 = 2
+    // };
 
     /////////////////////////////////////
     // common

ecal/core/include/ecal/ecal_core.h

@@ -31,6 +31,7 @@
 #include <utility>
 
 #include <ecal/ecal_os.h>
+#include "ecal/types/ecal_config_types.h"
 
 namespace eCAL
 {
@@ -69,7 +70,7 @@ namespace eCAL
    *
    * @return Zero if succeeded, 1 if already initialized, -1 if failed.
   **/
-  ECAL_API int Initialize(int argc_ = 0, char **argv_ = nullptr, const char *unit_name_ = nullptr, unsigned int components_ = Init::Default);
+  ECAL_API int Initialize(int argc_ = 0, char** argv_ = nullptr, const char* unit_name_ = nullptr, unsigned int components_ = Init::Default, Config::eCALConfig* = nullptr);
 
   /**
    * @brief Initialize eCAL API.
@@ -80,7 +81,7 @@ namespace eCAL
    *
    * @return Zero if succeeded, 1 if already initialized, -1 if failed.
   **/
-  ECAL_API int Initialize(std::vector<std::string> args_, const char *unit_name_ = nullptr, unsigned int components_ = Init::Default);
+  ECAL_API int Initialize(std::vector<std::string> args_, const char *unit_name_ = nullptr, unsigned int components_ = Init::Default, Config::eCALConfig* user_settings_ = nullptr);
 
   /**
    * @brief Finalize eCAL API.

ecal/core/include/ecal/types/ecal_application_options.h

@@ -0,0 +1,49 @@
+/* =========================== LICENSE =================================
+ *
+ * Copyright (C) 2016 - 2024 Continental Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * =========================== LICENSE =================================
+ */
+
+/**
+ * @file   ecal_application_options.h
+ * @brief  eCAL options for configuration of applications
+**/
+
+#pragma once
+
+#include <string>
+
+namespace eCAL
+{
+  namespace Config
+  {
+    struct SysOptions
+    {
+      std::string filter_excl;
+    };
+
+    struct ProcessOptions
+    {
+      std::string terminal_emulator;
+    };
+
+    struct ApplicationOptions
+    {
+      SysOptions     sys_options;
+      ProcessOptions process_options;
+    };
+  }
+}

ecal/core/include/ecal/types/ecal_config_types.h

@@ -0,0 +1,66 @@
+/* =========================== LICENSE =================================
+ *
+ * Copyright (C) 2016 - 2024 Continental Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * =========================== LICENSE =================================
+ */
+
+/**
+ * @file   ecal_config_types.h
+ * @brief  eCAL config interface using structs
+**/
+
+#pragma once
+
+#include "ecal_application_options.h"
+#include "ecal_custom_data_types.h"
+#include "ecal_monitoring_options.h"
+#include "ecal_publisher_options.h"
+#include "ecal_receiving_options.h"
+#include "ecal_registration_options.h"
+#include "ecal_service_options.h"
+#include "ecal_internal_options.h"
+#include "ecal_transport_layer_options.h"
+
+#include "ecal/ecal_os.h"
+#include "ecal/ecal_log_level.h"
+
+#include <string>
+#include <vector>
+#include <iostream>
+#include <chrono>
+
+namespace eCAL
+{
+  namespace Config
+  {        
+    struct eCALConfig
+    {
+        TransportLayerOptions transport_layer_options;
+        RegistrationOptions   registration_options;
+        MonitoringOptions     monitoring_options;
+        ReceivingOptions      receiving_options;
+        PublisherOptions      publisher_options;
+        TimesyncOptions       timesync_options;
+        ServiceOptions        service_options;
+        ApplicationOptions    application_options;
+        std::string           loaded_ecal_ini_file;
+
+        ECAL_API eCALConfig();
+    };
+
+    ECAL_API eCALConfig* GetCurrentConfig();
+	}
+}

ecal/core/include/ecal/types/ecal_custom_data_types.h

@@ -0,0 +1,101 @@
+/* =========================== LICENSE =================================
+ *
+ * Copyright (C) 2016 - 2024 Continental Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * =========================== LICENSE =================================
+ */
+
+/**
+ * @file   ecal_custom_types.h
+ * @brief  eCAL custom types for configuration declarations
+**/
+
+#pragma once
+
+#include "ecal/ecal_os.h"
+
+#include <string>
+#include <iostream>
+#include <regex>
+#include <limits>
+
+namespace eCAL
+{
+  namespace Config
+  {
+    /**
+     * @brief  Class for evaluation and storing an IP address.
+     *
+     * @param ip_adress_  The IP address as std::string.
+    **/
+    class IpAddressV4
+    {
+    public:      
+      IpAddressV4() = default;
+      ECAL_API IpAddressV4(const std::string ip_address_);  
+
+      const std::string get() { return m_ip_address; }
+
+    private:            
+      static bool checkIpString(std::string ip_address_);  
+
+      std::string     m_ip_address{};
+    };
+
+    /**
+     * @brief  Template class to specify sizes with a concrete minimum, maximum and step size definition.
+     *
+     * @tparam MIN   Optional minimum possible size. Default: 0
+     * @tparam STEP  Optional step size.             Default: 1 
+     * @tparam MAX   Optional maximum possible size. Default: std::numeric_limits<int>::max()
+     * 
+     * @param size_  Optional size value. If not set, LimitSize::get() will return the MIN value.
+    **/
+    template<int MIN = 0, int STEP = 1, int MAX = std::numeric_limits<int>::max()>
+    class LimitSize
+    {
+    public:
+      LimitSize(int size_ = MIN)
+      {
+        if (size_ >= MIN && size_ <= MAX && size_ % STEP == 0)
+        {
+          m_size = size_;
+        }
+        else
+        {
+          std::cerr << "[LimitSize] Faulty size configuration or assignment. MIN: " << MIN << " MAX: " << MAX << " STEP: " << STEP << " VALUE:" << size_ << "\n";
+          exit(EXIT_FAILURE);
+        }
+      };
+
+      const int get() const { return m_size; };
+
+      bool operator==(const LimitSize& other) const { return this->m_size == other.get(); };
+      friend bool operator==(const LimitSize& lhs, const int& rhs) { return lhs.get() == rhs; };
+      friend bool operator==(const int& lhs, const LimitSize& rhs) { return rhs == lhs; };
+      friend bool operator==(const LimitSize& lhs, const unsigned int& rhs) { return lhs.get() == static_cast<int>(rhs); };
+      friend bool operator==(const unsigned int& lhs, const LimitSize& rhs) { return rhs == lhs; };
+
+    private:
+      int m_size;
+    };
+
+    enum class UdpConfigVersion
+    {
+      V1 = 1,
+      V2 = 2
+    };
+  }
+}