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 # * Spacing before and after mudela blocks should be fixed. No empy lines
11 # before and after the mudela block should make just little space between
12 # music and text, one or more empy lines should make bigger space, like
14 # * center option (??)
15 # * make mudela-book understand usepackage{geometry}
16 # * check that linewidth set in \paper is not wider than actual linewidth?
17 # * the following fails because mudelabook doesn't care that the
18 # last } after \end{mudela} finishes the marginpar:
23 # * force-verbatim is maybe not that useful since latex fails with footnotes,
24 # marginpars and others
29 # much rewritten by new author. I think the work has been split more
30 # logical between different classes.
33 # - speedup, do all mudela parsing at the same time to avoid multiple
34 # guile startup that takes some seconds on my computer
36 # - fixed default latex fontsize, it should be 10pt not 11pt
37 # - verbatim option no longer visible
38 # - mudela-book produces .dvi output
39 # - change to use castingalgorithm = \Gourlay instead of \Wordwrap. It gives
40 # better result on small linewidths.
41 # - mudela-book-doc.doc rewritten
43 # - junked floating and fragment options, added eps option
44 # - mudela-book will scan the mudela code to find out if it has to add
45 # paper-definition and \score{\notes{...}}
46 # - possible to define commands that look like this: \mudela{ c d e }
47 # - don't produce .dvi output, it was a silly idea...
49 # - removed init/mudela-book-defs.py, \mudela is defined inside mudela-book
50 # - fragment and nonfragment options will override autodetection of type of
51 # in mudela-block (voice contents or complete code)
53 # - fixed verbatim option behaviour: don't show \begin{mudela} \end{mudela}
54 # and show both mudela code and music
55 # - veryverbatim option, same as verbatim but show \begin{mudela}
56 # and \end{mudela}. (saves keystrokes in mudela-book-doc.doc)
57 # - intertext="bla bla bla" option
58 # - mudela-book now understand latex \begin{verbatim}
60 # - bf: \mudela{ \times 2/3{...} }
61 # * \t in \times is not tab character and
62 # * dont treat the first '}' as command ending
64 # - .fly and .sly files in \mudelafile{} are treated as standalone Lilypond.
65 # - Fragments, .fly and .sly files are in \relative mode.
67 # - bf: Default fragments have linewidth=-1.0
68 # - Added 'singleline' and 'multiline' options.
70 # - \mudelafile{} set linewith correct, -1 for .sly and texlinewidth for .fly
71 # - changes to Mudela_output
72 # - changed RE to search for pre/postMudelaExample to make it possible to
73 # comment out a definition.
74 # - use sys.stderr and sys.stdout instead of print
83 program_version = '0.5.6'
88 fontsize_i2a = {11:'eleven', 13:'thirteen', 16:'sixteen',
89 20:'twenty', 26:'twentysix'}
90 fontsize_pt2i = {'11pt':11, '13pt':13, '16pt':16, '20pt':20, '26pt':26}
92 begin_mudela_re = re.compile ('^ *\\\\begin{mudela}')
93 begin_verbatim_re = re.compile ('^ *\\\\begin{verbatim}')
94 end_verbatim_re = re.compile ('^ *\\\\end{verbatim}')
95 extract_papersize_re = re.compile('\\\\documentclass[\[, ]*(\w*)paper[\w ,]*\]\{\w*\}')
96 extract_fontsize_re = re.compile('[ ,\[]*([0-9]*)pt')
97 begin_mudela_opts_re = re.compile('\[[^\]]*\]')
98 end_mudela_re = re.compile ('^ *\\\\end{mudela}')
99 section_re = re.compile ('\\\\section')
100 chapter_re = re.compile ('\\\\chapter')
101 input_re = re.compile ('^\\\\input{([^}]*)')
102 include_re = re.compile ('^\\\\include{([^}]*)')
103 begin_document_re = re.compile ('^ *\\\\begin{document}')
104 documentclass_re = re.compile('\\\\documentclass')
105 twocolumn_re = re.compile('\\\\twocolumn')
106 onecolumn_re = re.compile('\\\\onecolumn')
107 mudela_file_re = re.compile('\\\\mudelafile{([^}]+)}')
108 file_ext_re = re.compile('.+\\.([^.}]+$)')
109 preMudelaExample_re = re.compile('^\s*\\\\def\\\\preMudelaExample')
110 postMudelaExample_re = re.compile('^\s*\\\\def\\\\postMudelaExample')
111 boundingBox_re = re.compile('%%BoundingBox: ([0-9]+) ([0-9]+) ([0-9]+) ([0-9]+)')
112 intertext_re = re.compile("intertext=\"([^\"]*)\"")
114 def file_exist_b(name):
122 def ps_dimention(fname):
124 lines = fd.readlines()
126 s = boundingBox_re.search(line)
129 return (int(s.groups()[2])-int(s.groups()[0]),
130 int(s.groups()[3])-int(s.groups()[1]))
133 def find_file (name):
134 for a in include_path:
136 nm = os.path.join (a, name)
146 class SomethingIsSeriouslyBroken:
149 def file_mtime (name):
150 return os.stat (name)[8] #mod time
152 def need_recompile_b(infile, outfile):
153 indate = file_mtime (infile)
155 outdate = file_mtime (outfile)
156 return indate > outdate
161 # executes os.system(command) if infile is newer than
162 # outfile or outfile don't exist
164 def compile (command, workingdir, infile, outfile):
165 "Test if infile is newer than outfile. If so, cd to workingdir"
166 "and execute command"
167 indate = file_mtime (workingdir+infile)
169 outdate = file_mtime (workingdir+outfile)
170 recompile = indate > outdate
176 sys.stderr.write ('invoking `%s\'\n' % command)
178 status = os.system (command)
180 status = os.system ('cd %s; %s' %(workingdir, command))
190 1: {'a4':{10: 345, 11: 360, 12: 390},
191 'a5':{10: 276, 11: 276, 12: 276},
192 'b5':{10: 345, 11: 356, 12: 356},
193 'letter':{10: 345, 11: 360, 12: 390},
194 'legal': {10: 345, 11: 360, 12: 390},
195 'executive':{10: 345, 11: 360, 12: 379}},
196 2: {'a4':{10: 167, 11: 175, 12: 190},
197 'a5':{10: 133, 11: 133, 12: 133},
198 'b5':{10: 167, 11: 173, 12: 173},
199 'letter':{10: 167, 11: 175, 12: 190},
200 'legal':{10: 167, 11: 175, 12: 190},
201 'executive':{10: 167, 11: 175, 12: 184}}}
202 # >0 --> force all mudela to this pt size
203 self.force_mudela_fontsize = 0
204 self.force_verbatim_b = 0
206 'mudela-fontsize' : {'init': 16},
207 'papersize' : {'init': 'a4'},
208 'num-column' : {'init': 1},
209 'tex-fontsize' : {'init': 10}
211 def clear_for_new_file(self):
212 for var in self.__data.keys():
213 self.__data[var] = {'init': self.__data[var]['init']}
214 def clear_for_new_block(self):
215 for var in self.__data.keys():
216 if self.__data[var].has_key('block'):
217 del self.__data[var]['block']
218 def __get_variable(self, var):
219 if self.__data[var].has_key('block'):
220 return self.__data[var]['block']
221 elif self.__data[var].has_key('file'):
222 return self.__data[var]['file']
224 return self.__data[var]['init']
225 def setPapersize(self, size, requester):
226 self.__data['papersize'][requester] = size
227 def getPapersize(self):
228 return self.__get_variable('papersize')
229 def setMudelaFontsize(self, size, requester):
230 self.__data['mudela-fontsize'][requester] = size
231 def getMudelaFontsize(self):
232 if self.force_mudela_fontsize:
233 return self.force_mudela_fontsize
234 return self.__get_variable('mudela-fontsize')
235 def setTexFontsize(self, size, requester):
236 self.__data['tex-fontsize'][requester] = size
237 def getTexFontsize(self):
238 return self.__get_variable('tex-fontsize')
239 def setNumColumn(self, num, requester):
240 self.__data['num-column'][requester] = num
241 def getNumColumn(self):
242 return self.__get_variable('num-column')
243 def getLineWidth(self):
244 return self.__linewidth[self.getNumColumn()][self.getPapersize()][self.getTexFontsize()]
248 """ Using only self.code_type to deside both value of linewith and
249 if we have to put code into \score{...} was silly. Now we use:
250 self.code_type: show us what need to be added.
252 'NOTES' : add \context Voice{ ... }
253 'CONTEXT' : add \score{ ... }
255 self.single_line_b: 0 : linewidth=-1 1: linewith=textwidth
257 def __init__ (self, basename):
258 self.basename = basename
259 self.temp_filename = "%s/%s" %(outdir, 'mudela-temp.ly')
260 self.file = open (self.temp_filename, 'w')
263 self.graphic_type = 'tex'
264 self.code_type = None
265 self.single_line_b = 1
267 def write (self, line):
268 # match only if there is nothing but whitespace before \begin.
269 # we should not have to do this RE for every line
270 if re.search('^\s*\\\\begin{mudela}', line):
271 r = begin_mudela_opts_re.search(line)
274 self.optlist = re.compile('[\s,]*').split(o)
277 else: # ugh this is NOT bulletproof...
278 if not self.code_type:
279 if re.search('^\s*%', line) or re.search('^\s*$', line):
281 elif re.search('^\s*\\\\context', line):
282 self.code_type = 'CONTEXT'
283 self.single_line_b = 0
284 elif re.search('^\s*\\\\score', line) or \
285 re.search('^\s*\\\\paper', line) or \
286 re.search('^\s*\\\\header', line) or \
287 re.search('^\s*\\\\version', line) or \
288 re.search('^\s*\\\\include', line) or \
289 re.search('^\s*[A-Za-z]*\s*=', line):
290 self.code_type = 'COMPLETE'
291 self.single_line_b = 0
293 self.code_type = 'NOTES'
294 self.single_line_b = 1
295 self.__lines.append(line)
296 def write_red_tape(self):
297 if 'eps' in self.optlist:
298 self.graphic_type = 'eps'
299 #self.single_line_b = 1
300 if 'fragment' in self.optlist:
301 self.code_type = 'NOTES'
302 if 'nonfragment' in self.optlist:
303 self.code_type = 'COMPLETE'
304 if 'multiline' in self.optlist:
305 self.single_line_b = 0
306 for pt in fontsize_pt2i.keys():
307 if pt in self.optlist:
308 Props.setMudelaFontsize(fontsize_pt2i[pt], 'block')
309 self.file.write ('\\include \"paper%d.ly\"\n' \
310 % Props.getMudelaFontsize())
312 s = fontsize_i2a[Props.getMudelaFontsize()]
313 if 'singleline' in self.optlist:
314 self.single_line_b = 1
315 if self.single_line_b:
316 linewidth_str = 'linewidth = -1.\cm;'
318 linewidth_str = 'linewidth = %i.\\pt;' % Props.getLineWidth()
319 self.file.write("\\paper {"
322 + "castingalgorithm = \Gourlay; \n}")
323 #+ "castingalgorithm = \Wordwrap; indent = 2.\cm; \n}")
324 if self.code_type == 'CONTEXT':
325 self.file.write('\\score{\n\\notes\\relative c{')
326 if self.code_type == 'NOTES' :
327 self.file.write('\\score{\n\\notes\\relative c{\\context Voice{')
329 self.write_red_tape()
330 for l in self.__lines:
332 if self.code_type == 'CONTEXT':
333 self.file.write('}}')
334 elif self.code_type == 'NOTES':
335 self.file.write('}}}')
338 inf = outdir + self.basename + '.ly'
339 outf = outdir + self.basename + '.tex'
340 if not os.path.isfile(inf):
343 status = os.system ('diff -q %s %s' % (self.temp_filename, inf))
345 os.rename (self.temp_filename, inf)
347 recompile_b = need_recompile_b(inf, outf)
349 out_files.append((self.graphic_type, inf))
352 def insert_me_string(self):
353 "ugh the name of this function is wrong"
354 if self.graphic_type == 'tex':
355 return ['tex', self.basename]
356 elif self.graphic_type == 'eps':
357 return ['eps', self.basename]
359 raise SomethingIsSeriouslyBroken
362 def __init__ (self, name):
363 self.output_fn = '%s/%s' % (outdir, name)
365 def open_verbatim (self, line, level):
366 self.__lines.append('\\begin{verbatim}\n')
368 s = re.sub('veryverbatim[\s,]*', '', line)
369 s = re.sub('intertext=\"([^\"]*)\"[\s,]*', '', s)
370 s = re.sub(',\s*\]', ']', s)
371 s = re.sub('\[\]', '', s)
372 self.__lines.append(s);
373 def close_verbatim (self):
374 self.__lines.append('\\end{verbatim}\n')
376 self.__lines.append(s)
377 def create_graphics(self):
380 for line in self.__lines:
381 if type(line)==type([]):
384 if need_recompile_b(outdir+g[1]+'.ly', outdir+g[1]+'.tex'):
385 s = s + ' ' + g[1]+'.ly'
387 e = os.system('cd %s; lilypond %s' %(outdir, s))
389 sys.stderr.write("error: lilypond exited with value %i\n" % e)
393 compile('tex %s' % g[1]+'.tex', outdir, g[1]+'.tex', g[1]+'.dvi')
394 compile('dvips -E -o %s %s' %(g[1]+'.eps', g[1]+'.dvi'), outdir,
395 g[1]+'.dvi', g[1]+'.eps')
396 def write_outfile(self):
397 file = open(self.output_fn+'.latex', 'w')
398 file.write('% Created by mudela-book\n')
399 for line in self.__lines:
400 if type(line)==type([]):
402 #\\def\\interscoreline{}
403 file.write('\\preMudelaExample \\input %s \\postMudelaExample\n'\
404 # TeX applies the prefix of the main source automatically.
406 # % (outdir+line[1]+'.tex'))
408 ps_dim = ps_dimention(outdir+line[1]+'.eps')
409 file.write('\\noindent\\parbox{%ipt}{\includegraphics{%s}}\n' \
410 % (ps_dim[0], line[1]+'.eps'))
411 # % (ps_dim[0], outdir+line[1]+'.eps'))
416 # given parameter s="\mudela[some options]{CODE} some text and commands"
417 # it returns a tuple:
419 # where the last number is the index of the ending '}'
420 def extract_command(s):
424 for idx in range(len(s)):
426 if not start_found_b:
432 if (start_found_b == 1) and (count == 0):
434 return s[start+1:idx], idx
437 def __init__ (self, filename):
438 for fn in [filename, filename+'.tex', filename+'.doc']:
440 self.infile = open (fn)
447 def get_lines (self):
448 lines = self.infile.readlines ()
449 (retlines, retdeps) = ([],[self.filename])
451 r_inp = input_re.search (line)
452 r_inc = include_re.search (line)
454 # Filename rules for \input :
456 # 1. will search for file with exact that name (tex-input.my will be found)
457 # 2. will search for file with .tex ext, (tex-input.my
458 # will find tex-input.my.tex)
459 # input: with .tex ext
460 # 1. will find exact match
462 # Filename rules for \include :
463 # 1. will only find files with name given to \include + .tex ext
466 t = Tex_input (r_inp.groups()[0])
468 retlines = retlines + ls[0]
469 retdeps = retdeps + ls[1]
471 sys.stderr.write("warning: can't find %s, let's hope latex will\n" % r_inp.groups()[0])
472 retlines.append (line)
475 t = Tex_input (r_inc.groups()[0]+'.tex')
477 ls[0].insert(0, '\\newpage\n')
478 ls[0].append('\\newpage\n')
479 retlines = retlines + ls[0]
480 retdeps = retdeps + ls[1]
482 sys.stderr.write("warning: can't find %s, let's hope latex will" % r_inc.groups()[0])
483 retlines.append (line)
485 # This code should be rewritten, it looks terrible
486 r_mud = defined_mudela_cmd_re.search(line)
489 ss = "\\\\verb(?P<xx>[^a-zA-Z])\s*\\\\%s\s*(?P=xx)" \
490 % re.escape(r_mud.group()[1:])
491 # just append the line if the command is inside \verb|..|
492 if re.search(ss, line):
493 retlines.append(line)
496 opts = r_mud.groups()[2]
497 cmd_start_idx = r_mud.span()[0]
498 if cmd_start_idx > 0:
499 retlines.append(line[:cmd_start_idx])
501 cmd_data, rest_idx = extract_command(line[cmd_start_idx:])
502 rest_idx = rest_idx + cmd_start_idx + 1
508 v = string.split(defined_mudela_cmd[r_mud.groups()[0]], '\n')
510 l = string.replace(l, '\\fontoptions', opts)
511 l = string.replace(l, '\\maininput', cmd_data)
513 r_mud = defined_mudela_cmd_re.search(line[rest_idx:])
519 retlines.append(line[rest_idx:])
521 line = line[rest_idx:]
523 retlines.append (line)
524 return (retlines, retdeps)
527 class Main_tex_input(Tex_input):
528 def __init__ (self, name, outname):
530 Tex_input.__init__ (self, name) # ugh
531 self.outname = outname
535 self.mudtex = Tex_output (self.outname)
539 # set to 'mudela' when we are processing mudela code,
540 # both verbatim and graphic-to-be
542 def set_sections (self, l):
543 if section_re.search (l):
544 self.section = self.section + 1
545 if chapter_re.search (l):
547 self.chapter = self.chapter + 1
549 def gen_basename (self):
550 return '%s-%d.%d.%d' % (self.outname, self.chapter,
551 self.section, self.fine_count)
552 def extract_papersize_from_documentclass(self, line):
553 pre = extract_papersize_re.search(line)
556 return pre.groups()[0]
557 def extract_fontsize_from_documentclass(self, line):
558 r = extract_fontsize_re.search(line)
560 return int(r.groups()[0])
562 preMudelaDef = postMudelaDef = 0
563 (lines, self.deps) = self.get_lines ()
567 if documentclass_re.search (line):
568 p = self.extract_papersize_from_documentclass (line)
570 Props.setPapersize(p, 'file')
571 f = self.extract_fontsize_from_documentclass (line)
573 Props.setTexFontsize (f, 'file')
574 elif twocolumn_re.search (line):
575 Props.setNumColumn (2, 'file')
576 elif onecolumn_re.search (line):
577 Props.setNumColumn (1, 'file')
578 elif preMudelaExample_re.search (line):
580 elif postMudelaExample_re.search (line):
582 elif begin_verbatim_re.search (line):
584 elif end_verbatim_re.search (line):
586 elif begin_document_re.search (line):
588 self.mudtex.write ('\\def\\preMudelaExample{}\n')
589 if not postMudelaDef:
590 self.mudtex.write ('\\def\\postMudelaExample{}\n')
592 elif mudela_file_re.search(line):
593 r = mudela_file_re.search(line)
595 self.mudela = Mudela_output(self.gen_basename())
597 full_path = find_file (fn)
599 sys.stderr.write("error: can't find file '%s'\n" % fn)
602 f = open (full_path, 'r')
603 lines =f.readlines ()
605 self.mudela.write (x)
606 r = file_ext_re.search(fn)
608 if r.group(1) == 'fly':
609 self.mudela.optlist.append('multiline')
610 stat =self.mudela.close ()
612 sys.stdout.write("(File %s needs recompiling)\n" % full_path)
613 self.mudtex.write (self.mudela.insert_me_string())
614 self.deps.append (full_path)
617 self.fine_count = self.fine_count + 1
619 elif begin_mudela_re.search (line) and not latex_verbatim:
620 Props.clear_for_new_block()
622 if self.mode == 'mudela':
625 r = begin_mudela_opts_re.search (line)
627 o = r.group()[1:][:-1]
628 optlist = re.compile('[ ,]*').split(o)
629 m = intertext_re.search(r.group())
631 self.intertext = m.groups()[0]
633 self.intertext = None
636 if ('veryverbatim' in optlist):
638 elif ('verbatim' in optlist) or (Props.force_verbatim_b):
643 self.mudtex.open_verbatim (line, self.verbatim)
644 self.mudela = Mudela_output (self.gen_basename ())
645 self.mudela.write (line)
647 elif end_mudela_re.search (line) and not latex_verbatim:
649 if self.mode != 'mudela':
653 if self.verbatim == 2:
654 self.mudtex.write (line)
655 self.mudtex.close_verbatim ()
657 if self.verbatim and self.intertext:
658 self.mudtex.write(self.intertext)
659 self.mudtex.write (self.mudela.insert_me_string())
662 self.fine_count = self.fine_count + 1
667 if self.mode == 'mudela':
668 self.mudela.write (line)
670 self.mudtex.write (line)
672 self.mudtex.write (line)
673 self.set_sections(line)
674 self.mudtex.create_graphics()
675 self.mudtex.write_outfile()
680 sys.stdout.write("""Usage: mudela-book [options] FILE\n
681 Generate hybrid LaTeX input from Latex + mudela
683 -h, --help print this help
684 -d, --outdir=DIR directory to put generated files
685 -o, --outname=FILE prefix for filenames
686 --default-mudela-fontsize=??pt default fontsize for music
687 --force-mudela-fontsize=??pt force fontsize for all inline mudela
688 --force-verbatim make all mudela verbatim\n
689 --dependencies write dependencies
690 --include include path
691 --init mudela-book initfile
697 def write_deps (fn, out, deps):
698 out_fn = os.path.join (outdir, fn)
700 sys.stdout.write('writing `%s\'\n' % out_fn)
702 f = open (out_fn, 'w')
703 target = re.sub (os.sep + os.sep, os.sep, os.path.join (outdir, out + '.latex'))
704 f.write ('%s: %s\n'% (target,
705 reduce (lambda x,y: x + ' '+ y, deps)))
709 sys.stderr.write ('This is %s version %s\n' % ('mudela-book', program_version))
712 global outdir, initfile, defined_mudela_cmd, defined_mudela_cmd_re
715 (options, files) = getopt.getopt(
716 sys.argv[1:], 'hd:o:I:', ['outdir=', 'outname=',
717 'default-mudela-fontsize=',
718 'force-mudela-fontsize=',
719 'help', 'dependencies', 'include=',
720 'force-verbatim', 'init='])
721 except getopt.error, msg:
722 sys.stderr.write("error: %s" % msg)
729 if o == '--include' or o == '-I':
730 include_path.append (a)
731 elif o == '--outname' or o == '-o':
734 sys.stderr.write("Mudela-book is confused by --outname on multiple files")
737 elif o == '--outdir' or o == '-d':
739 elif o == '--help' or o == '-h':
741 elif o == '--dependencies':
743 elif o == '--default-mudela-fontsize':
744 if not fontsize_pt2i.has_key(a):
745 sys.stderr.write("Error: illegal fontsize: %s" % a)
746 sys.stderr.write(" accepted fontsizes are: 11pt, 13pt, 16pt, 20pt, 26pt")
748 Props.setMudelaFontsize(fontsize_pt2i[a], 'init')
749 elif o == '--force-mudela-fontsize':
750 if not fontsize_pt2i.has_key(a):
751 sys.stderr.write("Error: illegal fontsize: %s" % a)
752 sys.stderr.write(" accepted fontsizes are: 11pt, 13pt, 16pt, 20pt, 26pt")
754 Props.force_mudela_fontsize = fontsize_pt2i[a]
755 elif o == '--force-verbatim':
756 Props.force_verbatim_b = 1
759 if outdir[-1:] != '/':
760 outdir = outdir + '/'
762 # r""" ... """ means: leave escape seqs alone.
763 defined_mudela_cmd = {'mudela': r"""
764 \begin{mudela}[eps, singleline \fontoptions]
778 defined_mudela_cmd[i] = d[i]
781 c = string.join (defined_mudela_cmd.keys(), '|')
783 defined_mudela_cmd_re = re.compile("\\\\(%s)(\[(\d*pt)\])*{([^}]*)}" %c)
785 if not os.path.isdir(outdir):
786 os.system('mkdir %s' % outdir)
788 for input_filename in files:
789 Props.clear_for_new_file()
793 my_outname = os.path.basename(os.path.splitext(input_filename)[0])
794 my_depname = my_outname + '.dep'
795 inp = Main_tex_input (input_filename, my_outname)
798 write_deps (my_depname, my_outname, inp.deps)