]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/script-engraver.cc
release commit
[lilypond.git] / lily / script-engraver.cc
index 74df559d3bd7145f3e94c7f7b205df8c40b153e5..0bb713d5819204926eba4218f292ca8ad5092126 100644 (file)
@@ -1,58 +1,73 @@
 /*
-  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 "slur.hh"
 #include "note-column.hh"
-#include "translator-group.hh"
+#include "paper-column.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_;
-  SCM description_;
+  Grob *script_;
+  bool follow_into_staff_;
   Script_tuple ()
   {
+    follow_into_staff_ = false;
     event_ = 0;
     script_ = 0;
-    description_ = SCM_EOL;
   }
 };
 
 class Script_engraver : public Engraver
 {
   Array<Script_tuple> scripts_;
-public:
-  TRANSLATOR_DECLARATIONS(Script_engraver);
+  Spanner *slur_;
+
 protected:
   virtual bool try_music (Music*);
-  virtual void initialize ();
   virtual void stop_translation_timestep ();
-  virtual void start_translation_timestep ();
   virtual void process_music ();
   virtual void acknowledge_grob (Grob_info);
+
+public:
+  TRANSLATOR_DECLARATIONS (Script_engraver);
 };
 
-void
-Script_engraver::initialize ()
+Script_engraver::Script_engraver ()
 {
-  scripts_.clear ();
+  slur_ = 0;
 }
 
 bool
-Script_engraver::try_music (Music *r)
+Script_engraver::try_music (Music *m)
 {
-  if (r->is_mus_type ("articulation-event"))
+  if (m->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"),
+                         m->get_property ("articulation-type")))
+         return true;
+
       Script_tuple t;
-      t.event_ =r;
+      t.event_ = m;
       scripts_.push (t);
       return true;
     }
@@ -60,175 +75,176 @@ 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 (scm_is_pair (entry))
+       g->internal_set_property (sym, ly_cdr (entry));
     }
 }
 
+/* Add the properties, one by one for each Script.  A little memory
+   could be saved by tacking the props onto the Script grob (i.e. make
+   ScriptStaccato , ScriptMarcato, etc. ).
 
-/*
-  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)
+*/
+void make_script_from_event (Grob *p, bool * follow, Context *tg,
+                            SCM art_type, int index)
 {
   SCM alist = tg->get_property ("scriptDefinitions");
-  SCM art = scm_assoc (event->get_mus_property ("articulation-type"), alist);
+  SCM art = scm_assoc (art_type, alist);
 
   if (art == SCM_BOOL_F)
     {
-      String a = ly_scm2string (event->get_mus_property ("articulation-type"));
-      event->origin ()->warning (_f ("Don't know how to interpret articulation `%s'", a.to_str0 ()));
-      return 0 ;
+      /* FIXME: */
+      warning (_ ("Do not know how to interpret articulation: "));
+      warning (_ ("Scheme encoding: "));
+      scm_write (art_type, scm_current_error_port ());
+      return;
     }
 
-  art = gh_cdr (art);
-    
-  Grob *p =new Item (tg->get_property ("Script"));
-  *descr = art;  
-
-  SCM force_dir = event->get_mus_property ("direction");
-  if (ly_dir_p (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 ("direction"), art);
-  copy_property (p, ly_symbol2scm ("side-relative-direction"), art);
+  art = ly_cdr (art);
 
-  int prio =0;
-  SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
-  if (gh_pair_p (sprio))
-    prio = gh_scm2int (gh_cdr (sprio));
+  SCM follow_scm = scm_assoc (ly_symbol2scm ("follow-into-staff"),
+                             art);
 
+  *follow = scm_is_pair (follow_scm) && to_boolean (ly_cdr (follow_scm));
+  bool priority_found = false ; 
+    
+  for (SCM s = art ; scm_is_pair (s); s = ly_cdr (s))
+    {
+      SCM sym = ly_caar (s);
+      SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
+      if (!ly_c_procedure_p (type))
+       continue;
+      
+      SCM val = ly_cdar (s);
 
-  /*
-    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;
+      if (sym == ly_symbol2scm ("script-priority"))
+       {
+         priority_found = true;
+         /* 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.  */
+         int prio  = scm_to_int (val) +  index;
+         
+        
+         val = scm_int2num (prio);
+       }
+      if (p->internal_get_property (sym) == SCM_EOL)
+       p->internal_set_property (sym, val);
+    }
 
+  if (!priority_found)
+    {
+      p->set_property ("script-priority",
+                      scm_int2num (index));
+    }
+  
   Side_position_interface::set_axis (p, Y_AXIS);
-  p->set_grob_property ("script-priority", gh_int2scm (prio));
-  return p;
+
 }
 
 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_item ("Script", m->self_scm ());
 
-      Grob * p = make_script_from_event (&scripts_[i].description_, daddy_trans_, l, i);
+      make_script_from_event (p, &scripts_[i].follow_into_staff_, 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)
+Script_engraver::acknowledge_grob (Grob_info info)
 {
-  if (Stem::has_interface (inf.grob_))
+  int script_count = scripts_.size ();
+  if (Stem::has_interface (info.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", info.grob_->self_scm ());
 
-         /*
-           add dep ? 
-          */
-         e->add_dependency (inf.grob_);
-         Side_position_interface::add_support (e, inf.grob_);
+         /* FIXME: add dependency */
+         e->add_dependency (info.grob_);
+         Side_position_interface::add_support (e, info.grob_);
        }
     }
-  else if (Rhythmic_head::has_interface (inf.grob_))
+  else if (Rhythmic_head::has_interface (info.grob_)
+          && info.music_cause ())
     {
-      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))
            {
-             e->set_parent (inf.grob_, Y_AXIS);
-             e->add_dependency (inf.grob_); // ??
+             e->set_parent (info.grob_, Y_AXIS);
+             e->add_dependency (info.grob_);
            }
-         Side_position_interface::add_support (e,inf.grob_);
+         Side_position_interface::add_support (e,info.grob_);
        }
     }
-  else if (Note_column::has_interface (inf.grob_))
+  else if (Note_column::has_interface (info.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 (info.grob_, X_AXIS);
        }
     }
+  else if (Slur::has_interface (info.grob_))
+    slur_ = dynamic_cast<Spanner*> (info.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);
-    }
-  scripts_.clear ();
-}
-
-void
-Script_engraver::start_translation_timestep ()
-{
+  int script_count = scripts_.size ();
+  for (int i = 0; i < script_count; i++)
+    if (scripts_[i].follow_into_staff_)
+      {
+       Grob *sc = scripts_[i].script_;
+       sc->add_offset_callback (Side_position_interface
+                                ::quantised_position_proc, Y_AXIS);
+       sc->set_property ("staff-padding", SCM_EOL);
+      }
+  
   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 " 
+                 "slur-interface note-column-interface",
 /* reads */       "scriptDefinitions",
 /* write */       "");