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 prepend_env_path (char const *key, String value)
 274 {
 275   if (char const* cur = getenv (key))
 276     value += to_string (PATHSEP) + cur;
 277   return sane_putenv (key, value.to_str0 ());
 278 }
 279
 280 String
 281 dir_name (String const file_name)
 282 {
 283   String s = file_name;
 284   s.substitute ('\\', '/');
 285   s = s.left_string (s.index_last ('/'));
 286   return s;
 287 }
 288 #endif
 289
 290 #ifdef __MINGW32__
 291 #  include <winbase.h>
 292 #endif
 293
 294 static void
 295 setup_paths (char const* argv0)
 296 {
 297   prefix_directory = LILYPOND_DATADIR;
 298
 299 #if ARGV0_RELOCATION
 300   String bindir = dir_name (argv0);
 301   String argv0_prefix = dir_name (bindir);
 302   if (argv0_prefix != dir_name (dir_name (dir_name (prefix_directory))))
 303     {
 304 #if 0
 305       warning (_f ("argv0 relocation: argv0=%s, prefix=%s", argv0,
 306                    prefix_directory));
 307 #endif
 308       String datadir = argv0_prefix + "/share";
 309       String libdir = argv0_prefix + "/lib";
 310       String sysconfdir = argv0_prefix + "/etc";
 311       prefix_directory = datadir + "/lilypond/" TOPLEVEL_VERSION;
 312
 313       sane_putenv ("FONTCONFIG_FILE", sysconfdir + "/fonts/fonts.conf", false);
 314 #ifdef __MINGW32__
 315       char font_dir[PATH_MAX];
 316       ExpandEnvironmentStrings ("%windir%/fonts", font_dir, sizeof (font_dir));
 317       prepend_env_path ("GS_FONTPATH", font_dir);
 318 #endif
 319       prepend_env_path ("GS_FONTPATH", datadir + "/gs/fonts");
 320       prepend_env_path ("GS_LIB", datadir + "/gs/Resource");
 321       prepend_env_path ("GS_LIB", datadir + "/gs/lib");
 322       prepend_env_path ("GUILE_LOAD_PATH", datadir
 323                         + to_string ("/guile/%d.%d",
 324                                      SCM_MAJOR_VERSION, SCM_MINOR_VERSION));
 325       sane_putenv ("PANGO_RC_FILE", sysconfdir + "/pango/pangorc", false);
 326       prepend_env_path ("PATH", bindir);
 327     }
 328 #else
 329   (void) argv0;
 330 #endif /* ARGV0_RELOCATION */
 331
 332   if (char const *env = getenv ("LILYPONDPREFIX"))
 333     {
 334 #ifdef __MINGW32__
 335       /* Normalize file name.  */
 336       env = File_name (env).to_string ().get_copy_str0 ();
 337 #endif
 338       prefix_directory = env;
 339     }
 340
 341   global_path.append ("");
 342
 343   /* Adding mf/out make lilypond unchanged source directory, when setting
 344      LILYPONDPREFIX to lilypond-x.y.z */
 345   char *suffixes[] = {"ly", "ps", "scm", 0 };
 346
 347   Array<String> dirs;
 348   for (char **s = suffixes; *s; s++)
 349     {
 350       String path = prefix_directory + to_string ('/') + String (*s);
 351       dirs.push (path);
 352     }
 353
 354   /*
 355     ugh. C&P font-config.cc
 356   */
 357   struct stat statbuf;
 358   String builddir = prefix_directory + "/mf/out/";
 359   if (stat (builddir.to_str0 (), &statbuf) == 0)
 360     {
 361       dirs.push (builddir.to_str0 ());
 362     }
 363   else
 364     {
 365       dirs.push (prefix_directory + "/fonts/otf/");
 366       dirs.push (prefix_directory + "/fonts/type1/");
 367       dirs.push (prefix_directory + "/fonts/cff/");
 368       dirs.push (prefix_directory + "/fonts/svg/");
 369       dirs.push (prefix_directory + "/fonts/cff/");
 370     }
 371
 372   for (int i = 0; i < dirs.size (); i++)
 373     global_path.prepend (dirs[i]);
 374 }
 375
 376 static void
 377 prepend_load_path (String dir)
 378 {
 379   String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
 380   scm_c_eval_string (s.to_str0 ());
 381 }
 382
 383 void init_global_tweak_registry ();
 384 void init_fontconfig ();
 385
 386 #if HAVE_CHROOT
 387 static void
 388 do_chroot_jail ()
 389 {
 390   /* Now we chroot, setuid/setgrp and chdir.  If something goes wrong,
 391      we exit (this is a security-sensitive area).  First we split
 392      jail_spec into its components, then we retrieve the user/group id
 393      (necessarily *before* chroot'ing) and finally we perform the
 394      actual actions.  */
 395
 396   enum Jail
 397     {
 398       USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
 399     };
 400
 401   Array<String> components = String_convert::split (jail_spec, ',');
 402   if (components.size () != JAIL_MAX)
 403     {
 404       error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
 405                  components.size ()));
 406       exit (2);
 407     }
 408
 409   /* Hmm.  */
 410   errno = 0;
 411
 412   int uid;
 413   if (passwd * passwd = getpwnam (components[USER_NAME].to_str0 ()))
 414     uid = passwd->pw_uid;
 415   else
 416     {
 417       if (errno == 0)
 418         error (_f ("no such user: %s", components[USER_NAME]));
 419       else
 420         error (_f ("can't get user id from user name: %s: %s",
 421                    components[USER_NAME],
 422                    strerror (errno)));
 423       exit (3);
 424     }
 425
 426   /* Hmm.  */
 427   errno = 0;
 428
 429   int gid;
 430   if (group * group = getgrnam (components[GROUP_NAME].to_str0 ()))
 431     gid = group->gr_gid;
 432   else
 433     {
 434       if (errno == 0)
 435         error (_f ("no such group: %s", components[GROUP_NAME]));
 436       else
 437         error (_f ("can't get group id from group name: %s: %s",
 438                    components[GROUP_NAME],
 439                    strerror (errno)));
 440       exit (3);
 441     }
 442
 443   if (chroot (components[JAIL].to_str0 ()))
 444     {
 445       error (_f ("can't chroot to: %s: %s", components[JAIL],
 446                  strerror (errno)));
 447       exit (3);
 448     }
 449
 450   if (setgid (gid))
 451     {
 452       error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
 453       exit (3);
 454     }
 455
 456   if (setuid (uid))
 457     {
 458       error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
 459       exit (3);
 460     }
 461
 462   if (chdir (components[DIR].to_str0 ()))
 463     {
 464       error (_f ("can't change working directory to: %s: %s", components[DIR],
 465                  strerror (errno)));
 466       exit (3);
 467     }
 468 }
 469 #endif
 470
 471
 472
 473 static void
 474 main_with_guile (void *, int, char **)
 475 {
 476   /* Engravers use lily.scm contents, need to make Guile find it.
 477      Prepend onto GUILE %load-path, very ugh. */
 478
 479   prepend_load_path (prefix_directory);
 480   prepend_load_path (prefix_directory + "/scm");
 481
 482   if (be_verbose_global)
 483     dir_info (stderr);
 484   is_TeX_format_global = (output_backend_global == "tex"
 485                           || output_backend_global == "texstr");
 486
 487   is_pango_format_global = !is_TeX_format_global;
 488
 489   ly_c_init_guile ();
 490   call_constructors ();
 491   init_global_tweak_registry ();
 492   init_fontconfig ();
 493
 494   init_freetype ();
 495
 496   all_fonts_global = new All_font_metrics (global_path.to_string ());
 497
 498
 499   if (!init_scheme_variables.is_empty ()
 500       || !init_scheme_code_string.is_empty ())
 501     {
 502       init_scheme_variables = "(ly:set-option 'command-line-settings (list "
 503         + init_scheme_variables + "))";
 504
 505       init_scheme_code_string
 506         += "(begin #t "
 507         + init_scheme_variables
 508         + init_scheme_code_string
 509         + ")";
 510
 511       char const *str0 = init_scheme_code_string.to_str0 ();
 512
 513       if (be_verbose_global)
 514         progress_indication (_f("Evaluating %s", str0));
 515       scm_c_eval_string ((char *) str0);
 516     }
 517
 518
 519   /* We accept multiple independent music files on the command line to
 520      reduce compile time when processing lots of small files.
 521      Starting the GUILE engine is very time consuming.  */
 522
 523   SCM files = SCM_EOL;
 524   SCM *tail = &files;
 525   while (char const *arg = option_parser->get_next_arg ())
 526     {
 527       *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
 528       tail = SCM_CDRLOC (*tail);
 529     }
 530   delete option_parser;
 531   option_parser = 0;
 532
 533 #if HAVE_CHROOT
 534   if (!jail_spec.is_empty ())
 535     do_chroot_jail ();
 536 #endif
 537
 538   SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
 539   (void) result;
 540
 541   /* Unreachable.  */
 542   exit (0);
 543 }
 544
 545 static void
 546 setup_localisation ()
 547 {
 548 #if HAVE_GETTEXT
 549   /* Enable locales */
 550   setlocale (LC_ALL, "");
 551
 552   /* FIXME: check if this is still true.
 553      Disable localisation of float values.  This breaks TeX output.  */
 554   setlocale (LC_NUMERIC, "C");
 555
 556   String name (PACKAGE);
 557   name.to_lower ();
 558   bindtextdomain (name.to_str0 (), LOCALEDIR);
 559   textdomain (name.to_str0 ());
 560 #endif
 561 }
 562
 563 static void
 564 add_output_format (String format)
 565 {
 566   if (output_format_global != "")
 567     output_format_global += ",";
 568   output_format_global += format;
 569 }
 570
 571 static void
 572 parse_argv (int argc, char **argv)
 573 {
 574   bool show_help = false;
 575   option_parser = new Getopt_long (argc, argv, options_static);
 576   while (Long_option_init const *opt = (*option_parser) ())
 577     {
 578       switch (opt->shortname_char_)
 579         {
 580         case 0:
 581           if (String (opt->longname_str0_) == "dvi"
 582               || String (opt->longname_str0_) == "pdf"
 583               || String (opt->longname_str0_) == "png"
 584               || String (opt->longname_str0_) == "ps"
 585               || String (opt->longname_str0_) == "tex")
 586             add_output_format (opt->longname_str0_);
 587           else if (String (opt->longname_str0_) == "preview")
 588             make_preview = true;
 589           else if (String (opt->longname_str0_) == "no-pages")
 590             make_print = false;
 591           break;
 592
 593         case 'd':
 594           {
 595             String arg (option_parser->optional_argument_str0_);
 596             int eq = arg.index ('=');
 597
 598             String key = arg;
 599             String val = "#t";
 600
 601             if (eq >= 0)
 602               {
 603                 key = arg.left_string (eq);
 604                 val = arg.right_string (arg.length () - eq - 1);
 605               }
 606
 607             init_scheme_variables
 608               += "(cons \'" + key  + "  " + val + ")\n";
 609           }
 610           break;
 611
 612         case 'v':
 613           notice ();
 614           exit (0);
 615           break;
 616         case 'o':
 617           {
 618             String s = option_parser->optional_argument_str0_;
 619             File_name file_name (s);
 620             output_name_global = file_name.to_string ();
 621           }
 622           break;
 623         case 'j':
 624           jail_spec = option_parser->optional_argument_str0_;
 625           break;
 626         case 'e':
 627           init_scheme_code_string += option_parser->optional_argument_str0_;
 628           break;
 629         case 'w':
 630           warranty ();
 631           exit (0);
 632           break;
 633
 634         case 'b':
 635           output_backend_global = option_parser->optional_argument_str0_;
 636           break;
 637
 638         case 'f':
 639           output_format_global = option_parser->optional_argument_str0_;
 640           break;
 641
 642         case 'H':
 643           dump_header_fieldnames_global
 644             .push (option_parser->optional_argument_str0_);
 645           break;
 646         case 'I':
 647           global_path.append (option_parser->optional_argument_str0_);
 648           break;
 649         case 'i':
 650           init_name_global = option_parser->optional_argument_str0_;
 651           break;
 652         case 'h':
 653           show_help = true;
 654           break;
 655         case 'V':
 656           be_verbose_global = true;
 657           break;
 658         case 's':
 659           be_safe_global = true;
 660           break;
 661         case 'p':
 662           make_preview = true;
 663           break;
 664         default:
 665           programming_error (to_string ("unhandled short option: %c",
 666                                         opt->shortname_char_));
 667           assert (false);
 668           break;
 669         }
 670     }
 671
 672   if (show_help)
 673     {
 674       identify (stdout);
 675       ly_usage ();
 676       if (be_verbose_global)
 677         dir_info (stdout);
 678       exit (0);
 679     }
 680 }
 681
 682 int
 683 main (int argc, char **argv)
 684 {
 685   setup_localisation ();
 686   setup_paths (argv[0]);
 687   parse_argv (argc, argv);
 688   if (isatty (STDIN_FILENO))
 689     identify (stderr);
 690
 691   scm_boot_guile (argc, argv, main_with_guile, 0);
 692
 693   /* Only reachable if GUILE exits.  That is an error.  */
 694   return 1;
 695 }