]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/score-element.cc
release: 1.3.52
[lilypond.git] / lily / score-element.cc
index 7bbf22594dcc22889d9bfe2a1cb727698277beab..654469111fbb5e62258d449581356f2c8e1f4da9 100644 (file)
 #include "side-position-interface.hh"
 #include "item.hh"
 
+/*
+TODO:
+
+remove dynamic_cast<Spanner,Item> and put this code into respective
+  subclass.
+*/
+
 Score_element::Score_element()
 {
-  output_p_ =0;
   dim_cache_[X_AXIS] = new Dimension_cache;
   dim_cache_[Y_AXIS] = new Dimension_cache;
   dim_cache_[X_AXIS]->elt_l_ = dim_cache_[Y_AXIS]->elt_l_ = this;
-  
+
+  // junkme.
   used_b_ = false;
 
-  dim_cache_[X_AXIS]->set_callback (molecule_extent);
-  dim_cache_[Y_AXIS]->set_callback (molecule_extent); 
+  dim_cache_[X_AXIS]->set_extent_callback (molecule_extent);
+  dim_cache_[Y_AXIS]->set_extent_callback (molecule_extent); 
   used_b_ = false;
   pscore_l_=0;
   lookup_l_ =0;
@@ -51,19 +58,7 @@ Score_element::Score_element()
 
 
   set_elt_property ("dependencies", SCM_EOL);
-}
-
-SCM ly_deep_copy (SCM);
-
-SCM
-ly_deep_copy (SCM l)
-{
-  if (gh_pair_p (l))
-    {
-      return gh_cons (ly_deep_copy (gh_car (l)), ly_deep_copy (gh_cdr (l)));
-    }
-  else
-    return l;
+  set_elt_property ("interfaces", SCM_EOL);
 }
 
 
@@ -76,13 +71,8 @@ Score_element::Score_element (Score_element const&s)
   self_scm_ = SCM_EOL;
   used_b_ = true;
   original_l_ =(Score_element*) &s;
+  element_property_alist_ = SCM_EOL; // onstack;
 
-  /*
-    should protect because smobify_self () might trigger GC.
-   */
-  element_property_alist_ = scm_protect_object (ly_deep_copy (s.element_property_alist_));
-
-  output_p_ =0;
   status_i_ = s.status_i_;
   lookup_l_ = s.lookup_l_;
   pscore_l_ = s.pscore_l_;
@@ -92,7 +82,6 @@ Score_element::Score_element (Score_element const&s)
 
 Score_element::~Score_element()
 {
-  assert (!output_p_);
   assert (status_i_ >=0);
   status_i_  = -1;
 
@@ -100,19 +89,6 @@ Score_element::~Score_element()
   delete dim_cache_[Y_AXIS];  
 }
 
-
-Real
-Score_element::get_real (String s) const
-{
-  return gh_scm2double (get_elt_property (s));
-}
-
-void
-Score_element::set_real (String s, Real r)
-{
-  set_elt_property (s, gh_double2scm (r));
-}
-
 // should also have one that takes SCM arg. 
 SCM
 Score_element::get_elt_property (String nm) const
@@ -159,11 +135,31 @@ Score_element::set_elt_property (String k, SCM v)
 }
 
 Interval
-Score_element::molecule_extent(Dimension_cache const *c)
+Score_element::molecule_extent (Dimension_cache const *c)
 {
   Score_element *s = dynamic_cast<Score_element*>(c->element_l());
-  Molecule*m = s->do_brew_molecule_p();
-  return  m->extent()[c->axis ()];
+  Molecule m = s->do_brew_molecule();
+  return m.extent()[c->axis ()];
+}
+
+Interval
+Score_element::preset_extent (Dimension_cache const *c)
+{
+  Score_element *s = dynamic_cast<Score_element*>(c->element_l());
+  SCM ext = s->get_elt_property ((c->axis () == X_AXIS)
+                                ? "extent-X"
+                                : "extent-Y");
+  
+  if (gh_pair_p (ext))
+    {
+      Real l = gh_scm2double (gh_car (ext));
+      Real r = gh_scm2double (gh_cdr (ext));
+      l *= s->paper_l ()->get_var ("staffspace");
+      r *= s->paper_l ()->get_var ("staffspace");
+      return Interval (l, r);
+    }
+  
+  return Interval ();
 }
 
 
