]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/main.cc
* SConstruct: Further development.
[lilypond.git] / lily / main.cc
index 9adf5a59419f5e97679217da4bc9ad58829ffd0f..e171dfff822f7aebbe11e757745c4b44ca7fd60e 100644 (file)
 /*
-  main.cc -- implement main: entrypoints
+  main.cc -- implement main () entrypoint.
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1998 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 "lily-guile.hh"
+#include <string.h>
 
-#include "proto.hh"
-#include "dimensions.hh"
-#include "plist.hh"
-#include "getopt-long.hh"
-#include "misc.hh"
-#include "string.hh"
-#include "main.hh"
-#include "file-path.hh"
 #include "config.hh"
-#include "file-results.hh"
-#include "debug.hh"
-#include "lily-guile.hh"
 
 #if HAVE_GETTEXT
 #include <libintl.h>
 #endif
 
+#include "all-font-metrics.hh"
+#include "file-name.hh"
+#include "file-path.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.
+ */
+
+/* Names of header fields to be dumped to a separate file. */
+Array<String> dump_header_fieldnames_global;
 
-bool version_ignore_global_b = false;
+/* Name of initialisation file. */
+String init_name_global;
+
+/* Do not calculate and write paper output? */
 bool no_paper_global_b = false;
-bool no_timestamps_global_b = false;
-bool find_quarts_global_b = false;
 
-char const* output_global_ch = "tex";
-// temporarily default to ps, because tex is even more broken
-//char const* output_global_ch = "ps";
+/* Selected output format.
+   One of tex, ps, scm, as. */
+String output_format_global = "tex";
+
+/* Current output name. */
+String output_name_global;
+
+/* Run in safe mode? */
+bool safe_global_b = false;
+
+/* 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 ";
 
-String default_outname_base_global =  "lelie";
-int default_count_global;
+
+
+/*
+ * Miscellaneous global stuff.
+ */
 File_path global_path;
 
-bool experimental_features_global_b = false;
-bool dependency_global_b = false;
-
-int exit_status_i_;
-
-String distill_inname_str (String name_str, String& ext_r);
-
-Long_option_init theopts[] = {
-  {0, "about", 'a'},
-  {1, "output", 'o'},
-  {0, "warranty", 'w'},
-  {0, "help", 'h'},
-  {0, "test", 't'},
-  {0, "debug", 'D'},
-  {1, "init", 'i'},
-  {1, "include", 'I'},
-  {0, "no-paper", 'M'},
-  {0, "dependencies", 'd'},
-  {0, "no-timestamps", 'T'},
-  {0, "find-fourths", 'Q'},
-  {0, "ignore-version", 'V'},
-  {1, "output-format", 'f'},
-  {0,0,0}
-};
-
-void
-usage ()
-{
-  cout << _f ("Usage: %s [OPTION]... [FILE]...", "lilypond") << '\n';
-  cout << _ ("Typeset music and or play MIDI from FILE or <stdin>");
-  cout << '\n';
-  cout << '\n';
-  cout << _ ("Options:");
-  cout << '\n';
-  cout  << _ (
-    "  -a, --about            about LilyPond\n"
-    );
-  cout  << _ (
-    "  -D, --debug            enable debugging output\n"
-    );
-  cout  << _ (
-    "  -d, --dependencies     write Makefile dependencies for every input file\n"
-    );
-  cout  << _ (
-    "  -h, --help             this help\n"
-    );
-  cout  << _ (
-    "  -f, --output-format=X  use output format X\n"
-    );
-  cout  << _ (
-    "  -I, --include=DIR      add DIR to search path\n"
-    );
-  cout  << _ (
-    "  -i, --init=FILE        use FILE as init file\n"
-    );
-  cout  << _ (
-    "  -M, --no-paper         produce midi output only\n"
-    );
-  cout  << _ (
-    "  -o, --output=FILE      set FILE as default output base\n"
-    );
-  cout  << _ (
-    "  -Q, --find-fourths     show all intervals greater than a fourth\n"
-    );
-  cout  << _ (
-    "  -t, --test             switch on experimental features\n"
-    );
-  cout  << _ (
-    "  -T, --no-timestamps    don't timestamp the output\n"
-    );
-  cout  << _ (
-    "  -V, --ignore-version   ignore mudela version\n"
-    );
-  cout  << _ (
-    "  -w, --warranty         show warranty and copyright\n"
-    );
-  cout << '\n';
-  cout << _ ("GNU LilyPond was compiled with the following settings:");
-  cout << '\n';
-  cout <<
-#ifdef NDEBUG
-    "NDEBUG "
-#endif
-#ifdef NPRINT
-    "NPRINT "
-#endif
-#ifdef STRING_UTILS_INLINED
-    "STRING_UTILS_INLINED "
-#endif
-        "datadir=" DIR_DATADIR
-       " "
-        "localedir=" DIR_LOCALEDIR
 
-    "\n";
+/*
+ * File globals.
+ */
 
-  ;
-}
+static char const *AUTHORS =
+"  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
+"  Jan Nieuwenhuizen <janneke@gnu.org>\n";
 
