mantis/execution/readtree.py

from ..utilities.utilities import prRed, prGreen, prPurple, prWhite, prOrange, \
                        wrapRed, wrapGreen, wrapPurple, wrapWhite, wrapOrange

# FIXME I don't think these signatures are unique.
# TODO this is a really silly and bad and also really dumb way to do this
def insert_lazy_parents(mantis_node):
    from ..link_nodes import LinkInherit
    inherit_node = None
    if mantis_node.inputs["Relationship"].is_connected:
        from ..utilities.node_common import trace_single_line_safe
        # BUG this line can create infinite loops
        node_line, last_socket = trace_single_line_safe(mantis_node, 'Relationship')
        # if last_socket is from a valid XFORM, it is the relationship in
        # because it was traversed from the xForm Out... so get the traverse target.
        if last_socket.traverse_target is None:
            return # this is not a valid lazy parent.
        for other_node in node_line[1:]: # skip the first one, it is the same node
            if other_node.node_type == 'LINK':
                return # this one has a realtionship connection.
            elif other_node.node_type == 'XFORM':
                break
        if other_node.node_type in ["XFORM"] and last_socket.traverse_target.name in ["xForm Out"]:
            for link in other_node.outputs['xForm Out'].links:
                if link.to_node == mantis_node: link.die()
            inherit_node = LinkInherit(("MANTIS_AUTOGENERATED", *mantis_node.signature[1:], "LAZY_INHERIT"), mantis_node.base_tree)
            l = other_node.outputs['xForm Out'].connect(inherit_node, 'Parent')
            l1 = inherit_node.outputs['Inheritance'].connect(mantis_node, 'Relationship')
            inherit_node.parameters = { "Parent":None,
                                      "Inherit Rotation":True,
                                      "Inherit Scale":'FULL',
                                      "Connected":False, }
            # because the from node may have already been done.
            init_connections(other_node); init_dependencies(other_node)
            init_connections(inherit_node); init_dependencies(inherit_node)
    return inherit_node

# *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #
#                                  DATA FROM NODES                                  #
# *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #

from ..base_definitions import replace_types, NodeSocket

def autogen_node(base_tree, ui_socket, signature, mContext):
    mantis_node=None
    from ..internal_nodes import AutoGenNode
    mantis_node = AutoGenNode(signature, base_tree)
    mantis_node.mContext = mContext
    mantis_node.outputs[ui_socket.identifier] = NodeSocket(is_input=False, name=ui_socket.identifier, node=mantis_node)
    mantis_node.parameters[ui_socket.identifier] = None
    mantis_node.ui_signature = None # does not exist in the UI
    return mantis_node


def make_connections_to_ng_dummy(base_tree, tree_path_names, local_mantis_nodes, all_mantis_nodes, to_mantis_node):
    from ..socket_definitions import no_default_value
    for inp in to_mantis_node.ui_node.inputs:
        if inp.bl_idname in no_default_value:
            continue
        from_mantis_node = None
        to_s = inp.identifier
        if not inp.is_linked: # make an autogenerated NC for the inputs of the group node
            # This can be run inside schema. Make it unique with uuid() to be safe.
            from uuid import uuid4
            signature = ("MANTIS_AUTOGENERATED", *tree_path_names, to_mantis_node.ui_signature[-1], inp.identifier, inp.identifier, str(uuid4()))
            from_mantis_node = all_mantis_nodes.get(signature) # creating this without checking and
                                                               #  using UUID signature leads to TERRIBLE CONFUSING BUGS.
            if from_mantis_node is None: 
                from_mantis_node = autogen_node(base_tree, inp, signature, to_mantis_node.mContext)
                local_mantis_nodes[signature]=from_mantis_node
                all_mantis_nodes[signature]=from_mantis_node
            if from_mantis_node: # autogen can fail and we should catch it.
                from_mantis_node.fill_parameters(ui_node=to_mantis_node.ui_node)
                from_mantis_node.outputs[inp.identifier].connect(node=to_mantis_node, socket=to_s, sort_id=0)
            else:
                prRed("No available auto-generated class for input %s in %s" % (inp.name, to_mantis_node.ui_node.name))