@@ -214,24 +210,6 @@ Score_element::add_processing()
     return;
   status_i_ ++;
 
-#if 0
-    /*
-    UGH. UGH. UGH.
-   */
-  if (get_elt_property ("self-alignment-X") != SCM_UNDEFINED
-      && !dim_cache_[X_AXIS]->off_callback_l_)
-    {
-      dim_cache_[X_AXIS]->off_callbacks_.push (Side_position_interface::self_alignment);
-    }
-  
-  if (get_elt_property ("self-alignment-Y") != SCM_UNDEFINED
-      && !dim_cache_[X_AXIS]->off_callback_l_)
-      
-    {
-      dim_cache_[Y_AXIS]->set_offset_callback (Side_position_interface::self_alignment);
-    }
-#endif
-  
   do_add_processing();
 }
 
@@ -244,19 +222,20 @@ Score_element::calculate_dependencies (int final, int busy,
   if (status_i_ >= final)
     return;
 
-  assert (status_i_!= busy);
+  if (status_i_== busy)
+    {
+      programming_error ("Element is busy, come back later");
+      return;
+    }
+  
   status_i_= busy;
 
-  Link_array<Score_element> dependency_arr =
-    Group_interface__extract_elements (this, (Score_element*)0, "dependencies");
-  
-  for (int i=0; i < dependency_arr.size(); i++)
-    dependency_arr[i]->calculate_dependencies (final, busy, funcptr);
+  for (SCM d=  get_elt_property ("dependencies"); gh_pair_p (d); d = gh_cdr (d))
+    {
+      unsmob_element (gh_car (d))
+       ->calculate_dependencies (final, busy, funcptr);
+    }
 
-  Link_array<Score_element> extra (get_extra_dependencies());
-  for (int i=0; i < extra.size(); i++)
-    extra[i]->calculate_dependencies (final, busy, funcptr);
-  
   (this->*funcptr)();
   status_i_= final;
 }
@@ -264,14 +243,10 @@ Score_element::calculate_dependencies (int final, int busy,
 void
 Score_element::output_processing () 
 {
-  if (to_boolean  (get_elt_property ("transparent")))
+  if (to_boolean (get_elt_property ("transparent")))
     return;
 
-  // we're being silly here. 
-  if (output_p_)
-    delete output_p_;
-  
-  output_p_ = do_brew_molecule_p ();
+  Molecule m (do_brew_molecule ());
   Offset o (relative_coordinate (0, X_AXIS), relative_coordinate (0, Y_AXIS));
 
   SCM s = get_elt_property ("extra-offset");
@@ -282,12 +257,7 @@ Score_element::output_processing ()
       o[Y_AXIS] += il * gh_scm2double (gh_cdr (s));      
     }
   
-  pscore_l_->outputter_l_->output_molecule (output_p_,
-                                           o,
-                                           classname(this));
-
-  delete output_p_;
-  output_p_ =0;
+  line_l ()->output_molecule (m.expr_, o);
 }
 
 /*
@@ -301,18 +271,13 @@ Score_element::do_break_processing()
 }
 
 void
-Score_element::do_post_processing()
+Score_element::after_line_breaking ()
 {
 }
 
-void
-Score_element::do_breakable_col_processing()
-{
-  handle_prebroken_dependencies();
-}
 
 void
-Score_element::do_pre_processing()
+Score_element::before_line_breaking ()
 {
 }
 
@@ -327,23 +292,23 @@ Score_element::do_add_processing()
 }
 
 
-
-Molecule*
-Score_element::do_brew_molecule_p() const
+/*
+  ugh.
+ */  
+Molecule 
+Score_element::do_brew_molecule() const
 {
   SCM glyph = get_elt_property ("glyph");
   if (gh_string_p (glyph))
     {
-      Molecule*output = new Molecule (lookup_l ()->afm_find (String (ly_scm2string (glyph))));
+      return lookup_l ()->afm_find (String (ly_scm2string (glyph)));
       
-      return output;
     }
   else
     {
-      Interval emp;
-      emp.set_empty ();
-      Molecule a (lookup_l ()->fill (Box (emp,emp)));
-      return new Molecule (a);
+      Molecule m ;
+      m.set_empty (true);
+      return m;
     }
 }
 
