lily/include/context.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef CONTEXT_HH
  21 #define CONTEXT_HH
  22
  23 #include "duration.hh"
  24 #include "lily-proto.hh"
  25 #include "listener.hh"
  26 #include "moment.hh"
  27 #include "scm-hash.hh"
  28 #include "std-vector.hh"
  29 #include "virtual-methods.hh"
  30
  31 class Context
  32 {
  33   Scheme_hash_table *properties_dict () const;
  34   Context (Context const &src);
  35
  36   DECLARE_SMOBS (Context);
  37   DECLARE_CLASSNAME (Context);
  38   void terminate ();
  39
  40 private:
  41   friend class Context_handle;
  42   int iterator_count_;
  43
  44   /* Used internally by create_context */
  45   Stream_event *infant_event_;
  46
  47 protected:
  48   Context *daddy_context_;
  49   /* The used Context_def */
  50   SCM definition_;
  51   /* Additions to the Context_def, given by \with */
  52   SCM definition_mods_;
  53
  54   SCM properties_scm_;
  55   SCM context_list_;
  56   SCM accepts_list_;
  57   SCM aliases_;
  58   Translator_group *implementation_;
  59   string id_string_;
  60
  61   /* Events reported in the context is sent to this dispatcher. */
  62   Dispatcher *event_source_;
  63
  64   /* Events reported to this context or recursively in any of its
  65      children, are sent to this dispatcher. */
  66   Dispatcher *events_below_;
  67
  68   // Translator_group is allowed to set implementation_.
  69   friend class Translator_group;
  70   // Context_def::instantiate initialises some protected members.
  71   friend class Context_def;
  72   // UGH! initialises implementation_
  73   friend SCM ly_make_global_translator (SCM);
  74
  75   DECLARE_LISTENER (set_property_from_event);
  76   DECLARE_LISTENER (unset_property_from_event);
  77
  78 public:
  79   string id_string () const { return id_string_; }
  80   SCM children_contexts () const { return context_list_; }
  81   SCM default_child_context_name () const;
  82
  83   Dispatcher *event_source () const { return event_source_; }
  84   Dispatcher *events_below () const { return events_below_; }
  85   void internal_send_stream_event (SCM type, Input *origin, SCM props[]);
  86
  87   SCM get_definition () const { return definition_; }
  88   SCM get_definition_mods () const { return definition_mods_; }
  89
  90   Translator_group *implementation () const { return implementation_; }
  91   Context *get_parent_context () const;
  92   Context ();
  93
  94   /* properties:  */
  95   SCM internal_get_property (SCM name_sym) const;
  96   SCM properties_as_alist () const;
  97   Context *where_defined (SCM name_sym, SCM *value) const;
  98   void unset_property (SCM var_sym);
  99
 100   void instrumented_set_property (SCM, SCM, const char *, int, const char *);
 101   void internal_set_property (SCM var_sym, SCM value);
 102
 103   Context *create_context (Context_def *, string, SCM);
 104   DECLARE_LISTENER (create_context_from_event);
 105   DECLARE_LISTENER (acknowledge_infant);
 106   DECLARE_LISTENER (remove_context);
 107   DECLARE_LISTENER (change_parent);
 108   void disconnect_from_parent ();
 109   void check_removal ();
 110   string context_name () const;
 111   SCM context_name_symbol () const;
 112   Global_context *get_global_context () const;
 113
 114   virtual Context *get_score_context () const;
 115   virtual Output_def *get_output_def () const;
 116   virtual Moment now_mom () const;
 117   virtual Context *get_default_interpreter (string context_id = "");
 118
 119   bool is_alias (SCM) const;
 120   void add_alias (SCM);
 121   void add_context (Context *trans);
 122   bool is_bottom_context () const;
 123   bool is_removable () const;
 124
 125   Context *find_create_context (SCM context_name,
 126                                 string id, SCM ops);
 127   Context *create_unique_context (SCM context_name, string context_id,
 128                                   SCM ops);
 129   vector<Context_def *> path_to_acceptable_context (SCM alias) const;
 130 };
 131
 132 /*
 133   Context arg?
 134 */
 135
 136 void apply_property_operations (Context *tg, SCM pre_init_ops);
 137 void execute_revert_property (Context *context,
 138                               SCM context_property,
 139                               SCM grob_property_path);
 140 void execute_pushpop_property (Context *trg, SCM prop, SCM eltprop, SCM val);
 141 void sloppy_general_pushpop_property (Context *context,
 142                                       SCM context_property, SCM grob_property_path, SCM val);
 143 SCM updated_grob_properties (Context *tg, SCM sym);
 144 Context *find_context_below (Context *where,
 145                              SCM type_sym, string id);
 146 bool melisma_busy (Context *);
 147
 148 Context *get_voice_to_lyrics (Context *lyrics);
 149 Grob *get_current_note_head (Context *voice, bool include_grace_notes);
 150 Grob *get_current_rest (Context *voice);
 151 DECLARE_UNSMOB (Context, context);
 152
 153 Moment measure_position (Context const *context);
 154 Moment measure_position (Context const *context, Duration const *dur);
 155 Rational measure_length (Context const *context);
 156 int measure_number (Context const *context);
 157
 158 bool check_repeat_count_visibility (Context const *context, SCM count);
 159
 160 void set_context_property_on_children (Context *trans, SCM sym, SCM val);
 161
 162 /* Shorthand for creating and broadcasting stream events. */
 163 #define send_stream_event(ctx, type, origin, ...)                               \
 164 {                                                                       \
 165   SCM props[] = { __VA_ARGS__, 0 };                                     \
 166   ctx->internal_send_stream_event (ly_symbol2scm (type), origin, props);        \
 167 }
 168
 169 SCM nested_property_alist (SCM alist, SCM prop_path, SCM value);
 170 SCM nested_property_revert_alist (SCM alist, SCM prop_path);
 171 SCM evict_from_alist (SCM, SCM, SCM);
 172
 173 #endif /* CONTEXT_HH */