def gen_mantis_nodes(base_tree, current_tree, tree_path_names, mContext, all_mantis_nodes, local_mantis_nodes, dummy_nodes, group_nodes, schema_nodes, in_schema ):
    from ..internal_nodes import DummyNode, GroupInterface
    for ui_node in current_tree.nodes:
        mantis_node = None
        if ui_node.bl_idname in ["NodeFrame", "NodeReroute"]:
            continue # not a Mantis Node
        if ui_node.bl_idname in ["NodeGroupInput", "NodeGroupOutput"]:
            # we only want ONE dummy in/out per tree_path, so use the bl_idname to make a Dummy node
            sig = (None, *tree_path_names, ui_node.bl_idname)
            ui_sig = (None, *tree_path_names, ui_node.name)
            if not local_mantis_nodes.get(sig):
                mantis_node = DummyNode( signature=sig , base_tree=base_tree, ui_node=ui_node, ui_signature=ui_sig )
                local_mantis_nodes[sig] = mantis_node; all_mantis_nodes[sig] = mantis_node; dummy_nodes[sig] = mantis_node
                if ui_node.bl_idname in {"NodeGroupOutput"}:
                    # We need an interface node, let's make it now.
                    items_tree = ui_node.id_data.interface.items_tree
                    interface = GroupInterface(
                        # we'll clip the 'NodeGroupOutput' from the signature
                        ( *mantis_node.signature[:-1], "OutputInterface"),
                        mantis_node.base_tree, 'OUTPUT', ui_node=mantis_node.ui_node,
                        items_tree=items_tree,)
                    interface.mContext = mContext
                    all_mantis_nodes[interface.signature] = interface; local_mantis_nodes[interface.signature] = interface
                    mantis_node.reroute_links_type = 'out'
        elif ui_node.bl_idname in  ["MantisNodeGroup", "MantisSchemaGroup"]:
            mantis_node = DummyNode( signature= (sig := (None, *tree_path_names, ui_node.name) ), base_tree=base_tree, ui_node=ui_node )
            mantis_node.mContext = mContext
            local_mantis_nodes[sig] = mantis_node; all_mantis_nodes[sig] = mantis_node; dummy_nodes[sig] = mantis_node
            items_tree = ui_node.node_tree.interface.items_tree
            if ui_node.bl_idname == "MantisNodeGroup":
                mantis_node.reroute_links_type = 'group'
                name = 'InputInterface'
                interface_in_out = 'INPUT'
            else:
                schema_nodes[sig] = mantis_node
                name = 'InputInterface.0000'
                interface_in_out = 'SCHEMA_INPUT'
            # let's make the interface node for this now
            interface = GroupInterface(
                ( *mantis_node.signature, name), mantis_node.base_tree,
                   interface_in_out, mantis_node.ui_node, items_tree=items_tree )
            interface.mContext = mContext
            all_mantis_nodes[interface.signature] = interface; local_mantis_nodes[interface.signature] = interface
            group_nodes.append(mantis_node)
            # This function depends on generating the interface
            make_connections_to_ng_dummy(base_tree, tree_path_names, local_mantis_nodes, all_mantis_nodes, mantis_node)
        # if it wasn't the types we ignore or the types we make a Dummy for, use this to catch all non-special cases.
        elif (mantis_class := ui_node.mantis_class):
            sig = (None, *tree_path_names, ui_node.name)
            if ui_node.bl_idname in replace_types:
                sig = (None, *tree_path_names, ui_node.bl_idname)
                if local_mantis_nodes.get(sig):
                    continue # already made
            mantis_node = mantis_class( sig , base_tree)
            local_mantis_nodes[sig] = mantis_node; all_mantis_nodes[sig] = mantis_node
            mantis_node.ui_signature = (*mantis_node.ui_signature[:-1], ui_node.name) # just to ensure it points to a real node.
        else:
            mantis_node = None
            prRed(f"Can't make mantis_node for.. {ui_node.bl_idname}")
        if mantis_node is not None:
            # this should be done at init
            mantis_node.mContext = mContext
            if mantis_node.signature[0] != 'MANTIS_AUTOGENERATED' and mantis_node.node_type not in {'SCHEMA', 'DUMMY', 'DUMMY_SCHEMA'}:
                mantis_node.fill_parameters(ui_node)
            mantis_node.is_schema_prototype = in_schema

def data_from_tree(base_tree, tree_path, mContext, dummy_nodes, all_mantis_nodes, all_schema, in_schema):#
    # TODO: it should be relatively easy to make this use a while loop instead of recursion.
    local_mantis_nodes, group_nodes = {}, []
    tree_path_names = [tree.name for tree in tree_path if hasattr(tree, "name")]
    if tree_path[-1]:
        
        current_tree = tree_path[-1].node_tree # this may be None.
    else:
        current_tree = base_tree
    #
    if current_tree: # the node-group may not have a tree set - if so, ignore it.
        if not in_schema:
            in_schema = current_tree.bl_idname in ['SchemaTree']
        from ..utilities.utilities import clear_reroutes
        links = clear_reroutes(list(current_tree.links))
        gen_mantis_nodes(base_tree, current_tree, tree_path_names, mContext, all_mantis_nodes, local_mantis_nodes, dummy_nodes, group_nodes, all_schema, in_schema)

        from ..utilities.utilities import link_mantis_nodes
        for link in links:
            link_mantis_nodes((None, *tree_path_names), link, local_mantis_nodes)
        if current_tree == base_tree:
            # in the base tree, we need to auto-gen the default values in a slightly different way to node groups.
            insert_default_values_base_tree(base_tree, all_mantis_nodes)
        # Now, descend into the Node Groups and recurse
        for mantis_node in group_nodes:
            data_from_tree(base_tree, tree_path+[mantis_node.ui_node], mContext, dummy_nodes, all_mantis_nodes, all_schema, in_schema)
    return dummy_nodes, all_mantis_nodes, all_schema

