lily/main.cc

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