lily/lily-parser.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 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 "sources.hh"
  36 #include "warn.hh"
  37 #include "program-option.hh"
  38
  39 #include "ly-smobs.icc"
  40
  41 Lily_parser::Lily_parser (Sources *sources)
  42 {
  43   lexer_ = 0;
  44   sources_ = sources;
  45   default_duration_ = Duration (2, 0);
  46   error_level_ = 0;
  47   local_environment_ = SCM_UNDEFINED;
  48
  49   smobify_self ();
  50
  51   lexer_ = new Lily_lexer (sources_, this);
  52   lexer_->unprotect ();
  53 }
  54
  55 Lily_parser::Lily_parser (Lily_parser const &src, SCM env)
  56 {
  57   lexer_ = 0;
  58   sources_ = src.sources_;
  59   default_duration_ = src.default_duration_;
  60   error_level_ = 0;
  61   output_basename_ = src.output_basename_;
  62   local_environment_ = env;
  63
  64   smobify_self ();
  65   if (src.lexer_)
  66     {
  67       lexer_ = new Lily_lexer (*src.lexer_, this);
  68     }
  69
  70   lexer_->unprotect ();
  71 }
  72
  73 Lily_parser::~Lily_parser ()
  74 {
  75 }
  76
  77 SCM
  78 Lily_parser::mark_smob (SCM s)
  79 {
  80   Lily_parser *parser = (Lily_parser *) SCM_CELL_WORD_1 (s);
  81   scm_gc_mark (parser->local_environment_);
  82   return (parser->lexer_) ? parser->lexer_->self_scm () : SCM_EOL;
  83 }
  84
  85 int
  86 Lily_parser::print_smob (SCM s, SCM port, scm_print_state *)
  87 {
  88   scm_puts ("#<Lily_parser ", port);
  89   Lily_parser *parser = (Lily_parser *) SCM_CELL_WORD_1 (s);
  90   if (parser->lexer_)
  91     scm_display (parser->lexer_->self_scm (), port);
  92   else
  93     scm_puts ("(no lexer yet)", port);
  94   scm_puts (" >", port);
  95   return 1;
  96 }
  97
  98 /* Process one .ly file, or book.  */
  99 void
 100 Lily_parser::parse_file (string init, string name, string out_name)
 101 {
 102   // TODO: use $parser
 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_yyparse ();
 124
 125   /*
 126     Don't mix cyclic pointers with weak tables.
 127   */
 128   lexer_->set_identifier (ly_symbol2scm ("parser"),
 129                           SCM_EOL);
 130   ly_reexport_module (scm_current_module ());
 131
 132   scm_set_current_module (mod);
 133
 134   error_level_ = error_level_ | lexer_->error_level_;
 135   clear ();
 136 }
 137
 138 void
 139 Lily_parser::parse_string (string ly_code)
 140 {
 141   // TODO: use $parser
 142   lexer_->set_identifier (ly_symbol2scm ("parser"),
 143                           self_scm ());
 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   do_yyparse ();
 151   scm_set_current_module (mod);
 152
 153   error_level_ = error_level_ | lexer_->error_level_;
 154 }
 155
 156 SCM
 157 Lily_parser::parse_string_expression (string ly_code)
 158 {
 159   // TODO: use $parser
 160   lexer_->set_identifier (ly_symbol2scm ("parser"),
 161                           self_scm ());
 162
 163   lexer_->main_input_name_ = "<string>";
 164   lexer_->is_main_input_ = true;
 165   lexer_->new_input (lexer_->main_input_name_, ly_code, sources_);
 166
 167   SCM mod = lexer_->set_current_scope ();
 168   lexer_->push_extra_token (EMBEDDED_LILY);
 169   do_yyparse ();
 170   SCM result = lexer_->lookup_identifier_symbol (ly_symbol2scm ("parseStringResult"));
 171   // parseStringResult is set in the grammar rule for embedded_lilypond
 172
 173   scm_set_current_module (mod);
 174
 175   error_level_ = error_level_ | lexer_->error_level_;
 176   return result;
 177 }
 178
 179 void
 180 Lily_parser::include_string (string ly_code)
 181 {
 182   lexer_->new_input ("<included string>", ly_code, sources_);
 183 }
 184
 185 void
 186 Lily_parser::clear ()
 187 {
 188   if (lexer_)
 189     {
 190       while (lexer_->has_scope ())
 191         lexer_->remove_scope ();
 192     }
 193
 194   lexer_ = 0;
 195 }
 196
 197 char const *
 198 Lily_parser::here_str0 () const
 199 {
 200   return lexer_->here_str0 ();
 201 }
 202
 203 void
 204 Lily_parser::parser_error (string s)
 205 {
 206   lexer_->here_input ().error (_ (s.c_str ()));
 207   error_level_ = 1;
 208 }
 209
 210 void
 211 Lily_parser::parser_error (Input const &i, string s)
 212 {
 213   i.error (s);
 214   error_level_ = 1;
 215 }
 216
 217 IMPLEMENT_SMOBS (Lily_parser);
 218 IMPLEMENT_TYPE_P (Lily_parser, "ly:lily-parser?");
 219 IMPLEMENT_DEFAULT_EQUAL_P (Lily_parser);
 220
 221 /****************************************************************
 222   OUTPUT-DEF
 223  ****************************************************************/
 224
 225 Output_def *
 226 get_layout (Lily_parser *parser)
 227 {
 228   SCM id = parser->lexer_->lookup_identifier ("$defaultlayout");
 229   Output_def *layout = unsmob_output_def (id);
 230   layout = layout ? layout->clone () : new Output_def;
 231   layout->set_variable (ly_symbol2scm ("is-layout"), SCM_BOOL_T);
 232
 233   return layout;
 234 }
 235
 236 Output_def *
 237 get_midi (Lily_parser *parser)
 238 {
 239   SCM id = parser->lexer_->lookup_identifier ("$defaultmidi");
 240   Output_def *layout = unsmob_output_def (id);
 241   layout = layout ? layout->clone () : new Output_def;
 242   layout->set_variable (ly_symbol2scm ("is-midi"), SCM_BOOL_T);
 243   return layout;
 244 }
 245
 246 /* Return a copy of the top of $papers stack, or $defaultpaper if the
 247  * stack is empty */
 248 Output_def *
 249 get_paper (Lily_parser *parser)
 250 {
 251   SCM papers = parser->lexer_->lookup_identifier ("$papers");
 252   Output_def *layout = ((papers == SCM_UNDEFINED) || scm_is_null (papers))
 253                        ? 0 : unsmob_output_def (scm_car (papers));
 254   SCM default_paper = parser->lexer_->lookup_identifier ("$defaultpaper");
 255   layout = layout ? layout : unsmob_output_def (default_paper);
 256
 257   layout = layout ? dynamic_cast<Output_def *> (layout->clone ()) : new Output_def;
 258   layout->set_variable (ly_symbol2scm ("is-paper"), SCM_BOOL_T);
 259   return layout;
 260 }
 261
 262 /* Initialize (reset) the $papers stack */
 263 void
 264 init_papers (Lily_parser *parser)
 265 {
 266   parser->lexer_->set_identifier (ly_symbol2scm ("$papers"), SCM_EOL);
 267 }
 268
 269 /* Push a paper on top of $papers stack */
 270 void
 271 push_paper (Lily_parser *parser, Output_def *paper)
 272 {
 273   parser->lexer_->set_identifier (ly_symbol2scm ("$papers"),
 274                                   scm_cons (paper->self_scm (),
 275                                             parser->lexer_->lookup_identifier ("$papers")));
 276 }
 277
 278 /* Pop a paper from $papers stack */
 279 void
 280 pop_paper (Lily_parser *parser)
 281 {
 282   if (scm_is_pair (parser->lexer_->lookup_identifier ("$papers")))
 283     parser->lexer_->set_identifier (ly_symbol2scm ("$papers"),
 284                                     scm_cdr (parser->lexer_->lookup_identifier ("$papers")));
 285 }
 286
 287 /* Change the paper on top of $papers stack */
 288 void
 289 set_paper (Lily_parser *parser, Output_def *paper)
 290 {
 291   scm_set_car_x (parser->lexer_->lookup_identifier ("$papers"), paper->self_scm ());
 292 }
 293
 294 SCM
 295 get_header (Lily_parser *parser)
 296 {
 297   SCM id = parser->lexer_->lookup_identifier ("$defaultheader");
 298   if (!ly_is_module (id))
 299     id = parser->make_scope ();
 300   else
 301     {
 302       SCM nid = parser->make_scope ();
 303       ly_module_copy (nid, id);
 304       id = nid;
 305     }
 306
 307   return id;
 308 }
 309
 310 SCM
 311 Lily_parser::make_scope () const
 312 {
 313   SCM module = ly_make_module (be_safe_global);
 314   return module;
 315 }