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