]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/script-engraver.cc
($(outdir)/%.pdf): add DVIPS_FLAGS. This will
[lilypond.git] / lily / script-engraver.cc
index 6947d403907f2bf32e16fbfebd7ccbc5fc7a03e6..e313e0a0e02e901b7bca1b499f831217ee75bd41 100644 (file)
 /*
   script-engraver.cc -- implement Script_engraver
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-
 #include "script.hh"
 #include "side-position-interface.hh"
-#include "musical-request.hh"
+#include "event.hh"
 #include "stem.hh"
 #include "rhythmic-head.hh"
 #include "engraver.hh"
+#include "note-column.hh"
+#include "translator-group.hh"
+#include "warn.hh"
 
-class Script_engraver : public Engraver {
-  Link_array<Score_element> script_p_arr_;
-  Link_array<Articulation_req> script_req_l_arr_;
+struct Script_tuple
+{
+  Music *event_;
+  Grob * script_;
+  SCM description_;
+  Script_tuple ()
+  {
+    event_ = 0;
+    script_ = 0;
+    description_ = SCM_EOL;
+  }
+};
 
+class Script_engraver : public Engraver
+{
+  Array<Script_tuple> scripts_;
 public:
-  VIRTUAL_COPY_CONS(Translator);
-  
-  Script_engraver();
+  TRANSLATOR_DECLARATIONS(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);
 };
 
-
-Script_engraver::Script_engraver()
+bool
+Script_engraver::try_music (Music *r)
 {
-  do_post_move_processing();
+  if (r->is_mus_type ("articulation-event"))
+    {
+      /*
+       Discard double articulations.
+       This is necessary for part-combining.
+       */
+      for (int j = 0; j < scripts_.size (); j++)
+       if (gh_equal_p (scripts_[j]. event_->get_mus_property ("articulation-type"),
+                       r->get_mus_property ("articulation-type")
+                       ))
+         return true;
+         
+      Script_tuple t;
+      t.event_ =r;
+      scripts_.push (t);
+      
+      return true;
+    }
+  return false;
 }
 
-bool
-Script_engraver::do_try_music (Music *r_l)
+void
+copy_property (Grob * g , SCM sym, SCM alist)
 {
-  if (Articulation_req *mr = dynamic_cast <Articulation_req *> (r_l))
+  if (g->internal_get_grob_property (sym) == SCM_EOL)
     {
-      for (int i=0; i < script_req_l_arr_.size(); i++) 
+      SCM entry = scm_assoc (sym,alist);
+      if (gh_pair_p (entry))
        {
-         if (script_req_l_arr_[i]->equal_b (mr))
-           return true;
+         g->internal_set_grob_property (sym, gh_cdr (entry));
        }
-      script_req_l_arr_.push (mr);
-      return true;
     }
-  return false;
 }
 
-void
-Script_engraver::do_process_music()
+
+/*
+  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. )
+ */
+void make_script_from_event (Grob *p,
+                            SCM * descr, Translator_group*tg,
+                            SCM art_type, 
+                            int index)
 {
-  for (int i=0; i < script_req_l_arr_.size(); i++)
+  SCM alist = tg->get_property ("scriptDefinitions");
+  SCM art = scm_assoc (art_type, alist);
+
+  if (art == SCM_BOOL_F)
     {
-      Articulation_req* l=script_req_l_arr_[i];
+      warning (_("Don't know how to interpret articulation:"));
+      warning (_("Scheme encoding: "));
+      scm_write (art_type, scm_current_error_port ());
+      return  ;
+    }
 
-      SCM alist = get_property ("scriptDefinitions");
-      SCM list = scm_assoc (ly_str02scm (l->articulation_str_.ch_C ()), alist);
+  art = gh_cdr (art);
+  
+  *descr = art;  
 
-      if (list == SCM_BOOL_F)
-       {
-         l->origin ()->warning (_f ("Don't know how to interpret articulation `%s'",
-                       l->articulation_str_.ch_C ()));
-         continue;
-       }
-      // todo -> use result of articulation-to-scriptdef directly as basic prop list.
-      Score_element *p =new Item (get_property ("Script"));
-      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);
-      SCM relative_stem_dir = gh_car (list);
-      list = gh_cdr(list);
 
-      SCM force_dir = l->get_mus_property ("direction");
-      if (!isdir_b (force_dir))
-       force_dir = gh_car (list);
-      list = gh_cdr(list);
-      SCM priority = gh_car (list);
+  copy_property (p, ly_symbol2scm ("script-stencil"), art);
+  copy_property (p, ly_symbol2scm ("direction"), art);
+  copy_property (p, ly_symbol2scm ("side-relative-direction"), art);
 
-      
-      if (to_dir (relative_stem_dir))
-       p->set_elt_property ("side-relative-direction", relative_stem_dir);
-      else
-       p->set_elt_property ("direction", force_dir);
+  int prio =0;
+  SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
+  if (gh_pair_p (sprio))
+    prio = gh_scm2int (gh_cdr (sprio));
 
