]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/main.cc
* SConstruct: Further development.
[lilypond.git] / lily / main.cc
index b98056a3755a25259eec18eeacdb3a0e1f259c87..e171dfff822f7aebbe11e757745c4b44ca7fd60e 100644 (file)
 /*
-  main.cc -- implement main: entrypoints
+  main.cc -- implement main () entrypoint.
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 #include <stdlib.h>
-#include <iostream.h>
+#include <stdio.h>
 #include <assert.h>
 #include <locale.h>
+#include <string.h>
 
-#include "lily-guile.hh"
-#include "lily-version.hh"
+#include "config.hh"
+
+#if HAVE_GETTEXT
+#include <libintl.h>
+#endif
 
 #include "all-font-metrics.hh"
-#include "getopt-long.hh"
-#include "misc.hh"
-#include "string.hh"
-#include "main.hh"
+#include "file-name.hh"
 #include "file-path.hh"
-#include "config.h"
-#include "file-results.hh"
-#include "debug.hh"
-#include "lily-guile.hh"
-#include "paper-def.hh"
-#include "midi-def.hh"
+#include "getopt-long.hh"
 #include "global-ctor.hh"
 #include "kpath.hh"
+#include "lily-guile.hh"
+#include "lily-version.hh"
+#include "main.hh"
+#include "misc.hh"
+#include "output-def.hh"
+#include "string.hh"
+#include "warn.hh"
 
+/*
+ * Global options that can be overridden through command line.
+ */
 
-#if HAVE_GETTEXT
-#include <libintl.h>
-#endif
-
+/* Names of header fields to be dumped to a separate file. */
+Array<String> dump_header_fieldnames_global;
 
+/* Name of initialisation file. */
+String init_name_global;
 
-bool verbose_global_b = false;
+/* Do not calculate and write paper output? */
 bool no_paper_global_b = false;
-bool no_timestamps_global_b = false;
-bool find_old_relative_b = false;
-
-char const* output_global_ch = "tex";
-All_font_metrics *all_fonts_global_p;
 
-String default_outname_base_global =  "lelie";
-String outname_str_global;
-String init_str_global;
+/* Selected output format.
+   One of tex, ps, scm, as. */
+String output_format_global = "tex";
 
-int default_count_global;
-File_path global_path;
-
-Array<String> global_score_header_fields;
+/* Current output name. */
+String output_name_global;
 
+/* Run in safe mode? */
 bool safe_global_b = false;
-bool experimental_features_global_b = false;
-bool dependency_global_b = false;
 
-int exit_status_i_;
+/* Verbose progress indication? */
+bool verbose_global_b = false;
+
+/* Scheme code to execute before parsing, after .scm init
+   This is where -e arguments are appended to.
+*/
+String init_scheme_code_string = "(begin #t ";
 
-Getopt_long * oparser_global_p = 0;
 
-String distill_inname_str (String name_str, String& ext_r);
 
 /*
- Internationalisation kludge in two steps:
-   * use _i () to get entry in POT file
-   * call gettext () explicitely for actual "translation"
+ * Miscellaneous global stuff.
+ */
+File_path global_path;
 
- Note: these messages all start with lower case (ie, don't
-       follow regular localisation guidelines).
+
+/*
+ * File globals.
  */
