]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/script-engraver.cc
Release: bump Welcome versions.
[lilypond.git] / lily / script-engraver.cc
index bac852ce5582402b1310f26d5e05ffaa51e018c7..1e989ae55d7800aee0e3e5ba7b5e52ab229c3cb6 100644 (file)
 /*
-  script-engraver.cc -- implement Script_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
+
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+#include "engraver.hh"
 
-#include "script.hh"
+#include "context.hh"
+#include "directional-element-interface.hh"
+#include "international.hh"
+#include "note-column.hh"
+#include "paper-column.hh"
+#include "rhythmic-head.hh"
+#include "script-interface.hh"
 #include "side-position-interface.hh"
-#include "musical-request.hh"
+#include "slur.hh"
+#include "staff-symbol-referencer.hh"
 #include "stem.hh"
-#include "rhythmic-head.hh"
-#include "engraver.hh"
+#include "stream-event.hh"
+#include "warn.hh"
 
-class Script_engraver : public Engraver {
-  Link_array<Score_element> script_p_arr_;
-  Link_array<Articulation_req> script_req_l_arr_;
+#include "translator.icc"
+
+struct Script_tuple
+{
+  Stream_event *event_;
+  Grob *script_;
+  Script_tuple ()
+  {
+    event_ = 0;
+    script_ = 0;
+  }
+};
+
+class Script_engraver : public Engraver
+{
+  vector<Script_tuple> scripts_;
 
-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);
+  void stop_translation_timestep ();
+  void process_music ();
+
+  void listen_articulation (Stream_event *);
+  void acknowledge_rhythmic_head (Grob_info);
+  void acknowledge_stem (Grob_info);
+  void acknowledge_stem_tremolo (Grob_info);
+  void acknowledge_tie (Grob_info);
+  void acknowledge_end_tie (Grob_info);
+  void acknowledge_note_column (Grob_info);
+  void acknowledge_inline_accidental (Grob_info);
+
+public:
+  TRANSLATOR_DECLARATIONS (Script_engraver);
 };
 
+Script_engraver::Script_engraver (Context *c)
+  : Engraver (c)
+{
+}
 
-Script_engraver::Script_engraver()
+void
+Script_engraver::listen_articulation (Stream_event *ev)
 {
-  do_post_move_processing();
+  /* Discard double articulations for part-combining.  */
+  for (vsize i = 0; i < scripts_.size (); i++)
+    if (ly_is_equal (scripts_[i].event_
+                     ->get_property ("articulation-type"),
+                     ev->get_property ("articulation-type")))
+      return;
+
+  Script_tuple t;
+  t.event_ = ev;
+  scripts_.push_back (t);
 }
 
-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 (scm_is_null (g->get_property (sym)))
     {
-      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);
-      return true;
+      SCM entry = scm_assoc (sym, alist);
+      if (scm_is_pair (entry))
+        g->set_property (sym, scm_cdr (entry));
     }
-  return false;
 }
 
+/* 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. ).
+*/
 void
-Script_engraver::do_process_music()
+make_script_from_event (Grob *p, Context *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 (scm_is_false (art))
     {
-      Articulation_req* l=script_req_l_arr_[i];
-
-      SCM list = scm_assoc (ly_str02scm (l->articulation_str_.ch_C ()),
-                           scm_eval2 (ly_symbol2scm ("script-alist"),
-                                      SCM_EOL));
-      
-      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 ("basicScriptProperties"));
-      Script::set_interface (p);
-
-      p->add_offset_callback (Side_position::centered_on_parent, X_AXIS);
-      
-      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
-       Side_position::set_direction (p,(Direction)force_dir);
-
-      if (l->get_direction ())
-       Side_position::set_direction (p, l->get_direction ());
-
-      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, Y_AXIS);
-      
-      
-      p->set_elt_property ("script-priority", priority);
-  
-      script_p_arr_.push (p);
-      
-      announce_element (p, l);
+      /* FIXME: */
+      warning (_ ("do not know how to interpret articulation:"));
+      warning (_ (" scheme encoding: "));
+      scm_write (art_type, scm_current_error_port ());
+      message ("");
+      return;
+    }
+
+  art = scm_cdr (art);
+
+  bool priority_found = false;
+
+  for (SCM s = art; scm_is_pair (s); s = scm_cdr (s))
+    {
+      SCM sym = scm_caar (s);
+      SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
+      if (!ly_is_procedure (type))
+        continue;
+
+      SCM val = scm_cdar (s);
+
+      if (scm_is_eq (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_from_int (prio);
+        }
+
+      SCM preset = p->get_property_data (sym);
+      if (scm_is_null (val)
+          || scm_is_false (scm_call_1 (type, preset)))
+        p->set_property (sym, val);
+    }
+
+  if (!priority_found)
+    {
+      p->set_property ("script-priority",
+                       scm_from_int (index));
     }
 }
 
 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"));
+  for (vsize i = 0; i < scripts_.size (); i++)
+    {
+      Stream_event *ev = scripts_[i].event_;
+
+      Grob *p = make_item ("Script", ev->self_scm ());
+
+      make_script_from_event (p, context (),
+                              ev->get_property ("articulation-type"),
+                              i);
+
+      scripts_[i].script_ = p;
+
+      SCM force_dir = ev->get_property ("direction");
+      if (is_direction (force_dir) && to_dir (force_dir))
+        p->set_property ("direction", force_dir);
+    }
+}
 
