2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--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 "context-def.hh"
23 #include "file-path.hh"
24 #include "global-context.hh"
25 #include "international.hh"
26 #include "interval.hh"
28 #include "output-def.hh"
29 #include "scm-hash.hh"
33 #include "program-option.hh"
35 #include "string-convert.hh"
37 ADD_SMOB_INIT (Output_def);
39 Output_def::Output_def ()
46 scope_ = ly_make_module (false);
49 Output_def::Output_def (Output_def const &s)
56 input_origin_ = s.input_origin_;
57 scope_ = ly_make_module (false);
58 if (ly_is_module (s.scope_))
59 ly_module_copy (scope_, s.scope_);
62 Output_def::~Output_def ()
68 Output_def::mark_smob ()
70 /* FIXME: why is this necessary?
71 all paper_ should be protected by themselves. */
73 scm_gc_mark (parent_->self_scm ());
79 assign_context_def (Output_def * m, SCM transdef)
81 Context_def *tp = Context_def::unsmob (transdef);
86 SCM sym = tp->get_context_name ();
87 m->set_variable (sym, transdef);
91 /* find the translator for NAME. NAME must be a symbol. */
93 find_context_def (Output_def const *m, SCM name)
95 Context_def *cd = Context_def::unsmob (m->lookup_variable (name));
96 return cd ? cd->self_scm () : SCM_EOL;
100 Output_def::print_smob (SCM p, scm_print_state *)
103 scm_puts (class_name (), p);
109 Output_def::get_dimension (SCM s) const
111 SCM val = lookup_variable (s);
112 return scm_to_double (val);
116 Output_def::lookup_variable (SCM sym) const
118 SCM var = ly_module_lookup (scope_, sym);
119 if (SCM_VARIABLEP (var) && !SCM_UNBNDP (SCM_VARIABLE_REF (var)))
120 return SCM_VARIABLE_REF (var);
123 return parent_->lookup_variable (sym);
125 return SCM_UNDEFINED;
129 Output_def::c_variable (const string &s) const
131 return lookup_variable (ly_symbol2scm (s.c_str ()));
135 Output_def::set_variable (SCM sym, SCM val)
137 scm_module_define (scope_, sym, val);
141 Output_def::normalize ()
144 SCM scm_paper_width = c_variable ("paper-width");
146 bool twosided = to_boolean (c_variable ("two-sided"));
147 // We don't distinguish between outer-margin / left-margin and so on
148 // until page-stencil positioning in page.scm
149 Real left_margin, left_margin_default;
150 SCM scm_left_margin_default = (twosided
151 ? c_variable ("outer-margin-default-scaled")
152 : c_variable ("left-margin-default-scaled"));
153 SCM scm_left_margin = (twosided
154 ? c_variable ("outer-margin")
155 : c_variable ("left-margin"));
157 Real right_margin, right_margin_default;
158 SCM scm_right_margin_default = (twosided
159 ? c_variable ("inner-margin-default-scaled")
160 : c_variable ("right-margin-default-scaled"));
161 SCM scm_right_margin = (twosided
162 ? c_variable ("inner-margin")
163 : c_variable ("right-margin"));
165 if (SCM_UNBNDP (scm_paper_width)
166 || SCM_UNBNDP (scm_left_margin_default)
167 || SCM_UNBNDP (scm_right_margin_default))
169 programming_error ("called normalize () on paper with missing settings");
174 paper_width = scm_to_double (scm_paper_width);
175 left_margin_default = scm_to_double (scm_left_margin_default);
176 right_margin_default = scm_to_double (scm_right_margin_default);
180 Real line_width_default
181 = paper_width - left_margin_default - right_margin_default;
182 SCM scm_line_width = c_variable ("line-width");
184 Real binding_offset = 0;
186 binding_offset = robust_scm2double (c_variable ("binding-offset"), 0);
188 if (SCM_UNBNDP (scm_line_width))
190 left_margin = (SCM_UNBNDP (scm_left_margin)
191 ? left_margin_default
192 : scm_to_double (scm_left_margin));
193 right_margin = (SCM_UNBNDP (scm_right_margin)
194 ? right_margin_default
195 : scm_to_double (scm_right_margin)) + binding_offset;
196 line_width = paper_width - left_margin - right_margin;
200 line_width = scm_to_double (scm_line_width);
201 if (SCM_UNBNDP (scm_left_margin))
203 // Vertically center systems if only line-width is given
204 if (SCM_UNBNDP (scm_right_margin))
206 left_margin = (paper_width - line_width) / 2;
207 right_margin = left_margin;
211 right_margin = scm_to_double (scm_right_margin) + binding_offset;
212 left_margin = paper_width - line_width - right_margin;
217 left_margin = scm_to_double (scm_left_margin);
218 right_margin = (SCM_UNBNDP (scm_right_margin)
219 ? (paper_width - line_width - left_margin)
220 : scm_to_double (scm_right_margin)) + binding_offset;
224 if (to_boolean (c_variable ("check-consistency")))
226 // Consistency checks. If values don't match, set defaults.
227 if (abs (paper_width - line_width - left_margin - right_margin) > 1e-6)
229 line_width = line_width_default;
230 left_margin = left_margin_default;
231 right_margin = right_margin_default;
232 warning (_ ("margins do not fit with line-width, setting default values"));
234 else if ((left_margin < 0) || (right_margin < 0))
236 line_width = line_width_default;
237 left_margin = left_margin_default;
238 right_margin = right_margin_default;
239 warning (_ ("systems run off the page due to improper paper settings, setting default values"));
243 set_variable (ly_symbol2scm ("left-margin"), scm_from_double (left_margin));
244 set_variable (ly_symbol2scm ("right-margin"), scm_from_double (right_margin));
245 set_variable (ly_symbol2scm ("line-width"), scm_from_double (line_width));
248 /* FIXME. This is broken until we have a generic way of
249 putting lists inside the \layout block. */
251 line_dimensions_int (Output_def *def, int n)
253 Real lw = def->get_dimension (ly_symbol2scm ("line-width"));
255 ? def->get_dimension (ly_symbol2scm ("short-indent"))
256 : def->get_dimension (ly_symbol2scm ("indent"));
257 return Interval (ind, lw);