]> git.donarmstrong.com Git - lilypond.git/blob - lily/main.cc
* lily/melisma-engraver.cc (try_music): use melisma_busy()
[lilypond.git] / 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 ("print 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 ("be 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 [OPTIONS]... FILE...", "lilypond").to_str0 ());
156   printf ("\n\n");
157   printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
158   printf ("\n\n");
159   printf(_ ("LilyPond produces beautiful music notation.\n"
160             "For more information, see http://lilypond.org/"
161 ).to_str0 ());
162
163   printf ("\n");
164   printf (_ ("Options:").to_str0 ());
165   printf ("\n");
166   printf (Long_option_init::table_string (options_static).to_str0 ());
167   printf ("\n");
168   printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
169   printf ("\n");
170   printf ("\n");
171 }
172
173 void
174 version ()
175 {
176   identify (stdout);
177   printf ("\n");
178   printf (_f (
179   "This is free software.  It is covered by the GNU General Public License,\n"
180   "and you are welcome to change it and/or distribute copies of it under\n"
181   "certain conditions.  Invoke as `%s --warranty' for more information.\n",
182     "lilypond").to_str0 ());
183   printf ("\n");
184
185   printf (_f ("Copyright (c) %s by", "1996--2003").to_str0 ());
186   printf ("\n");
187   printf ("  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n");
188   printf ("  Jan Nieuwenhuizen <janneke@gnu.org>\n");
189 }
190
191 void
192 notice ()
193 {
194   printf ("\n");
195   printf (_ ("GNU LilyPond -- The music typesetter").to_str0 ());
196   printf ("\n");
197   printf (_f ("Copyright (c) %s by", "1996--2003").to_str0 ());
198   printf ("\n");
199   printf ("  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n");
200   printf ("  Jan Nieuwenhuizen <janneke@gnu.org>\n");
201   printf ("\n");
202   printf ( _ (
203              "    This program is free software; you can redistribute it and/or\n"
204              "modify it under the terms of the GNU General Public License version 2\n"
205              "as published by the Free Software Foundation.\n"
206              "\n"
207              "    This program is distributed in the hope that it will be useful,\n"
208              "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
209              "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
210              "General Public License for more details.\n"
211              "\n"
212              "    You should have received a copy (refer to the file COPYING) of the\n"
213              "GNU General Public License along with this program; if not, write to\n"
214              "the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,\n"
215              "USA.\n").to_str0 ());
216 }
217
218
219 /* Where LilyPond's init files live.  Typically:
220    LILYPOND_DATADIR = /usr/local/share/lilypond
221    LOCAL_LILYPOND_DATADIR = /usr/local/share/lilypond/1.5.68 */
222 char const *prefix_directory[] = {LILYPOND_DATADIR, LOCAL_LILYPOND_DATADIR, 0};
223
224 void
225 setup_paths ()
226 {
227   if (char const *lilypond_prefix = getenv ("LILYPONDPREFIX"))
228     prefix_directory[1] = lilypond_prefix;
229
230 #if HAVE_GETTEXT
231   /* Enable locales */
232   setlocale (LC_ALL, "");
233   /* Mustn't have commas in TeX output... */
234   setlocale (LC_NUMERIC, "C");
235   String lily_locale_dir;
236   String name (PACKAGE);
237   name.to_lower ();
238   bindtextdomain (name.to_str0 (), LOCALEDIR);
239   textdomain (name.to_str0 ());
240 #endif
241
242   global_path.add ("");
243
244
245   /* Adding mf/out make lilypond unchanged source directory, when setting
246      LILYPONDPREFIX to lilypond-x.y.z */
247   char *suffixes[] = {"ly", "afm", "mf/out", "scm", "tfm", "ps", 0};
248
249   for (unsigned i = 0; prefix_directory[i]; i++)
250     for (char **s = suffixes; *s; s++)
251       {
252         String p = prefix_directory[i] + to_string ('/') + String (*s);
253         global_path.prepend (p);
254         
255 #if !KPATHSEA
256         /* Urg: GNU make's $ (word) index starts at 1 */
257         int i  = 1;
258         while (global_path.try_add (p + to_string (".") + to_string (i)))
259           i++;
260 #endif
261       }
262   }
263   
264 /**
265   Make input file name from command argument.
266
267   Path describes file name with added default extension,
268   ".ly" if none.  "-" is stdin.
269  */
270 Path
271 distill_inname (String str)
272 {
273   Path p = split_path (str);
274   if (str.is_empty () || str == "-")
275     p.base = "-";
276   else
277     {
278       String orig_ext = p.ext;
279       char const *extensions[] = {"ly", "", 0};
280       for (int i = 0; extensions[i]; i++)
281         {
282           p.ext = orig_ext;
283           if (*extensions[i] && !p.ext.is_empty ())
284             p.ext += ".";
285           p.ext += extensions[i];
286           if (!global_path.find (p.to_string ()).is_empty ())
287               break;
288         }
289       /* Reshuffle extension */
290       p = split_path (p.to_string ());
291     }
292   return p;
293 }
294
295 void
296 prepend_load_path (String dir)
297 {
298   String s = "(set! %load-path (cons \""
299     + dir
300     + "\" %load-path))";
301   scm_c_eval_string (s.to_str0 ());
302 }
303
304 void
305 main_prog (void *, int, char **)
306 {
307   /* Engravers use lily.scm contents, need to make Guile find it.
308      Prepend onto GUILE %load-path, very ugh. */
309      
310   for (unsigned i = 0; prefix_directory[i]; i++)
311     {
312       prepend_load_path (prefix_directory[i]);
313
314       /* Junk this.  We should make real modules iso. just loading files. */
315       prepend_load_path (String (prefix_directory[i]) + "/scm");
316     }
317
318   if (verbose_global_b)
319     dirinfo (stderr);
320   
321   ly_init_guile ();
322   call_constructors ();
323
324   progress_indication ("\n");
325
326   all_fonts_global = new All_font_metrics (global_path.to_string ());
327
328   init_scheme_code_string += ")";
329   gh_eval_str ((char *)init_scheme_code_string.to_str0 ());
330   
331   int p=0;
332   const char *arg  = oparser_p_static->get_next_arg ();
333
334   /* Only exit until after running init_scheme_code, for
335      (ly-option-usage) or
336      -e "(ly-set-option 'help #t)" */
337   if (!arg)
338     {
339       usage ();
340       /* No FILE arguments is now a usage error */
341       exit (2);
342     }
343
344   do
345     {
346       String infile (arg);
347       Path inpath = distill_inname (infile);
348
349       /* By default, use base name of input file for output file name */
350       Path outpath = inpath;
351       if (inpath.to_string () != "-")
352         outpath.ext = output_format_global;
353
354       /* By default, write output to cwd; do not copy directory part
355          of input file name */
356       outpath.root = "";
357       outpath.dir = "";
358       
359       if (!output_name_global.is_empty ())
360         outpath = split_path (output_name_global);
361       
362       String init;
363       if (!init_name_global.is_empty ())
364         init = init_name_global;
365       else
366         init = "init.ly";
367         
368       do_one_file (init, inpath.to_string (), outpath.to_string ());
369       
370       p++;
371     } while ((arg  = oparser_p_static->get_next_arg ()));
372   delete oparser_p_static;
373   oparser_p_static = 0;
374   exit (exit_status_global);
375 }
376
377
378 static int
379 sane_putenv (char const* key, char const* value, bool overwrite)
380 {
381   if (overwrite || !getenv (key))
382     {
383       String combine = String (key) + "=" + String (value);
384       char * s = strdup(combine.to_str0 ());
385       return putenv (s);
386     }
387   return -1;
388 }
389
390 int
391 main (int argc, char **argv)
392 {
393   setup_paths ();
394
395   /*
396     
397     These settings hopefully prepare lily for a lot of memory usage.
398
399     In practice the effect on GC times is barely measurable -- larger
400     segments cost slighly less time for the conservative marking. (but
401     not impressively much)
402     
403   */
404   sane_putenv ("GUILE_INIT_SEGMENT_SIZE_1", "4194304", false);
405   sane_putenv ("GUILE_MAX_SEGMENT_SIZE", "8388608", false);
406
407   init_kpath (argv[0]);
408
409   bool help_b = false;
410   oparser_p_static = new Getopt_long (argc, argv, options_static);
411   while (Long_option_init const * opt = (*oparser_p_static) ())
412     {
413       switch (opt->shortname_char_)
414         {
415         case 'v':
416           version ();
417           exit (0);             // we print a version anyway.
418           break;
419         case 'o':
420           {
421             String s = oparser_p_static->optional_argument_str0_;
422             Path p = split_path (s);
423             if (s != "-" && p.ext.is_empty ())
424               p.ext = output_format_global;
425
426             output_name_global = p.to_string ();
427           }
428           break;
429         case 'e':
430           init_scheme_code_string +=
431             oparser_p_static->optional_argument_str0_;
432           break;
433         case 'w':
434           notice ();
435           exit (0);
436           break;
437         case 'f':
438           if (oparser_p_static->optional_argument_str0_ == "help")
439             {
440               printf("This option is for developers only;  Read the source code for more information\n");
441               
442               // actually it's not here,
443               // but we award you special points for looking here.
444               
445               exit (0);
446             }
447           output_format_global = oparser_p_static->optional_argument_str0_;
448           break;
449         case 'P':
450             dependency_prefix_global = oparser_p_static->optional_argument_str0_;
451           break;
452         case 'H':
453           dump_header_fieldnames_global.push (oparser_p_static->optional_argument_str0_);
454           break;
455         case 'I':
456           global_path.push (oparser_p_static->optional_argument_str0_);
457           break;
458         case 'i':
459           init_name_global = oparser_p_static->optional_argument_str0_;
460           break;
461         case 'h':
462           help_b = true;
463           break;
464         case 'V':
465           verbose_global_b = true;
466           break;
467         case 's':
468           safe_global_b = true;
469           break;
470         case 'M':
471           dependency_global_b = true;
472           break; 
473         case 'm':
474           no_paper_global_b = true;
475           break;
476         default:
477           assert (false);
478           break;
479         }
480     }
481
482   if (help_b)
483     {
484       usage ();
485       if (verbose_global_b)
486         dirinfo (stdout);
487       exit (0);
488     }
489
490   scm_boot_guile (argc, argv, (void (*) (void*, int, char**))main_prog, 0);
491
492   return 0;                     // unreachable
493 }