@@ -371,109 +336,126 @@ Score_element::add_dependency (Score_element*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.  */
+      CRITERION is either a SMOB pointer to the desired line, or a number
+      representing the break direction. Do not modify SRC.
+*/
 SCM
-Score_element::handle_broken_smobs (SCM s, SCM criterion)
+Score_element::handle_broken_smobs (SCM src, SCM criterion)
 {
  again:
-
-  
-  Score_element *sc = unsmob_element ( s);
+  Score_element *sc = unsmob_element (src);
   if (sc)
     {
-      if (criterion == SCM_UNDEFINED)
-       return SCM_UNDEFINED;
-      else if (gh_number_p (criterion))
+      if (gh_number_p (criterion))
        {
          Item * i = dynamic_cast<Item*> (sc);
          Direction d = to_dir (criterion);
          if (i && i->break_status_dir () != d)
            {
-             Item *br = i->find_broken_piece (d);
+             Item *br = i->find_prebroken_piece (d);
              return  (br) ? br->self_scm_ : SCM_UNDEFINED;
            }
        }
       else
        {
-         Score_element * ln = unsmob_element ( criterion);
-         Line_of_score * line = dynamic_cast<Line_of_score*> (ln);
-         Score_element * br =0;
+         Line_of_score * line = dynamic_cast<Line_of_score*> (unsmob_element ( criterion));
          Line_of_score * dep_line = sc->line_l ();
          if (dep_line != line)
            {
-             br = sc->find_broken_piece (line);
+             Score_element * br = sc->find_broken_piece (line);
              return  (br) ?  br->self_scm_ : SCM_UNDEFINED;
            }
-         if (!dep_line)
-           return SCM_UNDEFINED;
+         if (line
+             &&  (!dep_line
+                  || !sc->common_refpoint (line, X_AXIS)
+                  || !sc->common_refpoint (line, Y_AXIS)))
+           {
+             return SCM_UNDEFINED;
+           }
        }
     }
-  else if (gh_pair_p (s))
+  else if (gh_pair_p (src))
     {
+      SCM oldcar =gh_car (src);
       /*
        UGH! breaks on circular lists.
       */
-      SCM car = handle_broken_smobs (gh_car (s), criterion);
-      SCM cdr = gh_cdr (s);
+      SCM newcar = handle_broken_smobs (oldcar, criterion);
+      SCM oldcdr = gh_cdr (src);
       
-      if (car == SCM_UNDEFINED
-         && (gh_pair_p (cdr) || cdr == SCM_EOL))
+      if (newcar == SCM_UNDEFINED
+         && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL))
        {
          /*
            This is tail-recursion, ie. 
            
            return handle_broken_smobs (cdr, criterion);
 
-           We don't want to rely on the compiler to do this.  */
-         s =  cdr;     
+           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;
        }
 
-      gh_set_car_x (s, car);
-      gh_set_cdr_x (s, handle_broken_smobs (cdr, criterion));
-      return s;
+      SCM newcdr = handle_broken_smobs (oldcdr, criterion);
+      return gh_cons (newcar, newcdr);
     }
-  return s;
+  else
+    return src;
+
+  return src;
 }
 
 void
 Score_element::handle_broken_dependencies()
 {
-  Line_of_score *line  = line_l();
-  element_property_alist_ = handle_broken_smobs (element_property_alist_,
-                                                line ? line->self_scm_ : SCM_UNDEFINED);
-
-  if (!line)
+  Spanner * s= dynamic_cast<Spanner*> (this);
+  if (original_l_ && s)
     return;
-}
-
 
