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