source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "dimension-cache.hh"
-#include "paper-score.hh"
-#include "debug.hh"
#include "item.hh"
+
+#include "axis-group-interface.hh"
+#include "paper-score.hh"
+#include "warn.hh"
#include "paper-column.hh"
-#include "spanner.hh"
#include "lily-guile.hh"
-#include "line-of-score.hh"
+#include "system.hh"
+#include "pointer-group-interface.hh"
+
+Grob *
+Item::clone (int count) const
+{
+ return new Item (*this, count);
+}
-Item::Item ()
+Item::Item (SCM s, Object_key const *key)
+ : Grob (s, key)
{
- broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0;
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
}
/**
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)
- : Score_element (s)
+Item::Item (Item const &s, int copy_count)
+ : Grob (s, copy_count)
{
- broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] =0;
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
}
-
-
bool
-Item::breakable_b () const
+Item::is_non_musical (Grob *me)
{
- if (original_l_ )
+ if (me->original ())
return false;
-
- Item * i =dynamic_cast<Item*> (parent_l (X_AXIS));
- return (i) ? i->breakable_b () : to_boolean (get_elt_property ("breakable"));
+
+ Item *i = dynamic_cast<Item *> (me->get_parent (X_AXIS));
+ return i ? Item::is_non_musical (i) : to_boolean (me->get_property ("non-musical"));
}
-Line_of_score *
-Item::line_l() const
+Paper_column *
+Item::get_column () const
{
- Score_element *g = parent_l (X_AXIS);
- return g ? g->line_l () : 0;
+ Item *parent = dynamic_cast<Item *> (get_parent (X_AXIS));
+ return parent ? parent->get_column () : 0;
}
+System *
+Item::get_system () const
+{
+ 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
+ Direction i = LEFT;
+ int count = 0;
+ do
{
- Score_element * dolly = clone();
- Item * item_p = dynamic_cast<Item*>(dolly);
- pscore_l_->line_l_->typeset_element (item_p);
- new_copies[i] =item_p;
+ Grob *dolly = clone (count++);
+ Item *item = dynamic_cast<Item *> (dolly);
+ get_root_system (this)->typeset_grob (item);
+ new_copies[i] = item;
}
- while (flip(&i) != LEFT);
- broken_to_drul_= new_copies;
-}
+ 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];
}
-
/*
Generate items for begin and end-of line.
- */
+*/
void
-Item::discretionary_processing()
+Item::discretionary_processing ()
{
- if (broken_b ())
+ if (is_broken ())
return;
- if (breakable_b ())
- copy_breakable_items();
+ if (Item::is_non_musical (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 = broken_to_drul_[d];
- if (s && s->line_l () == l)
- return s;
- }
+ do
+ {
+ Grob *s = broken_to_drul_[d];
+ if (s && s->get_system () == l)
+ return s;
+ }
while (flip (&d) != LEFT);
return 0;
}
-
-Item*
+Item *
Item::find_prebroken_piece (Direction d) const
{
- Item * me = (Item *) (this);
+ Item *me = (Item *) (this);
if (!d)
return me;
- return dynamic_cast<Item*> (broken_to_drul_[d]);
-}
-
-Paper_column *
-Item::column_l () const
-{
- return dynamic_cast<Item*> (parent_l (X_AXIS))->column_l ();
+ return dynamic_cast<Item *> (broken_to_drul_[d]);
}
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_)
- {
- property_alist_
- = handle_broken_smobs (original_l_->property_alist_,
- gh_int2scm (break_status_dir ()));
- pointer_alist_
- = handle_broken_smobs (original_l_->pointer_alist_,
- gh_int2scm (break_status_dir ()));
- }
-
+ Grob::handle_prebroken_dependencies ();
+
/*
Can't do this earlier, because try_visibility_lambda () might set
the elt property transparent, which would then be copied.
*/
- SCM vis = remove_elt_property ("visibility-lambda");
- if (gh_procedure_p (vis))
+ SCM vis = get_property ("break-visibility");
+ if (scm_is_vector (vis))
+ {
+ bool visible = to_boolean (scm_c_vector_ref (vis, break_status_dir () + 1));
+
+ if (!visible)
+ suicide ();
+ }
+}
+
+bool
+Item::pure_is_visible (int start, int end) const
+{
+ SCM vis = get_property ("break-visibility");
+ if (scm_is_vector (vis))
{
- SCM args = scm_listify (gh_int2scm (break_status_dir ()), SCM_UNDEFINED);
- SCM result = gh_apply (vis, args);
- bool trans = gh_scm2bool (gh_car (result));
- bool empty = gh_scm2bool (gh_cdr (result));
-
- if (empty)
- {
- set_extent_callback (0, X_AXIS);
- set_extent_callback (0, Y_AXIS);
- }
- if (trans)
- set_elt_property ("transparent", SCM_BOOL_T);
+ int pos = 1;
+ int pc_rank = Paper_column::get_rank (get_column ());
+ if (pc_rank == start)
+ pos = 2;
+ else if (pc_rank == end)
+ pos = 0;
+ return to_boolean (scm_vector_ref (vis, scm_from_int (pos)));
}
+ return true;
}
+
+Interval_t<int>
+Item::spanned_rank_iv ()
+{
+ int c = get_column ()->get_rank ();
+ return Interval_t<int> (c, c);
+}
+
+void
+Item::derived_mark () const
+{
+ 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 ());
+}
+
+Item *
+unsmob_item (SCM s)
+{
+ return dynamic_cast<Item *> (unsmob_grob (s));
+}
+
+ADD_INTERFACE (Item,
+
+ "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"
+ " center-invisible yes no yes\n"
+ "@end example\n",
+
+ /* properties */
+ "break-visibility "
+ "no-spacing-rods "
+ "non-musical")