lily/my-lily-parser.cc

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