lily/new-fingering-engraver.cc

   1 /*
   2   fingering-engraver.cc --  implement New_fingering_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "warn.hh"
  11 #include "engraver.hh"
  12 #include "side-position-interface.hh"
  13 #include "item.hh"
  14 #include "event.hh"
  15 #include "stem.hh"
  16 #include "rhythmic-head.hh"
  17 #include "self-alignment-interface.hh"
  18 #include "script.hh"
  19 #include "stem.hh"
  20
  21 struct Finger_tuple
  22 {
  23   Grob *head_;
  24   Grob *script_;
  25   Music *note_event_;
  26   Music *finger_event_;
  27   SCM description_;
  28   int position_;
  29
  30   Finger_tuple ()
  31   {
  32     position_ = 0;
  33     head_ = script_ = 0;
  34     note_event_ = finger_event_ = 0;
  35     description_ = SCM_EOL;
  36   }
  37   static int compare (Finger_tuple const & c1, Finger_tuple const & c2)
  38   {
  39     return c1.position_-  c2.position_;
  40   }
  41
  42 };
  43
  44 class New_fingering_engraver : public Engraver
  45 {
  46   Array<Finger_tuple> fingerings_;
  47   Array<Finger_tuple> articulations_;
  48   Link_array<Grob> heads_;
  49   Grob *stem_;
  50
  51 public:
  52   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
  53 protected:
  54   virtual void stop_translation_timestep ();
  55   virtual void acknowledge_grob (Grob_info);
  56   void add_fingering (Grob*, Music*,Music*);
  57   void add_script  (Grob*, Music*,Music*);
  58   void position_scripts ();
  59 };
  60
  61 void
  62 New_fingering_engraver::acknowledge_grob (Grob_info inf)
  63 {
  64   if (Rhythmic_head::has_interface (inf.grob_))
  65     {
  66       Music * note_ev =inf.music_cause ();
  67
  68       SCM arts = note_ev->get_property ("articulations");
  69
  70       for (SCM s = arts; gh_pair_p (s); s = gh_cdr  (s))
  71         {
  72           Music * m = unsmob_music (gh_car (s));
  73
  74           if (!m)
  75             continue;
  76
  77
  78           if (m->is_mus_type ("fingering-event"))
  79             {
  80               add_fingering (inf.grob_ , m, note_ev);
  81             }
  82           else if (m->is_mus_type ("text-script-event"))
  83             {
  84               m->origin ()->warning ("Can not add text scripts to individual note heads");
  85             }
  86           else if (m->is_mus_type ("script-event"))
  87             {
  88               add_script (inf.grob_, m, note_ev);
  89             }
  90           else if (m->is_mus_type ("harmonic-event"))
  91             {
  92               inf.grob_->set_property ("style", ly_symbol2scm ("harmonic"));
  93               Grob * d = unsmob_grob (inf.grob_->get_property ("dot"));
  94               if (d)
  95                 d->suicide ();
  96             }
  97         }
  98
  99       heads_.push (inf.grob_);
 100     }
 101   else if (Stem::has_interface (inf.grob_))
 102     {
 103       stem_ = inf.grob_;
 104     }
 105 }
 106
 107 void
 108 New_fingering_engraver::add_script (Grob * head,
 109                                     Music * event,
 110                                     Music * )
 111 {
 112   Finger_tuple ft ;
 113
 114   Grob * g=  make_item ("Script");
 115   make_script_from_event (g, &ft.description_, daddy_context_,
 116                           event->get_property ("articulation-type"), 0);
 117   if (g)
 118     {
 119       ft.script_ =g ;
 120
 121       articulations_.push (ft);
 122       announce_grob (g, event->self_scm ());
 123
 124       ft.script_->set_parent (head, X_AXIS);
 125     }
 126 }
 127
 128
 129 void
 130 New_fingering_engraver::add_fingering (Grob * head,
 131                                        Music * event,
 132                                        Music *hevent)
 133 {
 134   Finger_tuple ft;
 135
 136   ft.script_ = make_item ("Fingering");
 137   announce_grob (ft.script_, event->self_scm ());
 138
 139   Side_position_interface::add_support (ft.script_, head);
 140
 141   int d = gh_scm2int (event->get_property ("digit"));
 142
 143   /*
 144     TODO:
 145
 146     Should add support for thumb.  It's a little involved, since
 147     the thumb lives in a different font. Maybe it should be moved?
 148
 149    */
 150   if (d > 5)
 151     {
 152       /*
 153         music for the softenon children?
 154        */
 155       event->origin ()->warning (_("music for the martians."));
 156     }
 157   SCM sstr = scm_number_to_string (gh_int2scm (d), gh_int2scm (10)) ;
 158   ft.script_->set_property ("text", sstr);
 159
 160   ft.finger_event_ = event;
 161   ft.note_event_ = hevent;
 162   ft.head_ = head;
 163
 164   fingerings_.push (ft);
 165 }
 166
 167 void
 168 New_fingering_engraver::position_scripts ()
 169 {
 170
 171   /*
 172     This is not extremely elegant, but we have to do a little
 173     formatting here, because the parent/child relations should be
 174     known before we move on to the next time step.
 175
 176     A more sophisticated approach would be to set both X and Y parents
 177     to the note head, and write a more flexible function for
 178     positioning the fingerings, setting both X and Y coordinates.
 179   */
 180   for (int i = 0; i < fingerings_.size (); i++)
 181     {
 182       fingerings_[i].position_ = gh_scm2int (fingerings_[i].head_ -> get_property ( "staff-position"));
 183     }
 184
 185   for (int i = fingerings_.size (); i--;)
 186     for (int j = heads_.size () ; j--;)
 187       Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
 188
 189   Array<Finger_tuple> up, down, horiz;
 190   for (int i = fingerings_.size (); i--;)
 191     {
 192       SCM d = fingerings_[i].finger_event_->get_property ("direction");
 193       if (to_dir (d))
 194         {
 195           ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
 196           fingerings_.del (i);
 197         }
 198     }
 199
 200   fingerings_.sort (&Finger_tuple::compare);
 201   SCM orientations = get_property ("fingeringOrientations");
 202
 203   bool up_p = scm_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 204   bool down_p = scm_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 205   bool left_p = scm_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 206   bool right_p = scm_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 207   Direction hordir = (right_p) ? RIGHT : LEFT;
 208   if (left_p || right_p)
 209     {
 210       if (up_p && !up.size () && fingerings_.size ())
 211         up.push (fingerings_.pop ());
 212
 213       if (down_p && !down.size () && fingerings_.size ())
 214         {
 215           down.push (fingerings_[0]);
 216           fingerings_.del (0);
 217         }
 218
 219       horiz.concat (fingerings_);
 220     }
 221   else if (up_p && down_p)
 222     {
 223       int center = fingerings_.size () / 2;
 224       down.concat (fingerings_.slice (0,center));
 225       up.concat (fingerings_.slice (center, fingerings_.size ()));
 226     }
 227   else if (up_p)
 228     {
 229       up.concat (fingerings_);
 230       fingerings_ .clear ();
 231     }
 232   else
 233     {
 234       if (!down_p)
 235         warning (_ ("Fingerings are also not down?! Putting them down anyway."));
 236       down.concat (fingerings_);
 237       fingerings_.clear ();
 238     }
 239
 240   for (int i = 0; i < horiz.size (); i++)
 241     {
 242       Finger_tuple ft = horiz[i];
 243       Grob* f = ft.script_;
 244       f->set_parent (ft.head_, X_AXIS);
 245       f->set_parent (ft.head_, Y_AXIS);
 246       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
 247       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
 248       f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
 249
 250       f->set_property ("direction", gh_int2scm (hordir));
 251       typeset_grob (f);
 252     }
 253
 254   int finger_prio = 200;
 255   for (int i = 0; i < up.size (); i++)
 256     {
 257       Finger_tuple ft = up[i];
 258       Grob* f = ft.script_;
 259       f->set_parent (ft.head_, X_AXIS);
 260       f->set_property ("script-priority",
 261                             gh_int2scm (finger_prio + i));
 262       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 263       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 264       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 265
 266       f->set_property ("direction", gh_int2scm (UP));
 267
 268       typeset_grob (f);
 269     }
 270
 271   for (int i = 0; i < down.size (); i++)
 272     {
 273       Finger_tuple ft = down[i];
 274       Grob* f = ft.script_;
 275       f->set_parent (ft.head_, X_AXIS);
 276       f->set_property ("script-priority",
 277                             gh_int2scm (finger_prio + down.size () - i));
 278
 279       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 280       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 281       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 282       f->set_property ("direction", gh_int2scm (DOWN));
 283       typeset_grob (f);
 284     }
 285 }
 286
 287 void
 288 New_fingering_engraver::stop_translation_timestep ()
 289 {
 290   if (fingerings_.size ())
 291     {
 292       position_scripts ();
 293       fingerings_.clear ();
 294     }
 295
 296   for (int i =  articulations_.size (); i--;)
 297     {
 298       Grob *sc = articulations_[i].script_;
 299
 300       for (int j = heads_.size () ; j--;)
 301         Side_position_interface::add_support (sc, heads_[j]);
 302
 303       if (stem_ && to_dir (sc->get_property ("side-relative-direction")))
 304         sc->set_property ("direction-source", stem_->self_scm ());
 305
 306       SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), articulations_[i].description_);
 307       if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
 308         {
 309           sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
 310           sc->set_property ("staff-padding" , SCM_EOL);
 311         }
 312       typeset_grob (sc);
 313     }
 314
 315   stem_ = 0;
 316   heads_.clear ();
 317   articulations_.clear ();
 318 }
 319
 320
 321 New_fingering_engraver::New_fingering_engraver ()
 322 {
 323   stem_ = 0;
 324 }
 325
 326 ENTER_DESCRIPTION (New_fingering_engraver,
 327 /* descr */       "Create fingering-scripts for notes in a new chord.  "
 328                   "This engraver is ill-named, since it "
 329                   "also takes care of articulations and harmonic note heads",
 330 /* creats*/       "Fingering",
 331 /* accepts */     "",
 332 /* acks  */       "rhythmic-head-interface stem-interface",
 333 /* reads */       "fingeringOrientations",
 334 /* write */       "");