2 paper-outputter.cc -- implement Paper_outputter
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
14 #include "dimensions.hh"
15 #include "font-metric.hh"
16 #include "input-smob.hh"
17 #include "lily-guile.hh"
18 #include "lily-version.hh"
19 #include "ly-module.hh"
22 #include "paper-book.hh"
23 #include "paper-def.hh"
24 #include "paper-line.hh"
25 #include "paper-outputter.hh"
26 #include "file-name.hh"
27 #include "scm-hash.hh"
29 #include "string-convert.hh"
33 extern SCM stencil2line (Stencil* stil, bool is_title = false);
35 Paper_outputter::Paper_outputter (String filename)
38 file_ = scm_open_file (scm_makfrom0str (filename.to_str0 ()),
39 scm_makfrom0str ("w"));
42 scm_define (ly_symbol2scm ("safe-mode?"), SCM_BOOL_T);
44 String module_name = "scm output-" + output_format_global;
47 /* In safe mode, start from a GUILE safe-module and import
48 all symbols from the output module. */
49 scm_c_use_module ("ice-9 safe");
50 SCM msm = scm_primitive_eval (ly_symbol2scm ("make-safe-module"));
51 output_module_ = scm_call_0 (msm);
52 ly_import_module (output_module_,
53 scm_c_resolve_module (module_name.to_str0 ()));
56 output_module_ = scm_c_resolve_module (module_name.to_str0 ());
58 /* FIXME: output-lib should be module, that can be imported. */
59 #define IMPORT_LESS 1 // only import the list of IMPORTS
61 scm_c_use_module ("lily");
62 scm_c_use_module ("ice-9 regex");
63 scm_c_use_module ("srfi srfi-1");
64 scm_c_use_module ("srfi srfi-13");
66 char const *imports[] = {
67 "lilypond-version", /* from lily */
68 "ly:output-def-scope",
71 "ly:ragged-page-breaks",
72 "ly:optimal-page-breaks",
74 "ly:number-pair->string", /* output-lib.scm */
80 "remove", /* from srfi srfi-1 */
81 "string-index", /* from srfi srfi-13 */
83 "regexp-substitute/global", /* from (ice9 regex) */
88 for (int i = 0; imports[i]; i++)
90 SCM s = ly_symbol2scm (imports[i]);
91 scm_module_define (output_module_, s, scm_primitive_eval (s));
93 #ifndef IMPORT_LESS // rather crude, esp for safe-mode let's not
94 SCM m = scm_set_current_module (output_module_);
95 /* not present in current module*/
96 scm_c_use_module ("ice-9 regex");
97 scm_c_use_module ("srfi srfi-13");
98 /* Need only a few of these, see above
99 scm_c_use_module ("lily"); */
100 scm_set_current_module (m);
104 Paper_outputter::~Paper_outputter ()
106 scm_close_port (file_);
111 Paper_outputter::output_scheme (SCM scm)
113 scm_display (scm_eval (scm, output_module_), file_);
117 Paper_outputter::output_metadata (Paper_def *paper, SCM scopes)
119 SCM fields = SCM_EOL;
120 for (int i = dump_header_fieldnames_global.size (); i--; )
122 = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].to_str0 ()),
125 File_name file_name (filename_);
127 String basename = file_name.to_string ();
128 output_scheme (scm_list_n (ly_symbol2scm ("output-scopes"),
130 ly_quote_scm (scopes),
131 ly_quote_scm (fields),
132 scm_makfrom0str (basename.to_str0 ()),
137 Paper_outputter::output_header (Paper_def *paper, SCM scopes, int page_count,
140 String creator = gnu_lilypond_version_string ();
141 creator += " (http://lilypond.org)";
143 String time_stamp = ctime (&t);
144 time_stamp = time_stamp.left_string (time_stamp.length () - 1)
146 output_scheme (scm_list_n (ly_symbol2scm ("header"),
147 scm_makfrom0str (creator.to_str0 ()),
148 scm_makfrom0str (time_stamp.to_str0 ()),
150 scm_int2num (page_count),
151 ly_bool2scm (is_classic),
154 output_metadata (paper, scopes);
155 output_music_output_def (paper);
157 output_scheme (scm_list_1 (ly_symbol2scm ("header-end")));
159 /* TODO: maybe have Scheme extract the fonts directly from \paper ?
161 Alternatively, we could simply load the fonts on demand in the
162 output, and do away with this define-fonts step. */
163 SCM fonts = paper->font_descriptions ();
164 output_scheme (scm_list_3 (ly_symbol2scm ("define-fonts"),
167 ly_quote_scm (ly_list_qsort_uniq_x (fonts))));
171 Paper_outputter::output_line (SCM line, Offset *origin, bool is_last)
173 Paper_line *p = unsmob_paper_line (line);
174 Offset dim = p->dim ();
175 if (dim[Y_AXIS] > 50 CM)
177 programming_error (to_string ("Improbable line height: %f",
182 output_scheme (scm_list_3 (ly_symbol2scm ("start-system"),
183 ly_quote_scm (ly_offset2scm (*origin)),
184 ly_quote_scm (ly_offset2scm (dim))));
186 output_stencil (unsmob_stencil (p->to_stencil ()));
188 (*origin)[Y_AXIS] += dim[Y_AXIS];
189 output_scheme (scm_list_2 (ly_symbol2scm ("stop-system"),
190 ly_bool2scm (is_last)));
194 Paper_outputter::output_page (Page *p, bool is_last)
196 output_scheme (scm_list_1 (ly_symbol2scm ("start-page")));
198 output_scheme (scm_list_3 (ly_symbol2scm ("start-system"),
199 ly_quote_scm (ly_offset2scm (Offset (0, 0))),
200 ly_quote_scm (ly_offset2scm (Offset (0, 0)))));
202 output_stencil (unsmob_stencil (p->to_stencil ()));
204 output_scheme (scm_list_2 (ly_symbol2scm ("stop-system"), SCM_BOOL_T));
205 output_scheme (scm_list_2 (ly_symbol2scm ("stop-page"),
207 && !unsmob_stencil (p->footer_))));
211 Paper_outputter::output_music_output_def (Music_output_def *odef)
213 output_scheme (scm_list_2 (ly_symbol2scm ("output-paper-def"),
218 Paper_outputter::output_stencil (Stencil *stil)
220 output_expr (stil->expr (), stil->origin ());
223 /* TODO: replaceme/rewriteme, see output-ps.scm: output-stencil */
225 Paper_outputter::output_expr (SCM expr, Offset o)
229 if (!ly_c_pair_p (expr))
232 SCM head =ly_car (expr);
233 if (unsmob_input (head))
235 Input *ip = unsmob_input (head);
236 output_scheme (scm_list_4 (ly_symbol2scm ("define-origin"),
237 scm_makfrom0str (ip->file_string ()
239 scm_int2num (ip->line_number ()),
240 scm_int2num (ip->column_number ())));
241 expr = ly_cadr (expr);
243 else if (head == ly_symbol2scm ("no-origin"))
245 output_scheme (scm_list_1 (head));
246 expr = ly_cadr (expr);
248 else if (head == ly_symbol2scm ("translate-stencil"))
250 o += ly_scm2offset (ly_cadr (expr));
251 expr = ly_caddr (expr);
253 else if (head == ly_symbol2scm ("combine-stencil"))
255 output_expr (ly_cadr (expr), o);
256 expr = ly_caddr (expr);
260 output_scheme (scm_list_4 (ly_symbol2scm ("placebox"),
261 scm_make_real (o[X_AXIS]),
262 scm_make_real (o[Y_AXIS]),