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