lily/clef-engraver.cc

   1 /*
   2   clef-engraver.cc -- implement Clef_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
   7
   8   Mats Bengtsson <matsb@s3.kth.se>
   9 */
  10
  11 #include <ctype.h>
  12
  13 #include "translator-group.hh"
  14
  15 #include "bar-line.hh"
  16 #include "staff-symbol-referencer.hh"
  17 #include "debug.hh"
  18 #include "engraver.hh"
  19 #include "direction.hh"
  20 #include "side-position-interface.hh"
  21 #include "item.hh"
  22
  23
  24 class Clef_engraver : public  Engraver
  25 {
  26 public:
  27   TRANSLATOR_DECLARATIONS(Clef_engraver);
  28
  29   Direction octave_dir_;
  30
  31 protected:
  32   virtual void stop_translation_timestep ();
  33   virtual void start_translation_timestep ();
  34   virtual void process_music ();
  35   virtual void acknowledge_grob (Grob_info);
  36 private:
  37   Item * clef_p_;
  38   Item * octavate_p_;
  39
  40   SCM prev_glyph_;
  41   SCM prev_cpos_;
  42   SCM prev_octavation_;
  43   void create_clef ();
  44   void set_glyph ();
  45   void inspect_clef_properties ();
  46 };
  47
  48 Clef_engraver::Clef_engraver ()
  49 {
  50   clef_p_ = 0;
  51   octave_dir_ = CENTER;
  52   octavate_p_ = 0;
  53
  54   /*
  55     will trigger a clef at the start since #f != ' ()
  56    */
  57   prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
  58 }
  59
  60 void
  61 Clef_engraver::set_glyph ()
  62 {
  63   SCM glyph_sym = ly_symbol2scm ("glyph-name");
  64   SCM glyph = get_property ("clefGlyph");
  65
  66   SCM basic = ly_symbol2scm ("Clef");
  67
  68   daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
  69   daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, glyph);
  70 }
  71
  72 /**
  73   Generate a clef at the start of a measure. (when you see a Bar,
  74   ie. a breakpoint)
  75   */
  76 void
  77 Clef_engraver::acknowledge_grob (Grob_info info)
  78 {
  79   Item * item =dynamic_cast <Item *> (info.grob_l_);
  80   if (item)
  81     {
  82       if (Bar_line::has_interface (info.grob_l_)
  83           && gh_string_p (get_property ("clefGlyph")))
  84         create_clef ();
  85
  86     }
  87 }
  88
  89 void
  90 Clef_engraver::create_clef ()
  91 {
  92   if (!clef_p_)
  93     {
  94       Item *c= new Item (get_property ("Clef"));
  95       announce_grob(c, SCM_EOL);
  96
  97       clef_p_ = c;
  98     }
  99   SCM cpos = get_property ("clefPosition");
 100
 101   if (gh_number_p (cpos))
 102     Staff_symbol_referencer::set_position (clef_p_, gh_scm2int (cpos));
 103
 104   SCM oct =  get_property ("clefOctavation");
 105   if (gh_number_p (oct) && gh_scm2int (oct))
 106     {
 107       Item * g = new Item (get_property ("OctavateEight"));
 108
 109       Side_position_interface::add_support (g,clef_p_);
 110
 111       g->set_parent (clef_p_, Y_AXIS);
 112       g->set_parent (clef_p_, X_AXIS);
 113
 114       g->set_grob_property ("direction", gh_int2scm (sign (gh_scm2int (oct))));
 115       octavate_p_ = g;
 116       announce_grob(octavate_p_, SCM_EOL);
 117     }
 118 }
 119
 120 void
 121 Clef_engraver::process_music ()
 122 {
 123   inspect_clef_properties ();
 124 }
 125
 126 void
 127 Clef_engraver::inspect_clef_properties ()
 128 {
 129   SCM glyph = get_property ("clefGlyph");
 130   SCM clefpos = get_property ("clefPosition");
 131   SCM octavation = get_property ("clefOctavation");
 132   SCM force_clef = get_property ("forceClef");
 133
 134   if (clefpos == SCM_EOL
 135       || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
 136       || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
 137       || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
 138       || to_boolean (force_clef)
 139 )
 140     {
 141       set_glyph ();
 142       create_clef ();
 143
 144       clef_p_->set_grob_property ("non-default", SCM_BOOL_T);
 145
 146       prev_cpos_ = clefpos;
 147       prev_glyph_ = glyph;
 148       prev_octavation_ = octavation;
 149     }
 150
 151   if (to_boolean (force_clef))
 152     {
 153       Translator_group * w = daddy_trans_l_->where_defined (ly_symbol2scm ("forceClef"));
 154       w->set_property ("forceClef", SCM_EOL);
 155     }
 156 }
 157
 158
 159 void
 160 Clef_engraver::stop_translation_timestep ()
 161 {
 162   if (clef_p_)
 163     {
 164       SCM vis = 0;
 165       if (to_boolean (clef_p_->get_grob_property ("non-default")))
 166         {
 167           vis = get_property ("explicitClefVisibility");
 168         }
 169
 170       if (vis)
 171         {
 172           clef_p_->set_grob_property ("visibility-lambda", vis);
 173           if (octavate_p_)
 174             octavate_p_->set_grob_property ("visibility-lambda", vis);
 175         }
 176
 177       typeset_grob (clef_p_);
 178       clef_p_ =0;
 179
 180       if (octavate_p_)
 181         typeset_grob (octavate_p_);
 182
 183       octavate_p_ = 0;
 184     }
 185 }
 186
 187 void
 188 Clef_engraver::start_translation_timestep ()
 189 {
 190 }
 191
 192
 193
 194 ENTER_DESCRIPTION(Clef_engraver,
 195 /* descr */       "Determine and set reference point for pitches",
 196 /* creats*/       "Clef OctavateEight",
 197 /* acks  */       "bar-line-interface",
 198 /* reads */       "clefPosition clefGlyph centralCPosition clefOctavation explicitClefVisibility",
 199 /* write */       "");