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--2001 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       int duration_log  = unsmob_duration (i.req_l_->get_mus_property ("duration"))-> duration_log ();
  58
  59       if (!stem_p_)
  60         {
  61           stem_p_ = new Item (get_property ("Stem"));
  62           Stem::set_interface (stem_p_);
  63           Staff_symbol_referencer::set_interface (stem_p_);
  64
  65
  66           stem_p_->set_grob_property ("duration-log", gh_int2scm (duration_log));
  67
  68           if (tremolo_req_l_)
  69             {
  70               /*
  71                 Stem tremolo is never applied to a note by default,
  72                 is must me requested.  But there is a default for the
  73                 tremolo value:
  74
  75                    c4:8 c c:
  76
  77                 the first and last (quarter) note bothe get one tremolo flag.
  78                */
  79               int requested_type = gh_scm2int (tremolo_req_l_->get_mus_property ("tremolo-type"));
  80
  81               SCM f = get_property ("tremoloFlags");
  82               if (!requested_type && gh_number_p (f))
  83                 requested_type = gh_scm2int (f);
  84               else
  85                 daddy_trans_l_->set_property ("tremoloFlags", gh_int2scm (requested_type));
  86
  87               if (requested_type)
  88                 {
  89                   tremolo_p_ = new Item (get_property ("StemTremolo"));
  90                   Stem_tremolo::set_interface (tremolo_p_);
  91
  92                   announce_grob (tremolo_p_, tremolo_req_l_);
  93                   /*
  94                     The number of tremolo flags is the number of flags of
  95                     the tremolo-type minus the number of flags of the note
  96                     itself.
  97                    */
  98                   int tremolo_flags = intlog2 (requested_type) - 2
  99                     - (duration_log > 2 ? duration_log - 2 : 0);
 100                   if (tremolo_flags < 0)
 101                     tremolo_flags = 0;
 102                   tremolo_p_->set_grob_property ("tremolo-flags",
 103                                                 gh_int2scm (tremolo_flags));
 104                 }
 105             }
 106           announce_grob (stem_p_, i.req_l_);
 107         }
 108
 109       if (Stem::flag_i (stem_p_) != duration_log)
 110         {
 111           i.req_l_->origin ()->warning (_f ("Adding note head to incompatible stem (type = %d)", 1 <<  Stem::flag_i (stem_p_)));
 112         }
 113
 114       Stem::add_head (stem_p_,h);
 115     }
 116 }
 117
 118 void
 119 Stem_engraver::stop_translation_timestep ()
 120 {
 121   if (tremolo_p_)
 122     {
 123       Stem_tremolo::set_stem (tremolo_p_, stem_p_);
 124       typeset_grob (tremolo_p_);
 125       tremolo_p_ = 0;
 126     }
 127
 128   if (stem_p_)
 129     {
 130       SCM prop = get_property ("stemLeftBeamCount");
 131       if (gh_number_p (prop))
 132         {
 133           Stem::set_beaming (stem_p_,gh_scm2int (prop),LEFT);
 134           daddy_trans_l_->set_property ("stemLeftBeamCount", SCM_UNDEFINED);
 135         }
 136       prop = get_property ("stemRightBeamCount");
 137       if (gh_number_p (prop))
 138         {
 139           Stem::set_beaming (stem_p_,gh_scm2int (prop), RIGHT);
 140           daddy_trans_l_->set_property ("stemRightBeamCount", SCM_UNDEFINED);
 141         }
 142
 143
 144       // UGH. Should mark non-forced instead.
 145       /*
 146          aargh: I don't get it.  direction is being set (and then set
 147          to forced), if we have a Chord_tremolo.
 148        */
 149       SCM dir = stem_p_->get_grob_property ("direction");
 150       if (gh_number_p (dir) && to_dir (dir))
 151         {
 152           stem_p_->set_grob_property ("dir-forced", SCM_BOOL_T);
 153         }
 154
 155       typeset_grob (stem_p_);
 156       stem_p_ = 0;
 157     }
 158
 159
 160   tremolo_req_l_ = 0;
 161 }
 162
 163 bool
 164 Stem_engraver::try_music (Music* r)
 165 {
 166   if (Tremolo_req* a = dynamic_cast <Tremolo_req *> (r))
 167     {
 168       tremolo_req_l_ = a;
 169       return true;
 170     }
 171   return false;
 172 }
 173
 174 ENTER_DESCRIPTION(Stem_engraver,
 175 /* descr */       "Create stems and single-stem tremolos.  It also works together with
 176 the beam engraver for overriding beaming.",
 177 /* creats*/       "Stem StemTremolo",
 178 /* acks  */       "rhythmic-head-interface",
 179 /* reads */       "tremoloFlags stemLeftBeamCount stemRightBeamCount",
 180 /* write */       "");