]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/axis-group-engraver.cc
remove TEXMF from variables.
[lilypond.git] / lily / axis-group-engraver.cc
index ef031b322953df93a43bfbf426f72c3efe04d5db..946914e6555de1d38efbde77fcbff1fe263d835d 100644 (file)
-/*   
-  axis-group-engraver.cc --  implement Axis_group_engraver
-  
+/*
+  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>
- */
+
+  (c) 1999--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+*/
 
 #include "spanner.hh"
 #include "paper-column.hh"
 #include "axis-group-interface.hh"
-#include "engraver.hh"
 #include "engraver-group-engraver.hh"
+#include "warn.hh"
+#include "context.hh"
 
 /**
    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:
-  Spanner *staffline_p_;
-  Link_array<Score_element> elts_;
-  virtual void do_creation_processing();
-  virtual void do_removal_processing();
-  virtual void acknowledge_element (Score_element_info);
-  virtual void process_acknowledged ();
-  virtual Spanner* get_spanner_p () const;
-  virtual void add_element (Score_element*) ;
-public:  
-  VIRTUAL_COPY_CONS(Translator);
-  Axis_group_engraver ();
+  Spanner *staffline_;
+  Link_array<Grob> elts_;
+  virtual void process_music ();
+  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);
 };
 
-ADD_THIS_TRANSLATOR(Axis_group_engraver);
-
 Axis_group_engraver::Axis_group_engraver ()
 {
-  staffline_p_ = 0;
+  must_be_last_ = true;
+  staffline_ = 0;
 }
 
 void
-Axis_group_engraver::do_creation_processing ()
+Axis_group_engraver::process_music ()
 {
-  staffline_p_ = get_spanner_p ();
-  Axis_group_interface::set_interface (staffline_p_);
-  Axis_group_interface::set_axes (staffline_p_, Y_AXIS, Y_AXIS);
-
-  Score_element *  it = unsmob_element (get_property ("currentCommandColumn"));
-
-  staffline_p_->set_bound(LEFT,it);
-
-  announce_element (staffline_p_, 0);
+  if (!staffline_)
+    {
+      staffline_ = get_spanner ();
+      Grob *it = unsmob_grob (get_property ("currentCommandColumn"));
+      staffline_->set_bound (LEFT, it);
+    }
 }
 
-Spanner*
-Axis_group_engraver::get_spanner_p () const
+Spanner *
+Axis_group_engraver::get_spanner ()
 {
-  return new Spanner (get_property ("basicVerticalAxisGroupProperties"));
+  return make_spanner ("VerticalAxisGroup", SCM_EOL);
 }
 
+/*
+  TODO: should we junk minimumVerticalExtent/extraVerticalExtent ?
+*/
+
 void
-Axis_group_engraver::do_removal_processing ()
+Axis_group_engraver::finalize ()
 {
-  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)))
-    {
-      staffline_p_->set_extent_callback (&Score_element::preset_extent, Y_AXIS);
-      staffline_p_->set_elt_property ("extent-Y", dims);
-    }
+  if (!staffline_)
+    return;
+
+  String type = context ()->context_name ();
+  SCM dims = get_property ("verticalExtent");
 
-  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);
+  if (is_number_pair (dims))
+    staffline_->set_extent (dims, Y_AXIS);
 
-  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);
+  dims = get_property ("minimumVerticalExtent");
+  if (is_number_pair (dims))
+    staffline_->set_property ("minimum-Y-extent", dims);
 
-  Score_element *  it = unsmob_element (get_property ("currentCommandColumn"));
+  dims = get_property ("extraVerticalExtent");
+  if (is_number_pair (dims))
+    staffline_->set_property ("extra-Y-extent", dims);
 
+  Grob *it = unsmob_grob (get_property ("currentCommandColumn"));
 
-  staffline_p_->set_bound(RIGHT,it);
+  staffline_->set_bound (RIGHT, it);
 
-  typeset_element (staffline_p_);
-  staffline_p_ = 0;
+  staffline_ = 0;
 }
 
 void
