lily/parse-scm.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "parse-scm.hh"
  21
  22 #include <cstdio>
  23 using namespace std;
  24
  25 #include "lily-parser.hh"
  26 #include "lily-lexer.hh"
  27 #include "international.hh"
  28 #include "main.hh"
  29 #include "paper-book.hh"
  30 #include "source-file.hh"
  31
  32 /* Pass string to scm parser, read one expression.
  33    Return result value and #chars read.
  34
  35    Thanks to Gary Houston <ghouston@freewire.co.uk>  */
  36 SCM
  37 internal_ly_parse_scm (Parse_start *ps)
  38 {
  39   Source_file *sf = ps->start_location_.get_source_file ();
  40   SCM port = sf->get_port ();
  41
  42   long off = ps->start_location_.start () - sf->c_str ();
  43
  44   scm_seek (port, scm_from_long (off), scm_from_long (SEEK_SET));
  45   SCM from = scm_ftell (port);
  46
  47   scm_set_port_line_x (port, scm_from_int (ps->start_location_.line_number () - 1));
  48   scm_set_port_column_x (port, scm_from_int (ps->start_location_.column_number () - 1));
  49
  50   bool multiple = ly_is_equal (scm_peek_char (port), SCM_MAKE_CHAR ('@'));
  51
  52   if (multiple)
  53     (void) scm_read_char (port);
  54
  55   SCM form = scm_read (port);
  56   SCM to = scm_ftell (port);
  57
  58   ps->nchars = scm_to_int (to) - scm_to_int (from);
  59
  60   if (!SCM_EOF_OBJECT_P (form))
  61     {
  62       if (ps->parser_->lexer_->top_input ())
  63         {
  64           // Find any precompiled form.
  65           SCM c = scm_assv_ref (ps->parser_->closures_, from);
  66           if (scm_is_true (c))
  67             // Replace form with a call to previously compiled closure
  68             form = scm_list_1 (c);
  69         }
  70       if (multiple)
  71         form = scm_list_3 (ly_symbol2scm ("apply"),
  72                            ly_symbol2scm ("values"),
  73                            form);
  74       return scm_cons (form, make_input (ps->start_location_));
  75     }
  76
  77   /* Don't close the port here; if we re-enter this function via a
  78      continuation, then the next time we enter it, we'll get an error.
  79      It's a string port anyway, so there's no advantage to closing it
  80      early. */
  81   // scm_close_port (port);
  82
  83   return SCM_UNDEFINED;
  84 }
  85
  86 SCM
  87 internal_ly_eval_scm (Parse_start *ps)
  88 {
  89   if (ps->safe_)
  90     {
  91       static SCM module = SCM_BOOL_F;
  92       if (module == SCM_BOOL_F)
  93         {
  94           SCM function = ly_lily_module_constant ("make-safe-lilypond-module");
  95           module = scm_gc_protect_object (scm_call_0 (function));
  96         }
  97
  98       // We define the parser so trusted Scheme functions can
  99       // access the real namespace underlying the parser.
 100       if (ps->parser_)
 101         scm_module_define (module, ly_symbol2scm ("parser"),
 102                            ps->parser_->self_scm ());
 103       return scm_eval (ps->form_, module);
 104     }
 105   return scm_primitive_eval (ps->form_);
 106 }
 107
 108 SCM
 109 catch_protected_parse_body (void *p)
 110 {
 111   Parse_start *ps = (Parse_start *) p;
 112
 113   return (*ps->func_) (ps);
 114 }
 115
 116 SCM
 117 parse_handler (void *data, SCM tag, SCM args)
 118 {
 119   Parse_start *ps = (Parse_start *) data;
 120
 121   ps->start_location_.error (_ ("GUILE signaled an error for the expression beginning here"));
 122
 123   if (scm_ilength (args) > 2)
 124     scm_display_error_message (scm_cadr (args), scm_caddr (args), scm_current_error_port ());
 125
 126   if (tag == ly_symbol2scm ("read-error"))
 127     ps->nchars = 1;
 128
 129   return SCM_UNDEFINED;
 130 }
 131
 132 SCM
 133 protected_ly_parse_scm (Parse_start *ps)
 134 {
 135   /*
 136     Catch #t : catch all Scheme level errors.
 137    */
 138   return scm_internal_catch (SCM_BOOL_T,
 139                              &catch_protected_parse_body,
 140                              (void *) ps,
 141                              &parse_handler, (void *) ps);
 142 }
 143
 144 bool parse_protect_global = true;
 145 bool parsed_objects_should_be_dead = false;
 146
 147 /* Try parsing.  Upon failure return SCM_UNDEFINED. */
 148
 149 SCM
 150 ly_parse_scm (char const *s, int *n, Input i, bool safe, Lily_parser *parser)
 151 {
 152   Parse_start ps;
 153   ps.str = s;
 154   ps.start_location_ = i;
 155   ps.safe_ = safe;
 156   ps.form_ = SCM_UNDEFINED;
 157   ps.parser_ = parser;
 158   ps.func_ = internal_ly_parse_scm;
 159
 160   SCM ans = parse_protect_global ? protected_ly_parse_scm (&ps)
 161             : internal_ly_parse_scm (&ps);
 162   *n = ps.nchars;
 163
 164   return ans;
 165 }
 166
 167 SCM
 168 ly_eval_scm (SCM form, Input i, bool safe, Lily_parser *parser)
 169 {
 170   Parse_start ps;
 171   ps.str = 0;
 172   ps.start_location_ = i;
 173   ps.safe_ = safe;
 174   ps.form_ = form;
 175   ps.parser_ = parser;
 176   ps.func_ = internal_ly_eval_scm;
 177
 178   SCM ans = parse_protect_global ? protected_ly_parse_scm (&ps)
 179             : internal_ly_eval_scm (&ps);
 180   scm_remember_upto_here_1 (form);
 181   return ans;
 182 }