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