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