]> git.donarmstrong.com Git - lilypond.git/blob - buildscripts/output-distance.py
7c7a914d567dd23a4426c5d8e1c3b77f678b58f3
[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     
250     entries = open (name).read ().split ('\n')
251     def string_to_tup (s):
252         return tuple (map (float, s.split (' '))) 
253
254     def string_to_entry (s):
255         fields = s.split('@')
256         fields[2] = string_to_tup (fields[2])
257         fields[3] = string_to_tup (fields[3])
258
259         return tuple (fields)
260     
261     entries = [string_to_entry (e) for e in entries
262                if e and not e.startswith ('#')]
263
264     grob_sigs = [GrobSignature (e) for e in entries]
265     sig = SystemSignature (grob_sigs)
266     return sig
267
268
269 ################################################################
270 # different systems of a .ly file.
271
272 class FileLink:
273     def __init__ (self):
274         self.original_name = ''
275         self.base_names = ('','')
276         self.system_links = {}
277         self._distance = None
278         
279     def add_system_link (self, link, number):
280         self.system_links[number] = link
281
282     def calc_distance (self):
283         d = 0.0
284
285         orphan_distance = 0.0
286         for l in self.system_links.values ():
287             d = max (d, l.geometric_distance ())
288             orphan_distance += l.orphan_count ()
289             
290         return d + orphan_distance
291
292     def distance (self):
293         if type (self._distance) != type (0.0):
294             return self.calc_distance ()
295         
296         return self._distance
297
298     def text_record_string (self):
299         return '%-30f %-20s\n' % (self.distance (),
300                              self.original_name)
301
302     def source_file (self):
303         for ext in ('.ly', '.ly.txt'):
304             if os.path.exists (self.base_names[1] + ext):
305                 return self.base_names[1] + ext
306         return ''
307     
308     def add_file_compare (self, f1, f2):
309         system_index = [] 
310
311         def note_system_index (m):
312             system_index.append (int (m.group (1)))
313             return ''
314         
315         base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
316         base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
317
318         self.base_names = (os.path.normpath (base1),
319                            os.path.normpath (base2))
320
321         def note_original (match):
322             self.original_name = match.group (1)
323             return ''
324         
325         if not self.original_name:
326             self.original_name = os.path.split (base1)[1]
327
328             ## ugh: drop the .ly.txt
329             for ext in ('.ly', '.ly.txt'):
330                 try:
331                     re.sub (r'\\sourcefilename "([^"]+)"',
332                             note_original, open (base1 + ext).read ())
333                 except IOError:
334                     pass
335                 
336         s1 = read_signature_file (f1)
337         s2 = read_signature_file (f2)
338
339         link = SystemLink (s1, s2)
340
341         self.add_system_link (link, system_index[0])
342
343     def link_files_for_html (self, old_dir, new_dir, dest_dir):
344         for ext in ('.png', '.ly'):
345             for oldnew in (0,1):
346                 link_file (self.base_names[oldnew] + ext, 
347                            dest_dir + '/' + self.base_names[oldnew] + ext)
348
349     def html_record_string (self,  old_dir, new_dir):
350         def img_cell (ly, img, name):
351             if not name:
352                 name = 'source'
353             else:
354                 name = '<tt>%s</tt>' % name
355                 
356             return '''
357 <td align="center">
358 <a href="%(img)s">
359 <img src="%(img)s" style="border-style: none; max-width: 500px;">
360 </a><br>
361 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
362 </font>
363 </td>
364 ''' % locals ()
365         
366
367         img_1  = self.base_names[0] + '.png'
368         ly_1  = self.base_names[0] + '.ly'
369         img_2  = self.base_names[1] + '.png'
370         ly_2  = self.base_names[1] + '.ly'
371         html_2  = self.base_names[1] + '.html'
372         name = self.original_name
373         
374         html_entry = '''
375 <tr>
376 <td>
377 %f<br>
378 (<a href="%s">details</a>)
379 </td>
380
381 %s
382 %s
383 </tr>
384 ''' % (self.distance (), html_2,
385        img_cell (ly_1, img_1, name), img_cell (ly_2, img_2, name))
386
387
388         return html_entry
389
390
391     def html_system_details_string (self):
392         systems = self.system_links.items ()
393         systems.sort ()
394
395         html = ""
396         for (c, link) in systems:
397             e = '<td>%d</td>' % c
398             for d in link.distance ():
399                 e += '<td>%f</td>' % d
400             
401             e = '<tr>%s</tr>' % e
402
403             html += e
404
405             e = '<td>%d</td>' % c
406             for s in (link.output_expression_details_string (),
407                       link.orphan_details_string (),
408                       link.geo_details_string ()):
409                 e += "<td>%s</td>" % s
410
411             
412             e = '<tr>%s</tr>' % e
413             html += e
414             
415         original = self.original_name
416         html = '''<html>
417 <head>
418 <title>comparison details for %(original)s</title>
419 </head>
420 <body>
421 <table border=1>
422 <tr>
423 <th>system</th>
424 <th>output</th>
425 <th>orphan</th>
426 <th>geo</th>
427 </tr>
428
429 %(html)s
430 </table>
431
432 </body>
433 </html>
434 ''' % locals ()
435         return html
436
437     def write_html_system_details (self, dir1, dir2, dest_dir):
438         dest_file =  os.path.join (dest_dir, self.base_names[1] + '.html')
439
440         details = open_write_file (dest_file)
441         details.write (self.html_system_details_string ())
442
443 ################################################################
444 # Files/directories
445
446 import glob
447 import re
448
449
450
451 def compare_signature_files (f1, f2):
452     s1 = read_signature_file (f1)
453     s2 = read_signature_file (f2)
454     
455     return SystemLink (s1, s2).distance ()
456
457 def paired_files (dir1, dir2, pattern):
458     """
459     Search DIR1 and DIR2 for PATTERN.
460
461     Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
462
463     """
464     
465     files1 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir1 + '/' + pattern))
466     files2 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir2 + '/' + pattern))
467
468     pairs = []
469     missing = []
470     for f in files1.keys ():
471         try:
472             files2.pop (f)
473             pairs.append (f)
474         except KeyError:
475             missing.append (f)
476
477     return (pairs, files2.keys (), missing)
478     
479 class ComparisonData:
480     def __init__ (self):
481         self.result_dict = {}
482         self.missing = []
483         self.added = []
484         self.file_links = {}
485
486     def compare_trees (self, dir1, dir2):
487         self.compare_directories (dir1, dir2)
488         
489         (root, dirs, files) = os.walk (dir1).next ()
490         for d in dirs:
491             d1 = os.path.join (dir1, d)
492             d2 = os.path.join (dir2, d)
493
494             if os.path.islink (d1) or os.path.islink (d2):
495                 continue
496             
497             if os.path.isdir (d2):
498                 self.compare_trees (d1, d2)
499     
500     def compare_directories (self, dir1, dir2):
501
502         (paired, m1, m2) = paired_files (dir1, dir2, '*.signature')
503
504         self.missing += [(dir1, m) for m in m1] 
505         self.added += [(dir2, m) for m in m2] 
506
507         for p in paired:
508             if (inspect_max_count
509                 and len (self.file_links) > inspect_max_count):
510                 
511                 continue
512             
513             f2 = dir2 +  '/' + p
514             f1 = dir1 +  '/' + p
515             self.compare_files (f1, f2)
516
517     def compare_files (self, f1, f2):
518         name = os.path.split (f1)[1]
519         name = re.sub ('-[0-9]+.signature', '', name)
520         
521         file_link = None
522         try:
523             file_link = self.file_links[name]
524         except KeyError:
525             file_link = FileLink ()
526             self.file_links[name] = file_link
527
528         file_link.add_file_compare (f1,f2)
529
530     def write_text_result_page (self, filename, threshold):
531         print 'writing "%s"' % filename
532         out = None
533         if filename == '':
534             out = sys.stdout
535         else:
536             out = open_write_file (filename)
537
538         ## todo: support more scores.
539         results = [(link.distance(), link)
540                    for link in self.file_links.values ()]
541         results.sort ()
542         results.reverse ()
543
544         
545         for (score, link) in results:
546             if score > threshold:
547                 out.write (link.text_record_string ())
548
549         out.write ('\n\n')
550         out.write ('%d below threshold\n' % len ([1 for s,l  in results
551                                                     if threshold >=  s > 0.0]))
552         out.write ('%d unchanged\n' % len ([1 for (s,l) in results if s == 0.0]))
553         
554     def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
555         self.write_text_result_page (dest_dir + '/index.txt', threshold)
556         
557     def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
558         dir1 = dir1.replace ('//', '/')
559         dir2 = dir2.replace ('//', '/')
560         
561         results = [(link.distance(), link)
562                    for link in self.file_links.values ()]
563         results.sort ()
564         results.reverse ()
565
566         html = ''
567         old_prefix = os.path.split (dir1)[1]
568         for (score, link) in results:
569             if score <= threshold:
570                 continue
571
572             link.write_html_system_details (dir1, dir2, dest_dir)
573             link.link_files_for_html (dir1, dir2, dest_dir) 
574             html += link.html_record_string (dir1, dir2)
575
576
577         html = '''<html>
578 <table rules="rows" border bordercolor="blue">
579 <tr>
580 <th>distance</th>
581 <th>%(dir1)s</th>
582 <th>%(dir2)s</th>
583 </tr>
584 %(html)s
585 </table>
586 </html>''' % locals()
587
588         html += ('<p>')
589         below_count  =len ([1 for s,l  in results
590                             if threshold >=  s > 0.0])
591
592         if below_count:
593             html += ('<p>%d below threshold</p>' % below_count)
594
595         html += ('<p>%d unchanged</p>'
596                  % len ([1 for (s,l) in results if s == 0.0]))
597
598
599         dest_file = dest_dir + '/index.html'
600         open_write_file (dest_file).write (html)
601         
602     def print_results (self, threshold):
603         self.write_text_result_page ('', threshold)
604
605 def compare_trees (dir1, dir2, dest_dir, threshold):
606     data = ComparisonData ()
607     data.compare_trees (dir1, dir2)
608     data.print_results (threshold)
609
610     if os.path.isdir (dest_dir):
611         system ('rm -rf %s '% dest_dir)
612
613     data.create_html_result_page (dir1, dir2, dest_dir, threshold)
614     data.create_text_result_page (dir1, dir2, dest_dir, threshold)
615     
616 ################################################################
617 # TESTING
618
619 def mkdir (x):
620     if not os.path.isdir (x):
621         print 'mkdir', x
622         os.makedirs (x)
623
624 def link_file (x, y):
625     mkdir (os.path.split (y)[0])
626     try:
627         os.link (x, y)
628     except OSError, z:
629         print 'OSError', x, y, z
630         raise OSError
631     
632 def open_write_file (x):
633     d = os.path.split (x)[0]
634     mkdir (d)
635     return open (x, 'w')
636
637
638 def system (x):
639     
640     print 'invoking', x
641     stat = os.system (x)
642     assert stat == 0
643
644
645 def test_paired_files ():
646     print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
647                         os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
648                   
649     
650 def test_compare_trees ():
651     system ('rm -rf dir1 dir2')
652     system ('mkdir dir1 dir2')
653     system ('cp 20{-*.signature,.ly,.png} dir1')
654     system ('cp 20{-*.signature,.ly,.png} dir2')
655     system ('cp 20expr{-*.signature,.ly,.png} dir1')
656     system ('cp 19{-*.signature,.ly,.png} dir2/')
657     system ('cp 19{-*.signature,.ly,.png} dir1/')
658     system ('cp 19-1.signature 19-sub-1.signature')
659     system ('cp 19.ly 19-sub.ly')
660     system ('cp 19.png 19-sub.png')
661     
662     system ('mkdir -p dir1/subdir/ dir2/subdir/')
663     system ('cp 19-sub{-*.signature,.ly,.png} dir1/subdir/')
664     system ('cp 19-sub{-*.signature,.ly,.png} dir2/subdir/')
665     system ('cp 20grob{-*.signature,.ly,.png} dir2/')
666     system ('cp 20grob{-*.signature,.ly,.png} dir1/')
667
668     ## introduce differences
669     system ('cp 19-1.signature dir2/20-1.signature')
670     system ('cp 20-1.signature dir2/subdir/19-sub-1.signature')
671
672     ## radical diffs.
673     system ('cp 19-1.signature dir2/20grob-1.signature')
674     system ('cp 19-1.signature dir2/20grob-2.signature')
675
676     compare_trees ('dir1', 'dir2', 'compare-dir1dir2', 0.5)
677
678
679 def test_basic_compare ():
680     ly_template = r"""#(set! toplevel-score-handler print-score-with-defaults)
681 #(set! toplevel-music-handler
682  (lambda (p m)
683  (if (not (eq? (ly:music-property m 'void) #t))
684     (print-score-with-defaults
685     p (scorify-music m p)))))
686
687 \sourcefilename "my-source.ly"
688
689 %(papermod)s
690 <<
691 \new Staff \relative c {
692   c4^"%(userstring)s" %(extragrob)s
693   }
694 \new Staff \relative c {
695   c4^"%(userstring)s" %(extragrob)s
696   }
697 >>
698 """
699
700     dicts = [{ 'papermod' : '',
701                'name' : '20',
702                'extragrob': '',
703                'userstring': 'test' },
704              { 'papermod' : '#(set-global-staff-size 19.5)',
705                'name' : '19',
706                'extragrob': '',
707                'userstring': 'test' },
708              { 'papermod' : '',
709                'name' : '20expr',
710                'extragrob': '',
711                'userstring': 'blabla' },
712              { 'papermod' : '',
713                'name' : '20grob',
714                'extragrob': 'r2. \\break c1',
715                'userstring': 'test' }
716
717              ]
718
719     for d in dicts:
720         open (d['name'] + '.ly','w').write (ly_template % d)
721         
722     names = [d['name'] for d in dicts]
723     
724     system ('lilypond -ddump-signatures --png -b eps ' + ' '.join (names))
725     test_compare_signatures (names)
726     
727 def test_compare_signatures (names, timing=False):
728
729     import time
730
731     times = 1
732     if timing:
733         times = 100
734
735     t0 = time.clock ()
736
737     count = 0
738     for t in range (0, times):
739         sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
740         count += 1
741
742     if timing:
743         print 'elapsed', (time.clock() - t0)/count
744
745
746     t0 = time.clock ()
747     count = 0
748     combinations = {}
749     for (n1, s1) in sigs.items():
750         for (n2, s2) in sigs.items():
751             combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
752             count += 1
753
754     if timing:
755         print 'elapsed', (time.clock() - t0)/count
756
757     results = combinations.items ()
758     results.sort ()
759     for k,v in results:
760         print '%-20s' % k, v
761
762     assert combinations['20-20'] == (0.0,0.0,0.0)
763     assert combinations['20-20expr'][0] > 0.0
764     assert combinations['20-19'][2] < 10.0
765     assert combinations['20-19'][2] > 0.0
766
767
768 def run_tests ():
769     dir = 'output-distance-test'
770
771     do_clean = not os.path.exists (dir)
772
773     print 'test results in ', dir
774     if do_clean:
775         system ('rm -rf ' + dir)
776         system ('mkdir ' + dir)
777         
778     os.chdir (dir)
779     if do_clean:
780         test_basic_compare ()
781         
782     test_compare_trees ()
783     
784 ################################################################
785 #
786
787 def main ():
788     p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
789     p.usage = 'output-distance.py [options] tree1 tree2'
790     
791     p.add_option ('', '--test-self',
792                   dest="run_test",
793                   action="store_true",
794                   help='run test method')
795     
796     p.add_option ('--max-count',
797                   dest="max_count",
798                   metavar="COUNT",
799                   type="int",
800                   default=0, 
801                   action="store",
802                   help='only analyze COUNT signature pairs')
803
804     p.add_option ('', '--threshold',
805                   dest="threshold",
806                   default=0.3,
807                   action="store",
808                   type="float",
809                   help='threshold for geometric distance')
810
811     (o,a) = p.parse_args ()
812
813     if o.run_test:
814         run_tests ()
815         sys.exit (0)
816
817     if len (a) != 2:
818         p.print_usage()
819         sys.exit (2)
820
821     global inspect_max_count
822     inspect_max_count = o.max_count
823
824     compare_trees (a[0], a[1], os.path.join (a[1],  'compare-' +  a[0]),
825                    o.threshold)
826
827 if __name__ == '__main__':
828     main()
829