]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/script-engraver.cc
*** empty log message ***
[lilypond.git] / lily / script-engraver.cc
index 5498b5b7f60f2db2d717bd5e41293609853932da..45fbb9d71c1839aff1820081b8cb925b40ba14a8 100644 (file)
 /*
-  script-engraver.cc -- implement Script_engraver
+  script-engraver.cc -- engrave Scripts: Articulations.
 
-  (c)  1997--2000 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 "context.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
+#include "event.hh"
+#include "new-slur.hh"
+#include "note-column.hh"
+#include "rhythmic-head.hh"
+#include "script-interface.hh"
 #include "side-position-interface.hh"
-#include "musical-request.hh"
+#include "staff-symbol-referencer.hh"
 #include "stem.hh"
-#include "staff-symbol.hh"
-#include "rhythmic-head.hh"
-#include "dimension-cache.hh"
+#include "warn.hh"
 
-#include "engraver.hh"
+struct Script_tuple
+{
+  Music *event_;
+  Grob *script_;
+  SCM description_;
+  Script_tuple ()
+  {
+    event_ = 0;
+    script_ = 0;
+    description_ = SCM_EOL;
+  }
+};
 
-class Script_engraver : public Engraver {
-  Link_array<Script> script_p_arr_;
-  Link_array<Articulation_req> script_req_l_arr_;
+class Script_engraver : public Engraver
+{
+  Array<Script_tuple> scripts_;
+  Grob *slur_;
 
-public:
-  VIRTUAL_COPY_CONS(Translator);
-  
-  Script_engraver();
 protected:
-  virtual bool do_try_music (Music*);
-  virtual void do_process_music ();
-  virtual void do_pre_move_processing ();
-  virtual void do_post_move_processing ();
-  virtual void acknowledge_element (Score_element_info);
-};
+  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()
+Script_engraver::Script_engraver ()
 {
-  do_post_move_processing();
+  slur_ = 0;
 }
 
 bool
-Script_engraver::do_try_music (Music *r_l)
+Script_engraver::try_music (Music *r)
 {
-  if (Articulation_req *mr = dynamic_cast <Articulation_req *> (r_l))
+  if (r->is_mus_type ("articulation-event"))
     {
-      for (int i=0; i < script_req_l_arr_.size(); i++) 
-       {
-         if (script_req_l_arr_[i]->equal_b (mr))
-           return true;
-       }
-      script_req_l_arr_.push (mr);
+      /* 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;
+      scripts_.push (t);
       return true;
     }
   return false;
 }
 
 void
-Script_engraver::do_process_music()
+copy_property (Grob *g, SCM sym, SCM alist)
 {
-  for (int i=0; i < script_req_l_arr_.size(); i++)
+  if (g->internal_get_property (sym) == SCM_EOL)
     {
-      Articulation_req* l=script_req_l_arr_[i];
+      SCM entry = scm_assoc (sym, alist);
+      if (ly_c_pair_p (entry))
+       g->internal_set_property (sym, ly_cdr (entry));
+    }
+}
 
-      SCM list = ly_eval_str (("(articulation-to-scriptdef \"" + l->articulation_str_ + "\")").ch_C());
-      
-      if (list == SCM_BOOL_F)
-       {
-         l->warning (_f ("Don't know how to interpret articulation `%s'",
-                       l->articulation_str_.ch_C ()));
-         continue;
-       }
-      Script *p =new Script;
-      Side_position_interface stafy (p);
-      
-      
-      list = gh_cdr (list);
-      p->set_elt_property ("molecule",
-                          gh_car (list));
-
-      list = gh_cdr(list);
-      bool follow_staff = gh_scm2bool (gh_car (list));
-      list = gh_cdr(list);
-      int relative_stem_dir = gh_scm2int (gh_car (list));
-      list = gh_cdr(list);
-      int force_dir =gh_scm2int (gh_car (list));
-      list = gh_cdr(list);
-      SCM priority = gh_car (list);
-
-      
-      if (relative_stem_dir)
-         p->set_elt_property ("side-relative-direction", gh_int2scm (relative_stem_dir));
-      else
-         stafy.set_direction ((Direction)force_dir);
-
-      if (l->get_direction ())
-       stafy.set_direction (l->get_direction ());
-
-      SCM axisprop = get_property ("scriptHorizontal");
-      bool xaxis = to_boolean (axisprop);
-      if (xaxis)
-       stafy.set_axis (X_AXIS);
-      else
-       stafy.set_axis (Y_AXIS);
-      
-      if (!follow_staff && ! xaxis)
-       p->set_elt_property ("staff-support", SCM_BOOL_T);
-
-      if (!xaxis && follow_staff)
-       stafy.set_quantised (Y_AXIS);
-      
-      p->set_elt_property ("script-priority", priority);
-  
-      script_p_arr_.push (p);
-      
-      announce_element (Score_element_info (p, l));
+/* 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 = scm_assoc (art_type, alist);
+
+  if (art == SCM_BOOL_F)
+    {
+      /* FIXME: */
+      warning (_ ("Do not know how to interpret articulation: "));
+      warning (_ ("Scheme encoding: "));
+      scm_write (art_type, scm_current_error_port ());
+      return;
     }
