Move all signals search functions into new signals_manager_t object

Create a class from signals lookup and find standalone function and gather all
find function into it. There is now only 1 function to find either CAN signals
or diagnostic messages, results are returned using an ad-hoc struct containing
vector of one or the other type pointers.

This object also hold subscribed_signals map with events, so this class is a singleton.

Change-Id: I3584c6a91201e6904edc6aeac0abfa1785bdeccc
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>

2 files changed, 90 insertions, 101 deletions

diff --git a/CAN-binder/low-can-binding/utils/signals.cpp b/CAN-binder/low-can-binding/utils/signals.cpp
index 2e14a98f..219dfd40 100644
--- a/CAN-binder/low-can-binding/utils/signals.cpp
+++ b/CAN-binder/low-can-binding/utils/signals.cpp
@@ -17,60 +17,58 @@
 
 #include "signals.hpp"
 
-/// 
-/// @brief Can signal event map making access to afb_event
-/// externaly to an openxc existing structure.
-///
-/// Event map is making relation between can_signal_t generic name
-/// and the afb_event struct used by application framework to pushed
-/// to the subscriber.
-///
-std::map<std::string, struct afb_event> subscribed_signals;
-
-///
-/// @brief Mutex allowing safe manipulation on subscribed_signals map.
-/// To ensure that the map object isn't modified when we read it, you
-///  have to set this mutex before use subscribed_signals map object.
-///
-std::mutex subscribed_signals_mutex;
-
-std::mutex& get_subscribed_signals_mutex()
+namespace utils
 {
-	return subscribed_signals_mutex;
-}
+	/// @brief Return singleton instance of configuration object.
+	signals_manager_t& signals_manager_t::instance()
+	{
+		static signals_manager_t sm;
+		return sm;
+	}
 
-std::map<std::string, struct afb_event>& get_subscribed_signals()
-{
-	return subscribed_signals;
-}
+	/// @brief Return Subscribed signals map mutex.
+	std::mutex& signals_manager_t::get_subscribed_signals_mutex()
+	{
+		return subscribed_signals_mutex_;
+	}
 
-///
-/// @fn std::vector<std::string> find_signals(const openxc_DynamicField &key)
-/// @brief return signals name found searching through CAN_signals and OBD2 pid
-///
-/// @param[in] key : can contain numeric or string value in order to search against 
-///   can signals or obd2 signals name.
-///
-/// @return Vector of signals name found. 
-///
-std::vector<std::string> find_signals(const openxc_DynamicField &key)
-{
-	std::vector<std::string> found_signals_name;
+	///
+	/// @brief return the subscribed_signals map.
+	/// 
+	/// @return Map of subscribed signals.
+	std::map<std::string, struct afb_event>& signals_manager_t::get_subscribed_signals()
+	{
+		return subscribed_signals_;
+	}
 
-	switch(key.type)
+	///
+	/// @fn std::vector<std::string> find_signals(const openxc_DynamicField &key)
+	/// @brief return signals name found searching through CAN_signals and OBD2 pid
+	///
+	/// @param[in] key : can contain numeric or string value in order to search against 
+	///   can signals or obd2 signals name.
+	///
+	/// @return Vector of signals name found. 
+	///
+	struct signals_found signals_manager_t::find_signals(const openxc_DynamicField &key)
 	{
-		case openxc_DynamicField_Type::openxc_DynamicField_Type_STRING:
-				lookup_signals_by_name(key.string_value, configuration_t::instance().get_can_signals(), found_signals_name);
-				lookup_signals_by_name(key.string_value, configuration_t::instance().get_diagnostic_messages(), found_signals_name);
-			break;
-		case openxc_DynamicField_Type::openxc_DynamicField_Type_NUM:
-				lookup_signals_by_id(key.numeric_value, configuration_t::instance().get_can_signals(), found_signals_name);
-				lookup_signals_by_id(key.numeric_value, configuration_t::instance().get_diagnostic_messages(), found_signals_name);
-			break;
-		default:
-			ERROR(binder_interface, "find_signals: wrong openxc_DynamicField specified. Use openxc_DynamicField_Type_NUM or openxc_DynamicField_Type_STRING type only.");
-			break;
+		struct signals_found sf;
+
+		switch(key.type)
+		{
+			case openxc_DynamicField_Type::openxc_DynamicField_Type_STRING:
+					lookup_signals_by_name(key.string_value, configuration_t::instance().get_can_signals(), sf.can_signals);
+					lookup_signals_by_name(key.string_value, configuration_t::instance().get_diagnostic_messages(), sf.diagnostic_messages);
+				break;
+			case openxc_DynamicField_Type::openxc_DynamicField_Type_NUM:
+					lookup_signals_by_id(key.numeric_value, configuration_t::instance().get_can_signals(), sf.can_signals);
+					lookup_signals_by_id(key.numeric_value, configuration_t::instance().get_diagnostic_messages(), sf.diagnostic_messages);
+				break;
+			default:
+				ERROR(binder_interface, "find_signals: wrong openxc_DynamicField specified. Use openxc_DynamicField_Type_NUM or openxc_DynamicField_Type_STRING type only.");
+				break;
+		}
+		DEBUG(binder_interface, "find_signals: Found %d signal(s)", (int)(sf.can_signals.size() + sf.diagnostic_messages.size()));
+		return sf;
 	}
-	DEBUG(binder_interface, "find_signals: Found %d signal(s)", (int)found_signals_name.size());
-	return found_signals_name;
-}
+}
\ No newline at end of file
diff --git a/CAN-binder/low-can-binding/utils/signals.hpp b/CAN-binder/low-can-binding/utils/signals.hpp
index e9417569..d2e9205c 100644
--- a/CAN-binder/low-can-binding/utils/signals.hpp
+++ b/CAN-binder/low-can-binding/utils/signals.hpp
@@ -28,63 +28,54 @@
 
 #include "../low-can-binding.hpp"
 
