]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/new-fingering-engraver.cc
Run `make grand-replace'.
[lilypond.git] / lily / new-fingering-engraver.cc
index 843cae76d21693a586078d3ec78e7d1d4774e0eb..5078e2d2db9f1bcd11139528f93c469703c80c33 100644 (file)
@@ -1,29 +1,33 @@
-/*   
-  fingering-engraver.cc --  implement New_fingering_engraver
-  
+/*
+  fingering-engraver.cc -- implement New_fingering_engraver
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
 
-#include "warn.hh"
+  (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
+
 #include "engraver.hh"
-#include "side-position-interface.hh"
-#include "item.hh"
-#include "event.hh"
-#include "stem.hh"
+
+#include "international.hh"
 #include "rhythmic-head.hh"
-#include "self-alignment-interface.hh"
 #include "script-interface.hh"
+#include "self-alignment-interface.hh"
+#include "side-position-interface.hh"
 #include "stem.hh"
+#include "stream-event.hh"
+#include "item.hh"
+#include "warn.hh"
+
+#include "translator.icc"
+
+
 
 struct Finger_tuple
 {
   Grob *head_;
   Grob *script_;
-  Music *note_event_;
-  Music *finger_event_;
+  Stream_event *note_event_;
+  Stream_event *finger_event_;
   bool follow_into_staff_;
   int position_;
 
@@ -34,139 +38,138 @@ struct Finger_tuple
     note_event_ = finger_event_ = 0;
     follow_into_staff_ = false;
   }
-  static int compare (Finger_tuple const & c1, Finger_tuple const & c2)
-  {
-    return c1.position_-  c2.position_;
-  }
-              
 };
 
+bool
+operator< (Finger_tuple const &a, Finger_tuple const &b)
+{
+  return a.position_ < b.position_;
+}
+
 class New_fingering_engraver : public Engraver
 {
-  Array<Finger_tuple> fingerings_;
-  Array<Finger_tuple> articulations_;
-  Link_array<Grob> heads_;
+  vector<Finger_tuple> fingerings_;
+  vector<Finger_tuple> stroke_fingerings_;
+  vector<Finger_tuple> articulations_;
+  vector<Finger_tuple> string_numbers_;
+
+  vector<Grob*> heads_;
   Grob *stem_;
-  
+
+  void position_all ();
 public:
   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
 protected:
-  virtual void stop_translation_timestep ();
-  virtual void acknowledge_grob (Grob_info);
-  void add_fingering (Grob*, Music*,Music*);
-  void add_script  (Grob*, Music*,Music*);
-  void position_scripts ();
+  void stop_translation_timestep ();
+  DECLARE_ACKNOWLEDGER (rhythmic_head);
+  DECLARE_ACKNOWLEDGER (stem);
+  void add_fingering (Grob *, SCM,
+                     vector<Finger_tuple> *,
+                     Stream_event *, Stream_event *);
+  void add_script (Grob *, Stream_event *, Stream_event *);
+  void add_string (Grob *, Stream_event *, Stream_event *);
+  void position_scripts (SCM orientations, vector<Finger_tuple> *);
 };
 
 void
-New_fingering_engraver::acknowledge_grob (Grob_info inf)
+New_fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
 {
-  if (Rhythmic_head::has_interface (inf.grob_))
-    {
-      Music * note_ev =inf.music_cause ();
-      if (!note_ev)
-       return;
-      
-      SCM arts = note_ev->get_property ("articulations");
+  Stream_event *note_ev = inf.event_cause ();
+  if (!note_ev)
+    return;
 
-      for (SCM s = arts; ly_c_pair_p (s); s = ly_cdr  (s))
-       {
-         Music * m = unsmob_music (ly_car (s));
-
-         if (!m)
-           continue;
-         
-
-         if (m->is_mus_type ("fingering-event"))
-           {
-             add_fingering (inf.grob_ , m, note_ev);
-           }
-         else if (m->is_mus_type ("text-script-event"))
-           {
-             m->origin ()->warning ("Can not add text scripts to individual note heads");
-           }
-         else if (m->is_mus_type ("script-event"))
-           {
-             add_script (inf.grob_, m, note_ev);
-           }
-         else if (m->is_mus_type ("harmonic-event"))
-           {
-             inf.grob_->set_property ("style", ly_symbol2scm ("harmonic"));
-             Grob * d = unsmob_grob (inf.grob_->get_property ("dot"));
-             if (d)
-               d->suicide ();  
-           }
-       }
+  SCM arts = note_ev->get_property ("articulations");
 
-      heads_.push (inf.grob_);
-    }
-  else if (Stem::has_interface (inf.grob_))
+  for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
     {
-      stem_ = inf.grob_;
+      Stream_event *ev = unsmob_stream_event (scm_car (s));
+
+      if (!ev)
+       continue;
+
+      if (ev->in_event_class ("fingering-event"))
+       add_fingering (inf.grob (),
+                      ly_symbol2scm ("Fingering"),
+                      &fingerings_,
+                      ev, note_ev);
+      else if (ev->in_event_class ("text-script-event"))
+       ev->origin ()->warning (_ ("cannot add text scripts to individual note heads"));
+      else if (ev->in_event_class ("script-event"))
+       add_script (inf.grob (), ev, note_ev);
+      else if (ev->in_event_class ("string-number-event"))
+       add_fingering (inf.grob (),
+                      ly_symbol2scm ("StringNumber"), &string_numbers_,
+                      ev, note_ev);
+      else if (ev->in_event_class ("stroke-finger-event"))
+       add_fingering (inf.grob (),
+                      ly_symbol2scm ("StrokeFinger"), &stroke_fingerings_,
+                      ev, note_ev);
+      else if (ev->in_event_class ("harmonic-event"))
+       {
+         inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
+         Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
+         if (d && !to_boolean (get_property ("harmonicDots")))
+           d->suicide ();
+       }
     }
+
+  heads_.push_back (inf.grob ());
+}
+
+void
+New_fingering_engraver::acknowledge_stem (Grob_info inf)
+{
+  stem_ = inf.grob ();
 }
 
 void
-New_fingering_engraver::add_script (Grob * head,
-                                   Music * event,
-                                   Music * )
+New_fingering_engraver::add_script (Grob *head,
+                                   Stream_event *event,
+                                   Stream_event *note)
 {
-  Finger_tuple ft ;
+  (void) note;
+
+  Finger_tuple ft;
 
-  Grob * g=  make_item ("Script", event->self_scm () );
-  make_script_from_event (g, &ft.follow_into_staff_, context (),
+  Grob *g = make_item ("Script", event->self_scm ());
+  make_script_from_event (g, context (),
                          event->get_property ("articulation-type"), 0);
-  if (g)
-    {
-      ft.script_ =g ;
-      
-      articulations_.push (ft);
-      ft.script_->set_parent (head, X_AXIS);
-    }
-}                                  
-                                   
+  ft.script_ = g;
+  ft.script_->set_parent (head, X_AXIS);
+  
+  articulations_.push_back (ft);
+}
 
 void
-New_fingering_engraver::add_fingering (Grob * head,
-                                      Music * event,
-                                      Music *hevent)
+New_fingering_engraver::add_fingering (Grob *head,
+                                      SCM grob_sym,
+                                      vector<Finger_tuple> *tuple_vector,
+                                      Stream_event *event,
+                                      Stream_event *hevent)
 {
   Finger_tuple ft;
 
-  ft.script_ = make_item ("Fingering", event->self_scm () );
-  
+  ft.script_ = internal_make_item (grob_sym, event->self_scm (),
+                                  ly_symbol2string (grob_sym).c_str (),
+                                  __FILE__, __LINE__, __FUNCTION__
+                                  );
+
   Side_position_interface::add_support (ft.script_, head);
 
-  int d = scm_to_int (event->get_property ("digit"));
-  
-  /*
-    TODO:
-    
-    Should add support for thumb.  It's a little involved, since
-    the thumb lives in a different font. Maybe it should be moved?
-    
-   */
-  if (d > 5)
-    {
-      /*
-       music for the softenon children? 
-       */
-      event->origin ()->warning (_("music for the martians."));
-    }
-  SCM sstr = scm_number_to_string (scm_int2num (d), scm_int2num (10)) ;
-  ft.script_->set_property ("text", sstr);
-       
   ft.finger_event_ = event;
   ft.note_event_ = hevent;
   ft.head_ = head;
 
-  fingerings_.push (ft);
+  tuple_vector->push_back (ft);
 }
 
 void
-New_fingering_engraver::position_scripts ()
+New_fingering_engraver::position_scripts (SCM orientations,
+                                         vector<Finger_tuple> *scripts)
 {
+  for (vsize i = 0; i < scripts->size (); i++)
+    if (stem_ && to_boolean (scripts->at (i).script_->get_property ("add-stem-support")))
+      Side_position_interface::add_support (scripts->at (i).script_, stem_);
 
   /*
     This is not extremely elegant, but we have to do a little
@@ -177,28 +180,25 @@ New_fingering_engraver::position_scripts ()
     to the note head, and write a more flexible function for
     positioning the fingerings, setting both X and Y coordinates.
   */
-  for (int i = 0; i < fingerings_.size (); i++)
-    {      
-      fingerings_[i].position_ = scm_to_int (fingerings_[i].head_ -> get_property ( "staff-position"));
-    }
+  for (vsize i = 0; i < scripts->size (); i++)
+    (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
+
+  for (vsize i = scripts->size (); i--;)
+    for (vsize j = heads_.size (); j--;)
+      Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
 
-  for (int i = fingerings_.size (); i--;)
-    for (int j = heads_.size () ; j--;)
-      Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
-    
-  Array<Finger_tuple> up, down, horiz;
-  for (int i = fingerings_.size (); i--;)
+  vector<Finger_tuple> up, down, horiz;
+  for (vsize i = scripts->size (); i--;)
     {
-      SCM d = fingerings_[i].finger_event_->get_property ("direction");
+      SCM d = (*scripts)[i].finger_event_->get_property ("direction");
       if (to_dir (d))
        {
-         ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
-         fingerings_.del (i);
+         ((to_dir (d) == UP) ? up : down).push_back ((*scripts)[i]);
+         scripts->erase (scripts->begin () + i);
        }
     }
-  
-  fingerings_.sort (&Finger_tuple::compare);
-  SCM orientations = get_property ("fingeringOrientations");
+
+  vector_sort (*scripts, less<Finger_tuple> ());
 
   bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
   bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
@@ -207,130 +207,160 @@ New_fingering_engraver::position_scripts ()
   Direction hordir = (right_p) ? RIGHT : LEFT;
   if (left_p || right_p)
     {
-      if (up_p && !up.size () && fingerings_.size ())
-       up.push (fingerings_.pop ());
+      if (up_p && !up.size () && scripts->size ())
+       {
+         up.push_back (scripts->back ());
+         scripts->pop_back ();
+       }
 
-      if (down_p && !down.size () && fingerings_.size ())
+      if (down_p && !down.size () && scripts->size ())
        {
-         down.push (fingerings_[0]);
-         fingerings_.del (0);
+         down.push_back ((*scripts)[0]);
+         scripts->erase (scripts->begin ());
        }
 
-      horiz.concat (fingerings_);
+      horiz.insert (horiz.end (), scripts->begin (), scripts->end ());
     }
   else if (up_p && down_p)
     {
-      int center = fingerings_.size () / 2;
-      down.concat (fingerings_.slice (0,center));
-      up.concat (fingerings_.slice (center, fingerings_.size ()));
+      int center = scripts->size () / 2;
+      down.insert (down.end (), scripts->begin (), scripts->begin () + center);
+      up.insert (up.end (), scripts->begin () + center, scripts->end ());
     }
   else if (up_p)
     {
-      up.concat (fingerings_);
-      fingerings_ .clear ();
+      up.insert (up.end (), scripts->begin (), scripts->end ());
+      scripts->clear ();
     }
   else
     {
       if (!down_p)
-       warning (_ ("Fingerings are also not down?! Putting them down anyway."));
-      down.concat (fingerings_);
-      fingerings_.clear ();
+       {
+         warning (_ ("no placement found for fingerings"));
+         warning (_ ("placing below"));
+       }
+      down.insert (down.end (), scripts->begin (), scripts->end ());
+      scripts->clear ();
     }
-  
-  for (int i = 0; i < horiz.size (); i++)
+
+  for (vsize i = 0; i < horiz.size (); i++)
     {
       Finger_tuple ft = horiz[i];
-      Grobf = ft.script_;
+      Grob *f = ft.script_;
       f->set_parent (ft.head_, X_AXIS);
       f->set_parent (ft.head_, Y_AXIS);
-      f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
-      f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
-      f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
-
-      f->set_property ("direction", scm_int2num (hordir));
+      f->set_property ("avoid-slur", SCM_BOOL_F);
+      if (hordir == LEFT
+         && unsmob_grob (ft.head_->get_object ("accidental-grob")))
+       Side_position_interface::add_support (f,
+                                             unsmob_grob (ft.head_->get_object ("accidental-grob")));
+                                             
+      Self_alignment_interface::set_align_self (f, Y_AXIS);
+      Self_alignment_interface::set_center_parent (f, Y_AXIS);
+      Side_position_interface::set_axis (f, X_AXIS);
+
+      f->set_property ("direction", scm_from_int (hordir));
     }
 
-  int finger_prio = 200;
-  for (int i = 0; i < up.size (); i++)
+  Direction d = DOWN;
+  Drul_array< vector<Finger_tuple> > vertical (down, up);
+  do
     {
-      Finger_tuple ft = up[i];
-      Grob* f = ft.script_;
-      f->set_parent (ft.head_, X_AXIS);
-      f->set_property ("script-priority",
-                           scm_int2num (finger_prio + i));
-      f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
-      f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
-      f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
+      for (vsize i = 0; i < vertical[d].size (); i++)
+       {
+         Finger_tuple ft = vertical[d][i];
+         Grob *f = ft.script_;
+         int finger_prio = robust_scm2int (f->get_property ("script-priority"), 200);
+         f->set_parent (ft.head_, X_AXIS);
+         f->set_property ("script-priority",
+                          scm_from_int (finger_prio + d * ft.position_));
+
+         Self_alignment_interface::set_align_self (f, X_AXIS);
+         Self_alignment_interface::set_center_parent (f, X_AXIS);
+         Side_position_interface::set_axis (f, Y_AXIS);
       
-      f->set_property ("direction", scm_int2num (UP));
-
-    }
-  
-  for (int i = 0; i < down.size (); i++)
-    {
-      Finger_tuple ft = down[i];
-      Grob* f = ft.script_;
-      f->set_parent (ft.head_, X_AXIS);
-      f->set_property ("script-priority",
-                           scm_int2num (finger_prio + down.size () - i));
-
-      f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
-      f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
-      f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
-      f->set_property ("direction", scm_int2num (DOWN));
+         f->set_property ("direction", scm_from_int (d));
+       }
     }
+  while (flip (&d) != DOWN);
 }
 
 void
 New_fingering_engraver::stop_translation_timestep ()
+{
+  position_all ();
+  stem_ = 0;
+  heads_.clear ();
+}
+
+
+void
+New_fingering_engraver::position_all ()
 {
   if (fingerings_.size ())
     {
-      for (int i = 0;  i < fingerings_.size(); i++)
-       if (stem_ && to_boolean (fingerings_[i].script_->get_property ("add-stem-support")))
-         Side_position_interface::add_support (fingerings_[i].script_, stem_);
-      position_scripts ();
+      position_scripts (get_property ("fingeringOrientations"),
+                       &fingerings_);
       fingerings_.clear ();
     }
+
+  if (string_numbers_.size ())
+    {
+      position_scripts (get_property ("stringNumberOrientations"),
+                       &string_numbers_);
+      string_numbers_.clear ();
+    }
+
+  if (stroke_fingerings_.size ())
+    {
+      position_scripts (get_property ("strokeFingerOrientations"),
+                       &stroke_fingerings_);
+      stroke_fingerings_.clear ();
+    }
   
-  for (int i =  articulations_.size (); i--;)
+  for (vsize i = articulations_.size (); i--;)
     {
       Grob *script = articulations_[i].script_;
-   
-      for (int j = heads_.size () ; j--;)
+
+      for (vsize j = heads_.size (); j--;)
        Side_position_interface::add_support (script, heads_[j]);
 
       if (stem_ && to_dir (script->get_property ("side-relative-direction")))
-       script->set_property ("direction-source", stem_->self_scm ());
-
+       script->set_object ("direction-source", stem_->self_scm ());
 
       if (stem_ && to_boolean (script->get_property ("add-stem-support")))
        Side_position_interface::add_support (script, stem_);
-      
-      if (articulations_[i].follow_into_staff_)
-       {
-         script->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
-         script->set_property ("staff-padding" , SCM_EOL);
-       }
     }
-
-  stem_ = 0;
-  heads_.clear ();
   articulations_.clear ();
 }
 
-
 New_fingering_engraver::New_fingering_engraver ()
 {
-  stem_ = 0;  
+  stem_ = 0;
 }
 
-ENTER_DESCRIPTION (New_fingering_engraver,
-/* descr */       "Create fingering-scripts for notes in a new chord.  "
-                 "This engraver is ill-named, since it "
-                 "also takes care of articulations and harmonic note heads",
-/* creats*/       "Fingering",
-/* accepts */     "",
-/* acks  */       "rhythmic-head-interface stem-interface",
-/* reads */       "fingeringOrientations",
-/* write */       "");
+
+ADD_ACKNOWLEDGER (New_fingering_engraver, rhythmic_head);
+ADD_ACKNOWLEDGER (New_fingering_engraver, stem);
+
+ADD_TRANSLATOR (New_fingering_engraver,
+               /* doc */
+               "Create fingering scripts for notes in a new chord.  This"
+               " engraver is ill-named, since it also takes care of"
+               " articulations and harmonic note heads.",
+
+               /* create */
+               "Fingering "
+               "StringNumber "
+               "StrokeFinger "
+               "Script ",
+
+               /* read */
+               "fingeringOrientations "
+               "harmonicDots "
+               "strokeFingerOrientations "
+               "stringNumberOrientations ",
+               
+               /* write */
+               ""
+               );