Workbench: API Changes
[blender.git] / source / blender / blenkernel / intern / node.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Bob Holcomb.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/node.c
29  *  \ingroup bke
30  */
31
32 #include "MEM_guardedalloc.h"
33
34 #include <stdlib.h>
35 #include <stddef.h>
36 #include <string.h>
37 #include <limits.h>
38
39 #include "DNA_action_types.h"
40 #include "DNA_anim_types.h"
41 #include "DNA_lamp_types.h"
42 #include "DNA_material_types.h"
43 #include "DNA_node_types.h"
44 #include "DNA_scene_types.h"
45 #include "DNA_texture_types.h"
46 #include "DNA_world_types.h"
47 #include "DNA_linestyle_types.h"
48
49 #include "BLI_listbase.h"
50 #include "BLI_math.h"
51 #include "BLI_path_util.h"
52 #include "BLI_string.h"
53 #include "BLI_string_utils.h"
54 #include "BLI_utildefines.h"
55
56 #include "BLT_translation.h"
57
58 #include "BKE_animsys.h"
59 #include "BKE_global.h"
60 #include "BKE_idprop.h"
61 #include "BKE_library.h"
62 #include "BKE_library_query.h"
63 #include "BKE_library_remap.h"
64 #include "BKE_main.h"
65 #include "BKE_node.h"
66
67 #include "BLI_ghash.h"
68 #include "BLI_threads.h"
69 #include "RNA_access.h"
70 #include "RNA_define.h"
71
72 #include "NOD_socket.h"
73 #include "NOD_common.h"
74 #include "NOD_composite.h"
75 #include "NOD_shader.h"
76 #include "NOD_texture.h"
77
78 #include "DEG_depsgraph.h"
79
80 #define NODE_DEFAULT_MAX_WIDTH 700
81
82 /* Fallback types for undefined tree, nodes, sockets */
83 bNodeTreeType NodeTreeTypeUndefined;
84 bNodeType NodeTypeUndefined;
85 bNodeSocketType NodeSocketTypeUndefined;
86
87
88 static void node_add_sockets_from_type(bNodeTree *ntree, bNode *node, bNodeType *ntype)
89 {
90         bNodeSocketTemplate *sockdef;
91         /* bNodeSocket *sock; */ /* UNUSED */
92
93         if (ntype->inputs) {
94                 sockdef = ntype->inputs;
95                 while (sockdef->type != -1) {
96                         /* sock = */ node_add_socket_from_template(ntree, node, sockdef, SOCK_IN);
97                         
98                         sockdef++;
99                 }
100         }
101         if (ntype->outputs) {
102                 sockdef = ntype->outputs;
103                 while (sockdef->type != -1) {
104                         /* sock = */ node_add_socket_from_template(ntree, node, sockdef, SOCK_OUT);
105                         
106                         sockdef++;
107                 }
108         }
109 }
110
111 /* Note: This function is called to initialize node data based on the type.
112  * The bNodeType may not be registered at creation time of the node,
113  * so this can be delayed until the node type gets registered.
114  */
115 static void node_init(const struct bContext *C, bNodeTree *ntree, bNode *node)
116 {
117         bNodeType *ntype = node->typeinfo;
118         if (ntype == &NodeTypeUndefined)
119                 return;
120         
121         /* only do this once */
122         if (node->flag & NODE_INIT)
123                 return;
124         
125         node->flag = NODE_SELECT | NODE_OPTIONS | ntype->flag;
126         node->width = ntype->width;
127         node->miniwidth = 42.0f;
128         node->height = ntype->height;
129         node->color[0] = node->color[1] = node->color[2] = 0.608;   /* default theme color */
130         /* initialize the node name with the node label.
131          * note: do this after the initfunc so nodes get their data set which may be used in naming
132          * (node groups for example) */
133         /* XXX Do not use nodeLabel() here, it returns translated content for UI, which should *only* be used
134          *     in UI, *never* in data... Data have their own translation option!
135          *     This solution may be a bit rougher than nodeLabel()'s returned string, but it's simpler
136          *     than adding "do_translate" flags to this func (and labelfunc() as well). */
137         BLI_strncpy(node->name, DATA_(ntype->ui_name), NODE_MAXSTR);
138         nodeUniqueName(ntree, node);
139         
140         node_add_sockets_from_type(ntree, node, ntype);
141
142         if (ntype->initfunc != NULL)
143                 ntype->initfunc(ntree, node);
144
145         if (ntree->typeinfo->node_add_init != NULL)
146                 ntree->typeinfo->node_add_init(ntree, node);
147
148         /* extra init callback */
149         if (ntype->initfunc_api) {
150                 PointerRNA ptr;
151                 RNA_pointer_create((ID *)ntree, &RNA_Node, node, &ptr);
152                 
153                 /* XXX Warning: context can be NULL in case nodes are added in do_versions.
154                  * Delayed init is not supported for nodes with context-based initfunc_api atm.
155                  */
156                 BLI_assert(C != NULL);
157                 ntype->initfunc_api(C, &ptr);
158         }
159         
160         if (node->id)
161                 id_us_plus(node->id);
162         
163         node->flag |= NODE_INIT;
164 }
165
166 static void ntree_set_typeinfo(bNodeTree *ntree, bNodeTreeType *typeinfo)
167 {
168         if (typeinfo) {
169                 ntree->typeinfo = typeinfo;
170                 
171                 /* deprecated integer type */
172                 ntree->type = typeinfo->type;
173         }
174         else {
175                 ntree->typeinfo = &NodeTreeTypeUndefined;
176                 
177                 ntree->init &= ~NTREE_TYPE_INIT;
178         }
179 }
180
181 static void node_set_typeinfo(const struct bContext *C, bNodeTree *ntree, bNode *node, bNodeType *typeinfo)
182 {
183         /* for nodes saved in older versions storage can get lost, make undefined then */
184         if (node->flag & NODE_INIT) {
185                 if (typeinfo && typeinfo->storagename[0] && !node->storage)
186                         typeinfo = NULL;
187         }
188         
189         if (typeinfo) {
190                 node->typeinfo = typeinfo;
191                 
192                 /* deprecated integer type */
193                 node->type = typeinfo->type;
194                 
195                 /* initialize the node if necessary */
196                 node_init(C, ntree, node);
197         }
198         else {
199                 node->typeinfo = &NodeTypeUndefined;
200                 
201                 ntree->init &= ~NTREE_TYPE_INIT;
202         }
203 }
204
205 static void node_socket_set_typeinfo(bNodeTree *ntree, bNodeSocket *sock, bNodeSocketType *typeinfo)
206 {
207         if (typeinfo) {
208                 sock->typeinfo = typeinfo;
209                 
210                 /* deprecated integer type */
211                 sock->type = typeinfo->type;
212                 
213                 if (sock->default_value == NULL) {
214                         /* initialize the default_value pointer used by standard socket types */
215                         node_socket_init_default_value(sock);
216                 }
217         }
218         else {
219                 sock->typeinfo = &NodeSocketTypeUndefined;
220                 
221                 ntree->init &= ~NTREE_TYPE_INIT;
222         }
223 }
224
225 /* Set specific typeinfo pointers in all node trees on register/unregister */
226 static void update_typeinfo(Main *bmain, const struct bContext *C, bNodeTreeType *treetype, bNodeType *nodetype, bNodeSocketType *socktype, bool unregister)
227 {
228         if (!bmain)
229                 return;
230         
231         FOREACH_NODETREE(bmain, ntree, id) {
232                 bNode *node;
233                 bNodeSocket *sock;
234                 
235                 ntree->init |= NTREE_TYPE_INIT;
236                 
237                 if (treetype && STREQ(ntree->idname, treetype->idname))
238                         ntree_set_typeinfo(ntree, unregister ? NULL : treetype);
239                 
240                 /* initialize nodes */
241                 for (node = ntree->nodes.first; node; node = node->next) {
242                         if (nodetype && STREQ(node->idname, nodetype->idname))
243                                 node_set_typeinfo(C, ntree, node, unregister ? NULL : nodetype);
244                         
245                         /* initialize node sockets */
246                         for (sock = node->inputs.first; sock; sock = sock->next)
247                                 if (socktype && STREQ(sock->idname, socktype->idname))
248                                         node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
249                         for (sock = node->outputs.first; sock; sock = sock->next)
250                                 if (socktype && STREQ(sock->idname, socktype->idname))
251                                         node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
252                 }
253                 
254                 /* initialize tree sockets */
255                 for (sock = ntree->inputs.first; sock; sock = sock->next)
256                         if (socktype && STREQ(sock->idname, socktype->idname))
257                                 node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
258                 for (sock = ntree->outputs.first; sock; sock = sock->next)
259                         if (socktype && STREQ(sock->idname, socktype->idname))
260                                 node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
261         }
262         FOREACH_NODETREE_END
263 }
264
265 /* Try to initialize all typeinfo in a node tree.
266  * NB: In general undefined typeinfo is a perfectly valid case, the type may just be registered later.
267  * In that case the update_typeinfo function will set typeinfo on registration
268  * and do necessary updates.
269  */
270 void ntreeSetTypes(const struct bContext *C, bNodeTree *ntree)
271 {
272         bNode *node;
273         bNodeSocket *sock;
274         
275         ntree->init |= NTREE_TYPE_INIT;
276         
277         ntree_set_typeinfo(ntree, ntreeTypeFind(ntree->idname));
278         
279         for (node = ntree->nodes.first; node; node = node->next) {
280                 node_set_typeinfo(C, ntree, node, nodeTypeFind(node->idname));
281                 
282                 for (sock = node->inputs.first; sock; sock = sock->next)
283                         node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
284                 for (sock = node->outputs.first; sock; sock = sock->next)
285                         node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
286         }
287         
288         for (sock = ntree->inputs.first; sock; sock = sock->next)
289                 node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
290         for (sock = ntree->outputs.first; sock; sock = sock->next)
291                 node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
292 }
293
294
295 static GHash *nodetreetypes_hash = NULL;
296 static GHash *nodetypes_hash = NULL;
297 static GHash *nodesockettypes_hash = NULL;
298 static SpinLock spin;
299
300 bNodeTreeType *ntreeTypeFind(const char *idname)
301 {
302         bNodeTreeType *nt;
303
304         if (idname[0]) {
305                 nt = BLI_ghash_lookup(nodetreetypes_hash, idname);
306                 if (nt)
307                         return nt;
308         }
309
310         return NULL;
311 }
312
313 void ntreeTypeAdd(bNodeTreeType *nt)
314 {
315         BLI_ghash_insert(nodetreetypes_hash, nt->idname, nt);
316         /* XXX pass Main to register function? */
317         update_typeinfo(G.main, NULL, nt, NULL, NULL, false);
318 }
319
320 /* callback for hash value free function */
321 static void ntree_free_type(void *treetype_v)
322 {
323         bNodeTreeType *treetype = treetype_v;
324         /* XXX pass Main to unregister function? */
325         update_typeinfo(G.main, NULL, treetype, NULL, NULL, true);
326         MEM_freeN(treetype);
327 }
328
329 void ntreeTypeFreeLink(const bNodeTreeType *nt)
330 {
331         BLI_ghash_remove(nodetreetypes_hash, nt->idname, NULL, ntree_free_type);
332 }
333
334 bool ntreeIsRegistered(bNodeTree *ntree)
335 {
336         return (ntree->typeinfo != &NodeTreeTypeUndefined);
337 }
338
339 GHashIterator *ntreeTypeGetIterator(void)
340 {
341         return BLI_ghashIterator_new(nodetreetypes_hash);
342 }
343
344 bNodeType *nodeTypeFind(const char *idname)
345 {
346         bNodeType *nt;
347
348         if (idname[0]) {
349                 nt = BLI_ghash_lookup(nodetypes_hash, idname);
350                 if (nt)
351                         return nt;
352         }
353
354         return NULL;
355 }
356
357 static void free_dynamic_typeinfo(bNodeType *ntype)
358 {
359         if (ntype->type == NODE_DYNAMIC) {
360                 if (ntype->inputs) {
361                         MEM_freeN(ntype->inputs);
362                 }
363                 if (ntype->outputs) {
364                         MEM_freeN(ntype->outputs);
365                 }
366         }
367 }
368
369 /* callback for hash value free function */
370 static void node_free_type(void *nodetype_v)
371 {
372         bNodeType *nodetype = nodetype_v;
373         /* XXX pass Main to unregister function? */
374         update_typeinfo(G.main, NULL, NULL, nodetype, NULL, true);
375         
376         /* XXX deprecated */
377         if (nodetype->type == NODE_DYNAMIC)
378                 free_dynamic_typeinfo(nodetype);
379         
380         if (nodetype->needs_free)
381                 MEM_freeN(nodetype);
382 }
383
384 void nodeRegisterType(bNodeType *nt)
385 {
386         /* debug only: basic verification of registered types */
387         BLI_assert(nt->idname[0] != '\0');
388         BLI_assert(nt->poll != NULL);
389         
390         BLI_ghash_insert(nodetypes_hash, nt->idname, nt);
391         /* XXX pass Main to register function? */
392         update_typeinfo(G.main, NULL, NULL, nt, NULL, false);
393 }
394
395 void nodeUnregisterType(bNodeType *nt)
396 {
397         BLI_ghash_remove(nodetypes_hash, nt->idname, NULL, node_free_type);
398 }
399
400 bool nodeIsRegistered(bNode *node)
401 {
402         return (node->typeinfo != &NodeTypeUndefined);
403 }
404
405 GHashIterator *nodeTypeGetIterator(void)
406 {
407         return BLI_ghashIterator_new(nodetypes_hash);
408 }
409
410 bNodeSocketType *nodeSocketTypeFind(const char *idname)
411 {
412         bNodeSocketType *st;
413
414         if (idname[0]) {
415                 st = BLI_ghash_lookup(nodesockettypes_hash, idname);
416                 if (st)
417                         return st;
418         }
419
420         return NULL;
421 }
422
423 /* callback for hash value free function */
424 static void node_free_socket_type(void *socktype_v)
425 {
426         bNodeSocketType *socktype = socktype_v;
427         /* XXX pass Main to unregister function? */
428         update_typeinfo(G.main, NULL, NULL, NULL, socktype, true);
429         
430         MEM_freeN(socktype);
431 }
432
433 void nodeRegisterSocketType(bNodeSocketType *st)
434 {
435         BLI_ghash_insert(nodesockettypes_hash, (void *)st->idname, st);
436         /* XXX pass Main to register function? */
437         update_typeinfo(G.main, NULL, NULL, NULL, st, false);
438 }
439
440 void nodeUnregisterSocketType(bNodeSocketType *st)
441 {
442         BLI_ghash_remove(nodesockettypes_hash, st->idname, NULL, node_free_socket_type);
443 }
444
445 bool nodeSocketIsRegistered(bNodeSocket *sock)
446 {
447         return (sock->typeinfo != &NodeSocketTypeUndefined);
448 }
449
450 GHashIterator *nodeSocketTypeGetIterator(void)
451 {
452         return BLI_ghashIterator_new(nodesockettypes_hash);
453 }
454
455 struct bNodeSocket *nodeFindSocket(bNode *node, int in_out, const char *identifier)
456 {
457         bNodeSocket *sock = (in_out == SOCK_IN ? node->inputs.first : node->outputs.first);
458         for (; sock; sock = sock->next) {
459                 if (STREQ(sock->identifier, identifier))
460                         return sock;
461         }
462         return NULL;
463 }
464
465 /* find unique socket identifier */
466 static bool unique_identifier_check(void *arg, const char *identifier)
467 {
468         struct ListBase *lb = arg;
469         bNodeSocket *sock;
470         for (sock = lb->first; sock; sock = sock->next) {
471                 if (STREQ(sock->identifier, identifier))
472                         return true;
473         }
474         return false;
475 }
476
477 static bNodeSocket *make_socket(bNodeTree *ntree, bNode *UNUSED(node), int in_out, ListBase *lb,
478                                 const char *idname, const char *identifier, const char *name)
479 {
480         bNodeSocket *sock;
481         char auto_identifier[MAX_NAME];
482         
483         if (identifier && identifier[0] != '\0') {
484                 /* use explicit identifier */
485                 BLI_strncpy(auto_identifier, identifier, sizeof(auto_identifier));
486         }
487         else {
488                 /* if no explicit identifier is given, assign a unique identifier based on the name */
489                 BLI_strncpy(auto_identifier, name, sizeof(auto_identifier));
490         }
491         /* make the identifier unique */
492         BLI_uniquename_cb(unique_identifier_check, lb, "socket", '.', auto_identifier, sizeof(auto_identifier));
493         
494         sock = MEM_callocN(sizeof(bNodeSocket), "sock");
495         sock->in_out = in_out;
496         
497         BLI_strncpy(sock->identifier, auto_identifier, NODE_MAXSTR);
498         sock->limit = (in_out == SOCK_IN ? 1 : 0xFFF);
499         
500         BLI_strncpy(sock->name, name, NODE_MAXSTR);
501         sock->storage = NULL;
502         sock->flag |= SOCK_COLLAPSED;
503         sock->type = SOCK_CUSTOM;       /* int type undefined by default */
504         
505         BLI_strncpy(sock->idname, idname, sizeof(sock->idname));
506         node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(idname));
507         
508         return sock;
509 }
510
511 void nodeModifySocketType(bNodeTree *ntree, bNode *UNUSED(node), bNodeSocket *sock,
512                           int type, int subtype)
513 {
514         const char *idname = nodeStaticSocketType(type, subtype);
515
516         if (!idname) {
517                 printf("Error: static node socket type %d undefined\n", type);
518                 return;
519         }
520
521         if (sock->default_value) {
522                 MEM_freeN(sock->default_value);
523                 sock->default_value = NULL;
524         }
525
526         sock->type = type;
527         BLI_strncpy(sock->idname, idname, sizeof(sock->idname));
528         node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(idname));
529 }
530
531 bNodeSocket *nodeAddSocket(bNodeTree *ntree, bNode *node, int in_out, const char *idname,
532                            const char *identifier, const char *name)
533 {
534         ListBase *lb = (in_out == SOCK_IN ? &node->inputs : &node->outputs);
535         bNodeSocket *sock = make_socket(ntree, node, in_out, lb, idname, identifier, name);
536         
537         BLI_remlink(lb, sock);  /* does nothing for new socket */
538         BLI_addtail(lb, sock);
539         
540         node->update |= NODE_UPDATE;
541         
542         return sock;
543 }
544
545 bNodeSocket *nodeInsertSocket(bNodeTree *ntree, bNode *node, int in_out, const char *idname,
546                               bNodeSocket *next_sock, const char *identifier, const char *name)
547 {
548         ListBase *lb = (in_out == SOCK_IN ? &node->inputs : &node->outputs);
549         bNodeSocket *sock = make_socket(ntree, node, in_out, lb, idname, identifier, name);
550         
551         BLI_remlink(lb, sock);  /* does nothing for new socket */
552         BLI_insertlinkbefore(lb, next_sock, sock);
553         
554         node->update |= NODE_UPDATE;
555         
556         return sock;
557 }
558
559 const char *nodeStaticSocketType(int type, int subtype)
560 {
561         switch (type) {
562                 case SOCK_FLOAT:
563                         switch (subtype) {
564                                 case PROP_UNSIGNED:
565                                         return "NodeSocketFloatUnsigned";
566                                 case PROP_PERCENTAGE:
567                                         return "NodeSocketFloatPercentage";
568                                 case PROP_FACTOR:
569                                         return "NodeSocketFloatFactor";
570                                 case PROP_ANGLE:
571                                         return "NodeSocketFloatAngle";
572                                 case PROP_TIME:
573                                         return "NodeSocketFloatTime";
574                                 case PROP_NONE:
575                                 default:
576                                         return "NodeSocketFloat";
577                         }
578                 case SOCK_INT:
579                         switch (subtype) {
580                                 case PROP_UNSIGNED:
581                                         return "NodeSocketIntUnsigned";
582                                 case PROP_PERCENTAGE:
583                                         return "NodeSocketIntPercentage";
584                                 case PROP_FACTOR:
585                                         return "NodeSocketIntFactor";
586                                 case PROP_NONE:
587                                 default:
588                                         return "NodeSocketInt";
589                         }
590                 case SOCK_BOOLEAN:
591                         return "NodeSocketBool";
592                 case SOCK_VECTOR:
593                         switch (subtype) {
594                                 case PROP_TRANSLATION:
595                                         return "NodeSocketVectorTranslation";
596                                 case PROP_DIRECTION:
597                                         return "NodeSocketVectorDirection";
598                                 case PROP_VELOCITY:
599                                         return "NodeSocketVectorVelocity";
600                                 case PROP_ACCELERATION:
601                                         return "NodeSocketVectorAcceleration";
602                                 case PROP_EULER:
603                                         return "NodeSocketVectorEuler";
604                                 case PROP_XYZ:
605                                         return "NodeSocketVectorXYZ";
606                                 case PROP_NONE:
607                                 default:
608                                         return "NodeSocketVector";
609                         }
610                 case SOCK_RGBA:
611                         return "NodeSocketColor";
612                 case SOCK_STRING:
613                         return "NodeSocketString";
614                 case SOCK_SHADER:
615                         return "NodeSocketShader";
616         }
617         return NULL;
618 }
619
620 const char *nodeStaticSocketInterfaceType(int type, int subtype)
621 {
622         switch (type) {
623                 case SOCK_FLOAT:
624                         switch (subtype) {
625                                 case PROP_UNSIGNED:
626                                         return "NodeSocketInterfaceFloatUnsigned";
627                                 case PROP_PERCENTAGE:
628                                         return "NodeSocketInterfaceFloatPercentage";
629                                 case PROP_FACTOR:
630                                         return "NodeSocketInterfaceFloatFactor";
631                                 case PROP_ANGLE:
632                                         return "NodeSocketInterfaceFloatAngle";
633                                 case PROP_TIME:
634                                         return "NodeSocketInterfaceFloatTime";
635                                 case PROP_NONE:
636                                 default:
637                                         return "NodeSocketInterfaceFloat";
638                         }
639                 case SOCK_INT:
640                         switch (subtype) {
641                                 case PROP_UNSIGNED:
642                                         return "NodeSocketInterfaceIntUnsigned";
643                                 case PROP_PERCENTAGE:
644                                         return "NodeSocketInterfaceIntPercentage";
645                                 case PROP_FACTOR:
646                                         return "NodeSocketInterfaceIntFactor";
647                                 case PROP_NONE:
648                                 default:
649                                         return "NodeSocketInterfaceInt";
650                         }
651                 case SOCK_BOOLEAN:
652                         return "NodeSocketInterfaceBool";
653                 case SOCK_VECTOR:
654                         switch (subtype) {
655                                 case PROP_TRANSLATION:
656                                         return "NodeSocketInterfaceVectorTranslation";
657                                 case PROP_DIRECTION:
658                                         return "NodeSocketInterfaceVectorDirection";
659                                 case PROP_VELOCITY:
660                                         return "NodeSocketInterfaceVectorVelocity";
661                                 case PROP_ACCELERATION:
662                                         return "NodeSocketInterfaceVectorAcceleration";
663                                 case PROP_EULER:
664                                         return "NodeSocketInterfaceVectorEuler";
665                                 case PROP_XYZ:
666                                         return "NodeSocketInterfaceVectorXYZ";
667                                 case PROP_NONE:
668                                 default:
669                                         return "NodeSocketInterfaceVector";
670                         }
671                 case SOCK_RGBA:
672                         return "NodeSocketInterfaceColor";
673                 case SOCK_STRING:
674                         return "NodeSocketInterfaceString";
675                 case SOCK_SHADER:
676                         return "NodeSocketInterfaceShader";
677         }
678         return NULL;
679 }
680
681 bNodeSocket *nodeAddStaticSocket(bNodeTree *ntree, bNode *node, int in_out, int type, int subtype,
682                                  const char *identifier, const char *name)
683 {
684         const char *idname = nodeStaticSocketType(type, subtype);
685         bNodeSocket *sock;
686         
687         if (!idname) {
688                 printf("Error: static node socket type %d undefined\n", type);
689                 return NULL;
690         }
691         
692         sock = nodeAddSocket(ntree, node, in_out, idname, identifier, name);
693         sock->type = type;
694         return sock;
695 }
696
697 bNodeSocket *nodeInsertStaticSocket(bNodeTree *ntree, bNode *node, int in_out, int type, int subtype,
698                                     bNodeSocket *next_sock, const char *identifier, const char *name)
699 {
700         const char *idname = nodeStaticSocketType(type, subtype);
701         bNodeSocket *sock;
702         
703         if (!idname) {
704                 printf("Error: static node socket type %d undefined\n", type);
705                 return NULL;
706         }
707         
708         sock = nodeInsertSocket(ntree, node, in_out, idname, next_sock, identifier, name);
709         sock->type = type;
710         return sock;
711 }
712
713 static void node_socket_free(bNodeTree *UNUSED(ntree), bNodeSocket *sock, bNode *UNUSED(node))
714 {
715         if (sock->prop) {
716                 IDP_FreeProperty(sock->prop);
717                 MEM_freeN(sock->prop);
718         }
719         
720         if (sock->default_value)
721                 MEM_freeN(sock->default_value);
722 }
723
724 void nodeRemoveSocket(bNodeTree *ntree, bNode *node, bNodeSocket *sock)
725 {
726         bNodeLink *link, *next;
727         
728         for (link = ntree->links.first; link; link = next) {
729                 next = link->next;
730                 if (link->fromsock == sock || link->tosock == sock) {
731                         nodeRemLink(ntree, link);
732                 }
733         }
734         
735         /* this is fast, this way we don't need an in_out argument */
736         BLI_remlink(&node->inputs, sock);
737         BLI_remlink(&node->outputs, sock);
738         
739         node_socket_free(ntree, sock, node);
740         MEM_freeN(sock);
741         
742         node->update |= NODE_UPDATE;
743 }
744
745 void nodeRemoveAllSockets(bNodeTree *ntree, bNode *node)
746 {
747         bNodeSocket *sock, *sock_next;
748         bNodeLink *link, *next;
749         
750         for (link = ntree->links.first; link; link = next) {
751                 next = link->next;
752                 if (link->fromnode == node || link->tonode == node) {
753                         nodeRemLink(ntree, link);
754                 }
755         }
756         
757         for (sock = node->inputs.first; sock; sock = sock_next) {
758                 sock_next = sock->next;
759                 node_socket_free(ntree, sock, node);
760                 MEM_freeN(sock);
761         }
762         BLI_listbase_clear(&node->inputs);
763
764         for (sock = node->outputs.first; sock; sock = sock_next) {
765                 sock_next = sock->next;
766                 node_socket_free(ntree, sock, node);
767                 MEM_freeN(sock);
768         }
769         BLI_listbase_clear(&node->outputs);
770         
771         node->update |= NODE_UPDATE;
772 }
773
774 /* finds a node based on its name */
775 bNode *nodeFindNodebyName(bNodeTree *ntree, const char *name)
776 {
777         return BLI_findstring(&ntree->nodes, name, offsetof(bNode, name));
778 }
779
780 /* finds a node based on given socket */
781 int nodeFindNode(bNodeTree *ntree, bNodeSocket *sock, bNode **nodep, int *sockindex)
782 {
783         int in_out = sock->in_out;
784         bNode *node;
785         bNodeSocket *tsock;
786         int index = 0;
787         
788         for (node = ntree->nodes.first; node; node = node->next) {
789                 tsock = (in_out == SOCK_IN ? node->inputs.first : node->outputs.first);
790                 for (index = 0; tsock; tsock = tsock->next, index++) {
791                         if (tsock == sock)
792                                 break;
793                 }
794                 if (tsock)
795                         break;
796         }
797
798         if (node) {
799                 *nodep = node;
800                 if (sockindex) *sockindex = index;
801                 return 1;
802         }
803         
804         *nodep = NULL;
805         return 0;
806 }
807
808 /**
809  * \note Recursive
810  */
811 bNode *nodeFindRootParent(bNode *node)
812 {
813         if (node->parent) {
814                 return nodeFindRootParent(node->parent);
815         }
816         else {
817                 return node->type == NODE_FRAME ? node : NULL;
818         }
819 }
820
821 /**
822  * \returns true if \a child has \a parent as a parent/grandparent/...
823  * \note Recursive
824  */
825 bool nodeIsChildOf(const bNode *parent, const bNode *child)
826 {
827         if (parent == child) {
828                 return true;
829         }
830         else if (child->parent) {
831                 return nodeIsChildOf(parent, child->parent);
832         }
833         return false;
834 }
835
836 /**
837  * Iterate over a chain of nodes, starting with \a node_start, executing
838  * \a callback for each node (which can return false to end iterator).
839  *
840  * \param reversed for backwards iteration
841  * \note Recursive
842  */
843 void nodeChainIter(
844         const bNodeTree *ntree, const bNode *node_start,
845         bool (*callback)(bNode *, bNode *, void *, const bool), void *userdata,
846         const bool reversed)
847 {
848         bNodeLink *link;
849
850         for (link = ntree->links.first; link; link = link->next) {
851                 if ((link->flag & NODE_LINK_VALID) == 0) {
852                         /* Skip links marked as cyclic. */
853                         continue;
854                 }
855                 if (link->tonode && link->fromnode) {
856                         /* is the link part of the chain meaning node_start == fromnode (or tonode for reversed case)? */
857                         if ((reversed && (link->tonode == node_start)) ||
858                             (!reversed && link->fromnode == node_start))
859                         {
860                                 if (!callback(link->fromnode, link->tonode, userdata, reversed)) {
861                                         return;
862                                 }
863                                 nodeChainIter(ntree, reversed ? link->fromnode : link->tonode, callback, userdata, reversed);
864                         }
865                 }
866         }
867 }
868
869 /**
870  * Iterate over all parents of \a node, executing \a callback for each parent (which can return false to end iterator)
871  *
872  * \note Recursive
873  */
874 void nodeParentsIter(bNode *node, bool (*callback)(bNode *, void *), void *userdata)
875 {
876         if (node->parent) {
877                 if (!callback(node->parent, userdata)) {
878                         return;
879                 }
880                 nodeParentsIter(node->parent, callback, userdata);
881         }
882 }
883
884 /* ************** Add stuff ********** */
885
886 /* Find the first available, non-duplicate name for a given node */
887 void nodeUniqueName(bNodeTree *ntree, bNode *node)
888 {
889         BLI_uniquename(&ntree->nodes, node, DATA_("Node"), '.', offsetof(bNode, name), sizeof(node->name));
890 }
891
892 bNode *nodeAddNode(const struct bContext *C, bNodeTree *ntree, const char *idname)
893 {
894         bNode *node;
895         
896         node = MEM_callocN(sizeof(bNode), "new node");
897         BLI_addtail(&ntree->nodes, node);
898         
899         BLI_strncpy(node->idname, idname, sizeof(node->idname));
900         node_set_typeinfo(C, ntree, node, nodeTypeFind(idname));
901         
902         ntree->update |= NTREE_UPDATE_NODES;
903         
904         return node;
905 }
906
907 bNode *nodeAddStaticNode(const struct bContext *C, bNodeTree *ntree, int type)
908 {
909         const char *idname = NULL;
910         
911         NODE_TYPES_BEGIN(ntype)
912                 /* do an extra poll here, because some int types are used
913                  * for multiple node types, this helps find the desired type
914                  */
915                 if (ntype->type == type && (!ntype->poll || ntype->poll(ntype, ntree))) {
916                         idname = ntype->idname;
917                         break;
918                 }
919         NODE_TYPES_END
920         if (!idname) {
921                 printf("Error: static node type %d undefined\n", type);
922                 return NULL;
923         }
924         return nodeAddNode(C, ntree, idname);
925 }
926
927 static void node_socket_copy(bNodeSocket *sock_dst, bNodeSocket *sock_src, const int flag)
928 {
929         sock_src->new_sock = sock_dst;
930
931         if (sock_src->prop) {
932                 sock_dst->prop = IDP_CopyProperty_ex(sock_src->prop, flag);
933         }
934
935         if (sock_src->default_value) {
936                 sock_dst->default_value = MEM_dupallocN(sock_src->default_value);
937         }
938
939         sock_dst->stack_index = 0;
940         /* XXX some compositor node (e.g. image, render layers) still store
941          * some persistent buffer data here, need to clear this to avoid dangling pointers.
942          */
943         sock_dst->cache = NULL;
944 }
945
946 /* keep socket listorder identical, for copying links */
947 /* ntree is the target tree */
948 bNode *BKE_node_copy_ex(bNodeTree *ntree, bNode *node_src, const int flag)
949 {
950         bNode *node_dst = MEM_callocN(sizeof(bNode), "dupli node");
951         bNodeSocket *sock_dst, *sock_src;
952         bNodeLink *link_dst, *link_src;
953
954         *node_dst = *node_src;
955         /* can be called for nodes outside a node tree (e.g. clipboard) */
956         if (ntree) {
957                 nodeUniqueName(ntree, node_dst);
958
959                 BLI_addtail(&ntree->nodes, node_dst);
960         }
961
962         BLI_duplicatelist(&node_dst->inputs, &node_src->inputs);
963         for (sock_dst = node_dst->inputs.first, sock_src = node_src->inputs.first;
964              sock_dst != NULL;
965              sock_dst = sock_dst->next, sock_src = sock_src->next)
966         {
967                 node_socket_copy(sock_dst, sock_src, flag);
968         }
969
970         BLI_duplicatelist(&node_dst->outputs, &node_src->outputs);
971         for (sock_dst = node_dst->outputs.first, sock_src = node_src->outputs.first;
972              sock_dst != NULL;
973              sock_dst = sock_dst->next, sock_src = sock_src->next)
974         {
975                 node_socket_copy(sock_dst, sock_src, flag);
976         }
977
978         if (node_src->prop) {
979                 node_dst->prop = IDP_CopyProperty_ex(node_src->prop, flag);
980         }
981
982         BLI_duplicatelist(&node_dst->internal_links, &node_src->internal_links);
983         for (link_dst = node_dst->internal_links.first, link_src = node_src->internal_links.first;
984              link_dst != NULL;
985              link_dst = link_dst->next, link_src = link_src->next)
986         {
987                 link_dst->fromnode = node_dst;
988                 link_dst->tonode = node_dst;
989                 link_dst->fromsock = link_dst->fromsock->new_sock;
990                 link_dst->tosock = link_dst->tosock->new_sock;
991         }
992
993         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
994                 id_us_plus(node_dst->id);
995         }
996
997         if (node_src->typeinfo->copyfunc) {
998                 node_src->typeinfo->copyfunc(ntree, node_dst, node_src);
999         }
1000
1001         node_src->new_node = node_dst;
1002         node_dst->new_node = NULL;
1003
1004         if (node_dst->typeinfo->copyfunc_api) {
1005                 PointerRNA ptr;
1006                 RNA_pointer_create((ID *)ntree, &RNA_Node, node_dst, &ptr);
1007
1008                 node_dst->typeinfo->copyfunc_api(&ptr, node_src);
1009         }
1010
1011         if (ntree) {
1012                 ntree->update |= NTREE_UPDATE_NODES;
1013         }
1014
1015         return node_dst;
1016 }
1017
1018 bNode *nodeCopyNode(bNodeTree *ntree, bNode *node)
1019 {
1020         return BKE_node_copy_ex(ntree, node, LIB_ID_CREATE_NO_USER_REFCOUNT);
1021 }
1022
1023 /* also used via rna api, so we check for proper input output direction */
1024 bNodeLink *nodeAddLink(bNodeTree *ntree, bNode *fromnode, bNodeSocket *fromsock, bNode *tonode, bNodeSocket *tosock)
1025 {
1026         bNodeLink *link = NULL;
1027         
1028         /* test valid input */
1029         BLI_assert(fromnode);
1030         BLI_assert(tonode);
1031         
1032         if (fromsock->in_out == SOCK_OUT && tosock->in_out == SOCK_IN) {
1033                 link = MEM_callocN(sizeof(bNodeLink), "link");
1034                 if (ntree)
1035                         BLI_addtail(&ntree->links, link);
1036                 link->fromnode = fromnode;
1037                 link->fromsock = fromsock;
1038                 link->tonode = tonode;
1039                 link->tosock = tosock;
1040         }
1041         else if (fromsock->in_out == SOCK_IN && tosock->in_out == SOCK_OUT) {
1042                 /* OK but flip */
1043                 link = MEM_callocN(sizeof(bNodeLink), "link");
1044                 if (ntree)
1045                         BLI_addtail(&ntree->links, link);
1046                 link->fromnode = tonode;
1047                 link->fromsock = tosock;
1048                 link->tonode = fromnode;
1049                 link->tosock = fromsock;
1050         }
1051         
1052         if (ntree)
1053                 ntree->update |= NTREE_UPDATE_LINKS;
1054         
1055         return link;
1056 }
1057
1058 void nodeRemLink(bNodeTree *ntree, bNodeLink *link)
1059 {
1060         /* can be called for links outside a node tree (e.g. clipboard) */
1061         if (ntree)
1062                 BLI_remlink(&ntree->links, link);
1063
1064         if (link->tosock)
1065                 link->tosock->link = NULL;
1066         MEM_freeN(link);
1067         
1068         if (ntree)
1069                 ntree->update |= NTREE_UPDATE_LINKS;
1070 }
1071
1072 void nodeRemSocketLinks(bNodeTree *ntree, bNodeSocket *sock)
1073 {
1074         bNodeLink *link, *next;
1075         
1076         for (link = ntree->links.first; link; link = next) {
1077                 next = link->next;
1078                 if (link->fromsock == sock || link->tosock == sock) {
1079                         nodeRemLink(ntree, link);
1080                 }
1081         }
1082         
1083         ntree->update |= NTREE_UPDATE_LINKS;
1084 }
1085
1086 bool nodeLinkIsHidden(bNodeLink *link)
1087 {
1088         return nodeSocketIsHidden(link->fromsock) || nodeSocketIsHidden(link->tosock);
1089 }
1090
1091 void nodeInternalRelink(bNodeTree *ntree, bNode *node)
1092 {
1093         bNodeLink *link, *link_next;
1094         
1095         /* store link pointers in output sockets, for efficient lookup */
1096         for (link = node->internal_links.first; link; link = link->next)
1097                 link->tosock->link = link;
1098         
1099         /* redirect downstream links */
1100         for (link = ntree->links.first; link; link = link_next) {
1101                 link_next = link->next;
1102                 
1103                 /* do we have internal link? */
1104                 if (link->fromnode == node) {
1105                         if (link->fromsock->link) {
1106                                 /* get the upstream input link */
1107                                 bNodeLink *fromlink = link->fromsock->link->fromsock->link;
1108                                 /* skip the node */
1109                                 if (fromlink) {
1110                                         link->fromnode = fromlink->fromnode;
1111                                         link->fromsock = fromlink->fromsock;
1112                                         
1113                                         /* if the up- or downstream link is invalid,
1114                                          * the replacement link will be invalid too.
1115                                          */
1116                                         if (!(fromlink->flag & NODE_LINK_VALID))
1117                                                 link->flag &= ~NODE_LINK_VALID;
1118                                         
1119                                         ntree->update |= NTREE_UPDATE_LINKS;
1120                                 }
1121                                 else
1122                                         nodeRemLink(ntree, link);
1123                         }
1124                         else
1125                                 nodeRemLink(ntree, link);
1126                 }
1127         }
1128         
1129         /* remove remaining upstream links */
1130         for (link = ntree->links.first; link; link = link_next) {
1131                 link_next = link->next;
1132                 
1133                 if (link->tonode == node)
1134                         nodeRemLink(ntree, link);
1135         }
1136 }
1137
1138 void nodeToView(bNode *node, float x, float y, float *rx, float *ry)
1139 {
1140         if (node->parent) {
1141                 nodeToView(node->parent, x + node->locx, y + node->locy, rx, ry);
1142         }
1143         else {
1144                 *rx = x + node->locx;
1145                 *ry = y + node->locy;
1146         }
1147 }
1148
1149 void nodeFromView(bNode *node, float x, float y, float *rx, float *ry)
1150 {
1151         if (node->parent) {
1152                 nodeFromView(node->parent, x, y, rx, ry);
1153                 *rx -= node->locx;
1154                 *ry -= node->locy;
1155         }
1156         else {
1157                 *rx = x - node->locx;
1158                 *ry = y - node->locy;
1159         }
1160 }
1161
1162 bool nodeAttachNodeCheck(bNode *node, bNode *parent)
1163 {
1164         bNode *parent_recurse;
1165         for (parent_recurse = node; parent_recurse; parent_recurse = parent_recurse->parent) {
1166                 if (parent_recurse == parent) {
1167                         return true;
1168                 }
1169         }
1170
1171         return false;
1172 }
1173
1174 void nodeAttachNode(bNode *node, bNode *parent)
1175 {
1176         float locx, locy;
1177
1178         BLI_assert(parent->type == NODE_FRAME);
1179         BLI_assert(nodeAttachNodeCheck(parent, node) == false);
1180
1181         nodeToView(node, 0.0f, 0.0f, &locx, &locy);
1182         
1183         node->parent = parent;
1184         /* transform to parent space */
1185         nodeFromView(parent, locx, locy, &node->locx, &node->locy);
1186 }
1187
1188 void nodeDetachNode(struct bNode *node)
1189 {
1190         float locx, locy;
1191         
1192         if (node->parent) {
1193
1194                 BLI_assert(node->parent->type == NODE_FRAME);
1195
1196                 /* transform to view space */
1197                 nodeToView(node, 0.0f, 0.0f, &locx, &locy);
1198                 node->locx = locx;
1199                 node->locy = locy;
1200                 node->parent = NULL;
1201         }
1202 }
1203
1204 void ntreeInitDefault(bNodeTree *ntree)
1205 {
1206         ntree_set_typeinfo(ntree, NULL);
1207 }
1208
1209 bNodeTree *ntreeAddTree(Main *bmain, const char *name, const char *idname)
1210 {
1211         bNodeTree *ntree;
1212         
1213         /* trees are created as local trees for compositor, material or texture nodes,
1214          * node groups and other tree types are created as library data.
1215          */
1216         if (bmain) {
1217                 ntree = BKE_libblock_alloc(bmain, ID_NT, name, 0);
1218         }
1219         else {
1220                 ntree = MEM_callocN(sizeof(bNodeTree), "new node tree");
1221                 *( (short *)ntree->id.name ) = ID_NT;
1222                 BLI_strncpy(ntree->id.name + 2, name, sizeof(ntree->id.name));
1223         }
1224         
1225         /* Types are fully initialized at this point,
1226          * if an undefined node is added later this will be reset.
1227          */
1228         ntree->init |= NTREE_TYPE_INIT;
1229         
1230         BLI_strncpy(ntree->idname, idname, sizeof(ntree->idname));
1231         ntree_set_typeinfo(ntree, ntreeTypeFind(idname));
1232         
1233         return ntree;
1234 }
1235
1236 /**
1237  * Only copy internal data of NodeTree ID from source to already allocated/initialized destination.
1238  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
1239  *
1240  * WARNING! This function will not handle ID user count!
1241  *
1242  * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
1243  */
1244 void BKE_node_tree_copy_data(Main *UNUSED(bmain), bNodeTree *ntree_dst, const bNodeTree *ntree_src, const int flag)
1245 {
1246         bNodeSocket *sock_dst, *sock_src;
1247         bNodeLink *link_dst;
1248
1249         /* We never handle usercount here for own data. */
1250         const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT;
1251
1252         /* in case a running nodetree is copied */
1253         ntree_dst->execdata = NULL;
1254
1255         ntree_dst->duplilock = NULL;
1256
1257         BLI_listbase_clear(&ntree_dst->nodes);
1258         BLI_listbase_clear(&ntree_dst->links);
1259
1260         for (bNode *node_src = ntree_src->nodes.first; node_src; node_src = node_src->next) {
1261                 BKE_node_copy_ex(ntree_dst, node_src, flag_subdata);
1262         }
1263
1264         /* copy links */
1265         BLI_duplicatelist(&ntree_dst->links, &ntree_src->links);
1266         for (link_dst = ntree_dst->links.first; link_dst; link_dst = link_dst->next) {
1267                 link_dst->fromnode = (link_dst->fromnode ? link_dst->fromnode->new_node : NULL);
1268                 link_dst->fromsock = (link_dst->fromsock ? link_dst->fromsock->new_sock : NULL);
1269                 link_dst->tonode = (link_dst->tonode ? link_dst->tonode->new_node : NULL);
1270                 link_dst->tosock = (link_dst->tosock ? link_dst->tosock->new_sock : NULL);
1271                 /* update the link socket's pointer */
1272                 if (link_dst->tosock) {
1273                         link_dst->tosock->link = link_dst;
1274                 }
1275         }
1276
1277         /* copy interface sockets */
1278         BLI_duplicatelist(&ntree_dst->inputs, &ntree_src->inputs);
1279         for (sock_dst = ntree_dst->inputs.first, sock_src = ntree_src->inputs.first;
1280              sock_dst != NULL;
1281              sock_dst = sock_dst->next, sock_src = sock_src->next)
1282         {
1283                 node_socket_copy(sock_dst, sock_src, flag_subdata);
1284         }
1285
1286         BLI_duplicatelist(&ntree_dst->outputs, &ntree_src->outputs);
1287         for (sock_dst = ntree_dst->outputs.first, sock_src = ntree_src->outputs.first;
1288              sock_dst != NULL;
1289              sock_dst = sock_dst->next, sock_src = sock_src->next)
1290         {
1291                 node_socket_copy(sock_dst, sock_src, flag_subdata);
1292         }
1293
1294         /* copy preview hash */
1295         if (ntree_src->previews && (flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
1296                 bNodeInstanceHashIterator iter;
1297
1298                 ntree_dst->previews = BKE_node_instance_hash_new("node previews");
1299
1300                 NODE_INSTANCE_HASH_ITER(iter, ntree_src->previews) {
1301                         bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1302                         bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1303                         BKE_node_instance_hash_insert(ntree_dst->previews, key, BKE_node_preview_copy(preview));
1304                 }
1305         }
1306         else {
1307                 ntree_dst->previews = NULL;
1308         }
1309
1310         /* update node->parent pointers */
1311         for (bNode *node_dst = ntree_dst->nodes.first, *node_src = ntree_src->nodes.first; node_dst; node_dst = node_dst->next, node_src = node_src->next) {
1312                 if (node_dst->parent) {
1313                         node_dst->parent = node_dst->parent->new_node;
1314                 }
1315         }
1316
1317         /* node tree will generate its own interface type */
1318         ntree_dst->interface_type = NULL;
1319 }
1320
1321 bNodeTree *ntreeCopyTree_ex(const bNodeTree *ntree, Main *bmain, const bool do_id_user)
1322 {
1323         bNodeTree *ntree_copy;
1324         BKE_id_copy_ex(bmain, (ID *)ntree, (ID **)&ntree_copy, do_id_user ? 0 : LIB_ID_CREATE_NO_USER_REFCOUNT, false);
1325         return ntree_copy;
1326 }
1327 bNodeTree *ntreeCopyTree(Main *bmain, const bNodeTree *ntree)
1328 {
1329         return ntreeCopyTree_ex(ntree, bmain, true);
1330 }
1331
1332 void ntreeUserIncrefID(bNodeTree *ntree)
1333 {
1334         bNode *node;
1335         for (node = ntree->nodes.first; node; node = node->next) {
1336                 id_us_plus(node->id);
1337         }
1338 }
1339 void ntreeUserDecrefID(bNodeTree *ntree)
1340 {
1341         bNode *node;
1342         for (node = ntree->nodes.first; node; node = node->next) {
1343                 id_us_min(node->id);
1344         }
1345 }
1346
1347 /* *************** Node Preview *********** */
1348
1349 /* XXX this should be removed eventually ...
1350  * Currently BKE functions are modeled closely on previous code,
1351  * using BKE_node_preview_init_tree to set up previews for a whole node tree in advance.
1352  * This should be left more to the individual node tree implementations.
1353  */
1354 int BKE_node_preview_used(bNode *node)
1355 {
1356         /* XXX check for closed nodes? */
1357         return (node->typeinfo->flag & NODE_PREVIEW) != 0;
1358 }
1359
1360 bNodePreview *BKE_node_preview_verify(bNodeInstanceHash *previews, bNodeInstanceKey key, int xsize, int ysize, bool create)
1361 {
1362         bNodePreview *preview;
1363         
1364         preview = BKE_node_instance_hash_lookup(previews, key);
1365         if (!preview) {
1366                 if (create) {
1367                         preview = MEM_callocN(sizeof(bNodePreview), "node preview");
1368                         BKE_node_instance_hash_insert(previews, key, preview);
1369                 }
1370                 else
1371                         return NULL;
1372         }
1373         
1374         /* node previews can get added with variable size this way */
1375         if (xsize == 0 || ysize == 0)
1376                 return preview;
1377         
1378         /* sanity checks & initialize */
1379         if (preview->rect) {
1380                 if (preview->xsize != xsize || preview->ysize != ysize) {
1381                         MEM_freeN(preview->rect);
1382                         preview->rect = NULL;
1383                 }
1384         }
1385         
1386         if (preview->rect == NULL) {
1387                 preview->rect = MEM_callocN(4 * xsize + xsize * ysize * sizeof(char) * 4, "node preview rect");
1388                 preview->xsize = xsize;
1389                 preview->ysize = ysize;
1390         }
1391         /* no clear, makes nicer previews */
1392         
1393         return preview;
1394 }
1395
1396 bNodePreview *BKE_node_preview_copy(bNodePreview *preview)
1397 {
1398         bNodePreview *new_preview = MEM_dupallocN(preview);
1399         if (preview->rect)
1400                 new_preview->rect = MEM_dupallocN(preview->rect);
1401         return new_preview;
1402 }
1403
1404 void BKE_node_preview_free(bNodePreview *preview)
1405 {
1406         if (preview->rect)
1407                 MEM_freeN(preview->rect);
1408         MEM_freeN(preview);
1409 }
1410
1411 static void node_preview_init_tree_recursive(bNodeInstanceHash *previews, bNodeTree *ntree, bNodeInstanceKey parent_key, int xsize, int ysize, int create)
1412 {
1413         bNode *node;
1414         for (node = ntree->nodes.first; node; node = node->next) {
1415                 bNodeInstanceKey key = BKE_node_instance_key(parent_key, ntree, node);
1416                 
1417                 if (BKE_node_preview_used(node)) {
1418                         node->preview_xsize = xsize;
1419                         node->preview_ysize = ysize;
1420                         
1421                         BKE_node_preview_verify(previews, key, xsize, ysize, create);
1422                 }
1423                 
1424                 if (node->type == NODE_GROUP && node->id)
1425                         node_preview_init_tree_recursive(previews, (bNodeTree *)node->id, key, xsize, ysize, create);
1426         }
1427 }
1428
1429 void BKE_node_preview_init_tree(bNodeTree *ntree, int xsize, int ysize, int create_previews)
1430 {
1431         if (!ntree)
1432                 return;
1433         
1434         if (!ntree->previews)
1435                 ntree->previews = BKE_node_instance_hash_new("node previews");
1436         
1437         node_preview_init_tree_recursive(ntree->previews, ntree, NODE_INSTANCE_KEY_BASE, xsize, ysize, create_previews);
1438 }
1439
1440 static void node_preview_tag_used_recursive(bNodeInstanceHash *previews, bNodeTree *ntree, bNodeInstanceKey parent_key)
1441 {
1442         bNode *node;
1443         for (node = ntree->nodes.first; node; node = node->next) {
1444                 bNodeInstanceKey key = BKE_node_instance_key(parent_key, ntree, node);
1445                 
1446                 if (BKE_node_preview_used(node))
1447                         BKE_node_instance_hash_tag_key(previews, key);
1448                 
1449                 if (node->type == NODE_GROUP && node->id)
1450                         node_preview_tag_used_recursive(previews, (bNodeTree *)node->id, key);
1451         }
1452 }
1453
1454 void BKE_node_preview_remove_unused(bNodeTree *ntree)
1455 {
1456         if (!ntree || !ntree->previews)
1457                 return;
1458         
1459         /* use the instance hash functions for tagging and removing unused previews */
1460         BKE_node_instance_hash_clear_tags(ntree->previews);
1461         node_preview_tag_used_recursive(ntree->previews, ntree, NODE_INSTANCE_KEY_BASE);
1462         
1463         BKE_node_instance_hash_remove_untagged(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1464 }
1465
1466 void BKE_node_preview_free_tree(bNodeTree *ntree)
1467 {
1468         if (!ntree)
1469                 return;
1470         
1471         if (ntree->previews) {
1472                 BKE_node_instance_hash_free(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1473                 ntree->previews = NULL;
1474         }
1475 }
1476
1477 void BKE_node_preview_clear(bNodePreview *preview)
1478 {
1479         if (preview && preview->rect)
1480                 memset(preview->rect, 0, MEM_allocN_len(preview->rect));
1481 }
1482
1483 void BKE_node_preview_clear_tree(bNodeTree *ntree)
1484 {
1485         bNodeInstanceHashIterator iter;
1486         
1487         if (!ntree || !ntree->previews)
1488                 return;
1489         
1490         NODE_INSTANCE_HASH_ITER(iter, ntree->previews) {
1491                 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1492                 BKE_node_preview_clear(preview);
1493         }
1494 }
1495
1496 static void node_preview_sync(bNodePreview *to, bNodePreview *from)
1497 {
1498         /* sizes should have been initialized by BKE_node_preview_init_tree */
1499         BLI_assert(to->xsize == from->xsize && to->ysize == from->ysize);
1500         
1501         /* copy over contents of previews */
1502         if (to->rect && from->rect) {
1503                 int xsize = to->xsize;
1504                 int ysize = to->ysize;
1505                 memcpy(to->rect, from->rect, xsize * ysize * sizeof(char) * 4);
1506         }
1507 }
1508
1509 void BKE_node_preview_sync_tree(bNodeTree *to_ntree, bNodeTree *from_ntree)
1510 {
1511         bNodeInstanceHash *from_previews = from_ntree->previews;
1512         bNodeInstanceHash *to_previews = to_ntree->previews;
1513         bNodeInstanceHashIterator iter;
1514         
1515         if (!from_previews || !to_previews)
1516                 return;
1517         
1518         NODE_INSTANCE_HASH_ITER(iter, from_previews) {
1519                 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1520                 bNodePreview *from = BKE_node_instance_hash_iterator_get_value(&iter);
1521                 bNodePreview *to = BKE_node_instance_hash_lookup(to_previews, key);
1522                 
1523                 if (from && to)
1524                         node_preview_sync(to, from);
1525         }
1526 }
1527
1528 void BKE_node_preview_merge_tree(bNodeTree *to_ntree, bNodeTree *from_ntree, bool remove_old)
1529 {
1530         if (remove_old || !to_ntree->previews) {
1531                 /* free old previews */
1532                 if (to_ntree->previews)
1533                         BKE_node_instance_hash_free(to_ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1534                 
1535                 /* transfer previews */
1536                 to_ntree->previews = from_ntree->previews;
1537                 from_ntree->previews = NULL;
1538                 
1539                 /* clean up, in case any to_ntree nodes have been removed */
1540                 BKE_node_preview_remove_unused(to_ntree);
1541         }
1542         else {
1543                 bNodeInstanceHashIterator iter;
1544                 
1545                 if (from_ntree->previews) {
1546                         NODE_INSTANCE_HASH_ITER(iter, from_ntree->previews) {
1547                                 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1548                                 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1549                                 
1550                                 /* replace existing previews */
1551                                 BKE_node_instance_hash_remove(to_ntree->previews, key, (bNodeInstanceValueFP)BKE_node_preview_free);
1552                                 BKE_node_instance_hash_insert(to_ntree->previews, key, preview);
1553                         }
1554                         
1555                         /* Note: NULL free function here, because pointers have already been moved over to to_ntree->previews! */
1556                         BKE_node_instance_hash_free(from_ntree->previews, NULL);
1557                         from_ntree->previews = NULL;
1558                 }
1559         }
1560 }
1561
1562 /* hack warning! this function is only used for shader previews, and 
1563  * since it gets called multiple times per pixel for Ztransp we only
1564  * add the color once. Preview gets cleared before it starts render though */
1565 void BKE_node_preview_set_pixel(bNodePreview *preview, const float col[4], int x, int y, bool do_manage)
1566 {
1567         if (preview) {
1568                 if (x >= 0 && y >= 0) {
1569                         if (x < preview->xsize && y < preview->ysize) {
1570                                 unsigned char *tar = preview->rect + 4 * ((preview->xsize * y) + x);
1571                                 
1572                                 if (do_manage) {
1573                                         linearrgb_to_srgb_uchar4(tar, col);
1574                                 }
1575                                 else {
1576                                         rgba_float_to_uchar(tar, col);
1577                                 }
1578                         }
1579                         //else printf("prv out bound x y %d %d\n", x, y);
1580                 }
1581                 //else printf("prv out bound x y %d %d\n", x, y);
1582         }
1583 }
1584
1585 #if 0
1586 static void nodeClearPreview(bNode *node)
1587 {
1588         if (node->preview && node->preview->rect)
1589                 memset(node->preview->rect, 0, MEM_allocN_len(node->preview->rect));
1590 }
1591
1592 /* use it to enforce clear */
1593 void ntreeClearPreview(bNodeTree *ntree)
1594 {
1595         bNode *node;
1596         
1597         if (ntree == NULL)
1598                 return;
1599         
1600         for (node = ntree->nodes.first; node; node = node->next) {
1601                 if (node->typeinfo->flag & NODE_PREVIEW)
1602                         nodeClearPreview(node);
1603                 if (node->type == NODE_GROUP)
1604                         ntreeClearPreview((bNodeTree *)node->id);
1605         }
1606 }
1607
1608 /* hack warning! this function is only used for shader previews, and 
1609  * since it gets called multiple times per pixel for Ztransp we only
1610  * add the color once. Preview gets cleared before it starts render though */
1611 void nodeAddToPreview(bNode *node, const float col[4], int x, int y, int do_manage)
1612 {
1613         bNodePreview *preview = node->preview;
1614         if (preview) {
1615                 if (x >= 0 && y >= 0) {
1616                         if (x < preview->xsize && y < preview->ysize) {
1617                                 unsigned char *tar = preview->rect + 4 * ((preview->xsize * y) + x);
1618                                 
1619                                 if (do_manage) {
1620                                         linearrgb_to_srgb_uchar4(tar, col);
1621                                 }
1622                                 else {
1623                                         rgba_float_to_uchar(tar, col);
1624                                 }
1625                         }
1626                         //else printf("prv out bound x y %d %d\n", x, y);
1627                 }
1628                 //else printf("prv out bound x y %d %d\n", x, y);
1629         }
1630 }
1631 #endif
1632
1633 /* ************** Free stuff ********** */
1634
1635 /* goes over entire tree */
1636 void nodeUnlinkNode(bNodeTree *ntree, bNode *node)
1637 {
1638         bNodeLink *link, *next;
1639         bNodeSocket *sock;
1640         ListBase *lb;
1641         
1642         for (link = ntree->links.first; link; link = next) {
1643                 next = link->next;
1644                 
1645                 if (link->fromnode == node) {
1646                         lb = &node->outputs;
1647                         if (link->tonode)
1648                                 link->tonode->update |= NODE_UPDATE;
1649                 }
1650                 else if (link->tonode == node)
1651                         lb = &node->inputs;
1652                 else
1653                         lb = NULL;
1654
1655                 if (lb) {
1656                         for (sock = lb->first; sock; sock = sock->next) {
1657                                 if (link->fromsock == sock || link->tosock == sock)
1658                                         break;
1659                         }
1660                         if (sock) {
1661                                 nodeRemLink(ntree, link);
1662                         }
1663                 }
1664         }
1665 }
1666
1667 static void node_unlink_attached(bNodeTree *ntree, bNode *parent)
1668 {
1669         bNode *node;
1670         for (node = ntree->nodes.first; node; node = node->next) {
1671                 if (node->parent == parent)
1672                         nodeDetachNode(node);
1673         }
1674 }
1675
1676 /** \note caller needs to manage node->id user */
1677 static void node_free_node_ex(bNodeTree *ntree, bNode *node, bool remove_animdata, bool use_api_free_cb)
1678 {
1679         bNodeSocket *sock, *nextsock;
1680         
1681         /* don't remove node animdata if the tree is localized,
1682          * Action is shared with the original tree (T38221)
1683          */
1684         remove_animdata &= ntree && !(ntree->flag & NTREE_IS_LOCALIZED);
1685         
1686         /* extra free callback */
1687         if (use_api_free_cb && node->typeinfo->freefunc_api) {
1688                 PointerRNA ptr;
1689                 RNA_pointer_create((ID *)ntree, &RNA_Node, node, &ptr);
1690                 
1691                 node->typeinfo->freefunc_api(&ptr);
1692         }
1693         
1694         /* since it is called while free database, node->id is undefined */
1695         
1696         /* can be called for nodes outside a node tree (e.g. clipboard) */
1697         if (ntree) {
1698                 /* remove all references to this node */
1699                 nodeUnlinkNode(ntree, node);
1700                 node_unlink_attached(ntree, node);
1701                 
1702                 BLI_remlink(&ntree->nodes, node);
1703                 
1704                 if (remove_animdata) {
1705                         char propname_esc[MAX_IDPROP_NAME * 2];
1706                         char prefix[MAX_IDPROP_NAME * 2];
1707
1708                         BLI_strescape(propname_esc, node->name, sizeof(propname_esc));
1709                         BLI_snprintf(prefix, sizeof(prefix), "nodes[\"%s\"]", propname_esc);
1710
1711                         BKE_animdata_fix_paths_remove((ID *)ntree, prefix);
1712                 }
1713
1714                 if (ntree->typeinfo->free_node_cache)
1715                         ntree->typeinfo->free_node_cache(ntree, node);
1716                 
1717                 /* texture node has bad habit of keeping exec data around */
1718                 if (ntree->type == NTREE_TEXTURE && ntree->execdata) {
1719                         ntreeTexEndExecTree(ntree->execdata);
1720                         ntree->execdata = NULL;
1721                 }
1722         }
1723
1724         if (node->typeinfo->freefunc) {
1725                 node->typeinfo->freefunc(node);
1726         }
1727
1728         for (sock = node->inputs.first; sock; sock = nextsock) {
1729                 nextsock = sock->next;
1730                 node_socket_free(ntree, sock, node);
1731                 MEM_freeN(sock);
1732         }
1733         for (sock = node->outputs.first; sock; sock = nextsock) {
1734                 nextsock = sock->next;
1735                 node_socket_free(ntree, sock, node);
1736                 MEM_freeN(sock);
1737         }
1738
1739         BLI_freelistN(&node->internal_links);
1740
1741         if (node->prop) {
1742                 IDP_FreeProperty(node->prop);
1743                 MEM_freeN(node->prop);
1744         }
1745
1746         MEM_freeN(node);
1747         
1748         if (ntree)
1749                 ntree->update |= NTREE_UPDATE_NODES;
1750 }
1751
1752 void nodeFreeNode(bNodeTree *ntree, bNode *node)
1753 {
1754         node_free_node_ex(ntree, node, true, true);
1755 }
1756
1757 static void node_socket_interface_free(bNodeTree *UNUSED(ntree), bNodeSocket *sock)
1758 {
1759         if (sock->prop) {
1760                 IDP_FreeProperty(sock->prop);
1761                 MEM_freeN(sock->prop);
1762         }
1763         
1764         if (sock->default_value)
1765                 MEM_freeN(sock->default_value);
1766 }
1767
1768 static void free_localized_node_groups(bNodeTree *ntree)
1769 {
1770         bNode *node;
1771         
1772         /* Only localized node trees store a copy for each node group tree.
1773          * Each node group tree in a localized node tree can be freed,
1774          * since it is a localized copy itself (no risk of accessing free'd
1775          * data in main, see [#37939]).
1776          */
1777         if (!(ntree->flag & NTREE_IS_LOCALIZED))
1778                 return;
1779         
1780         for (node = ntree->nodes.first; node; node = node->next) {
1781                 if (node->type == NODE_GROUP && node->id) {
1782                         bNodeTree *ngroup = (bNodeTree *)node->id;
1783                         ntreeFreeTree(ngroup);
1784                         MEM_freeN(ngroup);
1785                 }
1786         }
1787 }
1788
1789 /** Free (or release) any data used by this nodetree (does not free the nodetree itself). */
1790 void ntreeFreeTree(bNodeTree *ntree)
1791 {
1792         bNodeTree *tntree;
1793         bNode *node, *next;
1794         bNodeSocket *sock, *nextsock;
1795
1796         BKE_animdata_free((ID *)ntree, false);
1797
1798         /* XXX hack! node trees should not store execution graphs at all.
1799          * This should be removed when old tree types no longer require it.
1800          * Currently the execution data for texture nodes remains in the tree
1801          * after execution, until the node tree is updated or freed.
1802          */
1803         if (ntree->execdata) {
1804                 switch (ntree->type) {
1805                         case NTREE_SHADER:
1806                                 ntreeShaderEndExecTree(ntree->execdata);
1807                                 break;
1808                         case NTREE_TEXTURE:
1809                                 ntreeTexEndExecTree(ntree->execdata);
1810                                 ntree->execdata = NULL;
1811                                 break;
1812                 }
1813         }
1814         
1815         /* XXX not nice, but needed to free localized node groups properly */
1816         free_localized_node_groups(ntree);
1817         
1818         /* unregister associated RNA types */
1819         ntreeInterfaceTypeFree(ntree);
1820         
1821         BLI_freelistN(&ntree->links);   /* do first, then unlink_node goes fast */
1822         
1823         for (node = ntree->nodes.first; node; node = next) {
1824                 next = node->next;
1825                 node_free_node_ex(ntree, node, false, false);
1826         }
1827
1828         /* free interface sockets */
1829         for (sock = ntree->inputs.first; sock; sock = nextsock) {
1830                 nextsock = sock->next;
1831                 node_socket_interface_free(ntree, sock);
1832                 MEM_freeN(sock);
1833         }
1834         for (sock = ntree->outputs.first; sock; sock = nextsock) {
1835                 nextsock = sock->next;
1836                 node_socket_interface_free(ntree, sock);
1837                 MEM_freeN(sock);
1838         }
1839         
1840         /* free preview hash */
1841         if (ntree->previews) {
1842                 BKE_node_instance_hash_free(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1843         }
1844
1845         if (ntree->duplilock)
1846                 BLI_mutex_free(ntree->duplilock);
1847         
1848         /* if ntree is not part of library, free the libblock data explicitly */
1849         for (tntree = G.main->nodetree.first; tntree; tntree = tntree->id.next)
1850                 if (tntree == ntree)
1851                         break;
1852         if (tntree == NULL) {
1853                 BKE_libblock_free_data(&ntree->id, true);
1854         }
1855 }
1856
1857 void ntreeFreeCache(bNodeTree *ntree)
1858 {
1859         if (ntree == NULL) return;
1860         
1861         if (ntree->typeinfo->free_cache)
1862                 ntree->typeinfo->free_cache(ntree);
1863 }
1864
1865 void ntreeSetOutput(bNodeTree *ntree)
1866 {
1867         bNode *node;
1868
1869         /* find the active outputs, might become tree type dependent handler */
1870         for (node = ntree->nodes.first; node; node = node->next) {
1871                 if (node->typeinfo->nclass == NODE_CLASS_OUTPUT) {
1872                         bNode *tnode;
1873                         int output = 0;
1874                         
1875                         /* we need a check for which output node should be tagged like this, below an exception */
1876                         if (node->type == CMP_NODE_OUTPUT_FILE)
1877                                 continue;
1878
1879                         /* there is more types having output class, each one is checked */
1880                         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
1881                                 if (tnode->typeinfo->nclass == NODE_CLASS_OUTPUT) {
1882                                         
1883                                         if (ntree->type == NTREE_COMPOSIT) {
1884                                                         
1885                                                 /* same type, exception for viewer */
1886                                                 if (tnode->type == node->type ||
1887                                                     (ELEM(tnode->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER) &&
1888                                                      ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER)))
1889                                                 {
1890                                                         if (tnode->flag & NODE_DO_OUTPUT) {
1891                                                                 output++;
1892                                                                 if (output > 1)
1893                                                                         tnode->flag &= ~NODE_DO_OUTPUT;
1894                                                         }
1895                                                 }
1896                                         }
1897                                         else {
1898                                                 /* same type */
1899                                                 if (tnode->type == node->type) {
1900                                                         if (tnode->flag & NODE_DO_OUTPUT) {
1901                                                                 output++;
1902                                                                 if (output > 1)
1903                                                                         tnode->flag &= ~NODE_DO_OUTPUT;
1904                                                         }
1905                                                 }
1906                                         }
1907                                 }
1908                         }
1909                         if (output == 0)
1910                                 node->flag |= NODE_DO_OUTPUT;
1911                 }
1912                 
1913                 /* group node outputs use this flag too */
1914                 if (node->type == NODE_GROUP_OUTPUT) {
1915                         bNode *tnode;
1916                         int output = 0;
1917                         
1918                         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
1919                                 if (tnode->type == NODE_GROUP_OUTPUT) {
1920                                         if (tnode->flag & NODE_DO_OUTPUT) {
1921                                                 output++;
1922                                                 if (output > 1)
1923                                                         tnode->flag &= ~NODE_DO_OUTPUT;
1924                                         }
1925                                 }
1926                         }
1927                         if (output == 0)
1928                                 node->flag |= NODE_DO_OUTPUT;
1929                 }
1930         }
1931         
1932         /* here we could recursively set which nodes have to be done,
1933          * might be different for editor or for "real" use... */
1934 }
1935
1936 bNodeTree *ntreeFromID(const ID *id)
1937 {
1938         switch (GS(id->name)) {
1939                 case ID_MA:  return ((const Material *)id)->nodetree;
1940                 case ID_LA:  return ((const Lamp *)id)->nodetree;
1941                 case ID_WO:  return ((const World *)id)->nodetree;
1942                 case ID_TE:  return ((const Tex *)id)->nodetree;
1943                 case ID_SCE: return ((const Scene *)id)->nodetree;
1944                 case ID_LS:  return ((const FreestyleLineStyle *)id)->nodetree;
1945                 default: return NULL;
1946         }
1947 }
1948
1949 void ntreeMakeLocal(Main *bmain, bNodeTree *ntree, bool id_in_mainlist, const bool lib_local)
1950 {
1951         BKE_id_make_local_generic(bmain, &ntree->id, id_in_mainlist, lib_local);
1952 }
1953
1954 int ntreeNodeExists(bNodeTree *ntree, bNode *testnode)
1955 {
1956         bNode *node = ntree->nodes.first;
1957         for (; node; node = node->next)
1958                 if (node == testnode)
1959                         return 1;
1960         return 0;
1961 }
1962
1963 int ntreeOutputExists(bNode *node, bNodeSocket *testsock)
1964 {
1965         bNodeSocket *sock = node->outputs.first;
1966         for (; sock; sock = sock->next)
1967                 if (sock == testsock)
1968                         return 1;
1969         return 0;
1970 }
1971
1972 void ntreeNodeFlagSet(const bNodeTree *ntree, const int flag, const bool enable)
1973 {
1974         bNode *node = ntree->nodes.first;
1975
1976         for (; node; node = node->next) {
1977                 if (enable) {
1978                         node->flag |= flag;
1979                 }
1980                 else {
1981                         node->flag &= ~flag;
1982                 }
1983         }
1984 }
1985
1986 /* returns localized tree for execution in threads */
1987 bNodeTree *ntreeLocalize(bNodeTree *ntree)
1988 {
1989         if (ntree) {
1990                 bNodeTree *ltree;
1991                 bNode *node;
1992
1993                 BLI_spin_lock(&spin);
1994                 if (!ntree->duplilock) {
1995                         ntree->duplilock = BLI_mutex_alloc();
1996                 }
1997                 BLI_spin_unlock(&spin);
1998
1999                 BLI_mutex_lock(ntree->duplilock);
2000
2001                 /* Make full copy outside of Main database.
2002                  * Note: previews are not copied here.
2003                  */
2004                 BKE_id_copy_ex(
2005                         NULL, &ntree->id, (ID **)&ltree,
2006                         (LIB_ID_CREATE_NO_MAIN |
2007                          LIB_ID_CREATE_NO_USER_REFCOUNT |
2008                          LIB_ID_COPY_NO_PREVIEW |
2009                          LIB_ID_COPY_NO_ANIMDATA),
2010                         false);
2011                 ltree->flag |= NTREE_IS_LOCALIZED;
2012
2013                 for (node = ltree->nodes.first; node; node = node->next) {
2014                         if (node->type == NODE_GROUP && node->id) {
2015                                 node->id = (ID *)ntreeLocalize((bNodeTree *)node->id);
2016                         }
2017                 }
2018
2019                 /* ensures only a single output node is enabled */
2020                 ntreeSetOutput(ntree);
2021
2022                 for (node = ntree->nodes.first; node; node = node->next) {
2023                         /* store new_node pointer to original */
2024                         node->new_node->original = node;
2025                 }
2026
2027                 if (ntree->typeinfo->localize)
2028                         ntree->typeinfo->localize(ltree, ntree);
2029
2030                 ltree->id.tag |= LIB_TAG_LOCALIZED;
2031
2032                 BLI_mutex_unlock(ntree->duplilock);
2033
2034                 return ltree;
2035         }
2036         else
2037                 return NULL;
2038 }
2039
2040 /* sync local composite with real tree */
2041 /* local tree is supposed to be running, be careful moving previews! */
2042 /* is called by jobs manager, outside threads, so it doesnt happen during draw */
2043 void ntreeLocalSync(bNodeTree *localtree, bNodeTree *ntree)
2044 {
2045         if (localtree && ntree) {
2046                 if (ntree->typeinfo->local_sync)
2047                         ntree->typeinfo->local_sync(localtree, ntree);
2048         }
2049 }
2050
2051 /* merge local tree results back, and free local tree */
2052 /* we have to assume the editor already changed completely */
2053 void ntreeLocalMerge(bNodeTree *localtree, bNodeTree *ntree)
2054 {
2055         if (ntree && localtree) {
2056                 if (ntree->typeinfo->local_merge)
2057                         ntree->typeinfo->local_merge(localtree, ntree);
2058                 
2059                 ntreeFreeTree(localtree);
2060                 MEM_freeN(localtree);
2061         }
2062 }
2063
2064
2065 /* ************ NODE TREE INTERFACE *************** */
2066
2067 static bNodeSocket *make_socket_interface(bNodeTree *ntree, int in_out,
2068                                          const char *idname, const char *name)
2069 {
2070         bNodeSocketType *stype = nodeSocketTypeFind(idname);
2071         bNodeSocket *sock;
2072         int own_index = ntree->cur_index++;
2073
2074         if (stype == NULL) {
2075                 return NULL;
2076         }
2077
2078         sock = MEM_callocN(sizeof(bNodeSocket), "socket template");
2079         BLI_strncpy(sock->idname, stype->idname, sizeof(sock->idname));
2080         node_socket_set_typeinfo(ntree, sock, stype);
2081         sock->in_out = in_out;
2082         sock->type = SOCK_CUSTOM;       /* int type undefined by default */
2083         
2084         /* assign new unique index */
2085         own_index = ntree->cur_index++;
2086         /* use the own_index as socket identifier */
2087         if (in_out == SOCK_IN)
2088                 BLI_snprintf(sock->identifier, MAX_NAME, "Input_%d", own_index);
2089         else
2090                 BLI_snprintf(sock->identifier, MAX_NAME, "Output_%d", own_index);
2091 #ifdef USE_NODE_COMPAT_CUSTOMNODES
2092         /* XXX forward compatibility:
2093          * own_index is deprecated, but needs to be set here.
2094          * Node sockets generally use the identifier string instead now,
2095          * but reconstructing own_index in writefile.c would require parsing the identifier string.
2096          */
2097
2098 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406)) || defined(__clang__)
2099 #  pragma GCC diagnostic push
2100 #  pragma GCC diagnostic ignored "-Wdeprecated-declarations"
2101 #endif
2102
2103         sock->own_index = own_index;
2104
2105 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406)) || defined(__clang__)
2106 #  pragma GCC diagnostic pop
2107 #endif
2108
2109 #endif  /* USE_NODE_COMPAT_CUSTOMNODES */
2110         
2111         sock->limit = (in_out == SOCK_IN ? 1 : 0xFFF);
2112         
2113         BLI_strncpy(sock->name, name, NODE_MAXSTR);
2114         sock->storage = NULL;
2115         sock->flag |= SOCK_COLLAPSED;
2116         
2117         return sock;
2118 }
2119
2120 bNodeSocket *ntreeFindSocketInterface(bNodeTree *ntree, int in_out, const char *identifier)
2121 {
2122         bNodeSocket *iosock = (in_out == SOCK_IN ? ntree->inputs.first : ntree->outputs.first);
2123         for (; iosock; iosock = iosock->next)
2124                 if (STREQ(iosock->identifier, identifier))
2125                         return iosock;
2126         return NULL;
2127 }
2128
2129 bNodeSocket *ntreeAddSocketInterface(bNodeTree *ntree, int in_out, const char *idname, const char *name)
2130 {
2131         bNodeSocket *iosock;
2132         
2133         iosock = make_socket_interface(ntree, in_out, idname, name);
2134         if (in_out == SOCK_IN) {
2135                 BLI_addtail(&ntree->inputs, iosock);
2136                 ntree->update |= NTREE_UPDATE_GROUP_IN;
2137         }
2138         else if (in_out == SOCK_OUT) {
2139                 BLI_addtail(&ntree->outputs, iosock);
2140                 ntree->update |= NTREE_UPDATE_GROUP_OUT;
2141         }
2142         
2143         return iosock;
2144 }
2145
2146 bNodeSocket *ntreeInsertSocketInterface(bNodeTree *ntree, int in_out, const char *idname,
2147                                bNodeSocket *next_sock, const char *name)
2148 {
2149         bNodeSocket *iosock;
2150         
2151         iosock = make_socket_interface(ntree, in_out, idname, name);
2152         if (in_out == SOCK_IN) {
2153                 BLI_insertlinkbefore(&ntree->inputs, next_sock, iosock);
2154                 ntree->update |= NTREE_UPDATE_GROUP_IN;
2155         }
2156         else if (in_out == SOCK_OUT) {
2157                 BLI_insertlinkbefore(&ntree->outputs, next_sock, iosock);
2158                 ntree->update |= NTREE_UPDATE_GROUP_OUT;
2159         }
2160         
2161         return iosock;
2162 }
2163
2164 struct bNodeSocket *ntreeAddSocketInterfaceFromSocket(bNodeTree *ntree, bNode *from_node, bNodeSocket *from_sock)
2165 {
2166         bNodeSocket *iosock = ntreeAddSocketInterface(ntree, from_sock->in_out, from_sock->idname, from_sock->name);
2167         if (iosock) {
2168                 if (iosock->typeinfo->interface_from_socket)
2169                         iosock->typeinfo->interface_from_socket(ntree, iosock, from_node, from_sock);
2170         }
2171         return iosock;
2172 }
2173
2174 struct bNodeSocket *ntreeInsertSocketInterfaceFromSocket(bNodeTree *ntree, bNodeSocket *next_sock, bNode *from_node, bNodeSocket *from_sock)
2175 {
2176         bNodeSocket *iosock = ntreeInsertSocketInterface(ntree, from_sock->in_out, from_sock->idname, next_sock, from_sock->name);
2177         if (iosock) {
2178                 if (iosock->typeinfo->interface_from_socket)
2179                         iosock->typeinfo->interface_from_socket(ntree, iosock, from_node, from_sock);
2180         }
2181         return iosock;
2182 }
2183
2184 void ntreeRemoveSocketInterface(bNodeTree *ntree, bNodeSocket *sock)
2185 {
2186         /* this is fast, this way we don't need an in_out argument */
2187         BLI_remlink(&ntree->inputs, sock);
2188         BLI_remlink(&ntree->outputs, sock);
2189         
2190         node_socket_interface_free(ntree, sock);
2191         MEM_freeN(sock);
2192         
2193         ntree->update |= NTREE_UPDATE_GROUP;
2194 }
2195
2196 /* generates a valid RNA identifier from the node tree name */
2197 static void ntree_interface_identifier_base(bNodeTree *ntree, char *base)
2198 {
2199         /* generate a valid RNA identifier */
2200         sprintf(base, "NodeTreeInterface_%s", ntree->id.name + 2);
2201         RNA_identifier_sanitize(base, false);
2202 }
2203
2204 /* check if the identifier is already in use */
2205 static bool ntree_interface_unique_identifier_check(void *UNUSED(data), const char *identifier)
2206 {
2207         return (RNA_struct_find(identifier) != NULL);
2208 }
2209
2210 /* generates the actual unique identifier and ui name and description */
2211 static void ntree_interface_identifier(bNodeTree *ntree, const char *base, char *identifier, int maxlen, char *name, char *description)
2212 {
2213         /* There is a possibility that different node tree names get mapped to the same identifier
2214          * after sanitization (e.g. "SomeGroup_A", "SomeGroup.A" both get sanitized to "SomeGroup_A").
2215          * On top of the sanitized id string add a number suffix if necessary to avoid duplicates.
2216          */
2217         identifier[0] = '\0';
2218         BLI_uniquename_cb(ntree_interface_unique_identifier_check, NULL, base, '_', identifier, maxlen);
2219         
2220         sprintf(name, "Node Tree %s Interface", ntree->id.name + 2);
2221         sprintf(description, "Interface properties of node group %s", ntree->id.name + 2);
2222 }
2223
2224 static void ntree_interface_type_create(bNodeTree *ntree)
2225 {
2226         StructRNA *srna;
2227         bNodeSocket *sock;
2228         /* strings are generated from base string + ID name, sizes are sufficient */
2229         char base[MAX_ID_NAME + 64], identifier[MAX_ID_NAME + 64], name[MAX_ID_NAME + 64], description[MAX_ID_NAME + 64];
2230         
2231         /* generate a valid RNA identifier */
2232         ntree_interface_identifier_base(ntree, base);
2233         ntree_interface_identifier(ntree, base, identifier, sizeof(identifier), name, description);
2234         
2235         /* register a subtype of PropertyGroup */
2236         srna = RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup);
2237         RNA_def_struct_ui_text(srna, name, description);
2238         RNA_def_struct_duplicate_pointers(&BLENDER_RNA, srna);
2239         
2240         /* associate the RNA type with the node tree */
2241         ntree->interface_type = srna;
2242         RNA_struct_blender_type_set(srna, ntree);
2243         
2244         /* add socket properties */
2245         for (sock = ntree->inputs.first; sock; sock = sock->next) {
2246                 bNodeSocketType *stype = sock->typeinfo;
2247                 if (stype && stype->interface_register_properties)
2248                         stype->interface_register_properties(ntree, sock, srna);
2249         }
2250         for (sock = ntree->outputs.first; sock; sock = sock->next) {
2251                 bNodeSocketType *stype = sock->typeinfo;
2252                 if (stype && stype->interface_register_properties)
2253                         stype->interface_register_properties(ntree, sock, srna);
2254         }
2255 }
2256
2257 StructRNA *ntreeInterfaceTypeGet(bNodeTree *ntree, int create)
2258 {
2259         if (ntree->interface_type) {
2260                 /* strings are generated from base string + ID name, sizes are sufficient */
2261                 char base[MAX_ID_NAME + 64], identifier[MAX_ID_NAME + 64], name[MAX_ID_NAME + 64], description[MAX_ID_NAME + 64];
2262                 
2263                 /* A bit of a hack: when changing the ID name, update the RNA type identifier too,
2264                  * so that the names match. This is not strictly necessary to keep it working,
2265                  * but better for identifying associated NodeTree blocks and RNA types.
2266                  */
2267                 StructRNA *srna = ntree->interface_type;
2268                 
2269                 ntree_interface_identifier_base(ntree, base);
2270                 
2271                 /* RNA identifier may have a number suffix, but should start with the idbase string */
2272                 if (!STREQLEN(RNA_struct_identifier(srna), base, sizeof(base))) {
2273                         /* generate new unique RNA identifier from the ID name */
2274                         ntree_interface_identifier(ntree, base, identifier, sizeof(identifier), name, description);
2275                         
2276                         /* rename the RNA type */
2277                         RNA_def_struct_free_pointers(&BLENDER_RNA, srna);
2278                         RNA_def_struct_identifier(&BLENDER_RNA, srna, identifier);
2279                         RNA_def_struct_ui_text(srna, name, description);
2280                         RNA_def_struct_duplicate_pointers(&BLENDER_RNA, srna);
2281                 }
2282         }
2283         else if (create) {
2284                 ntree_interface_type_create(ntree);
2285         }
2286         
2287         return ntree->interface_type;
2288 }
2289
2290 void ntreeInterfaceTypeFree(bNodeTree *ntree)
2291 {
2292         if (ntree->interface_type) {
2293                 RNA_struct_free(&BLENDER_RNA, ntree->interface_type);
2294                 ntree->interface_type = NULL;
2295         }
2296 }
2297
2298 void ntreeInterfaceTypeUpdate(bNodeTree *ntree)
2299 {
2300         /* XXX it would be sufficient to just recreate all properties
2301          * instead of re-registering the whole struct type,
2302          * but there is currently no good way to do this in the RNA functions.
2303          * Overhead should be negligible.
2304          */
2305         ntreeInterfaceTypeFree(ntree);
2306         ntree_interface_type_create(ntree);
2307 }
2308
2309
2310 /* ************ find stuff *************** */
2311
2312 bNode *ntreeFindType(const bNodeTree *ntree, int type)
2313 {
2314         if (ntree) {
2315                 for (bNode * node = ntree->nodes.first; node; node = node->next) {
2316                         if (node->type == type) {
2317                                 return node;
2318                         }
2319                 }
2320         }
2321         return NULL;
2322 }
2323
2324 bool ntreeHasType(const bNodeTree *ntree, int type)
2325 {
2326         return ntreeFindType(ntree, type) != NULL;
2327 }
2328
2329 bool ntreeHasTree(const bNodeTree *ntree, const bNodeTree *lookup)
2330 {
2331         bNode *node;
2332
2333         if (ntree == lookup)
2334                 return true;
2335
2336         for (node = ntree->nodes.first; node; node = node->next)
2337                 if (node->type == NODE_GROUP && node->id)
2338                         if (ntreeHasTree((bNodeTree *)node->id, lookup))
2339                                 return true;
2340
2341         return false;
2342 }
2343
2344 bNodeLink *nodeFindLink(bNodeTree *ntree, bNodeSocket *from, bNodeSocket *to)
2345 {
2346         bNodeLink *link;
2347         
2348         for (link = ntree->links.first; link; link = link->next) {
2349                 if (link->fromsock == from && link->tosock == to)
2350                         return link;
2351                 if (link->fromsock == to && link->tosock == from) /* hrms? */
2352                         return link;
2353         }
2354         return NULL;
2355 }
2356
2357 int nodeCountSocketLinks(bNodeTree *ntree, bNodeSocket *sock)
2358 {
2359         bNodeLink *link;
2360         int tot = 0;
2361         
2362         for (link = ntree->links.first; link; link = link->next) {
2363                 if (link->fromsock == sock || link->tosock == sock)
2364                         tot++;
2365         }
2366         return tot;
2367 }
2368
2369 bNode *nodeGetActive(bNodeTree *ntree)
2370 {
2371         bNode *node;
2372         
2373         if (ntree == NULL) return NULL;
2374         
2375         for (node = ntree->nodes.first; node; node = node->next)
2376                 if (node->flag & NODE_ACTIVE)
2377                         break;
2378         return node;
2379 }
2380
2381 static bNode *node_get_active_id_recursive(bNodeInstanceKey active_key, bNodeInstanceKey parent_key, bNodeTree *ntree, short idtype)
2382 {
2383         if (parent_key.value == active_key.value || active_key.value == 0) {
2384                 bNode *node;
2385                 for (node = ntree->nodes.first; node; node = node->next)
2386                         if (node->id && GS(node->id->name) == idtype)
2387                                 if (node->flag & NODE_ACTIVE_ID)
2388                                         return node;
2389         }
2390         else {
2391                 bNode *node, *tnode;
2392                 /* no node with active ID in this tree, look inside groups */
2393                 for (node = ntree->nodes.first; node; node = node->next) {
2394                         if (node->type == NODE_GROUP) {
2395                                 bNodeTree *group = (bNodeTree *)node->id;
2396                                 if (group) {
2397                                         bNodeInstanceKey group_key = BKE_node_instance_key(parent_key, ntree, node);
2398                                         tnode = node_get_active_id_recursive(active_key, group_key, group, idtype);
2399                                         if (tnode)
2400                                                 return tnode;
2401                                 }
2402                         }
2403                 }
2404         }
2405         
2406         return NULL;
2407 }
2408
2409 /* two active flags, ID nodes have special flag for buttons display */
2410 bNode *nodeGetActiveID(bNodeTree *ntree, short idtype)
2411 {
2412         if (ntree)
2413                 return node_get_active_id_recursive(ntree->active_viewer_key, NODE_INSTANCE_KEY_BASE, ntree, idtype);
2414         else
2415                 return NULL;
2416 }
2417
2418 bool nodeSetActiveID(bNodeTree *ntree, short idtype, ID *id)
2419 {
2420         bNode *node;
2421         bool ok = false;
2422
2423         if (ntree == NULL) return ok;
2424
2425         for (node = ntree->nodes.first; node; node = node->next) {
2426                 if (node->id && GS(node->id->name) == idtype) {
2427                         if (id && ok == false && node->id == id) {
2428                                 node->flag |= NODE_ACTIVE_ID;
2429                                 ok = true;
2430                         }
2431                         else {
2432                                 node->flag &= ~NODE_ACTIVE_ID;
2433                         }
2434                 }
2435         }
2436
2437         /* update all groups linked from here
2438          * if active ID node has been found already,
2439          * just pass NULL so other matching nodes are deactivated.
2440          */
2441         for (node = ntree->nodes.first; node; node = node->next) {
2442                 if (node->type == NODE_GROUP)
2443                         ok |= nodeSetActiveID((bNodeTree *)node->id, idtype, (ok == false ? id : NULL));
2444         }
2445
2446         return ok;
2447 }
2448
2449
2450 /* two active flags, ID nodes have special flag for buttons display */
2451 void nodeClearActiveID(bNodeTree *ntree, short idtype)
2452 {
2453         bNode *node;
2454         
2455         if (ntree == NULL) return;
2456         
2457         for (node = ntree->nodes.first; node; node = node->next)
2458                 if (node->id && GS(node->id->name) == idtype)
2459                         node->flag &= ~NODE_ACTIVE_ID;
2460 }
2461
2462 void nodeSetSelected(bNode *node, bool select)
2463 {
2464         if (select) {
2465                 node->flag |= NODE_SELECT;
2466         }
2467         else {
2468                 bNodeSocket *sock;
2469                 
2470                 node->flag &= ~NODE_SELECT;
2471                 
2472                 /* deselect sockets too */
2473                 for (sock = node->inputs.first; sock; sock = sock->next)
2474                         sock->flag &= ~NODE_SELECT;
2475                 for (sock = node->outputs.first; sock; sock = sock->next)
2476                         sock->flag &= ~NODE_SELECT;
2477         }
2478 }
2479
2480 void nodeClearActive(bNodeTree *ntree)
2481 {
2482         bNode *node;
2483
2484         if (ntree == NULL) return;
2485
2486         for (node = ntree->nodes.first; node; node = node->next)
2487                 node->flag &= ~(NODE_ACTIVE | NODE_ACTIVE_ID);
2488 }
2489
2490 /* two active flags, ID nodes have special flag for buttons display */
2491 void nodeSetActive(bNodeTree *ntree, bNode *node)
2492 {
2493         bNode *tnode;
2494         
2495         /* make sure only one node is active, and only one per ID type */
2496         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
2497                 tnode->flag &= ~NODE_ACTIVE;
2498                 
2499                 if (node->id && tnode->id) {
2500                         if (GS(node->id->name) == GS(tnode->id->name))
2501                                 tnode->flag &= ~NODE_ACTIVE_ID;
2502                 }
2503                 if (node->typeinfo->nclass == NODE_CLASS_TEXTURE)
2504                         tnode->flag &= ~NODE_ACTIVE_TEXTURE;
2505         }
2506         
2507         node->flag |= NODE_ACTIVE;
2508         if (node->id)
2509                 node->flag |= NODE_ACTIVE_ID;
2510         if (node->typeinfo->nclass == NODE_CLASS_TEXTURE)
2511                 node->flag |= NODE_ACTIVE_TEXTURE;
2512 }
2513
2514 int nodeSocketIsHidden(bNodeSocket *sock)
2515 {
2516         return ((sock->flag & (SOCK_HIDDEN | SOCK_UNAVAIL)) != 0);
2517 }
2518
2519 /* ************** Node Clipboard *********** */
2520
2521 #define USE_NODE_CB_VALIDATE
2522
2523 #ifdef USE_NODE_CB_VALIDATE
2524 /**
2525  * This data structure is to validate the node on creation,
2526  * otherwise we may reference missing data.
2527  *
2528  * Currently its only used for ID's, but nodes may one day
2529  * reference other pointers which need validation.
2530  */
2531 typedef struct bNodeClipboardExtraInfo {
2532         struct bNodeClipboardExtraInfo *next, *prev;
2533         ID  *id;
2534         char id_name[MAX_ID_NAME];
2535         char library_name[FILE_MAX];
2536 } bNodeClipboardExtraInfo;
2537 #endif  /* USE_NODE_CB_VALIDATE */
2538
2539
2540 typedef struct bNodeClipboard {
2541         ListBase nodes;
2542
2543 #ifdef USE_NODE_CB_VALIDATE
2544         ListBase nodes_extra_info;
2545 #endif
2546
2547         ListBase links;
2548         int type;
2549 } bNodeClipboard;
2550
2551 static bNodeClipboard node_clipboard = {{NULL}};
2552
2553 void BKE_node_clipboard_init(struct bNodeTree *ntree)
2554 {
2555         node_clipboard.type = ntree->type;
2556 }
2557
2558 void BKE_node_clipboard_clear(void)
2559 {
2560         bNode *node, *node_next;
2561         bNodeLink *link, *link_next;
2562         
2563         for (link = node_clipboard.links.first; link; link = link_next) {
2564                 link_next = link->next;
2565                 nodeRemLink(NULL, link);
2566         }
2567         BLI_listbase_clear(&node_clipboard.links);
2568         
2569         for (node = node_clipboard.nodes.first; node; node = node_next) {
2570                 node_next = node->next;
2571                 node_free_node_ex(NULL, node, false, false);
2572         }
2573         BLI_listbase_clear(&node_clipboard.nodes);
2574
2575 #ifdef USE_NODE_CB_VALIDATE
2576         BLI_freelistN(&node_clipboard.nodes_extra_info);
2577 #endif
2578 }
2579
2580 /* return false when one or more ID's are lost */
2581 bool BKE_node_clipboard_validate(void)
2582 {
2583         bool ok = true;
2584
2585 #ifdef USE_NODE_CB_VALIDATE
2586         bNodeClipboardExtraInfo *node_info;
2587         bNode *node;
2588
2589
2590         /* lists must be aligned */
2591         BLI_assert(BLI_listbase_count(&node_clipboard.nodes) ==
2592                    BLI_listbase_count(&node_clipboard.nodes_extra_info));
2593
2594         for (node = node_clipboard.nodes.first, node_info = node_clipboard.nodes_extra_info.first;
2595              node;
2596              node = node->next, node_info = node_info->next)
2597         {
2598                 /* validate the node against the stored node info */
2599
2600                 /* re-assign each loop since we may clear,
2601                  * open a new file where the ID is valid, and paste again */
2602                 node->id = node_info->id;
2603
2604                 /* currently only validate the ID */
2605                 if (node->id) {
2606                         ListBase *lb = which_libbase(G.main, GS(node_info->id_name));
2607                         BLI_assert(lb != NULL);
2608
2609                         if (BLI_findindex(lb, node_info->id) == -1) {
2610                                 /* may assign NULL */
2611                                 node->id = BLI_findstring(lb, node_info->id_name + 2, offsetof(ID, name) + 2);
2612
2613                                 if (node->id == NULL) {
2614                                         ok = false;
2615                                 }
2616                         }
2617                 }
2618         }
2619 #endif  /* USE_NODE_CB_VALIDATE */
2620
2621         return ok;
2622 }
2623
2624 void BKE_node_clipboard_add_node(bNode *node)
2625 {
2626 #ifdef USE_NODE_CB_VALIDATE
2627         /* add extra info */
2628         bNodeClipboardExtraInfo *node_info = MEM_mallocN(sizeof(bNodeClipboardExtraInfo), "bNodeClipboardExtraInfo");
2629
2630         node_info->id = node->id;
2631         if (node->id) {
2632                 BLI_strncpy(node_info->id_name, node->id->name, sizeof(node_info->id_name));
2633                 if (ID_IS_LINKED(node->id)) {
2634                         BLI_strncpy(node_info->library_name, node->id->lib->filepath, sizeof(node_info->library_name));
2635                 }
2636                 else {
2637                         node_info->library_name[0] = '\0';
2638                 }
2639         }
2640         else {
2641                 node_info->id_name[0] = '\0';
2642                 node_info->library_name[0] = '\0';
2643         }
2644         BLI_addtail(&node_clipboard.nodes_extra_info, node_info);
2645         /* end extra info */
2646 #endif  /* USE_NODE_CB_VALIDATE */
2647
2648         /* add node */
2649         BLI_addtail(&node_clipboard.nodes, node);
2650
2651 }
2652
2653 void BKE_node_clipboard_add_link(bNodeLink *link)
2654 {
2655         BLI_addtail(&node_clipboard.links, link);
2656 }
2657
2658 const ListBase *BKE_node_clipboard_get_nodes(void)
2659 {
2660         return &node_clipboard.nodes;
2661 }
2662
2663 const ListBase *BKE_node_clipboard_get_links(void)
2664 {
2665         return &node_clipboard.links;
2666 }
2667
2668 int BKE_node_clipboard_get_type(void)
2669 {
2670         return node_clipboard.type;
2671 }
2672
2673
2674 /* Node Instance Hash */
2675
2676 /* magic number for initial hash key */
2677 const bNodeInstanceKey NODE_INSTANCE_KEY_BASE = {5381};
2678 const bNodeInstanceKey NODE_INSTANCE_KEY_NONE = {0};
2679
2680 /* Generate a hash key from ntree and node names
2681  * Uses the djb2 algorithm with xor by Bernstein:
2682  * http://www.cse.yorku.ca/~oz/hash.html
2683  */
2684 static bNodeInstanceKey node_hash_int_str(bNodeInstanceKey hash, const char *str)
2685 {
2686         char c;
2687         
2688         while ((c = *str++))
2689                 hash.value = ((hash.value << 5) + hash.value) ^ c; /* (hash * 33) ^ c */
2690         
2691         /* separator '\0' character, to avoid ambiguity from concatenated strings */
2692         hash.value = (hash.value << 5) + hash.value; /* hash * 33 */
2693         
2694         return hash;
2695 }
2696
2697 bNodeInstanceKey BKE_node_instance_key(bNodeInstanceKey parent_key, bNodeTree *ntree, bNode *node)
2698 {
2699         bNodeInstanceKey key;
2700         
2701         key = node_hash_int_str(parent_key, ntree->id.name + 2);
2702         
2703         if (node)
2704                 key = node_hash_int_str(key, node->name);
2705         
2706         return key;
2707 }
2708
2709 static unsigned int node_instance_hash_key(const void *key)
2710 {
2711         return ((const bNodeInstanceKey *)key)->value;
2712 }
2713
2714 static bool node_instance_hash_key_cmp(const void *a, const void *b)
2715 {
2716         unsigned int value_a = ((const bNodeInstanceKey *)a)->value;
2717         unsigned int value_b = ((const bNodeInstanceKey *)b)->value;
2718
2719         return (value_a != value_b);
2720 }
2721
2722 bNodeInstanceHash *BKE_node_instance_hash_new(const char *info)
2723 {
2724         bNodeInstanceHash *hash = MEM_mallocN(sizeof(bNodeInstanceHash), info);
2725         hash->ghash = BLI_ghash_new(node_instance_hash_key, node_instance_hash_key_cmp, "node instance hash ghash");
2726         return hash;
2727 }
2728
2729 void BKE_node_instance_hash_free(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2730 {
2731         BLI_ghash_free(hash->ghash, NULL, (GHashValFreeFP)valfreefp);
2732         MEM_freeN(hash);
2733 }
2734
2735 void BKE_node_instance_hash_insert(bNodeInstanceHash *hash, bNodeInstanceKey key, void *value)
2736 {
2737         bNodeInstanceHashEntry *entry = value;
2738         entry->key = key;
2739         entry->tag = 0;
2740         BLI_ghash_insert(hash->ghash, &entry->key, value);
2741 }
2742
2743 void *BKE_node_instance_hash_lookup(bNodeInstanceHash *hash, bNodeInstanceKey key)
2744 {
2745         return BLI_ghash_lookup(hash->ghash, &key);
2746 }
2747
2748 int BKE_node_instance_hash_remove(bNodeInstanceHash *hash, bNodeInstanceKey key, bNodeInstanceValueFP valfreefp)
2749 {
2750         return BLI_ghash_remove(hash->ghash, &key, NULL, (GHashValFreeFP)valfreefp);
2751 }
2752
2753 void BKE_node_instance_hash_clear(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2754 {
2755         BLI_ghash_clear(hash->ghash, NULL, (GHashValFreeFP)valfreefp);
2756 }
2757
2758 void *BKE_node_instance_hash_pop(bNodeInstanceHash *hash, bNodeInstanceKey key)
2759 {
2760         return BLI_ghash_popkey(hash->ghash, &key, NULL);
2761 }
2762
2763 int BKE_node_instance_hash_haskey(bNodeInstanceHash *hash, bNodeInstanceKey key)
2764 {
2765         return BLI_ghash_haskey(hash->ghash, &key);
2766 }
2767
2768 int BKE_node_instance_hash_size(bNodeInstanceHash *hash)
2769 {
2770         return BLI_ghash_len(hash->ghash);
2771 }
2772
2773 void BKE_node_instance_hash_clear_tags(bNodeInstanceHash *hash)
2774 {
2775         bNodeInstanceHashIterator iter;
2776         
2777         NODE_INSTANCE_HASH_ITER(iter, hash) {
2778                 bNodeInstanceHashEntry *value = BKE_node_instance_hash_iterator_get_value(&iter);
2779                 
2780                 value->tag = 0;
2781         }
2782 }
2783
2784 void BKE_node_instance_hash_tag(bNodeInstanceHash *UNUSED(hash), void *value)
2785 {
2786         bNodeInstanceHashEntry *entry = value;
2787         entry->tag = 1;
2788 }
2789
2790 bool BKE_node_instance_hash_tag_key(bNodeInstanceHash *hash, bNodeInstanceKey key)
2791 {
2792         bNodeInstanceHashEntry *entry = BKE_node_instance_hash_lookup(hash, key);
2793         
2794         if (entry) {
2795                 entry->tag = 1;
2796                 return true;
2797         }
2798         else
2799                 return false;
2800 }
2801
2802 void BKE_node_instance_hash_remove_untagged(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2803 {
2804         /* NOTE: Hash must not be mutated during iterating!
2805          * Store tagged entries in a separate list and remove items afterward.
2806          */
2807         bNodeInstanceKey *untagged = MEM_mallocN(sizeof(bNodeInstanceKey) * BKE_node_instance_hash_size(hash), "temporary node instance key list");
2808         bNodeInstanceHashIterator iter;
2809         int num_untagged, i;
2810         
2811         num_untagged = 0;
2812         NODE_INSTANCE_HASH_ITER(iter, hash) {
2813                 bNodeInstanceHashEntry *value = BKE_node_instance_hash_iterator_get_value(&iter);
2814                 
2815                 if (!value->tag)
2816                         untagged[num_untagged++] = BKE_node_instance_hash_iterator_get_key(&iter);
2817         }
2818         
2819         for (i = 0; i < num_untagged; ++i) {
2820                 BKE_node_instance_hash_remove(hash, untagged[i], valfreefp);
2821         }
2822         
2823         MEM_freeN(untagged);
2824 }
2825
2826
2827 /* ************** dependency stuff *********** */
2828
2829 /* node is guaranteed to be not checked before */
2830 static int node_get_deplist_recurs(bNodeTree *ntree, bNode *node, bNode ***nsort)
2831 {
2832         bNode *fromnode;
2833         bNodeLink *link;
2834         int level = 0xFFF;
2835         
2836         node->done = true;
2837         
2838         /* check linked nodes */
2839         for (link = ntree->links.first; link; link = link->next) {
2840                 if (link->tonode == node) {
2841                         fromnode = link->fromnode;
2842                         if (fromnode->done == 0)
2843                                 fromnode->level = node_get_deplist_recurs(ntree, fromnode, nsort);
2844                         if (fromnode->level <= level)
2845                                 level = fromnode->level - 1;
2846                 }
2847         }
2848         
2849         /* check parent node */
2850         if (node->parent) {
2851                 if (node->parent->done == 0)
2852                         node->parent->level = node_get_deplist_recurs(ntree, node->parent, nsort);
2853                 if (node->parent->level <= level)
2854                         level = node->parent->level - 1;
2855         }
2856         
2857         if (nsort) {
2858                 **nsort = node;
2859                 (*nsort)++;
2860         }
2861         
2862         return level;
2863 }
2864
2865 void ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes)
2866 {
2867         bNode *node, **nsort;
2868         
2869         *totnodes = 0;
2870         
2871         /* first clear data */
2872         for (node = ntree->nodes.first; node; node = node->next) {
2873                 node->done = false;
2874                 (*totnodes)++;
2875         }
2876         if (*totnodes == 0) {
2877                 *deplist = NULL;
2878                 return;
2879         }
2880         
2881         nsort = *deplist = MEM_callocN((*totnodes) * sizeof(bNode *), "sorted node array");
2882         
2883         /* recursive check */
2884         for (node = ntree->nodes.first; node; node = node->next) {
2885                 if (node->done == 0) {
2886                         node->level = node_get_deplist_recurs(ntree, node, &nsort);
2887                 }
2888         }
2889 }
2890
2891 /* only updates node->level for detecting cycles links */
2892 static void ntree_update_node_level(bNodeTree *ntree)
2893 {
2894         bNode *node;
2895         
2896         /* first clear tag */
2897         for (node = ntree->nodes.first; node; node = node->next) {
2898                 node->done = false;
2899         }
2900         
2901         /* recursive check */
2902         for (node = ntree->nodes.first; node; node = node->next) {
2903                 if (node->done == 0) {
2904                         node->level = node_get_deplist_recurs(ntree, node, NULL);
2905                 }
2906         }
2907 }
2908
2909 void ntreeTagUsedSockets(bNodeTree *ntree)
2910 {
2911         bNode *node;
2912         bNodeSocket *sock;
2913         bNodeLink *link;
2914         
2915         /* first clear data */
2916         for (node = ntree->nodes.first; node; node = node->next) {
2917                 for (sock = node->inputs.first; sock; sock = sock->next) {
2918                         sock->flag &= ~SOCK_IN_USE;
2919                 }
2920                 for (sock = node->outputs.first; sock; sock = sock->next) {
2921                         sock->flag &= ~SOCK_IN_USE;
2922                 }
2923         }
2924         
2925         for (link = ntree->links.first; link; link = link->next) {
2926                 /* link is unused if either side is disabled */
2927                 if ((link->fromsock->flag & SOCK_UNAVAIL) || (link->tosock->flag & SOCK_UNAVAIL))
2928                         continue;
2929                 
2930                 link->fromsock->flag |= SOCK_IN_USE;
2931                 link->tosock->flag |= SOCK_IN_USE;
2932         }
2933 }
2934
2935 static void ntree_update_link_pointers(bNodeTree *ntree)
2936 {
2937         bNode *node;
2938         bNodeSocket *sock;
2939         bNodeLink *link;
2940         
2941         /* first clear data */
2942         for (node = ntree->nodes.first; node; node = node->next) {
2943                 for (sock = node->inputs.first; sock; sock = sock->next) {
2944                         sock->link = NULL;
2945                 }
2946         }
2947
2948         for (link = ntree->links.first; link; link = link->next) {
2949                 link->tosock->link = link;
2950         }
2951         
2952         ntreeTagUsedSockets(ntree);
2953 }
2954
2955 static void ntree_validate_links(bNodeTree *ntree)
2956 {
2957         bNodeLink *link;
2958         
2959         for (link = ntree->links.first; link; link = link->next) {
2960                 link->flag |= NODE_LINK_VALID;
2961                 if (link->fromnode && link->tonode && link->fromnode->level <= link->tonode->level)
2962                         link->flag &= ~NODE_LINK_VALID;
2963                 else if (ntree->typeinfo->validate_link) {
2964                         if (!ntree->typeinfo->validate_link(ntree, link))
2965                                 link->flag &= ~NODE_LINK_VALID;
2966                 }
2967         }
2968 }
2969
2970 void ntreeVerifyNodes(struct Main *main, struct ID *id)
2971 {
2972         FOREACH_NODETREE(main, ntree, owner_id) {
2973                 bNode *node;
2974                 
2975                 for (node = ntree->nodes.first; node; node = node->next)
2976                         if (node->typeinfo->verifyfunc)
2977                                 node->typeinfo->verifyfunc(ntree, node, id);
2978         } FOREACH_NODETREE_END
2979 }
2980
2981 void ntreeUpdateTree(Main *bmain, bNodeTree *ntree)
2982 {
2983         bNode *node;
2984         
2985         if (!ntree)
2986                 return;
2987         
2988         /* avoid reentrant updates, can be caused by RNA update callbacks */
2989         if (ntree->is_updating)
2990                 return;
2991         ntree->is_updating = true;
2992         
2993         if (ntree->update & (NTREE_UPDATE_LINKS | NTREE_UPDATE_NODES)) {
2994                 /* set the bNodeSocket->link pointers */
2995                 ntree_update_link_pointers(ntree);
2996         }
2997         
2998         /* update individual nodes */
2999         for (node = ntree->nodes.first; node; node = node->next) {
3000                 /* node tree update tags override individual node update flags */
3001                 if ((node->update & NODE_UPDATE) || (ntree->update & NTREE_UPDATE)) {
3002                         if (node->typeinfo->updatefunc)
3003                                 node->typeinfo->updatefunc(ntree, node);
3004                         
3005                         nodeUpdateInternalLinks(ntree, node);
3006                 }
3007         }
3008         
3009         /* generic tree update callback */
3010         if (ntree->typeinfo->update)
3011                 ntree->typeinfo->update(ntree);
3012         /* XXX this should be moved into the tree type update callback for tree supporting node groups.
3013          * Currently the node tree interface is still a generic feature of the base NodeTree type.
3014          */
3015         if (ntree->update & NTREE_UPDATE_GROUP)
3016                 ntreeInterfaceTypeUpdate(ntree);
3017         
3018         /* XXX hack, should be done by depsgraph!! */
3019         if (bmain)
3020                 ntreeVerifyNodes(bmain, &ntree->id);
3021         
3022         if (ntree->update & (NTREE_UPDATE_LINKS | NTREE_UPDATE_NODES)) {
3023                 /* node updates can change sockets or links, repeat link pointer update afterward */
3024                 ntree_update_link_pointers(ntree);
3025                 
3026                 /* update the node level from link dependencies */
3027                 ntree_update_node_level(ntree);
3028                 
3029                 /* check link validity */
3030                 ntree_validate_links(ntree);
3031         }
3032         
3033         /* clear update flags */
3034         for (node = ntree->nodes.first; node; node = node->next) {
3035                 node->update = 0;
3036         }
3037         ntree->update = 0;
3038         
3039         ntree->is_updating = false;
3040 }
3041
3042 void nodeUpdate(bNodeTree *ntree, bNode *node)
3043 {
3044         /* avoid reentrant updates, can be caused by RNA update callbacks */
3045         if (ntree->is_updating)
3046                 return;
3047         ntree->is_updating = true;
3048         
3049         if (node->typeinfo->updatefunc)
3050                 node->typeinfo->updatefunc(ntree, node);
3051         
3052         nodeUpdateInternalLinks(ntree, node);
3053         
3054         /* clear update flag */
3055         node->update = 0;
3056         
3057         ntree->is_updating = false;
3058 }
3059
3060 bool nodeUpdateID(bNodeTree *ntree, ID *id)
3061 {
3062         bNode *node;
3063         bool changed = false;
3064         
3065         if (ELEM(NULL, id, ntree))
3066                 return changed;
3067         
3068         /* avoid reentrant updates, can be caused by RNA update callbacks */
3069         if (ntree->is_updating)
3070                 return changed;
3071         ntree->is_updating = true;
3072         
3073         for (node = ntree->nodes.first; node; node = node->next) {
3074                 if (node->id == id) {
3075                         changed = true;
3076                         node->update |= NODE_UPDATE_ID;
3077                         if (node->typeinfo->updatefunc)
3078                                 node->typeinfo->updatefunc(ntree, node);
3079                         /* clear update flag */
3080                         node->update = 0;
3081                 }
3082         }
3083         
3084         for (node = ntree->nodes.first; node; node = node->next) {
3085                 nodeUpdateInternalLinks(ntree, node);
3086         }
3087         
3088         ntree->is_updating = false;
3089         return changed;
3090 }
3091
3092 void nodeUpdateInternalLinks(bNodeTree *ntree, bNode *node)
3093 {
3094         BLI_freelistN(&node->internal_links);
3095         
3096         if (node->typeinfo && node->typeinfo->update_internal_links)
3097                 node->typeinfo->update_internal_links(ntree, node);
3098 }
3099
3100
3101 /* ************* node type access ********** */
3102
3103 void nodeLabel(bNodeTree *ntree, bNode *node, char *label, int maxlen)
3104 {
3105         label[0] = '\0';
3106
3107         if (node->label[0] != '\0') {
3108                 BLI_strncpy(label, node->label, maxlen);
3109         }
3110         else if (node->typeinfo->labelfunc) {
3111                 node->typeinfo->labelfunc(ntree, node, label, maxlen);
3112         }
3113
3114         /* The previous methods (labelfunc) could not provide an adequate label for the node. */
3115         if (label[0] == '\0') {
3116                 /* Kind of hacky and weak... Ideally would be better to use RNA here. :| */
3117                 const char *tmp = CTX_IFACE_(BLT_I18NCONTEXT_ID_NODETREE, node->typeinfo->ui_name);
3118                 if (tmp == node->typeinfo->ui_name) {
3119                         tmp = IFACE_(node->typeinfo->ui_name);
3120                 }
3121                 BLI_strncpy(label, tmp, maxlen);
3122         }
3123 }
3124
3125 static void node_type_base_defaults(bNodeType *ntype)
3126 {
3127         /* default size values */
3128         node_type_size_preset(ntype, NODE_SIZE_DEFAULT);
3129         ntype->height = 100;
3130         ntype->minheight = 30;
3131         ntype->maxheight = FLT_MAX;
3132 }
3133
3134 /* allow this node for any tree type */
3135 static int node_poll_default(bNodeType *UNUSED(ntype), bNodeTree *UNUSED(ntree))
3136 {
3137         return true;
3138 }
3139
3140 /* use the basic poll function */
3141 static int node_poll_instance_default(bNode *node, bNodeTree *ntree)
3142 {
3143         return node->typeinfo->poll(node->typeinfo, ntree);
3144 }
3145
3146 void node_type_base(bNodeType *ntype, int type, const char *name, short nclass, short flag)
3147 {
3148         /* Use static type info header to map static int type to identifier string and RNA struct type.
3149          * Associate the RNA struct type with the bNodeType.
3150          * Dynamically registered nodes will create an RNA type at runtime
3151          * and call RNA_struct_blender_type_set, so this only needs to be done for old RNA types
3152          * created in makesrna, which can not be associated to a bNodeType immediately,
3153          * since bNodeTypes are registered afterward ...
3154          */
3155 #define DefNode(Category, ID, DefFunc, EnumName, StructName, UIName, UIDesc) \
3156                 case ID: \
3157                         BLI_strncpy(ntype->idname, #Category #StructName, sizeof(ntype->idname)); \
3158                         ntype->ext.srna = RNA_struct_find(#Category #StructName); \
3159                         BLI_assert(ntype->ext.srna != NULL); \
3160                         RNA_struct_blender_type_set(ntype->ext.srna, ntype); \
3161                         break;
3162         
3163         switch (type) {
3164 #include "NOD_static_types.h"
3165         }
3166         
3167         /* make sure we have a valid type (everything registered) */
3168         BLI_assert(ntype->idname[0] != '\0');
3169         
3170         ntype->type = type;
3171         BLI_strncpy(ntype->ui_name, name, sizeof(ntype->ui_name));
3172         ntype->nclass = nclass;
3173         ntype->flag = flag;
3174
3175         node_type_base_defaults(ntype);
3176
3177         ntype->poll = node_poll_default;
3178         ntype->poll_instance = node_poll_instance_default;
3179 }
3180
3181 void node_type_base_custom(bNodeType *ntype, const char *idname, const char *name, short nclass, short flag)
3182 {
3183         BLI_strncpy(ntype->idname, idname, sizeof(ntype->idname));
3184         ntype->type = NODE_CUSTOM;
3185         BLI_strncpy(ntype->ui_name, name, sizeof(ntype->ui_name));
3186         ntype->nclass = nclass;
3187         ntype->flag = flag;
3188
3189         node_type_base_defaults(ntype);
3190 }
3191
3192 static bool unique_socket_template_identifier_check(void *arg, const char *name)
3193 {
3194         bNodeSocketTemplate *ntemp;
3195         struct {bNodeSocketTemplate *list; bNodeSocketTemplate *ntemp;} *data = arg;
3196         
3197         for (ntemp = data->list; ntemp->type >= 0; ++ntemp) {
3198                 if (ntemp != data->ntemp) {
3199                         if (STREQ(ntemp->identifier, name)) {
3200                                 return true;
3201                         }
3202                 }
3203         }
3204         
3205         return false;
3206 }
3207
3208 static void unique_socket_template_identifier(bNodeSocketTemplate *list, bNodeSocketTemplate *ntemp, const char defname[], char delim)
3209 {
3210         struct {bNodeSocketTemplate *list; bNodeSocketTemplate *ntemp;} data;
3211         data.list = list;
3212         data.ntemp = ntemp;
3213
3214         BLI_uniquename_cb(unique_socket_template_identifier_check, &data, defname, delim, ntemp->identifier, sizeof(ntemp->identifier));
3215 }
3216
3217 void node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs)
3218 {
3219         bNodeSocketTemplate *ntemp;
3220         
3221         ntype->inputs = inputs;
3222         ntype->outputs = outputs;
3223         
3224         /* automatically generate unique identifiers */
3225         if (inputs) {
3226                 /* clear identifier strings (uninitialized memory) */
3227                 for (ntemp = inputs; ntemp->type >= 0; ++ntemp)
3228                         ntemp->identifier[0] = '\0';
3229                 
3230                 for (ntemp = inputs; ntemp->type >= 0; ++ntemp) {
3231                         BLI_strncpy(ntemp->identifier, ntemp->name, sizeof(ntemp->identifier));
3232                         unique_socket_template_identifier(inputs, ntemp, ntemp->identifier, '_');
3233                 }
3234         }
3235         if (outputs) {
3236                 /* clear identifier strings (uninitialized memory) */
3237                 for (ntemp = outputs; ntemp->type >= 0; ++ntemp)
3238                         ntemp->identifier[0] = '\0';
3239                 
3240                 for (ntemp = outputs; ntemp->type >= 0; ++ntemp) {
3241                         BLI_strncpy(ntemp->identifier, ntemp->name, sizeof(ntemp->identifier));
3242                         unique_socket_template_identifier(outputs, ntemp, ntemp->identifier, '_');
3243                 }
3244         }
3245 }
3246
3247 void node_type_init(struct bNodeType *ntype, void (*initfunc)(struct bNodeTree *ntree, struct bNode *node))
3248 {
3249         ntype->initfunc = initfunc;
3250 }
3251
3252 void node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth)
3253 {
3254         ntype->width = width;
3255         ntype->minwidth = minwidth;
3256         if (maxwidth <= minwidth)
3257                 ntype->maxwidth = FLT_MAX;
3258         else
3259                 ntype->maxwidth = maxwidth;
3260 }
3261
3262 void node_type_size_preset(struct bNodeType *ntype, eNodeSizePreset size)
3263 {
3264         switch (size) {
3265                 case NODE_SIZE_DEFAULT:
3266                         node_type_size(ntype, 140, 100, NODE_DEFAULT_MAX_WIDTH);
3267                         break;
3268                 case NODE_SIZE_SMALL:
3269                         node_type_size(ntype, 100, 80, NODE_DEFAULT_MAX_WIDTH);
3270                         break;
3271                 case NODE_SIZE_MIDDLE:
3272                         node_type_size(ntype, 150, 120, NODE_DEFAULT_MAX_WIDTH);
3273                         break;
3274                 case NODE_SIZE_LARGE:
3275                         node_type_size(ntype, 240, 140, NODE_DEFAULT_MAX_WIDTH);
3276                         break;
3277         }
3278 }
3279
3280 /**
3281  * \warning Nodes defining a storage type _must_ allocate this for new nodes.
3282  * Otherwise nodes will reload as undefined (T46619).
3283  */
3284 void node_type_storage(bNodeType *ntype,
3285         const char *storagename,
3286         void (*freefunc)(struct bNode *node),
3287         void (*copyfunc)(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node))
3288 {
3289         if (storagename)
3290                 BLI_strncpy(ntype->storagename, storagename, sizeof(ntype->storagename));
3291         else
3292                 ntype->storagename[0] = '\0';
3293         ntype->copyfunc = copyfunc;
3294         ntype->freefunc = freefunc;
3295 }
3296
3297 void node_type_label(struct bNodeType *ntype, void (*labelfunc)(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen))
3298 {
3299         ntype->labelfunc = labelfunc;
3300 }
3301
3302 void node_type_update(struct bNodeType *ntype,
3303                       void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node),
3304                       void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id))
3305 {
3306         ntype->updatefunc = updatefunc;
3307         ntype->verifyfunc = verifyfunc;
3308 }
3309
3310 void node_type_exec(struct bNodeType *ntype, NodeInitExecFunction initexecfunc, NodeFreeExecFunction freeexecfunc, NodeExecFunction execfunc)
3311 {
3312         ntype->initexecfunc = initexecfunc;
3313         ntype->freeexecfunc = freeexecfunc;
3314         ntype->execfunc = execfunc;
3315 }
3316
3317 void node_type_gpu(struct bNodeType *ntype, NodeGPUExecFunction gpufunc)
3318 {
3319         ntype->gpufunc = gpufunc;
3320 }
3321
3322 void node_type_internal_links(bNodeType *ntype, void (*update_internal_links)(bNodeTree *, bNode *))
3323 {
3324         ntype->update_internal_links = update_internal_links;
3325 }
3326
3327 void node_type_compatibility(struct bNodeType *ntype, short compatibility)
3328 {
3329         ntype->compatibility = compatibility;
3330 }
3331
3332 /* callbacks for undefined types */
3333
3334 static int node_undefined_poll(bNodeType *UNUSED(ntype), bNodeTree *UNUSED(nodetree))
3335 {
3336         /* this type can not be added deliberately, it's just a placeholder */
3337         return false;
3338 }
3339
3340 /* register fallback types used for undefined tree, nodes, sockets */
3341 static void register_undefined_types(void)
3342 {
3343         /* Note: these types are not registered in the type hashes,