2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "font-metric.hh"
24 #include "modified-font-metric.hh"
26 LY_DEFINE (ly_font_get_glyph, "ly:font-get-glyph",
29 "Return a stencil from @var{font} for the glyph named @var{name}."
30 " If the glyph is not available, return an empty stencil.\n"
32 "Note that this command can only be used to access glyphs from"
33 " fonts loaded with @code{ly:system-font-load}; currently, this"
34 " means either the Emmentaler or Aybabtu fonts, corresponding"
35 " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
38 Font_metric *fm = unsmob_metrics (font);
39 LY_ASSERT_SMOB (Font_metric, font, 1);
40 LY_ASSERT_TYPE (scm_is_string, name, 2);
42 Stencil m = fm->find_by_name (ly_scm2string (name));
44 /* TODO: make optional argument for default if not found. */
45 return m.smobbed_copy ();
48 LY_DEFINE (ly_get_glyph, "ly:get-glyph",
50 (SCM font, SCM index),
51 "Retrieve a stencil for the glyph numbered @var{index}"
54 "Note that this command can only be used to access glyphs from"
55 " fonts loaded with @code{ly:system-font-load}; currently, this"
56 " means either the Emmentaler or Aybabtu fonts, corresponding"
57 " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
60 Font_metric *fm = unsmob_metrics (font);
61 LY_ASSERT_SMOB (Font_metric, font, 1);
62 LY_ASSERT_TYPE (scm_is_number, index,2);
64 return fm->get_ascii_char_stencil (scm_to_int (index)).smobbed_copy ();
67 LY_DEFINE (ly_font_glyph_name_to_index, "ly:font-glyph-name-to-index",
70 "Return the index for @var{name} in @var{font}.\n"
72 "Note that this command can only be used to access glyphs from"
73 " fonts loaded with @code{ly:system-font-load}; currently, this"
74 " means either the Emmentaler or Aybabtu fonts, corresponding"
75 " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
78 Font_metric *fm = unsmob_metrics (font);
79 LY_ASSERT_SMOB (Font_metric, font, 1);
80 LY_ASSERT_TYPE (scm_is_string, name, 2);
82 return scm_from_int (fm->name_to_index (ly_scm2string (name)));
85 LY_DEFINE (ly_font_index_to_charcode, "ly:font-index-to-charcode",
87 (SCM font, SCM index),
88 "Return the character code for @var{index} in @var{font}.\n"
90 "Note that this command can only be used to access glyphs from"
91 " fonts loaded with @code{ly:system-font-load}; currently, this"
92 " means either the Emmentaler or Aybabtu fonts, corresponding"
93 " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
96 Font_metric *fm = unsmob_metrics (font);
97 LY_ASSERT_SMOB (Font_metric, font, 1);
98 LY_ASSERT_TYPE (scm_is_integer, index, 2);
100 return scm_from_unsigned_integer (fm->index_to_charcode (scm_to_int (index)));
103 LY_DEFINE (ly_font_glyph_name_to_charcode, "ly:font-glyph-name-to-charcode",
105 (SCM font, SCM name),
106 "Return the character code for glyph @var{name} in @var{font}.\n"
108 "Note that this command can only be used to access glyphs from"
109 " fonts loaded with @code{ly:system-font-load}; currently, this"
110 " means either the Emmentaler or Aybabtu fonts, corresponding"
111 " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
114 Font_metric *fm = unsmob_metrics (font);
115 LY_ASSERT_SMOB (Font_metric, font, 1);
116 LY_ASSERT_TYPE (scm_is_string, name, 2);
118 return scm_from_unsigned_integer (fm->index_to_charcode (fm->name_to_index (ly_scm2string (name))));
121 LY_DEFINE (ly_text_dimension, "ly:text-dimension",
123 (SCM font, SCM text),
124 "Given the font metric in @var{font} and the string @var{text},"
125 " compute the extents of that text in that font. The return"
126 " value is a pair of number-pairs.")
129 Modified_font_metric *fm = dynamic_cast<Modified_font_metric *>
130 (unsmob_metrics (font));
132 LY_ASSERT_SMOB (Font_metric, font, 1);
133 LY_ASSERT_TYPE (scm_is_string, text, 2);
134 Stencil stc (fm->text_stencil (ly_scm2string (text), false));
135 return scm_cons (ly_interval2scm (stc.extent (X_AXIS)),
136 ly_interval2scm (stc.extent (Y_AXIS)));
141 TODO: when are non string retvals allowed?
143 LY_DEFINE (ly_font_file_name, "ly:font-file-name",
146 "Given the font metric @var{font},"
147 " return the corresponding file name.")
149 LY_ASSERT_SMOB (Font_metric, font, 1);
151 Font_metric *fm = unsmob_metrics (font);
152 SCM name = fm->font_file_name ();
157 LY_DEFINE (ly_font_name, "ly:font-name",
160 "Given the font metric @var{font},"
161 " return the corresponding name.")
163 LY_ASSERT_SMOB (Font_metric, font, 1);
164 Font_metric *fm = unsmob_metrics (font);
166 return ly_string2scm (fm->font_name ());
169 LY_DEFINE (ly_font_magnification, "ly:font-magnification", 1, 0, 0,
171 "Given the font metric @var{font}, return the"
172 " magnification, relative to the current output-scale.")
174 LY_ASSERT_SMOB (Font_metric, font, 1);
176 Font_metric *fm = unsmob_metrics (font);
177 return scm_cdr (fm->description_);
180 LY_DEFINE (ly_font_design_size, "ly:font-design-size", 1, 0, 0,
182 "Given the font metric @var{font}, return the"
183 " design size, relative to the current output-scale.")
185 LY_ASSERT_SMOB (Font_metric, font, 1);
187 Font_metric *fm = unsmob_metrics (font);
188 return scm_from_double (fm->design_size ());