]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/lily-parser-scheme.cc
Doc-es: various updates.
[lilypond.git] / lily / lily-parser-scheme.cc
index 023237c3cccf793c8cc69595a1d630c5fcff040c..ea84aae41a247f99fb3151a1558337e9f8ae4886 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  lily-parser-scheme.cc -- implement Lily_parser bindings
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include <unistd.h>
 #include "file-path.hh"
 #include "international.hh"
 #include "lily-lexer.hh"
-#include "ly-module.hh"
 #include "main.hh"
 #include "program-option.hh"
 #include "sources.hh"
 #include "warn.hh"
+#include "lily-imports.hh"
 
 LY_DEFINE (ly_parse_file, "ly:parse-file",
-          1, 0, 0, (SCM name),
-          "Parse a single @code{.ly} file."
-          "  Upon failure, throw @code{ly-file-failed} key.")
+           1, 0, 0, (SCM name),
+           "Parse a single @code{.ly} file."
+           "  Upon failure, throw @code{ly-file-failed} key.")
 {
   LY_ASSERT_TYPE (scm_is_string, name, 1);
   string file = ly_scm2string (name);
@@ -39,10 +50,11 @@ LY_DEFINE (ly_parse_file, "ly:parse-file",
 
   out_file_name.ext_ = "";
   out_file_name.root_ = "";
-  if (ly_get_option (ly_symbol2scm ("gui")) != SCM_BOOL_T
-      && ly_get_option (ly_symbol2scm ("strip-output-dir")) == SCM_BOOL_T) {
-    out_file_name.dir_ = "";
-  }
+  if (!to_boolean (ly_get_option (ly_symbol2scm ("gui")))
+      && to_boolean (ly_get_option (ly_symbol2scm ("strip-output-dir"))))
+    {
+      out_file_name.dir_ = "";
+    }
 
   /* When running from gui, generate output in .ly source directory.  */
   string output_name = output_name_global;
@@ -51,29 +63,28 @@ LY_DEFINE (ly_parse_file, "ly:parse-file",
       /* Interpret --output=DIR to mean --output=DIR/BASE.  */
       string dir;
       if (is_dir (output_name))
-       {
-         dir = output_name;
-         output_name = "";
-       }
+        {
+          dir = output_name;
+          output_name = "";
+        }
       else
-       {
-         File_name out (output_name);
-         if (is_dir (out.dir_part ()))
-           {
-             dir = out.dir_part ();
-             out_file_name = out.file_part ();
-           }
-       }
+        {
+          File_name out (output_name);
+          dir = out.dir_part ();
+          out_file_name = out.file_part ();
+        }
 
       if (dir != "" && dir != "." && dir != get_working_directory ())
-       {
-         global_path.prepend (get_working_directory ());
-         message (_f ("Changing working directory to: `%s'",
-                      dir.c_str ()));
-         chdir (dir.c_str ());
-       }
+        {
+          global_path.prepend (get_working_directory ());
+          message (_f ("Changing working directory to: `%s'", dir));
+          // If we can't change to the output dir (not existing, wrong
+          // permissions), exit lilypond
+          if (chdir (dir.c_str ()) != 0)
+            error (_f ("unable to change directory to: `%s'", dir));
+        }
       else
-       out_file_name = File_name (output_name);
+        out_file_name = File_name (output_name);
     }
 
   string init;
@@ -87,11 +98,10 @@ LY_DEFINE (ly_parse_file, "ly:parse-file",
     {
       warning (_f ("cannot find init file: `%s'", init));
       warning (_f ("(search path: `%s')",
-                  global_path.to_string ().c_str ()));
+                   global_path.to_string ().c_str ()));
       exit (2);
     }
 
-
   bool error = false;
   if ((file_name != "-") && file_name.empty ())
     {
@@ -104,8 +114,7 @@ LY_DEFINE (ly_parse_file, "ly:parse-file",
       sources.set_path (&global_path);
 
       string mapped_fn = map_file_name (file_name);
-      message (_f ("Processing `%s'", mapped_fn.c_str ()));
-      progress_indication ("\n");
+      basic_progress (_f ("Processing `%s'", mapped_fn.c_str ()));
 
       Lily_parser *parser = new Lily_parser (&sources);
 
@@ -123,157 +132,205 @@ LY_DEFINE (ly_parse_file, "ly:parse-file",
   if (error)
     /* TODO: pass renamed input file too.  */
     scm_throw (ly_symbol2scm ("ly-file-failed"),
-              scm_list_1 (ly_string2scm (file_name)));
+               scm_list_1 (ly_string2scm (file_name)));
 
   return SCM_UNSPECIFIED;
 }
 
-
 LY_DEFINE (ly_parser_lexer, "ly:parser-lexer",
-          1, 0, 0, (SCM parser_smob),
-          "Return the lexer for @var{parser-smob}.")
+           0, 1, 0, (SCM parser),
+           "Return the lexer for @var{parser}, defaulting to current parser")
 {
-  Lily_parser *parser = unsmob_lily_parser (parser_smob);
-  return parser->lexer_->self_scm ();
+  if (SCM_UNBNDP (parser))
+    parser = scm_fluid_ref (Lily::f_parser);
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 1);
+  return p->lexer_->self_scm ();
 }
 
 LY_DEFINE (ly_parser_clone, "ly:parser-clone",
-          1, 0, 0, (SCM parser_smob),
-          "Return a clone of @var{parser-smob}.")
+           0, 2, 0, (SCM closures, SCM location),
+           "Return a clone of current parser.  An association list"
+           " of port positions to closures can be specified in @var{closures}"
+           " in order to have @code{$} and @code{#} interpreted in their original"
+           " lexical environment.  If @var{location} is a valid location,"
+           " it becomes the source of all music expressions inside.")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
-  Lily_parser *parser = unsmob_lily_parser (parser_smob);
-  Lily_parser *clone = new Lily_parser (*parser);
+  SCM parser = scm_fluid_ref (Lily::f_parser);
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 0);
+
+  if (SCM_UNBNDP (closures))
+    closures = SCM_EOL;
+  else
+    LY_ASSERT_TYPE (ly_is_list, closures, 2);
+  Lily_parser *clone = new Lily_parser (*p, closures, location);
 
   return clone->unprotect ();
 }
 
 LY_DEFINE (ly_parser_define_x, "ly:parser-define!",
-          3, 0, 0, (SCM parser_smob, SCM symbol, SCM val),
-          "Bind @var{symbol} to @var{val} in @var{parser-smob}'s module.")
+           2, 0, 0, (SCM symbol, SCM val),
+           "Bind @var{symbol} to @var{val} in current parser's module.")
 {
+  SCM parser = scm_fluid_ref (Lily::f_parser);
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 0);
 