-Long_option_init theopts[] = {
-  {_i ("EXT"), "output-format", 'f',  _i ("use output format EXT (scm, ps, tex or as)")},
-  {0, "help", 'h',  _i ("this help")},
-  {_i ("FIELD"), "header", 'H',  _i ("write header field to BASENAME.FIELD")},
-  {_i ("DIR"), "include", 'I',  _i ("add DIR to search path")},
-  {_i ("FILE"), "init", 'i',  _i ("use FILE as init file")},
-  {0, "dependencies", 'M',  _i ("write Makefile dependencies for every input file")},
-  {0, "no-paper", 'm',  _i ("produce MIDI output only")},
-  {_i ("BASENAME"), "output", 'o',  _i ("write output to BASENAME[-x].extension")},
-  {0, "find-old-relative", 'Q',  _i ("show all changes in relative syntax")},
-  {0, "safe", 's',  _i ("inhibit file output naming and exporting")},
-  {0, "no-timestamps", 'T',  _i ("don't timestamp the output")},
-  {0, "test", 't',  _i ("switch on experimental features")},
-  {0, "version", 'v',  _i ("print version number")},
-  {0, "verbose", 'V', _i("verbose")},
-  {0, "warranty", 'w',  _i ("show warranty and copyright")},
-  {0,0,0, 0}
-};
-
-void
-identify (ostream* os)
-{
-  //*os << gnu_lilypond_version_str () << endl;
-  *os << gnu_lilypond_version_str ();
-}
 
