source: branches/alilink/SL/TREEDISP/TreeCallbacks.cxx

Last change on this file was 18126, checked in by westram, 6 years ago
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 33.5 KB
Line 
1// =============================================================== //
2//                                                                 //
3//   File      : TreeCallbacks.cxx                                 //
4//   Purpose   :                                                   //
5//                                                                 //
6//   Institute of Microbiology (Technical University Munich)       //
7//   http://www.arb-home.de/                                       //
8//                                                                 //
9// =============================================================== //
10
11#include "TreeCallbacks.hxx"
12
13#include <aw_color_groups.hxx>
14#include <aw_awars.hxx>
15#include <aw_advice.hxx>
16#include <aw_msg.hxx>
17#include <aw_root.hxx>
18#include <mode_text.h>
19
20#include <cctype>
21
22using namespace AW;
23
24// AISC_MKPT_PROMOTE:#ifndef TREEDISPLAY_HXX
25// AISC_MKPT_PROMOTE:#include <TreeDisplay.hxx>
26// AISC_MKPT_PROMOTE:#endif
27
28void nt_mode_event(UNFIXED, TREE_canvas *ntw, AWT_COMMAND_MODE mode) {
29    const char *text;
30
31    switch (mode) {
32        case AWT_MODE_ZOOM:  text = MODE_TEXT_STANDARD_ZOOMMODE(); break;
33        case AWT_MODE_EMPTY: text = MODE_TEXT_PLACEHOLDER();       break;
34
35        case AWT_MODE_SELECT: text = MODE_TEXT_1BUTTON("SELECT", "select species or open/close group");                  break;
36        case AWT_MODE_INFO:   text = MODE_TEXT_1BUTTON("INFO",   "click for info");                                      break;
37        case AWT_MODE_WWW:    text = MODE_TEXT_1BUTTON("WEB",    "Launch node dependent URL (see <Properties/WWW...>)"); break;
38
39        case AWT_MODE_SWAP:       text= MODE_TEXT_2BUTTONS("SWAP",         "swap child branches",        "flip whole subtree");          break;
40        case AWT_MODE_MARK:       text= MODE_TEXT_2BUTTONS("MARK",         "mark subtree",               "unmark subtree");              break;
41        case AWT_MODE_GROUP:      text= MODE_TEXT_2BUTTONS("GROUP",        "fold/unfold group",          "create/rename/destroy group"); break;
42        case AWT_MODE_NNI:        text= MODE_TEXT_2BUTTONS("OPTI(NNI)",    "once",                       "repeated");                    break;
43        case AWT_MODE_KERNINGHAN: text= MODE_TEXT_2BUTTONS("OPTI(KL)",     "once",                       "repeated");                    break;
44        case AWT_MODE_OPTIMIZE:   text= MODE_TEXT_2BUTTONS("OPTI(NNI&KL)", "once",                       "repeated");                    break;
45        case AWT_MODE_SETROOT:    text= MODE_TEXT_2BUTTONS("REROOT",       "set root to clicked branch", "search optimal root");         break;
46
47        case AWT_MODE_ROTATE: text = MODE_TEXT_1BUTTON_KEYS("ROTATE", "drag branch to rotate",         KEYINFO_ABORT_AND_RESET); break;
48        case AWT_MODE_SPREAD: text = MODE_TEXT_1BUTTON_KEYS("SPREAD", "drag branch to spread subtree", KEYINFO_ABORT_AND_RESET); break;
49
50        case AWT_MODE_LENGTH:    text = MODE_TEXT_2BUTTONS_KEYS("LENGTH",       "drag branch/ruler", "use discrete lengths", KEYINFO_ABORT_AND_RESET); break;
51        case AWT_MODE_MULTIFURC: text = MODE_TEXT_2BUTTONS_KEYS("MULTIFURC",    "drag branch",       "use discrete lengths", KEYINFO_ABORT_AND_RESET); break;
52        case AWT_MODE_LINE:      text = MODE_TEXT_2BUTTONS_KEYS("LINE",         "drag branch/ruler", "whole subtree",        KEYINFO_ABORT_AND_RESET); break;
53        case AWT_MODE_MOVE:      text = MODE_TEXT_2BUTTONS_KEYS("MOVE",         "drag branch/ruler", "move groupinfo only",  KEYINFO_ABORT);           break;
54        case AWT_MODE_LZOOM:     text = MODE_TEXT_2BUTTONS_KEYS("LOGICAL ZOOM", "show only subtree", "go up one step",       KEYINFO_RESET);           break;
55
56        default: text = no_mode_text_defined(); break;
57    }
58
59    td_assert(strlen(text) < AWAR_FOOTER_MAX_LEN); // text too long!
60
61    ntw->awr->awar(AWAR_FOOTER)->write_string(text);
62    ntw->set_mode(mode);
63}
64
65// ---------------------------------------
66//      Basic mark/unmark callbacks :
67
68static void count_mark_all_cb(UNFIXED, TREE_canvas *ntw) {
69    GB_push_transaction(ntw->gb_main);
70
71    GBDATA *gb_species_data = GBT_get_species_data(ntw->gb_main);
72    long    count           = GB_number_of_marked_subentries(gb_species_data);
73
74    GB_pop_transaction(ntw->gb_main);
75
76    char buf[256];
77    switch (count) {
78        case 0: strcpy(buf, "There are NO marked species"); break;
79        case 1: strcpy(buf, "There is 1 marked species"); break;
80        default: sprintf(buf, "There are %li marked species", count); break;
81    }
82    strcat(buf, ". (The number of species is displayed in the top area as well)");
83    aw_message(buf);
84}
85
86static bool species_has_alignment(GBDATA *gb_species, void *cd_use) {
87    return GBT_find_sequence(gb_species, (const char*)cd_use);
88}
89
90static bool sequence_is_partial(GBDATA *gb_species, void *cd_partial) {
91    long wanted  = (long)cd_partial;
92    td_assert(wanted == 0 || wanted == 1);
93    bool partial = GBT_is_partial(gb_species, 0, false);
94
95    return partial == wanted;
96}
97
98#define MARK_MODE_LOWER_BITS (1|2)
99#define MARK_MODE_UPPER_BITS (4|8|16)
100
101void NT_mark_all_cb(UNFIXED, TREE_canvas *ntw, int mark_mode) {
102    // Bits 0 and 1 of mark_mode:
103    //
104    // mark_mode&3  == 0 -> unmark
105    // mark_mode&3  == 1 -> mark
106    // mark_mode&3  == 2 -> toggle mark
107    //
108    // Bits 2 .. 4 of mark_mode:
109    //
110    // mark_mode&12 == 4 -> affect only full sequences
111    // mark_mode&12 == 8 -> affect only partial sequences
112    // mark_mode&12 == 16 -> affect only species with data in current alignment
113    // else -> affect all sequences
114
115    AWT_auto_refresh allowed_on(ntw);
116    GB_transaction   ta(ntw->gb_main);
117
118    switch (mark_mode&MARK_MODE_UPPER_BITS) {
119        case 0:                 // all sequences
120            GBT_mark_all(ntw->gb_main, mark_mode&MARK_MODE_LOWER_BITS);
121            break;
122        case 4:                 // full sequences only
123            GBT_mark_all_that(ntw->gb_main, mark_mode&MARK_MODE_LOWER_BITS, sequence_is_partial, (void*)NULp);
124            break;
125        case 8:                 // partial sequences only
126            GBT_mark_all_that(ntw->gb_main, mark_mode&MARK_MODE_LOWER_BITS, sequence_is_partial, (void*)1);
127            break;
128        case 16: {               // species with data in alignment only
129            char *ali = GBT_get_default_alignment(ntw->gb_main);
130            if (ali) GBT_mark_all_that(ntw->gb_main, mark_mode&MARK_MODE_LOWER_BITS, species_has_alignment, (void*)ali);
131            free(ali);
132            break;
133        }
134        default:
135            td_assert(0); // illegal mode
136            break;
137    }
138
139    ntw->request_structure_update(); // includes refresh etc
140}
141
142static void mark_tree_cb(UNFIXED, TREE_canvas *ntw, int mark_mode) {
143    GB_transaction    ta(ntw->gb_main);
144    AWT_auto_refresh  allowed_on(ntw);
145    AWT_graphic_tree *gtree     = AWT_TREE(ntw);
146    AP_tree          *tree_root = gtree->get_root_node();
147
148    switch (mark_mode&MARK_MODE_UPPER_BITS) {
149        case 0:                 // all sequences
150            gtree->mark_species_in_tree(tree_root, mark_mode&MARK_MODE_LOWER_BITS);
151            break;
152        case 4:                 // full sequences only
153            gtree->mark_species_in_tree_that(tree_root, mark_mode&MARK_MODE_LOWER_BITS, sequence_is_partial, (void*)NULp);
154            break;
155        case 8:                 // partial sequences only
156            gtree->mark_species_in_tree_that(tree_root, mark_mode&MARK_MODE_LOWER_BITS, sequence_is_partial, (void*)1);
157            break;
158        case 16: {               // species with data in alignment only
159            char *ali = GBT_get_default_alignment(ntw->gb_main);
160            if (ali) gtree->mark_species_in_tree_that(tree_root, mark_mode&MARK_MODE_LOWER_BITS, species_has_alignment, (void*)ali);
161            free(ali);
162            break;
163        }
164        default:
165            td_assert(0); // illegal mode
166            break;
167    }
168    ntw->request_structure_update();
169}
170
171struct mark_nontree_cb_data {
172    int      mark_mode_upper_bits;
173    char    *ali;               // current alignment (only if mark_mode_upper_bits == 16)
174    GB_HASH *hash;
175};
176
177static bool are_not_in_tree(GBDATA *gb_species, void *cb_data) {
178    struct mark_nontree_cb_data *data    = (mark_nontree_cb_data*)cb_data;
179    const char                  *name    = GBT_read_name(gb_species);
180    bool                         mark_me = false;
181
182    if (GBS_read_hash(data->hash, name) == (long)gb_species) { // species is not in tree!
183        switch (data->mark_mode_upper_bits) {
184            case 0:             // all sequences
185                mark_me = true;
186                break;
187            case 4:             // full sequences only
188                mark_me = sequence_is_partial(gb_species, (void*)NULp);
189                break;
190            case 8:             // partial sequences only
191                mark_me = sequence_is_partial(gb_species, (void*)1);
192                break;
193            case 16:            // species with data in alignment only
194                mark_me = species_has_alignment(gb_species, data->ali);
195                break;
196            default:
197                td_assert(0); // illegal mode
198                break;
199        }
200    }
201
202    return mark_me;
203}
204
205static void mark_nontree_cb(UNFIXED, TREE_canvas *ntw, int mark_mode) {
206    AWT_graphic_tree            *gtree = AWT_TREE(ntw);
207    GB_transaction               ta(ntw->gb_main);
208    struct mark_nontree_cb_data  cd;
209    AWT_auto_refresh             allowed_on(ntw);
210
211    if ((mark_mode&MARK_MODE_LOWER_BITS) == 0) {   // unmark is much faster
212        cd.hash = GBT_create_marked_species_hash(ntw->gb_main); // because it only hashes marked species
213    }
214    else {
215        cd.hash = GBT_create_species_hash(ntw->gb_main); // for mark we have to hash ALL species
216    }
217
218    NT_remove_species_in_tree_from_hash(gtree->get_root_node(), cd.hash);
219
220    cd.mark_mode_upper_bits = mark_mode&MARK_MODE_UPPER_BITS;
221    cd.ali                  = cd.mark_mode_upper_bits == 16 ? GBT_get_default_alignment(ntw->gb_main) : NULp;
222
223    GBT_mark_all_that(ntw->gb_main, mark_mode&MARK_MODE_LOWER_BITS, are_not_in_tree, (void*)&cd);
224
225    free(cd.ali);
226
227    ntw->request_refresh(); // does only affect display of NDS list (if tree shown -> never changes; i.e. no structure update needed)
228}
229
230static char *create_mark_menu_entry(const char *attrib, const char *entry_template) {
231    char *entry = NULp;
232    if (attrib) {
233        bool append = attrib[0] == '-'; // if attrib starts with '-' then append (otherwise prepend)
234        if (append) ++attrib; // skip '-'
235
236        if (append) {
237            char *spaced_attrib = GBS_global_string_copy(" %s", attrib);
238            entry               = GBS_global_string_copy(entry_template, "", spaced_attrib);
239            free(spaced_attrib);
240        }
241        else {
242            char *spaced_attrib = GBS_global_string_copy("%s ", attrib);
243            entry               = GBS_global_string_copy(entry_template, spaced_attrib, "");
244
245            if (islower(entry[0])) entry[0] = toupper(entry[0]); // Caps prepended lowercase 'attrib'
246
247            free(spaced_attrib);
248        }
249    }
250    else {
251        entry = GBS_global_string_copy(entry_template, "", "");
252    }
253    return entry;
254}
255static char *create_mark_menu_id(const char *attrib, const char *id_suffix) {
256    char *id = NULp;
257    if (attrib) {
258        id = GBS_global_string_copy("%s_%s", attrib[0] == '-' ? attrib+1 : attrib, id_suffix);
259    }
260    else {
261        id = strdup(id_suffix);
262    }
263    return id;
264}
265
266static void insert_mark_topic(AW_window_menu_modes *awm, AW_active mask, const char *attrib, const char *id_suffix, const char *entry_template,
267                              const char *hotkey, const char *helpfile, const WindowCallback& wcb)
268{
269    char *entry = create_mark_menu_entry(attrib, entry_template);
270    char *id    = create_mark_menu_id(attrib, id_suffix);
271
272    awm->insert_menu_topic(id, entry, hotkey, helpfile, mask, wcb);
273
274    free(id);
275    free(entry);
276}
277
278static void insert_mark_topics(AW_window_menu_modes *awm, AW_active mask, TREE_canvas *ntw, int affect, const char *attrib) {
279    td_assert(affect == (affect&MARK_MODE_UPPER_BITS)); // only bits 2 .. 4 are allowed
280
281    insert_mark_topic(awm, mask, attrib, "mark_all",    "Mark all %sSpecies%s",            "M", "sp_mark.hlp", makeWindowCallback(NT_mark_all_cb, ntw, 1+affect));
282    insert_mark_topic(awm, mask, attrib, "unmark_all",  "Unmark all %sSpecies%s",          "U", "sp_mark.hlp", makeWindowCallback(NT_mark_all_cb, ntw, 0+affect));
283    insert_mark_topic(awm, mask, attrib, "swap_marked", "Invert marks of all %sSpecies%s", "I", "sp_mark.hlp", makeWindowCallback(NT_mark_all_cb, ntw, 2+affect));
284    awm->sep______________();
285
286    char *label = create_mark_menu_entry(attrib, "%sSpecies%s in Tree");
287
288    awm->insert_sub_menu(label, "T");
289    insert_mark_topic(awm, mask, attrib, "mark_tree",        "Mark %sSpecies%s in Tree",            "M", "sp_mark.hlp", makeWindowCallback(mark_tree_cb, ntw, 1+affect));
290    insert_mark_topic(awm, mask, attrib, "unmark_tree",      "Unmark %sSpecies%s in Tree",          "U", "sp_mark.hlp", makeWindowCallback(mark_tree_cb, ntw, 0+affect));
291    insert_mark_topic(awm, mask, attrib, "swap_marked_tree", "Invert marks of %sSpecies%s in Tree", "I", "sp_mark.hlp", makeWindowCallback(mark_tree_cb, ntw, 2+affect));
292    awm->close_sub_menu();
293
294    freeset(label, create_mark_menu_entry(attrib, "%sSpecies%s NOT in Tree"));
295
296    awm->insert_sub_menu(label, "N");
297    insert_mark_topic(awm, mask, attrib, "mark_nontree",        "Mark %sSpecies%s NOT in Tree",            "M", "sp_mark.hlp", makeWindowCallback(mark_nontree_cb, ntw, 1+affect));
298    insert_mark_topic(awm, mask, attrib, "unmark_nontree",      "Unmark %sSpecies%s NOT in Tree",          "U", "sp_mark.hlp", makeWindowCallback(mark_nontree_cb, ntw, 0+affect));
299    insert_mark_topic(awm, mask, attrib, "swap_marked_nontree", "Invert marks of %sSpecies%s NOT in Tree", "I", "sp_mark.hlp", makeWindowCallback(mark_nontree_cb, ntw, 2+affect));
300    awm->close_sub_menu();
301
302    free(label);
303}
304
305void NT_insert_mark_submenus(AW_window_menu_modes *awm, TREE_canvas *ntw, int insert_as_submenu) {
306    if (insert_as_submenu) {
307        awm->insert_sub_menu("Mark species", "M");
308    }
309
310    {
311        awm->insert_menu_topic("count_marked", "Count Marked Species", "C", "sp_count_mrk.hlp", AWM_ALL, makeWindowCallback(count_mark_all_cb, ntw));
312        awm->sep______________();
313        insert_mark_topics(awm, AWM_ALL, ntw, 0, NULp);
314        awm->sep______________();
315
316        awm->insert_sub_menu("Complete sequences", "o");
317        insert_mark_topics(awm, AWM_EXP, ntw, 4, "complete");
318        awm->close_sub_menu();
319
320        awm->insert_sub_menu("Partial sequences", "P");
321        insert_mark_topics(awm, AWM_EXP, ntw, 8, "partial");
322        awm->close_sub_menu();
323
324        awm->insert_sub_menu("Current Alignment", "A");
325        insert_mark_topics(awm, AWM_EXP, ntw, 16, "-with data");
326        awm->close_sub_menu();
327    }
328
329    if (insert_as_submenu) {
330        awm->close_sub_menu();
331    }
332}
333
334// ----------------------------------------
335//      Automated collapse/expand tree
336
337static void group_and_refold_tree(TREE_canvas *ntw, CollapseMode mode, int color_group) {
338    GB_transaction    ta(ntw->gb_main);
339    AWT_auto_refresh  allowed_on(ntw);
340    AWT_graphic_tree *agt       = AWT_TREE(ntw);
341    AP_tree          *root_node = agt->get_root_node();
342
343    agt->group_tree(root_node, mode, color_group);
344
345    agt->fast_sync_changed_folding(root_node);
346}
347
348static void collapse_all_cb     (UNFIXED, TREE_canvas *ntw) { group_and_refold_tree(ntw, COLLAPSE_ALL,      0); }
349static void collapse_terminal_cb(UNFIXED, TREE_canvas *ntw) { group_and_refold_tree(ntw, COLLAPSE_TERMINAL, 0); }
350static void expand_all_cb       (UNFIXED, TREE_canvas *ntw) { group_and_refold_tree(ntw, EXPAND_ALL,        0); }
351void NT_expand_marked_cb        (UNFIXED, TREE_canvas *ntw) { group_and_refold_tree(ntw, EXPAND_MARKED,     0); }
352static void expand_zombies_cb   (UNFIXED, TREE_canvas *ntw) { group_and_refold_tree(ntw, EXPAND_ZOMBIES,    0); }
353
354static void expand_color_cb(UNFIXED, TREE_canvas *ntw, int colornum) { group_and_refold_tree(ntw, EXPAND_COLOR, colornum); }
355
356static void insert_color_collapse_submenu(AW_window_menu_modes *awm, TREE_canvas *ntree_canvas) {
357#define MAXLABEL 31
358#define MAXENTRY (AW_COLOR_GROUP_NAME_LEN+10)
359
360    td_assert(ntree_canvas);
361
362    awm->insert_sub_menu("Expand color ...", "o");
363
364    char        label_buf[MAXLABEL+1];
365    char        entry_buf[MAXENTRY+1];
366    char hotkey[]       = "x";
367    const char *hotkeys = "AN1234567890BC"+1;
368
369    for (int i = -1; i <= AW_COLOR_GROUPS; ++i) {
370        hotkey[0]                       = hotkeys[i];
371        if (hotkey[0] == ' ') hotkey[0] = 0;
372
373        if (i) {
374            if (i<0) {
375                strcpy(label_buf, "tree_group_not_any_color");
376                strcpy(entry_buf, "Any color group");
377            }
378            else {
379                sprintf(label_buf, "tree_group_not_color_%i", i);
380
381                char *color_group_name = AW_get_color_group_name(awm->get_root(), i);
382                sprintf(entry_buf, "%s group '%s'", hotkey, color_group_name);
383                free(color_group_name);
384            }
385        }
386        else {
387            strcpy(label_buf, "tree_group_not_no_color");
388            strcpy(entry_buf, "No color group");
389        }
390
391        awm->insert_menu_topic(awm->local_id(label_buf), entry_buf, hotkey, "tree_group.hlp", AWM_ALL, makeWindowCallback(expand_color_cb, ntree_canvas, i));
392    }
393
394    awm->close_sub_menu();
395
396#undef MAXLABEL
397#undef MAXENTRY
398}
399
400void NT_insert_collapse_submenu(AW_window_menu_modes *awm, TREE_canvas *ntw) {
401    awm->insert_sub_menu("Collapse/expand groups",         "d");
402    {
403        const char *grouphelp = "tree_group.hlp";
404        awm->insert_menu_topic(awm->local_id("tree_group_all"),         "Collapse all",      "C", grouphelp, AWM_ALL, makeWindowCallback(collapse_all_cb,      ntw));
405        awm->insert_menu_topic(awm->local_id("tree_group_term_groups"), "Collapse terminal", "t", grouphelp, AWM_ALL, makeWindowCallback(collapse_terminal_cb, ntw));
406        awm->sep______________();
407        awm->insert_menu_topic(awm->local_id("tree_ungroup_all"),       "Expand all",        "E", grouphelp, AWM_ALL, makeWindowCallback(expand_all_cb,        ntw));
408        awm->insert_menu_topic(awm->local_id("tree_group_not_marked"),  "Expand marked",     "m", grouphelp, AWM_ALL, makeWindowCallback(NT_expand_marked_cb,  ntw));
409        awm->insert_menu_topic(awm->local_id("tree_ungroup_zombies"),   "Expand zombies",    "z", grouphelp, AWM_ALL, makeWindowCallback(expand_zombies_cb,    ntw));
410        awm->sep______________();
411        insert_color_collapse_submenu(awm, ntw);
412    }
413    awm->close_sub_menu();
414}
415
416// ------------------------
417//      tree sorting :
418
419GB_ERROR NT_with_displayed_tree_do(TREE_canvas *ntw, bool (*displayed_tree_cb)(TreeNode *tree, GB_ERROR& error)) {
420    // 'displayed_tree_cb' has to return true if tree was changed and needs to be saved
421
422    GB_transaction   ta(ntw->gb_main);
423    AWT_auto_refresh allowed_on(ntw);
424
425    GB_ERROR error = NULp;
426    if (displayed_tree_cb(AWT_TREE(ntw)->get_root_node(), error)) {
427        ntw->request_save_and_zoom_reset();
428    }
429    return error;
430}
431
432void NT_resort_tree_cb(UNFIXED, TREE_canvas *ntw, TreeOrder order) {
433    GB_transaction   ta(ntw->gb_main);
434    AWT_auto_refresh allowed_on(ntw);
435
436    AWT_TREE(ntw)->reorderTree(order);
437    ntw->request_save_and_zoom_reset();
438}
439
440void NT_reset_lzoom_cb(UNFIXED, TREE_canvas *ntw) {
441    GB_transaction    ta(ntw->gb_main);
442    AWT_auto_refresh  allowed_on(ntw);
443    AWT_graphic_tree *agt = AWT_TREE(ntw);
444
445    agt->set_logical_root_to(agt->get_root_node());
446    ntw->request_zoom_reset();
447}
448
449void NT_reset_pzoom_cb(UNFIXED, TREE_canvas *ntw) {
450    GB_transaction   ta(ntw->gb_main);
451    AWT_auto_refresh allowed_on(ntw);
452    ntw->request_zoom_reset();
453}
454
455void NT_set_tree_style(UNFIXED, TREE_canvas *ntw, AP_tree_display_style style) {
456    {
457        AWT_auto_refresh allowed_on(ntw);
458        AWT_TREE(ntw)->set_tree_style(style, ntw);
459        ntw->request_zoom_reset();
460    }
461    TREE_auto_jump_cb(NULp, ntw, AP_JUMP_REASON_STYLE);
462}
463
464void NT_reinit_treetype(UNFIXED, TREE_canvas *ntw) {
465    NT_set_tree_style(NULp, ntw, AWT_TREE(ntw)->get_tree_style());
466}
467
468void NT_remove_leafs(UNFIXED, TREE_canvas *ntw, AWT_RemoveType mode) {
469    GB_transaction    ta(ntw->gb_main);
470    AWT_auto_refresh  allowed_on(ntw);
471
472    AP_tree *root_node = AWT_TREE(ntw)->get_root_node();
473    if (root_node) {
474        AWT_TREE(ntw)->get_tree_root()->remove_leafs(mode);
475        ntw->request_save_and_zoom_reset();
476    }
477    else {
478        aw_message("Got no tree");
479    }
480}
481
482void NT_remove_bootstrap(UNFIXED, TREE_canvas *ntw) { // delete all bootstrap values
483    GB_transaction   ta(ntw->gb_main);
484    AWT_auto_refresh allowed_on(ntw);
485
486    AP_tree *root_node = AWT_TREE(ntw)->get_root_node();
487    if (root_node) {
488        root_node->remove_bootstrap();
489        ntw->request_save_and_zoom_reset();
490    }
491    else {
492        aw_message("Got no tree");
493    }
494}
495
496void NT_reset_branchlengths(UNFIXED, TREE_canvas *ntw) { // set all branchlengths to tree_defaults::LENGTH
497    GB_transaction   ta(ntw->gb_main);
498    AWT_auto_refresh allowed_on(ntw);
499
500    AP_tree *root_node = AWT_TREE(ntw)->get_root_node();
501    if (root_node) {
502        root_node->reset_branchlengths();
503        ntw->request_save_and_zoom_reset();
504    }
505    else {
506        aw_message("Got no tree");
507    }
508}
509
510void NT_multifurcate_tree(TREE_canvas *ntw, const TreeNode::multifurc_limits& below) {
511    GB_transaction   ta(ntw->gb_main);
512    AWT_auto_refresh allowed_on(ntw);
513
514    TreeNode *tree = AWT_TREE(ntw)->get_root_node();
515    if (tree) {
516        tree->multifurcate_whole_tree(below);
517        ntw->request_save_and_zoom_reset();
518    }
519    else {
520        aw_message("Got no tree");
521    }
522}
523
524void NT_move_boot_branch(UNFIXED, TREE_canvas *ntw, int direction) { // copy branchlengths to bootstraps (or vice versa)
525    GB_transaction   ta(ntw->gb_main);
526    AWT_auto_refresh allowed_on(ntw);
527
528    AP_tree *root_node = AWT_TREE(ntw)->get_root_node();
529    if (root_node) {
530        if (direction == 0) root_node->bootstrap2branchlen();
531        else                root_node->branchlen2bootstrap();
532
533        ntw->request_save_and_zoom_reset();
534
535        char *adviceText = GBS_global_string_copy("Please note, that you just overwrote your existing %s.",
536                                                  direction ? "bootstrap values" : "branchlengths");
537        AW_advice(adviceText, AW_ADVICE_TOGGLE_AND_HELP, NULp, "tbl_boot2len.hlp");
538        free(adviceText);
539    }
540    else {
541        aw_message("Got no tree");
542    }
543}
544
545void NT_scale_tree(UNFIXED, TREE_canvas *ntw) { // scale branchlengths
546    char *answer = aw_input("Enter scale factor", "Scale branchlengths by factor:", "100");
547    if (answer) {
548        double   factor    = atof(answer);
549        AP_tree *root_node = AWT_TREE(ntw)->get_root_node();
550
551        if (root_node) {
552            GB_transaction   ta(ntw->gb_main);
553            AWT_auto_refresh allowed_on(ntw);
554            root_node->scale_branchlengths(factor);
555            ntw->request_save_and_zoom_reset();
556        }
557        else {
558            aw_message("Got no tree");
559        }
560        free(answer);
561    }
562}
563
564inline AP_tree *common_ancestor(AP_tree *t1, AP_tree *t2) {
565    return DOWNCAST(AP_tree*, t1->ancestor_common_with(t2));
566}
567
568void NT_jump_cb(UNFIXED, TREE_canvas *ntw, AP_tree_jump_type jumpType) {
569    if (jumpType == AP_DONT_JUMP) return;
570
571    AW_window        *aww   = ntw->aww;
572    AWT_graphic_tree *gtree = AWT_TREE(ntw);
573
574    GB_transaction   ta(ntw->gb_main);
575    AWT_auto_refresh allowed_on(ntw);
576
577    AW_root    *aw_root  = aww->get_root();
578    const char *name     = aw_root->awar(AWAR_SPECIES_NAME)->read_char_pntr();
579    GBDATA     *gb_group = gtree->get_selected_group().get_group_data();
580
581    char *msg      = NULp;
582    bool  verboose = jumpType & AP_JUMP_BE_VERBOOSE;
583
584    if (name[0] || gb_group) {
585        AP_tree *found         = NULp;
586        bool     is_tree       = is_tree_style(gtree->get_tree_style());
587        bool     jump_to_group = gb_group && is_tree; // @@@ prefer group atm
588
589        if (is_tree) {
590            if (gtree && gtree->get_logical_root()) {
591                if (jump_to_group) {
592                    found = gtree->locate_selected_group(gtree->get_logical_root());
593                    td_assert(found && found->is_clade());
594                }
595                else {
596                    found = gtree->get_logical_root()->findLeafNamed(name);
597                }
598
599                if (!found && gtree->is_logically_zoomed()) {
600                    if (jump_to_group) {
601                        found = gtree->locate_selected_group(gtree->get_root_node());
602                    }
603                    else {
604                        found = gtree->get_root_node()->findLeafNamed(name);
605                    }
606
607                    if (found) { // species/group is invisible because it is outside logically zoomed tree
608                        if (jumpType & AP_JUMP_LOGICAL_UNZOOM) {
609                            gtree->set_logical_root_to(common_ancestor(found, gtree->get_logical_root()));
610                            ntw->request_resize();
611                        }
612                        else {
613                            if (verboose) {
614                                if (jump_to_group) {
615                                    msg = GBS_global_string_copy("Group '%s' is outside logical zoomed subtree", gtree->get_selected_group().get_name());
616                                }
617                                else {
618                                    msg = GBS_global_string_copy("Species '%s' is outside logical zoomed subtree", name);
619                                }
620                            }
621
622                            found = NULp;
623                        }
624                    }
625                }
626
627                if (found && !(jumpType&AP_JUMP_AUTO_UNFOLD) && found->is_inside_folded_group()) {
628                    found = NULp; // => just undo auto-unfolding
629                }
630                gtree->auto_unfold(found);
631            }
632        }
633
634        if (found || !is_tree) {
635            bool is_IRS  = gtree->get_tree_style() == AP_TREE_IRS;
636            bool repeat  = is_IRS;
637            bool do_jump = true;
638
639            ntw->sync_DB_model_and_view(false); // sync w/o refresh
640
641            while (do_jump) {
642                do_jump = false;
643
644                AW_device_size *device = aww->get_size_device(AW_MIDDLE_AREA);
645                device->set_filter(AW_SIZE|AW_SIZE_UNSCALED);
646                device->reset();
647                ntw->init_device(device);
648                ntw->gfx->show(device);
649
650                const AW_screen_area& screen = device->get_area_size();
651
652                const Position& cursor = jump_to_group ? gtree->get_group_cursor() : gtree->get_cursor();
653                if (are_distinct(Origin, cursor)) {
654                    Position S = device->transform(cursor);
655
656                    int scroll_x = 0;
657                    int scroll_y = 0;
658
659                    bool do_vcenter = jumpType & AP_JUMP_FORCE_VCENTER;
660                    bool do_hcenter = jumpType & AP_JUMP_FORCE_HCENTER;
661
662                    if (!do_vcenter) {
663                        if (is_IRS) {
664                            // attempt to center IRS tree vertically often fails (too complicated to predict)
665                            // => force into center-half of screen to reduce error rate
666                            int border = screen.b/10;
667                            do_vcenter = S.ypos()<border || S.ypos()>(screen.b-border);
668                        }
669                        else {
670                            do_vcenter = S.ypos()<0.0 || S.ypos()>screen.b; // center if outside viewport
671                        }
672                    }
673
674                    if (do_vcenter) {
675                        scroll_y = (int)(S.ypos() - screen.b*(is_IRS ? .6 : .5)); // position a bit below vertical center for IRS tree
676
677                        if (!scroll_y && (jumpType & AP_JUMP_ALLOW_HCENTER)) { // allow horizontal centering if vertical has no effect
678                            do_hcenter = true;
679                        }
680                    }
681
682                    if (do_hcenter) {
683                        scroll_x = (int) (S.xpos() - screen.r * (is_tree ? .5 : .02));
684                    }
685                    else { // keep visible
686                        if (S.xpos()<0.0) {
687                            double relPos = 0;
688                            switch (gtree->get_tree_style()) {
689                                case AP_TREE_NORMAL:
690                                case AP_TREE_IRS:      relPos = .1; break;
691                                case AP_TREE_RADIAL:   relPos = .5; break;
692                                case AP_LIST_NDS:
693                                case AP_LIST_SIMPLE:   relPos = .02; break;
694                            }
695                            scroll_x = (int)(S.xpos() - screen.r * relPos);
696                        }
697                        else if (S.xpos()>screen.r) {
698                            scroll_x = (int)(S.xpos() - screen.r * .5);
699                        }
700                    }
701
702                    if (scroll_x || scroll_y) ntw->scroll(scroll_x, scroll_y);
703                    if (repeat) {
704                        // reposition jump in IRS tree (reduces jump failure rate)
705                        repeat  = false;
706                        do_jump = true;
707                    }
708                }
709                else {
710                    td_assert(!is_tree); // jumped-to position should have been found
711                    if (verboose) msg = GBS_global_string_copy("Species '%s' is no member of this list", name);
712                }
713            }
714        }
715
716        if (!found && is_tree && verboose && !msg) {
717            td_assert(!jump_to_group); // need special handling
718            msg = GBS_global_string_copy("Species '%s' is no member of this %s", name, gtree->get_tree_style() == AP_LIST_NDS ? "list" : "tree");
719        }
720
721    }
722    else { // select "no species" and "no group"
723        gtree->auto_unfold(NULp); // undo auto-unfolding
724        if (verboose) {
725            msg = strdup("Neither species nor group selected");
726        }
727    }
728
729    if (gtree) gtree->exports.request_refresh(); // always do refresh to show change of selected species
730
731    if (msg) {
732        td_assert(verboose);
733        aw_message(msg);
734        free(msg);
735    }
736}
737
738void TREE_auto_jump_cb(UNFIXED, TREE_canvas *ntw, AP_tree_jump_reason cause) {
739    /*! jump to species when tree/treemode/species changes
740     * @param cause reason why auto-jump was triggered
741     */
742
743    AWT_auto_refresh allowed_on(ntw);
744
745    bool tree_change = cause == AP_JUMP_REASON_TREE || cause == AP_JUMP_REASON_STYLE;
746
747    const char        *awar_name = tree_change ? AWAR_DTREE_AUTO_JUMP_TREE : AWAR_DTREE_AUTO_JUMP;
748    AW_root           *awr       = ntw->aww->get_root();
749    AP_tree_jump_type  jump_type = AP_tree_jump_type(awr->awar(awar_name)->read_int());
750
751    if (jump_type == AP_DONT_JUMP) {
752        ntw->request_refresh();
753    }
754    else {
755        bool auto_unfold           = awr->awar(AWAR_DTREE_AUTO_UNFOLD)->read_int();
756        if (auto_unfold) jump_type = AP_tree_jump_type(jump_type|AP_JUMP_AUTO_UNFOLD);
757        NT_jump_cb(NULp, ntw, jump_type);
758    }
759}
760
761inline const char *plural(int val) {
762    return "s"+(val == 1);
763}
764
765void NT_reload_tree_event(AW_root *, TREE_canvas *ntw, bool unzoom_and_expose) {
766    GB_push_transaction(ntw->gb_main);
767
768    {
769        AWT_auto_refresh update(ntw);
770
771        AWT_graphic_tree *agt   = ntw->get_graphic_tree();
772        AP_tree_root     *troot = agt->get_tree_root();
773
774        if (!troot->get_gb_tree()) { // happens at initial startup (=first load) and after a shown tree gets renamed
775            // forget all about old tree
776            agt->forget_auto_unfolded();
777            agt->deselect_group();
778        }
779        else {
780            agt->auto_unfold(NULp);     // undo auto-unfolding before tree-change (otherwise temp. unfolding remains saved in DB)
781        }
782        update.suppress_update_and_refresh(); // suppress update (speed)
783    }
784
785    char     *tree_name = ntw->get_awar_tree()->read_string();
786    GB_ERROR  error     = ntw->gfx->load_from_DB(ntw->gb_main, tree_name);
787    if (error) {
788        aw_message(error);
789    }
790    else {
791        int zombies, duplicates;
792        DOWNCAST(AWT_graphic_tree*, ntw->gfx)->get_zombies_and_duplicates(zombies, duplicates);
793
794        if (zombies || duplicates) {
795            const char *msg = NULp;
796            if (duplicates) {
797                if (zombies) msg = GBS_global_string("%i zombie%s and %i duplicate%s", zombies, plural(zombies), duplicates, plural(duplicates));
798                else msg         = GBS_global_string("%i duplicate%s", duplicates, plural(duplicates));
799            }
800            else {
801                td_assert(zombies);
802                msg = GBS_global_string("%i zombie%s", zombies, plural(zombies));
803            }
804            aw_message(GBS_global_string("%s in '%s'", msg, tree_name));
805        }
806    }
807    free(tree_name);
808    if (unzoom_and_expose) {
809        AWT_auto_refresh allowed_on(ntw);
810        ntw->request_zoom_reset();
811    }
812    GB_pop_transaction(ntw->gb_main);
813}
814
815static void tree_recompute_cb(UNFIXED, AWT_canvas *ntw) {
816    AWT_auto_refresh allowed_on(ntw);
817    ntw->request_structure_update();
818}
819
820void TREE_GC_changed_cb(GcChange whatChanged, AWT_canvas *ntw) {
821    AWT_auto_refresh allowed_on(ntw);
822
823    if (whatChanged == GC_COLOR_GROUP_USE_CHANGED) {
824        tree_recompute_cb(NULp, ntw);
825    }
826    else {
827        AWT_GC_changed_cb(whatChanged, ntw);
828    }
829}
830
831void NT_remove_species_in_tree_from_hash(AP_tree *tree, GB_HASH *hash) {
832    if (!tree) return;
833    if (tree->is_leaf() && tree->name) {
834        GBS_write_hash(hash, tree->name, 0); // delete species in hash table
835    }
836    else {
837        NT_remove_species_in_tree_from_hash(tree->get_leftson(), hash);
838        NT_remove_species_in_tree_from_hash(tree->get_rightson(), hash);
839    }
840}
841
Note: See TracBrowser for help on using the repository browser.