Class Namespace

openage/codegen/cpp_testlist.py:11–61

Represents a C++ namespace, which contains other namespaces and functions. gen_prototypes() generates the code for the namespace.

class Namespace:
    """
    Represents a C++ namespace, which contains other namespaces and functions.

    gen_prototypes() generates the code for the namespace.
    """

    def __init__(self):
        self.namespaces = collections.defaultdict(self.__class__)
        self.functions = []

    def add_functionname(self, path):
        """
        Adds a function to the namespace.

        Path is the qualified function "path" (e.g., openage::test::foo)
        has the path ["openage", "test", "foo"].

        Descends recursively, creating subnamespaces as required.
        """
        if len(path) == 1:
            self.functions.append(path[0])
        else:
            subnamespace = self.namespaces[path[0]]
            subnamespace.add_functionname(path[1:])

    def gen_prototypes(self):
        """
        Generates the actual C++ code for this namespace,
        including all sub-namespaces and function prototypes.
        """
        for name in self.functions:
            yield f"void {name}();\n"

        for namespacename, namespace in sorted(self.namespaces.items()):
            yield f"namespace {namespacename} {{\n"
            for line in namespace.gen_prototypes():
                yield line
            yield f"}} // {namespacename}\n\n"

    def get_functionnames(self):
        """
        Yields all function names in this namespace,
        as well as all subnamespaces.
        """
        for name in self.functions:
            yield name

        for namespacename, namespace in sorted(self.namespaces.items()):
            for name in namespace.get_functionnames():
                yield namespacename + "::" + name


def generate_testlist(projectdir):