lily/main.cc

   1 /*
   2   main.cc -- implement main: entrypoints
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2002 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 #include <stdio.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 "file-results.hh"
  30 #include "debug.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_p;
  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   /* print example usage:  lilypond -e "(set-lily-option 'help 0)" ? */
 107   {_i ("EXPR"), "evaluate", 'e',_i ("evalute EXPR as Scheme after .scm init is read")},
 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 (tex [default], pdftex, ps, scm or as)")},
 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   {0, "safe", 's',  _i ("inhibit file output naming and exporting")},
 120   {0, "version", 'v',  _i ("print version number")},
 121   {0, "verbose", 'V', _i ("verbose")},
 122   {0, "warranty", 'w',  _i ("show warranty and copyright")},
 123   {0,0,0,0}
 124 };
 125
 126 void
 127 identify (ostream* os)
 128 {
 129   *os << gnu_lilypond_version_str ();
 130 }
 131
 132 void
 133 usage ()
 134 {
 135
 136   /*
 137     No version number or newline here. It confuses help2man
 138    */
 139   cout << _f ("Usage: %s [OPTION]... FILE...", "lilypond");
 140   cout << "\n\n";
 141   cout << _ ("Typeset music and or play MIDI from FILE");
 142   cout << "\n\n";
 143   cout <<
 144 _ (
 145 "LilyPond is a music typesetter.  It produces beautiful sheet music\n"
 146 "using a high level description file as input.  LilyPond is part of \n"
 147 "the GNU Project.\n"
 148 );
 149
 150   cout << '\n';
 151   cout << _ ("Options:");
 152   cout << '\n';
 153   cout << Long_option_init::table_str (options_static);
 154   cout << '\n';
 155   cout << _ ("This binary was compiled with the following options:")
 156     << " " <<
 157 #ifdef NDEBUG
 158     "NDEBUG "
 159 #endif
 160     "\n"
 161     "datadir: `" DIR_DATADIR "'\n"
 162     "localedir: `" DIR_LOCALEDIR "'\n"
 163     "\n";
 164
 165
 166   cout << endl;
 167
 168   cout << _f ("Report bugs to %s", "bug-lilypond@gnu.org") << endl;
 169 }
 170
 171 void
 172 version ()
 173 {
 174   identify (&cout);
 175   cout << '\n';
 176   cout << _f (""
 177   "This is free software.  It is covered by the GNU General Public License,\n"
 178   "and you are welcome to change it and/or distribute copies of it under\n"
 179   "certain conditions.  Invoke as `%s --warranty' for more information.\n",
 180     "lilypond");
 181   cout << endl;
 182
 183   cout << _f ("Copyright (c) %s by", "1996--2002");
 184   cout << '\n';
 185   cout << "  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n";
 186   cout << "  Jan Nieuwenhuizen <janneke@gnu.org>\n";
 187 }
 188
 189 void
 190 notice ()
 191 {
 192   cout << '\n';
 193   cout << _ ("GNU LilyPond -- The music typesetter");
 194   cout << '\n';
 195   cout << _f ("Copyright (c) %s by", "1996--2002");
 196   cout << '\n';
 197   cout << "  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n";
 198   cout << "  Jan Nieuwenhuizen <janneke@gnu.org>\n";
 199   cout << '\n';
 200   cout << _ (
 201              "    This program is free software; you can redistribute it and/or\n"
 202              "modify it under the terms of the GNU General Public License version 2\n"
 203              "as published by the Free Software Foundation.\n"
 204              "\n"
 205              "    This program is distributed in the hope that it will be useful,\n"
 206              "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
 207              "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
 208              "General Public License for more details.\n"
 209              "\n"
 210              "    You should have received a copy (refer to the file COPYING) of the\n"
 211              "GNU General Public License along with this program; if not, write to\n"
 212              "the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,\n"
 213              "USA.\n");
 214 }
 215
 216 String prefix_directory;
 217
 218 void
 219 setup_paths ()
 220 {
 221   // facilitate binary distributions
 222   char const *env_lily = getenv ("LILYPONDPREFIX");
 223
 224   if (env_lily)
 225     prefix_directory = env_lily;
 226
 227 #if HAVE_GETTEXT
 228   setlocale (LC_ALL, ""); /* enable locales */
 229   setlocale (LC_NUMERIC, "C"); /* musn't have comma's in TeX output... */
 230   String lily_locale_dir;
 231   String name (PACKAGE);
 232   name.to_lower ();
 233
 234   /*
 235     urg; what *do* we want with $LILYPONDPREFIX, DIR_DATADIR and $prefix/share
 236     handy for multiple source-dir runs, though...
 237    */
 238   if (!prefix_directory.empty_b ())
 239     {
 240       lily_locale_dir = prefix_directory + "/share/locale";
 241       bindtextdomain (name.ch_C (), lily_locale_dir.ch_C ());
 242     }
 243   else
 244     bindtextdomain (name.ch_C (), DIR_LOCALEDIR);
 245   textdomain (name.ch_C ());
 246 #endif
 247
 248   global_path.add ("");
 249   // must override (come before) "/usr/local/share/lilypond"!
 250   char const *env_sz = getenv ("LILYINCLUDE");
 251   if (env_sz)
 252     global_path.parse_path (env_sz);
 253
 254
 255   /* Adding mf/out make lilypond unchanged source directory, when setting
 256      LILYPONDPREFIX to lilypond-x.y.z */
 257   char *suffixes[] = {"ly", "afm", "mf/out", "scm", "tfm", "ps", 0};
 258
 259   if (prefix_directory.empty_b ())
 260     prefix_directory =  DIR_DATADIR;
 261   for (char **s = suffixes; *s; s++)
 262     {
 263       String p =  prefix_directory + to_str ('/') + String (*s);
 264       global_path.add (p);
 265
 266 #if !KPATHSEA
 267       /* Urg: GNU make's $ (word) index starts at 1 */
 268       int i  = 1;
 269       while (global_path.try_add (p + to_str (".") + to_str (i)))
 270         i++;
 271 #endif
 272     }
 273 }
 274
 275 /**
 276   Make input file name from command argument.
 277
 278   Path describes file name with added default extension,
 279   ".ly" if none.  "-" is stdin.
 280  */
 281 Path
 282 distill_inname (String str)
 283 {
 284   Path p = split_path (str);
 285   if (str.empty_b () || str == "-")
 286     p.base = "-";
 287   else
 288     {
 289       String orig_ext = p.ext;
 290       char const *extensions[] = {"ly", "fly", "sly", "", 0};
 291       for (int i = 0; extensions[i]; i++)
 292         {
 293           p.ext = orig_ext;
 294           if (*extensions[i] && !p.ext.empty_b ())
 295             p.ext += ".";
 296           p.ext += extensions[i];
 297           if (!global_path.find (p.str ()).empty_b ())
 298               break;
 299         }
 300       /* Reshuffle extension */
 301       p = split_path (p.str ());
 302     }
 303   return p;
 304 }
 305
 306 String
 307 format_to_ext (String format)
 308 {
 309   if (format == "tex")
 310     /* .lytex change put off */
 311     return "tex"; // "lytex";
 312   return format;
 313 }
 314
 315 void
 316 main_prog (void * , int, char**)
 317 {
 318   /*
 319     need to do this first. Engravers use lily.scm contents.
 320    */
 321
 322   /*
 323     prepend onto GUILE  loadpath.
 324
 325     Very ugh.
 326    */
 327
 328   init_lily_guile (prefix_directory);
 329   cout << endl;
 330
 331   call_constructors ();
 332   all_fonts_global_p = new All_font_metrics (global_path.str ());
 333
 334   init_scheme_code_string += ")";
 335   gh_eval_str ((char *)init_scheme_code_string.ch_C());
 336
 337   int p=0;
 338   const char *arg  = oparser_p_static->get_next_arg ();
 339
 340   if (!arg)
 341     {
 342       usage ();
 343       /* No FILE arguments is now a usage error */
 344       exit (2);
 345     }
 346   else
 347     do
 348     {
 349       String infile (arg);
 350
 351       /* What/when was this supposed to do?
 352        It looks like it reset the outname_str_global for every new
 353        file, but only if user didn't specify a outname?  Huh?
 354
 355        // if (outname_str_global == "")
 356
 357       */
 358       {
 359         Midi_def::reset_score_count ();
 360         Paper_def::reset_score_count ();
 361       }
 362
 363       Path inpath = distill_inname (infile);
 364
 365       /* By default, use base name of input file for output file name */
 366       Path outpath = inpath;
 367       if (inpath.str () != "-")
 368         outpath.ext = format_to_ext (output_format_global);
 369
 370       /* By default, write output to cwd; do not copy directory part
 371          of input file name */
 372       outpath.root = "";
 373       outpath.dir = "";
 374
 375       if (!output_name_global.empty_b ())
 376         outpath = split_path (output_name_global);
 377
 378       String init;
 379       if (!init_name_global.empty_b ())
 380         init = init_name_global;
 381       else if (!inpath.ext.empty_b ())
 382         init = "init." + inpath.ext;
 383       else
 384         init = "init.ly";
 385
 386       /* Burp: output name communication goes through _global */
 387       String save_output_name_global = output_name_global;
 388       output_name_global = outpath.str ();
 389       do_one_file (init, inpath.str ());
 390       output_name_global = save_output_name_global;
 391
 392       p++;
 393     } while ((arg  = oparser_p_static->get_next_arg ()));
 394   delete oparser_p_static;
 395   oparser_p_static = 0;
 396   exit (exit_status_global);
 397 }
 398
 399
 400 static int
 401 sane_putenv (char const* key, char const* value, bool overwrite)
 402 {
 403   if (overwrite || !getenv (key))
 404     return putenv ((char*)((String (key) + "=" + value).ch_C ()));
 405   return -1;
 406 }
 407
 408 int
 409 main (int argc, char **argv)
 410 {
 411   setup_paths ();
 412
 413   /* Prepare GUILE for heavy memory usage.  If you have plenty memory,
 414      this may speed up GUILE a bit.  If you're short on memory, these
 415      settings
 416
 417          export GUILE_INIT_SEGMENT_SIZE_1=36000
 418          export GUILE_MAX_SEGMENT_SIZE=576000
 419
 420      may considerably decrease memory footprint (~*0.85), with a small
 421      execution time penalty (~*1.10).  However, if this 15% gain in memory
 422      usage prevents swapping, the execution time falls drastically. */
 423
 424   sane_putenv ("GUILE_INIT_SEGMENT_SIZE_1", "4194304", false);
 425   sane_putenv ("GUILE_MAX_SEGMENT_SIZE", "8388608", false);
 426
 427   ly_init_kpath (argv[0]);
 428
 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_ch_)
 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_ch_C_;
 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.str ();
 445           }
 446           break;
 447         case 'e':
 448           init_scheme_code_string +=
 449             oparser_p_static->optional_argument_ch_C_;
 450           break;
 451         case 'w':
 452           notice ();
 453           exit (0);
 454           break;
 455         case 'f':
 456             output_format_global = oparser_p_static->optional_argument_ch_C_;
 457           break;
 458         case 'P':
 459             dependency_prefix_global = oparser_p_static->optional_argument_ch_C_;
 460           break;
 461         case 'H':
 462           dump_header_fieldnames_global.push (oparser_p_static->optional_argument_ch_C_);
 463           break;
 464         case 'I':
 465           global_path.push (oparser_p_static->optional_argument_ch_C_);
 466           break;
 467         case 'i':
 468           init_name_global = oparser_p_static->optional_argument_ch_C_;
 469           break;
 470         case 'h':
 471           usage ();
 472           exit (0);
 473           break;
 474         case 'V':
 475           verbose_global_b = true;
 476           break;
 477         case 's':
 478           safe_global_b = true;
 479           break;
 480         case 'M':
 481           dependency_global_b = true;
 482           break;
 483         case 'm':
 484           no_paper_global_b = true;
 485           break;
 486         default:
 487           assert (false);
 488           break;
 489         }
 490     }
 491   identify (&cerr);
 492
 493 #ifdef WINNT
 494   scm_boot_guile (argc, argv, main_prog, 0);
 495 #else
 496   scm_boot_guile (argc, argv, (void (*) (void*, int, char**))main_prog, 0);
 497 #endif
 498
 499   return 0;                     // unreachable
 500 }
 501
 502