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     {
 125       do_yyparse ();
 126     }
 127   while (!lexer_->is_clean ());
 128
 129   /*
 130     Don't mix cyclic pointers with weak tables.
 131   */
 132   lexer_->set_identifier (ly_symbol2scm ("parser"),
 133                           SCM_EOL);
 134   ly_reexport_module (scm_current_module ());
 135
 136   scm_set_current_module (mod);
 137
 138   error_level_ = error_level_ | lexer_->error_level_;
 139   clear ();
 140 }
 141
 142 void
 143 Lily_parser::parse_string (string ly_code)
 144 {
 145   lexer_->main_input_name_ = "<string>";
 146   lexer_->is_main_input_ = true;
 147   lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
 148
 149   SCM mod = lexer_->set_current_scope ();
 150   SCM parser = lexer_->lookup_identifier_symbol (ly_symbol2scm ("parser"));
 151   lexer_->set_identifier (ly_symbol2scm ("parser"), self_scm ());
 152   do_yyparse ();
 153   lexer_->set_identifier (ly_symbol2scm ("parser"), parser);
 154   scm_set_current_module (mod);
 155
 156   error_level_ = error_level_ | lexer_->error_level_;
 157 }
 158
 159 SCM
 160 Lily_parser::parse_string_expression (string ly_code, string filename,
 161                                       int line)
 162 {
 163   lexer_->main_input_name_ = filename;
 164   lexer_->is_main_input_ = true;
 165   lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
 166   if (line)
 167     {
 168       lexer_->get_source_file ()->set_line (0, line);
 169     }
 170   SCM mod = lexer_->set_current_scope ();
 171   SCM parser = lexer_->lookup_identifier_symbol (ly_symbol2scm ("parser"));
 172   lexer_->set_identifier (ly_symbol2scm ("parser"), self_scm ());
 173   lexer_->push_extra_token (EMBEDDED_LILY);
 174   do_yyparse ();
 175   SCM result = lexer_->lookup_identifier_symbol (ly_symbol2scm ("parseStringResult"));
 176   // parseStringResult is set in the grammar rule for embedded_lilypond
 177
 178   lexer_->set_identifier (ly_symbol2scm ("parser"), parser);
 179   scm_set_current_module (mod);
 180
 181   error_level_ = error_level_ | lexer_->error_level_;
 182   return result;
 183 }
 184
 185 void
 186 Lily_parser::include_string (string ly_code)
 187 {
 188   lexer_->new_input ("<included string>", ly_code, sources_);
 189 }
 190
 191 void
 192 Lily_parser::clear ()
 193 {
 194   if (lexer_)
 195     {
 196       while (lexer_->has_scope ())
 197         lexer_->remove_scope ();
 198     }
 199
 200   lexer_ = 0;
 201 }
 202
 203 char const *
 204 Lily_parser::here_str0 () const
 205 {
 206   return lexer_->here_str0 ();
 207 }
 208
 209 void
 210 Lily_parser::parser_error (string s)
 211 {
 212   lexer_->here_input ().error (_ (s.c_str ()));
 213   error_level_ = 1;
 214 }
 215
 216 void
 217 Lily_parser::parser_error (Input const &i, string s)
 218 {
 219   i.error (s);
 220   error_level_ = 1;
 221 }
 222
 223 IMPLEMENT_SMOBS (Lily_parser);
 224 IMPLEMENT_TYPE_P (Lily_parser, "ly:lily-parser?");
 225 IMPLEMENT_DEFAULT_EQUAL_P (Lily_parser);
 226
 227 /****************************************************************
 228   OUTPUT-DEF
 229  ****************************************************************/
 230
 231 Output_def *
 232 get_layout (Lily_parser *parser)
 233 {
 234   SCM id = parser->lexer_->lookup_identifier ("$defaultlayout");
 235   Output_def *layout = unsmob_output_def (id);
 236   layout = layout ? layout->clone () : new Output_def;
 237   layout->set_variable (ly_symbol2scm ("is-layout"), SCM_BOOL_T);
 238
 239   return layout;
 240 }
 241
 242 Output_def *
 243 get_midi (Lily_parser *parser)
 244 {
 245   SCM id = parser->lexer_->lookup_identifier ("$defaultmidi");
 246   Output_def *layout = unsmob_output_def (id);
 247   layout = layout ? layout->clone () : new Output_def;
 248   layout->set_variable (ly_symbol2scm ("is-midi"), SCM_BOOL_T);
 249   return layout;
 250 }
 251
 252 /* Return a copy of the top of $papers stack, or $defaultpaper if the
 253  * stack is empty */
 254 Output_def *
 255 get_paper (Lily_parser *parser)
 256 {
 257   SCM papers = parser->lexer_->lookup_identifier ("$papers");
 258   Output_def *layout = ((papers == SCM_UNDEFINED) || scm_is_null (papers))
 259                        ? 0 : unsmob_output_def (scm_car (papers));
 260   SCM default_paper = parser->lexer_->lookup_identifier ("$defaultpaper");
 261   layout = layout ? layout : unsmob_output_def (default_paper);
 262
 263   layout = layout ? dynamic_cast<Output_def *> (layout->clone ()) : new Output_def;
 264   layout->set_variable (ly_symbol2scm ("is-paper"), SCM_BOOL_T);
 265   return layout;
 266 }
 267
 268 /* Initialize (reset) the $papers stack */
 269 void
 270 init_papers (Lily_parser *parser)
 271 {
 272   parser->lexer_->set_identifier (ly_symbol2scm ("$papers"), SCM_EOL);
 273 }
 274
 275 /* Push a paper on top of $papers stack */
 276 void
 277 push_paper (Lily_parser *parser, Output_def *paper)
 278 {
 279   parser->lexer_->set_identifier (ly_symbol2scm ("$papers"),
 280                                   scm_cons (paper->self_scm (),
 281                                             parser->lexer_->lookup_identifier ("$papers")));
 282 }
 283
 284 /* Pop a paper from $papers stack */
 285 void
 286 pop_paper (Lily_parser *parser)
 287 {
 288   if (scm_is_pair (parser->lexer_->lookup_identifier ("$papers")))
 289     parser->lexer_->set_identifier (ly_symbol2scm ("$papers"),
 290                                     scm_cdr (parser->lexer_->lookup_identifier ("$papers")));
 291 }
 292
 293 /* Change the paper on top of $papers stack */
 294 void
 295 set_paper (Lily_parser *parser, Output_def *paper)
 296 {
 297   scm_set_car_x (parser->lexer_->lookup_identifier ("$papers"), paper->self_scm ());
 298 }
 299
 300 SCM
 301 get_header (Lily_parser *parser)
 302 {
 303   SCM id = parser->lexer_->lookup_identifier ("$defaultheader");
 304   if (!ly_is_module (id))
 305     id = parser->make_scope ();
 306   else
 307     {
 308       SCM nid = parser->make_scope ();
 309       ly_module_copy (nid, id);
 310       id = nid;
 311     }
 312
 313   return id;
 314 }
 315
 316 SCM
 317 Lily_parser::make_scope () const
 318 {
 319   SCM module = ly_make_module (be_safe_global);
 320   return module;
 321 }