lily/include/context.hh

   1 /*
   2   context.hh -- declare  Context
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #ifndef CONTEXT_HH
  10 #define CONTEXT_HH
  11
  12 #include <map>
  13
  14 #include "moment.hh"
  15 #include "lily-proto.hh"
  16
  17
  18 class Context
  19 {
  20   Scheme_hash_table *properties_dict () const;
  21   Context (Context const &src);
  22
  23   DECLARE_SMOBS (Context, dummy);
  24
  25   void terminate ();
  26
  27 private:
  28   friend class Interpretation_context_handle;
  29   int iterator_count_;
  30   bool init_;
  31
  32   std::map<String, int> grob_counts_;
  33   std::map<String, int> context_counts_;
  34
  35 protected:
  36   Object_key const * key_;
  37   Context * daddy_context_;
  38   SCM definition_;
  39   SCM properties_scm_;
  40   SCM context_list_;
  41   SCM accepts_list_;
  42   SCM aliases_;
  43   SCM implementation_;
  44   String id_string_;
  45
  46   friend class Context_def;
  47   void clear_key_disambiguations ();
  48
  49 public:
  50   Object_key const *get_key () const;
  51   Object_key const *get_grob_key (String);
  52   Object_key const *get_context_key (String, String);
  53
  54   Context *create_context (Context_def*, String, SCM);
  55   String id_string () const { return id_string_; }
  56   SCM children_contexts () const { return context_list_; }
  57   SCM default_child_context_name () const;
  58
  59   Translator_group* implementation () const;
  60   Context *get_parent_context () const;
  61   Context (Object_key const*);
  62
  63   /* properties:  */
  64   void execute_pushpop_property (SCM prop, SCM sym, SCM val);
  65   SCM internal_get_property (SCM name_sym) const;
  66   SCM properties_as_alist () const;
  67   void internal_set_property (SCM var_sym, SCM value);
  68   Context *where_defined (SCM name_sym) const;
  69   void unset_property (SCM var_sym);
  70
  71
  72   Context *remove_context (Context *trans);
  73   void check_removal ();
  74   String context_name () const;
  75   SCM context_name_symbol () const;
  76   Global_context *get_global_context () const;
  77
  78   virtual Score_context * get_score_context () const;
  79   virtual Output_def *get_output_def () const;
  80   virtual Moment now_mom () const;
  81   virtual Context *get_default_interpreter ();
  82
  83   bool is_alias (SCM) const;
  84   void add_alias (SCM);
  85   void add_context (Context *trans);
  86   bool is_bottom_context () const;
  87   bool is_removable () const;
  88   bool try_music (Music *);
  89
  90   Context *find_create_context (SCM context_name,
  91                                 String id, SCM ops);
  92   Context *create_unique_context (SCM context_name,
  93                                    SCM ops);
  94   Link_array<Context> path_to_acceptable_context (SCM alias,
  95                                                   Output_def*) const;
  96
  97 };
  98
  99 /*
 100   Context arg?
 101  */
 102
 103 void apply_property_operations (Context *tg, SCM pre_init_ops);
 104 void execute_pushpop_property (Context *trg, SCM prop, SCM eltprop, SCM val);
 105 SCM updated_grob_properties (Context *tg, SCM sym);
 106 Context *find_context_below (Context *where,
 107                               SCM type_sym, String id);
 108 bool melisma_busy (Context *);
 109
 110 Context *get_voice_to_lyrics (Context *lyrics);
 111 Grob *get_current_note_head (Context *voice);
 112 Grob *get_current_rest (Context *voice);
 113 DECLARE_UNSMOB(Context, context);
 114
 115 #endif /* CONTEXT_HH */
 116