]> git.donarmstrong.com Git - lilypond.git/blob - lily/main.cc
Add dummy xgettext markers.
[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 <pwd.h>
17 #include <grp.h>
18 #include <sys/types.h>
19
20 #include "config.hh"
21
22 #if HAVE_GETTEXT
23 #include <libintl.h>
24 #endif
25
26 #include "all-font-metrics.hh"
27 #include "file-name.hh"
28 #include "freetype.hh"
29 #include "getopt-long.hh"
30 #include "global-ctor.hh"
31 #include "lily-guile.hh"
32 #include "lily-version.hh"
33 #include "misc.hh"
34 #include "output-def.hh"
35 #include "string-convert.hh"
36 #include "version.hh"
37 #include "warn.hh"
38
39 /*
40  * Global options that can be overridden through command line.
41  */
42
43 /* Names of header fields to be dumped to a separate file. */
44 Array<String> dump_header_fieldnames_global;
45
46 /* Name of initialisation file. */
47 String init_name_global;
48
49 /* Selected output format.
50    One of tex, ps, scm, as.
51 */
52 String output_backend_global = "ps";
53 String output_format_global = "pdf";
54
55 bool is_pango_format_global;
56 bool is_TeX_format_global;
57
58 /* Current output name. */
59 String output_name_global;
60
61 /* Run in safe mode? */
62 bool be_safe_global = false;
63
64 /* Verbose progress indication? */
65 bool be_verbose_global = false;
66
67 /* Scheme code to execute before parsing, after .scm init
68    This is where -e arguments are appended to.
69 */
70 String init_scheme_code_string = "(begin #t ";
71
72 bool make_preview = false;
73 bool make_pages = true;
74
75
76 /*
77  * Miscellaneous global stuff.
78  */
79 File_path global_path;
80
81
82 /*
83  * File globals.
84  */
85
86 static char const *AUTHORS =
87 "  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
88 "  Jan Nieuwenhuizen <janneke@gnu.org>\n";
89
90 static char const *PROGRAM_NAME = "lilypond";
91 static char const *PROGRAM_URL = "http://lilypond.org";
92
93 static char const *NOTICE =
94 _i("This program is free software.  It is covered by the GNU General Public\n"
95    "License and you are welcome to change it and/or distribute copies of it\n"
96    "under certain conditions.  Invoke as `%s --warranty' for more\n"
97    "information.\n");
98   
99 static char const *WARRANTY =
100 _i("    This program is free software; you can redistribute it and/or\n"
101    "modify it under the terms of the GNU General Public License version 2\n"
102    "as published by the Free Software Foundation.\n"
103    "\n"
104    "    This program is distributed in the hope that it will be useful,\n"
105    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
106    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
107    "General Public License for more details.\n"
108    "\n"
109    "    You should have received a copy (refer to the file COPYING) of the\n"
110    "GNU General Public License along with this program; if not, write to\n"
111    "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
112    "Boston, MA 02111-1307, USA.\n");
113
114 /* Where the init files live.  Typically:
115    LILYPOND_DATADIR = /usr/share/lilypond
116 */
117 String prefix_directory;
118
119 /* The jail specification: USER,GROUP,JAIL,DIR. */
120 String jail_spec;
121
122 /*  The option parser */
123 static Getopt_long *option_parser = 0;
124
125 /* Internationalisation kludge in two steps:
126    * use _i () to get entry in POT file
127    * call gettext () explicitely for actual "translation"  */
128
129 static Long_option_init options_static[] =
130   {
131     {_i ("EXT"), "backend", 'b', _i ("select backend to use")},
132     {_i ("EXPR"), "evaluate", 'e',
133      _i ("set option, use -e '(ly:option-usage)' for help")},
134     /* Bug in option parser: --output =foe is taken as an abbreviation
135        for --output-format.  */
136     {_i ("EXTs"), "formats", 'f', _i ("list of formats to dump")},
137     {0, "help", 'h',  _i ("print this help")},
138     {_i ("FIELD"), "header", 'H',  _i ("write header field to BASENAME.FIELD")},
139     {_i ("DIR"), "include", 'I',  _i ("add DIR to search path")},
140     {_i ("FILE"), "init", 'i',  _i ("use FILE as init file")},
141     {_i ("FILE"), "output", 'o',  _i ("write output to FILE (suffix will be added)")},
142     {_i ("USER,GROUP,JAIL,DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP and cd into DIR")},
143     {0, "preview", 'p',  _i ("generate a preview")},
144     {0, "no-pages", 0,  _i ("don't generate full pages")},
145     {0, "png", 0,  _i ("generate PNG")},
146     {0, "ps", 0,  _i ("generate PostScript")},
147     {0, "dvi", 0,  _i ("generate DVI")},
148     {0, "pdf", 0,  _i ("generate PDF (default)")},
149     {0, "tex", 0,  _i ("generate TeX")},
150     {0, "safe-mode", 's',  _i ("run in safe mode")},
151     {0, "version", 'v',  _i ("print version number")},
152     {0, "verbose", 'V', _i ("be verbose")},
153     {0, "warranty", 'w',  _i ("show warranty and copyright")},
154     {0, 0, 0, 0}
155   };
156
157 static void
158 dir_info (FILE *out)
159 {
160   fputs ("\n", out);
161   fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
162   if (char const * env = getenv ("LILYPONDPREFIX"))
163     fprintf (out, "LILYPONDPREFIX=\"%s\"\n",  env);
164   fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
165
166   fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.to_str0());
167 }
168
169 static void
170 copyright ()
171 {
172   printf (_f ("Copyright (c) %s by\n%s  and others.",
173               "1996--2005",
174               AUTHORS).to_str0 ());
175   printf ("\n");
176 }
177
178 static void
179 identify (FILE *out)
180 {
181   fputs (gnu_lilypond_version_string ().to_str0 (), out);
182   fputs ("\n", out);
183 }
184  
185 static void
186 notice ()
187 {
188   identify (stdout);
189   puts (_f (NOTICE, PROGRAM_NAME).to_str0 ());
190   printf ("\n");
191   copyright ();
192 }
193
194 static void
195 usage ()
196 {
197   /* No version number or newline here.  It confuses help2man.  */
198   printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).to_str0 ());
199   printf ("\n\n");
200   printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
201   printf ("\n\n");
202   printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
203   printf ("\n");
204   printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
205   printf ("\n\n");
206   printf (_ ("Options:").to_str0 ());
207   printf ("\n");
208   printf (Long_option_init::table_string (options_static).to_str0 ());
209   printf ("\n");
210   printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
211   printf ("\n");
212   printf ("\n");
213 }
214
215 static void
216 warranty ()
217 {
218   identify (stdout);
219   printf ("\n");
220   copyright ();
221   printf ("\n");
222   printf (_ (WARRANTY).to_str0 ());
223 }
224
225 static void
226 setup_paths ()
227 {
228   prefix_directory = LILYPOND_DATADIR;
229   if (char const * env = getenv ("LILYPONDPREFIX"))
230     prefix_directory = env;
231
232   global_path.append ("");
233
234   /* Adding mf/out make lilypond unchanged source directory, when setting
235      LILYPONDPREFIX to lilypond-x.y.z */
236   char *suffixes[] = {"ly", "cff", "otf", "mf/out", "scm", "tfm", "ps", "svg",
237                       0};
238
239   for (char **s = suffixes; *s; s++)
240     {
241       String path = prefix_directory + to_string ('/') + String (*s);
242       global_path.prepend (path);
243     }
244 }
245   
246 static void
247 prepend_load_path (String dir)
248 {
249   String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
250   scm_c_eval_string (s.to_str0 ());
251 }
252
253 void init_global_tweak_registry ();
254 void init_fontconfig ();
255
256 static void
257 do_chroot_jail ()
258 {
259   /* Now we chroot, setuid/setgrp and chdir.  If something goes wrong,
260      we exit (this is a security-sensitive area).  First we split
261      jail_spec into its components, then we retrieve the user/group id
262      (necessarily *before* chroot'ing) and finally we perform the
263      actual actions.  */
264
265   enum Jail
266     {
267       USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
268     };
269   
270   Array<String> components = String_convert::split (jail_spec, ',');
271   if (components.size () != JAIL_MAX)
272     {
273       error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
274                  components.size ()));
275       exit (2);
276     }
277
278   /* Hmm.  */
279   errno = 0;
280
281   int uid;
282   if (passwd *passwd = getpwnam (components[USER_NAME].to_str0 ()))
283     uid = passwd->pw_uid;
284   else
285     {
286       if (errno == 0)
287         error (_f ("no such user: %s", components[USER_NAME]));
288       else 
289         error(_f ("can't get user id from user name: %s: %s",
290                   components[USER_NAME],
291                   strerror (errno)));
292       exit (3);
293     }
294
295   /* Hmm.  */
296   errno = 0;
297
298   int gid;
299   if (group *group = getgrnam (components[GROUP_NAME].to_str0 ()))
300     gid = group->gr_gid;
301   else
302     {
303       if (errno == 0) 
304         error (_f ("no such group: %s", components[GROUP_NAME]));
305       else 
306         error (_f ("can't get group id from group name: %s: ",
307                    components[GROUP_NAME],
308                    strerror (errno)));
309       exit (3);
310     }
311
312   if (chroot (components[JAIL].to_str0 ()))
313     {
314       error (_f ("can't chroot to: %s: %s", components[JAIL],
315                  strerror (errno)));
316       exit (3);
317     }
318
319   if (setgid (gid))
320     {
321       error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
322       exit (3);
323     }
324
325   if (setuid (uid))
326     {
327       error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
328       exit (3);
329     }
330
331   if (chdir (components[DIR].to_str0 ()))
332     {
333       error (_f ("can't change working directory to: %s: %s", components[DIR],
334                  strerror (errno)));
335       exit (3);
336     }
337 }
338
339 void test_pango();
340
341 static void
342 main_with_guile (void *, int, char **)
343 {
344   /* Engravers use lily.scm contents, need to make Guile find it.
345      Prepend onto GUILE %load-path, very ugh. */
346
347   prepend_load_path (prefix_directory);
348   prepend_load_path (prefix_directory + "/scm");
349
350   if (be_verbose_global)
351     dir_info (stderr);
352   is_TeX_format_global = (output_backend_global == "tex"
353                           || output_backend_global == "texstr");
354
355   is_pango_format_global = !is_TeX_format_global;
356     
357
358   ly_c_init_guile ();
359   call_constructors ();
360   init_global_tweak_registry ();
361   init_fontconfig ();
362   
363   init_freetype ();
364
365   all_fonts_global = new All_font_metrics (global_path.to_string ());
366
367   init_scheme_code_string += ")";
368   scm_c_eval_string ((char*) init_scheme_code_string.to_str0 ());
369
370   /* We accept multiple independent music files on the command line to
371      reduce compile time when processing lots of small files.
372      Starting the GUILE engine is very time consuming.  */
373
374   SCM files = SCM_EOL;
375   SCM *tail = &files;
376   while (char const *arg = option_parser->get_next_arg ())
377     {
378       *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
379       tail = SCM_CDRLOC (*tail);
380     }
381   delete option_parser;
382   option_parser = 0;
383
384   if (files == SCM_EOL)
385     {
386       /* No FILE arguments is now a usage error to help newbies.  If you
387          want a filter, you're not a newbie and should know to use file
388          argument `-'.  */
389       usage ();
390       exit (2);
391     }
392
393   if (! jail_spec.is_empty ()) 
394      do_chroot_jail ();
395
396   SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
397   (void) result;
398
399   /* Unreachable.  */
400   exit (0);
401 }
402
403 static void
404 setup_localisation ()
405 {
406 #if HAVE_GETTEXT
407   /* Enable locales */
408   setlocale (LC_ALL, "");
409   
410   /* FIXME: check if this is still true.
411     Disable localisation of float values.  This breaks TeX output.  */
412   setlocale (LC_NUMERIC, "C");
413   
414   String name (PACKAGE);
415   name.to_lower ();
416   bindtextdomain (name.to_str0 (), LOCALEDIR);
417   textdomain (name.to_str0 ());
418 #endif
419 }
420
421 static void
422 add_output_format (String format)
423 {
424   if (output_format_global != "")
425     output_format_global += ",";
426   output_format_global += format;
427 }
428
429 static void
430 parse_argv (int argc, char **argv)
431 {
432   bool show_help = false;
433   option_parser = new Getopt_long (argc, argv, options_static);
434   while (Long_option_init const *opt = (*option_parser) ())
435     {
436       switch (opt->shortname_char_)
437         {
438         case 0:
439           if (String (opt->longname_str0_) == "png"
440               || String (opt->longname_str0_) == "pdf"
441               || String (opt->longname_str0_) == "ps"
442               || String (opt->longname_str0_) == "dvi"
443               || String (opt->longname_str0_) == "tex")
444             {
445               add_output_format (opt->longname_str0_);
446             }
447           else if (String (opt->longname_str0_) == "preview")
448             make_preview = true;
449           else if (String (opt->longname_str0_) == "no-pages")
450             make_pages = false;
451           break;
452           
453         case 'v':
454           notice ();
455           exit (0);
456           break;
457         case 'o':
458           {
459             String s = option_parser->optional_argument_str0_;
460             File_name file_name (s);
461             output_name_global = file_name.to_string ();
462           }
463           break;
464         case 'j':
465           jail_spec = option_parser->optional_argument_str0_;
466           break;
467         case 'e':
468           init_scheme_code_string += option_parser->optional_argument_str0_;
469           break;
470         case 'w':
471           warranty ();
472           exit (0);
473           break;
474           
475         case 'b':
476           output_backend_global = option_parser->optional_argument_str0_;
477           break;
478
479         case 'f':
480           output_format_global = option_parser->optional_argument_str0_;
481           break;
482           
483         case 'H':
484           dump_header_fieldnames_global
485             .push (option_parser->optional_argument_str0_);
486           break;
487         case 'I':
488           global_path.append (option_parser->optional_argument_str0_);
489           break;
490         case 'i':
491           init_name_global = option_parser->optional_argument_str0_;
492           break;
493         case 'h':
494           show_help = true;
495           break;
496         case 'V':
497           be_verbose_global = true;
498           break;
499         case 's':
500           be_safe_global = true;
501           break;
502         case 'p':
503           make_preview = true;
504           break;
505         default:
506           programming_error (to_string ("unhandled short option: %c",
507                                         opt->shortname_char_));
508           assert (false);
509           break;
510         }
511     }
512
513   if (show_help)
514     {
515       identify (stdout);
516       usage ();
517       if (be_verbose_global)
518         dir_info (stdout);
519       exit (0);
520     }
521 }
522
523 int
524 main (int argc, char **argv)
525 {
526   setup_localisation ();
527   setup_paths ();
528   parse_argv (argc, argv);
529   identify (stderr);
530
531   scm_boot_guile (argc, argv, main_with_guile, 0);
532
533   /* Unreachable */
534   return 0;
535 }