source file of the GNU LilyPond music typesetter
- (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "grob.hh"
#include <cstring>
-#include "main.hh"
-#include "input-smob.hh"
-#include "warn.hh"
-#include "pointer-group-interface.hh"
-#include "misc.hh"
-#include "paper-score.hh"
-#include "stencil.hh"
-#include "warn.hh"
-#include "system.hh"
+#include "align-interface.hh"
+#include "input.hh"
+#include "international.hh"
#include "item.hh"
-#include "stencil.hh"
+#include "main.hh"
#include "misc.hh"
#include "music.hh"
-#include "item.hh"
-#include "paper-score.hh"
-#include "ly-smobs.icc"
#include "output-def.hh"
+#include "pointer-group-interface.hh"
+#include "stencil.hh"
+#include "stream-event.hh"
+#include "system.hh"
+#include "warn.hh"
-
-
-
-MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1);
-SCM
-Grob::y_parent_positioning (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
- Grob *par = me->get_parent (Y_AXIS);
- if (par)
- (void) par->get_property ("positioning-done");
-
- return scm_from_double (0.0);
-}
-
-
-MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1);
-SCM
-Grob::x_parent_positioning (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
-
- Grob *par = me->get_parent (X_AXIS);
- if (par)
- (void) par->get_property ("positioning-done");
-
- return scm_from_double (0.0);
-}
+#include "ly-smobs.icc"
Grob *
-Grob::clone (int count) const
+Grob::clone () const
{
- return new Grob (*this, count);
+ return new Grob (*this);
}
-/* TODO:
-
-- remove dynamic_cast<Spanner, Item> and put this code into respective
-subclass. */
-
-#define HASH_SIZE 3
-#define INFINITY_MSG "Infinity or NaN encountered"
-
-Grob::Grob (SCM basicprops,
- Object_key const *key)
+Grob::Grob (SCM basicprops)
{
- key_ = key;
+
/* FIXME: default should be no callback. */
self_scm_ = SCM_EOL;
- pscore_ = 0;
+ layout_ = 0;
original_ = 0;
interfaces_ = SCM_EOL;
immutable_property_alist_ = basicprops;
GC. After smobify_self (), they are. */
smobify_self ();
- /*
- We always get a new key object for a new grob.
- */
- if (key_)
- ((Object_key *)key_)->unprotect ();
-
SCM meta = get_property ("meta");
if (scm_is_pair (meta))
- interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta));
+ {
+ interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta));
+
+ SCM object_cbs = scm_assq (ly_symbol2scm ("object-callbacks"), meta);
+ if (scm_is_pair (object_cbs))
+ {
+ for (SCM s = scm_cdr (object_cbs); scm_is_pair (s); s = scm_cdr (s))
+ set_object (scm_caar (s), scm_cdar (s));
+ }
+ }
- if (get_property_data (ly_symbol2scm ("X-extent")) == SCM_EOL)
+ if (get_property_data ("X-extent") == SCM_EOL)
set_property ("X-extent", Grob::stencil_width_proc);
- if (get_property_data (ly_symbol2scm ("Y-extent")) == SCM_EOL)
+ if (get_property_data ("Y-extent") == SCM_EOL)
set_property ("Y-extent", Grob::stencil_height_proc);
}
-Grob::Grob (Grob const &s, int copy_index)
+Grob::Grob (Grob const &s)
: dim_cache_ (s.dim_cache_)
{
- key_ = (use_object_keys) ? new Copied_key (s.key_, copy_index) : 0;
original_ = (Grob *) & s;
self_scm_ = SCM_EOL;
interfaces_ = s.interfaces_;
object_alist_ = SCM_EOL;
- pscore_ = 0;
+ layout_ = 0;
smobify_self ();
- if (key_)
- ((Object_key *)key_)->unprotect ();
}
Grob::~Grob ()
{
}
-
-
-MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1);
-SCM
-Grob::stencil_height (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
- return stencil_extent (me, Y_AXIS);
-}
-
-MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1);
-SCM
-Grob::stencil_width (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
- return stencil_extent (me, X_AXIS);
-}
-
-SCM
-Grob::stencil_extent (Grob *me, Axis a)
-{
- Stencil *m = me->get_stencil ();
- Interval e;
- if (m)
- e = m->extent (a);
- return ly_interval2scm (e);
-}
-
-Interval
-robust_relative_extent (Grob *me, Grob *refpoint, Axis a)
-{
- Interval ext = me->extent (refpoint, a);
- if (ext.is_empty ())
- ext.add_point (me->relative_coordinate (refpoint, a));
-
- return ext;
-}
-
-Output_def *
-Grob::get_layout () const
-{
- return pscore_ ? pscore_->layout () : 0;
-}
+/****************************************************************
+ STENCILS
+****************************************************************/
Stencil *
Grob::get_stencil () const
else
{
SCM expr = m->expr ();
- if (point_and_click_global)
- expr = scm_list_3 (ly_symbol2scm ("grob-cause"),
- self_scm (), expr);
+ expr = scm_list_3 (ly_symbol2scm ("grob-cause"),
+ self_scm (), expr);
retval = Stencil (m->extent_box (), expr);
}
+ SCM rot = get_property ("rotation");
+ if (scm_is_pair (rot))
+ {
+ Real angle = scm_to_double (scm_car (rot));
+ Real x = scm_to_double (scm_cadr (rot));
+ Real y = scm_to_double (scm_caddr (rot));
+
+ retval.rotate_degrees (angle, Offset (x, y));
+ }
+
/* color support... see interpret_stencil_expression () for more... */
SCM color = get_property ("color");
- if (color != SCM_EOL)
+ if (scm_is_pair (color))
{
- m = unsmob_stencil (stil);
SCM expr = scm_list_3 (ly_symbol2scm ("color"),
color,
- m->expr ());
+ retval.expr ());
- retval = Stencil (m->extent_box (), expr);
+ retval = Stencil (retval.extent_box (), expr);
}
}
return retval;
}
-/*
+/****************************************************************
VIRTUAL STUBS
-*/
+****************************************************************/
void
Grob::do_break_processing ()
{
}
+void
+Grob::discretionary_processing ()
+{
+}
+
System *
Grob::get_system () const
{
Grob::handle_broken_dependencies ()
{
Spanner *sp = dynamic_cast<Spanner *> (this);
- if (original_ && sp)
+ if (original () && sp)
return;
if (sp)
if (!is_live ())
return;
+ for (int a = X_AXIS; a < NO_AXES; a++)
+ dim_cache_[a].clear ();
+
mutable_property_alist_ = SCM_EOL;
object_alist_ = SCM_EOL;
immutable_property_alist_ = SCM_EOL;
{
/* Don't do this in the derived method, since we want to keep access to
object_alist_ centralized. */
- if (original_)
+ if (original ())
{
Item *it = dynamic_cast<Item *> (this);
substitute_object_links (scm_from_int (it->break_status_dir ()),
- original_->object_alist_);
+ original ()->object_alist_);
}
}
return 0;
}
-/* Translate in one direction. */
+/****************************************************************
+ OFFSETS
+****************************************************************/
+
void
Grob::translate_axis (Real y, Axis a)
{
if (isinf (y) || isnan (y))
{
- programming_error (_ (INFINITY_MSG));
+ programming_error (_ ("Infinity or NaN encountered"));
return ;
}
return off;
}
+Real
+Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
+{
+ if (refp == this)
+ return 0.0;
+
+ Real off = 0;
+
+ if (dim_cache_[Y_AXIS].offset_)
+ off = *dim_cache_[Y_AXIS].offset_;
+ else
+ {
+ SCM proc = get_property_data ("Y-offset");
+
+ dim_cache_[Y_AXIS].offset_ = new Real (0.0);
+ off = robust_scm2double (call_pure_function (proc,
+ scm_list_1 (self_scm ()),
+ start, end),
+ 0.0);
+ delete dim_cache_[Y_AXIS].offset_;
+ dim_cache_[Y_AXIS].offset_ = 0;
+ }
+
+ /* we simulate positioning-done if we are the child of a VerticalAlignment,
+ but only if we don't have a cached offset. If we do have a cached offset,
+ it probably means that the Alignment was fixed and it has already been
+ calculated.
+ */
+ if (Grob *p = get_parent (Y_AXIS))
+ {
+ Real trans = 0;
+ if (Align_interface::has_interface (p) && !dim_cache_[Y_AXIS].offset_)
+ trans = Align_interface::get_pure_child_y_translation (p, this, start, end);
+
+ return off + trans + p->pure_relative_y_coordinate (refp, start, end);
+ }
+ return off;
+}
+
/* Invoke callbacks to get offset relative to parent. */
Real
Grob::get_offset (Axis a) const
SCM sym = axis_offset_symbol (a);
me->dim_cache_[a].offset_ = new Real (0.0);
- *me->dim_cache_[a].offset_ += robust_scm2double (internal_get_property (sym), 0.0);
- me->del_property (sym);
- return *me->dim_cache_[a].offset_;
+ /*
+ UGH: can't fold next 2 statements together. Apparently GCC thinks
+ dim_cache_[a].offset_ is unaliased.
+ */
+ Real off = robust_scm2double (internal_get_property (sym), 0.0);
+ if (me->dim_cache_[a].offset_)
+ {
+ *me->dim_cache_[a].offset_ += off;
+ me->del_property (sym);
+ return *me->dim_cache_[a].offset_;
+ }
+ else
+ return 0.0;
+}
+
+Real
+Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end)
+{
+ if (pure && a != Y_AXIS)
+ programming_error ("tried to get pure X-offset");
+ return (pure && a == Y_AXIS) ? pure_relative_y_coordinate (refp, start, end)
+ : relative_coordinate (refp, a);
}
+/****************************************************************
+ extents
+****************************************************************/
+
void
Grob::flush_extent_cache (Axis axis)
{
}
else
{
- SCM min_ext_sym =
- (a == X_AXIS)
- ? ly_symbol2scm ("minimum-X-extent")
- : ly_symbol2scm ("minimum-Y-extent");
-
+ /*
+ Order is significant: ?-extent may trigger suicide.
+ */
SCM ext_sym =
(a == X_AXIS)
? ly_symbol2scm ("X-extent")
: ly_symbol2scm ("Y-extent");
-
- SCM min_ext = internal_get_property (min_ext_sym);
+
SCM ext = internal_get_property (ext_sym);
+ if (is_number_pair (ext))
+ real_ext.unite (ly_scm2interval (ext));
+ SCM min_ext_sym =
+ (a == X_AXIS)
+ ? ly_symbol2scm ("minimum-X-extent")
+ : ly_symbol2scm ("minimum-Y-extent");
+ SCM min_ext = internal_get_property (min_ext_sym);
if (is_number_pair (min_ext))
real_ext.unite (ly_scm2interval (min_ext));
- if (is_number_pair (ext))
- real_ext.unite (ly_scm2interval (ext));
- ((Grob*)this)->del_property (ext_sym);
((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext);
}
return real_ext;
}
+Interval
+Grob::pure_height (Grob *refp, int start, int end)
+{
+ SCM proc = get_property_data (ly_symbol2scm ("Y-extent"));
+ SCM iv_scm = call_pure_function (proc,
+ scm_list_1 (self_scm ()),
+ start, end);
+ Interval iv = robust_scm2interval (iv_scm, Interval (0, 0));
+ Real offset = pure_relative_y_coordinate (refp, start, end);
+
+ SCM min_ext = get_property ("minimum-Y-extent");
+
+ /* we don't add minimum-Y-extent if the extent is empty. This solves
+ a problem with Hara-kiri spanners. They would request_suicide and
+ return empty extents, but we would force them here to be large. */
+ if (!iv.is_empty () && is_number_pair (min_ext))
+ iv.unite (ly_scm2interval (min_ext));
+
+ iv.translate (offset);
+ return iv;
+}
+
+Interval
+Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end)
+{
+ if (pure && a != Y_AXIS)
+ programming_error ("tried to get pure width");
+ return (pure && a == Y_AXIS) ? pure_height (refp, start, end) : extent (refp, a);
+}
+
+Interval_t<int>
+Grob::spanned_rank_iv () const
+{
+ return Interval_t<int> (-1, 0);
+}
+
+/****************************************************************
+ REFPOINTS
+****************************************************************/
+
/* Find the group-element which has both #this# and #s# */
Grob *
Grob::common_refpoint (Grob const *s, Axis a) const
return 0;
}
-Grob *
-common_refpoint_of_list (SCM elist, Grob *common, Axis a)
+void
+Grob::set_parent (Grob *g, Axis a)
{
- for (; scm_is_pair (elist); elist = scm_cdr (elist))
- if (Grob *s = unsmob_grob (scm_car (elist)))
- {
- if (common)
- common = common->common_refpoint (s, a);
- else
- common = s;
- }
-
- return common;
+ dim_cache_[a].parent_ = g;
}
Grob *
-common_refpoint_of_array (Link_array<Grob> const &arr, Grob *common, Axis a)
-{
- for (int i = arr.size (); i--;)
- if (Grob *s = arr[i])
- {
- if (common)
- common = common->common_refpoint (s, a);
- else
- common = s;
- }
-
- return common;
-}
-
-String
-Grob::name () const
+Grob::get_parent (Axis a) const
{
- SCM meta = get_property ("meta");
- SCM nm = scm_assq (ly_symbol2scm ("name"), meta);
- nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
- return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name ();
+ return dim_cache_[a].parent_;
}
-void
-Grob::set_parent (Grob *g, Axis a)
-{
- dim_cache_[a].parent_ = g;
-}
void
Grob::fixup_refpoint ()
}
}
+
+/****************************************************************
+ MESSAGES
+****************************************************************/
void
-Grob::warning (String s) const
+Grob::warning (string s) const
{
SCM cause = self_scm ();
while (Grob *g = unsmob_grob (cause))
cause = g->get_property ("cause");
+ /* ES TODO: cause can't be Music*/
if (Music *m = unsmob_music (cause))
m->origin ()->warning (s);
+ else if (Stream_event *ev = unsmob_stream_event (cause))
+ ev->origin ()->warning (s);
else
::warning (s);
}
+
+string
+Grob::name () const
+{
+ SCM meta = get_property ("meta");
+ SCM nm = scm_assq (ly_symbol2scm ("name"), meta);
+ nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
+ return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name ();
+}
+
void
-Grob::programming_error (String s) const
+Grob::programming_error (string s) const
{
SCM cause = self_scm ();
while (Grob *g = unsmob_grob (cause))
s = _f ("programming error: %s", s);
+ /* ES TODO: cause can't be Music*/
if (Music *m = unsmob_music (cause))
m->origin ()->message (s);
+ else if (Stream_event *ev = unsmob_stream_event (cause))
+ ev->origin ()->warning (s);
else
::message (s);
}
-void
-Grob::discretionary_processing ()
-{
-}
-
-bool
-Grob::internal_has_interface (SCM k)
-{
- return scm_c_memq (k, interfaces_) != SCM_BOOL_F;
-}
-
-Grob *
-Grob::get_parent (Axis a) const
-{
- return dim_cache_[a].parent_;
-}
-/** Return Array of Grobs in SCM list LST */
-Link_array<Grob>
-ly_scm2grobs (SCM lst)
-{
- Link_array<Grob> arr;
-
- for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s))
- {
- SCM e = scm_car (s);
- arr.push (unsmob_grob (e));
- }
-
- arr.reverse ();
- return arr;
-}
-Object_key const *
-Grob::get_key () const
-{
- return key_;
-}
-
-/** Return SCM list of Grob array A */
-SCM
-ly_grobs2scm (Link_array<Grob> a)
-{
- SCM s = SCM_EOL;
- for (int i = a.size (); i; i--)
- s = scm_cons (a[i - 1]->self_scm (), s);
-
- return s;
-}
-
-ADD_INTERFACE (Grob, "grob-interface",
+ADD_INTERFACE (Grob,
"A grob represents a piece of music notation\n"
"\n"
"All grobs have an X and Y-position on the page. These X and Y positions\n"
"Y-extent "
"Y-offset "
"after-line-breaking "
+ "avoid-slur "
"axis-group-parent-X "
"axis-group-parent-Y "
"before-line-breaking "
"cause "
"color "
+ "cross-staff "
"extra-X-extent "
"extra-Y-extent "
"extra-offset "
"meta "
"minimum-X-extent "
"minimum-Y-extent "
+ "outside-staff-horizontal-padding "
+ "outside-staff-padding "
+ "outside-staff-priority "
+ "rotation "
"springs-and-rods "
"staff-symbol "
"stencil "
"transparent "
);
+/****************************************************************
+ CALLBACKS
+****************************************************************/
+
+static SCM
+grob_stencil_extent (Grob *me, Axis a)
+{
+ Stencil *m = me->get_stencil ();
+ Interval e;
+ if (m)
+ e = m->extent (a);
+ return ly_interval2scm (e);
+}
+
+
+MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1);
+SCM
+Grob::stencil_height (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ return grob_stencil_extent (me, Y_AXIS);
+}
+
+MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1);
+SCM
+Grob::y_parent_positioning (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ Grob *par = me->get_parent (Y_AXIS);
+ if (par)
+ (void) par->get_property ("positioning-done");
+
+ return scm_from_double (0.0);
+}
+
+
+MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1);
+SCM
+Grob::x_parent_positioning (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+
+ Grob *par = me->get_parent (X_AXIS);
+ if (par)
+ (void) par->get_property ("positioning-done");
+
+ return scm_from_double (0.0);
+}
+
+MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1);
+SCM
+Grob::stencil_width (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ return grob_stencil_extent (me, X_AXIS);
+}
+
+
+
+Grob *
+common_refpoint_of_list (SCM elist, Grob *common, Axis a)
+{
+ for (; scm_is_pair (elist); elist = scm_cdr (elist))
+ if (Grob *s = unsmob_grob (scm_car (elist)))
+ {
+ if (common)
+ common = common->common_refpoint (s, a);
+ else
+ common = s;
+ }
+
+ return common;
+}
+
+Grob *
+common_refpoint_of_array (vector<Grob*> const &arr, Grob *common, Axis a)
+{
+ for (vsize i = arr.size (); i--;)
+ if (Grob *s = arr[i])
+ {
+ if (common)
+ common = common->common_refpoint (s, a);
+ else
+ common = s;
+ }
+
+ return common;
+}
+
+Interval
+robust_relative_extent (Grob *me, Grob *refpoint, Axis a)
+{
+ Interval ext = me->extent (refpoint, a);
+ if (ext.is_empty ())
+ ext.add_point (me->relative_coordinate (refpoint, a));
+
+ return ext;
+}
+