[ISSUE #111][COMPONENTS] Introduce components architecture in the pro…

…ject

1. [x] Have you followed the guidelines in our [Contributing document](../blob/master/CONTRIBUTING.md)?
2. [x] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
3. [x] Have you built the project, and performed manual testing of your functionality for all supported platforms - Linux and Windows?
4. [x] Is your change backward-compatible with the previous version of the plugin?

>>> Change description:

- Creation of the separate component from the analyzer folder of the project
- Adaptation of the project
- Update of the class diagrams
- Update of README

>>> Verification criteria:

- Manually checked on the Windows platform
- All sanity checks on Git Hub were passed

dltmessageanalyzerplugin/src/CDLTMessageAnalyzer.cpp

@@ -39,7 +39,7 @@
 
 #include "groupedView/CGroupedViewModel.hpp"
 #include "searchView/CSearchResultModel.hpp"
-#include "analyzer/IDLTMessageAnalyzerController.hpp"
+#include "components/analyzer/api/IDLTMessageAnalyzerController.hpp"
 #include "common/CBGColorAnimation.hpp"
 #include "patternsView/CPatternsView.hpp"
 #include "filtersView/CFiltersView.hpp"
@@ -1800,5 +1800,6 @@ PUML_PACKAGE_BEGIN(DMA_Root)
         PUML_COMPOSITION_DEPENDENCY_CHECKED(CRegexDirectoryMonitor, 1, 1, contains)
         PUML_COMPOSITION_DEPENDENCY_CHECKED(CTableMemoryJumper, 1, 1, contains)
         PUML_COMPOSITION_DEPENDENCY_CHECKED(CConsoleInputProcessor, 1, 1, contains)
+        PUML_USE_DEPENDENCY_CHECKED(IDLTMessageAnalyzerController, 1, 1, gets and feeds to IDLTMessageAnalyzerControllerConsumer)
     PUML_CLASS_END()
 PUML_PACKAGE_END()

dltmessageanalyzerplugin/src/CDLTMessageAnalyzer.hpp

@@ -23,7 +23,7 @@
 
 
 #include "common/Definitions.hpp"
-#include "analyzer/IDLTMessageAnalyzerControllerConsumer.hpp"
+#include "components/analyzer/api/IDLTMessageAnalyzerControllerConsumer.hpp"
 
 #include "QElapsedTimer"
 

dltmessageanalyzerplugin/src/CMakeLists.txt

@@ -14,6 +14,19 @@ FetchContent_MakeAvailable(dma_common_deps)
 include(${FETCHCONTENT_BASE_DIR}/dma_common_deps-src/CMakeLists_Helper.txt)
 ################### COMMON_DEPS ( END ) ###################
 
+################### POSITION INDEPENDENT CODE #############
+# as we are building the shared library, all the involved code
+# should be compiled with the -fPIC flags
+set_property(GLOBAL PROPERTY POSITION_INDEPENDENT_CODE ON)
+################### POSITION INDEPENDENT CODE ( END ) #####
+
+################### DEFINES ###############################
+# enables generation of diagrams within DMA_Framework
+add_definitions(-DPUML_ENABLED)
+# enables force link which is used by DMA_Framework in diagrams generation
+add_definitions(-DDMA_FORCE_LINK_ON)
+################### DEFINES ( END ) #######################
+
 ################### DEPENDENCIES ##########################
 DMA_sync_g_test_framework()
 DMA_sync_plantuml()
@@ -63,15 +76,14 @@ add_library(antlr4_PCRE_static STATIC
     ${ANTLR_PCRE_CXX_OUTPUTS}
 )
 
-add_definitions(-DPUML_ENABLED)
-
 set_property(TARGET antlr4_PCRE_static PROPERTY POSITION_INDEPENDENT_CODE ON)
 
 TARGET_LINK_LIBRARIES(antlr4_PCRE_static antlr4_static)
 ################### ANTLR ( END ) #########################
 
 ################### DLT_MESSAGE_ANALYZER ##################
 QT5_WRAP_UI( UI_HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/form.ui )
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
 
 ################### PROJECT ###############################
 enable_testing()
@@ -87,8 +99,8 @@ endif()
 
 include_directories(../../thirdparty/DMA_Plantuml/src)
 
-DMA_add_subdirectory_with_clang_tidy(analyzer)
 DMA_add_subdirectory_with_clang_tidy(common)
+DMA_add_subdirectory_with_clang_tidy(components)
 DMA_add_subdirectory_with_clang_tidy(searchView)
 DMA_add_subdirectory_with_clang_tidy(plant_uml)
 DMA_add_subdirectory_with_clang_tidy(log)
@@ -120,7 +132,8 @@ target_link_libraries(DLT-Message-Analyzer
     DMA_groupedView
     DMA_patternsView
     DMA_PCRE
-    DMA_Plantuml)
+    DMA_Plantuml
+    )
 
 if(TURN_OFF_RCC)
     set(CMAKE_AUTORCC OFF)

