lily/include/engraver-group.hh

   1 /*
   2   engravergroup.hh -- declare Engraver_group_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
   7 */
   8
   9
  10 #ifndef ENGRAVERGROUP_HH
  11 #define ENGRAVERGROUP_HH
  12
  13 #include "parray.hh"
  14 #include "plist.hh"
  15 #include "score-elem-info.hh"
  16 #include "engraver.hh"
  17 #include "translator.hh"
  18
  19
  20 /**
  21   Group a number of engravers. Usually delegates everything to its contents.
  22   Postfix: group
  23   */
  24 class Engraver_group_engraver : public Engraver, public virtual Translator {
  25 protected:
  26
  27     Pointer_list<Engraver*> grav_list_;
  28     Link_array<Engraver_group_engraver> group_l_arr_;
  29     Link_array<Engraver> nongroup_l_arr_;
  30
  31     Array<Score_elem_info> announce_info_arr_;
  32
  33     virtual void do_print()const;
  34
  35     virtual bool removable_b()const;
  36
  37 public:
  38     Input_engraver * igrav_l_;
  39     void check_removal();
  40     Engraver_group_engraver();
  41     ~Engraver_group_engraver();
  42
  43     bool is_bottom_engraver_b() const;
  44
  45
  46     /**
  47       Junk #grav_l#.
  48       Pre:
  49       #grav_l# is in #grav_list_#
  50      */
  51     virtual void terminate_engraver(Engraver * grav_l);
  52
  53    NAME_MEMBERS();
  54
  55     /**
  56       Remove #grav_l# from the list, and return it.
  57      */
  58     virtual Engraver * remove_engraver_p(Engraver*grav_l);
  59     virtual void set_feature(Feature i);
  60     virtual void sync_features();
  61
  62     virtual void do_pre_move_processing();
  63     virtual void do_post_move_processing();
  64     virtual void do_removal_processing();
  65     virtual bool do_try_request(Request*);
  66     virtual bool try_request(Request*);
  67     virtual void do_process_requests();
  68
  69     virtual Staff_info get_staff_info()const;
  70
  71     virtual Engraver_group_engraver * find_engraver_l(String name,String id);
  72     virtual void do_announces();
  73     virtual void announce_element(Score_elem_info);
  74     virtual void add(Engraver* grav_p);
  75     virtual bool contains_b(Engraver*)const;
  76
  77     virtual Translator* find_get_translator_l(String name, String id);
  78     virtual Translator * get_default_interpreter();
  79     /**
  80       Go up in the tree. default: choose next parent
  81      */
  82     Translator * ancestor_l(int l=1);
  83     int depth_i() const;
  84
  85 };
  86
  87 #endif // ENGRAVERGROUP_HH
  88
  89