Support variable declarations in c (pyccel#1847)

This feature pull request adds the appropriate C language equivalent for
declaring `list` and `set` containers in Python, as well as freeing
their memory, with the help of the STC library. This fixes pyccel#1655 and
pyccel#1659.

**Commit Summary**
- Copy STC files to the destination path using
`copy_internal_library()`.
- Change the order of printing the module and the module header in
`codegen` to determine the appropriate STC macros.
- Perform the appropriate class method renaming in `_print_Module()`
instead of `_print_Module_Header()`.
- Determine the right STC container type and construct its macros, as
well as the container variable name (`i_type` macro).
- Generate the deallocation node of a container using the STC method
`container_X_drop(&container_var)`.
- Generate the initialization of an STC container in C using the method
`c_init()`.
- Add tests to check the initialization of `list` and `set` using
different data types.

---------

Co-authored-by: Farouk-Echaref <[email protected]>
Co-authored-by: mustapha-belbiad <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>
Co-authored-by: EmilyBourne <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -19,6 +19,8 @@ All notable changes to this project will be documented in this file.
 -   #1787 : Ensure `STC` is installed with Pyccel.
 -   #1656 : Ensure `gFTL` is installed with Pyccel.
 -   #1844 : Add line numbers and code to errors from built-in function calls.
+-   #1655 : Add the appropriate C language equivalent for declaring a Python `list` container using the `STC` library.
+-   #1659 : Add the appropriate C language equivalent for declaring a Python `set` container using the `STC` library. 
 -   \[INTERNALS\] Added `container_rank` property to `ast.datatypes.PyccelType` objects.
 -   \[DEVELOPER\] Added an improved traceback to the developer-mode errors for errors in function calls.
 -   #1893 : Add Python support for set initialisation with `set()`.

pyccel/ast/datatypes.py

@@ -149,6 +149,16 @@ class PyccelType:
     is expected when calling a bitwise comparison operator on objects of these types.
     """
     __slots__ = ()
+    _name = None
+
+    @property
+    def name(self):
+        """
+        Get the name of the pyccel type.
+        
+        Get the name of the pyccel type.
+        """
+        return self._name
 
     def __init__(self): #pylint: disable=useless-parent-delegation
         # This __init__ function is required so the ArgumentSingleton can
@@ -433,6 +443,12 @@ class GenericType(FixedSizeType):
     def __add__(self, other):
         return other
 
+    def __eq__(self, other):
+        return True
+
+    def __hash__(self):
+        return hash(self.__class__)
+
 class SymbolicType(FixedSizeType):
     """
     Class representing the datatype of a placeholder symbol.
@@ -745,6 +761,13 @@ def __init__(self, element_type):
         self._order = 'C' if (element_type.order == 'C' or element_type.rank == 1) else None
         super().__init__()
 
+    def __eq__(self, other):
+        return isinstance(other, self.__class__) and self._element_type == other._element_type \
+                and self._order == other._order
+
+    def __hash__(self):
+        return hash((self.__class__, self._element_type, self._order))
+
 class HomogeneousSetType(HomogeneousContainerType, metaclass = ArgumentSingleton):
     """
     Class representing the homogeneous set type.
@@ -767,6 +790,12 @@ def __init__(self, element_type):
         self._element_type = element_type
         super().__init__()
 
+    def __eq__(self, other):
+        return isinstance(other, self.__class__) and self._element_type == other._element_type
+
+    def __hash__(self):
+        return hash((self.__class__, self._element_type))
+
 #==============================================================================
 
 class CustomDataType(ContainerType, metaclass=Singleton):

pyccel/ast/utilities.py

@@ -17,7 +17,7 @@
                             Concatenate, Module, PyccelFunctionDef)
 
 from .builtins      import (builtin_functions_dict,
-                            PythonRange, PythonList, PythonTuple)
+                            PythonRange, PythonList, PythonTuple, PythonSet)
 from .cmathext      import cmath_mod
 from .datatypes     import HomogeneousTupleType, PythonNativeInt
 from .internals     import PyccelFunction, Slice
@@ -409,7 +409,7 @@ def collect_loops(block, indices, new_index, language_has_vectors = False, resul
     if result is None:
         result = []
     current_level = 0
-    array_creator_types = (Allocate, PythonList, PythonTuple, Concatenate, Duplicate)
+    array_creator_types = (Allocate, PythonList, PythonTuple, Concatenate, Duplicate, PythonSet)
     is_function_call = lambda f: ((isinstance(f, FunctionCall) and not f.funcdef.is_elemental)
                                 or (isinstance(f, PyccelFunction) and not f.is_elemental and not hasattr(f, '__getitem__')
                                     and not isinstance(f, (NumpyTranspose))))

pyccel/codegen/codegen.py

@@ -216,19 +216,19 @@ def export(self, filename):
         header_filename = f'{filename}.{header_ext}'
         filename = f'{filename}.{ext}'
 
+        # print module
+        code = self._printer.doprint(self.ast)
+        with open(filename, 'w', encoding="utf-8") as f:
+            for line in code:
+                f.write(line)
+
         # print module header
         if header_ext is not None:
             code = self._printer.doprint(ModuleHeader(self.ast))
-            with open(header_filename, 'w') as f:
+            with open(header_filename, 'w', encoding="utf-8") as f:
                 for line in code:
                     f.write(line)
 
-        # print module
-        code = self._printer.doprint(self.ast)
-        with open(filename, 'w') as f:
-            for line in code:
-                f.write(line)
-
         # print program
         prog_filename = None
         if self.is_program and self.language != 'python':

pyccel/codegen/pipeline.py

@@ -21,6 +21,7 @@
 from pyccel.codegen.utilities      import recompile_object
 from pyccel.codegen.utilities      import copy_internal_library
 from pyccel.codegen.utilities      import internal_libs
+from pyccel.codegen.utilities      import external_libs
 from pyccel.codegen.python_wrapper import create_shared_library
 from pyccel.naming                 import name_clash_checkers
 from pyccel.utilities.stage        import PyccelStage
@@ -334,6 +335,14 @@ def handle_error(stage):
 
             mod_obj.add_dependencies(stdlib)
 
+
+    # Iterate over the external_libs list and determine if the printer
+    # requires an external lib to be included.
+    for key in codegen.get_printer_imports():
+        lib_name = key.split("/", 1)[0]
+        if lib_name in external_libs:
+            lib_dest_path = copy_internal_library(lib_name, pyccel_dirpath)
+
     if convert_only:
         # Change working directory back to starting point
         os.chdir(base_dirpath)