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(struct bNodeTree *ntree, struct 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(bNodeTree *ntree, Main *bmain, bool skip_database, bool do_id_user, bool do_make_extern, bool copy_previews)
1204 {
1205         bNodeTree *newtree;
1206         bNode *node /*, *nnode */ /* UNUSED */, *last;
1207         bNodeSocket *sock, *oldsock;
1208         bNodeLink *link;
1209         
1210         if (ntree == NULL) return NULL;
1211         
1212         /* is ntree part of library? */
1213         if (bmain && !skip_database && BLI_findindex(&bmain->nodetree, ntree) >= 0) {
1214                 newtree = BKE_libblock_copy(bmain, &ntree->id);
1215         }
1216         else {
1217                 newtree = BKE_libblock_copy_nolib(&ntree->id, true);
1218         }
1219
1220         id_us_plus((ID *)newtree->gpd);
1221
1222         /* in case a running nodetree is copied */
1223         newtree->execdata = NULL;
1224
1225         newtree->duplilock = NULL;
1226         
1227         BLI_listbase_clear(&newtree->nodes);
1228         BLI_listbase_clear(&newtree->links);
1229         
1230         last = ntree->nodes.last;
1231         for (node = ntree->nodes.first; node; node = node->next) {
1232
1233                 /* ntreeUserDecrefID inline */
1234                 if (do_id_user) {
1235                         id_us_plus(node->id);
1236                 }
1237
1238                 if (do_make_extern) {
1239                         id_lib_extern(node->id);
1240                 }
1241
1242                 node->new_node = NULL;
1243                 /* nnode = */ nodeCopyNode(newtree, node);   /* sets node->new */
1244                 
1245                 /* make sure we don't copy new nodes again! */
1246                 if (node == last)
1247                         break;
1248         }
1249         
1250         /* copy links */
1251         BLI_duplicatelist(&newtree->links, &ntree->links);
1252         for (link = newtree->links.first; link; link = link->next) {
1253                 link->fromnode = (link->fromnode ? link->fromnode->new_node : NULL);
1254                 link->fromsock = (link->fromsock ? link->fromsock->new_sock : NULL);
1255                 link->tonode = (link->tonode ? link->tonode->new_node : NULL);
1256                 link->tosock = (link->tosock ? link->tosock->new_sock : NULL);
1257                 /* update the link socket's pointer */
1258                 if (link->tosock)
1259                         link->tosock->link = link;
1260         }
1261         
1262         /* copy interface sockets */
1263         BLI_duplicatelist(&newtree->inputs, &ntree->inputs);
1264         oldsock = ntree->inputs.first;
1265         for (sock = newtree->inputs.first; sock; sock = sock->next, oldsock = oldsock->next)
1266                 node_socket_copy(sock, oldsock);
1267         
1268         BLI_duplicatelist(&newtree->outputs, &ntree->outputs);
1269         oldsock = ntree->outputs.first;
1270         for (sock = newtree->outputs.first; sock; sock = sock->next, oldsock = oldsock->next)
1271                 node_socket_copy(sock, oldsock);
1272         
1273         /* copy preview hash */
1274         if (ntree->previews && copy_previews) {
1275                 bNodeInstanceHashIterator iter;
1276                 
1277                 newtree->previews = BKE_node_instance_hash_new("node previews");
1278                 
1279                 NODE_INSTANCE_HASH_ITER(iter, ntree->previews) {
1280                         bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1281                         bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1282                         BKE_node_instance_hash_insert(newtree->previews, key, BKE_node_preview_copy(preview));
1283                 }
1284         }
1285         else
1286                 newtree->previews = NULL;
1287         
1288         /* update node->parent pointers */
1289         for (node = newtree->nodes.first; node; node = node->next) {
1290                 if (node->parent)
1291                         node->parent = node->parent->new_node;
1292         }
1293         
1294         /* node tree will generate its own interface type */
1295         newtree->interface_type = NULL;
1296         
1297         BKE_id_copy_ensure_local(bmain, &ntree->id, &newtree->id);
1298
1299         return newtree;
1300 }
1301
1302 bNodeTree *ntreeCopyTree_ex(bNodeTree *ntree, Main *bmain, const bool do_id_user)
1303 {
1304         return ntreeCopyTree_internal(ntree, bmain, false, do_id_user, true, true);
1305 }
1306 bNodeTree *ntreeCopyTree(Main *bmain, bNodeTree *ntree)
1307 {
1308         return ntreeCopyTree_ex(ntree, bmain, true);
1309 }
1310
1311 void ntreeUserIncrefID(bNodeTree *ntree)
1312 {
1313         bNode *node;
1314         for (node = ntree->nodes.first; node; node = node->next) {
1315                 id_us_plus(node->id);
1316         }
1317 }
1318 void ntreeUserDecrefID(bNodeTree *ntree)
1319 {
1320         bNode *node;
1321         for (node = ntree->nodes.first; node; node = node->next) {
1322                 id_us_min(node->id);
1323         }
1324 }
1325
1326 /* *************** Node Preview *********** */
1327
1328 /* XXX this should be removed eventually ...
1329  * Currently BKE functions are modelled closely on previous code,
1330  * using BKE_node_preview_init_tree to set up previews for a whole node tree in advance.
1331  * This should be left more to the individual node tree implementations.
1332  */
1333 int BKE_node_preview_used(bNode *node)
1334 {
1335         /* XXX check for closed nodes? */
1336         return (node->typeinfo->flag & NODE_PREVIEW) != 0;
1337 }
1338
1339 bNodePreview *BKE_node_preview_verify(bNodeInstanceHash *previews, bNodeInstanceKey key, int xsize, int ysize, bool create)
1340 {
1341         bNodePreview *preview;
1342         
1343         preview = BKE_node_instance_hash_lookup(previews, key);
1344         if (!preview) {
1345                 if (create) {
1346                         preview = MEM_callocN(sizeof(bNodePreview), "node preview");
1347                         BKE_node_instance_hash_insert(previews, key, preview);
1348                 }
1349                 else
1350                         return NULL;
1351         }
1352         
1353         /* node previews can get added with variable size this way */
1354         if (xsize == 0 || ysize == 0)
1355                 return preview;
1356         
1357         /* sanity checks & initialize */
1358         if (preview->rect) {
1359                 if (preview->xsize != xsize || preview->ysize != ysize) {
1360                         MEM_freeN(preview->rect);
1361                         preview->rect = NULL;
1362                 }
1363         }
1364         
1365         if (preview->rect == NULL) {
1366                 preview->rect = MEM_callocN(4 * xsize + xsize * ysize * sizeof(char) * 4, "node preview rect");
1367                 preview->xsize = xsize;
1368                 preview->ysize = ysize;
1369         }
1370         /* no clear, makes nicer previews */
1371         
1372         return preview;
1373 }
1374
1375 bNodePreview *BKE_node_preview_copy(bNodePreview *preview)
1376 {
1377         bNodePreview *new_preview = MEM_dupallocN(preview);
1378         if (preview->rect)
1379                 new_preview->rect = MEM_dupallocN(preview->rect);
1380         return new_preview;
1381 }
1382
1383 void BKE_node_preview_free(bNodePreview *preview)
1384 {
1385         if (preview->rect)
1386                 MEM_freeN(preview->rect);
1387         MEM_freeN(preview);
1388 }
1389
1390 static void node_preview_init_tree_recursive(bNodeInstanceHash *previews, bNodeTree *ntree, bNodeInstanceKey parent_key, int xsize, int ysize, int create)
1391 {
1392         bNode *node;
1393         for (node = ntree->nodes.first; node; node = node->next) {
1394                 bNodeInstanceKey key = BKE_node_instance_key(parent_key, ntree, node);
1395                 
1396                 if (BKE_node_preview_used(node)) {
1397                         node->preview_xsize = xsize;
1398                         node->preview_ysize = ysize;
1399                         
1400                         BKE_node_preview_verify(previews, key, xsize, ysize, create);
1401                 }
1402                 
1403                 if (node->type == NODE_GROUP && node->id)
1404                         node_preview_init_tree_recursive(previews, (bNodeTree *)node->id, key, xsize, ysize, create);
1405         }
1406 }
1407
1408 void BKE_node_preview_init_tree(bNodeTree *ntree, int xsize, int ysize, int create_previews)
1409 {
1410         if (!ntree)
1411                 return;
1412         
1413         if (!ntree->previews)
1414                 ntree->previews = BKE_node_instance_hash_new("node previews");
1415         
1416         node_preview_init_tree_recursive(ntree->previews, ntree, NODE_INSTANCE_KEY_BASE, xsize, ysize, create_previews);
1417 }
1418
1419 static void node_preview_tag_used_recursive(bNodeInstanceHash *previews, bNodeTree *ntree, bNodeInstanceKey parent_key)
1420 {
1421         bNode *node;
1422         for (node = ntree->nodes.first; node; node = node->next) {
1423                 bNodeInstanceKey key = BKE_node_instance_key(parent_key, ntree, node);
1424                 
1425                 if (BKE_node_preview_used(node))
1426                         BKE_node_instance_hash_tag_key(previews, key);
1427                 
1428                 if (node->type == NODE_GROUP && node->id)
1429                         node_preview_tag_used_recursive(previews, (bNodeTree *)node->id, key);
1430         }
1431 }
1432
1433 void BKE_node_preview_remove_unused(bNodeTree *ntree)
1434 {
1435         if (!ntree || !ntree->previews)
1436                 return;
1437         
1438         /* use the instance hash functions for tagging and removing unused previews */
1439         BKE_node_instance_hash_clear_tags(ntree->previews);
1440         node_preview_tag_used_recursive(ntree->previews, ntree, NODE_INSTANCE_KEY_BASE);
1441         
1442         BKE_node_instance_hash_remove_untagged(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1443 }
1444
1445 void BKE_node_preview_free_tree(bNodeTree *ntree)
1446 {
1447         if (!ntree)
1448                 return;
1449         
1450         if (ntree->previews) {
1451                 BKE_node_instance_hash_free(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1452                 ntree->previews = NULL;
1453         }
1454 }
1455
1456 void BKE_node_preview_clear(bNodePreview *preview)
1457 {
1458         if (preview && preview->rect)
1459                 memset(preview->rect, 0, MEM_allocN_len(preview->rect));
1460 }
1461
1462 void BKE_node_preview_clear_tree(bNodeTree *ntree)
1463 {
1464         bNodeInstanceHashIterator iter;
1465         
1466         if (!ntree || !ntree->previews)
1467                 return;
1468         
1469         NODE_INSTANCE_HASH_ITER(iter, ntree->previews) {
1470                 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1471                 BKE_node_preview_clear(preview);
1472         }
1473 }
1474
1475 static void node_preview_sync(bNodePreview *to, bNodePreview *from)
1476 {
1477         /* sizes should have been initialized by BKE_node_preview_init_tree */
1478         BLI_assert(to->xsize == from->xsize && to->ysize == from->ysize);
1479         
1480         /* copy over contents of previews */
1481         if (to->rect && from->rect) {
1482                 int xsize = to->xsize;
1483                 int ysize = to->ysize;
1484                 memcpy(to->rect, from->rect, xsize * ysize * sizeof(char) * 4);
1485         }
1486 }
1487
1488 void BKE_node_preview_sync_tree(bNodeTree *to_ntree, bNodeTree *from_ntree)
1489 {
1490         bNodeInstanceHash *from_previews = from_ntree->previews;
1491         bNodeInstanceHash *to_previews = to_ntree->previews;
1492         bNodeInstanceHashIterator iter;
1493         
1494         if (!from_previews || !to_previews)
1495                 return;
1496         
1497         NODE_INSTANCE_HASH_ITER(iter, from_previews) {
1498                 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1499                 bNodePreview *from = BKE_node_instance_hash_iterator_get_value(&iter);
1500                 bNodePreview *to = BKE_node_instance_hash_lookup(to_previews, key);
1501                 
1502                 if (from && to)
1503                         node_preview_sync(to, from);
1504         }
1505 }
1506
1507 void BKE_node_preview_merge_tree(bNodeTree *to_ntree, bNodeTree *from_ntree, bool remove_old)
1508 {
1509         if (remove_old || !to_ntree->previews) {
1510                 /* free old previews */
1511                 if (to_ntree->previews)
1512                         BKE_node_instance_hash_free(to_ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1513                 
1514                 /* transfer previews */
1515                 to_ntree->previews = from_ntree->previews;
1516                 from_ntree->previews = NULL;
1517                 
1518                 /* clean up, in case any to_ntree nodes have been removed */
1519                 BKE_node_preview_remove_unused(to_ntree);
1520         }
1521         else {
1522                 bNodeInstanceHashIterator iter;
1523                 
1524                 if (from_ntree->previews) {
1525                         NODE_INSTANCE_HASH_ITER(iter, from_ntree->previews) {
1526                                 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1527                                 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1528                                 
1529                                 /* replace existing previews */
1530                                 BKE_node_instance_hash_remove(to_ntree->previews, key, (bNodeInstanceValueFP)BKE_node_preview_free);
1531                                 BKE_node_instance_hash_insert(to_ntree->previews, key, preview);
1532                         }
1533                         
1534                         /* Note: NULL free function here, because pointers have already been moved over to to_ntree->previews! */
1535                         BKE_node_instance_hash_free(from_ntree->previews, NULL);
1536                         from_ntree->previews = NULL;
1537                 }
1538         }
1539 }
1540
1541 /* hack warning! this function is only used for shader previews, and 
1542  * since it gets called multiple times per pixel for Ztransp we only
1543  * add the color once. Preview gets cleared before it starts render though */
1544 void BKE_node_preview_set_pixel(bNodePreview *preview, const float col[4], int x, int y, bool do_manage)
1545 {
1546         if (preview) {
1547                 if (x >= 0 && y >= 0) {
1548                         if (x < preview->xsize && y < preview->ysize) {
1549                                 unsigned char *tar = preview->rect + 4 * ((preview->xsize * y) + x);
1550                                 
1551                                 if (do_manage) {
1552                                         linearrgb_to_srgb_uchar4(tar, col);
1553                                 }
1554                                 else {
1555                                         rgba_float_to_uchar(tar, col);
1556                                 }
1557                         }
1558                         //else printf("prv out bound x y %d %d\n", x, y);
1559                 }
1560                 //else printf("prv out bound x y %d %d\n", x, y);
1561         }
1562 }
1563
1564 #if 0
1565 static void nodeClearPreview(bNode *node)
1566 {
1567         if (node->preview && node->preview->rect)
1568                 memset(node->preview->rect, 0, MEM_allocN_len(node->preview->rect));
1569 }
1570
1571 /* use it to enforce clear */
1572 void ntreeClearPreview(bNodeTree *ntree)
1573 {
1574         bNode *node;
1575         
1576         if (ntree == NULL)
1577                 return;
1578         
1579         for (node = ntree->nodes.first; node; node = node->next) {
1580                 if (node->typeinfo->flag & NODE_PREVIEW)
1581                         nodeClearPreview(node);
1582                 if (node->type == NODE_GROUP)
1583                         ntreeClearPreview((bNodeTree *)node->id);
1584         }
1585 }
1586
1587 /* hack warning! this function is only used for shader previews, and 
1588  * since it gets called multiple times per pixel for Ztransp we only
1589  * add the color once. Preview gets cleared before it starts render though */
1590 void nodeAddToPreview(bNode *node, const float col[4], int x, int y, int do_manage)
1591 {
1592         bNodePreview *preview = node->preview;
1593         if (preview) {
1594                 if (x >= 0 && y >= 0) {
1595                         if (x < preview->xsize && y < preview->ysize) {
1596                                 unsigned char *tar = preview->rect + 4 * ((preview->xsize * y) + x);
1597                                 
1598                                 if (do_manage) {
1599                                         linearrgb_to_srgb_uchar4(tar, col);
1600                                 }
1601                                 else {
1602                                         rgba_float_to_uchar(tar, col);
1603                                 }
1604                         }
1605                         //else printf("prv out bound x y %d %d\n", x, y);
1606                 }
1607                 //else printf("prv out bound x y %d %d\n", x, y);
1608         }
1609 }
1610 #endif
1611
1612 /* ************** Free stuff ********** */
1613
1614 /* goes over entire tree */
1615 void nodeUnlinkNode(bNodeTree *ntree, bNode *node)
1616 {
1617         bNodeLink *link, *next;
1618         bNodeSocket *sock;
1619         ListBase *lb;
1620         
1621         for (link = ntree->links.first; link; link = next) {
1622                 next = link->next;
1623                 
1624                 if (link->fromnode == node) {
1625                         lb = &node->outputs;
1626                         if (link->tonode)
1627                                 link->tonode->update |= NODE_UPDATE;
1628                 }
1629                 else if (link->tonode == node)
1630                         lb = &node->inputs;
1631                 else
1632                         lb = NULL;
1633
1634                 if (lb) {
1635                         for (sock = lb->first; sock; sock = sock->next) {
1636                                 if (link->fromsock == sock || link->tosock == sock)
1637                                         break;
1638                         }
1639                         if (sock) {
1640                                 nodeRemLink(ntree, link);
1641                         }
1642                 }
1643         }
1644 }
1645
1646 static void node_unlink_attached(bNodeTree *ntree, bNode *parent)
1647 {
1648         bNode *node;
1649         for (node = ntree->nodes.first; node; node = node->next) {
1650                 if (node->parent == parent)
1651                         nodeDetachNode(node);
1652         }
1653 }
1654
1655 /** \note caller needs to manage node->id user */
1656 static void node_free_node_ex(bNodeTree *ntree, bNode *node, bool remove_animdata, bool use_api_free_cb)
1657 {
1658         bNodeSocket *sock, *nextsock;
1659         
1660         /* don't remove node animdata if the tree is localized,
1661          * Action is shared with the original tree (T38221)
1662          */
1663         remove_animdata &= ntree && !(ntree->flag & NTREE_IS_LOCALIZED);
1664         
1665         /* extra free callback */
1666         if (use_api_free_cb && node->typeinfo->freefunc_api) {
1667                 PointerRNA ptr;
1668                 RNA_pointer_create((ID *)ntree, &RNA_Node, node, &ptr);
1669                 
1670                 node->typeinfo->freefunc_api(&ptr);
1671         }
1672         
1673         /* since it is called while free database, node->id is undefined */
1674         
1675         /* can be called for nodes outside a node tree (e.g. clipboard) */
1676         if (ntree) {
1677                 /* remove all references to this node */
1678                 nodeUnlinkNode(ntree, node);
1679                 node_unlink_attached(ntree, node);
1680                 
1681                 BLI_remlink(&ntree->nodes, node);
1682                 
1683                 if (remove_animdata) {
1684                         char propname_esc[MAX_IDPROP_NAME * 2];
1685                         char prefix[MAX_IDPROP_NAME * 2];
1686
1687                         BLI_strescape(propname_esc, node->name, sizeof(propname_esc));
1688                         BLI_snprintf(prefix, sizeof(prefix), "nodes[\"%s\"]", propname_esc);
1689
1690                         BKE_animdata_fix_paths_remove((ID *)ntree, prefix);
1691                 }
1692
1693                 if (ntree->typeinfo->free_node_cache)
1694                         ntree->typeinfo->free_node_cache(ntree, node);
1695                 
1696                 /* texture node has bad habit of keeping exec data around */
1697                 if (ntree->type == NTREE_TEXTURE && ntree->execdata) {
1698                         ntreeTexEndExecTree(ntree->execdata);
1699                         ntree->execdata = NULL;
1700                 }
1701                 
1702                 if (node->typeinfo->freefunc)
1703                         node->typeinfo->freefunc(node);
1704         }
1705         
1706         for (sock = node->inputs.first; sock; sock = nextsock) {
1707                 nextsock = sock->next;
1708                 node_socket_free(ntree, sock, node);
1709                 MEM_freeN(sock);
1710         }
1711         for (sock = node->outputs.first; sock; sock = nextsock) {
1712                 nextsock = sock->next;
1713                 node_socket_free(ntree, sock, node);
1714                 MEM_freeN(sock);
1715         }
1716
1717         BLI_freelistN(&node->internal_links);
1718
1719         if (node->prop) {
1720                 IDP_FreeProperty(node->prop);
1721                 MEM_freeN(node->prop);
1722         }
1723
1724         MEM_freeN(node);
1725         
1726         if (ntree)
1727                 ntree->update |= NTREE_UPDATE_NODES;
1728 }
1729
1730 void nodeFreeNode(bNodeTree *ntree, bNode *node)
1731 {
1732         node_free_node_ex(ntree, node, true, true);
1733 }
1734
1735 static void node_socket_interface_free(bNodeTree *UNUSED(ntree), bNodeSocket *sock)
1736 {
1737         if (sock->prop) {
1738                 IDP_FreeProperty(sock->prop);
1739                 MEM_freeN(sock->prop);
1740         }
1741         
1742         if (sock->default_value)
1743                 MEM_freeN(sock->default_value);
1744 }
1745
1746 static void free_localized_node_groups(bNodeTree *ntree)
1747 {
1748         bNode *node;
1749         
1750         /* Only localized node trees store a copy for each node group tree.
1751          * Each node group tree in a localized node tree can be freed,
1752          * since it is a localized copy itself (no risk of accessing free'd
1753          * data in main, see [#37939]).
1754          */
1755         if (!(ntree->flag & NTREE_IS_LOCALIZED))
1756                 return;
1757         
1758         for (node = ntree->nodes.first; node; node = node->next) {
1759                 if (node->type == NODE_GROUP && node->id) {
1760                         bNodeTree *ngroup = (bNodeTree *)node->id;
1761                         ntreeFreeTree(ngroup);
1762                         MEM_freeN(ngroup);
1763                 }
1764         }
1765 }
1766
1767 /** Free (or release) any data used by this nodetree (does not free the nodetree itself). */
1768 void ntreeFreeTree(bNodeTree *ntree)
1769 {
1770         bNodeTree *tntree;
1771         bNode *node, *next;
1772         bNodeSocket *sock, *nextsock;
1773
1774         BKE_animdata_free((ID *)ntree, false);
1775
1776         /* XXX hack! node trees should not store execution graphs at all.
1777          * This should be removed when old tree types no longer require it.
1778          * Currently the execution data for texture nodes remains in the tree
1779          * after execution, until the node tree is updated or freed.
1780          */
1781         if (ntree->execdata) {
1782                 switch (ntree->type) {
1783                         case NTREE_SHADER:
1784                                 ntreeShaderEndExecTree(ntree->execdata);
1785                                 break;
1786                         case NTREE_TEXTURE:
1787                                 ntreeTexEndExecTree(ntree->execdata);
1788                                 ntree->execdata = NULL;
1789                                 break;
1790                 }
1791         }
1792         
1793         /* XXX not nice, but needed to free localized node groups properly */
1794         free_localized_node_groups(ntree);
1795         
1796         /* unregister associated RNA types */
1797         ntreeInterfaceTypeFree(ntree);
1798         
1799         BLI_freelistN(&ntree->links);   /* do first, then unlink_node goes fast */
1800         
1801         for (node = ntree->nodes.first; node; node = next) {
1802                 next = node->next;
1803                 node_free_node_ex(ntree, node, false, false);
1804         }
1805
1806         /* free interface sockets */
1807         for (sock = ntree->inputs.first; sock; sock = nextsock) {
1808                 nextsock = sock->next;
1809                 node_socket_interface_free(ntree, sock);
1810                 MEM_freeN(sock);
1811         }
1812         for (sock = ntree->outputs.first; sock; sock = nextsock) {
1813                 nextsock = sock->next;
1814                 node_socket_interface_free(ntree, sock);
1815                 MEM_freeN(sock);
1816         }
1817         
1818         /* free preview hash */
1819         if (ntree->previews) {
1820                 BKE_node_instance_hash_free(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1821         }
1822
1823         if (ntree->duplilock)
1824                 BLI_mutex_free(ntree->duplilock);
1825         
1826         /* if ntree is not part of library, free the libblock data explicitly */
1827         for (tntree = G.main->nodetree.first; tntree; tntree = tntree->id.next)
1828                 if (tntree == ntree)
1829                         break;
1830         if (tntree == NULL) {
1831                 BKE_libblock_free_data(&ntree->id, true);
1832         }
1833 }
1834
1835 void ntreeFreeCache(bNodeTree *ntree)
1836 {
1837         if (ntree == NULL) return;
1838         
1839         if (ntree->typeinfo->free_cache)
1840                 ntree->typeinfo->free_cache(ntree);
1841 }
1842
1843 void ntreeSetOutput(bNodeTree *ntree)
1844 {
1845         bNode *node;
1846
1847         /* find the active outputs, might become tree type dependent handler */
1848         for (node = ntree->nodes.first; node; node = node->next) {
1849                 if (node->typeinfo->nclass == NODE_CLASS_OUTPUT) {
1850                         bNode *tnode;
1851                         int output = 0;
1852                         
1853                         /* we need a check for which output node should be tagged like this, below an exception */
1854                         if (node->type == CMP_NODE_OUTPUT_FILE)
1855                                 continue;
1856
1857                         /* there is more types having output class, each one is checked */
1858                         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
1859                                 if (tnode->typeinfo->nclass == NODE_CLASS_OUTPUT) {
1860                                         
1861                                         if (ntree->type == NTREE_COMPOSIT) {
1862                                                         
1863                                                 /* same type, exception for viewer */
1864                                                 if (tnode->type == node->type ||
1865                                                     (ELEM(tnode->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER) &&
1866                                                      ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER)))
1867                                                 {
1868                                                         if (tnode->flag & NODE_DO_OUTPUT) {
1869                                                                 output++;
1870                                                                 if (output > 1)
1871                                                                         tnode->flag &= ~NODE_DO_OUTPUT;
1872                                                         }
1873                                                 }
1874                                         }
1875                                         else {
1876                                                 /* same type */
1877                                                 if (tnode->type == node->type) {
1878                                                         if (tnode->flag & NODE_DO_OUTPUT) {
1879                                                                 output++;
1880                                                                 if (output > 1)
1881                                                                         tnode->flag &= ~NODE_DO_OUTPUT;
1882                                                         }
1883                                                 }
1884                                         }
1885                                 }
1886                         }
1887                         if (output == 0)
1888                                 node->flag |= NODE_DO_OUTPUT;
1889                 }
1890                 
1891                 /* group node outputs use this flag too */
1892                 if (node->type == NODE_GROUP_OUTPUT) {
1893                         bNode *tnode;
1894                         int output = 0;
1895                         
1896                         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
1897                                 if (tnode->type == NODE_GROUP_OUTPUT) {
1898                                         if (tnode->flag & NODE_DO_OUTPUT) {
1899                                                 output++;
1900                                                 if (output > 1)
1901                                                         tnode->flag &= ~NODE_DO_OUTPUT;
1902                                         }
1903                                 }
1904                         }
1905                         if (output == 0)
1906                                 node->flag |= NODE_DO_OUTPUT;
1907                 }
1908         }
1909         
1910         /* here we could recursively set which nodes have to be done,
1911          * might be different for editor or for "real" use... */
1912 }
1913
1914 bNodeTree *ntreeFromID(ID *id)
1915 {
1916         switch (GS(id->name)) {
1917                 case ID_MA:  return ((Material *)id)->nodetree;
1918                 case ID_LA:  return ((Lamp *)id)->nodetree;
1919                 case ID_WO:  return ((World *)id)->nodetree;
1920                 case ID_TE:  return ((Tex *)id)->nodetree;
1921                 case ID_SCE: return ((Scene *)id)->nodetree;
1922                 case ID_LS:  return ((FreestyleLineStyle *)id)->nodetree;
1923                 default: return NULL;
1924         }
1925 }
1926
1927 void ntreeMakeLocal(Main *bmain, bNodeTree *ntree, bool id_in_mainlist, const bool lib_local)
1928 {
1929         BKE_id_make_local_generic(bmain, &ntree->id, id_in_mainlist, lib_local);
1930 }
1931
1932 int ntreeNodeExists(bNodeTree *ntree, bNode *testnode)
1933 {
1934         bNode *node = ntree->nodes.first;
1935         for (; node; node = node->next)
1936                 if (node == testnode)
1937                         return 1;
1938         return 0;
1939 }
1940
1941 int ntreeOutputExists(bNode *node, bNodeSocket *testsock)
1942 {
1943         bNodeSocket *sock = node->outputs.first;
1944         for (; sock; sock = sock->next)
1945                 if (sock == testsock)
1946                         return 1;
1947         return 0;
1948 }
1949
1950 void ntreeNodeFlagSet(const bNodeTree *ntree, const int flag, const bool enable)
1951 {
1952         bNode *node = ntree->nodes.first;
1953
1954         for (; node; node = node->next) {
1955                 if (enable) {
1956                         node->flag |= flag;
1957                 }
1958                 else {
1959                         node->flag &= ~flag;
1960                 }
1961         }
1962 }
1963
1964 /* returns localized tree for execution in threads */
1965 bNodeTree *ntreeLocalize(bNodeTree *ntree)
1966 {
1967         if (ntree) {
1968                 bNodeTree *ltree;
1969                 bNode *node;
1970                 AnimData *adt;
1971
1972                 bAction *action_backup = NULL, *tmpact_backup = NULL;
1973
1974                 BLI_spin_lock(&spin);
1975                 if (!ntree->duplilock) {
1976                         ntree->duplilock = BLI_mutex_alloc();
1977                 }
1978                 BLI_spin_unlock(&spin);
1979
1980                 BLI_mutex_lock(ntree->duplilock);
1981
1982                 /* Workaround for copying an action on each render!
1983                  * set action to NULL so animdata actions don't get copied */
1984                 adt = BKE_animdata_from_id(&ntree->id);
1985
1986                 if (adt) {
1987                         action_backup = adt->action;
1988                         tmpact_backup = adt->tmpact;
1989
1990                         adt->action = NULL;
1991                         adt->tmpact = NULL;
1992                 }
1993
1994                 /* Make full copy.
1995                  * Note: previews are not copied here.
1996                  */
1997                 ltree = ntreeCopyTree_internal(ntree, G.main, true, false, false, false);
1998                 ltree->flag |= NTREE_IS_LOCALIZED;
1999
2000                 for (node = ltree->nodes.first; node; node = node->next) {
2001                         if (node->type == NODE_GROUP && node->id) {
2002                                 node->id = (ID *)ntreeLocalize((bNodeTree *)node->id);
2003                         }
2004                 }
2005
2006                 if (adt) {
2007                         AnimData *ladt = BKE_animdata_from_id(&ltree->id);
2008
2009                         adt->action = ladt->action = action_backup;
2010                         adt->tmpact = ladt->tmpact = tmpact_backup;
2011
2012                         if (action_backup)
2013                                 id_us_plus(&action_backup->id);
2014                         if (tmpact_backup)
2015                                 id_us_plus(&tmpact_backup->id);
2016
2017                 }
2018                 /* end animdata uglyness */
2019
2020                 /* ensures only a single output node is enabled */
2021                 ntreeSetOutput(ntree);
2022
2023                 for (node = ntree->nodes.first; node; node = node->next) {
2024                         /* store new_node pointer to original */
2025                         node->new_node->new_node = node;
2026                 }
2027
2028                 if (ntree->typeinfo->localize)
2029                         ntree->typeinfo->localize(ltree, ntree);
2030
2031                 BLI_mutex_unlock(ntree->duplilock);
2032
2033                 return ltree;
2034         }
2035         else
2036                 return NULL;
2037 }
2038
2039 /* sync local composite with real tree */
2040 /* local tree is supposed to be running, be careful moving previews! */
2041 /* is called by jobs manager, outside threads, so it doesnt happen during draw */
2042 void ntreeLocalSync(bNodeTree *localtree, bNodeTree *ntree)
2043 {
2044         if (localtree && ntree) {
2045                 if (ntree->typeinfo->local_sync)
2046                         ntree->typeinfo->local_sync(localtree, ntree);
2047         }
2048 }
2049
2050 /* merge local tree results back, and free local tree */
2051 /* we have to assume the editor already changed completely */
2052 void ntreeLocalMerge(bNodeTree *localtree, bNodeTree *ntree)
2053 {
2054         if (ntree && localtree) {
2055                 if (ntree->typeinfo->local_merge)
2056                         ntree->typeinfo->local_merge(localtree, ntree);
2057                 
2058                 ntreeFreeTree(localtree);
2059                 MEM_freeN(localtree);
2060         }
2061 }
2062
2063
2064 /* ************ NODE TREE INTERFACE *************** */
2065
2066 static bNodeSocket *make_socket_interface(bNodeTree *ntree, int in_out,
2067                                          const char *idname, const char *name)
2068 {
2069         bNodeSocketType *stype = nodeSocketTypeFind(idname);
2070         bNodeSocket *sock;
2071         int own_index = ntree->cur_index++;
2072
2073         if (stype == NULL) {
2074                 return NULL;
2075         }
2076
2077         sock = MEM_callocN(sizeof(bNodeSocket), "socket template");
2078         BLI_strncpy(sock->idname, stype->idname, sizeof(sock->idname));
2079         node_socket_set_typeinfo(ntree, sock, stype);
2080         sock->in_out = in_out;
2081         sock->type = SOCK_CUSTOM;       /* int type undefined by default */
2082         
2083         /* assign new unique index */
2084         own_index = ntree->cur_index++;
2085         /* use the own_index as socket identifier */
2086         if (in_out == SOCK_IN)
2087                 BLI_snprintf(sock->identifier, MAX_NAME, "Input_%d", own_index);
2088         else
2089                 BLI_snprintf(sock->identifier, MAX_NAME, "Output_%d", own_index);
2090 #ifdef USE_NODE_COMPAT_CUSTOMNODES
2091         /* XXX forward compatibility:
2092          * own_index is deprecated, but needs to be set here.
2093          * Node sockets generally use the identifier string instead now,
2094          * but reconstructing own_index in writefile.c would require parsing the identifier string.
2095          */
2096
2097 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406)) || defined(__clang__)
2098 #  pragma GCC diagnostic push
2099 #  pragma GCC diagnostic ignored "-Wdeprecated-declarations"
2100 #endif
2101
2102         sock->own_index = own_index;
2103
2104 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406)) || defined(__clang__)
2105 #  pragma GCC diagnostic pop
2106 #endif
2107
2108 #endif  /* USE_NODE_COMPAT_CUSTOMNODES */
2109         
2110         sock->limit = (in_out == SOCK_IN ? 1 : 0xFFF);
2111         
2112         BLI_strncpy(sock->name, name, NODE_MAXSTR);
2113         sock->storage = NULL;
2114         sock->flag |= SOCK_COLLAPSED;
2115         
2116         return sock;
2117 }
2118
2119 bNodeSocket *ntreeFindSocketInterface(bNodeTree *ntree, int in_out, const char *identifier)
2120 {
2121         bNodeSocket *iosock = (in_out == SOCK_IN ? ntree->inputs.first : ntree->outputs.first);
2122         for (; iosock; iosock = iosock->next)
2123                 if (STREQ(iosock->identifier, identifier))
2124                         return iosock;
2125         return NULL;
2126 }
2127
2128 bNodeSocket *ntreeAddSocketInterface(bNodeTree *ntree, int in_out, const char *idname, const char *name)
2129 {
2130         bNodeSocket *iosock;
2131         
2132         iosock = make_socket_interface(ntree, in_out, idname, name);
2133         if (in_out == SOCK_IN) {
2134                 BLI_addtail(&ntree->inputs, iosock);
2135                 ntree->update |= NTREE_UPDATE_GROUP_IN;
2136         }
2137         else if (in_out == SOCK_OUT) {
2138                 BLI_addtail(&ntree->outputs, iosock);
2139                 ntree->update |= NTREE_UPDATE_GROUP_OUT;
2140         }
2141         
2142         return iosock;
2143 }
2144
2145 bNodeSocket *ntreeInsertSocketInterface(bNodeTree *ntree, int in_out, const char *idname,
2146                                bNodeSocket *next_sock, const char *name)
2147 {
2148         bNodeSocket *iosock;
2149         
2150         iosock = make_socket_interface(ntree, in_out, idname, name);
2151         if (in_out == SOCK_IN) {
2152                 BLI_insertlinkbefore(&ntree->inputs, next_sock, iosock);
2153                 ntree->update |= NTREE_UPDATE_GROUP_IN;
2154         }
2155         else if (in_out == SOCK_OUT) {
2156                 BLI_insertlinkbefore(&ntree->outputs, next_sock, iosock);
2157                 ntree->update |= NTREE_UPDATE_GROUP_OUT;
2158         }
2159         
2160         return iosock;
2161 }
2162
2163 struct bNodeSocket *ntreeAddSocketInterfaceFromSocket(bNodeTree *ntree, bNode *from_node, bNodeSocket *from_sock)
2164 {
2165         bNodeSocket *iosock = ntreeAddSocketInterface(ntree, from_sock->in_out, from_sock->idname, from_sock->name);
2166         if (iosock) {
2167                 if (iosock->typeinfo->interface_from_socket)
2168                         iosock->typeinfo->interface_from_socket(ntree, iosock, from_node, from_sock);
2169         }
2170         return iosock;
2171 }
2172
2173 struct bNodeSocket *ntreeInsertSocketInterfaceFromSocket(bNodeTree *ntree, bNodeSocket *next_sock, bNode *from_node, bNodeSocket *from_sock)
2174 {
2175         bNodeSocket *iosock = ntreeInsertSocketInterface(ntree, from_sock->in_out, from_sock->idname, next_sock, from_sock->name);
2176         if (iosock) {
2177                 if (iosock->typeinfo->interface_from_socket)
2178                         iosock->typeinfo->interface_from_socket(ntree, iosock, from_node, from_sock);
2179         }
2180         return iosock;
2181 }
2182
2183 void ntreeRemoveSocketInterface(bNodeTree *ntree, bNodeSocket *sock)
2184 {
2185         /* this is fast, this way we don't need an in_out argument */
2186         BLI_remlink(&ntree->inputs, sock);
2187         BLI_remlink(&ntree->outputs, sock);
2188         
2189         node_socket_interface_free(ntree, sock);
2190         MEM_freeN(sock);
2191         
2192         ntree->update |= NTREE_UPDATE_GROUP;
2193 }
2194
2195 /* generates a valid RNA identifier from the node tree name */
2196 static void ntree_interface_identifier_base(bNodeTree *ntree, char *base)
2197 {
2198         /* generate a valid RNA identifier */
2199         sprintf(base, "NodeTreeInterface_%s", ntree->id.name + 2);
2200         RNA_identifier_sanitize(base, false);
2201 }
2202
2203 /* check if the identifier is already in use */
2204 static bool ntree_interface_unique_identifier_check(void *UNUSED(data), const char *identifier)
2205 {
2206         return (RNA_struct_find(identifier) != NULL);
2207 }
2208
2209 /* generates the actual unique identifier and ui name and description */
2210 static void ntree_interface_identifier(bNodeTree *ntree, const char *base, char *identifier, int maxlen, char *name, char *description)
2211 {
2212         /* There is a possibility that different node tree names get mapped to the same identifier
2213          * after sanitization (e.g. "SomeGroup_A", "SomeGroup.A" both get sanitized to "SomeGroup_A").
2214          * On top of the sanitized id string add a number suffix if necessary to avoid duplicates.
2215          */
2216         identifier[0] = '\0';
2217         BLI_uniquename_cb(ntree_interface_unique_identifier_check, NULL, base, '_', identifier, maxlen);
2218         
2219         sprintf(name, "Node Tree %s Interface", ntree->id.name + 2);
2220         sprintf(description, "Interface properties of node group %s", ntree->id.name + 2);
2221 }
2222
2223 static void ntree_interface_type_create(bNodeTree *ntree)
2224 {
2225         StructRNA *srna;
2226         bNodeSocket *sock;
2227         /* strings are generated from base string + ID name, sizes are sufficient */
2228         char base[MAX_ID_NAME + 64], identifier[MAX_ID_NAME + 64], name[MAX_ID_NAME + 64], description[MAX_ID_NAME + 64];
2229         
2230         /* generate a valid RNA identifier */
2231         ntree_interface_identifier_base(ntree, base);
2232         ntree_interface_identifier(ntree, base, identifier, sizeof(identifier), name, description);
2233         
2234         /* register a subtype of PropertyGroup */
2235         srna = RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup);
2236         RNA_def_struct_ui_text(srna, name, description);
2237         RNA_def_struct_duplicate_pointers(srna);
2238         
2239         /* associate the RNA type with the node tree */
2240         ntree->interface_type = srna;
2241         RNA_struct_blender_type_set(srna, ntree);
2242         
2243         /* add socket properties */
2244         for (sock = ntree->inputs.first; sock; sock = sock->next) {
2245                 bNodeSocketType *stype = sock->typeinfo;
2246                 if (stype && stype->interface_register_properties)
2247                         stype->interface_register_properties(ntree, sock, srna);
2248         }
2249         for (sock = ntree->outputs.first; sock; sock = sock->next) {
2250                 bNodeSocketType *stype = sock->typeinfo;
2251                 if (stype && stype->interface_register_properties)
2252                         stype->interface_register_properties(ntree, sock, srna);
2253         }
2254 }
2255
2256 StructRNA *ntreeInterfaceTypeGet(bNodeTree *ntree, int create)
2257 {
2258         if (ntree->interface_type) {
2259                 /* strings are generated from base string + ID name, sizes are sufficient */
2260                 char base[MAX_ID_NAME + 64], identifier[MAX_ID_NAME + 64], name[MAX_ID_NAME + 64], description[MAX_ID_NAME + 64];
2261                 
2262                 /* A bit of a hack: when changing the ID name, update the RNA type identifier too,
2263                  * so that the names match. This is not strictly necessary to keep it working,
2264                  * but better for identifying associated NodeTree blocks and RNA types.
2265                  */
2266                 StructRNA *srna = ntree->interface_type;
2267                 
2268                 ntree_interface_identifier_base(ntree, base);
2269                 
2270                 /* RNA identifier may have a number suffix, but should start with the idbase string */
2271                 if (!STREQLEN(RNA_struct_identifier(srna), base, sizeof(base))) {
2272                         /* generate new unique RNA identifier from the ID name */
2273                         ntree_interface_identifier(ntree, base, identifier, sizeof(identifier), name, description);
2274                         
2275                         /* rename the RNA type */
2276                         RNA_def_struct_free_pointers(srna);
2277                         RNA_def_struct_identifier(srna, identifier);
2278                         RNA_def_struct_ui_text(srna, name, description);
2279                         RNA_def_struct_duplicate_pointers(srna);
2280                 }
2281         }
2282         else if (create) {
2283                 ntree_interface_type_create(ntree);
2284         }
2285         
2286         return ntree->interface_type;
2287 }
2288
2289 void ntreeInterfaceTypeFree(bNodeTree *ntree)
2290 {
2291         if (ntree->interface_type) {
2292                 RNA_struct_free(&BLENDER_RNA, ntree->interface_type);
2293                 ntree->interface_type = NULL;
2294         }
2295 }
2296
2297 void ntreeInterfaceTypeUpdate(bNodeTree *ntree)
2298 {
2299         /* XXX it would be sufficient to just recreate all properties
2300          * instead of re-registering the whole struct type,
2301          * but there is currently no good way to do this in the RNA functions.
2302          * Overhead should be negligible.
2303          */
2304         ntreeInterfaceTypeFree(ntree);
2305         ntree_interface_type_create(ntree);
2306 }
2307
2308
2309 /* ************ find stuff *************** */
2310
2311 bNode *ntreeFindType(const bNodeTree *ntree, int type)
2312 {
2313         if (ntree) {
2314                 for (bNode * node = ntree->nodes.first; node; node = node->next) {
2315                         if (node->type == type) {
2316                                 return node;
2317                         }
2318                 }
2319         }
2320         return NULL;
2321 }
2322
2323 bool ntreeHasType(const bNodeTree *ntree, int type)
2324 {
2325         return ntreeFindType(ntree, type) != NULL;
2326 }
2327
2328 bool ntreeHasTree(const bNodeTree *ntree, const bNodeTree *lookup)
2329 {
2330         bNode *node;
2331
2332         if (ntree == lookup)
2333                 return true;
2334
2335         for (node = ntree->nodes.first; node; node = node->next)
2336                 if (node->type == NODE_GROUP && node->id)
2337                         if (ntreeHasTree((bNodeTree *)node->id, lookup))
2338                                 return true;
2339
2340         return false;
2341 }
2342
2343 bNodeLink *nodeFindLink(bNodeTree *ntree, bNodeSocket *from, bNodeSocket *to)
2344 {
2345         bNodeLink *link;
2346         
2347         for (link = ntree->links.first; link; link = link->next) {
2348                 if (link->fromsock == from && link->tosock == to)
2349                         return link;
2350                 if (link->fromsock == to && link->tosock == from) /* hrms? */
2351                         return link;
2352         }
2353         return NULL;
2354 }
2355
2356 int nodeCountSocketLinks(bNodeTree *ntree, bNodeSocket *sock)
2357 {
2358         bNodeLink *link;
2359         int tot = 0;
2360         
2361         for (link = ntree->links.first; link; link = link->next) {
2362                 if (link->fromsock == sock || link->tosock == sock)
2363                         tot++;
2364         }
2365         return tot;
2366 }
2367
2368 bNode *nodeGetActive(bNodeTree *ntree)
2369 {
2370         bNode *node;
2371         
2372         if (ntree == NULL) return NULL;
2373         
2374         for (node = ntree->nodes.first; node; node = node->next)
2375                 if (node->flag & NODE_ACTIVE)
2376                         break;
2377         return node;
2378 }
2379
2380 static bNode *node_get_active_id_recursive(bNodeInstanceKey active_key, bNodeInstanceKey parent_key, bNodeTree *ntree, short idtype)
2381 {
2382         if (parent_key.value == active_key.value || active_key.value == 0) {
2383                 bNode *node;
2384                 for (node = ntree->nodes.first; node; node = node->next)
2385                         if (node->id && GS(node->id->name) == idtype)
2386                                 if (node->flag & NODE_ACTIVE_ID)
2387                                         return node;
2388         }
2389         else {
2390                 bNode *node, *tnode;
2391                 /* no node with active ID in this tree, look inside groups */
2392                 for (node = ntree->nodes.first; node; node = node->next) {
2393                         if (node->type == NODE_GROUP) {
2394                                 bNodeTree *group = (bNodeTree *)node->id;
2395                                 if (group) {
2396                                         bNodeInstanceKey group_key = BKE_node_instance_key(parent_key, ntree, node);
2397                                         tnode = node_get_active_id_recursive(active_key, group_key, group, idtype);
2398                                         if (tnode)
2399                                                 return tnode;
2400                                 }
2401                         }
2402                 }
2403         }
2404         
2405         return NULL;
2406 }
2407
2408 /* two active flags, ID nodes have special flag for buttons display */
2409 bNode *nodeGetActiveID(bNodeTree *ntree, short idtype)
2410 {
2411         if (ntree)
2412                 return node_get_active_id_recursive(ntree->active_viewer_key, NODE_INSTANCE_KEY_BASE, ntree, idtype);
2413         else
2414                 return NULL;
2415 }
2416
2417 bool nodeSetActiveID(bNodeTree *ntree, short idtype, ID *id)
2418 {
2419         bNode *node;
2420         bool ok = false;
2421
2422         if (ntree == NULL) return ok;
2423
2424         for (node = ntree->nodes.first; node; node = node->next) {
2425                 if (node->id && GS(node->id->name) == idtype) {
2426                         if (id && ok == false && node->id == id) {
2427                                 node->flag |= NODE_ACTIVE_ID;
2428                                 ok = true;
2429                         }
2430                         else {
2431                                 node->flag &= ~NODE_ACTIVE_ID;
2432                         }
2433                 }
2434         }
2435
2436         /* update all groups linked from here
2437          * if active ID node has been found already,
2438          * just pass NULL so other matching nodes are deactivated.
2439          */
2440         for (node = ntree->nodes.first; node; node = node->next) {
2441                 if (node->type == NODE_GROUP)
2442                         ok |= nodeSetActiveID((bNodeTree *)node->id, idtype, (ok == false ? id : NULL));
2443         }
2444
2445         return ok;
2446 }
2447
2448
2449 /* two active flags, ID nodes have special flag for buttons display */
2450 void nodeClearActiveID(bNodeTree *ntree, short idtype)
2451 {
2452         bNode *node;
2453         
2454         if (ntree == NULL) return;
2455         
2456         for (node = ntree->nodes.first; node; node = node->next)
2457                 if (node->id && GS(node->id->name) == idtype)
2458                         node->flag &= ~NODE_ACTIVE_ID;
2459 }
2460
2461 void nodeSetSelected(bNode *node, bool select)
2462 {
2463         if (select) {
2464                 node->flag |= NODE_SELECT;
2465         }
2466         else {
2467                 bNodeSocket *sock;
2468                 
2469                 node->flag &= ~NODE_SELECT;
2470                 
2471                 /* deselect sockets too */
2472                 for (sock = node->inputs.first; sock; sock = sock->next)
2473                         sock->flag &= ~NODE_SELECT;
2474                 for (sock = node->outputs.first; sock; sock = sock->next)
2475                         sock->flag &= ~NODE_SELECT;
2476         }
2477 }
2478
2479 void nodeClearActive(bNodeTree *ntree)
2480 {
2481         bNode *node;
2482
2483         if (ntree == NULL) return;
2484
2485         for (node = ntree->nodes.first; node; node = node->next)
2486                 node->flag &= ~(NODE_ACTIVE | NODE_ACTIVE_ID);
2487 }
2488
2489 /* two active flags, ID nodes have special flag for buttons display */
2490 void nodeSetActive(bNodeTree *ntree, bNode *node)
2491 {
2492         bNode *tnode;
2493         
2494         /* make sure only one node is active, and only one per ID type */
2495         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
2496                 tnode->flag &= ~NODE_ACTIVE;
2497                 
2498                 if (node->id && tnode->id) {
2499                         if (GS(node->id->name) == GS(tnode->id->name))
2500                                 tnode->flag &= ~NODE_ACTIVE_ID;
2501                 }
2502                 if (node->typeinfo->nclass == NODE_CLASS_TEXTURE)
2503                         tnode->flag &= ~NODE_ACTIVE_TEXTURE;
2504         }
2505         
2506         node->flag |= NODE_ACTIVE;
2507         if (node->id)
2508                 node->flag |= NODE_ACTIVE_ID;
2509         if (node->typeinfo->nclass == NODE_CLASS_TEXTURE)
2510                 node->flag |= NODE_ACTIVE_TEXTURE;
2511 }
2512
2513 int nodeSocketIsHidden(bNodeSocket *sock)
2514 {
2515         return ((sock->flag & (SOCK_HIDDEN | SOCK_UNAVAIL)) != 0);
2516 }
2517
2518 /* ************** Node Clipboard *********** */
2519
2520 #define USE_NODE_CB_VALIDATE
2521
2522 #ifdef USE_NODE_CB_VALIDATE
2523 /**
2524  * This data structure is to validate the node on creation,
2525  * otherwise we may reference missing data.
2526  *
2527  * Currently its only used for ID's, but nodes may one day
2528  * reference other pointers which need validation.
2529  */
2530 typedef struct bNodeClipboardExtraInfo {
2531         struct bNodeClipboardExtraInfo *next, *prev;
2532         ID  *id;
2533         char id_name[MAX_ID_NAME];
2534         char library_name[FILE_MAX];
2535 } bNodeClipboardExtraInfo;
2536 #endif  /* USE_NODE_CB_VALIDATE */
2537
2538
2539 typedef struct bNodeClipboard {
2540         ListBase nodes;
2541
2542 #ifdef USE_NODE_CB_VALIDATE
2543         ListBase nodes_extra_info;
2544 #endif
2545
2546         ListBase links;
2547         int type;
2548 } bNodeClipboard;
2549
2550 static bNodeClipboard node_clipboard = {{NULL}};
2551
2552 void BKE_node_clipboard_init(struct bNodeTree *ntree)
2553 {
2554         node_clipboard.type = ntree->type;
2555 }
2556
2557 void BKE_node_clipboard_clear(void)
2558 {
2559         bNode *node, *node_next;
2560         bNodeLink *link, *link_next;
2561         
2562         for (link = node_clipboard.links.first; link; link = link_next) {
2563                 link_next = link->next;
2564                 nodeRemLink(NULL, link);
2565         }
2566         BLI_listbase_clear(&node_clipboard.links);
2567         
2568         for (node = node_clipboard.nodes.first; node; node = node_next) {
2569                 node_next = node->next;
2570                 node_free_node_ex(NULL, node, false, false);
2571         }
2572         BLI_listbase_clear(&node_clipboard.nodes);
2573
2574 #ifdef USE_NODE_CB_VALIDATE
2575         BLI_freelistN(&node_clipboard.nodes_extra_info);
2576 #endif
2577 }
2578
2579 /* return false when one or more ID's are lost */
2580 bool BKE_node_clipboard_validate(void)
2581 {
2582         bool ok = true;
2583
2584 #ifdef USE_NODE_CB_VALIDATE
2585         bNodeClipboardExtraInfo *node_info;
2586         bNode *node;
2587
2588
2589         /* lists must be aligned */
2590         BLI_assert(BLI_listbase_count(&node_clipboard.nodes) ==
2591                    BLI_listbase_count(&node_clipboard.nodes_extra_info));
2592
2593         for (node = node_clipboard.nodes.first, node_info = node_clipboard.nodes_extra_info.first;
2594              node;
2595              node = node->next, node_info = node_info->next)
2596         {
2597                 /* validate the node against the stored node info */
2598
2599                 /* re-assign each loop since we may clear,
2600                  * open a new file where the ID is valid, and paste again */
2601                 node->id = node_info->id;
2602
2603                 /* currently only validate the ID */
2604                 if (node->id) {
2605                         ListBase *lb = which_libbase(G.main, GS(node_info->id_name));
2606                         BLI_assert(lb != NULL);
2607
2608                         if (BLI_findindex(lb, node_info->id) == -1) {
2609                                 /* may assign NULL */
2610                                 node->id = BLI_findstring(lb, node_info->id_name + 2, offsetof(ID, name) + 2);
2611
2612                                 if (node->id == NULL) {
2613                                         ok = false;
2614                                 }
2615                         }
2616                 }
2617         }
2618 #endif  /* USE_NODE_CB_VALIDATE */
2619
2620         return ok;
2621 }
2622
2623 void BKE_node_clipboard_add_node(bNode *node)
2624 {
2625 #ifdef USE_NODE_CB_VALIDATE
2626         /* add extra info */
2627         bNodeClipboardExtraInfo *node_info = MEM_mallocN(sizeof(bNodeClipboardExtraInfo), "bNodeClipboardExtraInfo");
2628
2629         node_info->id = node->id;
2630         if (node->id) {
2631                 BLI_strncpy(node_info->id_name, node->id->name, sizeof(node_info->id_name));
2632                 if (ID_IS_LINKED_DATABLOCK(node->id)) {
2633                         BLI_strncpy(node_info->library_name, node->id->lib->filepath, sizeof(node_info->library_name));
2634                 }
2635                 else {
2636                         node_info->library_name[0] = '\0';
2637                 }
2638         }
2639         else {
2640                 node_info->id_name[0] = '\0';
2641                 node_info->library_name[0] = '\0';
2642         }
2643         BLI_addtail(&node_clipboard.nodes_extra_info, node_info);
2644         /* end extra info */
2645 #endif  /* USE_NODE_CB_VALIDATE */
2646
2647         /* add node */
2648         BLI_addtail(&node_clipboard.nodes, node);
2649
2650 }
2651
2652 void BKE_node_clipboard_add_link(bNodeLink *link)
2653 {
2654         BLI_addtail(&node_clipboard.links, link);
2655 }
2656
2657 const ListBase *BKE_node_clipboard_get_nodes(void)
2658 {
2659         return &node_clipboard.nodes;
2660 }
2661
2662 const ListBase *BKE_node_clipboard_get_links(void)
2663 {
2664         return &node_clipboard.links;
2665 }
2666
2667 int BKE_node_clipboard_get_type(void)
2668 {
2669         return node_clipboard.type;
2670 }
2671
2672
2673 /* Node Instance Hash */
2674
2675 /* magic number for initial hash key */
2676 const bNodeInstanceKey NODE_INSTANCE_KEY_BASE = {5381};
2677 const bNodeInstanceKey NODE_INSTANCE_KEY_NONE = {0};
2678
2679 /* Generate a hash key from ntree and node names
2680  * Uses the djb2 algorithm with xor by Bernstein:
2681  * http://www.cse.yorku.ca/~oz/hash.html
2682  */
2683 static bNodeInstanceKey node_hash_int_str(bNodeInstanceKey hash, const char *str)
2684 {
2685         char c;
2686         
2687         while ((c = *str++))
2688                 hash.value = ((hash.value << 5) + hash.value) ^ c; /* (hash * 33) ^ c */
2689         
2690         /* separator '\0' character, to avoid ambiguity from concatenated strings */
2691         hash.value = (hash.value << 5) + hash.value; /* hash * 33 */
2692         
2693         return hash;
2694 }
2695
2696 bNodeInstanceKey BKE_node_instance_key(bNodeInstanceKey parent_key, bNodeTree *ntree, bNode *node)
2697 {
2698         bNodeInstanceKey key;
2699         
2700         key = node_hash_int_str(parent_key, ntree->id.name + 2);
2701         
2702         if (node)
2703                 key = node_hash_int_str(key, node->name);
2704         
2705         return key;
2706 }
2707
2708 static unsigned int node_instance_hash_key(const void *key)
2709 {
2710         return ((const bNodeInstanceKey *)key)->value;
2711 }
2712
2713 static bool node_instance_hash_key_cmp(const void *a, const void *b)
2714 {
2715         unsigned int value_a = ((const bNodeInstanceKey *)a)->value;
2716         unsigned int value_b = ((const bNodeInstanceKey *)b)->value;
2717
2718         return (value_a != value_b);
2719 }
2720
2721 bNodeInstanceHash *BKE_node_instance_hash_new(const char *info)
2722 {
2723         bNodeInstanceHash *hash = MEM_mallocN(sizeof(bNodeInstanceHash), info);
2724         hash->ghash = BLI_ghash_new(node_instance_hash_key, node_instance_hash_key_cmp, "node instance hash ghash");
2725         return hash;
2726 }
2727
2728 void BKE_node_instance_hash_free(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2729 {
2730         BLI_ghash_free(hash->ghash, NULL, (GHashValFreeFP)valfreefp);
2731         MEM_freeN(hash);
2732 }
2733
2734 void BKE_node_instance_hash_insert(bNodeInstanceHash *hash, bNodeInstanceKey key, void *value)
2735 {
2736         bNodeInstanceHashEntry *entry = value;
2737         entry->key = key;
2738         entry->tag = 0;
2739         BLI_ghash_insert(hash->ghash, &entry->key, value);
2740 }
2741
2742 void *BKE_node_instance_hash_lookup(bNodeInstanceHash *hash, bNodeInstanceKey key)
2743 {
2744         return BLI_ghash_lookup(hash->ghash, &key);
2745 }
2746
2747 int BKE_node_instance_hash_remove(bNodeInstanceHash *hash, bNodeInstanceKey key, bNodeInstanceValueFP valfreefp)
2748 {
2749         return BLI_ghash_remove(hash->ghash, &key, NULL, (GHashValFreeFP)valfreefp);
2750 }
2751
2752 void BKE_node_instance_hash_clear(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2753 {
2754         BLI_ghash_clear(hash->ghash, NULL, (GHashValFreeFP)valfreefp);
2755 }
2756
2757 void *BKE_node_instance_hash_pop(bNodeInstanceHash *hash, bNodeInstanceKey key)
2758 {
2759         return BLI_ghash_popkey(hash->ghash, &key, NULL);
2760 }
2761
2762 int BKE_node_instance_hash_haskey(bNodeInstanceHash *hash, bNodeInstanceKey key)
2763 {
2764         return BLI_ghash_haskey(hash->ghash, &key);
2765 }
2766
2767 int BKE_node_instance_hash_size(bNodeInstanceHash *hash)
2768 {
2769         return BLI_ghash_size(hash->ghash);
2770 }
2771
2772 void BKE_node_instance_hash_clear_tags(bNodeInstanceHash *hash)
2773 {
2774         bNodeInstanceHashIterator iter;
2775         
2776         NODE_INSTANCE_HASH_ITER(iter, hash) {
2777                 bNodeInstanceHashEntry *value = BKE_node_instance_hash_iterator_get_value(&iter);
2778                 
2779                 value->tag = 0;
2780         }
2781 }
2782
2783 void BKE_node_instance_hash_tag(bNodeInstanceHash *UNUSED(hash), void *value)
2784 {
2785         bNodeInstanceHashEntry *entry = value;
2786         entry->tag = 1;
2787 }
2788
2789 bool BKE_node_instance_hash_tag_key(bNodeInstanceHash *hash, bNodeInstanceKey key)
2790 {
2791         bNodeInstanceHashEntry *entry = BKE_node_instance_hash_lookup(hash, key);
2792         
2793         if (entry) {
2794                 entry->tag = 1;
2795                 return true;
2796         }
2797         else
2798                 return false;
2799 }
2800
2801 void BKE_node_instance_hash_remove_untagged(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2802 {
2803         /* NOTE: Hash must not be mutated during iterating!
2804          * Store tagged entries in a separate list and remove items afterward.
2805          */
2806         bNodeInstanceKey *untagged = MEM_mallocN(sizeof(bNodeInstanceKey) * BKE_node_instance_hash_size(hash), "temporary node instance key list");
2807         bNodeInstanceHashIterator iter;
2808         int num_untagged, i;
2809         
2810         num_untagged = 0;
2811         NODE_INSTANCE_HASH_ITER(iter, hash) {
2812                 bNodeInstanceHashEntry *value = BKE_node_instance_hash_iterator_get_value(&iter);
2813                 
2814                 if (!value->tag)
2815                         untagged[num_untagged++] = BKE_node_instance_hash_iterator_get_key(&iter);
2816         }
2817         
2818         for (i = 0; i < num_untagged; ++i) {
2819                 BKE_node_instance_hash_remove(hash, untagged[i], valfreefp);
2820         }
2821         
2822         MEM_freeN(untagged);
2823 }
2824
2825
2826 /* ************** dependency stuff *********** */
2827
2828 /* node is guaranteed to be not checked before */
2829 static int node_get_deplist_recurs(bNodeTree *ntree, bNode *node, bNode ***nsort)
2830 {
2831         bNode *fromnode;
2832         bNodeLink *link;
2833         int level = 0xFFF;
2834         
2835         node->done = true;
2836         
2837         /* check linked nodes */
2838         for (link = ntree->links.first; link; link = link->next) {
2839                 if (link->tonode == node) {
2840                         fromnode = link->fromnode;
2841                         if (fromnode->done == 0)
2842                                 fromnode->level = node_get_deplist_recurs(ntree, fromnode, nsort);
2843                         if (fromnode->level <= level)
2844                                 level = fromnode->level - 1;
2845                 }
2846         }
2847         
2848         /* check parent node */
2849         if (node->parent) {
2850                 if (node->parent->done == 0)
2851                         node->parent->level = node_get_deplist_recurs(ntree, node->parent, nsort);
2852                 if (node->parent->level <= level)
2853                         level = node->parent->level - 1;
2854         }
2855         
2856         if (nsort) {
2857                 **nsort = node;
2858                 (*nsort)++;
2859         }
2860         
2861         return level;
2862 }
2863
2864 void ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes)
2865 {
2866         bNode *node, **nsort;
2867         
2868         *totnodes = 0;
2869         
2870         /* first clear data */
2871         for (node = ntree->nodes.first; node; node = node->next) {
2872                 node->done = false;
2873                 (*totnodes)++;
2874         }
2875         if (*totnodes == 0) {
2876                 *deplist = NULL;
2877                 return;
2878         }
2879         
2880         nsort = *deplist = MEM_callocN((*totnodes) * sizeof(bNode *), "sorted node array");
2881         
2882         /* recursive check */
2883         for (node = ntree->nodes.first; node; node = node->next) {
2884                 if (node->done == 0) {
2885                         node->level = node_get_deplist_recurs(ntree, node, &nsort);
2886                 }
2887         }
2888 }
2889
2890 /* only updates node->level for detecting cycles links */
2891 static void ntree_update_node_level(bNodeTree *ntree)
2892 {
2893         bNode *node;
2894         
2895         /* first clear tag */
2896         for (node = ntree->nodes.first; node; node = node->next) {
2897                 node->done = false;
2898         }
2899         
2900         /* recursive check */
2901         for (node = ntree->nodes.first; node; node = node->next) {
2902                 if (node->done == 0) {
2903                         node->level = node_get_deplist_recurs(ntree, node, NULL);
2904                 }
2905         }
2906 }
2907
2908 void ntreeTagUsedSockets(bNodeTree *ntree)
2909 {
2910         bNode *node;
2911         bNodeSocket *sock;
2912         bNodeLink *link;
2913         
2914         /* first clear data */
2915         for (node = ntree->nodes.first; node; node = node->next) {
2916                 for (sock = node->inputs.first; sock; sock = sock->next) {
2917                         sock->flag &= ~SOCK_IN_USE;
2918                 }
2919                 for (sock = node->outputs.first; sock; sock = sock->next) {
2920                         sock->flag &= ~SOCK_IN_USE;
2921                 }
2922         }
2923         
2924         for (link = ntree->links.first; link; link = link->next) {
2925                 /* link is unused if either side is disabled */
2926                 if ((link->fromsock->flag & SOCK_UNAVAIL) || (link->tosock->flag & SOCK_UNAVAIL))
2927                         continue;
2928                 
2929                 link->fromsock->flag |= SOCK_IN_USE;
2930                 link->tosock->flag |= SOCK_IN_USE;
2931         }
2932 }
2933
2934 static void ntree_update_link_pointers(bNodeTree *ntree)
2935 {
2936         bNode *node;
2937         bNodeSocket *sock;
2938         bNodeLink *link;
2939         
2940         /* first clear data */
2941         for (node = ntree->nodes.first; node; node = node->next) {
2942                 for (sock = node->inputs.first; sock; sock = sock->next) {
2943                         sock->link = NULL;
2944                 }
2945         }
2946
2947         for (link = ntree->links.first; link; link = link->next) {
2948                 link->tosock->link = link;
2949         }
2950         
2951         ntreeTagUsedSockets(ntree);
2952 }
2953
2954 static void ntree_validate_links(bNodeTree *ntree)
2955 {
2956         bNodeLink *link;
2957         
2958         for (link = ntree->links.first; link; link = link->next) {
2959                 link->flag |= NODE_LINK_VALID;
2960                 if (link->fromnode && link->tonode && link->fromnode->level <= link->tonode->level)
2961                         link->flag &= ~NODE_LINK_VALID;
2962                 else if (ntree->typeinfo->validate_link) {
2963                         if (!ntree->typeinfo->validate_link(ntree, link))
2964                                 link->flag &= ~NODE_LINK_VALID;
2965                 }
2966         }
2967 }
2968
2969 void ntreeVerifyNodes(struct Main *main, struct ID *id)
2970 {
2971         FOREACH_NODETREE(main, ntree, owner_id) {
2972                 bNode *node;
2973                 
2974                 for (node = ntree->nodes.first; node; node = node->next)
2975                         if (node->typeinfo->verifyfunc)
2976                                 node->typeinfo->verifyfunc(ntree, node, id);
2977         } FOREACH_NODETREE_END
2978 }
2979
2980 void ntreeUpdateTree(Main *bmain, bNodeTree *ntree)
2981 {
2982         bNode *node;
2983         
2984         if (!ntree)
2985                 return;
2986         
2987         /* avoid reentrant updates, can be caused by RNA update callbacks */
2988         if (ntree->is_updating)
2989                 return;
2990         ntree->is_updating = true;
2991         
2992         if (ntree->update & (NTREE_UPDATE_LINKS | NTREE_UPDATE_NODES)) {
2993                 /* set the bNodeSocket->link pointers */
2994                 ntree_update_link_pointers(ntree);
2995         }
2996         
2997         /* update individual nodes */
2998         for (node = ntree->nodes.first; node; node = node->next) {
2999                 /* node tree update tags override individual node update flags */
3000                 if ((node->update & NODE_UPDATE) || (ntree->update & NTREE_UPDATE)) {
3001                         if (node->typeinfo->updatefunc)
3002                                 node->typeinfo->updatefunc(ntree, node);
3003                         
3004                         nodeUpdateInternalLinks(ntree, node);
3005                 }
3006         }
3007         
3008         /* generic tree update callback */
3009         if (ntree->typeinfo->update)
3010                 ntree->typeinfo->update(ntree);
3011         /* XXX this should be moved into the tree type update callback for tree supporting node groups.
3012          * Currently the node tree interface is still a generic feature of the base NodeTree type.
3013          */
3014         if (ntree->update & NTREE_UPDATE_GROUP)
3015                 ntreeInterfaceTypeUpdate(ntree);
3016         
3017         /* XXX hack, should be done by depsgraph!! */
3018         if (bmain)
3019                 ntreeVerifyNodes(bmain, &ntree->id);
3020         
3021         if (ntree->update & (NTREE_UPDATE_LINKS | NTREE_UPDATE_NODES)) {
3022                 /* node updates can change sockets or links, repeat link pointer update afterward */
3023                 ntree_update_link_pointers(ntree);
3024                 
3025                 /* update the node level from link dependencies */
3026                 ntree_update_node_level(ntree);
3027                 
3028                 /* check link validity */
3029                 ntree_validate_links(ntree);
3030         }
3031         
3032         /* clear update flags */
3033         for (node = ntree->nodes.first; node; node = node->next) {
3034                 node->update = 0;
3035         }
3036         ntree->update = 0;
3037         
3038         ntree->is_updating = false;
3039 }
3040
3041 void nodeUpdate(bNodeTree *ntree, bNode *node)
3042 {
3043         /* avoid reentrant updates, can be caused by RNA update callbacks */
3044         if (ntree->is_updating)
3045                 return;
3046         ntree->is_updating = true;
3047         
3048         if (node->typeinfo->updatefunc)
3049                 node->typeinfo->updatefunc(ntree, node);
3050         
3051         nodeUpdateInternalLinks(ntree, node);
3052         
3053         /* clear update flag */
3054         node->update = 0;
3055         
3056         ntree->is_updating = false;
3057 }
3058
3059 bool nodeUpdateID(bNodeTree *ntree, ID *id)
3060 {
3061         bNode *node;
3062         bool changed = false;
3063         
3064         if (ELEM(NULL, id, ntree))
3065                 return changed;
3066         
3067         /* avoid reentrant updates, can be caused by RNA update callbacks */
3068         if (ntree->is_updating)
3069                 return changed;
3070         ntree->is_updating = true;
3071         
3072         for (node = ntree->nodes.first; node; node = node->next) {
3073                 if (node->id == id) {
3074                         changed = true;
3075                         node->update |= NODE_UPDATE_ID;
3076                         if (node->typeinfo->updatefunc)
3077                                 node->typeinfo->updatefunc(ntree, node);
3078                         /* clear update flag */
3079                         node->update = 0;
3080                 }
3081         }
3082         
3083         for (node = ntree->nodes.first; node; node = node->next) {
3084                 nodeUpdateInternalLinks(ntree, node);
3085         }
3086         
3087         ntree->is_updating = false;
3088         return changed;
3089 }
3090
3091 void nodeUpdateInternalLinks(bNodeTree *ntree, bNode *node)
3092 {
3093         BLI_freelistN(&node->internal_links);
3094         
3095         if (node->typeinfo && node->typeinfo->update_internal_links)
3096                 node->typeinfo->update_internal_links(ntree, node);
3097 }
3098
3099
3100 /* nodes that use ID data get synced with local data */
3101 void nodeSynchronizeID(bNode *node, bool copy_to_id)
3102 {
3103         if (node->id == NULL) return;
3104         
3105         if (ELEM(node->type, SH_NODE_MATERIAL, SH_NODE_MATERIAL_EXT)) {
3106                 bNodeSocket *sock;
3107                 Material *ma = (Material *)node->id;
3108                 int a;
3109                 short check_flags = SOCK_UNAVAIL;
3110
3111                 if (!copy_to_id)
3112                         check_flags |= SOCK_HIDDEN;
3113                 
3114                 /* hrmf, case in loop isn't super fast, but we don't edit 100s of material at same time either! */
3115                 for (a = 0, sock = node->inputs.first; sock; sock = sock->next, a++) {
3116                         if (!(sock->flag & check_flags)) {
3117                                 if (copy_to_id) {
3118                                         switch (a) {
3119                                                 case MAT_IN_COLOR:
3120                                                         copy_v3_v3(&ma->r, ((bNodeSocketValueRGBA *)sock->default_value)->value); break;
3121                                                 case MAT_IN_SPEC:
3122                                                         copy_v3_v3(&ma->specr, ((bNodeSocketValueRGBA *)sock->default_value)->value); break;
3123                                                 case MAT_IN_REFL:
3124                                                         ma->ref = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3125                                                 case MAT_IN_MIR:
3126                                                         copy_v3_v3(&ma->mirr, ((bNodeSocketValueRGBA *)sock->default_value)->value); break;
3127                                                 case MAT_IN_AMB:
3128                                                         ma->amb = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3129                                                 case MAT_IN_EMIT:
3130                                                         ma->emit = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3131                                                 case MAT_IN_SPECTRA:
3132                                                         ma->spectra = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3133                                                 case MAT_IN_RAY_MIRROR:
3134                                                         ma->ray_mirror = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3135                                                 case MAT_IN_ALPHA:
3136                                                         ma->alpha = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3137                                                 case MAT_IN_TRANSLUCENCY:
3138                                                         ma->translucency = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3139                                         }
3140                                 }
3141                                 else {
3142                                         switch (a) {
3143                                                 case MAT_IN_COLOR:
3144                                                         copy_v3_v3(((bNodeSocketValueRGBA *)sock->default_value)->value, &ma->r); break;
3145                                                 case MAT_IN_SPEC:
3146                                                         copy_v3_v3(((bNodeSocketValueRGBA *)sock->default_value)->value, &ma->specr); break;
3147                                                 case MAT_IN_REFL:
3148                                                         ((bNodeSocketValueFloat *)sock->default_value)->value = ma->ref; break;
3149                                                 case MAT_IN_MIR:
3150                                                         copy_v3_v3(((bNodeSocketValueRGBA *)sock->default_value)->value, &ma->mirr); break;
3151                                                 case MAT_IN_AMB:
3152                                                         ((bNodeSocketValueFloat *)sock->default_value)->value = ma->amb; break;
3153                                                 case MAT_IN_EMIT:
3154                                                         ((bNodeSocketValueFloat *)sock->default_value)->value = ma->emit; break;
3155                                                 case MAT_IN_SPECTRA:
3156                                                         ((bNodeSocketValueFloat *)sock->default_value)->value = ma->spectra; break;
3157                                                 case MAT_IN_RAY_MIRROR:
3158                                                         ((bNodeSocketValueFloat *)sock->default_value)->value = ma->ray_mirror; break;
3159                                                 case MAT_IN_ALPHA:
3160                                                         ((bNodeSocketValueFloat *)sock->default_value)->value = ma->alpha; break;
3161                                                 case MAT_IN_TRANSLUCENCY:
3162                                                         ((bNodeSocketValueFloat *)sock->default_value)->value = ma->translucency; break;
3163                                         }
3164                                 }
3165                         }
3166                 }
3167         }
3168 }
3169
3170
3171 /* ************* node type access ********** */
3172
3173 void nodeLabel(bNodeTree *ntree, bNode *node, char *label, int maxlen)
3174 {
3175         if (node->label[0] != '\0')
3176                 BLI_strncpy(label, node->label, maxlen);
3177         else if (node->typeinfo->labelfunc)
3178                 node->typeinfo->labelfunc(ntree, node, label, maxlen);
3179         else
3180                 BLI_strncpy(label, IFACE_(node->typeinfo->ui_name), maxlen);
3181 }
3182
3183 static void node_type_base_defaults(bNodeType *ntype)
3184 {
3185         /* default size values */
3186         node_type_size_preset(ntype, NODE_SIZE_DEFAULT);
3187         ntype->height = 100;
3188         ntype->minheight = 30;
3189         ntype->maxheight = FLT_MAX;
3190 }
3191
3192 /* allow this node for any tree type */
3193 static int node_poll_default(bNodeType *UNUSED(ntype), bNodeTree *UNUSED(ntree))
3194 {
3195         return true;
3196 }
3197
3198 /* use the basic poll function */
3199 static int node_poll_instance_default(bNode *node, bNodeTree *ntree)
3200 {
3201         return node->typeinfo->poll(node->typeinfo, ntree);
3202 }
3203
3204 void node_type_base(bNodeType *ntype, int type, const char *name, short nclass, short flag)
3205 {
3206         /* Use static type info header to map static int type to identifier string and RNA struct type.
3207          * Associate the RNA struct type with the bNodeType.
3208          * Dynamically registered nodes will create an RNA type at runtime
3209          * and call RNA_struct_blender_type_set, so this only needs to be done for old RNA types
3210          * created in makesrna, which can not be associated to a bNodeType immediately,
3211          * since bNodeTypes are registered afterward ...
3212          */
3213 #define DefNode(Category, ID, DefFunc, EnumName, StructName, UIName, UIDesc) \
3214                 case ID: \
3215                         BLI_strncpy(ntype->idname, #Category #StructName, sizeof(ntype->idname)); \
3216                         ntype->ext.srna = RNA_struct_find(#Category #StructName); \
3217                         BLI_assert(ntype->ext.srna != NULL); \
3218                         RNA_struct_blender_type_set(ntype->ext.srna, ntype); \
3219                         break;
3220         
3221         switch (type) {
3222 #include "NOD_static_types.h"
3223         }
3224         
3225         /* make sure we have a valid type (everything registered) */
3226         BLI_assert(ntype->idname[0] != '\0');
3227         
3228         ntype->type = type;
3229         BLI_strncpy(ntype->ui_name, name, sizeof(ntype->ui_name));
3230         ntype->nclass = nclass;
3231         ntype->flag = flag;
3232
3233         node_type_base_defaults(ntype);
3234
3235         ntype->poll = node_poll_default;
3236         ntype->poll_instance = node_poll_instance_default;
3237 }
3238
3239 void node_type_base_custom(bNodeType *ntype, const char *idname, const char *name, short nclass, short flag)
3240 {
3241         BLI_strncpy(ntype->idname, idname, sizeof(ntype->idname));
3242         ntype->type = NODE_CUSTOM;
3243         BLI_strncpy(ntype->ui_name, name, sizeof(ntype->ui_name));
3244         ntype->nclass = nclass;
3245         ntype->flag = flag;
3246
3247         node_type_base_defaults(ntype);
3248 }
3249
3250 static bool unique_socket_template_identifier_check(void *arg, const char *name)
3251 {
3252         bNodeSocketTemplate *ntemp;
3253         struct {bNodeSocketTemplate *list; bNodeSocketTemplate *ntemp;} *data = arg;
3254         
3255         for (ntemp = data->list; ntemp->type >= 0; ++ntemp) {
3256                 if (ntemp != data->ntemp) {
3257                         if (STREQ(ntemp->identifier, name)) {
3258                                 return true;
3259                         }
3260                 }
3261         }
3262         
3263         return false;
3264 }
3265
3266 static void unique_socket_template_identifier(bNodeSocketTemplate *list, bNodeSocketTemplate *ntemp, const char defname[], char delim)
3267 {
3268         struct {bNodeSocketTemplate *list; bNodeSocketTemplate *ntemp;} data;
3269         data.list = list;
3270         data.ntemp = ntemp;
3271
3272         BLI_uniquename_cb(unique_socket_template_identifier_check, &data, defname, delim, ntemp->identifier, sizeof(ntemp->identifier));
3273 }
3274
3275 void node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs)
3276 {
3277         bNodeSocketTemplate *ntemp;
3278         
3279         ntype->inputs = inputs;
3280         ntype->outputs = outputs;
3281         
3282         /* automatically generate unique identifiers */
3283         if (inputs) {
3284                 /* clear identifier strings (uninitialized memory) */
3285                 for (ntemp = inputs; ntemp->type >= 0; ++ntemp)
3286                         ntemp->identifier[0] = '\0';
3287                 
3288                 for (ntemp = inputs; ntemp->type >= 0; ++ntemp) {
3289                         BLI_strncpy(ntemp->identifier, ntemp->name, sizeof(ntemp->identifier));
3290                         unique_socket_template_identifier(inputs, ntemp, ntemp->identifier, &