Improved Source File and Code Structure Modelling

Closes #7 (closed) , #4 (closed)

This MR brings a significant refactoring and several extensions to the modelling of source file structure and contents in the SFG IR, as well as to the way these are constructed by the composer internally.

IR

Replace ir.source_components by ir.entities and ir.syntax

• ir.entities defines C++ code entities independently from their place in the output file syntax. It defines namespaces (including kernel namespaces and the global namespace), functions, kernels, classes and their members (methods, constructors). It also places these entities in parent-child-relationsships.
• ir.syntax defines the class SfgSourceFile to represent source files. It also contains the representation of the above entities as syntactic objects: namespace blocks (one namespace can have multiple blocks), entity declaration and definition nodes, class body and visibility block nodes.

Context and Composer

• The context now manages up to two source files (header and implementation)
• The composer navigates their syntax structure using a cursor
• sfg.namespace can now be called multiple times and be used as a context manager to enter and exit nested namespaces
• Remove sfg.define_once since it can no longer reliably check definitions for uniqueness
• The previously fixed structure "first kernel namespaces, then all the rest" of output files is broken up - syntax elements are now placed in the order they are created in

Generator and Emission

• Replace the old file printers and emitters with a minimal, entirely syntax-oriented printer
• Update SourceFileGenerator to prepare the file objects for the context and correctly invoke the printer

Configuration

• Users can now define a sort key for sorting #includes via the SfgConfig - if one is specified, clang-format header sorting will be automatically disabled

src/pystencilssfg/composer/basic_composer.py

@@ -4,6 +4,7 @@ from abc import ABC, abstractmethod
 import numpy as np
 import sympy as sp
 from functools import reduce
+from warnings import warn
 
 from pystencils import Field
 from pystencils.codegen import Kernel
@@ -252,7 +253,13 @@ class SfgBasicComposer(SfgIComposer):
         func = SfgFunction(name, tree)
         self._ctx.add_function(func)
 
-    def function(self, name: str, return_type: UserTypeSpec = void):
+    def function(
+        self,
+        name: str,
+        returns: UserTypeSpec = void,
+        inline: bool = False,
+        return_type: UserTypeSpec | None = None,
+    ):
         """Add a function.
 
         The syntax of this function adder uses a chain of two calls to mimic C++ syntax:
@@ -265,12 +272,23 @@ class SfgBasicComposer(SfgIComposer):
 
         The function body is constructed via sequencing (see `make_sequence`).
         """
+        if return_type is not None:
+            warn(
+                "The parameter `return_type` to `function()` is deprecated and will be removed by version 0.1. "
+                "Setting it will override the value of the `returns` parameter. "
+                "Use `returns` instead.",
+                FutureWarning,
+            )
+            returns = return_type
+
         if self._ctx.get_function(name) is not None:
             raise ValueError(f"Function {name} already exists.")
 
         def sequencer(*args: SequencerArg):
             tree = make_sequence(*args)
-            func = SfgFunction(name, tree, return_type=create_type(return_type))
+            func = SfgFunction(
+                name, tree, return_type=create_type(returns), inline=inline
+            )
             self._ctx.add_function(func)
 
         return sequencer