source file of the GNU LilyPond music typesetter
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "p-score.hh"
-#include "debug.hh"
#include "item.hh"
-#include "p-col.hh"
-#include "spanner.hh"
-Item::Item ()
+#include "paper-score.hh"
+#include "warn.hh"
+#include "paper-column.hh"
+#include "lily-guile.hh"
+#include "system.hh"
+#include "pointer-group-interface.hh"
+
+Grob *
+Item::clone (int count) const
{
- unbroken_original_l_ =0;
- break_priority_i_ = 0;
- breakable_b_ = false;
- break_status_dir_ = CENTER;
- broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0;
+ return new Item (*this, count);
}
-bool
-Item::breakable_b () const
+Item::Item (SCM s, Object_key const *key)
+ : Grob (s, key)
{
- return !unbroken_original_l_
- && dynamic_cast<Item*>(parent_l (X_AXIS))->breakable_b ();
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
}
-void
-Item::do_print() const
+/**
+ 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, int copy_count)
+ : Grob (s, copy_count)
{
-#ifndef NPRINT
- DOUT << "breakable_b_: " << breakable_b_ <<
- " break_status_dir_: " << break_status_dir_;
-#endif
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
}
-
-Real
-Item::hpos_f() const
+bool
+Item::is_non_musical (Grob *me)
{
- return absolute_coordinate (X_AXIS);
+ if (me->original ())
+ return false;
+
+ 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
{
- Graphical_element *g = parent_l (X_AXIS);
- if (!g)
- return 0;
- return dynamic_cast<Score_element *> (g)-> line_l ();
+ Item *parent = dynamic_cast<Item *> (get_parent (X_AXIS));
+ return parent ? parent->get_column () : 0;
}
-Direction
-Item::break_status_dir() const
+System *
+Item::get_system () const
{
- return break_status_dir_;
+ Grob *g = get_parent (X_AXIS);
+ return g ? g->get_system () : 0;
}
void
-Item::copy_breakable_items()
+Item::copy_breakable_items ()
{
- if (broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]
- || ! breakable_b ())
- return;
-
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);
-
- item_p->break_status_dir_ = i;
- pscore_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);
- do
- {
- broken_to_drul_[i]->handle_prebroken_dependencies();
- broken_to_drul_[i]->try_visibility_lambda();
- }
- while (flip(&i) != LEFT);
- try_visibility_lambda ();
+ broken_to_drul_ = new_copies;
}
-void
-Item::try_visibility_lambda ()
+bool
+Item::is_broken () const
{
- if (visibility_lambda_)
- {
- SCM args = scm_listify (gh_int2scm (break_status_dir_), SCM_UNDEFINED);
- SCM result = gh_apply (visibility_lambda_, args);
- int trans = gh_scm2bool (gh_car (result));
- int empty = gh_scm2bool (gh_cdr (result));
-
- if (empty)
- set_empty (true);
- if (trans)
- transparent_b_ = true;
- }
+ return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
}
+/*
+ Generate items for begin and end-of line.
+*/
void
-Item::do_break ()
+Item::discretionary_processing ()
{
- copy_breakable_items();
- handle_prebroken_dependencies();
-
- /*
- Otherwise the broken items won't be pre_process()'ed.
- */
- add_dependency (broken_to_drul_[LEFT]);
- add_dependency (broken_to_drul_[RIGHT]);
+ if (is_broken ())
+ return;
+
+ if (Item::is_non_musical (this))
+ copy_breakable_items ();
}
-void
-Item::do_breakable_col_processing()
+Grob *
+Item::find_broken_piece (System *l) const
{
- if (breakable_b ())
- do_break ();
+ if (get_system () == l)
+ return (Item *) (this);
-}
-Item*
-Item::find_prebroken_piece (Line_of_score*l) const
-{
- if (line_l() == l)
- return (Item*)(this);
- else if (broken_to_drul_[LEFT] && broken_to_drul_[LEFT]->line_l() == l)
- return broken_to_drul_[LEFT];
- else if (broken_to_drul_[RIGHT] && broken_to_drul_[RIGHT]->line_l() == l)
- return broken_to_drul_[RIGHT];
+ Direction d = LEFT;
+ do
+ {
+ Grob *s = broken_to_drul_[d];
+ if (s && s->get_system () == l)
+ return s;
+ }
+ while (flip (&d) != LEFT);
return 0;
}
-Item*
-Item::find_prebroken_piece (Direction breakstatus) const
-{
- if (!breakstatus)
- return (Item *) (this); // ugh
- else
- return dynamic_cast<Item*> (broken_to_drul_[breakstatus]);
-}
-
-void
-Item::handle_prebroken_dependencies()
+Item *
+Item::find_prebroken_piece (Direction d) const
{
- if (breakable_b_)
- Score_element::handle_prebroken_dependencies();
+ Item *me = (Item *) (this);
+ if (!d)
+ return me;
+ return dynamic_cast<Item *> (broken_to_drul_[d]);
}
-int
-Item::left_right_compare(Item const *l, Item const *r)
+Direction
+Item::break_status_dir () const
{
- Paper_column *p1 = l->column_l ();
- Paper_column* p2 = r->column_l ();
- return p1->rank_i () - p2->rank_i ();
-}
-
+ if (original ())
+ {
+ Item *i = dynamic_cast<Item *> (original ());
-bool
-Item::linked_b() const
-{
- return Score_element::linked_b() || attached_span_l_arr_.size();
+ return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
+ }
+ else
+ return CENTER;
}
void
-Item::do_junk_links()
+Item::handle_prebroken_dependencies ()
{
- attached_span_l_arr_.set_size(0);
-}
+ Grob::handle_prebroken_dependencies ();
-void
-Item::do_unlink()
-{
- Link_array<Spanner> attached=attached_span_l_arr_;
- for (int i=0; i < attached.size (); i++)
+ /*
+ Can't do this earlier, because try_visibility_lambda () might set
+ the elt property transparent, which would then be copied.
+ */
+ SCM vis = get_property ("break-visibility");
+ if (scm_is_vector (vis))
{
- Spanner *s= attached[i];
-
- Direction d= LEFT;
- do {
- if (s->spanned_drul_[d] == this)
- s->set_bounds (d, 0);
- if (unbroken_original_l_
- && unbroken_original_l_-> broken_to_drul_[d] == this)
- unbroken_original_l_->broken_to_drul_[d] = 0;
- } while (flip (&d) != LEFT);
- }
- assert (!attached_span_l_arr_.size ());
- unbroken_original_l_ =0;
-}
-
-Paper_column *
-Item::column_l () const
-{
- return dynamic_cast<Item*> (parent_l (X_AXIS))->column_l ();
-}
+ bool visible = to_boolean (scm_vector_ref (vis, scm_from_int (break_status_dir () + 1)));
-Item::Item (Item const &s)
- : Score_element (s)
-{
- unbroken_original_l_ = &s;
- /* do not copy attached_span_l_arr_ */
- breakable_b_ = s.breakable_b_;
- visibility_lambda_ = s.visibility_lambda_;
- broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] =0;
- break_status_dir_ = s.break_status_dir_;
- break_priority_i_ = s.break_priority_i_;
-}
-
-
-void
-Item::handle_prebroken_dependents ()
-{
- Item * parent = dynamic_cast<Item*> (parent_l( X_AXIS));
- if (breakable_b () && parent)
- {
- if(!(broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]))
- do_break ();
-
- Direction d = LEFT;
- do
- {
- broken_to_drul_[d]->dim_cache_[X_AXIS].parent_l_ =
- &parent->broken_to_drul_[d]->dim_cache_[X_AXIS];
- parent->broken_to_drul_[d]->add_dependency (broken_to_drul_[d]);
- }
- while ((flip (&d))!=LEFT);
+ if (!visible)
+ suicide ();
}
}
+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,
+ "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"
+ " center-invisible yes no yes\n"
+ "@end example\n",
+
+ /* properties */
+ "break-visibility "
+ "no-spacing-rods "
+ "non-musical")
projects / lilypond.git / blobdiff