-/*
-  TODO: cleanify.
- */
-void
-Score_element::handle_prebroken_dependencies()
-{
-  if (Item*i =dynamic_cast<Item*> (this))
+  if (s)
     {
-      element_property_alist_
-       = handle_broken_smobs (element_property_alist_,
-                              gh_int2scm (i->break_status_dir ()));
+      for (int i = 0;  i< s->broken_into_l_arr_ .size (); i++)
+       {
+         Score_element * sc = s->broken_into_l_arr_[i];
+         Line_of_score * l = sc->line_l ();
+         s->broken_into_l_arr_[i]->element_property_alist_ =
+           handle_broken_smobs (element_property_alist_,
+                                l ? l->self_scm_ : SCM_UNDEFINED);
+       }
     }
-}
 
 
+  Line_of_score *line = line_l();
 
+  if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
+    {
+      element_property_alist_
+       = handle_broken_smobs (element_property_alist_,
+                              line ? line->self_scm_ : SCM_UNDEFINED);
+    }
+  else if (!dynamic_cast <Line_of_score*> (this))
+    {
+      /*
+       This element is `invalid'; it has been removed from all
+       dependencies, so let's junk the element itself.
 
+       do not do this for Line_of_score , since that would free
+       up originals of score-elts (a bad thing.)
+      */
+      
+      element_property_alist_ = SCM_EOL;
+      set_extent_callback (0, Y_AXIS);
+      set_extent_callback (0, X_AXIS);
+    }
+}
 
-Link_array<Score_element>
-Score_element::get_extra_dependencies() const
+void
+Score_element::handle_prebroken_dependencies()
 {
-  Link_array<Score_element> empty;
-  return empty;
 }
 
+
 bool
 Score_element::linked_b() const
 {
@@ -491,8 +473,6 @@ Score_element::find_broken_piece (Line_of_score*) const
   return 0;
 }
 
-
-
 void
 Score_element::translate_axis (Real y, Axis a)
 {
@@ -512,24 +492,44 @@ Score_element::common_refpoint (Score_element const* s, Axis a) const
   return  dim ? dim->element_l () : 0;
 }
 
-void
-Score_element::set_empty (Axis a)
-{
-  dim_cache_[a]->callback_l_ =0;
-}
-
 bool
 Score_element::empty_b (Axis a)const
 {
-  return !dim_cache_[a]->callback_l_;
+  return !dim_cache_[a]->extent_callback_l_;
 }
 
 Interval
 Score_element::extent (Axis a) const
 {
   Dimension_cache const * d = dim_cache_[a];
+  Interval ext = d->get_dim ();
 
-  return d->get_dim ();
+  if (empty_b (a)) 
+    return ext;
+
+  SCM extra = get_elt_property (a == X_AXIS ? "extra-extent-X"
+                               : "extra-extent-Y");
+
+  /*
+    signs ?
+   */
+  Real s = paper_l ()->get_var ("staffspace");
+  if (gh_pair_p (extra))
+    {
+      ext[BIGGER] +=  s * gh_scm2double (gh_cdr (extra));
+      ext[SMALLER] +=  s * gh_scm2double (gh_car (extra));
+    }
+  
+  extra = get_elt_property (a == X_AXIS
+                               ? "minimum-extent-X"
+                               : "minimum-extent-Y");
+  if (gh_pair_p (extra))
+    {
+      ext.unite (Interval (s * gh_scm2double (gh_car (extra)),
+                          s * gh_scm2double (gh_cdr (extra))));
+    }
+  
+  return ext;
 }
 
 
@@ -558,7 +558,30 @@ Score_element::name () const
   return classname (this);
 }
 
+void
+Score_element::add_offset_callback (Offset_cache_callback cb, Axis a)
+{
+  dim_cache_[a]->off_callbacks_.push (cb);
+}
+
+bool
+Score_element::has_offset_callback_b (Offset_cache_callback cb, Axis a)const
+{
+  for (int i= dim_cache_[a]->off_callbacks_.size (); i--;)
+    {
+      if (dim_cache_[a]->off_callbacks_[i] == cb)
+       return true;
+    }
+  return false;
+}
 
