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--1999 Han-Wen Nienhuys <hanwen@cs.uu.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 "cons.hh"
  18 #include "parray.hh"
  19
  20 // egcs
  21 typedef void (Translator::*Method_pointer)(void);
  22 typedef void (Translator::*Const_method_pointer)(void) const;
  23
  24 /** Make some kind of #Element#s from Requests. Elements are made by
  25   hierarchically grouped #Translator#s
  26   */
  27 class Translator_group : public virtual Translator {
  28   Array<String> consists_str_arr_;
  29   Array<String> consists_end_str_arr_;
  30   Array<String> accepts_str_arr_;
  31   Dictionary<Scalar> properties_dict_;
  32
  33   int iterator_count_;
  34   friend class Interpretation_context_handle;
  35
  36   Cons_list<Translator> trans_p_list_;
  37
  38 public:
  39   Scalar get_property (String type_str, Translator_group  **where_found_l) const;
  40   void set_property (String var_name, Scalar value);
  41
  42   String id_str_;
  43
  44   VIRTUAL_COPY_CONS(Translator);
  45
  46   void set_acceptor (String accepts, bool add);
  47   void set_element (String elt, bool add);
  48   void add_last_element (String elt);
  49
  50   Translator_group(Translator_group const &);
  51   Translator_group();
  52   void add_translator (Translator *trans_p);
  53
  54   Link_array<Translator> nongroup_l_arr () const;
  55   Link_array<Translator_group> group_l_arr () const;
  56
  57   virtual Global_translator *global_l() { return 0; }
  58
  59   /// Score_register = 0, Staff_registers = 1, etc)
  60   Translator_group* ancestor_l (int l=1);
  61   int depth_i() const;
  62   bool is_bottom_translator_b () const;
  63   bool removable_b() const;
  64   void terminate_translator (Translator*r_l);
  65   Translator *remove_translator_p (Translator*trans_l);
  66   void check_removal ();
  67
  68
  69   Translator *get_simple_translator (String) const;
  70   Translator_group *find_existing_translator_l (String n, String id);
  71   Translator_group *find_create_translator_l (String n, String id);
  72   Link_array<Translator_group> path_to_acceptable_translator (String alias) const;
  73
  74   Translator_group*get_default_interpreter();
  75 protected:
  76   virtual ~Translator_group ();
  77   virtual void do_print () const;
  78   virtual void do_process_requests ();
  79   virtual void do_add_processing ();
  80   virtual bool do_try_music (Music* req_l);
  81   virtual void do_pre_move_processing();
  82   virtual void do_post_move_processing();
  83   virtual void do_creation_processing();
  84   virtual void do_removal_processing();
  85   virtual void each (Method_pointer);
  86   virtual void each (Const_method_pointer) const;
  87 };
  88
  89 #endif // TRANSLATOR_GROUP_HH