Doc-es: various updates.

[lilypond.git] / lily / paper-system-scheme.cc

diff --git a/lily/paper-system-scheme.cc b/lily/paper-system-scheme.cc
index 97bb947afe32cd10fc5d9cb6508a108df7fd78dc..1f5a39b96af82208e73285d8595951a3b992fccd 100644 (file)
--- a/lily/paper-system-scheme.cc
+++ b/lily/paper-system-scheme.cc
@@ -1,66 +1,56 @@
 /*
-  paper-system-scheme.cc -- implement Paper_system bindings
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2008--2015 Han-Wen Nienhuys <hanwen@lilypond.org>
 
-  (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
-*/
 
-#include "paper-system.hh"
+  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.
 
-LY_DEFINE (ly_paper_system_height, "ly:paper-system-extent",
-          2, 0, 0, (SCM system, SCM axis),
-          "Return the extent of @var{system}.")
-{
-  Paper_system *ps = unsmob_paper_system (system);
-  SCM_ASSERT_TYPE (ps, system, SCM_ARG1, __FUNCTION__, "paper-system");
-  SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
-  Axis ax = (Axis)scm_to_int (axis);
-  return ly_interval2scm (ps->to_stencil ().extent (ax));
-}
+  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.
 
-LY_DEFINE (ly_paper_system_title_p, "ly:paper-system-title?",
-          1, 0, 0, (SCM system),
-          "Is  @var{system} a title system?")
-{
-  Paper_system *ps = unsmob_paper_system (system);
-  SCM_ASSERT_TYPE (ps, system, SCM_ARG1, __FUNCTION__, "paper-system");
-  return SCM_BOOL (ps->is_title ());
-}
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
-LY_DEFINE (ly_paper_system_number, "ly:paper-system-number",
-          1, 0, 0, (SCM system),
-          "Return the number of @var{system}.")
-{
-  Paper_system *ps = unsmob_paper_system (system);
-  SCM_ASSERT_TYPE (ps, system, SCM_ARG1, __FUNCTION__, "paper-system");
-  return scm_from_int (ps->number_);
-}
+#include "prob.hh"
 
-LY_DEFINE (ly_paper_system_break_before_penalty, "ly:paper-system-break-before-penalty",
-          1, 0, 0, (SCM system),
-          "Return the score for page break after @var{system}.")
-{
-  Paper_system *ps = unsmob_paper_system (system);
-  SCM_ASSERT_TYPE (ps, system, SCM_ARG1, __FUNCTION__, "paper-system");
-  return scm_from_int (int (ps->break_before_penalty ()));
-}
+#include "skyline-pair.hh"
 
-LY_DEFINE (ly_paper_system_stencil, "ly:paper-system-stencil",
-          1, 0, 0, (SCM system),
-          "Return the height of @var{system}.")
+LY_DEFINE (ly_paper_system_p, "ly:paper-system?",
+           1, 0, 0, (SCM obj),
+           "Is @var{obj} a C++ @code{Prob} object of type"
+           " @code{paper-system}?")
 {
-  Paper_system *ps = unsmob_paper_system (system);
-  SCM_ASSERT_TYPE (ps, system, SCM_ARG1, __FUNCTION__, "paper-system");
-  return ps->to_stencil ().smobbed_copy ();
+  return ly_prob_type_p (obj, ly_symbol2scm ("paper-system"));
 }
 
-LY_DEFINE (ly_paper_system_staff_extent, "ly:paper-system-staff-extents",
-          1, 0, 0, (SCM system),
-          "Return the top and bottom staff refpoint.")
+LY_DEFINE (ly_paper_system_minimum_distance, "ly:paper-system-minimum-distance",
+           2, 0, 0, (SCM sys1, SCM sys2),
+           "Measure the minimum distance between these two paper-systems,"
+           " using their stored skylines if possible and falling back to"
+           " their extents otherwise.")
 {
-  Paper_system *ps = unsmob_paper_system (system);
-  SCM_ASSERT_TYPE (ps, system, SCM_ARG1, __FUNCTION__, "paper-system");
-  return ly_interval2scm (ps->staff_refpoints ());
+  Real ret = 0;
+  Prob *p1 = unsmob<Prob> (sys1);
+  Prob *p2 = unsmob<Prob> (sys2);
+  Skyline_pair *sky1 = unsmob<Skyline_pair> (p1->get_property ("vertical-skylines"));
+  Skyline_pair *sky2 = unsmob<Skyline_pair> (p2->get_property ("vertical-skylines"));
+
+  if (sky1 && sky2)
+    ret = (*sky1)[DOWN].distance ((*sky2)[UP]);
+  else
+    {
+      Stencil *s1 = unsmob<Stencil> (p1->get_property ("stencil"));
+      Stencil *s2 = unsmob<Stencil> (p2->get_property ("stencil"));
+      Interval iv1 = s1->extent (Y_AXIS);
+      Interval iv2 = s2->extent (Y_AXIS);
+      ret = iv2[UP] - iv1[DOWN];
+    }
+  return scm_from_double (ret);
 }
-