]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/new-fingering-engraver.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / new-fingering-engraver.cc
index 35e7e3328e566457f5b6ce20664dd41b87eddcd7..cb2a1bd20274288ae4386b3bfa03f5564e4671f2 100644 (file)
@@ -1,22 +1,23 @@
-/*   
-  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--2006 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 "script-interface.hh"
 #include "self-alignment-interface.hh"
-#include "script.hh"
+#include "side-position-interface.hh"
+#include "stem.hh"
 #include "stem.hh"
+#include "warn.hh"
+
+#include "translator.icc"
 
 struct Finger_tuple
 {
@@ -24,7 +25,7 @@ struct Finger_tuple
   Grob *script_;
   Music *note_event_;
   Music *finger_event_;
-  SCM description_;
+  bool follow_into_staff_;
   int position_;
 
   Finger_tuple ()
@@ -32,141 +33,165 @@ struct Finger_tuple
     position_ = 0;
     head_ = script_ = 0;
     note_event_ = finger_event_ = 0;
-    description_ = SCM_EOL;
+    follow_into_staff_ = false;
   }
-  static int compare (Finger_tuple const & c1, Finger_tuple const & c2)
+  static int compare (Finger_tuple const &c1, Finger_tuple const &c2)
   {
-    return c1.position_-  c2.position_;
+    return c1.position_- c2.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> articulations_;
+  vector<Finger_tuple> string_numbers_;
+
+  vector<Grob*> heads_;
   Grob *stem_;
-  
+
 public:
-  TRANSLATOR_DECLARATIONS(New_fingering_engraver);
+  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 *, Music *, Music *);
+  void add_script (Grob *, Music *, Music *);
+  void add_string (Grob *, Music *, Music *);
+  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 ();
+  Music *note_ev = inf.music_cause ();
+  if (!note_ev)
+    return;
 
-      SCM arts = note_ev->get_mus_property ("articulations");
+  SCM arts = note_ev->get_property ("articulations");
 
-      for (SCM s = arts; gh_pair_p (s); s = gh_cdr  (s))
+  for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
+    {
+      Music *m = unsmob_music (scm_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't 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 ("string-number-event"))
+       add_string (inf.grob (), m, note_ev);
+      else if (m->is_mus_type ("harmonic-event"))
        {
-         Music * m = unsmob_music (gh_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_grob_property ("style", ly_symbol2scm ("harmonic"));
-             Grob * d = unsmob_grob (inf.grob_->get_grob_property ("dot"));
-             if (d)
-               d->suicide ();  
-           }
+         inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
+         Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
+         if (d)
+           d->suicide ();
        }
-
-      heads_.push (inf.grob_);
-    }
-  else if (Stem::has_interface (inf.grob_))
-    {
-      stem_ = inf.grob_;
     }
+
+  heads_.push_back (inf.grob ());
 }
 
 void
-New_fingering_engraver::add_script (Grob * head,
-                                   Music * event,
-                                   Music * )
+New_fingering_engraver::acknowledge_stem (Grob_info inf)
 {
-  Finger_tuple ft ;
+  stem_ = inf.grob ();
+}
 
-  Grob * g=  make_item ("Script");
-  make_script_from_event (g, &ft.description_, daddy_trans_,
-                         event->get_mus_property ("articulation-type"), 0);
+void
+New_fingering_engraver::add_script (Grob *head,
+                                   Music *event,
+                                   Music *note)
+{
+  (void) note;
+
+  Finger_tuple ft;
+
+  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);
-      announce_grob (g, event->self_scm ());
+      ft.script_ = g;
+
+      articulations_.push_back (ft);
+
       ft.script_->set_parent (head, X_AXIS);
     }
-}                                  
-                                   
+}
 
 void
-New_fingering_engraver::add_fingering (Grob * head,
-                                      Music * event,
+New_fingering_engraver::add_fingering (Grob *head,
+                                      Music *event,
                                       Music *hevent)
 {
   Finger_tuple ft;
 
-  ft.script_ = make_item ("Fingering");
-  announce_grob (ft.script_, event->self_scm());
-  
+  ft.script_ = make_item ("Fingering", event->self_scm ());
+
   Side_position_interface::add_support (ft.script_, head);
 
-  int d = gh_scm2int (event->get_mus_property ("digit"));
-  
+  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."));
+       music for the softenon children?
+      */
+      event->origin ()->warning (_ ("music for the martians."));
     }
