Doc-es: various updates.

[lilypond.git] / lily / spaceable-grob.cc

diff --git a/lily/spaceable-grob.cc b/lily/spaceable-grob.cc
index 79b4173efd91036eadc6b9c479d3caa3990b6dfb..c6ed9120396c3e9550edc8b4088f7bc081606aa3 100644 (file)
--- a/lily/spaceable-grob.cc
+++ b/lily/spaceable-grob.cc
@@ -1,21 +1,32 @@
 /*
-  spaceable-grob.cc -- implement Spaceable_grob
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "spaceable-grob.hh"
 
 #include <cstdio>
-#include <math.h>
 
 #include "warn.hh"
 #include "spring.hh"
 #include "pointer-group-interface.hh"
 #include "grob.hh"
 #include "paper-column.hh"
+#include "international.hh"
 
 SCM
 Spaceable_grob::get_minimum_distances (Grob *me)
@@ -31,7 +42,7 @@ Spaceable_grob::add_rod (Grob *me, Grob *p, Real d)
   //  printf ("rod %lf\n", d);
   if (d < 0)
     return;
-  
+
   if (isinf (d))
     programming_error ("infinite rod");
 
@@ -40,91 +51,63 @@ Spaceable_grob::add_rod (Grob *me, Grob *p, Real d)
   for (SCM s = mins; scm_is_pair (s); s = scm_cdr (s))
     {
       SCM dist = scm_car (s);
-      if (scm_car (dist) == p->self_scm ())
-       {
-         scm_set_cdr_x (dist, scm_max (scm_cdr (dist),
-                                       newdist));
-         return;
-       }
+      if (scm_is_eq (scm_car (dist), p->self_scm ()))
+        {
+          scm_set_cdr_x (dist, scm_max (scm_cdr (dist),
+                                        newdist));
+          return;
+        }
     }
 
   if (Paper_column::get_rank (p) < Paper_column::get_rank (me))
-    {
-      programming_error ("Adding reverse rod");
-    }
-  
+    programming_error ("Adding reverse rod");
+
   mins = scm_cons (scm_cons (p->self_scm (), newdist), mins);
   me->set_object ("minimum-distances", mins);
 }
 
 void
-Spaceable_grob::add_spring (Grob *me, Grob *p, Real d, Real inverse_strength)
+Spaceable_grob::add_spring (Grob *me, Grob *other, Spring sp)
 {
-  if (d <= 0.0 || inverse_strength < 0.0)
-    {
-      programming_error ("adding reverse spring, setting to unit");
-      d = 1.0;
-      inverse_strength = 1.0;
-    }
-
-  if (isinf (d) || isnan (d)
-      || isnan (inverse_strength))
-    {
-      /* strength == INF is possible. It means fixed distance.  */
-      programming_error ("insane distance found");
-      d = 1.0;
-      inverse_strength = 1.0;
-    }
-
-#ifndef NDEBUG
-  SCM mins = me->get_object ("ideal-distances");
-  for (SCM s = mins; scm_is_pair (s); s = scm_cdr (s))
-    {
-      Spring_smob *sp = unsmob_spring (scm_car (s));
-      if (sp->other_ == p)
-       {
-         programming_error ("already have that spring");
-         return;
-       }
-    }
-#endif
-
-  Spring_smob spring;
-  spring.inverse_strength_ = inverse_strength;
-  spring.distance_ = d;
-  spring.other_ = p;
-
   SCM ideal = me->get_object ("ideal-distances");
-  ideal = scm_cons (spring.smobbed_copy (), ideal);
+
+  ideal = scm_cons (scm_cons (sp.smobbed_copy (), other->self_scm ()), ideal);
   me->set_object ("ideal-distances", ideal);
 }
 
-void
-Spaceable_grob::get_spring (Grob *me, Grob *other, Real *dist, Real *inv_strength)
+Spring
+Spaceable_grob::get_spring (Grob *this_col, Grob *next_col)
 {
-  for (SCM s = me->get_object ("ideal-distances");
-       scm_is_pair (s); s = scm_cdr (s))
+  Spring *spring = 0;
+
+  for (SCM s = this_col->get_object ("ideal-distances");
+       !spring && scm_is_pair (s);
+       s = scm_cdr (s))
     {
-      Spring_smob *spring = unsmob_spring (scm_car (s));
-      if (spring && spring->other_ == other)
-       {
-         *dist = spring->distance_;
-         *inv_strength = spring->inverse_strength_;
-       }
+      if (scm_is_pair (scm_car (s))
+          && unsmob<Grob> (scm_cdar (s)) == next_col
+          && unsmob<Spring> (scm_caar (s)))
+        spring = unsmob<Spring> (scm_caar (s));
     }
-}
 
+  if (!spring)
+    programming_error (to_string ("No spring between column %d and next one",
+                                  Paper_column::get_rank (this_col)));
 
-void
-Spaceable_grob::remove_interface (Grob *me)
-{
-  me->set_object ("minimum-distances", SCM_EOL);
-  me->set_object ("spacing-wishes", SCM_EOL);
-  me->set_object ("ideal-distances", SCM_EOL);
+  return spring ? *spring : Spring ();
 }
 
-ADD_INTERFACE (Spaceable_grob, "spaceable-grob-interface",
-              "A layout object that takes part in the spacing problem. ",
-              "measure-length spacing-wishes penalty minimum-distances ideal-distances "
-              "keep-inside-line left-neighbors right-neighbors");
+ADD_INTERFACE (Spaceable_grob,
+               "A layout object that takes part in the spacing problem.",
+
+               /* properties */
+               "allow-loose-spacing "
+               "ideal-distances "
+               "keep-inside-line "
+               "left-neighbor "
+               "measure-length "
+               "minimum-distances "
+               "right-neighbor "
+               "spacing-wishes "
+              );