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>
12 #include "lilypond-key.hh"
13 #include "context-selector.hh"
14 #include "grob-selector.hh"
15 #include "file-name.hh"
16 #include "file-path.hh"
17 #include "lily-version.hh"
18 #include "ly-module.hh"
20 #include "lily-lexer.hh"
21 #include "lily-parser.hh"
22 #include "output-def.hh"
23 #include "paper-book.hh"
30 Lily_parser::Lily_parser (Sources *sources)
36 default_duration_ = Duration (2, 0);
38 last_beam_start_ = SCM_EOL;
43 Lily_parser::Lily_parser (Lily_parser const &src)
45 book_count_ = src.book_count_;
46 score_count_ = src.score_count_;
48 sources_ = src.sources_;
49 default_duration_ = src.default_duration_;
50 error_level_ = src.error_level_;
51 last_beam_start_ = src.last_beam_start_;
55 lexer_ = new Lily_lexer (*src.lexer_);
57 scm_gc_unprotect_object (lexer_->self_scm ());
60 Lily_parser::~Lily_parser ()
64 #include "ly-smobs.icc"
66 IMPLEMENT_SMOBS (Lily_parser);
67 IMPLEMENT_TYPE_P (Lily_parser, "ly:lily-parser?");
68 IMPLEMENT_DEFAULT_EQUAL_P (Lily_parser);
71 Lily_parser::mark_smob (SCM s)
73 Lily_parser *parser = (Lily_parser*) SCM_CELL_WORD_1 (s);
74 return (parser->lexer_) ? parser->lexer_->self_scm () : SCM_EOL;
78 Lily_parser::print_smob (SCM s, SCM port, scm_print_state*)
80 scm_puts ("#<my_lily_parser ", port);
81 Lily_parser *parser = (Lily_parser*) SCM_CELL_WORD_1 (s);
83 scm_puts (" >", port);
88 /* Process one .ly file, or book. */
90 Lily_parser::parse_file (String init, String name, String out_name)
92 lexer_ = new Lily_lexer (sources_);
93 scm_gc_unprotect_object (lexer_->self_scm ());
95 lexer_->set_identifier (ly_symbol2scm ("parser"),
97 output_basename_ = out_name;
99 lexer_->main_input_name_ = name;
101 progress_indication (_ ("Parsing..."));
102 progress_indication ("\n");
106 lexer_->new_input (init, sources_);
109 String s = global_path.find (f.base_ + ".twy");
110 s = gulp_file_to_string (s, false);
111 scm_eval_string (scm_makfrom0str (s.to_str0 ()));
113 /* Read .ly IN_FILE, lex, parse, write \score blocks from IN_FILE to
114 OUT_FILE (unless IN_FILE redefines output file name). */
117 if (!define_spots_.is_empty ())
119 define_spots_.top ().warning (_ ("Braces don't match"));
123 error_level_ = error_level_ | lexer_->error_level_;
128 Lily_parser::parse_string (String ly_code)
130 Lily_lexer * parent = lexer_;
131 lexer_ = (parent == 0 ? new Lily_lexer (sources_)
132 : new Lily_lexer (*parent));
133 scm_gc_unprotect_object (lexer_->self_scm ());
136 SCM oldmod = scm_current_module ();
137 scm_set_current_module (scm_car (lexer_->scopes_));
140 lexer_->set_identifier (ly_symbol2scm ("parser"),
143 lexer_->main_input_name_ = "<string>";
144 lexer_->main_input_b_ = true;
147 lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
150 if (!define_spots_.is_empty ())
152 define_spots_.top ().warning (_ ("Braces don't match"));
156 error_level_ = error_level_ | lexer_->error_level_;
158 scm_set_current_module (oldmod);
163 Lily_parser::push_spot ()
165 define_spots_.push (here_input ());
169 Lily_parser::here_str0 () const
171 return lexer_->here_str0 ();
175 Lily_parser::parser_error (String s)
177 here_input ().error (s);
182 Lily_parser::pop_spot ()
184 return define_spots_.pop ();
188 Lily_parser::here_input () const
191 Parsing looks ahead , so we really want the previous location of the
192 lexer, not lexer_->here_input ().
196 Actually, that gets very icky when there are white space, because
197 the line-numbers are all wrong. Let's try the character before
198 the current token. That gets the right result for note/duration
199 stuff, but doesn't mess up for errors in the 1st token of the
202 Input hi (lexer_->here_input ());
204 char const * bla = hi.defined_str0_;
205 if (hi.line_number () > 1
206 || hi.column_number () > 1)
209 return Input (hi.source_file_, bla);
213 /****************************************************************/
219 bool store_locations_global_b;
221 /* Do not append `!' suffix, since 1st argument is not modified. */
222 LY_DEFINE (ly_set_point_and_click, "ly:set-point-and-click",
224 "Set the options for Point-and-click source specials output. The\n"
225 "argument is a symbol. Possible options are @code{none} (no source specials),\n"
226 "@code{line} and @code{line-column}")
229 SCM val = SCM_BOOL_F;
230 if (ly_symbol2scm ("line-column") == what)
231 val = ly_scheme_function ("line-column-location");
232 else if (what == ly_symbol2scm ("line"))
233 val = ly_scheme_function ("line-location");
235 scm_module_define (global_lily_module, ly_symbol2scm ("point-and-click"),
237 store_locations_global_b = ly_c_procedure_p (val);
238 return SCM_UNSPECIFIED;
241 LY_DEFINE (ly_parse_file, "ly:parse-file",
243 "Parse a single @code{.ly} file. "
244 "Upon failure, throw @code{ly-file-failed} key.")
246 SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string");
247 char const *file = scm_i_string_chars (name);
248 char const *extensions[] = {"ly", "", 0};
250 String file_name = global_path.find (file, extensions);
252 /* By default, use base name of input file for output file name,
253 write output to cwd; do not use root and directory parts of input
255 File_name out_file_name (file_name);
257 global_path.append (out_file_name.dir_);
259 out_file_name.ext_ = "";
260 out_file_name.root_ = "";
261 out_file_name.dir_ = "";
263 if (!output_name_global.is_empty ())
264 out_file_name = File_name (output_name_global);
267 if (!init_name_global.is_empty ())
268 init = init_name_global;
272 String out_file = out_file_name.to_string ();
274 if (init.length () && global_path.find (init).is_empty ())
276 warning (_f ("can't find init file: `%s'", init));
277 warning (_f ("(search path: `%s')",
278 global_path.to_string ().to_str0 ()));
282 if ((file_name != "-") && global_path.find (file_name).is_empty ())
284 warning (_f ("can't find file: `%s'", file_name));
285 scm_throw (ly_symbol2scm ("ly-file-failed"),
286 scm_list_1 (scm_makfrom0str (file_name.to_str0 ())));
291 sources.set_path (&global_path);
293 progress_indication (_f ("Processing `%s'", file_name.to_str0 ()));
294 progress_indication ("\n");
296 Lily_parser *parser = new Lily_parser (&sources);
298 parser->parse_file (init, file_name, out_file);
300 bool error = parser->error_level_;
301 scm_gc_unprotect_object (parser->self_scm ());
304 /* TODO: pass renamed input file too. */
305 scm_throw (ly_symbol2scm ("ly-file-failed"),
306 scm_list_1 (scm_makfrom0str (file_name.to_str0 ())));
308 return SCM_UNSPECIFIED;
311 LY_DEFINE (ly_parse_string, "ly:parse-string",
312 1, 0, 0, (SCM ly_code),
313 "Parse the string LY_CODE. "
314 "Upon failure, throw @code{ly-file-failed} key.")
316 SCM_ASSERT_TYPE (scm_is_string (ly_code), ly_code, SCM_ARG1, __FUNCTION__, "string");
319 sources.set_path (&global_path);
320 Lily_parser *parser = new Lily_parser (&sources);
321 scm_module_define (global_lily_module, ly_symbol2scm ("parser"),
322 parser->self_scm ());
323 parser->parse_string (ly_scm2string (ly_code));
324 scm_gc_unprotect_object (parser->self_scm ());
327 return SCM_UNSPECIFIED;
330 LY_DEFINE (ly_clone_parser, "ly:clone-parser",
331 1, 0, 0, (SCM parser_smob),
332 "Return a clone of PARSER_SMOB.")
334 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
335 Lily_parser *clone = new Lily_parser (*parser);
337 /* FIXME: should copy scopes too. */
338 return scm_gc_unprotect_object (clone->self_scm ());
341 LY_DEFINE (ly_parser_define, "ly:parser-define",
342 3, 0, 0, (SCM parser_smob, SCM symbol, SCM val),
343 "Bind SYMBOL to VAL in PARSER_SMOB's module.")
345 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
346 SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol, SCM_ARG2, __FUNCTION__, "symbol");
347 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG2, __FUNCTION__, "parser");
349 parser->lexer_->set_identifier (scm_symbol_to_string (symbol), val);
350 return SCM_UNSPECIFIED;
353 LY_DEFINE (ly_parser_lookup, "ly:parser-lookup",
354 2, 0, 0, (SCM parser_smob, SCM symbol),
355 "Lookup @var{symbol} in @var{parser_smob}'s module. "
358 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
360 SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol, SCM_ARG2, __FUNCTION__, "symbol");
361 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG2, __FUNCTION__, "parser");
363 SCM val= parser->lexer_->lookup_identifier (ly_scm2string (scm_symbol_to_string (symbol)));
364 if (val != SCM_UNDEFINED)
370 LY_DEFINE (ly_parser_parse_string, "ly:parser-parse-string",
371 2, 0, 0, (SCM parser_smob, SCM ly_code),
372 "Parse the string LY_CODE with PARSER_SMOB."
373 "Upon failure, throw @code{ly-file-failed} key.")
375 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
377 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "parser");
378 SCM_ASSERT_TYPE (scm_is_string (ly_code), ly_code, SCM_ARG2, __FUNCTION__, "string");
380 parser->parse_string (ly_scm2string (ly_code));
382 return SCM_UNSPECIFIED;
386 get_layout (Lily_parser *parser)
388 SCM id = parser->lexer_->lookup_identifier ("$defaultlayout");
389 Output_def *layout = unsmob_output_def (id);
390 layout = layout ? layout->clone () : new Output_def;
391 layout->set_variable (ly_symbol2scm ("is-layout"), SCM_BOOL_T);
398 get_midi (Lily_parser *parser)
400 SCM id = parser->lexer_->lookup_identifier ("$defaultmidi");
401 Output_def *layout = unsmob_output_def (id);
402 layout = layout ? layout->clone () : new Output_def;
403 layout->set_variable (ly_symbol2scm ("is-midi"), SCM_BOOL_T);
409 get_paper (Lily_parser *parser)
411 SCM id = parser->lexer_->lookup_identifier ("$defaultpaper");
412 Output_def *layout = unsmob_output_def (id);
414 layout = layout ? dynamic_cast<Output_def*> (layout->clone ()) : new Output_def;
415 layout->set_variable (ly_symbol2scm ("is-paper"), SCM_BOOL_T);
420 /* TODO: move this to Scheme? Why take the parser arg, and all the back
421 & forth between scm and c++? */
422 LY_DEFINE (ly_parser_print_score, "ly:parser-print-score",
424 (SCM parser_smob, SCM score_smob),
425 "Print score, i.e., the classic way.")
427 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
428 Score *score = unsmob_score (score_smob);
430 Object_key * key = new Lilypond_general_key (0, score->user_key_, 0);
432 if (score->error_found_)
433 return SCM_UNSPECIFIED;
435 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "parser");
436 SCM_ASSERT_TYPE (score, score_smob, SCM_ARG2, __FUNCTION__, "score");
438 SCM header = ly_c_module_p (score->header_) ? score->header_
439 : parser->lexer_->lookup_identifier ("$globalheader");
441 File_name outname (parser->output_basename_);
442 int *c = &parser->book_count_;
444 outname.base_ += "-" + to_string (*c);
447 SCM os = scm_makfrom0str (outname.to_string ().to_str0 ());
448 SCM paper = get_paper (parser)->self_scm ();
449 for (int i = 0; i < score->defs_.size (); i++)
450 default_rendering (score->get_music (), score->defs_[i]->self_scm (),
455 if (score->defs_.is_empty ())
457 Output_def *layout = get_layout (parser);
458 default_rendering (score->get_music(), layout->self_scm (),
459 get_paper (parser)->self_scm (),
460 header, os, key->self_scm ());
461 scm_gc_unprotect_object (layout->self_scm ());
464 scm_gc_unprotect_object (key->self_scm ());
465 return SCM_UNSPECIFIED;
469 LY_DEFINE (ly_parser_set_note_names, "ly:parser-set-note-names",
470 2, 0, 0, (SCM parser, SCM names),
471 "Replace current note names in @var{parser}. "
472 "@var{names} is an alist of symbols. "
473 "This only has effect if the current mode is notes.")
475 Lily_parser *p = unsmob_my_lily_parser (parser);
476 SCM_ASSERT_TYPE(p, parser, SCM_ARG1, __FUNCTION__, "Lilypond parser");
478 if (p->lexer_->is_note_state ())
480 p->lexer_->pop_state ();
481 p->lexer_->push_note_state (alist_to_hashq (names));
484 return SCM_UNSPECIFIED;
487 LY_DEFINE (ly_parser_print_book, "ly:parser-print-book",
488 2, 0, 0, (SCM parser_smob, SCM book_smob),
491 Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
492 Book *book = unsmob_book (book_smob);
493 Output_def *bp = unsmob_output_def (parser->lexer_->lookup_identifier ("$defaultpaper"));
495 SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "Lilypond parser");
496 SCM_ASSERT_TYPE (book, book_smob, SCM_ARG2, __FUNCTION__, "Book");
498 /* ugh. changing argument.*/
501 File_name outname (parser->output_basename_);
502 int *c = &parser->book_count_;
504 outname.base_ += "-" + to_string (*c);
507 Output_def *layout = get_layout (parser);
508 Paper_book* pb = book->process (outname.to_string (), layout);
512 pb->output (outname.to_string ());
513 scm_gc_unprotect_object (pb->self_scm ());
516 scm_gc_unprotect_object (layout->self_scm ());
517 return SCM_UNSPECIFIED;