source/blender/blenkernel/intern/node.c

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