]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob.cc
Fix issue 542: Harden Grob::relative_coordinate()
[lilypond.git] / lily / grob.cc
index f79b266b08ee4e6f36f01cd5e22912d5b0bce838..7f78b5ff60112937bc5745106da7e2b96535fcab 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "grob.hh"
@@ -11,7 +11,7 @@
 #include <cstring>
 
 #include "align-interface.hh"
-#include "input-smob.hh"
+#include "input.hh"
 #include "international.hh"
 #include "item.hh"
 #include "main.hh"
 #include "output-def.hh"
 #include "pointer-group-interface.hh"
 #include "stencil.hh"
+#include "stream-event.hh"
 #include "system.hh"
 #include "warn.hh"
 
 #include "ly-smobs.icc"
 
 Grob *
-Grob::clone (int count) const
+Grob::clone () const
 {
-  return new Grob (*this, count);
+  return new Grob (*this);
 }
 
-Grob::Grob (SCM basicprops,
-           Object_key const *key)
+Grob::Grob (SCM basicprops)        
 {
-  key_ = key;
+  
   /* FIXME: default should be no callback.  */
   self_scm_ = SCM_EOL;
   layout_ = 0;
@@ -49,26 +49,28 @@ Grob::Grob (SCM 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;
 
@@ -80,8 +82,6 @@ Grob::Grob (Grob const &s, int copy_index)
   layout_ = 0;
 
   smobify_self ();
-  if (key_)
-    ((Object_key *)key_)->unprotect ();
 }
 
 Grob::~Grob ()
@@ -120,6 +120,7 @@ Grob::get_print_stencil () const
 
          retval = Stencil (m->extent_box (), expr);
        }
+
       SCM rot = get_property ("rotation");
       if (scm_is_pair (rot))
        {
@@ -127,19 +128,18 @@ Grob::get_print_stencil () const
          Real x = scm_to_double (scm_cadr (rot));
          Real y = scm_to_double (scm_caddr (rot));
 
-         retval.rotate (angle, Offset (x, y));
+         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);
        }
 
     }
@@ -265,7 +265,8 @@ Grob::translate_axis (Real y, Axis a)
 Real
 Grob::relative_coordinate (Grob const *refp, Axis a) const
 {
-  if (refp == this)
+  /* eaa - hmmm, should we do a programming_error() here? */
+  if ((this == NULL) || (refp == this))
     return 0.0;
 
   /* We catch PARENT_L_ == nil case with this, but we crash if we did
@@ -285,29 +286,44 @@ Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
   if (refp == this)
     return 0.0;
 
-  SCM pure_off = ly_lily_module_constant ("pure-Y-offset");
   Real off = 0;
 
   if (dim_cache_[Y_AXIS].offset_)
-    off = *dim_cache_[Y_AXIS].offset_;
-  else if (ly_is_procedure (pure_off))
     {
+      if (to_boolean (get_property ("pure-Y-offset-in-progress")))
+       programming_error ("cyclic chain in pure-Y-offset callbacks");
+
+      off = *dim_cache_[Y_AXIS].offset_;
+    }
+  else
+    {
+      SCM proc = get_property_data ("Y-offset");
+
       dim_cache_[Y_AXIS].offset_ = new Real (0.0);
-      off = scm_to_double (scm_apply_3 (pure_off, self_scm (),
-                                       scm_from_int (start), scm_from_int (end),
-                                       SCM_EOL));
+      set_property ("pure-Y-offset-in-progress", SCM_BOOL_T);
+      off = robust_scm2double (call_pure_function (proc,
+                                                  scm_list_1 (self_scm ()),
+                                                  start, end),
+                              0.0);
+      del_property ("pure-Y-offset-in-progress");
       delete dim_cache_[Y_AXIS].offset_;
       dim_cache_[Y_AXIS].offset_ = 0;
     }
 
-  /* we simulate positioning-done if we are the child of a VerticalAlignment */
-  Grob *p = get_parent (Y_AXIS);
-  Real trans = 0;
-  if (Align_interface::has_interface (p))
-    trans = Align_interface::get_pure_child_y_translation (p, this, start, end);
+  /* 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
-    + dim_cache_[Y_AXIS].parent_->pure_relative_y_coordinate (refp, start, end);
+      return off + trans + p->pure_relative_y_coordinate (refp, start, end);
+    }
+  return off;
 }
 
 /* Invoke callbacks to get offset relative to parent.  */
@@ -386,7 +402,7 @@ Grob::extent (Grob *refp, Axis a) const
        (a == X_AXIS)
        ? ly_symbol2scm ("X-extent")
        : ly_symbol2scm ("Y-extent");
-
+       
       SCM ext = internal_get_property (ext_sym);
       if (is_number_pair (ext))
        real_ext.unite (ly_scm2interval (ext));
@@ -398,6 +414,7 @@ Grob::extent (Grob *refp, Axis a) const
       SCM min_ext = internal_get_property (min_ext_sym);
       if (is_number_pair (min_ext))
        real_ext.unite (ly_scm2interval (min_ext));
+
       ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext);  
     }
   
