lily/stem-engraver.cc

   1 /*
   2   stem-grav.cc -- implement Stem_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "staff-symbol-referencer.hh"
  10 #include "rhythmic-head.hh"
  11 #include "stem.hh"
  12 #include "event.hh"
  13 #include "misc.hh"
  14 #include "stem-tremolo.hh"
  15 #include "item.hh"
  16 #include "context.hh"
  17
  18 #include "engraver.hh"
  19
  20
  21
  22 /**
  23   Make stems upon receiving noteheads.
  24  */
  25 class Stem_engraver : public Engraver
  26 {
  27   TRANSLATOR_DECLARATIONS (Stem_engraver);
  28 protected:
  29   virtual void acknowledge_grob (Grob_info);
  30   virtual void stop_translation_timestep ();
  31   virtual bool try_music (Music*);
  32
  33 private:
  34   Grob  *stem_;
  35   Grob *tremolo_;
  36   Music *rhythmic_ev_;
  37   Music* tremolo_ev_;
  38 };
  39
  40 Stem_engraver::Stem_engraver ()
  41 {
  42   tremolo_ev_ = 0;
  43   stem_ = 0;
  44   tremolo_ = 0;
  45   rhythmic_ev_ =0;
  46 }
  47
  48
  49 void
  50 Stem_engraver::acknowledge_grob (Grob_info i)
  51 {
  52   Grob* h = i.grob_;
  53   if (Rhythmic_head::has_interface (h))
  54     {
  55       if (Rhythmic_head::get_stem (h))
  56         return;
  57
  58       /* Reverted to the old method so chord tremolos work again. /MB
  59       */
  60       int duration_log = 0;
  61
  62       Music * m = i.music_cause ();
  63       if (m->is_mus_type ("rhythmic-event"))
  64         duration_log = unsmob_duration (m->get_property ("duration"))-> duration_log ();
  65
  66       if (!stem_)
  67         {
  68           /*
  69             We announce the cause of the head as cause of the stem.
  70             The stem needs a rhythmic structure to fit it into a beam.  */
  71           stem_ = make_item ("Stem",i.music_cause ()->self_scm ());
  72
  73           stem_->set_property ("duration-log", scm_int2num (duration_log));
  74
  75           if (tremolo_ev_)
  76             {
  77               /*
  78                 Stem tremolo is never applied to a note by default,
  79                 is must me evuested.  But there is a default for the
  80                 tremolo value:
  81
  82                    c4:8 c c:
  83
  84                 the first and last (quarter) note bothe get one tremolo flag.
  85                */
  86               int requested_type = ly_scm2int (tremolo_ev_->get_property ("tremolo-type"));
  87               SCM f = get_property ("tremoloFlags");
  88               if (!requested_type)
  89                 if (ly_c_number_p (f))
  90                   requested_type = ly_scm2int (f);
  91                 else
  92                   requested_type = 8;
  93               else
  94                 context ()->set_property ("tremoloFlags", scm_int2num (requested_type));
  95
  96               int tremolo_flags = intlog2 (requested_type) - 2
  97                 - (duration_log > 2 ? duration_log - 2 : 0);
  98               if (tremolo_flags <= 0)
  99                 {
 100                   tremolo_ev_->origin ()->warning (_("tremolo duration is too long"));
 101                   tremolo_flags = 0;
 102                 }
 103
 104               if (tremolo_flags)
 105                 {
 106                   tremolo_ = make_item ("StemTremolo", tremolo_ev_->self_scm ());
 107
 108                   /*
 109                     The number of tremolo flags is the number of flags of
 110                     the tremolo-type minus the number of flags of the note
 111                     itself.
 112                    */
 113                   tremolo_->set_property ("flag-count",
 114                                                scm_int2num (tremolo_flags));
 115                   tremolo_->set_parent (stem_, X_AXIS);
 116                   stem_->set_property ("tremolo-flag", tremolo_->self_scm ());
 117                   tremolo_->set_property ("stem",
 118                                           stem_->self_scm ());
 119                 }
 120             }
 121
 122         }
 123
 124       if (Stem::duration_log (stem_) != duration_log)
 125         {
 126           i.music_cause ()->origin ()->warning (_f ("Adding note head to incompatible stem (type = %d)", 1 <<  Stem::duration_log (stem_))
 127                                                 + _f ("Don't you want polyphonic voices instead?")
 128                                                 );
 129         }
 130
 131       Stem::add_head (stem_,h);
 132     }
 133 }
 134
 135 void
 136 Stem_engraver::stop_translation_timestep ()
 137 {
 138   if (tremolo_)
 139     {
 140       typeset_grob (tremolo_);
 141       tremolo_ = 0;
 142     }
 143
 144   if (stem_)
 145     {
 146       /*
 147         toDO: junk these properties.
 148        */
 149       SCM prop = get_property ("stemLeftBeamCount");
 150       if (ly_c_number_p (prop))
 151         {
 152           Stem::set_beaming (stem_,ly_scm2int (prop),LEFT);
 153           context ()->unset_property (ly_symbol2scm ("stemLeftBeamCount"));
 154         }
 155       prop = get_property ("stemRightBeamCount");
 156       if (ly_c_number_p (prop))
 157         {
 158           Stem::set_beaming (stem_,ly_scm2int (prop), RIGHT);
 159           context ()->unset_property (ly_symbol2scm ("stemRightBeamCount"));
 160         }
 161
 162       typeset_grob (stem_);
 163       stem_ = 0;
 164     }
 165
 166
 167   tremolo_ev_ = 0;
 168 }
 169
 170 bool
 171 Stem_engraver::try_music (Music* r)
 172 {
 173   if (r->is_mus_type ("tremolo-event"))
 174     {
 175       tremolo_ev_ = r;
 176       return true;
 177     }
 178   return false;
 179 }
 180
 181 ENTER_DESCRIPTION (Stem_engraver,
 182 /* descr */       "Create stems and single-stem tremolos.  It also works together with "
 183 "the beam engraver for overriding beaming.",
 184 /* creats*/       "Stem StemTremolo",
 185 /* accepts */     "tremolo-event",
 186 /* acks  */      "rhythmic-head-interface",
 187 /* reads */       "tremoloFlags stemLeftBeamCount stemRightBeamCount",
 188 /* write */       "");