/*
- item.cc -- implement Item
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "p-score.hh"
-#include "debug.hh"
#include "item.hh"
-#include "p-col.hh"
-#include "spanner.hh"
+
+#include "axis-group-interface.hh"
+#include "paper-score.hh"
+#include "warn.hh"
+#include "paper-column.hh"
#include "lily-guile.hh"
+#include "system.hh"
+#include "pointer-group-interface.hh"
-Item::Item ()
+#include "moment.hh"
+
+Grob *
+Item::clone () const
{
- broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0;
+ return new Item (*this);
}
-bool
-Item::breakable_b () const
+Item::Item (SCM s)
+ : Grob (s)
{
- if (original_l_ )
- return false;
-
- Item * i =dynamic_cast<Item*> (parent_l (X_AXIS));
- return (i) ? i->breakable_b () : get_elt_property( breakable_scm_sym) != SCM_BOOL_F;
+ broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
+ cached_pure_height_valid_ = false;
}
-void
-Item::do_print() const
+/**
+ Item copy ctor. Copy nothing: everything should be an 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;
+ cached_pure_height_valid_ = false;
}
-
-Real
-Item::hpos_f() const
+bool
+Item::is_non_musical (Grob *me)
{
- return absolute_coordinate (X_AXIS);
+ 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;
}
+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 ()
{
- if (broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]
- || ! breakable_b ())
- return;
-
Drul_array<Item *> new_copies;
- Direction i=LEFT;
- do
+ for (LEFT_and_RIGHT (d))
{
- 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);
+ get_root_system (this)->typeset_grob (item);
+ new_copies[d] = item;
}
- 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);
- try_visibility_lambda ();
+ broken_to_drul_ = new_copies;
}
-void
-Item::try_visibility_lambda ()
+bool
+Item::is_broken () const
{
- SCM vis = remove_elt_property (visibility_lambda_scm_sym);
- if (vis != SCM_BOOL_F)
- {
- SCM args = scm_listify (gh_int2scm (break_status_dir ()), SCM_UNDEFINED);
- SCM result = gh_apply ( SCM_CDR(vis), args);
- int trans = gh_scm2bool (gh_car (result));
- int empty = gh_scm2bool (gh_cdr (result));
-
- if (empty)
- set_empty (true);
- if (trans)
- set_elt_property (transparent_scm_sym, SCM_BOOL_T);
- }
+ 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 () || original ())
+ 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];
+ for (LEFT_and_RIGHT (d))
+ {
+ Grob *s = broken_to_drul_[d];
+ if (s && s->get_system () == l)
+ return s;
+ }
return 0;
}
-Item*
+Item *
Item::find_prebroken_piece (Direction d) const
{
+ Item *me = (Item *) (this);
if (!d)
- return (Item *) (this); // ugh
+ return me;
+ return dynamic_cast<Item *> (broken_to_drul_[d]);
+}
+
+Direction
+Item::break_status_dir () const
+{
+ if (original ())
+ {
+ Item *i = dynamic_cast<Item *> (original ());
+
+ return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
+ }
else
- return dynamic_cast<Item*> (broken_to_drul_[d]);
+ return CENTER;
}
void
-Item::handle_prebroken_dependencies()
+Item::handle_prebroken_dependencies ()
{
- if (original_l_)
- Score_element::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.
+ */
+ if (!Item::break_visible (this))
+ suicide ();
}
bool
-Item::broken_original_b () const
+Item::break_visible (Grob *g)
{
- return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
+ Item *it = dynamic_cast<Item *> (g);
+ SCM vis = g->get_property ("break-visibility");
+ if (scm_is_vector (vis))
+ return to_boolean (scm_c_vector_ref (vis, it->break_status_dir () + 1));
+ return true;
}
-int
-Item::left_right_compare(Item const *l, Item const *r)
+bool
+Item::pure_is_visible (int start, int end) const
{
- Paper_column *p1 = l->column_l ();
- Paper_column* p2 = r->column_l ();
- return p1->rank_i () - p2->rank_i ();
+ SCM vis = get_property ("break-visibility");
+ if (scm_is_vector (vis))
+ {
+ 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;
}
-Paper_column *
-Item::column_l () const
+Interval_t<int>
+Item::spanned_rank_interval () const
{
- return dynamic_cast<Item*> (parent_l (X_AXIS))->column_l ();
+ int c = get_column ()->get_rank ();
+ return Interval_t<int> (c, c);
}
-Item::Item (Item const &s)
- : Score_element (s)
+Interval_t<Moment>
+spanned_time_interval (Item *l, Item *r)
{
- broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] =0;
-}
+ Drul_array<Item *> bounds (l, r);
+ Interval_t<Moment> iv;
+ for (LEFT_and_RIGHT (d))
+ {
+ if (bounds[d] && bounds[d]->get_column ())
+ iv[d] = robust_scm2moment (bounds[d]->get_column ()->get_property ("when"),
+ iv[d]);
+ }
-void
-Item::handle_prebroken_dependents ()
-{
- Item * parent = dynamic_cast<Item*> (parent_l (X_AXIS));
- if (breakable_b () && parent)
+ for (LEFT_and_RIGHT (d))
{
- if(!(broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]))
- do_break ();
-
- Direction d = LEFT;
- do
- {
- Item * broken_self = find_prebroken_piece (d);
- Item * broken_parent = parent->find_prebroken_piece (d);
-
- broken_self->dim_cache_[X_AXIS].parent_l_ =
- &broken_parent->dim_cache_[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_prebroken_piece (d) : 0;
-
- if (!yparent)
- programming_error ("Vertical refpoint lost!");
- else if (yparenti)
- {
- broken_self->dim_cache_[Y_AXIS].parent_l_ =
- &broken_yparent->dim_cache_[Y_AXIS];
- }
- }
- }
- while ((flip (&d))!=LEFT);
+ if (!bounds[d] || !bounds[d]->get_column ())
+ iv[d] = iv[-d];
}
+
+ return iv;
}
-Direction
-Item::break_status_dir () const
+void
+Item::derived_mark () const
{
- if (original_l_)
- {
- Item * i = dynamic_cast<Item*> (original_l_);
+ 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 (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
- }
- else
- return CENTER;
+Item *
+unsmob_item (SCM s)
+{
+ return dynamic_cast<Item *> (unsmob_grob (s));
}
+
+Interval
+Item::pure_height (Grob *g, int start, int end)
+{
+ if (cached_pure_height_valid_)
+ return cached_pure_height_ + pure_relative_y_coordinate (g, start, end);
+ /* Note: cached_pure_height_ does not notice if start changes, implicitly
+ assuming that Items' pure_heights do not depend on 'start' or 'end'.
+ Accidental_interface::pure_height(), however, does depend on 'start'.
+ */
+
+ cache_pure_height (Grob::pure_height (this, start, end));
+ return cached_pure_height_ + pure_relative_y_coordinate (g, start, end);
+}
+
+void
+Item::cache_pure_height (Interval height)
+{
+ cached_pure_height_ = height;
+ cached_pure_height_valid_ = true;
+}
+
+ADD_INTERFACE (Item,
+ "Grobs can be distinguished in their role in the horizontal"
+ " spacing. Many grobs define constraints on the spacing by"
+ " their sizes, for example, note heads, clefs, stems, and all"
+ " other symbols with a fixed shape. These grobs form a"
+ " subtype called @code{Item}.\n"
+ "\n"
+ "Some items need special treatment for line breaking. For"
+ " example, a clef is normally only printed at the start of a"
+ " line (i.e., after a line break). To model this,"
+ " @q{breakable} items (clef, key signature, bar lines, etc.)"
+ " are copied twice. Then we have three versions of each"
+ " breakable item: one version if there is no line break, one"
+ " version that is printed before the line break (at the end of"
+ " a system), and one version that is printed after the line"
+ " break.\n"
+ "\n"
+ "Whether these versions are visible and take up space is"
+ " determined by the outcome of the @code{break-visibility}"
+ " grob property, which is a function taking a direction"
+ " (@w{@code{-1}}, @code{0} or@tie{}@code{1}) as an argument. It"
+ " returns a cons of booleans, signifying whether this grob"
+ " should be transparent and have no extent.\n"
+ "\n"
+ "The following variables for @code{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",
+
+ /* properties */
+ "break-visibility "
+ "extra-spacing-height "
+ "extra-spacing-width "
+ "non-musical "
+ );
projects / lilypond.git / blobdiff