-  LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
-  Lily_parser *parser = unsmob_lily_parser (parser_smob);
+  LY_ASSERT_TYPE (ly_is_symbol, symbol, 1);
 
-  LY_ASSERT_TYPE (ly_is_symbol, symbol, 2);
-
-  parser->lexer_->set_identifier (scm_symbol_to_string (symbol), val);
+  p->lexer_->set_identifier (scm_symbol_to_string (symbol), val);
   return SCM_UNSPECIFIED;
 }
 
 LY_DEFINE (ly_parser_lookup, "ly:parser-lookup",
-          2, 0, 0, (SCM parser_smob, SCM symbol),
-          "Look up @var{symbol} in @var{parser-smob}'s module."
-          "  Return @code{'()} if not defined.")
+           1, 0, 0, (SCM symbol),
+           "Look up @var{symbol} in current parser's module."
+           "  Return @code{'()} if not defined.")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
-
-  Lily_parser *parser = unsmob_lily_parser (parser_smob);
+  SCM parser = scm_fluid_ref (Lily::f_parser);
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 0);
 
-  LY_ASSERT_TYPE (ly_is_symbol, symbol, 2);
+  LY_ASSERT_TYPE (ly_is_symbol, symbol, 1);
 
-  SCM val = parser->lexer_->lookup_identifier (ly_scm2string (scm_symbol_to_string (symbol)));
-  if (val != SCM_UNDEFINED)
+  SCM val = p->lexer_->lookup_identifier (ly_symbol2string (symbol));
+  if (!SCM_UNBNDP (val))
     return val;
   else
     return SCM_EOL;
 }
 
 LY_DEFINE (ly_parser_parse_string, "ly:parser-parse-string",
-          2, 0, 0, (SCM parser_smob, SCM ly_code),
-          "Parse the string @var{ly-code} with @var{parser-smob}."
-          "  Upon failure, throw @code{ly-file-failed} key.")
+           2, 0, 0, (SCM parser_smob, SCM ly_code),
+           "Parse the string @var{ly-code} with @var{parser-smob}."
+           "  Upon failure, throw @code{ly-file-failed} key.")
 {
   LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
-  Lily_parser *parser = unsmob_lily_parser (parser_smob);
+  Lily_parser *parser = unsmob<Lily_parser> (parser_smob);
   LY_ASSERT_TYPE (scm_is_string, ly_code, 2);
 
-  parser->parse_string (ly_scm2string (ly_code));
+  if (!parser->lexer_->is_clean ())
+    parser->parser_error (_ ("ly:parser-parse-string is only valid with a new parser."
+                             "  Use ly:parser-include-string instead."));
+  else
+    parser->parse_string (ly_scm2string (ly_code));
 
   return SCM_UNSPECIFIED;
 }
 