+void
+Score_element::set_extent_callback (Dim_cache_callback dc, Axis a)
+{
+  dim_cache_[a]->extent_callback_l_ = dc ;
+}
+
+                                   
 void
 Score_element::set_parent (Score_element *g, Axis a)
 {
@@ -571,28 +594,28 @@ Score_element::fixup_refpoint ()
   for (int a = X_AXIS; a < NO_AXES; a ++)
     {
       Axis ax = (Axis)a;
-      Score_element * par = parent_l (ax);
+      Score_element * parent = parent_l (ax);
 
-      if (!par)
+      if (!parent)
        continue;
       
-      if (par->line_l () != line_l ())
+      if (parent->line_l () != line_l () && line_l ())
        {
-         Score_element * newpar = par->find_broken_piece (line_l ());
-         set_parent (newpar, ax);
+         Score_element * newparent = parent->find_broken_piece (line_l ());
+         set_parent (newparent, ax);
        }
 
       if (Item * i  = dynamic_cast<Item*> (this))
        {
-         Item *pari = dynamic_cast<Item*> (par);
+         Item *parenti = dynamic_cast<Item*> (parent);
 
-         if (pari && i)
+         if (parenti && i)
            {
              Direction  my_dir = i->break_status_dir () ;
-             if (my_dir!= pari->break_status_dir())
+             if (my_dir!= parenti->break_status_dir())
                {
-                 Item *newpar =  pari->find_broken_piece (my_dir);
-                 set_parent (newpar, ax);
+                 Item *newparent =  parenti->find_prebroken_piece (my_dir);
+                 set_parent (newparent, ax);
                }
            }
        }
@@ -605,11 +628,11 @@ Score_element::fixup_refpoint ()
   SMOB funcs
  ****************************************************/
 
-
 #include "ly-smobs.icc"
 
-IMPLEMENT_SMOBS(Score_element);
 IMPLEMENT_UNSMOB(Score_element, element);
+IMPLEMENT_SMOBS(Score_element);
+
 SCM
 Score_element::mark_smob (SCM ses)
 {
@@ -630,8 +653,9 @@ Score_element::print_smob (SCM s, SCM port, scm_print_state *)
   scm_puts ("#<Score_element ", port);
   scm_puts ((char *)sc->name (), port);
 
-  // scm_puts (" properties = ", port);
-  // scm_display (sc->element_property_alist_, port);
+  /*
+    don't try to print properties, that is too much hassle.
+   */
   scm_puts (" >", port);
   return 1;
 }
@@ -639,7 +663,6 @@ Score_element::print_smob (SCM s, SCM port, scm_print_state *)
 void
 Score_element::do_smobify_self ()
 {
-  scm_unprotect_object (element_property_alist_); // ugh
 }
 
 SCM
@@ -647,3 +670,67 @@ Score_element::equal_p (SCM a, SCM b)
 {
   return gh_cdr(a) == gh_cdr(b) ? SCM_BOOL_T : SCM_BOOL_F;
 }
+
+
+SCM
+Score_element::ly_set_elt_property (SCM elt, SCM sym, SCM val)
+{
+  Score_element * sc = unsmob_element (elt);
+
+  if (!gh_symbol_p (sym))
+    {
+      error ("Not a symbol");
+      ly_display_scm (sym);
+      return SCM_UNDEFINED;
+    }
+
+  if (sc)
+    {
+      sc->element_property_alist_ = scm_assoc_set_x (sc->element_property_alist_, sym, val);
+    }
+  else
+    {
+      error ("Not a score element");
+      ly_display_scm (elt);
+    }
+
+  return SCM_UNDEFINED;
+}
+
+
+SCM
+Score_element::ly_get_elt_property (SCM elt, SCM sym)
+{
+  Score_element * sc = unsmob_element (elt);
+  
+  if (sc)
+    {
+      SCM s = scm_assq(sym, sc->element_property_alist_);
+
+      if (s != SCM_BOOL_F)
+       return gh_cdr (s); 
+      else
+       return SCM_UNDEFINED;
+    }
+  else
+    {
+      error ("Not a score element");
+      ly_display_scm (elt);
+    }
+  return SCM_UNDEFINED;
+}
+
+
+static void
+init_functions ()
+{
+  scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (SCM(*)(...))Score_element::ly_get_elt_property);
+  scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (SCM(*)(...))Score_element::ly_set_elt_property);
+}
+
+ADD_SCM_INIT_FUNC(scoreelt, init_functions);
+
+void
+Score_element::do_breakable_col_processing ()
+{
+}