-  SCM sstr = scm_number_to_string (gh_int2scm (d), gh_int2scm (10)) ;
-  ft.script_->set_grob_property ("text", sstr);
-       
+  SCM sstr = scm_number_to_string (scm_from_int (d), scm_from_int (10));
+  ft.script_->set_property ("text", sstr);
+
   ft.finger_event_ = event;
   ft.note_event_ = hevent;
   ft.head_ = head;
 
-  fingerings_.push (ft);
+  fingerings_.push_back (ft);
 }
 
 void
-New_fingering_engraver::position_scripts ()
+New_fingering_engraver::add_string (Grob *head,
+                                   Music *event,
+                                   Music *hevent)
 {
+  Finger_tuple ft;
+
+  ft.script_ = make_item ("StringNumber", event->self_scm ());
+
+  Side_position_interface::add_support (ft.script_, head);
+
+  int d = scm_to_int (event->get_property ("string-number"));
+
+  SCM sstr = scm_number_to_string (scm_from_int (d), scm_from_int (10));
+  ft.script_->set_property ("text", sstr);
+
+  ft.finger_event_ = event;
+  ft.note_event_ = hevent;
+  ft.head_ = head;
+
+  string_numbers_.push_back (ft);
+}
+
+void
+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,111 +202,105 @@ 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_ = gh_scm2int (fingerings_[i].head_ -> get_grob_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_mus_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");
-
-  bool up_p = scm_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
-  bool down_p = scm_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
-  bool left_p = scm_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
-  bool right_p = scm_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
+
+  vector_sort (*scripts, Finger_tuple::compare);
+
+  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;
+  bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
+  bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
   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_grob_property ("direction", gh_int2scm (hordir));
-      typeset_grob (f);
+      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++)
-    {
-      Finger_tuple ft = up[i];
-      Grob* f = ft.script_;
-      f->set_parent (ft.head_, X_AXIS);
-      f->set_grob_property ("script-priority",
-                           gh_int2scm (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);
-      
-      f->set_grob_property ("direction", gh_int2scm (UP));
 
-      typeset_grob (f);
-    }
-  
-  for (int i = 0; i < down.size(); i++)
+  Direction d = DOWN;
+  Drul_array< vector<Finger_tuple> > vertical (down, up);
+  do
     {
-      Finger_tuple ft = down[i];
-      Grob* f = ft.script_;
-      f->set_parent (ft.head_, X_AXIS);
-      f->set_grob_property ("script-priority",
-                           gh_int2scm (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_grob_property ("direction", gh_int2scm (DOWN));
-      typeset_grob (f);
+      for (vsize i = 0; i < vertical[d].size (); i++)
+       {
+         Finger_tuple ft = vertical[d][i];
+         Grob *f = ft.script_;
+         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_from_int (d));
+       }
     }
+  while (flip (&d) != DOWN);
 }
 
 void
@@ -289,46 +308,51 @@ New_fingering_engraver::stop_translation_timestep ()
 {
   if (fingerings_.size ())
     {
-      position_scripts();
+      position_scripts (get_property ("fingeringOrientations"),
+                       &fingerings_);
       fingerings_.clear ();
     }
-  
-  for (int i =  articulations_.size(); i--;)
+
+  if (string_numbers_.size ())
     {
-      Grob *sc = articulations_[i].script_;
-   
-      for (int j = heads_.size() ; j--;)
-       Side_position_interface::add_support (sc, heads_[j]);
+      position_scripts (get_property ("stringNumberOrientations"),
+                       &string_numbers_);
+      string_numbers_.clear ();
+    }
+
+  for (vsize i = articulations_.size (); i--;)
+    {
+      Grob *script = articulations_[i].script_;
+
+      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_object ("direction-source", stem_->self_scm ());
+
+      if (stem_ && to_boolean (script->get_property ("add-stem-support")))
+       Side_position_interface::add_support (script, stem_);
+
 
-      if (stem_ && to_dir (sc->get_grob_property ("side-relative-direction")))
-       sc->set_grob_property ("direction-source", stem_->self_scm ());
-      
-      SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), articulations_[i].description_);
-      if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
-       {
-         sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
-         sc->set_grob_property ("staff-padding" , SCM_EOL);
-       }
-      typeset_grob (sc);
     }
 
   stem_ = 0;
   heads_.clear ();
-  articulations_.clear();
+  articulations_.clear ();
 }
 
-
-New_fingering_engraver::New_fingering_engraver()
+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",
+               /* accept */ "",
+               /* read */ "fingeringOrientations",
+               /* write */ "");