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