Docs-fr: fix PDF docs build

[lilypond.git] / lily / font-metric-scheme.cc

diff --git a/lily/font-metric-scheme.cc b/lily/font-metric-scheme.cc
index 88cfc58e2b707662fd496719b98db9aaf8641d03..55373f72c8de1f0c51329c3133e31c34e37bca22 100644 (file)
--- a/lily/font-metric-scheme.cc
+++ b/lily/font-metric-scheme.cc
@@ -1,9 +1,20 @@
 /*
-  font-metric-scheme.cc -- implement Font_metric scheme bindings
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--2007 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 "font-metric.hh"
@@ -16,8 +27,13 @@ LY_DEFINE (ly_font_get_glyph, "ly:font-get-glyph",
           2, 0, 0,
           (SCM font, SCM name),
           "Return a stencil from @var{font} for the glyph named @var{name}."
-          "  @var{font} must be available as an AFM file.  If the glyph"
-          " is not available, return @code{#f}.")
+          "  If the glyph is not available, return an empty stencil.\n"
+          "\n"
+          "Note that this command can only be used to access glyphs from"
+          " fonts loaded with @code{ly:system-font-load}; currently, this"
+          " means either the Emmentaler or Aybabtu fonts, corresponding"
+          " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+          " respectively.")
 {
   Font_metric *fm = unsmob_metrics (font);
   LY_ASSERT_SMOB (Font_metric, font, 1);
@@ -33,7 +49,13 @@ LY_DEFINE (ly_get_glyph, "ly:get-glyph",
           2, 0, 0,
           (SCM font, SCM index),
           "Retrieve a stencil for the glyph numbered @var{index}"
-          " in @var{font}.")
+          " in @var{font}.\n"
+          "\n"
+          "Note that this command can only be used to access glyphs from"
+          " fonts loaded with @code{ly:system-font-load}; currently, this"
+          " means either the Emmentaler or Aybabtu fonts, corresponding"
+          " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+          " respectively.")
 {
   Font_metric *fm = unsmob_metrics (font);
   LY_ASSERT_SMOB (Font_metric, font, 1);
@@ -45,7 +67,13 @@ LY_DEFINE (ly_get_glyph, "ly:get-glyph",
 LY_DEFINE (ly_font_glyph_name_to_index, "ly:font-glyph-name-to-index",
           2, 0, 0,
           (SCM font, SCM name),
-          "Return the index for @var{name} in @var{font}.")
+          "Return the index for @var{name} in @var{font}.\n"
+          "\n"
+          "Note that this command can only be used to access glyphs from"
+          " fonts loaded with @code{ly:system-font-load}; currently, this"
+          " means either the Emmentaler or Aybabtu fonts, corresponding"
+          " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+          " respectively.")
 {
   Font_metric *fm = unsmob_metrics (font);
   LY_ASSERT_SMOB (Font_metric, font, 1);
@@ -57,7 +85,13 @@ LY_DEFINE (ly_font_glyph_name_to_index, "ly:font-glyph-name-to-index",
 LY_DEFINE (ly_font_index_to_charcode, "ly:font-index-to-charcode",
           2, 0, 0,
           (SCM font, SCM index),
-          "Return the character code for @var{index} in @var{font}.")
+          "Return the character code for @var{index} in @var{font}.\n"
+          "\n"
+          "Note that this command can only be used to access glyphs from"
+          " fonts loaded with @code{ly:system-font-load}; currently, this"
+          " means either the Emmentaler or Aybabtu fonts, corresponding"
+          " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+          " respectively.")
 {
   Font_metric *fm = unsmob_metrics (font);
   LY_ASSERT_SMOB (Font_metric, font, 1);
@@ -69,7 +103,13 @@ LY_DEFINE (ly_font_index_to_charcode, "ly:font-index-to-charcode",
 LY_DEFINE (ly_font_glyph_name_to_charcode, "ly:font-glyph-name-to-charcode",
           2, 0, 0,
           (SCM font, SCM name),
-          "Return the character code for glyph @var{name} in @var{font}.")
+          "Return the character code for glyph @var{name} in @var{font}.\n"
+          "\n"
+          "Note that this command can only be used to access glyphs from"
+          " fonts loaded with @code{ly:system-font-load}; currently, this"
+          " means either the Emmentaler or Aybabtu fonts, corresponding"
+          " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+          " respectively.")
 {
   Font_metric *fm = unsmob_metrics (font);
   LY_ASSERT_SMOB (Font_metric, font, 1);
@@ -91,7 +131,7 @@ LY_DEFINE (ly_text_dimension, "ly:text-dimension",
 
   LY_ASSERT_SMOB (Font_metric, font, 1);
   LY_ASSERT_TYPE (scm_is_string, text, 2);
-  Stencil stc (fm->text_stencil (ly_scm2string (text)));
+  Stencil stc (fm->text_stencil (ly_scm2string (text), false));
   return scm_cons (ly_interval2scm (stc.extent (X_AXIS)),
                   ly_interval2scm (stc.extent (Y_AXIS)));
 }