Python API: add Python-defined node groups for shaders and compositing.
[blender.git] / source / blender / editors / space_node / node_relationships.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2005 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup spnode
22  */
23
24 #include "MEM_guardedalloc.h"
25
26 #include "DNA_anim_types.h"
27 #include "DNA_node_types.h"
28
29 #include "BLI_math.h"
30 #include "BLI_blenlib.h"
31 #include "BLI_easing.h"
32
33 #include "BKE_animsys.h"
34 #include "BKE_context.h"
35 #include "BKE_library.h"
36 #include "BKE_main.h"
37 #include "BKE_node.h"
38
39 #include "ED_node.h"  /* own include */
40 #include "ED_screen.h"
41 #include "ED_render.h"
42 #include "ED_util.h"
43
44 #include "RNA_access.h"
45 #include "RNA_define.h"
46
47 #include "WM_api.h"
48 #include "WM_types.h"
49
50 #include "UI_view2d.h"
51 #include "UI_resources.h"
52
53 #include "BLT_translation.h"
54
55 #include "node_intern.h"  /* own include */
56
57 /* ****************** Relations helpers *********************** */
58
59 static bool ntree_has_drivers(bNodeTree *ntree)
60 {
61         AnimData *adt = BKE_animdata_from_id(&ntree->id);
62         if (adt == NULL) {
63                 return false;
64         }
65         return !BLI_listbase_is_empty(&adt->drivers);
66 }
67
68 static bool ntree_check_nodes_connected_dfs(bNodeTree *ntree,
69                                             bNode *from,
70                                             bNode *to)
71 {
72         if (from->flag & NODE_TEST) {
73                 return false;
74         }
75         from->flag |= NODE_TEST;
76         for (bNodeLink *link = ntree->links.first; link != NULL; link = link->next) {
77                 if (link->fromnode == from) {
78                         if (link->tonode == to) {
79                                 return true;
80                         }
81                         else {
82                                 if (ntree_check_nodes_connected_dfs(ntree, link->tonode, to)) {
83                                         return true;
84                                 }
85                         }
86                 }
87         }
88         return false;
89 }
90
91 static bool ntree_check_nodes_connected(bNodeTree *ntree, bNode *from, bNode *to)
92 {
93         if (from == to) {
94                 return true;
95         }
96         ntreeNodeFlagSet(ntree, NODE_TEST, false);
97         return ntree_check_nodes_connected_dfs(ntree, from, to);
98 }
99
100 static bool node_group_has_output_dfs(bNode *node)
101 {
102         bNodeTree *ntree = (bNodeTree *)node->id;
103         if (ntree->id.tag & LIB_TAG_DOIT) {
104                 return false;
105         }
106         ntree->id.tag |= LIB_TAG_DOIT;
107         for (bNode *current_node = ntree->nodes.first;
108              current_node != NULL;
109              current_node = current_node->next)
110         {
111                 if (current_node->type == NODE_GROUP) {
112                         if (current_node->id && node_group_has_output_dfs(current_node)) {
113                                 return true;
114                         }
115                 }
116                 if (current_node->flag & NODE_DO_OUTPUT &&
117                     current_node->type != NODE_GROUP_OUTPUT)
118                 {
119                         return true;
120                 }
121         }
122         return false;
123 }
124
125 static bool node_group_has_output(Main *bmain, bNode *node)
126 {
127         BLI_assert(ELEM(node->type, NODE_GROUP, NODE_CUSTOM_GROUP));
128         bNodeTree *ntree = (bNodeTree *)node->id;
129         if (ntree == NULL) {
130                 return false;
131         }
132         BKE_main_id_tag_listbase(&bmain->nodetrees, LIB_TAG_DOIT, false);
133         return node_group_has_output_dfs(node);
134 }
135
136 bool node_connected_to_output(Main *bmain, bNodeTree *ntree, bNode *node)
137 {
138         /* Special case for drivers: if node tree has any drivers we assume it is
139          * always to be tagged for update when node changes. Otherwise we will be
140          * doomed to do some deep and nasty deep search of indirect dependencies,
141          * which will be too complicated without real benefit.
142          */
143         if (ntree_has_drivers(ntree)) {
144                 return true;
145         }
146         for (bNode *current_node = ntree->nodes.first;
147              current_node != NULL;
148              current_node = current_node->next)
149         {
150                 /* Special case for group nodes -- if modified node connected to a group
151                  * with active output inside we consider refresh is needed.
152                  *
153                  * We could make check more grained here by taking which socket the node
154                  * is connected to and so eventually.
155                  */
156                 if (ELEM(current_node->type, NODE_GROUP, NODE_CUSTOM_GROUP)) {
157                         if (current_node->id != NULL &&
158                             ntree_has_drivers((bNodeTree *)current_node->id))
159                         {
160                                 return true;
161                         }
162                         if (ntree_check_nodes_connected(ntree, node, current_node) &&
163                             node_group_has_output(bmain, current_node))
164                         {
165                                 return true;
166                         }
167                 }
168                 if (current_node->flag & NODE_DO_OUTPUT) {
169                         if (ntree_check_nodes_connected(ntree, node, current_node)) {
170                                 return true;
171                         }
172                 }
173         }
174         return false;
175 }
176
177 /* ****************** Add *********************** */
178
179
180 typedef struct bNodeListItem {
181         struct bNodeListItem *next, *prev;
182         struct bNode *node;
183 } bNodeListItem;
184
185 typedef struct NodeInsertOfsData {
186         bNodeTree *ntree;
187         bNode *insert;        /* inserted node */
188         bNode *prev, *next;   /* prev/next node in the chain */
189         bNode *insert_parent;
190
191         wmTimer *anim_timer;
192
193         float offset_x;       /* offset to apply to node chain */
194 } NodeInsertOfsData;
195
196 static int sort_nodes_locx(const void *a, const void *b)
197 {
198         const bNodeListItem *nli1 = a;
199         const bNodeListItem *nli2 = b;
200         const bNode *node1 = nli1->node;
201         const bNode *node2 = nli2->node;
202
203         if (node1->locx > node2->locx)
204                 return 1;
205         else
206                 return 0;
207 }
208
209 static bool socket_is_available(bNodeTree *UNUSED(ntree), bNodeSocket *sock, const bool allow_used)
210 {
211         if (nodeSocketIsHidden(sock))
212                 return 0;
213
214         if (!allow_used && (sock->flag & SOCK_IN_USE))
215                 return 0;
216
217         return 1;
218 }
219
220 static bNodeSocket *best_socket_output(bNodeTree *ntree, bNode *node, bNodeSocket *sock_target, const bool allow_multiple)
221 {
222         bNodeSocket *sock;
223
224         /* first look for selected output */
225         for (sock = node->outputs.first; sock; sock = sock->next) {
226                 if (!socket_is_available(ntree, sock, allow_multiple))
227                         continue;
228
229                 if (sock->flag & SELECT)
230                         return sock;
231         }
232
233         /* try to find a socket with a matching name */
234         for (sock = node->outputs.first; sock; sock = sock->next) {
235                 if (!socket_is_available(ntree, sock, allow_multiple))
236                         continue;
237
238                 /* check for same types */
239                 if (sock->type == sock_target->type) {
240                         if (STREQ(sock->name, sock_target->name))
241                                 return sock;
242                 }
243         }
244
245         /* otherwise settle for the first available socket of the right type */
246         for (sock = node->outputs.first; sock; sock = sock->next) {
247
248                 if (!socket_is_available(ntree, sock, allow_multiple))
249                         continue;
250
251                 /* check for same types */
252                 if (sock->type == sock_target->type) {
253                         return sock;
254                 }
255         }
256
257         return NULL;
258 }
259
260 /* this is a bit complicated, but designed to prioritize finding
261  * sockets of higher types, such as image, first */
262 static bNodeSocket *best_socket_input(bNodeTree *ntree, bNode *node, int num, int replace)
263 {
264         bNodeSocket *sock;
265         int socktype, maxtype = 0;
266         int a = 0;
267
268         for (sock = node->inputs.first; sock; sock = sock->next) {
269                 maxtype = max_ii(sock->type, maxtype);
270         }
271
272         /* find sockets of higher 'types' first (i.e. image) */
273         for (socktype = maxtype; socktype >= 0; socktype--) {
274                 for (sock = node->inputs.first; sock; sock = sock->next) {
275
276                         if (!socket_is_available(ntree, sock, replace)) {
277                                 a++;
278                                 continue;
279                         }
280
281                         if (sock->type == socktype) {
282                                 /* increment to make sure we don't keep finding
283                                  * the same socket on every attempt running this function */
284                                 a++;
285                                 if (a > num)
286                                         return sock;
287                         }
288                 }
289         }
290
291         return NULL;
292 }
293
294 static bool snode_autoconnect_input(SpaceNode *snode, bNode *node_fr, bNodeSocket *sock_fr, bNode *node_to, bNodeSocket *sock_to, int replace)
295 {
296         bNodeTree *ntree = snode->edittree;
297
298         /* then we can connect */
299         if (replace)
300                 nodeRemSocketLinks(ntree, sock_to);
301
302         nodeAddLink(ntree, node_fr, sock_fr, node_to, sock_to);
303         return true;
304 }
305
306 static void snode_autoconnect(Main *bmain, SpaceNode *snode, const bool allow_multiple, const bool replace)
307 {
308         bNodeTree *ntree = snode->edittree;
309         ListBase *nodelist = MEM_callocN(sizeof(ListBase), "items_list");
310         bNodeListItem *nli;
311         bNode *node;
312         int i, numlinks = 0;
313
314         for (node = ntree->nodes.first; node; node = node->next) {
315                 if (node->flag & NODE_SELECT) {
316                         nli = MEM_mallocN(sizeof(bNodeListItem), "temporary node list item");
317                         nli->node = node;
318                         BLI_addtail(nodelist, nli);
319                 }
320         }
321
322         /* sort nodes left to right */
323         BLI_listbase_sort(nodelist, sort_nodes_locx);
324
325         for (nli = nodelist->first; nli; nli = nli->next) {
326                 bNode *node_fr, *node_to;
327                 bNodeSocket *sock_fr, *sock_to;
328                 bool has_selected_inputs = false;
329
330                 if (nli->next == NULL) break;
331
332                 node_fr = nli->node;
333                 node_to = nli->next->node;
334                 /* corner case: input/output node aligned the wrong way around (T47729) */
335                 if (BLI_listbase_is_empty(&node_to->inputs) || BLI_listbase_is_empty(&node_fr->outputs)) {
336                         SWAP(bNode *, node_fr, node_to);
337                 }
338
339                 /* if there are selected sockets, connect those */
340                 for (sock_to = node_to->inputs.first; sock_to; sock_to = sock_to->next) {
341                         if (sock_to->flag & SELECT) {
342                                 has_selected_inputs = 1;
343
344                                 if (!socket_is_available(ntree, sock_to, replace))
345                                         continue;
346
347                                 /* check for an appropriate output socket to connect from */
348                                 sock_fr = best_socket_output(ntree, node_fr, sock_to, allow_multiple);
349                                 if (!sock_fr)
350                                         continue;
351
352                                 if (snode_autoconnect_input(snode, node_fr, sock_fr, node_to, sock_to, replace)) {
353                                         numlinks++;
354                                 }
355                         }
356                 }
357
358                 if (!has_selected_inputs) {
359                         /* no selected inputs, connect by finding suitable match */
360                         int num_inputs = BLI_listbase_count(&node_to->inputs);
361
362                         for (i = 0; i < num_inputs; i++) {
363
364                                 /* find the best guess input socket */
365                                 sock_to = best_socket_input(ntree, node_to, i, replace);
366                                 if (!sock_to)
367                                         continue;
368
369                                 /* check for an appropriate output socket to connect from */
370                                 sock_fr = best_socket_output(ntree, node_fr, sock_to, allow_multiple);
371                                 if (!sock_fr)
372                                         continue;
373
374                                 if (snode_autoconnect_input(snode, node_fr, sock_fr, node_to, sock_to, replace)) {
375                                         numlinks++;
376                                         break;
377                                 }
378                         }
379                 }
380         }
381
382         if (numlinks > 0) {
383                 ntreeUpdateTree(bmain, ntree);
384         }
385
386         BLI_freelistN(nodelist);
387         MEM_freeN(nodelist);
388 }
389
390 /* *************************** link viewer op ******************** */
391
392 static int node_link_viewer(const bContext *C, bNode *tonode)
393 {
394         SpaceNode *snode = CTX_wm_space_node(C);
395         bNode *node;
396         bNodeLink *link;
397         bNodeSocket *sock;
398
399         /* context check */
400         if (tonode == NULL || BLI_listbase_is_empty(&tonode->outputs))
401                 return OPERATOR_CANCELLED;
402         if (ELEM(tonode->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER))
403                 return OPERATOR_CANCELLED;
404
405         /* get viewer */
406         for (node = snode->edittree->nodes.first; node; node = node->next)
407                 if (ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER))
408                         if (node->flag & NODE_DO_OUTPUT)
409                                 break;
410         /* no viewer, we make one active */
411         if (node == NULL) {
412                 for (node = snode->edittree->nodes.first; node; node = node->next) {
413                         if (ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER)) {
414                                 node->flag |= NODE_DO_OUTPUT;
415                                 break;
416                         }
417                 }
418         }
419
420         sock = NULL;
421
422         /* try to find an already connected socket to cycle to the next */
423         if (node) {
424                 link = NULL;
425                 for (link = snode->edittree->links.first; link; link = link->next)
426                         if (link->tonode == node && link->fromnode == tonode)
427                                 if (link->tosock == node->inputs.first)
428                                         break;
429                 if (link) {
430                         /* unlink existing connection */
431                         sock = link->fromsock;
432                         nodeRemLink(snode->edittree, link);
433
434                         /* find a socket after the previously connected socket */
435                         for (sock = sock->next; sock; sock = sock->next)
436                                 if (!nodeSocketIsHidden(sock))
437                                         break;
438                 }
439         }
440
441         /* find a socket starting from the first socket */
442         if (!sock) {
443                 for (sock = tonode->outputs.first; sock; sock = sock->next)
444                         if (!nodeSocketIsHidden(sock))
445                                 break;
446         }
447
448         if (sock) {
449                 /* add a new viewer if none exists yet */
450                 if (!node) {
451                         /* XXX location is a quick hack, just place it next to the linked socket */
452                         node = node_add_node(C, NULL, CMP_NODE_VIEWER, sock->locx + 100, sock->locy);
453                         if (!node)
454                                 return OPERATOR_CANCELLED;
455
456                         link = NULL;
457                 }
458                 else {
459                         /* get link to viewer */
460                         for (link = snode->edittree->links.first; link; link = link->next)
461                                 if (link->tonode == node && link->tosock == node->inputs.first)
462                                         break;
463                 }
464
465                 if (link == NULL) {
466                         nodeAddLink(snode->edittree, tonode, sock, node, node->inputs.first);
467                 }
468                 else {
469                         link->fromnode = tonode;
470                         link->fromsock = sock;
471                         /* make sure the dependency sorting is updated */
472                         snode->edittree->update |= NTREE_UPDATE_LINKS;
473                 }
474                 ntreeUpdateTree(CTX_data_main(C), snode->edittree);
475                 snode_update(snode, node);
476         }
477
478         return OPERATOR_FINISHED;
479 }
480
481
482 static int node_active_link_viewer_exec(bContext *C, wmOperator *UNUSED(op))
483 {
484         SpaceNode *snode = CTX_wm_space_node(C);
485         bNode *node;
486
487         node = nodeGetActive(snode->edittree);
488
489         if (!node)
490                 return OPERATOR_CANCELLED;
491
492         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
493
494         if (node_link_viewer(C, node) == OPERATOR_CANCELLED)
495                 return OPERATOR_CANCELLED;
496
497         snode_notify(C, snode);
498
499         return OPERATOR_FINISHED;
500 }
501
502
503 void NODE_OT_link_viewer(wmOperatorType *ot)
504 {
505         /* identifiers */
506         ot->name = "Link to Viewer Node";
507         ot->description = "Link to viewer node";
508         ot->idname = "NODE_OT_link_viewer";
509
510         /* api callbacks */
511         ot->exec = node_active_link_viewer_exec;
512         ot->poll = composite_node_editable;
513
514         /* flags */
515         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
516 }
517
518
519 /* *************************** add link op ******************** */
520
521 static void node_link_update_header(bContext *C, bNodeLinkDrag *UNUSED(nldrag))
522 {
523         char header[UI_MAX_DRAW_STR];
524
525         BLI_strncpy(header, IFACE_("LMB: drag node link, RMB: cancel"), sizeof(header));
526         ED_workspace_status_text(C, header);
527 }
528
529 static int node_count_links(bNodeTree *ntree, bNodeSocket *sock)
530 {
531         bNodeLink *link;
532         int count = 0;
533         for (link = ntree->links.first; link; link = link->next) {
534                 if (link->fromsock == sock)
535                         ++count;
536                 if (link->tosock == sock)
537                         ++count;
538         }
539         return count;
540 }
541
542 static void node_remove_extra_links(SpaceNode *snode, bNodeLink *link)
543 {
544         bNodeTree *ntree = snode->edittree;
545         bNodeSocket *from = link->fromsock, *to = link->tosock;
546         bNodeLink *tlink, *tlink_next;
547         int to_count = node_count_links(ntree, to);
548         int from_count = node_count_links(ntree, from);
549
550         for (tlink = ntree->links.first; tlink; tlink = tlink_next) {
551                 tlink_next = tlink->next;
552                 if (tlink == link)
553                         continue;
554
555                 if (tlink && tlink->fromsock == from) {
556                         if (from_count > from->limit) {
557                                 nodeRemLink(ntree, tlink);
558                                 tlink = NULL;
559                                 --from_count;
560                         }
561                 }
562
563                 if (tlink && tlink->tosock == to) {
564                         if (to_count > to->limit) {
565                                 nodeRemLink(ntree, tlink);
566                                 tlink = NULL;
567                                 --to_count;
568                         }
569                 }
570         }
571 }
572
573 static void node_link_exit(bContext *C, wmOperator *op, bool apply_links)
574 {
575         Main *bmain = CTX_data_main(C);
576         SpaceNode *snode = CTX_wm_space_node(C);
577         bNodeTree *ntree = snode->edittree;
578         bNodeLinkDrag *nldrag = op->customdata;
579         LinkData *linkdata;
580         bool do_tag_update = false;
581
582         /* avoid updates while applying links */
583         ntree->is_updating = true;
584         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
585                 bNodeLink *link = linkdata->data;
586
587                 /* See note below, but basically TEST flag means that the link
588                  * was connected to output (or to a node which affects the
589                  * output).
590                  */
591                 do_tag_update |= (link->flag & NODE_LINK_TEST) != 0;
592
593                 if (apply_links && link->tosock && link->fromsock) {
594                         /* before actually adding the link,
595                          * let nodes perform special link insertion handling
596                          */
597                         if (link->fromnode->typeinfo->insert_link)
598                                 link->fromnode->typeinfo->insert_link(ntree, link->fromnode, link);
599                         if (link->tonode->typeinfo->insert_link)
600                                 link->tonode->typeinfo->insert_link(ntree, link->tonode, link);
601
602                         /* add link to the node tree */
603                         BLI_addtail(&ntree->links, link);
604
605                         ntree->update |= NTREE_UPDATE_LINKS;
606
607                         /* tag tonode for update */
608                         link->tonode->update |= NODE_UPDATE;
609
610                         /* we might need to remove a link */
611                         node_remove_extra_links(snode, link);
612
613                         if (link->tonode) {
614                                 do_tag_update |= (do_tag_update || node_connected_to_output(bmain, ntree, link->tonode));
615                         }
616                 }
617                 else {
618                         nodeRemLink(ntree, link);
619                 }
620         }
621         ntree->is_updating = false;
622
623         ntreeUpdateTree(bmain, ntree);
624         snode_notify(C, snode);
625         if (do_tag_update) {
626                 snode_dag_update(C, snode);
627         }
628
629         BLI_remlink(&snode->linkdrag, nldrag);
630         /* links->data pointers are either held by the tree or freed already */
631         BLI_freelistN(&nldrag->links);
632         MEM_freeN(nldrag);
633 }
634
635 static void node_link_find_socket(bContext *C, wmOperator *op, float cursor[2])
636 {
637         SpaceNode *snode = CTX_wm_space_node(C);
638         bNodeLinkDrag *nldrag = op->customdata;
639         bNode *tnode;
640         bNodeSocket *tsock = NULL;
641         LinkData *linkdata;
642
643         if (nldrag->in_out == SOCK_OUT) {
644                 if (node_find_indicated_socket(snode, &tnode, &tsock, cursor, SOCK_IN)) {
645                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
646                                 bNodeLink *link = linkdata->data;
647
648                                 /* skip if this is already the target socket */
649                                 if (link->tosock == tsock)
650                                         continue;
651                                 /* skip if socket is on the same node as the fromsock */
652                                 if (tnode && link->fromnode == tnode)
653                                         continue;
654
655                                 /* attach links to the socket */
656                                 link->tonode = tnode;
657                                 link->tosock = tsock;
658                         }
659                 }
660                 else {
661                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
662                                 bNodeLink *link = linkdata->data;
663
664                                 link->tonode = NULL;
665                                 link->tosock = NULL;
666                         }
667                 }
668         }
669         else {
670                 if (node_find_indicated_socket(snode, &tnode, &tsock, cursor, SOCK_OUT)) {
671                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
672                                 bNodeLink *link = linkdata->data;
673
674                                 /* skip if this is already the target socket */
675                                 if (link->fromsock == tsock)
676                                         continue;
677                                 /* skip if socket is on the same node as the fromsock */
678                                 if (tnode && link->tonode == tnode)
679                                         continue;
680
681                                 /* attach links to the socket */
682                                 link->fromnode = tnode;
683                                 link->fromsock = tsock;
684                         }
685                 }
686                 else {
687                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
688                                 bNodeLink *link = linkdata->data;
689
690                                 link->fromnode = NULL;
691                                 link->fromsock = NULL;
692                         }
693                 }
694         }
695 }
696
697 /* loop that adds a nodelink, called by function below  */
698 /* in_out = starting socket */
699 static int node_link_modal(bContext *C, wmOperator *op, const wmEvent *event)
700 {
701         bNodeLinkDrag *nldrag = op->customdata;
702         ARegion *ar = CTX_wm_region(C);
703         float cursor[2];
704
705         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1],
706                                  &cursor[0], &cursor[1]);
707
708         switch (event->type) {
709                 case MOUSEMOVE:
710                         node_link_find_socket(C, op, cursor);
711
712                         node_link_update_header(C, nldrag);
713                         ED_region_tag_redraw(ar);
714                         break;
715
716                 case LEFTMOUSE:
717                 case RIGHTMOUSE:
718                 case MIDDLEMOUSE:
719                 {
720                         if (event->val == KM_RELEASE) {
721                                 node_link_exit(C, op, true);
722
723                                 ED_workspace_status_text(C, NULL);
724                                 ED_region_tag_redraw(ar);
725                                 return OPERATOR_FINISHED;
726                         }
727                         break;
728                 }
729         }
730
731         return OPERATOR_RUNNING_MODAL;
732 }
733
734 /* return 1 when socket clicked */
735 static bNodeLinkDrag *node_link_init(Main *bmain, SpaceNode *snode, float cursor[2], bool detach)
736 {
737         bNode *node;
738         bNodeSocket *sock;
739         bNodeLink *link, *link_next, *oplink;
740         bNodeLinkDrag *nldrag = NULL;
741         LinkData *linkdata;
742         int num_links;
743
744         /* output indicated? */
745         if (node_find_indicated_socket(snode, &node, &sock, cursor, SOCK_OUT)) {
746                 nldrag = MEM_callocN(sizeof(bNodeLinkDrag), "drag link op customdata");
747
748                 num_links = nodeCountSocketLinks(snode->edittree, sock);
749                 if (num_links > 0 && (num_links >= sock->limit || detach)) {
750                         /* dragged links are fixed on input side */
751                         nldrag->in_out = SOCK_IN;
752                         /* detach current links and store them in the operator data */
753                         for (link = snode->edittree->links.first; link; link = link_next) {
754                                 link_next = link->next;
755                                 if (link->fromsock == sock) {
756                                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
757                                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
758                                         *oplink = *link;
759                                         oplink->next = oplink->prev = NULL;
760                                         oplink->flag |= NODE_LINK_VALID;
761
762                                         /* The link could be disconnected and in that case we
763                                          * wouldn't be able to check whether tag update is
764                                          * needed or not when releasing mouse button. So we
765                                          * cache whether the link affects output or not here
766                                          * using TEST flag.
767                                          */
768                                         oplink->flag &= ~NODE_LINK_TEST;
769                                         if (node_connected_to_output(bmain, snode->edittree, link->tonode)) {
770                                                 oplink->flag |= NODE_LINK_TEST;
771                                         }
772
773                                         BLI_addtail(&nldrag->links, linkdata);
774                                         nodeRemLink(snode->edittree, link);
775                                 }
776                         }
777                 }
778                 else {
779                         /* dragged links are fixed on output side */
780                         nldrag->in_out = SOCK_OUT;
781                         /* create a new link */
782                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
783                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
784                         oplink->fromnode = node;
785                         oplink->fromsock = sock;
786                         oplink->flag |= NODE_LINK_VALID;
787                         oplink->flag &= ~NODE_LINK_TEST;
788                         if (node_connected_to_output(bmain, snode->edittree, node)) {
789                                 oplink->flag |= NODE_LINK_TEST;
790                         }
791
792                         BLI_addtail(&nldrag->links, linkdata);
793                 }
794         }
795         /* or an input? */
796         else if (node_find_indicated_socket(snode, &node, &sock, cursor, SOCK_IN)) {
797                 nldrag = MEM_callocN(sizeof(bNodeLinkDrag), "drag link op customdata");
798
799                 num_links = nodeCountSocketLinks(snode->edittree, sock);
800                 if (num_links > 0 && (num_links >= sock->limit || detach)) {
801                         /* dragged links are fixed on output side */
802                         nldrag->in_out = SOCK_OUT;
803                         /* detach current links and store them in the operator data */
804                         for (link = snode->edittree->links.first; link; link = link_next) {
805                                 link_next = link->next;
806                                 if (link->tosock == sock) {
807                                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
808                                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
809                                         *oplink = *link;
810                                         oplink->next = oplink->prev = NULL;
811                                         oplink->flag |= NODE_LINK_VALID;
812                                         oplink->flag &= ~NODE_LINK_TEST;
813                                         if (node_connected_to_output(bmain, snode->edittree, link->tonode)) {
814                                                 oplink->flag |= NODE_LINK_TEST;
815                                         }
816
817                                         BLI_addtail(&nldrag->links, linkdata);
818                                         nodeRemLink(snode->edittree, link);
819
820                                         /* send changed event to original link->tonode */
821                                         if (node)
822                                                 snode_update(snode, node);
823                                 }
824                         }
825                 }
826                 else {
827                         /* dragged links are fixed on input side */
828                         nldrag->in_out = SOCK_IN;
829                         /* create a new link */
830                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
831                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
832                         oplink->tonode = node;
833                         oplink->tosock = sock;
834                         oplink->flag |= NODE_LINK_VALID;
835                         oplink->flag &= ~NODE_LINK_TEST;
836                         if (node_connected_to_output(bmain, snode->edittree, node)) {
837                                 oplink->flag |= NODE_LINK_TEST;
838                         }
839
840                         BLI_addtail(&nldrag->links, linkdata);
841                 }
842         }
843
844         return nldrag;
845 }
846
847 static int node_link_invoke(bContext *C, wmOperator *op, const wmEvent *event)
848 {
849         Main *bmain = CTX_data_main(C);
850         SpaceNode *snode = CTX_wm_space_node(C);
851         ARegion *ar = CTX_wm_region(C);
852         bNodeLinkDrag *nldrag;
853         float cursor[2];
854
855         bool detach = RNA_boolean_get(op->ptr, "detach");
856
857         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1],
858                                  &cursor[0], &cursor[1]);
859
860         ED_preview_kill_jobs(CTX_wm_manager(C), bmain);
861
862         nldrag = node_link_init(bmain, snode, cursor, detach);
863
864         if (nldrag) {
865                 op->customdata = nldrag;
866                 BLI_addtail(&snode->linkdrag, nldrag);
867
868                 /* add modal handler */
869                 WM_event_add_modal_handler(C, op);
870
871                 return OPERATOR_RUNNING_MODAL;
872         }
873         else
874                 return OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH;
875 }
876
877 static void node_link_cancel(bContext *C, wmOperator *op)
878 {
879         SpaceNode *snode = CTX_wm_space_node(C);
880         bNodeLinkDrag *nldrag = op->customdata;
881
882         BLI_remlink(&snode->linkdrag, nldrag);
883
884         BLI_freelistN(&nldrag->links);
885         MEM_freeN(nldrag);
886 }
887
888 void NODE_OT_link(wmOperatorType *ot)
889 {
890         /* identifiers */
891         ot->name = "Link Nodes";
892         ot->idname = "NODE_OT_link";
893         ot->description = "Use the mouse to create a link between two nodes";
894
895         /* api callbacks */
896         ot->invoke = node_link_invoke;
897         ot->modal = node_link_modal;
898 //      ot->exec = node_link_exec;
899         ot->poll = ED_operator_node_editable;
900         ot->cancel = node_link_cancel;
901
902         /* flags */
903         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_BLOCKING;
904
905         RNA_def_boolean(ot->srna, "detach", false, "Detach", "Detach and redirect existing links");
906 }
907
908 /* ********************** Make Link operator ***************** */
909
910 /* makes a link between selected output and input sockets */
911 static int node_make_link_exec(bContext *C, wmOperator *op)
912 {
913         Main *bmain = CTX_data_main(C);
914         SpaceNode *snode = CTX_wm_space_node(C);
915         const bool replace = RNA_boolean_get(op->ptr, "replace");
916
917         ED_preview_kill_jobs(CTX_wm_manager(C), bmain);
918
919         snode_autoconnect(bmain, snode, 1, replace);
920
921         /* deselect sockets after linking */
922         node_deselect_all_input_sockets(snode, 0);
923         node_deselect_all_output_sockets(snode, 0);
924
925         ntreeUpdateTree(CTX_data_main(C), snode->edittree);
926         snode_notify(C, snode);
927         snode_dag_update(C, snode);
928
929         return OPERATOR_FINISHED;
930 }
931
932 void NODE_OT_link_make(wmOperatorType *ot)
933 {
934         /* identifiers */
935         ot->name = "Make Links";
936         ot->description = "Makes a link between selected output in input sockets";
937         ot->idname = "NODE_OT_link_make";
938
939         /* callbacks */
940         ot->exec = node_make_link_exec;
941         ot->poll = ED_operator_node_editable; // XXX we need a special poll which checks that there are selected input/output sockets
942
943         /* flags */
944         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
945
946         RNA_def_boolean(ot->srna, "replace", 0, "Replace", "Replace socket connections with the new links");
947 }
948
949 /* ********************** Cut Link operator ***************** */
950 static bool cut_links_intersect(bNodeLink *link, float mcoords[][2], int tot)
951 {
952         float coord_array[NODE_LINK_RESOL + 1][2];
953         int i, b;
954
955         if (node_link_bezier_points(NULL, NULL, link, coord_array, NODE_LINK_RESOL)) {
956
957                 for (i = 0; i < tot - 1; i++)
958                         for (b = 0; b < NODE_LINK_RESOL; b++)
959                                 if (isect_seg_seg_v2(mcoords[i], mcoords[i + 1], coord_array[b], coord_array[b + 1]) > 0)
960                                         return 1;
961         }
962         return 0;
963 }
964
965 static int cut_links_exec(bContext *C, wmOperator *op)
966 {
967         Main *bmain = CTX_data_main(C);
968         SpaceNode *snode = CTX_wm_space_node(C);
969         ARegion *ar = CTX_wm_region(C);
970         float mcoords[256][2];
971         int i = 0;
972         bool do_tag_update = false;
973
974         RNA_BEGIN (op->ptr, itemptr, "path")
975         {
976                 float loc[2];
977
978                 RNA_float_get_array(&itemptr, "loc", loc);
979                 UI_view2d_region_to_view(&ar->v2d, (int)loc[0], (int)loc[1],
980                                          &mcoords[i][0], &mcoords[i][1]);
981                 i++;
982                 if (i >= 256) break;
983         }
984         RNA_END;
985
986         if (i > 1) {
987                 bool found = false;
988                 bNodeLink *link, *next;
989
990                 ED_preview_kill_jobs(CTX_wm_manager(C), bmain);
991
992                 for (link = snode->edittree->links.first; link; link = next) {
993                         next = link->next;
994                         if (nodeLinkIsHidden(link))
995                                 continue;
996
997                         if (cut_links_intersect(link, mcoords, i)) {
998
999                                 if (found == false) {
1000                                         /* TODO(sergey): Why did we kill jobs twice? */
1001                                         ED_preview_kill_jobs(CTX_wm_manager(C), bmain);
1002                                         found = true;
1003                                 }
1004
1005                                 do_tag_update |= (do_tag_update || node_connected_to_output(bmain, snode->edittree, link->tonode));
1006
1007                                 snode_update(snode, link->tonode);
1008                                 nodeRemLink(snode->edittree, link);
1009                         }
1010                 }
1011
1012                 if (found) {
1013                         ntreeUpdateTree(CTX_data_main(C), snode->edittree);
1014                         snode_notify(C, snode);
1015                         if (do_tag_update) {
1016                                 snode_dag_update(C, snode);
1017                         }
1018
1019                         return OPERATOR_FINISHED;
1020                 }
1021                 else {
1022                         return OPERATOR_CANCELLED;
1023                 }
1024
1025         }
1026
1027         return OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH;
1028 }
1029
1030 void NODE_OT_links_cut(wmOperatorType *ot)
1031 {
1032         ot->name = "Cut Links";
1033         ot->idname = "NODE_OT_links_cut";
1034         ot->description = "Use the mouse to cut (remove) some links";
1035
1036         ot->invoke = WM_gesture_lines_invoke;
1037         ot->modal = WM_gesture_lines_modal;
1038         ot->exec = cut_links_exec;
1039         ot->cancel = WM_gesture_lines_cancel;
1040
1041         ot->poll = ED_operator_node_editable;
1042
1043         /* flags */
1044         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1045
1046         /* properties */
1047         PropertyRNA *prop;
1048         prop = RNA_def_collection_runtime(ot->srna, "path", &RNA_OperatorMousePath, "Path", "");
1049         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1050
1051         /* internal */
1052         RNA_def_int(ot->srna, "cursor", BC_KNIFECURSOR, 0, INT_MAX, "Cursor", "", 0, INT_MAX);
1053 }
1054
1055 /* ********************** Detach links operator ***************** */
1056
1057 static int detach_links_exec(bContext *C, wmOperator *UNUSED(op))
1058 {
1059         SpaceNode *snode = CTX_wm_space_node(C);
1060         bNodeTree *ntree = snode->edittree;
1061         bNode *node;
1062
1063         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
1064
1065         for (node = ntree->nodes.first; node; node = node->next) {
1066                 if (node->flag & SELECT) {
1067                         nodeInternalRelink(ntree, node);
1068                 }
1069         }
1070
1071         ntreeUpdateTree(CTX_data_main(C), ntree);
1072
1073         snode_notify(C, snode);
1074         snode_dag_update(C, snode);
1075
1076         return OPERATOR_FINISHED;
1077 }
1078
1079 void NODE_OT_links_detach(wmOperatorType *ot)
1080 {
1081         ot->name = "Detach Links";
1082         ot->idname = "NODE_OT_links_detach";
1083         ot->description = "Remove all links to selected nodes, and try to connect neighbor nodes together";
1084
1085         ot->exec = detach_links_exec;
1086         ot->poll = ED_operator_node_editable;
1087
1088         /* flags */
1089         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1090 }
1091
1092
1093 /* ****************** Set Parent ******************* */
1094
1095 static int node_parent_set_exec(bContext *C, wmOperator *UNUSED(op))
1096 {
1097         SpaceNode *snode = CTX_wm_space_node(C);
1098         bNodeTree *ntree = snode->edittree;
1099         bNode *frame = nodeGetActive(ntree), *node;
1100         if (!frame || frame->type != NODE_FRAME)
1101                 return OPERATOR_CANCELLED;
1102
1103         for (node = ntree->nodes.first; node; node = node->next) {
1104                 if (node == frame)
1105                         continue;
1106                 if (node->flag & NODE_SELECT) {
1107                         nodeDetachNode(node);
1108                         nodeAttachNode(node, frame);
1109                 }
1110         }
1111
1112         ED_node_sort(ntree);
1113         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1114
1115         return OPERATOR_FINISHED;
1116 }
1117
1118 void NODE_OT_parent_set(wmOperatorType *ot)
1119 {
1120         /* identifiers */
1121         ot->name = "Make Parent";
1122         ot->description = "Attach selected nodes";
1123         ot->idname = "NODE_OT_parent_set";
1124
1125         /* api callbacks */
1126         ot->exec = node_parent_set_exec;
1127         ot->poll = ED_operator_node_editable;
1128
1129         /* flags */
1130         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1131 }
1132
1133 /* ****************** Join Nodes ******************* */
1134
1135 /* tags for depth-first search */
1136 #define NODE_JOIN_DONE          1
1137 #define NODE_JOIN_IS_DESCENDANT 2
1138
1139 static void node_join_attach_recursive(bNode *node, bNode *frame)
1140 {
1141         node->done |= NODE_JOIN_DONE;
1142
1143         if (node == frame) {
1144                 node->done |= NODE_JOIN_IS_DESCENDANT;
1145         }
1146         else if (node->parent) {
1147                 /* call recursively */
1148                 if (!(node->parent->done & NODE_JOIN_DONE))
1149                         node_join_attach_recursive(node->parent, frame);
1150
1151                 /* in any case: if the parent is a descendant, so is the child */
1152                 if (node->parent->done & NODE_JOIN_IS_DESCENDANT)
1153                         node->done |= NODE_JOIN_IS_DESCENDANT;
1154                 else if (node->flag & NODE_TEST) {
1155                         /* if parent is not an descendant of the frame, reattach the node */
1156                         nodeDetachNode(node);
1157                         nodeAttachNode(node, frame);
1158                         node->done |= NODE_JOIN_IS_DESCENDANT;
1159                 }
1160         }
1161         else if (node->flag & NODE_TEST) {
1162                 nodeAttachNode(node, frame);
1163                 node->done |= NODE_JOIN_IS_DESCENDANT;
1164         }
1165 }
1166
1167 static int node_join_exec(bContext *C, wmOperator *UNUSED(op))
1168 {
1169         SpaceNode *snode = CTX_wm_space_node(C);
1170         bNodeTree *ntree = snode->edittree;
1171         bNode *node, *frame;
1172
1173         /* XXX save selection: node_add_node call below sets the new frame as single
1174          * active+selected node */
1175         for (node = ntree->nodes.first; node; node = node->next) {
1176                 if (node->flag & NODE_SELECT)
1177                         node->flag |= NODE_TEST;
1178                 else
1179                         node->flag &= ~NODE_TEST;
1180         }
1181
1182         frame = node_add_node(C, NULL, NODE_FRAME, 0.0f, 0.0f);
1183
1184         /* reset tags */
1185         for (node = ntree->nodes.first; node; node = node->next)
1186                 node->done = 0;
1187
1188         for (node = ntree->nodes.first; node; node = node->next) {
1189                 if (!(node->done & NODE_JOIN_DONE))
1190                         node_join_attach_recursive(node, frame);
1191         }
1192
1193         /* restore selection */
1194         for (node = ntree->nodes.first; node; node = node->next) {
1195                 if (node->flag & NODE_TEST)
1196                         node->flag |= NODE_SELECT;
1197         }
1198
1199         ED_node_sort(ntree);
1200         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1201
1202         return OPERATOR_FINISHED;
1203 }
1204
1205 void NODE_OT_join(wmOperatorType *ot)
1206 {
1207         /* identifiers */
1208         ot->name = "Join Nodes";
1209         ot->description = "Attach selected nodes to a new common frame";
1210         ot->idname = "NODE_OT_join";
1211
1212         /* api callbacks */
1213         ot->exec = node_join_exec;
1214         ot->poll = ED_operator_node_editable;
1215
1216         /* flags */
1217         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1218 }
1219
1220 /* ****************** Attach ******************* */
1221
1222 static bNode *node_find_frame_to_attach(ARegion *ar, const bNodeTree *ntree, const int mouse_xy[2])
1223 {
1224         bNode *frame;
1225         float cursor[2];
1226
1227         /* convert mouse coordinates to v2d space */
1228         UI_view2d_region_to_view(&ar->v2d, UNPACK2(mouse_xy), &cursor[0], &cursor[1]);
1229
1230         /* check nodes front to back */
1231         for (frame = ntree->nodes.last; frame; frame = frame->prev) {
1232                 /* skip selected, those are the nodes we want to attach */
1233                 if ((frame->type != NODE_FRAME) || (frame->flag & NODE_SELECT))
1234                         continue;
1235                 if (BLI_rctf_isect_pt_v(&frame->totr, cursor))
1236                         return frame;
1237         }
1238
1239         return NULL;
1240 }
1241
1242 static int node_attach_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
1243 {
1244         ARegion *ar = CTX_wm_region(C);
1245         SpaceNode *snode = CTX_wm_space_node(C);
1246         bNodeTree *ntree = snode->edittree;
1247         bNode *frame = node_find_frame_to_attach(ar, ntree, event->mval);
1248
1249         if (frame) {
1250                 bNode *node, *parent;
1251                 for (node = ntree->nodes.last; node; node = node->prev) {
1252                         if (node->flag & NODE_SELECT) {
1253                                 if (node->parent == NULL) {
1254                                         /* disallow moving a parent into its child */
1255                                         if (nodeAttachNodeCheck(frame, node) == false) {
1256                                                 /* attach all unparented nodes */
1257                                                 nodeAttachNode(node, frame);
1258                                         }
1259                                 }
1260                                 else {
1261                                         /* attach nodes which share parent with the frame */
1262                                         for (parent = frame->parent; parent; parent = parent->parent) {
1263                                                 if (parent == node->parent) {
1264                                                         break;
1265                                                 }
1266                                         }
1267
1268                                         if (parent) {
1269                                                 /* disallow moving a parent into its child */
1270                                                 if (nodeAttachNodeCheck(frame, node) == false) {
1271                                                         nodeDetachNode(node);
1272                                                         nodeAttachNode(node, frame);
1273                                                 }
1274                                         }
1275                                 }
1276                         }
1277                 }
1278         }
1279
1280         ED_node_sort(ntree);
1281         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1282
1283         return OPERATOR_FINISHED;
1284 }
1285
1286
1287 void NODE_OT_attach(wmOperatorType *ot)
1288 {
1289         /* identifiers */
1290         ot->name = "Attach Nodes";
1291         ot->description = "Attach active node to a frame";
1292         ot->idname = "NODE_OT_attach";
1293
1294         /* api callbacks */
1295
1296         ot->invoke = node_attach_invoke;
1297         ot->poll = ED_operator_node_editable;
1298
1299         /* flags */
1300         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1301 }
1302
1303 /* ****************** Detach ******************* */
1304
1305 /* tags for depth-first search */
1306 #define NODE_DETACH_DONE            1
1307 #define NODE_DETACH_IS_DESCENDANT   2
1308
1309 static void node_detach_recursive(bNode *node)
1310 {
1311         node->done |= NODE_DETACH_DONE;
1312
1313         if (node->parent) {
1314                 /* call recursively */
1315                 if (!(node->parent->done & NODE_DETACH_DONE))
1316                         node_detach_recursive(node->parent);
1317
1318                 /* in any case: if the parent is a descendant, so is the child */
1319                 if (node->parent->done & NODE_DETACH_IS_DESCENDANT)
1320                         node->done |= NODE_DETACH_IS_DESCENDANT;
1321                 else if (node->flag & NODE_SELECT) {
1322                         /* if parent is not a descendant of a selected node, detach */
1323                         nodeDetachNode(node);
1324                         node->done |= NODE_DETACH_IS_DESCENDANT;
1325                 }
1326         }
1327         else if (node->flag & NODE_SELECT) {
1328                 node->done |= NODE_DETACH_IS_DESCENDANT;
1329         }
1330 }
1331
1332
1333 /* detach the root nodes in the current selection */
1334 static int node_detach_exec(bContext *C, wmOperator *UNUSED(op))
1335 {
1336         SpaceNode *snode = CTX_wm_space_node(C);
1337         bNodeTree *ntree = snode->edittree;
1338         bNode *node;
1339
1340         /* reset tags */
1341         for (node = ntree->nodes.first; node; node = node->next)
1342                 node->done = 0;
1343         /* detach nodes recursively
1344          * relative order is preserved here!
1345          */
1346         for (node = ntree->nodes.first; node; node = node->next) {
1347                 if (!(node->done & NODE_DETACH_DONE))
1348                         node_detach_recursive(node);
1349         }
1350
1351         ED_node_sort(ntree);
1352         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1353
1354         return OPERATOR_FINISHED;
1355 }
1356
1357 void NODE_OT_detach(wmOperatorType *ot)
1358 {
1359         /* identifiers */
1360         ot->name = "Detach Nodes";
1361         ot->description = "Detach selected nodes from parents";
1362         ot->idname = "NODE_OT_detach";
1363
1364         /* api callbacks */
1365         ot->exec = node_detach_exec;
1366         ot->poll = ED_operator_node_editable;
1367
1368         /* flags */
1369         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1370 }
1371
1372 /* *********************  automatic node insert on dragging ******************* */
1373
1374
1375 /* prevent duplicate testing code below */
1376 static bool ed_node_link_conditions(ScrArea *sa, bool test, SpaceNode **r_snode, bNode **r_select)
1377 {
1378         SpaceNode *snode = sa ? sa->spacedata.first : NULL;
1379         bNode *node, *select = NULL;
1380         bNodeLink *link;
1381
1382         *r_snode = snode;
1383         *r_select = NULL;
1384
1385         /* no unlucky accidents */
1386         if (sa == NULL || sa->spacetype != SPACE_NODE)
1387                 return false;
1388
1389         if (!test) {
1390                 /* no need to look for a node */
1391                 return true;
1392         }
1393
1394         for (node = snode->edittree->nodes.first; node; node = node->next) {
1395                 if (node->flag & SELECT) {
1396                         if (select)
1397                                 break;
1398                         else
1399                                 select = node;
1400                 }
1401         }
1402         /* only one selected */
1403         if (node || select == NULL)
1404                 return false;
1405
1406         /* correct node */
1407         if (BLI_listbase_is_empty(&select->inputs) || BLI_listbase_is_empty(&select->outputs))
1408                 return false;
1409
1410         /* test node for links */
1411         for (link = snode->edittree->links.first; link; link = link->next) {
1412                 if (nodeLinkIsHidden(link))
1413                         continue;
1414
1415                 if (link->tonode == select || link->fromnode == select)
1416                         return false;
1417         }
1418
1419         *r_select = select;
1420         return true;
1421 }
1422
1423 /* test == 0, clear all intersect flags */
1424 void ED_node_link_intersect_test(ScrArea *sa, int test)
1425 {
1426         bNode *select;
1427         SpaceNode *snode;
1428         bNodeLink *link, *selink = NULL;
1429         float dist_best = FLT_MAX;
1430
1431         if (!ed_node_link_conditions(sa, test, &snode, &select)) return;
1432
1433         /* clear flags */
1434         for (link = snode->edittree->links.first; link; link = link->next)
1435                 link->flag &= ~NODE_LINKFLAG_HILITE;
1436
1437         if (test == 0) return;
1438
1439         /* find link to select/highlight */
1440         for (link = snode->edittree->links.first; link; link = link->next) {
1441                 float coord_array[NODE_LINK_RESOL + 1][2];
1442
1443                 if (nodeLinkIsHidden(link))
1444                         continue;
1445
1446                 if (node_link_bezier_points(NULL, NULL, link, coord_array, NODE_LINK_RESOL)) {
1447                         float dist = FLT_MAX;
1448                         int i;
1449
1450                         /* loop over link coords to find shortest dist to
1451                          * upper left node edge of a intersected line segment */
1452                         for (i = 0; i < NODE_LINK_RESOL; i++) {
1453                                 /* check if the node rect intersetcts the line from this point to next one */
1454                                 if (BLI_rctf_isect_segment(&select->totr, coord_array[i], coord_array[i + 1])) {
1455                                         /* store the shortest distance to the upper left edge
1456                                          * of all intersetctions found so far */
1457                                         const float node_xy[] = {select->totr.xmin, select->totr.ymax};
1458
1459                                         /* to be precise coord_array should be clipped by select->totr,
1460                                          * but not done since there's no real noticeable difference */
1461                                         dist = min_ff(dist_squared_to_line_segment_v2(node_xy, coord_array[i], coord_array[i + 1]),
1462                                                            dist);
1463                                 }
1464                         }
1465
1466                         /* we want the link with the shortest distance to node center */
1467                         if (dist < dist_best) {
1468                                 dist_best = dist;
1469                                 selink = link;
1470                         }
1471                 }
1472         }
1473
1474         if (selink)
1475                 selink->flag |= NODE_LINKFLAG_HILITE;
1476 }
1477
1478 /* assumes sockets in list */
1479 static bNodeSocket *socket_best_match(ListBase *sockets)
1480 {
1481         bNodeSocket *sock;
1482         int type, maxtype = 0;
1483
1484         /* find type range */
1485         for (sock = sockets->first; sock; sock = sock->next)
1486                 maxtype = max_ii(sock->type, maxtype);
1487
1488         /* try all types, starting from 'highest' (i.e. colors, vectors, values) */
1489         for (type = maxtype; type >= 0; --type) {
1490                 for (sock = sockets->first; sock; sock = sock->next) {
1491                         if (!nodeSocketIsHidden(sock) && type == sock->type) {
1492                                 return sock;
1493                         }
1494                 }
1495         }
1496
1497         /* no visible sockets, unhide first of highest type */
1498         for (type = maxtype; type >= 0; --type) {
1499                 for (sock = sockets->first; sock; sock = sock->next) {
1500                         if (type == sock->type) {
1501                                 sock->flag &= ~SOCK_HIDDEN;
1502                                 return sock;
1503                         }
1504                 }
1505         }
1506
1507         return NULL;
1508 }
1509
1510 static bool node_parents_offset_flag_enable_cb(bNode *parent, void *UNUSED(userdata))
1511 {
1512         /* NODE_TEST is used to flag nodes that shouldn't be offset (again) */
1513         parent->flag |= NODE_TEST;
1514
1515         return true;
1516 }
1517
1518 static void node_offset_apply(bNode *node, const float offset_x)
1519 {
1520         /* NODE_TEST is used to flag nodes that shouldn't be offset (again) */
1521         if ((node->flag & NODE_TEST) == 0) {
1522                 node->anim_init_locx = node->locx;
1523                 node->anim_ofsx = (offset_x / UI_DPI_FAC);
1524                 node->flag |= NODE_TEST;
1525         }
1526 }
1527
1528 static void node_parent_offset_apply(NodeInsertOfsData *data, bNode *parent, const float offset_x)
1529 {
1530         bNode *node;
1531
1532         node_offset_apply(parent, offset_x);
1533
1534         /* flag all childs as offset to prevent them from being offset
1535          * separately (they've already moved with the parent) */
1536         for (node = data->ntree->nodes.first; node; node = node->next) {
1537                 if (nodeIsChildOf(parent, node)) {
1538                         /* NODE_TEST is used to flag nodes that shouldn't be offset (again) */
1539                         node->flag |= NODE_TEST;
1540                 }
1541         }
1542 }
1543
1544 #define NODE_INSOFS_ANIM_DURATION 0.25f
1545
1546 /**
1547  * Callback that applies NodeInsertOfsData.offset_x to a node or its parent, similar
1548  * to node_link_insert_offset_output_chain_cb below, but with slightly different logic
1549  */
1550 static bool node_link_insert_offset_frame_chain_cb(
1551         bNode *fromnode, bNode *tonode,
1552         void *userdata,
1553         const bool reversed)
1554 {
1555         NodeInsertOfsData *data = userdata;
1556         bNode *ofs_node = reversed ? fromnode : tonode;
1557
1558         if (ofs_node->parent && ofs_node->parent != data->insert_parent) {
1559                 node_offset_apply(ofs_node->parent, data->offset_x);
1560         }
1561         else {
1562                 node_offset_apply(ofs_node, data->offset_x);
1563         }
1564
1565         return true;
1566 }
1567
1568 /**
1569  * Applies NodeInsertOfsData.offset_x to all childs of \a parent
1570  */
1571 static void node_link_insert_offset_frame_chains(
1572         const bNodeTree *ntree, const bNode *parent,
1573         NodeInsertOfsData *data,
1574         const bool reversed)
1575 {
1576         bNode *node;
1577
1578         for (node = ntree->nodes.first; node; node = node->next) {
1579                 if (nodeIsChildOf(parent, node)) {
1580                         nodeChainIter(ntree, node, node_link_insert_offset_frame_chain_cb, data, reversed);
1581                 }
1582         }
1583 }
1584
1585 /**
1586  * Callback that applies NodeInsertOfsData.offset_x to a node or its parent,
1587  * considering the logic needed for offsetting nodes after link insert
1588  */
1589 static bool node_link_insert_offset_chain_cb(
1590         bNode *fromnode, bNode *tonode,
1591         void *userdata,
1592         const bool reversed)
1593 {
1594         NodeInsertOfsData *data = userdata;
1595         bNode *ofs_node = reversed ? fromnode : tonode;
1596
1597         if (data->insert_parent) {
1598                 if (ofs_node->parent && (ofs_node->parent->flag & NODE_TEST) == 0) {
1599                         node_parent_offset_apply(data, ofs_node->parent, data->offset_x);
1600                         node_link_insert_offset_frame_chains(data->ntree, ofs_node->parent, data, reversed);
1601                 }
1602                 else {
1603                         node_offset_apply(ofs_node, data->offset_x);
1604                 }
1605
1606                 if (nodeIsChildOf(data->insert_parent, ofs_node) == false) {
1607                         data->insert_parent = NULL;
1608                 }
1609         }
1610         else if (ofs_node->parent) {
1611                 bNode *node = nodeFindRootParent(ofs_node);
1612                 node_offset_apply(node, data->offset_x);
1613         }
1614         else {
1615                 node_offset_apply(ofs_node, data->offset_x);
1616         }
1617
1618         return true;
1619 }
1620
1621 static void node_link_insert_offset_ntree(
1622         NodeInsertOfsData *iofsd, ARegion *ar,
1623         const int mouse_xy[2], const bool right_alignment)
1624 {
1625         bNodeTree *ntree = iofsd->ntree;
1626         bNode *insert = iofsd->insert;
1627         bNode *prev = iofsd->prev, *next = iofsd->next;
1628         bNode *init_parent = insert->parent; /* store old insert->parent for restoring later */
1629         rctf totr_insert;
1630
1631         const float min_margin = U.node_margin * UI_DPI_FAC;
1632         const float width = NODE_WIDTH(insert);
1633         const bool needs_alignment = (next->totr.xmin - prev->totr.xmax) < (width + (min_margin * 2.0f));
1634
1635         float margin = width;
1636         float dist, addval;
1637
1638
1639         /* NODE_TEST will be used later, so disable for all nodes */
1640         ntreeNodeFlagSet(ntree, NODE_TEST, false);
1641
1642         /* insert->totr isn't updated yet,
1643          * so totr_insert is used to get the correct worldspace coords */
1644         node_to_updated_rect(insert, &totr_insert);
1645
1646         /* frame attachment wasn't handled yet
1647          * so we search the frame that the node will be attached to later */
1648         insert->parent = node_find_frame_to_attach(ar, ntree, mouse_xy);
1649
1650         /* this makes sure nodes are also correctly offset when inserting a node on top of a frame
1651          * without actually making it a part of the frame (because mouse isn't intersecting it)
1652          * - logic here is similar to node_find_frame_to_attach */
1653         if (!insert->parent ||
1654             (prev->parent && (prev->parent == next->parent) && (prev->parent != insert->parent)))
1655         {
1656                 bNode *frame;
1657                 rctf totr_frame;
1658
1659                 /* check nodes front to back */
1660                 for (frame = ntree->nodes.last; frame; frame = frame->prev) {
1661                         /* skip selected, those are the nodes we want to attach */
1662                         if ((frame->type != NODE_FRAME) || (frame->flag & NODE_SELECT))
1663                                 continue;
1664
1665                         /* for some reason frame y coords aren't correct yet */
1666                         node_to_updated_rect(frame, &totr_frame);
1667
1668                         if (BLI_rctf_isect_x(&totr_frame, totr_insert.xmin) &&
1669                             BLI_rctf_isect_x(&totr_frame, totr_insert.xmax))
1670                         {
1671                                 if (BLI_rctf_isect_y(&totr_frame, totr_insert.ymin) ||
1672                                     BLI_rctf_isect_y(&totr_frame, totr_insert.ymax))
1673                                 {
1674                                         /* frame isn't insert->parent actually, but this is needed to make offsetting
1675                                          * nodes work correctly for above checked cases (it is restored later) */
1676                                         insert->parent = frame;
1677                                         break;
1678                                 }
1679                         }
1680                 }
1681         }
1682
1683
1684         /* *** ensure offset at the left (or right for right_alignment case) of insert_node *** */
1685
1686         dist = right_alignment ? totr_insert.xmin - prev->totr.xmax : next->totr.xmin - totr_insert.xmax;
1687         /* distance between insert_node and prev is smaller than min margin */
1688         if (dist < min_margin) {
1689                 addval = (min_margin - dist) * (right_alignment ? 1.0f : -1.0f);
1690
1691                 node_offset_apply(insert, addval);
1692
1693                 totr_insert.xmin  += addval;
1694                 totr_insert.xmax  += addval;
1695                 margin            += min_margin;
1696         }
1697
1698         /* *** ensure offset at the right (or left for right_alignment case) of insert_node *** */
1699
1700         dist = right_alignment ? next->totr.xmin - totr_insert.xmax : totr_insert.xmin - prev->totr.xmax;
1701         /* distance between insert_node and next is smaller than min margin */
1702         if (dist < min_margin) {
1703                 addval = (min_margin - dist) * (right_alignment ? 1.0f : -1.0f);
1704                 if (needs_alignment) {
1705                         bNode *offs_node = right_alignment ? next : prev;
1706                         if (!offs_node->parent ||
1707                             offs_node->parent == insert->parent ||
1708                             nodeIsChildOf(offs_node->parent, insert))
1709                         {
1710                                 node_offset_apply(offs_node, addval);
1711                         }
1712                         else if (!insert->parent && offs_node->parent) {
1713                                 node_offset_apply(nodeFindRootParent(offs_node), addval);
1714                         }
1715                         margin = addval;
1716                 }
1717                 /* enough room is available, but we want to ensure the min margin at the right */
1718                 else {
1719                         /* offset inserted node so that min margin is kept at the right */
1720                         node_offset_apply(insert, -addval);
1721                 }
1722         }
1723
1724
1725         if (needs_alignment) {
1726                 iofsd->insert_parent = insert->parent;
1727                 iofsd->offset_x = margin;
1728
1729                 /* flag all parents of insert as offset to prevent them from being offset */
1730                 nodeParentsIter(insert, node_parents_offset_flag_enable_cb, NULL);
1731                 /* iterate over entire chain and apply offsets */
1732                 nodeChainIter(ntree, right_alignment ? next : prev, node_link_insert_offset_chain_cb, iofsd, !right_alignment);
1733         }
1734
1735         insert->parent = init_parent;
1736 }
1737
1738 /**
1739  * Modal handler for insert offset animation
1740  */
1741 static int node_insert_offset_modal(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
1742 {
1743         SpaceNode *snode = CTX_wm_space_node(C);
1744         NodeInsertOfsData *iofsd = snode->iofsd;
1745         bNode *node;
1746         float duration;
1747         bool redraw = false;
1748
1749         if (!snode || event->type != TIMER || iofsd == NULL || iofsd->anim_timer != event->customdata)
1750                 return OPERATOR_PASS_THROUGH;
1751
1752         duration = (float)iofsd->anim_timer->duration;
1753
1754         /* handle animation - do this before possibly aborting due to duration, since
1755          * main thread might be so busy that node hasn't reached final position yet */
1756         for (node = snode->edittree->nodes.first; node; node = node->next) {
1757                 if (UNLIKELY(node->anim_ofsx)) {
1758                         const float endval = node->anim_init_locx + node->anim_ofsx;
1759                         if (IS_EQF(node->locx, endval) == false) {
1760                                 node->locx = BLI_easing_cubic_ease_in_out(duration, node->anim_init_locx, node->anim_ofsx,
1761                                                                           NODE_INSOFS_ANIM_DURATION);
1762                                 if (node->anim_ofsx < 0) {
1763                                         CLAMP_MIN(node->locx, endval);
1764                                 }
1765                                 else {
1766                                         CLAMP_MAX(node->locx, endval);
1767                                 }
1768                                 redraw = true;
1769                         }
1770                 }
1771         }
1772         if (redraw) {
1773                 ED_region_tag_redraw(CTX_wm_region(C));
1774         }
1775
1776         /* end timer + free insert offset data */
1777         if (duration > NODE_INSOFS_ANIM_DURATION) {
1778                 WM_event_remove_timer(CTX_wm_manager(C), NULL, iofsd->anim_timer);
1779
1780                 for (node = snode->edittree->nodes.first; node; node = node->next) {
1781                         node->anim_init_locx = node->anim_ofsx = 0.0f;
1782                 }
1783
1784                 snode->iofsd = NULL;
1785                 MEM_freeN(iofsd);
1786
1787                 return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
1788         }
1789
1790         return OPERATOR_RUNNING_MODAL;
1791 }
1792
1793 #undef NODE_INSOFS_ANIM_DURATION
1794
1795 static int node_insert_offset_invoke(bContext *C, wmOperator *op, const wmEvent *event)
1796 {
1797         const SpaceNode *snode = CTX_wm_space_node(C);
1798         NodeInsertOfsData *iofsd = snode->iofsd;
1799
1800         if (!iofsd || !iofsd->insert)
1801                 return OPERATOR_CANCELLED;
1802
1803         BLI_assert((snode->flag & SNODE_SKIP_INSOFFSET) == 0);
1804
1805         iofsd->ntree = snode->edittree;
1806         iofsd->anim_timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.02);
1807
1808         node_link_insert_offset_ntree(
1809                     iofsd, CTX_wm_region(C),
1810                     event->mval, (snode->insert_ofs_dir == SNODE_INSERTOFS_DIR_RIGHT));
1811
1812         /* add temp handler */
1813         WM_event_add_modal_handler(C, op);
1814
1815         return OPERATOR_RUNNING_MODAL;
1816 }
1817
1818 void NODE_OT_insert_offset(wmOperatorType *ot)
1819 {
1820         /* identifiers */
1821         ot->name = "Insert Offset";
1822         ot->description = "Automatically offset nodes on insertion";
1823         ot->idname = "NODE_OT_insert_offset";
1824
1825         /* callbacks */
1826         ot->invoke = node_insert_offset_invoke;
1827         ot->modal = node_insert_offset_modal;
1828         ot->poll = ED_operator_node_editable;
1829
1830         /* flags */
1831         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_BLOCKING;
1832 }
1833
1834 /* assumes link with NODE_LINKFLAG_HILITE set */
1835 void ED_node_link_insert(Main *bmain, ScrArea *sa)
1836 {
1837         bNode *node, *select;
1838         SpaceNode *snode;
1839         bNodeLink *link;
1840         bNodeSocket *sockto;
1841
1842         if (!ed_node_link_conditions(sa, true, &snode, &select)) return;
1843
1844         /* get the link */
1845         for (link = snode->edittree->links.first; link; link = link->next)
1846                 if (link->flag & NODE_LINKFLAG_HILITE)
1847                         break;
1848
1849         if (link) {
1850                 bNodeSocket *best_input = socket_best_match(&select->inputs);
1851                 bNodeSocket *best_output = socket_best_match(&select->outputs);
1852
1853                 if (best_input && best_output) {
1854                         node = link->tonode;
1855                         sockto = link->tosock;
1856
1857                         link->tonode = select;
1858                         link->tosock = best_input;
1859                         node_remove_extra_links(snode, link);
1860                         link->flag &= ~NODE_LINKFLAG_HILITE;
1861
1862                         nodeAddLink(snode->edittree, select, best_output, node, sockto);
1863
1864                         /* set up insert offset data, it needs stuff from here */
1865                         if ((snode->flag & SNODE_SKIP_INSOFFSET) == 0) {
1866                                 NodeInsertOfsData *iofsd = MEM_callocN(sizeof(NodeInsertOfsData), __func__);
1867
1868                                 iofsd->insert = select;
1869                                 iofsd->prev = link->fromnode;
1870                                 iofsd->next = node;
1871
1872                                 snode->iofsd = iofsd;
1873                         }
1874
1875                         ntreeUpdateTree(bmain, snode->edittree);   /* needed for pointers */
1876                         snode_update(snode, select);
1877                         ED_node_tag_update_id(snode->id);
1878                 }
1879         }
1880 }