source file of the GNU LilyPond music typesetter
- (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "p-score.hh"
-#include "debug.hh"
+
#include "item.hh"
-#include "p-col.hh"
-Item::Item()
-{
- pcol_l_ = 0;
+#include "paper-score.hh"
+#include "warn.hh"
+#include "paper-column.hh"
+#include "lily-guile.hh"
+#include "system.hh"
+#include "pointer-group-interface.hh"
- broken_to_a_[0]
- = broken_to_a_[1]=0;
+Grob *
+Item::clone (int count) const
+{
+ return new Item (*this, count);
}
+Item::Item (SCM s, Object_key const *key)
+ : Grob (s, key)
+{
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
+}
-IMPLEMENT_IS_TYPE_B1(Item, Score_elem);
+/**
+ 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)
+{
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
+}
-void
-Item::do_print() const
+bool
+Item::is_breakable (Grob *me)
{
-#ifndef NPRINT
- mtor << "(unknown)";
-#endif
+ if (me->original ())
+ return false;
+
+ 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::is_breakable (i) : to_boolean (me->get_property ("breakable"));
}
+Paper_column *
+Item::get_column () const
+{
+ Item *parent = dynamic_cast<Item *> (get_parent (X_AXIS));
+ return parent ? parent->get_column () : 0;
+}
-Real
-Item::hpos_f()const
+System *
+Item::get_system () const
{
- return pcol_l_->hpos_f_ + offset().x;
+ Grob *g = get_parent (X_AXIS);
+ return g ? g->get_system () : 0;
}
+void
+Item::copy_breakable_items ()
+{
+ Drul_array<Item *> new_copies;
+ Direction i = LEFT;
+ int count = 0;
+ do
+ {
+ 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;
+}
-Line_of_score *
-Item::line_l()const
+bool
+Item::is_broken () const
{
- return pcol_l_->line_l_;
+ return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
}
-int
-Item::break_status_i() const
+/*
+ Generate items for begin and end-of line.
+*/
+void
+Item::discretionary_processing ()
{
- PCol * c = pcol_l_;
- if (c->breakable_b())
- return 0;
- else if (!c->daddy_l_)
- return 0;
- else if (c == c->daddy_l_->prebreak_p_)
- return -1;
- else
- return 1;
+ if (is_broken ())
+ return;
+
+ if (Item::is_breakable (this))
+ copy_breakable_items ();
}
-void
-Item::do_breakable_col_processing()
+Grob *
+Item::find_broken_piece (System *l) const
{
- PCol * c = pcol_l_;
- if (!c->breakable_b())
- return;
-
- for (int i=0; i < 2; i++) {
- broken_to_a_[i] = clone()->item();
- pscore_l_->typeset_item(broken_to_a_[i], c, -1+ 2*i);
- broken_to_a_[i]->handle_prebroken_dependencies();
+ if (get_system () == l)
+ return (Item *) (this);
+
+ Direction d = LEFT;
+ do
+ {
+ Grob *s = broken_to_drul_[d];
+ if (s && s->get_system () == l)
+ return s;
}
+ while (flip (&d) != LEFT);
- handle_prebroken_dependencies();
+ return 0;
}
-Item*
-Item::find_prebroken_piece(Line_of_score*l) const
+Item *
+Item::find_prebroken_piece (Direction d) const
{
- if (line_l() == l)
- return this;
- else if (broken_to_a_[0] && broken_to_a_[0]->line_l() == l)
- return broken_to_a_[0];
- else if (broken_to_a_[1] && broken_to_a_[1]->line_l() == l)
- return broken_to_a_[1];
-
- return 0;
+ Item *me = (Item *) (this);
+ if (!d)
+ return me;
+ return dynamic_cast<Item *> (broken_to_drul_[d]);
}
-Item*
-Item::find_prebroken_piece(PCol*c)const
+Direction
+Item::break_status_dir () const
{
- if (c == pcol_l_ )
- return (Item *) this; // ugh
+ if (original ())
+ {
+ Item *i = dynamic_cast<Item *> (original ());
- if (c == pcol_l_->prebreak_p_)
- return (Item *) broken_to_a_[0];
- else if (c==pcol_l_->postbreak_p_)
- return (Item *)broken_to_a_[1];
+ return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
+ }
+ else
+ return CENTER;
+}
- assert(false);
+void
+Item::handle_prebroken_dependencies ()
+{
+ 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 = get_property ("break-visibility");
+ if (scm_is_vector (vis))
+ {
+ bool visible = to_boolean (scm_vector_ref (vis, scm_from_int (break_status_dir () + 1)));
+
+ if (!visible)
+ suicide ();
+ }
}
void
-Item::handle_prebroken_dependencies()
+Item::derived_mark () const
{
- if ( pcol_l_->breakable_b() || pcol_l_->daddy_l_ )
- Score_elem::handle_prebroken_dependencies();
+ 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",
+ "no-spacing-rods break-visibility breakable")
projects / lilypond.git / blobdiff