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