]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/script-engraver.cc
*** empty log message ***
[lilypond.git] / lily / script-engraver.cc
index bfce6c5a1faeaecf8ef48318fc4f1c62802f6505..45fbb9d71c1839aff1820081b8cb925b40ba14a8 100644 (file)
@@ -1,22 +1,28 @@
 /*
-  script-engraver.cc -- implement Script_engraver
+  script-engraver.cc -- engrave Scripts: Articulations.
 
-  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  source file of the GNU LilyPond music typesetter
+
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-#include "script.hh"
-#include "side-position-interface.hh"
-#include "event.hh"
-#include "stem.hh"
-#include "rhythmic-head.hh"
+#include "context.hh"
+#include "directional-element-interface.hh"
 #include "engraver.hh"
+#include "event.hh"
+#include "new-slur.hh"
 #include "note-column.hh"
-#include "translator-group.hh"
+#include "rhythmic-head.hh"
+#include "script-interface.hh"
+#include "side-position-interface.hh"
+#include "staff-symbol-referencer.hh"
+#include "stem.hh"
+#include "warn.hh"
 
 struct Script_tuple
 {
   Music *event_;
-  Grob * script_;
+  Grob *script_;
   SCM description_;
   Script_tuple ()
   {
@@ -29,22 +35,38 @@ struct Script_tuple
 class Script_engraver : public Engraver
 {
   Array<Script_tuple> scripts_;
-public:
-  TRANSLATOR_DECLARATIONS(Script_engraver);
+  Grob *slur_;
+
 protected:
   virtual bool try_music (Music*);
   virtual void stop_translation_timestep ();
   virtual void process_music ();
   virtual void acknowledge_grob (Grob_info);
+
+public:
+  TRANSLATOR_DECLARATIONS (Script_engraver);
 };
 
+Script_engraver::Script_engraver ()
+{
+  slur_ = 0;
+}
+
 bool
 Script_engraver::try_music (Music *r)
 {
   if (r->is_mus_type ("articulation-event"))
     {
+      /* Discard double articulations for part-combining.  */
+      int script_count = scripts_.size ();
+      for (int i = 0; i < script_count; i++)
+       if (ly_c_equal_p (scripts_[i].event_
+                         ->get_property ("articulation-type"),
+                         r->get_property ("articulation-type")))
+         return true;
+
       Script_tuple t;
-      t.event_ =r;
+      t.event_ = r;
       scripts_.push (t);
       return true;
     }
@@ -52,110 +74,101 @@ Script_engraver::try_music (Music *r)
 }
 
 void
-copy_property (Grob * g , SCM sym, SCM alist)
+copy_property (Grob *g, SCM sym, SCM alist)
 {
-  if (g->internal_get_grob_property (sym) == SCM_EOL)
+  if (g->internal_get_property (sym) == SCM_EOL)
     {
-      SCM entry = scm_assoc (sym,alist);
-      if (gh_pair_p (entry))
-       {
-         g->internal_set_grob_property (sym, gh_cdr (entry));
-       }
+      SCM entry = scm_assoc (sym, alist);
+      if (ly_c_pair_p (entry))
+       g->internal_set_property (sym, ly_cdr (entry));
     }
 }
 
