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