lily/main.cc

   1 /*
   2   main.cc -- implement main () entrypoint.
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 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_string;
  81 string init_scheme_variables;
  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 prefix_directory;
 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, "safe-mode", 's',  _i ("disallow unsafe Scheme and PostScript\n"
 182                              "operations")},
 183   {0, "version", 'v',  _i ("show version number and exit")},
 184   {0, "verbose", 'V', _i ("be verbose")},
 185   {0, "warranty", 'w',  _i ("show warranty and copyright")},
 186   {0, 0, 0, 0}
 187 };
 188
 189 char const *LILYPOND_DATADIR = PACKAGE_DATADIR "/" TOPLEVEL_VERSION;
 190
 191 static void
 192 env_var_info (FILE *out, char const *key)
 193 {
 194   if (char const *value = getenv (key))
 195     fprintf (out, "%s=\"%s\"\n", key, value);
 196 }
 197
 198 static void
 199 dir_info (FILE *out)
 200 {
 201   fputs ("\n", out);
 202   fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
 203   env_var_info (out, "LILYPONDPREFIX");
 204   fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
 205
 206   fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.c_str ());
 207
 208   if (relocate_binary)
 209     {
 210       env_var_info (out, "FONTCONFIG_FILE");
 211       env_var_info (out, "FONTCONFIG_PATH");
 212       env_var_info (out, "GS_FONTPATH");
 213       env_var_info (out, "GS_LIB");
 214       env_var_info (out, "GUILE_LOAD_PATH");
 215       env_var_info (out, "PANGO_RC_FILE");
 216       env_var_info (out, "PANGO_PREFIX");
 217       env_var_info (out, "PATH");
 218     }
 219 }
 220
 221 static void
 222 copyright ()
 223 {
 224   printf (_f ("Copyright (c) %s by\n%s  and others.",
 225               "1996--2006",
 226               AUTHORS).c_str ());
 227   printf ("\n");
 228 }
 229
 230 static void
 231 identify (FILE *out)
 232 {
 233   fputs (gnu_lilypond_version_string ().c_str (), out);
 234   fputs ("\n", out);
 235 }
 236
 237 static void
 238 notice ()
 239 {
 240   identify (stdout);
 241   puts (_f (NOTICE, PROGRAM_NAME).c_str ());
 242   printf ("\n");
 243   copyright ();
 244 }
 245
 246 LY_DEFINE (ly_usage, "ly:usage",
 247            0, 0, 0, (),
 248            "Print usage message.")
 249 {
 250   /* No version number or newline here.  It confuses help2man.  */
 251   printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).c_str ());
 252   printf ("\n\n");
 253   printf (_ ("Typeset music and/or produce MIDI from FILE.").c_str ());
 254   printf ("\n\n");
 255   printf (_ ("LilyPond produces beautiful music notation.").c_str ());
 256   printf ("\n");
 257   printf (_f ("For more information, see %s", PROGRAM_URL).c_str ());
 258   printf ("\n\n");
 259   printf (_ ("Options:").c_str ());
 260   printf ("\n");
 261   printf (Long_option_init::table_string (options_static).c_str ());
 262   printf ("\n");
 263   printf (_f ("Report bugs via %s",
 264               "http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs"
 265               ).c_str ());
 266   printf ("\n");
 267   printf ("\n");
 268   return SCM_UNSPECIFIED;
 269 }
 270
 271 static void
 272 warranty ()
 273 {
 274   identify (stdout);
 275   printf ("\n");
 276   copyright ();
 277   printf ("\n");
 278   printf (_ (WARRANTY).c_str ());
 279 }
 280
 281 static void
 282 prepend_load_path (string dir)
 283 {
 284   string s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
 285   scm_c_eval_string (s.c_str ());
 286 }
 287
 288 void init_global_tweak_registry ();
 289 void init_fontconfig ();
 290
 291 #if HAVE_CHROOT
 292 static void
 293 do_chroot_jail ()
 294 {
 295   /* Now we chroot, setuid/setgrp and chdir.  If something goes wrong,
 296      we exit (this is a security-sensitive area).  First we split
 297      jail_spec into its components, then we retrieve the user/group id
 298      (necessarily *before* chroot'ing) and finally we perform the
 299      actual actions.  */
 300
 301   enum Jail
 302     {
 303       USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
 304     };
 305
 306   vector<string> components = string_split (jail_spec, ',');
 307   if (components.size () != JAIL_MAX)
 308     {
 309       error (_f ("expected %d arguments with jail, found: %u", JAIL_MAX,
 310                  (unsigned) components.size ()));
 311       exit (2);
 312     }
 313
 314   /* Hmm.  */
 315   errno = 0;
 316
 317   int uid;
 318   if (passwd * passwd = getpwnam (components[USER_NAME].c_str ()))
 319     uid = passwd->pw_uid;
 320   else
 321     {
 322       if (errno == 0)
 323         error (_f ("no such user: %s", components[USER_NAME]));
 324       else
 325         error (_f ("cannot get user id from user name: %s: %s",
 326                    components[USER_NAME],
 327                    strerror (errno)));
 328       exit (3);
 329     }
 330
 331   /* Hmm.  */
 332   errno = 0;
 333
 334   int gid;
 335   if (group * group = getgrnam (components[GROUP_NAME].c_str ()))
 336     gid = group->gr_gid;
 337   else
 338     {
 339       if (errno == 0)
 340         error (_f ("no such group: %s", components[GROUP_NAME]));
 341       else
 342         error (_f ("cannot get group id from group name: %s: %s",
 343                    components[GROUP_NAME],
 344                    strerror (errno)));
 345       exit (3);
 346     }
 347
 348   if (chroot (components[JAIL].c_str ()))
 349     {
 350       error (_f ("cannot chroot to: %s: %s", components[JAIL],
 351                  strerror (errno)));
 352       exit (3);
 353     }
 354
 355   if (setgid (gid))
 356     {
 357       error (_f ("cannot change group id to: %d: %s", gid, strerror (errno)));
 358       exit (3);
 359     }
 360
 361   if (setuid (uid))
 362     {
 363       error (_f ("cannot change user id to: %d: %s", uid, strerror (errno)));
 364       exit (3);
 365     }
 366
 367   if (chdir (components[DIR].c_str ()))
 368     {
 369       error (_f ("cannot change working directory to: %s: %s", components[DIR],
 370                  strerror (errno)));
 371       exit (3);
 372     }
 373 }
 374 #endif
 375
 376 static void
 377 main_with_guile (void *, int, char **)
 378 {
 379   /* Engravers use lily.scm contents, need to make Guile find it.
 380      Prepend onto GUILE %load-path, very ugh. */
 381
 382   prepend_load_path (prefix_directory);
 383   prepend_load_path (prefix_directory + "/scm");
 384
 385   if (be_verbose_global)
 386     dir_info (stderr);
 387   is_TeX_format_global = (output_backend_global == "tex"
 388                           || output_backend_global == "texstr");
 389
 390   is_pango_format_global = !is_TeX_format_global;
 391
 392   ly_c_init_guile ();
 393   call_constructors ();
 394   init_global_tweak_registry ();
 395   init_fontconfig ();
 396
 397   init_freetype ();
 398   ly_reset_all_fonts ();
 399
 400   if (!init_scheme_variables.empty ()
 401       || !init_scheme_code_string.empty ())
 402     {
 403       init_scheme_variables = "(map (lambda (x) (ly:set-option (car x) (cdr x))) (list "
 404         + init_scheme_variables + "))";
 405
 406       init_scheme_code_string
 407         = "(begin #t "
 408         + init_scheme_variables
 409         + init_scheme_code_string
 410         + ")";
 411
 412       char const *str0 = init_scheme_code_string.c_str ();
 413
 414       if (be_verbose_global)
 415         progress_indication (_f ("Evaluating %s", str0));
 416       scm_c_eval_string ((char *) str0);
 417     }
 418
 419   /* We accept multiple independent music files on the command line to
 420      reduce compile time when processing lots of small files.
 421      Starting the GUILE engine is very time consuming.  */
 422
 423   SCM files = SCM_EOL;
 424   SCM *tail = &files;
 425   while (char const *arg = option_parser->get_next_arg ())
 426     {
 427       *tail = scm_cons (scm_from_locale_string (arg), SCM_EOL);
 428       tail = SCM_CDRLOC (*tail);
 429     }
 430
 431   delete option_parser;
 432   option_parser = 0;
 433
 434 #if HAVE_CHROOT
 435   if (!jail_spec.empty ())
 436     do_chroot_jail ();
 437 #endif
 438
 439   SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
 440   (void) result;
 441
 442   /* Unreachable.  */
 443   exit (0);
 444 }
 445
 446 static void
 447 setup_localisation ()
 448 {
 449 #if HAVE_GETTEXT
 450   /* Enable locales */
 451   setlocale (LC_ALL, "");
 452
 453   /* FIXME: check if this is still true.
 454      Disable localisation of float values.  This breaks TeX output.  */
 455   setlocale (LC_NUMERIC, "C");
 456
 457   string localedir = LOCALEDIR;
 458   if (char const *env = getenv ("LILYPOND_LOCALEDIR"))
 459     localedir = env;
 460
 461   bindtextdomain ("lilypond", localedir.c_str ());
 462   textdomain ("lilypond");
 463 #endif
 464 }
 465
 466 static void
 467 add_output_format (string format)
 468 {
 469   if (output_format_global != "")
 470     output_format_global += ",";
 471   output_format_global += format;
 472 }
 473
 474 static void
 475 parse_argv (int argc, char **argv)
 476 {
 477   bool show_help = false;
 478   option_parser = new Getopt_long (argc, argv, options_static);
 479   while (Long_option_init const *opt = (*option_parser) ())
 480     {
 481       switch (opt->shortname_char_)
 482         {
 483         case 0:
 484           if (string (opt->longname_str0_) == "dvi"
 485               || string (opt->longname_str0_) == "pdf"
 486               || string (opt->longname_str0_) == "png"
 487               || string (opt->longname_str0_) == "ps"
 488               || string (opt->longname_str0_) == "tex")
 489             add_output_format (opt->longname_str0_);
 490           else if (string (opt->longname_str0_) == "preview")
 491             make_preview = true;
 492           else if (string (opt->longname_str0_) == "no-pages")
 493             make_print = false;
 494           else if (string (opt->longname_str0_) == "relocate")
 495             relocate_binary = true;
 496           break;
 497
 498         case 'd':
 499           {
 500             string arg (option_parser->optional_argument_str0_);
 501             ssize eq = arg.find ('=');
 502
 503             string key = arg;
 504             string val = "#t";
 505
 506             if (eq != NPOS)
 507               {
 508                 key = arg.substr (0, eq);
 509                 val = arg.substr (eq + 1, key.length () - 1);
 510               }
 511
 512             init_scheme_variables
 513               += "(cons \'" + key + "  " + val + ")\n";
 514           }
 515           break;
 516
 517         case 'v':
 518           notice ();
 519           exit (0);
 520           break;
 521         case 'o':
 522           {
 523             string s = option_parser->optional_argument_str0_;
 524             File_name file_name (s);
 525             output_name_global = file_name.to_string ();
 526           }
 527           break;
 528         case 'j':
 529           jail_spec = option_parser->optional_argument_str0_;
 530           break;
 531         case 'e':
 532           init_scheme_code_string += option_parser->optional_argument_str0_;
 533           break;
 534         case 'w':
 535           warranty ();
 536           exit (0);
 537           break;
 538
 539         case 'b':
 540           output_backend_global = option_parser->optional_argument_str0_;
 541           break;
 542
 543         case 'f':
 544           {
 545             vector<string> components
 546               = string_split (option_parser->optional_argument_str0_, ',');
 547             for (vsize i = 0; i < components.size (); i++)
 548               add_output_format (components[i]);
 549           }
 550           break;
 551
 552         case 'H':
 553           dump_header_fieldnames_global
 554             .push_back (option_parser->optional_argument_str0_);
 555           break;
 556         case 'I':
 557           global_path.append (option_parser->optional_argument_str0_);
 558           break;
 559         case 'i':
 560           init_name_global = option_parser->optional_argument_str0_;
 561           break;
 562         case 'h':
 563           show_help = true;
 564           break;
 565         case 'V':
 566           be_verbose_global = true;
 567           break;
 568         case 's':
 569           init_scheme_variables
 570             += "(cons \'safe #t)\n";
 571           break;
 572         case 'p':
 573           make_preview = true;
 574           break;
 575         default:
 576           programming_error (to_string ("unhandled short option: %c",
 577                                         opt->shortname_char_));
 578           assert (false);
 579           break;
 580         }
 581     }
 582
 583   if (output_format_global == "")
 584     output_format_global = "pdf";
 585
 586   if (show_help)
 587     {
 588       identify (stdout);
 589       ly_usage ();
 590       if (be_verbose_global)
 591         dir_info (stdout);
 592       exit (0);
 593     }
 594 }
 595
 596 void
 597 setup_guile_env ()
 598 {
 599   const char *yield = getenv ("LILYPOND_GC_YIELD");
 600   bool overwrite = true;
 601   if (!yield)
 602     {
 603       yield = "65";
 604       overwrite = false;
 605     }
 606
 607   sane_putenv ("GUILE_MIN_YIELD_1", yield, overwrite);
 608   sane_putenv ("GUILE_MIN_YIELD_2", yield, overwrite);
 609   sane_putenv ("GUILE_MIN_YIELD_MALLOC", yield, overwrite);
 610
 611
 612   sane_putenv ("GUILE_INIT_SEGMENT_SIZE_1",
 613                "10485760", overwrite);
 614   sane_putenv ("GUILE_MAX_SEGMENT_SIZE",
 615                "104857600", overwrite);
 616 }
 617
 618 void
 619 read_relocation_dir (string);
 620
 621 int
 622 main (int argc, char **argv)
 623 {
 624   if (getenv ("LILYPOND_VERBOSE"))
 625     be_verbose_global = true;
 626
 627   setup_localisation ();
 628   parse_argv (argc, argv);
 629   if (isatty (STDIN_FILENO))
 630     identify (stderr);
 631
 632   setup_paths (argv[0]);
 633   setup_guile_env ();
 634
 635 #if 0
 636   /* Debugging aid.  */
 637   try
 638     {
 639       scm_boot_guile (argc, argv, main_with_guile, 0);
 640     }
 641   catch (exception e)
 642     {
 643       error (_f ("exception caught: %s", e.what ()));
 644     };
 645 #else
 646   scm_boot_guile (argc, argv, main_with_guile, 0);
 647 #endif
 648
 649   /* Only reachable if GUILE exits.  That is an error.  */
 650   return 1;
 651 }