2 main.cc -- implement main () entrypoint.
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
18 #include <sys/types.h>
27 #include "all-font-metrics.hh"
28 #include "file-name.hh"
29 #include "freetype.hh"
30 #include "getopt-long.hh"
31 #include "global-ctor.hh"
32 #include "lily-guile.hh"
33 #include "lily-version.hh"
35 #include "output-def.hh"
36 #include "string-convert.hh"
41 * Global options that can be overridden through command line.
44 /* Names of header fields to be dumped to a separate file. */
45 Array<String> dump_header_fieldnames_global;
47 /* Name of initialisation file. */
48 String init_name_global;
50 /* Selected output backend
51 One of (gnome, ps [default], scm, svg, tex, texstr)") */
52 String output_backend_global = "ps";
53 /* Output formats to generate. */
54 String output_format_global = "pdf";
56 bool is_pango_format_global;
57 bool is_TeX_format_global;
59 /* Current output name. */
60 String output_name_global;
62 /* Run in safe mode? */
63 bool be_safe_global = false;
65 /* Provide URI links to the original file */
66 bool point_and_click_global = true;
68 /* Verbose progress indication? */
69 bool be_verbose_global = false;
71 /* Scheme code to execute before parsing, after .scm init.
72 This is where -e arguments are appended to. */
73 String init_scheme_code_string = "(begin #t ";
75 /* Generate preview of first system. */
76 bool make_preview = false;
78 /* Generate printed output. */
79 bool make_print = true;
82 * Miscellaneous global stuff.
84 File_path global_path;
90 static char const *AUTHORS
91 = " Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
92 " Jan Nieuwenhuizen <janneke@gnu.org>\n";
94 static char const *PROGRAM_NAME = "lilypond";
95 static char const *PROGRAM_URL = "http://lilypond.org";
97 static char const *NOTICE
98 = _i ("This program is free software. It is covered by the GNU General Public\n"
99 "License and you are welcome to change it and/or distribute copies of it\n"
100 "under certain conditions. Invoke as `%s --warranty' for more\n"
103 static char const *WARRANTY
104 = _i (" This program is free software; you can redistribute it and/or\n"
105 "modify it under the terms of the GNU General Public License version 2\n"
106 "as published by the Free Software Foundation.\n"
108 " This program is distributed in the hope that it will be useful,\n"
109 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
110 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n"
111 "General Public License for more details.\n"
113 " You should have received a copy (refer to the file COPYING) of the\n"
114 "GNU General Public License along with this program; if not, write to\n"
115 "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
116 "Boston, MA 02111-1307, USA.\n");
118 /* Where the init files live. Typically:
119 LILYPOND_DATADIR = /usr/share/lilypond
121 String prefix_directory;
123 /* The jail specification: USER,GROUP,JAIL,DIR. */
126 /* The option parser */
127 static Getopt_long *option_parser = 0;
129 /* Internationalisation kludge in two steps:
130 * use _i () to get entry in POT file
131 * call gettext () explicitely for actual "translation" */
133 static Long_option_init options_static[]
135 {_i ("BACK"), "backend", 'b', _i ("use backend BACK (gnome, ps [default],\n scm, svg, tex, texstr)")},
137 {_i ("SYM=VAL"), "define-default", 'd',
138 _i ("define a default Scheme setting.")},
140 {_i ("EXPR"), "evaluate", 'e', _i ("set scheme option, for help use\n -e '(ly:option-usage)'")},
141 /* Bug in option parser: --output =foe is taken as an abbreviation
142 for --output-format. */
143 {_i ("FORMATs"), "formats", 'f', _i ("dump FORMAT,... Also as separate options:")},
144 {0, "dvi", 0, _i ("generate DVI (tex backend only)")},
145 {0, "pdf", 0, _i ("generate PDF (default)")},
146 {0, "png", 0, _i ("generate PNG")},
147 {0, "ps", 0, _i ("generate PostScript")},
148 {0, "tex", 0, _i ("generate TeX (tex backend only)")},
149 {0, "help", 'h', _i ("print this help")},
150 {_i ("FIELD"), "header", 'H', _i ("write header field to BASENAME.FIELD")},
151 {_i ("DIR"), "include", 'I', _i ("add DIR to search path")},
152 {_i ("FILE"), "init", 'i', _i ("use FILE as init file")},
153 {_i ("FILE"), "output", 'o', _i ("write output to FILE (suffix will be added)")},
154 {_i ("USER,GROUP,JAIL,DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n and cd into DIR")},
155 {0, "no-print", 0, _i ("do not generate printed output")},
156 {0, "preview", 'p', _i ("generate a preview of the first system")},
157 {0, "safe-mode", 's', _i ("run in safe mode")},
158 {0, "version", 'v', _i ("print version number")},
159 {0, "verbose", 'V', _i ("be verbose")},
160 {0, "warranty", 'w', _i ("show warranty and copyright")},
164 #define LILYPOND_DATADIR PACKAGE_DATADIR "/" TOPLEVEL_VERSION
170 fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
171 if (char const *env = getenv ("LILYPONDPREFIX"))
172 fprintf (out, "LILYPONDPREFIX=\"%s\"\n", env);
173 fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
175 fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.to_str0 ());
181 printf (_f ("Copyright (c) %s by\n%s and others.",
183 AUTHORS).to_str0 ());
190 fputs (gnu_lilypond_version_string ().to_str0 (), out);
198 puts (_f (NOTICE, PROGRAM_NAME).to_str0 ());
206 /* No version number or newline here. It confuses help2man. */
207 printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).to_str0 ());
209 printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
211 printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
213 printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
215 printf (_ ("Options:").to_str0 ());
217 printf (Long_option_init::table_string (options_static).to_str0 ());
219 printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
231 printf (_ (WARRANTY).to_str0 ());
237 prefix_directory = LILYPOND_DATADIR;
238 if (char const *env = getenv ("LILYPONDPREFIX"))
239 prefix_directory = env;
241 global_path.append ("");
243 /* Adding mf/out make lilypond unchanged source directory, when setting
244 LILYPONDPREFIX to lilypond-x.y.z */
245 char *suffixes[] = {"ly", "ps", "scm", 0 };
248 for (char **s = suffixes; *s; s++)
250 String path = prefix_directory + to_string ('/') + String (*s);
255 ugh. C&P font-config.cc
258 String builddir = prefix_directory + "/mf/out/";
259 if (stat (builddir.to_str0 (), &statbuf) == 0)
261 dirs.push (builddir.to_str0 ());
265 dirs.push (prefix_directory + "/fonts/otf/");
266 dirs.push (prefix_directory + "/fonts/type1/");
267 dirs.push (prefix_directory + "/fonts/cff/");
268 dirs.push (prefix_directory + "/fonts/svg/");
269 dirs.push (prefix_directory + "/fonts/cff/");
272 for (int i = 0; i < dirs.size (); i++)
273 global_path.prepend (dirs[i]);
277 prepend_load_path (String dir)
279 String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
280 scm_c_eval_string (s.to_str0 ());
283 void init_global_tweak_registry ();
284 void init_fontconfig ();
289 /* Now we chroot, setuid/setgrp and chdir. If something goes wrong,
290 we exit (this is a security-sensitive area). First we split
291 jail_spec into its components, then we retrieve the user/group id
292 (necessarily *before* chroot'ing) and finally we perform the
297 USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
300 Array<String> components = String_convert::split (jail_spec, ',');
301 if (components.size () != JAIL_MAX)
303 error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
304 components.size ()));
312 if (passwd * passwd = getpwnam (components[USER_NAME].to_str0 ()))
313 uid = passwd->pw_uid;
317 error (_f ("no such user: %s", components[USER_NAME]));
319 error (_f ("can't get user id from user name: %s: %s",
320 components[USER_NAME],
329 if (group * group = getgrnam (components[GROUP_NAME].to_str0 ()))
334 error (_f ("no such group: %s", components[GROUP_NAME]));
336 error (_f ("can't get group id from group name: %s: %s",
337 components[GROUP_NAME],
342 if (chroot (components[JAIL].to_str0 ()))
344 error (_f ("can't chroot to: %s: %s", components[JAIL],
351 error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
357 error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
361 if (chdir (components[DIR].to_str0 ()))
363 error (_f ("can't change working directory to: %s: %s", components[DIR],
372 main_with_guile (void *, int, char **)
374 /* Engravers use lily.scm contents, need to make Guile find it.
375 Prepend onto GUILE %load-path, very ugh. */
377 prepend_load_path (prefix_directory);
378 prepend_load_path (prefix_directory + "/scm");
380 if (be_verbose_global)
382 is_TeX_format_global = (output_backend_global == "tex"
383 || output_backend_global == "texstr");
385 is_pango_format_global = !is_TeX_format_global;
388 call_constructors ();
389 init_global_tweak_registry ();
394 all_fonts_global = new All_font_metrics (global_path.to_string ());
396 init_scheme_code_string += ")";
397 scm_c_eval_string ((char *) init_scheme_code_string.to_str0 ());
399 /* We accept multiple independent music files on the command line to
400 reduce compile time when processing lots of small files.
401 Starting the GUILE engine is very time consuming. */
405 while (char const *arg = option_parser->get_next_arg ())
407 *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
408 tail = SCM_CDRLOC (*tail);
410 delete option_parser;
413 if (files == SCM_EOL)
415 /* No FILE arguments is now a usage error to help newbies. If you
416 want a filter, you're not a newbie and should know to use file
422 if (! jail_spec.is_empty ())
425 SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
433 setup_localisation ()
437 setlocale (LC_ALL, "");
439 /* FIXME: check if this is still true.
440 Disable localisation of float values. This breaks TeX output. */
441 setlocale (LC_NUMERIC, "C");
443 String name (PACKAGE);
445 bindtextdomain (name.to_str0 (), LOCALEDIR);
446 textdomain (name.to_str0 ());
451 add_output_format (String format)
453 if (output_format_global != "")
454 output_format_global += ",";
455 output_format_global += format;
459 parse_argv (int argc, char **argv)
461 bool show_help = false;
462 option_parser = new Getopt_long (argc, argv, options_static);
463 while (Long_option_init const *opt = (*option_parser) ())
465 switch (opt->shortname_char_)
468 if (String (opt->longname_str0_) == "dvi"
469 || String (opt->longname_str0_) == "pdf"
470 || String (opt->longname_str0_) == "png"
471 || String (opt->longname_str0_) == "ps"
472 || String (opt->longname_str0_) == "tex")
473 add_output_format (opt->longname_str0_);
474 else if (String (opt->longname_str0_) == "preview")
476 else if (String (opt->longname_str0_) == "no-pages")
490 String s = option_parser->optional_argument_str0_;
491 File_name file_name (s);
492 output_name_global = file_name.to_string ();
496 jail_spec = option_parser->optional_argument_str0_;
499 init_scheme_code_string += option_parser->optional_argument_str0_;
507 output_backend_global = option_parser->optional_argument_str0_;
511 output_format_global = option_parser->optional_argument_str0_;
515 dump_header_fieldnames_global
516 .push (option_parser->optional_argument_str0_);
519 global_path.append (option_parser->optional_argument_str0_);
522 init_name_global = option_parser->optional_argument_str0_;
528 be_verbose_global = true;
531 be_safe_global = true;
537 programming_error (to_string ("unhandled short option: %c",
538 opt->shortname_char_));
548 if (be_verbose_global)
555 main (int argc, char **argv)
557 setup_localisation ();
559 parse_argv (argc, argv);
562 scm_boot_guile (argc, argv, main_with_guile, 0);