-LY_DEFINE (ly_parser_set_note_names, "ly:parser-set-note-names",
-          2, 0, 0, (SCM parser, SCM names),
-          "Replace current note names in @var{parser}."
-          "  @var{names} is an alist of symbols.  This only has effect"
-          " if the current mode is notes.")
+LY_DEFINE (ly_parse_string_expression, "ly:parse-string-expression",
+           2, 2, 0, (SCM parser_smob, SCM ly_code, SCM filename,
+                     SCM line),
+           "Parse the string @var{ly-code} with @var{parser-smob}."
+           " Return the contained music expression."
+           " @var{filename} and @var{line} are optional source indicators.")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser, 1);
-  Lily_parser *p = unsmob_lily_parser (parser);
+  LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
+  Lily_parser *parser = unsmob<Lily_parser> (parser_smob);
+  LY_ASSERT_TYPE (scm_is_string, ly_code, 2);
+  string fn;
+  if (SCM_UNBNDP (filename) || !scm_is_string (filename))
+    fn = "<string>";
+  else
+    fn = ly_scm2string (filename);
+  int ln;
+  if (SCM_UNBNDP (line) || !scm_is_integer (line))
+    ln = 0;
+  else
+    ln = scm_to_int (line);
 
-  if (p->lexer_->is_note_state ())
+  if (!parser->lexer_->is_clean ())
     {
-      p->lexer_->pop_state ();
-      p->lexer_->push_note_state (alist_to_hashq (names));
+      parser->parser_error (_ ("ly:parse-string-expression is only valid with a new parser."
+                               "  Use ly:parser-include-string instead."));
+      return SCM_UNSPECIFIED;
     }
 
-  return SCM_UNSPECIFIED;
+  return parser->parse_string_expression (ly_scm2string (ly_code),
+                                          fn, ln);
 }
 
-LY_DEFINE (ly_parser_set_repetition_symbol, "ly:parser-set-repetition-symbol",
-           2, 0, 0, (SCM parser, SCM sym),
-           "Replace the current repetition symbol in @var{parser}."
-           "  @var{sym} is the new repetition symbol.")
+LY_DEFINE (ly_parser_include_string, "ly:parser-include-string",
+           1, 0, 0, (SCM ly_code),
+           "Include the string @var{ly-code} into the input stream"
+           " for current parser.  Can only be used in immediate"
+           " Scheme expressions (@code{$} instead of @code{#}).")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser, 1);
-  Lily_parser *p = unsmob_lily_parser (parser);
+  SCM parser = scm_fluid_ref (Lily::f_parser);
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 0);
 
-  p->lexer_->chord_repetition_.repetition_symbol_ = sym;
+  LY_ASSERT_TYPE (scm_is_string, ly_code, 1);
+
+  p->include_string (ly_scm2string (ly_code));
 
   return SCM_UNSPECIFIED;
 }
 
