Doc-es: various updates.

[lilypond.git] / lily / part-combine-engraver.cc

diff --git a/lily/part-combine-engraver.cc b/lily/part-combine-engraver.cc
index be9564685d2007314ab115236d45b3a7e2f515bb..9646d7a355a6a46bdf6c6bcb12b36614d9f904b8 100644 (file)
--- a/lily/part-combine-engraver.cc
+++ b/lily/part-combine-engraver.cc
@@ -1,15 +1,25 @@
 /*
-  part-combine-engraver.cc -- implement PC-engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 2000--2008 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>
 
   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 "multi-measure-rest.hh"
 #include "note-head.hh"
 #include "side-position-interface.hh"
 #include "stem.hh"
@@ -24,50 +34,77 @@ class Part_combine_engraver : public Engraver
   TRANSLATOR_DECLARATIONS (Part_combine_engraver);
 
 protected:
-  DECLARE_ACKNOWLEDGER (note_head);
-  DECLARE_ACKNOWLEDGER (stem);
+  void acknowledge_note_head (Grob_info);
+  void acknowledge_stem (Grob_info);
 
-  DECLARE_TRANSLATOR_LISTENER (part_combine);
+  void listen_part_combine (Stream_event *);
+  void listen_note (Stream_event *);
   void process_music ();
   void stop_translation_timestep ();
+  void create_item (Stream_event *ev);
+
 private:
   Item *text_;
-  Stream_event *event_;
+  Stream_event *new_event_; // Event happened at this moment
+  bool note_found_;
+  // Event possibly from an earlier moment waiting to create a text:
+  Stream_event *waiting_event_;
 };
 
-IMPLEMENT_TRANSLATOR_LISTENER (Part_combine_engraver, part_combine);
 void
 Part_combine_engraver::listen_part_combine (Stream_event *ev)
 {
-  ASSIGN_EVENT_ONCE (event_, ev);
+  ASSIGN_EVENT_ONCE (new_event_, ev);
+  // If two events occur at the same moment, discard the second as the
+  // warning indicates:
+  waiting_event_ = new_event_;
 }
 
-Part_combine_engraver::Part_combine_engraver ()
+void
+Part_combine_engraver::listen_note (Stream_event *)
+{
+  note_found_ = true;
+}
+
+Part_combine_engraver::Part_combine_engraver (Context *c)
+  : Engraver (c)
 {
   text_ = 0;
-  event_ = 0;
+  new_event_ = 0;
+  waiting_event_ = 0;
+  note_found_ = false;
+}
+
+void
+Part_combine_engraver::create_item (Stream_event *ev)
+{
+  SCM what = scm_car (ev->get_property ("class"));
+  SCM text = SCM_EOL;
+  if (scm_is_eq (what, ly_symbol2scm ("solo-one-event")))
+    text = get_property ("soloText");
+  else if (scm_is_eq (what, ly_symbol2scm ("solo-two-event")))
+    text = get_property ("soloIIText");
+  else if (scm_is_eq (what, ly_symbol2scm ("unisono-event")))
+    text = get_property ("aDueText");
+
+  if (Text_interface::is_markup (text))
+    {
+      text_ = make_item ("CombineTextScript", ev->self_scm ());
+      text_->set_property ("text", text);
+    }
 }
 
 void
 Part_combine_engraver::process_music ()
 {
-  if (event_
+  if (waiting_event_
       && to_boolean (get_property ("printPartCombineTexts")))
     {
-      SCM what = event_->get_property ("class");
-      SCM text = SCM_EOL;
-      if (what == ly_symbol2scm ("solo-one-event"))
-       text = get_property ("soloText");
-      else if (what == ly_symbol2scm ("solo-two-event"))
-       text = get_property ("soloIIText");
-      else if (what == ly_symbol2scm ("unisono-event"))
-       text = get_property ("aDueText");
-
-      if (Text_interface::is_markup (text))
-       {
-         text_ = make_item ("CombineTextScript", event_->self_scm ());
-         text_->set_property ("text", text);
-       }
+      if (note_found_ || !to_boolean (get_property ("partCombineTextsOnNote")))
+        {
+          create_item (waiting_event_);
+          waiting_event_ = 0;
+        }
     }
 }
 
@@ -79,8 +116,8 @@ Part_combine_engraver::acknowledge_note_head (Grob_info i)
       Grob *t = text_;
       Side_position_interface::add_support (t, i.grob ());
       if (Side_position_interface::get_axis (t) == X_AXIS
-         && !t->get_parent (Y_AXIS))
-       t->set_parent (i.grob (), Y_AXIS);
+          && !t->get_parent (Y_AXIS))
+        t->set_parent (i.grob (), Y_AXIS);
     }
 }
 
@@ -95,25 +132,34 @@ void
 Part_combine_engraver::stop_translation_timestep ()
 {
   text_ = 0;
-  event_ = 0;
+  new_event_ = 0;
+  note_found_ = false;
+}
+
+void
+Part_combine_engraver::boot ()
+{
+  ADD_LISTENER (Part_combine_engraver, part_combine);
+  ADD_LISTENER (Part_combine_engraver, note);
+  ADD_ACKNOWLEDGER (Part_combine_engraver, note_head);
+  ADD_ACKNOWLEDGER (Part_combine_engraver, stem);
 }
 
-ADD_ACKNOWLEDGER (Part_combine_engraver, note_head);
-ADD_ACKNOWLEDGER (Part_combine_engraver, stem);
 ADD_TRANSLATOR (Part_combine_engraver,
-               /* doc */
-               "Part combine engraver for orchestral scores: Print markings"
-               " @q{a2}, @q{Solo}, @q{Solo II}, and @q{unisono}.",
-
-               /* create */
-               "CombineTextScript ",
-
-               /* read */
-               "printPartCombineTexts "
-               "soloText "
-               "soloIIText "
-               "aDueText ",
-
-               /* write */
-               ""
-               );
+                /* doc */
+                "Part combine engraver for orchestral scores: Print markings"
+                " @q{a2}, @q{Solo}, @q{Solo II}, and @q{unisono}.",
+
+                /* create */
+                "CombineTextScript ",
+
+                /* read */
+                "printPartCombineTexts "
+                "partCombineTextsOnNote "
+                "soloText "
+                "soloIIText "
+                "aDueText ",
+
+                /* write */
+                ""
+               );