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 ("dump a header field to file 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
174 env_var_info (FILE *out, char const* key)
176 if (char const *value = getenv (key))
177 fprintf (out, "%s=\"%s\"\n", key, value);
184 fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
185 env_var_info (out, "LILYPONDPREFIX");
186 fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
188 fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.to_str0 ());
191 env_var_info (out, "FONTCONFIG_FILE");
192 env_var_info (out, "FONTCONFIG_PATH");
193 env_var_info (out, "GS_FONTPATH");
194 env_var_info (out, "GS_LIB");
195 env_var_info (out, "GUILE_LOAD_PATH");
196 env_var_info (out, "PANGO_RC_FILE");
197 env_var_info (out, "PATH");
204 printf (_f ("Copyright (c) %s by\n%s and others.",
206 AUTHORS).to_str0 ());
213 fputs (gnu_lilypond_version_string ().to_str0 (), out);
221 puts (_f (NOTICE, PROGRAM_NAME).to_str0 ());
226 LY_DEFINE (ly_usage, "ly:usage",
228 "Print usage message.")
230 /* No version number or newline here. It confuses help2man. */
231 printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).to_str0 ());
233 printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
235 printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
237 printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
239 printf (_ ("Options:").to_str0 ());
241 printf (Long_option_init::table_string (options_static).to_str0 ());
243 printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
246 return SCM_UNSPECIFIED;
256 printf (_ (WARRANTY).to_str0 ());
261 sane_putenv (char const* key, String value, bool overwrite = true)
263 if (overwrite || !getenv (key))
265 String combine = String (key) + "=" + value;
266 char *s = strdup (combine.to_str0 ());
273 prepend_env_path (char const *key, String value)
275 if (char const* cur = getenv (key))
276 value += to_string (PATHSEP) + cur;
277 return sane_putenv (key, value.to_str0 ());
281 dir_name (String const file_name)
283 String s = file_name;
284 s.substitute ('\\', '/');
285 s = s.left_string (s.index_last ('/'));
291 # include <winbase.h>
295 setup_paths (char const* argv0)
297 prefix_directory = LILYPOND_DATADIR;
300 String bindir = dir_name (argv0);
301 String argv0_prefix = dir_name (bindir);
302 if (argv0_prefix != dir_name (dir_name (dir_name (prefix_directory))))
305 warning (_f ("argv0 relocation: argv0=%s, prefix=%s", argv0,
308 String datadir = argv0_prefix + "/share";
309 String libdir = argv0_prefix + "/lib";
310 String sysconfdir = argv0_prefix + "/etc";
311 prefix_directory = datadir + "/lilypond/" TOPLEVEL_VERSION;
313 sane_putenv ("FONTCONFIG_FILE", sysconfdir + "/fonts/fonts.conf", false);
315 char font_dir[PATH_MAX];
316 ExpandEnvironmentStrings ("%windir%/fonts", font_dir, sizeof (font_dir));
317 prepend_env_path ("GS_FONTPATH", font_dir);
319 prepend_env_path ("GS_FONTPATH", datadir + "/gs/fonts");
320 prepend_env_path ("GS_LIB", datadir + "/gs/Resource");
321 prepend_env_path ("GS_LIB", datadir + "/gs/lib");
322 prepend_env_path ("GUILE_LOAD_PATH", datadir
323 + to_string ("/guile/%d.%d",
324 SCM_MAJOR_VERSION, SCM_MINOR_VERSION));
325 sane_putenv ("PANGO_RC_FILE", sysconfdir + "/pango/pangorc", false);
326 prepend_env_path ("PATH", bindir);
330 #endif /* ARGV0_RELOCATION */
332 if (char const *env = getenv ("LILYPONDPREFIX"))
335 /* Normalize file name. */
336 env = File_name (env).to_string ().get_copy_str0 ();
338 prefix_directory = env;
341 global_path.append ("");
343 /* Adding mf/out make lilypond unchanged source directory, when setting
344 LILYPONDPREFIX to lilypond-x.y.z */
345 char *suffixes[] = {"ly", "ps", "scm", 0 };
348 for (char **s = suffixes; *s; s++)
350 String path = prefix_directory + to_string ('/') + String (*s);
355 ugh. C&P font-config.cc
358 String builddir = prefix_directory + "/mf/out/";
359 if (stat (builddir.to_str0 (), &statbuf) == 0)
361 dirs.push (builddir.to_str0 ());
365 dirs.push (prefix_directory + "/fonts/otf/");
366 dirs.push (prefix_directory + "/fonts/type1/");
367 dirs.push (prefix_directory + "/fonts/cff/");
368 dirs.push (prefix_directory + "/fonts/svg/");
369 dirs.push (prefix_directory + "/fonts/cff/");
372 for (int i = 0; i < dirs.size (); i++)
373 global_path.prepend (dirs[i]);
377 prepend_load_path (String dir)
379 String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
380 scm_c_eval_string (s.to_str0 ());
383 void init_global_tweak_registry ();
384 void init_fontconfig ();
390 /* Now we chroot, setuid/setgrp and chdir. If something goes wrong,
391 we exit (this is a security-sensitive area). First we split
392 jail_spec into its components, then we retrieve the user/group id
393 (necessarily *before* chroot'ing) and finally we perform the
398 USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
401 Array<String> components = String_convert::split (jail_spec, ',');
402 if (components.size () != JAIL_MAX)
404 error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
405 components.size ()));
413 if (passwd * passwd = getpwnam (components[USER_NAME].to_str0 ()))
414 uid = passwd->pw_uid;
418 error (_f ("no such user: %s", components[USER_NAME]));
420 error (_f ("can't get user id from user name: %s: %s",
421 components[USER_NAME],
430 if (group * group = getgrnam (components[GROUP_NAME].to_str0 ()))
435 error (_f ("no such group: %s", components[GROUP_NAME]));
437 error (_f ("can't get group id from group name: %s: %s",
438 components[GROUP_NAME],
443 if (chroot (components[JAIL].to_str0 ()))
445 error (_f ("can't chroot to: %s: %s", components[JAIL],
452 error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
458 error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
462 if (chdir (components[DIR].to_str0 ()))
464 error (_f ("can't change working directory to: %s: %s", components[DIR],
474 main_with_guile (void *, int, char **)
476 /* Engravers use lily.scm contents, need to make Guile find it.
477 Prepend onto GUILE %load-path, very ugh. */
479 prepend_load_path (prefix_directory);
480 prepend_load_path (prefix_directory + "/scm");
482 if (be_verbose_global)
484 is_TeX_format_global = (output_backend_global == "tex"
485 || output_backend_global == "texstr");
487 is_pango_format_global = !is_TeX_format_global;
490 call_constructors ();
491 init_global_tweak_registry ();
496 all_fonts_global = new All_font_metrics (global_path.to_string ());
499 if (!init_scheme_variables.is_empty ()
500 || !init_scheme_code_string.is_empty ())
502 init_scheme_variables = "(ly:set-option 'command-line-settings (list "
503 + init_scheme_variables + "))";
505 init_scheme_code_string
507 + init_scheme_variables
508 + init_scheme_code_string
511 char const *str0 = init_scheme_code_string.to_str0 ();
513 if (be_verbose_global)
514 progress_indication (_f("Evaluating %s", str0));
515 scm_c_eval_string ((char *) str0);
519 /* We accept multiple independent music files on the command line to
520 reduce compile time when processing lots of small files.
521 Starting the GUILE engine is very time consuming. */
525 while (char const *arg = option_parser->get_next_arg ())
527 *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
528 tail = SCM_CDRLOC (*tail);
530 delete option_parser;
534 if (!jail_spec.is_empty ())
538 SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
546 setup_localisation ()
550 setlocale (LC_ALL, "");
552 /* FIXME: check if this is still true.
553 Disable localisation of float values. This breaks TeX output. */
554 setlocale (LC_NUMERIC, "C");
556 String name (PACKAGE);
558 bindtextdomain (name.to_str0 (), LOCALEDIR);
559 textdomain (name.to_str0 ());
564 add_output_format (String format)
566 if (output_format_global != "")
567 output_format_global += ",";
568 output_format_global += format;
572 parse_argv (int argc, char **argv)
574 bool show_help = false;
575 option_parser = new Getopt_long (argc, argv, options_static);
576 while (Long_option_init const *opt = (*option_parser) ())
578 switch (opt->shortname_char_)
581 if (String (opt->longname_str0_) == "dvi"
582 || String (opt->longname_str0_) == "pdf"
583 || String (opt->longname_str0_) == "png"
584 || String (opt->longname_str0_) == "ps"
585 || String (opt->longname_str0_) == "tex")
586 add_output_format (opt->longname_str0_);
587 else if (String (opt->longname_str0_) == "preview")
589 else if (String (opt->longname_str0_) == "no-pages")
595 String arg (option_parser->optional_argument_str0_);
596 int eq = arg.index ('=');
603 key = arg.left_string (eq);
604 val = arg.right_string (arg.length () - eq - 1);
607 init_scheme_variables
608 += "(cons \'" + key + " " + val + ")\n";
618 String s = option_parser->optional_argument_str0_;
619 File_name file_name (s);
620 output_name_global = file_name.to_string ();
624 jail_spec = option_parser->optional_argument_str0_;
627 init_scheme_code_string += option_parser->optional_argument_str0_;
635 output_backend_global = option_parser->optional_argument_str0_;
639 output_format_global = option_parser->optional_argument_str0_;
643 dump_header_fieldnames_global
644 .push (option_parser->optional_argument_str0_);
647 global_path.append (option_parser->optional_argument_str0_);
650 init_name_global = option_parser->optional_argument_str0_;
656 be_verbose_global = true;
659 be_safe_global = true;
665 programming_error (to_string ("unhandled short option: %c",
666 opt->shortname_char_));
676 if (be_verbose_global)
683 main (int argc, char **argv)
685 setup_localisation ();
686 setup_paths (argv[0]);
687 parse_argv (argc, argv);
688 if (isatty (STDIN_FILENO))
691 scm_boot_guile (argc, argv, main_with_guile, 0);
693 /* Only reachable if GUILE exits. That is an error. */