dltmessageanalyzerplugin/src/components/CMakeLists.txt

@@ -0,0 +1 @@
+DMA_add_subdirectory_with_clang_tidy(analyzer)

dltmessageanalyzerplugin/src/components/analyzer/CMakeLists.txt

@@ -0,0 +1 @@
+DMA_add_subdirectory_with_clang_tidy(src)

dltmessageanalyzerplugin/src/components/analyzer/api/CAnalyzerComponent.hpp

@@ -0,0 +1,24 @@
+#pragma once
+
+#include "memory"
+
+#include "dma/component/IComponent.hpp"
+
+#include "components/analyzer/api/IDLTMessageAnalyzerController.hpp"
+
+class CAnalyzerComponent : public DMA::IComponent
+{
+public:
+
+    CAnalyzerComponent();
+    std::shared_ptr<IDLTMessageAnalyzerController> getAnalyzerController() const;
+
+    virtual const char* getName() const override;
+
+protected:
+    virtual DMA::tSyncInitOperationResult init() override;
+    virtual DMA::tSyncInitOperationResult shutdown() override;
+
+private:
+    std::shared_ptr<IDLTMessageAnalyzerController> mpMessageAnalyzerController;
+};

dltmessageanalyzerplugin/src/analyzer/IDLTMessageAnalyzerController.hpp → dltmessageanalyzerplugin/src/components/analyzer/api/IDLTMessageAnalyzerController.hpp

@@ -3,12 +3,11 @@
  * @author  vgoncharuk
  * @brief   Declaration of the IDLTMessageAnalyzerController class
  */
-#ifndef IDLTMESSAGEANALYZERCONTROLLER_HPP
-#define IDLTMESSAGEANALYZERCONTROLLER_HPP
+#pragma once
 
 #include <QObject>
 
-#include "../common/Definitions.hpp"
+#include "common/Definitions.hpp"
 
 //Forward declarations
 class IDLTMessageAnalyzerControllerConsumer;
@@ -88,5 +87,3 @@ class IDLTMessageAnalyzerController: public QObject
 };
 
 typedef std::shared_ptr<IDLTMessageAnalyzerController> tDLTMessageAnalyzerControllerPtr;
-
-#endif // IDLTMESSAGEANALYZERCONTROLLER_HPP

dltmessageanalyzerplugin/src/analyzer/IDLTMessageAnalyzerControllerConsumer.hpp → dltmessageanalyzerplugin/src/components/analyzer/api/IDLTMessageAnalyzerControllerConsumer.hpp

@@ -3,12 +3,11 @@
  * @author  vgoncharuk
  * @brief   Declaration of the IDLTMessageAnalyzerControllerConsumer class
  */
-#ifndef IDLTMESSAGEANALYZERCONTROLLERCONSUMER_HPP
-#define IDLTMESSAGEANALYZERCONTROLLERCONSUMER_HPP
+#pragma once
 
 #include <QObject>
 
-#include "../common/Definitions.hpp"
+#include "common/Definitions.hpp"
 
 //Forward declarations
 
@@ -52,4 +51,3 @@ public slots:
 
 typedef std::shared_ptr<IDLTMessageAnalyzerControllerConsumer> tDLTMessageAnalyzerControllerConsumerPtr;
 typedef std::weak_ptr<IDLTMessageAnalyzerControllerConsumer> tDLTMessageAnalyzerControllerConsumerWeakPtr;
-#endif // IDLTMESSAGEANALYZERCONTROLLERCONSUMER_HPP

dltmessageanalyzerplugin/src/components/analyzer/doc/doc.md

