schema_solve.py 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776
  1. from .utilities import (prRed, prGreen, prPurple, prWhite,
  2. prOrange,
  3. wrapRed, wrapGreen, wrapPurple, wrapWhite,
  4. wrapOrange,)
  5. from .utilities import init_connections, init_dependencies, get_link_in_out
  6. from .base_definitions import (SchemaUINode, custom_props_types, \
  7. MantisNodeGroup, SchemaGroup, replace_types, GraphError)
  8. from .node_container_common import setup_custom_props_from_np
  9. # a class that solves Schema nodes
  10. from bpy.types import NodeGroupInput, NodeGroupOutput
  11. from .readtree import execution_error_cleanup
  12. class SchemaSolver:
  13. def __init__(self, schema_dummy, nodes, prototype, signature=None, error_popups=False):
  14. self.all_nodes = nodes # this is the parsed tree from Mantis
  15. self.node = schema_dummy
  16. self.tree = prototype.node_tree
  17. self.uuid = self.node.uuid
  18. self.error_popups = error_popups
  19. if signature:
  20. self.signature = signature
  21. else:
  22. self.signature = self.node.signature
  23. self.schema_nodes={}
  24. self.solved_nodes = {}
  25. self.incoming_connections = {}
  26. self.outgoing_connections = {}
  27. self.constant_in = {}
  28. self.constant_out = {}
  29. self.array_input_connections = {}
  30. self.array_output_connections = {}
  31. self.nested_schemas = {}
  32. self.autogenerated_nodes = {}
  33. self.held_links = []
  34. self.tree_path_names = [*self.node.signature] # same tree as the schema node
  35. self.autogen_path_names = ['SCHEMA_AUTOGENERATED', *self.node.signature[1:]]
  36. self.is_node_group = False
  37. if self.node.prototype.bl_idname == "MantisNodeGroup":
  38. self.is_node_group = True
  39. if self.node.inputs['Schema Length'].links:
  40. self.index_link = self.node.inputs['Schema Length'].links[0]
  41. else:
  42. self.index_link = None
  43. # this should never happen, but it's OK to check.
  44. if self.node.inputs["Schema Length"].is_linked:
  45. if (other := self.node.inputs['Schema Length'].links[0].from_node).prepared == False:
  46. raise RuntimeError(f"Schema Length cannot be determined for {self.node} because {other} is not prepared.")
  47. self.solve_length = self.node.evaluate_input("Schema Length")
  48. # I'm making this a property of the solver because the solver's data is modified as it solves each iteration
  49. self.index = 0
  50. self.init_schema_links()
  51. self.set_index_strings()
  52. # Sort the multi-input nodes in reverse order of ID, this ensures that they are
  53. # read in the order they were created
  54. for inp in self.node.inputs.values():
  55. inp.links.sort(key=lambda a : -a.multi_input_sort_id)
  56. for ui_node in self.tree.nodes:
  57. # first we need to fill the parameters of the schema nodes.
  58. # we use the bl_idname because all schema nodes should be single-instance
  59. signature = (*self.tree_path_names, ui_node.bl_idname)
  60. if isinstance(ui_node, SchemaUINode):
  61. # We use the schema node's "natural signature" here because it represents
  62. # the "original" signature of the schema UI group node since this schema
  63. # solver may be in a nested schema, and its node's signature may have
  64. # uuid/index attached.
  65. get_sig = (*self.node.ui_signature, ui_node.bl_idname)
  66. if not (mantis_node := self.all_nodes.get(get_sig)):
  67. raise RuntimeError(wrapRed(f"Not found: {get_sig}"))
  68. self.schema_nodes[signature] = mantis_node
  69. mantis_node.fill_parameters(ui_node)
  70. # HACK to make Group Nodes work
  71. if ui_node.bl_idname == "NodeGroupInput":
  72. from .schema_containers import SchemaConstInput
  73. mantis_node = SchemaConstInput(signature=signature, base_tree=self.node.base_tree, parent_schema_node=self.node)
  74. self.schema_nodes[signature] = mantis_node
  75. mantis_node.fill_parameters(ui_node)
  76. if ui_node.bl_idname == "NodeGroupOutput":
  77. from .schema_containers import SchemaConstOutput
  78. mantis_node = SchemaConstOutput(signature=signature, base_tree=self.node.base_tree, parent_schema_node=self.node)
  79. self.schema_nodes[signature] = mantis_node
  80. mantis_node.fill_parameters(ui_node)
  81. def set_index_strings(self):
  82. self.index_str = lambda : '.'+str(self.uuid)+'.'+str(self.index).zfill(4)
  83. self.prev_index_str = lambda : '.'+str(self.uuid)+'.'+str(self.index-1).zfill(4)
  84. if self.is_node_group:
  85. self.index_str=lambda : ''
  86. self.prev_index_str=lambda : ''
  87. def init_schema_links(self,):
  88. """ Sort and store the links to/from the Schema group node."""
  89. for item in self.tree.interface.items_tree:
  90. if item.item_type == 'PANEL': continue
  91. parent_name='Constant'
  92. if item.parent.name != '': # in an "prphan" item this is left blank , it is not None or an AttributeError.
  93. parent_name = item.parent.name
  94. match parent_name:
  95. case 'Connection':
  96. if item.in_out == 'INPUT':
  97. if incoming_links := self.node.inputs[item.identifier].links:
  98. self.incoming_connections[item.name] = incoming_links[0]
  99. else:
  100. self.incoming_connections[item.name] = None
  101. else: # OUTPUT
  102. if outgoing_links := self.node.outputs[item.identifier].links:
  103. self.outgoing_connections[item.name] = outgoing_links.copy()
  104. else:
  105. self.outgoing_connections[item.name] = []
  106. case 'Constant':
  107. if item.in_out == 'INPUT':
  108. if constant_in_links := self.node.inputs[item.identifier].links:
  109. self.constant_in[item.name] = constant_in_links[0]
  110. else:
  111. self.constant_in[item.name] = None
  112. else: # OUTPUT
  113. if constant_out_links := self.node.outputs[item.identifier].links:
  114. self.constant_out[item.name] = constant_out_links.copy()
  115. else:
  116. self.constant_out[item.name] = []
  117. case 'Array':
  118. if item.in_out == 'INPUT':
  119. if item.identifier not in self.array_input_connections.keys():
  120. self.array_input_connections[item.identifier]=[]
  121. if in_links := self.node.inputs[item.identifier].links:
  122. self.array_input_connections[item.identifier]=in_links.copy()
  123. # I am tempted to put a check here, but it is sufficient to
  124. # rely on hierarchy links ensuring the arrays are prepared.
  125. # and testing here for un-prepared arrays will mess up schema
  126. # relationships in non-hierarchy situations.
  127. # Still, I'd like to have an easier time catching these problems.
  128. else: # OUTPUT
  129. if item.identifier not in self.array_output_connections.keys():
  130. self.array_output_connections[item.identifier]=[]
  131. if out_links := self.node.outputs[item.identifier].links:
  132. self.array_output_connections[item.identifier] = out_links.copy()
  133. def gen_solve_iteration_mantis_nodes(self, frame_mantis_nodes, unprepared):
  134. for prototype_ui_node in self.tree.nodes:
  135. mantis_node_name = prototype_ui_node.name
  136. index_str = self.index_str()
  137. mContext=self.node.mContext
  138. if isinstance(prototype_ui_node, SchemaUINode):
  139. continue # IGNORE the schema interface nodes, we already made them in __init__()
  140. # they are reused for each iteration.
  141. elif prototype_ui_node.bl_idname in ['NodeFrame', 'NodeReroute']:
  142. continue # IGNORE stuff that is purely UI - frames, reroutes.
  143. elif prototype_ui_node.bl_idname in ['NodeGroupInput', 'NodeGroupOutput']:
  144. continue # we converted these to Schema Nodes because they represent a Group input.
  145. signature = (*self.autogen_path_names, mantis_node_name+index_str)
  146. ui_signature=(*self.signature, mantis_node_name)
  147. prototype_mantis_node = self.all_nodes[ui_signature]
  148. # the prototype_mantis_node was generated inside the schema when we parsed the tree.
  149. # it is the prototype of the mantis node which we make for this iteration
  150. # for Schema sub-nodes ... they need a prototype to init.
  151. if prototype_mantis_node.node_type in ['DUMMY', 'DUMMY_SCHEMA']:
  152. # We stored the prototype ui_node when creating the Mantis node.
  153. ui_node = prototype_mantis_node.prototype
  154. # if prototype_mantis_node is a group or schema: TODO changes are needed elsewhere to make this easier to read. LEGIBILITY
  155. if ui_node.bl_idname in ["MantisNodeGroup", "MantisSchemaGroup"]:
  156. mantis_node = prototype_mantis_node.__class__(
  157. signature, prototype_mantis_node.base_tree, prototype=ui_node,
  158. ui_signature = prototype_mantis_node.signature)
  159. # now let's copy the links from the prototype node
  160. if ui_node.bl_idname in ["MantisNodeGroup"]:
  161. mantis_node.prepared = False
  162. mantis_node.node_type = 'DUMMY_SCHEMA' # we promote it to a schema for now
  163. mantis_node.inputs.init_sockets(['Schema Length']) # add a Schema Length socket
  164. mantis_node.parameters['Schema Length'] = 1 # set the length to 1 since it is a single group instance
  165. # we'll make the autogenerated nodes for constant inputs. It doesn't matter that there is technically
  166. # a prototype available for each one -- these are cheap and I want this to be easy.
  167. from .readtree import make_connections_to_ng_dummy
  168. make_connections_to_ng_dummy(self.node.base_tree, self.autogen_path_names, frame_mantis_nodes, self.all_nodes, mantis_node)
  169. else:
  170. mantis_node = prototype_mantis_node.__class__(signature, prototype_mantis_node.base_tree, prototype=ui_node)
  171. else:
  172. mantis_node = prototype_mantis_node.__class__(signature, prototype_mantis_node.base_tree)
  173. frame_mantis_nodes[mantis_node.signature] = mantis_node
  174. mantis_node.ui_signature=ui_signature # set the natural signature to ensure we can access from the UI
  175. if mantis_node.prepared == False:
  176. unprepared.append(mantis_node)
  177. if mantis_node.__class__.__name__ in custom_props_types:
  178. setup_custom_props_from_np(mantis_node, prototype_ui_node)
  179. mantis_node.fill_parameters(prototype_ui_node)
  180. # be sure to pass on the Mantis Context to them
  181. mantis_node.mContext=mContext
  182. def handle_link_from_index_input(self, index, frame_mantis_nodes, ui_link):
  183. _from_name, to_name = get_link_in_out(ui_link)
  184. to_node = frame_mantis_nodes[ (*self.autogen_path_names, to_name+self.index_str()) ]
  185. if to_node.node_type in ['DUMMY', 'DUMMY_SCHEMA']:
  186. from .utilities import gen_nc_input_for_data
  187. nc_cls = gen_nc_input_for_data(ui_link.from_socket)
  188. if (nc_cls): #HACK
  189. unique_name = "".join([
  190. ui_link.to_socket.node.name+self.index_str(),
  191. ui_link.from_socket.name,
  192. ui_link.from_socket.identifier,
  193. "==>",
  194. ui_link.to_socket.name,
  195. ui_link.to_socket.identifier,
  196. ])
  197. sig = ("MANTIS_AUTOGENERATED", *self.tree_path_names[1:-1], unique_name)
  198. nc_from = frame_mantis_nodes.get(sig)
  199. if not nc_from:
  200. nc_from = nc_cls(sig, self.node.base_tree)
  201. # ugly! maybe even a HACK!
  202. nc_from.inputs = {}
  203. from .base_definitions import NodeSocket
  204. nc_from.outputs = {ui_link.from_socket.name:NodeSocket(name = ui_link.from_socket.name, node=nc_from)}
  205. nc_from.parameters = {ui_link.from_socket.name:index}
  206. frame_mantis_nodes[sig]=nc_from
  207. nc_from.execution_prepared=True
  208. from_node = nc_from
  209. self.solved_nodes[sig]=from_node
  210. _connection = from_node.outputs[ui_link.from_socket.name].connect(node=to_node, socket=ui_link.to_socket.identifier)
  211. return
  212. # Since the index is already determined, it is safe to remove the socket and just keep the value.
  213. to_node.parameters[ui_link.to_socket.name] = index
  214. del to_node.inputs[ui_link.to_socket.name]
  215. def handle_link_from_schema_length_input(self, frame_mantis_nodes, ui_link):
  216. # see, here I can just use the schema node
  217. _from_name, to_name = get_link_in_out(ui_link)
  218. if to_name in replace_types:
  219. to_node = self.schema_nodes[(*self.autogen_path_names, to_name)]
  220. else:
  221. to_node = frame_mantis_nodes[(*self.autogen_path_names, to_name+self.index_str())]
  222. # this self.index_link is only used here?
  223. if self.index_link is None:
  224. # this should be impossible because the Schema gets an auto-generated Int input.
  225. raise NotImplementedError(" 241 This code should be unreachable. Please report this as a bug!")
  226. if (self.index_link.from_node):
  227. connection = self.index_link.from_node.outputs[self.index_link.from_socket].connect(node=to_node, socket=ui_link.to_socket.name)
  228. # otherwise we can autogen an int input I guess...?
  229. else:
  230. raise RuntimeError("247 I This code should be unreachable. Please report this as a bug!")
  231. def handle_link_from_incoming_connection_input(self, frame_mantis_nodes, ui_link):
  232. incoming = self.incoming_connections[ui_link.from_socket.name]
  233. if incoming is not None:
  234. from_node = incoming.from_node
  235. _from_name, to_name = get_link_in_out(ui_link)
  236. to_node = frame_mantis_nodes[ (*self.autogen_path_names, to_name+self.index_str()) ]
  237. socket_name=ui_link.to_socket.name
  238. if to_node.node_type in [ 'DUMMY_SCHEMA' ]:
  239. socket_name=ui_link.to_socket.identifier
  240. connection = from_node.outputs[incoming.from_socket].connect(node=to_node, socket=socket_name)
  241. init_connections(from_node)
  242. def handle_link_to_outgoing_connection_output(self, frame_mantis_nodes, ui_link,):
  243. mantis_incoming_node = self.schema_nodes[*self.tree_path_names, 'SchemaIncomingConnection']
  244. for mantis_link in mantis_incoming_node.outputs[ui_link.to_socket.name].links:
  245. to_mantis_node, to_mantis_socket = mantis_link.to_node, mantis_link.to_socket
  246. from_name = get_link_in_out(ui_link)[0]
  247. from_mantis_node = self.solved_nodes[ (*self.autogen_path_names, from_name+self.prev_index_str()) ]
  248. to_mantis_node = frame_mantis_nodes[ (*self.autogen_path_names, to_mantis_node.signature[-1]+self.index_str()) ]
  249. from_socket_name = ui_link.from_socket.name
  250. if from_mantis_node.node_type in ['DUMMY_SCHEMA']:
  251. from_socket_name = ui_link.from_socket.identifier
  252. connection = from_mantis_node.outputs[from_socket_name].connect(node=to_mantis_node, socket=to_mantis_socket)
  253. # We want to delete the links from the tree into the schema node.
  254. # TODO: this is not robust enough and I do not feel sure this is doing the right thing.
  255. if existing_link := self.incoming_connections[ui_link.to_socket.name]:
  256. if existing_link.to_node == self.node:
  257. print ("INFO: Deleting...", existing_link)
  258. if self.node.signature[-1] in existing_link.to_node.signature:
  259. existing_link.die()
  260. # BUG may exist here.
  261. self.incoming_connections[ui_link.to_socket.name] = connection
  262. def handle_link_from_constant_input(self, frame_mantis_nodes, ui_link, to_ui_node):
  263. incoming = self.constant_in[ui_link.from_socket.name]
  264. if incoming is None:
  265. raise GraphError (f"{self.node} is missing a required input: {ui_link.from_socket.name}")
  266. from_node = incoming.from_node
  267. to_name = get_link_in_out(ui_link)[1]
  268. to_node = frame_mantis_nodes[(*self.autogen_path_names, to_name+self.index_str())]
  269. to_socket=ui_link.to_socket.name
  270. from .base_definitions import MantisNodeGroup, SchemaGroup
  271. if isinstance(to_ui_node, (SchemaGroup, MantisNodeGroup)):
  272. to_socket=ui_link.to_socket.identifier
  273. connection = from_node.outputs[incoming.from_socket].connect(node=to_node, socket=to_socket)
  274. init_connections(from_node)
  275. def handle_link_from_array_input_get(self, frame_mantis_nodes, ui_link ):
  276. from_ui_node = ui_link.from_socket.node
  277. from_node = self.schema_nodes[(*self.node.ui_signature, from_ui_node.bl_idname)]
  278. from collections import deque
  279. unprepared = deque(from_node.hierarchy_dependencies)
  280. self.prepare_nodes(unprepared)
  281. from .utilities import cap, wrap
  282. get_index = from_node.evaluate_input("Index", self.index) # get the most recent link
  283. # getting the link at self.index just saves the trouble of killing the old links
  284. # that are left because this node is reused in each iteration of the schema
  285. assert(get_index is not None), f"Cannot get index in {from_node}"
  286. oob = from_node.evaluate_input("OoB Behaviour")
  287. if oob == 'WRAP':
  288. get_index = wrap(get_index, len(self.array_input_connections[ui_link.from_socket.identifier]), 0)
  289. if oob == 'HOLD':
  290. get_index = cap(get_index, len(self.array_input_connections[ui_link.from_socket.identifier]))
  291. try:
  292. incoming = self.array_input_connections[ui_link.from_socket.identifier][get_index]
  293. except IndexError:
  294. raise RuntimeError(f"The array index {get_index} is out of bounds. Size: "
  295. f"{len(self.array_input_connections[ui_link.from_socket.identifier])}")
  296. to_name = get_link_in_out(ui_link)[1]
  297. to_node = frame_mantis_nodes[(*self.autogen_path_names, to_name+self.index_str())]
  298. from_socket = incoming.from_node.outputs[incoming.from_socket]
  299. connection = from_socket.connect(to_node, ui_link.to_socket.name)
  300. # TODO: kill links to the array get that are no longer needed
  301. # right now I inefficiently waste cpu-time solving extra nodes
  302. # because I took the lazy way out
  303. def handle_link_to_array_input_get(self, frame_mantis_nodes, ui_link):
  304. from_name, to_name = get_link_in_out(ui_link)
  305. from_nc = frame_mantis_nodes[(*self.autogen_path_names, from_name+self.index_str())]
  306. to_nc = self.schema_nodes[(*self.tree_path_names, to_name)]
  307. # this only needs to be done once:
  308. if self.index == 0: # BUG? HACK? TODO find out what is going on here.
  309. # Kill the link between the schema node group and the node connecting to it
  310. old_nc = self.all_nodes[(*self.tree_path_names, from_name)]
  311. # I am not sure about this!
  312. existing_link = old_nc.outputs[ui_link.from_socket.name].links[0]
  313. existing_link.die()
  314. #
  315. connection = from_nc.outputs[ui_link.from_socket.name].connect(node=to_nc, socket=ui_link.to_socket.name)
  316. connection.is_hierarchy = True # we have to mark this because links to Schema are not usually hierarchy (?)
  317. to_nc.hierarchy_dependencies.append(from_nc); from_nc.hierarchy_connections.append(to_nc)
  318. # TODO: review the wisdom of this default.
  319. def handle_link_from_array_input(self, frame_mantis_nodes, ui_link, index):
  320. get_index = index
  321. try:
  322. incoming = self.array_input_connections[ui_link.from_socket.identifier][get_index]
  323. except IndexError:
  324. if len(self.array_input_connections[ui_link.from_socket.identifier]) > 0:
  325. incoming = self.array_input_connections[ui_link.from_socket.identifier][0]
  326. # prOrange(incoming.from_node.node_type)
  327. if incoming.from_node.node_type not in ['DUMMY_SCHEMA']:
  328. raise NotImplementedError(wrapRed("dev: make it so Mantis checks if there are enough Array inputs."))
  329. else: # do nothing
  330. return
  331. else:
  332. raise RuntimeError(wrapRed("make it so Mantis checks if there are enough Array inputs!"))
  333. to_name = get_link_in_out(ui_link)[1]
  334. to_node = frame_mantis_nodes[(*self.autogen_path_names, to_name+self.index_str())]
  335. connection = incoming.from_node.outputs[incoming.from_socket].connect(node=to_node, socket=ui_link.to_socket.name)
  336. init_connections(incoming.from_node)
  337. def handle_link_from_array_input_all(self, frame_mantis_nodes, ui_link):
  338. all_links = self.array_input_connections[ui_link.from_socket.identifier]
  339. to_name = get_link_in_out(ui_link)[1]
  340. to_node = frame_mantis_nodes[(*self.autogen_path_names, to_name+self.index_str())]
  341. # connection = incoming.from_node.outputs[incoming.from_socket].connect(node=to_node, socket=ui_link.to_socket.name)
  342. for l in all_links:
  343. # we need to copy the link with the new from-node info
  344. from .base_definitions import NodeLink
  345. to_socket_name=ui_link.to_socket.name
  346. if to_node.node_type in ['DUMMY_SCHEMA']:
  347. to_socket_name=ui_link.to_socket.identifier
  348. connection = NodeLink(l.from_node, l.from_socket, to_node, to_socket_name, l.multi_input_sort_id)
  349. to_node.flush_links()
  350. def handle_link_to_constant_output(self, frame_mantis_nodes, index, ui_link, to_ui_node):
  351. to_node = self.schema_nodes[(*self.tree_path_names, to_ui_node.bl_idname)]
  352. expose_when = to_node.evaluate_input('Expose when N==')
  353. from_name = get_link_in_out(ui_link)[0]
  354. from bpy.types import NodeSocket
  355. #use it directly if it is a mantis node; this happens when the previous node was a Schema
  356. if isinstance( ui_link.from_socket, NodeSocket): # normal
  357. from_node = frame_mantis_nodes[(*self.autogen_path_names, from_name+self.index_str()) ]
  358. else: # it's a mantis socket, set manually while looping though prepped links
  359. from_node = ui_link.from_socket.node
  360. from_socket_name = ui_link.from_socket.name
  361. if from_node.node_type == 'DUMMY_SCHEMA':
  362. if isinstance( ui_link.from_socket, NodeSocket): # normal
  363. from_socket_name = ui_link.from_socket.identifier
  364. else:
  365. from_socket_name = ui_link.from_socket.name
  366. # HACK here to force it to work with ordinary node groups, which don't seem to set this value correctly.
  367. if to_ui_node.bl_idname == "NodeGroupOutput":
  368. expose_when = index # just set it directly since it is getting set to None somewhere (I should find out where tho)
  369. # end HACK
  370. if index == expose_when:
  371. for outgoing in self.constant_out[ui_link.to_socket.name]:
  372. to_node = outgoing.to_node
  373. connection = from_node.outputs[from_socket_name].connect(node=to_node, socket=outgoing.to_socket)
  374. def handle_link_from_subschema_to_output(self, frame_mantis_nodes, ui_link, to_ui_node):
  375. # wire the schema node itself to the output so it will push the connections when solving
  376. to_node = self.schema_nodes[(*self.tree_path_names, to_ui_node.bl_idname)]
  377. from_name = get_link_in_out(ui_link)[0]
  378. from_node = frame_mantis_nodes[ (*self.autogen_path_names, from_name+self.index_str()) ]
  379. connection = from_node.outputs[ui_link.from_socket.identifier].connect(node=to_node, socket=ui_link.to_socket.name)
  380. # WTF is even happening here?? TODO BUG HACK
  381. def handle_link_to_array_output(self, frame_mantis_nodes, index, ui_link, to_ui_node, from_ui_node):# if this duplicated code works, dedupe!
  382. to_node = self.schema_nodes[(*self.tree_path_names, to_ui_node.bl_idname)] # get it by [], we want a KeyError if this fails
  383. from_name = get_link_in_out(ui_link)[0]
  384. from bpy.types import NodeSocket
  385. #use it directly if it is a mantis node; this happens when the previous node was a Schema
  386. if isinstance( ui_link.from_socket, NodeSocket): # normal
  387. from_node = frame_mantis_nodes[(*self.autogen_path_names, from_name+self.index_str()) ]
  388. else: # it's a mantis socket, set manually while looping though prepped links
  389. from_node = ui_link.from_socket.node
  390. from_socket_name = ui_link.from_socket.name
  391. for outgoing in self.array_output_connections[ui_link.to_socket.identifier]:
  392. if not from_node:
  393. from_node = self.schema_nodes[(*self.tree_path_names, from_ui_node.bl_idname)]
  394. to_node = outgoing.to_node
  395. from .schema_containers import SchemaIndex
  396. if isinstance(from_node, SchemaIndex): # I think I need to dedup this stuff
  397. # print("INDEX")
  398. from .utilities import gen_nc_input_for_data
  399. nc_cls = gen_nc_input_for_data(ui_link.from_socket)
  400. if (nc_cls): #HACK
  401. sig = ("MANTIS_AUTOGENERATED", *self.tree_path_names[1:-1], self.index_str(), ui_link.from_socket.name, ui_link.from_socket.identifier)
  402. nc_from = nc_cls(sig, self.node.base_tree)
  403. nc_from.execution_prepared=True
  404. # ugly! maybe even a HACK!
  405. nc_from.inputs = {}
  406. from .node_container_common import NodeSocket
  407. nc_from.outputs = {ui_link.from_socket.name:NodeSocket(name = ui_link.from_socket.name, node=nc_from)}
  408. from .node_container_common import get_socket_value
  409. if ui_link.from_socket.name in ['Index']:
  410. nc_from.parameters = {ui_link.from_socket.name:index}
  411. else:
  412. nc_from.parameters = {ui_link.from_socket.name:self.solve_length}
  413. frame_mantis_nodes[sig]=nc_from
  414. from_node = nc_from
  415. self.solved_nodes[sig]=from_node
  416. elif from_node.node_type == 'DUMMY_SCHEMA':
  417. if isinstance( ui_link.from_socket, NodeSocket): # normal
  418. from_socket_name = ui_link.from_socket.identifier
  419. else:
  420. from_socket_name = ui_link.from_socket.name
  421. # I have a feeling that something bad will happen if both of these conditions (above and below) are true
  422. if to_node.node_type == 'DUMMY_SCHEMA' and to_node.prepared:
  423. other_stem = ('SCHEMA_AUTOGENERATED', *to_node.signature[1:])
  424. from .utilities import get_node_prototype
  425. other_schema_np = get_node_prototype(to_node.signature, to_node.base_tree)
  426. other_schema_tree = other_schema_np.node_tree
  427. for n in other_schema_tree.nodes:
  428. if n.bl_idname not in ["SchemaArrayInput", "SchemaArrayInputGet"]:
  429. continue
  430. out = n.outputs[outgoing.to_socket]
  431. for l in out.links:
  432. other_index_str = lambda : '.'+str(to_node.uuid)+'.'+str(index).zfill(4)
  433. # get it by [], we want a KeyError if this fails
  434. try:
  435. out_node = self.all_nodes[(*other_stem, l.to_node.name+other_index_str())]
  436. except KeyError as e:
  437. for n in self.all_nodes:
  438. if len(n) > len(other_stem)+1: break
  439. for elem in other_stem:
  440. if elem not in n: break
  441. else:
  442. print(n)
  443. raise e
  444. connection = from_node.outputs[from_socket_name].connect(node=out_node, socket=l.to_socket.name)
  445. else:
  446. connection = from_node.outputs[from_socket_name].connect(node=to_node, socket=outgoing.to_socket)
  447. def spoof_link_for_subschema_to_output_edge_case(self, ui_link, ):
  448. to_ui_node = ui_link.to_socket.node
  449. # ui_link is the link between the Schema & the output but we have mantis_links
  450. # connected up correctly. between the output and the schema's generated nodes.
  451. # so seek BACK from the output node and grab the from-node that is connected to
  452. # the link. then modify the ui_link to point to that node.
  453. from .base_definitions import DummyLink
  454. if not isinstance(ui_link, DummyLink): # make it a Dummy so i can modify it
  455. ui_link = DummyLink(ui_link.from_socket, ui_link.to_socket,
  456. multi_input_sort_id=ui_link.multi_input_sort_id)
  457. to_node = self.schema_nodes[(*self.node.ui_signature, to_ui_node.bl_idname)]
  458. for inp in to_node.inputs:
  459. if inp.name == ui_link.to_socket.name: # the most recent one is from
  460. l = inp.links[-1]; break # <---- this index of the outer schema
  461. ui_link.from_nc = l.from_node; ui_link.from_socket = l.from_node.outputs[l.from_socket]
  462. return ui_link
  463. def test_is_sub_schema(self, other):
  464. for i in range(len(other.ui_signature)-1): # -1, we don't want to check this node, obviously
  465. if self.node.ui_signature[:i+1]:
  466. return False
  467. return True
  468. def prepare_nodes(self, unprepared):
  469. # At this point, we've already run a pretty exhaustive preperation phase to prep the schema's dependencies
  470. # So we should not need to add any new dependencies unless there is a bug elsewhere.
  471. # and in fact, I could skip this in some cases, and should investigate if profiling reveals a slowdown here.
  472. forbidden=set()
  473. e = None
  474. # forbid some nodes - they aren't necessary to solve the schema & cause problems.
  475. while unprepared:
  476. nc = unprepared.pop()
  477. if nc.node_type == 'DUMMY_SCHEMA' and not self.test_is_sub_schema(nc):
  478. forbidden.add(nc) # do NOT add this as a dependency.
  479. if nc in forbidden: continue # trying to resolve dependencies for.
  480. if sum([dep.prepared for dep in nc.hierarchy_dependencies]) == len(nc.hierarchy_dependencies):
  481. try:
  482. nc.bPrepare()
  483. if nc.node_type == 'DUMMY_SCHEMA':
  484. self.solve_nested_schema(nc)
  485. except Exception as e:
  486. raise execution_error_cleanup(nc, e, show_error = False)
  487. break
  488. if not nc.prepared:
  489. raise RuntimeError( f"{nc} has failed to prepare."
  490. " Please report this as a bug in mantis." )
  491. else: # Keeping this for-loop as a fallback, it should never add dependencies though
  492. can_add_me = True
  493. for dep in nc.hierarchy_dependencies:
  494. if not dep.prepared and dep not in unprepared:
  495. if dep in forbidden:
  496. can_add_me=False
  497. forbidden.add(nc) # forbid the parent, too
  498. continue
  499. prOrange(f"Adding dependency... {dep}")
  500. unprepared.appendleft(dep)
  501. if can_add_me:
  502. unprepared.appendleft(nc) # just rotate them until they are ready.
  503. def solve_iteration(self):
  504. """ Solve an iteration of the schema.
  505. - 1 Create the Mantis Node instances that represent this iteration of the schema
  506. - 2 Connect the links from the entrypoint or previous iteration.
  507. - 3 Connect the constant and array links, and any link between nodes entirely within the tree
  508. - 4 Prepare the nodes that modify data (in case of e.g. array get index or nested schema length input)
  509. - 5 Connect the final prepared nodes
  510. and return the nodes that were created in this schema iteration (frame).
  511. This function also adds to held_links to pass data between iterations.
  512. """
  513. from .schema_definitions import (SchemaIndex,
  514. SchemaArrayInput,
  515. SchemaArrayInputGet,
  516. SchemaArrayInputAll,
  517. SchemaArrayOutput,
  518. SchemaConstInput,
  519. SchemaConstOutput,
  520. SchemaOutgoingConnection,
  521. SchemaIncomingConnection,)
  522. from .utilities import clear_reroutes, link_node_containers
  523. self.set_index_strings()
  524. frame_mantis_nodes = {}
  525. # Later we have to run bPrepare() on these guys, so we make the deque and fill it now.
  526. from collections import deque
  527. unprepared= deque()
  528. self.gen_solve_iteration_mantis_nodes(frame_mantis_nodes, unprepared)
  529. # This is where we handle node connections BETWEEN frames
  530. while(self.held_links):
  531. ui_link = self.held_links.pop()
  532. to_ui_node = ui_link.to_socket.node; from_ui_node = ui_link.from_socket.node
  533. if isinstance(to_ui_node, SchemaOutgoingConnection):
  534. self.handle_link_to_outgoing_connection_output(frame_mantis_nodes, ui_link)
  535. # Get the rerouted links from the graph. We don't really need to do this every iteration.
  536. # TODO: use profiling to determine if this is slow; if so: copy & reuse the data, refactor the pop()'s out.
  537. ui_links = clear_reroutes(list(self.tree.links))
  538. # Now we handle ui_links in the current frame, including those ui_links between Schema nodes and "real" nodes
  539. awaiting_prep_stage = []
  540. array_input_get_link = []
  541. for ui_link in ui_links:
  542. to_ui_node = ui_link.to_socket.node; from_ui_node = ui_link.from_socket.node
  543. if isinstance(from_ui_node, SchemaIndex):
  544. if ui_link.from_socket.name == "Index":
  545. self.handle_link_from_index_input(self.index, frame_mantis_nodes, ui_link)
  546. elif ui_link.from_socket.name == "Schema Length":
  547. self.handle_link_from_schema_length_input(frame_mantis_nodes, ui_link)
  548. continue
  549. if isinstance(from_ui_node, SchemaIncomingConnection):
  550. if ui_link.from_socket.name in self.incoming_connections.keys():
  551. self.handle_link_from_incoming_connection_input(frame_mantis_nodes, ui_link)
  552. continue
  553. if isinstance(from_ui_node, (SchemaConstInput, NodeGroupInput)):
  554. if ui_link.from_socket.name in self.constant_in.keys():
  555. self.handle_link_from_constant_input( frame_mantis_nodes, ui_link, to_ui_node)
  556. continue
  557. if isinstance(to_ui_node, SchemaArrayInputGet):
  558. self.handle_link_to_array_input_get( frame_mantis_nodes, ui_link)
  559. continue
  560. if isinstance(from_ui_node, SchemaArrayInput):
  561. self.handle_link_from_array_input(frame_mantis_nodes, ui_link, self.index)
  562. continue
  563. if isinstance(from_ui_node, SchemaArrayInputAll):
  564. self.handle_link_from_array_input_all(frame_mantis_nodes, ui_link)
  565. continue
  566. # HOLD these links to the next iteration:
  567. if isinstance(to_ui_node, SchemaOutgoingConnection):
  568. if isinstance(from_ui_node, (MantisNodeGroup, SchemaGroup)):
  569. e = NotImplementedError(
  570. "You have connected a Node Group or Schema directly into an Outgoing Connection node"
  571. " inside another Schema. This is not currently supported. Try using a Constant Output" \
  572. f" instead. Affected node: {from_ui_node.name}"
  573. )
  574. e = execution_error_cleanup(self.node, e, show_error=self.error_popups)
  575. raise e # always raise this error because it is not implemented.
  576. self.handle_link_from_subschema_to_output(frame_mantis_nodes, ui_link, to_ui_node)
  577. self.held_links.append(ui_link)
  578. continue
  579. # HOLD these links until prep is done a little later
  580. if isinstance(to_ui_node, (SchemaConstOutput, NodeGroupOutput)) or isinstance(to_ui_node, SchemaArrayOutput):
  581. if isinstance(from_ui_node, (MantisNodeGroup, SchemaGroup)):
  582. self.handle_link_from_subschema_to_output(frame_mantis_nodes, ui_link, to_ui_node)
  583. # both links are desirable to create, so don't continue here
  584. awaiting_prep_stage.append(ui_link)
  585. continue
  586. if isinstance(from_ui_node, SchemaArrayInputGet):
  587. array_input_get_link.append(ui_link)
  588. continue
  589. # for any of the special cases, we hit a 'continue' block. So this connection is not special, and is made here.
  590. connection = link_node_containers(self.autogen_path_names, ui_link,
  591. frame_mantis_nodes, from_suffix=self.index_str(),
  592. to_suffix=self.index_str())
  593. for signature, node in frame_mantis_nodes.items():
  594. self.solved_nodes[signature]=node
  595. if node.node_type == "DUMMY_SCHEMA":
  596. # make sure to add the nodes to the group's sockets if the user set them directly
  597. from .readtree import make_connections_to_ng_dummy
  598. make_connections_to_ng_dummy(
  599. self.node.base_tree,
  600. self.autogen_path_names,
  601. {}, # just pass an empty dict, this argument is not needed in this context
  602. self.all_nodes,
  603. node)
  604. from .utilities import init_schema_dependencies
  605. init_schema_dependencies(node, self.all_nodes)
  606. else:
  607. init_dependencies(node) # it is hard to overstate how important this single line of code is
  608. unprepared=[]
  609. for ui_link in array_input_get_link:
  610. from_name = get_link_in_out(ui_link)[0]
  611. # because this both provides and receives deps, it must be solved first.
  612. from_node = self.schema_nodes.get( (*self.node.ui_signature, ui_link.from_node.bl_idname) )
  613. self.handle_link_from_array_input_get(frame_mantis_nodes, ui_link )
  614. while(awaiting_prep_stage):
  615. ui_link = awaiting_prep_stage.pop()
  616. to_ui_node = ui_link.to_socket.node; from_ui_node = ui_link.from_socket.node
  617. # ugly workaround here in a very painful edge case...
  618. if isinstance(from_ui_node, (MantisNodeGroup, SchemaGroup)):
  619. ui_link=self.spoof_link_for_subschema_to_output_edge_case(ui_link)
  620. from_name = get_link_in_out(ui_link)[0]
  621. signature = (*self.autogen_path_names, from_name+self.index_str())
  622. #use it directly if it is a mantis node; this happens when the previous node was a Schema
  623. if hasattr(ui_link, "from_node") and (from_node := self.schema_nodes.get( (*self.node.ui_signature, ui_link.from_node.bl_idname))):
  624. unprepared = deque(from_node.hierarchy_dependencies)
  625. elif from_node := frame_mantis_nodes.get(signature):
  626. unprepared = deque(from_node.hierarchy_dependencies)
  627. else:
  628. raise RuntimeError(" 671 there has been an error parsing the tree. Please report this as a bug.")
  629. self.prepare_nodes(unprepared) # prepare only the dependencies we need for this link
  630. # and then handle the link by specific type.
  631. if isinstance(from_ui_node, (MantisNodeGroup, SchemaGroup)):
  632. ui_link=self.spoof_link_for_subschema_to_output_edge_case(ui_link)
  633. if isinstance(to_ui_node, (SchemaConstOutput, NodeGroupOutput)):
  634. self.handle_link_to_constant_output(frame_mantis_nodes, self.index, ui_link, to_ui_node)
  635. if isinstance(to_ui_node, SchemaArrayOutput):
  636. self.handle_link_to_array_output(frame_mantis_nodes, self.index, ui_link, to_ui_node, from_ui_node)
  637. return frame_mantis_nodes
  638. def solve_nested_schema(self, schema_nc):
  639. """ Solves all schema node groups found in this Schema. This is a recursive function, which will
  640. solve all levels of nested schema - since this function is called by solver.solve().
  641. """
  642. solver=None
  643. if schema_nc.prepared == False:
  644. all_nodes = self.all_nodes.copy()
  645. ui_node = schema_nc.prototype
  646. length = schema_nc.evaluate_input("Schema Length")
  647. tree = ui_node.node_tree
  648. if schema_nc.prototype.bl_idname == "MantisNodeGroup":
  649. prOrange(f"Expanding Node Group {tree.name} in node {schema_nc}.")
  650. else:
  651. prOrange(f"Expanding schema {tree.name} in node {schema_nc} with length {length}.")
  652. solver = SchemaSolver(schema_nc, all_nodes, ui_node, schema_nc.ui_signature, error_popups=self.error_popups)
  653. solved_nodes = solver.solve()
  654. schema_nc.prepared = True
  655. for k,v in solved_nodes.items():
  656. self.solved_nodes[k]=v
  657. return solver
  658. def finalize(self, frame_nc):
  659. from .schema_definitions import (SchemaOutgoingConnection,)
  660. for i in range(len(self.held_links)):
  661. link = self.held_links.pop()
  662. to_np = link.to_socket.node; from_np = link.from_socket.node
  663. if isinstance(to_np, SchemaOutgoingConnection):
  664. if link.to_socket.name in self.outgoing_connections.keys():
  665. if (outgoing_links := self.outgoing_connections[link.to_socket.name]) is None: continue
  666. for outgoing in outgoing_links:
  667. if outgoing:
  668. to_node = outgoing.to_node
  669. from_node =frame_nc[(*self.autogen_path_names, from_np.name+self.index_str()) ]
  670. from_socket_name = link.from_socket.name
  671. if from_node.node_type in ['DUMMY_SCHEMA']:
  672. from_socket_name = link.from_socket.identifier
  673. connection = from_node.outputs[from_socket_name].connect(node=to_node, socket=outgoing.to_socket)
  674. # we need to kill the link between the Schema itself and the next node and update the deps. Otherwise:confusing bugs.
  675. outgoing.die(); init_dependencies(to_node)
  676. # else: # the node just isn't connected out this socket.
  677. # # solve all unsolved nested schemas...
  678. for schema_sig, schema_nc in self.nested_schemas.items():
  679. self.solve_nested_schema(schema_nc)
  680. for n in self.autogenerated_nodes.values():
  681. init_connections(n)
  682. for c in n.connections:
  683. init_dependencies(c)
  684. all_outgoing_links = []
  685. for conn in self.outgoing_connections.values():
  686. for outgoing in conn:
  687. all_outgoing_links.append(outgoing)
  688. for conn in self.constant_out.values():
  689. for outgoing in conn:
  690. all_outgoing_links.append(outgoing)
  691. for conn in self.array_output_connections.values():
  692. for outgoing in conn:
  693. all_outgoing_links.append(outgoing)
  694. for outgoing in all_outgoing_links:
  695. to_node = outgoing.to_node
  696. for l in to_node.inputs[outgoing.to_socket].links:
  697. if self.node == l.from_node:
  698. l.die()
  699. for inp in self.node.inputs.values():
  700. for l in inp.links:
  701. init_connections(l.from_node) # to force it to have hierarchy connections with the new nodes.
  702. def solve(self):
  703. if self.solve_length < 1:
  704. from .base_definitions import GraphError
  705. for o in self.node.outputs:
  706. if o.is_linked:
  707. raise GraphError(f"ERROR: Schema {self} has a length"
  708. " of 0 but other nodes depend on it.")
  709. print (f"WARN: Schema {self} has a length of 0 or less and will not expand.")
  710. return {} # just don't do anything - it's OK to have a noop schema if it doesn't have dependencies.
  711. for index in range(self.solve_length):
  712. self.index = index
  713. frame_mantis_nodes = self.solve_iteration()
  714. for sig, nc in frame_mantis_nodes.items():
  715. if nc.node_type == 'DUMMY_SCHEMA':
  716. self.nested_schemas[sig] = nc
  717. self.finalize(frame_mantis_nodes)
  718. self.node.solver = self
  719. self.node.prepared = True
  720. return self.solved_nodes