+
+  art = ly_cdr (art);
+  *descr = 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;
+  SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
+  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.  */
+  prio += index;
+
+  Side_position_interface::set_axis (p, Y_AXIS);
+  p->set_property ("script-priority", scm_int2num (prio));
 }
 
 void
-Script_engraver::acknowledge_element (Score_element_info inf)
+Script_engraver::process_music ()
 {
-  bool them_grace = to_boolean (inf.elem_l_->get_elt_property ("grace"));
-  bool us_grace = to_boolean (get_property ("weAreGraceContext"));
+  int script_count = scripts_.size ();
+  for (int i = 0; i < script_count; i++)
+    {
+      Music *m = scripts_[i].event_;
+
+      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 (us_grace != them_grace)
-    return;
-  
-  if (Stem *s = dynamic_cast<Stem*>(inf.elem_l_))
+      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 < script_p_arr_.size(); i++)
+      for (int i = 0; i < script_count; i++)
        {
-         Side_position_interface stafy (script_p_arr_[i]);
-         stafy.elt_l_->set_elt_property ("direction-source", s->self_scm_);
-         stafy.add_support (s);
+         Grob *e = scripts_[i].script_;
+
+         if (to_dir (e->get_property ("side-relative-direction")))
+           e->set_property ("direction-source", inf.grob_->self_scm ());
+
+         /* FIXME: add dependency */
+         e->add_dependency (inf.grob_);
+         Side_position_interface::add_support (e, inf.grob_);
        }
     }
-  else if (Rhythmic_head * rh = dynamic_cast<Rhythmic_head*>(inf.elem_l_))
+  else if (Rhythmic_head::has_interface (inf.grob_))
     {
-      for (int i=0; i < script_p_arr_.size(); i++)
+      for (int i = 0; i < script_count; i++)
        {
-         Side_position_interface stafy(script_p_arr_[i]);
-         
-         if (!stafy.elt_l_->parent_l (X_AXIS))
+         Grob *e = scripts_[i].script_;
+       
+         if (Side_position_interface::get_axis (e) == X_AXIS
+             && !e->get_parent (Y_AXIS))
            {
-             stafy.elt_l_->set_parent (inf.elem_l_, X_AXIS);
+             e->set_parent (inf.grob_, Y_AXIS);
+             e->add_dependency (inf.grob_); // ??
            }
-         if (stafy.get_axis () == X_AXIS
-             && !stafy.elt_l_->parent_l (Y_AXIS))
-           stafy.elt_l_->set_parent (rh, Y_AXIS);
-         
-         stafy.add_support (rh);
+         Side_position_interface::add_support (e,inf.grob_);
        }
-    }  
-}
-
-void
-Script_engraver::do_pre_move_processing()
-{
-  for (int i=0; i < script_p_arr_.size(); i++) 
+    }
+  else if (Note_column::has_interface (inf.grob_))
     {
-      if (to_boolean (script_p_arr_[i]->remove_elt_property ("staff-support")))
-       side_position (script_p_arr_[i]).add_staff_support ();
-      typeset_element (script_p_arr_[i]);
+      /* 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.
+
+       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);
+       }
     }
-  script_p_arr_.clear();
+  else if (New_slur::has_interface (inf.grob_) && script_count)
+    slur_ = inf.grob_;
 }
 
 void
-Script_engraver::do_post_move_processing()
+Script_engraver::stop_translation_timestep ()
 {
-  script_req_l_arr_.clear();
+  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 ();
 }
 
-ADD_THIS_TRANSLATOR(Script_engraver);
-
-
+ENTER_DESCRIPTION (Script_engraver,
+/* descr */       "Handles note scripted articulations.",
+/* creats*/       "Script",
+/* accepts */     "script-event articulation-event",
+/* acks  */       "stem-interface rhythmic-head-interface\
+ new-slur-interface note-column-interface",
+/* reads */       "scriptDefinitions",
+/* write */       "");