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--2002 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 "musical-request.hh"
  13 #include "misc.hh"
  14 #include "stem-tremolo.hh"
  15 #include "item.hh"
  16 #include "translator-group.hh"
  17 #include "engraver.hh"
  18
  19
  20
  21 /**
  22   Make stems upon receiving noteheads.
  23  */
  24 class Stem_engraver : public Engraver
  25 {
  26   TRANSLATOR_DECLARATIONS(Stem_engraver);
  27 protected:
  28   virtual void acknowledge_grob (Grob_info);
  29   virtual void stop_translation_timestep ();
  30   virtual bool try_music (Music*);
  31
  32 private:
  33   Grob  *stem_p_;
  34   Grob *tremolo_p_;
  35   Rhythmic_req *rhythmic_req_l_;
  36   Tremolo_req* tremolo_req_l_;
  37 };
  38
  39 Stem_engraver::Stem_engraver ()
  40 {
  41   tremolo_req_l_ = 0;
  42   stem_p_ = 0;
  43   tremolo_p_ = 0;
  44   rhythmic_req_l_ =0;
  45 }
  46
  47
  48 void
  49 Stem_engraver::acknowledge_grob (Grob_info i)
  50 {
  51   Grob* h = i.grob_l_;
  52   if (Rhythmic_head::has_interface (h))
  53     {
  54       if (Rhythmic_head::stem_l (h))
  55         return;
  56
  57       /* Reverted to the old method so chord tremolos work again. /MB
  58       */
  59       int duration_log = 0;
  60       Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (i.music_cause ());
  61       if (rhythmic_req)
  62         duration_log = unsmob_duration (rhythmic_req->get_mus_property ("duration"))-> duration_log ();
  63
  64       if (!stem_p_)
  65         {
  66           stem_p_ = new Item (get_property ("Stem"));
  67
  68           stem_p_->set_grob_property ("duration-log", gh_int2scm (duration_log));
  69
  70           if (tremolo_req_l_)
  71             {
  72               /*
  73                 Stem tremolo is never applied to a note by default,
  74                 is must me requested.  But there is a default for the
  75                 tremolo value:
  76
  77                    c4:8 c c:
  78
  79                 the first and last (quarter) note bothe get one tremolo flag.
  80                */
  81               int requested_type = gh_scm2int (tremolo_req_l_->get_mus_property ("tremolo-type"));
  82
  83               SCM f = get_property ("tremoloFlags");
  84               if (!requested_type && gh_number_p (f))
  85                 requested_type = gh_scm2int (f);
  86               else
  87                 daddy_trans_l_->set_property ("tremoloFlags", gh_int2scm (requested_type));
  88
  89               if (requested_type)
  90                 {
  91                   tremolo_p_ = new Item (get_property ("StemTremolo"));
  92                   announce_grob(tremolo_p_, tremolo_req_l_->self_scm());
  93
  94                   /*
  95                     The number of tremolo flags is the number of flags of
  96                     the tremolo-type minus the number of flags of the note
  97                     itself.
  98                    */
  99                   int tremolo_flags = intlog2 (requested_type) - 2
 100                     - (duration_log > 2 ? duration_log - 2 : 0);
 101                   if (tremolo_flags < 0)
 102                     tremolo_flags = 0;
 103                   tremolo_p_->set_grob_property ("flag-count",
 104                                                 gh_int2scm (tremolo_flags));
 105                 }
 106             }
 107
 108           /*
 109             We announce the cause of the head as cause of the stem.
 110             The stem needs a rhythmic structure to fit it into a beam.  */
 111           announce_grob(stem_p_, i.music_cause ()->self_scm());
 112         }
 113
 114       if (Stem::duration_log (stem_p_) != duration_log)
 115         {
 116           i.music_cause ()->origin ()->warning (_f ("Adding note head to incompatible stem (type = %d)", 1 <<  Stem::duration_log (stem_p_)));
 117         }
 118
 119       Stem::add_head (stem_p_,h);
 120     }
 121 }
 122
 123 void
 124 Stem_engraver::stop_translation_timestep ()
 125 {
 126   if (tremolo_p_)
 127     {
 128       Stem_tremolo::set_stem (tremolo_p_, stem_p_);
 129       typeset_grob (tremolo_p_);
 130       tremolo_p_ = 0;
 131     }
 132
 133   if (stem_p_)
 134     {
 135       SCM prop = get_property ("stemLeftBeamCount");
 136       if (gh_number_p (prop))
 137         {
 138           Stem::set_beaming (stem_p_,gh_scm2int (prop),LEFT);
 139           daddy_trans_l_->unset_property (ly_symbol2scm ("stemLeftBeamCount"));
 140         }
 141       prop = get_property ("stemRightBeamCount");
 142       if (gh_number_p (prop))
 143         {
 144           Stem::set_beaming (stem_p_,gh_scm2int (prop), RIGHT);
 145           daddy_trans_l_->unset_property (ly_symbol2scm ("stemRightBeamCount"));
 146         }
 147
 148
 149       // UGH. Should mark non-forced instead.
 150       /*
 151          aargh: I don't get it.  direction is being set (and then set
 152          to forced), if we have a Chord_tremolo.
 153        */
 154
 155       /*
 156         Why the separate check for forced directions? --hwn.
 157
 158         (docme)
 159        */
 160       SCM dir = stem_p_->get_grob_property ("direction");
 161       if (gh_number_p (dir) && to_dir (dir))
 162         {
 163           stem_p_->set_grob_property ("dir-forced", SCM_BOOL_T);
 164         }
 165
 166       typeset_grob (stem_p_);
 167       stem_p_ = 0;
 168     }
 169
 170
 171   tremolo_req_l_ = 0;
 172 }
 173
 174 bool
 175 Stem_engraver::try_music (Music* r)
 176 {
 177   if (Tremolo_req* a = dynamic_cast <Tremolo_req *> (r))
 178     {
 179       tremolo_req_l_ = a;
 180       return true;
 181     }
 182   return false;
 183 }
 184
 185 ENTER_DESCRIPTION(Stem_engraver,
 186 /* descr */       "Create stems and single-stem tremolos.  It also works together with
 187 the beam engraver for overriding beaming.",
 188 /* creats*/       "Stem StemTremolo",
 189 /* acks  */       "rhythmic-head-interface",
 190 /* reads */       "tremoloFlags stemLeftBeamCount stemRightBeamCount",
 191 /* write */       "");