]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/axis-group-engraver.cc
Issue 5167/6: Changes: show \markup xxx = ... \etc assignments
[lilypond.git] / lily / axis-group-engraver.cc
index f5266ecdd43b1836d03916ce4ebf26ddc63e9d22..d500c6ba64fea97a2f96e362143137ecd01a429e 100644 (file)
-/*   
-  axis-group-engraver.cc --  implement Axis_group_engraver
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1999--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- */
-
-#include "axis-group-engraver.hh"
-#include "spanner.hh"
-#include "paper-column.hh"
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 1999--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 "axis-group-interface.hh"
-#include "dimension-cache.hh"
-#include "engraver-group-engraver.hh"
+#include "hara-kiri-group-spanner.hh"
+#include "pointer-group-interface.hh"
+#include "context.hh"
+#include "international.hh"
+#include "spanner.hh"
+#include "warn.hh"
 
-Axis_group_engraver::Axis_group_engraver ()
+#include "translator.icc"
+
+/**
+   Put stuff in a Spanner with an Axis_group_interface.
+   Use as last element of a context.
+*/
+class Axis_group_engraver : public Engraver
+{
+protected:
+  bool active_;
+  Spanner *staffline_;
+  SCM interesting_;
+  vector<Grob *> elts_;
+  void process_music ();
+  virtual void initialize ();
+  virtual void finalize ();
+  void acknowledge_grob (Grob_info);
+  void process_acknowledged ();
+  virtual Spanner *get_spanner ();
+  virtual void add_element (Grob *);
+  virtual bool must_be_last () const;
+  virtual void derived_mark () const;
+
+public:
+  TRANSLATOR_DECLARATIONS (Axis_group_engraver);
+};
+
+
+Axis_group_engraver::Axis_group_engraver (Context *c)
+  : Engraver (c)
 {
-  staffline_p_ = 0;
+  staffline_ = 0;
+  interesting_ = SCM_EOL;
+  active_ = false;
 }
 
 void
-Axis_group_engraver::do_creation_processing ()
+Axis_group_engraver::initialize ()
 {
-  staffline_p_ = get_spanner_p ();
-  Axis_group_interface (staffline_p_).set_interface ();
-  Axis_group_interface (staffline_p_).set_axes (Y_AXIS, Y_AXIS);
-
-  Score_element *  it = unsmob_element (get_property ("currentCommandColumn"));
-  Pointer_group_interface (it, "bounded-by-me").add_element (staffline_p_);  
-  staffline_p_->set_bound(LEFT,it);
+  active_ = !to_boolean (get_property ("hasAxisGroup"));
+  if (active_)
+    context ()->set_property ("hasAxisGroup", SCM_BOOL_T);
+}
 
-  announce_element (Score_element_info (staffline_p_, 0));
+void
+Axis_group_engraver::derived_mark () const
+{
+  scm_gc_mark (interesting_);
 }
 
-Spanner*
-Axis_group_engraver::get_spanner_p () const
+
+bool
+Axis_group_engraver::must_be_last () const
 {
-  return new Spanner (get_property ("basicVerticalAxisGroupProperties"));
+  return true;
 }
 
 void
-Axis_group_engraver::do_removal_processing ()
+Axis_group_engraver::process_music ()
 {
-  String type = daddy_grav_l ()->type_str_ ;
-  SCM dims = get_property ((type  + "VerticalExtent").ch_C());
-  
-  if (gh_pair_p (dims) && gh_number_p (gh_car (dims))
-      && gh_number_p (gh_cdr (dims)))
+  if (!staffline_ && active_)
     {
-      staffline_p_->set_extent_callback (&Score_element::preset_extent, Y_AXIS);
-      staffline_p_->set_elt_property ("extent-Y", dims);
+      staffline_ = get_spanner ();
+      Grob *it = unsmob<Grob> (get_property ("currentCommandColumn"));
+      staffline_->set_bound (LEFT, it);
     }
+  interesting_ = get_property ("keepAliveInterfaces");
+}
 