-void
-about ()
-{
-  cout << '\n';
-  cout << 
-  #include "BLURB.hh"
-  cout << '\n';
-  cout << _ ("GNU LilyPond is Free software, see --warranty");
-  cout << '\n';
-  cout << '\n';
-  cout << _f ("Copyright (c) %s by", "1996, 1997, 1998");
-  cout << '\n';
-  cout << "  " + _ ("Han-Wen Nienhuys <hanwen@cs.uu.nl>") + "\n";
-  cout << "  " + _ ("Jan Nieuwenhuizen <janneke@gnu.org>") + "\n";
-  cout << '\n';
-}
+static char const *PROGRAM_NAME = "lilypond-bin";
+static char const *PROGRAM_URL = "http://lilypond.org";
 
-void
-notice ()
-{
-  cout << '\n';
-  cout << _ ("GNU LilyPond -- The GNU Project music typesetter");
-  cout << '\n';
-  cout << _f ("Copyright (c) %s by", "1996, 1997, 1998");
-  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"
+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");
+  
+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"
@@ -181,219 +100,301 @@ notice ()
     "\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");
+    "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
+    "Boston, MA 02111-1307, USA.\n");
+
+
+/* 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};
+
+/*  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
-identify ()
+static void
+copyright ()
 {
-  *mlog << get_version_str () << endl;
+  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 ()
+{
+  identify (stdout);
+  printf ("\n");
+  printf (_f (NOTICE, PROGRAM_NAME).to_str0 ());
+  printf ("\n");
+  copyright ();
+}
+
+static void
+usage ()
+{
+  /* 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");
+}
+
+static void
+warranty ()
+{
+  identify (stdout);
+  printf ("\n");
+  copyright ();
+  printf ("\n");
+  printf (_ (WARRANTY).to_str0 ());
+}
+
+static void
 setup_paths ()
 {
-  // facilitate binary distributions
-  char const *env_lily = getenv ("LILYPONDPREFIX");
-  String prefix_directory;
-  if (env_lily)
-    prefix_directory = env_lily;
+  if (char const *lilypond_prefix = getenv ("LILYPONDPREFIX"))
+    prefix_directory[1] = lilypond_prefix;
+
+  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_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 ());
+}
 
-#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 ();
-  if (!prefix_directory.empty_b())
+static void
+main_with_guile (void *, int, char **)
+{
+  /* 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++)
     {
-      lily_locale_dir = prefix_directory + "/share/locale";
-      bindtextdomain (name.ch_C (), lily_locale_dir.ch_C());
+      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");
     }
-  else
-    bindtextdomain (name.ch_C (), DIR_LOCALEDIR);
-  textdomain (name.ch_C ());
-#endif
 
-  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);
+  if (verbose_global_b)
+    dir_info (stderr);
+
+  ly_c_init_guile ();
+  call_constructors ();
+  progress_indication ("\n");
+
+  all_fonts_global = new All_font_metrics (global_path.to_string ());
 
-  if (!prefix_directory.empty_b())
+  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 ())
     {
-      global_path.add (prefix_directory + "/share/lilypond/ly/");
-      global_path.add (prefix_directory + "/share/lilypond/afm/");
+      *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
+      tail = SCM_CDRLOC (*tail);
     }
-  else
+  delete option_parser;
+  option_parser = 0;
+
+  if (files == SCM_EOL)
     {
-      global_path.add (String (DIR_DATADIR) + "/ly/");
-      global_path.add (String (DIR_DATADIR) + "/afm/");  
+      /* 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);
     }
-}
 
+  SCM result = scm_call_1 (ly_scheme_function ("lilypond-main"), files);
+  (void) result;
 
 
-void
-main_prog (int argc, char **argv)
-{
-  identify ();
-  call_constructors ();
-  debug_init ();               // should be first
-
-  setup_paths ();
+  /* Unreachable.  */
+  exit (0);
+}
 
