]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/axis-group-engraver.cc
Run grand replace for 2015.
[lilypond.git] / lily / axis-group-engraver.cc
index ee07b86f456bdbeb236083e5903e516da77917a4..adc0dae661b92979156be727c5fc14c6a80a6ad5 100644 (file)
-/*   
-  axis-group-engraver.cc --  implement Axis_group_engraver
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- */
+/*
+  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 "spanner.hh"
-#include "paper-column.hh"
-#include "axis-group-interface.hh"
 #include "engraver.hh"
-#include "engraver-group-engraver.hh"
-#include "warn.hh"
+
+#include "axis-group-interface.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"
 
 /**
    Put stuff in a Spanner with an Axis_group_interface.
-   Use as last element of a context. 
- */
+   Use as last element of a context.
+*/
 class Axis_group_engraver : public Engraver
 {
 protected:
+  bool active_;
   Spanner *staffline_;
-  Link_array<Grob> elts_;
-  virtual void process_music ();
+  SCM interesting_;
+  vector<Grob *> elts_;
+  void process_music ();
+  virtual void initialize ();
   virtual void finalize ();
-  virtual void acknowledge_grob (Grob_info);
-  virtual void process_acknowledged_grobs ();
-  virtual Spanner* get_spanner () ;
-  virtual void add_element (Grob*) ;
-public:  
-  TRANSLATOR_DECLARATIONS(Axis_group_engraver);
+  DECLARE_ACKNOWLEDGER (grob);
+  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 ()
 {
   staffline_ = 0;
+  interesting_ = SCM_EOL;
+  active_ = false;
 }
 
 void
-Axis_group_engraver::process_music ()
+Axis_group_engraver::initialize ()
 {
-  if (!staffline_)
-    {
-      staffline_ = get_spanner ();
+  active_ = !to_boolean (get_property ("hasAxisGroup"));
+  if (active_)
+    context ()->set_property ("hasAxisGroup", SCM_BOOL_T);
+}
 
-      Grob *  it = unsmob_grob (get_property ("currentCommandColumn"));
+void
+Axis_group_engraver::derived_mark () const
+{
+  scm_gc_mark (interesting_);
+}
 
-      staffline_->set_bound (LEFT,it);
 
-      announce_grob(staffline_, SCM_EOL);
-    }
-} 
+bool
+Axis_group_engraver::must_be_last () const
+{
+  return true;
+}
 
-Spanner*
-Axis_group_engraver::get_spanner () 
+void
+Axis_group_engraver::process_music ()
 {
-  return make_spanner ("VerticalAxisGroup");
+  if (!staffline_ && active_)
+    {
+      staffline_ = get_spanner ();
+      Grob *it = Grob::unsmob (get_property ("currentCommandColumn"));
+      staffline_->set_bound (LEFT, it);
+    }
+  interesting_ = get_property ("keepAliveInterfaces");
 }
 
-/*
-  TODO: should we junk minimumVerticalExtent/extraVerticalExtent ?  
- */
+Spanner *
+Axis_group_engraver::get_spanner ()
+{
+  return make_spanner ("VerticalAxisGroup", SCM_EOL);
+}
 
 void
 Axis_group_engraver::finalize ()
 {
-  if (!staffline_)
-    return ;
-  
-  String type = daddy_context_->context_name ();
-  SCM dims = get_property ("verticalExtent");
-  
-  if (is_number_pair (dims))
-    staffline_->set_extent (dims, Y_AXIS);
-
-  dims = get_property ("minimumVerticalExtent");
-  if (is_number_pair (dims) )
-    staffline_->set_property ("minimum-Y-extent", dims);
-
-  dims = get_property ("extraVerticalExtent");
-  if (is_number_pair (dims))
-    staffline_->set_property ("extra-Y-extent", dims);
-
-  Grob *  it = unsmob_grob (get_property ("currentCommandColumn"));
-
-  staffline_->set_bound (RIGHT,it);
+  if (staffline_)
+    {
+      Grob *it = Grob::unsmob (get_property ("currentCommandColumn"));
+      staffline_->set_bound (RIGHT, it);
 
-  typeset_grob (staffline_);
-  staffline_ = 0;
+      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_)
+    elts_.push_back (i.grob ());
+
+  if (staffline_ && 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 ());
+        }
+    }
 }
 
 /*
@@ -102,102 +134,52 @@ Axis_group_engraver::acknowledge_grob (Grob_info i)
   cyclic parent relationship if we have two Axis_group_engravers in
   the context.  */
 void
