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],\nscm, svg, tex, texstr)")},
142 {_i ("SYM=VAL"), "define-default", 'd',
143 _i ("set a Scheme program option. Uses #t if VAL is not specified\n"
144 "Try -dhelp for help.")},
146 {_i ("EXPR"), "evaluate", 'e', _i ("evaluate scheme code")},
147 /* Bug in option parser: --output =foe is taken as an abbreviation
148 for --output-format. */
149 {_i ("FORMATs"), "formats", 'f', _i ("dump FORMAT,... Also as separate options:")},
150 {0, "dvi", 0, _i ("generate DVI (tex backend only)")},
151 {0, "pdf", 0, _i ("generate PDF (default)")},
152 {0, "png", 0, _i ("generate PNG")},
153 {0, "ps", 0, _i ("generate PostScript")},
154 {0, "tex", 0, _i ("generate TeX (tex backend only)")},
155 {0, "help", 'h', _i ("print this help")},
156 {_i ("FIELD"), "header", 'H', _i ("dump a header field to file BASENAME.FIELD")},
157 {_i ("DIR"), "include", 'I', _i ("add DIR to search path")},
158 {_i ("FILE"), "init", 'i', _i ("use FILE as init file")},
159 {_i ("FILE"), "output", 'o', _i ("write output to FILE (suffix will be added)")},
161 {_i ("USER,GROUP,JAIL,DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n"
164 {0, "no-print", 0, _i ("do not generate printed output")},
165 {0, "preview", 'p', _i ("generate a preview of the first system")},
166 {0, "safe-mode", 's', _i ("run in safe mode")},
167 {0, "version", 'v', _i ("print version number")},
168 {0, "verbose", 'V', _i ("be verbose")},
169 {0, "warranty", 'w', _i ("show warranty and copyright")},
173 #define LILYPOND_DATADIR PACKAGE_DATADIR "/" TOPLEVEL_VERSION
176 env_var_info (FILE *out, char const* key)
178 if (char const *value = getenv (key))
179 fprintf (out, "%s=\"%s\"\n", key, value);
186 fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
187 env_var_info (out, "LILYPONDPREFIX");
188 fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
190 fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.to_str0 ());
193 env_var_info (out, "FONTCONFIG_FILE");
194 env_var_info (out, "FONTCONFIG_PATH");
195 env_var_info (out, "GS_FONTPATH");
196 env_var_info (out, "GS_LIB");
197 env_var_info (out, "GUILE_LOAD_PATH");
198 env_var_info (out, "PANGO_RC_FILE");
199 env_var_info (out, "PATH");
206 printf (_f ("Copyright (c) %s by\n%s and others.",
208 AUTHORS).to_str0 ());
215 fputs (gnu_lilypond_version_string ().to_str0 (), out);
223 puts (_f (NOTICE, PROGRAM_NAME).to_str0 ());
228 LY_DEFINE (ly_usage, "ly:usage",
230 "Print usage message.")
232 /* No version number or newline here. It confuses help2man. */
233 printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).to_str0 ());
235 printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
237 printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
239 printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
241 printf (_ ("Options:").to_str0 ());
243 printf (Long_option_init::table_string (options_static).to_str0 ());
245 printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
248 return SCM_UNSPECIFIED;
258 printf (_ (WARRANTY).to_str0 ());
263 sane_putenv (char const* key, String value, bool overwrite = true)
265 if (overwrite || !getenv (key))
267 String combine = String (key) + "=" + value;
268 char *s = strdup (combine.to_str0 ());
275 set_env_file (char const* key, String value)
278 return sane_putenv (key, value, false);
279 else if (be_verbose_global)
280 warning (_f ("no such file: %s", value));
285 prepend_env_path (char const *key, String value)
289 if (char const* cur = getenv (key))
290 value += to_string (PATHSEP) + cur;
291 return sane_putenv (key, value.to_str0 ());
293 else if (be_verbose_global)
294 warning (_f ("no such directory: %s", value));
299 dir_name (String const file_name)
301 String s = file_name;
302 s.substitute ('\\', '/');
303 s = s.left_string (s.index_last ('/'));
309 # include <winbase.h>
313 setup_paths (char const* argv0)
315 prefix_directory = LILYPOND_DATADIR;
319 if (getenv ("LILYPOND_VERBOSE"))
320 be_verbose_global = true;
322 String bindir = dir_name (argv0);
323 String argv0_prefix = dir_name (bindir);
324 if (argv0_prefix != dir_name (dir_name (dir_name (prefix_directory))))
326 if (be_verbose_global)
327 warning (_f ("argv0 relocation: argv0=%s, prefix=%s", argv0,
329 String datadir = argv0_prefix + "/share";
330 String libdir = argv0_prefix + "/lib";
331 String localedir = datadir + "/locale";
332 String sysconfdir = argv0_prefix + "/etc";
333 String argv0_lilypond_datadir = datadir + "/lilypond/" TOPLEVEL_VERSION;
335 if (is_dir (argv0_lilypond_datadir))
336 prefix_directory = argv0_lilypond_datadir;
339 if (is_dir (localedir))
340 bindtextdomain ("lilypond", localedir.to_str0 ());
343 set_env_file ("FONTCONFIG_FILE", sysconfdir + "/fonts/fonts.conf");
345 char font_dir[PATH_MAX];
346 ExpandEnvironmentStrings ("%windir%/fonts", font_dir, sizeof (font_dir));
347 prepend_env_path ("GS_FONTPATH", font_dir);
350 /* FIXME: *cough* 8.15 *cough* */
351 prepend_env_path ("GS_FONTPATH", datadir + "/ghostscript/8.15/fonts");
352 prepend_env_path ("GS_LIB", datadir + "/ghostscript/8.15/Resource");
353 prepend_env_path ("GS_LIB", datadir + "/ghostscript/8.15/lib");
355 prepend_env_path ("GS_FONTPATH", datadir + "/gs/fonts");
356 prepend_env_path ("GS_LIB", datadir + "/gs/Resource");
357 prepend_env_path ("GS_LIB", datadir + "/gs/lib");
359 prepend_env_path ("GUILE_LOAD_PATH", datadir
360 + to_string ("/guile/%d.%d",
361 SCM_MAJOR_VERSION, SCM_MINOR_VERSION));
362 set_env_file ("PANGO_RC_FILE", sysconfdir + "/pango/pangorc");
363 prepend_env_path ("PATH", bindir);
367 #endif /* ARGV0_RELOCATION */
369 /* FIXME: use LILYPOND_DATADIR. */
370 if (char const *env = getenv ("LILYPONDPREFIX"))
373 /* Normalize file name. */
374 env = File_name (env).to_string ().get_copy_str0 ();
376 prefix_directory = env;
379 global_path.append ("");
381 /* Adding mf/out make lilypond unchanged source directory, when setting
382 LILYPONDPREFIX to lilypond-x.y.z */
383 char *suffixes[] = {"ly", "ps", "scm", 0 };
386 for (char **s = suffixes; *s; s++)
388 String path = prefix_directory + to_string ('/') + String (*s);
393 ugh. C&P font-config.cc
396 String builddir = prefix_directory + "/mf/out/";
397 if (stat (builddir.to_str0 (), &statbuf) == 0)
399 dirs.push (builddir.to_str0 ());
403 dirs.push (prefix_directory + "/fonts/otf/");
404 dirs.push (prefix_directory + "/fonts/type1/");
405 dirs.push (prefix_directory + "/fonts/cff/");
406 dirs.push (prefix_directory + "/fonts/svg/");
407 dirs.push (prefix_directory + "/fonts/cff/");
410 for (int i = 0; i < dirs.size (); i++)
411 global_path.prepend (dirs[i]);
415 prepend_load_path (String dir)
417 String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
418 scm_c_eval_string (s.to_str0 ());
421 void init_global_tweak_registry ();
422 void init_fontconfig ();
428 /* Now we chroot, setuid/setgrp and chdir. If something goes wrong,
429 we exit (this is a security-sensitive area). First we split
430 jail_spec into its components, then we retrieve the user/group id
431 (necessarily *before* chroot'ing) and finally we perform the
436 USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
439 Array<String> components = String_convert::split (jail_spec, ',');
440 if (components.size () != JAIL_MAX)
442 error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
443 components.size ()));
451 if (passwd * passwd = getpwnam (components[USER_NAME].to_str0 ()))
452 uid = passwd->pw_uid;
456 error (_f ("no such user: %s", components[USER_NAME]));
458 error (_f ("can't get user id from user name: %s: %s",
459 components[USER_NAME],
468 if (group * group = getgrnam (components[GROUP_NAME].to_str0 ()))
473 error (_f ("no such group: %s", components[GROUP_NAME]));
475 error (_f ("can't get group id from group name: %s: %s",
476 components[GROUP_NAME],
481 if (chroot (components[JAIL].to_str0 ()))
483 error (_f ("can't chroot to: %s: %s", components[JAIL],
490 error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
496 error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
500 if (chdir (components[DIR].to_str0 ()))
502 error (_f ("can't change working directory to: %s: %s", components[DIR],
512 main_with_guile (void *, int, char **)
514 /* Engravers use lily.scm contents, need to make Guile find it.
515 Prepend onto GUILE %load-path, very ugh. */
517 prepend_load_path (prefix_directory);
518 prepend_load_path (prefix_directory + "/scm");
520 if (be_verbose_global)
522 is_TeX_format_global = (output_backend_global == "tex"
523 || output_backend_global == "texstr");
525 is_pango_format_global = !is_TeX_format_global;
528 call_constructors ();
529 init_global_tweak_registry ();
534 all_fonts_global = new All_font_metrics (global_path.to_string ());
537 if (!init_scheme_variables.is_empty ()
538 || !init_scheme_code_string.is_empty ())
540 init_scheme_variables = "(map (lambda (x) (ly:set-option (car x) (cdr x))) (list "
541 + init_scheme_variables + "))";
543 init_scheme_code_string
545 + init_scheme_variables
546 + init_scheme_code_string
549 char const *str0 = init_scheme_code_string.to_str0 ();
551 if (be_verbose_global)
552 progress_indication (_f("Evaluating %s", str0));
553 scm_c_eval_string ((char *) str0);
557 /* We accept multiple independent music files on the command line to
558 reduce compile time when processing lots of small files.
559 Starting the GUILE engine is very time consuming. */
563 while (char const *arg = option_parser->get_next_arg ())
565 *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
566 tail = SCM_CDRLOC (*tail);
568 delete option_parser;
572 if (!jail_spec.is_empty ())
576 SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
584 setup_localisation ()
588 setlocale (LC_ALL, "");
590 /* FIXME: check if this is still true.
591 Disable localisation of float values. This breaks TeX output. */
592 setlocale (LC_NUMERIC, "C");
594 String localedir = LOCALEDIR;
595 if (char const *env = getenv ("LILYPOND_LOCALEDIR"))
598 bindtextdomain ("lilypond", localedir.to_str0 ());
599 textdomain ("lilypond");
604 add_output_format (String format)
606 if (output_format_global != "")
607 output_format_global += ",";
608 output_format_global += format;
612 parse_argv (int argc, char **argv)
614 bool show_help = false;
615 option_parser = new Getopt_long (argc, argv, options_static);
616 while (Long_option_init const *opt = (*option_parser) ())
618 switch (opt->shortname_char_)
621 if (String (opt->longname_str0_) == "dvi"
622 || String (opt->longname_str0_) == "pdf"
623 || String (opt->longname_str0_) == "png"
624 || String (opt->longname_str0_) == "ps"
625 || String (opt->longname_str0_) == "tex")
626 add_output_format (opt->longname_str0_);
627 else if (String (opt->longname_str0_) == "preview")
629 else if (String (opt->longname_str0_) == "no-pages")
635 String arg (option_parser->optional_argument_str0_);
636 int eq = arg.index ('=');
643 key = arg.left_string (eq);
644 val = arg.right_string (arg.length () - eq - 1);
647 init_scheme_variables
648 += "(cons \'" + key + " " + val + ")\n";
658 String s = option_parser->optional_argument_str0_;
659 File_name file_name (s);
660 output_name_global = file_name.to_string ();
664 jail_spec = option_parser->optional_argument_str0_;
667 init_scheme_code_string += option_parser->optional_argument_str0_;
675 output_backend_global = option_parser->optional_argument_str0_;
679 output_format_global = option_parser->optional_argument_str0_;
683 dump_header_fieldnames_global
684 .push (option_parser->optional_argument_str0_);
687 global_path.append (option_parser->optional_argument_str0_);
690 init_name_global = option_parser->optional_argument_str0_;
696 be_verbose_global = true;
699 be_safe_global = true;
705 programming_error (to_string ("unhandled short option: %c",
706 opt->shortname_char_));
716 if (be_verbose_global)
723 main (int argc, char **argv)
725 setup_localisation ();
726 setup_paths (argv[0]);
727 parse_argv (argc, argv);
728 if (isatty (STDIN_FILENO))
731 scm_boot_guile (argc, argv, main_with_guile, 0);
733 /* Only reachable if GUILE exits. That is an error. */