2 lily-parser.cc -- implement Lily_parser
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>
10 #include "lily-parser.hh"
13 #include "lilypond-key.hh"
14 #include "file-name.hh"
15 #include "file-path.hh"
16 #include "lily-version.hh"
17 #include "ly-module.hh"
19 #include "lily-lexer.hh"
20 #include "output-def.hh"
21 #include "paper-book.hh"
27 Lily_parser::Lily_parser (Sources *sources)
33 default_duration_ = Duration (2, 0);
35 last_beam_start_ = SCM_EOL;
40 Lily_parser::Lily_parser (Lily_parser const &src)
42 book_count_ = src.book_count_;
43 score_count_ = src.score_count_;
45 sources_ = src.sources_;
46 default_duration_ = src.default_duration_;
47 error_level_ = src.error_level_;
48 last_beam_start_ = src.last_beam_start_;
52 lexer_ = new Lily_lexer (*src.lexer_);
54 scm_gc_unprotect_object (lexer_->self_scm ());
57 Lily_parser::~Lily_parser ()
61 #include "ly-smobs.icc"
63 IMPLEMENT_SMOBS (Lily_parser);
64 IMPLEMENT_TYPE_P (Lily_parser, "ly:lily-parser?");
65 IMPLEMENT_DEFAULT_EQUAL_P (Lily_parser);
68 Lily_parser::mark_smob (SCM s)
70 Lily_parser *parser = (Lily_parser*) SCM_CELL_WORD_1 (s);
71 return (parser->lexer_) ? parser->lexer_->self_scm () : SCM_EOL;
75 Lily_parser::print_smob (SCM s, SCM port, scm_print_state*)
77 scm_puts ("#<my_lily_parser ", port);
78 Lily_parser *parser = (Lily_parser*) SCM_CELL_WORD_1 (s);
80 scm_puts (" >", port);
85 /* Process one .ly file, or book. */
87 Lily_parser::parse_file (String init, String name, String out_name)
89 lexer_ = new Lily_lexer (sources_);
90 scm_gc_unprotect_object (lexer_->self_scm ());
92 lexer_->set_identifier (ly_symbol2scm ("parser"),
94 output_basename_ = out_name;
96 lexer_->main_input_name_ = name;
98 progress_indication (_ ("Parsing..."));
99 progress_indication ("\n");
103 lexer_->new_input (init, sources_);
106 String s = global_path.find (f.base_ + ".twy");
107 s = gulp_file_to_string (s, false);
108 scm_eval_string (scm_makfrom0str (s.to_str0 ()));
110 /* Read .ly IN_FILE, lex, parse, write \score blocks from IN_FILE to
111 OUT_FILE (unless IN_FILE redefines output file name). */
114 if (!define_spots_.is_empty ())
116 define_spots_.top ().warning (_ ("Braces don't match"));
120 error_level_ = error_level_ | lexer_->error_level_;
125 Lily_parser::parse_string (String ly_code)
127 Lily_lexer * parent = lexer_;
128 lexer_ = (parent == 0 ? new Lily_lexer (sources_)
129 : new Lily_lexer (*parent));
130 scm_gc_unprotect_object (lexer_->self_scm ());
133 SCM oldmod = scm_current_module ();
134 scm_set_current_module (scm_car (lexer_->scopes_));
137 lexer_->set_identifier (ly_symbol2scm ("parser"),
140 lexer_->main_input_name_ = "<string>";
141 lexer_->main_input_b_ = true;
144 lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
147 if (!define_spots_.is_empty ())
149 if (define_spots_.is_empty()
151 programming_error ("Braces don't match, but error_level_ not set.");
154 error_level_ = error_level_ | lexer_->error_level_;
156 scm_set_current_module (oldmod);
161 Lily_parser::push_spot ()
163 define_spots_.push (here_input ());
167 Lily_parser::here_str0 () const
169 return lexer_->here_str0 ();
173 Lily_parser::parser_error (String s)
175 here_input ().error (s);
180 Lily_parser::pop_spot ()
182 return define_spots_.pop ();
186 Lily_parser::here_input () const
189 Parsing looks ahead , so we really want the previous location of the
190 lexer, not lexer_->here_input ().
194 Actually, that gets very icky when there are white space, because
195 the line-numbers are all wrong. Let's try the character before
196 the current token. That gets the right result for note/duration
197 stuff, but doesn't mess up for errors in the 1st token of the
200 Input hi (lexer_->here_input ());
202 char const * bla = hi.defined_str0_;
203 if (hi.line_number () > 1
204 || hi.column_number () > 1)
207 return Input (hi.source_file_, bla);
211 /****************************************************************/
217 bool store_locations_global_b;
219 /* Do not append `!' suffix, since 1st argument is not modified. */
220 LY_DEFINE (ly_set_point_and_click, "ly:set-point-and-click",
222 "Set the options for Point-and-click source specials output. The\n"
223 "argument is a symbol. Possible options are @code{none} (no source specials),\n"
224 "@code{line} and @code{line-column}")
227 SCM val = SCM_BOOL_F;
228 if (ly_symbol2scm ("line-column") == what)
229 val = ly_scheme_function ("line-column-location");
230 else if (what == ly_symbol2scm ("line"))
231 val = ly_scheme_function ("line-location");
233 scm_module_define (global_lily_module, ly_symbol2scm ("point-and-click"),
235 store_locations_global_b = ly_c_procedure_p (val);
236 return SCM_UNSPECIFIED;
239 LY_DEFINE (ly_parse_file, "ly:parse-file",
241 "Parse a single @code{.ly} file. "
242 "Upon failure, throw @code{ly-file-failed} key.")
244 SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string");
245 char const *file = scm_i_string_chars (name);
246 char const *extensions[] = {"ly", "", 0};
248 String file_name = global_path.find (file, extensions);
250 /* By default, use base name of input file for output file name,
251 write output to cwd; do not use root and directory parts of input
253 File_name out_file_name (file_name);
255 global_path.append (out_file_name.dir_);
257 out_file_name.ext_ = "";
258 out_file_name.root_ = "";
259 out_file_name.dir_ = "";
261 if (!output_name_global.is_empty ())
262 out_file_name = File_name (output_name_global);
265 if (!init_name_global.is_empty ())
266 init = init_name_global;
270 String out_file = out_file_name.to_string ();
272 if (init.length () && global_path.find (init).is_empty ())
274 warning (_f ("can't find init file: `%s'", init));
275 warning (_f ("(search path: `%s')",
276 global_path.to_string ().to_str0 ()));
280 if ((file_name != "-") && global_path.find (file_name).is_empty ())
282 warning (_f ("can't find file: `%s'", file_name));
283 scm_throw (ly_symbol2scm ("ly-file-failed"),
284 scm_list_1 (scm_makfrom0str (file_name.to_str0 ())));
289 sources.set_path (&global_path);
291 progress_indication (_f ("Processing `%s'", file_name.to_str0 ()));
292 progress_indication ("\n");
294 Lily_parser *parser = new Lily_parser (&sources);
296 parser->parse_file (init, file_name, out_file);
298 bool error = parser->error_level_;
299 scm_gc_unprotect_object (parser->self_scm ());
302 /* TODO: pass renamed input file too. */
303 scm_throw (ly_symbol2scm ("ly-file-failed"),
304 scm_list_1 (scm_makfrom0str (file_name.to_str0 ())));
306 return SCM_UNSPECIFIED;
309 LY_DEFINE (ly_parse_string, "ly:parse-string",
310 1, 0, 0, (SCM ly_code),
311 "Parse the string LY_CODE. "
312 "Upon failure, throw @code{ly-file-failed} key.")
314 SCM_ASSERT_TYPE (scm_is_string (ly_code), ly_code, SCM_ARG1, __FUNCTION__, "string");
317 sources.set_path (&global_path);
318 Lily_parser *parser = new Lily_parser (&sources);
319 scm_module_define (global_lily_module, ly_symbol2scm ("parser"),
320 parser->self_scm ());
321 parser->parse_string (ly_scm2string (ly_code));
322 scm_gc_unprotect_object (parser->self_scm ());
325 return SCM_UNSPECIFIED;
328 LY_DEFINE (ly_clone_parser, "ly:clone-parser",
329 1, 0, 0, (SCM parser_smob),
330 "Return a clone of PARSER_SMOB.")
332 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
333 Lily_parser *clone = new Lily_parser (*parser);
335 /* FIXME: should copy scopes too. */
336 return scm_gc_unprotect_object (clone->self_scm ());
339 LY_DEFINE (ly_parser_define, "ly:parser-define",
340 3, 0, 0, (SCM parser_smob, SCM symbol, SCM val),
341 "Bind SYMBOL to VAL in PARSER_SMOB's module.")
343 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
344 SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol, SCM_ARG2, __FUNCTION__, "symbol");
345 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG2, __FUNCTION__, "parser");
347 parser->lexer_->set_identifier (scm_symbol_to_string (symbol), val);
348 return SCM_UNSPECIFIED;
351 LY_DEFINE (ly_parser_lookup, "ly:parser-lookup",
352 2, 0, 0, (SCM parser_smob, SCM symbol),
353 "Lookup @var{symbol} in @var{parser_smob}'s module. "
356 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
358 SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol, SCM_ARG2, __FUNCTION__, "symbol");
359 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG2, __FUNCTION__, "parser");
361 SCM val = parser->lexer_->lookup_identifier (ly_scm2string (scm_symbol_to_string (symbol)));
362 if (val != SCM_UNDEFINED)
368 LY_DEFINE (ly_parser_parse_string, "ly:parser-parse-string",
369 2, 0, 0, (SCM parser_smob, SCM ly_code),
370 "Parse the string LY_CODE with PARSER_SMOB."
371 "Upon failure, throw @code{ly-file-failed} key.")
373 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
375 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "parser");
376 SCM_ASSERT_TYPE (scm_is_string (ly_code), ly_code, SCM_ARG2, __FUNCTION__, "string");
378 parser->parse_string (ly_scm2string (ly_code));
380 return SCM_UNSPECIFIED;
384 get_layout (Lily_parser *parser)
386 SCM id = parser->lexer_->lookup_identifier ("$defaultlayout");
387 Output_def *layout = unsmob_output_def (id);
388 layout = layout ? layout->clone () : new Output_def;
389 layout->set_variable (ly_symbol2scm ("is-layout"), SCM_BOOL_T);
396 get_midi (Lily_parser *parser)
398 SCM id = parser->lexer_->lookup_identifier ("$defaultmidi");
399 Output_def *layout = unsmob_output_def (id);
400 layout = layout ? layout->clone () : new Output_def;
401 layout->set_variable (ly_symbol2scm ("is-midi"), SCM_BOOL_T);
407 get_paper (Lily_parser *parser)
409 SCM id = parser->lexer_->lookup_identifier ("$defaultpaper");
410 Output_def *layout = unsmob_output_def (id);
412 layout = layout ? dynamic_cast<Output_def*> (layout->clone ()) : new Output_def;
413 layout->set_variable (ly_symbol2scm ("is-paper"), SCM_BOOL_T);
418 /* TODO: move this to Scheme? Why take the parser arg, and all the back
419 & forth between scm and c++? */
420 LY_DEFINE (ly_parser_print_score, "ly:parser-print-score",
422 (SCM parser_smob, SCM score_smob),
423 "Print score, i.e., the classic way.")
425 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
426 Score *score = unsmob_score (score_smob);
428 Object_key * key = new Lilypond_general_key (0, score->user_key_, 0);
430 if (score->error_found_)
431 return SCM_UNSPECIFIED;
433 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "parser");
434 SCM_ASSERT_TYPE (score, score_smob, SCM_ARG2, __FUNCTION__, "score");
436 SCM header = ly_c_module_p (score->header_) ? score->header_
437 : parser->lexer_->lookup_identifier ("$globalheader");
439 File_name outname (parser->output_basename_);
440 int *c = &parser->book_count_;
442 outname.base_ += "-" + to_string (*c);
445 SCM os = scm_makfrom0str (outname.to_string ().to_str0 ());
446 SCM paper = get_paper (parser)->self_scm ();
447 for (int i = 0; i < score->defs_.size (); i++)
448 default_rendering (score->get_music (), score->defs_[i]->self_scm (),
453 if (score->defs_.is_empty ())
455 Output_def *layout = get_layout (parser);
456 default_rendering (score->get_music(), layout->self_scm (),
457 get_paper (parser)->self_scm (),
458 header, os, key->self_scm ());
459 scm_gc_unprotect_object (layout->self_scm ());
462 scm_gc_unprotect_object (key->self_scm ());
463 return SCM_UNSPECIFIED;
467 LY_DEFINE (ly_parser_set_note_names, "ly:parser-set-note-names",
468 2, 0, 0, (SCM parser, SCM names),
469 "Replace current note names in @var{parser}. "
470 "@var{names} is an alist of symbols. "
471 "This only has effect if the current mode is notes.")
473 Lily_parser *p = unsmob_my_lily_parser (parser);
474 SCM_ASSERT_TYPE(p, parser, SCM_ARG1, __FUNCTION__, "Lilypond parser");
476 if (p->lexer_->is_note_state ())
478 p->lexer_->pop_state ();
479 p->lexer_->push_note_state (alist_to_hashq (names));
482 return SCM_UNSPECIFIED;
485 LY_DEFINE (ly_parser_print_book, "ly:parser-print-book",
486 2, 0, 0, (SCM parser_smob, SCM book_smob),
489 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
490 Book *book = unsmob_book (book_smob);
491 Output_def *bp = unsmob_output_def (parser->lexer_->lookup_identifier ("$defaultpaper"));
493 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "Lilypond parser");
494 SCM_ASSERT_TYPE (book, book_smob, SCM_ARG2, __FUNCTION__, "Book");
496 /* ugh. changing argument.*/
499 File_name outname (parser->output_basename_);
500 int *c = &parser->book_count_;
502 outname.base_ += "-" + to_string (*c);
505 Output_def *layout = get_layout (parser);
506 Paper_book* pb = book->process (outname.to_string (), layout);
510 pb->output (outname.to_string ());
511 scm_gc_unprotect_object (pb->self_scm ());
514 scm_gc_unprotect_object (layout->self_scm ());
515 return SCM_UNSPECIFIED;