2 main.cc -- implement main () entrypoint.
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
18 #include <sys/types.h>
31 #include "all-font-metrics.hh"
32 #include "file-name.hh"
33 #include "freetype.hh"
34 #include "getopt-long.hh"
35 #include "global-ctor.hh"
36 #include "international.hh"
37 #include "lily-guile.hh"
38 #include "lily-version.hh"
40 #include "output-def.hh"
41 #include "program-option.hh"
42 #include "relocate.hh"
43 #include "string-convert.hh"
48 * Global options that can be overridden through command line.
51 /* Names of header fields to be dumped to a separate file. */
52 Array<std::string> dump_header_fieldnames_global;
54 /* Name of initialisation file. */
55 std::string init_name_global;
57 /* Selected output backend
58 One of (gnome, ps [default], eps, scm, svg, tex, texstr)") */
59 std::string output_backend_global = "ps";
60 /* Output formats to generate. */
61 std::string output_format_global = "";
63 bool is_pango_format_global;
64 bool is_TeX_format_global;
66 /* Current output name. */
67 std::string output_name_global;
69 /* Run in safe mode? */
70 bool be_safe_global = false;
72 /* Provide URI links to the original file */
73 bool point_and_click_global = true;
75 /* Verbose progress indication? */
76 bool be_verbose_global = false;
78 /* Scheme code to execute before parsing, after .scm init.
79 This is where -e arguments are appended to. */
80 std::string init_scheme_code_string;
81 std::string init_scheme_variables;
83 /* Generate preview of first system. */
84 bool make_preview = false;
86 /* Generate printed output. */
87 bool make_print = true;
90 bool relocate_binary =
100 * Miscellaneous global stuff.
102 File_path global_path;
108 static char const *AUTHORS
109 = " Han-Wen Nienhuys <hanwen@xs4all.nl>\n"
110 " Jan Nieuwenhuizen <janneke@gnu.org>\n";
112 static char const *PROGRAM_NAME = "lilypond";
113 static char const *PROGRAM_URL = "http://lilypond.org";
115 static char const *NOTICE
116 = _i ("This program is free software. It is covered by the GNU General Public\n"
117 "License and you are welcome to change it and/or distribute copies of it\n"
118 "under certain conditions. Invoke as `%s --warranty' for more\n"
121 static char const *WARRANTY
122 = _i (" This program is free software; you can redistribute it and/or\n"
123 "modify it under the terms of the GNU General Public License version 2\n"
124 "as published by the Free Software Foundation.\n"
126 " This program is distributed in the hope that it will be useful,\n"
127 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
128 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n"
129 "General Public License for more details.\n"
131 " You should have received a copy (refer to the file COPYING) of the\n"
132 "GNU General Public License along with this program; if not, write to\n"
133 "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
134 "Boston, MA 02111-1307, USA.\n");
136 /* Where the init files live. Typically:
137 LILYPOND_DATADIR = /usr/share/lilypond
139 std::string prefix_directory;
141 /* The jail specification: USER,GROUP,JAIL,DIR. */
142 std::string jail_spec;
144 /* The option parser */
145 static Getopt_long *option_parser = 0;
147 /* Internationalisation kludge in two steps:
148 * use _i () to get entry in POT file
149 * call gettext () explicitely for actual "translation" */
151 static Long_option_init options_static[]
153 {_i ("BACK"), "backend", 'b', _i ("use backend BACK (gnome, ps,eps,\nscm, svg, tex, texstr)\ndefault: PS")},
155 {_i ("SYM=VAL"), "define-default", 'd',
156 _i ("set a Scheme program option. Uses #t if VAL is not specified\n"
157 "Try -dhelp for help.")},
159 {_i ("EXPR"), "evaluate", 'e', _i ("evaluate scheme code")},
160 /* Bug in option parser: --output =foe is taken as an abbreviation
161 for --output-format. */
162 {_i ("FORMATs"), "formats", 'f', _i ("dump FORMAT,... Also as separate options:")},
163 {0, "dvi", 0, _i ("generate DVI (tex backend only)")},
164 {0, "relocate", 0, _i ("relocate using directory of lilypond program")},
165 {0, "pdf", 0, _i ("generate PDF (default)")},
166 {0, "png", 0, _i ("generate PNG")},
167 {0, "ps", 0, _i ("generate PostScript")},
168 {0, "tex", 0, _i ("generate TeX (tex backend only)")},
169 {0, "help", 'h', _i ("print this help")},
170 {_i ("FIELD"), "header", 'H', _i ("dump a header field to file BASENAME.FIELD")},
171 {_i ("DIR"), "include", 'I', _i ("add DIR to search path")},
172 {_i ("FILE"), "init", 'i', _i ("use FILE as init file")},
174 {_i ("USER,GROUP,JAIL,DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n"
177 {0, "no-print", 0, _i ("do not generate printed output")},
178 {_i ("FILE"), "output", 'o', _i ("write output to FILE (suffix will be added)")},
179 {0, "preview", 'p', _i ("generate a preview of the first system")},
180 {0, "safe-mode", 's', _i ("disallow unsafe Scheme and PostScript operations")},
181 {0, "version", 'v', _i ("print version number")},
182 {0, "verbose", 'V', _i ("be verbose")},
183 {0, "warranty", 'w', _i ("show warranty and copyright")},
187 const char *LILYPOND_DATADIR = PACKAGE_DATADIR "/" TOPLEVEL_VERSION;
190 env_var_info (FILE *out, char const *key)
192 if (char const *value = getenv (key))
193 fprintf (out, "%s=\"%s\"\n", key, value);
200 fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
201 env_var_info (out, "LILYPONDPREFIX");
202 fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
204 fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.c_str ());
208 env_var_info (out, "FONTCONFIG_FILE");
209 env_var_info (out, "FONTCONFIG_PATH");
210 env_var_info (out, "GS_FONTPATH");
211 env_var_info (out, "GS_LIB");
212 env_var_info (out, "GUILE_LOAD_PATH");
213 env_var_info (out, "PANGO_RC_FILE");
214 env_var_info (out, "PATH");
221 printf (_f ("Copyright (c) %s by\n%s and others.",
230 fputs (gnu_lilypond_version_string ().c_str (), out);
238 puts (_f (NOTICE, PROGRAM_NAME).c_str ());
243 LY_DEFINE (ly_usage, "ly:usage",
245 "Print usage message.")
247 /* No version number or newline here. It confuses help2man. */
248 printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).c_str ());
250 printf (_ ("Typeset music and/or produce MIDI from FILE.").c_str ());
252 printf (_ ("LilyPond produces beautiful music notation.").c_str ());
254 printf (_f ("For more information, see %s", PROGRAM_URL).c_str ());
256 printf (_ ("Options:").c_str ());
258 printf (Long_option_init::table_string (options_static).c_str ());
260 printf (_f ("Report bugs via %s",
261 "http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs"
265 return SCM_UNSPECIFIED;
275 printf (_ (WARRANTY).c_str ());
279 prepend_load_path (std::string dir)
281 std::string s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
282 scm_c_eval_string (s.c_str ());
285 void init_global_tweak_registry ();
286 void init_fontconfig ();
292 /* Now we chroot, setuid/setgrp and chdir. If something goes wrong,
293 we exit (this is a security-sensitive area). First we split
294 jail_spec into its components, then we retrieve the user/group id
295 (necessarily *before* chroot'ing) and finally we perform the
300 USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
303 Array<std::string> components = String_convert::split (jail_spec, ',');
304 if (components.size () != JAIL_MAX)
306 error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
307 components.size ()));
315 if (passwd * passwd = getpwnam (components[USER_NAME].c_str ()))
316 uid = passwd->pw_uid;
320 error (_f ("no such user: %s", components[USER_NAME]));
322 error (_f ("can't get user id from user name: %s: %s",
323 components[USER_NAME],
332 if (group * group = getgrnam (components[GROUP_NAME].c_str ()))
337 error (_f ("no such group: %s", components[GROUP_NAME]));
339 error (_f ("can't get group id from group name: %s: %s",
340 components[GROUP_NAME],
345 if (chroot (components[JAIL].c_str ()))
347 error (_f ("can't chroot to: %s: %s", components[JAIL],
354 error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
360 error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
364 if (chdir (components[DIR].c_str ()))
366 error (_f ("can't change working directory to: %s: %s", components[DIR],
374 main_with_guile (void *, int, char **)
376 /* Engravers use lily.scm contents, need to make Guile find it.
377 Prepend onto GUILE %load-path, very ugh. */
379 prepend_load_path (prefix_directory);
380 prepend_load_path (prefix_directory + "/scm");
382 if (be_verbose_global)
384 is_TeX_format_global = (output_backend_global == "tex"
385 || output_backend_global == "texstr");
387 is_pango_format_global = !is_TeX_format_global;
390 call_constructors ();
391 init_global_tweak_registry ();
396 all_fonts_global = new All_font_metrics (global_path.to_string ());
398 if (!init_scheme_variables.empty ()
399 || !init_scheme_code_string.empty ())
401 init_scheme_variables = "(map (lambda (x) (ly:set-option (car x) (cdr x))) (list "
402 + init_scheme_variables + "))";
404 init_scheme_code_string
406 + init_scheme_variables
407 + init_scheme_code_string
410 char const *str0 = init_scheme_code_string.c_str ();
412 if (be_verbose_global)
413 progress_indication (_f ("Evaluating %s", str0));
414 scm_c_eval_string ((char *) str0);
417 /* We accept multiple independent music files on the command line to
418 reduce compile time when processing lots of small files.
419 Starting the GUILE engine is very time consuming. */
423 while (char const *arg = option_parser->get_next_arg ())
425 *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
426 tail = SCM_CDRLOC (*tail);
428 delete option_parser;
432 if (!jail_spec.empty ())
436 SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
444 setup_localisation ()
448 setlocale (LC_ALL, "");
450 /* FIXME: check if this is still true.
451 Disable localisation of float values. This breaks TeX output. */
452 setlocale (LC_NUMERIC, "C");
454 std::string localedir = LOCALEDIR;
455 if (char const *env = getenv ("LILYPOND_LOCALEDIR"))
458 bindtextdomain ("lilypond", localedir.c_str ());
459 textdomain ("lilypond");
464 add_output_format (std::string format)
466 if (output_format_global != "")
467 output_format_global += ",";
468 output_format_global += format;
472 parse_argv (int argc, char **argv)
474 bool show_help = false;
475 option_parser = new Getopt_long (argc, argv, options_static);
476 while (Long_option_init const *opt = (*option_parser) ())
478 switch (opt->shortname_char_)
481 if (std::string (opt->longname_str0_) == "dvi"
482 || std::string (opt->longname_str0_) == "pdf"
483 || std::string (opt->longname_str0_) == "png"
484 || std::string (opt->longname_str0_) == "ps"
485 || std::string (opt->longname_str0_) == "tex")
486 add_output_format (opt->longname_str0_);
487 else if (std::string (opt->longname_str0_) == "preview")
489 else if (std::string (opt->longname_str0_) == "no-pages")
491 else if (std::string (opt->longname_str0_) == "relocate")
492 relocate_binary = true;
497 std::string arg (option_parser->optional_argument_str0_);
498 ssize eq = arg.find ('=');
500 std::string key = arg;
501 std::string val = "#t";
505 key = arg.substr (0, eq);
506 val = arg.substr (eq + 1);
509 init_scheme_variables
510 += "(cons \'" + key + " " + val + ")\n";
520 std::string s = option_parser->optional_argument_str0_;
521 File_name file_name (s);
522 output_name_global = file_name.to_string ();
526 jail_spec = option_parser->optional_argument_str0_;
529 init_scheme_code_string += option_parser->optional_argument_str0_;
537 output_backend_global = option_parser->optional_argument_str0_;
541 output_format_global = option_parser->optional_argument_str0_;
545 dump_header_fieldnames_global
546 .push (option_parser->optional_argument_str0_);
549 global_path.append (option_parser->optional_argument_str0_);
552 init_name_global = option_parser->optional_argument_str0_;
558 be_verbose_global = true;
561 be_safe_global = true;
562 init_scheme_variables
563 += "(cons \'safe #t)\n";
570 programming_error (to_string ("unhandled short option: %c",
571 opt->shortname_char_));
577 if (output_format_global == "")
578 output_format_global = "pdf";
584 if (be_verbose_global)
593 char *yield = getenv ("LILYPOND_GC_YIELD");
594 bool overwrite = true;
601 sane_putenv ("GUILE_MIN_YIELD_1", yield, overwrite);
602 sane_putenv ("GUILE_MIN_YIELD_2", yield, overwrite);
603 sane_putenv ("GUILE_MIN_YIELD_MALLOC", yield, overwrite);
607 main (int argc, char **argv)
609 if (getenv ("LILYPOND_VERBOSE"))
610 be_verbose_global = true;
612 setup_localisation ();
613 parse_argv (argc, argv);
614 if (isatty (STDIN_FILENO))
617 setup_paths (argv[0]);
619 scm_boot_guile (argc, argv, main_with_guile, 0);
621 /* Only reachable if GUILE exits. That is an error. */