@@ -409,16 +426,23 @@ Grob::extent (Grob *refp, Axis a) const
 Interval
 Grob::pure_height (Grob *refp, int start, int end)
 {
-  SCM pure_height = ly_lily_module_constant ("pure-Y-extent");
-  Interval iv (0, 0);
-
-  if (ly_is_procedure (pure_height))
-    iv = ly_scm2interval (scm_apply_3 (pure_height, self_scm (),
-                                      scm_from_int (start), scm_from_int (end),
-                                      SCM_EOL));
+  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);
 
-  iv.translate (offset);
+  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));
+
+  if (!iv.is_empty ())
+    iv.translate (offset);
   return iv;
 }
 
@@ -431,9 +455,9 @@ Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end)
 }
 
 Interval_t<int>
-Grob::spanned_rank_iv ()
+Grob::spanned_rank_interval () const
 {
-  return Interval_t<int> (INT_MIN, INT_MAX);
+  return Interval_t<int> (-1, 0);
 }
 
 /****************************************************************
@@ -513,8 +537,11 @@ Grob::warning (string s) const
   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);
 }
@@ -538,14 +565,17 @@ Grob::programming_error (string s) const
 
   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);
 }
 
 
-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"
@@ -586,11 +616,13 @@ ADD_INTERFACE (Grob, "grob-interface",
               "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 "
@@ -599,6 +631,10 @@ ADD_INTERFACE (Grob, "grob-interface",
               "meta "
               "minimum-X-extent "
               "minimum-Y-extent "
+              "outside-staff-horizontal-padding "
+              "outside-staff-padding "
+              "outside-staff-priority "
+              "pure-Y-offset-in-progress "
               "rotation "
               "springs-and-rods "
               "staff-symbol "
@@ -606,15 +642,10 @@ ADD_INTERFACE (Grob, "grob-interface",
               "transparent "
               );
 
-
-
-
-
 /****************************************************************
   CALLBACKS
 ****************************************************************/
 
-
 static SCM
 grob_stencil_extent (Grob *me, Axis a)
 {
@@ -634,7 +665,7 @@ Grob::stencil_height (SCM smob)
   return grob_stencil_extent (me, Y_AXIS);
 }
 
-MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1);
+MAKE_SCHEME_CALLBACK (Grob, y_parent_positioning, 1);
 SCM
 Grob::y_parent_positioning (SCM smob)
 {
@@ -647,7 +678,7 @@ Grob::y_parent_positioning (SCM smob)
 }
 
 
-MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1);
+MAKE_SCHEME_CALLBACK (Grob, x_parent_positioning, 1);
 SCM
 Grob::x_parent_positioning (SCM smob)
 {