STRING_PADDING = 4
overlay_valid_socket_types = [
    "FloatSocket", "FloatPositiveSocket", "FloatFactorSocket",
    "FloatAngleSocket", "UnsignedIntSocket", "IntSocket", "StringSocket",
]
# Do not use these input names as overlay keys:
forbidden_key_names = ["",]
forbidden_in_key_name = ['$',]
def node_scan_overlays(node, socket_id,):
    from ..misc_nodes import SimpleInputNode
    overlay_data_type = str
    if isinstance(node, SimpleInputNode):
        overlay_data_type = type(node.parameters[list(node.outputs.values())[0].name])
    else:
        match node.inputs[socket_id].socket_type:
            case "IntSocket" | "UnsignedIntSocket":
                overlay_data_type = int
            case "FloatSocket" | "FloatPositiveSocket" | "FloatFactorSocket" | "FloatAngleSocket":
                overlay_data_type = float
    from ..utilities.node_common import GraphError
    interface_nodes = node.mContext.interface_nodes
    from ..utilities.utilities import get_ui_node
    ui_node = get_ui_node(node.ui_signature, node.base_tree)
    # we'll assume that the overlay tag system checked if this is linked.
    # TODO this is probably redundant with the check above this
    # First let's check if it is a simple input node, by checking outputs that are marked "input"
    for socket in ui_node.outputs:
        # weird edge case for simple input nodes with unnamed sockets
        # the socket.identifier is not used by Mantis but it defaults to 'socket'\
        if socket.identifier == socket_id and socket.input == True: break
    else:
        for socket in ui_node.inputs:
            if socket.identifier == socket_id: break
        else:
            raise KeyError(f"Socket not found by ID {socket_id} in node {node.ui_signature}\n"
                        f"Candidates: {[socket.identifier for socket in ui_node.inputs]}")
    
    value = socket.default_value # get the ACTUAL UI value
    if hasattr(socket, 'overlay_text'): # TODO this is all wrong but for now
        value = "$"+socket.overlay_text # I am not implementing the Parser feature
    if not isinstance(value, str): return
    # First step: get the interface nodes and the overlay keys
    # this should only check interfaces that are ancestors of this node
    my_interfaces = []
    for index in range(len(node.signature)-1):
        if index == 0: continue # root
        # we add one here because the node inside the schema references the schema's interface...
        current_schema_interface_index = node.generated_at_schema_index[index+1]
        if current_schema_interface_index < 0: # this indicates that it is not in a schema
            interface = interface_nodes.get(
                interface_signature := (*node.signature[:index+1], "InputInterface"))
        else: # First we get the interface that enters the schema (index 0)
            interface = interface_nodes.get(
                interface_signature := (*node.signature[:index+1],
                "InputInterface."+str( 0 ).zfill(4)))
            if interface not in my_interfaces: my_interfaces.append(interface)
            if current_schema_interface_index == 0: continue # just did it
            # we need to get the schema of the current index
            interface = interface_nodes.get(
                interface_signature := (*node.signature[:index+1],
                "InputInterface."+str(current_schema_interface_index).zfill(4)))
        my_interfaces.append( interface )
    # the my_interfaces list is sorted in REVERSE order of importance
    # Next, get all the overlay providers.
    name_to_id_map = {}
    name_to_type_map = {} # Just for printing reasonable error messages
    overlay_keys = set()
    root_overlay_values = {}
    # First, we'll get the base tree's default inputs
    for interface_item in node.mContext.base_tree.interface.items_tree:
        if interface_item.item_type != "SOCKET": continue
        if interface_item.in_out != "INPUT": continue
        # NOTE this will need to change if overlays extend to other data types
        if hasattr(interface_item, "default_string"):
            # NOTE that there may be duplicate names. Too bad!
            root_overlay_values[interface_item.name] = interface_item.default_string
        elif hasattr(interface_item, "default_int"):
            root_overlay_values[interface_item.name] = str(interface_item.default_int).zfill(STRING_PADDING)
        elif hasattr(interface_item, "default_float"):
            root_overlay_values[interface_item.name] = str(interface_item.default_float).zfill(STRING_PADDING)
        overlay_keys.add(interface_item.name)
        name_to_id_map[interface_item.name] = None # don't worry about it
        name_to_type_map[interface_item.name] = interface_item.bl_socket_idname
    # BUG? should this be my_interfaces ? why bother with interfaces this may not be a part of?
    for interface_node in interface_nodes.values():
        # problem: the interface node stores socket identifiers as keys
        # so in reality we need to get the group UI node and ask for its input names
        # if there is a duplicate name, too bad!
        group_ui_node = get_ui_node(interface_node.ui_signature[:-1], node.base_tree)
        for interface_item in group_ui_node.node_tree.interface.items_tree:
            if interface_item.item_type != 'SOCKET': continue
            if interface_item.in_out != 'INPUT': continue
            if interface_item.name in forbidden_key_names: continue
            for substr in forbidden_in_key_name:
                if substr in interface_item.name:
                    break
            else: # if we do not find a bad substr
                name_to_id_map[interface_item.name]=interface_item.identifier
                name_to_type_map[interface_item.name] = interface_item.bl_socket_idname
                overlay_keys.add(interface_item.name)
        # For schema interfaces, we also need to get the length and index.
        if 'Index' in interface.outputs:
            overlay_keys.add('Index'); overlay_keys.add('Length')
    if 'Index' in overlay_keys:
        name_to_id_map['Index']='Index'
        name_to_type_map['Index']= "IntSocket"
        name_to_id_map['Length']='Length'
        name_to_type_map['Length']= "IntSocket"
    # sort by reverse length so we find "CatsAndFrogs" before "Cats"
    overlay_keys = sorted(overlay_keys, key= lambda a :-1*len(a))
    # First I need to break it into substrings based on quotation marks
    from ..utilities.utilities import split_quoted_substrings_to_strings
    quoted_substrings = split_quoted_substrings_to_strings(value)
    overlay_tries = []
    for quoted_substring in  quoted_substrings:
        overlay_tries.extend(quoted_substring.split("$"))
    if overlay_data_type == str:
        result = overlay_tries[0] # the 0th element is always before the split character
    else: # TODO HACK later use the parser feature
        result = 0
    # the reason for the difference between overlay_try and key is because
    #  we don't actually know if the $text part has a key in it
    for overlay_try in overlay_tries[1:]:
        if not overlay_try: continue # some of these are empty
        overlay_resolved_value = "$" + overlay_try
        for key in overlay_keys:
            if key in overlay_try:
                overlay_resolved_value = "$" + key
                for interface in reversed(my_interfaces): # since this is reversed when we build it
                    actual_key = name_to_id_map.get(key)
                    socket = interface.inputs.get(actual_key)
                    if key in ['Index', 'Length']:
                        socket = interface.outputs.get(actual_key)
                    if socket:
                        overlay_value = None
                        try:
                            overlay_value = interface.evaluate_input(actual_key)
                        except KeyError:
                            if (socket_type := name_to_type_map.get(key) or 'NOT FOUND') in overlay_valid_socket_types:
                                raise GraphError(f"Error: Variable {key} is not supported because it has "
                                                 f"an invalid input in the node group: {interface.signature[:-1]}.")
                            raise GraphError( f"Error: Variable {key} is not supported because it is "
                                              f"type {socket_type}" )
                            # NOTE that the above can also be caused by any BUG occuring in node group update
                            # because it causes the interface to be invalid for the UI node that spawns the interface node.
                        if overlay_data_type == str:
                            if isinstance(overlay_value, (float, int)):
                                overlay_value = str(overlay_value).zfill(STRING_PADDING)
                            assert (isinstance(overlay_value, str)), f"Error: Variable {key} is not supported because it is type {type(overlay_value)}"
                            overlay_resolved_value = overlay_try.replace(key, overlay_value)
                        else:
                            overlay_resolved_value = overlay_value
                        break
                else: # we'll try the base tree
                    if base_tree_result := root_overlay_values.get(overlay_try):
                        overlay_resolved_value = base_tree_result
                    else:
                        prOrange(f"WARN: no overlay value applied for {node.ui_signature} for key {key}")
                break # we found the key and are done here. One found Key per overlay-try
        result += overlay_resolved_value
    # Simple Input sockets with unnamed sockets assign this ID automatically
    # But Mantis uses the name instead. Usually the name and ID are the same.
    if socket_id == 'socket' and ui_node.outputs[0].name == "":
        socket_id = ''
    node.parameters[socket_id] = result
    return result # because sometimes I need to get the result, too

