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>
16 #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 "lily-guile.hh"
37 #include "lily-version.hh"
39 #include "output-def.hh"
40 #include "string-convert.hh"
45 * Global options that can be overridden through command line.
48 /* Names of header fields to be dumped to a separate file. */
49 Array<String> dump_header_fieldnames_global;
51 /* Name of initialisation file. */
52 String init_name_global;
54 /* Selected output backend
55 One of (gnome, ps [default], scm, svg, tex, texstr)") */
56 String output_backend_global = "ps";
57 /* Output formats to generate. */
58 String output_format_global = "pdf";
60 bool is_pango_format_global;
61 bool is_TeX_format_global;
63 /* Current output name. */
64 String output_name_global;
66 /* Run in safe mode? */
67 bool be_safe_global = false;
69 /* Provide URI links to the original file */
70 bool point_and_click_global = true;
72 /* Verbose progress indication? */
73 bool be_verbose_global = false;
75 /* Scheme code to execute before parsing, after .scm init.
76 This is where -e arguments are appended to. */
77 String init_scheme_code_string;
78 String init_scheme_variables;
80 /* Generate preview of first system. */
81 bool make_preview = false;
83 /* Generate printed output. */
84 bool make_print = true;
87 * Miscellaneous global stuff.
89 File_path global_path;
95 static char const *AUTHORS
96 = " Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
97 " Jan Nieuwenhuizen <janneke@gnu.org>\n";
99 static char const *PROGRAM_NAME = "lilypond";
100 static char const *PROGRAM_URL = "http://lilypond.org";
102 static char const *NOTICE
103 = _i ("This program is free software. It is covered by the GNU General Public\n"
104 "License and you are welcome to change it and/or distribute copies of it\n"
105 "under certain conditions. Invoke as `%s --warranty' for more\n"
108 static char const *WARRANTY
109 = _i (" This program is free software; you can redistribute it and/or\n"
110 "modify it under the terms of the GNU General Public License version 2\n"
111 "as published by the Free Software Foundation.\n"
113 " This program is distributed in the hope that it will be useful,\n"
114 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
115 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n"
116 "General Public License for more details.\n"
118 " You should have received a copy (refer to the file COPYING) of the\n"
119 "GNU General Public License along with this program; if not, write to\n"
120 "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
121 "Boston, MA 02111-1307, USA.\n");
123 /* Where the init files live. Typically:
124 LILYPOND_DATADIR = /usr/share/lilypond
126 String prefix_directory;
128 /* The jail specification: USER,GROUP,JAIL,DIR. */
131 /* The option parser */
132 static Getopt_long *option_parser = 0;
134 /* Internationalisation kludge in two steps:
135 * use _i () to get entry in POT file
136 * call gettext () explicitely for actual "translation" */
138 static Long_option_init options_static[]
140 {_i ("BACK"), "backend", 'b', _i ("use backend BACK (gnome, ps [default],\n scm, svg, tex, texstr)")},
142 {_i ("SYM=VAL"), "define-default", 'd',
143 _i ("define a default Scheme setting.")},
145 {_i ("EXPR"), "evaluate", 'e', _i ("set scheme option, for help use\n -e '(ly:option-usage)'")},
146 /* Bug in option parser: --output =foe is taken as an abbreviation
147 for --output-format. */
148 {_i ("FORMATs"), "formats", 'f', _i ("dump FORMAT,... Also as separate options:")},
149 {0, "dvi", 0, _i ("generate DVI (tex backend only)")},
150 {0, "pdf", 0, _i ("generate PDF (default)")},
151 {0, "png", 0, _i ("generate PNG")},
152 {0, "ps", 0, _i ("generate PostScript")},
153 {0, "tex", 0, _i ("generate TeX (tex backend only)")},
154 {0, "help", 'h', _i ("print this help")},
155 {_i ("FIELD"), "header", 'H', _i ("write header field to BASENAME.FIELD")},
156 {_i ("DIR"), "include", 'I', _i ("add DIR to search path")},
157 {_i ("FILE"), "init", 'i', _i ("use FILE as init file")},
158 {_i ("FILE"), "output", 'o', _i ("write output to FILE (suffix will be added)")},
160 {_i ("USER,GROUP,JAIL,DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n and cd into DIR")},
162 {0, "no-print", 0, _i ("do not generate printed output")},
163 {0, "preview", 'p', _i ("generate a preview of the first system")},
164 {0, "safe-mode", 's', _i ("run in safe mode")},
165 {0, "version", 'v', _i ("print version number")},
166 {0, "verbose", 'V', _i ("be verbose")},
167 {0, "warranty", 'w', _i ("show warranty and copyright")},
171 #define LILYPOND_DATADIR PACKAGE_DATADIR "/" TOPLEVEL_VERSION
177 fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
178 if (char const *env = getenv ("LILYPONDPREFIX"))
179 fprintf (out, "LILYPONDPREFIX=\"%s\"\n", env);
180 fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
182 fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.to_str0 ());
188 printf (_f ("Copyright (c) %s by\n%s and others.",
190 AUTHORS).to_str0 ());
197 fputs (gnu_lilypond_version_string ().to_str0 (), out);
205 puts (_f (NOTICE, PROGRAM_NAME).to_str0 ());
213 /* No version number or newline here. It confuses help2man. */
214 printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).to_str0 ());
216 printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
218 printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
220 printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
222 printf (_ ("Options:").to_str0 ());
224 printf (Long_option_init::table_string (options_static).to_str0 ());
226 printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
238 printf (_ (WARRANTY).to_str0 ());
244 prefix_directory = LILYPOND_DATADIR;
245 if (char const *env = getenv ("LILYPONDPREFIX"))
246 prefix_directory = env;
248 global_path.append ("");
250 /* Adding mf/out make lilypond unchanged source directory, when setting
251 LILYPONDPREFIX to lilypond-x.y.z */
252 char *suffixes[] = {"ly", "ps", "scm", 0 };
255 for (char **s = suffixes; *s; s++)
257 String path = prefix_directory + to_string ('/') + String (*s);
262 ugh. C&P font-config.cc
265 String builddir = prefix_directory + "/mf/out/";
266 if (stat (builddir.to_str0 (), &statbuf) == 0)
268 dirs.push (builddir.to_str0 ());
272 dirs.push (prefix_directory + "/fonts/otf/");
273 dirs.push (prefix_directory + "/fonts/type1/");
274 dirs.push (prefix_directory + "/fonts/cff/");
275 dirs.push (prefix_directory + "/fonts/svg/");
276 dirs.push (prefix_directory + "/fonts/cff/");
279 for (int i = 0; i < dirs.size (); i++)
280 global_path.prepend (dirs[i]);
284 prepend_load_path (String dir)
286 String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
287 scm_c_eval_string (s.to_str0 ());
290 void init_global_tweak_registry ();
291 void init_fontconfig ();
297 /* Now we chroot, setuid/setgrp and chdir. If something goes wrong,
298 we exit (this is a security-sensitive area). First we split
299 jail_spec into its components, then we retrieve the user/group id
300 (necessarily *before* chroot'ing) and finally we perform the
305 USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
308 Array<String> components = String_convert::split (jail_spec, ',');
309 if (components.size () != JAIL_MAX)
311 error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
312 components.size ()));
320 if (passwd * passwd = getpwnam (components[USER_NAME].to_str0 ()))
321 uid = passwd->pw_uid;
325 error (_f ("no such user: %s", components[USER_NAME]));
327 error (_f ("can't get user id from user name: %s: %s",
328 components[USER_NAME],
337 if (group * group = getgrnam (components[GROUP_NAME].to_str0 ()))
342 error (_f ("no such group: %s", components[GROUP_NAME]));
344 error (_f ("can't get group id from group name: %s: %s",
345 components[GROUP_NAME],
350 if (chroot (components[JAIL].to_str0 ()))
352 error (_f ("can't chroot to: %s: %s", components[JAIL],
359 error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
365 error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
369 if (chdir (components[DIR].to_str0 ()))
371 error (_f ("can't change working directory to: %s: %s", components[DIR],
381 main_with_guile (void *, int, char **)
383 /* Engravers use lily.scm contents, need to make Guile find it.
384 Prepend onto GUILE %load-path, very ugh. */
386 prepend_load_path (prefix_directory);
387 prepend_load_path (prefix_directory + "/scm");
389 if (be_verbose_global)
391 is_TeX_format_global = (output_backend_global == "tex"
392 || output_backend_global == "texstr");
394 is_pango_format_global = !is_TeX_format_global;
397 call_constructors ();
398 init_global_tweak_registry ();
403 all_fonts_global = new All_font_metrics (global_path.to_string ());
406 if (!init_scheme_variables.is_empty ()
407 || !init_scheme_code_string.is_empty ())
409 init_scheme_variables = "(ly:set-option 'command-line-settings (list "
410 + init_scheme_variables + "))";
412 init_scheme_code_string
414 + init_scheme_variables
415 + init_scheme_code_string
418 char const *str0 = init_scheme_code_string.to_str0 ();
420 if (be_verbose_global)
422 progress_indication (_f("Evaluating %s", str0));
424 scm_c_eval_string ((char *) str0);
428 /* We accept multiple independent music files on the command line to
429 reduce compile time when processing lots of small files.
430 Starting the GUILE engine is very time consuming. */
434 while (char const *arg = option_parser->get_next_arg ())
436 *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
437 tail = SCM_CDRLOC (*tail);
439 delete option_parser;
442 if (files == SCM_EOL)
444 /* No FILE arguments is now a usage error to help newbies. If you
445 want a filter, you're not a newbie and should know to use file
452 if (! jail_spec.is_empty ())
456 SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
464 setup_localisation ()
468 setlocale (LC_ALL, "");
470 /* FIXME: check if this is still true.
471 Disable localisation of float values. This breaks TeX output. */
472 setlocale (LC_NUMERIC, "C");
474 String name (PACKAGE);
476 bindtextdomain (name.to_str0 (), LOCALEDIR);
477 textdomain (name.to_str0 ());
482 add_output_format (String format)
484 if (output_format_global != "")
485 output_format_global += ",";
486 output_format_global += format;
490 parse_argv (int argc, char **argv)
492 bool show_help = false;
493 option_parser = new Getopt_long (argc, argv, options_static);
494 while (Long_option_init const *opt = (*option_parser) ())
496 switch (opt->shortname_char_)
499 if (String (opt->longname_str0_) == "dvi"
500 || String (opt->longname_str0_) == "pdf"
501 || String (opt->longname_str0_) == "png"
502 || String (opt->longname_str0_) == "ps"
503 || String (opt->longname_str0_) == "tex")
504 add_output_format (opt->longname_str0_);
505 else if (String (opt->longname_str0_) == "preview")
507 else if (String (opt->longname_str0_) == "no-pages")
513 String arg (option_parser->optional_argument_str0_);
514 int eq = arg.index ('=');
521 key = arg.left_string (eq);
522 val = arg.right_string (arg.length () - eq - 1);
525 init_scheme_variables
526 += "(cons \'" + key + " " + val + ")\n";
536 String s = option_parser->optional_argument_str0_;
537 File_name file_name (s);
538 output_name_global = file_name.to_string ();
542 jail_spec = option_parser->optional_argument_str0_;
545 init_scheme_code_string += option_parser->optional_argument_str0_;
553 output_backend_global = option_parser->optional_argument_str0_;
557 output_format_global = option_parser->optional_argument_str0_;
561 dump_header_fieldnames_global
562 .push (option_parser->optional_argument_str0_);
565 global_path.append (option_parser->optional_argument_str0_);
568 init_name_global = option_parser->optional_argument_str0_;
574 be_verbose_global = true;
577 be_safe_global = true;
583 programming_error (to_string ("unhandled short option: %c",
584 opt->shortname_char_));
594 if (be_verbose_global)
601 main (int argc, char **argv)
603 setup_localisation ();
605 parse_argv (argc, argv);
608 scm_boot_guile (argc, argv, main_with_guile, 0);