source file of the GNU LilyPond music typesetter
- (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ (c) 2005--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "font-metric.hh"
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);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
- SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG2, __FUNCTION__, "string");
+ LY_ASSERT_SMOB (Font_metric, font, 1);
+ LY_ASSERT_TYPE (scm_is_string, name, 2);
Stencil m = fm->find_by_name (ly_scm2string (name));
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);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
- SCM_ASSERT_TYPE (scm_is_number (index), index, SCM_ARG2, __FUNCTION__, "number");
+ LY_ASSERT_SMOB (Font_metric, font, 1);
+ LY_ASSERT_TYPE (scm_is_number, index,2);
return fm->get_ascii_char_stencil (scm_to_int (index)).smobbed_copy ();
}
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);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
- SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG2, __FUNCTION__, "string");
+ LY_ASSERT_SMOB (Font_metric, font, 1);
+ LY_ASSERT_TYPE (scm_is_string, name, 2);
return scm_from_int (fm->name_to_index (ly_scm2string (name)));
}
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);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
- SCM_ASSERT_TYPE (scm_is_integer (index), index, SCM_ARG2, __FUNCTION__, "index");
+ LY_ASSERT_SMOB (Font_metric, font, 1);
+ LY_ASSERT_TYPE (scm_is_integer, index, 2);
return scm_from_unsigned_integer (fm->index_to_charcode (scm_to_int (index)));
}
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);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
- SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG2, __FUNCTION__, "string");
+ LY_ASSERT_SMOB (Font_metric, font, 1);
+ LY_ASSERT_TYPE (scm_is_string, name, 2);
return scm_from_unsigned_integer (fm->index_to_charcode (fm->name_to_index (ly_scm2string (name))));
}
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));
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "modified font metric");
- SCM_ASSERT_TYPE (scm_is_string (text), text, SCM_ARG2, __FUNCTION__, "string");
+ LY_ASSERT_SMOB (Font_metric, font, 1);
+ 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)));
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);
+
Font_metric *fm = unsmob_metrics (font);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
SCM name = fm->font_file_name ();
return 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);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
return ly_string2scm (fm->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 outputs-cale.")
+ "Given the font metric @var{font}, return the"
+ " magnification, relative to the current output-scale.")
{
+ LY_ASSERT_SMOB (Font_metric, font, 1);
+
Font_metric *fm = unsmob_metrics (font);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
return scm_cdr (fm->description_);
}
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);
+
Font_metric *fm = unsmob_metrics (font);
- SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
return scm_from_double (fm->design_size ());
}
projects / lilypond.git / blobdiff