]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob.cc
release commit
[lilypond.git] / lily / grob.cc
index 7daa21f1d48d3344867942c0a893c79ed51be0f3..d1e515fda9a8fb8a7f91dc190e630b3ff1597b2f 100644 (file)
@@ -21,7 +21,7 @@
 #include "grob.hh"
 #include "debug.hh"
 #include "spanner.hh"
-#include "line-of-score.hh"
+#include "system.hh"
 #include "item.hh"
 #include "paper-column.hh"
 #include "molecule.hh"
@@ -54,8 +54,27 @@ Grob::Grob (SCM basicprops)
   immutable_property_alist_ =  basicprops;
   mutable_property_alist_ = SCM_EOL;
 
+  /*
+    We do smobify_self() as the first step. Since the object lives on
+    the heap, none of its SCM variables are protected from GC. After
+    smobify_self(), they are.
+   */
   smobify_self ();
 
+
+  SCM meta = get_grob_property ("meta");
+  if (gh_pair_p (meta))
+    {
+      SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
+
+      /*
+       do it directly to bypass interface checks.
+       */
+      mutable_property_alist_ = gh_cons (gh_cons (ly_symbol2scm ("interfaces"),
+                                                 gh_cdr (ifs)),
+                                        mutable_property_alist_);
+    }
+  
   /*
     TODO:
 
@@ -94,18 +113,6 @@ Grob::Grob (SCM basicprops)
       dim_cache_[a].dimension_ = cb;
     }
 
-  SCM meta = get_grob_property ("meta");
-  if (gh_pair_p (meta))
-    {
-      SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
-
-      /*
-       do it directly to bypass interface checks.
-       */
-      mutable_property_alist_ = gh_cons (gh_cons (ly_symbol2scm ("interfaces"),
-                                                 gh_cdr (ifs)),
-                                        mutable_property_alist_);
-    }
 }
 
 Grob::Grob (Grob const&s)
@@ -114,11 +121,17 @@ Grob::Grob (Grob const&s)
   original_l_ = (Grob*) &s;
   immutable_property_alist_ = s.immutable_property_alist_;
   mutable_property_alist_ = SCM_EOL;
+
+  /*
+    No properties are copied. That is the job of handle_broken_dependencies.
+   */
   
   status_c_ = s.status_c_;
   pscore_l_ = s.pscore_l_;
 
   smobify_self ();
+
+
 }
 
 Grob::~Grob ()
@@ -129,6 +142,25 @@ Grob::~Grob ()
 }
 
 
+
+extern void check_interfaces_for_property (Grob const *me, SCM sym);
+
+void
+Grob::internal_set_grob_property (SCM s, SCM v)
+{
+#ifndef NDEBUG
+  if (internal_type_checking_global_b)
+    {
+      assert (type_check_assignment (s, v, ly_symbol2scm ("backend-type?")));
+      check_interfaces_for_property(this, s);
+    }
+#endif
+
+  
+  mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
+}
+
+
 SCM
 Grob::internal_get_grob_property (SCM sym) const
 {
@@ -137,6 +169,15 @@ Grob::internal_get_grob_property (SCM sym) const
     return ly_cdr (s);
 
   s = scm_sloppy_assq (sym, immutable_property_alist_);
+  
+#ifndef NDEBUG
+  if (internal_type_checking_global_b && gh_pair_p (s))
+    {
+      assert (type_check_assignment (sym, gh_cdr (s), ly_symbol2scm ("backend-type?")));
+      check_interfaces_for_property(this, sym);
+    }
+#endif
+
   return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s); 
 }
 
@@ -155,44 +196,6 @@ Grob::remove_grob_property (const char* key)
 }
 
 
