source file of the GNU LilyPond music typesetter
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "dimension-cache.hh"
#include "paper-score.hh"
-#include "debug.hh"
+#include "warn.hh"
#include "item.hh"
#include "paper-column.hh"
#include "spanner.hh"
#include "lily-guile.hh"
+#include "system.hh"
+#include "group-interface.hh"
-Item::Item ()
+Item::Item (SCM s)
+ : Grob (s)
{
broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0;
+ Group_interface::add_thing (this, ly_symbol2scm ("interfaces"), ly_symbol2scm ("item-interface"));
}
+/**
+ Item copy ctor. Copy nothing: everything should be a elt property
+ or a special purpose pointer (such as broken_to_drul_[]) */
+Item::Item (Item const &s)
+ : Grob (s)
+{
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] =0;
+}
+
+
bool
-Item::breakable_b () const
+Item::breakable_b (Grob*me)
{
- if (original_l_ )
+ if (me->original_)
return false;
+
+ if (!dynamic_cast<Item*> (me))
+ me->programming_error ("only items can be breakable.");
- Item * i =dynamic_cast<Item*> (parent_l (X_AXIS));
- return (i) ? i->breakable_b () : get_elt_property( "breakable") != SCM_UNDEFINED;
+ Item * i =dynamic_cast<Item*> (me->get_parent (X_AXIS));
+ return (i) ? Item::breakable_b (i) : to_boolean (me->get_grob_property ("breakable"));
}
-Real
-Item::hpos_f() const
+Paper_column *
+Item::get_column () const
{
- return relative_coordinate (0, X_AXIS);
+ Item *parent = dynamic_cast<Item*> (get_parent (X_AXIS));
+ return parent ? parent->get_column () : 0;
}
-Line_of_score *
-Item::line_l() const
+System *
+Item::get_system () const
{
- Score_element *g = parent_l (X_AXIS);
- if (!g)
- return 0;
- return dynamic_cast<Score_element *> (g)-> line_l ();
+ Grob *g = get_parent (X_AXIS);
+ return g ? g->get_system () : 0;
}
void
-Item::copy_breakable_items()
+Item::copy_breakable_items ()
{
Drul_array<Item *> new_copies;
Direction i=LEFT;
do
{
- Score_element * dolly = clone();
- Item * item_p = dynamic_cast<Item*>(dolly);
- pscore_l_->typeset_element (item_p);
- new_copies[i] =item_p;
+ Grob * dolly = clone ();
+ Item * item = dynamic_cast<Item*> (dolly);
+ pscore_->system_->typeset_grob (item);
+ new_copies[i] =item;
}
- while (flip(&i) != LEFT);
+ while (flip (&i) != LEFT);
broken_to_drul_= new_copies;
-
- do
- {
- broken_to_drul_[i]->handle_prebroken_dependencies();
- broken_to_drul_[i]->try_visibility_lambda();
- }
- while (flip(&i) != LEFT);
}
-void
-Item::try_visibility_lambda ()
-{
- SCM vis = remove_elt_property ("visibility-lambda");
- if (vis != SCM_UNDEFINED)
- {
- SCM args = scm_listify (gh_int2scm (break_status_dir ()), SCM_UNDEFINED);
- SCM result = gh_apply (vis, args);
- int trans = gh_scm2bool (gh_car (result));
- int empty = gh_scm2bool (gh_cdr (result));
-
- if (empty)
- {
- set_empty (X_AXIS);
- set_empty ( Y_AXIS);
- }
- if (trans)
- set_elt_property ("transparent", SCM_BOOL_T);
- }
-}
bool
Item::broken_b () const
return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
}
+
+/*
+ Generate items for begin and end-of line.
+ */
void
-Item::do_break ()
+Item::discretionary_processing ()
{
if (broken_b ())
return;
- if (breakable_b ())
- {
- copy_breakable_items();
- handle_prebroken_dependencies();
-
- /*
- Otherwise the broken items won't be pre_process()'ed.
- */
-
- if (broken_to_drul_[LEFT])
- {
- add_dependency (broken_to_drul_[LEFT]);
- add_dependency (broken_to_drul_[RIGHT]);
- }
- }
- try_visibility_lambda (); // ugh.
-}
-
-void
-Item::do_breakable_col_processing()
-{
- do_break ();
+ if (Item::breakable_b (this))
+ copy_breakable_items ();
}
-Score_element*
-Item::find_broken_piece (Line_of_score*l) const
+Grob*
+Item::find_broken_piece (System*l) const
{
- if (line_l() == l)
- return (Item*)(this);
+ if (get_system () == l)
+ return (Item*) (this);
Direction d = LEFT;
do {
- Score_element *s = find_broken_piece (d);
- if (s && s->line_l () == l)
+ Grob *s = broken_to_drul_[d];
+ if (s && s->get_system () == l)
return s;
}
while (flip (&d) != LEFT);
return 0;
}
+
Item*
-Item::find_broken_piece (Direction d) const
+Item::find_prebroken_piece (Direction d) const
{
Item * me = (Item *) (this);
if (!d)
return me;
- else
- {
- me->do_break ();
- return dynamic_cast<Item*> (broken_to_drul_[d]);
- }
+ return dynamic_cast<Item*> (broken_to_drul_[d]);
}
-void
-Item::handle_prebroken_dependencies()
-{
- if (original_l_)
- Score_element::handle_prebroken_dependencies();
-}
-bool
-Item::broken_original_b () const
+Direction
+Item::break_status_dir () const
{
- return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
-}
+ if (original_)
+ {
+ Item * i = dynamic_cast<Item*> (original_);
-int
-Item::left_right_compare(Item const *l, Item const *r)
-{
- Paper_column *p1 = l->column_l ();
- Paper_column* p2 = r->column_l ();
- return p1->rank_i () - p2->rank_i ();
+ return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
+ }
+ else
+ return CENTER;
}
-Paper_column *
-Item::column_l () const
+void
+Item::handle_prebroken_dependencies ()
{
- return dynamic_cast<Item*> (parent_l (X_AXIS))->column_l ();
-}
+ Grob::handle_prebroken_dependencies ();
+
+ /*
+ Can't do this earlier, because try_visibility_lambda () might set
+ the elt property transparent, which would then be copied.
-Item::Item (Item const &s)
- : Score_element (s)
-{
- broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] =0;
-}
+ TODO:
-#if 0
-void
-Item::handle_prebroken_dependents ()
-{
- Item * parent = dynamic_cast<Item*> (parent_l (X_AXIS));
- if (breakable_b () && parent)
+ 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))
{
- if(!(broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]))
- do_break ();
-
- Direction d = LEFT;
- do
+ 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));
+
+ if (empty && trans)
+ suicide ();
+ else if (empty)
{
- Item * broken_self = find_broken_piece (d);
- Item * broken_parent = parent->find_broken_piece (d);
-
- broken_self->set_parent (broken_parent, X_AXIS);
-
- /*
- ugh. Should do this is after breaking?
- */
- if (!broken_self->parent_l (Y_AXIS))
- {
- Score_element * yparent =dynamic_cast<Score_element*>(parent_l (Y_AXIS));
- Item *yparenti = dynamic_cast<Item*> (yparent);
- Item *broken_yparent = yparenti ?
- yparenti->find_broken_piece (d) : 0;
-
- if (!yparent)
- programming_error ("Vertical refpoint lost!");
- else if (yparenti)
- {
- broken_self->set_parent (broken_yparent, Y_AXIS);
- }
- }
+ set_extent (SCM_EOL, X_AXIS);
+ set_extent (SCM_EOL, Y_AXIS);
}
- while ((flip (&d))!=LEFT);
+ else if (trans)
+ set_grob_property ("molecule-callback", SCM_EOL);
}
}
-#endif
-Direction
-Item::break_status_dir () const
+SCM
+Item::do_derived_mark ()const
{
- if (original_l_)
- {
- Item * i = dynamic_cast<Item*> (original_l_);
-
- return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
- }
- else
- return CENTER;
+ if (broken_to_drul_[LEFT])
+ scm_gc_mark (broken_to_drul_[LEFT]->self_scm ());
+ if (broken_to_drul_[RIGHT])
+ scm_gc_mark (broken_to_drul_[RIGHT]->self_scm ());
+ return SCM_EOL;
}
-
+Item*
+unsmob_item (SCM s )
+{
+ return dynamic_cast<Item*> (unsmob_grob (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")
projects / lilypond.git / blobdiff