-  dims = get_property ((type + "MinimumVerticalExtent").ch_C());
-  if (gh_pair_p (dims) && gh_number_p (gh_car (dims))
-      && gh_number_p (gh_cdr (dims)))
-    staffline_p_->set_elt_property ("minimum-extent-Y", dims);
-
-  dims = get_property ((type + "ExtraVerticalExtent").ch_C());
-  if (gh_pair_p (dims) && gh_number_p (gh_car (dims))
-      && gh_number_p (gh_cdr (dims)))
-    staffline_p_->set_elt_property ("extra-extent-Y", dims);
-
-Score_element *  it = unsmob_element (get_property ("currentCommandColumn"));
+Spanner *
+Axis_group_engraver::get_spanner ()
+{
+  return make_spanner ("VerticalAxisGroup", SCM_EOL);
+}
 
-  Pointer_group_interface (it, "bounded-by-me").add_element (staffline_p_);  
-  staffline_p_->set_bound(RIGHT,it);
+void
+Axis_group_engraver::finalize ()
+{
+  if (staffline_)
+    {
+      Grob *it = unsmob<Grob> (get_property ("currentCommandColumn"));
+      staffline_->set_bound (RIGHT, it);
 
-  typeset_element (staffline_p_);
-  staffline_p_ = 0;
+      Pointer_group_interface::set_ordered (staffline_, ly_symbol2scm ("elements"), false);
+    }
 }
 
 void
-Axis_group_engraver::acknowledge_element (Score_element_info i)
+Axis_group_engraver::acknowledge_grob (Grob_info i)
 {
-  elts_.push (i.elem_l_);
+  if (!staffline_)
+    return;
+
+  elts_.push_back (i.grob ());
+
+  if (to_boolean (staffline_->get_property ("remove-empty")))
+    {
+      for (SCM s = interesting_; scm_is_pair (s); s = scm_cdr (s))
+        {
+          if (i.grob ()->internal_has_interface (scm_car (s)))
+            {
+              Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob ());
+              break;
+            }
+        }
+    }
 }
 
+/*
+  maybe should check if our parent is set, because we now get a
+  cyclic parent relationship if we have two Axis_group_engravers in
+  the context.  */
 void
 Axis_group_engraver::process_acknowledged ()
 {
-  /* UGH UGH UGH */
-  for (int i=0; i < elts_.size (); i++)
-    {
-      Score_element *par = elts_[i]->parent_l (Y_AXIS);
+  if (!staffline_)
+    return;
 
-      if ((!par || !Axis_group_interface (par).has_interface_b ())
-         && ! elts_[i]->empty_b (Y_AXIS))
-       Axis_group_interface (staffline_p_).add_element (elts_[i]);
+  for (vsize i = 0; i < elts_.size (); i++)
+    {
+      if (!unsmob<Grob> (elts_[i]->get_object ("axis-group-parent-Y")))
+        {
+          if (staffline_->get_parent (Y_AXIS)
+              && staffline_->get_parent (Y_AXIS) == elts_[i])
+            {
+              staffline_->warning (_ ("Axis_group_engraver: vertical group already has a parent"));
+              staffline_->warning (_ ("are there two Axis_group_engravers?"));
+              staffline_->warning (_ ("removing this vertical group"));
+              staffline_->suicide ();
+              staffline_ = 0;
+              break;
+            }
+          add_element (elts_[i]);
+        }
     }
   elts_.clear ();
 }
 
-ADD_THIS_TRANSLATOR(Axis_group_engraver);
+void
+Axis_group_engraver::add_element (Grob *e)
+{
+  Axis_group_interface::add_element (staffline_, e);
+}
+
+
+void
+Axis_group_engraver::boot ()
+{
+  ADD_ACKNOWLEDGER (Axis_group_engraver, grob);
+}
+
+ADD_TRANSLATOR (Axis_group_engraver,
+                /* doc */
+                "Group all objects created in this context in a"
+                " @code{VerticalAxisGroup} spanner.",
+
+                /* create */
+                "VerticalAxisGroup ",
+
+                /* read */
+                "currentCommandColumn "
+                "keepAliveInterfaces "
+                "hasAxisGroup ",
+                
+                /* write */
+                "hasAxisGroup "
+               );