from ..utilities.utilities import check_and_add_root, init_connections, init_dependencies, init_schema_dependencies
def solve_schema_to_tree(mantis_node, all_mantis_nodes, roots=[], error_popups=False):
    from ..utilities.utilities import get_ui_node
    np = get_ui_node(mantis_node.signature, mantis_node.base_tree)
    from .schema_solve import SchemaSolver
    solver = SchemaSolver(mantis_node, all_mantis_nodes.copy(), np, error_popups=error_popups)
    try:
        solved_nodes = solver.solve()
    except Exception as e:
    #     # the schema will run the error cleanup code, we just need to raise or not
        solved_nodes = {}
        mantis_node.base_tree.hash_recursive=''
        raise execution_error_cleanup(mantis_node, e, show_error=error_popups)
    for k,v in solved_nodes.items():
        all_mantis_nodes[k]=v
        init_connections(v)
        check_and_add_root(v, roots, include_non_hierarchy=True)

    return solved_nodes

# *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #
#                                  PARSE NODE TREE                                  #
# *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #

schema_bl_idnames = [   "SchemaIndex",
                        "SchemaArrayInput",
                        "SchemaArrayInputGet",
                        "SchemaArrayInputAll",
                        "SchemaArrayOutput",
                        "SchemaConstInput",
                        "SchemaConstOutput",
                        "SchemaOutgoingConnection",
                        "SchemaIncomingConnection",
                    ]

from ..utilities.utilities import get_all_dependencies, read_schema_type
def get_schema_length_dependencies(node, all_nodes={}):
    """ Get a list of all dependencies for the given node's length or array properties.
        This function will also recursively search for dependencies in its sub-trees.
    """
    deps = []
    prepare_links_to = ['Schema Length', 'Array', 'Index']
    def extend_dependencies_from_inputs(node):
        for inp in node.inputs.values():
            for l in inp.links:
                if not l.from_node in node.hierarchy_dependencies:
                    continue
                if "MANTIS_AUTOGENERATED" in l.from_node.signature:
                    deps.extend([l.from_node]) # why we need this lol
                if inp.name in prepare_links_to:
                    deps.append(l.from_node)
                    deps.extend(get_all_dependencies(l.from_node))
                # we also always need to prepare these inputs because they create links.
                # HACK below until I can be less stupid and solve this the right way
                if l.from_node.__class__.__name__ in 'UtilityMatricesFromCurve':
                    deps.append(l.from_node)
                    deps.extend(get_all_dependencies(l.from_node))
    def deps_filter(dep): # remove any nodes inside the schema
        if len(dep.signature) > len(node.signature):
            for i in range(len(node.signature)):
                dep_sig_elem, node_sig_elem = dep.signature[i], node.signature[i]
                if dep_sig_elem != node_sig_elem: break # they don't match, it isn't an inner-node
            else: # remove this, it didn't break, meaning it shares signature with outer node
                return False # this is an inner-node
        return True
    # this way we can handle Schema and Array Get nodes with one function
    extend_dependencies_from_inputs(node)
    if node.node_type == 'DUMMY_SCHEMA':
        trees = [(node.ui_node.node_tree, node.signature)] # this is UI data
        while trees:
            tree, tree_signature = trees.pop()
            for sub_ui_node in tree.nodes:
                if sub_ui_node.bl_idname in ['NodeReroute', 'NodeFrame']:
                    continue
                if sub_ui_node.bl_idname in schema_bl_idnames:
                    sub_node = all_nodes[(*tree_signature, sub_ui_node.bl_idname)]
                else:
                    sub_node = all_nodes[(*tree_signature, sub_ui_node.name)]
                if sub_node.node_type == 'DUMMY_SCHEMA':
                    extend_dependencies_from_inputs(sub_node)
                    trees.append((sub_node.ui_node.node_tree, sub_node.signature))
    return list(filter(deps_filter, deps))

