]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob.cc
Run `make grand-replace'.
[lilypond.git] / lily / grob.cc
index e377494e7c0022bfe1af74797a035ee13ede77c3..56000a0c129608c8a29767ce05fde61bad0c7088 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--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "grob.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;
@@ -51,15 +49,18 @@ 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 ("X-extent") == SCM_EOL)
     set_property ("X-extent", Grob::stencil_width_proc);
@@ -67,10 +68,9 @@ Grob::Grob (SCM basicprops,
     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;
 
@@ -82,8 +82,6 @@ Grob::Grob (Grob const &s, int copy_index)
   layout_ = 0;
 
   smobify_self ();
-  if (key_)
-    ((Object_key *)key_)->unprotect ();
 }
 
 Grob::~Grob ()
@@ -130,7 +128,7 @@ 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... */
@@ -267,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
@@ -290,16 +289,23 @@ Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
   Real off = 0;
 
   if (dim_cache_[Y_AXIS].offset_)
-    off = *dim_cache_[Y_AXIS].offset_;
+    {
+      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);
+      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;
     }
@@ -309,13 +315,15 @@ Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
      it probably means that the Alignment was fixed and it has already been
      calculated.
   */
-  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);
+  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.  */
@@ -394,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));
@@ -418,11 +426,11 @@ Grob::extent (Grob *refp, Axis a) const
 Interval
 Grob::pure_height (Grob *refp, int start, int end)
 {
-  SCM proc = get_property_data ( ly_symbol2scm ("Y-extent"));
-  Interval iv = robust_scm2interval (call_pure_function (proc,
-                                                        scm_list_1 (self_scm ()),
-                                                        start, end),
-                                    Interval (0, 0));
+  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");
@@ -433,7 +441,8 @@ Grob::pure_height (Grob *refp, int start, int end)
   if (!iv.is_empty () && is_number_pair (min_ext))
     iv.unite (ly_scm2interval (min_ext));
 
-  iv.translate (offset);
+  if (!iv.is_empty ())
+    iv.translate (offset);
   return iv;
 }
 
@@ -446,7 +455,7 @@ 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> (-1, 0);
 }
@@ -567,39 +576,42 @@ Grob::programming_error (string s) const
 
 
 ADD_INTERFACE (Grob,
-              "A grob represents a piece of music notation\n"
+              "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"
-              "are stored in a relative format, so they can easily be combined by\n"
-              "stacking them, hanging one grob to the side of another, and coupling\n"
-              "them into a grouping objects.\n"
+              "All grobs have an X and Y@tie{}position on the page.  These"
+              " X and Y@tie{}positions are stored in a relative format, thus"
+              " they can easily be combined by stacking them, hanging one"
+              " grob to the side of another, or coupling them into grouping"
+              " objects.\n"
               "\n"
-              "Each grob has a reference point (a.k.a.  parent): the position of a grob\n"
-              "is stored relative to that reference point. For example the X-reference\n"
-              "point of a staccato dot usually is the note head that it applies\n"
-              "to. When the note head is moved, the staccato dot moves along\n"
-              "automatically.\n"
+              "Each grob has a reference point (a.k.a.@: parent): The"
+              " position of a grob is stored relative to that reference"
+              " point.  For example, the X@tie{}reference point of a staccato"
+              " dot usually is the note head that it applies to.  When the"
+              " note head is moved, the staccato dot moves along"
+              " automatically.\n"
               "\n"
-              "A grob is often associated with a symbol, but some grobs do not print\n"
-              "any symbols. They take care of grouping objects. For example, there is a\n"
-              "separate grob that stacks staves vertically. The @ref{NoteCollision}\n"
-              "is also an abstract grob: it only moves around chords, but doesn't print\n"
-              "anything.\n"
+              "A grob is often associated with a symbol, but some grobs do"
+              " not print any symbols.  They take care of grouping objects."
+              " For example, there is a separate grob that stacks staves"
+              " vertically.  The @ref{NoteCollision} object is also an"
+              " abstract grob: It only moves around chords, but doesn't print"
+              " anything.\n"
               "\n"
-              "Grobs have a properties: Scheme variables, that can be read and set. "
-              "They have two types. Immutable variables "
-              "define the default style and behavior.  They are shared between  many objects. "
-              "They can be changed using @code{\\override} and @code{\\revert}. "
-              "\n\n"
-              "Mutable properties are variables that are specific to one grob. Typically, "
-              "lists of other objects, or results from computations are stored in"
-              "mutable properties: every call to set-grob-property (or its C++ equivalent) "
-              "sets a mutable property. "
-              "\n\n"
-              "The properties @code{after-line-breaking} and @code{before-line-breaking} "
-              "are dummies that are not user-serviceable. "
-
-              ,
+              "Grobs have properties (Scheme variables) that can be read and"
+              " set.  Two types of them exist: immutable and mutable."
+              "  Immutable variables define the default style and behavior."
+              "  They are shared between many objects.  They can be changed"
+              " using @code{\\override} and @code{\\revert}.  Mutable"
+              " properties are variables that are specific to one grob."
+              "  Typically, lists of other objects, or results from"
+              " computations are stored in mutable properties.  In"
+              " particular, every call to @code{set-grob-property} (or its"
+              " C++ equivalent) sets a mutable property.\n"
+              "\n"
+              "The properties @code{after-line-breaking} and"
+              " @code{before-line-breaking} are dummies that are not"
+              " user-serviceable.",
 
               /* properties */
               "X-extent "
@@ -613,6 +625,7 @@ ADD_INTERFACE (Grob,
               "before-line-breaking "
               "cause "
               "color "
+              "cross-staff "
               "extra-X-extent "
               "extra-Y-extent "
               "extra-offset "
@@ -621,8 +634,10 @@ ADD_INTERFACE (Grob,
               "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 "
@@ -630,15 +645,10 @@ ADD_INTERFACE (Grob,
               "transparent "
               );
 
-
-
-
-
 /****************************************************************
   CALLBACKS
 ****************************************************************/
 
-
 static SCM
 grob_stencil_extent (Grob *me, Axis a)
 {
@@ -658,7 +668,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)
 {
@@ -671,7 +681,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)
 {
@@ -712,14 +722,11 @@ common_refpoint_of_list (SCM elist, Grob *common, Axis a)
 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;
-      }
+  for (vsize i = 0; i < arr.size (); i++)
+    if (common)
+      common = common->common_refpoint (arr[i], a);
+    else
+      common = arr[i];
 
   return common;
 }