-extern std::mutex subscribed_signals_mutex;
-std::mutex& get_subscribed_signals_mutex();
-
-/**
- * @brief return the subscribed_signals map.
- * 
- * return Map of subscribed signals.
- */
-extern std::map<std::string, struct afb_event> subscribed_signals;
-std::map<std::string, struct afb_event>& get_subscribed_signals();
-
-template <typename T>
-void lookup_signals_by_name(const std::string& key, std::vector<T>& signals, std::vector<T*>& found_signals)
+namespace utils
 {
-	for(T& s : signals)
+	struct signals_found
 	{
-		if(::fnmatch(key.c_str(), s.get_generic_name().c_str(), FNM_CASEFOLD) == 0)
-			found_signals.push_back(&s);
-		if(::fnmatch(key.c_str(), s.get_name().c_str(), FNM_CASEFOLD) == 0)
-			found_signals.push_back(&s);
-	}
-}
+		std::vector<can_signal_t*> can_signals;
+		std::vector<diagnostic_message_t*> diagnostic_messages;
+	};
 
-template <typename T>
-void lookup_signals_by_name(const std::string& key, std::vector<T>& signals, std::vector<std::string>& found_signals_name)
-{
-	for(T& s : signals)
+	class signals_manager_t
 	{
-		if(::fnmatch(key.c_str(), s.get_generic_name().c_str(), FNM_CASEFOLD) == 0)
-			found_signals_name.push_back(s.get_name());
-		if(::fnmatch(key.c_str(), s.get_name().c_str(), FNM_CASEFOLD) == 0)
-			found_signals_name.push_back(s.get_name());
-	}
-}
+	private:
+		std::mutex subscribed_signals_mutex_;
+		std::map<std::string, struct afb_event> subscribed_signals_;
 
-template <typename T>
-void lookup_signals_by_id(const double key, std::vector<T>& signals, std::vector<T*>& found_signals)
-{
-	for(T& s : signals)
-	{
-		if(configuration_t::instance().get_signal_id(s) == key)
+		signals_manager_t(); ///< Private constructor to make singleton class.
+
+	public:
+		static signals_manager_t& instance();
+
+		std::mutex& get_subscribed_signals_mutex();
+		std::map<std::string, struct afb_event>& get_subscribed_signals();
+
+		struct signals_found find_signals(const openxc_DynamicField &key);
+		void find_diagnostic_messages(const openxc_DynamicField &key, std::vector<diagnostic_message_t*>& found_signals);
+		void find_can_signals(const openxc_DynamicField &key, std::vector<can_signal_t*>& found_signals);
+
+		template <typename T>
+		void lookup_signals_by_name(const std::string& key, std::vector<T>& signals, std::vector<T*>& found_signals)
 		{
-			found_signals.push_back(&s);
+			for(T& s : signals)
+			{
+				if(::fnmatch(key.c_str(), s.get_generic_name().c_str(), FNM_CASEFOLD) == 0)
+					found_signals.push_back(&s);
+				if(::fnmatch(key.c_str(), s.get_name().c_str(), FNM_CASEFOLD) == 0)
+					found_signals.push_back(&s);
+			}
 		}
-	}
-}
 
-template <typename T>
-void lookup_signals_by_id(const double key, std::vector<T>& signals, std::vector<std::string>& found_signals_name)
-{
-	for(T& s : signals)
-	{
-		if(configuration_t::instance().get_signal_id(s) == key)
+		template <typename T>
+		void lookup_signals_by_id(const double key, std::vector<T>& signals, std::vector<T*>& found_signals)
 		{
-			found_signals_name.push_back(s.get_name());
+			for(T& s : signals)
+			{
+				if(configuration_t::instance().get_signal_id(s) == key)
+				{
+					found_signals.push_back(&s);
+				}
+			}
 		}
-	}
-}
-
-std::vector<std::string> find_signals(const openxc_DynamicField &key);
+	};
+}
\ No newline at end of file