]> git.donarmstrong.com Git - lilypond.git/blob - buildscripts/output-distance.py
(main): use compare-XXX for
[lilypond.git] / buildscripts / output-distance.py
1 #!@TARGET_PYTHON@
2 import sys
3 import optparse
4 import os
5
6 ## so we can call directly as buildscripts/output-distance.py
7 me_path = os.path.abspath (os.path.split (sys.argv[0])[0])
8 sys.path.insert (0, me_path + '/../python/')
9
10
11 import safeeval
12
13
14 X_AXIS = 0
15 Y_AXIS = 1
16 INFTY = 1e6
17
18 OUTPUT_EXPRESSION_PENALTY = 1
19 ORPHAN_GROB_PENALTY = 1
20 inspect_max_count = 0
21
22 def max_distance (x1, x2):
23     dist = 0.0
24
25     for (p,q) in zip (x1, x2):
26         dist = max (abs (p-q), dist)
27         
28     return dist
29
30
31 empty_interval = (INFTY, -INFTY)
32 empty_bbox = (empty_interval, empty_interval)
33
34 def interval_is_empty (i):
35     return i[0] > i[1]
36
37 def interval_length (i):
38     return max (i[1]-i[0], 0) 
39     
40 def interval_union (i1, i2):
41     return (min (i1[0], i2[0]),
42             max (i1[1], i2[1]))
43
44 def interval_intersect (i1, i2):
45     return (max (i1[0], i2[0]),
46             min (i1[1], i2[1]))
47
48 def bbox_is_empty (b):
49     return (interval_is_empty (b[0])
50             or interval_is_empty (b[1]))
51
52 def bbox_union (b1, b2):
53     return (interval_union (b1[X_AXIS], b2[X_AXIS]),
54             interval_union (b2[Y_AXIS], b2[Y_AXIS]))
55             
56 def bbox_intersection (b1, b2):
57     return (interval_intersect (b1[X_AXIS], b2[X_AXIS]),
58             interval_intersect (b2[Y_AXIS], b2[Y_AXIS]))
59
60 def bbox_area (b):
61     return interval_length (b[X_AXIS]) * interval_length (b[Y_AXIS])
62
63 def bbox_diameter (b):
64     return max (interval_length (b[X_AXIS]),
65                 interval_length (b[Y_AXIS]))
66                 
67
68 def difference_area (a, b):
69     return bbox_area (a) - bbox_area (bbox_intersection (a,b))
70
71 class GrobSignature:
72     def __init__ (self, exp_list):
73         (self.name, self.origin, bbox_x,
74          bbox_y, self.output_expression) = tuple (exp_list)
75         
76         self.bbox = (bbox_x, bbox_y)
77         self.centroid = (bbox_x[0] + bbox_x[1], bbox_y[0] + bbox_y[1])
78
79     def __repr__ (self):
80         return '%s: (%.2f,%.2f), (%.2f,%.2f)\n' % (self.name,
81                                                    self.bbox[0][0],
82                                                    self.bbox[0][1],
83                                                    self.bbox[1][0],
84                                                    self.bbox[1][1])
85                                                  
86     def axis_centroid (self, axis):
87         return apply (sum, self.bbox[axis])  / 2 
88     
89     def centroid_distance (self, other, scale):
90         return max_distance (self.centroid, other.centroid) / scale 
91         
92     def bbox_distance (self, other):
93         divisor = bbox_area (self.bbox) + bbox_area (other.bbox)
94
95         if divisor:
96             return (difference_area (self.bbox, other.bbox) +
97                     difference_area (other.bbox, self.bbox)) / divisor
98         else:
99             return 0.0
100         
101     def expression_distance (self, other):
102         if self.output_expression == other.output_expression:
103             return 0
104         else:
105             return 1
106
107 ################################################################
108 # single System.
109
110 class SystemSignature:
111     def __init__ (self, grob_sigs):
112         d = {}
113         for g in grob_sigs:
114             val = d.setdefault (g.name, [])
115             val += [g]
116
117         self.grob_dict = d
118         self.set_all_bbox (grob_sigs)
119
120     def set_all_bbox (self, grobs):
121         self.bbox = empty_bbox
122         for g in grobs:
123             self.bbox = bbox_union (g.bbox, self.bbox)
124
125     def closest (self, grob_name, centroid):
126         min_d = INFTY
127         min_g = None
128         try:
129             grobs = self.grob_dict[grob_name]
130
131             for g in grobs:
132                 d = max_distance (g.centroid, centroid)
133                 if d < min_d:
134                     min_d = d
135                     min_g = g
136
137
138             return min_g
139
140         except KeyError:
141             return None
142     def grobs (self):
143         return reduce (lambda x,y: x+y, self.grob_dict.values(), [])
144
145 ################################################################
146 ## comparison of systems.
147
148 class SystemLink:
149     def __init__ (self, system1, system2):
150         self.system1 = system1
151         self.system2 = system2
152         
153         self.link_list_dict = {}
154         self.back_link_dict = {}
155
156
157         ## pairs
158         self.orphans = []
159
160         ## pair -> distance
161         self.geo_distances = {}
162
163         ## pairs
164         self.expression_changed = []
165
166         self._geometric_distance = None
167         self._expression_change_count = None
168         self._orphan_count = None
169         
170         for g in system1.grobs ():
171
172             ## skip empty bboxes.
173             if bbox_is_empty (g.bbox):
174                 continue
175             
176             closest = system2.closest (g.name, g.centroid)
177             
178             self.link_list_dict.setdefault (closest, [])
179             self.link_list_dict[closest].append (g)
180             self.back_link_dict[g] = closest
181
182
183     def calc_geometric_distance (self):
184         total = 0.0
185         for (g1,g2) in self.back_link_dict.items ():
186             if g2:
187                 d = g1.bbox_distance (g2)
188                 if d:
189                     self.geo_distances[(g1,g2)] = d
190
191                 total += d
192
193         self._geometric_distance = total
194     
195     def calc_orphan_count (self):
196         count = 0
197         for (g1, g2) in self.back_link_dict.items ():
198             if g2 == None:
199                 self.orphans.append ((g1, None))
200                 
201                 count += 1
202
203         self._orphan_count = count
204     
205     def calc_output_exp_distance (self):
206         d = 0
207         for (g1,g2) in self.back_link_dict.items ():
208             if g2:
209                 d += g1.expression_distance (g2)
210
211         self._expression_change_count = d
212
213     def output_expression_details_string (self):
214         return ', '.join ([g1.name for g1 in self.expression_changed])
215     
216     def geo_details_string (self):
217         results = [(d, g1,g2) for ((g1, g2), d) in self.geo_distances.items()]
218         results.sort ()
219         results.reverse ()
220         
221         return ', '.join (['%s: %f' % (g1.name, d) for (d, g1, g2) in results])
222
223     def orphan_details_string (self):
224         return ', '.join (['%s-None' % g1.name for (g1,g2) in self.orphans if g2==None])
225
226     def geometric_distance (self):
227         if self._geometric_distance == None:
228             self.calc_geometric_distance ()
229         return self._geometric_distance
230     
231     def orphan_count (self):
232         if self._orphan_count == None:
233             self.calc_orphan_count ()
234             
235         return self._orphan_count
236     
237     def output_expression_change_count (self):
238         if self._expression_change_count == None:
239             self.calc_output_exp_distance ()
240         return self._expression_change_count
241         
242     def distance (self):
243         return (self.output_expression_change_count (),
244                 self.orphan_count (),
245                 self.geometric_distance ())
246     
247 def read_signature_file (name):
248     print 'reading', name
249     exp_str = ("[%s]" % open (name).read ())
250     entries = safeeval.safe_eval (exp_str)
251
252     grob_sigs = [GrobSignature (e) for e in entries]
253     sig = SystemSignature (grob_sigs)
254     return sig
255
256
257 ################################################################
258 # different systems of a .ly file.
259
260 class FileLink:
261     def __init__ (self):
262         self.original_name = ''
263         self.base_names = ('','')
264         self.system_links = {}
265         self._distance = None
266         
267     def add_system_link (self, link, number):
268         self.system_links[number] = link
269
270     def calc_distance (self):
271         d = 0.0
272         for l in self.system_links.values ():
273             d = max (d, l.geometric_distance ())
274         return d
275
276     def distance (self):
277         if type (self._distance) != type (0.0):
278             return self.calc_distance ()
279         
280         return self._distance
281
282     def text_record_string (self):
283         return '%-30f %-20s\n' % (self.distance (),
284                              self.original_name)
285
286     def source_file (self):
287         for ext in ('.ly', '.ly.txt'):
288             if os.path.exists (self.base_names[1] + ext):
289                 return self.base_names[1] + ext
290         return ''
291     
292     def add_file_compare (self, f1, f2):
293         system_index = [] 
294
295         def note_system_index (m):
296             system_index.append (int (m.group (1)))
297             return ''
298         
299         base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
300         base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
301
302         self.base_names = (os.path.normpath (base1),
303                            os.path.normpath (base2))
304
305         def note_original (match):
306             self.original_name = match.group (1)
307             return ''
308         
309         if not self.original_name:
310             self.original_name = os.path.split (base1)[1]
311
312             ## ugh: drop the .ly.txt
313             for ext in ('.ly', '.ly.txt'):
314                 try:
315                     re.sub (r'\\sourcefilename "([^"]+)"',
316                             note_original, open (base1 + ext).read ())
317                 except IOError:
318                     pass
319                 
320         s1 = read_signature_file (f1)
321         s2 = read_signature_file (f2)
322
323         link = SystemLink (s1, s2)
324
325         self.add_system_link (link, system_index[0])
326
327     def link_files_for_html (self, old_dir, new_dir, dest_dir):
328         for ext in ('.png', '.ly'):
329             for oldnew in (0,1):
330                 link_file (self.base_names[oldnew] + ext, 
331                            dest_dir + '/' + self.base_names[oldnew] + ext)
332
333     def html_record_string (self,  old_dir, new_dir):
334         def img_cell (ly, img, name):
335             if not name:
336                 name = 'source'
337             else:
338                 name = '<tt>%s</tt>' % name
339                 
340             return '''
341 <td align="center">
342 <a href="%(img)s">
343 <img src="%(img)s" style="border-style: none; max-width: 500px;">
344 </a><br>
345 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
346 </font>
347 </td>
348 ''' % locals ()
349         
350
351         img_1  = self.base_names[0] + '.png'
352         ly_1  = self.base_names[0] + '.ly'
353         img_2  = self.base_names[1] + '.png'
354         ly_2  = self.base_names[1] + '.ly'
355         html_2  = self.base_names[1] + '.html'
356         name = self.original_name
357         
358         html_entry = '''
359 <tr>
360 <td>
361 %f<br>
362 (<a href="%s">details</a>)
363 </td>
364
365 %s
366 %s
367 </tr>
368 ''' % (self.distance (), html_2,
369        img_cell (ly_1, img_1, name), img_cell (ly_2, img_2, name))
370
371
372         return html_entry
373
374
375     def html_system_details_string (self):
376         systems = self.system_links.items ()
377         systems.sort ()
378
379         html = ""
380         for (c, link) in systems:
381             e = '<td>%d</td>' % c
382             for d in link.distance ():
383                 e += '<td>%f</td>' % d
384             
385             e = '<tr>%s</tr>' % e
386
387             html += e
388
389             e = '<td>%d</td>' % c
390             for s in (link.output_expression_details_string (),
391                       link.orphan_details_string (),
392                       link.geo_details_string ()):
393                 e += "<td>%s</td>" % s
394
395             
396             e = '<tr>%s</tr>' % e
397             html += e
398             
399         original = self.original_name
400         html = '''<html>
401 <head>
402 <title>comparison details for %(original)s</title>
403 </head>
404 <body>
405 <table border=1>
406 <tr>
407 <th>system</th>
408 <th>output</th>
409 <th>orphan</th>
410 <th>geo</th>
411 </tr>
412
413 %(html)s
414 </table>
415
416 </body>
417 </html>
418 ''' % locals ()
419         return html
420
421     def write_html_system_details (self, dir1, dir2, dest_dir):
422         dest_file =  os.path.join (dest_dir, self.base_names[1] + '.html')
423
424         details = open_write_file (dest_file)
425         details.write (self.html_system_details_string ())
426
427 ################################################################
428 # Files/directories
429
430 import glob
431 import re
432
433
434
435 def compare_signature_files (f1, f2):
436     s1 = read_signature_file (f1)
437     s2 = read_signature_file (f2)
438     
439     return SystemLink (s1, s2).distance ()
440
441 def paired_files (dir1, dir2, pattern):
442     """
443     Search DIR1 and DIR2 for PATTERN.
444
445     Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
446
447     """
448     
449     files1 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir1 + '/' + pattern))
450     files2 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir2 + '/' + pattern))
451
452     pairs = []
453     missing = []
454     for f in files1.keys ():
455         try:
456             files2.pop (f)
457             pairs.append (f)
458         except KeyError:
459             missing.append (f)
460
461     return (pairs, files2.keys (), missing)
462     
463 class ComparisonData:
464     def __init__ (self):
465         self.result_dict = {}
466         self.missing = []
467         self.added = []
468         self.file_links = {}
469
470     def compare_trees (self, dir1, dir2):
471         self.compare_directories (dir1, dir2)
472         
473         (root, dirs, files) = os.walk (dir1).next ()
474         for d in dirs:
475             d1 = os.path.join (dir1, d)
476             d2 = os.path.join (dir2, d)
477
478             if os.path.islink (d1) or os.path.islink (d2):
479                 continue
480             
481             if os.path.isdir (d2):
482                 self.compare_trees (d1, d2)
483     
484     def compare_directories (self, dir1, dir2):
485
486         (paired, m1, m2) = paired_files (dir1, dir2, '*.signature')
487
488         self.missing += [(dir1, m) for m in m1] 
489         self.added += [(dir2, m) for m in m2] 
490
491         for p in paired:
492             if (inspect_max_count
493                 and len (self.file_links) > inspect_max_count):
494                 
495                 continue
496             
497             f2 = dir2 +  '/' + p
498             f1 = dir1 +  '/' + p
499             self.compare_files (f1, f2)
500
501     def compare_files (self, f1, f2):
502         name = os.path.split (f1)[1]
503         name = re.sub ('-[0-9]+.signature', '', name)
504         
505         file_link = None
506         try:
507             file_link = self.file_links[name]
508         except KeyError:
509             file_link = FileLink ()
510             self.file_links[name] = file_link
511
512         file_link.add_file_compare (f1,f2)
513
514     def write_text_result_page (self, filename, threshold):
515         print 'writing "%s"' % filename
516         out = None
517         if filename == '':
518             out = sys.stdout
519         else:
520             out = open_write_file (filename)
521
522         ## todo: support more scores.
523         results = [(link.distance(), link)
524                    for link in self.file_links.values ()]
525         results.sort ()
526         results.reverse ()
527
528         
529         for (score, link) in results:
530             if score > threshold:
531                 out.write (link.text_record_string ())
532
533         out.write ('\n\n')
534         out.write ('%d below threshold\n' % len ([1 for s,l  in results
535                                                     if threshold >=  s > 0.0]))
536         out.write ('%d unchanged\n' % len ([1 for (s,l) in results if s == 0.0]))
537         
538     def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
539         self.write_text_result_page (dest_dir + '/index.txt', threshold)
540         
541     def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
542         dir1 = dir1.replace ('//', '/')
543         dir2 = dir2.replace ('//', '/')
544         
545         results = [(link.distance(), link)
546                    for link in self.file_links.values ()]
547         results.sort ()
548         results.reverse ()
549
550         html = ''
551         old_prefix = os.path.split (dir1)[1]
552         for (score, link) in results:
553             if score <= threshold:
554                 continue
555
556             link.write_html_system_details (dir1, dir2, dest_dir)
557             link.link_files_for_html (dir1, dir2, dest_dir) 
558             html += link.html_record_string (dir1, dir2)
559
560
561         html = '''<html>
562 <table rules="rows" border bordercolor="blue">
563 <tr>
564 <th>distance</th>
565 <th>old</th>
566 <th>new</th>
567 </tr>
568 %(html)s
569 </table>
570 </html>''' % locals()
571
572         html += ('<p>')
573         below_count  =len ([1 for s,l  in results
574                             if threshold >=  s > 0.0])
575
576         if below_count:
577             html += ('<p>%d below threshold</p>' % below_count)
578
579         html += ('<p>%d unchanged</p>'
580                  % len ([1 for (s,l) in results if s == 0.0]))
581
582
583         dest_file = dest_dir + '/index.html'
584         open_write_file (dest_file).write (html)
585         
586     def print_results (self, threshold):
587         self.write_text_result_page ('', threshold)
588
589 def compare_trees (dir1, dir2, dest_dir, threshold):
590     data = ComparisonData ()
591     data.compare_trees (dir1, dir2)
592     data.print_results (threshold)
593
594     if os.path.isdir (dest_dir):
595         system ('rm -rf %s '% dest_dir)
596
597     data.create_html_result_page (dir1, dir2, dest_dir, threshold)
598     data.create_text_result_page (dir1, dir2, dest_dir, threshold)
599     
600 ################################################################
601 # TESTING
602
603 def mkdir (x):
604     if not os.path.isdir (x):
605         print 'mkdir', x
606         os.makedirs (x)
607
608 def link_file (x, y):
609     mkdir (os.path.split (y)[0])
610     os.link (x, y)
611     
612 def open_write_file (x):
613     d = os.path.split (x)[0]
614     mkdir (d)
615     return open (x, 'w')
616
617
618 def system (x):
619     
620     print 'invoking', x
621     stat = os.system (x)
622     assert stat == 0
623
624
625 def test_paired_files ():
626     print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
627                         os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
628                   
629     
630 def test_compare_trees ():
631     system ('rm -rf dir1 dir2')
632     system ('mkdir dir1 dir2')
633     system ('cp 20{-*.signature,.ly,.png} dir1')
634     system ('cp 20{-*.signature,.ly,.png} dir2')
635     system ('cp 20expr{-*.signature,.ly,.png} dir1')
636     system ('cp 19{-*.signature,.ly,.png} dir2/')
637     system ('cp 19{-*.signature,.ly,.png} dir1/')
638     system ('cp 19-1.signature 19-sub-1.signature')
639     system ('cp 19.ly 19-sub.ly')
640     system ('cp 19.png 19-sub.png')
641     
642     system ('mkdir -p dir1/subdir/ dir2/subdir/')
643     system ('cp 19-sub{-*.signature,.ly,.png} dir1/subdir/')
644     system ('cp 19-sub{-*.signature,.ly,.png} dir2/subdir/')
645     system ('cp 20grob{-*.signature,.ly,.png} dir2/')
646     system ('cp 20grob{-*.signature,.ly,.png} dir1/')
647
648     ## introduce differences
649     system ('cp 19-1.signature dir2/20-1.signature')
650     system ('cp 20-1.signature dir2/subdir/19-sub-1.signature')
651
652     ## radical diffs.
653     system ('cp 19-1.signature dir2/20grob-1.signature')
654     system ('cp 19-1.signature dir2/20grob-2.signature')
655
656     compare_trees ('dir1', 'dir2', 'compare-dir1dir2', 0.5)
657
658
659 def test_basic_compare ():
660     ly_template = r"""#(set! toplevel-score-handler print-score-with-defaults)
661 #(set! toplevel-music-handler
662  (lambda (p m)
663  (if (not (eq? (ly:music-property m 'void) #t))
664     (print-score-with-defaults
665     p (scorify-music m p)))))
666
667 \sourcefilename "my-source.ly"
668
669 %(papermod)s
670 <<
671 \new Staff \relative c {
672   c4^"%(userstring)s" %(extragrob)s
673   }
674 \new Staff \relative c {
675   c4^"%(userstring)s" %(extragrob)s
676   }
677 >>
678 """
679
680     dicts = [{ 'papermod' : '',
681                'name' : '20',
682                'extragrob': '',
683                'userstring': 'test' },
684              { 'papermod' : '#(set-global-staff-size 19.5)',
685                'name' : '19',
686                'extragrob': '',
687                'userstring': 'test' },
688              { 'papermod' : '',
689                'name' : '20expr',
690                'extragrob': '',
691                'userstring': 'blabla' },
692              { 'papermod' : '',
693                'name' : '20grob',
694                'extragrob': 'r2. \\break c1',
695                'userstring': 'test' }
696
697              ]
698
699     for d in dicts:
700         open (d['name'] + '.ly','w').write (ly_template % d)
701         
702     names = [d['name'] for d in dicts]
703     
704     system ('lilypond -ddump-signatures --png -b eps ' + ' '.join (names))
705     
706     sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
707     combinations = {}
708     for (n1, s1) in sigs.items():
709         for (n2, s2) in sigs.items():
710             combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
711
712     results = combinations.items ()
713     results.sort ()
714     for k,v in results:
715         print '%-20s' % k, v
716
717     assert combinations['20-20'] == (0.0,0.0,0.0)
718     assert combinations['20-20expr'][0] > 0.0
719     assert combinations['20-19'][2] < 10.0
720     assert combinations['20-19'][2] > 0.0
721
722
723 def run_tests ():
724     dir = 'output-distance-test'
725
726     do_clean = not os.path.exists (dir)
727
728     print 'test results in ', dir
729     if do_clean:
730         system ('rm -rf ' + dir)
731         system ('mkdir ' + dir)
732         
733     os.chdir (dir)
734     if do_clean:
735         test_basic_compare ()
736         
737     test_compare_trees ()
738     
739 ################################################################
740 #
741
742 def main ():
743     p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
744     p.usage = 'output-distance.py [options] tree1 tree2'
745     
746     p.add_option ('', '--test-self',
747                   dest="run_test",
748                   action="store_true",
749                   help='run test method')
750     p.add_option ('--max-count',
751                   dest="max_count",
752                   metavar="COUNT",
753                   type="int",
754                   default=0, 
755                   action="store",
756                   help='only analyze COUNT signature pairs')
757  
758
759     p.add_option ('', '--threshold',
760                   dest="threshold",
761                   default=0.3,
762                   action="store",
763                   type="float",
764                   help='threshold for geometric distance')
765
766     (o,a) = p.parse_args ()
767
768     if o.run_test:
769         run_tests ()
770         sys.exit (0)
771
772     if len (a) != 2:
773         p.print_usage()
774         sys.exit (2)
775
776     global inspect_max_count
777     inspect_max_count = o.max_count
778
779     compare_trees (a[0], a[1], os.path.join (a[1],  'compare-' +  a[0]))
780
781 if __name__ == '__main__':
782     main()
783