Fix type predicates/docstrings for two music properties.
[lilypond/mpolesky.git] / lily / lily-parser-scheme.cc
bloba608111dcab2648bd814b3a63b31767b0ee1b0f5
1 /*
2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2010 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/>.
20 #include <unistd.h>
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"
30 #include "main.hh"
31 #include "program-option.hh"
32 #include "sources.hh"
33 #include "warn.hh"
35 LY_DEFINE (ly_parse_file, "ly:parse-file",
36 1, 0, 0, (SCM name),
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
48 file name. */
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) {
55 out_file_name.dir_ = "";
58 /* When running from gui, generate output in .ly source directory. */
59 string output_name = output_name_global;
60 if (!output_name.empty ())
62 /* Interpret --output=DIR to mean --output=DIR/BASE. */
63 string dir;
64 if (is_dir (output_name))
66 dir = output_name;
67 output_name = "";
69 else
71 File_name out (output_name);
72 if (is_dir (out.dir_part ()))
74 dir = out.dir_part ();
75 out_file_name = out.file_part ();
79 if (dir != "" && dir != "." && dir != get_working_directory ())
81 global_path.prepend (get_working_directory ());
82 message (_f ("Changing working directory to: `%s'",
83 dir.c_str ()));
84 chdir (dir.c_str ());
86 else
87 out_file_name = File_name (output_name);
90 string init;
91 if (!init_name_global.empty ())
92 init = init_name_global;
93 else
94 init = "init.ly";
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 ()));
102 exit (2);
106 bool error = false;
107 if ((file_name != "-") && file_name.empty ())
109 warning (_f ("cannot find file: `%s'", file));
110 error = true;
112 else
114 Sources sources;
115 sources.set_path (&global_path);
117 string mapped_fn = map_file_name (file_name);
118 message (_f ("Processing `%s'", mapped_fn.c_str ()));
119 progress_indication ("\n");
121 Lily_parser *parser = new Lily_parser (&sources);
123 parser->parse_file (init, file_name, out_file);
125 error = parser->error_level_;
127 parser->clear ();
128 parser->unprotect ();
132 outside the if-else to ensure cleanup fo Sources object,
134 if (error)
135 /* TODO: pass renamed input file too. */
136 scm_throw (ly_symbol2scm ("ly-file-failed"),
137 scm_list_1 (ly_string2scm (file_name)));
139 return SCM_UNSPECIFIED;
143 LY_DEFINE (ly_parser_lexer, "ly:parser-lexer",
144 1, 0, 0, (SCM parser_smob),
145 "Return the lexer for @var{parser-smob}.")
147 Lily_parser *parser = unsmob_lily_parser (parser_smob);
148 return parser->lexer_->self_scm ();
151 LY_DEFINE (ly_parser_clone, "ly:parser-clone",
152 1, 0, 0, (SCM parser_smob),
153 "Return a clone of @var{parser-smob}.")
155 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
156 Lily_parser *parser = unsmob_lily_parser (parser_smob);
157 Lily_parser *clone = new Lily_parser (*parser);
159 return clone->unprotect ();
162 LY_DEFINE (ly_parser_define_x, "ly:parser-define!",
163 3, 0, 0, (SCM parser_smob, SCM symbol, SCM val),
164 "Bind @var{symbol} to @var{val} in @var{parser-smob}'s module.")
167 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
168 Lily_parser *parser = unsmob_lily_parser (parser_smob);
170 LY_ASSERT_TYPE (ly_is_symbol, symbol, 2);
172 parser->lexer_->set_identifier (scm_symbol_to_string (symbol), val);
173 return SCM_UNSPECIFIED;
176 LY_DEFINE (ly_parser_lookup, "ly:parser-lookup",
177 2, 0, 0, (SCM parser_smob, SCM symbol),
178 "Look up @var{symbol} in @var{parser-smob}'s module."
179 " Return @code{'()} if not defined.")
181 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
183 Lily_parser *parser = unsmob_lily_parser (parser_smob);
185 LY_ASSERT_TYPE (ly_is_symbol, symbol, 2);
187 SCM val = parser->lexer_->lookup_identifier (ly_scm2string (scm_symbol_to_string (symbol)));
188 if (val != SCM_UNDEFINED)
189 return val;
190 else
191 return SCM_EOL;
194 LY_DEFINE (ly_parser_parse_string, "ly:parser-parse-string",
195 2, 0, 0, (SCM parser_smob, SCM ly_code),
196 "Parse the string @var{ly-code} with @var{parser-smob}."
197 " Upon failure, throw @code{ly-file-failed} key.")
199 LY_ASSERT_SMOB (Lily_parser, parser_smob, 1);
200 Lily_parser *parser = unsmob_lily_parser (parser_smob);
201 LY_ASSERT_TYPE (scm_is_string, ly_code, 2);
203 parser->parse_string (ly_scm2string (ly_code));
205 return SCM_UNSPECIFIED;
208 LY_DEFINE (ly_parser_set_note_names, "ly:parser-set-note-names",
209 2, 0, 0, (SCM parser, SCM names),
210 "Replace current note names in @var{parser}."
211 " @var{names} is an alist of symbols. This only has effect"
212 " if the current mode is notes.")
214 LY_ASSERT_SMOB (Lily_parser, parser, 1);
215 Lily_parser *p = unsmob_lily_parser (parser);
217 if (p->lexer_->is_note_state ())
219 p->lexer_->pop_state ();
220 p->lexer_->push_note_state (alist_to_hashq (names));
223 return SCM_UNSPECIFIED;
226 LY_DEFINE (ly_parser_set_repetition_symbol, "ly:parser-set-repetition-symbol",
227 2, 0, 0, (SCM parser, SCM sym),
228 "Replace the current repetition symbol in @var{parser}."
229 " @var{sym} is the new repetition symbol.")
231 LY_ASSERT_SMOB (Lily_parser, parser, 1);
232 Lily_parser *p = unsmob_lily_parser (parser);
234 p->lexer_->chord_repetition_.repetition_symbol_ = sym;
236 return SCM_UNSPECIFIED;
239 LY_DEFINE (ly_parser_set_repetition_function, "ly:parser-set-repetition-function",
240 2, 0, 0, (SCM parser, SCM fun),
241 "Replace the current repetition function in @var{parser}."
242 " @var{fun} is the new repetition function.")
244 LY_ASSERT_SMOB (Lily_parser, parser, 1);
245 Lily_parser *p = unsmob_lily_parser (parser);
247 p->lexer_->chord_repetition_.repetition_function_ = fun;
249 return SCM_UNSPECIFIED;
252 LY_DEFINE (ly_parser_output_name, "ly:parser-output-name",
253 1, 0, 0, (SCM parser),
254 "Return the base name of the output file.")
256 LY_ASSERT_SMOB (Lily_parser, parser, 1);
257 Lily_parser *p = unsmob_lily_parser (parser);
259 return ly_string2scm (p->output_basename_);
262 LY_DEFINE (ly_parser_error, "ly:parser-error",
263 2, 1, 0, (SCM parser, SCM msg, SCM input),
264 "Display an error message and make the parser fail.")
266 LY_ASSERT_SMOB (Lily_parser, parser, 1);
267 Lily_parser *p = unsmob_lily_parser (parser);
269 LY_ASSERT_TYPE (scm_is_string, msg, 2);
270 string s = ly_scm2string (msg);
272 Input *i = unsmob_input (input);
273 if (i)
274 p->parser_error (*i, s);
275 else
276 p->parser_error (s);
278 return parser;
281 LY_DEFINE (ly_parser_clear_error, "ly:parser-clear-error",
282 1, 0, 0, (SCM parser),
283 "Clear the error flag for the parser.")
285 LY_ASSERT_SMOB (Lily_parser, parser, 1);
286 Lily_parser *p = unsmob_lily_parser (parser);
289 p->error_level_ = 0;
290 p->lexer_->error_level_ = 0;
292 return SCM_UNSPECIFIED;
295 LY_DEFINE (ly_parser_has_error_p, "ly:parser-has-error?",
296 1, 0, 0, (SCM parser),
297 "Does @var{parser} have an error flag?")
299 LY_ASSERT_SMOB (Lily_parser, parser, 1);
300 Lily_parser *p = unsmob_lily_parser (parser);
302 return scm_from_bool (p->error_level_ || p->lexer_->error_level_);