def insert_default_values_base_tree(base_tree, all_mantis_nodes):
    # we can get this by name because group inputs are gathered to the bl_idname
    InputNode = all_mantis_nodes.get((None, 'NodeGroupInput'))
    if InputNode is None: return # nothing to do here.
    ui_node = InputNode.ui_node

    for i, output in enumerate(InputNode.outputs):
        ui_output = ui_node.outputs[i] # I need this for the error messages to make sense
        assert ui_output.identifier == output.name, "Cannot find UI Socket for Default Value"
        for interface_item in base_tree.interface.items_tree:
            if interface_item.item_type == 'PANEL': continue
            if interface_item.identifier == output.name: break
        else:
            raise RuntimeError(f"Default value {ui_output.name} does not exist in {base_tree.name} ")
        if interface_item.item_type == "PANEL":
            raise RuntimeError(f"Cannot get default value for {ui_output.name} in {base_tree.name} ")
        default_value = None
        from bpy.types import bpy_prop_array
        from mathutils import Vector
        val_type = None
        if hasattr(ui_output, 'default_value'):
            val_type = type(ui_output.default_value) # why tf can't I match/case here?
        if val_type is bool: default_value = interface_item.default_bool
        elif val_type is int: default_value = interface_item.default_int
        elif val_type is float: default_value = interface_item.default_float
        elif val_type is Vector: default_value = interface_item.default_vector
        elif val_type is str: default_value = interface_item.default_string
        elif val_type is bpy_prop_array: default_value = interface_item.default_bool_vector
        elif interface_item.bl_socket_idname == "xFormSocket":
            if interface_item.default_xForm == 'ARMATURE':
                default_value = 'MANTIS_DEFAULT_ARMATURE'
            else:
                raise RuntimeError(f"No xForm connected for {ui_output.name} in {base_tree.name}.")

        else:
            raise RuntimeError(f"Cannot get default value for {ui_output.name} in {base_tree.name} ")
        output_name = output.name
        if interface_item.bl_socket_idname not in ['xFormSocket']:
            signature = ("MANTIS_AUTOGENERATED", f"Default Value {output.name}",)
            autogen_mantis_node = all_mantis_nodes.get(signature)
            if autogen_mantis_node is None:
                autogen_mantis_node = autogen_node(base_tree, output, signature, InputNode.mContext)
                autogen_mantis_node.parameters[output_name]=default_value
        elif interface_item.bl_socket_idname == 'xFormSocket' \
                                        and default_value == 'MANTIS_DEFAULT_ARMATURE':
            signature = ("MANTIS_AUTOGENERATED", "MANTIS_DEFAULT_ARMATURE",)
            autogen_mantis_node = all_mantis_nodes.get(signature)
            if autogen_mantis_node is None:
                from ..xForm_nodes import xFormArmature
                autogen_mantis_node = xFormArmature(signature, base_tree)
                autogen_mantis_node.parameters['Name']=base_tree.name+'_MANTIS_AUTOGEN'
                autogen_mantis_node.mContext =  InputNode.mContext
                from mathutils import Matrix
                autogen_mantis_node.parameters['Matrix'] = Matrix.Identity(4)
            output_name = 'xForm Out'
        while output.links:
            l = output.links.pop()
            to_node = l.to_node; to_socket = l.to_socket
            l.die()
            autogen_mantis_node.outputs[output_name].connect(to_node, to_socket)
            init_connections(l.from_node); init_dependencies(l.from_node)
        all_mantis_nodes[autogen_mantis_node.signature]=autogen_mantis_node

