3 # The bugs you find are made by Tom Cato Amundsen <tomcato@xoommail.com>
4 # Send patches/questions/bugreports to a mailinglist:
5 # gnu-music-discuss@gnu.org
6 # bug-gnu-music@gnu.org
7 # help-gnu-music@gnu.org
10 # * center option (??)
11 # * make mudela-book understand usepackage{geometry}
12 # * check that linewidth set in \paper is not wider than actual linewidth?
13 # * the following fails because mudelabook doesn't care that the
14 # last } after \end{mudela} finishes the marginpar:
19 # * force-verbatim is maybe not that useful since latex fails with footnotes,
20 # marginpars and others
25 # much rewritten by new author. I think the work has been split more
26 # logical between different classes.
29 # - speedup, do all mudela parsing at the same time to avoid multiple
30 # guile startup that takes some seconds on my computer
32 # - fixed default latex fontsize, it should be 10pt not 11pt
33 # - verbatim option no longer visible
34 # - mudela-book produces .dvi output
35 # - change to use castingalgorithm = \Gourlay instead of \Wordwrap. It gives
36 # better result on small linewidths.
37 # - mudela-book-doc.doc rewritten
39 # - junked floating and fragment options, added eps option
40 # - mudela-book will scan the mudela code to find out if it has to add
41 # paper-definition and \score{\notes{...}}
42 # - possible to define commands that look like this: \mudela{ c d e }
43 # - don't produce .dvi output, it was a silly idea...
45 # - removed init/mudela-book-defs.py, \mudela is defined inside mudela-book
46 # - fragment and nonfragment options will override autodetection of type of
47 # in mudela-block (voice contents or complete code)
49 # - fixed verbatim option behaviour: don't show \begin{mudela} \end{mudela}
50 # and show both mudela code and music
51 # - veryverbatim option, same as verbatim but show \begin{mudela}
52 # and \end{mudela}. (saves keystrokes in mudela-book-doc.doc)
53 # - intertext="bla bla bla" option
54 # - mudela-book now understand latex \begin{verbatim}
56 # - bf: \mudela{ \times 2/3{...} }
57 # * \t in \times is not tab character and
58 # * dont treat the first '}' as command ending
60 # - .fly and .sly files in \mudelafile{} are treated as standalone Lilypond.
61 # - Fragments, .fly and .sly files are in \relative mode.
63 # - bf: Default fragments have linewidth=-1.0
64 # - Added 'singleline' and 'multiline' options.
66 # - \mudelafile{} set linewidth correct, -1 for .sly and texlinewidth for .fly
67 # - changes to Mudela_output
68 # - changed RE to search for pre/postMudelaExample to make it possible to
69 # comment out a definition.
70 # - use sys.stderr and sys.stdout instead of print
79 program_version = '0.5.6'
84 fontsize_i2a = {11:'eleven', 13:'thirteen', 16:'sixteen',
85 20:'twenty', 26:'twentysix'}
86 fontsize_pt2i = {'11pt':11, '13pt':13, '16pt':16, '20pt':20, '26pt':26}
88 # perhaps we can do without this?
90 begin_mudela_re = re.compile ('^ *\\\\begin{mudela}')
91 begin_verbatim_re = re.compile ('^ *\\\\begin{verbatim}')
92 end_verbatim_re = re.compile ('^ *\\\\end{verbatim}')
93 extract_papersize_re = re.compile('\\\\documentclass[\[, ]*(\w*)paper[\w ,]*\]\{\w*\}')
94 extract_fontsize_re = re.compile('[ ,\[]*([0-9]*)pt')
95 begin_mudela_opts_re = re.compile('\[[^\]]*\]')
96 end_mudela_re = re.compile ('^ *\\\\end{mudela}')
97 section_re = re.compile ('\\\\section')
98 chapter_re = re.compile ('\\\\chapter')
99 input_re = re.compile ('^\\\\input{([^}]*)')
100 include_re = re.compile ('^\\\\include{([^}]*)')
101 begin_document_re = re.compile ('^ *\\\\begin{document}')
102 documentclass_re = re.compile('\\\\documentclass')
103 twocolumn_re = re.compile('\\\\twocolumn')
104 onecolumn_re = re.compile('\\\\onecolumn')
105 mudela_file_re = re.compile('\\\\mudelafile{([^}]+)}')
106 file_ext_re = re.compile('.+\\.([^.}]+$)')
107 preMudelaExample_re = re.compile('^\s*\\\\def\\\\preMudelaExample')
108 postMudelaExample_re = re.compile('^\s*\\\\def\\\\postMudelaExample')
109 boundingBox_re = re.compile('%%BoundingBox: ([0-9]+) ([0-9]+) ([0-9]+) ([0-9]+)')
110 intertext_re = re.compile("intertext=\"([^\"]*)\"")
112 def file_exist_b(name):
120 def ps_dimention(fname):
122 lines = fd.readlines()
124 s = boundingBox_re.search(line)
127 return (int(s.groups()[2])-int(s.groups()[0]),
128 int(s.groups()[3])-int(s.groups()[1]))
131 def find_file (name):
132 for a in include_path:
134 nm = os.path.join (a, name)
144 class SomethingIsSeriouslyBroken:
147 def file_mtime (name):
148 return os.stat (name)[8] #mod time
150 def need_recompile_b(infile, outfile):
151 indate = file_mtime (infile)
153 outdate = file_mtime (outfile)
154 return indate > outdate
159 # executes os.system(command) if infile is newer than
160 # outfile or outfile don't exist
162 def compile (command, workingdir, infile, outfile):
163 "Test if infile is newer than outfile. If so, cd to workingdir"
164 "and execute command"
165 indate = file_mtime (workingdir+infile)
167 outdate = file_mtime (workingdir+outfile)
168 recompile = indate > outdate
174 sys.stderr.write ('invoking `%s\'\n' % command)
176 status = os.system (command)
178 status = os.system ('cd %s; %s' %(workingdir, command))
188 1: {'a4':{10: 345, 11: 360, 12: 390},
189 'a5':{10: 276, 11: 276, 12: 276},
190 'b5':{10: 345, 11: 356, 12: 356},
191 'letter':{10: 345, 11: 360, 12: 390},
192 'legal': {10: 345, 11: 360, 12: 390},
193 'executive':{10: 345, 11: 360, 12: 379}},
194 2: {'a4':{10: 167, 11: 175, 12: 190},
195 'a5':{10: 133, 11: 133, 12: 133},
196 'b5':{10: 167, 11: 173, 12: 173},
197 'letter':{10: 167, 11: 175, 12: 190},
198 'legal':{10: 167, 11: 175, 12: 190},
199 'executive':{10: 167, 11: 175, 12: 184}}}
200 # >0 --> force all mudela to this pt size
201 self.force_mudela_fontsize = 0
202 self.force_verbatim_b = 0
204 'mudela-fontsize' : {'init': 16},
205 'papersize' : {'init': 'a4'},
206 'num-column' : {'init': 1},
207 'tex-fontsize' : {'init': 10}
209 def clear_for_new_file(self):
210 for var in self.__data.keys():
211 self.__data[var] = {'init': self.__data[var]['init']}
212 def clear_for_new_block(self):
213 for var in self.__data.keys():
214 if self.__data[var].has_key('block'):
215 del self.__data[var]['block']
216 def __get_variable(self, var):
217 if self.__data[var].has_key('block'):
218 return self.__data[var]['block']
219 elif self.__data[var].has_key('file'):
220 return self.__data[var]['file']
222 return self.__data[var]['init']
223 def setPapersize(self, size, requester):
224 self.__data['papersize'][requester] = size
225 def getPapersize(self):
226 return self.__get_variable('papersize')
227 def setMudelaFontsize(self, size, requester):
228 self.__data['mudela-fontsize'][requester] = size
229 def getMudelaFontsize(self):
230 if self.force_mudela_fontsize:
231 return self.force_mudela_fontsize
232 return self.__get_variable('mudela-fontsize')
233 def setTexFontsize(self, size, requester):
234 self.__data['tex-fontsize'][requester] = size
235 def getTexFontsize(self):
236 return self.__get_variable('tex-fontsize')
237 def setNumColumn(self, num, requester):
238 self.__data['num-column'][requester] = num
239 def getNumColumn(self):
240 return self.__get_variable('num-column')
241 def getLineWidth(self):
242 return self.__linewidth[self.getNumColumn()][self.getPapersize()][self.getTexFontsize()]
246 """ Using only self.code_type to deside both value of linewith and
247 if we have to put code into \score{...} was silly. Now we use:
248 self.code_type: show us what need to be added.
250 'NOTES' : add \context Voice{ ... }
251 'CONTEXT' : add \score{ ... }
253 self.single_line_b: 0 : linewidth=-1 1: linewith=textwidth
255 def __init__ (self, basename):
256 self.basename = basename
257 self.temp_filename = "%s/%s" %(outdir, 'mudela-temp.ly')
258 self.file = open (self.temp_filename, 'w')
261 self.graphic_type = 'tex'
262 self.code_type = None
263 self.single_line_b = 1
265 def write (self, line):
266 # match only if there is nothing but whitespace before \begin.
267 # we should not have to do this RE for every line
268 if re.search('^\s*\\\\begin{mudela}', line):
269 r = begin_mudela_opts_re.search(line)
272 self.optlist = re.compile('[\s,]*').split(o)
275 else: # ugh this is NOT bulletproof...
276 if not self.code_type:
277 if re.search('^\s*%', line) or re.search('^\s*$', line):
279 elif re.search('^\s*\\\\context', line):
280 self.code_type = 'CONTEXT'
281 self.single_line_b = 0
282 elif re.search('^\s*\\\\score', line) or \
283 re.search('^\s*\\\\paper', line) or \
284 re.search('^\s*\\\\header', line) or \
285 re.search('^\s*\\\\version', line) or \
286 re.search('^\s*\\\\include', line) or \
287 re.search('^\s*[A-Za-z]*\s*=', line):
288 self.code_type = 'COMPLETE'
289 self.single_line_b = 0
291 self.code_type = 'NOTES'
292 self.single_line_b = 1
293 self.__lines.append(line)
294 def write_red_tape(self):
295 if 'eps' in self.optlist:
296 self.graphic_type = 'eps'
297 #self.single_line_b = 1
298 if 'fragment' in self.optlist:
299 self.code_type = 'NOTES'
300 if 'nonfragment' in self.optlist:
301 self.code_type = 'COMPLETE'
302 if 'multiline' in self.optlist:
303 self.single_line_b = 0
304 for pt in fontsize_pt2i.keys():
305 if pt in self.optlist:
306 Props.setMudelaFontsize(fontsize_pt2i[pt], 'block')
307 self.file.write ('\\include \"paper%d.ly\"\n' \
308 % Props.getMudelaFontsize())
310 s = fontsize_i2a[Props.getMudelaFontsize()]
311 if 'singleline' in self.optlist:
312 self.single_line_b = 1
313 if self.single_line_b:
314 linewidth_str = 'linewidth = -1.\cm;'
316 linewidth_str = 'linewidth = %i.\\pt;' % Props.getLineWidth()
317 self.file.write("\\paper {"
320 + "castingalgorithm = \Gourlay; \n}")
321 #+ "castingalgorithm = \Wordwrap; indent = 2.\cm; \n}")
322 if self.code_type == 'CONTEXT':
323 self.file.write('\\score{\n\\notes\\relative c{')
324 if self.code_type == 'NOTES' :
325 self.file.write('\\score{\n\\notes\\relative c{\\context Voice{')
327 self.write_red_tape()
328 for l in self.__lines:
330 if self.code_type == 'CONTEXT':
331 self.file.write('}}')
332 elif self.code_type == 'NOTES':
333 self.file.write('}}}')
336 inf = outdir + self.basename + '.ly'
337 outf = outdir + self.basename + '.tex'
338 if not os.path.isfile(inf):
341 status = os.system ('diff -q %s %s' % (self.temp_filename, inf))
343 os.rename (self.temp_filename, inf)
345 recompile_b = need_recompile_b(inf, outf)
347 out_files.append((self.graphic_type, inf))
350 def insert_me_string(self):
351 "ugh the name of this function is wrong"
352 if self.graphic_type == 'tex':
353 return ['tex', self.basename]
354 elif self.graphic_type == 'eps':
355 return ['eps', self.basename]
357 raise SomethingIsSeriouslyBroken
360 def __init__ (self, name):
361 self.output_fn = '%s/%s' % (outdir, name)
363 def open_verbatim (self, line, level):
364 self.__lines.append('\\begin{verbatim}\n')
366 s = re.sub('veryverbatim[\s,]*', '', line)
367 s = re.sub('intertext=\"([^\"]*)\"[\s,]*', '', s)
368 s = re.sub(',\s*\]', ']', s)
369 s = re.sub('\[\]', '', s)
370 self.__lines.append(s);
371 def close_verbatim (self):
372 self.__lines.append('\\end{verbatim}\n')
374 self.__lines.append(s)
375 def create_graphics(self):
378 for line in self.__lines:
379 if type(line)==type([]):
382 if need_recompile_b(outdir+g[1]+'.ly', outdir+g[1]+'.tex'):
383 s = s + ' ' + g[1]+'.ly'
385 e = os.system('cd %s; lilypond %s' %(outdir, s))
387 sys.stderr.write("error: lilypond exited with value %i\n" % e)
391 compile('tex %s' % g[1]+'.tex', outdir, g[1]+'.tex', g[1]+'.dvi')
392 compile('dvips -E -o %s %s' %(g[1]+'.eps', g[1]+'.dvi'), outdir,
393 g[1]+'.dvi', g[1]+'.eps')
394 def write_outfile(self):
395 file = open(self.output_fn+'.latex', 'w')
396 file.write('% Created by mudela-book\n')
398 for line in self.__lines:
399 if type(line)==type([]):
400 if last_line == '\n':
401 file.write(r'\vspace{0.5cm}')
403 file.write('\\preMudelaExample \\input %s \\postMudelaExample\n'\
406 ps_dim = ps_dimention(outdir+line[1]+'.eps')
407 file.write('\\noindent\\parbox{%ipt}{\includegraphics{%s}}\n' \
408 % (ps_dim[0], line[1]+'.eps'))
411 if type(last_line)==type([]):
413 file.write(r'\vspace{0.5cm}')
417 # given parameter s="\mudela[some options]{CODE} some text and commands"
418 # it returns a tuple:
420 # where the last number is the index of the ending '}'
421 def extract_command(s):
425 for idx in range(len(s)):
427 if not start_found_b:
433 if (start_found_b == 1) and (count == 0):
435 return s[start+1:idx], idx
438 def __init__ (self, filename):
439 for fn in [filename, filename+'.tex', filename+'.doc']:
441 self.infile = open (fn)
448 def get_lines (self):
449 lines = self.infile.readlines ()
450 (retlines, retdeps) = ([],[self.filename])
452 r_inp = input_re.search (line)
453 r_inc = include_re.search (line)
455 # Filename rules for \input :
457 # 1. will search for file with exact that name (tex-input.my will be found)
458 # 2. will search for file with .tex ext, (tex-input.my
459 # will find tex-input.my.tex)
460 # input: with .tex ext
461 # 1. will find exact match
463 # Filename rules for \include :
464 # 1. will only find files with name given to \include + .tex ext
467 t = Tex_input (r_inp.groups()[0])
469 retlines = retlines + ls[0]
470 retdeps = retdeps + ls[1]
472 sys.stderr.write("warning: can't find %s, let's hope latex will\n" % r_inp.groups()[0])
473 retlines.append (line)
476 t = Tex_input (r_inc.groups()[0]+'.tex')
478 ls[0].insert(0, '\\newpage\n')
479 ls[0].append('\\newpage\n')
480 retlines = retlines + ls[0]
481 retdeps = retdeps + ls[1]
483 sys.stderr.write("warning: can't find %s, let's hope latex will" % r_inc.groups()[0])
484 retlines.append (line)
486 # This code should be rewritten, it looks terrible
487 r_mud = defined_mudela_cmd_re.search(line)
490 ss = "\\\\verb(?P<xx>[^a-zA-Z])\s*\\\\%s\s*(?P=xx)" \
491 % re.escape(r_mud.group()[1:])
492 # just append the line if the command is inside \verb|..|
493 if re.search(ss, line):
494 retlines.append(line)
497 opts = r_mud.groups()[2]
498 cmd_start_idx = r_mud.span()[0]
499 if cmd_start_idx > 0:
500 retlines.append(line[:cmd_start_idx])
502 cmd_data, rest_idx = extract_command(line[cmd_start_idx:])
503 rest_idx = rest_idx + cmd_start_idx + 1
509 v = string.split(defined_mudela_cmd[r_mud.groups()[0]], '\n')
511 l = string.replace(l, '\\fontoptions', opts)
512 l = string.replace(l, '\\maininput', cmd_data)
514 r_mud = defined_mudela_cmd_re.search(line[rest_idx:])
520 retlines.append(line[rest_idx:])
522 line = line[rest_idx:]
524 retlines.append (line)
525 return (retlines, retdeps)
528 class Main_tex_input(Tex_input):
529 def __init__ (self, name, outname):
531 Tex_input.__init__ (self, name) # ugh
532 self.outname = outname
536 self.mudtex = Tex_output (self.outname)
540 # set to 'mudela' when we are processing mudela code,
541 # both verbatim and graphic-to-be
543 def set_sections (self, l):
544 if section_re.search (l):
545 self.section = self.section + 1
546 if chapter_re.search (l):
548 self.chapter = self.chapter + 1
550 def gen_basename (self):
551 return '%s-%d.%d.%d' % (self.outname, self.chapter,
552 self.section, self.fine_count)
553 def extract_papersize_from_documentclass(self, line):
554 pre = extract_papersize_re.search(line)
557 return pre.groups()[0]
558 def extract_fontsize_from_documentclass(self, line):
559 r = extract_fontsize_re.search(line)
561 return int(r.groups()[0])
563 preMudelaDef = postMudelaDef = 0
564 (lines, self.deps) = self.get_lines ()
568 if documentclass_re.search (line):
569 p = self.extract_papersize_from_documentclass (line)
571 Props.setPapersize(p, 'file')
572 f = self.extract_fontsize_from_documentclass (line)
574 Props.setTexFontsize (f, 'file')
575 elif twocolumn_re.search (line):
576 Props.setNumColumn (2, 'file')
577 elif onecolumn_re.search (line):
578 Props.setNumColumn (1, 'file')
579 elif preMudelaExample_re.search (line):
581 elif postMudelaExample_re.search (line):
583 elif begin_verbatim_re.search (line):
585 elif end_verbatim_re.search (line):
587 elif begin_document_re.search (line):
589 self.mudtex.write ('\\def\\preMudelaExample{}\n')
590 if not postMudelaDef:
591 self.mudtex.write ('\\def\\postMudelaExample{}\n')
593 elif mudela_file_re.search(line):
594 r = mudela_file_re.search(line)
596 self.mudela = Mudela_output(self.gen_basename())
598 full_path = find_file (fn)
600 sys.stderr.write("error: can't find file '%s'\n" % fn)
603 f = open (full_path, 'r')
604 lines =f.readlines ()
605 self.mudela.write ('%% This is a copy of file %s\n' % full_path)
607 self.mudela.write (x)
608 r = file_ext_re.search(fn)
610 if r.group(1) == 'fly':
611 self.mudela.optlist.append('multiline')
612 stat =self.mudela.close ()
614 sys.stdout.write("(File %s needs recompiling)\n" % full_path)
615 self.mudtex.write (self.mudela.insert_me_string())
616 self.deps.append (full_path)
619 self.fine_count = self.fine_count + 1
621 elif begin_mudela_re.search (line) and not latex_verbatim:
622 Props.clear_for_new_block()
624 if self.mode == 'mudela':
627 r = begin_mudela_opts_re.search (line)
629 o = r.group()[1:][:-1]
630 optlist = re.compile('[ ,]*').split(o)
631 m = intertext_re.search(r.group())
633 self.intertext = m.groups()[0]
635 self.intertext = None
638 if ('veryverbatim' in optlist):
640 elif ('verbatim' in optlist) or (Props.force_verbatim_b):
645 self.mudtex.open_verbatim (line, self.verbatim)
646 self.mudela = Mudela_output (self.gen_basename ())
647 self.mudela.write (line)
649 elif end_mudela_re.search (line) and not latex_verbatim:
651 if self.mode != 'mudela':
655 if self.verbatim == 2:
656 self.mudtex.write (line)
657 self.mudtex.close_verbatim ()
659 if self.verbatim and self.intertext:
660 self.mudtex.write(self.intertext)
661 self.mudtex.write (self.mudela.insert_me_string())
664 self.fine_count = self.fine_count + 1
669 if self.mode == 'mudela':
670 self.mudela.write (line)
672 self.mudtex.write (line)
674 self.mudtex.write (line)
675 self.set_sections(line)
676 self.mudtex.create_graphics()
677 self.mudtex.write_outfile()
682 sys.stdout.write("""Usage: mudela-book [options] FILE\n
683 Generate hybrid LaTeX input from Latex + mudela
685 -h, --help print this help
686 -d, --outdir=DIR directory to put generated files
687 -o, --outname=FILE prefix for filenames
688 --default-mudela-fontsize=??pt default fontsize for music
689 --force-mudela-fontsize=??pt force fontsize for all inline mudela
690 --force-verbatim make all mudela verbatim\n
691 --dependencies write dependencies
692 --include include path
693 --init mudela-book initfile
699 def write_deps (fn, out, deps):
700 out_fn = os.path.join (outdir, fn)
702 sys.stdout.write('writing `%s\'\n' % out_fn)
704 f = open (out_fn, 'w')
705 target = re.sub (os.sep + os.sep, os.sep, os.path.join (outdir, out + '.latex'))
706 f.write ('%s: %s\n'% (target,
707 reduce (lambda x,y: x + ' '+ y, deps)))
711 sys.stderr.write ('This is %s version %s\n' % ('mudela-book', program_version))
714 global outdir, initfile, defined_mudela_cmd, defined_mudela_cmd_re
717 (options, files) = getopt.getopt(
718 sys.argv[1:], 'hd:o:I:', ['outdir=', 'outname=',
719 'default-mudela-fontsize=',
720 'force-mudela-fontsize=',
721 'help', 'dependencies', 'include=',
722 'force-verbatim', 'init='])
723 except getopt.error, msg:
724 sys.stderr.write("error: %s" % msg)
731 if o == '--include' or o == '-I':
732 include_path.append (a)
733 elif o == '--outname' or o == '-o':
736 sys.stderr.write("Mudela-book is confused by --outname on multiple files")
739 elif o == '--outdir' or o == '-d':
741 elif o == '--help' or o == '-h':
743 elif o == '--dependencies':
745 elif o == '--default-mudela-fontsize':
746 if not fontsize_pt2i.has_key(a):
747 sys.stderr.write("Error: invalid fontsize: %s" % a)
748 sys.stderr.write(" accepted fontsizes are: 11pt, 13pt, 16pt, 20pt, 26pt")
750 Props.setMudelaFontsize(fontsize_pt2i[a], 'init')
751 elif o == '--force-mudela-fontsize':
752 if not fontsize_pt2i.has_key(a):
753 sys.stderr.write("Error: invalid fontsize: %s" % a)
754 sys.stderr.write(" accepted fontsizes are: 11pt, 13pt, 16pt, 20pt, 26pt")
756 Props.force_mudela_fontsize = fontsize_pt2i[a]
757 elif o == '--force-verbatim':
758 Props.force_verbatim_b = 1
761 if outdir[-1:] != '/':
762 outdir = outdir + '/'
764 # r""" ... """ means: leave escape seqs alone.
765 defined_mudela_cmd = {'mudela': r"""
766 \begin{mudela}[eps, singleline \fontoptions]
780 defined_mudela_cmd[i] = d[i]
783 c = string.join (defined_mudela_cmd.keys(), '|')
785 defined_mudela_cmd_re = re.compile("\\\\(%s)(\[(\d*pt)\])*{([^}]*)}" %c)
787 if not os.path.isdir(outdir):
788 os.system('mkdir %s' % outdir)
790 for input_filename in files:
791 Props.clear_for_new_file()
795 my_outname = os.path.basename(os.path.splitext(input_filename)[0])
796 my_depname = my_outname + '.dep'
797 inp = Main_tex_input (input_filename, my_outname)
800 write_deps (my_depname, my_outname, inp.deps)