update for the lily-wins.py script.

[lilypond.git] / lily / item.cc

diff --git a/lily/item.cc b/lily/item.cc
index 12d4d48a47c238576b82f771b6e980c88aa06624..f857ff55917f038a80652eb9136da4d41ed5c1ab 100644 (file)
--- a/lily/item.cc
+++ b/lily/item.cc
@@ -3,10 +3,9 @@
 
   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 "warn.hh"
 #include "item.hh"
@@ -34,7 +33,7 @@ Item::Item (Item const &s)
 
 
 bool
-Item::breakable_b (Grob*me) 
+Item::is_breakable (Grob*me) 
 {
   if (me->original_)
     return false;
@@ -42,8 +41,8 @@ Item::breakable_b (Grob*me)
   if (!dynamic_cast<Item*> (me))
     me->programming_error ("only items can be breakable.");
   
-  Item * i  =dynamic_cast<Item*> (me->get_parent (X_AXIS));
-  return (i) ?  Item::breakable_b (i) : to_boolean (me->get_grob_property ("breakable"));
+  Item * i = dynamic_cast<Item*> (me->get_parent (X_AXIS));
+  return (i) ? Item::is_breakable (i) : to_boolean (me->get_property ("breakable"));
 }
 
 Paper_column *
@@ -79,7 +78,7 @@ Item::copy_breakable_items ()
 
 
 bool
-Item::broken_b () const
+Item::is_broken () const
 {
   return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
 }
@@ -91,10 +90,10 @@ Item::broken_b () const
 void
 Item::discretionary_processing ()
 {
-  if (broken_b ())
+  if (is_broken ())
     return;
 
-  if (Item::breakable_b (this))
+  if (Item::is_breakable (this))
     copy_breakable_items ();
 }
 
@@ -153,13 +152,13 @@ Item::handle_prebroken_dependencies ()
     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))
+  SCM vis = get_property ("break-visibility");
+  if (ly_c_procedure_p (vis))
     {
-      SCM args = scm_list_n (gh_int2scm (break_status_dir ()), SCM_UNDEFINED);
-      SCM result = gh_apply (vis, args);
-      bool trans = gh_scm2bool (ly_car (result));
-      bool empty = gh_scm2bool (ly_cdr (result));
+      SCM args = scm_list_n (scm_int2num (break_status_dir ()), SCM_UNDEFINED);
+      SCM result = scm_apply_0 (vis, args);
+      bool trans = ly_scm2bool (ly_car (result));
+      bool empty = ly_scm2bool (ly_cdr (result));
       
       if (empty && trans)
        suicide ();
@@ -169,12 +168,12 @@ Item::handle_prebroken_dependencies ()
          set_extent (SCM_EOL, Y_AXIS);
        }
       else if (trans)
-       set_grob_property ("molecule-callback", SCM_EOL);
+       set_property ("print-function", SCM_EOL);
     }
 }
 
 SCM
-Item::do_derived_mark ()
+Item::do_derived_mark ()const
 {
   if (broken_to_drul_[LEFT])
     scm_gc_mark (broken_to_drul_[LEFT]->self_scm ());
@@ -191,14 +190,40 @@ unsmob_item (SCM s )
 
 
 
-ADD_INTERFACE(Item,
+ADD_INTERFACE (Item,
              "item-interface",
-             "
-
-Grobs can be distinguished in their role in the horizontal spacing.
-Many grobs define constraints on the spacing by their sizes. For
-example, note heads, clefs, stems, and all other symbols with a fixed
-shape.  These grobs form a subtype called @code{Item}.
-
-",
+             "\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")