-#if 0
-/*
-  Puts the k, v in the immutable_property_alist_, which is convenient for
-  storing variables that are needed during the breaking process. (eg.
-  System::rank : int)
- */
-void
-Grob::set_immutable_grob_property (const char*k, SCM v)
-{
-  SCM s = ly_symbol2scm (k);
-  set_immutable_grob_property (s, v);
-}
-
-void
-Grob::set_immutable_grob_property (SCM s, SCM v)
-{
-  immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
-  mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
-}
-#endif
-
-extern void check_interfaces_for_property (Grob *me, SCM sym);
-
-void
-Grob::internal_set_grob_property (SCM s, SCM v)
-{
-#ifndef NDEBUG
-  if (internal_type_checking_global_b)
-    {
-      assert (type_check_assignment (s, v, ly_symbol2scm ("backend-type?")));
-      check_interfaces_for_property(this, s);
-    }
-#endif
-
-  
-  mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
-}
-
 
 MAKE_SCHEME_CALLBACK (Grob,molecule_extent,2);
 SCM
@@ -209,7 +212,6 @@ Grob::molecule_extent (SCM element_smob, SCM scm_axis)
 }
 
 MAKE_SCHEME_CALLBACK (Grob,preset_extent,2);
-
 SCM
 Grob::preset_extent (SCM element_smob, SCM scm_axis)
 {
@@ -259,15 +261,11 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname)
        ->calculate_dependencies (final, busy, funcname);
     }
 
-  // ughugh.
-  String s = ly_symbol2string (funcname);
-  SCM proc = get_grob_property (s.ch_C ());
+  
+  SCM proc = internal_get_grob_property (funcname);
   if (gh_procedure_p (proc))
     gh_call1 (proc, this->self_scm ());
-  else if (gh_list_p (proc))
-    for (SCM i = proc; gh_pair_p (i); i = ly_cdr (i))
-      gh_call1 (ly_car (i), this->self_scm ());
-  
   status_c_= final;
 }
 
@@ -369,99 +367,6 @@ Grob::add_dependency (Grob*e)
 
 
 
-
-/**
-      Do break substitution in S, using CRITERION. Return new value.
-      CRITERION is either a SMOB pointer to the desired line, or a number
-      representing the break direction. Do not modify SRC.
-
-      It is rather tightly coded, since it takes a lot of time; it is
-      one of the top functions in the profile.
-
-*/
-SCM
-Grob::handle_broken_grobs (SCM src, SCM criterion)
-{
- again:
-  Grob *sc = unsmob_grob (src);
-  if (sc)
-    {
-      if (SCM_INUMP (criterion))
-       {
-         Item * i = dynamic_cast<Item*> (sc);
-         Direction d = to_dir (criterion);
-         if (i && i->break_status_dir () != d)
-           {
-             Item *br = i->find_prebroken_piece (d);
-             return (br) ? br->self_scm () : SCM_UNDEFINED;
-           }
-       }
-      else
-       {
-         System * line
-           = dynamic_cast<System*> (unsmob_grob (criterion));
-         if (sc->line_l () != line)
-           {
-             sc = sc->find_broken_piece (line);
-
-           }
-
-         /* now: !sc || (sc && sc->line_l () == line) */
-         if (!sc)
-           return SCM_UNDEFINED;
-
-         /* now: sc && sc->line_l () == line */
-         if (!line)
-           return sc->self_scm();
-         /*
-           This was introduced in 1.3.49 as a measure to prevent
-           programming errors. It looks expensive (?).
-
-           TODO:
-               
-           benchmark , document when (what kind of programming
-           errors) this happens.
-         */
-         if (sc->common_refpoint (line, X_AXIS)
-              && sc->common_refpoint (line, Y_AXIS))
-           {
-             return sc->self_scm ();
-           }
-         return SCM_UNDEFINED;
-       }
-    }
-  else if (ly_pair_p (src)) // SCM_CONSP (src))  // huh?
-    {
-      SCM oldcar =ly_car (src);
-      /*
-       UGH! breaks on circular lists.
-      */
-      SCM newcar = handle_broken_grobs (oldcar, criterion);
-      SCM oldcdr = ly_cdr (src);
-      
-      if (newcar == SCM_UNDEFINED
-         && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL))
-       {
-         /*
-           This is tail-recursion, ie. 
-           
-           return handle_broken_grobs (cdr, criterion);
-
-           We don't want to rely on the compiler to do this.  Without
-           tail-recursion, this easily crashes with a stack overflow.  */
-         src =  oldcdr;
-         goto again;
-       }
-
-      SCM newcdr = handle_broken_grobs (oldcdr, criterion);
-      return scm_cons (newcar, newcdr);
-    }
-  else
-    return src;
-
-  return src;
-}
-
 void
 Grob::handle_broken_dependencies ()
 {
@@ -475,9 +380,11 @@ Grob::handle_broken_dependencies ()
        {
          Grob * sc = s->broken_into_l_arr_[i];
          System * l = sc->line_l ();
+
+         set_break_subsititution (l ? l->self_scm () : SCM_UNDEFINED);
          sc->mutable_property_alist_ =
-           handle_broken_grobs (mutable_property_alist_,
-                                l ? l->self_scm () : SCM_UNDEFINED);
+           substitute_mutable_properties (mutable_property_alist_);
+
        }
     }
 
