]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-symbol-engraver.cc
Import guile-1.8 as multiple upstream tarball component
[lilypond.git] / lily / staff-symbol-engraver.cc
index 4bed0bf75264e00da63edfe0fbd094aa1f2112c9..1ca6a4dce1f57ad256f472bba2c0eda6a960a602 100644 (file)
 /*
-  staff-sym-reg.cc -- implement Staff_symbol_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.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 "staff-symbol.hh"
-#include "score.hh"
-#include "paper-column.hh"
-#include "paper-def.hh"
-#include "side-position-interface.hh"
 #include "engraver.hh"
-#include "moment.hh"
+#include "international.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
+#include "warn.hh"
 
-/**
-  Manage the staff symbol.
- */
-class Staff_symbol_engraver : public Engraver { 
-  Staff_symbol *span_p_;
+#include "translator.icc"
+
+class Staff_symbol_engraver : public Engraver
+{
 public:
-  VIRTUAL_COPY_CONS(Translator);
-  Staff_symbol_engraver();
-  
+  TRANSLATOR_DECLARATIONS (Staff_symbol_engraver);
+
 protected:
-  virtual ~Staff_symbol_engraver();
+  Drul_array<Stream_event *> span_events_;
+  Spanner *span_;
+  Spanner *finished_span_;
+  bool first_start_;
 
-  virtual void acknowledge_element (Score_element_info);
-  virtual void do_removal_processing();
-  virtual void do_creation_processing();
-       
+protected:
+  virtual void start_spanner ();
+  virtual void stop_spanner ();
+
+  void stop_translation_timestep ();
+  virtual ~Staff_symbol_engraver ();
+  DECLARE_ACKNOWLEDGER (grob);
+  DECLARE_TRANSLATOR_LISTENER (staff_span);
+  virtual void finalize ();
+  void process_music ();
+  virtual void derived_mark () const;
 };
 
+void
+Staff_symbol_engraver::derived_mark () const
+{
+  for (LEFT_and_RIGHT (d))
+    {
+      if (span_events_[d])
+        scm_gc_mark (span_events_[d]->self_scm ());
+    }
+}
+
+Staff_symbol_engraver::~Staff_symbol_engraver ()
+{
+  if (span_)
+    {
+      // Somehow finalize() was not called?
+      programming_error ("Have a pending spanner in destructor.");
+    }
+}
 
-Staff_symbol_engraver::~Staff_symbol_engraver()
+Staff_symbol_engraver::Staff_symbol_engraver ()
 {
-  assert (!span_p_);
+  finished_span_ = 0;
+  first_start_ = true;
+  span_ = 0;
+  span_events_.set (0, 0);
 }
 
-Staff_symbol_engraver::Staff_symbol_engraver()
+IMPLEMENT_TRANSLATOR_LISTENER (Staff_symbol_engraver, staff_span);
+void
+Staff_symbol_engraver::listen_staff_span (Stream_event *ev)
 {
-  span_p_ = 0;
+  Direction d = to_dir (ev->get_property ("span-direction"));
+  if (d)
+    ASSIGN_EVENT_ONCE (span_events_[d], ev);
+  else
+    programming_error ("staff-span event has no direction");
 }
 
 void
-Staff_symbol_engraver::do_creation_processing()
+Staff_symbol_engraver::process_music ()
 {
-  span_p_ = new Staff_symbol;
-  span_p_->set_bound(LEFT,get_staff_info().command_pcol_l ());
-  announce_element (Score_element_info (span_p_, 0));
+  if (span_events_[STOP])
+    {
+      finished_span_ = span_;
+      span_ = 0;
+      if (first_start_)
+        first_start_ = false;
+    }
+
+  if (span_events_[START]
+      || (first_start_ && !span_events_[STOP]))
+    start_spanner ();
 }
 
 void
-Staff_symbol_engraver::do_removal_processing()
+Staff_symbol_engraver::start_spanner ()
 {
-  SCM n = get_property ("numberOfStaffLines");
-  SCM ss = get_property ("staffSpace");
+  if (!span_)
+    {
+      span_ = make_spanner ("StaffSymbol", SCM_EOL);
+      span_->set_bound (LEFT,
+                        unsmob_grob (get_property ("currentCommandColumn")));
+    }
+}
 
-  if (gh_number_p (ss))
-    span_p_->set_elt_property ("staff-space", ss);
-  if (gh_number_p (n))
-    span_p_->set_elt_property ("line-count", n);
+void
+Staff_symbol_engraver::stop_spanner ()
+{
+  if (!finished_span_)
+    return;
 
-  span_p_->set_bound(RIGHT,get_staff_info().command_pcol_l ());
-  typeset_element (span_p_);
-  span_p_ =0;
+  if (!finished_span_->get_bound (RIGHT))
+    finished_span_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
+
+  announce_end_grob (finished_span_,
+                     span_events_[STOP]
+                     ? span_events_[STOP]->self_scm ()
+                     : SCM_EOL);
+
+  finished_span_ = 0;
+}
+
+void
+Staff_symbol_engraver::stop_translation_timestep ()
+{
+  if ((span_events_[START] || first_start_)
+      && span_)
+    first_start_ = false;
+
+  span_events_.set (0, 0);
+  stop_spanner ();
 }
 
 void
-Staff_symbol_engraver::acknowledge_element (Score_element_info s)
+Staff_symbol_engraver::finalize ()
 {
-  s.elem_l_->set_elt_property ("staff-symbol", span_p_->self_scm_);
-  s.elem_l_->add_dependency (span_p_); // UGH. UGH. UGH 
+  finished_span_ = span_;
+  span_ = 0;
+  stop_spanner ();
 }
 
+/*
+  Todo: staff-symbol-referencer iface.
+*/
+void
+Staff_symbol_engraver::acknowledge_grob (Grob_info s)
+{
+  if (span_ || finished_span_)
+    {
+      Spanner *my = span_ ? span_ : finished_span_;
+      s.grob ()->set_object ("staff-symbol", my->self_scm ());
+    }
+}
+
+ADD_ACKNOWLEDGER (Staff_symbol_engraver, grob);
+
+ADD_TRANSLATOR (Staff_symbol_engraver,
+                /* doc */
+                "Create the constellation of five (default) staff lines.",
+
+                /* create */
+                "StaffSymbol ",
 
-ADD_THIS_TRANSLATOR(Staff_symbol_engraver);
+                /* read */
+                "",
 
+                /* write */
+                ""
+               );