]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/axis-group-engraver.cc
Web-ja: update introduction
[lilypond.git] / lily / axis-group-engraver.cc
index 2796f05ca4272ac18134954e6fea6c42ec9ea4b3..d500c6ba64fea97a2f96e362143137ecd01a429e 100644 (file)
@@ -1,35 +1,99 @@
 /*
-  axis-group-engraver.cc -- implement Axis_group_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1999--2005 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 "axis-group-engraver.hh"
+#include "engraver.hh"
 
-#include "spanner.hh"
 #include "axis-group-interface.hh"
-#include "warn.hh"
+#include "hara-kiri-group-spanner.hh"
+#include "pointer-group-interface.hh"
 #include "context.hh"
+#include "international.hh"
+#include "spanner.hh"
+#include "warn.hh"
 
 #include "translator.icc"
 
-Axis_group_engraver::Axis_group_engraver ()
+/**
+   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)
 {
-  must_be_last_ = true;
   staffline_ = 0;
+  interesting_ = SCM_EOL;
+  active_ = false;
+}
+
+void
+Axis_group_engraver::initialize ()
+{
+  active_ = !to_boolean (get_property ("hasAxisGroup"));
+  if (active_)
+    context ()->set_property ("hasAxisGroup", SCM_BOOL_T);
+}
+
+void
+Axis_group_engraver::derived_mark () const
+{
+  scm_gc_mark (interesting_);
+}
+
+
+bool
+Axis_group_engraver::must_be_last () const
+{
+  return true;
 }
 
 void
 Axis_group_engraver::process_music ()
 {
-  if (!staffline_)
+  if (!staffline_ && active_)
     {
       staffline_ = get_spanner ();
-      Grob *it = unsmob_grob (get_property ("currentCommandColumn"));
+      Grob *it = unsmob<Grob> (get_property ("currentCommandColumn"));
       staffline_->set_bound (LEFT, it);
     }
+  interesting_ = get_property ("keepAliveInterfaces");
 }
 
 Spanner *
@@ -38,24 +102,37 @@ Axis_group_engraver::get_spanner ()
   return make_spanner ("VerticalAxisGroup", SCM_EOL);
 }
 
-/*
-  TODO: should we junk minimumVerticalExtent/extraVerticalExtent ?
-*/
-
 void
 Axis_group_engraver::finalize ()
 {
   if (staffline_)
     {
-      Grob *it = unsmob_grob (get_property ("currentCommandColumn"));
+      Grob *it = unsmob<Grob> (get_property ("currentCommandColumn"));
       staffline_->set_bound (RIGHT, it);
+
+      Pointer_group_interface::set_ordered (staffline_, ly_symbol2scm ("elements"), false);
     }
 }
 
 void
 Axis_group_engraver::acknowledge_grob (Grob_info i)
 {
-  elts_.push (i.grob ());
+  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;
+            }
+        }
+    }
 }
 
 /*
@@ -68,34 +145,22 @@ Axis_group_engraver::process_acknowledged ()
   if (!staffline_)
     return;
 
-  for (int i = 0; i < elts_.size (); 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;
-           }
-#if 0 
-         else if (elts_[i]->is_empty (Y_AXIS))
-           {
-             /*
-               We have to do _something_, otherwise staff objects will
-               end up with System as parent.
-
-             */
-             elts_[i]->set_parent (staffline_, Y_AXIS);
-           }
-         else
-#endif
-           add_element (elts_[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 ();
 }
@@ -106,11 +171,26 @@ Axis_group_engraver::add_element (Grob *e)
   Axis_group_interface::add_element (staffline_, e);
 }
 
-ADD_ACKNOWLEDGER (Axis_group_engraver, grob);
+
+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 VerticalAxisGroup spanner.",
-               /* create */ "VerticalAxisGroup",
-               /* accept */ "",
-               /* read */ "verticalExtent minimumVerticalExtent extraVerticalExtent",
-               /* write */ "");
+                /* doc */
+                "Group all objects created in this context in a"
+                " @code{VerticalAxisGroup} spanner.",
+
+                /* create */
+                "VerticalAxisGroup ",
+
+                /* read */
+                "currentCommandColumn "
+                "keepAliveInterfaces "
+                "hasAxisGroup ",
+                
+                /* write */
+                "hasAxisGroup "
+               );