2003 -> 2004

[lilypond.git] / lily / item.cc

diff --git a/lily/item.cc b/lily/item.cc
index 594c97517c8c9b40c796c9cc5a6df9e4d68ab132..44964dc108c9d034d75fe559e2f66deeb84ec447 100644 (file)
--- a/lily/item.cc
+++ b/lily/item.cc
@@ -3,12 +3,11 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-
 #include "paper-score.hh"
-#include "debug.hh"
+#include "warn.hh"
 #include "item.hh"
 #include "paper-column.hh"
 #include "spanner.hh"
@@ -21,7 +20,6 @@ Item::Item (SCM s)
 {
   broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0;
   Group_interface::add_thing (this, ly_symbol2scm ("interfaces"), ly_symbol2scm ("item-interface"));
-                    
 }
 
 /**
@@ -37,7 +35,7 @@ Item::Item (Item const &s)
 bool
 Item::breakable_b (Grob*me) 
 {
-  if (me->original_l_)
+  if (me->original_)
     return false;
 
   if (!dynamic_cast<Item*> (me))
@@ -48,17 +46,17 @@ Item::breakable_b (Grob*me)
 }
 
 Paper_column *
-Item::column_l () const
+Item::get_column () const
 {
   Item *parent = dynamic_cast<Item*> (get_parent (X_AXIS));
-  return parent ? parent->column_l () : 0;
+  return parent ? parent->get_column () : 0;
 }
 
 System *
-Item::line_l () const
+Item::get_system () const
 {
   Grob *g = get_parent (X_AXIS);
-  return g ?  g->line_l () : 0;
+  return g ?  g->get_system () : 0;
 }
 
 
@@ -70,9 +68,9 @@ Item::copy_breakable_items ()
   do 
     {
       Grob * dolly = clone ();
-      Item * item_p = dynamic_cast<Item*> (dolly);
-      pscore_l_->line_l_->typeset_grob (item_p);
-      new_copies[i] =item_p;
+      Item * item = dynamic_cast<Item*> (dolly);
+      pscore_->system_->typeset_grob (item);
+      new_copies[i] =item;
     }
   while (flip (&i) != LEFT);
   broken_to_drul_= new_copies;
@@ -102,13 +100,13 @@ Item::discretionary_processing ()
 Grob*
 Item::find_broken_piece (System*l) const
 {
-  if (line_l () == l) 
+  if (get_system () == l) 
     return (Item*) (this);
 
   Direction d = LEFT;
   do {
     Grob *s = broken_to_drul_[d];
-    if (s && s->line_l () == l)
+    if (s && s->get_system () == l)
       return s;
   }
   while (flip (&d) != LEFT);
@@ -130,9 +128,9 @@ Item::find_prebroken_piece (Direction d) const
 Direction
 Item::break_status_dir () const
 {
-  if (original_l_)
+  if (original_)
     {
-      Item * i = dynamic_cast<Item*> (original_l_);
+      Item * i = dynamic_cast<Item*> (original_);
 
       return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
     }
@@ -143,12 +141,7 @@ Item::break_status_dir () const
 void
 Item::handle_prebroken_dependencies ()
 {
-  if (original_l_)
-    {
-      mutable_property_alist_
-       = handle_broken_grobs(original_l_->mutable_property_alist_,
-                              gh_int2scm (break_status_dir ()));
-    }
+  Grob::handle_prebroken_dependencies ();
   
   /*
     Can't do this earlier, because try_visibility_lambda () might set
@@ -156,9 +149,8 @@ Item::handle_prebroken_dependencies ()
 
     TODO:
 
-    handle break-visibility the item itself iso. breakstatusdir, so
-    the function can do more complicated things.
-    
+    give the item to break-visibility itself, so the function can do
+    more complicated things.
   */
   SCM vis = get_grob_property ("break-visibility");
   if (gh_procedure_p (vis))
@@ -181,7 +173,7 @@ Item::handle_prebroken_dependencies ()
 }
 
 SCM
-Item::do_derived_mark ()
+Item::do_derived_mark ()const
 {
   if (broken_to_drul_[LEFT])
     scm_gc_mark (broken_to_drul_[LEFT]->self_scm ());
@@ -200,5 +192,38 @@ unsmob_item (SCM s )
 
 ADD_INTERFACE(Item,
              "item-interface",
-             "",
+             "\n"
+             "\n"
+             "Grobs can be distinguished in their role in the horizontal spacing.\n"
+             "Many grobs define constraints on the spacing by their sizes. For\n"
+             "example, note heads, clefs, stems, and all other symbols with a fixed\n"
+             "shape.  These grobs form a subtype called @code{Item}.\n"
+             "\n"
+             "\n"
+             "Some items need special treatment for line breaking. For example, a\n"
+             "clef is normally only printed at the start of a line (i.e. after a\n"
+             "line break).  To model this, `breakable' items (clef, key signature,\n"
+             "bar lines, etc.) are copied twice. Then we have three versions of each\n"
+             "breakable item: one version if there is no line break, one version\n"
+             "that is printed before the line break (at the end of a system), one\n"
+             "version that is printed after the line break.\n"
+             "\n"
+             "Whether these versions are visible and take up space, is determined by\n"
+             "the outcome of the @code{break-visibility}. This grob property is a\n"
+             "function taking a direction (-1, 0 or 1) as argument. It returns a\n"
+             "cons of booleans, signifying whether this grob should be transparent\n"
+             "and have no extent.\n"
+             "\n"
+             "The following variables for break-visibility are predefined:\n"
+             "@example\n"
+             "           grob will show:   before  no     after\n"
+             "                             break   break  break\n"
+             "  all-invisible              no      no     no\n"
+             "  begin-of-line-visible      no      no     yes\n"
+             "  end-of-line-visible        yes     no     no\n"
+             "  all-visible                yes     yes    yes\n"
+             "  begin-of-line-invisible    yes     yes    no\n"
+             "  end-of-line-invisible      no      yes    yes\n"
+             "@end example\n"
+             ,
              "no-spacing-rods break-visibility breakable")