lily/clef-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Mats Bengtsson <matsb@s3.kth.se>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include <cctype>
  22 using namespace std;
  23
  24 #include "item.hh"
  25 #include "context.hh"
  26 #include "staff-symbol-referencer.hh"
  27 #include "engraver.hh"
  28 #include "direction.hh"
  29 #include "side-position-interface.hh"
  30
  31 #include "translator.icc"
  32
  33 class Clef_engraver : public Engraver
  34 {
  35 public:
  36   TRANSLATOR_DECLARATIONS (Clef_engraver);
  37
  38 protected:
  39   void stop_translation_timestep ();
  40   void process_music ();
  41   DECLARE_ACKNOWLEDGER (bar_line);
  42
  43   virtual void derived_mark () const;
  44 private:
  45   Item *clef_;
  46   Item *octavate_;
  47
  48   SCM prev_glyph_;
  49   SCM prev_cpos_;
  50   SCM prev_octavation_;
  51   void create_clef ();
  52   void set_glyph ();
  53   void inspect_clef_properties ();
  54 };
  55
  56 void
  57 Clef_engraver::derived_mark () const
  58 {
  59   scm_gc_mark (prev_octavation_);
  60   scm_gc_mark (prev_cpos_);
  61   scm_gc_mark (prev_glyph_);
  62 }
  63
  64 Clef_engraver::Clef_engraver ()
  65 {
  66   clef_ = 0;
  67   octavate_ = 0;
  68
  69   /*
  70     will trigger a clef at the start since #f != ' ()
  71   */
  72   prev_octavation_ = prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
  73 }
  74
  75 void
  76 Clef_engraver::set_glyph ()
  77 {
  78   SCM glyph_sym = ly_symbol2scm ("glyph");
  79   SCM basic = ly_symbol2scm ("Clef");
  80
  81   execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
  82   execute_pushpop_property (context (), basic, glyph_sym, get_property ("clefGlyph"));
  83 }
  84
  85 /**
  86    Generate a clef at the start of a measure. (when you see a Bar,
  87    ie. a breakpoint)
  88 */
  89 void
  90 Clef_engraver::acknowledge_bar_line (Grob_info info)
  91 {
  92   Item *item = info.item ();
  93   if (item && scm_is_string (get_property ("clefGlyph")))
  94     create_clef ();
  95 }
  96
  97 void
  98 Clef_engraver::create_clef ()
  99 {
 100   if (!clef_)
 101     {
 102       Item *c = make_item ("Clef", SCM_EOL);
 103
 104       clef_ = c;
 105       SCM cpos = get_property ("clefPosition");
 106
 107       if (scm_is_number (cpos))
 108         clef_->set_property ("staff-position", cpos);
 109
 110       SCM oct = get_property ("clefOctavation");
 111       if (scm_is_number (oct) && scm_to_int (oct))
 112         {
 113           Item *g = make_item ("OctavateEight", SCM_EOL);
 114
 115           int abs_oct = scm_to_int (oct);
 116           int dir = sign (abs_oct);
 117           abs_oct = abs (abs_oct) + 1;
 118
 119           SCM txt = scm_number_to_string (scm_from_int (abs_oct),
 120                                           scm_from_int (10));
 121
 122           g->set_property ("text",
 123                            scm_list_n (ly_lily_module_constant ("vcenter-markup"),
 124                                        txt, SCM_UNDEFINED));
 125           Side_position_interface::add_support (g, clef_);
 126
 127           g->set_parent (clef_, Y_AXIS);
 128           g->set_parent (clef_, X_AXIS);
 129           g->set_property ("direction", scm_from_int (dir));
 130           octavate_ = g;
 131         }
 132     }
 133 }
 134 void
 135 Clef_engraver::process_music ()
 136 {
 137   inspect_clef_properties ();
 138 }
 139
 140 static void apply_on_children (Context *context, SCM fun)
 141 {
 142   scm_call_1 (fun, context->self_scm ());
 143   for (SCM s = context->children_contexts ();
 144        scm_is_pair (s); s = scm_cdr (s))
 145     apply_on_children (unsmob_context (scm_car (s)), fun);
 146 }
 147
 148 void
 149 Clef_engraver::inspect_clef_properties ()
 150 {
 151   SCM glyph = get_property ("clefGlyph");
 152   SCM clefpos = get_property ("clefPosition");
 153   SCM octavation = get_property ("clefOctavation");
 154   SCM force_clef = get_property ("forceClef");
 155
 156   if (clefpos == SCM_EOL
 157       || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
 158       || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
 159       || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
 160       || to_boolean (force_clef))
 161     {
 162       apply_on_children (context (),
 163                          ly_lily_module_constant ("invalidate-alterations"));
 164
 165       set_glyph ();
 166       if (prev_cpos_ != SCM_BOOL_F || to_boolean (get_property ("firstClef")))
 167         create_clef ();
 168
 169       if (clef_)
 170         clef_->set_property ("non-default", SCM_BOOL_T);
 171
 172       prev_cpos_ = clefpos;
 173       prev_glyph_ = glyph;
 174       prev_octavation_ = octavation;
 175     }
 176
 177   if (to_boolean (force_clef))
 178     {
 179       SCM prev;
 180       Context *w = context ()->where_defined (ly_symbol2scm ("forceClef"), &prev);
 181       w->set_property ("forceClef", SCM_EOL);
 182     }
 183 }
 184
 185 void
 186 Clef_engraver::stop_translation_timestep ()
 187 {
 188   if (clef_)
 189     {
 190       SCM vis = 0;
 191       if (to_boolean (clef_->get_property ("non-default")))
 192         vis = get_property ("explicitClefVisibility");
 193
 194       if (vis)
 195         clef_->set_property ("break-visibility", vis);
 196
 197       clef_ = 0;
 198
 199       octavate_ = 0;
 200     }
 201 }
 202
 203 ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
 204 ADD_TRANSLATOR (Clef_engraver,
 205                 /* doc */
 206                 "Determine and set reference point for pitches.",
 207
 208                 /* create */
 209                 "Clef "
 210                 "OctavateEight ",
 211
 212                 /* read */
 213                 "clefGlyph "
 214                 "clefOctavation "
 215                 "clefPosition "
 216                 "explicitClefVisibility "
 217                 "forceClef ",
 218
 219                 /* write */
 220                 ""
 221                );