]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/separating-line-group-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / separating-line-group-engraver.cc
index 0e726c1d4f808b27b887b016fb3855e15508f516..234008d9830bcac736edd19ad69459a3a7931b67 100644 (file)
-/*   
-  separating-line-group-engraver.cc --  implement Separating_line_group_engraver
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1998--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
-
-#include "separating-group-spanner.hh"
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 1998--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 "separation-item.hh"
 #include "paper-column.hh"
-#include "paper-def.hh"
-#include "engraver.hh"
+#include "output-def.hh"
 #include "axis-group-interface.hh"
+#include "note-spacing.hh"
+#include "accidental-placement.hh"
+#include "context.hh"
+#include "spanner.hh"
+#include "grob-array.hh"
+#include "pointer-group-interface.hh"
+
+#include "translator.icc"
+
+struct Spacings
+{
+  Item *staff_spacing_;
+  vector<Item *> note_spacings_;
+
+  Spacings ()
+  {
+    staff_spacing_ = 0;
+  }
+
+  bool is_empty () const
+  {
+    return !staff_spacing_ && !note_spacings_.size ();
+  }
+  void clear ()
+  {
+    staff_spacing_ = 0;
+    note_spacings_.clear ();
+  }
+};
 
 class Separating_line_group_engraver : public Engraver
 {
 protected:
-  Item * break_malt_p_;
-  Item * nobreak_malt_p_;
-  Spanner * sep_span_p_;
-  
-  virtual void acknowledge_grob (Grob_info);
-  virtual void initialize ();
-  virtual void finalize ();
-  virtual void stop_translation_timestep ();
+  Spacings current_spacings_;
+  Spacings last_spacings_;
+
+  void acknowledge_item (Grob_info);
+  void acknowledge_break_aligned (Grob_info);
+  void stop_translation_timestep ();
+  void start_translation_timestep ();
+
+  vector<Grob *> break_aligned_;
 public:
-  Separating_line_group_engraver ();
-  VIRTUAL_COPY_CONS (Translator);
+  TRANSLATOR_DECLARATIONS (Separating_line_group_engraver);
 };
 
-Separating_line_group_engraver::Separating_line_group_engraver ()
+Separating_line_group_engraver::Separating_line_group_engraver (Context *c)
+  : Engraver (c)
 {
-  sep_span_p_ = 0;
-  break_malt_p_ = 0;
-  nobreak_malt_p_ =0;
 }
 
 void
-Separating_line_group_engraver::initialize ()
+Separating_line_group_engraver::acknowledge_item (Grob_info i)
 {
-  sep_span_p_ = new Spanner (get_property ("SeparatingGroupSpanner"));
-  Separating_group_spanner::set_interface (sep_span_p_);
-  announce_grob (sep_span_p_, 0);
-  sep_span_p_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
+  Item *it = i.item ();
+
+  if (has_interface<Note_spacing> (it))
+    {
+      current_spacings_.note_spacings_.push_back (it);
+      return;
+    }
+
+  if (Item::is_non_musical (it)
+      && !current_spacings_.staff_spacing_
+      && to_boolean (get_property ("createSpacing")))
+    {
+      Grob *col = unsmob<Grob> (get_property ("currentCommandColumn"));
+
+      current_spacings_.staff_spacing_ = make_item ("StaffSpacing", SCM_EOL);
+      context ()->set_property ("hasStaffSpacing", SCM_BOOL_T);
+
+      Pointer_group_interface::add_grob (current_spacings_.staff_spacing_,
+                                         ly_symbol2scm ("left-items"),
+                                         col);
+
+      if (!last_spacings_.note_spacings_.size ()
+          && last_spacings_.staff_spacing_)
+        {
+          SCM ri = last_spacings_.staff_spacing_->get_object ("right-items");
+          Grob_array *ga = unsmob<Grob_array> (ri);
+          if (!ga)
+            {
+              SCM ga_scm = Grob_array::make_array ();
+              last_spacings_.staff_spacing_->set_object ("right-items", ga_scm);
+              ga = unsmob<Grob_array> (ga_scm);
+            }
+
+          ga->clear ();
+          ga->add (col);
+        }
+    }
 }
 
 void
-Separating_line_group_engraver::finalize ()
+Separating_line_group_engraver::acknowledge_break_aligned (Grob_info gi)
 {
-  sep_span_p_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
-  typeset_grob (sep_span_p_);
-  sep_span_p_ =0;
+  break_aligned_.push_back (gi.grob ());
 }
 
 void
-Separating_line_group_engraver::acknowledge_grob (Grob_info i)
+Separating_line_group_engraver::start_translation_timestep ()
 {
-  Item * it = dynamic_cast <Item *> (i.elem_l_);
-  if (!it)
-    return;
-  if (it->parent_l (X_AXIS)
-      && it->parent_l (X_AXIS)->has_extent_callback_b
-      (Axis_group_interface::group_extent_callback_proc, X_AXIS))
-    return;
-
-  
-  bool ib =Item::breakable_b (it);
-  Item *&p_ref_ (ib ? break_malt_p_
-                : nobreak_malt_p_);
-
-  if (!p_ref_)
-    {
-      p_ref_ = new Item
-       (get_property ("SeparationItem"));
-         
-      if (ib)
-       p_ref_->set_grob_property ("breakable", SCM_BOOL_T);
-      announce_grob (p_ref_, 0);
-    }
-  Separation_item::add_item (p_ref_,it);
+  context ()->unset_property (ly_symbol2scm ("hasStaffSpacing"));
 }
 
 void
 Separating_line_group_engraver::stop_translation_timestep ()
 {
-  if (break_malt_p_)
-    {
-      Separating_group_spanner::add_spacing_unit (sep_span_p_, break_malt_p_);
-      
-      typeset_grob (break_malt_p_);
-      break_malt_p_ =0;
-    }
-  if (nobreak_malt_p_)
+  for (vsize i = 0; i < break_aligned_.size (); i++)
     {
-      Separating_group_spanner::add_spacing_unit (sep_span_p_, nobreak_malt_p_);
-      typeset_grob (nobreak_malt_p_);
-      nobreak_malt_p_ =0;
+      SCM smob = break_aligned_[i]->self_scm ();
+
+      if (Item *sp = current_spacings_.staff_spacing_)
+        Pointer_group_interface::add_grob (sp, ly_symbol2scm ("left-break-aligned"), smob);
+
+      for (vsize j = 0; j < last_spacings_.note_spacings_.size (); j++)
+        Pointer_group_interface::add_grob (last_spacings_.note_spacings_[j],
+                                           ly_symbol2scm ("right-break-aligned"), smob);
     }
+
+  if (!current_spacings_.is_empty ())
+    last_spacings_ = current_spacings_;
+
+  if (Item *sp = current_spacings_.staff_spacing_)
+    if (Grob *col = unsmob<Grob> (get_property ("currentMusicalColumn")))
+      Pointer_group_interface::add_grob (sp, ly_symbol2scm ("right-items"), col);
+
+  current_spacings_.clear ();
+  break_aligned_.clear ();
+}
+
+
+void
+Separating_line_group_engraver::boot ()
+{
+  ADD_ACKNOWLEDGER (Separating_line_group_engraver, item);
+  ADD_ACKNOWLEDGER (Separating_line_group_engraver, break_aligned);
 }
 
+ADD_TRANSLATOR (Separating_line_group_engraver,
+                /* doc */
+                "Generate objects for computing spacing parameters.",
 
+                /* create */
+                "StaffSpacing ",
 
-ADD_THIS_TRANSLATOR(Separating_line_group_engraver);
+                /* read */
+                "createSpacing ",
 
+                /* write */
+                "hasStaffSpacing "
+               );