lily/main.cc

   1 /*
   2   main.cc -- implement main () entrypoint.
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "main.hh"
  10
  11 #include <cassert>
  12 #include <clocale>
  13 #include <cstring>
  14 #include <cerrno>
  15 using namespace std;
  16
  17 #include <unistd.h>
  18 #include <sys/types.h>
  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 "international.hh"
  37 #include "lily-version.hh"
  38 #include "misc.hh"
  39 #include "output-def.hh"
  40 #include "program-option.hh"
  41 #include "relocate.hh"
  42 #include "string-convert.hh"
  43 #include "version.hh"
  44 #include "warn.hh"
  45
  46 /*
  47  * Global options that can be overridden through command line.
  48  */
  49
  50 /* Names of header fields to be dumped to a separate file. */
  51 vector<string> dump_header_fieldnames_global;
  52
  53 /* Name of initialisation file. */
  54 string init_name_global;
  55
  56 /* Selected output backend
  57    One of (gnome, ps [default], eps, scm, svg, tex, texstr)") */
  58 string output_backend_global = "ps";
  59
  60 /* Output formats to generate.  */
  61 string output_format_global = "";
  62
  63 bool is_pango_format_global;
  64 bool is_TeX_format_global;
  65
  66 /* Current output name. */
  67 string output_name_global;
  68
  69 /* Run in safe mode? */
  70 bool be_safe_global = false;
  71
  72 /* Provide URI links to the original file */
  73 bool point_and_click_global = true;
  74
  75 /* Verbose progress indication? */
  76 bool be_verbose_global = false;
  77
  78 /* Scheme code to execute before parsing, after .scm init.
  79    This is where -e arguments are appended to.  */
  80 string init_scheme_code_global;
  81 string init_scheme_variables_global;
  82
  83 /* Generate preview of first system.  */
  84 bool make_preview = false;
  85
  86 /* Generate printed output.  */
  87 bool make_print = true;
  88
  89
  90 bool relocate_binary =
  91 #if 1
  92   true;
  93 #else
  94   false
  95 #endif
  96   ;
  97
  98
  99 /*
 100  * Miscellaneous global stuff.
 101  */
 102 File_path global_path;
 103
 104 /*
 105  * File globals.
 106  */
 107
 108 static char const *AUTHORS
 109 = "  Han-Wen Nienhuys <hanwen@xs4all.nl>\n"
 110   "  Jan Nieuwenhuizen <janneke@gnu.org>\n";
 111
 112 static char const *PROGRAM_NAME = "lilypond";
 113 static char const *PROGRAM_URL = "http://lilypond.org";
 114
 115 static char const *NOTICE
 116 = _i ("This program is free software.  It is covered by the GNU General Public\n"
 117       "License and you are welcome to change it and/or distribute copies of it\n"
 118       "under certain conditions.  Invoke as `%s --warranty' for more\n"
 119       "information.\n");
 120
 121 static char const *WARRANTY
 122 = _i ("    This program is free software; you can redistribute it and/or\n"
 123       "modify it under the terms of the GNU General Public License version 2\n"
 124       "as published by the Free Software Foundation.\n"
 125       "\n"
 126       "    This program is distributed in the hope that it will be useful,\n"
 127       "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
 128       "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
 129       "General Public License for more details.\n"
 130       "\n"
 131       "    You should have received a copy of the\n"
 132       "GNU General Public License along with this program; if not, write to\n"
 133       "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
 134       "Boston, MA 02111-1307, USA.\n");
 135
 136 /* Where the init files live.  Typically:
 137    LILYPOND_DATADIR = /usr/share/lilypond
 138 */
 139 string lilypond_datadir;
 140
 141 /* The jail specification: USER, GROUP, JAIL, DIR. */
 142 string jail_spec;
 143
 144 /*  The option parser */
 145 static Getopt_long *option_parser = 0;
 146
 147 /* Internationalisation kludge in two steps:
 148  * use _i () to get entry in POT file
 149  * call gettext () explicitely for actual "translation"  */
 150
 151 static Long_option_init options_static[]
 152 = {
 153   {_i ("BACK"), "backend", 'b', _i ("use backend BACK (eps, gnome, ps [default],\nscm, svg, tex, texstr)")},
 154
 155   {_i ("SYM[=VAL]"), "define-default", 'd',
 156    _i ("set Scheme option SYM to VAL (default: #t).\n"
 157        "Use -dhelp for help.")},
 158
 159   {_i ("EXPR"), "evaluate", 'e', _i ("evaluate scheme code")},
 160   /* Bug in option parser: --output =foe is taken as an abbreviation
 161      for --output-format.  */
 162   {_i ("FORMATs"), "formats", 'f', _i ("dump FORMAT,...  Also as separate options:")},
 163   {0, "dvi", 0, _i ("generate DVI (tex backend only)")},
 164   {0, "pdf", 0, _i ("generate PDF (default)")},
 165   {0, "png", 0, _i ("generate PNG")},
 166   {0, "ps", 0, _i ("generate PostScript")},
 167   {0, "tex", 0, _i ("generate TeX (tex backend only)")},
 168   {0, "help", 'h',  _i ("show this help and exit")},
 169   {_i ("FIELD"), "header", 'H',  _i ("dump header field FIELD to file\n"
 170                                      "named BASENAME.FIELD")},
 171   {_i ("DIR"), "include", 'I',  _i ("add DIR to search path")},
 172   {_i ("FILE"), "init", 'i',  _i ("use FILE as init file")},
 173 #if HAVE_CHROOT
 174   {_i ("USER, GROUP, JAIL, DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n"
 175                                                 "and cd into DIR")},
 176 #endif
 177   {0, "no-print", 0, _i ("do not generate printed output")},
 178   {_i ("FILE"), "output", 'o',  _i ("write output to FILE (suffix will be added)")},
 179   {0, "preview", 'p',  _i ("generate a preview of the first system")},
 180   {0, "relocate", 0, _i ("relocate using directory of lilypond program")},
 181   {0, "version", 'v',  _i ("show version number and exit")},
 182   {0, "verbose", 'V', _i ("be verbose")},
 183   {0, "warranty", 'w',  _i ("show warranty and copyright")},
 184   {0, 0, 0, 0}
 185 };
 186
 187 char const *LILYPOND_DATADIR = PACKAGE_DATADIR "/" TOPLEVEL_VERSION;
 188
 189 static void
 190 env_var_info (FILE *out, char const *key)
 191 {
 192   if (char const *value = getenv (key))
 193     fprintf (out, "%s=\"%s\"\n", key, value);
 194 }
 195
 196 static void
 197 dir_info (FILE *out)
 198 {
 199   fputs ("\n", out);
 200   fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
 201   env_var_info (out, "LILYPONDPREFIX");
 202   env_var_info (out, "LILYPOND_DATADIR");
 203   fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
 204
 205   fprintf (out, "\nEffective prefix: \"%s\"\n", lilypond_datadir.c_str ());
 206
 207   if (relocate_binary)
 208     {
 209       env_var_info (out, "FONTCONFIG_FILE");
 210       env_var_info (out, "FONTCONFIG_PATH");
 211       env_var_info (out, "GS_FONTPATH");
 212       env_var_info (out, "GS_LIB");
 213       env_var_info (out, "GUILE_LOAD_PATH");
 214       env_var_info (out, "PANGO_RC_FILE");
 215       env_var_info (out, "PANGO_PREFIX");
 216       env_var_info (out, "PATH");
 217     }
 218 }
 219
 220 static void
 221 copyright ()
 222 {
 223   printf (_f ("Copyright (c) %s by\n%s  and others.",
 224               "1996--2007",
 225               AUTHORS).c_str ());
 226   printf ("\n");
 227 }
 228
 229 static void
 230 identify (FILE *out)
 231 {
 232   fputs (gnu_lilypond_version_string ().c_str (), out);
 233   fputs ("\n", out);
 234 }
 235
 236 static void
 237 notice ()
 238 {
 239   identify (stdout);
 240   puts (_f (NOTICE, PROGRAM_NAME).c_str ());
 241   printf ("\n");
 242   copyright ();
 243 }
 244
 245 LY_DEFINE (ly_usage, "ly:usage",
 246            0, 0, 0, (),
 247            "Print usage message.")
 248 {
 249   /* No version number or newline here.  It confuses help2man.  */
 250   printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).c_str ());
 251   printf ("\n\n");
 252   printf (_ ("Typeset music and/or produce MIDI from FILE.").c_str ());
 253   printf ("\n\n");
 254   printf (_ ("LilyPond produces beautiful music notation.").c_str ());
 255   printf ("\n");
 256   printf (_f ("For more information, see %s", PROGRAM_URL).c_str ());
 257   printf ("\n\n");
 258   printf (_ ("Options:").c_str ());
 259   printf ("\n");
 260   printf (Long_option_init::table_string (options_static).c_str ());
 261   printf ("\n");
 262   printf (_f ("Report bugs via %s",
 263               "http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs"
 264               ).c_str ());
 265   printf ("\n");
 266   printf ("\n");
 267   return SCM_UNSPECIFIED;
 268 }
 269
 270 static void
 271 warranty ()
 272 {
 273   identify (stdout);
 274   printf ("\n");
 275   copyright ();
 276   printf ("\n");
 277   printf (_ (WARRANTY).c_str ());
 278 }
 279
 280 static void
 281 prepend_load_path (string dir)
 282 {
 283   string s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
 284   scm_c_eval_string (s.c_str ());
 285 }
 286
 287 void init_global_tweak_registry ();
 288 void init_fontconfig ();
 289
 290 #if HAVE_CHROOT
 291 static void
 292 do_chroot_jail ()
 293 {
 294   /* Now we chroot, setuid/setgrp and chdir.  If something goes wrong,
 295      we exit (this is a security-sensitive area).  First we split
 296      jail_spec into its components, then we retrieve the user/group id
 297      (necessarily *before* chroot'ing) and finally we perform the
 298      actual actions.  */
 299
 300   enum Jail
 301     {
 302       USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
 303     };
 304
 305   vector<string> components = string_split (jail_spec, ',');
 306   if (components.size () != JAIL_MAX)
 307     {
 308       error (_f ("expected %d arguments with jail, found: %u", JAIL_MAX,
 309                  (unsigned) components.size ()));
 310       exit (2);
 311     }
 312
 313   /* Hmm.  */
 314   errno = 0;
 315
 316   int uid;
 317   if (passwd * passwd = getpwnam (components[USER_NAME].c_str ()))
 318     uid = passwd->pw_uid;
 319   else
 320     {
 321       if (errno == 0)
 322         error (_f ("no such user: %s", components[USER_NAME]));
 323       else
 324         error (_f ("cannot get user id from user name: %s: %s",
 325                    components[USER_NAME],
 326                    strerror (errno)));
 327       exit (3);
 328     }
 329
 330   /* Hmm.  */
 331   errno = 0;
 332
 333   int gid;
 334   if (group * group = getgrnam (components[GROUP_NAME].c_str ()))
 335     gid = group->gr_gid;
 336   else
 337     {
 338       if (errno == 0)
 339         error (_f ("no such group: %s", components[GROUP_NAME]));
 340       else
 341         error (_f ("cannot get group id from group name: %s: %s",
 342                    components[GROUP_NAME],
 343                    strerror (errno)));
 344       exit (3);
 345     }
 346
 347   if (chroot (components[JAIL].c_str ()))
 348     {
 349       error (_f ("cannot chroot to: %s: %s", components[JAIL],
 350                  strerror (errno)));
 351       exit (3);
 352     }
 353
 354   if (setgid (gid))
 355     {
 356       error (_f ("cannot change group id to: %d: %s", gid, strerror (errno)));
 357       exit (3);
 358     }
 359
 360   if (setuid (uid))
 361     {
 362       error (_f ("cannot change user id to: %d: %s", uid, strerror (errno)));
 363       exit (3);
 364     }
 365
 366   if (chdir (components[DIR].c_str ()))
 367     {
 368       error (_f ("cannot change working directory to: %s: %s", components[DIR],
 369                  strerror (errno)));
 370       exit (3);
 371     }
 372 }
 373 #endif
 374
 375 static void
 376 main_with_guile (void *, int, char **)
 377 {
 378   /* Engravers use lily.scm contents, need to make Guile find it.
 379      Prepend onto GUILE %load-path, very ugh. */
 380
 381   prepend_load_path (lilypond_datadir);
 382   prepend_load_path (lilypond_datadir + "/scm");
 383
 384   if (be_verbose_global)
 385     dir_info (stderr);
 386   is_TeX_format_global = (output_backend_global == "tex"
 387                           || output_backend_global == "texstr");
 388
 389   is_pango_format_global = !is_TeX_format_global;
 390   init_scheme_variables_global = "(list " + init_scheme_variables_global + ")";
 391   init_scheme_code_global = "(begin " + init_scheme_code_global + ")";
 392
 393   ly_c_init_guile ();
 394   call_constructors ();
 395   init_fontconfig ();
 396
 397   init_freetype ();
 398   ly_reset_all_fonts ();
 399
 400
 401   /* We accept multiple independent music files on the command line to
 402      reduce compile time when processing lots of small files.
 403      Starting the GUILE engine is very time consuming.  */
 404
 405   SCM files = SCM_EOL;
 406   SCM *tail = &files;
 407   while (char const *arg = option_parser->get_next_arg ())
 408     {
 409       *tail = scm_cons (scm_from_locale_string (arg), SCM_EOL);
 410       tail = SCM_CDRLOC (*tail);
 411     }
 412
 413   delete option_parser;
 414   option_parser = 0;
 415
 416 #if HAVE_CHROOT
 417   if (!jail_spec.empty ())
 418     do_chroot_jail ();
 419 #endif
 420
 421   SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
 422   (void) result;
 423
 424   /* Unreachable.  */
 425   exit (0);
 426 }
 427
 428 static void
 429 setup_localisation ()
 430 {
 431 #if HAVE_GETTEXT
 432   /* Enable locales */
 433   setlocale (LC_ALL, "");
 434
 435   /* FIXME: check if this is still true.
 436      Disable localisation of float values.  This breaks TeX output.  */
 437   setlocale (LC_NUMERIC, "C");
 438
 439   string localedir = LOCALEDIR;
 440   if (char const *env = getenv ("LILYPOND_LOCALEDIR"))
 441     localedir = env;
 442
 443   bindtextdomain ("lilypond", localedir.c_str ());
 444   textdomain ("lilypond");
 445 #endif
 446 }
 447
 448 static void
 449 add_output_format (string format)
 450 {
 451   if (output_format_global != "")
 452     output_format_global += ",";
 453   output_format_global += format;
 454 }
 455
 456 static void
 457 parse_argv (int argc, char **argv)
 458 {
 459   bool show_help = false;
 460   option_parser = new Getopt_long (argc, argv, options_static);
 461   while (Long_option_init const *opt = (*option_parser) ())
 462     {
 463       switch (opt->shortname_char_)
 464         {
 465         case 0:
 466           if (string (opt->longname_str0_) == "dvi"
 467               || string (opt->longname_str0_) == "pdf"
 468               || string (opt->longname_str0_) == "png"
 469               || string (opt->longname_str0_) == "ps"
 470               || string (opt->longname_str0_) == "tex")
 471             add_output_format (opt->longname_str0_);
 472           else if (string (opt->longname_str0_) == "preview")
 473             make_preview = true;
 474           else if (string (opt->longname_str0_) == "no-pages")
 475             make_print = false;
 476           else if (string (opt->longname_str0_) == "relocate")
 477             relocate_binary = true;
 478           break;
 479
 480         case 'd':
 481           {
 482             string arg (option_parser->optional_argument_str0_);
 483             ssize eq = arg.find ('=');
 484
 485             string key = arg;
 486             string val = "#t";
 487
 488             if (eq != NPOS)
 489               {
 490                 key = arg.substr (0, eq);
 491                 val = arg.substr (eq + 1, arg.length () - 1);
 492               }
 493
 494             init_scheme_variables_global
 495               += "(cons \'" + key + "  " + val + ")\n";
 496           }
 497           break;
 498
 499         case 'v':
 500           notice ();
 501           exit (0);
 502           break;
 503         case 'o':
 504           {
 505             string s = option_parser->optional_argument_str0_;
 506             File_name file_name (s);
 507             output_name_global = file_name.to_string ();
 508           }
 509           break;
 510         case 'j':
 511           jail_spec = option_parser->optional_argument_str0_;
 512           break;
 513
 514         case 'e':
 515           init_scheme_code_global += option_parser->optional_argument_str0_ + string (" ");
 516           break;
 517         case 'w':
 518           warranty ();
 519           exit (0);
 520           break;
 521
 522         case 'b':
 523           output_backend_global = option_parser->optional_argument_str0_;
 524           break;
 525
 526         case 'f':
 527           {
 528             vector<string> components
 529               = string_split (option_parser->optional_argument_str0_, ',');
 530             for (vsize i = 0; i < components.size (); i++)
 531               add_output_format (components[i]);
 532           }
 533           break;
 534
 535         case 'H':
 536           dump_header_fieldnames_global
 537             .push_back (option_parser->optional_argument_str0_);
 538           break;
 539         case 'I':
 540           global_path.append (option_parser->optional_argument_str0_);
 541           break;
 542         case 'i':
 543           init_name_global = option_parser->optional_argument_str0_;
 544           break;
 545         case 'h':
 546           show_help = true;
 547           break;
 548         case 'V':
 549           be_verbose_global = true;
 550           break;
 551         case 'p':
 552           make_preview = true;
 553           break;
 554         default:
 555           programming_error (to_string ("unhandled short option: %c",
 556                                         opt->shortname_char_));
 557           assert (false);
 558           break;
 559         }
 560     }
 561
 562   if (output_format_global == "")
 563     output_format_global = "pdf";
 564
 565   if (show_help)
 566     {
 567       identify (stdout);
 568       ly_usage ();
 569       if (be_verbose_global)
 570         dir_info (stdout);
 571       exit (0);
 572     }
 573 }
 574
 575 void
 576 setup_guile_env ()
 577 {
 578   const char *yield = getenv ("LILYPOND_GC_YIELD");
 579   bool overwrite = true;
 580   if (!yield)
 581     {
 582       yield = "65";
 583       overwrite = false;
 584     }
 585
 586   sane_putenv ("GUILE_MIN_YIELD_1", yield, overwrite);
 587   sane_putenv ("GUILE_MIN_YIELD_2", yield, overwrite);
 588   sane_putenv ("GUILE_MIN_YIELD_MALLOC", yield, overwrite);
 589
 590
 591   sane_putenv ("GUILE_INIT_SEGMENT_SIZE_1",
 592                "10485760", overwrite);
 593   sane_putenv ("GUILE_MAX_SEGMENT_SIZE",
 594                "104857600", overwrite);
 595 }
 596
 597 int
 598 main (int argc, char **argv)
 599 {
 600   if (getenv ("LILYPOND_VERBOSE"))
 601     be_verbose_global = true;
 602
 603   setup_localisation ();
 604   parse_argv (argc, argv);
 605   if (isatty (STDIN_FILENO))
 606     identify (stderr);
 607
 608   setup_paths (argv[0]);
 609   setup_guile_env ();
 610
 611 #if 0
 612   /* Debugging aid.  */
 613   try
 614     {
 615       scm_boot_guile (argc, argv, main_with_guile, 0);
 616     }
 617   catch (exception e)
 618     {
 619       error (_f ("exception caught: %s", e.what ()));
 620     };
 621 #else
 622   scm_boot_guile (argc, argv, main_with_guile, 0);
 623 #endif
 624
 625   /* Only reachable if GUILE exits.  That is an error.  */
 626   return 1;
 627 }