Run `make grand-replace'.

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

diff --git a/lily/font-metric-scheme.cc b/lily/font-metric-scheme.cc
index a1e18da2c24e120efabdaa078d1916d18440ecf4..7cdffddfd1c914624cb47c8dab8968b3aad5ada1 100644 (file)
--- a/lily/font-metric-scheme.cc
+++ b/lily/font-metric-scheme.cc
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2005--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2005--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "font-metric.hh"
@@ -15,13 +15,18 @@
 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}.")
+          "Return a stencil from @var{font} for the glyph named @var{name}."
+          "  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);
-  LY_ASSERT_TYPE(scm_is_string,name, 2);
+  LY_ASSERT_TYPE (scm_is_string, name, 2);
 
   Stencil m = fm->find_by_name (ly_scm2string (name));
 
@@ -32,12 +37,18 @@ LY_DEFINE (ly_font_get_glyph, "ly:font-get-glyph",
 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}.")
+          "Retrieve a stencil for the glyph numbered @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);
-  LY_ASSERT_TYPE(scm_is_number, index,2);
+  LY_ASSERT_TYPE (scm_is_number, index,2);
 
   return fm->get_ascii_char_stencil (scm_to_int (index)).smobbed_copy ();
 }
@@ -45,11 +56,17 @@ 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);
-  LY_ASSERT_TYPE(scm_is_string,name, 2);
+  LY_ASSERT_TYPE (scm_is_string, name, 2);
 
   return scm_from_int (fm->name_to_index (ly_scm2string (name)));
 }
@@ -57,11 +74,17 @@ 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} @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);
-  LY_ASSERT_TYPE(scm_is_integer,index, 2);
+  LY_ASSERT_TYPE (scm_is_integer, index, 2);
 
   return scm_from_unsigned_integer (fm->index_to_charcode (scm_to_int (index)));
 }
@@ -69,11 +92,17 @@ 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);
-  LY_ASSERT_TYPE(scm_is_string,name, 2);
+  LY_ASSERT_TYPE (scm_is_string, name, 2);
 
   return scm_from_unsigned_integer (fm->index_to_charcode (fm->name_to_index (ly_scm2string (name))));
 }
@@ -81,16 +110,16 @@ LY_DEFINE (ly_font_glyph_name_to_charcode, "ly:font-glyph-name-to-charcode",
 LY_DEFINE (ly_text_dimension, "ly:text-dimension",
           2, 0, 0,
           (SCM font, SCM text),
-          "Given the font metric in @var{font} and the string @var{text}, "
-          "compute the extents of that text in that font.  "
-          "The return value is a pair of number-pairs.")
+          "Given the font metric in @var{font} and the string @var{text},"
+          " compute the extents of that text in that font.  The return"
+          " value is a pair of number-pairs.")
 {
   Box b;
   Modified_font_metric *fm = dynamic_cast<Modified_font_metric *>
     (unsmob_metrics (font));
 
   LY_ASSERT_SMOB (Font_metric, font, 1);
-  LY_ASSERT_TYPE(scm_is_string,text, 2);
+  LY_ASSERT_TYPE (scm_is_string, text, 2);
   Stencil stc (fm->text_stencil (ly_scm2string (text)));
   return scm_cons (ly_interval2scm (stc.extent (X_AXIS)),
                   ly_interval2scm (stc.extent (Y_AXIS)));
@@ -103,8 +132,8 @@ LY_DEFINE (ly_text_dimension, "ly:text-dimension",
 LY_DEFINE (ly_font_file_name, "ly:font-file-name",
           1, 0, 0,
           (SCM font),
-          "Given the font metric @var{font}, "
-          "return the corresponding file name.")
+          "Given the font metric @var{font},"
+          " return the corresponding file name.")
 {
   LY_ASSERT_SMOB (Font_metric, font, 1);
 
@@ -117,8 +146,8 @@ LY_DEFINE (ly_font_file_name, "ly:font-file-name",
 LY_DEFINE (ly_font_name, "ly:font-name",
           1, 0, 0,
           (SCM font),
-          "Given the font metric @var{font}, "
-          "return the corresponding name.")
+          "Given the font metric @var{font},"
+          " return the corresponding name.")
 {
   LY_ASSERT_SMOB (Font_metric, font, 1);
   Font_metric *fm = unsmob_metrics (font);
@@ -128,8 +157,8 @@ LY_DEFINE (ly_font_name, "ly:font-name",
 
 LY_DEFINE (ly_font_magnification, "ly:font-magnification", 1, 0, 0,
           (SCM font),
-          "Given the font metric @var{font}, return the "
-          "magnification, relative to the current output-scale.")
+          "Given the font metric @var{font}, return the"
+          " magnification, relative to the current output-scale.")
 {
   LY_ASSERT_SMOB (Font_metric, font, 1);
 
@@ -139,8 +168,8 @@ LY_DEFINE (ly_font_magnification, "ly:font-magnification", 1, 0, 0,
 
 LY_DEFINE (ly_font_design_size, "ly:font-design-size", 1, 0, 0,
           (SCM font),
-          "Given the font metric @var{font}, return the "
-          "design size, relative to the current output-scale.")
+          "Given the font metric @var{font}, return the"
+          " design size, relative to the current output-scale.")
 {
   LY_ASSERT_SMOB (Font_metric, font, 1);