def parse_tree(base_tree, error_popups=False):
    from uuid import uuid4
    base_tree.execution_id = uuid4().__str__() # set the unique id of this execution

    from ..base_definitions import MantisExecutionContext
    from ..utilities.node_common import GraphError
    mContext = MantisExecutionContext(base_tree=base_tree)

    import time
    data_start_time = time.time()
    # annoyingly I have to pass in values for all of the dicts because if I initialize them in the function call
    #  then they stick around because the function definition inits them once and keeps a reference
    # so instead I have to supply them to avoid ugly code or bugs elsewhere
    # it's REALLY confusing when you run into this sort of problem. So it warrants four entire lines of comments!      
    try:
        dummy_nodes, all_mantis_nodes, all_schema =  data_from_tree(
            base_tree,
            tree_path = [None], 
            mContext=mContext,
            dummy_nodes = {},
            all_mantis_nodes = {},
            all_schema={},
            in_schema=False
            )
    except GraphError as e:
        base_tree.tree_valid = False; base_tree.hash_recursive=""
        if error_popups:
            from bpy import context
            def error_popup_draw(self, context):
                error_popup_draw_inner(self.layout, e, ())
            context.window_manager.popup_menu(error_popup_draw, title="Error", icon='ERROR')
        else: raise e
        return # it is not possible to parse the tree until GraphErrors are resolved.
    for dummy in dummy_nodes.values():    # reroute the links in the group nodes
        dummy.reroute_links(all_mantis_nodes)
    prGreen(f"Pulling data from tree took {time.time() - data_start_time} seconds")

    start_time = time.time()
    solve_only_these = []; solve_only_these.extend(list(all_schema.values()))
    roots, array_nodes = [], []
    from collections import deque
    unsolved_schema = deque()

    from ..base_definitions import array_output_types, GraphError
    for mantis_node in all_mantis_nodes.values():
        # TODO I still need to assign mContext here because of autogen_node
        # so I have to do a deeper refactor to ensure autogen nodes get this at creation time.
        mantis_node.mContext = mContext
        if mantis_node.node_type in ["DUMMY"]: # clean up the groups
            if mantis_node.ui_node.bl_idname in ("MantisNodeGroup", "NodeGroupOutput"):
                continue
        # Initialize the dependencies and connections (from/to links) for each node.
        # we record & store it because using a getter is much slower (according to profiling)
        init_dependencies(mantis_node); init_connections(mantis_node)
        check_and_add_root(mantis_node, roots, include_non_hierarchy=True)
        # Array nodes need a little special treatment, they're quasi-schemas
        if mantis_node.__class__.__name__ in array_output_types:
            solve_only_these.append(mantis_node)
            array_nodes.append(mantis_node)
        if mantis_node.node_type == 'INTERFACE':
            mContext.interface_nodes[mantis_node.signature] = mantis_node

    from itertools import chain
    for schema in chain(all_schema.values(), array_nodes):
        # We must remove the schema/array nodes that are inside a schema tree.
        for i in range(len(schema.signature)-1): # -1, we don't want to check this node, obviously
            if parent := all_schema.get(schema.signature[:i+1]):
                # This will be solved along with its parent schema.
                solve_only_these.remove(schema)
                break
    for schema in all_schema.values():
            if schema not in solve_only_these: continue
            init_schema_dependencies(schema, all_mantis_nodes)
            solve_only_these.extend(get_schema_length_dependencies(schema, all_mantis_nodes))
            unsolved_schema.append(schema)
    for array in array_nodes:
        if array not in solve_only_these: continue
        solve_only_these.extend(get_schema_length_dependencies(array))
    solve_only_these.extend(array_nodes)
    schema_solve_done = set()

    solve_only_these = set(solve_only_these)


    overlay_tagged_nodes = {}
    for node_signature, socket_id in mContext.tagged_for_overlay:
        if overlay_tagged_nodes.get(node_signature):
            overlay_tagged_nodes[node_signature].append(socket_id)
        else:
            overlay_tagged_nodes[node_signature] = [socket_id]
    def check_and_apply_overlay(n):
        if overlays_for_this_node := overlay_tagged_nodes.get(n.signature):
            for socket_id in overlays_for_this_node:
                node_scan_overlays(n, socket_id,)

    solve_layer = unsolved_schema.copy(); solve_layer.extend(roots)
    while(solve_layer):
        n = solve_layer.pop()
        if n not in solve_only_these:
            continue

        if n.signature in all_schema.keys():
            prOrange(n)
            for dep in n.hierarchy_dependencies:
                if dep not in schema_solve_done and (dep in solve_only_these):
                    if dep.prepared:
                        continue
                    solve_layer.appendleft(n)
                    break
            else:
                try:
                    solved_nodes = solve_schema_to_tree(n, all_mantis_nodes, roots, error_popups=error_popups)
                except Exception as e:
                    e = execution_error_cleanup(n, e, show_error=error_popups)
                    solved_nodes = {}
                    if error_popups == False:
                        raise e
                    return # it is not possible to parse the tree.
                unsolved_schema.remove(n)
                schema_solve_done.add(n)
                for node in solved_nodes.values():
                    init_dependencies(node); init_connections(node)
                    solve_layer.appendleft(node)
                    schema_solve_done.add(node) # CRITICAL to prevent freezes.
                for conn in n.hierarchy_connections:
                    if conn not in schema_solve_done and conn not in solve_layer:
                        solve_layer.appendleft(conn)
            continue
        else:
            for dep in n.hierarchy_dependencies:
                if dep not in schema_solve_done:
                    break
            else:
                check_and_apply_overlay(n)
                try:
                    n.bPrepare()
                except Exception as e:
                    e = execution_error_cleanup(n, e, show_error=error_popups)
                    if error_popups == False:
                        raise e
                schema_solve_done.add(n)
                for conn in n.hierarchy_connections:
                    if conn not in schema_solve_done and conn not in solve_layer:
                        solve_layer.appendleft(conn)
                continue
    if unsolved_schema:
        raise RuntimeError("Failed to resolve all schema declarations")
    # I had a problem with this looping forever. I think it is resolved... but I don't know lol

    all_mantis_nodes = list(all_mantis_nodes.values())
    kept_mantis_node = {}
    while (all_mantis_nodes):
        mantis_node = all_mantis_nodes.pop()
        if mantis_node.node_type in ["DUMMY", 'SCHEMA', 'DUMMY_SCHEMA']:
            continue # screen out the ui_node schema nodes, group in/out, and group placeholders
        # cleanup autogen nodes
        if mantis_node.signature[0] == "MANTIS_AUTOGENERATED" and len(mantis_node.inputs) == 0 and len(mantis_node.outputs) == 1:
            from ..base_definitions import can_remove_socket_for_autogen
            output=list(mantis_node.outputs.values())[0]
            value=list(mantis_node.parameters.values())[0]
            # We can remove this node if it is safe to push it into the other node's socket.
            keep_me = False
            for l in output.links:
                to_node = l.to_node; to_socket = l.to_socket
                # do not remove the socket if it is a custom property.
                if not can_remove_socket_for_autogen(to_node, to_socket):
                    keep_me = True; continue
                l.die()
                to_node.parameters[to_socket] = value
                del to_node.inputs[to_socket]
                init_dependencies(to_node) # to remove the autogen node we no longer need.
            if not keep_me:
                continue
            init_connections(mantis_node) # because we have removed many connections.

        if (mantis_node.node_type in ['XFORM']) and ("Relationship" in mantis_node.inputs.keys()):
            from ..utilities.node_common import GraphError
            try:
                if (new_mantis_node := insert_lazy_parents(mantis_node)):
                    kept_mantis_node[new_mantis_node.signature]=new_mantis_node
                    # be sure to add the Mantis context.
                    new_mantis_node.mContext =mContext
            except GraphError as e:
                e = execution_error_cleanup(mantis_node, e, show_error=error_popups)
                if error_popups == False:
                    raise e
                return  # it is not possible to parse the tree.
        kept_mantis_node[mantis_node.signature]=mantis_node
    prWhite(f"Parsing tree took {time.time()-start_time} seconds.")
    prWhite("Number of Nodes: %s" % (len(kept_mantis_node)))
    return kept_mantis_node

