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