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"
{
broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0;
Group_interface::add_thing (this, ly_symbol2scm ("interfaces"), ly_symbol2scm ("item-interface"));
-
}
/**
bool
-Item::breakable_b (Grob*me)
+Item::is_breakable (Grob*me)
{
- if (me->original_l_)
+ if (me->original_)
return false;
if (!dynamic_cast<Item*> (me))
- programming_error ("only items can be breakable.");
+ 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 *
-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;
}
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;
bool
-Item::broken_b () const
+Item::is_broken () const
{
return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
}
void
Item::discretionary_processing ()
{
- if (broken_b ())
+ if (is_broken ())
return;
- if (Item::breakable_b (this))
+ if (Item::is_breakable (this))
copy_breakable_items ();
}
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);
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;
}
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
TODO:
- handle visibility-lambda 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 ("visibility-lambda");
- 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 (scm_car (result));
+ bool empty = ly_scm2bool (scm_cdr (result));
if (empty && trans)
suicide ();
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 ());
-ADD_INTERFACE(Item,
+ADD_INTERFACE (Item,
"item-interface",
- "",
- "no-spacing-rods visibility-lambda breakable")
+ "\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")