-  if (us_grace != them_grace)
-    return;
-  
-  if (Stem::has_interface (inf.elem_l_))
+void
+Script_engraver::acknowledge_stem (Grob_info info)
+{
+  for (vsize i = 0; i < scripts_.size (); i++)
     {
-      for (int i=0; i < script_p_arr_.size(); i++)
-       {
-         Score_element*e = script_p_arr_[i];
+      Grob *e = scripts_[i].script_;
+
+      if (to_dir (e->get_property ("side-relative-direction")))
+        e->set_object ("direction-source", info.grob ()->self_scm ());
 
-         e->set_elt_property ("direction-source", inf.elem_l_->self_scm ());
-         Side_position::add_support (e, inf.elem_l_);
-       }
+      Side_position_interface::add_support (e, info.grob ());
     }
-  else if (Rhythmic_head::has_interface (inf.elem_l_))
+}
+
+void
+Script_engraver::acknowledge_stem_tremolo (Grob_info info)
+{
+  for (vsize i = 0; i < scripts_.size (); i++)
     {
-      for (int i=0; i < script_p_arr_.size(); i++)
-       {
-         Score_element *e = script_p_arr_[i];
-         
-         if (!e->parent_l (X_AXIS))
-           {
-             e->set_parent (inf.elem_l_, X_AXIS);
-           }
-         if (Side_position::get_axis (e) == X_AXIS
-             && !e->parent_l (Y_AXIS))
-           e->set_parent (inf.elem_l_, Y_AXIS);
-         
-         Side_position::add_support (e,inf.elem_l_);
-       }
-    }  
+      Grob *e = scripts_[i].script_;
+      Side_position_interface::add_support (e, info.grob ());
+    }
 }
 
 void
-Script_engraver::do_pre_move_processing()
+Script_engraver::acknowledge_tie (Grob_info info)
 {
-  for (int i=0; i < script_p_arr_.size(); i++) 
+  for (vsize i = 0; i < scripts_.size (); i++)
     {
-      Score_element * sc = script_p_arr_[i];
-      if (to_boolean (sc->get_elt_property ("staff-support")))
-       {
-         Side_position::add_staff_support (sc);
-       }
-      typeset_element (sc);
+      Grob *e = scripts_[i].script_;
+      Side_position_interface::add_support (e, info.grob ());
     }
-  script_p_arr_.clear();
 }
 
 void
-Script_engraver::do_post_move_processing()
+Script_engraver::acknowledge_end_tie (Grob_info info)
 {
-  script_req_l_arr_.clear();
+  for (vsize i = 0; i < scripts_.size (); i++)
+    {
+      Grob *e = scripts_[i].script_;
+      Side_position_interface::add_support (e, info.grob ());
+    }
 }
 
-ADD_THIS_TRANSLATOR(Script_engraver);
+void
+Script_engraver::acknowledge_inline_accidental (Grob_info info)
+{
+  for (vsize i = 0; i < scripts_.size (); i++)
+    {
+      Grob *e = scripts_[i].script_;
+      Side_position_interface::add_support (e, info.grob ());
+    }
+}
+
+void
+Script_engraver::acknowledge_rhythmic_head (Grob_info info)
+{
+  if (info.event_cause ())
+    {
+      for (vsize i = 0; i < scripts_.size (); i++)
+        {
+          Grob *e = scripts_[i].script_;
+
+          if (Side_position_interface::get_axis (e) == X_AXIS
+              && !e->get_parent (Y_AXIS))
+            {
+              e->set_parent (info.grob (), Y_AXIS);
+            }
+          Side_position_interface::add_support (e, info.grob ());
+        }
+    }
+}
+
+void
+Script_engraver::acknowledge_note_column (Grob_info info)
+{
+  /* 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::calc_direction ().  */
+  for (vsize i = 0; i < scripts_.size (); i++)
+    {
+      Grob *e = scripts_[i].script_;
+
+      if (!e->get_parent (X_AXIS)
+          && Side_position_interface::get_axis (e) == Y_AXIS)
+        e->set_parent (info.grob (), X_AXIS);
+    }
+}
+
+void
+Script_engraver::stop_translation_timestep ()
+{
+  scripts_.clear ();
+}
+
+
+void
+Script_engraver::boot ()
+{
+  ADD_LISTENER (Script_engraver, articulation);
+  ADD_ACKNOWLEDGER (Script_engraver, rhythmic_head);
+  ADD_ACKNOWLEDGER (Script_engraver, stem);
+  ADD_ACKNOWLEDGER (Script_engraver, tie);
+  ADD_END_ACKNOWLEDGER (Script_engraver, tie);
+  ADD_ACKNOWLEDGER (Script_engraver, note_column);
+  ADD_ACKNOWLEDGER (Script_engraver, stem_tremolo);
+  ADD_ACKNOWLEDGER (Script_engraver, inline_accidental);
+}
+
+ADD_TRANSLATOR (Script_engraver,
+                /* doc */
+                "Handle note scripted articulations.",
+
+                /* create */
+                "Script ",
 
+                /* read */
+                "scriptDefinitions ",
 
+                /* write */
+                ""
+               );