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 "context-def.hh"
21 #include "file-path.hh"
22 #include "global-context.hh"
23 #include "international.hh"
24 #include "interval.hh"
25 #include "ly-module.hh"
27 #include "output-def.hh"
28 #include "scm-hash.hh"
32 #include "program-option.hh"
34 #include "string-convert.hh"
36 Output_def::Output_def ()
43 scope_ = ly_make_module (false);
46 Output_def::Output_def (Output_def const &s)
53 input_origin_ = s.input_origin_;
54 scope_ = ly_make_module (false);
55 if (ly_is_module (s.scope_))
56 ly_module_copy (scope_, s.scope_);
59 Output_def::~Output_def ()
65 Output_def::mark_smob () const
67 /* FIXME: why is this necessary?
68 all paper_ should be protected by themselves. */
70 scm_gc_mark (parent_->self_scm ());
76 assign_context_def (Output_def * m, SCM transdef)
78 Context_def *tp = unsmob<Context_def> (transdef);
83 SCM sym = tp->get_context_name ();
84 m->set_variable (sym, transdef);
88 /* find the translator for NAME. NAME must be a symbol. */
90 find_context_def (Output_def const *m, SCM name)
92 Context_def *cd = unsmob<Context_def> (m->lookup_variable (name));
93 return cd ? cd->self_scm () : SCM_EOL;
97 Output_def::print_smob (SCM p, scm_print_state *) const
100 scm_puts (class_name (), p);
106 Output_def::get_dimension (SCM s) const
108 SCM val = lookup_variable (s);
109 return scm_to_double (val);
113 Output_def::lookup_variable (SCM sym) const
115 SCM var = ly_module_lookup (scope_, sym);
116 if (SCM_VARIABLEP (var) && !SCM_UNBNDP (SCM_VARIABLE_REF (var)))
117 return SCM_VARIABLE_REF (var);
120 return parent_->lookup_variable (sym);
122 return SCM_UNDEFINED;
126 Output_def::c_variable (const string &s) const
128 return lookup_variable (ly_symbol2scm (s.c_str ()));
132 Output_def::set_variable (SCM sym, SCM val)
134 scm_module_define (scope_, sym, val);
138 Output_def::normalize ()
141 SCM scm_paper_width = c_variable ("paper-width");
143 bool twosided = to_boolean (c_variable ("two-sided"));
144 // We don't distinguish between outer-margin / left-margin and so on
145 // until page-stencil positioning in page.scm
146 Real left_margin, left_margin_default;
147 SCM scm_left_margin_default = (twosided
148 ? c_variable ("outer-margin-default-scaled")
149 : c_variable ("left-margin-default-scaled"));
150 SCM scm_left_margin = (twosided
151 ? c_variable ("outer-margin")
152 : c_variable ("left-margin"));
154 Real right_margin, right_margin_default;
155 SCM scm_right_margin_default = (twosided
156 ? c_variable ("inner-margin-default-scaled")
157 : c_variable ("right-margin-default-scaled"));
158 SCM scm_right_margin = (twosided
159 ? c_variable ("inner-margin")
160 : c_variable ("right-margin"));
162 if (SCM_UNBNDP (scm_paper_width)
163 || SCM_UNBNDP (scm_left_margin_default)
164 || SCM_UNBNDP (scm_right_margin_default))
166 programming_error ("called normalize () on paper with missing settings");
171 paper_width = scm_to_double (scm_paper_width);
172 left_margin_default = scm_to_double (scm_left_margin_default);
173 right_margin_default = scm_to_double (scm_right_margin_default);
177 Real line_width_default
178 = paper_width - left_margin_default - right_margin_default;
179 SCM scm_line_width = c_variable ("line-width");
181 Real binding_offset = 0;
183 binding_offset = robust_scm2double (c_variable ("binding-offset"), 0);
185 if (SCM_UNBNDP (scm_line_width))
187 left_margin = (SCM_UNBNDP (scm_left_margin)
188 ? left_margin_default
189 : scm_to_double (scm_left_margin));
190 right_margin = (SCM_UNBNDP (scm_right_margin)
191 ? right_margin_default
192 : scm_to_double (scm_right_margin)) + binding_offset;
193 line_width = paper_width - left_margin - right_margin;
197 line_width = scm_to_double (scm_line_width);
198 if (SCM_UNBNDP (scm_left_margin))
200 // Vertically center systems if only line-width is given
201 if (SCM_UNBNDP (scm_right_margin))
203 left_margin = (paper_width - line_width) / 2;
204 right_margin = left_margin;
208 right_margin = scm_to_double (scm_right_margin) + binding_offset;
209 left_margin = paper_width - line_width - right_margin;
214 left_margin = scm_to_double (scm_left_margin);
215 right_margin = (SCM_UNBNDP (scm_right_margin)
216 ? (paper_width - line_width - left_margin)
217 : scm_to_double (scm_right_margin)) + binding_offset;
221 if (to_boolean (c_variable ("check-consistency")))
223 // Consistency checks. If values don't match, set defaults.
224 if (abs (paper_width - line_width - left_margin - right_margin) > 1e-6)
226 line_width = line_width_default;
227 left_margin = left_margin_default;
228 right_margin = right_margin_default;
229 warning (_ ("margins do not fit with line-width, setting default values"));
231 else if ((left_margin < 0) || (right_margin < 0))
233 line_width = line_width_default;
234 left_margin = left_margin_default;
235 right_margin = right_margin_default;
236 warning (_ ("systems run off the page due to improper paper settings, setting default values"));
240 set_variable (ly_symbol2scm ("left-margin"), scm_from_double (left_margin));
241 set_variable (ly_symbol2scm ("right-margin"), scm_from_double (right_margin));
242 set_variable (ly_symbol2scm ("line-width"), scm_from_double (line_width));
245 /* FIXME. This is broken until we have a generic way of
246 putting lists inside the \layout block. */
248 line_dimensions_int (Output_def *def, int n)
250 Real lw = def->get_dimension (ly_symbol2scm ("line-width"));
252 ? def->get_dimension (ly_symbol2scm ("short-indent"))
253 : def->get_dimension (ly_symbol2scm ("indent"));
254 return Interval (ind, lw);