]> git.donarmstrong.com Git - lilypond.git/blob - lily/main.cc
* lily/main.cc (setup_localisation): Listen to LILYPOND_LOCALEDIR.
[lilypond.git] / lily / main.cc
1 /*
2   main.cc -- implement main () entrypoint.
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 */
8
9 #include "main.hh"
10
11 #include <cassert>
12 #include <clocale>
13 #include <cstring>
14 #include <unistd.h>
15 #include <errno.h>
16 #include <sys/types.h>
17 #include <sys/stat.h>
18
19 #include "config.hh"
20
21 #if HAVE_GRP_H
22 #include <grp.h>
23 #endif 
24 #if HAVE_PWD_H
25 #include <pwd.h>
26 #endif 
27 #if HAVE_GETTEXT
28 #include <libintl.h>
29 #endif
30
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"
38 #include "misc.hh"
39 #include "output-def.hh"
40 #include "string-convert.hh"
41 #include "version.hh"
42 #include "warn.hh"
43
44 /*
45  * Global options that can be overridden through command line.
46  */
47
48 /* Names of header fields to be dumped to a separate file. */
49 Array<String> dump_header_fieldnames_global;
50
51 /* Name of initialisation file. */
52 String init_name_global;
53
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";
59
60 bool is_pango_format_global;
61 bool is_TeX_format_global;
62
63 /* Current output name. */
64 String output_name_global;
65
66 /* Run in safe mode? */
67 bool be_safe_global = false;
68
69 /* Provide URI links to the original file */
70 bool point_and_click_global = true;
71
72 /* Verbose progress indication? */
73 bool be_verbose_global = false;
74
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;
79
80 /* Generate preview of first system.  */
81 bool make_preview = false;
82
83 /* Generate printed output.  */
84 bool make_print = true;
85
86 /*
87  * Miscellaneous global stuff.
88  */
89 File_path global_path;
90
91 /*
92  * File globals.
93  */
94
95 static char const *AUTHORS
96 = "  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
97   "  Jan Nieuwenhuizen <janneke@gnu.org>\n";
98
99 static char const *PROGRAM_NAME = "lilypond";
100 static char const *PROGRAM_URL = "http://lilypond.org";
101
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"
106       "information.\n");
107
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"
112       "\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"
117       "\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");
122
123 /* Where the init files live.  Typically:
124    LILYPOND_DATADIR = /usr/share/lilypond
125 */
126 String prefix_directory;
127
128 /* The jail specification: USER,GROUP,JAIL,DIR. */
129 String jail_spec;
130
131 /*  The option parser */
132 static Getopt_long *option_parser = 0;
133
134 /* Internationalisation kludge in two steps:
135  * use _i () to get entry in POT file
136  * call gettext () explicitely for actual "translation"  */
137
138 static Long_option_init options_static[]
139 = {
140   {_i ("BACK"), "backend", 'b', _i ("use backend BACK (gnome, ps [default],\n                                       scm, svg, tex, texstr)")},
141
142   {_i ("SYM=VAL"), "define-default", 'd',
143    _i ("define a default Scheme setting.")},
144
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)")},
159 #if HAVE_CHROOT
160   {_i ("USER,GROUP,JAIL,DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n                                       and cd into DIR")},
161 #endif 
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")},
168   {0, 0, 0, 0}
169 };
170
171 #define LILYPOND_DATADIR PACKAGE_DATADIR "/" TOPLEVEL_VERSION
172
173 static void
174 env_var_info (FILE *out, char const* key)
175 {
176   if (char const *value = getenv (key))
177     fprintf (out, "%s=\"%s\"\n", key, value);
178 }
179
180 static void
181 dir_info (FILE *out)
182 {
183   fputs ("\n", out);
184   fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
185   env_var_info (out, "LILYPONDPREFIX");
186   fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
187
188   fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.to_str0 ());
189
190 #if ARGV0_RELOCATION
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");
198 #endif  
199 }
200
201 static void
202 copyright ()
203 {
204   printf (_f ("Copyright (c) %s by\n%s  and others.",
205               "1996--2005",
206               AUTHORS).to_str0 ());
207   printf ("\n");
208 }
209
210 static void
211 identify (FILE *out)
212 {
213   fputs (gnu_lilypond_version_string ().to_str0 (), out);
214   fputs ("\n", out);
215 }
216
217 static void
218 notice ()
219 {
220   identify (stdout);
221   puts (_f (NOTICE, PROGRAM_NAME).to_str0 ());
222   printf ("\n");
223   copyright ();
224 }
225
226 LY_DEFINE (ly_usage, "ly:usage",
227            0, 0, 0, (),
228            "Print usage message.")
229 {
230   /* No version number or newline here.  It confuses help2man.  */
231   printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).to_str0 ());
232   printf ("\n\n");
233   printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
234   printf ("\n\n");
235   printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
236   printf ("\n");
237   printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
238   printf ("\n\n");
239   printf (_ ("Options:").to_str0 ());
240   printf ("\n");
241   printf (Long_option_init::table_string (options_static).to_str0 ());
242   printf ("\n");
243   printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
244   printf ("\n");
245   printf ("\n");
246   return SCM_UNSPECIFIED;
247 }
248
249 static void
250 warranty ()
251 {
252   identify (stdout);
253   printf ("\n");
254   copyright ();
255   printf ("\n");
256   printf (_ (WARRANTY).to_str0 ());
257 }
258
259 #if ARGV0_RELOCATION
260 static int
261 sane_putenv (char const* key, String value, bool overwrite = true)
262 {
263   if (overwrite || !getenv (key))
264     {
265       String combine = String (key) + "=" + value;
266       char *s = strdup (combine.to_str0 ());
267       return putenv (s);
268     }
269   return -1;
270 }
271
272 static int
273 set_env_file (char const* key, String value)
274 {
275   if (is_file (value))
276     return sane_putenv (key, value, false);
277   else if (be_verbose_global)
278     warning (_f ("no such file: %s", value));
279   return -1;
280 }
281
282 static int
283 prepend_env_path (char const *key, String value)
284 {
285   if (char const* cur = getenv (key))
286     value += to_string (PATHSEP) + cur;
287   if (is_dir (value + "/"))
288     return sane_putenv (key, value.to_str0 ());
289   else if (be_verbose_global)
290     warning (_f ("no such directory: %s", value));
291   return -1;
292 }
293
294 String
295 dir_name (String const file_name)
296 {
297   String s = file_name;
298   s.substitute ('\\', '/');
299   s = s.left_string (s.index_last ('/'));
300   return s;
301 }
302 #endif
303
304 #ifdef __MINGW32__
305 #  include <winbase.h>
306 #endif
307
308 static void
309 setup_paths (char const* argv0)
310 {
311   prefix_directory = LILYPOND_DATADIR;
312
313 #if ARGV0_RELOCATION
314
315   if (getenv ("LILYPOND_VERBOSE"))
316     be_verbose_global = true;
317
318   String bindir = dir_name (argv0);
319   String argv0_prefix = dir_name (bindir);
320   if (argv0_prefix != dir_name (dir_name (dir_name (prefix_directory))))
321     {
322       if (be_verbose_global)
323         warning (_f ("argv0 relocation: argv0=%s, prefix=%s", argv0,
324                      prefix_directory));
325       String datadir = argv0_prefix + "/share";
326       String libdir = argv0_prefix + "/lib";
327       String localedir = argv0_prefix + "/locale";
328       String sysconfdir = argv0_prefix + "/etc";
329       String argv0_lilypond_datadir = datadir + "/lilypond/" TOPLEVEL_VERSION;
330
331       if (is_dir (argv0_lilypond_datadir))
332         prefix_directory = argv0_lilypond_datadir;
333
334 #if HAVE_GETTEXT
335       if (is_dir (localedir))
336         bindtextdomain ("lilypond", localedir.to_str0 ());
337 #endif
338
339       set_env_file ("FONTCONFIG_FILE", sysconfdir + "/fonts/fonts.conf");
340 #ifdef __MINGW32__
341       char font_dir[PATH_MAX];
342       ExpandEnvironmentStrings ("%windir%/fonts", font_dir, sizeof (font_dir));
343       prepend_env_path ("GS_FONTPATH", font_dir);
344 #endif
345
346       /* FIXME: *cough* 8.15 *cough* */
347       prepend_env_path ("GS_FONTPATH", datadir + "/ghostscript/8.15/fonts");
348       prepend_env_path ("GS_LIB", datadir + "/ghostscript/8.15/Resource");
349       prepend_env_path ("GS_LIB", datadir + "/ghostscript/8.15/lib");
350
351       prepend_env_path ("GS_FONTPATH", datadir + "/gs/fonts");
352       prepend_env_path ("GS_LIB", datadir + "/gs/Resource");
353       prepend_env_path ("GS_LIB", datadir + "/gs/lib");
354
355       prepend_env_path ("GUILE_LOAD_PATH", datadir
356                         + to_string ("/guile/%d.%d",
357                                      SCM_MAJOR_VERSION, SCM_MINOR_VERSION));
358       set_env_file ("PANGO_RC_FILE", sysconfdir + "/pango/pangorc");
359       prepend_env_path ("PATH", bindir);
360     }
361 #else
362   (void) argv0;
363 #endif /* ARGV0_RELOCATION */
364
365   /* FIXME: use LILYPOND_DATADIR.  */
366   if (char const *env = getenv ("LILYPONDPREFIX"))
367     {
368 #ifdef __MINGW32__
369       /* Normalize file name.  */
370       env = File_name (env).to_string ().get_copy_str0 ();
371 #endif
372       prefix_directory = env;
373     }
374
375   global_path.append ("");
376
377   /* Adding mf/out make lilypond unchanged source directory, when setting
378      LILYPONDPREFIX to lilypond-x.y.z */
379   char *suffixes[] = {"ly", "ps", "scm", 0 };
380
381   Array<String> dirs;
382   for (char **s = suffixes; *s; s++)
383     {
384       String path = prefix_directory + to_string ('/') + String (*s);
385       dirs.push (path);
386     }
387
388   /*
389     ugh. C&P font-config.cc
390   */
391   struct stat statbuf; 
392   String builddir = prefix_directory + "/mf/out/";
393   if (stat (builddir.to_str0 (), &statbuf) == 0)
394     {
395       dirs.push (builddir.to_str0 ());
396     }
397   else
398     {
399       dirs.push (prefix_directory + "/fonts/otf/");
400       dirs.push (prefix_directory + "/fonts/type1/");
401       dirs.push (prefix_directory + "/fonts/cff/");
402       dirs.push (prefix_directory + "/fonts/svg/");
403       dirs.push (prefix_directory + "/fonts/cff/");
404     }
405
406   for (int i = 0; i < dirs.size (); i++)
407     global_path.prepend (dirs[i]);  
408 }
409   
410 static void
411 prepend_load_path (String dir)
412 {
413   String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
414   scm_c_eval_string (s.to_str0 ());
415 }
416
417 void init_global_tweak_registry ();
418 void init_fontconfig ();
419
420 #if HAVE_CHROOT
421 static void
422 do_chroot_jail ()
423 {
424   /* Now we chroot, setuid/setgrp and chdir.  If something goes wrong,
425      we exit (this is a security-sensitive area).  First we split
426      jail_spec into its components, then we retrieve the user/group id
427      (necessarily *before* chroot'ing) and finally we perform the
428      actual actions.  */
429
430   enum Jail
431     {
432       USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
433     };
434
435   Array<String> components = String_convert::split (jail_spec, ',');
436   if (components.size () != JAIL_MAX)
437     {
438       error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
439                  components.size ()));
440       exit (2);
441     }
442
443   /* Hmm.  */
444   errno = 0;
445
446   int uid;
447   if (passwd * passwd = getpwnam (components[USER_NAME].to_str0 ()))
448     uid = passwd->pw_uid;
449   else
450     {
451       if (errno == 0)
452         error (_f ("no such user: %s", components[USER_NAME]));
453       else
454         error (_f ("can't get user id from user name: %s: %s",
455                    components[USER_NAME],
456                    strerror (errno)));
457       exit (3);
458     }
459
460   /* Hmm.  */
461   errno = 0;
462
463   int gid;
464   if (group * group = getgrnam (components[GROUP_NAME].to_str0 ()))
465     gid = group->gr_gid;
466   else
467     {
468       if (errno == 0)
469         error (_f ("no such group: %s", components[GROUP_NAME]));
470       else
471         error (_f ("can't get group id from group name: %s: %s",
472                    components[GROUP_NAME],
473                    strerror (errno)));
474       exit (3);
475     }
476
477   if (chroot (components[JAIL].to_str0 ()))
478     {
479       error (_f ("can't chroot to: %s: %s", components[JAIL],
480                  strerror (errno)));
481       exit (3);
482     }
483
484   if (setgid (gid))
485     {
486       error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
487       exit (3);
488     }
489
490   if (setuid (uid))
491     {
492       error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
493       exit (3);
494     }
495
496   if (chdir (components[DIR].to_str0 ()))
497     {
498       error (_f ("can't change working directory to: %s: %s", components[DIR],
499                  strerror (errno)));
500       exit (3);
501     }
502 }
503 #endif
504
505
506
507 static void
508 main_with_guile (void *, int, char **)
509 {
510   /* Engravers use lily.scm contents, need to make Guile find it.
511      Prepend onto GUILE %load-path, very ugh. */
512
513   prepend_load_path (prefix_directory);
514   prepend_load_path (prefix_directory + "/scm");
515
516   if (be_verbose_global)
517     dir_info (stderr);
518   is_TeX_format_global = (output_backend_global == "tex"
519                           || output_backend_global == "texstr");
520
521   is_pango_format_global = !is_TeX_format_global;
522
523   ly_c_init_guile ();
524   call_constructors ();
525   init_global_tweak_registry ();
526   init_fontconfig ();
527
528   init_freetype ();
529
530   all_fonts_global = new All_font_metrics (global_path.to_string ());
531
532   
533   if (!init_scheme_variables.is_empty ()
534       || !init_scheme_code_string.is_empty ())
535     {
536       init_scheme_variables = "(ly:set-option 'command-line-settings (list "
537         + init_scheme_variables + "))";
538       
539       init_scheme_code_string
540         += "(begin #t "
541         + init_scheme_variables
542         + init_scheme_code_string
543         + ")";
544
545       char const *str0 = init_scheme_code_string.to_str0 ();
546       
547       if (be_verbose_global)
548         progress_indication (_f("Evaluating %s", str0));
549       scm_c_eval_string ((char *) str0);
550     }
551
552   
553   /* We accept multiple independent music files on the command line to
554      reduce compile time when processing lots of small files.
555      Starting the GUILE engine is very time consuming.  */
556
557   SCM files = SCM_EOL;
558   SCM *tail = &files;
559   while (char const *arg = option_parser->get_next_arg ())
560     {
561       *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
562       tail = SCM_CDRLOC (*tail);
563     }
564   delete option_parser;
565   option_parser = 0;
566
567 #if HAVE_CHROOT
568   if (!jail_spec.is_empty ())
569     do_chroot_jail ();
570 #endif
571
572   SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
573   (void) result;
574
575   /* Unreachable.  */
576   exit (0);
577 }
578
579 static void
580 setup_localisation ()
581 {
582 #if HAVE_GETTEXT
583   /* Enable locales */
584   setlocale (LC_ALL, "");
585
586   /* FIXME: check if this is still true.
587      Disable localisation of float values.  This breaks TeX output.  */
588   setlocale (LC_NUMERIC, "C");
589
590   String localedir = LOCALEDIR;
591   if (char const *env = getenv ("LILYPOND_LOCALEDIR"))
592     localedir = env;
593   
594   bindtextdomain ("lilypond", localedir.to_str0 ());
595   textdomain ("lilypond");
596 #endif
597 }
598
599 static void
600 add_output_format (String format)
601 {
602   if (output_format_global != "")
603     output_format_global += ",";
604   output_format_global += format;
605 }
606
607 static void
608 parse_argv (int argc, char **argv)
609 {
610   bool show_help = false;
611   option_parser = new Getopt_long (argc, argv, options_static);
612   while (Long_option_init const *opt = (*option_parser) ())
613     {
614       switch (opt->shortname_char_)
615         {
616         case 0:
617           if (String (opt->longname_str0_) == "dvi"
618               || String (opt->longname_str0_) == "pdf"
619               || String (opt->longname_str0_) == "png"
620               || String (opt->longname_str0_) == "ps"
621               || String (opt->longname_str0_) == "tex")
622             add_output_format (opt->longname_str0_);
623           else if (String (opt->longname_str0_) == "preview")
624             make_preview = true;
625           else if (String (opt->longname_str0_) == "no-pages")
626             make_print = false;
627           break;
628
629         case 'd':
630           {
631             String arg (option_parser->optional_argument_str0_);
632             int eq = arg.index ('=');
633
634             String key = arg;
635             String val = "#t";
636             
637             if (eq >= 0)
638               {
639                 key = arg.left_string (eq);
640                 val = arg.right_string (arg.length () - eq - 1);
641               }
642
643             init_scheme_variables
644               += "(cons \'" + key  + "  " + val + ")\n";
645           }
646           break;
647           
648         case 'v':
649           notice ();
650           exit (0);
651           break;
652         case 'o':
653           {
654             String s = option_parser->optional_argument_str0_;
655             File_name file_name (s);
656             output_name_global = file_name.to_string ();
657           }
658           break;
659         case 'j':
660           jail_spec = option_parser->optional_argument_str0_;
661           break;
662         case 'e':
663           init_scheme_code_string += option_parser->optional_argument_str0_;
664           break;
665         case 'w':
666           warranty ();
667           exit (0);
668           break;
669           
670         case 'b':
671           output_backend_global = option_parser->optional_argument_str0_;
672           break;
673
674         case 'f':
675           output_format_global = option_parser->optional_argument_str0_;
676           break;
677           
678         case 'H':
679           dump_header_fieldnames_global
680             .push (option_parser->optional_argument_str0_);
681           break;
682         case 'I':
683           global_path.append (option_parser->optional_argument_str0_);
684           break;
685         case 'i':
686           init_name_global = option_parser->optional_argument_str0_;
687           break;
688         case 'h':
689           show_help = true;
690           break;
691         case 'V':
692           be_verbose_global = true;
693           break;
694         case 's':
695           be_safe_global = true;
696           break;
697         case 'p':
698           make_preview = true;
699           break;
700         default:
701           programming_error (to_string ("unhandled short option: %c",
702                                         opt->shortname_char_));
703           assert (false);
704           break;
705         }
706     }
707
708   if (show_help)
709     {
710       identify (stdout);
711       ly_usage ();
712       if (be_verbose_global)
713         dir_info (stdout);
714       exit (0);
715     }
716 }
717
718 int
719 main (int argc, char **argv)
720 {
721   setup_localisation ();
722   setup_paths (argv[0]);
723   parse_argv (argc, argv);
724   if (isatty (STDIN_FILENO))
725     identify (stderr);
726
727   scm_boot_guile (argc, argv, main_with_guile, 0);
728
729   /* Only reachable if GUILE exits.  That is an error.  */
730   return 1;
731 }