/*
- global-context-scheme.cc -- implement Global_context bindings
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2005--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2005--2007 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 "cpu-timer.hh"
#include "warn.hh"
LY_DEFINE (ly_format_output, "ly:format-output",
- 1, 0, 0, (SCM context),
- "Given a Global context in its final state, "
- "process it and return the @code{Music_output} object in its final state.")
+ 1, 0, 0, (SCM context),
+ "Given a global context in its final state,"
+ " process it and return the @code{Music_output} object"
+ " in its final state.")
{
Global_context *g = dynamic_cast<Global_context *> (unsmob_context (context));
-
- LY_ASSERT_TYPE (unsmob_global_context, context, 1)
+
+ LY_ASSERT_TYPE (unsmob_global_context, context, 1);
SCM output = g->get_output ();
progress_indication ("\n");
if (Music_output *od = unsmob_music_output (output))
od->process ();
-
+
return output;
}
LY_DEFINE (ly_make_global_translator, "ly:make-global-translator",
- 1, 0, 0, (SCM global),
- "Create a translator group and connect it to the global context\n"
- "@var{global}. The translator group is returned.")
+ 1, 0, 0, (SCM global),
+ "Create a translator group and connect it to the global context"
+ " @var{global}. The translator group is returned.")
{
Global_context *g = dynamic_cast<Global_context *> (unsmob_context (global));
- LY_ASSERT_TYPE (unsmob_global_context, global, 1)
+ LY_ASSERT_TYPE (unsmob_global_context, global, 1);
Translator_group *tg = new Translator_group ();
tg->connect_to_context (g);
}
LY_DEFINE (ly_make_global_context, "ly:make-global-context",
- 1, 0, 0, (SCM output_def),
- "Set up a global interpretation context, using the output\n"
- "block @var{output_def}.\n"
- "The context is returned.\n"
- )
+ 1, 0, 0, (SCM output_def),
+ "Set up a global interpretation context, using the output"
+ " block @var{output-def}. The context is returned.")
{
LY_ASSERT_SMOB (Output_def, output_def, 1);
- Output_def *odef = unsmob_output_def (output_def);
+ Output_def *odef = unsmob_output_def (output_def);
Global_context *glob = new Global_context (odef);
}
LY_DEFINE (ly_interpret_music_expression, "ly:interpret-music-expression",
- 2, 0, 0, (SCM mus, SCM ctx),
- "Interpret the music expression @var{mus} in the\n"
- "global context @var{ctx}. The context is returned in its\n"
- "final state.\n")
+ 2, 0, 0, (SCM mus, SCM ctx),
+ "Interpret the music expression @var{mus} in the global context"
+ " @var{ctx}. The context is returned in its final state.")
{
LY_ASSERT_SMOB (Music, mus, 1);
LY_ASSERT_TYPE (unsmob_global_context, ctx, 2);
send_stream_event (g, "Finish", 0, 0);
- if (be_verbose_global)
- message (_f ("elapsed time: %.2f seconds", timer.read ()));
+ debug_output (_f ("elapsed time: %.2f seconds", timer.read ()));
return ctx;
}
LY_DEFINE (ly_run_translator, "ly:run-translator",
- 2, 1, 0, (SCM mus, SCM output_def),
- "Process @var{mus} according to @var{output_def}. \n"
- "An interpretation context is set up,\n"
- "and @var{mus} is interpreted with it. \n"
- "The context is returned in its final state.\n"
- "\n\n"
- "Optionally, this routine takes an Object-key to\n"
- "to uniquely identify the Score block containing it.\n")
+ 2, 1, 0, (SCM mus, SCM output_def),
+ "Process @var{mus} according to @var{output-def}. An"
+ " interpretation context is set up, and @var{mus} is"
+ " interpreted with it. The context is returned in its"
+ " final state.\n"
+ "\n"
+ "Optionally, this routine takes an object-key to"
+ " to uniquely identify the score block containing it.")
{
LY_ASSERT_SMOB (Music, mus, 1);
LY_ASSERT_SMOB (Output_def, output_def, 2);