lily/include/translator-group.hh

   1 /*
   2   translator-group.hh -- declare Translator_group
   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 TRANSLATOR_GROUP_HH
  11 #define TRANSLATOR_GROUP_HH
  12
  13 #include "string.hh"
  14 #include "lily-proto.hh"
  15 #include "virtual-methods.hh"
  16 #include "translator.hh"
  17 #include "plist.hh"
  18 #include "parray.hh"
  19
  20 typedef void (Translator::*Method_pointer)(void);
  21
  22 /** Make some kind of #Element#s from Requests. Elements are made by
  23   hierarchically grouped #Translator#s
  24   */
  25 class Translator_group : public virtual Translator {
  26 public:
  27   Pointer_list<Translator *> trans_p_list_;
  28   String id_str_;
  29   Array<String> consists_str_arr_;
  30   Array<String> accepts_str_arr_;
  31   int iterator_count_;
  32
  33   TRANSLATOR_CLONE(Translator_group);
  34   DECLARE_MY_RUNTIME_TYPEINFO;
  35
  36   Translator_group(Translator_group const &);
  37   Translator_group();
  38   void add (Translator *);
  39
  40   Link_array<Translator> nongroup_l_arr () const;
  41   Link_array<Translator_group> group_l_arr () const;
  42
  43   virtual Global_translator *global_l() { return 0; }
  44
  45   /// Score_register = 0, Staff_registers = 1, etc)
  46   Translator_group* ancestor_l (int l=1);
  47   int depth_i() const;
  48   bool is_bottom_translator_b () const;
  49   bool removable_b() const;
  50   void terminate_translator (Translator*r_l);
  51   Translator *remove_translator_p (Translator*trans_l);
  52   void check_removal ();
  53
  54   Translator *get_simple_translator (char const *type) const;
  55   Translator_group *find_existing_translator_l (String n, String id);
  56   Translator_group *find_create_translator_l (String n, String id);
  57   Link_array<Translator_group> path_to_acceptable_translator (String alias) const;
  58
  59   Translator_group*get_default_interpreter();
  60 protected:
  61   virtual ~Translator_group ();
  62   virtual Translator_group * group_l () { return this; }
  63   virtual void do_print () const;
  64   virtual void do_process_requests ();
  65   virtual void do_add_processing ();
  66   virtual bool do_try_request (Request* req_l);
  67   virtual void do_pre_move_processing();
  68   virtual void do_post_move_processing();
  69   virtual void do_creation_processing();
  70   virtual void do_removal_processing();
  71   void each (Method_pointer) const;
  72 };
  73
  74 #endif // TRANSLATOR_GROUP_HH