-LY_DEFINE (ly_parser_set_repetition_function, "ly:parser-set-repetition-function",
-           2, 0, 0, (SCM parser, SCM fun),
-           "Replace the current repetition function in @var{parser}."
-           "  @var{fun} is the new repetition function.")
+LY_DEFINE (ly_parser_set_note_names, "ly:parser-set-note-names",
+           1, 0, 0, (SCM names),
+           "Replace current note names in parser."
+           "  @var{names} is an alist of symbols.  This only has effect"
+           " if the current mode is notes.")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser, 1);
-  Lily_parser *p = unsmob_lily_parser (parser);
+  SCM parser = scm_fluid_ref (Lily::f_parser);
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 0);
 
-  p->lexer_->chord_repetition_.repetition_function_ = fun;
+  if (p->lexer_->is_note_state ())
+    {
+      p->lexer_->pop_state ();
+      p->lexer_->push_note_state (names);
+    }
 
   return SCM_UNSPECIFIED;
 }
 
 LY_DEFINE (ly_parser_output_name, "ly:parser-output-name",
-          1, 0, 0, (SCM parser),
-          "Return the base name of the output file.")
+           0, 1, 0, (SCM parser),
+           "Return the base name of the output file.  If @code{parser} is left off, use currently active parser.")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser, 1);
-  Lily_parser *p = unsmob_lily_parser (parser);
+  if (SCM_UNBNDP (parser))
+    parser = scm_fluid_ref (Lily::f_parser);
+
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 1);
 
   return ly_string2scm (p->output_basename_);
 }
 
 LY_DEFINE (ly_parser_error, "ly:parser-error",
-          2, 1, 0, (SCM parser, SCM msg, SCM input),
-          "Display an error message and make the parser fail.")
+           1, 1, 0, (SCM msg, SCM input),
+           "Display an error message and make current parser fail."
+           " Without a current parser, trigger an ordinary error.")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser, 1);
-  Lily_parser *p = unsmob_lily_parser (parser);
+  SCM parser = scm_fluid_ref (Lily::f_parser);
 
-  LY_ASSERT_TYPE (scm_is_string, msg, 2);
+  Lily_parser *p = unsmob<Lily_parser> (parser);
+
+  LY_ASSERT_TYPE (scm_is_string, msg, 1);
   string s = ly_scm2string (msg);
 
-  Input *i = unsmob_input (input);
-  if (i)
-    p->parser_error (*i, s);
+  Input *i = unsmob<Input> (input);
+  if (p)
+    {
+      if (i)
+        p->parser_error (*i, s);
+      else
+        p->parser_error (s);
+    }
   else
-    p->parser_error (s);
-
-  return parser;
+    {
+      if (i)
+        i->non_fatal_error (s);
+      else
+        scm_misc_error ("ly:parser-error", "~A", scm_list_1 (msg));
+    }
+  return SCM_UNSPECIFIED;
 }
 
 LY_DEFINE (ly_parser_clear_error, "ly:parser-clear-error",
-          1, 0, 0, (SCM parser),
-          "Clear the error flag for the parser.")
+           0, 1, 0, (SCM parser),
+           "Clear error flag for @var{parser}, defaulting to current parser.")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser, 1);
-  Lily_parser *p = unsmob_lily_parser (parser);
+  if (SCM_UNBNDP (parser))
+    parser = scm_fluid_ref (Lily::f_parser);
 
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 1);
 
   p->error_level_ = 0;
   p->lexer_->error_level_ = 0;
@@ -282,11 +339,12 @@ LY_DEFINE (ly_parser_clear_error, "ly:parser-clear-error",
 }
 
 LY_DEFINE (ly_parser_has_error_p, "ly:parser-has-error?",
-          1, 0, 0, (SCM parser),
-          "Does @var{parser} have an error flag?")
+           0, 1, 0, (SCM parser),
+           "Does @var{parser} (defaulting to current parser) have an error flag?")
 {
-  LY_ASSERT_SMOB (Lily_parser, parser, 1);
-  Lily_parser *p = unsmob_lily_parser (parser);
+  if (SCM_UNBNDP (parser))
+    parser = scm_fluid_ref (Lily::f_parser);
+  Lily_parser *p = LY_ASSERT_SMOB (Lily_parser, parser, 1);
 
   return scm_from_bool (p->error_level_ || p->lexer_->error_level_);
 }