2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "lily-guile.hh"
31 #include <sys/types.h>
44 #include "all-font-metrics.hh"
45 #include "file-name.hh"
46 #include "freetype.hh"
47 #include "getopt-long.hh"
48 #include "global-ctor.hh"
49 #include "international.hh"
50 #include "lily-version.hh"
52 #include "output-def.hh"
53 #include "program-option.hh"
54 #include "relocate.hh"
55 #include "string-convert.hh"
60 * Global options that can be overridden through command line.
63 /* Names of header fields to be dumped to a separate file. */
64 //vector<string> dump_header_fieldnames_global; // moved to global-data.cc
66 /* Name of initialisation file. */
67 //string init_name_global; // moved to global-data.cc
69 /* Output formats to generate. */
70 //string output_format_global = ""; // moved to global-data.cc
72 /* Current output name. */
73 //string output_name_global; // moved to global-data.cc
75 /* Run in safe mode? */
76 //bool be_safe_global = false; // moved to global-data.cc
78 /* Provide URI links to the original file */
79 bool point_and_click_global = true;
81 /* Scheme code to execute before parsing, after .scm init.
82 This is where -e arguments are appended to. */
83 //string init_scheme_code_global; // moved to global-data.cc
84 //string init_scheme_variables_global; // moved to global-data.cc
86 //bool relocate_binary = true; // moved to global-data.cc
89 * Miscellaneous global stuff.
91 //File_path global_path; // moved to global-data.cc
97 static char const *AUTHORS
98 = " Han-Wen Nienhuys <hanwen@xs4all.nl>\n"
99 " Jan Nieuwenhuizen <janneke@gnu.org>\n";
101 static char const *PROGRAM_NAME = "lilypond";
102 static char const *PROGRAM_URL = "http://lilypond.org";
104 static char const *NOTICE
105 = _i ("This program is free software. It is covered by the GNU General Public\n"
106 "License and you are welcome to change it and/or distribute copies of it\n"
107 "under certain conditions. Invoke as `%s --warranty' for more\n"
110 static char const *WARRANTY
111 = _i (" This program is free software; you can redistribute it and/or\n"
112 "modify it under the terms of the GNU General Public License as \n"
113 "published by the Free Software Foundation, either version 3 of\n"
114 "the License, or (at your option) any later version.\n"
116 " This program is distributed in the hope that it will be useful,\n"
117 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
118 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n"
119 "General Public License for more details.\n"
121 " You should have received a copy of the\n"
122 "GNU General Public License along with this program; if not, write to\n"
123 "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
124 "Boston, MA 02111-1307, USA.\n");
126 /* Where the init files live. Typically:
127 LILYPOND_DATADIR = /usr/share/lilypond
129 //string lilypond_datadir; // moved to global-data.cc
131 /* The jail specification: USER, GROUP, JAIL, DIR. */
134 /* The option parser */
135 static Getopt_long *option_parser = 0;
137 /* Internationalisation kludge in two steps:
138 * use _i () to get entry in POT file
139 * call gettext () explicitly for actual "translation" */
142 Data to be used to display when
143 -h command line option is detected.
145 static Long_option_init options_static[]
149 _i ("SYM[=VAL]"), "define-default", 'd',
150 _i ("set Scheme option SYM to VAL (default: #t).\n"
151 "Use -dhelp for help.")
154 {_i ("EXPR"), "evaluate", 'e', _i ("evaluate scheme code")},
155 /* Bug in option parser: --output =foe is taken as an abbreviation
156 for --output-format. */
157 {_i ("FORMATs"), "formats", 'f', _i ("dump FORMAT,... Also as separate options:")},
158 {0, "pdf", 0, _i ("generate PDF (default)")},
159 {0, "png", 0, _i ("generate PNG")},
160 {0, "ps", 0, _i ("generate PostScript")},
161 {0, "help", 'h', _i ("show this help and exit")},
163 _i ("FIELD"), "header", 'H', _i ("dump header field FIELD to file\n"
164 "named BASENAME.FIELD")
166 {_i ("DIR"), "include", 'I', _i ("add DIR to search path")},
167 {_i ("FILE"), "init", 'i', _i ("use FILE as init file")},
170 _i ("USER, GROUP, JAIL, DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n"
175 _i ("LOGLEVEL"), "loglevel", 'l', _i ("print log messages according to"
176 " LOGLEVEL. Possible values are:\n"
177 "NONE, ERROR, WARNING, BASIC, PROGRESS, INFO (default) and DEBUG.")
179 {_i ("FILE"), "output", 'o', _i ("write output to FILE (suffix will be added)")},
180 {0, "relocate", 0, _i ("relocate using directory of lilypond program")},
181 {0, "silent", 's', _i ("no progress, only error messages (equivalent to loglevel=ERROR)")},
182 {0, "version", 'v', _i ("show version number and exit")},
183 {0, "verbose", 'V', _i ("be verbose (equivalent to loglevel=DEBUG)")},
184 {0, "warranty", 'w', _i ("show warranty and copyright")},
188 char const *LILYPOND_DATADIR = PACKAGE_DATADIR "/" TOPLEVEL_VERSION;
190 /* x86 defaults to using 80-bit extended precision arithmetic. This can cause
191 problems because the truncation from 80 bits to 64 bits can occur in
192 unpredictable places. To get around this, we tell the x87 FPU to use only
193 double precision. Note that this is not needed for x86_64 because that uses
194 the SSE unit by default instead of the x87 FPU. */
195 #if ((defined (__x86__) || defined (__i386__)) \
196 && defined (HAVE_FPU_CONTROL_H) && (HAVE_FPU_CONTROL_H == 1))
198 #include <fpu_control.h>
202 fpu_control_t fpu_control = 0x027f;
203 _FPU_SETCW (fpu_control);
213 #endif /* defined(__x86__) || defined(__i386__) */
216 env_var_info (FILE *out, char const *key)
218 * Retrieve value of an OS environment variable.
220 * key, the name of an environment variable.
223 if (char const *value = getenv (key))
224 fprintf (out, "%s=\"%s\"\n", key, value);
230 * Print out information re directories being used by LilyPond
235 fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
236 env_var_info (out, "LILYPONDPREFIX");
237 env_var_info (out, "LILYPOND_DATADIR");
238 fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
240 fprintf (out, "\nEffective prefix: \"%s\"\n", lilypond_datadir.c_str ());
244 env_var_info (out, "FONTCONFIG_FILE");
245 env_var_info (out, "FONTCONFIG_PATH");
246 env_var_info (out, "GS_FONTPATH");
247 env_var_info (out, "GS_LIB");
248 env_var_info (out, "GUILE_LOAD_PATH");
249 env_var_info (out, "PANGO_RC_FILE");
250 env_var_info (out, "PANGO_PREFIX");
251 env_var_info (out, "PATH");
258 * Print out LilyPond copyright info.
261 /* Do not update the copyright years here, run `make grand-replace' */
262 printf ("%s", (_f ("Copyright (c) %s by\n%s and others.", "1996--2014",
270 * Print out LilyPond version string.
273 fputs (gnu_lilypond_version_string ().c_str (), out);
279 * Print copyright and program name
287 puts (_f (NOTICE, PROGRAM_NAME).c_str ());
290 LY_DEFINE (ly_usage, "ly:usage",
292 "Print usage message.")
294 * ly_usage: Routine to output standard information when LilyPond is run without a
295 * source file to compile.
296 * Also callable as ly:usage from Scheme.
299 /* No version number or newline here. It confuses help2man. */
300 printf ("%s", (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).c_str ()));
302 printf ("%s", (_ ("Typeset music and/or produce MIDI from FILE.").c_str ()));
304 printf ("%s", (_ ("LilyPond produces beautiful music notation.").c_str ()));
306 printf ("%s", (_f ("For more information, see %s", PROGRAM_URL).c_str ()));
308 printf ("%s", (_ ("Options:").c_str ()));
310 printf ("%s", Long_option_init::table_string (options_static).c_str ());
312 /* Translators, please translate this string as
313 "Report bugs in English via %s",
314 or if there is a LilyPond users list or forum in your language
315 "Report bugs in English via %s or in YOUR_LANG via URI" */
316 printf ("%s", (_f ("Report bugs via %s",
317 "http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs"
321 return SCM_UNSPECIFIED;
327 * Prints out LilyPond warranty information
334 printf ("%s", (_ (WARRANTY).c_str ()));
338 prepend_scheme_list (const string &dir, const string &scmlist)
340 * Inserts an item at the front of a Scheme list, e.g. %load-path
342 * dir: The directory to add to the front of the list
343 * scmlist: The Scheme list onto which to prepend the directory
346 SCM var = scm_c_lookup (scmlist.c_str());
347 scm_variable_set_x (var, scm_cons (scm_from_locale_string (dir.c_str()),
348 scm_variable_ref (var)));
350 "(set! " + scmlist + " (cons \"" + dir + "\" " + scmlist +"))";
351 scm_c_eval_string (setcmd.c_str());*/
354 void init_global_tweak_registry ();
355 void init_fontconfig ();
361 /* Now we chroot, setuid/setgrp and chdir. If something goes wrong,
362 we exit (this is a security-sensitive area). First we split
363 jail_spec into its components, then we retrieve the user/group id
364 (necessarily *before* chroot'ing) and finally we perform the
369 USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
372 vector<string> components = string_split (jail_spec, ',');
373 if (components.size () != JAIL_MAX)
375 error (_f ("expected %d arguments with jail, found: %u", JAIL_MAX,
376 (unsigned) components.size ()));
384 if (passwd *passwd = getpwnam (components[USER_NAME].c_str ()))
385 uid = passwd->pw_uid;
389 error (_f ("no such user: %s", components[USER_NAME]));
391 error (_f ("cannot get user id from user name: %s: %s",
392 components[USER_NAME],
401 if (group *group = getgrnam (components[GROUP_NAME].c_str ()))
406 error (_f ("no such group: %s", components[GROUP_NAME]));
408 error (_f ("cannot get group id from group name: %s: %s",
409 components[GROUP_NAME],
414 if (chroot (components[JAIL].c_str ()))
416 error (_f ("cannot chroot to: %s: %s", components[JAIL],
423 error (_f ("cannot change group id to: %d: %s", gid, strerror (errno)));
429 error (_f ("cannot change user id to: %d: %s", uid, strerror (errno)));
433 if (chdir (components[DIR].c_str ()))
435 error (_f ("cannot change working directory to: %s: %s", components[DIR],
443 main_with_guile (void *, int, char **)
445 * main-with-guile is invoked as a callback via scm_boot_guile from
447 * scm_boot_guile will have passed its data, argc and argv parameters
448 * to main_with_guile.
451 /* Engravers use lily.scm contents, so we need to make Guile find it.
452 Prepend onto GUILE %load-path.
453 %load-path is the symbol Guile searches for .scm files
454 %load-compiled-path is the symbol Guile V2 searches for .go files
456 string scm_pct_load_path = "%load-path";
457 string scm_pct_load_compiled_path = "%load-compiled-path";
459 prepend_scheme_list (lilypond_datadir, scm_pct_load_path );
460 prepend_scheme_list (lilypond_datadir + "/scm", scm_pct_load_path);
464 Just as ughy - prepend "/scm/out" onto GUILE V2+Â %load-compiled-path
465 and set %compile-fallback-path to our scm/out directory
468 %load-compiled-path is the symbol Guile V2 searches for .go files
470 prepend_scheme_list (lilypond_datadir + "/scm/out",
471 scm_pct_load_compiled_path);
473 %compile-fallback-path is the guile cache root for auto-compiled files
476 string scm_pct_fallback_path = "%compile-fallback-path";
477 string ly_scm_go_dir = lilypond_datadir + "/scm/out";
478 //string scm_pct_set_fallback = "(set! " + scm_pct_fallback_path +
479 // " \"" + lilypond_datadir + "/scm/out\")";
480 //scm_c_eval_string (scm_pct_set_fallback.c_str() );
482 (scm_list_3 (scm_from_locale_symbol ("set!"),
483 scm_from_locale_symbol ("%compile-fallback-path"),
484 scm_from_locale_string (ly_scm_go_dir.c_str())));
487 if (is_loglevel (LOG_DEBUG))
490 init_scheme_variables_global = "(list " + init_scheme_variables_global + ")";
491 init_scheme_code_global = "(begin " + init_scheme_code_global + ")";
494 call_constructors ();
498 ly_reset_all_fonts ();
501 We accept multiple independent music files on the command line to
502 reduce compile time when processing lots of small files.
503 This way we don't have to start the Guile/Scheme interpreter more than once, as
504 starting the GUILE engine is very time consuming.
509 while (char const *arg = option_parser->get_next_arg ())
511 *tail = scm_cons (scm_from_locale_string (arg), SCM_EOL);
512 tail = SCM_CDRLOC (*tail);
515 delete option_parser;
519 if (!jail_spec.empty ())
523 Now execute the Scheme entry-point declared in
524 lily.scm (lilypond-main)
526 // These commands moved to lily_guile_v2.scm
527 // SCM rep_mod = scm_c_resolve_module ("system repl repl");
528 // scm_c_use_module ("system repl repl");
529 // SCM err_handling_mod = scm_c_resolve_module ("system repl error-handling");
530 // SCM call_with_error_handling = scm_c_module_lookup (err_handling_mod, "call-with-error-handling");
531 // SCM result = scm_call_1 (
532 // scm_variable_ref (call_with_error_handling),
533 // scm_call_1 (ly_lily_module_constant ("lilypond-main"), files));
534 SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
542 setup_localisation ()
544 * Set up local language text locale (if available from configure)
546 * HAVE_GETTEXT: Internationalization available for a local language.
551 setlocale (LC_ALL, "");
553 /* FIXME: check if this is still true.
554 Disable localisation of float values. */
555 setlocale (LC_NUMERIC, "C");
558 // In order not to have this porting aid backfire to GUILE1 usage,
559 // this is only compiled in the GUILEV2 version. It should
560 // eventually be replaced with proper multibyte communication with
561 // GUILE2, but in the mean time it seems that this is the least
562 // invasive path to get comparable results between the
563 // not-really-multibyte-supporting GUILE1 and GUILE2
565 /* Disable character sets */
566 setlocale (LC_CTYPE, "C");
567 /* But our text domain is in UTF-8 */
568 bind_textdomain_codeset ("lilypond", "UTF-8");
571 string localedir = LOCALEDIR;
572 if (char const *env = getenv ("LILYPOND_LOCALEDIR"))
575 bindtextdomain ("lilypond", localedir.c_str ());
576 textdomain ("lilypond");
581 add_output_format (const string &format)
583 * Capture information internally from command-line options
588 if (output_format_global != "")
589 output_format_global += ",";
590 output_format_global += format;
594 parse_argv (int argc, char **argv)
596 * Parse command-line options
597 * also, if -h (help), -v (version) or -w (warranty) is detected,
598 * output the usage information and exit.
601 bool show_help = false;
602 option_parser = new Getopt_long (argc, argv, options_static);
603 while (Long_option_init const *opt = (*option_parser) ())
605 switch (opt->shortname_char_)
608 if (string (opt->longname_str0_) == "pdf"
609 || string (opt->longname_str0_) == "png"
610 || string (opt->longname_str0_) == "ps")
611 add_output_format (opt->longname_str0_);
612 else if (string (opt->longname_str0_) == "relocate")
613 relocate_binary = true;
618 string arg (option_parser->optional_argument_str0_);
619 ssize eq = arg.find ('=');
626 key = arg.substr (0, eq);
627 val = arg.substr (eq + 1, arg.length () - 1);
630 init_scheme_variables_global
631 += "(cons \'" + key + " '" + val + ")\n";
641 string s = option_parser->optional_argument_str0_;
642 File_name file_name (s);
643 output_name_global = file_name.to_string ();
647 jail_spec = option_parser->optional_argument_str0_;
651 init_scheme_code_global
652 += option_parser->optional_argument_str0_ + string (" ");
661 vector<string> components
662 = string_split (option_parser->optional_argument_str0_, ',');
663 for (vsize i = 0; i < components.size (); i++)
664 add_output_format (components[i]);
669 dump_header_fieldnames_global
670 .push_back (option_parser->optional_argument_str0_);
673 global_path.append (option_parser->optional_argument_str0_);
676 init_name_global = option_parser->optional_argument_str0_;
682 set_loglevel (LOGLEVEL_DEBUG);
685 set_loglevel (LOGLEVEL_ERROR);
688 set_loglevel (option_parser->optional_argument_str0_);
691 programming_error (to_string ("unhandled short option: %c",
692 opt->shortname_char_));
698 if (output_format_global == "")
699 output_format_global = "pdf";
704 if (is_loglevel (LOG_DEBUG))
711 T1686 Add two new routines called by setup_guile_env
715 setup_guile_gc_env ()
717 * Set up environment variables relevant to the
721 char const *yield = getenv ("LILYPOND_GC_YIELD");
722 bool overwrite = true;
729 sane_putenv ("GUILE_MIN_YIELD_1", yield, overwrite);
730 sane_putenv ("GUILE_MIN_YIELD_2", yield, overwrite);
731 sane_putenv ("GUILE_MIN_YIELD_MALLOC", yield, overwrite);
733 sane_putenv ("GUILE_INIT_SEGMENT_SIZE_1",
734 "10485760", overwrite);
735 sane_putenv ("GUILE_MAX_SEGMENT_SIZE",
736 "104857600", overwrite);
741 setup_guile_v2_env ()
743 * Set up environment variables relevant to compiling
744 * Scheme files for Guile V2.
747 sane_putenv("GUILE_AUTO_COMPILE", "0", true); // disable auto-compile
748 sane_putenv("GUILE_WARN_DEPRECATED",
749 "detailed", "true"); // set Guile to info re deprecation
751 Set root for Guile %compile-fallback to
752 Lilypond root for its data.
754 sane_putenv("XDG_CACHE_HOME",
755 lilypond_datadir, true);
761 * Set up environment variables relevant to Scheme
765 setup_guile_gc_env (); // configure garbage collector
767 setup_guile_v2_env (); // configure Guile V2 behaviour
771 //vector<string> start_environment_global;
774 main (int argc, char **argv, char **envp)
776 * Main entry-point for LilyPond executable image
778 * argc: Count of arguments on the command line
779 * argv: Vector of string arguments on command line
780 * envp: Point to vector of OS environment variables
785 Process environment variables
787 for (char **p = envp; *p; p++)
788 start_environment_global.push_back (*p);
790 Handle old-style environment equivalent to
791 old-style -V or --verbose command arguments.
792 Set it to the equivalent for --loglevel-DEBUG
794 if (getenv ("LILYPOND_VERBOSE"))
795 set_loglevel (LOGLEVEL_DEBUG);
796 if (getenv ("LILYPOND_LOGLEVEL"))
797 set_loglevel (getenv ("LILYPOND_LOGLEVEL"));
799 setup_localisation ();
800 parse_argv (argc, argv);
801 if (isatty (STDIN_FILENO) && (is_loglevel (LOG_BASIC)))
804 setup_paths (argv[0]);
805 setup_guile_env (); // set up environment variables to pass into Guile API
807 * Start up Guile API using main_with_guile as a callback.
811 Set it on by default for Guile V2
812 while migration in progress.
816 scm_boot_guile (argc, argv, main_with_guile, 0);
820 error (_f ("exception caught: %s", e.what ()));
823 scm_boot_guile (argc, argv, main_with_guile, 0);
826 /* Only reachable if GUILE exits. That is an error. */