Merge branch 'blender2.7'
[blender.git] / source / blender / nodes / intern / node_common.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) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Lukas Toenne.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/nodes/intern/node_common.c
29  *  \ingroup nodes
30  */
31
32 #include <string.h>
33 #include <stddef.h>
34
35 #include "DNA_node_types.h"
36
37 #include "BLI_listbase.h"
38 #include "BLI_string.h"
39 #include "BLI_utildefines.h"
40
41 #include "BLT_translation.h"
42
43 #include "BKE_node.h"
44
45 #include "RNA_types.h"
46
47 #include "MEM_guardedalloc.h"
48
49 #include "node_common.h"
50 #include "node_util.h"
51 #include "NOD_common.h"
52
53 enum {
54         REFINE_FORWARD  = 1 << 0,
55         REFINE_BACKWARD = 1 << 1,
56 };
57
58 /**** Group ****/
59
60 bNodeSocket *node_group_find_input_socket(bNode *groupnode, const char *identifier)
61 {
62         bNodeSocket *sock;
63         for (sock = groupnode->inputs.first; sock; sock = sock->next)
64                 if (STREQ(sock->identifier, identifier))
65                         return sock;
66         return NULL;
67 }
68
69 bNodeSocket *node_group_find_output_socket(bNode *groupnode, const char *identifier)
70 {
71         bNodeSocket *sock;
72         for (sock = groupnode->outputs.first; sock; sock = sock->next)
73                 if (STREQ(sock->identifier, identifier))
74                         return sock;
75         return NULL;
76 }
77
78 /* groups display their internal tree name as label */
79 void node_group_label(bNodeTree *UNUSED(ntree), bNode *node, char *label, int maxlen)
80 {
81         BLI_strncpy(label, (node->id) ? node->id->name + 2 : IFACE_("Missing Data-Block"), maxlen);
82 }
83
84 bool node_group_poll_instance(bNode *node, bNodeTree *nodetree)
85 {
86         if (node->typeinfo->poll(node->typeinfo, nodetree)) {
87                 bNodeTree *grouptree = (bNodeTree *)node->id;
88                 if (grouptree)
89                         return nodeGroupPoll(nodetree, grouptree);
90                 else
91                         return true;    /* without a linked node tree, group node is always ok */
92         }
93         else
94                 return false;
95 }
96
97 int nodeGroupPoll(bNodeTree *nodetree, bNodeTree *grouptree)
98 {
99         bNode *node;
100         int valid = 1;
101
102         /* unspecified node group, generally allowed
103          * (if anything, should be avoided on operator level)
104          */
105         if (grouptree == NULL)
106                 return 1;
107
108         if (nodetree == grouptree)
109                 return 0;
110
111         for (node = grouptree->nodes.first; node; node = node->next) {
112                 if (node->typeinfo->poll_instance && !node->typeinfo->poll_instance(node, nodetree)) {
113                         valid = 0;
114                         break;
115                 }
116         }
117         return valid;
118 }
119
120 /* used for both group nodes and interface nodes */
121 static bNodeSocket *group_verify_socket(bNodeTree *ntree, bNode *gnode, bNodeSocket *iosock, ListBase *verify_lb, int in_out)
122 {
123         bNodeSocket *sock;
124
125         for (sock = verify_lb->first; sock; sock = sock->next) {
126                 if (STREQ(sock->identifier, iosock->identifier))
127                         break;
128         }
129         if (sock) {
130                 strcpy(sock->name, iosock->name);
131
132                 if (iosock->typeinfo->interface_verify_socket)
133                         iosock->typeinfo->interface_verify_socket(ntree, iosock, gnode, sock, "interface");
134         }
135         else {
136                 sock = nodeAddSocket(ntree, gnode, in_out, iosock->idname, iosock->identifier, iosock->name);
137
138                 if (iosock->typeinfo->interface_init_socket)
139                         iosock->typeinfo->interface_init_socket(ntree, iosock, gnode, sock, "interface");
140         }
141
142         /* remove from list temporarily, to distinguish from orphaned sockets */
143         BLI_remlink(verify_lb, sock);
144
145         return sock;
146 }
147
148 /* used for both group nodes and interface nodes */
149 static void group_verify_socket_list(bNodeTree *ntree, bNode *gnode,
150                                      ListBase *iosock_lb, ListBase *verify_lb, int in_out)
151 {
152         bNodeSocket *iosock, *sock, *nextsock;
153
154         /* step by step compare */
155
156         iosock = iosock_lb->first;
157         for (; iosock; iosock = iosock->next) {
158                 /* abusing new_sock pointer for verification here! only used inside this function */
159                 iosock->new_sock = group_verify_socket(ntree, gnode, iosock, verify_lb, in_out);
160         }
161         /* leftovers are removed */
162         for (sock = verify_lb->first; sock; sock = nextsock) {
163                 nextsock = sock->next;
164                 nodeRemoveSocket(ntree, gnode, sock);
165         }
166         /* and we put back the verified sockets */
167         iosock = iosock_lb->first;
168         for (; iosock; iosock = iosock->next) {
169                 if (iosock->new_sock) {
170                         BLI_addtail(verify_lb, iosock->new_sock);
171                         iosock->new_sock = NULL;
172                 }
173         }
174 }
175
176 /* make sure all group node in ntree, which use ngroup, are sync'd */
177 void node_group_verify(struct bNodeTree *ntree, struct bNode *node, struct ID *id)
178 {
179         /* check inputs and outputs, and remove or insert them */
180         if (id == node->id) {
181                 if (id == NULL) {
182                         nodeRemoveAllSockets(ntree, node);
183                 }
184                 else {
185                         bNodeTree *ngroup = (bNodeTree *)node->id;
186                         group_verify_socket_list(ntree, node, &ngroup->inputs, &node->inputs, SOCK_IN);
187                         group_verify_socket_list(ntree, node, &ngroup->outputs, &node->outputs, SOCK_OUT);
188                 }
189         }
190 }
191
192 /**** FRAME ****/
193
194 static void node_frame_init(bNodeTree *UNUSED(ntree), bNode *node)
195 {
196         NodeFrame *data = (NodeFrame *)MEM_callocN(sizeof(NodeFrame), "frame node storage");
197         node->storage = data;
198
199         data->flag |= NODE_FRAME_SHRINK;
200
201         data->label_size = 20;
202 }
203
204 void register_node_type_frame(void)
205 {
206         /* frame type is used for all tree types, needs dynamic allocation */
207         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "frame node type");
208
209         node_type_base(ntype, NODE_FRAME, "Frame", NODE_CLASS_LAYOUT, NODE_BACKGROUND);
210         node_type_init(ntype, node_frame_init);
211         node_type_storage(ntype, "NodeFrame", node_free_standard_storage, node_copy_standard_storage);
212         node_type_size(ntype, 150, 100, 0);
213
214         ntype->needs_free = 1;
215         nodeRegisterType(ntype);
216 }
217
218
219 /* **************** REROUTE ******************** */
220
221 /* simple, only a single input and output here */
222 static void node_reroute_update_internal_links(bNodeTree *ntree, bNode *node)
223 {
224         bNodeLink *link;
225
226         /* Security check! */
227         if (!ntree)
228                 return;
229
230         link = MEM_callocN(sizeof(bNodeLink), "internal node link");
231         link->fromnode = node;
232         link->fromsock = node->inputs.first;
233         link->tonode = node;
234         link->tosock = node->outputs.first;
235         /* internal link is always valid */
236         link->flag |= NODE_LINK_VALID;
237         BLI_addtail(&node->internal_links, link);
238 }
239
240 static void node_reroute_init(bNodeTree *ntree, bNode *node)
241 {
242         /* Note: Cannot use socket templates for this, since it would reset the socket type
243          * on each file read via the template verification procedure.
244          */
245         nodeAddStaticSocket(ntree, node, SOCK_IN, SOCK_RGBA, PROP_NONE, "Input", "Input");
246         nodeAddStaticSocket(ntree, node, SOCK_OUT, SOCK_RGBA, PROP_NONE, "Output", "Output");
247 }
248
249 void register_node_type_reroute(void)
250 {
251         /* frame type is used for all tree types, needs dynamic allocation */
252         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "frame node type");
253
254         node_type_base(ntype, NODE_REROUTE, "Reroute", NODE_CLASS_LAYOUT, 0);
255         node_type_init(ntype, node_reroute_init);
256         node_type_internal_links(ntype, node_reroute_update_internal_links);
257
258         ntype->needs_free = 1;
259         nodeRegisterType(ntype);
260 }
261
262 static void node_reroute_inherit_type_recursive(bNodeTree *ntree, bNode *node, int flag)
263 {
264         bNodeSocket *input = node->inputs.first;
265         bNodeSocket *output = node->outputs.first;
266         bNodeLink *link;
267         int type = SOCK_FLOAT;
268         const char *type_idname = nodeStaticSocketType(type, PROP_NONE);
269
270         /* XXX it would be a little bit more efficient to restrict actual updates
271          * to rerout nodes connected to an updated node, but there's no reliable flag
272          * to indicate updated nodes (node->update is not set on linking).
273          */
274
275         node->done = 1;
276
277         /* recursive update */
278         for (link = ntree->links.first; link; link = link->next) {
279                 bNode *fromnode = link->fromnode;
280                 bNode *tonode = link->tonode;
281                 if (!tonode || !fromnode)
282                         continue;
283                 if (nodeLinkIsHidden(link))
284                         continue;
285
286                 if (flag & REFINE_FORWARD) {
287                         if (tonode == node && fromnode->type == NODE_REROUTE && !fromnode->done)
288                                 node_reroute_inherit_type_recursive(ntree, fromnode, REFINE_FORWARD);
289                 }
290                 if (flag & REFINE_BACKWARD) {
291                         if (fromnode == node && tonode->type == NODE_REROUTE && !tonode->done)
292                                 node_reroute_inherit_type_recursive(ntree, tonode, REFINE_BACKWARD);
293                 }
294         }
295
296         /* determine socket type from unambiguous input/output connection if possible */
297         if (input->limit == 1 && input->link) {
298                 type = input->link->fromsock->type;
299                 type_idname = nodeStaticSocketType(type, PROP_NONE);
300         }
301         else if (output->limit == 1 && output->link) {
302                 type = output->link->tosock->type;
303                 type_idname = nodeStaticSocketType(type, PROP_NONE);
304         }
305
306         if (input->type != type) {
307                 bNodeSocket *ninput = nodeAddSocket(ntree, node, SOCK_IN, type_idname, "input", "Input");
308                 for (link = ntree->links.first; link; link = link->next) {
309                         if (link->tosock == input) {
310                                 link->tosock = ninput;
311                                 ninput->link = link;
312                         }
313                 }
314                 nodeRemoveSocket(ntree, node, input);
315         }
316
317         if (output->type != type) {
318                 bNodeSocket *noutput = nodeAddSocket(ntree, node, SOCK_OUT, type_idname, "output", "Output");
319                 for (link = ntree->links.first; link; link = link->next) {
320                         if (link->fromsock == output) {
321                                 link->fromsock = noutput;
322                         }
323                 }
324                 nodeRemoveSocket(ntree, node, output);
325         }
326
327         nodeUpdateInternalLinks(ntree, node);
328 }
329
330 /* Global update function for Reroute node types.
331  * This depends on connected nodes, so must be done as a tree-wide update.
332  */
333 void ntree_update_reroute_nodes(bNodeTree *ntree)
334 {
335         bNode *node;
336
337         /* clear tags */
338         for (node = ntree->nodes.first; node; node = node->next)
339                 node->done = 0;
340
341         for (node = ntree->nodes.first; node; node = node->next)
342                 if (node->type == NODE_REROUTE && !node->done)
343                         node_reroute_inherit_type_recursive(ntree, node, REFINE_FORWARD | REFINE_BACKWARD);
344 }
345
346 static bool node_is_connected_to_output_recursive(bNodeTree *ntree, bNode *node)
347 {
348         bNodeLink *link;
349
350         /* avoid redundant checks, and infinite loops in case of cyclic node links */
351         if (node->done)
352                 return false;
353         node->done = 1;
354
355         /* main test, done before child loop so it catches output nodes themselves as well */
356         if (node->typeinfo->nclass == NODE_CLASS_OUTPUT && node->flag & NODE_DO_OUTPUT)
357                 return true;
358
359         /* test all connected nodes, first positive find is sufficient to return true */
360         for (link = ntree->links.first; link; link = link->next) {
361                 if (link->fromnode == node) {
362                         if (node_is_connected_to_output_recursive(ntree, link->tonode))
363                                 return true;
364                 }
365         }
366         return false;
367 }
368
369 bool BKE_node_is_connected_to_output(bNodeTree *ntree, bNode *node)
370 {
371         bNode *tnode;
372
373         /* clear flags */
374         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next)
375                 tnode->done = 0;
376
377         return node_is_connected_to_output_recursive(ntree, node);
378 }
379
380 void BKE_node_tree_unlink_id(ID *id, struct bNodeTree *ntree)
381 {
382         bNode *node;
383
384         for (node = ntree->nodes.first; node; node = node->next) {
385                 if (node->id == id) {
386                         node->id = NULL;
387                 }
388         }
389 }
390
391 /**** GROUP_INPUT / GROUP_OUTPUT ****/
392
393 static void node_group_input_init(bNodeTree *ntree, bNode *node)
394 {
395         node_group_input_verify(ntree, node, (ID *)ntree);
396 }
397
398 bNodeSocket *node_group_input_find_socket(bNode *node, const char *identifier)
399 {
400         bNodeSocket *sock;
401         for (sock = node->outputs.first; sock; sock = sock->next)
402                 if (STREQ(sock->identifier, identifier))
403                         return sock;
404         return NULL;
405 }
406
407 void node_group_input_verify(bNodeTree *ntree, bNode *node, ID *id)
408 {
409         /* check inputs and outputs, and remove or insert them */
410         if (id == (ID *)ntree) {
411                 /* value_in_out inverted for interface nodes to get correct socket value_property */
412                 group_verify_socket_list(ntree, node, &ntree->inputs, &node->outputs, SOCK_OUT);
413
414                 /* add virtual extension socket */
415                 nodeAddSocket(ntree, node, SOCK_OUT, "NodeSocketVirtual", "__extend__", "");
416         }
417 }
418
419 static void node_group_input_update(bNodeTree *ntree, bNode *node)
420 {
421         bNodeSocket *extsock = node->outputs.last;
422         bNodeLink *link, *linknext, *exposelink;
423         /* Adding a tree socket and verifying will remove the extension socket!
424          * This list caches the existing links from the extension socket
425          * so they can be recreated after verification.
426          */
427         ListBase tmplinks;
428
429         /* find links from the extension socket and store them */
430         BLI_listbase_clear(&tmplinks);
431         for (link = ntree->links.first; link; link = linknext) {
432                 linknext = link->next;
433                 if (nodeLinkIsHidden(link))
434                         continue;
435
436                 if (link->fromsock == extsock) {
437                         bNodeLink *tlink = MEM_callocN(sizeof(bNodeLink), "temporary link");
438                         *tlink = *link;
439                         BLI_addtail(&tmplinks, tlink);
440
441                         nodeRemLink(ntree, link);
442                 }
443         }
444
445         /* find valid link to expose */
446         exposelink = NULL;
447         for (link = tmplinks.first; link; link = link->next) {
448                 /* XXX Multiple sockets can be connected to the extension socket at once,
449                  * in that case the arbitrary first link determines name and type.
450                  * This could be improved by choosing the "best" type among all links,
451                  * whatever that means.
452                  */
453                 if (link->tosock->type != SOCK_CUSTOM) {
454                         exposelink = link;
455                         break;
456                 }
457         }
458
459         if (exposelink) {
460                 bNodeSocket *gsock, *newsock;
461
462                 gsock = ntreeAddSocketInterfaceFromSocket(ntree, exposelink->tonode, exposelink->tosock);
463
464                 node_group_input_verify(ntree, node, (ID *)ntree);
465                 newsock = node_group_input_find_socket(node, gsock->identifier);
466
467                 /* redirect links from the extension socket */
468                 for (link = tmplinks.first; link; link = link->next) {
469                         nodeAddLink(ntree, node, newsock, link->tonode, link->tosock);
470                 }
471
472         }
473
474         BLI_freelistN(&tmplinks);
475 }
476
477 void register_node_type_group_input(void)
478 {
479         /* used for all tree types, needs dynamic allocation */
480         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "node type");
481
482         node_type_base(ntype, NODE_GROUP_INPUT, "Group Input", NODE_CLASS_INTERFACE, 0);
483         node_type_size(ntype, 140, 80, 400);
484         node_type_init(ntype, node_group_input_init);
485         node_type_update(ntype, node_group_input_update, node_group_input_verify);
486
487         ntype->needs_free = 1;
488         nodeRegisterType(ntype);
489 }
490
491 static void node_group_output_init(bNodeTree *ntree, bNode *node)
492 {
493         node_group_output_verify(ntree, node, (ID *)ntree);
494 }
495
496 bNodeSocket *node_group_output_find_socket(bNode *node, const char *identifier)
497 {
498         bNodeSocket *sock;
499         for (sock = node->inputs.first; sock; sock = sock->next)
500                 if (STREQ(sock->identifier, identifier))
501                         return sock;
502         return NULL;
503 }
504
505 void node_group_output_verify(bNodeTree *ntree, bNode *node, ID *id)
506 {
507         /* check inputs and outputs, and remove or insert them */
508         if (id == (ID *)ntree) {
509                 /* value_in_out inverted for interface nodes to get correct socket value_property */
510                 group_verify_socket_list(ntree, node, &ntree->outputs, &node->inputs, SOCK_IN);
511
512                 /* add virtual extension socket */
513                 nodeAddSocket(ntree, node, SOCK_IN, "NodeSocketVirtual", "__extend__", "");
514         }
515 }
516
517 static void node_group_output_update(bNodeTree *ntree, bNode *node)
518 {
519         bNodeSocket *extsock = node->inputs.last;
520         bNodeLink *link, *linknext, *exposelink;
521         /* Adding a tree socket and verifying will remove the extension socket!
522          * This list caches the existing links to the extension socket
523          * so they can be recreated after verification.
524          */
525         ListBase tmplinks;
526
527         /* find links to the extension socket and store them */
528         BLI_listbase_clear(&tmplinks);
529         for (link = ntree->links.first; link; link = linknext) {
530                 linknext = link->next;
531                 if (nodeLinkIsHidden(link))
532                         continue;
533
534                 if (link->tosock == extsock) {
535                         bNodeLink *tlink = MEM_callocN(sizeof(bNodeLink), "temporary link");
536                         *tlink = *link;
537                         BLI_addtail(&tmplinks, tlink);
538
539                         nodeRemLink(ntree, link);
540                 }
541         }
542
543         /* find valid link to expose */
544         exposelink = NULL;
545         for (link = tmplinks.first; link; link = link->next) {
546                 /* XXX Multiple sockets can be connected to the extension socket at once,
547                  * in that case the arbitrary first link determines name and type.
548                  * This could be improved by choosing the "best" type among all links,
549                  * whatever that means.
550                  */
551                 if (link->fromsock->type != SOCK_CUSTOM) {
552                         exposelink = link;
553                         break;
554                 }
555         }
556
557         if (exposelink) {
558                 bNodeSocket *gsock, *newsock;
559
560                 /* XXX what if connecting virtual to virtual socket?? */
561                 gsock = ntreeAddSocketInterfaceFromSocket(ntree, exposelink->fromnode, exposelink->fromsock);
562
563                 node_group_output_verify(ntree, node, (ID *)ntree);
564                 newsock = node_group_output_find_socket(node, gsock->identifier);
565
566                 /* redirect links to the extension socket */
567                 for (link = tmplinks.first; link; link = link->next) {
568                         nodeAddLink(ntree, link->fromnode, link->fromsock, node, newsock);
569                 }
570         }
571
572         BLI_freelistN(&tmplinks);
573 }
574
575 void register_node_type_group_output(void)
576 {
577         /* used for all tree types, needs dynamic allocation */
578         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "node type");
579
580         node_type_base(ntype, NODE_GROUP_OUTPUT, "Group Output", NODE_CLASS_INTERFACE, 0);
581         node_type_size(ntype, 140, 80, 400);
582         node_type_init(ntype, node_group_output_init);
583         node_type_update(ntype, node_group_output_update, node_group_output_verify);
584
585         ntype->needs_free = 1;
586         nodeRegisterType(ntype);
587 }