Merge pull request #2 from deckamil/dev

2nd phase delivery into 0.1.0-alpha release milestone

Author: deckamil

MCG/MCG_CC/mcg_cc_component_converter.py

@@ -1,12 +1,12 @@
 #   FILE:           mcg_cc_component_converter.py
 #
 #   DESCRIPTION:
-#       This module contains definition of ComponentConverter class, which is child
-#       class of Converter class and is responsible for conversion of component content
-#       into configuration file.
+#       This module contains definition of ComponentConverter class, which is
+#       responsible for conversion of component content into configuration file
+#       format.
 #
 #   COPYRIGHT:      Copyright (C) 2021-2022 Kamil Deć github.com/deckamil
-#   DATE:           20 FEB 2022
+#   DATE:           21 JUL 2022
 #
 #   LICENSE:
 #       This file is part of Mod Code Generator (MCG).
@@ -33,21 +33,12 @@
 from mcg_cc_logger import Logger
 
 
-# Class:
-# ComponentConverter()
-#
 # Description:
-# This is child class responsible for converting of component content into configuration file.
+# This class allows to convert component content into configuration file format.
 class ComponentConverter(Converter):
 
-    # Method:
-    # convert_action_interaction()
-    #
     # Description:
     # This method is responsible for conversion of action interaction into configuration file.
-    #
-    # Returns:
-    # This method does not return anything.
     def convert_action_interaction(self, sorted_node, math_symbol):
 
         # append interaction comment to configuration file
@@ -69,14 +60,11 @@ def convert_action_interaction(self, sorted_node, math_symbol):
         # append conversion line to configuration file
         self.configuration_file.append(conversion_line)
 
-    # Method:
-    # convert_signal_assignment()
-    #
+        # record info
+        Logger.save_in_log_file("Converter", "Have converted to " + str(conversion_line) + " line", False)
+
     # Description:
     # This method is responsible for conversion of signal assignment into configuration file.
-    #
-    # Returns:
-    # This method does not return anything.
     def convert_signal_assignment(self, sorted_node):
 
         # find output signal name within sorted node
@@ -90,21 +78,15 @@ def convert_signal_assignment(self, sorted_node):
         # append conversion line to configuration file
         self.configuration_file.append(conversion_line)
 
-    # Method:
-    # convert_component()
-    #
+        # record info
+        Logger.save_in_log_file("Converter", "Have converted to " + str(conversion_line) + " line", False)
+
     # Description:
     # This method is responsible for converting of component content into configuration file.
-    #
-    # Returns:
-    # This method does not return anything.
     def convert_component(self):
 
-        # component converter
-        Logger.save_in_log_file(">>>>>>>>>>>>>>>>>>>>>>>>>>>> COMPONENT CONVERTER <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n")
-
-        # convert header
-        Logger.save_in_log_file("*** convert header")
+        # record info
+        Logger.save_in_log_file("Converter", "Converting module source and name into configuration file", True)
 
         # append start marker of new component section to configuration file
         self.configuration_file.append(str("COMPONENT START"))
@@ -115,14 +97,20 @@ def convert_component(self):
         # append component name to configuration file
         self.configuration_file.append(str("COMPONENT NAME ") + str(self.model_element_name))
 
+        # record info
+        Logger.save_in_log_file("Converter", "Have converted to "
+                                + str(self.configuration_file[len(self.configuration_file) - 2]) + " line", False)
+        Logger.save_in_log_file("Converter", "Have converted to "
+                                + str(self.configuration_file[len(self.configuration_file) - 1]) + " line", False)
+
         # convert interface details to configuration file
-        self.convert_interfaces()
+        self.convert_interfaces(str("COMPONENT"))
 
-        # convert body
-        Logger.save_in_log_file("*** convert body")
+        # record info
+        Logger.save_in_log_file("Converter", "Converting module body into configuration file", False)
 
         # append start marker of function body section to configuration file
-        self.configuration_file.append(str("BODY START"))
+        self.configuration_file.append(str("COMPONENT BODY START"))
 
         # repeat for all nodes from sorted node list
         for sorted_node in self.sorted_node_list:
@@ -153,22 +141,14 @@ def convert_component(self):
                 self.convert_signal_assignment(sorted_node)
 
         # append end marker of function body section to configuration file
-        self.configuration_file.append(str("BODY END"))
+        self.configuration_file.append(str("COMPONENT BODY END"))
 
         # append end marker of new component section to configuration file
         self.configuration_file.append(str("COMPONENT END"))
 
+        # record info
+        Logger.save_in_log_file("Converter", "Saving conversion results into configuration file", False)
+
         # save configuration file
         self.save_in_configuration_file()
 
-        # process completed
-        Logger.save_in_log_file("PROCESS COMPLETED")
-
-        # display additional details after component conversion
-        Logger.save_in_log_file("")
-        Logger.save_in_log_file("Configuration File:")
-        for line in self.configuration_file:
-            Logger.save_in_log_file("          " + str(line))
-
-        # end of component converter
-        Logger.save_in_log_file("\n>>>>>>>>>>>>>>>>>>>>>>>> END OF COMPONENT CONVERTER <<<<<<<<<<<<<<<<<<<<<<<<<<<")