@@ -486,14 +393,13 @@ Grob::handle_broken_dependencies ()
 
   if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
     {
-      mutable_property_alist_
-       = handle_broken_grobs (mutable_property_alist_,
-                              line ? line->self_scm () : SCM_UNDEFINED);
+      set_break_subsititution (line ? line->self_scm () : SCM_UNDEFINED);
+      mutable_property_alist_ = substitute_mutable_properties (mutable_property_alist_);
     }
   else if (dynamic_cast <System*> (this))
     {
-      mutable_property_alist_ = handle_broken_grobs (mutable_property_alist_,
-                                           SCM_UNDEFINED);
+      set_break_subsititution (SCM_UNDEFINED);
+      mutable_property_alist_ = substitute_mutable_properties (mutable_property_alist_);
     }
   else
     {
@@ -501,9 +407,10 @@ Grob::handle_broken_dependencies ()
        This element is `invalid'; it has been removed from all
        dependencies, so let's junk the element itself.
 
-       do not do this for System, since that would remove
-       references to the originals of score-elts, which get then GC'd
- (a bad thing.)
+       do not do this for System, since that would remove references
+       to the originals of score-grobs, which get then GC'd (a bad
+       thing.)
       */
       suicide ();
     }
@@ -520,8 +427,8 @@ Grob::suicide ()
   mutable_property_alist_ = SCM_EOL;
   immutable_property_alist_ = SCM_EOL;
 
-  set_extent_callback (SCM_EOL, Y_AXIS);
-  set_extent_callback (SCM_EOL, X_AXIS);
+  set_extent (SCM_EOL, Y_AXIS);
+  set_extent (SCM_EOL, X_AXIS);
 
   for (int a= X_AXIS; a <= Y_AXIS; a++)
     {
@@ -541,6 +448,9 @@ Grob::find_broken_piece (System*) const
   return 0;
 }
 
+/*
+  translate in one direction
+*/
 void
 Grob::translate_axis (Real y, Axis a)
 {
@@ -552,6 +462,13 @@ Grob::translate_axis (Real y, Axis a)
     }
 }  
 
+
+/*
+  Find the offset relative to D.  If   D equals THIS, then it is 0.
+  Otherwise, it recursively defd as
+  
+  OFFSET_ + PARENT_L_->relative_coordinate (D)
+*/
 Real
 Grob::relative_coordinate (Grob const*refp, Axis a) const
 {
@@ -569,6 +486,11 @@ Grob::relative_coordinate (Grob const*refp, Axis a) const
     return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a);
 }
 
+
+  
+/*
+  Invoke callbacks to get offset relative to parent.
+*/
 Real
 Grob::get_offset (Axis a) const
 {
@@ -657,6 +579,9 @@ Grob::extent (Grob * refp, Axis a) const
   return ext;
 }
 
+/*
+  Find the group-element which has both #this# and #s#
+*/
 Grob * 
 Grob::common_refpoint (Grob const* s, Axis a) const
 {
@@ -674,14 +599,37 @@ Grob::common_refpoint (Grob const* s, Axis a) const
 
 
 Grob *
-Grob::common_refpoint (SCM elist, Axis a) const
+common_refpoint_of_list (SCM elist, Grob *common, Axis a) 
 {
-  Grob * common = (Grob*) this;
   for (; gh_pair_p (elist); elist = ly_cdr (elist))
     {
       Grob * s = unsmob_grob (ly_car (elist));
-      if (s)
+      if (!s)
+       continue;
+      if (common)
        common = common->common_refpoint (s, a);
+      else
+       common = s;
+    }
+
+  return common;
+}
+
+
+
+Grob *
+common_refpoint_of_array (Link_array<Grob> const &arr, Grob *common, Axis a) 
+{
+  for (int i = arr.size() ; i--; )
+    {
+      Grob * s = arr[i];
+      if (!s)
+       continue;
+
+      if (common)
+       common = common->common_refpoint (s, a);
+      else
+       common = s;
     }
 
   return common;
@@ -713,12 +661,6 @@ Grob::has_extent_callback_b (SCM cb, Axis a)const
 }
 
 
-bool
-Grob::has_extent_callback_b (Axis a) const
-{
-  return gh_procedure_p (dim_cache_[a].dimension_);
-}
-
 bool
 Grob::has_offset_callback_b (SCM cb, Axis a)const
 {
@@ -726,7 +668,7 @@ Grob::has_offset_callback_b (SCM cb, Axis a)const
 }
 
 void
-Grob::set_extent_callback (SCM dc, Axis a)
+Grob::set_extent (SCM dc, Axis a)
 {
   dim_cache_[a].dimension_ =dc;
 }
@@ -775,7 +717,7 @@ Grob::fixup_refpoint (SCM smob)
 }
 
 void
-Grob::warning (String s)
+Grob::warning (String s)const
 {
   SCM cause = self_scm();
   while (cause != SCM_EOL && !unsmob_music (cause))
@@ -790,7 +732,13 @@ Grob::warning (String s)
     }
   else
     ::warning (s);
-      
+}
+
+void
+Grob::programming_error (String s)const
+{
+  s = "Programming error: "  + s;
+  warning (s);
 }
 
 
@@ -814,9 +762,15 @@ Grob::mark_smob (SCM ses)
     {
       scm_gc_mark (s->dim_cache_[a].offset_callbacks_);
       scm_gc_mark (s->dim_cache_[a].dimension_);
-      Grob *p = s->get_parent (Y_AXIS);
-      if (p)
-       scm_gc_mark (p->self_scm ());
+      
+      /*
+       don't mark the parents. The pointers in the mutable property
+       list form two tree like structures (one for X relations, one
+       for Y relations). Marking these can be done in limited stack
+       space.  If we add the parents, we will jump between X and Y in
+       an erratic manner, leading to much more recursion depth (and
+       core dumps if we link to pthreads.)
+       */
     }
   
   if (s->original_l_)
@@ -847,117 +801,27 @@ Grob::do_derived_mark ()
 }
 
 
-SCM
-ly_set_grob_property (SCM elt, SCM sym, SCM val)
-{
-  Grob * sc = unsmob_grob (elt);
-  SCM_ASSERT_TYPE(sc, elt, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE(gh_symbol_p(sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
-
-  if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
-    error ("typecheck failed");
-      
-  sc->internal_set_grob_property (sym, val);
-  return SCM_UNSPECIFIED;
-}
-
-
-SCM
-ly_get_grob_property (SCM elt, SCM sym)
-{
-  Grob * sc = unsmob_grob (elt);
-  SCM_ASSERT_TYPE(sc, elt, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE(gh_symbol_p(sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
-
-  return sc->internal_get_grob_property (sym);
-}
-
 
 void
 Grob::discretionary_processing ()
 {
 }
 
-
-
-SCM
-spanner_get_bound (SCM slur, SCM dir)
-{
-  Spanner * sl = dynamic_cast<Spanner*> (unsmob_grob (slur));
-  SCM_ASSERT_TYPE(sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
-  SCM_ASSERT_TYPE(ly_dir_p (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
-  return sl->get_bound (to_dir (dir))->self_scm ();
-}
-
-SCM
-ly_get_paper_var (SCM grob, SCM sym)
-{
-  Grob * sc = unsmob_grob (grob);
-  SCM_ASSERT_TYPE(sc, grob, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE(gh_symbol_p(sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
-
-  return sc->paper_l() ->get_scmvar_scm (sym);
-}
-
-
-
-SCM
-ly_get_extent (SCM grob, SCM refp, SCM axis)
-{
-  Grob * sc = unsmob_grob (grob);
-  Grob * ref = unsmob_grob (refp);
-  SCM_ASSERT_TYPE(sc, grob, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE(ref, refp, SCM_ARG2, __FUNCTION__, "grob");
-  
-  SCM_ASSERT_TYPE(ly_axis_p(axis), axis, SCM_ARG3, __FUNCTION__, "axis");
-
-  return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
-}
-
-SCM
-ly_get_parent (SCM grob, SCM axis)
-{
-  Grob * sc = unsmob_grob (grob);
-  SCM_ASSERT_TYPE(sc, grob, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE(ly_axis_p(axis), axis, SCM_ARG2, __FUNCTION__, "axis");
-
-  return sc->get_parent (Axis (gh_scm2int (axis)))->self_scm();
-}
-
-
-static void
-init_functions ()
-{
-  scm_c_define_gsubr ("ly-get-grob-property", 2, 0, 0,
-                     (Scheme_function_unknown)ly_get_grob_property);
-  scm_c_define_gsubr ("ly-set-grob-property", 3, 0, 0,
-                     (Scheme_function_unknown)ly_set_grob_property);
-  scm_c_define_gsubr ("ly-get-spanner-bound", 2 , 0, 0,
-                     (Scheme_function_unknown) spanner_get_bound);
-  scm_c_define_gsubr ("ly-get-paper-variable", 2, 0, 0,
-                     (Scheme_function_unknown) ly_get_paper_var);
-  scm_c_define_gsubr ("ly-get-extent", 3, 0, 0,
-                     (Scheme_function_unknown) ly_get_extent);
-  scm_c_define_gsubr ("ly-get-parent", 2, 0, 0,
-                     (Scheme_function_unknown) ly_get_parent);
-}
-
 bool
-Grob::has_interface (SCM k)
+Grob::internal_has_interface (SCM k)
 {
   SCM ifs = get_grob_property ("interfaces");
 
   return scm_memq (k, ifs) != SCM_BOOL_F;
 }
 
-
-ADD_SCM_INIT_FUNC (scoreelt, init_functions);
 IMPLEMENT_TYPE_P (Grob, "ly-grob?");
 
 ADD_INTERFACE (Grob, "grob-interface",
   "All grobs support this",
   "X-offset-callbacks Y-offset-callbacks X-extent-callback molecule cause
-Y-extent-callback molecule-callback font-relative-size extra-offset
-staff-symbol interfaces dependencies no-spacing-rods extra-extent-X causes
-layer extra-extent-Y minimum-extent-X minimum-extent-Y transparent");
+Y-extent-callback molecule-callback extra-offset
+spacing-procedure
+staff-symbol interfaces dependencies extra-extent-X causes meta
+layer before-line-breaking-callback after-line-breaking-callback extra-extent-Y minimum-extent-X minimum-extent-Y transparent");