]> git.donarmstrong.com Git - lilypond.git/blob - buildscripts/output-distance.py
Third phase of tutorial rewrite.
[lilypond.git] / buildscripts / output-distance.py
1 #!@TARGET_PYTHON@
2 import sys
3 import optparse
4 import os
5 import math
6
7 ## so we can call directly as buildscripts/output-distance.py
8 me_path = os.path.abspath (os.path.split (sys.argv[0])[0])
9 sys.path.insert (0, me_path + '/../python/')
10 sys.path.insert (0, me_path + '/../python/out/')
11
12
13 X_AXIS = 0
14 Y_AXIS = 1
15 INFTY = 1e6
16
17 OUTPUT_EXPRESSION_PENALTY = 1
18 ORPHAN_GROB_PENALTY = 1
19 options = None
20
21 ################################################################
22 # system interface.
23 temp_dir = None
24 class TempDirectory:
25     def __init__ (self):
26         import tempfile
27         self.dir = tempfile.mkdtemp ()
28         print 'dir is', self.dir
29     def __del__ (self):
30         print 'rm -rf %s' % self.dir 
31         os.system ('rm -rf %s' % self.dir )
32     def __call__ (self):
33         return self.dir
34
35
36 def get_temp_dir  ():
37     global temp_dir
38     if not temp_dir:
39         temp_dir = TempDirectory ()
40     return temp_dir ()
41
42 def read_pipe (c):
43     print 'pipe' , c
44     return os.popen (c).read ()
45
46 def system (c):
47     print 'system' , c
48     s = os.system (c)
49     if s :
50         raise Exception ("failed")
51     return
52
53 def shorten_string (s):
54     threshold = 15 
55     if len (s) > 2*threshold:
56         s = s[:threshold] + '..' + s[-threshold:]
57     return s
58
59 def max_distance (x1, x2):
60     dist = 0.0
61
62     for (p,q) in zip (x1, x2):
63         dist = max (abs (p-q), dist)
64         
65     return dist
66
67
68 def compare_png_images (old, new, dest_dir):
69     def png_dims (f):
70         m = re.search ('([0-9]+) x ([0-9]+)', read_pipe ('file %s' % f))
71         
72         return tuple (map (int, m.groups ()))
73
74     dest = os.path.join (dest_dir, new.replace ('.png', '.compare.jpeg'))
75     try:
76         dims1 = png_dims (old)
77         dims2 = png_dims (new)
78     except AttributeError:
79         ## hmmm. what to do?
80         system ('touch %(dest)s' % locals ())
81         return
82     
83     dims = (min (dims1[0], dims2[0]),
84             min (dims1[1], dims2[1]))
85
86     dir = get_temp_dir ()
87     system ('convert -depth 8 -crop %dx%d+0+0 %s %s/crop1.png' % (dims + (old, dir)))
88     system ('convert -depth 8 -crop %dx%d+0+0 %s %s/crop2.png' % (dims + (new, dir)))
89
90     system ('compare -depth 8 %(dir)s/crop1.png %(dir)s/crop2.png %(dir)s/diff.png' % locals ())
91
92     system ("convert  -depth 8 %(dir)s/diff.png -blur 0x3 -negate -channel alpha,blue -type TrueColorMatte -fx 'intensity'    %(dir)s/matte.png" % locals ())
93
94     system ("composite -quality 65 %(dir)s/matte.png %(new)s %(dest)s" % locals ())
95
96
97 ################################################################
98 # interval/bbox arithmetic.
99
100 empty_interval = (INFTY, -INFTY)
101 empty_bbox = (empty_interval, empty_interval)
102
103 def interval_is_empty (i):
104     return i[0] > i[1]
105
106 def interval_length (i):
107     return max (i[1]-i[0], 0) 
108     
109 def interval_union (i1, i2):
110     return (min (i1[0], i2[0]),
111             max (i1[1], i2[1]))
112
113 def interval_intersect (i1, i2):
114     return (max (i1[0], i2[0]),
115             min (i1[1], i2[1]))
116
117 def bbox_is_empty (b):
118     return (interval_is_empty (b[0])
119             or interval_is_empty (b[1]))
120
121 def bbox_union (b1, b2):
122     return (interval_union (b1[X_AXIS], b2[X_AXIS]),
123             interval_union (b2[Y_AXIS], b2[Y_AXIS]))
124             
125 def bbox_intersection (b1, b2):
126     return (interval_intersect (b1[X_AXIS], b2[X_AXIS]),
127             interval_intersect (b2[Y_AXIS], b2[Y_AXIS]))
128
129 def bbox_area (b):
130     return interval_length (b[X_AXIS]) * interval_length (b[Y_AXIS])
131
132 def bbox_diameter (b):
133     return max (interval_length (b[X_AXIS]),
134                 interval_length (b[Y_AXIS]))
135                 
136
137 def difference_area (a, b):
138     return bbox_area (a) - bbox_area (bbox_intersection (a,b))
139
140 class GrobSignature:
141     def __init__ (self, exp_list):
142         (self.name, self.origin, bbox_x,
143          bbox_y, self.output_expression) = tuple (exp_list)
144         
145         self.bbox = (bbox_x, bbox_y)
146         self.centroid = (bbox_x[0] + bbox_x[1], bbox_y[0] + bbox_y[1])
147
148     def __repr__ (self):
149         return '%s: (%.2f,%.2f), (%.2f,%.2f)\n' % (self.name,
150                                                    self.bbox[0][0],
151                                                    self.bbox[0][1],
152                                                    self.bbox[1][0],
153                                                    self.bbox[1][1])
154                                                  
155     def axis_centroid (self, axis):
156         return apply (sum, self.bbox[axis])  / 2 
157     
158     def centroid_distance (self, other, scale):
159         return max_distance (self.centroid, other.centroid) / scale 
160         
161     def bbox_distance (self, other):
162         divisor = bbox_area (self.bbox) + bbox_area (other.bbox)
163
164         if divisor:
165             return (difference_area (self.bbox, other.bbox) +
166                     difference_area (other.bbox, self.bbox)) / divisor
167         else:
168             return 0.0
169         
170     def expression_distance (self, other):
171         if self.output_expression == other.output_expression:
172             return 0
173         else:
174             return 1
175
176 ################################################################
177 # single System.
178
179 class SystemSignature:
180     def __init__ (self, grob_sigs):
181         d = {}
182         for g in grob_sigs:
183             val = d.setdefault (g.name, [])
184             val += [g]
185
186         self.grob_dict = d
187         self.set_all_bbox (grob_sigs)
188
189     def set_all_bbox (self, grobs):
190         self.bbox = empty_bbox
191         for g in grobs:
192             self.bbox = bbox_union (g.bbox, self.bbox)
193
194     def closest (self, grob_name, centroid):
195         min_d = INFTY
196         min_g = None
197         try:
198             grobs = self.grob_dict[grob_name]
199
200             for g in grobs:
201                 d = max_distance (g.centroid, centroid)
202                 if d < min_d:
203                     min_d = d
204                     min_g = g
205
206
207             return min_g
208
209         except KeyError:
210             return None
211     def grobs (self):
212         return reduce (lambda x,y: x+y, self.grob_dict.values(), [])
213
214 ################################################################
215 ## comparison of systems.
216
217 class SystemLink:
218     def __init__ (self, system1, system2):
219         self.system1 = system1
220         self.system2 = system2
221         
222         self.link_list_dict = {}
223         self.back_link_dict = {}
224
225
226         ## pairs
227         self.orphans = []
228
229         ## pair -> distance
230         self.geo_distances = {}
231
232         ## pairs
233         self.expression_changed = []
234
235         self._geometric_distance = None
236         self._expression_change_count = None
237         self._orphan_count = None
238         
239         for g in system1.grobs ():
240
241             ## skip empty bboxes.
242             if bbox_is_empty (g.bbox):
243                 continue
244             
245             closest = system2.closest (g.name, g.centroid)
246             
247             self.link_list_dict.setdefault (closest, [])
248             self.link_list_dict[closest].append (g)
249             self.back_link_dict[g] = closest
250
251
252     def calc_geometric_distance (self):
253         total = 0.0
254         for (g1,g2) in self.back_link_dict.items ():
255             if g2:
256                 d = g1.bbox_distance (g2)
257                 if d:
258                     self.geo_distances[(g1,g2)] = d
259
260                 total += d
261
262         self._geometric_distance = total
263     
264     def calc_orphan_count (self):
265         count = 0
266         for (g1, g2) in self.back_link_dict.items ():
267             if g2 == None:
268                 self.orphans.append ((g1, None))
269                 
270                 count += 1
271
272         self._orphan_count = count
273     
274     def calc_output_exp_distance (self):
275         d = 0
276         for (g1,g2) in self.back_link_dict.items ():
277             if g2:
278                 d += g1.expression_distance (g2)
279
280         self._expression_change_count = d
281
282     def output_expression_details_string (self):
283         return ', '.join ([g1.name for g1 in self.expression_changed])
284     
285     def geo_details_string (self):
286         results = [(d, g1,g2) for ((g1, g2), d) in self.geo_distances.items()]
287         results.sort ()
288         results.reverse ()
289         
290         return ', '.join (['%s: %f' % (g1.name, d) for (d, g1, g2) in results])
291
292     def orphan_details_string (self):
293         return ', '.join (['%s-None' % g1.name for (g1,g2) in self.orphans if g2==None])
294
295     def geometric_distance (self):
296         if self._geometric_distance == None:
297             self.calc_geometric_distance ()
298         return self._geometric_distance
299     
300     def orphan_count (self):
301         if self._orphan_count == None:
302             self.calc_orphan_count ()
303             
304         return self._orphan_count
305     
306     def output_expression_change_count (self):
307         if self._expression_change_count == None:
308             self.calc_output_exp_distance ()
309         return self._expression_change_count
310         
311     def distance (self):
312         return (self.output_expression_change_count (),
313                 self.orphan_count (),
314                 self.geometric_distance ())
315     
316 def read_signature_file (name):
317     print 'reading', name
318     
319     entries = open (name).read ().split ('\n')
320     def string_to_tup (s):
321         return tuple (map (float, s.split (' '))) 
322
323     def string_to_entry (s):
324         fields = s.split('@')
325         fields[2] = string_to_tup (fields[2])
326         fields[3] = string_to_tup (fields[3])
327
328         return tuple (fields)
329     
330     entries = [string_to_entry (e) for e in entries
331                if e and not e.startswith ('#')]
332
333     grob_sigs = [GrobSignature (e) for e in entries]
334     sig = SystemSignature (grob_sigs)
335     return sig
336
337
338 ################################################################
339 # different systems of a .ly file.
340
341 hash_to_original_name = {}
342
343 class FileLink:
344     def __init__ (self, f1, f2):
345         self._distance = None
346         self.file_names = (f1, f2)
347         
348     def text_record_string (self):
349         return '%-30f %-20s\n' % (self.distance (),
350                                   self.name ())
351     def calc_distance (self):
352         return 0.0
353
354     def distance (self):
355         if self._distance == None:
356            self._distance = self.calc_distance ()
357
358         return self._distance
359     
360         
361     def name (self):
362         base = os.path.basename (self.file_names[1])
363         base = os.path.splitext (base)[0]
364         
365         base = hash_to_original_name.get (base, base)
366         base = os.path.splitext (base)[0]
367         return base
368     
369     def extension (self):
370         return os.path.splitext (self.file_names[1])[1]
371
372     def link_files_for_html (self, dest_dir):
373         for f in self.file_names:
374             link_file (f, os.path.join (dest_dir, f))
375
376     def get_distance_details (self):
377         return ''
378
379     def get_cell (self, oldnew):
380         return ''
381     
382     def get_file (self, oldnew):
383         return self.file_names[oldnew]
384     
385     def html_record_string (self, dest_dir):
386         dist = self.distance()
387         
388         details = self.get_distance_details ()
389         if details:
390             details_base = os.path.splitext (self.file_names[1])[0]
391             details_base += '.details.html'
392             fn = dest_dir + '/'  + details_base
393             open_write_file (fn).write (details)
394
395             details = '<br>(<a href="%(details_base)s">details</a>)' % locals ()
396
397         cell1 = self.get_cell (0)
398         cell2 = self.get_cell (1)
399
400         name = self.name () + self.extension ()
401         file1 = self.get_file (0)
402         file2 = self.get_file (1)
403         
404         return '''<tr>
405 <td>
406 %(dist)f
407 %(details)s
408 </td>
409 <td>%(cell1)s<br><font size=-2><a href="%(file1)s"><tt>%(name)s</tt></font></td>
410 <td>%(cell2)s<br><font size=-2><a href="%(file2)s"><tt>%(name)s</tt></font></td>
411 </tr>''' % locals ()
412
413
414 class FileCompareLink (FileLink):
415     def __init__ (self, f1, f2):
416         FileLink.__init__ (self, f1, f2)
417         self.contents = (self.get_content (self.file_names[0]),
418                          self.get_content (self.file_names[1]))
419         
420
421     def calc_distance (self):
422         ## todo: could use import MIDI to pinpoint
423         ## what & where changed.
424
425         if self.contents[0] == self.contents[1]:
426             return 0.0
427         else:
428             return 100.0;
429         
430     def get_content (self, f):
431         print 'reading', f
432         s = open (f).read ()
433         return s
434
435
436 class GitFileCompareLink (FileCompareLink):
437     def get_cell (self, oldnew):
438         str = self.contents[oldnew]
439
440         # truncate long lines
441         str = '\n'.join ([l[:80] for l in str.split ('\n')])
442
443         
444         str = '<font size="-2"><pre>%s</pre></font>' % str
445         return str
446     
447     def calc_distance (self):
448         if self.contents[0] == self.contents[1]:
449             d = 0.0
450         else:
451             d = 1.0001 *options.threshold
452
453         return d
454         
455 class TextFileCompareLink (FileCompareLink):
456     def calc_distance (self):
457         import difflib
458         diff = difflib.unified_diff (self.contents[0].strip().split ('\n'),
459                                      self.contents[1].strip().split ('\n'),
460                                      fromfiledate = self.file_names[0],
461                                      tofiledate = self.file_names[1]
462                                      )
463         
464         self.diff_lines =  [l for l in diff]
465         self.diff_lines = self.diff_lines[2:]
466         
467         return math.sqrt (float (len ([l for l in self.diff_lines if l[0] in '-+'])))
468         
469     def get_cell (self, oldnew):
470         str = ''
471         if oldnew == 1:
472             str = '\n'.join ([d.replace ('\n','') for d in self.diff_lines])
473         str = '<font size="-2"><pre>%s</pre></font>' % str
474         return str
475
476         
477 class ProfileFileLink (FileCompareLink):
478     def __init__ (self, f1, f2):
479         FileCompareLink.__init__ (self, f1, f2)
480         self.results = [{}, {}]
481     
482     def get_cell (self, oldnew):
483         str = ''
484         for k in ('time', 'cells'):
485             if oldnew==0:
486                 str += '%-8s: %d\n' %  (k, int (self.results[oldnew][k]))
487             else:
488                 str += '%-8s: %8d (%5.3f)\n' % (k, int (self.results[oldnew][k]),
489                                                 self.get_ratio (k))
490
491         return '<pre>%s</pre>' % str
492             
493     def get_ratio (self, key):
494         (v1,v2) = (self.results[0].get (key, -1),
495                    self.results[1].get (key, -1))
496
497         if v1 <= 0 or v2 <= 0:
498             return 0.0
499
500         return (v1 - v2) / float (v1+v2)
501     
502     def calc_distance (self):
503         for oldnew in (0,1):
504             def note_info (m):
505                 self.results[oldnew][m.group(1)] = float (m.group (2))
506             
507             re.sub ('([a-z]+): ([-0-9.]+)\n',
508                     note_info, self.contents[oldnew])
509
510         dist = 0.0
511         factor = {'time': 3.0 ,
512                   'cells': 5.0,
513                   }
514         
515         for k in ('time', 'cells'):
516             real_val = math.tan (self.get_ratio (k) * 0.5* math.pi)
517             dist += math.exp (math.fabs (real_val) * factor[k])  - 1
518
519         dist = min (dist, 100)
520         return dist
521
522     
523 class MidiFileLink (TextFileCompareLink):
524     def get_content (self, oldnew):
525         import midi
526         
527         data = FileCompareLink.get_content (self, oldnew)
528         midi = midi.parse (data)
529         tracks = midi[1]
530
531         str = ''
532         j = 0
533         for t in tracks:
534             str += 'track %d' % j
535             j += 1
536
537             for e in t:
538                 ev_str = repr (e)
539                 if re.search ('LilyPond [0-9.]+', ev_str):
540                     continue
541                 
542                 str += '  ev %s\n' % `e`
543         return str
544     
545
546
547 class SignatureFileLink (FileLink):
548     def __init__ (self, f1, f2 ):
549         FileLink.__init__ (self, f1, f2)
550         self.system_links = {}
551
552     def add_system_link (self, link, number):
553         self.system_links[number] = link
554
555     def calc_distance (self):
556         d = 0.0
557
558         orphan_distance = 0.0
559         for l in self.system_links.values ():
560             d = max (d, l.geometric_distance ())
561             orphan_distance += l.orphan_count ()
562             
563         return d + orphan_distance
564
565     def source_file (self):
566         for ext in ('.ly', '.ly.txt'):
567             if os.path.exists (self.base_names[1] + ext):
568                 return self.base_names[1] + ext
569         return ''
570     
571     def add_file_compare (self, f1, f2):
572         system_index = [] 
573
574         def note_system_index (m):
575             system_index.append (int (m.group (1)))
576             return ''
577         
578         base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
579         base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
580
581         self.base_names = (os.path.normpath (base1),
582                            os.path.normpath (base2))
583
584         def note_original (match):
585             hash_to_original_name[os.path.basename (self.base_names[1])] = match.group (1)
586             return ''
587         
588         ## ugh: drop the .ly.txt
589         for ext in ('.ly', '.ly.txt'):
590             try:
591                 re.sub (r'\\sourcefilename "([^"]+)"',
592                         note_original, open (base1 + ext).read ())
593             except IOError:
594                 pass
595                 
596         s1 = read_signature_file (f1)
597         s2 = read_signature_file (f2)
598
599         link = SystemLink (s1, s2)
600
601         self.add_system_link (link, system_index[0])
602
603     
604     def create_images (self, dest_dir):
605
606         files_created = [[], []]
607         for oldnew in (0, 1):
608             pat = self.base_names[oldnew] + '.eps'
609
610             for f in glob.glob (pat):
611                 infile = f
612                 outfile = (dest_dir + '/' + f).replace ('.eps', '.png')
613
614                 mkdir (os.path.split (outfile)[0])
615                 cmd = ('gs -sDEVICE=png16m -dGraphicsAlphaBits=4 -dTextAlphaBits=4 '
616                        ' -r101 '
617                        ' -sOutputFile=%(outfile)s -dNOSAFER -dEPSCrop -q -dNOPAUSE '
618                        ' %(infile)s  -c quit '  % locals ())
619
620                 files_created[oldnew].append (outfile)
621                 system (cmd)
622
623         return files_created
624     
625     def link_files_for_html (self, dest_dir):
626         FileLink.link_files_for_html (self, dest_dir)
627         to_compare = [[], []]
628
629         exts = []
630         if options.create_images:
631             to_compare = self.create_images (dest_dir)
632         else:
633             exts += ['.png', '-page*png']
634         
635         for ext in exts:            
636             for oldnew in (0,1):
637                 for f in glob.glob (self.base_names[oldnew] + ext):
638                     dst = dest_dir + '/' + f
639                     link_file (f, dst)
640
641                     if f.endswith ('.png'):
642                         to_compare[oldnew].append (f)
643                         
644         if options.compare_images:                
645             for (old, new) in zip (to_compare[0], to_compare[1]):
646                 compare_png_images (old, new, dest_dir)
647
648
649     def get_cell (self, oldnew):
650         def img_cell (ly, img, name):
651             if not name:
652                 name = 'source'
653             else:
654                 name = '<tt>%s</tt>' % name
655                 
656             return '''
657 <a href="%(img)s">
658 <img src="%(img)s" style="border-style: none; max-width: 500px;">
659 </a><br>
660 ''' % locals ()
661         def multi_img_cell (ly, imgs, name):
662             if not name:
663                 name = 'source'
664             else:
665                 name = '<tt>%s</tt>' % name
666
667             imgs_str = '\n'.join (['''<a href="%s">
668 <img src="%s" style="border-style: none; max-width: 500px;">
669 </a><br>''' % (img, img) 
670                                   for img in imgs])
671
672
673             return '''
674 %(imgs_str)s
675 ''' % locals ()
676
677
678
679         def cell (base, name):
680             pat = base + '-page*.png'
681             pages = glob.glob (pat)
682
683             if pages:
684                 return multi_img_cell (base + '.ly', sorted (pages), name)
685             else:
686                 return img_cell (base + '.ly', base + '.png', name)
687
688
689
690         str = cell (os.path.splitext (self.file_names[oldnew])[0], self.name ())  
691         if options.compare_images and oldnew == 1:
692             str = str.replace ('.png', '.compare.jpeg')
693             
694         return str
695
696
697     def get_distance_details (self):
698         systems = self.system_links.items ()
699         systems.sort ()
700
701         html = ""
702         for (c, link) in systems:
703             e = '<td>%d</td>' % c
704             for d in link.distance ():
705                 e += '<td>%f</td>' % d
706             
707             e = '<tr>%s</tr>' % e
708
709             html += e
710
711             e = '<td>%d</td>' % c
712             for s in (link.output_expression_details_string (),
713                       link.orphan_details_string (),
714                       link.geo_details_string ()):
715                 e += "<td>%s</td>" % s
716
717             
718             e = '<tr>%s</tr>' % e
719             html += e
720             
721         original = self.name ()
722         html = '''<html>
723 <head>
724 <title>comparison details for %(original)s</title>
725 </head>
726 <body>
727 <table border=1>
728 <tr>
729 <th>system</th>
730 <th>output</th>
731 <th>orphan</th>
732 <th>geo</th>
733 </tr>
734
735 %(html)s
736 </table>
737
738 </body>
739 </html>
740 ''' % locals ()
741         return html
742
743
744 ################################################################
745 # Files/directories
746
747 import glob
748 import re
749
750 def compare_signature_files (f1, f2):
751     s1 = read_signature_file (f1)
752     s2 = read_signature_file (f2)
753     
754     return SystemLink (s1, s2).distance ()
755
756 def paired_files (dir1, dir2, pattern):
757     """
758     Search DIR1 and DIR2 for PATTERN.
759
760     Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
761
762     """
763
764     files = []
765     for d in (dir1,dir2):
766         found = [os.path.split (f)[1] for f in glob.glob (d + '/' + pattern)]
767         found = dict ((f, 1) for f in found)
768         files.append (found)
769         
770     pairs = []
771     missing = []
772     for f in files[0].keys ():
773         try:
774             files[1].pop (f)
775             pairs.append (f)
776         except KeyError:
777             missing.append (f)
778
779     return (pairs, files[1].keys (), missing)
780     
781 class ComparisonData:
782     def __init__ (self):
783         self.result_dict = {}
784         self.missing = []
785         self.added = []
786         self.file_links = {}
787
788     def compare_trees (self, dir1, dir2):
789         self.compare_directories (dir1, dir2)
790         
791         (root, dirs, files) = os.walk (dir1).next ()
792         for d in dirs:
793             d1 = os.path.join (dir1, d)
794             d2 = os.path.join (dir2, d)
795
796             if os.path.islink (d1) or os.path.islink (d2):
797                 continue
798             
799             if os.path.isdir (d2):
800                 self.compare_trees (d1, d2)
801     
802     def compare_directories (self, dir1, dir2):
803         for ext in ['signature', 'midi', 'log', 'profile', 'gittxt']:
804             (paired, m1, m2) = paired_files (dir1, dir2, '*.' + ext)
805
806             self.missing += [(dir1, m) for m in m1] 
807             self.added += [(dir2, m) for m in m2] 
808
809             for p in paired:
810                 if (options.max_count
811                     and len (self.file_links) > options.max_count):
812                     continue
813                 
814                 f2 = dir2 +  '/' + p
815                 f1 = dir1 +  '/' + p
816                 self.compare_files (f1, f2)
817
818     def compare_files (self, f1, f2):
819         if f1.endswith ('signature'):
820             self.compare_signature_files (f1, f2)
821         else:
822             ext = os.path.splitext (f1)[1]
823             klasses = {
824                 '.midi': MidiFileLink,
825                 '.log' : TextFileCompareLink,
826                 '.profile': ProfileFileLink,
827                 '.gittxt': GitFileCompareLink, 
828                 }
829             
830             if klasses.has_key (ext):
831                 self.compare_general_files (klasses[ext], f1, f2)
832
833     def compare_general_files (self, klass, f1, f2):
834         name = os.path.split (f1)[1]
835
836         file_link = klass (f1, f2)
837         self.file_links[name] = file_link
838         
839     def compare_signature_files (self, f1, f2):
840         name = os.path.split (f1)[1]
841         name = re.sub ('-[0-9]+.signature', '', name)
842         
843         file_link = None
844         try:
845             file_link = self.file_links[name]
846         except KeyError:
847             generic_f1 = re.sub ('-[0-9]+.signature', '.ly', f1)
848             generic_f2 = re.sub ('-[0-9]+.signature', '.ly', f2)
849             file_link = SignatureFileLink (generic_f1, generic_f2)
850             self.file_links[name] = file_link
851
852         file_link.add_file_compare (f1, f2)
853
854     def write_changed (self, dest_dir, threshold):
855         (changed, below, unchanged) = self.thresholded_results (threshold)
856
857         str = '\n'.join ([os.path.splitext (link.file_names[1])[0]
858                         for link in changed])
859         fn = dest_dir + '/changed.txt'
860         
861         open_write_file (fn).write (str)
862                 
863     def thresholded_results (self, threshold):
864         ## todo: support more scores.
865         results = [(link.distance(), link)
866                    for link in self.file_links.values ()]
867         results.sort ()
868         results.reverse ()
869
870         unchanged = [r for (d,r) in results if d == 0.0]
871         below = [r for (d,r) in results if threshold >= d > 0.0]
872         changed = [r for (d,r) in results if d > threshold]
873
874         return (changed, below, unchanged)
875                 
876     def write_text_result_page (self, filename, threshold):
877         out = None
878         if filename == '':
879             out = sys.stdout
880         else:
881             print 'writing "%s"' % filename
882             out = open_write_file (filename)
883
884         (changed, below, unchanged) = self.thresholded_results (threshold)
885
886         
887         for link in changed:
888             out.write (link.text_record_string ())
889
890         out.write ('\n\n')
891         out.write ('%d below threshold\n' % len (below))
892         out.write ('%d unchanged\n' % len (unchanged))
893         
894     def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
895         self.write_text_result_page (dest_dir + '/index.txt', threshold)
896         
897     def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
898         dir1 = dir1.replace ('//', '/')
899         dir2 = dir2.replace ('//', '/')
900
901         (changed, below, unchanged) = self.thresholded_results (threshold)
902
903
904         html = ''
905         old_prefix = os.path.split (dir1)[1]
906         for link in changed:
907             html += link.html_record_string (dest_dir)
908
909
910         short_dir1 = shorten_string (dir1)
911         short_dir2 = shorten_string (dir2)
912         html = '''<html>
913 <table rules="rows" border bordercolor="blue">
914 <tr>
915 <th>distance</th>
916 <th>%(short_dir1)s</th>
917 <th>%(short_dir2)s</th>
918 </tr>
919 %(html)s
920 </table>
921 </html>''' % locals()
922
923         html += ('<p>')
924         below_count = len (below)
925
926         if below_count:
927             html += ('<p>%d below threshold</p>' % below_count)
928             
929         html += ('<p>%d unchanged</p>' % len (unchanged))
930
931         dest_file = dest_dir + '/index.html'
932         open_write_file (dest_file).write (html)
933
934
935         for link in changed:
936             link.link_files_for_html (dest_dir)
937         
938
939     def print_results (self, threshold):
940         self.write_text_result_page ('', threshold)
941
942 def compare_trees (dir1, dir2, dest_dir, threshold):
943     data = ComparisonData ()
944     data.compare_trees (dir1, dir2)
945     data.print_results (threshold)
946
947     if os.path.isdir (dest_dir):
948         system ('rm -rf %s '% dest_dir)
949
950     data.write_changed (dest_dir, threshold)
951     data.create_html_result_page (dir1, dir2, dest_dir, threshold)
952     data.create_text_result_page (dir1, dir2, dest_dir, threshold)
953     
954 ################################################################
955 # TESTING
956
957 def mkdir (x):
958     if not os.path.isdir (x):
959         print 'mkdir', x
960         os.makedirs (x)
961
962 def link_file (x, y):
963     mkdir (os.path.split (y)[0])
964     try:
965         print x, '->', y
966         os.link (x, y)
967     except OSError, z:
968         print 'OSError', x, y, z
969         raise OSError
970     
971 def open_write_file (x):
972     d = os.path.split (x)[0]
973     mkdir (d)
974     return open (x, 'w')
975
976
977 def system (x):
978     
979     print 'invoking', x
980     stat = os.system (x)
981     assert stat == 0
982
983
984 def test_paired_files ():
985     print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
986                         os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
987                   
988     
989 def test_compare_trees ():
990     system ('rm -rf dir1 dir2')
991     system ('mkdir dir1 dir2')
992     system ('cp 20{-*.signature,.ly,.png,.eps,.log,.profile} dir1')
993     system ('cp 20{-*.signature,.ly,.png,.eps,.log,.profile} dir2')
994     system ('cp 20expr{-*.signature,.ly,.png,.eps,.log,.profile} dir1')
995     system ('cp 19{-*.signature,.ly,.png,.eps,.log,.profile} dir2/')
996     system ('cp 19{-*.signature,.ly,.png,.eps,.log,.profile} dir1/')
997     system ('cp 19-1.signature 19.sub-1.signature')
998     system ('cp 19.ly 19.sub.ly')
999     system ('cp 19.profile 19.sub.profile')
1000     system ('cp 19.log 19.sub.log')
1001     system ('cp 19.png 19.sub.png')
1002     system ('cp 19.eps 19.sub.eps')
1003
1004     system ('cp 20multipage* dir1')
1005     system ('cp 20multipage* dir2')
1006     system ('cp 19multipage-1.signature dir2/20multipage-1.signature')
1007
1008     
1009     system ('mkdir -p dir1/subdir/ dir2/subdir/')
1010     system ('cp 19.sub{-*.signature,.ly,.png,.eps,.log,.profile} dir1/subdir/')
1011     system ('cp 19.sub{-*.signature,.ly,.png,.eps,.log,.profile} dir2/subdir/')
1012     system ('cp 20grob{-*.signature,.ly,.png,.eps,.log,.profile} dir2/')
1013     system ('cp 20grob{-*.signature,.ly,.png,.eps,.log,.profile} dir1/')
1014     system ('echo HEAD is 1 > dir1/tree.gittxt')
1015     system ('echo HEAD is 2 > dir2/tree.gittxt')
1016
1017     ## introduce differences
1018     system ('cp 19-1.signature dir2/20-1.signature')
1019     system ('cp 19.profile dir2/20.profile')
1020     system ('cp 19.png dir2/20.png')
1021     system ('cp 19multipage-page1.png dir2/20multipage-page1.png')
1022     system ('cp 20-1.signature dir2/subdir/19.sub-1.signature')
1023     system ('cp 20.png dir2/subdir/19.sub.png')
1024     system ("sed 's/: /: 1/g'  20.profile > dir2/subdir/19.sub.profile")
1025
1026     ## radical diffs.
1027     system ('cp 19-1.signature dir2/20grob-1.signature')
1028     system ('cp 19-1.signature dir2/20grob-2.signature')
1029     system ('cp 19multipage.midi dir1/midi-differ.midi')
1030     system ('cp 20multipage.midi dir2/midi-differ.midi')
1031     system ('cp 19multipage.log dir1/log-differ.log')
1032     system ('cp 19multipage.log dir2/log-differ.log &&  echo different >> dir2/log-differ.log &&  echo different >> dir2/log-differ.log')
1033
1034     compare_trees ('dir1', 'dir2', 'compare-dir1dir2', options.threshold)
1035
1036
1037 def test_basic_compare ():
1038     ly_template = r"""
1039
1040 \version "2.10.0"
1041 #(define default-toplevel-book-handler
1042   print-book-with-defaults-as-systems )
1043
1044 #(ly:set-option (quote no-point-and-click))
1045
1046 \sourcefilename "my-source.ly"
1047  
1048 %(papermod)s
1049 \header { tagline = ##f }
1050 \score {
1051 <<
1052 \new Staff \relative c {
1053   c4^"%(userstring)s" %(extragrob)s
1054   }
1055 \new Staff \relative c {
1056   c4^"%(userstring)s" %(extragrob)s
1057   }
1058 >>
1059 \layout{}
1060 }
1061
1062 """
1063
1064     dicts = [{ 'papermod' : '',
1065                'name' : '20',
1066                'extragrob': '',
1067                'userstring': 'test' },
1068              { 'papermod' : '#(set-global-staff-size 19.5)',
1069                'name' : '19',
1070                'extragrob': '',
1071                'userstring': 'test' },
1072              { 'papermod' : '',
1073                'name' : '20expr',
1074                'extragrob': '',
1075                'userstring': 'blabla' },
1076              { 'papermod' : '',
1077                'name' : '20grob',
1078                'extragrob': 'r2. \\break c1',
1079                'userstring': 'test' },
1080              ]
1081
1082     for d in dicts:
1083         open (d['name'] + '.ly','w').write (ly_template % d)
1084         
1085     names = [d['name'] for d in dicts]
1086
1087     system ('lilypond -ddump-profile -dseparate-log-files -ddump-signatures --png -b eps ' + ' '.join (names))
1088     
1089
1090     multipage_str = r'''
1091     #(set-default-paper-size "a6")
1092     \score {
1093       \relative {c1 \pageBreak c1 }
1094       \layout {}
1095       \midi {}
1096     }
1097     '''
1098
1099     open ('20multipage.ly', 'w').write (multipage_str.replace ('c1', 'd1'))
1100     open ('19multipage.ly', 'w').write ('#(set-global-staff-size 19.5)\n' + multipage_str)
1101     system ('lilypond -dseparate-log-files -ddump-signatures --png 19multipage 20multipage ')
1102  
1103     test_compare_signatures (names)
1104     
1105 def test_compare_signatures (names, timing=False):
1106
1107     import time
1108
1109     times = 1
1110     if timing:
1111         times = 100
1112
1113     t0 = time.clock ()
1114
1115     count = 0
1116     for t in range (0, times):
1117         sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
1118         count += 1
1119
1120     if timing:
1121         print 'elapsed', (time.clock() - t0)/count
1122
1123
1124     t0 = time.clock ()
1125     count = 0
1126     combinations = {}
1127     for (n1, s1) in sigs.items():
1128         for (n2, s2) in sigs.items():
1129             combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
1130             count += 1
1131
1132     if timing:
1133         print 'elapsed', (time.clock() - t0)/count
1134
1135     results = combinations.items ()
1136     results.sort ()
1137     for k,v in results:
1138         print '%-20s' % k, v
1139
1140     assert combinations['20-20'] == (0.0,0.0,0.0)
1141     assert combinations['20-20expr'][0] > 0.0
1142     assert combinations['20-19'][2] < 10.0
1143     assert combinations['20-19'][2] > 0.0
1144
1145
1146 def run_tests ():
1147     dir = 'test-output-distance'
1148
1149     do_clean = not os.path.exists (dir)
1150
1151     print 'test results in ', dir
1152     if do_clean:
1153         system ('rm -rf ' + dir)
1154         system ('mkdir ' + dir)
1155         
1156     os.chdir (dir)
1157     if do_clean:
1158         test_basic_compare ()
1159         
1160     test_compare_trees ()
1161     
1162 ################################################################
1163 #
1164
1165 def main ():
1166     p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
1167     p.usage = 'output-distance.py [options] tree1 tree2'
1168     
1169     p.add_option ('', '--test-self',
1170                   dest="run_test",
1171                   action="store_true",
1172                   help='run test method')
1173     
1174     p.add_option ('--max-count',
1175                   dest="max_count",
1176                   metavar="COUNT",
1177                   type="int",
1178                   default=0, 
1179                   action="store",
1180                   help='only analyze COUNT signature pairs')
1181
1182     p.add_option ('', '--threshold',
1183                   dest="threshold",
1184                   default=0.3,
1185                   action="store",
1186                   type="float",
1187                   help='threshold for geometric distance')
1188
1189     p.add_option ('--no-compare-images',
1190                   dest="compare_images",
1191                   default=True,
1192                   action="store_false",
1193                   help="Don't run graphical comparisons")
1194
1195     p.add_option ('--create-images',
1196                   dest="create_images",
1197                   default=False,
1198                   action="store_true",
1199                   help="Create PNGs from EPSes")
1200
1201     p.add_option ('-o', '--output-dir',
1202                   dest="output_dir",
1203                   default=None,
1204                   action="store",
1205                   type="string",
1206                   help='where to put the test results [tree2/compare-tree1tree2]')
1207
1208     global options
1209     (options, a) = p.parse_args ()
1210
1211     if options.run_test:
1212         run_tests ()
1213         sys.exit (0)
1214
1215     if len (a) != 2:
1216         p.print_usage()
1217         sys.exit (2)
1218
1219     name = options.output_dir
1220     if not name:
1221         name = a[0].replace ('/', '')
1222         name = os.path.join (a[1], 'compare-' + shorten_string (name))
1223     
1224     compare_trees (a[0], a[1], name, options.threshold)
1225
1226 if __name__ == '__main__':
1227     main()
1228