-
-/*
-  We add the properties, one by one for each Script. We could save a
-  little space by tacking the props onto the Script grob (i.e. make
-  ScriptStaccato , ScriptMarcato, etc. )
- */
-Grob *make_script_from_event (SCM * descr, Translator_group*tg, Music * event,
-                             int index)
+/* Add the properties, one by one for each Script.  A little space
+   (memory? --jcn) could be saved by tacking the props onto the Script
+   grob (i.e. make ScriptStaccato , ScriptMarcato, etc. ).  */
+void make_script_from_event (Grob *p, SCM *descr, Context *tg,
+                            SCM art_type, int index)
 {
   SCM alist = tg->get_property ("scriptDefinitions");
-  SCM art_type= event->get_mus_property ("articulation-type");
   SCM art = scm_assoc (art_type, alist);
 
   if (art == SCM_BOOL_F)
     {
-      event->origin ()->warning (_("Don't know how to interpret articulation:"));
-      event->origin ()->warning (_("Scheme encoding: "));
+      /* FIXME: */
+      warning (_ ("Do not know how to interpret articulation: "));
+      warning (_ ("Scheme encoding: "));
       scm_write (art_type, scm_current_error_port ());
-      return 0 ;
+      return;
     }
 
-  art = gh_cdr (art);
-    
-  Grob *p =new Item (tg->get_property ("Script"));
-  *descr = art;  
+  art = ly_cdr (art);
+  *descr = art;
 
-  SCM force_dir = event->get_mus_property ("direction");
-  if (is_direction (force_dir) && to_dir (force_dir))
-    p->set_grob_property ("direction", force_dir);
-
-  copy_property (p, ly_symbol2scm ("script-molecule"), art);
+  copy_property (p, ly_symbol2scm ("script-stencil"), art);
   copy_property (p, ly_symbol2scm ("direction"), art);
   copy_property (p, ly_symbol2scm ("side-relative-direction"), art);
 
-  int prio =0;
+  int prio = 0;
   SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
-  if (gh_pair_p (sprio))
-    prio = gh_scm2int (gh_cdr (sprio));
-
+  if (ly_c_pair_p (sprio))
+    prio = ly_scm2int (ly_cdr (sprio));
 
-  /*
-    Make sure they're in order of user input by adding index i.
-    Don't use the direction in this priority. Smaller means closer
-    to the head.
-  */
+  /* Make sure they're in order of user input by adding index i.
+     Don't use the direction in this priority. Smaller means closer
+     to the head.  */
   prio += index;
 
   Side_position_interface::set_axis (p, Y_AXIS);
-  p->set_grob_property ("script-priority", gh_int2scm (prio));
-  return p;
+  p->set_property ("script-priority", scm_int2num (prio));
 }
 
 void
 Script_engraver::process_music ()
 {
-  for (int i=0; i < scripts_.size (); i++)
+  int script_count = scripts_.size ();
+  for (int i = 0; i < script_count; i++)
     {
-      Music* l=scripts_[i].event_;
+      Music *m = scripts_[i].event_;
 
-      Grob * p = make_script_from_event (&scripts_[i].description_, daddy_trans_, l, i);
+      Grob *p = make_item ("Script", m->self_scm ());
+
+      make_script_from_event (p, &scripts_[i].description_, context (),
+                             m->get_property ("articulation-type"),
+                             i);
 
       scripts_[i].script_ = p;
-      if (p)
-       announce_grob (p, l->self_scm());
+
+      SCM force_dir = m->get_property ("direction");
+      if (is_direction (force_dir) && to_dir (force_dir))
+       p->set_property ("direction", force_dir);
     }
 }
 
 void
 Script_engraver::acknowledge_grob (Grob_info inf)
 {
+  int script_count = scripts_.size ();
   if (Stem::has_interface (inf.grob_))
     {
-      for (int i=0; i < scripts_.size (); i++)
+      for (int i = 0; i < script_count; i++)
        {
-         Grob*e = scripts_[i].script_;
+         Grob *e = scripts_[i].script_;
 
-         if (to_dir (e->get_grob_property ("side-relative-direction")))
-           e->set_grob_property ("direction-source", inf.grob_->self_scm ());
+         if (to_dir (e->get_property ("side-relative-direction")))
+           e->set_property ("direction-source", inf.grob_->self_scm ());
 
-         /*
-           add dep ? 
-          */
+         /* FIXME: add dependency */
          e->add_dependency (inf.grob_);
          Side_position_interface::add_support (e, inf.grob_);
        }
     }
   else if (Rhythmic_head::has_interface (inf.grob_))
     {
-      for (int i=0; i < scripts_.size (); i++)
+      for (int i = 0; i < script_count; i++)
        {
          Grob *e = scripts_[i].script_;
-         
+       
          if (Side_position_interface::get_axis (e) == X_AXIS
              && !e->get_parent (Y_AXIS))
            {
@@ -167,56 +180,73 @@ Script_engraver::acknowledge_grob (Grob_info inf)
     }
   else if (Note_column::has_interface (inf.grob_))
     {
-
-      /*
-       We make note column the parent of the script. That's not
+      /* Make note column the parent of the script.  That is not
        correct, but due to seconds in a chord, noteheads may be
-       swapped around horizontally. We don't know which note head to
-       put it on, so we postpone this decision to
-       Script_interface::before_line_breaking ().
-       */
-      for (int i=0; i < scripts_.size (); i++)
+       swapped around horizontally.
+
+       As the note head to put it on is not known now, postpone this
+       decision to Script_interface::before_line_breaking ().  */
+      for (int i = 0; i < script_count; i++)
        {
          Grob *e = scripts_[i].script_;
-         
-         if (!e->get_parent (X_AXIS) &&
-             Side_position_interface::get_axis (e) == Y_AXIS)
-           {
-             e->set_parent (inf.grob_, X_AXIS);
-           }
+
+         if (!e->get_parent (X_AXIS)
+             && Side_position_interface::get_axis (e) == Y_AXIS)
+           e->set_parent (inf.grob_, X_AXIS);
        }
     }
+  else if (New_slur::has_interface (inf.grob_) && script_count)
+    slur_ = inf.grob_;
 }
 
 void
 Script_engraver::stop_translation_timestep ()
 {
-  for (int i=0; i < scripts_.size (); i++) 
-    {
-      if (!scripts_[i].script_)
-       continue;
-      
-      Grob * sc = scripts_[i].script_;
-
-      SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), scripts_[i].description_);
-      if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
-       sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
-      else
-       Side_position_interface::add_staff_support (sc);
-      typeset_grob (sc);
-    }
+  int script_count = scripts_.size ();
+  for (int i = 0; i < script_count; i++)
+    if (Grob *sc = scripts_[i].script_)
+      {
+       SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"),
+                               scripts_[i].description_);
+       if (ly_c_pair_p (follow) && to_boolean (ly_cdr (follow)))
+         {
+           sc->add_offset_callback (Side_position_interface
+                                    ::quantised_position_proc, Y_AXIS);
+           sc->set_property ("staff-padding", SCM_EOL);
+         }
+       
+       /* Simplistic slur collision handling.  This fixes simple collisions
+          like
+          
+          a_\upbow( b)
+          
+          but it most probably breaks for more interesting cases.
+          Maybe make a new colission engraver.
+
+          
+          Assume that a SCRIPT that should collide with SLUR does not
+          have a negative priority. */
+       SCM priority = sc->get_property ("script-priority");
+       if (robust_scm2int (priority, 0) >= 0
+           && slur_
+           && get_grob_direction (sc) == get_slur_dir (slur_))
+         {
+           Real ss = Staff_symbol_referencer::staff_space (sc);
+           Real pad = robust_scm2double (sc->get_property ("padding"), 0);
+
+           /* FIXME: 1ss padding hardcoded */
+           sc->set_property ("padding", scm_make_real (pad + ss));
+         }
+      }
+  slur_ = 0;
   scripts_.clear ();
 }
 
-
-
-Script_engraver::Script_engraver(){}
-
-ENTER_DESCRIPTION(Script_engraver,
+ENTER_DESCRIPTION (Script_engraver,
 /* descr */       "Handles note scripted articulations.",
 /* creats*/       "Script",
 /* accepts */     "script-event articulation-event",
-/* acks  */      "stem-interface rhythmic-head-interface note-column-interface",
+/* acks  */       "stem-interface rhythmic-head-interface\
+ new-slur-interface note-column-interface",
 /* reads */       "scriptDefinitions",
 /* write */       "");