from ..utilities.utilities import switch_mode
def error_popup_draw_inner(layout, exception, ui_sig = ()):
    node_string = f"See node: {ui_sig[1:]}." if ui_sig else ""
    message = f"Error: {exception}\n" + node_string  
    lines = message.splitlines()
    for line in lines:
        layout.label(text=line)

def execution_error_cleanup(node, exception, switch_objects = [], show_error=False ):
    from bpy import  context
    ui_sig = None
    if show_error: # show a popup and select the relevant nodes
        if node:
            if node.mContext:
                if node.mContext.execution_failed==True:
                    # already have an error, pass it to avoid printing
                    return # a second error (it's confusing to users.)
                node.mContext.execution_failed=True
            ui_sig = node.ui_signature
            # TODO: see about zooming-to-node.
            base_tree = node.base_tree
            tree = base_tree
            try:
                for name in ui_sig[1:]:
                    for n in tree.nodes: n.select = False
                    n = tree.nodes[name]
                    n.select = True
                    tree.nodes.active = n
                    if hasattr(n, "node_tree"):
                        tree = n.node_tree
            except AttributeError: # not being run in node graph
                pass
            finally:
                def error_popup_draw(self, context):
                    error_popup_draw_inner(self.layout, exception, ui_sig)
                context.window_manager.popup_menu(error_popup_draw, title="Error", icon='ERROR')
    switch_mode(mode='OBJECT', objects=switch_objects)
    for ob in switch_objects:
        ob.data.pose_position = 'POSE'
    prRed(f"Error: {exception} in node {ui_sig}")
    return exception

def print_cycle(nodes):
    ret_str = ""
    for node in nodes:
        ret_str+= node.__repr__() + '\n'
    return ret_str

def sort_execution(nodes, error_popups):
    from ..utilities.node_common import GraphError
    from collections import deque
    xForm_pass = deque()
    execution_failed = False
    sorted_nodes = []
    # initialize the hierarchy dependency count. We'll use this to ensure there
    # are no cycles (using Kahn's algorithm).
    expected_sort_quantity = len(nodes)
    for mantis_node in nodes.values():
        if mantis_node.node_type in ['DUMMY', 'DUMMY_SCHEMA', 'INTERFACE']:
            expected_sort_quantity -=1 ; continue
        if mantis_node.is_schema_prototype:
            expected_sort_quantity -= 1; continue
        mantis_node.unmet_hierarchy_dependency_count = len(mantis_node.hierarchy_dependencies)
        if mantis_node.unmet_hierarchy_dependency_count == 0 :
            xForm_pass.append(mantis_node)
    
    processed_count = 0
    while(xForm_pass):
        n = xForm_pass.popleft()
        # if n.execution_prepared: continue
        n.execution_prepared = True
        sorted_nodes.append(n)
        processed_count+=1
        for child in n.hierarchy_connections:
            child.unmet_hierarchy_dependency_count-= 1
            if child.unmet_hierarchy_dependency_count == 0:
                xForm_pass.append(child)
    if processed_count < expected_sort_quantity:
        cycle = []
        for n in nodes.values():
            if n.execution_prepared == False:
                cycle.append(n)
        execution_failed = True
        e = GraphError("Detected a cycle in the tree, containing at "
                         "least one of the following nodes: " + print_cycle(cycle))
        e = execution_error_cleanup(cycle[-1], e, show_error=error_popups)
        prRed(processed_count, expected_sort_quantity)
        raise e
    return sorted_nodes, execution_failed

