lily/lily-parser.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Jan Nieuwenhuizen <janneke@gnu.org>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "lily-parser.hh"
  22
  23 #include "book.hh"
  24 #include "file-name.hh"
  25 #include "file-path.hh"
  26 #include "international.hh"
  27 #include "lily-lexer.hh"
  28 #include "lily-version.hh"
  29 #include "ly-module.hh"
  30 #include "main.hh"
  31 #include "output-def.hh"
  32 #include "paper-book.hh"
  33 #include "parser.hh"
  34 #include "score.hh"
  35 #include "source-file.hh"
  36 #include "sources.hh"
  37 #include "warn.hh"
  38 #include "program-option.hh"
  39
  40 #include "ly-smobs.icc"
  41
  42 Lily_parser::Lily_parser (Sources *sources)
  43 {
  44   lexer_ = 0;
  45   sources_ = sources;
  46   default_duration_ = Duration (2, 0);
  47   error_level_ = 0;
  48   closures_ = SCM_EOL;
  49
  50   smobify_self ();
  51
  52   lexer_ = new Lily_lexer (sources_, this);
  53   lexer_->unprotect ();
  54 }
  55
  56 Lily_parser::Lily_parser (Lily_parser const &src, SCM closures)
  57 {
  58   lexer_ = 0;
  59   sources_ = src.sources_;
  60   default_duration_ = src.default_duration_;
  61   error_level_ = 0;
  62   output_basename_ = src.output_basename_;
  63   closures_ = closures;
  64
  65   smobify_self ();
  66   if (src.lexer_)
  67     {
  68       lexer_ = new Lily_lexer (*src.lexer_, this);
  69     }
  70
  71   lexer_->unprotect ();
  72 }
  73
  74 Lily_parser::~Lily_parser ()
  75 {
  76 }
  77
  78 SCM
  79 Lily_parser::mark_smob (SCM s)
  80 {
  81   Lily_parser *parser = (Lily_parser *) SCM_CELL_WORD_1 (s);
  82   scm_gc_mark (parser->closures_);
  83   return (parser->lexer_) ? parser->lexer_->self_scm () : SCM_EOL;
  84 }
  85
  86 int
  87 Lily_parser::print_smob (SCM s, SCM port, scm_print_state *)
  88 {
  89   scm_puts ("#<Lily_parser ", port);
  90   Lily_parser *parser = (Lily_parser *) SCM_CELL_WORD_1 (s);
  91   if (parser->lexer_)
  92     scm_display (parser->lexer_->self_scm (), port);
  93   else
  94     scm_puts ("(no lexer yet)", port);
  95   scm_puts (" >", port);
  96   return 1;
  97 }
  98
  99 /* Process one .ly file, or book.  */
 100 void
 101 Lily_parser::parse_file (string init, string name, string out_name)
 102 {
 103   lexer_->set_identifier (ly_symbol2scm ("parser"), self_scm ());
 104   output_basename_ = out_name;
 105
 106   lexer_->main_input_name_ = name;
 107
 108   message (_ ("Parsing..."));
 109
 110   set_yydebug (0);
 111
 112   lexer_->new_input (init, sources_);
 113
 114   File_name f (name);
 115   string s = global_path.find (f.base_ + ".twy");
 116   s = gulp_file_to_string (s, false, -1);
 117   scm_eval_string (ly_string2scm (s));
 118
 119   /* Read .ly IN_FILE, lex, parse, write \score blocks from IN_FILE to
 120      OUT_FILE (unless IN_FILE redefines output file name).  */
 121
 122   SCM mod = lexer_->set_current_scope ();
 123   do {
 124     do_yyparse ();
 125   } while (!lexer_->is_clean ());
 126
 127   /*
 128     Don't mix cyclic pointers with weak tables.
 129   */
 130   lexer_->set_identifier (ly_symbol2scm ("parser"),
 131                           SCM_EOL);
 132   ly_reexport_module (scm_current_module ());
 133
 134   scm_set_current_module (mod);
 135
 136   error_level_ = error_level_ | lexer_->error_level_;
 137   clear ();
 138 }
 139
 140 void
 141 Lily_parser::parse_string (string ly_code)
 142 {
 143   lexer_->main_input_name_ = "<string>";
 144   lexer_->is_main_input_ = true;
 145   lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
 146
 147   SCM mod = lexer_->set_current_scope ();
 148   SCM parser = lexer_->lookup_identifier_symbol (ly_symbol2scm ("parser"));
 149   lexer_->set_identifier (ly_symbol2scm ("parser"), self_scm ());
 150   do_yyparse ();
 151   lexer_->set_identifier (ly_symbol2scm ("parser"), parser);
 152   scm_set_current_module (mod);
 153
 154   error_level_ = error_level_ | lexer_->error_level_;
 155 }
 156
 157 SCM
 158 Lily_parser::parse_string_expression (string ly_code, string filename,
 159                                       int line)
 160 {
 161   lexer_->main_input_name_ = filename;
 162   lexer_->is_main_input_ = true;
 163   lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
 164   if (line)
 165     {
 166       lexer_->get_source_file ()->set_line (0, line);
 167     }
 168   SCM mod = lexer_->set_current_scope ();
 169   SCM parser = lexer_->lookup_identifier_symbol (ly_symbol2scm ("parser"));
 170   lexer_->set_identifier (ly_symbol2scm ("parser"), self_scm ());
 171   lexer_->push_extra_token (EMBEDDED_LILY);
 172   do_yyparse ();
 173   SCM result = lexer_->lookup_identifier_symbol (ly_symbol2scm ("parseStringResult"));
 174   // parseStringResult is set in the grammar rule for embedded_lilypond
 175
 176   lexer_->set_identifier (ly_symbol2scm ("parser"), parser);
 177   scm_set_current_module (mod);
 178
 179   error_level_ = error_level_ | lexer_->error_level_;
 180   return result;
 181 }
 182
 183 void
 184 Lily_parser::include_string (string ly_code)
 185 {
 186   lexer_->new_input ("<included string>", ly_code, sources_);
 187 }
 188
 189 void
 190 Lily_parser::clear ()
 191 {
 192   if (lexer_)
 193     {
 194       while (lexer_->has_scope ())
 195         lexer_->remove_scope ();
 196     }
 197
 198   lexer_ = 0;
 199 }
 200
 201 char const *
 202 Lily_parser::here_str0 () const
 203 {
 204   return lexer_->here_str0 ();
 205 }
 206
 207 void
 208 Lily_parser::parser_error (string s)
 209 {
 210   lexer_->here_input ().error (_ (s.c_str ()));
 211   error_level_ = 1;
 212 }
 213
 214 void
 215 Lily_parser::parser_error (Input const &i, string s)
 216 {
 217   i.error (s);
 218   error_level_ = 1;
 219 }
 220
 221 IMPLEMENT_SMOBS (Lily_parser);
 222 IMPLEMENT_TYPE_P (Lily_parser, "ly:lily-parser?");
 223 IMPLEMENT_DEFAULT_EQUAL_P (Lily_parser);
 224
 225 /****************************************************************
 226   OUTPUT-DEF
 227  ****************************************************************/
 228
 229 Output_def *
 230 get_layout (Lily_parser *parser)
 231 {
 232   SCM id = parser->lexer_->lookup_identifier ("$defaultlayout");
 233   Output_def *layout = unsmob_output_def (id);
 234   layout = layout ? layout->clone () : new Output_def;
 235   layout->set_variable (ly_symbol2scm ("is-layout"), SCM_BOOL_T);
 236
 237   return layout;
 238 }
 239
 240 Output_def *
 241 get_midi (Lily_parser *parser)
 242 {
 243   SCM id = parser->lexer_->lookup_identifier ("$defaultmidi");
 244   Output_def *layout = unsmob_output_def (id);
 245   layout = layout ? layout->clone () : new Output_def;
 246   layout->set_variable (ly_symbol2scm ("is-midi"), SCM_BOOL_T);
 247   return layout;
 248 }
 249
 250 /* Return a copy of the top of $papers stack, or $defaultpaper if the
 251  * stack is empty */
 252 Output_def *
 253 get_paper (Lily_parser *parser)
 254 {
 255   SCM papers = parser->lexer_->lookup_identifier ("$papers");
 256   Output_def *layout = ((papers == SCM_UNDEFINED) || scm_is_null (papers))
 257                        ? 0 : unsmob_output_def (scm_car (papers));
 258   SCM default_paper = parser->lexer_->lookup_identifier ("$defaultpaper");
 259   layout = layout ? layout : unsmob_output_def (default_paper);
 260
 261   layout = layout ? dynamic_cast<Output_def *> (layout->clone ()) : new Output_def;
 262   layout->set_variable (ly_symbol2scm ("is-paper"), SCM_BOOL_T);
 263   return layout;
 264 }
 265
 266 /* Initialize (reset) the $papers stack */
 267 void
 268 init_papers (Lily_parser *parser)
 269 {
 270   parser->lexer_->set_identifier (ly_symbol2scm ("$papers"), SCM_EOL);
 271 }
 272
 273 /* Push a paper on top of $papers stack */
 274 void
 275 push_paper (Lily_parser *parser, Output_def *paper)
 276 {
 277   parser->lexer_->set_identifier (ly_symbol2scm ("$papers"),
 278                                   scm_cons (paper->self_scm (),
 279                                             parser->lexer_->lookup_identifier ("$papers")));
 280 }
 281
 282 /* Pop a paper from $papers stack */
 283 void
 284 pop_paper (Lily_parser *parser)
 285 {
 286   if (scm_is_pair (parser->lexer_->lookup_identifier ("$papers")))
 287     parser->lexer_->set_identifier (ly_symbol2scm ("$papers"),
 288                                     scm_cdr (parser->lexer_->lookup_identifier ("$papers")));
 289 }
 290
 291 /* Change the paper on top of $papers stack */
 292 void
 293 set_paper (Lily_parser *parser, Output_def *paper)
 294 {
 295   scm_set_car_x (parser->lexer_->lookup_identifier ("$papers"), paper->self_scm ());
 296 }
 297
 298 SCM
 299 get_header (Lily_parser *parser)
 300 {
 301   SCM id = parser->lexer_->lookup_identifier ("$defaultheader");
 302   if (!ly_is_module (id))
 303     id = parser->make_scope ();
 304   else
 305     {
 306       SCM nid = parser->make_scope ();
 307       ly_module_copy (nid, id);
 308       id = nid;
 309     }
 310
 311   return id;
 312 }
 313
 314 SCM
 315 Lily_parser::make_scope () const
 316 {
 317   SCM module = ly_make_module (be_safe_global);
 318   return module;
 319 }