]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/script-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / script-engraver.cc
index e25405b7328dc84122f2f369f366fb166c379817..1e989ae55d7800aee0e3e5ba7b5e52ab229c3cb6 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  script-engraver.cc -- engrave Scripts: Articulations.
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2006 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"
@@ -43,30 +54,32 @@ protected:
   void stop_translation_timestep ();
   void process_music ();
 
-  DECLARE_TRANSLATOR_LISTENER (articulation);
-  DECLARE_ACKNOWLEDGER (rhythmic_head);
-  DECLARE_ACKNOWLEDGER (stem);
-  DECLARE_ACKNOWLEDGER (stem_tremolo);
-  DECLARE_ACKNOWLEDGER (note_column);
+  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 ()
+Script_engraver::Script_engraver (Context *c)
+  : Engraver (c)
 {
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Script_engraver, articulation);
 void
 Script_engraver::listen_articulation (Stream_event *ev)
 {
   /* Discard double articulations for part-combining.  */
-  int script_count = scripts_.size ();
-  for (int i = 0; i < script_count; i++)
+  for (vsize i = 0; i < scripts_.size (); i++)
     if (ly_is_equal (scripts_[i].event_
-                    ->get_property ("articulation-type"),
-                    ev->get_property ("articulation-type")))
+                     ->get_property ("articulation-type"),
+                     ev->get_property ("articulation-type")))
       return;
 
   Script_tuple t;
@@ -77,11 +90,11 @@ Script_engraver::listen_articulation (Stream_event *ev)
 void
 copy_property (Grob *g, SCM sym, SCM alist)
 {
-  if (g->internal_get_property (sym) == SCM_EOL)
+  if (scm_is_null (g->get_property (sym)))
     {
       SCM entry = scm_assoc (sym, alist);
       if (scm_is_pair (entry))
-       g->set_property (sym, scm_cdr (entry));
+        g->set_property (sym, scm_cdr (entry));
     }
 }
 
@@ -90,17 +103,17 @@ copy_property (Grob *g, SCM sym, SCM alist)
    ScriptStaccato , ScriptMarcato, etc. ).
 */
 void
-make_script_from_event (Grob *p,  Context *tg,
-                       SCM art_type, int index)
+make_script_from_event (Grob *p, 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)
+  if (scm_is_false (art))
     {
       /* FIXME: */
-      warning (_ ("don't know how to interpret articulation: "));
-      warning (_ ("scheme encoding: "));
+      warning (_ ("do not know how to interpret articulation:"));
+      warning (_ (" scheme encoding: "));
       scm_write (art_type, scm_current_error_port ());
       message ("");
       return;
@@ -115,34 +128,32 @@ make_script_from_event (Grob *p,  Context *tg,
       SCM sym = scm_caar (s);
       SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
       if (!ly_is_procedure (type))
-       continue;
+        continue;
 
       SCM val = scm_cdar (s);
 
-      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;
+      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);
-       }
+          val = scm_from_int (prio);
+        }
 
       SCM preset = p->get_property_data (sym);
-      if (val == SCM_EOL
-         || scm_call_1 (type, preset) == SCM_BOOL_F)
-       p->set_property (sym, val);
+      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));
+                       scm_from_int (index));
     }
-
-  Side_position_interface::set_axis (p, Y_AXIS);
 }
 
 void
@@ -155,27 +166,26 @@ Script_engraver::process_music ()
       Grob *p = make_item ("Script", ev->self_scm ());
 
       make_script_from_event (p, context (),
-                             ev->get_property ("articulation-type"),
-                             i);
+                              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);
+        p->set_property ("direction", force_dir);
     }
 }
 
 void
 Script_engraver::acknowledge_stem (Grob_info info)
 {
-  int script_count = scripts_.size ();
-  for (int i = 0; i < script_count; i++)
+  for (vsize i = 0; i < scripts_.size (); 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_object ("direction-source", info.grob ()->self_scm ());
 
       Side_position_interface::add_support (e, info.grob ());
     }
@@ -184,14 +194,42 @@ Script_engraver::acknowledge_stem (Grob_info info)
 void
 Script_engraver::acknowledge_stem_tremolo (Grob_info info)
 {
-  int script_count = scripts_.size ();
-  for (int i = 0; i < script_count; i++)
+  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_tie (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_end_tie (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_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)
@@ -199,16 +237,16 @@ 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 ());
-       }
+        {
+          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 ());
+        }
     }
 }
 
@@ -226,8 +264,8 @@ Script_engraver::acknowledge_note_column (Grob_info info)
       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);
+          && Side_position_interface::get_axis (e) == Y_AXIS)
+        e->set_parent (info.grob (), X_AXIS);
     }
 }
 
@@ -237,14 +275,30 @@ Script_engraver::stop_translation_timestep ()
   scripts_.clear ();
 }
 
-ADD_ACKNOWLEDGER (Script_engraver, rhythmic_head);
-ADD_ACKNOWLEDGER (Script_engraver, stem);
-ADD_ACKNOWLEDGER (Script_engraver, note_column);
-ADD_ACKNOWLEDGER (Script_engraver, stem_tremolo);
+
+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 */ "Handles note scripted articulations.",
-               /* create */ "Script",
-               /* accept */ "script-event articulation-event",
-               /* read */ "scriptDefinitions",
-               /* write */ "");
+                /* doc */
+                "Handle note scripted articulations.",
+
+                /* create */
+                "Script ",
+
+                /* read */
+                "scriptDefinitions ",
+
+                /* write */
+                ""
+               );