GSOC 2013 paint
[blender-staging.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
33 #include <string.h>
34 #include <stddef.h>
35
36 #include "DNA_node_types.h"
37
38 #include "BLI_listbase.h"
39 #include "BLI_string.h"
40 #include "BLI_utildefines.h"
41
42 #include "BLF_translation.h"
43
44 #include "BKE_node.h"
45
46 #include "RNA_access.h"
47 #include "RNA_types.h"
48
49 #include "MEM_guardedalloc.h"
50
51 #include "node_common.h"
52 #include "node_util.h"
53 #include "node_exec.h"
54 #include "NOD_socket.h"
55 #include "NOD_common.h"
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 Datablock"), maxlen);
82 }
83
84 int 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                 bNodeTree *ngroup = (bNodeTree *)node->id;
182                 group_verify_socket_list(ntree, node, &ngroup->inputs, &node->inputs, SOCK_IN);
183                 group_verify_socket_list(ntree, node, &ngroup->outputs, &node->outputs, SOCK_OUT);
184         }
185 }
186
187 /**** FRAME ****/
188
189 static void node_frame_init(bNodeTree *UNUSED(ntree), bNode *node)
190 {
191         NodeFrame *data = (NodeFrame *)MEM_callocN(sizeof(NodeFrame), "frame node storage");
192         node->storage = data;
193         
194         data->flag |= NODE_FRAME_SHRINK;
195         
196         data->label_size = 20;
197 }
198
199 void register_node_type_frame(void)
200 {
201         /* frame type is used for all tree types, needs dynamic allocation */
202         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "frame node type");
203
204         node_type_base(ntype, NODE_FRAME, "Frame", NODE_CLASS_LAYOUT, NODE_BACKGROUND);
205         node_type_init(ntype, node_frame_init);
206         node_type_storage(ntype, "NodeFrame", node_free_standard_storage, node_copy_standard_storage);
207         node_type_size(ntype, 150, 100, 0);
208         node_type_compatibility(ntype, NODE_OLD_SHADING | NODE_NEW_SHADING);
209         
210         ntype->needs_free = 1;
211         nodeRegisterType(ntype);
212 }
213
214
215 /* **************** REROUTE ******************** */
216
217 /* simple, only a single input and output here */
218 static void node_reroute_update_internal_links(bNodeTree *ntree, bNode *node)
219 {
220         bNodeLink *link;
221
222         /* Security check! */
223         if (!ntree)
224                 return;
225
226         link = MEM_callocN(sizeof(bNodeLink), "internal node link");
227         link->fromnode = node;
228         link->fromsock = node->inputs.first;
229         link->tonode = node;
230         link->tosock = node->outputs.first;
231         /* internal link is always valid */
232         link->flag |= NODE_LINK_VALID;
233         BLI_addtail(&node->internal_links, link);
234 }
235
236 static void node_reroute_init(bNodeTree *ntree, bNode *node)
237 {
238         /* Note: Cannot use socket templates for this, since it would reset the socket type
239          * on each file read via the template verification procedure.
240          */
241         nodeAddStaticSocket(ntree, node, SOCK_IN, SOCK_RGBA, PROP_NONE, "Input", "Input");
242         nodeAddStaticSocket(ntree, node, SOCK_OUT, SOCK_RGBA, PROP_NONE, "Output", "Output");
243 }
244
245 void register_node_type_reroute(void)
246 {
247         /* frame type is used for all tree types, needs dynamic allocation */
248         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "frame node type");
249         
250         node_type_base(ntype, NODE_REROUTE, "Reroute", NODE_CLASS_LAYOUT, 0);
251         node_type_init(ntype, node_reroute_init);
252         node_type_internal_links(ntype, node_reroute_update_internal_links);
253         
254         ntype->needs_free = 1;
255         nodeRegisterType(ntype);
256 }
257
258 static void node_reroute_inherit_type_recursive(bNodeTree *ntree, bNode *node)
259 {
260         bNodeSocket *input = node->inputs.first;
261         bNodeSocket *output = node->outputs.first;
262         bNodeLink *link;
263         int type = SOCK_FLOAT;
264         const char *type_idname = nodeStaticSocketType(type, PROP_NONE);
265         
266         /* XXX it would be a little bit more efficient to restrict actual updates
267          * to rerout nodes connected to an updated node, but there's no reliable flag
268          * to indicate updated nodes (node->update is not set on linking).
269          */
270         
271         node->done = 1;
272         
273         /* recursive update */
274         for (link = ntree->links.first; link; link = link->next) {
275                 bNode *fromnode = link->fromnode;
276                 bNode *tonode = link->tonode;
277                 if (!tonode || !fromnode)
278                         continue;
279                 if (nodeLinkIsHidden(link))
280                         continue;
281                 
282                 if (tonode == node && fromnode->type == NODE_REROUTE && !fromnode->done)
283                         node_reroute_inherit_type_recursive(ntree, fromnode);
284                 
285                 if (fromnode == node && tonode->type == NODE_REROUTE && !tonode->done)
286                         node_reroute_inherit_type_recursive(ntree, tonode);
287         }
288         
289         /* determine socket type from unambiguous input/output connection if possible */
290         if (input->limit == 1 && input->link) {
291                 type = input->link->fromsock->type;
292                 type_idname = nodeStaticSocketType(type, PROP_NONE);
293         }
294         else if (output->limit == 1 && output->link) {
295                 type = output->link->tosock->type;
296                 type_idname = nodeStaticSocketType(type, PROP_NONE);
297         }
298         
299         if (input->type != type) {
300                 bNodeSocket *ninput = nodeAddSocket(ntree, node, SOCK_IN, type_idname, "input", "Input");
301                 for (link = ntree->links.first; link; link = link->next) {
302                         if (link->tosock == input) {
303                                 link->tosock = ninput;
304                                 ninput->link = link;
305                         }
306                 }
307                 nodeRemoveSocket(ntree, node, input);
308         }
309         
310         if (output->type != type) {
311                 bNodeSocket *noutput = nodeAddSocket(ntree, node, SOCK_OUT, type_idname, "output", "Output");
312                 for (link = ntree->links.first; link; link = link->next) {
313                         if (link->fromsock == output) {
314                                 link->fromsock = noutput;
315                         }
316                 }
317                 nodeRemoveSocket(ntree, node, output);
318         }
319         
320         nodeUpdateInternalLinks(ntree, node);
321 }
322
323 /* Global update function for Reroute node types.
324  * This depends on connected nodes, so must be done as a tree-wide update.
325  */
326 void ntree_update_reroute_nodes(bNodeTree *ntree)
327 {
328         bNode *node;
329         
330         /* clear tags */
331         for (node = ntree->nodes.first; node; node = node->next)
332                 node->done = 0;
333         
334         for (node = ntree->nodes.first; node; node = node->next)
335                 if (node->type == NODE_REROUTE && !node->done)
336                         node_reroute_inherit_type_recursive(ntree, node);
337 }
338
339 void BKE_node_tree_unlink_id(ID *id, struct bNodeTree *ntree)
340 {
341         bNode *node;
342
343         for (node = ntree->nodes.first; node; node = node->next) {
344                 if (node->id == id) {
345                         node->id = NULL;
346                 }
347         }
348 }
349
350 /**** GROUP_INPUT / GROUP_OUTPUT ****/
351
352 static void node_group_input_init(bNodeTree *ntree, bNode *node)
353 {
354         node_group_input_verify(ntree, node, (ID *)ntree);
355 }
356
357 bNodeSocket *node_group_input_find_socket(bNode *node, const char *identifier)
358 {
359         bNodeSocket *sock;
360         for (sock = node->outputs.first; sock; sock = sock->next)
361                 if (STREQ(sock->identifier, identifier))
362                         return sock;
363         return NULL;
364 }
365
366 void node_group_input_verify(bNodeTree *ntree, bNode *node, ID *id)
367 {
368         /* check inputs and outputs, and remove or insert them */
369         if (id == (ID *)ntree) {
370                 /* value_in_out inverted for interface nodes to get correct socket value_property */
371                 group_verify_socket_list(ntree, node, &ntree->inputs, &node->outputs, SOCK_OUT);
372                 
373                 /* add virtual extension socket */
374                 nodeAddSocket(ntree, node, SOCK_OUT, "NodeSocketVirtual", "__extend__", "");
375         }
376 }
377
378 static void node_group_input_update(bNodeTree *ntree, bNode *node)
379 {
380         bNodeSocket *extsock = node->outputs.last;
381         bNodeLink *link, *linknext, *exposelink;
382         /* Adding a tree socket and verifying will remove the extension socket!
383          * This list caches the existing links from the extension socket
384          * so they can be recreated after verification.
385          */
386         ListBase tmplinks;
387         
388         /* find links from the extension socket and store them */
389         BLI_listbase_clear(&tmplinks);
390         for (link = ntree->links.first; link; link = linknext) {
391                 linknext = link->next;
392                 if (nodeLinkIsHidden(link))
393                         continue;
394                 
395                 if (link->fromsock == extsock) {
396                         bNodeLink *tlink = MEM_callocN(sizeof(bNodeLink), "temporary link");
397                         *tlink = *link;
398                         BLI_addtail(&tmplinks, tlink);
399                         
400                         nodeRemLink(ntree, link);
401                 }
402         }
403         
404         /* find valid link to expose */
405         exposelink = NULL;
406         for (link = tmplinks.first; link; link = link->next) {
407                 /* XXX Multiple sockets can be connected to the extension socket at once,
408                  * in that case the arbitrary first link determines name and type.
409                  * This could be improved by choosing the "best" type among all links,
410                  * whatever that means.
411                  */
412                 if (link->tosock->type != SOCK_CUSTOM) {
413                         exposelink = link;
414                         break;
415                 }
416         }
417         
418         if (exposelink) {
419                 bNodeSocket *gsock, *newsock;
420                 
421                 gsock = ntreeAddSocketInterfaceFromSocket(ntree, exposelink->tonode, exposelink->tosock);
422                 
423                 node_group_input_verify(ntree, node, (ID *)ntree);
424                 newsock = node_group_input_find_socket(node, gsock->identifier);
425                 
426                 /* redirect links from the extension socket */
427                 for (link = tmplinks.first; link; link = link->next) {
428                         nodeAddLink(ntree, node, newsock, link->tonode, link->tosock);
429                 }
430                 
431         }
432         
433         BLI_freelistN(&tmplinks);
434 }
435
436 void register_node_type_group_input(void)
437 {
438         /* used for all tree types, needs dynamic allocation */
439         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "node type");
440         
441         node_type_base(ntype, NODE_GROUP_INPUT, "Group Input", NODE_CLASS_INTERFACE, 0);
442         node_type_size(ntype, 140, 80, 400);
443         node_type_init(ntype, node_group_input_init);
444         node_type_update(ntype, node_group_input_update, node_group_input_verify);
445         node_type_compatibility(ntype, NODE_OLD_SHADING | NODE_NEW_SHADING);
446         
447         ntype->needs_free = 1;
448         nodeRegisterType(ntype);
449 }
450
451 static void node_group_output_init(bNodeTree *ntree, bNode *node)
452 {
453         node_group_output_verify(ntree, node, (ID *)ntree);
454 }
455
456 bNodeSocket *node_group_output_find_socket(bNode *node, const char *identifier)
457 {
458         bNodeSocket *sock;
459         for (sock = node->inputs.first; sock; sock = sock->next)
460                 if (STREQ(sock->identifier, identifier))
461                         return sock;
462         return NULL;
463 }
464
465 void node_group_output_verify(bNodeTree *ntree, bNode *node, ID *id)
466 {
467         /* check inputs and outputs, and remove or insert them */
468         if (id == (ID *)ntree) {
469                 /* value_in_out inverted for interface nodes to get correct socket value_property */
470                 group_verify_socket_list(ntree, node, &ntree->outputs, &node->inputs, SOCK_IN);
471                 
472                 /* add virtual extension socket */
473                 nodeAddSocket(ntree, node, SOCK_IN, "NodeSocketVirtual", "__extend__", "");
474         }
475 }
476
477 static void node_group_output_update(bNodeTree *ntree, bNode *node)
478 {
479         bNodeSocket *extsock = node->inputs.last;
480         bNodeLink *link, *linknext, *exposelink;
481         /* Adding a tree socket and verifying will remove the extension socket!
482          * This list caches the existing links to the extension socket
483          * so they can be recreated after verification.
484          */
485         ListBase tmplinks;
486         
487         /* find links to the extension socket and store them */
488         BLI_listbase_clear(&tmplinks);
489         for (link = ntree->links.first; link; link = linknext) {
490                 linknext = link->next;
491                 if (nodeLinkIsHidden(link))
492                         continue;
493                 
494                 if (link->tosock == extsock) {
495                         bNodeLink *tlink = MEM_callocN(sizeof(bNodeLink), "temporary link");
496                         *tlink = *link;
497                         BLI_addtail(&tmplinks, tlink);
498                         
499                         nodeRemLink(ntree, link);
500                 }
501         }
502         
503         /* find valid link to expose */
504         exposelink = NULL;
505         for (link = tmplinks.first; link; link = link->next) {
506                 /* XXX Multiple sockets can be connected to the extension socket at once,
507                  * in that case the arbitrary first link determines name and type.
508                  * This could be improved by choosing the "best" type among all links,
509                  * whatever that means.
510                  */
511                 if (link->fromsock->type != SOCK_CUSTOM) {
512                         exposelink = link;
513                         break;
514                 }
515         }
516         
517         if (exposelink) {
518                 bNodeSocket *gsock, *newsock;
519                 
520                 /* XXX what if connecting virtual to virtual socket?? */
521                 gsock = ntreeAddSocketInterfaceFromSocket(ntree, exposelink->fromnode, exposelink->fromsock);
522                 
523                 node_group_output_verify(ntree, node, (ID *)ntree);
524                 newsock = node_group_output_find_socket(node, gsock->identifier);
525                 
526                 /* redirect links to the extension socket */
527                 for (link = tmplinks.first; link; link = link->next) {
528                         nodeAddLink(ntree, link->fromnode, link->fromsock, node, newsock);
529                 }
530         }
531         
532         BLI_freelistN(&tmplinks);
533 }
534
535 void register_node_type_group_output(void)
536 {
537         /* used for all tree types, needs dynamic allocation */
538         bNodeType *ntype = MEM_callocN(sizeof(bNodeType), "node type");
539         
540         node_type_base(ntype, NODE_GROUP_OUTPUT, "Group Output", NODE_CLASS_INTERFACE, 0);
541         node_type_size(ntype, 140, 80, 400);
542         node_type_init(ntype, node_group_output_init);
543         node_type_update(ntype, node_group_output_update, node_group_output_verify);
544         node_type_compatibility(ntype, NODE_OLD_SHADING | NODE_NEW_SHADING);
545         
546         ntype->needs_free = 1;
547         nodeRegisterType(ntype);
548 }