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--2003 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 #include "bar-line.hh"
  15 #include "staff-symbol-referencer.hh"
  16 #include "engraver.hh"
  17 #include "direction.hh"
  18 #include "side-position-interface.hh"
  19 #include "item.hh"
  20
  21 class Clef_engraver : public  Engraver
  22 {
  23 public:
  24   TRANSLATOR_DECLARATIONS(Clef_engraver);
  25
  26   Direction octave_dir_;
  27
  28 protected:
  29   virtual void stop_translation_timestep ();
  30   virtual void start_translation_timestep ();
  31   virtual void process_music ();
  32   virtual void acknowledge_grob (Grob_info);
  33 private:
  34   Item * clef_;
  35   Item * octavate_;
  36
  37   SCM prev_glyph_;
  38   SCM prev_cpos_;
  39   SCM prev_octavation_;
  40   void create_clef ();
  41   void set_glyph ();
  42   void inspect_clef_properties ();
  43 };
  44
  45 Clef_engraver::Clef_engraver ()
  46 {
  47   clef_ = 0;
  48   octave_dir_ = CENTER;
  49   octavate_ = 0;
  50
  51   /*
  52     will trigger a clef at the start since #f != ' ()
  53    */
  54   prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
  55 }
  56
  57 void
  58 Clef_engraver::set_glyph ()
  59 {
  60   SCM glyph_sym = ly_symbol2scm ("glyph-name");
  61   SCM glyph = get_property ("clefGlyph");
  62
  63   SCM basic = ly_symbol2scm ("Clef");
  64
  65   daddy_trans_->execute_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
  66   daddy_trans_->execute_pushpop_property (basic, glyph_sym, glyph);
  67 }
  68
  69 /**
  70   Generate a clef at the start of a measure. (when you see a Bar,
  71   ie. a breakpoint)
  72   */
  73 void
  74 Clef_engraver::acknowledge_grob (Grob_info info)
  75 {
  76   Item * item =dynamic_cast <Item *> (info.grob_);
  77   if (item)
  78     {
  79       if (Bar_line::has_interface (info.grob_)
  80           && gh_string_p (get_property ("clefGlyph")))
  81         create_clef ();
  82     }
  83 }
  84
  85 void
  86 Clef_engraver::create_clef ()
  87 {
  88   if (!clef_)
  89     {
  90       Item *c= new Item (get_property ("Clef"));
  91       announce_grob(c, SCM_EOL);
  92
  93       clef_ = c;
  94       SCM cpos = get_property ("clefPosition");
  95
  96       if (gh_number_p (cpos))
  97         Staff_symbol_referencer::set_position (clef_, gh_scm2int (cpos));
  98
  99       SCM oct =  get_property ("clefOctavation");
 100       if (gh_number_p (oct) && gh_scm2int (oct))
 101         {
 102           Item * g = new Item (get_property ("OctavateEight"));
 103
 104           int abs_oct = gh_scm2int (oct) ;
 105           int dir = sign (abs_oct);
 106           abs_oct = abs (abs_oct)  + 1;
 107
 108           g->set_grob_property ("text",
 109                                 scm_number_to_string (gh_int2scm (abs_oct),
 110                                                       SCM_MAKINUM (10)));
 111           Side_position_interface::add_support (g,clef_);
 112
 113           g->set_parent (clef_, Y_AXIS);
 114           g->set_parent (clef_, X_AXIS);
 115           g->set_grob_property ("direction", scm_int2num (dir));
 116           octavate_ = g;
 117           announce_grob(octavate_, SCM_EOL);
 118         }
 119     }
 120 }
 121 void
 122 Clef_engraver::process_music ()
 123 {
 124   inspect_clef_properties ();
 125 }
 126
 127 void
 128 Clef_engraver::inspect_clef_properties ()
 129 {
 130   SCM glyph = get_property ("clefGlyph");
 131   SCM clefpos = get_property ("clefPosition");
 132   SCM octavation = get_property ("clefOctavation");
 133   SCM force_clef = get_property ("forceClef");
 134
 135   if (clefpos == SCM_EOL
 136       || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
 137       || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
 138       || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
 139       || to_boolean (force_clef))
 140     {
 141       set_glyph ();
 142       create_clef ();
 143
 144       clef_->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_->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_)
 163     {
 164       SCM vis = 0;
 165       if (to_boolean (clef_->get_grob_property ("non-default")))
 166         {
 167           vis = get_property ("explicitClefVisibility");
 168         }
 169
 170       if (vis)
 171         {
 172           clef_->set_grob_property ("break-visibility", vis);
 173           if (octavate_)
 174             {
 175               octavate_->set_grob_property ("break-visibility", vis);
 176
 177             }
 178         }
 179
 180       typeset_grob (clef_);
 181       clef_ =0;
 182
 183       if (octavate_)
 184         {
 185           Side_position_interface::add_staff_support (octavate_);
 186           typeset_grob (octavate_);
 187         }
 188
 189       octavate_ = 0;
 190     }
 191 }
 192
 193 void
 194 Clef_engraver::start_translation_timestep ()
 195 {
 196 }
 197
 198
 199
 200 ENTER_DESCRIPTION(Clef_engraver,
 201 /* descr */       "Determine and set reference point for pitches",
 202 /* creats*/       "Clef OctavateEight",
 203 /* accepts */     "",
 204 /* acks  */      "bar-line-interface",
 205 /* reads */       "clefPosition clefGlyph centralCPosition clefOctavation explicitClefVisibility",
 206 /* write */       "");