lily/ambitus-engraver.cc

   1 /*
   2   ambitus-engraver.cc -- implement Ambitus_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2002--2005 Juergen Reuter <reuter@ipd.uka.de>
   7
   8   Han-Wen Nienhuys <hanwen@xs4all.nl
   9 */
  10
  11 #include "engraver.hh"
  12 #include "note-head.hh"
  13 #include "pitch-interval.hh"
  14 #include "protected-scm.hh"
  15 #include "staff-symbol-referencer.hh"
  16 #include "axis-group-interface.hh"
  17 #include "side-position-interface.hh"
  18
  19 class Ambitus_engraver : public Engraver
  20 {
  21 public:
  22   TRANSLATOR_DECLARATIONS (Ambitus_engraver);
  23   virtual void process_music ();
  24   virtual void acknowledge_grob (Grob_info);
  25   virtual void stop_translation_timestep ();
  26   virtual void finalize ();
  27   virtual void derived_mark () const;
  28
  29 private:
  30   void create_ambitus ();
  31   Item *ambitus_;
  32   Item *group_;
  33   Drul_array<Item *> heads_;
  34   Drul_array<Item *> accidentals_;
  35   Pitch_interval pitch_interval_;
  36   bool is_typeset_;
  37   int start_c0_;
  38   SCM start_key_sig_;
  39 };
  40
  41 void
  42 Ambitus_engraver::derived_mark () const
  43 {
  44   scm_gc_mark (start_key_sig_);
  45 }
  46
  47 void
  48 Ambitus_engraver::create_ambitus ()
  49 {
  50   ambitus_ = make_item ("AmbitusLine", SCM_EOL);
  51   group_ = make_item ("Ambitus", SCM_EOL);
  52   Direction d = DOWN;
  53   do
  54     {
  55       heads_[d] = make_item ("AmbitusNoteHead", SCM_EOL);
  56       accidentals_[d] = make_item ("AmbitusAccidental", SCM_EOL);
  57       accidentals_[d]->set_parent (heads_[d], Y_AXIS);
  58       heads_[d]->set_object ("accidental-grob",
  59                                accidentals_[d]->self_scm ());
  60       Axis_group_interface::add_element (group_, heads_[d]);
  61       Axis_group_interface::add_element (group_, accidentals_[d]);
  62       Side_position_interface::add_support (accidentals_[d], heads_[d]);
  63     }
  64   while (flip (&d) != DOWN);
  65
  66   ambitus_->set_parent (heads_[DOWN], X_AXIS);
  67   Axis_group_interface::add_element (group_, ambitus_);
  68
  69   is_typeset_ = false;
  70 }
  71
  72 Ambitus_engraver::Ambitus_engraver ()
  73 {
  74   ambitus_ = 0;
  75   heads_[LEFT] = heads_[RIGHT] = 0;
  76   accidentals_[LEFT] = accidentals_[RIGHT] = 0;
  77   group_ = 0;
  78   is_typeset_ = false;
  79   start_key_sig_ = SCM_EOL;
  80 }
  81
  82 void
  83 Ambitus_engraver::process_music ()
  84 {
  85   /*
  86    * Ensure that ambitus is created in the very first timestep (on
  87    * which lily does not call start_translation_timestep ()).
  88    * Otherwise, if a voice begins with a rest, the ambitus grob will
  89    * be placed after the rest.
  90    */
  91   if (!ambitus_)
  92     {
  93       create_ambitus ();
  94     }
  95 }
  96
  97 void
  98 Ambitus_engraver::stop_translation_timestep ()
  99 {
 100   if (ambitus_ && !is_typeset_)
 101     {
 102       /*
 103        * Evaluate middleCPosition not until now, since otherwise we
 104        * may then oversee a clef that is defined in a staff context if
 105        * we are in a voice context; middleCPosition would then be
 106        * assumed to be 0.
 107        */
 108       start_c0_ = robust_scm2int (get_property ("middleCPosition"), 0);
 109       start_key_sig_ = get_property ("keySignature");
 110
 111       is_typeset_ = true;
 112     }
 113 }
 114
 115 void
 116 Ambitus_engraver::acknowledge_grob (Grob_info info)
 117 {
 118   Item *item = dynamic_cast<Item *> (info.grob ());
 119   if (item)
 120     {
 121       if (Note_head::has_interface (info.grob ()))
 122         {
 123           Music *nr = info.music_cause ();
 124           if (nr && nr->is_mus_type ("note-event"))
 125             {
 126               Pitch pitch = *unsmob_pitch (nr->get_property ("pitch"));
 127               pitch_interval_.add_point (pitch);
 128             }
 129         }
 130     }
 131 }
 132
 133 void
 134 Ambitus_engraver::finalize ()
 135 {
 136   if (ambitus_ && !pitch_interval_.is_empty ())
 137     {
 138       Direction d = DOWN;
 139       do
 140         {
 141           Pitch p = pitch_interval_[d];
 142           heads_[d]->set_property ("staff-position",
 143                                    scm_from_int (start_c0_
 144                                                  + p.steps ()));
 145
 146           SCM handle = scm_assoc (scm_cons (scm_from_int (p.get_octave ()),
 147                                             scm_from_int (p.get_notename ())),
 148                                   start_key_sig_);
 149
 150           if (handle == SCM_BOOL_F)
 151             handle = scm_assoc (scm_from_int (p.get_notename ()),
 152                                 start_key_sig_);
 153
 154           int sig_alter = (handle != SCM_BOOL_F)
 155             ? scm_to_int (scm_cdr (handle)) : 0;
 156
 157           if (sig_alter == p.get_alteration ())
 158             {
 159               accidentals_[d]->suicide ();
 160               heads_[d]->set_object ("accidental-grob", SCM_EOL);
 161             }
 162           else
 163             {
 164               SCM l = scm_list_1 (scm_from_int (p.get_alteration ()));
 165               accidentals_[d]->set_property ("accidentals", l);
 166
 167             }
 168         }
 169       while (flip (&d) != DOWN);
 170
 171       ambitus_->set_object ("note-heads", scm_list_2 (heads_[DOWN]->self_scm (),
 172                                                         heads_[UP]->self_scm ()));
 173     }
 174   else
 175     {
 176       Direction d = DOWN;
 177       do
 178         {
 179           accidentals_[d]->suicide ();
 180           heads_[d]->suicide ();
 181         }
 182       while (flip (&d) != DOWN);
 183
 184       ambitus_->suicide ();
 185     }
 186 }
 187
 188 ADD_TRANSLATOR (Ambitus_engraver,
 189                 /* descr */ "",
 190                 /* creats*/ "Ambitus AmbitusLine AmbitusNoteHead AmbitusAccidental",
 191                 /* accepts */ "",
 192                 /* acks  */ "note-head-interface",
 193                 /* reads */ "",
 194                 /* write */ "");