Function _generate_cpp_plugin_list

scripts/configure_plugins.py:186–214

Generate the PluginList.cpp source file. Args: plugin_list_full_path (str): Full path to PluginList.cpp where it shall be created. plugin_list (list): List of all plugin names.

(plugin_list_full_path, plugin_list)

        file_desc.write("];\n")

def _generate_cpp_plugin_list(plugin_list_full_path, plugin_list):
    """Generate the PluginList.cpp source file.

    Args:
        plugin_list_full_path (str): Full path to PluginList.cpp where it shall be created.
        plugin_list (list): List of all plugin names.
    """
    includes = ""
    list_entries = ""

    for idx, plugin_name in enumerate(plugin_list):
        if 0 < idx:
            includes += "\n"
            list_entries += ",\n"

        includes += f"#include <{plugin_name}.h>"
        list_entries += f"    {{ \"{plugin_name}\", {plugin_name}::create }}"

    data = {
        "INCLUDES": includes,
        "LIST_ENTRIES": list_entries
    }

    with open(_PLUGIN_LIST_TEMPLATE_FULL_PATH, "r", encoding="utf-8") as file_desc:
        src = Template(file_desc.read())
        result = src.substitute(data)

    with open(plugin_list_full_path, "w", encoding="utf-8") as file_desc:
        file_desc.write(result)

def configure_plugins(plugin_list, layout):
    """Handle all plugin related artifacts.