source: tags/arb-6.0-rc1/EDIT4/ed4_class.hxx

Last change on this file was 11838, checked in by westram, 11 years ago
  • code visibility
    • made functions static
    • moved functions into UNIT_TESTS section
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 92.5 KB
Line 
1#ifndef ED4_CLASS_HXX
2#define ED4_CLASS_HXX
3
4#ifndef AW_FONT_GROUP_HXX
5#include <aw_font_group.hxx>
6#endif
7#ifndef POS_RANGE_H
8#include <pos_range.h>
9#endif
10
11#define e4_assert(bed) arb_assert(bed)
12
13#define concat(a,b) a##b
14
15#ifdef DEBUG
16# define IMPLEMENT_DUMP         // comment out this line to skip compilation of the dump() methods
17#endif
18
19#ifndef ARB_ERROR_H
20#include <arb_error.h>
21#endif
22#ifndef ED4_DEFS_HXX
23#include "ed4_defs.hxx"
24#endif
25#ifndef ED4_SEARCH_HXX
26#include "ed4_search.hxx"
27#endif
28#ifndef _GLIBCXX_SET
29#include <set>
30#endif
31#ifndef ATTRIBUTES_H
32#include <attributes.h>
33#endif
34#ifndef BI_BASEPOS_HXX
35#include <BI_basepos.hxx>
36#endif
37#ifndef DOWNCAST_H
38#include <downcast.h>
39#endif
40
41#if defined(IMPLEMENT_DUMP) // ------------------------------
42
43#if 0
44#define WARN(msg) void dummy_to_produce_a_warning(int msg) {}
45#else
46#define WARN(msg)
47#endif
48
49#define EMPTY_FUNCTION(name)         void name() const {}
50#define EMPTY_FUNCTION_VERBOSE(name) void name(int je_mappelle_##name) const {}
51
52#define DERIVABLEFROM(base) concat(prohibited_leafclass_derivation,base)
53
54#define COMMON_FOR_BASES()                      \
55    virtual void dump(size_t indent) const = 0; \
56
57#define COMMON_FOR_DERIVABLE(self)               \
58    void dump_base(size_t indent) const;         \
59    EMPTY_FUNCTION(DERIVABLEFROM(self));         \
60       
61#define COMMON_FOR_DERIVED(mybase)                                              \
62    void dump_my_base(size_t indent) const { mybase::dump_base(indent); }       \
63    virtual const char *baseclassname() const { return #mybase; }               \
64   
65#define COMMON_FOR_INSTANCIABLE(mybase)                 \
66    virtual void dump(size_t indent) const OVERRIDE;    \
67
68#define DECLARE_DUMP_FOR_ROOTCLASS(self)        \
69    COMMON_FOR_BASES();                         \
70    COMMON_FOR_DERIVABLE(self);                 \
71
72#define DECLARE_DUMP_FOR_BASECLASS(self,mybase) \
73    COMMON_FOR_BASES();                         \
74    COMMON_FOR_DERIVABLE(self);                 \
75    COMMON_FOR_DERIVED(mybase);                 \
76
77#define DECLARE_DUMP_FOR_MIDCLASS(self,mybase)  \
78    WARN(midclass_is_unwanted);                 \
79    COMMON_FOR_DERIVABLE(self);                 \
80    COMMON_FOR_DERIVED(mybase);                 \
81    COMMON_FOR_INSTANCIABLE(mybase);            \
82   
83#define DECLARE_DUMP_FOR_LEAFCLASS(mybase)              \
84    virtual void leaf() { DERIVABLEFROM(mybase)(); }    \
85    COMMON_FOR_DERIVED(mybase);                         \
86    COMMON_FOR_INSTANCIABLE(mybase);                    \
87
88#else
89#define DECLARE_DUMP_FOR_ROOTCLASS(self)
90#define DECLARE_DUMP_FOR_BASECLASS(self,mybase)
91#define DECLARE_DUMP_FOR_MIDCLASS(self,mybase)
92#define DECLARE_DUMP_FOR_LEAFCLASS(mybase)
93
94#endif // IMPLEMENT_DUMP ------------------------------
95
96
97
98// #define LIMIT_TOP_AREA_SPACE // if defined, top area is size-limited
99#ifdef LIMIT_TOP_AREA_SPACE
100#define MAX_TOP_AREA_SIZE 10    // size limit for top-area
101#endif
102
103#define ed4_beep() do { fputc(char(7), stdout); fflush(stdout); } while (0)
104
105enum PositionType {
106    ED4_POS_SEQUENCE, 
107    ED4_POS_ECOLI, 
108    ED4_POS_BASE, 
109};
110   
111// ****************************************
112// needed prototypes, definitions below
113// ****************************************
114
115class ED4_Edit_String;
116class ED4_area_manager;
117class ED4_abstract_group_manager;
118class ED4_base;
119class ED4_bases_table;
120class ED4_bracket_terminal;
121class ED4_char_table;
122class ED4_columnStat_terminal;
123class ED4_consensus_sequence_terminal;
124class ED4_cursor;
125class ED4_device_manager;
126class ED4_folding_line;
127class ED4_group_manager;
128class ED4_line_terminal;
129class ED4_main_manager;
130class ED4_manager;
131class ED4_members;
132class ED4_multi_name_manager;
133class ED4_multi_sequence_manager;
134class ED4_multi_species_manager;
135class ED4_name_manager;
136class ED4_pure_text_terminal;
137class ED4_remap;
138class ED4_root;
139class ED4_root_group_manager;
140class ED4_sequence_info_terminal;
141class ED4_sequence_manager;
142class ED4_sequence_terminal;
143class ED4_orf_terminal;
144class ED4_spacer_terminal;
145class ED4_species_manager;
146class ED4_species_name_terminal;
147class ED4_species_pointer;
148class ED4_terminal;
149class ED4_text_terminal;
150class ED4_tree_terminal;
151class ED4_window;
152
153class AP_tree;
154class AWT_reference;
155class AWT_seq_colors;
156class BI_ecoli_ref;
157class AW_helix;
158class arb_progress;
159class ST_ML;
160class ed_key;
161
162template <class T> class ED4_list;      // derived from Noncopyable
163template <class T> class ED4_list_elem; // derived from Noncopyable
164
165typedef ED4_list<ED4_base>      ED4_base_list;
166typedef ED4_list_elem<ED4_base> ED4_base_list_elem;
167
168typedef ED4_list<ED4_selection_entry>      ED4_selected_list;
169typedef ED4_list_elem<ED4_selection_entry> ED4_selected_elem;
170
171
172struct EDB_root_bact {
173    char *make_string();
174    char *make_top_bot_string();
175
176    void calc_no_of_all(const char *string_to_scan,       // group gets the number of groups in string_to_scan,
177                        long *group,                // species gets the number of species in string_to_scan
178                        long *species);
179
180    ED4_returncode fill_species(ED4_multi_species_manager  *multi_species_manager,
181                                ED4_sequence_info_terminal *ref_sequence_info_terminal,
182                                ED4_sequence_terminal      *ref_sequence_terminal,
183                                char                       *string,
184                                int                        *index,
185                                ED4_index                  *y,
186                                ED4_index                   curr_local_position,
187                                ED4_index                  *length_of_terminals,
188                                int                         group_depth,
189                                arb_progress               *progress);
190
191    ED4_returncode fill_data(ED4_multi_species_manager  *multi_species_manager,
192                             ED4_sequence_info_terminal *ref_sequence_info_terminal,
193                             ED4_sequence_terminal      *ref_sequence_terminal,
194                             char                       *string,
195                             ED4_index                  *y,
196                             ED4_index                   curr_local_position,
197                             ED4_index                  *length_of_terminals,
198                             int                         group_depth,
199                             ED4_datamode                datamode); // flag only needed for loading a new configuration
200
201    ED4_returncode search_sequence_data_rek(ED4_multi_sequence_manager *multi_sequence_manager,
202                                            ED4_sequence_info_terminal *ref_sequence_info_terminal,
203                                            ED4_sequence_terminal      *ref_sequence_terminal,
204                                            GBDATA                     *gb_datamode,
205                                            int                         count_too,
206                                            ED4_index                  *seq_coords,
207                                            ED4_index                  *max_seq_terminal_length,
208                                            ED4_alignment               alignment_flag,
209                                            bool                        isSAI);
210
211    ED4_index scan_string(ED4_multi_species_manager  *parent,
212                          ED4_sequence_info_terminal *ref_sequence_info_terminal,
213                          ED4_sequence_terminal      *ref_sequence_terminal,
214                          char                       *string,
215                          int                        *index,
216                          ED4_index                  *y,
217                          arb_progress&               progress);
218
219    ED4_returncode create_group_header(ED4_multi_species_manager   *parent,
220                                       ED4_sequence_info_terminal  *ref_sequence_info_terminal,
221                                       ED4_sequence_terminal       *ref_sequence_terminal,
222                                       ED4_multi_species_manager  **multi_species_manager,
223                                       ED4_bracket_terminal       **bracket_terminal,
224                                       ED4_index                   *y,
225                                       char                        *groupname,
226                                       int                          group_depth,
227                                       bool                         is_folded,
228                                       ED4_index                    local_count_position);
229
230    char *generate_config_string(char *confname);
231
232
233    EDB_root_bact() {}
234};
235
236#define SPECIFIED_OBJECT_TYPES 21
237
238class ED4_objspec : public Noncopyable {
239    static bool object_specs_initialized;
240    static bool descendants_uptodate;
241
242    mutable ED4_level used_children;         // in any object of this type
243    mutable ED4_level possible_descendants;  // below any object of this type (depends on used_children)
244    mutable ED4_level allowed_descendants;   // below any object of this type (depends on allowed_children)
245
246    void calc_descendants() const;
247
248public:
249    ED4_properties static_prop;
250    ED4_level      level;
251    ED4_level      allowed_children;
252    ED4_level      handled_level;
253    ED4_level      restriction_level;
254
255    ED4_objspec(ED4_properties static_prop_, ED4_level level_, ED4_level allowed_children_, ED4_level handled_level_, ED4_level restriction_level_);
256
257#if defined(IMPLEMENT_DUMP)
258    void dump(size_t indent) const;
259#endif // IMPLEMENT_DUMP
260
261    static void init_object_specs();
262
263    bool is_manager() const { return static_prop & ED4_P_IS_MANAGER; }
264    bool is_terminal() const { return static_prop & ED4_P_IS_TERMINAL; }
265
266    bool allowed_to_contain(ED4_level child_level) const {
267        // e4_assert(object_specs_initialized); // @@@ cant check here.. but where
268        e4_assert(is_manager()); // terminals can't contain anything - your test is senseless
269        return allowed_children & child_level;
270    }
271
272    void announce_added(ED4_level child_level) const {
273        e4_assert(allowed_to_contain(child_level));
274        used_children          = ED4_level(used_children|child_level);
275        descendants_uptodate = false;
276    }
277
278    static void recalc_descendants();
279
280    ED4_level get_possible_descendants() const { 
281        e4_assert(is_manager());
282        if (!descendants_uptodate) recalc_descendants();
283        return possible_descendants;
284    }
285    ED4_level get_allowed_descendants() const { // (allowed = possible + those allowed to add, but not added anywhere)
286        e4_assert(is_manager());
287        if (!descendants_uptodate) recalc_descendants();
288        return allowed_descendants;
289    }
290};
291
292class ED4_folding_line : virtual Noncopyable {
293    AW_pos            dimension; // amount of pixel folded away
294    AW_pos            pos;       // window position of folding line (x or y, only owner knows which coordinate is folded)
295    ED4_folding_line *next;
296
297    ED4_folding_line *insert(ED4_folding_line *fl) {
298        e4_assert(!fl->next);
299        if (pos <= fl->pos) { // insert behind
300            next = next ? next->insert(fl) : fl;
301            return this;
302        }
303
304        fl->next = this;
305        return fl;
306    }
307
308public:
309
310    ED4_folding_line(AW_pos world, AW_pos dim) : dimension(dim), next(0) { set_pos(world-dimension); }
311
312    ~ED4_folding_line() { delete next; }
313
314    void insertAs(ED4_folding_line*& ptr) {
315        ED4_folding_line *other = ptr;
316        e4_assert(this);
317        ptr = other ? other->insert(this) : this;
318    }
319
320    ED4_folding_line *delete_member(ED4_folding_line *fl) {
321        ED4_folding_line *result = this;
322        if (this == fl) {
323            result = next;
324            next   = NULL;
325            delete this;
326        }
327        return result;
328    }
329
330    AW_pos get_dimension() const { return dimension; }
331    const ED4_folding_line *get_next() const { return next; }
332
333    void warn_illegal_dimension();
334
335    void set_dimension(AW_pos dim) { dimension = dim; warn_illegal_dimension(); }
336    void add_to_dimension(AW_pos offset) { dimension += offset; warn_illegal_dimension(); }
337
338    void set_pos(AW_pos p) { pos = p; }
339    AW_pos get_pos() const { return pos; }
340
341    AW_pos win2world(AW_pos win) const {
342        if (win<pos) return win;
343        return (next ? next->win2world(win) : win)+dimension;
344    }
345    AW_pos world2win(AW_pos world) const {
346        if (world<pos) return world;
347        world -= dimension;
348        if (!next) return world;
349        return next->world2win(world);
350    }
351};
352
353struct ED4_scroll_links {
354    ED4_base *link_for_hor_slider;
355    ED4_base *link_for_ver_slider;
356
357    ED4_scroll_links() : link_for_hor_slider(0), link_for_ver_slider(0) {}
358};
359
360class ED4_foldable : virtual Noncopyable {
361    ED4_folding_line *horizontal_fl;
362    ED4_folding_line *vertical_fl;
363protected:
364    void reset() {
365        delete horizontal_fl;
366        delete vertical_fl;
367        horizontal_fl = NULL;
368        vertical_fl   = NULL;
369    }
370    bool is_reset() const { return !horizontal_fl && !vertical_fl; }
371public:
372
373    ED4_foldable() : horizontal_fl(NULL), vertical_fl(NULL) {}
374    ~ED4_foldable() { reset(); }
375
376    const ED4_folding_line *get_horizontal_folding() { return horizontal_fl; }
377    const ED4_folding_line *get_vertical_folding() { return vertical_fl; }
378
379    void world_to_win_coords(AW_pos *xPtr, AW_pos *yPtr) const { // @@@ old style
380        // Calculates transformation from world to window coordinates in a given window.
381        // world-coordinates inside folded range result in window coordinates lower than folding line position.
382        e4_assert(!is_reset());
383        *xPtr = vertical_fl->world2win(*xPtr);
384        *yPtr = horizontal_fl->world2win(*yPtr);
385    }
386    void win_to_world_coords(AW_pos *xPtr, AW_pos *yPtr) const { // @@@ old style
387        // calculates transformation from window to world coordinates in a given window
388        e4_assert(!is_reset());
389        *xPtr = vertical_fl->win2world(*xPtr);
390        *yPtr = horizontal_fl->win2world(*yPtr);
391    }
392
393    AW::Position world_to_win_coords(const AW::Position& pos) const {
394        e4_assert(!is_reset());
395        return AW::Position(vertical_fl->world2win(pos.xpos()),
396                            horizontal_fl->world2win(pos.ypos()));
397    }
398    AW::Position win_to_world_coords(const AW::Position& pos) const {
399        e4_assert(!is_reset());
400        return AW::Position(vertical_fl->win2world(pos.xpos()),
401                            horizontal_fl->win2world(pos.ypos()));
402    }
403
404    ED4_folding_line *insert_folding_line(AW_pos pos, AW_pos dimension, ED4_properties prop);
405    void              delete_folding_line(ED4_folding_line *fl, ED4_properties prop);
406};
407
408
409class ED4_scrolled_rectangle : virtual Noncopyable {
410    ED4_folding_line *scroll_bottom;
411    ED4_folding_line *scroll_right;
412    ED4_folding_line *scroll_top;
413    ED4_folding_line *scroll_left;
414
415    ED4_base *x_link;
416    ED4_base *y_link;
417    ED4_base *width_link;
418    ED4_base *height_link;
419
420    AW::Rectangle world;
421
422    bool folding_dimensions_calculated; // flag to ensure calc_bottomRight_folding_dimensions is called before get_window_rect
423   
424    void init_links() {
425        x_link      = 0;
426        y_link      = 0;
427        width_link  = 0;
428        height_link = 0;
429    }
430
431    void init_folding_lines() {
432        scroll_top    = 0;
433        scroll_bottom = 0;
434        scroll_left   = 0;
435        scroll_right  = 0;
436
437        folding_dimensions_calculated = false;
438    }
439    void init_pos_size() { world = AW::Rectangle(AW::Origin, AW::ZeroVector); }
440
441    void init() {
442        init_folding_lines();
443        init_pos_size();
444        init_links();
445    }
446
447    void update_folding_line_positions() {
448        scroll_top->set_pos(world.top());
449        scroll_left->set_pos(world.left());
450    }
451
452public:
453
454    ED4_scrolled_rectangle() { init(); }
455
456    AW_pos bottom() const { return world.bottom(); }
457    AW_pos right() const { return world.right(); }
458
459    void reset(ED4_foldable& owner) {
460        destroy_folding_lines(owner);
461        init_pos_size();
462    }
463
464    AW_pos top_dim() const { return scroll_top->get_dimension(); }
465    AW_pos left_dim() const { return scroll_left->get_dimension(); }
466
467    bool exists() const { return scroll_top && scroll_bottom && scroll_left && scroll_right; }
468    bool is_linked() const {
469        if (x_link) {
470            e4_assert(y_link);
471            e4_assert(width_link);
472            e4_assert(height_link);
473            return true;
474        }
475        e4_assert(!y_link);
476        e4_assert(!width_link);
477        e4_assert(!height_link);
478        return false;
479    }
480    void link(ED4_base *x, ED4_base *y, ED4_base *w, ED4_base *h) {
481        e4_assert(x && y && w && h);
482
483        x_link      = x;
484        y_link      = y;
485        width_link  = w;
486        height_link = h;
487    }
488
489    void replace_x_width_link_to(ED4_base *old_link, ED4_base *new_link) {
490        if (x_link == old_link)     x_link     = new_link;
491        if (width_link == old_link) width_link = new_link;
492    }
493
494    void add_to_top_left_dimension(int dx, int dy) {
495        scroll_left->add_to_dimension(dx);
496        scroll_top->add_to_dimension(dy);
497    }
498
499    void scroll(int dx, int dy) {
500        scroll_left->add_to_dimension(-dx);
501        scroll_top->add_to_dimension(-dy);
502        scroll_right->add_to_dimension(dx);
503        scroll_bottom->add_to_dimension(dy);
504    }
505
506    AW::Rectangle get_window_rect() const {
507        e4_assert(folding_dimensions_calculated);
508        return AW::Rectangle(scroll_left->get_pos(), scroll_top->get_pos(),
509                             scroll_right->get_pos(), scroll_bottom->get_pos());
510    }
511
512    AW::Rectangle get_world_rect() const;
513
514    void set_rect(const AW::Rectangle& rect) { world = rect; }
515    void set_rect_and_update_folding_line_positions(const AW::Rectangle& rect) {
516        set_rect(rect);
517        update_folding_line_positions();
518    }
519
520    void calc_bottomRight_folding_dimensions(int area_width, int area_height) {
521        area_width  -= SLIDER_OFFSET;
522        area_height -= SLIDER_OFFSET;
523
524        AW_pos dim;
525        if (bottom() > area_height) {   // our world doesn't fit vertically in our window
526            dim = bottom()-area_height; // calc dimension of both horizontal folding lines
527            scroll_top->set_dimension(std::min(dim, scroll_top->get_dimension()));
528            scroll_bottom->set_dimension(std::max(0, int(dim - scroll_top->get_dimension())));
529        }
530        else {
531            dim = 0;
532            scroll_bottom->set_dimension(0);
533            scroll_top->set_dimension(0);
534        }
535
536        e4_assert(dim == (scroll_top->get_dimension()+scroll_bottom->get_dimension()));
537        scroll_bottom->set_pos(world.bottom()-dim+SLIDER_OFFSET);
538
539        if (right()>area_width) {     // our world doesn't fit horizontally in our window
540            dim = right()-area_width; // calc dimension of both vertical folding lines
541            scroll_left->set_dimension(std::min(dim, scroll_left->get_dimension()));
542            scroll_right->set_dimension(std::max(0, int(dim - scroll_left->get_dimension())));
543        }
544        else {
545            dim = 0;
546            scroll_right->set_dimension(0);
547            scroll_left->set_dimension(0);
548        }
549
550        e4_assert(dim == (scroll_left->get_dimension()+scroll_right->get_dimension()));
551        scroll_right->set_pos(world.right()-dim+SLIDER_OFFSET);
552
553        folding_dimensions_calculated = true;
554    }
555
556    void create_folding_lines(ED4_foldable& owner, const AW::Rectangle& rect, int area_width, int area_height) {
557        scroll_top  = owner.insert_folding_line(rect.top(), 0, ED4_P_HORIZONTAL);
558        scroll_left = owner.insert_folding_line(rect.left(), 0, ED4_P_VERTICAL);
559
560        AW_pos dim = 0;
561        if (rect.bottom() > area_height) dim = rect.bottom() - area_height;
562        scroll_bottom = owner.insert_folding_line(rect.bottom(), dim, ED4_P_HORIZONTAL);
563
564        dim = 0;
565        if (rect.right() > area_width) dim = rect.right() - area_width;
566        scroll_right = owner.insert_folding_line(rect.right(), dim, ED4_P_VERTICAL);
567    }
568
569    void destroy_folding_lines(ED4_foldable& owner) {
570        if (scroll_top)    owner.delete_folding_line(scroll_top,    ED4_P_HORIZONTAL);
571        if (scroll_bottom) owner.delete_folding_line(scroll_bottom, ED4_P_HORIZONTAL);
572        if (scroll_left)   owner.delete_folding_line(scroll_left,   ED4_P_VERTICAL);
573        if (scroll_right)  owner.delete_folding_line(scroll_right,  ED4_P_VERTICAL);
574
575        init_folding_lines();
576    }
577};
578
579class ED4_base_position : private BasePosition { // derived from a Noncopyable
580    const ED4_terminal *calced4term;
581
582    void calc4term(const ED4_terminal *term);
583    void set_term(const ED4_terminal *term) { if (calced4term != term) calc4term(term); }
584
585public:
586
587    ED4_base_position();
588    ~ED4_base_position();
589
590    void invalidate();
591
592    void announce_deletion(const ED4_terminal *term) {
593        if (term == calced4term) invalidate();
594        e4_assert(calced4term != term);
595    }
596
597    int get_base_position(const ED4_terminal *base, int sequence_position);
598    int get_sequence_position(const ED4_terminal *base, int base_position);
599
600    int get_base_count(const ED4_terminal *term) { set_term(term); return base_count(); }
601    int get_abs_len(const ED4_terminal *term) { set_term(term); return abs_count(); }
602};
603
604class ED4_CursorShape;
605
606
607enum ED4_CursorType {
608    ED4_RIGHT_ORIENTED_CURSOR,
609    ED4_RIGHT_ORIENTED_CURSOR_THIN,
610    ED4_TRADITIONAL_CURSOR,
611    ED4_TRADITIONAL_CURSOR_BOTTOM,
612    ED4_TRADITIONAL_CURSOR_CONNECTED,
613    ED4_FUCKING_BIG_CURSOR,
614
615    ED4_CURSOR_TYPES
616
617};
618
619extern bool ED4_update_global_cursor_awars_allowed; // update selected species/SAI/cursor position
620
621struct ED4_TerminalPredicate {
622    virtual ~ED4_TerminalPredicate() {}
623    virtual bool fulfilled_by(const ED4_terminal *) const = 0;
624};
625
626class ED4_WinContextFree { // denies usage of the following functions in classes derived from this
627    AW_device   *current_device();
628    ED4_window  *current_ed4w();
629    AW_window   *current_aww();
630    ED4_cursor&  current_cursor();
631public:
632    void avoid_warning() {}
633};
634
635class ED4_cursor : virtual Noncopyable, virtual ED4_WinContextFree {
636    ED4_window                *win;
637    ED4_index                  cursor_abs_x;    // absolute (to terminal) x-position of cursor (absolute world coordinate of edit window)
638    int                        screen_position; // number of displayed characters leading the cursor
639    mutable ED4_base_position  base_position;   // # of bases left of cursor
640    ED4_CursorType             ctype;
641    ED4_CursorShape           *cursor_shape;
642
643    ED4_returncode  draw_cursor(AW_pos x, AW_pos y);
644    ED4_returncode  delete_cursor(AW_pos del_mark,  ED4_base *target_terminal);
645
646    void updateAwars(bool new_term_selected);
647
648public:
649
650    bool          allowed_to_draw; // needed for cursor handling
651    ED4_terminal *owner_of_cursor;
652
653    bool is_partly_visible() const;
654    bool is_completely_visible() const;
655
656    bool is_hidden_inside_group() const;
657
658    void changeType(ED4_CursorType typ);
659    ED4_CursorType  getType() const { return ctype; }
660
661    void redraw() { changeType(getType()); }
662
663    ED4_returncode HideCursor(); // deletes cursor and does refresh
664    ED4_returncode move_cursor(AW_event *event);
665    ED4_returncode show_clicked_cursor(AW_pos click_xpos, ED4_terminal *target_terminal);
666    ED4_returncode show_cursor_at(ED4_terminal *target_terminal, ED4_index what_pos);
667    ED4_returncode ShowCursor(ED4_index offset_x, ED4_cursor_move move, int move_pos = 1);
668
669    int get_sequence_pos() const;
670    int get_screen_pos() const { return screen_position; }
671
672    long get_abs_x() const   { return cursor_abs_x; }
673    void set_abs_x();
674
675    int base2sequence_position(int base_pos) const { return base_position.get_sequence_position(owner_of_cursor, base_pos); }
676    int sequence2base_position(int seq_pos) const { return base_position.get_base_position(owner_of_cursor, seq_pos); }
677
678    int get_base_position() const { return sequence2base_position(get_sequence_pos()); }
679
680    void invalidate_base_position() { base_position.invalidate(); }
681
682    void jump_screen_pos(int screen_pos, ED4_CursorJumpType jump_type);
683    void jump_sequence_pos(int sequence_pos, ED4_CursorJumpType jump_type);
684    void jump_base_pos(int base_pos, ED4_CursorJumpType jump_type);
685
686    int get_screen_relative_pos() const;
687    void set_screen_relative_pos(int scroll_to_relpos);
688
689    void set_to_terminal(ED4_terminal *terminal, int seq_pos, ED4_CursorJumpType jump_type);
690
691    inline bool in_species_seq_terminal() const;
692    inline bool in_consensus_terminal() const;
693    inline bool in_SAI_terminal() const;
694   
695    void announce_deletion(ED4_terminal *object) {
696        base_position.announce_deletion(object);
697        if (object == owner_of_cursor) owner_of_cursor = NULL; // no need to delete the cursor (deletion triggers full redraw)
698    }
699
700    void init();
701
702    ED4_window *window() const { return win; }
703
704    ED4_cursor(ED4_window *win);
705    ~ED4_cursor();
706};
707
708class ED4_window : public ED4_foldable, virtual ED4_WinContextFree { // derived from Noncopyable
709    void set_scrollbar_indents();
710
711public:
712    AW_window              *aww;   // Points to Window
713    ED4_window             *next;
714    int                     slider_pos_horizontal;
715    int                     slider_pos_vertical;
716    ED4_scrolled_rectangle  scrolled_rect;
717    int                     id;    // unique id in window-list
718    ED4_coords              coords;
719
720    static int no_of_windows;
721
722    char awar_path_for_cursor[50];                  // position in current sequence, range = [1;len]
723    char awar_path_for_Ecoli[50];                   // position relative to ecoli
724    char awar_path_for_basePos[50];                 // base position in current sequence (# of bases left to cursor)
725    char awar_path_for_IUPAC[50];                   // IUPAC decoder content for current position
726    char awar_path_for_helixNr[50];                 // # of helix (or 0) for current position
727
728    bool       is_hidden;
729    ED4_cursor cursor;
730
731    // ED4_window controlling functions
732    static ED4_window *insert_window(AW_window *new_aww); // append to window list
733
734    void        delete_window(ED4_window *window);  // delete from window list
735    void        reset_all_for_new_config(); // reset structures for loading new config
736    ED4_window *get_matching_ed4w(AW_window *aww);
737
738    void announce_deletion(ED4_terminal *object) { cursor.announce_deletion(object); }
739   
740    // functions concerned the scrolled area
741    void update_scrolled_rectangle();
742    ED4_returncode scroll_rectangle(int dx, int dy);
743    ED4_returncode set_scrolled_rectangle(ED4_base *x_link, ED4_base *y_link, ED4_base *width_link, ED4_base *height_link);
744
745    bool scrollbars_and_scrolledRect_inSync() const {
746        // Scrolling in EDIT4 window uses redundant data
747        // - dimension of folding lines
748        // - slider positions in AW_window and ED4_window
749        // This function checks whether they are in sync.
750       
751        bool inSync                    = 
752            (scrolled_rect.top_dim()  == aww->slider_pos_vertical) &&
753            (scrolled_rect.left_dim() == aww->slider_pos_horizontal);
754
755#if defined(DEBUG)
756        if (!inSync) {
757            fputs("scrollbars not in sync with scrolled_rect:\n", stderr);
758#if defined(ARB_GTK)
759            fprintf(stderr, "    aww->slider_pos_vertical  =%zu scrolled_rect->top_dim() =%f\n", aww->slider_pos_vertical, scrolled_rect.top_dim());
760            fprintf(stderr, "    aww->slider_pos_horizontal=%zu scrolled_rect->left_dim()=%f\n", aww->slider_pos_horizontal, scrolled_rect.left_dim());
761#else // !defined(ARB_GTK)
762            fprintf(stderr, "    aww->slider_pos_vertical  =%i scrolled_rect->top_dim() =%f\n", aww->slider_pos_vertical, scrolled_rect.top_dim());
763            fprintf(stderr, "    aww->slider_pos_horizontal=%i scrolled_rect->left_dim()=%f\n", aww->slider_pos_horizontal, scrolled_rect.left_dim());
764#endif
765        }
766#endif
767
768        return inSync;
769    }
770
771    void check_valid_scrollbar_values() { e4_assert(scrollbars_and_scrolledRect_inSync()); }
772
773    bool shows_xpos(int x) const { return x >= coords.window_left_clip_point && x <= coords.window_right_clip_point; }
774    bool partly_shows(int x1, int y1, int x2, int y2) const;
775    bool completely_shows(int x1, int y1, int x2, int y2) const;
776   
777    void update_window_coords();
778
779    AW_device *get_device() const { return aww->get_device(AW_MIDDLE_AREA); }
780
781    ED4_window(AW_window *window);
782    ~ED4_window();
783};
784
785class ED4_members : virtual Noncopyable {
786    // contains children related functions from members of a manager
787
788    ED4_manager  *my_owner;     // who is controlling this object
789    ED4_base    **memberList;
790    ED4_index     no_of_members; // How much members are in the list
791    ED4_index     size_of_list;
792
793public:
794
795    ED4_manager* owner() const { return my_owner; }
796    ED4_base* member(ED4_index i) const { e4_assert(i>=0 && i<size_of_list); return memberList[i]; }
797    ED4_index members() const { return no_of_members; }
798
799    ED4_returncode  insert_member(ED4_base *new_member); // only used to move members with mouse
800    ED4_returncode  append_member(ED4_base *new_member);
801
802    // an array is chosen instead of a linked list, because destructorhandling is more comfortable in various destructors (manager-destructors)
803
804    ED4_returncode  remove_member(ED4_base *member);
805    ED4_index       search_member(ED4_extension *location, ED4_properties prop); // search member
806    ED4_returncode  shift_list(ED4_index start_index, int length);
807    // list has to be shifted because member_list is an array and not a linked list
808
809    ED4_returncode  search_target_species   (ED4_extension *location, ED4_properties prop, ED4_base **found_member, ED4_level return_level);
810
811    ED4_returncode  move_member     (ED4_index old_pos, ED4_index new_pos);
812
813#if defined(IMPLEMENT_DUMP)
814    void dump(size_t indent) const;
815#endif // IMPLEMENT_DUMP
816
817#if defined(ASSERTION_USED)
818    int members_ok() const;
819#endif // ASSERTION_USED
820
821    ED4_members(ED4_manager *the_owner);
822    ~ED4_members();
823};
824
825#ifdef DEBUG
826// # define TEST_BASES_TABLE
827#endif
828
829#if defined(DEBUG) && !defined(DEVEL_RELEASE)
830# define TEST_CHAR_TABLE_INTEGRITY
831#endif
832
833#define SHORT_TABLE_ELEM_SIZE 1
834#define SHORT_TABLE_MAX_VALUE 0xff
835#define LONG_TABLE_ELEM_SIZE  4
836
837class ED4_bases_table : virtual Noncopyable {
838    int table_entry_size;       // how many bytes are used for each element of 'no_of_bases' (1 or 4 bytes)
839    union {
840        unsigned char *shortTable;
841        int           *longTable;
842    } no_of_bases;      // counts bases for each sequence position
843    int no_of_entries;      // length of bases table
844
845    int legal(int offset) const { return offset>=0 && offset<no_of_entries; }
846
847    void set_elem_long(int offset, int value) {
848#ifdef TEST_BASES_TABLE
849        e4_assert(legal(offset));
850        e4_assert(table_entry_size==LONG_TABLE_ELEM_SIZE);
851#endif
852        no_of_bases.longTable[offset] = value;
853    }
854
855    void set_elem_short(int offset, int value) {
856#ifdef TEST_BASES_TABLE
857        e4_assert(legal(offset));
858        e4_assert(table_entry_size==SHORT_TABLE_ELEM_SIZE);
859        e4_assert(value>=0 && value<=SHORT_TABLE_MAX_VALUE);
860#endif
861        no_of_bases.shortTable[offset] = value;
862    }
863
864    int get_elem_long(int offset) const {
865#ifdef TEST_BASES_TABLE
866        e4_assert(legal(offset));
867        e4_assert(table_entry_size==LONG_TABLE_ELEM_SIZE);
868#endif
869        return no_of_bases.longTable[offset];
870    }
871
872    int get_elem_short(int offset) const {
873#ifdef TEST_BASES_TABLE
874        e4_assert(legal(offset));
875        e4_assert(table_entry_size==SHORT_TABLE_ELEM_SIZE);
876#endif
877        return no_of_bases.shortTable[offset];
878    }
879
880public:
881
882    ED4_bases_table(int maxseqlength);
883    ~ED4_bases_table();
884
885    void init(int length);
886    int size() const { return no_of_entries; }
887
888    int get_table_entry_size() const { return table_entry_size; }
889    void expand_table_entry_size();
890    int bigger_table_entry_size_needed(int new_no_of_sequences) { return table_entry_size==SHORT_TABLE_ELEM_SIZE ? (new_no_of_sequences>SHORT_TABLE_MAX_VALUE) : 0; }
891
892    int operator[](int offset) const { return table_entry_size==SHORT_TABLE_ELEM_SIZE ? get_elem_short(offset) : get_elem_long(offset); }
893
894    void inc_short(int offset)  {
895        int old = get_elem_short(offset);
896        e4_assert(old<255);
897        set_elem_short(offset, old+1);
898    }
899    void dec_short(int offset)  {
900        int old = get_elem_short(offset);
901        e4_assert(old>0);
902        set_elem_short(offset, old-1);
903    }
904    void inc_long(int offset)   {
905        int old = get_elem_long(offset);
906        set_elem_long(offset, old+1);
907    }
908    void dec_long(int offset)   {
909        int old = get_elem_long(offset);
910        e4_assert(old>0);
911        set_elem_long(offset, old-1);
912    }
913
914    int firstDifference(const ED4_bases_table& other, int start, int end, int *firstDifferentPos) const;
915    int lastDifference(const ED4_bases_table& other, int start, int end, int *lastDifferentPos) const;
916
917    void add(const ED4_bases_table& other, int start, int end);
918    void sub(const ED4_bases_table& other, int start, int end);
919    void sub_and_add(const ED4_bases_table& Sub, const ED4_bases_table& Add, PosRange range);
920
921    void change_table_length(int new_length, int default_entry);
922
923
924#if defined(TEST_CHAR_TABLE_INTEGRITY) || defined(ASSERTION_USED)
925    int empty() const;
926#endif // TEST_CHAR_TABLE_INTEGRITY
927};
928
929typedef ED4_bases_table *ED4_bases_table_ptr;
930
931class ED4_char_table : virtual Noncopyable {
932    ED4_bases_table_ptr *bases_table;
933    int                  sequences; // # of sequences added to the table
934    int                  ignore; // this table will be ignored when calculating tables higher in hierarchy
935    // (used to suppress SAI in root_group_man tables)
936
937    // @@@ move statics into own class:
938    static bool               initialized;
939    static unsigned char      char_to_index_tab[MAXCHARTABLE];
940    static unsigned char     *upper_index_chars;
941    static unsigned char     *lower_index_chars;
942    static int                used_bases_tables; // size of 'bases_table'
943    static GB_alignment_type  ali_type;
944
945    static inline void set_char_to_index(unsigned char c, int index);
946
947    void add(const ED4_char_table& other, int start, int end);
948    void sub(const ED4_char_table& other, int start, int end);
949
950    void expand_tables();
951    int get_table_entry_size() const {
952        return linear_table(0).get_table_entry_size();
953    }
954    void prepare_to_add_elements(int new_sequences) {
955        e4_assert(used_bases_tables);
956        if (linear_table(0).bigger_table_entry_size_needed(sequences+new_sequences)) {
957            expand_tables();
958        }
959    }
960
961public:
962
963#if defined(TEST_CHAR_TABLE_INTEGRITY) || defined(ASSERTION_USED)
964    bool ok() const;
965    bool empty() const;
966#endif
967
968#if defined(TEST_CHAR_TABLE_INTEGRITY)
969    void test() const; // test if table is valid (dumps core if invalid)
970#else
971    void test() const {}
972#endif
973
974    ED4_char_table(int maxseqlength=0);
975    ~ED4_char_table();
976
977    static void initial_setup(const char *gap_chars, GB_alignment_type ali_type_);
978
979    void ignore_me() { ignore = 1; }
980    int is_ignored() const { return ignore; }
981
982    void init(int maxseqlength);
983    int size() const { return bases_table[0]->size(); }
984    int added_sequences() const { return sequences; }
985
986    void bases_and_gaps_at(int column, int *bases, int *gaps) const;
987
988    unsigned char index_to_upperChar(int index) const;
989    unsigned char index_to_lowerChar(int index) const;
990
991    // linear access to all tables
992    ED4_bases_table&        linear_table(int c)         { e4_assert(c<used_bases_tables); return *bases_table[c]; }
993    const ED4_bases_table&  linear_table(int c) const   { e4_assert(c<used_bases_tables); return *bases_table[c]; }
994
995    // access via character
996    ED4_bases_table&        table(int c)        { e4_assert(c>0 && c<MAXCHARTABLE); return linear_table(char_to_index_tab[c]); }
997    const ED4_bases_table&  table(int c) const  { e4_assert(c>0 && c<MAXCHARTABLE); return linear_table(char_to_index_tab[c]); }
998
999    const PosRange *changed_range(const ED4_char_table& other) const;
1000    static const PosRange *changed_range(const char *string1, const char *string2, int min_len);
1001
1002    void add(const ED4_char_table& other);
1003    void sub(const ED4_char_table& other);
1004    void sub_and_add(const ED4_char_table& Sub, const ED4_char_table& Add);
1005    void sub_and_add(const ED4_char_table& Sub, const ED4_char_table& Add, PosRange range);
1006
1007    void add(const char *string, int len);
1008    void sub(const char *string, int len);
1009    void sub_and_add(const char *old_string, const char *new_string, PosRange range);
1010
1011    void build_consensus_string_to(char *buffer, ExplicitRange range) const;
1012    char *build_consensus_string(PosRange range) const;
1013    char *build_consensus_string() const { return build_consensus_string(PosRange::whole()); }
1014
1015    void change_table_length(int new_length);
1016};
1017
1018// ----------------------------
1019//      ED4_species_pointer
1020
1021class ED4_species_pointer : virtual Noncopyable {
1022    // @@@ shall be renamed into ED4_gbdata_pointer to reflect general usage
1023
1024    GBDATA *species_pointer;    // points to database
1025
1026    void addCallback(ED4_base *base);
1027    void removeCallback(ED4_base *base);
1028
1029public:
1030
1031    ED4_species_pointer();
1032    ~ED4_species_pointer();
1033
1034    GBDATA *Get() const { return species_pointer; } 
1035    void Set(GBDATA *gbd, ED4_base *base);
1036    void notify_deleted() {
1037        species_pointer=0;
1038    }
1039};
1040
1041// -----------------
1042//      ED4_base
1043
1044class ED4_base;
1045typedef ARB_ERROR (*ED4_cb)(ED4_base *, AW_CL, AW_CL);
1046typedef ARB_ERROR (*ED4_cb1)(ED4_base *, AW_CL);
1047typedef ARB_ERROR (*ED4_cb0)(ED4_base *);
1048
1049enum ED4_species_type {
1050    ED4_SP_NONE, 
1051    ED4_SP_SPECIES, 
1052    ED4_SP_SAI, 
1053    ED4_SP_CONSENSUS,
1054};
1055
1056class ED4_base : virtual Noncopyable {
1057    // base object
1058
1059    ED4_species_pointer my_species_pointer;
1060
1061    // cache world coordinates:
1062
1063    static int           currTimestamp;
1064    mutable AW::Position lastPos;
1065    mutable int          timestamp;
1066
1067    ED4_base_list *linked_objects;                  // linked list of objects which are depending from this object
1068
1069public:
1070    const ED4_objspec& spec;           // contains information about Objectproperties
1071
1072    ED4_manager *parent;                            // Points to parent
1073
1074
1075    ED4_properties   dynamic_prop;                  // contains info about what i am, what i can do, what i should do
1076    char            *id;                            // globally unique name in hierarchy
1077    ED4_index        index;                         // defines the order of child objects
1078    ED4_base        *width_link;                    // concerning the hierarchy
1079    ED4_base        *height_link;                   // concerning the hierarchy
1080    ED4_extension    extension;                     // contains relative info about graphical properties
1081    ED4_update_info  update_info;                   // info about things to be done for the object, i.e. refresh; flag structure
1082    struct {
1083        unsigned int hidden : 1;                    // flag whether object is hidden or not
1084    } flag;
1085
1086    void draw_bb(int color);
1087
1088    DECLARE_DUMP_FOR_ROOTCLASS(ED4_base);
1089
1090    // function for species_pointer
1091
1092    GBDATA *get_species_pointer() const { return my_species_pointer.Get(); }
1093    void set_species_pointer(GBDATA *gbd) { my_species_pointer.Set(gbd, this); }
1094    int has_callback() const { return get_species_pointer()!=0; }
1095
1096    // callbacks
1097
1098    virtual void changed_by_database();
1099    virtual void deleted_from_database();
1100
1101    // functions concerned with graphic output
1102    int adjust_clipping_rectangle();
1103    virtual ED4_returncode  Show(int refresh_all=0, int is_cleared=0) = 0;
1104    virtual bool calc_bounding_box()                                  = 0;
1105
1106    ED4_returncode  clear_background(int color=0);
1107
1108    void set_links(ED4_base *width_link, ED4_base *height_link);
1109
1110    // functions concerned with special initialization
1111    void set_property(ED4_properties prop) { dynamic_prop = (ED4_properties) (dynamic_prop | prop); } 
1112    void clr_property(ED4_properties prop) { dynamic_prop = (ED4_properties) (dynamic_prop & ~prop); }
1113   
1114    // functions concerned with coordinate transformation
1115
1116    void calc_rel_coords(AW_pos *x, AW_pos *y);
1117
1118    void calc_world_coords(AW_pos *x, AW_pos *y) const {
1119        update_world_coords_cache();
1120        *x = lastPos.xpos();
1121        *y = lastPos.ypos();
1122    }
1123    const AW::Position& calc_world_coords() const {
1124        update_world_coords_cache();
1125        return lastPos;
1126    }
1127
1128    void update_world_coords_cache() const {
1129        bool cache_up_to_date = timestamp == currTimestamp;
1130        if (!cache_up_to_date) {
1131            if (parent) {
1132                ED4_base *pab = (ED4_base*)parent;
1133                lastPos = pab->calc_world_coords();
1134            }
1135            else {
1136                lastPos = AW::Origin;
1137            }
1138            lastPos.move(extension.get_parent_offset());
1139            timestamp = currTimestamp;
1140        }
1141    }
1142
1143    static void touch_world_cache() {
1144        currTimestamp++;
1145    }
1146
1147    AW::Rectangle get_win_area(ED4_window *ed4w) const {
1148        AW::Position pos = ed4w->world_to_win_coords(calc_world_coords());
1149        return AW::Rectangle(pos, extension.get_size()-AW::Vector(1, 1));
1150    }
1151
1152    // functions which refer to the object as a child, i.e. travelling down the hierarchy
1153    virtual void request_refresh(int clear=1) = 0;
1154
1155    inline void request_resize();
1156    void request_resize_of_linked();
1157    void resize_requested_by_link(ED4_base *link);
1158    virtual void resize_requested_children() = 0;
1159
1160    virtual void delete_requested_children() = 0;
1161    virtual void Delete()                    = 0;
1162
1163    inline void set_update();
1164    virtual void update_requested_children() = 0;
1165
1166    virtual ED4_returncode  move_requested_by_parent(ED4_move_info *mi)      = 0;
1167    virtual ED4_returncode  event_sent_by_parent(AW_event *event, AW_window *aww);
1168    virtual ED4_returncode  move_requested_by_child(ED4_move_info *moveinfo) = 0;
1169
1170
1171    virtual ED4_returncode  handle_move(ED4_move_info *moveinfo) = 0;
1172
1173    virtual ARB_ERROR route_down_hierarchy(ED4_cb cb, AW_CL cd1, AW_CL cd2);
1174    virtual ARB_ERROR route_down_hierarchy(ED4_cb1 cb, AW_CL cd) { return route_down_hierarchy(ED4_cb(cb), cd, 0); }
1175    virtual ARB_ERROR route_down_hierarchy(ED4_cb0 cb) { return route_down_hierarchy(ED4_cb(cb), 0, 0); }
1176
1177    int calc_group_depth();
1178
1179    // general purpose functions
1180    virtual ED4_base *search_ID(const char *id) = 0;
1181
1182    void  check_all();
1183    short in_border(AW_pos abs_x, AW_pos abs_y, ED4_movemode mode);
1184    ED4_returncode set_width();
1185
1186
1187    ED4_AREA_LEVEL get_area_level(ED4_multi_species_manager **multi_species_manager=0) const; // returns area we belong to and the next multi species manager of the area
1188
1189    ED4_base *get_parent(ED4_level lev) const;
1190    void unlink_from_parent();
1191    bool has_parent(ED4_manager *Parent);
1192    bool is_child_of(ED4_manager *Parent) { return has_parent(Parent); }
1193
1194    virtual char       *resolve_pointer_to_string_copy(int *str_len = 0) const;
1195    virtual const char *resolve_pointer_to_char_pntr(int *str_len = 0) const;
1196
1197    ED4_group_manager  *is_in_folded_group() const;
1198    virtual bool is_hidden() const = 0;
1199
1200    char *get_name_of_species();                      // go from terminal to name of species
1201
1202    // functions which refer to the selected object(s), i.e. across the hierarchy
1203    virtual ED4_base        *get_competent_child(AW_pos x, AW_pos y, ED4_properties relevant_prop)=0;
1204    virtual ED4_base        *get_competent_clicked_child(AW_pos x, AW_pos y, ED4_properties relevant_prop)=0;
1205    virtual ED4_base        *search_spec_child_rek(ED4_level level);    // recursive search for level
1206
1207    ED4_terminal        *get_next_terminal();
1208    ED4_terminal        *get_prev_terminal();
1209
1210    ED4_returncode      generate_configuration_string(char **generated_string);
1211
1212    virtual ED4_returncode  remove_callbacks();
1213   
1214    const ED4_terminal *get_consensus_relevant_terminal() const;
1215
1216    ED4_base(const ED4_objspec& spec_, GB_CSTR id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1217    virtual ~ED4_base();
1218
1219    // use the following functions to test which derived class we have
1220
1221    int is_terminal()               const { e4_assert(this); return spec.static_prop & ED4_P_IS_TERMINAL; }
1222
1223    int is_text_terminal()          const { e4_assert(this); return spec.level & (ED4_L_SPECIES_NAME|ED4_L_SEQUENCE_INFO|ED4_L_SEQUENCE_STRING|ED4_L_PURE_TEXT|ED4_L_COL_STAT); }
1224
1225    int is_species_name_terminal()  const { e4_assert(this); return spec.level & ED4_L_SPECIES_NAME; }
1226
1227    int is_sequence_info_terminal() const { e4_assert(this); return spec.level & ED4_L_SEQUENCE_INFO; }
1228    int is_sequence_terminal()      const { e4_assert(this); return spec.level & ED4_L_SEQUENCE_STRING; }
1229    int is_orf_terminal()           const { e4_assert(this); return spec.level & ED4_L_ORF; }
1230
1231    int is_pure_text_terminal()     const { e4_assert(this); return spec.level & ED4_L_PURE_TEXT; }
1232    int is_columnStat_terminal()    const { e4_assert(this); return spec.level & ED4_L_COL_STAT; }
1233
1234    int is_bracket_terminal()       const { e4_assert(this); return spec.level & ED4_L_BRACKET; }
1235    int is_spacer_terminal()        const { e4_assert(this); return spec.level & ED4_L_SPACER; }
1236    int is_line_terminal()          const { e4_assert(this); return spec.level & ED4_L_LINE; }
1237
1238    int is_manager()                const { e4_assert(this); return spec.static_prop & ED4_P_IS_MANAGER; }
1239
1240    int is_sequence_manager()       const { e4_assert(this); return spec.level & ED4_L_SEQUENCE; }
1241    int is_multi_name_manager()     const { e4_assert(this); return spec.level & ED4_L_MULTI_NAME; }
1242    int is_name_manager()           const { e4_assert(this); return spec.level & ED4_L_NAME_MANAGER; }
1243    int is_multi_species_manager()  const { e4_assert(this); return spec.level & ED4_L_MULTI_SPECIES; }
1244    int is_multi_sequence_manager() const { e4_assert(this); return spec.level & ED4_L_MULTI_SEQUENCE; }
1245    int is_device_manager()         const { e4_assert(this); return spec.level & ED4_L_DEVICE; }
1246
1247    int is_group_manager()          const { e4_assert(this); return spec.level & ED4_L_GROUP; }
1248    int is_root_group_manager()     const { e4_assert(this); return spec.level & ED4_L_ROOTGROUP; }
1249    int is_abstract_group_manager() const { e4_assert(this); return spec.level & (ED4_L_GROUP|ED4_L_ROOTGROUP); }
1250   
1251    int is_species_manager()        const { e4_assert(this); return spec.level & ED4_L_SPECIES; }
1252    int is_area_manager()           const { e4_assert(this); return spec.level & ED4_L_AREA; }
1253
1254    // use the following functions to cast ED4_base to derived classes:
1255
1256#define E4B_DECL_CASTOP_helper(Class,toName)            \
1257    inline const Class *toName() const;                 \
1258    inline Class *toName();
1259   
1260#define E4B_AVOID_CAST__helper(Class,toName,isName)     \
1261    const Class *toName() const;                        \
1262    Class *toName();                                    \
1263    int isName() const;
1264
1265#define E4B_IMPL_CASTOP_helper(Class,toName,isName)                             \
1266    const Class *ED4_base::toName() const {                                     \
1267        e4_assert(isName());                                                    \
1268        return DOWNCAST(const Class*, this);                                    \
1269    }                                                                           \
1270    Class *ED4_base::toName() {                                                 \
1271        return const_cast<Class*>(const_cast<const ED4_base*>(this)->toName()); \
1272    }
1273
1274#define E4B_DECL_CASTOP(name)          E4B_DECL_CASTOP_helper(concat(ED4_,name), concat(to_,name))
1275#define E4B_AVOID_UNNEEDED_CASTS(name) E4B_AVOID_CAST__helper(concat(ED4_,name), concat(to_,name), concat(is_,name))
1276#define E4B_IMPL_CASTOP(name)          E4B_IMPL_CASTOP_helper(concat(ED4_,name), concat(to_,name), concat(is_,name))
1277
1278    E4B_DECL_CASTOP(area_manager);           // to_area_manager
1279    E4B_DECL_CASTOP(abstract_group_manager); // to_abstract_group_manager
1280    E4B_DECL_CASTOP(bracket_terminal);       // to_bracket_terminal
1281    E4B_DECL_CASTOP(columnStat_terminal);    // to_columnStat_terminal
1282    E4B_DECL_CASTOP(device_manager);         // to_device_manager
1283    E4B_DECL_CASTOP(group_manager);          // to_group_manager
1284    E4B_DECL_CASTOP(line_terminal);          // to_line_terminal
1285    E4B_DECL_CASTOP(manager);                // to_manager
1286    E4B_DECL_CASTOP(multi_name_manager);     // to_multi_name_manager
1287    E4B_DECL_CASTOP(multi_sequence_manager); // to_multi_sequence_manager
1288    E4B_DECL_CASTOP(multi_species_manager);  // to_multi_species_manager
1289    E4B_DECL_CASTOP(name_manager);           // to_name_manager
1290    E4B_DECL_CASTOP(orf_terminal);           // to_orf_terminal
1291    E4B_DECL_CASTOP(pure_text_terminal);     // to_pure_text_terminal
1292    E4B_DECL_CASTOP(root_group_manager);     // to_root_group_manager
1293    E4B_DECL_CASTOP(sequence_info_terminal); // to_sequence_info_terminal
1294    E4B_DECL_CASTOP(sequence_manager);       // to_sequence_manager
1295    E4B_DECL_CASTOP(sequence_terminal);      // to_sequence_terminal
1296    E4B_DECL_CASTOP(spacer_terminal);        // to_spacer_terminal
1297    E4B_DECL_CASTOP(species_manager);        // to_species_manager
1298    E4B_DECL_CASTOP(species_name_terminal);  // to_species_name_terminal
1299    E4B_DECL_CASTOP(terminal);               // to_terminal
1300    E4B_DECL_CASTOP(text_terminal);          // to_text_terminal
1301
1302    // simple access to containing managers
1303    inline ED4_species_manager *containing_species_manager() const;
1304
1305    // discriminate between different sequence managers:
1306
1307    inline bool is_consensus_manager() const;
1308    inline bool is_SAI_manager() const;
1309    inline bool is_species_seq_manager() const;
1310
1311    inline ED4_species_type get_species_type() const; // works for all items (recursively) contained in ED4_species_manager
1312
1313    inline bool inside_consensus_manager() const;
1314    inline bool inside_SAI_manager() const;
1315    inline bool inside_species_seq_manager() const;
1316
1317    inline bool is_consensus_terminal() const;
1318    inline bool is_SAI_terminal() const;
1319    inline bool is_species_seq_terminal() const;
1320};
1321
1322struct ED4_manager : public ED4_base { // derived from a Noncopyable
1323    ED4_members *children;
1324
1325    E4B_AVOID_UNNEEDED_CASTS(manager);
1326    DECLARE_DUMP_FOR_BASECLASS(ED4_manager, ED4_base);
1327
1328    int refresh_flag_ok();
1329
1330    virtual void changed_by_database() OVERRIDE;
1331    virtual void deleted_from_database() OVERRIDE;
1332
1333    // functions concerned with graphics
1334    virtual ED4_returncode  Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
1335    virtual bool calc_bounding_box() OVERRIDE;
1336
1337    ED4_returncode distribute_children();
1338
1339    // top-down functions, means travelling down the hierarchy
1340    virtual ED4_returncode event_sent_by_parent(AW_event *event, AW_window *aww) OVERRIDE;
1341
1342    virtual void request_refresh(int clear=1) OVERRIDE;
1343    ED4_returncode clear_refresh();
1344
1345    virtual void resize_requested_children() OVERRIDE;
1346
1347    virtual void update_requested_children() OVERRIDE;
1348
1349    virtual void delete_requested_children() OVERRIDE;
1350    virtual void Delete() OVERRIDE;
1351
1352    virtual ED4_returncode  move_requested_by_parent(ED4_move_info *mi) OVERRIDE;
1353
1354    void create_consensus(ED4_abstract_group_manager *upper_group_manager, arb_progress *progress);
1355
1356    virtual ARB_ERROR route_down_hierarchy(ED4_cb cb, AW_CL cd1, AW_CL cd2) OVERRIDE;
1357    virtual ARB_ERROR route_down_hierarchy(ED4_cb1 cb, AW_CL cd) OVERRIDE { return route_down_hierarchy(ED4_cb(cb), cd, 0); }
1358    virtual ARB_ERROR route_down_hierarchy(ED4_cb0 cb) OVERRIDE { return route_down_hierarchy(ED4_cb(cb), 0, 0); }
1359
1360    ED4_base* find_first_that(ED4_level level, bool (*condition)(ED4_base *to_test, AW_CL arg), AW_CL arg);
1361    ED4_base* find_first_that(ED4_level level, bool (*condition)(ED4_base *to_test)) {
1362        return find_first_that(level, (bool(*)(ED4_base*, AW_CL))condition, (AW_CL)0);
1363    }
1364
1365     // bottom-up functions
1366    virtual ED4_returncode  move_requested_by_child(ED4_move_info *moveinfo) OVERRIDE;
1367    inline void resize_requested_by_child();
1368    ED4_returncode  refresh_requested_by_child();
1369    void delete_requested_by_child();
1370    void update_requested_by_child();
1371   
1372    ED4_base *get_defined_level(ED4_level lev) const;
1373
1374    // functions referring the consensus
1375
1376    ED4_returncode      create_group(ED4_group_manager **group_manager, GB_CSTR group_name);
1377
1378    void update_consensus(ED4_manager *old_parent, ED4_manager *new_parent, ED4_base *sequence);
1379    ED4_returncode rebuild_consensi(ED4_base *start_species, ED4_update_flag update_flag);
1380
1381    ED4_returncode  check_in_bases(ED4_base *added_base);
1382    ED4_returncode  check_out_bases(ED4_base *subbed_base);
1383
1384    ED4_returncode  update_bases(const ED4_base *old_base, const ED4_base *new_base, PosRange range = PosRange::whole());
1385    ED4_returncode  update_bases(const char *old_seq, int old_len, const char *new_seq, int new_len, PosRange range = PosRange::whole());
1386    ED4_returncode  update_bases(const char *old_seq, int old_len, const ED4_base *new_base, PosRange range = PosRange::whole());
1387    ED4_returncode  update_bases(const ED4_char_table *old_table, const ED4_char_table *new_table, PosRange range = PosRange::whole());
1388
1389    ED4_returncode  update_bases_and_rebuild_consensi(const char *old_seq, int old_len, ED4_base *species, ED4_update_flag update_flag, PosRange range = PosRange::whole());
1390
1391    // handle moves across the hierarchy
1392    virtual ED4_returncode  handle_move(ED4_move_info *moveinfo) OVERRIDE;
1393
1394    virtual ED4_base *get_competent_child(AW_pos x, AW_pos y, ED4_properties relevant_prop) OVERRIDE;
1395    virtual ED4_base *get_competent_clicked_child(AW_pos x, AW_pos y, ED4_properties relevant_prop) OVERRIDE;
1396    virtual ED4_base *search_spec_child_rek(ED4_level level) OVERRIDE;           // recursive search for level
1397
1398    // general purpose functions
1399    virtual ED4_base        *search_ID(const char *id) OVERRIDE;
1400    virtual ED4_returncode  remove_callbacks() OVERRIDE;
1401
1402    ED4_terminal *get_first_terminal(int start_index=0) const;
1403    ED4_terminal *get_last_terminal(int start_index=-1) const;
1404
1405    void hide_children();
1406    void unhide_children();
1407
1408    bool is_hidden() const OVERRIDE {
1409        if (flag.hidden) return true;
1410        if (!parent) return false;
1411        return parent->is_hidden();
1412    }
1413
1414    ED4_manager(const ED4_objspec& spec_, const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1415    virtual ~ED4_manager() OVERRIDE;
1416};
1417
1418struct ED4_terminal : public ED4_base { // derived from a Noncopyable
1419    E4B_AVOID_UNNEEDED_CASTS(terminal);
1420
1421    struct { unsigned int deleted : 1; } tflag; // @@@ go bool
1422
1423    long curr_timestamp;
1424
1425    DECLARE_DUMP_FOR_BASECLASS(ED4_terminal,ED4_base);
1426
1427    // callbacks
1428
1429    virtual void changed_by_database() OVERRIDE;
1430    virtual void deleted_from_database() OVERRIDE;
1431
1432    // functions concerning graphic output
1433    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE = 0;
1434    virtual ED4_returncode draw() = 0;
1435
1436    virtual bool calc_bounding_box() OVERRIDE;
1437
1438    ED4_returncode draw_drag_box(AW_pos x, AW_pos y, GB_CSTR text = NULL, int cursor_y=-1);
1439
1440    // functions which concern the object as a child
1441    virtual void request_refresh(int clear=1) OVERRIDE;
1442
1443    virtual void resize_requested_children() OVERRIDE;
1444
1445    virtual void update_requested_children() OVERRIDE;
1446    virtual void delete_requested_children() OVERRIDE;
1447    virtual void Delete() OVERRIDE;
1448
1449    virtual ED4_returncode  move_requested_by_parent(ED4_move_info *mi) OVERRIDE;
1450    virtual ED4_returncode  event_sent_by_parent(AW_event *event, AW_window *aww) OVERRIDE;
1451    virtual ED4_base *get_competent_child(AW_pos x, AW_pos y, ED4_properties relevant_prop) OVERRIDE;
1452    virtual ED4_base *get_competent_clicked_child(AW_pos x, AW_pos y, ED4_properties relevant_prop) OVERRIDE;
1453    virtual ED4_returncode  move_requested_by_child(ED4_move_info *moveinfo) OVERRIDE;
1454    virtual ED4_returncode  handle_move(ED4_move_info *moveinfo) OVERRIDE;
1455
1456    ED4_returncode kill_object();
1457
1458    // general purpose functions
1459    virtual ED4_base *search_ID(const char *id) OVERRIDE;
1460    virtual char          *resolve_pointer_to_string_copy(int *str_len = 0) const OVERRIDE;
1461    virtual const char    *resolve_pointer_to_char_pntr(int *str_len = 0) const OVERRIDE;
1462    virtual ED4_returncode remove_callbacks() OVERRIDE;
1463
1464    GB_ERROR write_sequence(const char *seq, int seq_len);
1465
1466    void scroll_into_view(ED4_window *ed4w);
1467    inline bool setCursorTo(ED4_cursor *cursor, int seq_pos, bool unfoldGroups, ED4_CursorJumpType jump_type);
1468
1469    bool is_hidden() const OVERRIDE { return parent && parent->is_hidden(); }
1470
1471    ED4_terminal(const ED4_objspec& spec_, GB_CSTR id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1472    virtual ~ED4_terminal() OVERRIDE;
1473};
1474
1475enum ED4_species_mode {
1476    ED4_SM_MOVE,
1477    ED4_SM_KILL,
1478    ED4_SM_MARK
1479};
1480
1481class ED4_reference_terminals : virtual Noncopyable {
1482    ED4_sequence_info_terminal *ref_sequence_info;
1483    ED4_sequence_terminal      *ref_sequence;
1484    ED4_sequence_info_terminal *ref_column_stat_info;
1485    ED4_columnStat_terminal    *ref_column_stat;
1486
1487    void null() { ref_sequence_info = 0; ref_sequence = 0; ref_column_stat = 0; ref_column_stat_info = 0; }
1488public:
1489    void clear();
1490    void init(ED4_sequence_info_terminal *, ED4_sequence_terminal *, ED4_sequence_info_terminal *, ED4_columnStat_terminal *);
1491
1492    ED4_sequence_info_terminal *get_ref_sequence_info()    { return ref_sequence_info; }
1493    ED4_sequence_terminal      *get_ref_sequence()         { return ref_sequence; }
1494    ED4_sequence_info_terminal *get_ref_column_stat_info() { return ref_column_stat_info; }
1495    ED4_columnStat_terminal    *get_ref_column_stat()      { return ref_column_stat; }
1496
1497    ED4_reference_terminals()  { null(); }
1498    ~ED4_reference_terminals() { clear(); }
1499};
1500
1501class ED4_WinContext {
1502    ED4_window *ed4w;
1503    AW_device  *device;
1504
1505    bool is_set() const { return ed4w; }
1506    void init(ED4_window *ew) {
1507        e4_assert(ew);
1508        ed4w   = ew;
1509        device = ed4w->get_device();
1510    }
1511
1512    void warn_missing_context() const;
1513    void expect_context() const { if (!is_set()) warn_missing_context(); }
1514
1515protected:
1516    ED4_WinContext() : ed4w(0), device(0) {}
1517    static ED4_WinContext current_context;
1518   
1519public:
1520    inline ED4_WinContext(AW_window *aww_);
1521    ED4_WinContext(ED4_window *ed4w_) { init(ed4w_); }
1522
1523    AW_device *get_device() const { expect_context(); return device; }
1524    ED4_window *get_ed4w() const { expect_context(); return ed4w; }
1525
1526    static const ED4_WinContext& get_current_context() { return current_context; }
1527    static bool have_context() { return current_context.is_set(); }
1528};
1529
1530// accessors for current context (see also ED4_WinContextFree)
1531inline AW_device *current_device() { return ED4_WinContext::get_current_context().get_device(); }
1532inline ED4_window *current_ed4w() { return ED4_WinContext::get_current_context().get_ed4w(); }
1533inline AW_window *current_aww() { return current_ed4w()->aww; }
1534inline ED4_cursor& current_cursor() { return current_ed4w()->cursor; }
1535
1536
1537class ED4_root : virtual Noncopyable {
1538    void ED4_ROOT() const { e4_assert(0); } // avoid ED4_root-members use global ED4_ROOT
1539
1540    void refresh_window_simple(bool redraw);
1541    void handle_update_requests(bool& redraw);
1542
1543    ED4_window *most_recently_used_window;
1544
1545public:
1546    char       *db_name;                            // name of Default Properties database (complete path)
1547    AW_root    *aw_root;                            // Points to 'AW-Window-Controller'
1548    AW_default  props_db;                           // Default Properties database
1549
1550    ED4_window              *first_window;          // Points to List of Main Windows of ED4
1551    ED4_main_manager        *main_manager;          // Points to Main manager of ED4
1552    ED4_area_manager        *middle_area_man;       // Points to middle area
1553    ED4_area_manager        *top_area_man;
1554    ED4_root_group_manager  *root_group_man;
1555    EDB_root_bact           *database;              // Points to Object which controls Data
1556    ED4_selected_list       *selected_objects;
1557    ED4_scroll_links         scroll_links;
1558    bool                     folding_action;        // flag tells whether action was folding action or not
1559    ED4_reference_terminals  ref_terminals;
1560    ED4_species_mode         species_mode;
1561    ED4_scroll_picture       scroll_picture;
1562    BI_ecoli_ref            *ecoli_ref;
1563    char                    *alignment_name;
1564    GB_alignment_type        alignment_type;
1565    AWT_reference           *reference;
1566    AWT_seq_colors          *sequence_colors;
1567    AW_gc_manager            gc_manager;
1568    ST_ML                   *st_ml;
1569    AW_helix                *helix;
1570    int                      helix_spacing;
1571    long                     helix_add_spacing;
1572    long                     terminal_add_spacing;
1573    char                    *protstruct;            // protein structure summary
1574    long                     protstruct_len;        // protein structure summary
1575    ed_key                  *edk;
1576    ED4_Edit_String         *edit_string;
1577
1578    bool column_stat_activated;
1579    bool column_stat_initialized;
1580    bool visualizeSAI;
1581    bool visualizeSAI_allSpecies;
1582
1583    int temp_gc;
1584    AW_font_group font_group;
1585
1586    void announce_useraction_in(AW_window *aww);
1587    ED4_window *get_most_recently_used_window() const { return most_recently_used_window; }
1588
1589    inline ED4_device_manager *get_device_manager();
1590
1591    // Initializing functions
1592    ED4_returncode  create_hierarchy(char *area_string_middle, char *area_string_top);
1593    ED4_returncode  init_alignment();
1594    void recalc_font_group();
1595
1596    AW_window *create_new_window();
1597    ED4_returncode generate_window(AW_device **device, ED4_window **new_window);
1598    void copy_window_struct(ED4_window *source,   ED4_window *destination);
1599
1600    // functions concerned with global refresh and resize
1601    void resize_all();
1602
1603    void special_window_refresh(bool handle_updates);
1604    ED4_returncode refresh_all_windows(bool redraw);
1605
1606    void request_refresh_for_all_terminals();
1607    void request_refresh_for_specific_terminals(ED4_level lev);
1608    void request_refresh_for_consensus_terminals();
1609    void request_refresh_for_sequence_terminals();
1610
1611    inline void announce_deletion(ED4_base *object); // before deleting an object, use this to announce
1612
1613     // functions concerned with list of selected objects
1614    ED4_returncode add_to_selected(ED4_species_name_terminal *object);
1615    void remove_from_selected(ED4_species_name_terminal *object);
1616    ED4_returncode deselect_all();
1617
1618    ED4_returncode get_area_rectangle(AW_screen_area *rect, AW_pos x, AW_pos y);
1619
1620    ED4_index pixel2pos(AW_pos click_x);
1621
1622    void remove_all_callbacks();
1623   
1624    ED4_root(int *argc, char*** argv);
1625    ~ED4_root();
1626};
1627
1628ED4_WinContext::ED4_WinContext(AW_window *aww_) { init(ED4_ROOT->first_window->get_matching_ed4w(aww_)); }
1629
1630struct ED4_LocalWinContext : private ED4_WinContext {
1631    ED4_LocalWinContext(AW_window *aww) : ED4_WinContext(current_context) { current_context = ED4_WinContext(aww); }
1632    ED4_LocalWinContext(ED4_window *ew) : ED4_WinContext(current_context) { current_context = ED4_WinContext(ew); }
1633    ~ED4_LocalWinContext() { current_context = *this; }
1634};
1635
1636class ED4_MostRecentWinContext : virtual Noncopyable { 
1637    ED4_LocalWinContext *most_recent;
1638public:
1639    ED4_MostRecentWinContext() : most_recent(0) {
1640        if (!ED4_WinContext::have_context()) {
1641            most_recent = new ED4_LocalWinContext(ED4_ROOT->get_most_recently_used_window());
1642        }
1643    }
1644    ~ED4_MostRecentWinContext() {
1645        delete most_recent;
1646    }
1647};
1648
1649inline void ED4_root::announce_deletion(ED4_base *object) {
1650    if (object->is_terminal()) {
1651        ED4_terminal *term = object->to_terminal();
1652        for (ED4_window *win = first_window; win; win = win->next) {
1653            ED4_LocalWinContext uses(win);
1654            win->announce_deletion(term);
1655        }
1656    }
1657}
1658
1659// ------------------------
1660//      manager classes
1661//
1662// All manager classes only differ in their static properties.
1663// This kind of construction was chosen for using a minimum of RAM
1664
1665class ED4_main_manager : public ED4_manager { // derived from a Noncopyable
1666    // first in hierarchy
1667
1668    E4B_AVOID_UNNEEDED_CASTS(main_manager);
1669
1670    // these terminals are redrawn after refresh (with increase clipping area)
1671    // to revert text from middle area drawn into top area:
1672    ED4_terminal *top_middle_line;
1673    ED4_terminal *top_middle_spacer;
1674
1675public:
1676    ED4_main_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1677
1678    void set_top_middle_spacer_terminal(ED4_terminal *top_middle_spacer_) { top_middle_spacer = top_middle_spacer_; }
1679    void set_top_middle_line_terminal(ED4_terminal *top_middle_line_) { top_middle_line = top_middle_line_; }
1680
1681    ED4_terminal *get_top_middle_spacer_terminal() const { return top_middle_spacer; }
1682    ED4_terminal *get_top_middle_line_terminal() const { return top_middle_line; }
1683
1684    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1685
1686    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
1687    virtual void resize_requested_children() OVERRIDE;
1688   
1689    void clear_whole_background();
1690};
1691
1692struct ED4_device_manager : public ED4_manager {
1693    E4B_AVOID_UNNEEDED_CASTS(device_manager);
1694    ED4_device_manager  (const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1695    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1696};
1697
1698struct ED4_area_manager : public ED4_manager {
1699    E4B_AVOID_UNNEEDED_CASTS(area_manager);
1700    ED4_area_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1701    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1702
1703    ED4_multi_species_manager *get_multi_species_manager() const {
1704        return get_defined_level(ED4_L_MULTI_SPECIES)->to_multi_species_manager();
1705    }
1706};
1707
1708class ED4_multi_species_manager : public ED4_manager {
1709    E4B_AVOID_UNNEEDED_CASTS(multi_species_manager);
1710
1711    int species;          // # of species (-1 == unknown)
1712    int selected_species; // # of selected species (-1 == unknown)
1713
1714    void    set_species_counters(int no_of_species, int no_of_selected);
1715#ifdef DEBUG
1716    void    count_species(int *speciesPtr, int *selectedPtr) const;
1717#endif
1718    void    update_species_counters();
1719
1720public:
1721    ED4_multi_species_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1722
1723    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1724
1725    virtual void update_requested_children() OVERRIDE;
1726    virtual void delete_requested_children() OVERRIDE;
1727
1728    int count_visible_children();           // is called by a multi_species_manager
1729
1730    ED4_species_manager       *get_consensus_manager() const;       // returns the consensus-manager or NULL
1731    ED4_species_name_terminal *get_consensus_name_terminal() const; // returns the consensus-name-terminal or NULL
1732
1733    // functions concerned with selection
1734    int get_no_of_selected_species();
1735    int get_no_of_species();
1736
1737    void update_group_id();
1738
1739    void invalidate_species_counters();
1740    int  has_valid_counters() const { return species != -1 && selected_species!=-1; }
1741    bool all_are_selected() const { e4_assert(has_valid_counters()); return species == selected_species; }
1742
1743    void select_all(bool only_species);
1744    void deselect_all_species_and_SAI();
1745    void invert_selection_of_all_species();
1746    void marked_species_select(bool select);
1747    void selected_species_mark(bool mark);
1748
1749    void toggle_selected_species();
1750};
1751
1752class ED4_abstract_group_manager : public ED4_manager {
1753    E4B_AVOID_UNNEEDED_CASTS(abstract_group_manager);
1754protected:
1755    ED4_char_table my_table; // table concerning Consensusfunction
1756
1757public:
1758    ED4_abstract_group_manager(const ED4_objspec& spec_, const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1759
1760    DECLARE_DUMP_FOR_BASECLASS(ED4_abstract_group_manager, ED4_manager);
1761
1762    ED4_char_table&         table() { return my_table; }
1763    const ED4_char_table&   table() const { return my_table; }
1764
1765    ED4_bases_table& table(unsigned char c) { return table().table(c); }
1766    const ED4_bases_table& table(unsigned char c) const { return table().table(c); }
1767
1768    ED4_multi_species_manager *get_multi_species_manager() const {
1769        return get_defined_level(ED4_L_MULTI_SPECIES)->to_multi_species_manager();
1770    }
1771};
1772
1773struct ED4_group_manager : public ED4_abstract_group_manager {
1774    E4B_AVOID_UNNEEDED_CASTS(group_manager);
1775    ED4_group_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1776    DECLARE_DUMP_FOR_LEAFCLASS(ED4_abstract_group_manager);
1777    void reinit_char_table();
1778};
1779
1780enum ED4_remap_mode {
1781    ED4_RM_NONE,                                    // no remapping (normal mode)
1782    ED4_RM_SHOW_ABOVE,                              // Show all positions, where xxx% of all edited sequences have any base
1783    ED4_RM_MAX_ALIGN,                               // ------------------------- any edited sequence has a base
1784    ED4_RM_MAX_EDIT,                                // like ED4_RM_MAX_ALIGN, but bases are pushed OVER remapped gaps (not INTO)
1785    ED4_RM_DYNAMIC_GAPS,                            // gaps shown as spaces (more gaps => more spaces)
1786
1787    ED4_RM_MODES
1788
1789};
1790
1791class ED4_remap : virtual Noncopyable {
1792
1793    ED4_remap_mode mode;
1794    int show_above_percent;     // used only for ED4_RM_SHOW_ABOVE
1795
1796    size_t sequence_table_len;      // allocated size of sequence_to_screen_tab
1797    size_t screen_table_len;        // allocated size of screen_to_sequence_tab
1798
1799    size_t sequence_len;        // size of recently compiled part of sequence_to_screen_tab
1800    size_t screen_len;          // size of recently compiled part of screen_to_sequence_tab
1801
1802    int *screen_to_sequence_tab;
1803    int *sequence_to_screen_tab;    // <0 means position is not mapped (last displayed sequence position)
1804
1805    int changed;            // remap-table changed at last compile
1806    int update_needed;          // remapping should be recompiled
1807
1808    inline void set_sequence_to_screen(int pos, int newVal);
1809
1810public:
1811
1812    ED4_remap();
1813    ~ED4_remap();
1814
1815    int screen_to_sequence(int screen_pos) const;
1816
1817    int sequence_to_screen_PLAIN(int sequence_pos) const { 
1818        e4_assert(sequence_pos>=0 && size_t(sequence_pos)<=sequence_len);
1819        return sequence_to_screen_tab[sequence_pos];
1820    }
1821    int shown_sequence_to_screen(int sequence_pos) const {
1822        // as well works for sequence_pos == MAXSEQUENCECHARACTERLENGTH
1823        int screen_pos = sequence_to_screen_PLAIN(sequence_pos);
1824        e4_assert(screen_pos >= 0); // sequence_pos expected to be visible (i.e. not folded away)
1825        return screen_pos;
1826    }
1827
1828    int clipped_sequence_to_screen_PLAIN(int sequence_pos) const; 
1829    int sequence_to_screen(int sequence_pos) const;
1830
1831    PosRange sequence_to_screen(PosRange range) const {
1832        e4_assert(!range.is_empty());
1833        return PosRange(sequence_to_screen(range.start()), sequence_to_screen(range.end()));
1834    }
1835    PosRange screen_to_sequence(PosRange range) const {
1836        e4_assert(!range.is_empty());
1837        if (range.is_unlimited()) return PosRange::from(screen_to_sequence(range.start()));
1838        return PosRange(screen_to_sequence(range.start()), screen_to_sequence(range.end()));
1839    }
1840
1841    size_t get_max_screen_pos() const { return screen_len-1; }
1842
1843    ED4_remap_mode get_mode() const { return mode; }
1844    void set_mode(ED4_remap_mode Mode, int above_percent) {
1845        if (Mode<0 || Mode>=ED4_RM_MODES) {
1846            Mode = ED4_RM_NONE;
1847        }
1848        if (mode!=Mode) {
1849            mode = Mode;
1850            update_needed = 1;
1851        }
1852
1853        if (show_above_percent!=above_percent) {
1854            show_above_percent = above_percent;
1855            if (mode==ED4_RM_SHOW_ABOVE) {
1856                update_needed = 1;
1857            }
1858        }
1859    }
1860
1861    void mark_compile_needed();     // recompile if mode != none
1862    void mark_compile_needed_force();   // always recompile
1863    int compile_needed() const { return update_needed; }
1864
1865    GB_ERROR compile(ED4_root_group_manager *gm);
1866    int was_changed() const { return changed; }     // mapping changed by last compile ?
1867
1868    int is_shown(int position) const { return sequence_to_screen_PLAIN(position)>=0; }
1869
1870    ExplicitRange clip_screen_range(PosRange screen_range) const { return ExplicitRange(screen_range, screen_len-1); }
1871};
1872
1873class ED4_root_group_manager : public ED4_abstract_group_manager {
1874    E4B_AVOID_UNNEEDED_CASTS(root_group_manager);
1875    ED4_remap my_remap;
1876public:
1877    ED4_root_group_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1878
1879    bool update_remap(); // 'true' if mapping has changed
1880
1881    const ED4_remap *remap() const { return &my_remap; }
1882    ED4_remap *remap() { return &my_remap; }
1883
1884    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
1885    virtual void resize_requested_children() OVERRIDE;
1886
1887    DECLARE_DUMP_FOR_LEAFCLASS(ED4_abstract_group_manager);
1888};
1889
1890typedef void (*ED4_species_manager_cb)(ED4_species_manager*, AW_CL);
1891
1892class ED4_species_manager_cb_data {
1893    ED4_species_manager_cb cb;
1894    AW_CL                  cd; // client data
1895
1896public:
1897    ED4_species_manager_cb_data(ED4_species_manager_cb cb_, AW_CL cd_) : cb(cb_), cd(cd_) {}
1898
1899    void call(ED4_species_manager *man) const { cb(man, cd); }
1900    bool operator<(const ED4_species_manager_cb_data& other) const {
1901        return (char*)cb < (char*)other.cb &&
1902            (char*)cd < (char*)other.cd;
1903    }
1904};
1905
1906class ED4_species_manager : public ED4_manager {
1907    E4B_AVOID_UNNEEDED_CASTS(species_manager);
1908   
1909    std::set<ED4_species_manager_cb_data> callbacks;
1910
1911    ED4_species_type type;
1912    bool selected;
1913
1914public:
1915    ED4_species_manager(ED4_species_type type_, const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1916    ~ED4_species_manager() OVERRIDE;
1917
1918    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1919
1920    ED4_species_type get_type() const { return type; }
1921
1922    bool is_selected() const { return selected; }
1923    void set_selected(bool select) {
1924        // e4_assert(type != ED4_SP_CONSENSUS); // it's not allowed to select a consensus // @@@ happens atm when moving a group
1925        selected = select;
1926    }
1927
1928    bool setCursorTo(ED4_cursor *cursor, int seq_pos, bool unfold_groups, ED4_CursorJumpType jump_type);
1929
1930    void add_sequence_changed_cb(ED4_species_manager_cb cb, AW_CL cd);
1931    void remove_sequence_changed_cb(ED4_species_manager_cb cb, AW_CL cd);
1932    void remove_all_callbacks();
1933
1934    void do_callbacks();
1935
1936    ED4_species_name_terminal *get_name_terminal() const { return children->member(0)->to_species_name_terminal(); }
1937};
1938
1939inline ED4_species_manager *ED4_base::containing_species_manager() const {
1940    ED4_base *sman = get_parent(ED4_L_SPECIES);
1941    return sman ? sman->to_species_manager() : NULL;
1942}
1943
1944inline bool ED4_base::is_consensus_manager()    const { return is_species_manager() && to_species_manager()->get_type() == ED4_SP_CONSENSUS; }
1945inline bool ED4_base::is_SAI_manager()          const { return is_species_manager() && to_species_manager()->get_type() == ED4_SP_SAI; }
1946inline bool ED4_base::is_species_seq_manager()  const { return is_species_manager() && to_species_manager()->get_type() == ED4_SP_SPECIES; }
1947
1948inline ED4_species_type ED4_base::get_species_type() const {
1949    ED4_species_manager *sman = containing_species_manager();
1950    return sman ? sman->get_type() : ED4_SP_NONE;
1951}
1952
1953inline bool ED4_base::inside_consensus_manager()   const { return get_species_type() == ED4_SP_CONSENSUS; }
1954inline bool ED4_base::inside_SAI_manager()         const { return get_species_type() == ED4_SP_SAI; }
1955inline bool ED4_base::inside_species_seq_manager() const { return get_species_type() == ED4_SP_SPECIES; }
1956
1957inline bool ED4_base::is_consensus_terminal()   const { return is_sequence_terminal() && inside_consensus_manager(); }
1958inline bool ED4_base::is_SAI_terminal()         const { return is_sequence_terminal() && inside_SAI_manager(); }
1959inline bool ED4_base::is_species_seq_terminal() const { return is_sequence_terminal() && inside_species_seq_manager(); }
1960
1961inline bool ED4_cursor::in_species_seq_terminal() const { return owner_of_cursor && owner_of_cursor->is_species_seq_terminal(); }
1962inline bool ED4_cursor::in_consensus_terminal()   const { return owner_of_cursor && owner_of_cursor->is_consensus_terminal(); }
1963inline bool ED4_cursor::in_SAI_terminal()         const { return owner_of_cursor && owner_of_cursor->is_SAI_terminal(); }
1964
1965
1966struct ED4_multi_sequence_manager : public ED4_manager {
1967    E4B_AVOID_UNNEEDED_CASTS(multi_sequence_manager);
1968    ED4_multi_sequence_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1969    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1970};
1971
1972struct ED4_sequence_manager : public ED4_manager {
1973    E4B_AVOID_UNNEEDED_CASTS(sequence_manager);
1974    ED4_sequence_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1975    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1976};
1977
1978struct ED4_multi_name_manager : public ED4_manager {
1979    E4B_AVOID_UNNEEDED_CASTS(multi_name_manager);
1980    // member of ED4_species_manager (contains ED4_name_manager for name and info)
1981    ED4_multi_name_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1982    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1983};
1984
1985
1986struct ED4_name_manager : public ED4_manager {
1987    E4B_AVOID_UNNEEDED_CASTS(name_manager);
1988    // member of ED4_multi_name_manager (contains speciesname or other info concerning the species)
1989    ED4_name_manager(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
1990    DECLARE_DUMP_FOR_LEAFCLASS(ED4_manager);
1991};
1992
1993
1994// -------------------------
1995//      terminal classes
1996
1997
1998struct ED4_tree_terminal : public ED4_terminal {
1999    E4B_AVOID_UNNEEDED_CASTS(tree_terminal);
2000   
2001    virtual ED4_returncode draw() OVERRIDE;
2002    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
2003
2004    ED4_tree_terminal(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2005
2006    DECLARE_DUMP_FOR_LEAFCLASS(ED4_terminal);
2007};
2008
2009struct ED4_bracket_terminal : public ED4_terminal {
2010    E4B_AVOID_UNNEEDED_CASTS(bracket_terminal);
2011
2012    virtual ED4_returncode draw() OVERRIDE;
2013    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
2014
2015    void fold();
2016    void unfold();
2017
2018    ED4_bracket_terminal(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2019
2020    DECLARE_DUMP_FOR_LEAFCLASS(ED4_terminal);
2021};
2022
2023struct ED4_text_terminal : public ED4_terminal {
2024    E4B_AVOID_UNNEEDED_CASTS(text_terminal);
2025   
2026    // functions concerning graphic output
2027    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
2028    virtual ED4_returncode draw() OVERRIDE;
2029
2030    virtual int get_length() const = 0;
2031    virtual void deleted_from_database() OVERRIDE;
2032
2033    ED4_text_terminal(const ED4_objspec& spec_, GB_CSTR id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2034    virtual ~ED4_text_terminal() OVERRIDE {}
2035
2036    DECLARE_DUMP_FOR_BASECLASS(ED4_text_terminal, ED4_terminal);
2037};
2038
2039class ED4_abstract_sequence_terminal : public ED4_text_terminal { // derived from a Noncopyable
2040
2041    PosRange pixel2index(PosRange pixel_range);
2042
2043    E4B_AVOID_UNNEEDED_CASTS(abstract_sequence_terminal);
2044public:
2045    char *species_name; // @@@ wrong place (may be member of ED4_sequence_manager)
2046
2047
2048    ED4_abstract_sequence_terminal(const ED4_objspec& spec_, const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2049    virtual ~ED4_abstract_sequence_terminal() OVERRIDE;
2050
2051    virtual GB_alignment_type GetAliType() = 0;
2052    virtual int get_length() const OVERRIDE { int len; resolve_pointer_to_char_pntr(&len); return len; }
2053
2054    ED4_species_name_terminal *corresponding_species_name_terminal() const {
2055        return get_parent(ED4_L_SPECIES)->search_spec_child_rek(ED4_L_SPECIES_NAME)->to_species_name_terminal();
2056    }
2057    PosRange calc_interval_displayed_in_rectangle(AW_screen_area *area_rect);
2058    PosRange calc_update_interval();
2059
2060    DECLARE_DUMP_FOR_BASECLASS(ED4_abstract_sequence_terminal, ED4_text_terminal);
2061};
2062
2063class ED4_orf_terminal : public ED4_abstract_sequence_terminal { // derived from a Noncopyable
2064    // NOTE: ED4_orf_terminal is a separate terminal class used to display Open Reading Frames (ORFs)
2065    //       for the corresponding gene (DNA) sequence. It is used in ProteinViewer Module and should not be
2066    //       used for drawing aminoacid sequence alone as in protein alignment. Aminoacid sequences are
2067    //       handled by the standard "ED4_sequence_terminal" class.
2068
2069    char *aaSequence;
2070    size_t aaSeqLen;
2071    char *aaColor;
2072    int   aaStartPos;
2073    int   aaStrandType;
2074
2075    virtual ED4_returncode draw() OVERRIDE;
2076    E4B_AVOID_UNNEEDED_CASTS(orf_terminal);
2077public:
2078    ED4_orf_terminal(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2079    virtual ~ED4_orf_terminal() OVERRIDE;
2080
2081    virtual GB_alignment_type GetAliType() OVERRIDE;
2082
2083    void SET_aaSeqFlags (int startPos, int strandType) { aaStartPos = startPos; aaStrandType = strandType; }
2084    void SET_aaSequence(const char *aaSeq) { freedup(aaSequence, aaSeq); aaSeqLen = strlen(aaSequence); }
2085    void SET_aaColor(const char *aaSeq) { freedup(aaColor, aaSeq); }
2086
2087    int GET_aaStartPos () { return aaStartPos; }
2088    int GET_aaStrandType () { return aaStrandType; }
2089
2090    DECLARE_DUMP_FOR_LEAFCLASS(ED4_abstract_sequence_terminal);
2091};
2092
2093class ED4_sequence_terminal : public ED4_abstract_sequence_terminal { // derived from a Noncopyable
2094    mutable ED4_SearchResults searchResults;
2095    bool shall_display_secstruct_info; // helix or protstruct
2096
2097    virtual ED4_returncode draw() OVERRIDE;
2098
2099    E4B_AVOID_UNNEEDED_CASTS(sequence_terminal);
2100   
2101public:
2102
2103    AP_tree *st_ml_node;
2104
2105    ED4_sequence_terminal(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent, bool shall_display_secstruct_info_);
2106
2107    virtual GB_alignment_type GetAliType() OVERRIDE;
2108
2109    virtual void deleted_from_database() OVERRIDE;
2110    virtual int get_length() const OVERRIDE { return ED4_abstract_sequence_terminal::get_length(); }
2111
2112    void set_secstruct_display(bool show) { shall_display_secstruct_info = show; }
2113
2114    ED4_SearchResults& results() const { return searchResults; }
2115
2116    ED4_columnStat_terminal *corresponding_columnStat_terminal() const {
2117        ED4_base *col_term = get_parent(ED4_L_MULTI_SEQUENCE)->search_spec_child_rek(ED4_L_COL_STAT);
2118        return col_term ? col_term->to_columnStat_terminal() : 0;
2119    }
2120
2121    DECLARE_DUMP_FOR_MIDCLASS(ED4_sequence_terminal,ED4_abstract_sequence_terminal);
2122};
2123
2124class ED4_columnStat_terminal : public ED4_text_terminal { // derived from a Noncopyable
2125    char *likelihood[4];        // likelihood-array for each base (ACGU) [length of array = alignment_length]
2126    int   latest_update;
2127
2128    static double threshold;
2129
2130    int update_likelihood();
2131
2132    E4B_AVOID_UNNEEDED_CASTS(columnStat_terminal);
2133
2134public:
2135    // functions concerning graphic output
2136    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
2137    virtual ED4_returncode draw() OVERRIDE;
2138    virtual int get_length() const OVERRIDE { return corresponding_sequence_terminal()->get_length(); }
2139
2140    static int threshold_is_set();
2141    static void set_threshold(double aThreshold);
2142    static double get_threshold() { return threshold; }
2143
2144    ED4_sequence_terminal *corresponding_sequence_terminal() const { return get_parent(ED4_L_MULTI_SEQUENCE)->search_spec_child_rek(ED4_L_SEQUENCE_STRING)->to_sequence_terminal(); }
2145
2146    GB_CSTR build_probe_match_string(PosRange range) const;
2147
2148    ED4_columnStat_terminal(GB_CSTR id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2149    ~ED4_columnStat_terminal() OVERRIDE;
2150
2151    DECLARE_DUMP_FOR_LEAFCLASS(ED4_text_terminal);
2152};
2153
2154struct ED4_species_name_terminal : public ED4_text_terminal { // derived from a Noncopyable
2155    ED4_species_name_terminal(GB_CSTR id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2156    ~ED4_species_name_terminal() OVERRIDE { delete selection_info; }
2157
2158    E4B_AVOID_UNNEEDED_CASTS(species_name_terminal);
2159
2160    ED4_selection_entry *selection_info;            // Info about i.e. Position
2161    bool dragged;
2162
2163    GB_CSTR get_displayed_text() const;
2164    virtual int get_length() const OVERRIDE { return strlen(get_displayed_text()); }
2165
2166    ED4_sequence_terminal *corresponding_sequence_terminal() const {
2167        ED4_base *seq_term = get_parent(ED4_L_SPECIES)->search_spec_child_rek(ED4_L_SEQUENCE_STRING);
2168        return seq_term ? seq_term->to_sequence_terminal() : 0;
2169    }
2170
2171    DECLARE_DUMP_FOR_LEAFCLASS(ED4_text_terminal);
2172};
2173
2174struct ED4_sequence_info_terminal : public ED4_text_terminal {
2175    E4B_AVOID_UNNEEDED_CASTS(sequence_info_terminal);
2176   
2177    ED4_sequence_info_terminal(const char *id, /* GBDATA *gbd, */ AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2178
2179    ED4_species_name_terminal *corresponding_species_name_terminal() const {
2180        return get_parent(ED4_L_SPECIES)->search_spec_child_rek(ED4_L_SPECIES_NAME)->to_species_name_terminal();
2181    }
2182
2183    virtual ED4_returncode draw() OVERRIDE;
2184
2185    GBDATA *data() { return get_species_pointer(); } // DB-entry ("ali_xxx/data")
2186    const GBDATA *data() const { return get_species_pointer(); }
2187
2188    virtual int get_length() const OVERRIDE { return 1+strlen(id); }
2189
2190    DECLARE_DUMP_FOR_LEAFCLASS(ED4_text_terminal);
2191};
2192
2193struct ED4_pure_text_terminal : public ED4_text_terminal {
2194    E4B_AVOID_UNNEEDED_CASTS(pure_text_terminal);
2195   
2196    ED4_pure_text_terminal(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2197
2198    virtual int get_length() const OVERRIDE { int len; resolve_pointer_to_char_pntr(&len); return len; }
2199
2200    DECLARE_DUMP_FOR_LEAFCLASS(ED4_text_terminal);
2201};
2202
2203class ED4_consensus_sequence_terminal : public ED4_sequence_terminal {
2204    E4B_AVOID_UNNEEDED_CASTS(consensus_sequence_terminal);
2205   
2206    virtual ED4_returncode draw() OVERRIDE;
2207    ED4_char_table& get_char_table() const { return get_parent(ED4_L_GROUP)->to_group_manager()->table(); }
2208public:
2209    ED4_consensus_sequence_terminal(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2210
2211    virtual int get_length() const OVERRIDE;
2212
2213    DECLARE_DUMP_FOR_LEAFCLASS(ED4_sequence_terminal);
2214};
2215
2216class ED4_spacer_terminal : public ED4_terminal {
2217    E4B_AVOID_UNNEEDED_CASTS(spacer_terminal);
2218    bool shallDraw; // true -> spacer is really drawn (otherwise it's only a placeholder)
2219
2220public:
2221    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
2222    virtual ED4_returncode draw() OVERRIDE;
2223
2224    ED4_spacer_terminal(const char *id, bool shallDraw_, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2225
2226    DECLARE_DUMP_FOR_LEAFCLASS(ED4_terminal);
2227};
2228
2229struct ED4_line_terminal : public ED4_terminal {
2230    E4B_AVOID_UNNEEDED_CASTS(line_terminal);
2231   
2232    virtual ED4_returncode Show(int refresh_all=0, int is_cleared=0) OVERRIDE;
2233    virtual ED4_returncode draw() OVERRIDE;
2234
2235    ED4_line_terminal(const char *id, AW_pos x, AW_pos y, AW_pos width, AW_pos height, ED4_manager *parent);
2236
2237    DECLARE_DUMP_FOR_LEAFCLASS(ED4_terminal);
2238};
2239
2240
2241// ----------------------------------------------
2242//      inlines which need complete classdefs
2243
2244inline void ED4_base::set_update() { // @@@ rename into request_update
2245    if (!update_info.update_requested) {
2246        update_info.update_requested = 1;
2247        if (parent) parent->update_requested_by_child();
2248    }
2249}
2250
2251inline void ED4_base::request_resize() {
2252    update_info.set_resize(1);
2253    if (parent) parent->resize_requested_by_child();
2254}
2255
2256void ED4_manager::resize_requested_by_child() { 
2257    if (!update_info.resize) request_resize();
2258}
2259
2260
2261inline bool ED4_terminal::setCursorTo(ED4_cursor *cursor, int seq_pos, bool unfoldGroups, ED4_CursorJumpType jump_type) {
2262    ED4_species_manager *sm = get_parent(ED4_L_SPECIES)->to_species_manager();
2263    return sm->setCursorTo(cursor, seq_pos, unfoldGroups, jump_type);
2264}
2265
2266E4B_IMPL_CASTOP(area_manager);           // to_area_manager
2267E4B_IMPL_CASTOP(abstract_group_manager); // to_abstract_group_manager
2268E4B_IMPL_CASTOP(bracket_terminal);       // to_bracket_terminal
2269E4B_IMPL_CASTOP(columnStat_terminal);    // to_columnStat_terminal
2270E4B_IMPL_CASTOP(device_manager);         // to_device_manager
2271E4B_IMPL_CASTOP(group_manager);          // to_group_manager
2272E4B_IMPL_CASTOP(line_terminal);          // to_line_terminal
2273E4B_IMPL_CASTOP(manager);                // to_manager
2274E4B_IMPL_CASTOP(multi_name_manager);     // to_multi_name_manager
2275E4B_IMPL_CASTOP(multi_sequence_manager); // to_multi_sequence_manager
2276E4B_IMPL_CASTOP(multi_species_manager);  // to_multi_species_manager
2277E4B_IMPL_CASTOP(name_manager);           // to_name_manager
2278E4B_IMPL_CASTOP(orf_terminal);           // to_orf_terminal
2279E4B_IMPL_CASTOP(pure_text_terminal);     // to_pure_text_terminal
2280E4B_IMPL_CASTOP(root_group_manager);     // to_root_group_manager
2281E4B_IMPL_CASTOP(sequence_info_terminal); // to_sequence_info_terminal
2282E4B_IMPL_CASTOP(sequence_manager);       // to_sequence_manager
2283E4B_IMPL_CASTOP(sequence_terminal);      // to_sequence_terminal
2284E4B_IMPL_CASTOP(spacer_terminal);        // to_spacer_terminal
2285E4B_IMPL_CASTOP(species_manager);        // to_species_manager
2286E4B_IMPL_CASTOP(species_name_terminal);  // to_species_name_terminal
2287E4B_IMPL_CASTOP(terminal);               // to_terminal
2288E4B_IMPL_CASTOP(text_terminal);          // to_text_terminal
2289
2290inline ED4_device_manager *ED4_root::get_device_manager() {
2291    return main_manager->search_spec_child_rek(ED4_L_DEVICE)->to_device_manager();
2292}
2293
2294inline ED4_species_name_terminal *ED4_multi_species_manager::get_consensus_name_terminal() const { 
2295    ED4_species_manager *consensus_man = get_consensus_manager();
2296    return consensus_man ? consensus_man->get_name_terminal() : NULL;
2297}
2298
2299// --------------------------------------------
2300//      Prototype functions without a class
2301
2302extern      ST_ML *st_ml;
2303
2304void ED4_with_all_edit_windows(void (*cb)(ED4_window *));
2305
2306void ED4_expose_recalculations();
2307void ED4_calc_terminal_extentions();
2308
2309void        ED4_input_cb            (AW_window *aww);
2310
2311void ED4_remote_event(AW_event *faked_event);
2312
2313void        ED4_quit                    (AW_window *aww, AW_CL cd1, AW_CL cd2);
2314void        ED4_motion_cb               (AW_window *aww);
2315void        ED4_vertical_change_cb      (AW_window *aww);
2316void        ED4_horizontal_change_cb    (AW_window *aww);
2317void        ED4_scrollbar_change_cb     (AW_window *aww);
2318
2319void        ED4_no_dangerous_modes      ();
2320void        group_species_cb        (AW_window *aww, AW_CL cd1, AW_CL cd2);
2321AW_window   *ED4_create_group_species_by_field_window(AW_root *aw_root);
2322
2323void ED4_trigger_instant_refresh();
2324void ED4_request_relayout();
2325void ED4_request_full_refresh();
2326void ED4_request_full_instant_refresh();
2327
2328AW_window   *ED4_start_editor_on_old_configuration  (AW_root *awr);
2329void        ED4_restart_editor          (AW_window *aww, AW_CL, AW_CL);
2330void        ED4_save_configuration          (AW_window *aww, AW_CL close_flag);
2331AW_window   *ED4_save_configuration_as_open_window  (AW_root *awr);
2332
2333void        ED4_set_iupac           (AW_window *aww, char *awar_name, bool callback_flag);
2334void        ED4_set_helixnr         (AW_window *aww, char *awar_name, bool callback_flag);
2335void        ed4_changesecurity      (AW_root *root, AW_CL cd1);
2336void        ed4_change_edit_mode        (AW_root *root, AW_CL cd1);
2337
2338ARB_ERROR rebuild_consensus(ED4_base *object);
2339
2340void ED4_exit() __ATTR__NORETURN;
2341
2342void        ED4_quit_editor         (AW_window *aww);                 // Be Careful: Is this the last window?
2343
2344void        ED4_store_curpos        (AW_window *aww);
2345void        ED4_restore_curpos      (AW_window *aww);
2346void        ED4_clear_stored_curpos     ();
2347void        ED4_helix_jump_opposite     (AW_window *aww);
2348void        ED4_jump_to_cursor_position (AW_window *aww, AW_CL cl_awar_name, AW_CL cl_pos_type);
2349void        ED4_remote_set_cursor_cb    (AW_root *awr);
2350void        ED4_change_cursor       (AW_window *aww);
2351void        ED4_set_reference_species   (AW_window *aww, AW_CL cd1, AW_CL cd2);
2352
2353void        ED4_new_editor_window       (AW_window *aww);
2354
2355AW_window  *ED4_create_consensus_definition_window (AW_root *root);
2356void        ED4_create_consensus_awars      (AW_root *aw_root);
2357void        ED4_consensus_definition_changed    (AW_root*, AW_CL, AW_CL);
2358void        ED4_consensus_display_changed       (AW_root*, AW_CL, AW_CL);
2359
2360AW_window   *ED4_create_level_1_options_window  (AW_root *root);
2361void        ED4_compression_toggle_changed_cb   (AW_root *root, AW_CL cd1, AW_CL cd2);
2362
2363AW_window   *ED4_create_new_seq_window      (AW_root *root, AW_CL cl_creation_mode);
2364
2365void ED4_jump_to_current_species     (AW_window *, AW_CL);
2366void ED4_get_and_jump_to_current      (AW_window *, AW_CL);
2367void ED4_get_and_jump_to_current_from_menu    (AW_window *aw, AW_CL cl, AW_CL);
2368void ED4_get_and_jump_to_species     (GB_CSTR species_name);
2369void ED4_get_marked_from_menu        (AW_window *, AW_CL, AW_CL);
2370void ED4_selected_species_changed_cb     (AW_root *aw_root);
2371void ED4_selected_SAI_changed_cb     (AW_root *aw_root);
2372
2373void ED4_init_notFoundMessage();
2374void ED4_finish_and_show_notFoundMessage();
2375
2376ED4_species_name_terminal *ED4_find_species_name_terminal(const char *species_name);
2377ED4_multi_species_manager *ED4_new_species_multi_species_manager();     // returns manager into which new species should be inserted
2378
2379void ED4_compression_changed_cb(AW_root *awr);
2380
2381// functions passed to external c-functions (i.e. as callbacks) have to be declared as 'extern "C"'
2382
2383extern "C" {
2384    void ED4_alignment_length_changed(GBDATA *gb_alignment_len, GB_CB_TYPE gbtype);
2385}
2386
2387struct AlignDataAccess;
2388void ED4_init_aligner_data_access(AlignDataAccess *data_access);
2389
2390#else
2391#error ed4_class included twice
2392#endif
2393
2394
Note: See TracBrowser for help on using the repository browser.