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/')
18 OUTPUT_EXPRESSION_PENALTY = 1
19 ORPHAN_GROB_PENALTY = 1
22 def max_distance (x1, x2):
25 for (p,q) in zip (x1, x2):
26 dist = max (abs (p-q), dist)
31 empty_interval = (INFTY, -INFTY)
32 empty_bbox = (empty_interval, empty_interval)
34 def interval_is_empty (i):
37 def interval_length (i):
38 return max (i[1]-i[0], 0)
40 def interval_union (i1, i2):
41 return (min (i1[0], i2[0]),
44 def interval_intersect (i1, i2):
45 return (max (i1[0], i2[0]),
48 def bbox_is_empty (b):
49 return (interval_is_empty (b[0])
50 or interval_is_empty (b[1]))
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]))
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]))
61 return interval_length (b[X_AXIS]) * interval_length (b[Y_AXIS])
63 def bbox_diameter (b):
64 return max (interval_length (b[X_AXIS]),
65 interval_length (b[Y_AXIS]))
68 def difference_area (a, b):
69 return bbox_area (a) - bbox_area (bbox_intersection (a,b))
72 def __init__ (self, exp_list):
73 (self.name, self.origin, bbox_x,
74 bbox_y, self.output_expression) = tuple (exp_list)
76 self.bbox = (bbox_x, bbox_y)
77 self.centroid = (bbox_x[0] + bbox_x[1], bbox_y[0] + bbox_y[1])
80 return '%s: (%.2f,%.2f), (%.2f,%.2f)\n' % (self.name,
86 def axis_centroid (self, axis):
87 return apply (sum, self.bbox[axis]) / 2
89 def centroid_distance (self, other, scale):
90 return max_distance (self.centroid, other.centroid) / scale
92 def bbox_distance (self, other):
93 divisor = bbox_area (self.bbox) + bbox_area (other.bbox)
96 return (difference_area (self.bbox, other.bbox) +
97 difference_area (other.bbox, self.bbox)) / divisor
101 def expression_distance (self, other):
102 if self.output_expression == other.output_expression:
107 ################################################################
110 class SystemSignature:
111 def __init__ (self, grob_sigs):
114 val = d.setdefault (g.name, [])
118 self.set_all_bbox (grob_sigs)
120 def set_all_bbox (self, grobs):
121 self.bbox = empty_bbox
123 self.bbox = bbox_union (g.bbox, self.bbox)
125 def closest (self, grob_name, centroid):
129 grobs = self.grob_dict[grob_name]
132 d = max_distance (g.centroid, centroid)
143 return reduce (lambda x,y: x+y, self.grob_dict.values(), [])
145 ################################################################
146 ## comparison of systems.
149 def __init__ (self, system1, system2):
150 self.system1 = system1
151 self.system2 = system2
153 self.link_list_dict = {}
154 self.back_link_dict = {}
161 self.geo_distances = {}
164 self.expression_changed = []
166 self._geometric_distance = None
167 self._expression_change_count = None
168 self._orphan_count = None
170 for g in system1.grobs ():
172 ## skip empty bboxes.
173 if bbox_is_empty (g.bbox):
176 closest = system2.closest (g.name, g.centroid)
178 self.link_list_dict.setdefault (closest, [])
179 self.link_list_dict[closest].append (g)
180 self.back_link_dict[g] = closest
183 def calc_geometric_distance (self):
185 for (g1,g2) in self.back_link_dict.items ():
187 d = g1.bbox_distance (g2)
189 self.geo_distances[(g1,g2)] = d
193 self._geometric_distance = total
195 def calc_orphan_count (self):
197 for (g1, g2) in self.back_link_dict.items ():
199 self.orphans.append ((g1, None))
203 self._orphan_count = count
205 def calc_output_exp_distance (self):
207 for (g1,g2) in self.back_link_dict.items ():
209 d += g1.expression_distance (g2)
211 self._expression_change_count = d
213 def output_expression_details_string (self):
214 return ', '.join ([g1.name for g1 in self.expression_changed])
216 def geo_details_string (self):
217 results = [(d, g1,g2) for ((g1, g2), d) in self.geo_distances.items()]
221 return ', '.join (['%s: %f' % (g1.name, d) for (d, g1, g2) in results])
223 def orphan_details_string (self):
224 return ', '.join (['%s-None' % g1.name for (g1,g2) in self.orphans if g2==None])
226 def geometric_distance (self):
227 if self._geometric_distance == None:
228 self.calc_geometric_distance ()
229 return self._geometric_distance
231 def orphan_count (self):
232 if self._orphan_count == None:
233 self.calc_orphan_count ()
235 return self._orphan_count
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
243 return (self.output_expression_change_count (),
244 self.orphan_count (),
245 self.geometric_distance ())
247 def read_signature_file (name):
248 print 'reading', name
250 entries = open (name).read ().split ('\n')
251 def string_to_tup (s):
252 return tuple (map (float, s.split (' ')))
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])
259 return tuple (fields)
261 entries = [string_to_entry (e) for e in entries
262 if e and not e.startswith ('#')]
264 grob_sigs = [GrobSignature (e) for e in entries]
265 sig = SystemSignature (grob_sigs)
269 ################################################################
270 # different systems of a .ly file.
274 self.original_name = ''
275 self.base_names = ('','')
276 self.system_links = {}
277 self._distance = None
279 def add_system_link (self, link, number):
280 self.system_links[number] = link
282 def calc_distance (self):
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 ()
290 return d + orphan_distance
293 if type (self._distance) != type (0.0):
294 return self.calc_distance ()
296 return self._distance
298 def text_record_string (self):
299 return '%-30f %-20s\n' % (self.distance (),
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
308 def add_file_compare (self, f1, f2):
311 def note_system_index (m):
312 system_index.append (int (m.group (1)))
315 base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
316 base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
318 self.base_names = (os.path.normpath (base1),
319 os.path.normpath (base2))
321 def note_original (match):
322 self.original_name = match.group (1)
325 if not self.original_name:
326 self.original_name = os.path.split (base1)[1]
328 ## ugh: drop the .ly.txt
329 for ext in ('.ly', '.ly.txt'):
331 re.sub (r'\\sourcefilename "([^"]+)"',
332 note_original, open (base1 + ext).read ())
336 s1 = read_signature_file (f1)
337 s2 = read_signature_file (f2)
339 link = SystemLink (s1, s2)
341 self.add_system_link (link, system_index[0])
343 def link_files_for_html (self, old_dir, new_dir, dest_dir):
344 for ext in ('.png', '.ly', '-page*png'):
346 for f in glob.glob (self.base_names[oldnew] + ext):
348 link_file (f, dest_dir + '/' + f)
350 def html_record_string (self, old_dir, new_dir):
351 def img_cell (ly, img, name):
355 name = '<tt>%s</tt>' % name
360 <img src="%(img)s" style="border-style: none; max-width: 500px;">
362 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
367 def multi_img_cell (ly, imgs, name):
371 name = '<tt>%s</tt>' % name
373 imgs_str = '\n'.join (['''<a href="%s">
374 <img src="%s" style="border-style: none; max-width: 500px;">
375 </a><br>''' % (img, img)
382 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
389 def cell (base, name):
390 pages = glob.glob (base + '-page*.png')
392 return multi_img_cell (base + '.ly', pages, name)
394 return img_cell (base + '.ly', base + '.png', name)
397 img_1 = self.base_names[0] + '.png'
398 ly_1 = self.base_names[0] + '.ly'
399 img_2 = self.base_names[1] + '.png'
400 ly_2 = self.base_names[1] + '.ly'
401 html_2 = self.base_names[1] + '.html'
402 name = self.original_name
408 (<a href="%s">details</a>)
414 ''' % (self.distance (), html_2,
415 cell (self.base_names[0], name),
416 cell (self.base_names[1], name))
421 def html_system_details_string (self):
422 systems = self.system_links.items ()
426 for (c, link) in systems:
427 e = '<td>%d</td>' % c
428 for d in link.distance ():
429 e += '<td>%f</td>' % d
431 e = '<tr>%s</tr>' % e
435 e = '<td>%d</td>' % c
436 for s in (link.output_expression_details_string (),
437 link.orphan_details_string (),
438 link.geo_details_string ()):
439 e += "<td>%s</td>" % s
442 e = '<tr>%s</tr>' % e
445 original = self.original_name
448 <title>comparison details for %(original)s</title>
467 def write_html_system_details (self, dir1, dir2, dest_dir):
468 dest_file = os.path.join (dest_dir, self.base_names[1] + '.html')
470 details = open_write_file (dest_file)
471 details.write (self.html_system_details_string ())
473 ################################################################
481 def compare_signature_files (f1, f2):
482 s1 = read_signature_file (f1)
483 s2 = read_signature_file (f2)
485 return SystemLink (s1, s2).distance ()
487 def paired_files (dir1, dir2, pattern):
489 Search DIR1 and DIR2 for PATTERN.
491 Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
495 files1 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir1 + '/' + pattern))
496 files2 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir2 + '/' + pattern))
500 for f in files1.keys ():
507 return (pairs, files2.keys (), missing)
509 class ComparisonData:
511 self.result_dict = {}
516 def compare_trees (self, dir1, dir2):
517 self.compare_directories (dir1, dir2)
519 (root, dirs, files) = os.walk (dir1).next ()
521 d1 = os.path.join (dir1, d)
522 d2 = os.path.join (dir2, d)
524 if os.path.islink (d1) or os.path.islink (d2):
527 if os.path.isdir (d2):
528 self.compare_trees (d1, d2)
530 def compare_directories (self, dir1, dir2):
532 (paired, m1, m2) = paired_files (dir1, dir2, '*.signature')
534 self.missing += [(dir1, m) for m in m1]
535 self.added += [(dir2, m) for m in m2]
538 if (inspect_max_count
539 and len (self.file_links) > inspect_max_count):
545 self.compare_files (f1, f2)
547 def compare_files (self, f1, f2):
548 name = os.path.split (f1)[1]
549 name = re.sub ('-[0-9]+.signature', '', name)
553 file_link = self.file_links[name]
555 file_link = FileLink ()
556 self.file_links[name] = file_link
558 file_link.add_file_compare (f1,f2)
560 def write_text_result_page (self, filename, threshold):
561 print 'writing "%s"' % filename
566 out = open_write_file (filename)
568 ## todo: support more scores.
569 results = [(link.distance(), link)
570 for link in self.file_links.values ()]
575 for (score, link) in results:
576 if score > threshold:
577 out.write (link.text_record_string ())
580 out.write ('%d below threshold\n' % len ([1 for s,l in results
581 if threshold >= s > 0.0]))
582 out.write ('%d unchanged\n' % len ([1 for (s,l) in results if s == 0.0]))
584 def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
585 self.write_text_result_page (dest_dir + '/index.txt', threshold)
587 def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
588 dir1 = dir1.replace ('//', '/')
589 dir2 = dir2.replace ('//', '/')
591 results = [(link.distance(), link)
592 for link in self.file_links.values ()]
597 old_prefix = os.path.split (dir1)[1]
598 for (score, link) in results:
599 if score <= threshold:
602 link.link_files_for_html (dir1, dir2, dest_dir)
603 link.write_html_system_details (dir1, dir2, dest_dir)
604 html += link.html_record_string (dir1, dir2)
608 <table rules="rows" border bordercolor="blue">
616 </html>''' % locals()
619 below_count =len ([1 for s,l in results
620 if threshold >= s > 0.0])
623 html += ('<p>%d below threshold</p>' % below_count)
625 html += ('<p>%d unchanged</p>'
626 % len ([1 for (s,l) in results if s == 0.0]))
629 dest_file = dest_dir + '/index.html'
630 open_write_file (dest_file).write (html)
632 def print_results (self, threshold):
633 self.write_text_result_page ('', threshold)
635 def compare_trees (dir1, dir2, dest_dir, threshold):
636 data = ComparisonData ()
637 data.compare_trees (dir1, dir2)
638 data.print_results (threshold)
640 if os.path.isdir (dest_dir):
641 system ('rm -rf %s '% dest_dir)
643 data.create_html_result_page (dir1, dir2, dest_dir, threshold)
644 data.create_text_result_page (dir1, dir2, dest_dir, threshold)
646 ################################################################
650 if not os.path.isdir (x):
654 def link_file (x, y):
655 mkdir (os.path.split (y)[0])
659 print 'OSError', x, y, z
662 def open_write_file (x):
663 d = os.path.split (x)[0]
675 def test_paired_files ():
676 print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
677 os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
680 def test_compare_trees ():
681 system ('rm -rf dir1 dir2')
682 system ('mkdir dir1 dir2')
683 system ('cp 20{-*.signature,.ly,.png} dir1')
684 system ('cp 20{-*.signature,.ly,.png} dir2')
685 system ('cp 20expr{-*.signature,.ly,.png} dir1')
686 system ('cp 19{-*.signature,.ly,.png} dir2/')
687 system ('cp 19{-*.signature,.ly,.png} dir1/')
688 system ('cp 19-1.signature 19-sub-1.signature')
689 system ('cp 19.ly 19-sub.ly')
690 system ('cp 19.png 19-sub.png')
692 system ('cp 20multipage* dir1')
693 system ('cp 20multipage* dir2')
694 system ('cp 19multipage-1.signature dir2/20multipage-1.signature')
697 system ('mkdir -p dir1/subdir/ dir2/subdir/')
698 system ('cp 19-sub{-*.signature,.ly,.png} dir1/subdir/')
699 system ('cp 19-sub{-*.signature,.ly,.png} dir2/subdir/')
700 system ('cp 20grob{-*.signature,.ly,.png} dir2/')
701 system ('cp 20grob{-*.signature,.ly,.png} dir1/')
703 ## introduce differences
704 system ('cp 19-1.signature dir2/20-1.signature')
705 system ('cp 20-1.signature dir2/subdir/19-sub-1.signature')
708 system ('cp 19-1.signature dir2/20grob-1.signature')
709 system ('cp 19-1.signature dir2/20grob-2.signature')
711 compare_trees ('dir1', 'dir2', 'compare-dir1dir2', 0.5)
714 def test_basic_compare ():
716 #(set! toplevel-score-handler print-score-with-defaults)
717 #(set! toplevel-music-handler
719 (if (not (eq? (ly:music-property m 'void) #t))
720 (print-score-with-defaults
721 p (scorify-music m p)))))
723 \sourcefilename "my-source.ly"
726 \header { tagline = ##f }
728 \new Staff \relative c {
729 c4^"%(userstring)s" %(extragrob)s
731 \new Staff \relative c {
732 c4^"%(userstring)s" %(extragrob)s
737 dicts = [{ 'papermod' : '',
740 'userstring': 'test' },
741 { 'papermod' : '#(set-global-staff-size 19.5)',
744 'userstring': 'test' },
748 'userstring': 'blabla' },
751 'extragrob': 'r2. \\break c1',
752 'userstring': 'test' },
757 open (d['name'] + '.ly','w').write (ly_template % d)
759 names = [d['name'] for d in dicts]
761 system ('lilypond -ddump-signatures --png -b eps ' + ' '.join (names))
765 #(set-default-paper-size "a6")
769 open ('20multipage', 'w').write (multipage_str)
770 open ('19multipage', 'w').write ('#(set-global-staff-size 19.5)\n' + multipage_str)
771 system ('lilypond -ddump-signatures --png 19multipage 20multipage ')
773 test_compare_signatures (names)
775 def test_compare_signatures (names, timing=False):
786 for t in range (0, times):
787 sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
791 print 'elapsed', (time.clock() - t0)/count
797 for (n1, s1) in sigs.items():
798 for (n2, s2) in sigs.items():
799 combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
803 print 'elapsed', (time.clock() - t0)/count
805 results = combinations.items ()
810 assert combinations['20-20'] == (0.0,0.0,0.0)
811 assert combinations['20-20expr'][0] > 0.0
812 assert combinations['20-19'][2] < 10.0
813 assert combinations['20-19'][2] > 0.0
817 dir = 'output-distance-test'
819 do_clean = not os.path.exists (dir)
821 print 'test results in ', dir
823 system ('rm -rf ' + dir)
824 system ('mkdir ' + dir)
828 test_basic_compare ()
830 test_compare_trees ()
832 ################################################################
836 p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
837 p.usage = 'output-distance.py [options] tree1 tree2'
839 p.add_option ('', '--test-self',
842 help='run test method')
844 p.add_option ('--max-count',
850 help='only analyze COUNT signature pairs')
852 p.add_option ('', '--threshold',
857 help='threshold for geometric distance')
859 (o,a) = p.parse_args ()
869 global inspect_max_count
870 inspect_max_count = o.max_count
872 compare_trees (a[0], a[1], os.path.join (a[1], 'compare-' + a[0]),
875 if __name__ == '__main__':