-void
-usage ()
-{
+static char const *AUTHORS =
+"  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
+"  Jan Nieuwenhuizen <janneke@gnu.org>\n";
+
+static char const *PROGRAM_NAME = "lilypond-bin";
+static char const *PROGRAM_URL = "http://lilypond.org";
+
+static char const *NOTICE =
+_i ("This program is free software.  It is covered by the GNU General Public\n"
+    "License and you are welcome to change it and/or distribute copies of it\n"
+    "under certain conditions.  Invoke as `lilypond-bin --warranty' for more\n"
+    "information.\n");
   
-  /*
-    No version number or newline here. It confuses help2man
-   */
-  cout << _f ("Usage: %s [OPTION]... [FILE]...", "lilypond");
-  cout << "\n\n";
-  cout << _ ("Typeset music and or play MIDI from FILE");
-  cout << "\n\n";
-  cout << 
-_(
-"LilyPond is a music typesetter.  It produces beautiful sheet music\n"
-"using a high level description file as input.  LilyPond is part of \n"
-"the GNU Project.\n"
-);
-
-  cout << '\n';
-  cout << _ ("Options:");
-  cout << '\n';
-  cout << Long_option_init::table_str (theopts);
-  cout << '\n';
-  cout << _ ("This binary was compiled with the following options:") 
-    << " " <<
-#ifdef NDEBUG
-    "NDEBUG "
-#endif
-#ifdef NPRINT
-    "NPRINT "
-#endif
-#ifdef STRING_UTILS_INLINED
-    "STRING_UTILS_INLINED "
-#endif
+static char const *WARRANTY =
+_i ("    This program is free software; you can redistribute it and/or\n"
+    "modify it under the terms of the GNU General Public License version 2\n"
+    "as published by the Free Software Foundation.\n"
+    "\n"
+    "    This program is distributed in the hope that it will be useful,\n"
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
+    "General Public License for more details.\n"
     "\n"
-    "datadir: `" DIR_DATADIR "'\n"
-    "localedir: `" DIR_LOCALEDIR "'\n"
-    "\n";
+    "    You should have received a copy (refer to the file COPYING) of the\n"
+    "GNU General Public License along with this program; if not, write to\n"
+    "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
+    "Boston, MA 02111-1307, USA.\n");
 
 
-  cout << endl;
+/* Where the init files live.  Typically:
+   LILYPOND_DATADIR = /usr/share/lilypond
+   LOCAL_LILYPOND_DATADIR = /usr/share/lilypond/<VERSION> */
+char const *prefix_directory[] = {LILYPOND_DATADIR, LOCAL_LILYPOND_DATADIR, 0};
 
-  cout << _f ("Report bugs to %s", "bug-gnu-music@gnu.org") << endl;
+/*  The option parser */
+static Getopt_long *option_parser = 0;
+
+/* Internationalisation kludge in two steps:
+   * use _i () to get entry in POT file
+   * call gettext () explicitely for actual "translation"  */
+
+static Long_option_init options_static[] =
+  {
+    {_i ("EXPR"), "evaluate", 'e',
+     _i ("set options, use -e '(ly-option-usage)' for help")},
+    /* Bug in option parser: --output=foe is taken as an abbreviation
+       for --output-format.  */
+    {_i ("EXT"), "format", 'f', _i ("use output format EXT")},
+    {0, "help", 'h',  _i ("print this help")},
+    {_i ("FIELD"), "header", 'H',  _i ("write header field to BASENAME.FIELD")},
+    {_i ("DIR"), "include", 'I',  _i ("add DIR to search path")},
+    {_i ("FILE"), "init", 'i',  _i ("use FILE as init file")},
+    {0, "no-paper", 'm',  _i ("produce MIDI output only")},
+    {_i ("FILE"), "output", 'o',  _i ("write output to FILE")},
+    {0, "safe-mode", 's',  _i ("run in safe mode")},
+    {0, "version", 'v',  _i ("print version number")},
+    {0, "verbose", 'V', _i ("be verbose")},
+    {0, "warranty", 'w',  _i ("show warranty and copyright")},
+    {0,0,0,0}
+  };
+
+static void
+dir_info (FILE *out)
+{
+  fputs ("\n", out);
+  fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
+  fprintf (out, "LOCAL_LILYPOND_DATADIR=\%s\"\n", LOCAL_LILYPOND_DATADIR);
+  fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
+
+  char *lilypond_prefix = getenv ("LILYPONDPREFIX");
+  fprintf (out, "LILYPONDPREFIX=\"%s\"\n",
+          (lilypond_prefix ? lilypond_prefix : ""));
 }
 
-void
-version ()
+static void
+copyright ()
 {
-  identify (&cout);
-  cout << '\n';
-  cout << _f (""
-  "This is free software.  It is covered by the GNU General Public License,\n"
-  "and you are welcome to change it and/or distribute copies of it under\n"
-  "certain conditions.  Invoke as `%s --warranty' for more information.\n",
-    "lilypond");
-  cout << endl;
-
-  cout << _f ("Copyright (c) %s by", "1996--2000");
-  cout << "Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
-       << "Jan Nieuwenhuizen <janneke@gnu.org>\n";
+  printf (_f ("Copyright (c) %s by\n%s  and others.",
+             "1996--2004",
+             AUTHORS).to_str0 ());
+  printf ("\n");
 }
 
-void
+static void
+identify (FILE *out)
+{
+  fputs (gnu_lilypond_version_string ().to_str0 (), out);
+}
+static void
 notice ()
 {
-  cout << '\n';
-  // GNU GNU?
-  cout << _ ("GNU LilyPond -- The GNU Project music typesetter");
-  cout << '\n';
-  cout << _f ("Copyright (c) %s by", "1996--2000");
-  cout << '\n';
-  cout << "  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n";
-  cout << "  Jan Nieuwenhuizen <janneke@gnu.org>\n";
-  cout << '\n';
-  cout << _ (
-            "    This program is free software; you can redistribute it and/or\n"
-            "modify it under the terms of the GNU General Public License version 2\n"
-            "as published by the Free Software Foundation.\n"
-            "\n"
-            "    This program is distributed in the hope that it will be useful,\n"
-            "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
-            "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
-            "General Public License for more details.\n"
-            "\n"
-            "    You should have received a copy (refer to the file COPYING) of the\n"
-            "GNU General Public License along with this program; if not, write to\n"
-            "the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,\n"
-            "USA.\n");
+  identify (stdout);
+  printf ("\n");
+  printf (_f (NOTICE, PROGRAM_NAME).to_str0 ());
+  printf ("\n");
+  copyright ();
 }
 
-void
-setup_paths ()
+static void
+usage ()
 {
-  // facilitate binary distributions
-  char const *env_lily = getenv ("LILYPONDPREFIX");
-  String prefix_directory;
-  if (env_lily)
-    prefix_directory = env_lily;
+  /* No version number or newline here.  It confuses help2man.  */
+  printf (_f ("Usage: %s [OPTIONS]... FILE...", PROGRAM_NAME).to_str0 ());
+  printf ("\n\n");
+  printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
+  printf ("\n\n");
+  printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
+  printf ("\n");
+  printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
+  printf ("\n\n");
+  printf (_ ("Options:").to_str0 ());
+  printf ("\n");
+  printf (Long_option_init::table_string (options_static).to_str0 ());
+  printf ("\n");
+  printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
+  printf ("\n");
+  printf ("\n");
+}
 
-#if HAVE_GETTEXT
-  setlocale (LC_ALL, ""); /* enable locales */
-  setlocale (LC_NUMERIC, "C"); /* musn't have comma's in TeX output... */
-  String lily_locale_dir;
-  String name (PACKAGE);
-  name.to_lower ();
+static void
+warranty ()
+{
+  identify (stdout);
+  printf ("\n");
+  copyright ();
+  printf ("\n");
+  printf (_ (WARRANTY).to_str0 ());
+}
 
-  /*
-    urg; what *do* we want with $LILYPONDPREFIX, DIR_DATADIR and $prefix/share
-    handy for multiple source-dir runs, though...
-   */
-  if (!prefix_directory.empty_b())
-    {
-      lily_locale_dir = prefix_directory + "/share/locale";
-      bindtextdomain (name.ch_C (), lily_locale_dir.ch_C());
-    }
-  else
-    bindtextdomain (name.ch_C (), DIR_LOCALEDIR);
-  textdomain (name.ch_C ());
-#endif
+static void
+setup_paths ()
+{
+  if (char const *lilypond_prefix = getenv ("LILYPONDPREFIX"))
+    prefix_directory[1] = lilypond_prefix;
 
-  global_path.add ("");
-  // must override (come before) "/usr/local/share/lilypond"!
-  char const *env_sz = getenv ("LILYINCLUDE");
-  if (env_sz)
-    global_path.parse_path (env_sz);
-
-
-  /*
-    Should use kpathsea, this is getting out of hand.  
-   */
-  char *suffixes[] = {"ly", "afm", "scm", "tfm", "ps", 0};
-  String prefix = prefix_directory;
-  if (prefix.empty_b ())
-    prefix =  DIR_DATADIR;
-  for (char **s = suffixes; *s; s++)
-    {
-      String p =  prefix + to_str ('/') + String (*s);
-      global_path.add (p);
+  global_path.append ("");
+
+  /* Adding mf/out make lilypond unchanged source directory, when setting
+     LILYPONDPREFIX to lilypond-x.y.z */
+  char *suffixes[] = {"ly", "afm", "mf/out", "scm", "tfm", "ps", 0};
 
+  for (unsigned i = 0; prefix_directory[i]; i++)
+    for (char **s = suffixes; *s; s++)
+      {
+       String p = prefix_directory[i] + to_string ('/') + String (*s);
+       global_path.prepend (p);
+       
 #if !KPATHSEA
-      /* Urg: GNU make's $(word) index starts at 1 */
-      int i  = 1;
-      while (global_path.try_add (p + to_str (".") + to_str (i)))
-       i++;
+       /* Urg: GNU make's $ (word) index starts at 1 */
+       int i  = 1;
+       while (global_path.try_append (p + to_string (".") + to_string (i)))
+         i++;
 #endif
-    }
+      }
+}
+  
+static void
+prepend_load_path (String dir)
+{
+  String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
+  scm_c_eval_string (s.to_str0 ());
 }
 
-
-void
-main_prog (int, char**)
+static void
+main_with_guile (void *, int, char **)
 {
-  /*
-    need to do this first. Engravers use lily.scm contents.
-   */
-  init_lily_guile ();
+  /* Engravers use lily.scm contents, need to make Guile find it.
+     Prepend onto GUILE %load-path, very ugh. */
+  for (unsigned i = 0; prefix_directory[i]; i++)
+    {
+      prepend_load_path (prefix_directory[i]);
+      /* Junk this.  We should make real modules iso. just loading files. */
+      prepend_load_path (String (prefix_directory[i]) + "/scm");
+    }
+
   if (verbose_global_b)
-    progress_indication ("\n");
-  read_lily_scm_file ("lily.scm");
-  cout << endl;
+    dir_info (stderr);
 
+  ly_c_init_guile ();
   call_constructors ();
-  default_outname_base_global = "lelie";
-  all_fonts_global_p = new All_font_metrics (global_path.str ());
-  
-  int p=0;
-  const char *arg ;
-  while ((arg= oparser_global_p->get_next_arg ()))
+  progress_indication ("\n");
+
+  all_fonts_global = new All_font_metrics (global_path.to_string ());
+
+  init_scheme_code_string += ")";
+  scm_c_eval_string ((char*) init_scheme_code_string.to_str0 ());
+
+  /* We accept multiple independent music files on the command line to
+     reduce compile time when processing lots of small files.
+     Starting the GUILE engine is very time consuming.  */
+
+  SCM files = SCM_EOL;
+  SCM *tail = &files;
+  while (char const *arg = option_parser->get_next_arg ())
     {
-      
-      if (outname_str_global == "")
-       {
-         Midi_def::reset_default_count ();
-         Paper_def::reset_default_count ();
-       }
-      String f (arg);
-      String i;
-      f = distill_inname_str (f, i);
-      if (f == "-")
-       default_outname_base_global = "-";
-      else
-       {
-         String a,b,c,d;
-         split_path (f, a, b, c, d);
-         default_outname_base_global = c;
-       }
-      if (outname_str_global.length_i ())
-       default_outname_base_global = outname_str_global;
-      if (init_str_global.length_i ())
-       i = init_str_global;
-      else
-       i = "init" + i;
-      do_one_file (i, f);
-      p++;
+      *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
+      tail = SCM_CDRLOC (*tail);
     }
-  if (!p)
+  delete option_parser;
+  option_parser = 0;
+
+  if (files == SCM_EOL)
     {
-      String i;
-      if (init_str_global.length_i ())
-       i = init_str_global;
-      else
-       i = "init.ly";
-      default_outname_base_global = "-";
-      if (outname_str_global.length_i ())
-       default_outname_base_global = outname_str_global;
-      do_one_file (i, default_outname_base_global);
+      /* No FILE arguments is now a usage error to help newbies.  If you
+        want a filter, you're not a newbie and should know to use file
+        argument `-'.  */
+      usage ();
+      exit (2);
     }
-  delete oparser_global_p;
-  exit( exit_status_i_);
-}
-
 
-int
-main (int argc, char **argv)
-{
-  debug_init ();               // should be first
-  setup_paths ();
+  SCM result = scm_call_1 (ly_scheme_function ("lilypond-main"), files);
+  (void) result;
 
-  /*
-    prepare guile for heavy mem usage.
 
-    putenv is POSIX, setenv is BSD 4.3
-   */
-  putenv ("GUILE_INIT_SEGMENT_SIZE_1=4194304");
-  putenv ("GUILE_MAX_SEGMENT_SIZE=8388608");
+  /* Unreachable.  */
+  exit (0);
+}
 
-  ly_init_kpath (argv[0]);
+static void
+setup_localisation ()
+{
+#if HAVE_GETTEXT
+  /* Enable locales */
+  setlocale (LC_ALL, "");
+  
+  /* FIXME: check if this is still true.
+    Disable localisation of float values.  This breaks TeX output.  */
+  setlocale (LC_NUMERIC, "C");
   
-  oparser_global_p = new Getopt_long(argc, argv,theopts);
-  while (Long_option_init const * opt = (*oparser_global_p)())
+  String name (PACKAGE);
+  name.to_lower ();
+  bindtextdomain (name.to_str0 (), LOCALEDIR);
+  textdomain (name.to_str0 ());
+#endif
+}
+
+static void
+parse_argv (int argc, char **argv)
+{
+  bool help_b = false;
+  option_parser = new Getopt_long (argc, argv, options_static);
+  while (Long_option_init const *opt = (*option_parser) ())
     {
-      switch (opt->shortname_ch_)
+      switch (opt->shortname_char_)
        {
        case 'v':
-         version();
-         exit (0);             // we print a version anyway.
-         break;
-       case 't':
-         experimental_features_global_b = true;
-         progress_indication ("*** enabling experimental features, you're on your own now ***\n");
+         notice ();
+         exit (0);
          break;
        case 'o':
-         outname_str_global = oparser_global_p->optional_argument_ch_C_;
+         {
+           String s = option_parser->optional_argument_str0_;
+           File_name file_name (s);
+           output_name_global = file_name.to_string ();
+         }
+         break;
+       case 'e':
+         init_scheme_code_string += option_parser->optional_argument_str0_;
          break;
        case 'w':
-         notice ();
+         warranty ();
          exit (0);
          break;
        case 'f':
-         output_global_ch = oparser_global_p->optional_argument_ch_C_;
-         break;
-       case 'Q':
-         find_old_relative_b= true;
+         if (option_parser->optional_argument_str0_ == "help")
+           {
+             printf (_ ("This option is for developers only.").to_str0 ());
+             printf (_ ("Read the sources for more information.").to_str0 ());
+             exit (0);
+           }
+         output_format_global = option_parser->optional_argument_str0_;
          break;
        case 'H':
-         global_score_header_fields.push (oparser_global_p->optional_argument_ch_C_);
+         dump_header_fieldnames_global
+           .push (option_parser->optional_argument_str0_);
          break;
        case 'I':
-         global_path.push (oparser_global_p->optional_argument_ch_C_);
+         global_path.append (option_parser->optional_argument_str0_);
          break;
        case 'i':
-         init_str_global = oparser_global_p->optional_argument_ch_C_;
+         init_name_global = option_parser->optional_argument_str0_;
          break;
        case 'h':
-         usage ();
-         exit (0);
+         help_b = true;
          break;
        case 'V':
          verbose_global_b = true;
@@ -370,72 +367,34 @@ main (int argc, char **argv)
        case 's':
          safe_global_b = true;
          break;
-       case 'M':
-         dependency_global_b = true;
-         break; 
        case 'm':
          no_paper_global_b = true;
          break;
-       case 'T':
-         no_timestamps_global_b = true;
-         break;
        default:
          assert (false);
          break;
        }
     }
-  identify (&cerr);
 
-#ifdef WINNT
-  gh_enter (argc, argv, main_prog);
-#else
-  gh_enter (argc, argv, (void(*)(int, char**))main_prog);
-#endif
-
-  return 0;                    // unreachable
+  if (help_b)
+    {
+      usage ();
+      if (verbose_global_b)
+       dir_info (stdout);
+      exit (0);
+    }
 }
 
-/**
-  make input file name from command arg.
-
-  @input file name
-
-  @output file name with added default extension. "" is stdin.
-          in reference argument: the extension. ".ly" if none
- */
-String
-distill_inname_str (String name_str, String& ext_r)
+int
+main (int argc, char **argv)
 {
-  String str = name_str;
-  if (str.length_i ())
-    {
-      if (str != "-")
-       {
-         String a,b,c;
-         split_path (str,a,b,c,ext_r);
+  setup_localisation ();  
+  setup_paths ();
+  parse_argv (argc, argv);
+  initialize_kpathsea (argv[0]);
 
-         // add extension if not present.
-         char const* extensions[] = {"", ".ly", ".fly", ".sly", "", 0};
-         extensions[0] = ext_r.ch_C ();
-         for (int i = 0; extensions[i]; i++)
-           {
-             if (!global_path.find (a+b+c+extensions[i]).empty_b ())
-               {
-                 ext_r = extensions[i];
-                 break;
-               }
-           }
-         str = a+b+c+ext_r;
-         // in any case, assume (init).ly
-         if (!ext_r.length_i ())
-           ext_r = ".ly";
-       }
-    }
-  else 
-    {
-      str = "-";
-      ext_r = ".ly";
-    }
-  return str;
-}
+  scm_boot_guile (argc, argv, main_with_guile, 0);
 
+  /* Unreachable */
+  return 0;
+}