lily/lily-parser.cc

   1 /*
   2   lily-parser.cc -- implement Lily_parser
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7        Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 #include "lily-parser.hh"
  11
  12 #include "book.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"
  18 #include "main.hh"
  19 #include "lily-lexer.hh"
  20 #include "output-def.hh"
  21 #include "paper-book.hh"
  22 #include "parser.hh"
  23 #include "score.hh"
  24 #include "source.hh"
  25 #include "warn.hh"
  26
  27 Lily_parser::Lily_parser (Sources *sources)
  28 {
  29   book_count_ = 0;
  30   score_count_ = 0;
  31   lexer_ = 0;
  32   sources_ = sources;
  33   default_duration_ = Duration (2, 0);
  34   error_level_ = 0;
  35   last_beam_start_ = SCM_EOL;
  36
  37   smobify_self ();
  38 }
  39
  40 Lily_parser::Lily_parser (Lily_parser const &src)
  41 {
  42   book_count_ = src.book_count_;
  43   score_count_ = src.score_count_;
  44   lexer_ = 0;
  45   sources_ = src.sources_;
  46   default_duration_ = src.default_duration_;
  47   error_level_ = src.error_level_;
  48   last_beam_start_ = src.last_beam_start_;
  49
  50   smobify_self ();
  51   if (src.lexer_)
  52     lexer_ = new Lily_lexer (*src.lexer_);
  53
  54   scm_gc_unprotect_object (lexer_->self_scm ());
  55 }
  56
  57 Lily_parser::~Lily_parser ()
  58 {
  59 }
  60
  61 #include "ly-smobs.icc"
  62
  63 IMPLEMENT_SMOBS (Lily_parser);
  64 IMPLEMENT_TYPE_P (Lily_parser, "ly:lily-parser?");
  65 IMPLEMENT_DEFAULT_EQUAL_P (Lily_parser);
  66
  67 SCM
  68 Lily_parser::mark_smob (SCM s)
  69 {
  70   Lily_parser *parser = (Lily_parser*) SCM_CELL_WORD_1 (s);
  71   return (parser->lexer_) ? parser->lexer_->self_scm () : SCM_EOL;
  72 }
  73
  74 int
  75 Lily_parser::print_smob (SCM s, SCM port, scm_print_state*)
  76 {
  77   scm_puts ("#<my_lily_parser ", port);
  78   Lily_parser *parser = (Lily_parser*) SCM_CELL_WORD_1 (s);
  79   (void) parser;
  80   scm_puts (" >", port);
  81   return 1;
  82 }
  83
  84
  85 /* Process one .ly file, or book.  */
  86 void
  87 Lily_parser::parse_file (String init, String name, String out_name)
  88 {
  89   lexer_ = new Lily_lexer (sources_);
  90   scm_gc_unprotect_object (lexer_->self_scm ());
  91   // TODO: use $parser
  92   lexer_->set_identifier (ly_symbol2scm ("parser"),
  93                           self_scm ());
  94   output_basename_ = out_name;
  95
  96   lexer_->main_input_name_ = name;
  97
  98   progress_indication (_ ("Parsing..."));
  99   progress_indication ("\n");
 100
 101   set_yydebug (0);
 102
 103   lexer_->new_input (init, sources_);
 104
 105   File_name f (name);
 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 ()));
 109
 110   /* Read .ly IN_FILE, lex, parse, write \score blocks from IN_FILE to
 111      OUT_FILE (unless IN_FILE redefines output file name).  */
 112   do_yyparse ();
 113
 114   if (!define_spots_.is_empty ())
 115     {
 116       define_spots_.top ().warning (_ ("Braces don't match"));
 117       error_level_ = 1;
 118     }
 119
 120   error_level_ = error_level_ | lexer_->error_level_;
 121   lexer_ = 0;
 122 }
 123
 124 void
 125 Lily_parser::parse_string (String ly_code)
 126 {
 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 ());
 131
 132
 133   SCM oldmod = scm_current_module ();
 134   scm_set_current_module (scm_car (lexer_->scopes_));
 135
 136   // TODO: use $parser
 137   lexer_->set_identifier (ly_symbol2scm ("parser"),
 138                           self_scm ());
 139
 140   lexer_->main_input_name_ = "<string>";
 141   lexer_->main_input_b_ = true;
 142
 143   set_yydebug (0);
 144   lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
 145   do_yyparse ();
 146
 147   if (!define_spots_.is_empty ())
 148     {
 149       define_spots_.top ().warning (_ ("Braces don't match"));
 150       error_level_ = 1;
 151     }
 152
 153   error_level_ = error_level_ | lexer_->error_level_;
 154
 155   scm_set_current_module (oldmod);
 156   lexer_ = 0;
 157 }
 158
 159 void
 160 Lily_parser::push_spot ()
 161 {
 162   define_spots_.push (here_input ());
 163 }
 164
 165 char const *
 166 Lily_parser::here_str0 () const
 167 {
 168   return lexer_->here_str0 ();
 169 }
 170
 171 void
 172 Lily_parser::parser_error (String s)
 173 {
 174   here_input ().error (s);
 175   error_level_ = 1;
 176 }
 177
 178 Input
 179 Lily_parser::pop_spot ()
 180 {
 181   return define_spots_.pop ();
 182 }
 183
 184 Input
 185 Lily_parser::here_input () const
 186 {
 187   /*
 188     Parsing looks ahead , so we really want the previous location of the
 189     lexer, not lexer_->here_input ().
 190   */
 191
 192   /*
 193     Actually, that gets very icky when there are white space, because
 194     the line-numbers are all wrong.  Let's try the character before
 195     the current token. That gets the right result for note/duration
 196     stuff, but doesn't mess up for errors in the 1st token of the
 197     line.
 198   */
 199   Input hi (lexer_->here_input ());
 200
 201   char const * bla = hi.defined_str0_;
 202   if (hi.line_number () > 1
 203       || hi.column_number () > 1)
 204     bla --;
 205
 206   return Input (hi.source_file_, bla);
 207 }
 208
 209
 210 /****************************************************************/
 211
 212
 213 /*
 214   junkme?
 215  */
 216 bool store_locations_global_b;
 217
 218 /* Do not append `!' suffix, since 1st argument is not modified. */
 219 LY_DEFINE (ly_set_point_and_click, "ly:set-point-and-click",
 220            1, 0, 0, (SCM what),
 221           "Set the options for Point-and-click source specials output. The\n"
 222 "argument is a symbol.  Possible options are @code{none} (no source specials),\n"
 223 "@code{line} and @code{line-column}")
 224 {
 225   /* UGH. */
 226   SCM val = SCM_BOOL_F;
 227   if (ly_symbol2scm ("line-column") == what)
 228     val = ly_scheme_function ("line-column-location");
 229   else if (what == ly_symbol2scm ("line"))
 230     val = ly_scheme_function ("line-location");
 231
 232   scm_module_define (global_lily_module, ly_symbol2scm ("point-and-click"),
 233                      val);
 234   store_locations_global_b = ly_c_procedure_p (val);
 235   return SCM_UNSPECIFIED;
 236 }
 237
 238 LY_DEFINE (ly_parse_file, "ly:parse-file",
 239            1, 0, 0, (SCM name),
 240            "Parse a single @code{.ly} file.  "
 241            "Upon failure, throw @code{ly-file-failed} key.")
 242 {
 243   SCM_ASSERT_TYPE (scm_is_string (name), name, SCM_ARG1, __FUNCTION__, "string");
 244   char const *file = scm_i_string_chars (name);
 245   char const *extensions[] = {"ly", "", 0};
 246
 247   String file_name = global_path.find (file, extensions);
 248
 249   /* By default, use base name of input file for output file name,
 250      write output to cwd; do not use root and directory parts of input
 251      file name.  */
 252   File_name out_file_name (file_name);
 253
 254   global_path.append (out_file_name.dir_);
 255
 256   out_file_name.ext_ = "";
 257   out_file_name.root_ = "";
 258   out_file_name.dir_ = "";
 259
 260   if (!output_name_global.is_empty ())
 261     out_file_name = File_name (output_name_global);
 262
 263   String init;
 264   if (!init_name_global.is_empty ())
 265     init = init_name_global;
 266   else
 267     init = "init.ly";
 268
 269   String out_file = out_file_name.to_string ();
 270
 271   if (init.length () && global_path.find (init).is_empty ())
 272     {
 273       warning (_f ("can't find init file: `%s'", init));
 274       warning (_f ("(search path: `%s')",
 275                    global_path.to_string ().to_str0 ()));
 276       exit (2);
 277     }
 278
 279   if ((file_name != "-") && global_path.find (file_name).is_empty ())
 280     {
 281       warning (_f ("can't find file: `%s'", file_name));
 282       scm_throw (ly_symbol2scm ("ly-file-failed"),
 283                  scm_list_1 (scm_makfrom0str (file_name.to_str0 ())));
 284     }
 285   else
 286     {
 287       Sources sources;
 288       sources.set_path (&global_path);
 289
 290       progress_indication (_f ("Processing `%s'", file_name.to_str0 ()));
 291       progress_indication ("\n");
 292
 293       Lily_parser *parser = new Lily_parser (&sources);
 294
 295       parser->parse_file (init, file_name, out_file);
 296
 297       bool error = parser->error_level_;
 298       scm_gc_unprotect_object (parser->self_scm ());
 299       parser = 0;
 300       if (error)
 301         /* TODO: pass renamed input file too.  */
 302         scm_throw (ly_symbol2scm ("ly-file-failed"),
 303                    scm_list_1 (scm_makfrom0str (file_name.to_str0 ())));
 304     }
 305   return SCM_UNSPECIFIED;
 306 }
 307
 308 LY_DEFINE (ly_parse_string, "ly:parse-string",
 309            1, 0, 0, (SCM ly_code),
 310            "Parse the string LY_CODE.  "
 311            "Upon failure, throw @code{ly-file-failed} key.")
 312 {
 313   SCM_ASSERT_TYPE (scm_is_string (ly_code), ly_code, SCM_ARG1, __FUNCTION__, "string");
 314
 315   Sources sources;
 316   sources.set_path (&global_path);
 317   Lily_parser *parser = new Lily_parser (&sources);
 318   scm_module_define (global_lily_module, ly_symbol2scm ("parser"),
 319                      parser->self_scm ());
 320   parser->parse_string (ly_scm2string (ly_code));
 321   scm_gc_unprotect_object (parser->self_scm ());
 322   parser = 0;
 323
 324   return SCM_UNSPECIFIED;
 325 }
 326
 327 LY_DEFINE (ly_clone_parser, "ly:clone-parser",
 328            1, 0, 0, (SCM parser_smob),
 329            "Return a clone of PARSER_SMOB.")
 330 {
 331   Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
 332   Lily_parser *clone = new Lily_parser (*parser);
 333
 334   /* FIXME: should copy scopes too. */
 335   return scm_gc_unprotect_object (clone->self_scm ());
 336 }
 337
 338 LY_DEFINE (ly_parser_define, "ly:parser-define",
 339            3, 0, 0, (SCM parser_smob, SCM symbol, SCM val),
 340            "Bind SYMBOL to VAL in PARSER_SMOB's module.")
 341 {
 342   Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
 343   SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol, SCM_ARG2, __FUNCTION__, "symbol");
 344   SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG2, __FUNCTION__, "parser");
 345
 346   parser->lexer_->set_identifier (scm_symbol_to_string (symbol), val);
 347   return SCM_UNSPECIFIED;
 348 }
 349
 350 LY_DEFINE (ly_parser_lookup, "ly:parser-lookup",
 351            2, 0, 0, (SCM parser_smob, SCM symbol),
 352            "Lookup @var{symbol} in @var{parser_smob}'s module.  "
 353            "Undefined is '().")
 354 {
 355   Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
 356
 357   SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol, SCM_ARG2, __FUNCTION__, "symbol");
 358   SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG2, __FUNCTION__, "parser");
 359
 360   SCM val= parser->lexer_->lookup_identifier (ly_scm2string (scm_symbol_to_string (symbol)));
 361   if (val != SCM_UNDEFINED)
 362     return val;
 363   else
 364     return SCM_EOL;
 365 }
 366
 367 LY_DEFINE (ly_parser_parse_string, "ly:parser-parse-string",
 368            2, 0, 0, (SCM parser_smob, SCM ly_code),
 369            "Parse the string LY_CODE with PARSER_SMOB."
 370            "Upon failure, throw @code{ly-file-failed} key.")
 371 {
 372   Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
 373
 374   SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "parser");
 375   SCM_ASSERT_TYPE (scm_is_string (ly_code), ly_code, SCM_ARG2, __FUNCTION__, "string");
 376
 377   parser->parse_string (ly_scm2string (ly_code));
 378
 379   return SCM_UNSPECIFIED;
 380 }
 381
 382 Output_def*
 383 get_layout (Lily_parser *parser)
 384 {
 385   SCM id = parser->lexer_->lookup_identifier ("$defaultlayout");
 386   Output_def *layout = unsmob_output_def (id);
 387   layout = layout ? layout->clone () : new Output_def;
 388   layout->set_variable (ly_symbol2scm ("is-layout"), SCM_BOOL_T);
 389
 390   return layout;
 391 }
 392
 393
 394 Output_def*
 395 get_midi (Lily_parser *parser)
 396 {
 397   SCM id = parser->lexer_->lookup_identifier ("$defaultmidi");
 398   Output_def *layout = unsmob_output_def (id);
 399   layout = layout ? layout->clone () : new Output_def;
 400   layout->set_variable (ly_symbol2scm ("is-midi"), SCM_BOOL_T);
 401   return layout;
 402 }
 403
 404
 405 Output_def*
 406 get_paper (Lily_parser *parser)
 407 {
 408   SCM id = parser->lexer_->lookup_identifier ("$defaultpaper");
 409   Output_def *layout = unsmob_output_def (id);
 410
 411   layout = layout ? dynamic_cast<Output_def*> (layout->clone ()) : new Output_def;
 412   layout->set_variable (ly_symbol2scm ("is-paper"), SCM_BOOL_T);
 413   return layout;
 414 }
 415
 416
 417 /* TODO: move this to Scheme?  Why take the parser arg, and all the back
 418    & forth between scm and c++? */
 419 LY_DEFINE (ly_parser_print_score, "ly:parser-print-score",
 420            2, 0, 0,
 421            (SCM parser_smob, SCM score_smob),
 422            "Print score, i.e., the classic way.")
 423 {
 424   Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
 425   Score *score = unsmob_score (score_smob);
 426
 427   Object_key * key = new Lilypond_general_key (0, score->user_key_, 0);
 428
 429   if (score->error_found_)
 430     return SCM_UNSPECIFIED;
 431
 432   SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "parser");
 433   SCM_ASSERT_TYPE (score, score_smob, SCM_ARG2, __FUNCTION__, "score");
 434
 435   SCM header = ly_c_module_p (score->header_) ? score->header_
 436     : parser->lexer_->lookup_identifier ("$globalheader");
 437
 438   File_name outname (parser->output_basename_);
 439   int *c = &parser->book_count_;
 440   if (*c)
 441     outname.base_ += "-" + to_string (*c);
 442   (*c)++;
 443
 444   SCM os = scm_makfrom0str (outname.to_string ().to_str0 ());
 445   SCM paper = get_paper (parser)->self_scm ();
 446   for (int i = 0; i < score->defs_.size (); i++)
 447     default_rendering (score->get_music (), score->defs_[i]->self_scm (),
 448                        paper,
 449                        header, os,
 450                        key->self_scm ());
 451
 452   if (score->defs_.is_empty ())
 453     {
 454       Output_def *layout = get_layout (parser);
 455       default_rendering (score->get_music(), layout->self_scm (),
 456                          get_paper (parser)->self_scm (),
 457                          header, os, key->self_scm ());
 458       scm_gc_unprotect_object (layout->self_scm ());
 459     }
 460
 461   scm_gc_unprotect_object (key->self_scm ());
 462   return SCM_UNSPECIFIED;
 463 }
 464
 465
 466 LY_DEFINE (ly_parser_set_note_names, "ly:parser-set-note-names",
 467            2, 0, 0, (SCM parser, SCM names),
 468            "Replace current note names in @var{parser}. "
 469            "@var{names} is an alist of symbols.  "
 470            "This only has effect if the current mode is notes.")
 471 {
 472   Lily_parser *p = unsmob_my_lily_parser (parser);
 473   SCM_ASSERT_TYPE(p, parser, SCM_ARG1, __FUNCTION__, "Lilypond parser");
 474
 475   if (p->lexer_->is_note_state ())
 476     {
 477       p->lexer_->pop_state ();
 478       p->lexer_->push_note_state (alist_to_hashq (names));
 479     }
 480
 481   return SCM_UNSPECIFIED;
 482 }
 483
 484 LY_DEFINE (ly_parser_print_book, "ly:parser-print-book",
 485            2, 0, 0, (SCM parser_smob, SCM book_smob),
 486            "Print book.")
 487 {
 488   Lily_parser *parser = unsmob_my_lily_parser (parser_smob);
 489   Book *book = unsmob_book (book_smob);
 490   Output_def *bp = unsmob_output_def (parser->lexer_->lookup_identifier ("$defaultpaper"));
 491
 492   SCM_ASSERT_TYPE (parser, parser_smob, SCM_ARG1, __FUNCTION__, "Lilypond parser");
 493   SCM_ASSERT_TYPE (book, book_smob, SCM_ARG2, __FUNCTION__, "Book");
 494
 495   /*  ugh. changing argument.*/
 496   book->paper_ = bp;
 497
 498   File_name outname (parser->output_basename_);
 499   int *c = &parser->book_count_;
 500   if (*c)
 501     outname.base_ += "-" + to_string (*c);
 502   (*c)++;
 503
 504   Output_def *layout = get_layout (parser);
 505   Paper_book* pb = book->process (outname.to_string (), layout);
 506
 507   if (pb)
 508     {
 509       pb->output (outname.to_string ());
 510       scm_gc_unprotect_object (pb->self_scm ());
 511     }
 512
 513   scm_gc_unprotect_object (layout->self_scm ());
 514   return SCM_UNSPECIFIED;
 515 }
 516