@@ -0,0 +1,25 @@
+[**Go to the previous page**](../../../../../md/dev_docs/dev_docs.md)
+
+----
+
+# DMA_Analyzer
+
+## Standalone package API diagram
+
+![Class diagram with dependencies](../../../../../md/dev_docs/puml/DMA_Analyzer_API_standalone.svg)
+
+## Package API diagram with the first-level dependencies
+
+![Class diagram with dependencies](../../../../../md/dev_docs/puml/DMA_Analyzer_API.svg)
+
+## Standalone package diagram
+
+![Class diagram with dependencies](../../../../../md/dev_docs/puml/DMA_Analyzer_standalone.svg)
+
+## Package diagram with the first-level dependencies
+
+![Class diagram with dependencies](../../../../../md/dev_docs/puml/DMA_Analyzer.svg)
+
+----
+
+[**Go to the previous page**](../../../../../md/dev_docs/dev_docs.md)

dltmessageanalyzerplugin/src/components/analyzer/src/CAnalyzerComponent.cpp

@@ -0,0 +1,60 @@
+#include "../api/CAnalyzerComponent.hpp"
+
+#include "CContinuousAnalyzer.hpp"
+#include "CMTAnalyzer.hpp"
+
+#include "DMA_Plantuml.hpp"
+
+#include "dma/base/ForceLink.hpp"
+
+CAnalyzerComponent::CAnalyzerComponent():
+mpMessageAnalyzerController(nullptr)
+{
+    // force linkage references in order to have consistent diagrams
+    DMA_FORCE_LINK_REFERENCE(INamedObject)
+}
+
+const char* CAnalyzerComponent::getName() const
+{
+    return "CAnalyzerComponent";
+}
+
+DMA::tSyncInitOperationResult CAnalyzerComponent::init()
+{
+    DMA::tSyncInitOperationResult result;
+
+    try
+    {
+        auto pMTController = IDLTMessageAnalyzerController::createInstance<CMTAnalyzer>();
+        mpMessageAnalyzerController = IDLTMessageAnalyzerController::createInstance<CContinuousAnalyzer>(pMTController);
+
+        result.bIsOperationSuccessful = true;
+        result.returnCode = 0;
+    }
+    catch (...)
+    {}
+
+    return result;
+}
+
+DMA::tSyncInitOperationResult CAnalyzerComponent::shutdown()
+{
+    DMA::tSyncInitOperationResult result;
+    result.bIsOperationSuccessful = true;
+    result.returnCode = 0;
+    return result;
+}
+
+std::shared_ptr<IDLTMessageAnalyzerController>
+CAnalyzerComponent::getAnalyzerController() const
+{
+    return mpMessageAnalyzerController;
+}
+
+PUML_PACKAGE_BEGIN(DMA_Analyzer)
+    PUML_CLASS_BEGIN(CAnalyzerComponent)
+        PUML_INHERITANCE_CHECKED(DMA::IComponent, implements)
+        PUML_COMPOSITION_DEPENDENCY_CHECKED(CContinuousAnalyzer, 1, 1, contains)
+        PUML_USE_DEPENDENCY_CHECKED(CMTAnalyzer, 1, 1, creates and feeds into CContinuousAnalyzer)
+    PUML_CLASS_END()
+PUML_PACKAGE_END()

dltmessageanalyzerplugin/src/analyzer/CContinuousAnalyzer.cpp → dltmessageanalyzerplugin/src/components/analyzer/src/CContinuousAnalyzer.cpp

@@ -7,12 +7,12 @@
 #include "qdlt.h"
 
 #include "CContinuousAnalyzer.hpp"
-#include "IDLTMessageAnalyzerControllerConsumer.hpp"
+#include "../api/IDLTMessageAnalyzerControllerConsumer.hpp"
 #include "functional"
 #include "QTimer"
 #include "QDebug"
 
-#include "../dltWrappers/CDLTFileWrapper.hpp"
+#include "dltWrappers/CDLTFileWrapper.hpp"
 
 #include "DMA_Plantuml.hpp"
 

dltmessageanalyzerplugin/src/analyzer/CContinuousAnalyzer.hpp → dltmessageanalyzerplugin/src/components/analyzer/src/CContinuousAnalyzer.hpp

@@ -3,11 +3,10 @@
  * @author  vgoncharuk
  * @brief   Declaration of the CContinuousAnalyzer class
  */
-#ifndef CCONTINUOUSANALYZER_HPP
-#define CCONTINUOUSANALYZER_HPP
+#pragma once
 
-#include "IDLTMessageAnalyzerController.hpp"
-#include "IDLTMessageAnalyzerControllerConsumer.hpp"
+#include "../api/IDLTMessageAnalyzerController.hpp"
+#include "../api/IDLTMessageAnalyzerControllerConsumer.hpp"
 #include "functional"
 #include "QRegularExpression"
 