-Axis_group_engraver::acknowledge_element (Score_element_info i)
+Axis_group_engraver::acknowledge_grob (Grob_info i)
 {
-  elts_.push (i.elem_l_);
+  elts_.push (i.grob_);
 }
 
 /*
-  maybe should check if our parent_l is set, because we now get a
+  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 ()
+Axis_group_engraver::process_acknowledged_grobs ()
 {
-  /* 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::has_interface (par))
-         && ! elts_[i]->empty_b (Y_AXIS))
-       add_element (elts_[i]);
+  for (int i = 0; i < elts_.size (); i++)
+    {
+      if (!unsmob_grob (elts_[i]->get_property ("axis-group-parent-Y")))
+       {
+         if (staffline_->get_parent (Y_AXIS)
+             && staffline_->get_parent (Y_AXIS) == elts_[i])
+           {
+             String msg = _ ("Axis_group_engraver: vertical group already has a parent.\n"
+                             "Do you have two Axis_group_engravers?\n"
+                             "Killing this vertical group.");
+             staffline_->warning (msg);
+             staffline_->suicide ();
+             staffline_ = 0;
+             break;
+           }
+         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
+           add_element (elts_[i]);
+       }
     }
   elts_.clear ();
 }
 
 void
-Axis_group_engraver::add_element (Score_element*e)
+Axis_group_engraver::add_element (Grob *e)
 {
-  Axis_group_interface::add_element (staffline_p_, e);
+  Axis_group_interface::add_element (staffline_, e);
 }
 
-////////////////////////////////////////////////////////
-// maybenot such a good idea after all., to put classes in .cc
+/****************************************************************/
+
+/*
+  maybenot such a good idea after all., to put class declarations in
+  .cc
+*/
 
 #include "hara-kiri-group-spanner.hh"
 #include "rhythmic-head.hh"
@@ -131,35 +152,56 @@ Axis_group_engraver::add_element (Score_element*e)
 class Hara_kiri_engraver : public Axis_group_engraver
 {
 protected:
-  virtual Spanner*get_spanner_p ()const;
-  virtual void acknowledge_element (Score_element_info);
-  virtual void add_element (Score_element *e);
+  virtual Spanner *get_spanner ();
+  virtual void acknowledge_grob (Grob_info);
+  virtual void add_element (Grob *e);
 public:
-  VIRTUAL_COPY_CONS(Translator);
+  TRANSLATOR_DECLARATIONS (Hara_kiri_engraver);
 };
 
 void
-Hara_kiri_engraver::add_element (Score_element*e)
+Hara_kiri_engraver::add_element (Grob *e)
 {
-  Hara_kiri_group_spanner::add_element (staffline_p_, e);
+  Hara_kiri_group_spanner::add_element (staffline_, e);
 }
 
-
-Spanner*
-Hara_kiri_engraver::get_spanner_p () const
+Spanner *
+Hara_kiri_engraver::get_spanner ()
 {
-  Spanner * sp = new Spanner (get_property ("basicHaraKiriVerticalGroupspannerProperties"));
-  Hara_kiri_group_spanner::set_interface (sp);
+  Spanner *sp = make_spanner ("RemoveEmptyVerticalGroup", SCM_EOL);
+
   return sp;
 }
 
 void
-Hara_kiri_engraver::acknowledge_element (Score_element_info i)
+Hara_kiri_engraver::acknowledge_grob (Grob_info i)
 {
-  Axis_group_engraver::acknowledge_element (i);
-  if (Rhythmic_head::has_interface (i.elem_l_))
+  Axis_group_engraver::acknowledge_grob (i);
+  if (staffline_
+      && (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_p_, i.elem_l_);
+      Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob_);
     }
 }
-ADD_THIS_TRANSLATOR(Hara_kiri_engraver);
+
+Hara_kiri_engraver::Hara_kiri_engraver ()
+{
+}
+
+ADD_TRANSLATOR (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 */ "");
+
+ADD_TRANSLATOR (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 */ "");