source: tags/ms_r17q3/SECEDIT/SEC_db.cxx

Last change on this file was 15665, checked in by westram, 7 years ago
  • reintegrates 'refactor' into 'trunk'
    • refactored AWT_graphic
      • now have explicit states with different permissions
        1. update model + request view/DB updates (AWT_auto_refresh)
          • always preceeded by DB→model up-to-date-check
          • automatically updates the view on destruction
        2. update (DB and view) from model
        3. neither
    • benefits
      • saves several view-updates
      • unproblematic nesting of functions requesting view-updates
      • will allow
        • delayed view-updates and
        • easier modification of update logic
    • fixes a bunch of update-issues (found on the way)
  • adds: log:branches/refactor@15613:15615,15627:15637,15639:15664
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.9 KB
Line 
1// =============================================================== //
2//                                                                 //
3//   File      : SEC_db.cxx                                        //
4//   Purpose   : db interface                                      //
5//                                                                 //
6//   Coded by Ralf Westram (coder@reallysoft.de) in August 2007    //
7//   Institute of Microbiology (Technical University Munich)       //
8//   http://www.arb-home.de/                                       //
9//                                                                 //
10// =============================================================== //
11
12#include "SEC_graphic.hxx"
13#include "SEC_root.hxx"
14#include "SEC_bonddef.hxx"
15#include "SEC_toggle.hxx"
16
17#include <aw_awars.hxx>
18#include <aw_file.hxx>
19#include <aw_msg.hxx>
20#include <aw_root.hxx>
21#include <ed4_extern.hxx>
22#include <arbdbt.h>
23#include <ad_cb.h>
24
25#include <arb_defs.h>
26
27using namespace std;
28
29// -----------------------------------
30//      member function callbacks
31
32typedef void (SEC_db_interface::*interface_cb)(const SEC_dbcb *);
33
34struct SEC_dbcb {
35    SEC_db_interface *instance;
36    interface_cb      member_fun;
37
38    SEC_dbcb(SEC_db_interface *db, interface_cb cb) : instance(db), member_fun(cb) {}
39    void call() const { (instance->*member_fun)(this); }
40};
41
42static void sec_dbcb(UNFIXED, const SEC_dbcb *cb) {
43    cb->call();
44}
45
46// ----------------------
47//      SEC_seq_data
48
49SEC_seq_data::SEC_seq_data(GBDATA *gb_item, const char *aliname, const SEC_dbcb *cb) {
50    gb_name   = GB_search(gb_item, "name", GB_FIND);
51    gb_data   = GBT_find_sequence(gb_item, aliname);
52    change_cb = cb;
53    len       = GB_read_string_count(gb_data);
54    Data      = GB_read_string(gb_data);
55
56    if (gb_name) GB_add_callback(gb_name, GB_CB_CHANGED_OR_DELETED, makeDatabaseCallback(sec_dbcb, change_cb));
57    if (gb_data) GB_add_callback(gb_data, GB_CB_CHANGED_OR_DELETED, makeDatabaseCallback(sec_dbcb, change_cb));
58}
59
60SEC_seq_data::~SEC_seq_data() {
61    if (gb_name) GB_remove_callback(gb_name, GB_CB_CHANGED_OR_DELETED, makeDatabaseCallback(sec_dbcb, change_cb));
62    if (gb_data) GB_remove_callback(gb_data, GB_CB_CHANGED_OR_DELETED, makeDatabaseCallback(sec_dbcb, change_cb));
63    free(Data);
64}
65
66// -------------------
67//      pair defs
68
69#define AWAR_PAIRS(type) AWAR_SECEDIT_##type##_PAIRS
70#define AWAR_PCHAR(type) AWAR_SECEDIT_##type##_PAIR_CHAR
71
72struct PairDefinition {
73    const char *awar_pairs;
74    const char *awar_pairchar;
75    const char *default_pairs;
76    const char *default_pairchar;
77};
78
79#define PAIR_TYPES 5
80static PairDefinition pairdef[PAIR_TYPES] = {
81    { AWAR_PAIRS(STRONG), AWAR_PCHAR(STRONG), "GC AU AT",                   "-" },
82    { AWAR_PAIRS(NORMAL), AWAR_PCHAR(NORMAL), "GU GT",                      "." },
83    { AWAR_PAIRS(WEAK),   AWAR_PCHAR(WEAK),   "GA",                         "o" },
84    { AWAR_PAIRS(NO),     AWAR_PCHAR(NO),     "AA AC CC CU CT GG UU TT TU", ""  },
85    { AWAR_PAIRS(USER),   AWAR_PCHAR(USER),   "",                           ""  },
86};
87
88GB_ERROR SEC_bond_def::update(AW_root *aw_root, const char *changed_awar_name)
89{
90    GB_ERROR error = 0;
91
92    if (changed_awar_name) {
93        int changed_pair_idx = -1;
94        for (int i = 0; i<PAIR_TYPES; ++i) {
95            if (strcmp(changed_awar_name, pairdef[i].awar_pairs) == 0) {
96                changed_pair_idx = i;
97                break;
98            }
99        }
100
101        sec_assert(changed_pair_idx != -1);
102
103        if (changed_pair_idx != -1) {
104            char *content = aw_root->awar(changed_awar_name)->read_string();
105
106            for (int i = 0; i<PAIR_TYPES; ++i) {
107                if (i != changed_pair_idx) { // correct other pair strings
108                    clear();
109                    AW_awar *awar = aw_root->awar(pairdef[i].awar_pairs);
110
111                    char *oldP = awar->read_string();
112
113                    insert(oldP, '#');
114                    insert(content, ' ');
115
116                    char *newP = get_pair_string('#');
117
118                    if (strcmp(oldP, newP) != 0) awar->write_string(newP);
119
120                    free(newP);
121                    free(oldP);
122                }
123            }
124            free(content);
125        }
126    }
127
128    clear();
129    for (int i = 0; !error && i<PAIR_TYPES; ++i) {
130        char *pairs    = aw_root->awar(pairdef[i].awar_pairs)->read_string();
131        char *pairchar = aw_root->awar(pairdef[i].awar_pairchar)->read_string();
132
133        error = insert(pairs, pairchar[0]);
134
135        free(pairchar);
136        free(pairs);
137    }
138
139    return error;
140}
141
142static void pair_def_changed_cb(AW_root *aw_root, SEC_db_interface *db, const char *awar_name) {
143    AWT_auto_refresh allowed_on(db->canvas());
144    GB_ERROR err = db->bonds()->update(aw_root, awar_name);
145    if (err) aw_message(err);
146    db->canvas()->request_refresh();
147}
148
149static void bind_bonddef_awars(SEC_db_interface *db) {
150    AW_root *aw_root = db->awroot();
151
152    for (int i = 0; i<PAIR_TYPES; ++i) {
153        PairDefinition& pd = pairdef[i];
154        aw_root->awar(pd.awar_pairs)   ->add_callback(makeRootCallback(pair_def_changed_cb, db, pd.awar_pairs));
155        aw_root->awar(pd.awar_pairchar)->add_callback(makeRootCallback(pair_def_changed_cb, db, (const char *)NULL));
156    }
157
158    pair_def_changed_cb(aw_root, db, NULL);
159}
160
161// --------------------------------------------------------------------------------
162
163void SEC_displayParams::reread(AW_root *aw_root, const ED4_plugin_host& host) {
164    show_helixNrs            = aw_root->awar(AWAR_SECEDIT_SHOW_HELIX_NRS)->read_int();
165    distance_between_strands = aw_root->awar(AWAR_SECEDIT_DIST_BETW_STRANDS)->read_float();
166    show_bonds               = (ShowBonds)aw_root->awar(AWAR_SECEDIT_SHOW_BONDS)->read_int();
167    show_curpos              = (ShowCursorPos)aw_root->awar(AWAR_SECEDIT_SHOW_CURPOS)->read_int();
168
169    hide_bases     = aw_root->awar(AWAR_SECEDIT_HIDE_BASES)->read_int();
170    show_ecoli_pos = aw_root->awar(AWAR_SECEDIT_SHOW_ECOLI_POS)->read_int();
171    display_search = aw_root->awar(AWAR_SECEDIT_DISPLAY_SEARCH)->read_int();
172    display_sai    = aw_root->awar(AWAR_SECEDIT_DISPLAY_SAI)->read_int() && host.SAIs_visualized();
173
174    show_strSkeleton   = aw_root->awar(AWAR_SECEDIT_SHOW_STR_SKELETON)->read_int();
175    skeleton_thickness = aw_root->awar(AWAR_SECEDIT_SKELETON_THICKNESS)->read_int();
176    bond_thickness     = aw_root->awar(AWAR_SECEDIT_BOND_THICKNESS)->read_int();
177
178    edit_rightward = aw_root->awar(AWAR_EDIT_RIGHTWARD)->read_int();
179
180#if defined(DEBUG)
181    show_debug = aw_root->awar(AWAR_SECEDIT_SHOW_DEBUG)->read_int();
182#endif // DEBUG
183}
184
185// --------------------------
186//      SEC_db_interface
187
188void SEC_db_interface::reload_sequence(const SEC_dbcb *cb) {
189    GB_transaction ta(gb_main);
190    AWT_auto_refresh allowed_on(scr);
191
192    char   *species_name = aw_root->awar(AWAR_SPECIES_NAME)->read_string();
193    bool    had_sequence = sequence;
194    GBDATA *gb_species   = GBT_find_species(gb_main, species_name);
195
196    delete sequence;
197    sequence = gb_species ? new SEC_seq_data(gb_species, aliname, cb) : 0;
198    Host.announce_current_species(species_name);
199
200    if (bool(sequence) != had_sequence) scr->request_zoom_reset();
201    if (sequence) gfx->request_update(SEC_UPDATE_SHOWN_POSITIONS);
202
203    scr->request_refresh();
204
205    free(species_name);
206}
207
208void SEC_db_interface::reload_ecoli(const SEC_dbcb *cb) {
209    GB_transaction ta(gb_main);
210    AWT_auto_refresh allowed_on(scr);
211
212    delete ecoli_seq;
213    delete Ecoli;
214
215    GBDATA *gb_ecoli = GBT_find_SAI(gb_main, "ECOLI");
216    if (gb_ecoli) {
217        ecoli_seq = new SEC_seq_data(gb_ecoli, aliname, cb);
218        Ecoli = new BI_ecoli_ref;
219
220        Ecoli->init(ecoli_seq->sequence(), ecoli_seq->length());
221    }
222    else {
223        ecoli_seq = 0;
224        Ecoli     = 0;
225    }
226
227    gfx->request_update(SEC_UPDATE_SHOWN_POSITIONS);
228    scr->request_refresh();
229}
230
231void SEC_db_interface::reload_helix(const SEC_dbcb *cb) {
232    GB_transaction ta(gb_main);
233    AWT_auto_refresh allowed_on(scr);
234
235    delete helix_nr;    helix_nr  = 0;
236    delete helix_pos;   helix_pos = 0;
237    delete Helix;       Helix     = 0;
238
239    char *helix_pos_name = GBT_get_default_helix(gb_main);
240    GBDATA *gb_helix_pos = GBT_find_SAI(gb_main, helix_pos_name);
241    if (gb_helix_pos) {
242        char   *helix_nr_name = GBT_get_default_helix_nr(gb_main);
243        GBDATA *gb_helix_nr   = GBT_find_SAI(gb_main, helix_nr_name);
244
245        if (gb_helix_nr) {
246            helix_pos = new SEC_seq_data(gb_helix_pos, aliname, cb);
247            helix_nr  = new SEC_seq_data(gb_helix_nr, aliname, cb);
248            Helix     = new BI_helix;
249
250            GB_ERROR error = Helix->initFromData(helix_nr->sequence(), helix_pos->sequence(), helix_pos->length());
251            if (error) {
252                error = ta.close(error);
253                aw_message(error);
254            }
255        }
256
257        free(helix_nr_name);
258    }
259    free(helix_pos_name);
260
261    gfx->request_update(static_cast<SEC_update_request>(SEC_UPDATE_SHOWN_POSITIONS|SEC_UPDATE_RELOAD));
262    scr->request_refresh();
263}
264
265void SEC_db_interface::update_positions(const SEC_dbcb *) {
266    AWT_auto_refresh allowed_on(scr);
267    displayBindingHelixPositions = aw_root->awar(AWAR_SECEDIT_DISPPOS_BINDING)->read_int();
268    displayEcoliPositions        = aw_root->awar(AWAR_SECEDIT_DISPPOS_ECOLI)->read_int();
269
270    gfx->sec_root->nail_cursor();
271    gfx->request_update(SEC_UPDATE_SHOWN_POSITIONS);
272    scr->request_refresh();
273}
274
275void SEC_db_interface::relayout(const SEC_dbcb *) {
276    SEC_root *root = secroot();
277    AWT_auto_refresh allowed_on(scr);
278    root->reread_display_params(awroot(), Host);
279    root->nail_cursor();
280    gfx->request_update(SEC_UPDATE_RECOUNT);
281    scr->request_refresh();
282}
283
284void SEC_db_interface::refresh(const SEC_dbcb *) {
285    SEC_root *root = secroot();
286    AWT_auto_refresh allowed_on(scr);
287    root->reread_display_params(awroot(), Host);
288    scr->request_refresh();
289}
290
291void SEC_root::set_cursor(int abspos) {
292
293    nail_cursor();
294    int nailedPos = nailedAbsPos;
295
296    cursorAbsPos = abspos;
297
298    {
299        AWT_auto_refresh allowed_on(db->canvas()); // @@@ try up-scope!
300        db->canvas()->request_refresh();
301    }
302
303    nailedAbsPos = nailedPos;
304    position_cursor(false, false);
305}
306
307void SEC_db_interface::cursor_changed(const SEC_dbcb *) {
308    SEC_root *root    = secroot();
309    int       seq_pos = bio2info(aw_root->awar_int(AWAR_CURSOR_POSITION)->read_int());
310
311    root->set_cursor(seq_pos);
312}
313
314void SEC_db_interface::alilen_changed(const SEC_dbcb *) {
315    AWT_auto_refresh allowed_on(scr);
316#if defined(WARN_TODO)
317#warning @@@reread alilen
318#warning test changing ali length!
319#endif
320    gfx->request_update(SEC_UPDATE_RELOAD);
321    scr->request_refresh();
322}
323
324// --------------------------------------------------------------------------------
325
326static const char *update_pos_awars[] = {
327    AWAR_SECEDIT_DISPPOS_BINDING,
328    AWAR_SECEDIT_DISPPOS_ECOLI,
329    NULL
330};
331
332static const char *relayout_awars[] = {
333    AWAR_SECEDIT_DIST_BETW_STRANDS,
334    NULL
335};
336
337static const char *refresh_awars[] = {
338    AWAR_SECEDIT_SHOW_HELIX_NRS,
339    AWAR_SECEDIT_SHOW_BONDS,
340    AWAR_SECEDIT_SHOW_CURPOS,
341    AWAR_SECEDIT_HIDE_BASES,
342    AWAR_SECEDIT_SHOW_ECOLI_POS,
343    AWAR_SECEDIT_DISPLAY_SEARCH,
344    AWAR_SECEDIT_DISPLAY_SAI,
345    AWAR_SECEDIT_SHOW_STR_SKELETON,
346    AWAR_SECEDIT_SKELETON_THICKNESS,
347    AWAR_SECEDIT_BOND_THICKNESS,
348    AWAR_EDIT_RIGHTWARD,
349    ED4_AWAR_SEARCH_RESULT_CHANGED,
350#if defined(DEBUG)
351    AWAR_SECEDIT_SHOW_DEBUG,
352#endif // DEBUG
353    NULL
354};
355
356void SEC_db_interface::bind_awars(const char **awars, SEC_dbcb *cb) {
357    RootCallback awarcb = makeRootCallback(sec_dbcb, cb);
358    for (int i = 0; awars[i]; ++i) {
359        aw_root->awar(awars[i])->add_callback(awarcb);
360    }
361}
362
363// --------------------------------------------------------------------------------
364
365static void create_awars(AW_root *aw_root, AW_default def) {
366    aw_root->awar_int(AWAR_SECEDIT_BASELINEWIDTH, 0, def)->set_minmax(0, 10);
367    aw_root->awar_string(AWAR_FOOTER);
368
369    {
370        char *dir = ARB_strdup(GB_path_in_arbprop("secondary_structure"));
371        AW_create_fileselection_awars(aw_root, AWAR_SECEDIT_SAVEDIR, dir, ".ass", "noname.ass");
372        free(dir);
373    }
374
375    aw_root->awar_float(AWAR_SECEDIT_DIST_BETW_STRANDS,  1, def)->set_minmax(0.01, 40);
376    aw_root->awar_int  (AWAR_SECEDIT_SKELETON_THICKNESS, 1, def)->set_minmax(1,    10);
377    aw_root->awar_int  (AWAR_SECEDIT_BOND_THICKNESS,     1, def)->set_minmax(1,    10);
378
379#if defined(DEBUG)
380    aw_root->awar_int(AWAR_SECEDIT_SHOW_DEBUG,        0,                def);
381#endif // DEBUG
382    aw_root->awar_int(AWAR_SECEDIT_SHOW_HELIX_NRS,    0,                def);
383    aw_root->awar_int(AWAR_SECEDIT_SHOW_ECOLI_POS,    0,                def);
384    aw_root->awar_int(AWAR_SECEDIT_SHOW_STR_SKELETON, 0,                def);
385    aw_root->awar_int(AWAR_SECEDIT_HIDE_BASES,        0,                def);
386    aw_root->awar_int(AWAR_SECEDIT_SHOW_BONDS,        SHOW_HELIX_BONDS, def);
387    aw_root->awar_int(AWAR_SECEDIT_SHOW_CURPOS,       SHOW_ABS_CURPOS,  def);
388    aw_root->awar_int(AWAR_SECEDIT_DISPLAY_SAI,       0,                def);
389    aw_root->awar_int(AWAR_SECEDIT_DISPLAY_SEARCH,    0,                def);
390    aw_root->awar_int(AWAR_SECEDIT_DISPPOS_BINDING,   0,                def);
391    aw_root->awar_int(AWAR_SECEDIT_DISPPOS_ECOLI,     1,                def);
392
393    for (int i = 0; i<PAIR_TYPES; ++i) {
394        PairDefinition& pd = pairdef[i];
395        aw_root->awar_string(pd.awar_pairs,    pd.default_pairs);
396        aw_root->awar_string(pd.awar_pairchar, pd.default_pairchar);
397    }
398}
399
400// --------------------------------------------------------------------------------
401
402SEC_db_interface::SEC_db_interface(SEC_graphic *Gfx, AWT_canvas *Scr, ED4_plugin_host& host_) :
403    sequence(0),
404    Host(host_),
405    displayEcoliPositions(false),
406    ecoli_seq(0),
407    Ecoli(0),
408    displayBindingHelixPositions(true),
409    helix_nr(0),
410    helix_pos(0),
411    Helix(0),
412    gfx(Gfx),
413    scr(Scr),
414    gb_main(gfx->gb_main),
415    aw_root(gfx->aw_root)
416{
417    AWT_auto_refresh allowed_on(Scr);
418    GB_transaction   ta(gb_main);
419
420    create_awars(aw_root, AW_ROOT_DEFAULT);
421
422    aliname    = GBT_get_default_alignment(gb_main);
423    sec_assert(aliname);
424    ali_length = GBT_get_alignment_len(gb_main, aliname);
425    displayPos = new bool[ali_length];
426    bonddef    = new SEC_bond_def(GBT_get_alignment_type(gb_main, aliname));
427
428    // awar and DB callbacks:
429
430    sequence_cb       = new SEC_dbcb(this, &SEC_db_interface::reload_sequence);
431    ecoli_cb          = new SEC_dbcb(this, &SEC_db_interface::reload_ecoli);
432    helix_cb          = new SEC_dbcb(this, &SEC_db_interface::reload_helix);
433    updatepos_cb      = new SEC_dbcb(this, &SEC_db_interface::update_positions);
434    relayout_cb       = new SEC_dbcb(this, &SEC_db_interface::relayout);
435    refresh_cb        = new SEC_dbcb(this, &SEC_db_interface::refresh);
436    cursorpos_cb      = new SEC_dbcb(this, &SEC_db_interface::cursor_changed);
437    alilen_changed_cb = new SEC_dbcb(this, &SEC_db_interface::alilen_changed);
438
439    aw_root->awar_string(AWAR_SPECIES_NAME,    "", gb_main)->add_callback(makeRootCallback(sec_dbcb, sequence_cb));
440    aw_root->awar_string(AWAR_CURSOR_POSITION, "", gb_main)->add_callback(makeRootCallback(sec_dbcb, cursorpos_cb));
441
442    bind_awars(update_pos_awars, updatepos_cb);
443    bind_awars(relayout_awars, relayout_cb);
444    bind_awars(refresh_awars, refresh_cb);
445
446    bind_bonddef_awars(this);
447
448    {
449        GBDATA *gb_alignment     = GBT_get_alignment(gb_main, aliname);
450        GBDATA *gb_alignment_len = GB_search(gb_alignment, "alignment_len", GB_FIND);
451        sec_assert(gb_alignment_len);
452        GB_add_callback(gb_alignment_len, GB_CB_CHANGED, makeDatabaseCallback(sec_dbcb, alilen_changed_cb));
453    }
454
455    sequence_cb->call();
456    ecoli_cb->call();
457    helix_cb->call();
458    updatepos_cb->call();
459    relayout_cb->call();
460    refresh_cb->call();
461
462    toggler = 0;
463}
464
465SEC_db_interface::~SEC_db_interface() {
466    free(aliname);
467
468    delete [] displayPos;
469
470    delete sequence;    sequence = 0;
471
472    delete ecoli_seq;   ecoli_seq = 0;
473    delete Ecoli;       Ecoli     = 0;
474
475    delete helix_nr;    helix_nr  = 0;
476    delete helix_pos;   helix_pos = 0;
477    delete Helix;       Helix     = 0;
478
479    delete sequence_cb;         sequence_cb       = 0;
480    delete ecoli_cb;            ecoli_cb          = 0;
481    delete helix_cb;            helix_cb          = 0;
482    delete updatepos_cb;        updatepos_cb      = 0;
483    delete relayout_cb;         relayout_cb       = 0;
484    delete refresh_cb;          refresh_cb        = 0;
485    delete cursorpos_cb;        cursorpos_cb      = 0;
486    delete alilen_changed_cb;   alilen_changed_cb = 0;
487
488    delete toggler;     toggler = 0;
489
490    delete bonddef;     bonddef = 0;
491}
492
493SEC_root *SEC_db_interface::secroot() const { return gfx->sec_root; }
494
495// --------------------------------------------------------------------------------
496
497inline bool gap(char c) { return c == '-' || c == '.'; }
498
499void SEC_db_interface::update_shown_positions() {
500    shown = 0;
501
502    sec_assert(sequence && Helix);
503
504    for (size_t pos = 0; pos<ali_length; ++pos) {
505        bool isPaired = Helix->pairtype(pos) != HELIX_NONE;
506        char base     = baseAt(pos);
507
508        if (isPaired) {
509            if (displayBindingHelixPositions) {
510                displayPos[pos] = true;
511            }
512            else {
513                char oppoBase = baseAt(Helix->opposite_position(pos));
514
515                displayPos[pos] = !(gap(base) && gap(oppoBase)); // display if one side of helix has base
516            }
517        }
518        else {
519            displayPos[pos] = !gap(base);
520        }
521
522        shown += displayPos[pos];
523    }
524
525    // add hidden ecoli positions
526    if (displayEcoliPositions && ecoli_seq) {
527        for (size_t pos = 0; pos<ali_length; ++pos) {
528            if (!displayPos[pos] && !gap(ecoli_seq->data(pos))) {
529                displayPos[pos] = true;
530                shown++;
531            }
532        }
533    }
534}
535
536void SEC_db_interface::init_toggler() const {
537    if (!toggler) toggler = new SEC_structure_toggler(gb_main, aliname, gfx);
538}
539
540void SEC_root::update_shown_positions() {
541    db->update_shown_positions();
542}
543
544// --------------------------------------------------------------------------------
545
Note: See TracBrowser for help on using the repository browser.