-Axis_group_engraver::process_acknowledged_grobs ()
+Axis_group_engraver::process_acknowledged ()
 {
-  /* UGH UGH UGH */
-  for (int i=0; i < elts_.size (); i++)
+  if (!staffline_)
+    return;
+
+  for (vsize i = 0; i < elts_.size (); i++)
     {
-      Grob *par = elts_[i]->get_parent (Y_AXIS);
-
-      if (!par || !Axis_group_interface::has_interface (par))
-       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
-         add_element (elts_[i]);
+      if (!Grob::is_smob (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 ();
 }
 
 void
-Axis_group_engraver::add_element (Grob*e)
+Axis_group_engraver::add_element (Grob *e)
 {
   Axis_group_interface::add_element (staffline_, e);
 }
 
-/****************************************************************/
-
-/*
-  
- maybenot such a good idea after all., to put class declarations in
- .cc
-*/
-
-#include "hara-kiri-group-spanner.hh"
-#include "rhythmic-head.hh"
-
-class Hara_kiri_engraver : public Axis_group_engraver
-{
-protected:
-  virtual Spanner*get_spanner ();
-  virtual void acknowledge_grob (Grob_info);
-  virtual void add_element (Grob *e);
-public:
-  TRANSLATOR_DECLARATIONS(Hara_kiri_engraver);
-};
-
-void
-Hara_kiri_engraver::add_element (Grob*e)
-{
-  Hara_kiri_group_spanner::add_element (staffline_, e);
-}
-
+ADD_ACKNOWLEDGER (Axis_group_engraver, grob);
 
-Spanner*
-Hara_kiri_engraver::get_spanner () 
-{
-  Spanner * sp = make_spanner ("RemoveEmptyVerticalGroup");
-  
-  return sp;
-}
+ADD_TRANSLATOR (Axis_group_engraver,
+                /* doc */
+                "Group all objects created in this context in a"
+                " @code{VerticalAxisGroup} spanner.",
 
-void
-Hara_kiri_engraver::acknowledge_grob (Grob_info i)
-{
-  Axis_group_engraver::acknowledge_grob (i);
-  if (i.grob_->internal_has_interface (ly_symbol2scm ("rhythmic-grob-interface"))
-      || i.grob_->internal_has_interface (ly_symbol2scm ("lyric-interface"))
-      )
-    {
-      Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob_);
-    }
-}
-
-
-Hara_kiri_engraver::Hara_kiri_engraver()
-{
-}
+                /* create */
+                "VerticalAxisGroup ",
 
-ENTER_DESCRIPTION(Hara_kiri_engraver,
-/* descr */       "Like Axis_group_engraver, but make a hara-kiri spanner, and add "
-"interesting items (ie. note heads, lyric syllables and normal rests) ",
-/* creats*/       "RemoveEmptyVerticalGroup",
-/* accepts */     "",
-/* acks  */      "grob-interface",
-/* reads */       "",
-/* write */       "");
-
-ENTER_DESCRIPTION(Axis_group_engraver,
-/* descr */       "Group all objects created in this context in a VerticalAxisGroup spanner.",
-/* creats*/       "VerticalAxisGroup",
-/* accepts */     "",
-/* acks  */      "grob-interface",
-/* reads */       "verticalExtent minimumVerticalExtent extraVerticalExtent",
-/* write */       "");
+                /* read */
+                "currentCommandColumn "
+                "keepAliveInterfaces "
+                "hasAxisGroup ",
+                
+                /* write */
+                "hasAxisGroup "
+               );