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--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
   7
   8   Mats Bengtsson <matsb@s3.kth.se>
   9 */
  10
  11 #include <cctype>
  12
  13 #include "context.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
  20 #include "translator.icc"
  21
  22 class Clef_engraver : public Engraver
  23 {
  24 public:
  25   TRANSLATOR_DECLARATIONS (Clef_engraver);
  26
  27   Direction octave_dir_;
  28
  29 protected:
  30   void stop_translation_timestep ();
  31   void process_music ();
  32   DECLARE_ACKNOWLEDGER (bar_line);
  33
  34   virtual void derived_mark () const;
  35 private:
  36   Item *clef_;
  37   Item *octavate_;
  38
  39   SCM prev_glyph_;
  40   SCM prev_cpos_;
  41   SCM prev_octavation_;
  42   void create_clef ();
  43   void set_glyph ();
  44   void inspect_clef_properties ();
  45 };
  46
  47 void
  48 Clef_engraver::derived_mark () const
  49 {
  50   scm_gc_mark (prev_octavation_);
  51   scm_gc_mark (prev_cpos_);
  52   scm_gc_mark (prev_glyph_);
  53 }
  54
  55 Clef_engraver::Clef_engraver ()
  56 {
  57   clef_ = 0;
  58   octave_dir_ = CENTER;
  59   octavate_ = 0;
  60
  61   /*
  62     will trigger a clef at the start since #f != ' ()
  63   */
  64   prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
  65 }
  66
  67 void
  68 Clef_engraver::set_glyph ()
  69 {
  70   SCM glyph_sym = ly_symbol2scm ("glyph-name");
  71   SCM glyph = get_property ("clefGlyph");
  72
  73   SCM basic = ly_symbol2scm ("Clef");
  74
  75   execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
  76   execute_pushpop_property (context (), basic, glyph_sym, glyph);
  77 }
  78
  79 /**
  80    Generate a clef at the start of a measure. (when you see a Bar,
  81    ie. a breakpoint)
  82 */
  83 void
  84 Clef_engraver::acknowledge_bar_line (Grob_info info)
  85 {
  86   Item *item = dynamic_cast<Item *> (info.grob ());
  87   if (item && scm_is_string (get_property ("clefGlyph")))
  88     {
  89       create_clef ();
  90     }
  91 }
  92
  93 void
  94 Clef_engraver::create_clef ()
  95 {
  96   if (!clef_)
  97     {
  98       Item *c = make_item ("Clef", SCM_EOL);
  99
 100       clef_ = c;
 101       SCM cpos = get_property ("clefPosition");
 102
 103       if (scm_is_number (cpos))
 104         clef_->set_property ("staff-position", cpos);
 105
 106       SCM oct = get_property ("clefOctavation");
 107       if (scm_is_number (oct) && scm_to_int (oct))
 108         {
 109           Item *g = make_item ("OctavateEight", SCM_EOL);
 110
 111           int abs_oct = scm_to_int (oct);
 112           int dir = sign (abs_oct);
 113           abs_oct = abs (abs_oct) + 1;
 114
 115           SCM txt = scm_number_to_string (scm_from_int (abs_oct),
 116                                           scm_from_int (10));
 117
 118           g->set_property ("text",
 119                            scm_list_n (ly_lily_module_constant ("vcenter-markup"),
 120                                        txt, SCM_UNDEFINED));
 121           Side_position_interface::add_support (g, clef_);
 122
 123           g->set_parent (clef_, Y_AXIS);
 124           g->set_parent (clef_, X_AXIS);
 125           g->set_property ("direction", scm_from_int (dir));
 126           octavate_ = g;
 127         }
 128     }
 129 }
 130 void
 131 Clef_engraver::process_music ()
 132 {
 133   inspect_clef_properties ();
 134 }
 135
 136 void
 137 Clef_engraver::inspect_clef_properties ()
 138 {
 139   SCM glyph = get_property ("clefGlyph");
 140   SCM clefpos = get_property ("clefPosition");
 141   SCM octavation = get_property ("clefOctavation");
 142   SCM force_clef = get_property ("forceClef");
 143
 144   if (clefpos == SCM_EOL
 145        || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
 146        || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
 147        || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
 148        || to_boolean (force_clef))
 149     {
 150       set_glyph ();
 151       if (prev_cpos_ != SCM_BOOL_F || to_boolean (get_property ("firstClef")))
 152         create_clef ();
 153
 154       if (clef_)
 155         clef_->set_property ("non-default", SCM_BOOL_T);
 156
 157       prev_cpos_ = clefpos;
 158       prev_glyph_ = glyph;
 159       prev_octavation_ = octavation;
 160     }
 161
 162   if (to_boolean (force_clef))
 163     {
 164       SCM prev;
 165       Context *w = context ()->where_defined (ly_symbol2scm ("forceClef"), &prev);
 166       w->set_property ("forceClef", SCM_EOL);
 167     }
 168 }
 169
 170 void
 171 Clef_engraver::stop_translation_timestep ()
 172 {
 173   if (clef_)
 174     {
 175       SCM vis = 0;
 176       if (to_boolean (clef_->get_property ("non-default")))
 177         {
 178           vis = get_property ("explicitClefVisibility");
 179         }
 180
 181       if (vis)
 182         {
 183           clef_->set_property ("break-visibility", vis);
 184           if (octavate_)
 185             {
 186               octavate_->set_property ("break-visibility", vis);
 187             }
 188         }
 189
 190       clef_ = 0;
 191
 192       octavate_ = 0;
 193     }
 194 }
 195
 196 ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
 197 ADD_TRANSLATOR (Clef_engraver,
 198                 /* descr */ "Determine and set reference point for pitches",
 199                 /* creats*/ "Clef OctavateEight",
 200                 /* accepts */ "",
 201                 /* reads */ "clefPosition clefGlyph middleCPosition clefOctavation explicitClefVisibility forceClef",
 202                 /* write */ "");