source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "moment.hh"
+
#include "paper-column.hh"
+
+#include "moment.hh"
#include "paper-score.hh"
-#include "debug.hh"
+#include "warn.hh"
+#include "axis-group-interface.hh"
+#include "spaceable-grob.hh"
+#include "text-item.hh"
+#include "lookup.hh"
+#include "font-interface.hh"
+#include "output-def.hh"
+
+Grob *
+Paper_column::clone (int count) const
+{
+ return new Paper_column (*this, count);
+}
+
+ADD_INTERFACE (Paper_column, "paper-column-interface",
+ "@code{Paper_column} objects form the top-most X-parents for items. "
+ " The are two types of columns: musical columns, where are attached to, and "
+ " non-musical columns, where bar-lines, clefs etc. are attached to. "
+ " The spacing engine determines the X-positions of these objects."
+ "\n\n"
+ "They are\n"
+ " numbered, the first (leftmost) is column 0. Numbering happens before\n"
+ " line-breaking, and columns are not renumbered after line breaking.\n"
+ " Since many columns go unused, you should only use the rank field to\n"
+ " get ordering information. Two adjacent columns may have\n"
+ " non-adjacent numbers.\n"
+ "\n",
+ "between-cols when bounded-by-me "
+ "page-penalty shortest-playing-duration shortest-starter-duration");
void
-Paper_column::add_rod (Paper_column * p, Real d)
+Paper_column::do_break_processing ()
{
- Direction dir = Direction (sign (p->rank_i () - rank_i ()));
-
- if (!dir)
- {
- programming_error ("Must set minimum distance between differing columns.");
- return;
- }
-
- for (int i=0; i < minimal_dists_arr_drul_[dir].size (); i++)
- {
- Column_rod &rod = minimal_dists_arr_drul_[dir][i];
- if (rod.other_l_ == p)
- {
- rod.distance_f_ = rod.distance_f_ >? d;
- return ;
- }
- }
-
- Column_rod cr;
- cr.distance_f_ = d;
- cr.other_l_ = p;
+ Spaceable_grob::remove_interface (this);
+ Item::do_break_processing ();
+}
- minimal_dists_arr_drul_[dir].push (cr);
+int
+Paper_column::get_rank (Grob *me)
+{
+ return dynamic_cast<Paper_column *> (me)->rank_;
}
-void
-Paper_column::add_spring (Paper_column * p, Real d, Real s)
+System *
+Paper_column::get_system () const
{
- Direction dir = Direction (sign (p->rank_i () - rank_i ()));
-
- if (!dir)
- {
- warning (_ ("Must set spring between differing columns"));
- return;
- }
-
- for (int i=0; i < spring_arr_drul_[dir].size (); i++)
- {
- Column_spring &spring = spring_arr_drul_[dir][i];
- if (spring.other_l_ == p)
- {
- spring.distance_f_ = spring.distance_f_ >? d;
- return ;
- }
- }
+ return system_;
+}
- Column_spring cr;
- cr.distance_f_ = d;
- cr.strength_f_ = s;
- cr.other_l_ = p;
+Paper_column *
+Paper_column::get_column () const
+{
+ return (Paper_column *) (this);
+}
- spring_arr_drul_[dir].push (cr);
+Paper_column::Paper_column (SCM l, Object_key const *key)
+ : Item (l, key) // guh.?
+{
+ system_ = 0;
+ rank_ = -1;
}
-int
-Paper_column::rank_i() const
+Paper_column::Paper_column (Paper_column const &src, int count)
+ : Item (src, count)
{
- return rank_i_;
+ system_ = 0;
+ rank_ = src.rank_;
}
-void
-Paper_column::set_rank (int i)
+Moment
+Paper_column::when_mom (Grob *me)
{
- rank_i_ = i;
+ SCM m = me->get_property ("when");
+ if (Moment *when = unsmob_moment (m))
+ return *when;
+ return Moment (0);
}
-void
-Paper_column::do_print() const
+bool
+Paper_column::is_musical (Grob *me)
{
-#ifndef NPRINT
- DEBUG_OUT << "rank: " << rank_i_ << '\n';
- Direction d = LEFT;
- do
+ SCM m = me->get_property ("shortest-starter-duration");
+ Moment s (0);
+ if (unsmob_moment (m))
{
- for (int i=0; i < minimal_dists_arr_drul_[d].size (); i++)
- {
- minimal_dists_arr_drul_[d][i].print ();
- }
- for (int i=0; i < spring_arr_drul_[d].size (); i++)
- {
- spring_arr_drul_[d][i].print ();
- }
-
+ s = *unsmob_moment (m);
}
- while ((flip (&d))!=LEFT);
- Item::do_print ();
-#endif
+ return s != Moment (0);
}
-Line_of_score*
-Paper_column::line_l() const
+bool
+Paper_column::is_used (Grob *me)
{
- return line_l_;
+ return scm_is_pair (me->get_property ("elements")) || Item::is_breakable (me)
+ || scm_is_pair (me->get_property ("bounded-by-me"));
}
+/*
+ Print a vertical line and the rank number, to aid debugging.
+*/
+MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
+SCM
+Paper_column::print (SCM p)
+{
+ Grob *me = unsmob_grob (p);
+ String r = to_string (Paper_column::get_rank (me));
+ SCM properties = Font_interface::text_font_alist_chain (me);
-Paper_column*
-Paper_column::column_l () const
-{
- return (Paper_column*)(this);
-}
+ SCM scm_mol = Text_interface::interpret_markup (me->get_layout ()->self_scm (),
+ properties,
+ scm_makfrom0str (r.to_str0 ()));
+ Stencil t = *unsmob_stencil (scm_mol);
+ t.align_to (X_AXIS, CENTER);
+ t.align_to (Y_AXIS, DOWN);
+ Stencil l = Lookup::filled_box (Box (Interval (-0.01, 0.01),
+ Interval (-2, -1)));
+ t.add_stencil (l);
+ return t.smobbed_copy ();
+}
+/*
+ This is all too hairy. We use bounded-by-me to make sure that some
+ columns are kept "alive". Unfortunately, when spanners are suicided,
+ this falls apart again. (sigh.)
-Paper_column::Paper_column (Moment w)
+ THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER.
+*/
+MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1);
+SCM
+Paper_column::before_line_breaking (SCM grob)
{
- set_elt_property ("when", (new Moment (w))->smobify_self ());
- set_axes (X_AXIS, X_AXIS);
+ Grob *me = unsmob_grob (grob);
- line_l_=0;
- rank_i_ = -1;
-}
+ SCM c = me->get_property ("bounded-by-me");
+ SCM *ptrptr = &c;
-Moment
-Paper_column::when_mom () const
-{
- SCM m = get_elt_property ("when");
- Moment s (0);
- if (SMOB_IS_TYPE_B(Moment, m))
+ while (scm_is_pair (*ptrptr))
{
- s = *SMOB_TO_TYPE (Moment,m);
- }
- return s;
-}
-
-bool
-Paper_column::musical_b () const
-{
- SCM m = get_elt_property ("shortest-starter");
- Moment s (0);
- if (SMOB_IS_TYPE_B(Moment, m))
- {
- s = *SMOB_TO_TYPE (Moment,m);
+ Grob *g = unsmob_grob (scm_car (*ptrptr));
+
+ if (!g || !g->is_live ())
+ {
+ *ptrptr = scm_cdr (*ptrptr);
+ }
+ else
+ {
+ ptrptr = SCM_CDRLOC (*ptrptr);
+ }
}
- return s != Moment(0);
+
+ me->set_property ("bounded-by-me", c);
+ return SCM_UNSPECIFIED;
}