def execute_tree(nodes, base_tree, context, error_popups = False, profile=False):
    assert nodes is not None, "Failed to parse tree."
    assert len(nodes) > 0, "No parsed nodes for execution."\
                           " Mantis probably failed to parse the tree."
    from bpy.types import Object as bpy_object
    from time import time
    original_active = context.view_layer.objects.active
    start_execution_time = time()
    mContext = None
    for mantis_node in nodes.values():
        if not mContext: # just grab one of these. this is a silly way to do this.
            mContext = mantis_node.mContext
            mContext.b_objects = {} # clear the objects and recreate them
        mantis_node.reset_execution()
    mContext.execution_failed = False

    interface_nodes = {}
    from ..internal_nodes import GroupInterface
    for node in nodes.values():
        if isinstance(node, GroupInterface):
            interface_nodes[node.signature] = node
    overlay_tagged_nodes = {}
    for node_signature, socket_id in mContext.tagged_for_overlay:
        if overlay_tagged_nodes.get(node_signature):
            overlay_tagged_nodes[node_signature].append(socket_id)
        else:
            overlay_tagged_nodes[node_signature] = [socket_id]
    def check_and_apply_overlay(n):
        if overlays_for_this_node := overlay_tagged_nodes.get(n.signature):
            for socket_id in overlays_for_this_node:
                node_scan_overlays(n, socket_id,)

    select_me, switch_me = [], [] # switch the mode on these objects
    active = None # only need it for switching modes
    select_me = []
    profiler = None
    if profile:
        from ..dev_helpers.profile_nodes import NodeProfiler
        profiler = NodeProfiler()
        profiler.new_session(mContext.execution_id)
        sort_key = 'total'
    try:
        sorted_nodes, execution_failed = sort_execution(nodes, error_popups=error_popups)
    except Exception as e:
        # We'll fire the popup in sort_execution because it has the node in scope
        if error_popups == False:
            raise e
        execution_failed = True
    try:
        for n in sorted_nodes:
            if execution_failed: break
            try:
                check_and_apply_overlay(n)
                if not n.prepared and 'bPrepare' in n.passes:
                    if profiler: profiler.record(n, "bPrepare", context)
                    else: n.bPrepare(context)
                if not n.executed and 'bTransform' in n.passes:
                    if profiler: profiler.record(n, "bTransformPass", context)
                    else: n.bTransformPass(context)
                if (n.__class__.__name__ == "xFormArmature" ):
                    ob = n.bGetObject()
                    switch_me.append(ob)
                    active = ob
                if not (n.__class__.__name__ == "xFormBone" ) and hasattr(n, "bGetObject"):
                    ob = n.bGetObject()
                    if isinstance(ob, bpy_object):
                        select_me.append(ob)
            except Exception as e:
                e = execution_error_cleanup(n, e, show_error=error_popups)
                if error_popups == False:
                    raise e
                execution_failed = True; break

        switch_mode(mode='POSE', objects=switch_me)

        for n in sorted_nodes:
            try:
                check_and_apply_overlay(n)
                if not n.prepared and 'bPrepare' in n.passes:
                    if profiler: profiler.record(n, "bPrepare", context)
                    else: n.bPrepare(context)
                if not n.executed and 'bRelationship' in n.passes:
                    if profiler: profiler.record(n, "bRelationshipPass", context)
                    else: n.bRelationshipPass(context)
            except Exception as e:
                e = execution_error_cleanup(n, e, show_error=error_popups)
                if error_popups == False:
                    raise e
                execution_failed = True; break

        switch_mode(mode='OBJECT', objects=switch_me)
        # switch to pose mode here so that the nodes can use the final pose data
        # this will require them to update the depsgraph.

        for ob in switch_me:
            ob.data.pose_position = 'POSE'

        for n in sorted_nodes:
            if 'bFinalize' in n.passes:
                try:
                    if profiler: profiler.record(n, "bFinalize", context)
                    else: n.bFinalize(context)
                except Exception as e:
                    e = execution_error_cleanup(n, e, show_error=error_popups)
                    if error_popups == False:
                        raise e
                    execution_failed = True; break

        # REST pose for deformer bind, so everything is in the rest position
        for ob in switch_me:
            ob.data.pose_position = 'REST'

        # finally, apply modifiers and bind stuff
        for n in sorted_nodes:
            if 'bModifierApply' in n.passes:
                try:
                    if profiler: profiler.record(n, "bModifierApply", context)
                    else: n.bModifierApply(context)
                except Exception as e:
                    e = execution_error_cleanup(n, e, show_error=error_popups)
                    if error_popups == False:
                        raise e
                    execution_failed = True; break

        for ob in switch_me:
            ob.data.pose_position = 'POSE'

        tot_time = (time() - start_execution_time)
        if not execution_failed:
            prGreen(f"Executed tree of {len(sorted_nodes)} nodes in {tot_time} seconds")
        if profiler:
            from ..dev_helpers.profile_nodes import summarize_profile
            summarize_profile(profiler._current, pass_name='bPrepare', sort_key = sort_key)
            summarize_profile(profiler._current, pass_name='bTransformPass', sort_key = sort_key)
            summarize_profile(profiler._current, pass_name='bRelationshipPass', sort_key = sort_key)
            summarize_profile(profiler._current, pass_name='bFinalize', sort_key = sort_key)
            summarize_profile(profiler._current, pass_name='bModifierApply', sort_key = sort_key)
        if (original_active):
            context.view_layer.objects.active = original_active
            original_active.select_set(True)
    except Exception as e:
        e = execution_error_cleanup(None, e, switch_me, show_error=error_popups)
        if error_popups == False:
            raise e
        prRed(f"Failed to execute tree.")
    finally:
        context.view_layer.objects.active = active
        # clear the selection first.
        from itertools import chain
        for ob in context.selected_objects:
            try:
                ob.select_set(False)
            except RuntimeError: # it isn't in the view layer
                pass
        for ob in chain(select_me, mContext.b_objects.values()):
            try:
                ob.select_set(True)
            except RuntimeError: # it isn't in the view layer
                pass