-  String init_str;
-  String outname_str;
+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");
+  
+  String name (PACKAGE);
+  name.to_lower ();
+  bindtextdomain (name.to_str0 (), LOCALEDIR);
+  textdomain (name.to_str0 ());
+#endif
+}
 
-  Getopt_long oparser (argc, argv,theopts);
-  while (Long_option_init const * opt = oparser ())
+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)
+      switch (opt->shortname_char_)
        {
-       case 't':
-         experimental_features_global_b = true;
-         *mlog << "*** enabling experimental features, you're on your own now ***\n";
+       case 'v':
+         notice ();
+         exit (0);
          break;
        case 'o':
-         outname_str = oparser.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.optional_argument_ch_C_;
+         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 'Q':
-         find_quarts_global_b = true;
+       case 'H':
+         dump_header_fieldnames_global
+           .push (option_parser->optional_argument_str0_);
          break;
        case 'I':
-         global_path.push (oparser.optional_argument_ch_C_);
+         global_path.append (option_parser->optional_argument_str0_);
          break;
        case 'i':
-         init_str = oparser.optional_argument_ch_C_;
+         init_name_global = option_parser->optional_argument_str0_;
          break;
-       case 'a':
-         about ();
-         exit (0);
        case 'h':
-         usage ();
-         exit (0);
+         help_b = true;
          break;
        case 'V':
-         version_ignore_global_b = true;
+         verbose_global_b = true;
          break;
-       case 'd':
-         dependency_global_b = true;
-         break; 
-       case 'D':
-         set_debug (true);
+       case 's':
+         safe_global_b = true;
          break;
-       case 'M':
+       case 'm':
          no_paper_global_b = true;
          break;
-       case 'T':
-         no_timestamps_global_b = true;
-         break;
        default:
          assert (false);
          break;
        }
     }
 
-  default_outname_base_global = "lelie";
-
-  
-
-  int p=0;
-  const char *arg ;
-  while ((arg= oparser.get_next_arg ()))
+  if (help_b)
     {
-      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.length_i ())
-       default_outname_base_global = outname_str;
-      if (init_str.length_i ())
-       i = init_str;
-      else
-       i = "init" + i;
-      do_one_file (i, f);
-      p++;
+      usage ();
+      if (verbose_global_b)
+       dir_info (stdout);
+      exit (0);
     }
-  if (!p)
-    {
-      String i;
-      if (init_str.length_i ())
-       i = init_str;
-      else
-       i = "init.ly";
-      default_outname_base_global = "-";
-      if (outname_str.length_i ())
-       default_outname_base_global = outname_str;
-      do_one_file (i, default_outname_base_global);
-    }
-  exit( exit_status_i_);
 }
 
 int
 main (int argc, char **argv)
 {
-#ifdef HAVE_LIBGUILE
-  gh_enter (argc, argv, (void(*)())main_prog);
-  return exit_status_i_;
-#else
-  main_prog (argc, argv);
-  return exit_status_i_;
-#endif
-}
-
-/**
-  make input file name from command arg.
-
-  @input file name
+  setup_localisation ();  
+  setup_paths ();
+  parse_argv (argc, argv);
+  initialize_kpathsea (argv[0]);
 
-  @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)
-{
-  String str = name_str;
-  if (str.length_i ())
-    {
-      if (str != "-")
-       {
-         String a,b,c;
-         split_path (str,a,b,c,ext_r);
+  scm_boot_guile (argc, argv, main_with_guile, 0);
 
-         // add extension if not present.
-         // UGH. Should parametrise in list of default extensions.
-         if (ext_r.empty_b ())
-           {
-             ext_r = ".fly";
-             if (global_path.find (a+b+c+ext_r).empty_b ())
-               ext_r = ".ly";
-           }
-         str = a+b+c+ext_r;
-       }
-    }
-  else 
-    {
-      str = "-";
-      ext_r = ".ly";
-    }
-  return str;
+  /* Unreachable */
+  return 0;
 }
-