2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2015 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 "output-def.hh"
22 #include "pango-font.hh"
23 #include "modified-font-metric.hh"
24 #include "ly-module.hh"
25 #include "context-def.hh"
26 #include "lily-parser.hh"
28 LY_DEFINE (ly_output_def_lookup, "ly:output-def-lookup",
29 2, 1, 0, (SCM def, SCM sym, SCM val),
30 "Return the value of @var{sym} in output definition @var{def}"
31 " (e.g., @code{\\paper}). If no value is found, return"
32 " @var{val} or @code{'()} if @var{val} is undefined.")
34 LY_ASSERT_SMOB (Output_def, def, 1);
35 Output_def *op = unsmob<Output_def> (def);
36 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
38 SCM answer = op->lookup_variable (sym);
39 if (SCM_UNBNDP (answer))
50 LY_DEFINE (ly_output_def_scope, "ly:output-def-scope",
52 "Return the variable scope inside @var{def}.")
54 LY_ASSERT_SMOB (Output_def, def, 1);
55 Output_def *op = unsmob<Output_def> (def);
59 LY_DEFINE (ly_output_def_parent, "ly:output-def-parent",
61 "Return the parent output definition of @var{def}.")
63 LY_ASSERT_SMOB (Output_def, def, 1);
64 Output_def *op = unsmob<Output_def> (def);
65 return op->parent_ ? op->parent_->self_scm () : SCM_EOL;
68 LY_DEFINE (ly_output_def_set_variable_x, "ly:output-def-set-variable!",
69 3, 0, 0, (SCM def, SCM sym, SCM val),
70 "Set an output definition @var{def} variable @var{sym} to @var{val}.")
72 LY_ASSERT_SMOB (Output_def, def, 1);
73 Output_def *output_def = unsmob<Output_def> (def);
74 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
75 output_def->set_variable (sym, val);
76 return SCM_UNSPECIFIED;
79 LY_DEFINE (ly_output_def_clone, "ly:output-def-clone",
81 "Clone output definition @var{def}.")
83 LY_ASSERT_SMOB (Output_def, def, 1);
84 Output_def *op = unsmob<Output_def> (def);
86 Output_def *clone = op->clone ();
87 return clone->unprotect ();
90 LY_DEFINE (ly_output_description, "ly:output-description",
91 1, 0, 0, (SCM output_def),
92 "Return the description of translators in @var{output-def}.")
94 LY_ASSERT_SMOB (Output_def, output_def, 1);
96 Output_def *id = unsmob<Output_def> (output_def);
98 SCM al = ly_module_2_alist (id->scope_);
100 for (SCM s = al; scm_is_pair (s); s = scm_cdr (s))
102 Context_def *td = unsmob<Context_def> (scm_cdar (s));
103 SCM key = scm_caar (s);
104 if (td && key == td->get_context_name ())
105 ell = scm_cons (scm_cons (key, td->to_alist ()), ell);
110 LY_DEFINE (ly_output_find_context_def, "ly:output-find-context-def",
111 1, 1, 0, (SCM output_def, SCM context_name),
112 "Return an alist of all context defs (matching @var{context-name}"
113 "if given) in @var{output-def}.")
115 LY_ASSERT_SMOB (Output_def, output_def, 1);
116 if (!SCM_UNBNDP (context_name))
117 LY_ASSERT_TYPE (ly_is_symbol, context_name, 2);
119 Output_def *id = unsmob<Output_def> (output_def);
121 SCM al = ly_module_2_alist (id->scope_);
123 for (SCM s = al; scm_is_pair (s); s = scm_cdr (s))
126 Context_def *td = unsmob<Context_def> (scm_cdr (p));
127 if (td && scm_is_eq (scm_car (p), td->get_context_name ())
128 && (SCM_UNBNDP (context_name) || td->is_alias (context_name)))
129 ell = scm_cons (p, ell);
135 Output_def::type_p_name_[] = "ly:output-def?";
137 LY_DEFINE (ly_paper_outputscale, "ly:paper-outputscale",
139 "Return the output-scale for output definition @var{def}.")
141 LY_ASSERT_SMOB (Output_def, def, 1);
142 Output_def *b = unsmob<Output_def> (def);
143 return scm_from_double (output_scale (b));
146 LY_DEFINE (ly_make_output_def, "ly:make-output-def",
148 "Make an output definition.")
150 Output_def *bp = new Output_def;
151 return bp->unprotect ();
154 LY_DEFINE (ly_paper_get_font, "ly:paper-get-font",
155 2, 0, 0, (SCM def, SCM chain),
156 "Find a font metric in output definition @var{def} satisfying"
157 " the font-qualifiers in alist chain @var{chain}, and return"
158 " it. (An alist chain is a list of alists, containing grob"
161 LY_ASSERT_SMOB (Output_def, def, 1);
163 Output_def *paper = unsmob<Output_def> (def);
164 Font_metric *fm = select_font (paper, chain);
165 return fm->self_scm ();
168 LY_DEFINE (ly_paper_get_number, "ly:paper-get-number",
169 2, 0, 0, (SCM def, SCM sym),
170 "Return the value of variable @var{sym} in output definition"
171 " @var{def} as a double.")
173 LY_ASSERT_SMOB (Output_def, def, 1);
174 Output_def *layout = unsmob<Output_def> (def);
175 return scm_from_double (layout->get_dimension (sym));
178 LY_DEFINE (ly_paper_fonts, "ly:paper-fonts",
180 "Return a list containing the fonts from output definition"
181 " @var{def} (e.g., @code{\\paper}).")
183 LY_ASSERT_SMOB (Output_def, def, 1);
184 Output_def *b = unsmob<Output_def> (def);
186 SCM tab1 = b->lookup_variable (ly_symbol2scm ("scaled-fonts"));
187 SCM tab2 = b->lookup_variable (ly_symbol2scm ("pango-fonts"));
189 SCM alist1 = SCM_EOL;
190 if (to_boolean (scm_hash_table_p (tab1)))
192 alist1 = scm_append (ly_alist_vals (ly_hash2alist (tab1)));
194 alist1 = ly_alist_vals (alist1);
197 SCM alist2 = SCM_EOL;
198 if (scm_hash_table_p (tab2) == SCM_BOOL_T)
200 // strip original-fonts/pango-font-descriptions
201 alist2 = scm_append (ly_alist_vals (ly_hash2alist (tab2)));
203 // strip size factors
204 alist2 = ly_alist_vals (alist2);
207 SCM alist = scm_append (scm_list_2 (alist1, alist2));
208 SCM font_list = SCM_EOL;
209 for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
211 SCM entry = scm_car (s);
213 Font_metric *fm = unsmob<Font_metric> (entry);
215 if (dynamic_cast<Modified_font_metric *> (fm)
216 || dynamic_cast<Pango_font *> (fm))
217 font_list = scm_cons (fm->self_scm (), font_list);