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