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 linewith 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 begin_mudela_re = re.compile ('^ *\\\\begin{mudela}')
89 begin_verbatim_re = re.compile ('^ *\\\\begin{verbatim}')
90 end_verbatim_re = re.compile ('^ *\\\\end{verbatim}')
91 extract_papersize_re = re.compile('\\\\documentclass[\[, ]*(\w*)paper[\w ,]*\]\{\w*\}')
92 extract_fontsize_re = re.compile('[ ,\[]*([0-9]*)pt')
93 begin_mudela_opts_re = re.compile('\[[^\]]*\]')
94 end_mudela_re = re.compile ('^ *\\\\end{mudela}')
95 section_re = re.compile ('\\\\section')
96 chapter_re = re.compile ('\\\\chapter')
97 input_re = re.compile ('^\\\\input{([^}]*)')
98 include_re = re.compile ('^\\\\include{([^}]*)')
99 begin_document_re = re.compile ('^ *\\\\begin{document}')
100 documentclass_re = re.compile('\\\\documentclass')
101 twocolumn_re = re.compile('\\\\twocolumn')
102 onecolumn_re = re.compile('\\\\onecolumn')
103 mudela_file_re = re.compile('\\\\mudelafile{([^}]+)}')
104 file_ext_re = re.compile('.+\\.([^.}]+$)')
105 preMudelaExample_re = re.compile('^\s*\\\\def\\\\preMudelaExample')
106 postMudelaExample_re = re.compile('^\s*\\\\def\\\\postMudelaExample')
107 boundingBox_re = re.compile('%%BoundingBox: ([0-9]+) ([0-9]+) ([0-9]+) ([0-9]+)')
108 intertext_re = re.compile("intertext=\"([^\"]*)\"")
110 def file_exist_b(name):
118 def ps_dimention(fname):
120 lines = fd.readlines()
122 s = boundingBox_re.search(line)
125 return (int(s.groups()[2])-int(s.groups()[0]),
126 int(s.groups()[3])-int(s.groups()[1]))
129 def find_file (name):
130 for a in include_path:
132 nm = os.path.join (a, name)
142 class SomethingIsSeriouslyBroken:
145 def file_mtime (name):
146 return os.stat (name)[8] #mod time
148 def need_recompile_b(infile, outfile):
149 indate = file_mtime (infile)
151 outdate = file_mtime (outfile)
152 return indate > outdate
157 # executes os.system(command) if infile is newer than
158 # outfile or outfile don't exist
160 def compile (command, workingdir, infile, outfile):
161 "Test if infile is newer than outfile. If so, cd to workingdir"
162 "and execute command"
163 indate = file_mtime (workingdir+infile)
165 outdate = file_mtime (workingdir+outfile)
166 recompile = indate > outdate
172 sys.stderr.write ('invoking `%s\'\n' % command)
174 status = os.system (command)
176 status = os.system ('cd %s; %s' %(workingdir, command))
186 1: {'a4':{10: 345, 11: 360, 12: 390},
187 'a5':{10: 276, 11: 276, 12: 276},
188 'b5':{10: 345, 11: 356, 12: 356},
189 'letter':{10: 345, 11: 360, 12: 390},
190 'legal': {10: 345, 11: 360, 12: 390},
191 'executive':{10: 345, 11: 360, 12: 379}},
192 2: {'a4':{10: 167, 11: 175, 12: 190},
193 'a5':{10: 133, 11: 133, 12: 133},
194 'b5':{10: 167, 11: 173, 12: 173},
195 'letter':{10: 167, 11: 175, 12: 190},
196 'legal':{10: 167, 11: 175, 12: 190},
197 'executive':{10: 167, 11: 175, 12: 184}}}
198 # >0 --> force all mudela to this pt size
199 self.force_mudela_fontsize = 0
200 self.force_verbatim_b = 0
202 'mudela-fontsize' : {'init': 16},
203 'papersize' : {'init': 'a4'},
204 'num-column' : {'init': 1},
205 'tex-fontsize' : {'init': 10}
207 def clear_for_new_file(self):
208 for var in self.__data.keys():
209 self.__data[var] = {'init': self.__data[var]['init']}
210 def clear_for_new_block(self):
211 for var in self.__data.keys():
212 if self.__data[var].has_key('block'):
213 del self.__data[var]['block']
214 def __get_variable(self, var):
215 if self.__data[var].has_key('block'):
216 return self.__data[var]['block']
217 elif self.__data[var].has_key('file'):
218 return self.__data[var]['file']
220 return self.__data[var]['init']
221 def setPapersize(self, size, requester):
222 self.__data['papersize'][requester] = size
223 def getPapersize(self):
224 return self.__get_variable('papersize')
225 def setMudelaFontsize(self, size, requester):
226 self.__data['mudela-fontsize'][requester] = size
227 def getMudelaFontsize(self):
228 if self.force_mudela_fontsize:
229 return self.force_mudela_fontsize
230 return self.__get_variable('mudela-fontsize')
231 def setTexFontsize(self, size, requester):
232 self.__data['tex-fontsize'][requester] = size
233 def getTexFontsize(self):
234 return self.__get_variable('tex-fontsize')
235 def setNumColumn(self, num, requester):
236 self.__data['num-column'][requester] = num
237 def getNumColumn(self):
238 return self.__get_variable('num-column')
239 def getLineWidth(self):
240 return self.__linewidth[self.getNumColumn()][self.getPapersize()][self.getTexFontsize()]
244 """ Using only self.code_type to deside both value of linewith and
245 if we have to put code into \score{...} was silly. Now we use:
246 self.code_type: show us what need to be added.
248 'NOTES' : add \context Voice{ ... }
249 'CONTEXT' : add \score{ ... }
251 self.single_line_b: 0 : linewidth=-1 1: linewith=textwidth
253 def __init__ (self, basename):
254 self.basename = basename
255 self.temp_filename = "%s/%s" %(outdir, 'mudela-temp.ly')
256 self.file = open (self.temp_filename, 'w')
259 self.graphic_type = 'tex'
260 self.code_type = None
261 self.single_line_b = 1
263 def write (self, line):
264 # match only if there is nothing but whitespace before \begin.
265 # we should not have to do this RE for every line
266 if re.search('^\s*\\\\begin{mudela}', line):
267 r = begin_mudela_opts_re.search(line)
270 self.optlist = re.compile('[\s,]*').split(o)
273 else: # ugh this is NOT bulletproof...
274 if not self.code_type:
275 if re.search('^\s*%', line) or re.search('^\s*$', line):
277 elif re.search('^\s*\\\\context', line):
278 self.code_type = 'CONTEXT'
279 self.single_line_b = 0
280 elif re.search('^\s*\\\\score', line) or \
281 re.search('^\s*\\\\paper', line) or \
282 re.search('^\s*\\\\header', line) or \
283 re.search('^\s*\\\\version', line) or \
284 re.search('^\s*\\\\include', line) or \
285 re.search('^\s*[A-Za-z]*\s*=', line):
286 self.code_type = 'COMPLETE'
287 self.single_line_b = 0
289 self.code_type = 'NOTES'
290 self.single_line_b = 1
291 self.__lines.append(line)
292 def write_red_tape(self):
293 if 'eps' in self.optlist:
294 self.graphic_type = 'eps'
295 #self.single_line_b = 1
296 if 'fragment' in self.optlist:
297 self.code_type = 'NOTES'
298 if 'nonfragment' in self.optlist:
299 self.code_type = 'COMPLETE'
300 if 'multiline' in self.optlist:
301 self.single_line_b = 0
302 for pt in fontsize_pt2i.keys():
303 if pt in self.optlist:
304 Props.setMudelaFontsize(fontsize_pt2i[pt], 'block')
305 self.file.write ('\\include \"paper%d.ly\"\n' \
306 % Props.getMudelaFontsize())
308 s = fontsize_i2a[Props.getMudelaFontsize()]
309 if 'singleline' in self.optlist:
310 self.single_line_b = 1
311 if self.single_line_b:
312 linewidth_str = 'linewidth = -1.\cm;'
314 linewidth_str = 'linewidth = %i.\\pt;' % Props.getLineWidth()
315 self.file.write("\\paper {"
318 + "castingalgorithm = \Gourlay; \n}")
319 #+ "castingalgorithm = \Wordwrap; indent = 2.\cm; \n}")
320 if self.code_type == 'CONTEXT':
321 self.file.write('\\score{\n\\notes\\relative c{')
322 if self.code_type == 'NOTES' :
323 self.file.write('\\score{\n\\notes\\relative c{\\context Voice{')
325 self.write_red_tape()
326 for l in self.__lines:
328 if self.code_type == 'CONTEXT':
329 self.file.write('}}')
330 elif self.code_type == 'NOTES':
331 self.file.write('}}}')
334 inf = outdir + self.basename + '.ly'
335 outf = outdir + self.basename + '.tex'
336 if not os.path.isfile(inf):
339 status = os.system ('diff -q %s %s' % (self.temp_filename, inf))
341 os.rename (self.temp_filename, inf)
343 recompile_b = need_recompile_b(inf, outf)
345 out_files.append((self.graphic_type, inf))
348 def insert_me_string(self):
349 "ugh the name of this function is wrong"
350 if self.graphic_type == 'tex':
351 return ['tex', self.basename]
352 elif self.graphic_type == 'eps':
353 return ['eps', self.basename]
355 raise SomethingIsSeriouslyBroken
358 def __init__ (self, name):
359 self.output_fn = '%s/%s' % (outdir, name)
361 def open_verbatim (self, line, level):
362 self.__lines.append('\\begin{verbatim}\n')
364 s = re.sub('veryverbatim[\s,]*', '', line)
365 s = re.sub('intertext=\"([^\"]*)\"[\s,]*', '', s)
366 s = re.sub(',\s*\]', ']', s)
367 s = re.sub('\[\]', '', s)
368 self.__lines.append(s);
369 def close_verbatim (self):
370 self.__lines.append('\\end{verbatim}\n')
372 self.__lines.append(s)
373 def create_graphics(self):
376 for line in self.__lines:
377 if type(line)==type([]):
380 if need_recompile_b(outdir+g[1]+'.ly', outdir+g[1]+'.tex'):
381 s = s + ' ' + g[1]+'.ly'
383 e = os.system('cd %s; lilypond %s' %(outdir, s))
385 sys.stderr.write("error: lilypond exited with value %i\n" % e)
389 compile('tex %s' % g[1]+'.tex', outdir, g[1]+'.tex', g[1]+'.dvi')
390 compile('dvips -E -o %s %s' %(g[1]+'.eps', g[1]+'.dvi'), outdir,
391 g[1]+'.dvi', g[1]+'.eps')
392 def write_outfile(self):
393 file = open(self.output_fn+'.latex', 'w')
394 file.write('% Created by mudela-book\n')
396 for line in self.__lines:
397 if type(line)==type([]):
398 if last_line == '\n':
399 file.write(r'\vspace{0.5cm}')
401 file.write('\\preMudelaExample \\input %s \\postMudelaExample\n'\
404 ps_dim = ps_dimention(outdir+line[1]+'.eps')
405 file.write('\\noindent\\parbox{%ipt}{\includegraphics{%s}}\n' \
406 % (ps_dim[0], line[1]+'.eps'))
409 if type(last_line)==type([]):
411 file.write(r'\vspace{0.5cm}')
415 # given parameter s="\mudela[some options]{CODE} some text and commands"
416 # it returns a tuple:
418 # where the last number is the index of the ending '}'
419 def extract_command(s):
423 for idx in range(len(s)):
425 if not start_found_b:
431 if (start_found_b == 1) and (count == 0):
433 return s[start+1:idx], idx
436 def __init__ (self, filename):
437 for fn in [filename, filename+'.tex', filename+'.doc']:
439 self.infile = open (fn)
446 def get_lines (self):
447 lines = self.infile.readlines ()
448 (retlines, retdeps) = ([],[self.filename])
450 r_inp = input_re.search (line)
451 r_inc = include_re.search (line)
453 # Filename rules for \input :
455 # 1. will search for file with exact that name (tex-input.my will be found)
456 # 2. will search for file with .tex ext, (tex-input.my
457 # will find tex-input.my.tex)
458 # input: with .tex ext
459 # 1. will find exact match
461 # Filename rules for \include :
462 # 1. will only find files with name given to \include + .tex ext
465 t = Tex_input (r_inp.groups()[0])
467 retlines = retlines + ls[0]
468 retdeps = retdeps + ls[1]
470 sys.stderr.write("warning: can't find %s, let's hope latex will\n" % r_inp.groups()[0])
471 retlines.append (line)
474 t = Tex_input (r_inc.groups()[0]+'.tex')
476 ls[0].insert(0, '\\newpage\n')
477 ls[0].append('\\newpage\n')
478 retlines = retlines + ls[0]
479 retdeps = retdeps + ls[1]
481 sys.stderr.write("warning: can't find %s, let's hope latex will" % r_inc.groups()[0])
482 retlines.append (line)
484 # This code should be rewritten, it looks terrible
485 r_mud = defined_mudela_cmd_re.search(line)
488 ss = "\\\\verb(?P<xx>[^a-zA-Z])\s*\\\\%s\s*(?P=xx)" \
489 % re.escape(r_mud.group()[1:])
490 # just append the line if the command is inside \verb|..|
491 if re.search(ss, line):
492 retlines.append(line)
495 opts = r_mud.groups()[2]
496 cmd_start_idx = r_mud.span()[0]
497 if cmd_start_idx > 0:
498 retlines.append(line[:cmd_start_idx])
500 cmd_data, rest_idx = extract_command(line[cmd_start_idx:])
501 rest_idx = rest_idx + cmd_start_idx + 1
507 v = string.split(defined_mudela_cmd[r_mud.groups()[0]], '\n')
509 l = string.replace(l, '\\fontoptions', opts)
510 l = string.replace(l, '\\maininput', cmd_data)
512 r_mud = defined_mudela_cmd_re.search(line[rest_idx:])
518 retlines.append(line[rest_idx:])
520 line = line[rest_idx:]
522 retlines.append (line)
523 return (retlines, retdeps)
526 class Main_tex_input(Tex_input):
527 def __init__ (self, name, outname):
529 Tex_input.__init__ (self, name) # ugh
530 self.outname = outname
534 self.mudtex = Tex_output (self.outname)
538 # set to 'mudela' when we are processing mudela code,
539 # both verbatim and graphic-to-be
541 def set_sections (self, l):
542 if section_re.search (l):
543 self.section = self.section + 1
544 if chapter_re.search (l):
546 self.chapter = self.chapter + 1
548 def gen_basename (self):
549 return '%s-%d.%d.%d' % (self.outname, self.chapter,
550 self.section, self.fine_count)
551 def extract_papersize_from_documentclass(self, line):
552 pre = extract_papersize_re.search(line)
555 return pre.groups()[0]
556 def extract_fontsize_from_documentclass(self, line):
557 r = extract_fontsize_re.search(line)
559 return int(r.groups()[0])
561 preMudelaDef = postMudelaDef = 0
562 (lines, self.deps) = self.get_lines ()
566 if documentclass_re.search (line):
567 p = self.extract_papersize_from_documentclass (line)
569 Props.setPapersize(p, 'file')
570 f = self.extract_fontsize_from_documentclass (line)
572 Props.setTexFontsize (f, 'file')
573 elif twocolumn_re.search (line):
574 Props.setNumColumn (2, 'file')
575 elif onecolumn_re.search (line):
576 Props.setNumColumn (1, 'file')
577 elif preMudelaExample_re.search (line):
579 elif postMudelaExample_re.search (line):
581 elif begin_verbatim_re.search (line):
583 elif end_verbatim_re.search (line):
585 elif begin_document_re.search (line):
587 self.mudtex.write ('\\def\\preMudelaExample{}\n')
588 if not postMudelaDef:
589 self.mudtex.write ('\\def\\postMudelaExample{}\n')
591 elif mudela_file_re.search(line):
592 r = mudela_file_re.search(line)
594 self.mudela = Mudela_output(self.gen_basename())
596 full_path = find_file (fn)
598 sys.stderr.write("error: can't find file '%s'\n" % fn)
601 f = open (full_path, 'r')
602 lines =f.readlines ()
604 self.mudela.write (x)
605 r = file_ext_re.search(fn)
607 if r.group(1) == 'fly':
608 self.mudela.optlist.append('multiline')
609 stat =self.mudela.close ()
611 sys.stdout.write("(File %s needs recompiling)\n" % full_path)
612 self.mudtex.write (self.mudela.insert_me_string())
613 self.deps.append (full_path)
616 self.fine_count = self.fine_count + 1
618 elif begin_mudela_re.search (line) and not latex_verbatim:
619 Props.clear_for_new_block()
621 if self.mode == 'mudela':
624 r = begin_mudela_opts_re.search (line)
626 o = r.group()[1:][:-1]
627 optlist = re.compile('[ ,]*').split(o)
628 m = intertext_re.search(r.group())
630 self.intertext = m.groups()[0]
632 self.intertext = None
635 if ('veryverbatim' in optlist):
637 elif ('verbatim' in optlist) or (Props.force_verbatim_b):
642 self.mudtex.open_verbatim (line, self.verbatim)
643 self.mudela = Mudela_output (self.gen_basename ())
644 self.mudela.write (line)
646 elif end_mudela_re.search (line) and not latex_verbatim:
648 if self.mode != 'mudela':
652 if self.verbatim == 2:
653 self.mudtex.write (line)
654 self.mudtex.close_verbatim ()
656 if self.verbatim and self.intertext:
657 self.mudtex.write(self.intertext)
658 self.mudtex.write (self.mudela.insert_me_string())
661 self.fine_count = self.fine_count + 1
666 if self.mode == 'mudela':
667 self.mudela.write (line)
669 self.mudtex.write (line)
671 self.mudtex.write (line)
672 self.set_sections(line)
673 self.mudtex.create_graphics()
674 self.mudtex.write_outfile()
679 sys.stdout.write("""Usage: mudela-book [options] FILE\n
680 Generate hybrid LaTeX input from Latex + mudela
682 -h, --help print this help
683 -d, --outdir=DIR directory to put generated files
684 -o, --outname=FILE prefix for filenames
685 --default-mudela-fontsize=??pt default fontsize for music
686 --force-mudela-fontsize=??pt force fontsize for all inline mudela
687 --force-verbatim make all mudela verbatim\n
688 --dependencies write dependencies
689 --include include path
690 --init mudela-book initfile
696 def write_deps (fn, out, deps):
697 out_fn = os.path.join (outdir, fn)
699 sys.stdout.write('writing `%s\'\n' % out_fn)
701 f = open (out_fn, 'w')
702 target = re.sub (os.sep + os.sep, os.sep, os.path.join (outdir, out + '.latex'))
703 f.write ('%s: %s\n'% (target,
704 reduce (lambda x,y: x + ' '+ y, deps)))
708 sys.stderr.write ('This is %s version %s\n' % ('mudela-book', program_version))
711 global outdir, initfile, defined_mudela_cmd, defined_mudela_cmd_re
714 (options, files) = getopt.getopt(
715 sys.argv[1:], 'hd:o:I:', ['outdir=', 'outname=',
716 'default-mudela-fontsize=',
717 'force-mudela-fontsize=',
718 'help', 'dependencies', 'include=',
719 'force-verbatim', 'init='])
720 except getopt.error, msg:
721 sys.stderr.write("error: %s" % msg)
728 if o == '--include' or o == '-I':
729 include_path.append (a)
730 elif o == '--outname' or o == '-o':
733 sys.stderr.write("Mudela-book is confused by --outname on multiple files")
736 elif o == '--outdir' or o == '-d':
738 elif o == '--help' or o == '-h':
740 elif o == '--dependencies':
742 elif o == '--default-mudela-fontsize':
743 if not fontsize_pt2i.has_key(a):
744 sys.stderr.write("Error: illegal fontsize: %s" % a)
745 sys.stderr.write(" accepted fontsizes are: 11pt, 13pt, 16pt, 20pt, 26pt")
747 Props.setMudelaFontsize(fontsize_pt2i[a], 'init')
748 elif o == '--force-mudela-fontsize':
749 if not fontsize_pt2i.has_key(a):
750 sys.stderr.write("Error: illegal fontsize: %s" % a)
751 sys.stderr.write(" accepted fontsizes are: 11pt, 13pt, 16pt, 20pt, 26pt")
753 Props.force_mudela_fontsize = fontsize_pt2i[a]
754 elif o == '--force-verbatim':
755 Props.force_verbatim_b = 1
758 if outdir[-1:] != '/':
759 outdir = outdir + '/'
761 # r""" ... """ means: leave escape seqs alone.
762 defined_mudela_cmd = {'mudela': r"""
763 \begin{mudela}[eps, singleline \fontoptions]
777 defined_mudela_cmd[i] = d[i]
780 c = string.join (defined_mudela_cmd.keys(), '|')
782 defined_mudela_cmd_re = re.compile("\\\\(%s)(\[(\d*pt)\])*{([^}]*)}" %c)
784 if not os.path.isdir(outdir):
785 os.system('mkdir %s' % outdir)
787 for input_filename in files:
788 Props.clear_for_new_file()
792 my_outname = os.path.basename(os.path.splitext(input_filename)[0])
793 my_depname = my_outname + '.dep'
794 inp = Main_tex_input (input_filename, my_outname)
797 write_deps (my_depname, my_outname, inp.deps)