2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
22 #include "lily-parser.hh"
24 #include "file-name-map.hh"
25 #include "file-name.hh"
26 #include "file-path.hh"
27 #include "international.hh"
28 #include "lily-lexer.hh"
29 #include "ly-module.hh"
31 #include "program-option.hh"
35 LY_DEFINE (ly_parse_file, "ly:parse-file",
37 "Parse a single @code{.ly} file."
38 " Upon failure, throw @code{ly-file-failed} key.")
40 LY_ASSERT_TYPE (scm_is_string, name, 1);
41 string file = ly_scm2string (name);
42 char const *extensions[] = {"ly", "", 0};
44 string file_name = global_path.find (file, extensions);
46 /* By default, use base name of input file for output file name,
47 write output to cwd; do not use root and directory parts of input
49 File_name out_file_name (file_name);
51 out_file_name.ext_ = "";
52 out_file_name.root_ = "";
53 if (ly_get_option (ly_symbol2scm ("gui")) != SCM_BOOL_T
54 && ly_get_option (ly_symbol2scm ("strip-output-dir")) == SCM_BOOL_T)
56 out_file_name.dir_ = "";
59 /* When running from gui, generate output in .ly source directory. */
60 string output_name = output_name_global;
61 if (!output_name.empty ())
63 /* Interpret --output=DIR to mean --output=DIR/BASE. */
65 if (is_dir (output_name))
72 File_name out (output_name);
73 dir = out.dir_part ();
74 out_file_name = out.file_part ();
77 if (dir != "" && dir != "." && dir != get_working_directory ())
79 global_path.prepend (get_working_directory ());
80 message (_f ("Changing working directory to: `%s'", dir));
81 // If we can't change to the output dir (not existing, wrong
82 // permissions), exit lilypond
83 if (chdir (dir.c_str ()) != 0)
84 error (_f ("unable to change directory to: `%s'", dir));
87 out_file_name = File_name (output_name);
91 if (!init_name_global.empty ())
92 init = init_name_global;
96 string out_file = out_file_name.to_string ();
97 if (init.length () && global_path.find (init).empty ())
99 warning (_f ("cannot find init file: `%s'", init));
100 warning (_f ("(search path: `%s')",
101 global_path.to_string ().c_str ()));
106 if ((file_name != "-") && file_name.empty ())
108 warning (_f ("cannot find file: `%s'", file));
114 sources.set_path (&global_path);
116 string mapped_fn = map_file_name (file_name);
117 basic_progress (_f ("Processing `%s'", mapped_fn.c_str ()));
119 Lily_parser *parser = new Lily_parser (&sources);
121 parser->parse_file (init, file_name, out_file);
123 error = parser->error_level_;
126 parser->unprotect ();
130 outside the if-else to ensure cleanup fo Sources object,
133 /* TODO: pass renamed input file too. */
134 scm_throw (ly_symbol2scm ("ly-file-failed"),
135 scm_list_1 (ly_string2scm (file_name)));
137 return SCM_UNSPECIFIED;
140 LY_DEFINE (ly_parser_lexer, "ly:parser-lexer",
141 1, 0, 0, (SCM parser_smob),
142 "Return the lexer for @var{parser-smob}.")
144 Lily_parser *parser = Lily_parser::unsmob (parser_smob);
145 return parser->lexer_->self_scm ();
148 LY_DEFINE (ly_parser_clone, "ly:parser-clone",
149 1, 2, 0, (SCM parser_smob, SCM closures, SCM location),
150 "Return a clone of @var{parser-smob}. An association list"
151 " of port positions to closures can be specified in @var{closures}"
152 " in order to have @code{$} and @code{#} interpreted in their original"
153 " lexical environment. If @var{location} is a valid location,"
154 " it becomes the source of all music expressions inside.")
156 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
157 Lily_parser *parser = Lily_parser::unsmob (parser_smob);
158 if (SCM_UNBNDP (closures))
161 LY_ASSERT_TYPE (ly_is_list, closures, 2);
162 Lily_parser *clone = new Lily_parser (*parser, closures, location);
164 return clone->unprotect ();
167 LY_DEFINE (ly_parser_define_x, "ly:parser-define!",
168 3, 0, 0, (SCM parser_smob, SCM symbol, SCM val),
169 "Bind @var{symbol} to @var{val} in @var{parser-smob}'s module.")
172 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
173 Lily_parser *parser = Lily_parser::unsmob (parser_smob);
175 LY_ASSERT_TYPE (ly_is_symbol, symbol, 2);
177 parser->lexer_->set_identifier (scm_symbol_to_string (symbol), val);
178 return SCM_UNSPECIFIED;
181 LY_DEFINE (ly_parser_lookup, "ly:parser-lookup",
182 2, 0, 0, (SCM parser_smob, SCM symbol),
183 "Look up @var{symbol} in @var{parser-smob}'s module."
184 " Return @code{'()} if not defined.")
186 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
188 Lily_parser *parser = Lily_parser::unsmob (parser_smob);
190 LY_ASSERT_TYPE (ly_is_symbol, symbol, 2);
192 SCM val = parser->lexer_->lookup_identifier (ly_symbol2string (symbol));
193 if (val != SCM_UNDEFINED)
199 LY_DEFINE (ly_parser_parse_string, "ly:parser-parse-string",
200 2, 0, 0, (SCM parser_smob, SCM ly_code),
201 "Parse the string @var{ly-code} with @var{parser-smob}."
202 " Upon failure, throw @code{ly-file-failed} key.")
204 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
205 Lily_parser *parser = Lily_parser::unsmob (parser_smob);
206 LY_ASSERT_TYPE (scm_is_string, ly_code, 2);
208 if (!parser->lexer_->is_clean ())
209 parser->parser_error (_ ("ly:parser-parse-string is only valid with a new parser."
210 " Use ly:parser-include-string instead."));
212 parser->parse_string (ly_scm2string (ly_code));
214 return SCM_UNSPECIFIED;
217 LY_DEFINE (ly_parse_string_expression, "ly:parse-string-expression",
218 2, 2, 0, (SCM parser_smob, SCM ly_code, SCM filename,
220 "Parse the string @var{ly-code} with @var{parser-smob}."
221 " Return the contained music expression."
222 " @var{filename} and @var{line} are optional source indicators.")
224 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
225 Lily_parser *parser = Lily_parser::unsmob (parser_smob);
226 LY_ASSERT_TYPE (scm_is_string, ly_code, 2);
228 if (SCM_UNBNDP (filename) || !scm_is_string (filename))
231 fn = ly_scm2string (filename);
233 if (SCM_UNBNDP (line) || !scm_is_integer (line))
236 ln = scm_to_int (line);
238 if (!parser->lexer_->is_clean ())
240 parser->parser_error (_ ("ly:parse-string-expression is only valid with a new parser."
241 " Use ly:parser-include-string instead."));
242 return SCM_UNSPECIFIED;
245 return parser->parse_string_expression (ly_scm2string (ly_code),
249 LY_DEFINE (ly_parser_include_string, "ly:parser-include-string",
250 2, 0, 0, (SCM parser_smob, SCM ly_code),
251 "Include the string @var{ly-code} into the input stream"
252 " for @var{parser-smob}. Can only be used in immediate"
253 " Scheme expressions (@code{$} instead of @code{#}).")
255 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
256 Lily_parser *parser = Lily_parser::unsmob (parser_smob);
257 LY_ASSERT_TYPE (scm_is_string, ly_code, 2);
259 parser->include_string (ly_scm2string (ly_code));
261 return SCM_UNSPECIFIED;
264 LY_DEFINE (ly_parser_set_note_names, "ly:parser-set-note-names",
265 2, 0, 0, (SCM parser, SCM names),
266 "Replace current note names in @var{parser}."
267 " @var{names} is an alist of symbols. This only has effect"
268 " if the current mode is notes.")
270 LY_ASSERT_SMOB (Lily_parser, parser, 1);
271 Lily_parser *p = Lily_parser::unsmob (parser);
273 if (p->lexer_->is_note_state ())
275 p->lexer_->pop_state ();
276 p->lexer_->push_note_state (names);
279 return SCM_UNSPECIFIED;
282 LY_DEFINE (ly_parser_output_name, "ly:parser-output-name",
283 1, 0, 0, (SCM parser),
284 "Return the base name of the output file.")
286 LY_ASSERT_SMOB (Lily_parser, parser, 1);
287 Lily_parser *p = Lily_parser::unsmob (parser);
289 return ly_string2scm (p->output_basename_);
292 LY_DEFINE (ly_parser_error, "ly:parser-error",
293 2, 1, 0, (SCM parser, SCM msg, SCM input),
294 "Display an error message and make the parser fail.")
296 LY_ASSERT_SMOB (Lily_parser, parser, 1);
297 Lily_parser *p = Lily_parser::unsmob (parser);
299 LY_ASSERT_TYPE (scm_is_string, msg, 2);
300 string s = ly_scm2string (msg);
302 Input *i = Input::unsmob (input);
304 p->parser_error (*i, s);
311 LY_DEFINE (ly_parser_clear_error, "ly:parser-clear-error",
312 1, 0, 0, (SCM parser),
313 "Clear the error flag for the parser.")
315 LY_ASSERT_SMOB (Lily_parser, parser, 1);
316 Lily_parser *p = Lily_parser::unsmob (parser);
319 p->lexer_->error_level_ = 0;
321 return SCM_UNSPECIFIED;
324 LY_DEFINE (ly_parser_has_error_p, "ly:parser-has-error?",
325 1, 0, 0, (SCM parser),
326 "Does @var{parser} have an error flag?")
328 LY_ASSERT_SMOB (Lily_parser, parser, 1);
329 Lily_parser *p = Lily_parser::unsmob (parser);
331 return scm_from_bool (p->error_level_ || p->lexer_->error_level_);