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