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       /*
  58         We take the duration-log of the head; this is because
  59         auto-tieing does strange things with the rhythmics.
  60        */
  61       int duration_log  =gh_scm2int (h->get_grob_property ("duration-log"));
  62       if (!stem_p_)
  63         {
  64           stem_p_ = new Item (get_property ("Stem"));
  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                   announce_grob(tremolo_p_, tremolo_req_l_->self_scm());
  91
  92                   /*
  93                     The number of tremolo flags is the number of flags of
  94                     the tremolo-type minus the number of flags of the note
  95                     itself.
  96                    */
  97                   int tremolo_flags = intlog2 (requested_type) - 2
  98                     - (duration_log > 2 ? duration_log - 2 : 0);
  99                   if (tremolo_flags < 0)
 100                     tremolo_flags = 0;
 101                   tremolo_p_->set_grob_property ("flag-count",
 102                                                 gh_int2scm (tremolo_flags));
 103                 }
 104             }
 105
 106           /*
 107             We announce the cause of the head as cause of the stem.
 108             The stem needs a rhythmic structure to fit it into a beam.  */
 109           announce_grob(stem_p_, i.music_cause ()->self_scm());
 110         }
 111
 112       if (Stem::flag_i (stem_p_) != duration_log)
 113         {
 114           i.music_cause ()->origin ()->warning (_f ("Adding note head to incompatible stem (type = %d)", 1 <<  Stem::flag_i (stem_p_)));
 115         }
 116
 117       Stem::add_head (stem_p_,h);
 118     }
 119 }
 120
 121 void
 122 Stem_engraver::stop_translation_timestep ()
 123 {
 124   if (tremolo_p_)
 125     {
 126       Stem_tremolo::set_stem (tremolo_p_, stem_p_);
 127       typeset_grob (tremolo_p_);
 128       tremolo_p_ = 0;
 129     }
 130
 131   if (stem_p_)
 132     {
 133       SCM prop = get_property ("stemLeftBeamCount");
 134       if (gh_number_p (prop))
 135         {
 136           Stem::set_beaming (stem_p_,gh_scm2int (prop),LEFT);
 137           daddy_trans_l_->unset_property (ly_symbol2scm ("stemLeftBeamCount"));
 138         }
 139       prop = get_property ("stemRightBeamCount");
 140       if (gh_number_p (prop))
 141         {
 142           Stem::set_beaming (stem_p_,gh_scm2int (prop), RIGHT);
 143           daddy_trans_l_->unset_property (ly_symbol2scm ("stemRightBeamCount"));
 144         }
 145
 146
 147       // UGH. Should mark non-forced instead.
 148       /*
 149          aargh: I don't get it.  direction is being set (and then set
 150          to forced), if we have a Chord_tremolo.
 151        */
 152
 153       /*
 154         Why the separate check for forced directions? --hwn.
 155
 156         (docme)
 157        */
 158       SCM dir = stem_p_->get_grob_property ("direction");
 159       if (gh_number_p (dir) && to_dir (dir))
 160         {
 161           stem_p_->set_grob_property ("dir-forced", SCM_BOOL_T);
 162         }
 163
 164       typeset_grob (stem_p_);
 165       stem_p_ = 0;
 166     }
 167
 168
 169   tremolo_req_l_ = 0;
 170 }
 171
 172 bool
 173 Stem_engraver::try_music (Music* r)
 174 {
 175   if (Tremolo_req* a = dynamic_cast <Tremolo_req *> (r))
 176     {
 177       tremolo_req_l_ = a;
 178       return true;
 179     }
 180   return false;
 181 }
 182
 183 ENTER_DESCRIPTION(Stem_engraver,
 184 /* descr */       "Create stems and single-stem tremolos.  It also works together with
 185 the beam engraver for overriding beaming.",
 186 /* creats*/       "Stem StemTremolo",
 187 /* acks  */       "rhythmic-head-interface",
 188 /* reads */       "tremoloFlags stemLeftBeamCount stemRightBeamCount",
 189 /* write */       "");