@@ -114,5 +113,3 @@ class CContinuousAnalyzer : public IDLTMessageAnalyzerController
     tSubRequestDataMap mSubRequestDataMap;
     tRequestId mRequestIdCounter;
 };
-
-#endif // CCONTINUOUSANALYZER_HPP

dltmessageanalyzerplugin/src/analyzer/CDLTRegexAnalyzerWorker.cpp → dltmessageanalyzerplugin/src/components/analyzer/src/CDLTRegexAnalyzerWorker.cpp

@@ -8,14 +8,14 @@
 
 #include "QDebug"
 
-#include "../common/Definitions.hpp"
+#include "common/Definitions.hpp"
 
 #ifdef DEBUG_BUILD
 #include "QElapsedTimer"
 #endif
 
-#include "../settings/CSettingsManager.hpp"
-#include "../log/CLog.hpp"
+#include "settings/CSettingsManager.hpp"
+#include "log/CLog.hpp"
 #include "CDLTRegexAnalyzerWorker.hpp"
 
 #include "DMA_Plantuml.hpp"

dltmessageanalyzerplugin/src/analyzer/CDLTRegexAnalyzerWorker.hpp → dltmessageanalyzerplugin/src/components/analyzer/src/CDLTRegexAnalyzerWorker.hpp

@@ -3,17 +3,16 @@
  * @author  vgoncharuk
  * @brief   Declaration of the CDLTRegexAnalyzerWorker class
  */
-#ifndef CDLTREGEXANALYZERWORKER_HPP
-#define CDLTREGEXANALYZERWORKER_HPP
+#pragma once
 
 #include "memory"
 #include "set"
 #include "map"
 
 #include <QRegularExpression>
 
-#include "../common/Definitions.hpp"
-#include "IDLTMessageAnalyzerController.hpp"
+#include "common/Definitions.hpp"
+#include "../api/IDLTMessageAnalyzerController.hpp"
 
 typedef int tWorkerThreadCookie;
 
@@ -49,5 +48,3 @@ public slots:
     tWorkerId mWorkerId;
     QVector<QColor> mColors;
 };
-
-#endif // CDLTREGEXANALYZERWORKER_HPP

dltmessageanalyzerplugin/src/analyzer/CMTAnalyzer.cpp → dltmessageanalyzerplugin/src/components/analyzer/src/CMTAnalyzer.cpp

@@ -13,11 +13,11 @@
 #include "qdlt.h"
 
 #include "CMTAnalyzer.hpp"
-#include "../dltWrappers/CDLTFileWrapper.hpp"
-#include "IDLTMessageAnalyzerControllerConsumer.hpp"
-#include "../dltWrappers/CDLTMsgWrapper.hpp"
-#include "../log/CLog.hpp"
-#include "../common/cpp_extensions.hpp"
+#include "dltWrappers/CDLTFileWrapper.hpp"
+#include "../api/IDLTMessageAnalyzerControllerConsumer.hpp"
+#include "dltWrappers/CDLTMsgWrapper.hpp"
+#include "log/CLog.hpp"
+#include "common/cpp_extensions.hpp"
 
 #include "DMA_Plantuml.hpp"
 

dltmessageanalyzerplugin/src/analyzer/CMTAnalyzer.hpp → dltmessageanalyzerplugin/src/components/analyzer/src/CMTAnalyzer.hpp

@@ -3,16 +3,15 @@
  * @author  vgoncharuk
  * @brief   Declaration of the CMTAnalyzer class
  */
-#ifndef CDLTMESSAGEANALYZERCONTROLLER_HPP
-#define CDLTMESSAGEANALYZERCONTROLLER_HPP
+#pragma once
 
 #include <list>
 
 #include <QRegularExpression>
 
-#include "../common/Definitions.hpp"
+#include "common/Definitions.hpp"
 
-#include "IDLTMessageAnalyzerController.hpp"
+#include "../api/IDLTMessageAnalyzerController.hpp"
 #include "CDLTRegexAnalyzerWorker.hpp"
 
 //Forward declarations
@@ -107,5 +106,3 @@ private slots:
     tRequestMap mRequestMap;
     tRequestId mRequestIdCounter;
 };
-
-#endif // CDLTMESSAGEANALYZERCONTROLLER_HPP