-      /*
-       FIXME: should figure this out in relation with basic props! 
-       */
-      SCM axisprop = get_property ("scriptHorizontal");
-      bool xaxis = to_boolean (axisprop);
-      Side_position::set_axis (p, xaxis ? X_AXIS : Y_AXIS);
-      
-      if (!follow_staff && ! xaxis)
-       p->set_elt_property ("staff-support", SCM_BOOL_T);
 
-      if (!xaxis && follow_staff)
-       p->add_offset_callback (Side_position::quantised_position_proc, Y_AXIS);
-      
+  /*
+    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));
+}
+
+void
+Script_engraver::process_music ()
+{
+  for (int i=0; i < scripts_.size (); i++)
+    {
+      Music* l=scripts_[i].event_;
+
+      Grob * p = make_item ("Script");
+
+      make_script_from_event (p, &scripts_[i].description_, daddy_trans_,
+                             l->get_mus_property ("articulation-type"),
+                             i);
+
+      scripts_[i].script_ = p;
+
       
-      p->set_elt_property ("script-priority", priority);
-  
-      script_p_arr_.push (p);
+      SCM force_dir = l->get_mus_property ("direction");
+      if (is_direction (force_dir) && to_dir (force_dir))
+       p->set_grob_property ("direction", force_dir);
       
-      announce_element (p, l);
+      if (p)
+       announce_grob (p, l->self_scm());
     }
 }
 
 void
-Script_engraver::acknowledge_element (Score_element_info inf)
+Script_engraver::acknowledge_grob (Grob_info inf)
 {
-  bool them_grace = to_boolean (inf.elem_l_->get_elt_property ("grace"));
-  bool us_grace = to_boolean (get_property ("weAreGraceContext"));
-
-  if (us_grace != them_grace)
-    return;
-  
-  if (Stem::has_interface (inf.elem_l_))
+  if (Stem::has_interface (inf.grob_))
     {
-      for (int i=0; i < script_p_arr_.size(); i++)
+      for (int i=0; i < scripts_.size (); i++)
        {
-         Score_element*e = script_p_arr_[i];
+         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 ());
 
-         e->set_elt_property ("direction-source", inf.elem_l_->self_scm ());
-         Side_position::add_support (e, inf.elem_l_);
+         /*
+           add dep ? 
+          */
+         e->add_dependency (inf.grob_);
+         Side_position_interface::add_support (e, inf.grob_);
        }
     }
-  else if (Rhythmic_head::has_interface (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 < scripts_.size (); i++)
        {
-         Score_element *e = script_p_arr_[i];
+         Grob *e = scripts_[i].script_;
          
-         if (!e->parent_l (X_AXIS))
+         if (Side_position_interface::get_axis (e) == X_AXIS
+             && !e->get_parent (Y_AXIS))
            {
-             e->set_parent (inf.elem_l_, X_AXIS);
+             e->set_parent (inf.grob_, Y_AXIS);
+             e->add_dependency (inf.grob_); // ??
            }
-         if (Side_position::get_axis (e) == X_AXIS
-             && !e->parent_l (Y_AXIS))
-           e->set_parent (inf.elem_l_, Y_AXIS);
+         Side_position_interface::add_support (e,inf.grob_);
+       }
+    }
+  else if (Note_column::has_interface (inf.grob_))
+    {
+
+      /*
+       We make note column the parent of the script. That's 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++)
+       {
+         Grob *e = scripts_[i].script_;
          
-         Side_position::add_support (e,inf.elem_l_);
+         if (!e->get_parent (X_AXIS) &&
+             Side_position_interface::get_axis (e) == Y_AXIS)
+           {
+             e->set_parent (inf.grob_, X_AXIS);
+           }
        }
-    }  
+    }
 }
 
 void
-Script_engraver::do_pre_move_processing()
+Script_engraver::stop_translation_timestep ()
 {
-  for (int i=0; i < script_p_arr_.size(); i++) 
+  for (int i=0; i < scripts_.size (); i++) 
     {
-      Score_element * sc = script_p_arr_[i];
-      if (to_boolean (sc->get_elt_property ("staff-support")))
+      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)))
        {
-         Side_position::add_staff_support (sc);
+         sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
+         sc->set_grob_property ("staff-padding", SCM_EOL);
        }
-      typeset_element (sc);
+      typeset_grob (sc);
     }
-  script_p_arr_.clear();
+  scripts_.clear ();
 }
 
-void
-Script_engraver::do_post_move_processing()
-{
-  script_req_l_arr_.clear();
-}
 
-ADD_THIS_TRANSLATOR(Script_engraver);
 
+Script_engraver::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",
+/* reads */       "scriptDefinitions",
+/* write */       "");