lily/main.cc

   1 /*
   2   main.cc -- implement main: entrypoints
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include <stdlib.h>
  10 #include <stdio.h>
  11 #include <assert.h>
  12 #include <locale.h>
  13 #include <string.h>
  14
  15 #include "config.h"
  16
  17 #if HAVE_GETTEXT
  18 #include <libintl.h>
  19 #endif
  20
  21 #include "lily-guile.hh"
  22 #include "lily-version.hh"
  23 #include "all-font-metrics.hh"
  24 #include "getopt-long.hh"
  25 #include "misc.hh"
  26 #include "string.hh"
  27 #include "main.hh"
  28 #include "file-path.hh"
  29 #include "input-file-results.hh"
  30 #include "warn.hh"
  31 #include "lily-guile.hh"
  32 #include "paper-def.hh"
  33 #include "midi-def.hh"
  34 #include "global-ctor.hh"
  35 #include "kpath.hh"
  36
  37 static int sane_putenv (char const* key, char const* value, bool overwrite = false);
  38
  39 /*
  40   Global options that can be overridden through command line.
  41 */
  42
  43 /* Write dependencies file? */
  44 bool dependency_global_b = false;
  45
  46 /* Prepend to dependencies */
  47 String dependency_prefix_global;
  48
  49 /* Names of header fields to be dumped to a separate file. */
  50 Array<String> dump_header_fieldnames_global;
  51
  52 /* Name of initialisation file. */
  53 String init_name_global;
  54
  55 /* Do not calculate and write paper output? */
  56 bool no_paper_global_b = false;
  57
  58 /* Selected output format.
  59    One of tex, ps, scm, as. */
  60 String output_format_global = "tex";
  61
  62 /* Current output name. */
  63 String output_name_global;
  64
  65 /* Run in safe mode? -- FIXME: should be re-analised */
  66 bool safe_global_b = false;
  67
  68 /* Verbose progress indication? */
  69 bool verbose_global_b = false;
  70
  71 /* Scheme code to execute before parsing, after .scm init */
  72 String init_scheme_code_string = "(begin #t ";
  73
  74
  75 /*
  76   Misc. global stuff.
  77  */
  78
  79
  80 All_font_metrics *all_fonts_global;
  81 int exit_status_global;
  82 File_path global_path;
  83
  84 /* Number of current score output block.  If there's more than one
  85    score block, this counter will be added to the output filename. */
  86 int score_count_global;
  87
  88
  89
  90 /*
  91   File globals.
  92  */
  93
  94 /*  The option parser */
  95 static Getopt_long *oparser_p_static = 0;
  96
  97 /*
  98  Internationalisation kludge in two steps:
  99    * use _i () to get entry in POT file
 100    * call gettext () explicitely for actual "translation"
 101
 102  Note: these messages all start with lower case (ie, don't
 103        follow regular localisation guidelines).
 104  */
 105 static Long_option_init options_static[] = {
 106   {_i ("EXPR"), "evaluate", 'e',
 107    _i ("set options, use -e '(ly-option-usage)' for help")},
 108   /* another bug in option parser: --output=foe is taken as an abbreviation
 109      for --output-format */
 110   {_i ("EXT"), "format", 'f', _i ("use output format EXT")},
 111   {0, "help", 'h',  _i ("this help")},
 112   {_i ("FIELD"), "header", 'H',  _i ("write header field to BASENAME.FIELD")},
 113   {_i ("DIR"), "include", 'I',  _i ("add DIR to search path")},
 114   {_i ("FILE"), "init", 'i',  _i ("use FILE as init file")},
 115   {0, "dependencies", 'M',  _i ("write Makefile dependencies for every input file")},
 116   {0, "no-paper", 'm',  _i ("produce MIDI output only")},
 117   {_i ("FILE"), "output", 'o',  _i ("write output to FILE")},
 118   {_i ("DIR"), "dep-prefix", 'P',  _i ("prepend DIR to dependencies")},
 119 #if 0
 120   /*
 121     should audit again.
 122    */
 123   {0, "safe", 's',  _i ("inhibit file output naming and exporting")},
 124 #endif
 125   {0, "version", 'v',  _i ("print version number")},
 126   {0, "verbose", 'V', _i ("verbose")},
 127   {0, "warranty", 'w',  _i ("show warranty and copyright")},
 128   {0,0,0,0}
 129 };
 130
 131 void
 132 identify (FILE *out)
 133 {
 134   fputs (gnu_lilypond_version_string ().to_str0 (), out);
 135 }
 136
 137 void
 138 dirinfo (FILE *out)
 139 {
 140   fputs ("\n", out);
 141   fprintf (out, "lilypond_datadir: `%s'\n", LILYPOND_DATADIR);
 142   fprintf (out, "local_lilypond_datadir: `%s'\n", LOCAL_LILYPOND_DATADIR);
 143   fprintf (out, "localedir: `%s'\n", LOCALEDIR);
 144
 145   char *lilypond_prefix = getenv ("LILYPONDPREFIX");
 146   fprintf (out, "LILYPONDPREFIX: `%s'\n",
 147            (lilypond_prefix ? lilypond_prefix : ""));
 148 }
 149
 150 void
 151 usage ()
 152 {
 153   printf ("\n");
 154   /* No version number or newline here. It confuses help2man.  */
 155   printf (_f ("Usage: %s [OPTION]... FILE...", "lilypond").to_str0 ());
 156   printf ("\n\n");
 157   printf (_ ("Typeset music and or play MIDI from FILE").to_str0 ());
 158   printf ("\n\n");
 159   printf(_ (
 160 "LilyPond is a music typesetter.  It produces beautiful sheet music\n"
 161 "using a high level description file as input.  LilyPond is part of \n"
 162 "the GNU Project.\n"
 163 ).to_str0 ());
 164
 165   printf ("\n");
 166   printf (_ ("Options:").to_str0 ());
 167   printf ("\n");
 168   printf (Long_option_init::table_string (options_static).to_str0 ());
 169   printf ("\n");
 170   printf ("\n");
 171
 172   printf (_f ("Report bugs to %s", "bug-lilypond@gnu.org").to_str0 ());
 173   printf ("\n");
 174 }
 175
 176 void
 177 version ()
 178 {
 179   identify (stdout);
 180   printf ("\n");
 181   printf (_f (
 182   "This is free software.  It is covered by the GNU General Public License,\n"
 183   "and you are welcome to change it and/or distribute copies of it under\n"
 184   "certain conditions.  Invoke as `%s --warranty' for more information.\n",
 185     "lilypond").to_str0 ());
 186   printf ("\n");
 187
 188   printf (_f ("Copyright (c) %s by", "1996--2003").to_str0 ());
 189   printf ("\n");
 190   printf ("  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n");
 191   printf ("  Jan Nieuwenhuizen <janneke@gnu.org>\n");
 192 }
 193
 194 void
 195 notice ()
 196 {
 197   printf ("\n");
 198   printf (_ ("GNU LilyPond -- The music typesetter").to_str0 ());
 199   printf ("\n");
 200   printf (_f ("Copyright (c) %s by", "1996--2003").to_str0 ());
 201   printf ("\n");
 202   printf ("  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n");
 203   printf ("  Jan Nieuwenhuizen <janneke@gnu.org>\n");
 204   printf ("\n");
 205   printf ( _ (
 206              "    This program is free software; you can redistribute it and/or\n"
 207              "modify it under the terms of the GNU General Public License version 2\n"
 208              "as published by the Free Software Foundation.\n"
 209              "\n"
 210              "    This program is distributed in the hope that it will be useful,\n"
 211              "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
 212              "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
 213              "General Public License for more details.\n"
 214              "\n"
 215              "    You should have received a copy (refer to the file COPYING) of the\n"
 216              "GNU General Public License along with this program; if not, write to\n"
 217              "the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,\n"
 218              "USA.\n").to_str0 ());
 219 }
 220
 221
 222 /* Where LilyPond's init files live.  Typically:
 223    LILYPOND_DATADIR = /usr/local/share/lilypond
 224    LOCAL_LILYPOND_DATADIR = /usr/local/share/lilypond/1.5.68 */
 225 char const *prefix_directory[] = {LILYPOND_DATADIR, LOCAL_LILYPOND_DATADIR, 0};
 226
 227 void
 228 setup_paths ()
 229 {
 230   if (char const *lilypond_prefix = getenv ("LILYPONDPREFIX"))
 231     prefix_directory[1] = lilypond_prefix;
 232
 233 #if HAVE_GETTEXT
 234   /* Enable locales */
 235   setlocale (LC_ALL, "");
 236   /* Mustn't have commas in TeX output... */
 237   setlocale (LC_NUMERIC, "C");
 238   String lily_locale_dir;
 239   String name (PACKAGE);
 240   name.to_lower ();
 241   bindtextdomain (name.to_str0 (), LOCALEDIR);
 242   textdomain (name.to_str0 ());
 243 #endif
 244
 245   global_path.add ("");
 246
 247
 248   /* Adding mf/out make lilypond unchanged source directory, when setting
 249      LILYPONDPREFIX to lilypond-x.y.z */
 250   char *suffixes[] = {"ly", "afm", "mf/out", "scm", "tfm", "ps", 0};
 251
 252   for (unsigned i = 0; prefix_directory[i]; i++)
 253     for (char **s = suffixes; *s; s++)
 254       {
 255         String p = prefix_directory[i] + to_string ('/') + String (*s);
 256         global_path.prepend (p);
 257
 258 #if !KPATHSEA
 259         /* Urg: GNU make's $ (word) index starts at 1 */
 260         int i  = 1;
 261         while (global_path.try_add (p + to_string (".") + to_string (i)))
 262           i++;
 263 #endif
 264       }
 265   }
 266
 267 /**
 268   Make input file name from command argument.
 269
 270   Path describes file name with added default extension,
 271   ".ly" if none.  "-" is stdin.
 272  */
 273 Path
 274 distill_inname (String str)
 275 {
 276   Path p = split_path (str);
 277   if (str.empty_b () || str == "-")
 278     p.base = "-";
 279   else
 280     {
 281       String orig_ext = p.ext;
 282       char const *extensions[] = {"ly", "", 0};
 283       for (int i = 0; extensions[i]; i++)
 284         {
 285           p.ext = orig_ext;
 286           if (*extensions[i] && !p.ext.empty_b ())
 287             p.ext += ".";
 288           p.ext += extensions[i];
 289           if (!global_path.find (p.to_string ()).empty_b ())
 290               break;
 291         }
 292       /* Reshuffle extension */
 293       p = split_path (p.to_string ());
 294     }
 295   return p;
 296 }
 297
 298 String
 299 format_to_ext (String format)
 300 {
 301   if (format == "tex")
 302     /* .lytex change put off */
 303     return "tex"; // "lytex";
 304   return format;
 305 }
 306
 307 void
 308 prepend_load_path (String dir)
 309 {
 310   String s = "(set! %load-path (cons \""
 311     + dir
 312     + "\" %load-path))";
 313   scm_c_eval_string (s.to_str0 ());
 314 }
 315
 316 void
 317 main_prog (void *, int, char **)
 318 {
 319   /* Engravers use lily.scm contents, need to make Guile find it.
 320      Prepend onto GUILE %load-path, very ugh. */
 321
 322   for (unsigned i = 0; prefix_directory[i]; i++)
 323     {
 324       prepend_load_path (prefix_directory[i]);
 325
 326       /* Junk this.  We should make real modules iso. just loading files. */
 327       prepend_load_path (String (prefix_directory[i]) + "/scm");
 328     }
 329
 330   if (verbose_global_b)
 331     dirinfo (stderr);
 332
 333   ly_init_guile ();
 334   call_constructors ();
 335
 336   progress_indication ("\n");
 337
 338   all_fonts_global = new All_font_metrics (global_path.to_string ());
 339
 340   init_scheme_code_string += ")";
 341   gh_eval_str ((char *)init_scheme_code_string.to_str0 ());
 342
 343   int p=0;
 344   const char *arg  = oparser_p_static->get_next_arg ();
 345
 346   /* Only exit until after running init_scheme_code, for
 347      (ly-option-usage) or
 348      -e "(ly-set-option 'help #t)" */
 349   if (!arg)
 350     {
 351       usage ();
 352       /* No FILE arguments is now a usage error */
 353       exit (2);
 354     }
 355
 356   do
 357     {
 358       String infile (arg);
 359       Midi_def::reset_score_count ();
 360       Paper_def::reset_score_count ();
 361
 362       Path inpath = distill_inname (infile);
 363
 364       /* By default, use base name of input file for output file name */
 365       Path outpath = inpath;
 366       if (inpath.to_string () != "-")
 367         outpath.ext = format_to_ext (output_format_global);
 368
 369       /* By default, write output to cwd; do not copy directory part
 370          of input file name */
 371       outpath.root = "";
 372       outpath.dir = "";
 373
 374       if (!output_name_global.empty_b ())
 375         outpath = split_path (output_name_global);
 376
 377       String init;
 378       if (!init_name_global.empty_b ())
 379         init = init_name_global;
 380       else
 381         init = "init.ly";
 382
 383       /* Burp: output name communication goes through _global */
 384       String save_output_name_global = output_name_global;
 385       output_name_global = outpath.to_string ();
 386       do_one_file (init, inpath.to_string ());
 387       output_name_global = save_output_name_global;
 388
 389       p++;
 390     } while ((arg  = oparser_p_static->get_next_arg ()));
 391   delete oparser_p_static;
 392   oparser_p_static = 0;
 393   exit (exit_status_global);
 394 }
 395
 396
 397 static int
 398 sane_putenv (char const* key, char const* value, bool overwrite)
 399 {
 400   if (overwrite || !getenv (key))
 401     {
 402       String combine = String (key) + "=" + String (value);
 403       char * s = strdup(combine.to_str0 ());
 404       return putenv (s);
 405     }
 406   return -1;
 407 }
 408
 409 int
 410 main (int argc, char **argv)
 411 {
 412   setup_paths ();
 413
 414   /*
 415
 416     These settings hopefully prepare lily for a lot of memory usage.
 417
 418     In practice the effect on GC times is barely measurable -- larger
 419     segments cost slighly less time for the conservative marking. (but
 420     not impressively much)
 421
 422   */
 423   sane_putenv ("GUILE_INIT_SEGMENT_SIZE_1", "4194304", false);
 424   sane_putenv ("GUILE_MAX_SEGMENT_SIZE", "8388608", false);
 425
 426   ly_init_kpath (argv[0]);
 427
 428   bool help_b = false;
 429   oparser_p_static = new Getopt_long (argc, argv, options_static);
 430   while (Long_option_init const * opt = (*oparser_p_static) ())
 431     {
 432       switch (opt->shortname_char_)
 433         {
 434         case 'v':
 435           version ();
 436           exit (0);             // we print a version anyway.
 437           break;
 438         case 'o':
 439           {
 440             String s = oparser_p_static->optional_argument_str0_;
 441             Path p = split_path (s);
 442             if (s != "-" && p.ext.empty_b ())
 443               p.ext = format_to_ext (output_format_global);
 444             output_name_global = p.to_string ();
 445           }
 446           break;
 447         case 'e':
 448           init_scheme_code_string +=
 449             oparser_p_static->optional_argument_str0_;
 450           break;
 451         case 'w':
 452           notice ();
 453           exit (0);
 454           break;
 455         case 'f':
 456           if (oparser_p_static->optional_argument_str0_ == "help")
 457             {
 458               printf("See http://lilypond.org/wiki?OutputFormats for more information.\n"\
 459                      "This option is for developers only.\n");
 460               exit (0);
 461             }
 462           output_format_global = oparser_p_static->optional_argument_str0_;
 463           break;
 464         case 'P':
 465             dependency_prefix_global = oparser_p_static->optional_argument_str0_;
 466           break;
 467         case 'H':
 468           dump_header_fieldnames_global.push (oparser_p_static->optional_argument_str0_);
 469           break;
 470         case 'I':
 471           global_path.push (oparser_p_static->optional_argument_str0_);
 472           break;
 473         case 'i':
 474           init_name_global = oparser_p_static->optional_argument_str0_;
 475           break;
 476         case 'h':
 477           help_b = true;
 478           break;
 479         case 'V':
 480           verbose_global_b = true;
 481           break;
 482         case 's':
 483           safe_global_b = true;
 484           break;
 485         case 'M':
 486           dependency_global_b = true;
 487           break;
 488         case 'm':
 489           no_paper_global_b = true;
 490           break;
 491         default:
 492           assert (false);
 493           break;
 494         }
 495     }
 496   identify (stderr);
 497
 498   if (help_b)
 499     {
 500       usage ();
 501       if (verbose_global_b)
 502         dirinfo (stdout);
 503       exit (0);
 504     }
 505
 506   scm_boot_guile (argc, argv, (void (*) (void*, int, char**))main_prog, 0);
 507
 508   return 0;                     // unreachable
 509 }