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