Doc-es: various updates.

[lilypond.git] / lily / spring-smob.cc

diff --git a/lily/spring-smob.cc b/lily/spring-smob.cc
index bab14e841859a4c6488d7ac31519c412db26dbac..19a5eef4c5ff87ffc4fc18a84f2f0af14fce3286 100644 (file)
--- a/lily/spring-smob.cc
+++ b/lily/spring-smob.cc
@@ -1,47 +1,70 @@
-/*   
-  spring.cc --  implement Spring
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.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 "spring.hh"
 #include "warn.hh"
-#include "ly-smobs.icc"
 
-Spring_smob::Spring_smob()
-{
-  distance_ =0.;
-  strength_ =1.0;
-  expand_only_b_ = false;
-  other_ = 0;
-}
 
 
-IMPLEMENT_SIMPLE_SMOBS(Spring_smob);
 
 SCM
-Spring_smob::mark_smob (SCM) { return SCM_UNSPECIFIED; }
+Spring::equal_p (SCM a, SCM b)
+{
+  // TODO SCM: This could be made simpler.
+  return scm_is_eq (a, b) ? SCM_BOOL_T : SCM_BOOL_F;
+}
 
-int
-Spring_smob::print_smob (SCM s, SCM p, scm_print_state *)
+LY_DEFINE (ly_make_spring, "ly:make-spring",
+           2, 0, 0, (SCM ideal, SCM min_dist),
+           "Make a spring.  @var{ideal} is the ideal distance of the"
+           " spring, and @var{min-dist} is the minimum distance.")
 {
-  Spring_smob *ss = unsmob_spring (s);
-  scm_puts (_f("#<spring smob d= %f>", ss->distance_).to_str0 (), p);
-  return 1;
+  LY_ASSERT_TYPE (scm_is_number, ideal, 1);
+  LY_ASSERT_TYPE (scm_is_number, min_dist, 2);
+
+  Spring s (scm_to_double (ideal), scm_to_double (min_dist));
+
+  return s.smobbed_copy ();
 }
 
-SCM
-Spring_smob::equal_p (SCM a , SCM b)
+LY_DEFINE (ly_spring_set_inverse_compress_strength_x, "ly:spring-set-inverse-compress-strength!",
+           2, 0, 0, (SCM spring, SCM strength),
+           "Set the inverse compress @var{strength} of @var{spring}.")
 {
-  return a==b? SCM_BOOL_T : SCM_BOOL_F;
+  LY_ASSERT_SMOB (Spring, spring, 1);
+  LY_ASSERT_TYPE (scm_is_number, strength, 2);
+
+  Spring *s = unsmob<Spring> (spring);
+  s->set_inverse_compress_strength (scm_to_double (strength));
+  return s->smobbed_copy ();
 }
 
-SCM
-Spring_smob::smobbed_copy ()const
+LY_DEFINE (ly_spring_set_inverse_stretch_strength_x, "ly:spring-set-inverse-stretch-strength!",
+           2, 0, 0, (SCM spring, SCM strength),
+           "Set the inverse stretch @var{strength} of @var{spring}.")
 {
-  Spring_smob *  p = new Spring_smob (*this);
-  return p->smobbed_self ();
+  LY_ASSERT_SMOB (Spring, spring, 1);
+  LY_ASSERT_TYPE (scm_is_number, strength, 2);
+
+  Spring *s = unsmob<Spring> (spring);
+  s->set_inverse_stretch_strength (scm_to_double (strength));
+  return s->smobbed_copy ();
 }
+
+const char * const Spring::type_p_name_ = "ly:spring?";