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 shorten_string (s):
  23     threshold = 15
  24     if len (s) > 2*threshold:
  25         s = s[:threshold] + '..' + s[-threshold:]
  26     return s
  27
  28 def max_distance (x1, x2):
  29     dist = 0.0
  30
  31     for (p,q) in zip (x1, x2):
  32         dist = max (abs (p-q), dist)
  33
  34     return dist
  35
  36
  37 empty_interval = (INFTY, -INFTY)
  38 empty_bbox = (empty_interval, empty_interval)
  39
  40 def interval_is_empty (i):
  41     return i[0] > i[1]
  42
  43 def interval_length (i):
  44     return max (i[1]-i[0], 0)
  45
  46 def interval_union (i1, i2):
  47     return (min (i1[0], i2[0]),
  48             max (i1[1], i2[1]))
  49
  50 def interval_intersect (i1, i2):
  51     return (max (i1[0], i2[0]),
  52             min (i1[1], i2[1]))
  53
  54 def bbox_is_empty (b):
  55     return (interval_is_empty (b[0])
  56             or interval_is_empty (b[1]))
  57
  58 def bbox_union (b1, b2):
  59     return (interval_union (b1[X_AXIS], b2[X_AXIS]),
  60             interval_union (b2[Y_AXIS], b2[Y_AXIS]))
  61
  62 def bbox_intersection (b1, b2):
  63     return (interval_intersect (b1[X_AXIS], b2[X_AXIS]),
  64             interval_intersect (b2[Y_AXIS], b2[Y_AXIS]))
  65
  66 def bbox_area (b):
  67     return interval_length (b[X_AXIS]) * interval_length (b[Y_AXIS])
  68
  69 def bbox_diameter (b):
  70     return max (interval_length (b[X_AXIS]),
  71                 interval_length (b[Y_AXIS]))
  72
  73
  74 def difference_area (a, b):
  75     return bbox_area (a) - bbox_area (bbox_intersection (a,b))
  76
  77 class GrobSignature:
  78     def __init__ (self, exp_list):
  79         (self.name, self.origin, bbox_x,
  80          bbox_y, self.output_expression) = tuple (exp_list)
  81
  82         self.bbox = (bbox_x, bbox_y)
  83         self.centroid = (bbox_x[0] + bbox_x[1], bbox_y[0] + bbox_y[1])
  84
  85     def __repr__ (self):
  86         return '%s: (%.2f,%.2f), (%.2f,%.2f)\n' % (self.name,
  87                                                    self.bbox[0][0],
  88                                                    self.bbox[0][1],
  89                                                    self.bbox[1][0],
  90                                                    self.bbox[1][1])
  91
  92     def axis_centroid (self, axis):
  93         return apply (sum, self.bbox[axis])  / 2
  94
  95     def centroid_distance (self, other, scale):
  96         return max_distance (self.centroid, other.centroid) / scale
  97
  98     def bbox_distance (self, other):
  99         divisor = bbox_area (self.bbox) + bbox_area (other.bbox)
 100
 101         if divisor:
 102             return (difference_area (self.bbox, other.bbox) +
 103                     difference_area (other.bbox, self.bbox)) / divisor
 104         else:
 105             return 0.0
 106
 107     def expression_distance (self, other):
 108         if self.output_expression == other.output_expression:
 109             return 0
 110         else:
 111             return 1
 112
 113 ################################################################
 114 # single System.
 115
 116 class SystemSignature:
 117     def __init__ (self, grob_sigs):
 118         d = {}
 119         for g in grob_sigs:
 120             val = d.setdefault (g.name, [])
 121             val += [g]
 122
 123         self.grob_dict = d
 124         self.set_all_bbox (grob_sigs)
 125
 126     def set_all_bbox (self, grobs):
 127         self.bbox = empty_bbox
 128         for g in grobs:
 129             self.bbox = bbox_union (g.bbox, self.bbox)
 130
 131     def closest (self, grob_name, centroid):
 132         min_d = INFTY
 133         min_g = None
 134         try:
 135             grobs = self.grob_dict[grob_name]
 136
 137             for g in grobs:
 138                 d = max_distance (g.centroid, centroid)
 139                 if d < min_d:
 140                     min_d = d
 141                     min_g = g
 142
 143
 144             return min_g
 145
 146         except KeyError:
 147             return None
 148     def grobs (self):
 149         return reduce (lambda x,y: x+y, self.grob_dict.values(), [])
 150
 151 ################################################################
 152 ## comparison of systems.
 153
 154 class SystemLink:
 155     def __init__ (self, system1, system2):
 156         self.system1 = system1
 157         self.system2 = system2
 158
 159         self.link_list_dict = {}
 160         self.back_link_dict = {}
 161
 162
 163         ## pairs
 164         self.orphans = []
 165
 166         ## pair -> distance
 167         self.geo_distances = {}
 168
 169         ## pairs
 170         self.expression_changed = []
 171
 172         self._geometric_distance = None
 173         self._expression_change_count = None
 174         self._orphan_count = None
 175
 176         for g in system1.grobs ():
 177
 178             ## skip empty bboxes.
 179             if bbox_is_empty (g.bbox):
 180                 continue
 181
 182             closest = system2.closest (g.name, g.centroid)
 183
 184             self.link_list_dict.setdefault (closest, [])
 185             self.link_list_dict[closest].append (g)
 186             self.back_link_dict[g] = closest
 187
 188
 189     def calc_geometric_distance (self):
 190         total = 0.0
 191         for (g1,g2) in self.back_link_dict.items ():
 192             if g2:
 193                 d = g1.bbox_distance (g2)
 194                 if d:
 195                     self.geo_distances[(g1,g2)] = d
 196
 197                 total += d
 198
 199         self._geometric_distance = total
 200
 201     def calc_orphan_count (self):
 202         count = 0
 203         for (g1, g2) in self.back_link_dict.items ():
 204             if g2 == None:
 205                 self.orphans.append ((g1, None))
 206
 207                 count += 1
 208
 209         self._orphan_count = count
 210
 211     def calc_output_exp_distance (self):
 212         d = 0
 213         for (g1,g2) in self.back_link_dict.items ():
 214             if g2:
 215                 d += g1.expression_distance (g2)
 216
 217         self._expression_change_count = d
 218
 219     def output_expression_details_string (self):
 220         return ', '.join ([g1.name for g1 in self.expression_changed])
 221
 222     def geo_details_string (self):
 223         results = [(d, g1,g2) for ((g1, g2), d) in self.geo_distances.items()]
 224         results.sort ()
 225         results.reverse ()
 226
 227         return ', '.join (['%s: %f' % (g1.name, d) for (d, g1, g2) in results])
 228
 229     def orphan_details_string (self):
 230         return ', '.join (['%s-None' % g1.name for (g1,g2) in self.orphans if g2==None])
 231
 232     def geometric_distance (self):
 233         if self._geometric_distance == None:
 234             self.calc_geometric_distance ()
 235         return self._geometric_distance
 236
 237     def orphan_count (self):
 238         if self._orphan_count == None:
 239             self.calc_orphan_count ()
 240
 241         return self._orphan_count
 242
 243     def output_expression_change_count (self):
 244         if self._expression_change_count == None:
 245             self.calc_output_exp_distance ()
 246         return self._expression_change_count
 247
 248     def distance (self):
 249         return (self.output_expression_change_count (),
 250                 self.orphan_count (),
 251                 self.geometric_distance ())
 252
 253 def read_signature_file (name):
 254     print 'reading', name
 255
 256     entries = open (name).read ().split ('\n')
 257     def string_to_tup (s):
 258         return tuple (map (float, s.split (' ')))
 259
 260     def string_to_entry (s):
 261         fields = s.split('@')
 262         fields[2] = string_to_tup (fields[2])
 263         fields[3] = string_to_tup (fields[3])
 264
 265         return tuple (fields)
 266
 267     entries = [string_to_entry (e) for e in entries
 268                if e and not e.startswith ('#')]
 269
 270     grob_sigs = [GrobSignature (e) for e in entries]
 271     sig = SystemSignature (grob_sigs)
 272     return sig
 273
 274
 275 ################################################################
 276 # different systems of a .ly file.
 277 def read_pipe (c):
 278     print 'pipe' , c
 279     return os.popen (c).read ()
 280
 281 def system (c):
 282     print 'system' , c
 283     s = os.system (c)
 284     if s :
 285         raise Exception ("failed")
 286     return
 287
 288 def compare_png_images (old, new, dir):
 289     def png_dims (f):
 290         m = re.search ('([0-9]+) x ([0-9]+)', read_pipe ('file %s' % f))
 291
 292         return tuple (map (int, m.groups ()))
 293
 294     dest = os.path.join (dir, new.replace ('.png', '.compare.jpeg'))
 295     try:
 296         dims1 = png_dims (old)
 297         dims2 = png_dims (new)
 298     except AttributeError:
 299         ## hmmm. what to do?
 300         system ('touch %(dest)s' % locals ())
 301         return
 302
 303     dims = (min (dims1[0], dims2[0]),
 304             min (dims1[1], dims2[1]))
 305
 306     system ('convert -depth 8 -crop %dx%d+0+0 %s crop1.png' % (dims + (old,)))
 307     system ('convert -depth 8 -crop %dx%d+0+0 %s crop2.png' % (dims + (new,)))
 308
 309     system ('compare -depth 8 crop1.png crop2.png diff.png')
 310
 311     system ("convert  -depth 8 diff.png -blur 0x3 -negate -channel alpha,blue -type TrueColorMatte -fx 'intensity'    matte.png")
 312
 313     system ("composite -quality 65 matte.png %(new)s %(dest)s" % locals ())
 314
 315 class FileLink:
 316     def text_record_string (self):
 317         return '%-30f %-20s\n' % (self.distance (),
 318                                   self.name ())
 319     def distance (self):
 320         return 0.0
 321
 322     def name (self):
 323         return ''
 324
 325     def link_files_for_html (self, old_dir, new_dir, dest_dir):
 326         pass
 327
 328     def write_html_system_details (self, dir1, dir2, dest_dir):
 329         pass
 330
 331     def html_record_string (self,  old_dir, new_dir):
 332         return ''
 333
 334 class MidiFileLink (FileLink):
 335     def __init__ (self, f1, f2):
 336         self.files = (f1, f2)
 337
 338         print 'reading', f1
 339         s1 = open (self.files[0]).read ()
 340         print 'reading', f2
 341         s2 = open (self.files[1]).read ()
 342
 343         self.same = (s1 == s2)
 344
 345     def name (self):
 346         name = os.path.split (self.files[0])[1]
 347         name = re.sub ('.midi', '', name)
 348         return name
 349
 350     def distance (self):
 351         ## todo: could use import MIDI to pinpoint
 352         ## what & where changed.
 353         if self.same:
 354             return 0
 355         else:
 356             return 100;
 357     def html_record_string (self, d1, d2):
 358         return '''<tr>
 359 <td>
 360 %f
 361 </td>
 362 <td><tt>%s</tt></td>
 363 <td><tt>%s</tt></td>
 364 </tr>''' % ((self.distance(),) + self.files)
 365
 366 class SignatureFileLink (FileLink):
 367     def __init__ (self):
 368         self.original_name = ''
 369         self.base_names = ('','')
 370         self.system_links = {}
 371         self._distance = None
 372     def name (self):
 373         return self.original_name
 374
 375     def add_system_link (self, link, number):
 376         self.system_links[number] = link
 377
 378     def calc_distance (self):
 379         d = 0.0
 380
 381         orphan_distance = 0.0
 382         for l in self.system_links.values ():
 383             d = max (d, l.geometric_distance ())
 384             orphan_distance += l.orphan_count ()
 385
 386         return d + orphan_distance
 387
 388     def distance (self):
 389         if type (self._distance) != type (0.0):
 390             return self.calc_distance ()
 391
 392         return self._distance
 393
 394     def source_file (self):
 395         for ext in ('.ly', '.ly.txt'):
 396             if os.path.exists (self.base_names[1] + ext):
 397                 return self.base_names[1] + ext
 398         return ''
 399
 400     def add_file_compare (self, f1, f2):
 401         system_index = []
 402
 403         def note_system_index (m):
 404             system_index.append (int (m.group (1)))
 405             return ''
 406
 407         base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
 408         base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
 409
 410         self.base_names = (os.path.normpath (base1),
 411                            os.path.normpath (base2))
 412
 413         def note_original (match):
 414             self.original_name = match.group (1)
 415             return ''
 416
 417         if not self.original_name:
 418             self.original_name = os.path.split (base1)[1]
 419
 420             ## ugh: drop the .ly.txt
 421             for ext in ('.ly', '.ly.txt'):
 422                 try:
 423                     re.sub (r'\\sourcefilename "([^"]+)"',
 424                             note_original, open (base1 + ext).read ())
 425                 except IOError:
 426                     pass
 427
 428         s1 = read_signature_file (f1)
 429         s2 = read_signature_file (f2)
 430
 431         link = SystemLink (s1, s2)
 432
 433         self.add_system_link (link, system_index[0])
 434
 435     def link_files_for_html (self, old_dir, new_dir, dest_dir):
 436         png_linked = [[], []]
 437         for ext in ('.png', '.ly', '-page*png'):
 438
 439             for oldnew in (0,1):
 440                 for f in glob.glob (self.base_names[oldnew] + ext):
 441                     dst = dest_dir + '/' + f
 442                     link_file (f, dst)
 443
 444                     if f.endswith ('.png'):
 445                         png_linked[oldnew].append (f)
 446
 447         for (old,new) in zip (png_linked[0], png_linked[1]):
 448             compare_png_images (old, new, dest_dir)
 449
 450     def html_record_string (self,  old_dir, new_dir):
 451         def img_cell (ly, img, name):
 452             if not name:
 453                 name = 'source'
 454             else:
 455                 name = '<tt>%s</tt>' % name
 456
 457             return '''
 458 <td align="center">
 459 <a href="%(img)s">
 460 <img src="%(img)s" style="border-style: none; max-width: 500px;">
 461 </a><br>
 462 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
 463 </font>
 464 </td>
 465 ''' % locals ()
 466
 467         def multi_img_cell (ly, imgs, name):
 468             if not name:
 469                 name = 'source'
 470             else:
 471                 name = '<tt>%s</tt>' % name
 472
 473             imgs_str = '\n'.join (['''<a href="%s">
 474 <img src="%s" style="border-style: none; max-width: 500px;">
 475 </a><br>''' % (img, img)
 476                                   for img in imgs])
 477
 478
 479             return '''
 480 <td align="center">
 481 %(imgs_str)s
 482 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
 483 </font>
 484 </td>
 485 ''' % locals ()
 486
 487
 488
 489         def cell (base, name):
 490             pat = base + '-page*.png'
 491             pages = glob.glob (pat)
 492
 493             if pages:
 494                 return multi_img_cell (base + '.ly', sorted (pages), name)
 495             else:
 496                 return img_cell (base + '.ly', base + '.png', name)
 497
 498
 499         html_2  = self.base_names[1] + '.html'
 500         name = self.original_name
 501
 502         html_entry = '''
 503 <tr>
 504 <td>
 505 %f<br>
 506 (<a href="%s">details</a>)
 507 </td>
 508
 509 %s
 510 %s
 511 </tr>
 512 ''' % (self.distance (), html_2,
 513        cell (self.base_names[0], name),
 514        cell (self.base_names[1], name).replace ('.png', '.compare.jpeg'))
 515
 516         return html_entry
 517
 518
 519     def html_system_details_string (self):
 520         systems = self.system_links.items ()
 521         systems.sort ()
 522
 523         html = ""
 524         for (c, link) in systems:
 525             e = '<td>%d</td>' % c
 526             for d in link.distance ():
 527                 e += '<td>%f</td>' % d
 528
 529             e = '<tr>%s</tr>' % e
 530
 531             html += e
 532
 533             e = '<td>%d</td>' % c
 534             for s in (link.output_expression_details_string (),
 535                       link.orphan_details_string (),
 536                       link.geo_details_string ()):
 537                 e += "<td>%s</td>" % s
 538
 539
 540             e = '<tr>%s</tr>' % e
 541             html += e
 542
 543         original = self.original_name
 544         html = '''<html>
 545 <head>
 546 <title>comparison details for %(original)s</title>
 547 </head>
 548 <body>
 549 <table border=1>
 550 <tr>
 551 <th>system</th>
 552 <th>output</th>
 553 <th>orphan</th>
 554 <th>geo</th>
 555 </tr>
 556
 557 %(html)s
 558 </table>
 559
 560 </body>
 561 </html>
 562 ''' % locals ()
 563         return html
 564
 565     def write_html_system_details (self, dir1, dir2, dest_dir):
 566         dest_file =  os.path.join (dest_dir, self.base_names[1] + '.html')
 567
 568         details = open_write_file (dest_file)
 569         details.write (self.html_system_details_string ())
 570
 571 ################################################################
 572 # Files/directories
 573
 574 import glob
 575 import re
 576
 577
 578
 579 def compare_signature_files (f1, f2):
 580     s1 = read_signature_file (f1)
 581     s2 = read_signature_file (f2)
 582
 583     return SystemLink (s1, s2).distance ()
 584
 585 def paired_files (dir1, dir2, pattern):
 586     """
 587     Search DIR1 and DIR2 for PATTERN.
 588
 589     Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
 590
 591     """
 592
 593     files1 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir1 + '/' + pattern))
 594     files2 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir2 + '/' + pattern))
 595
 596     pairs = []
 597     missing = []
 598     for f in files1.keys ():
 599         try:
 600             files2.pop (f)
 601             pairs.append (f)
 602         except KeyError:
 603             missing.append (f)
 604
 605     return (pairs, files2.keys (), missing)
 606
 607 class ComparisonData:
 608     def __init__ (self):
 609         self.result_dict = {}
 610         self.missing = []
 611         self.added = []
 612         self.file_links = {}
 613
 614     def compare_trees (self, dir1, dir2):
 615         self.compare_directories (dir1, dir2)
 616
 617         (root, dirs, files) = os.walk (dir1).next ()
 618         for d in dirs:
 619             d1 = os.path.join (dir1, d)
 620             d2 = os.path.join (dir2, d)
 621
 622             if os.path.islink (d1) or os.path.islink (d2):
 623                 continue
 624
 625             if os.path.isdir (d2):
 626                 self.compare_trees (d1, d2)
 627
 628     def compare_directories (self, dir1, dir2):
 629         for ext in ['signature', 'midi']:
 630             (paired, m1, m2) = paired_files (dir1, dir2, '*.' + ext)
 631
 632             self.missing += [(dir1, m) for m in m1]
 633             self.added += [(dir2, m) for m in m2]
 634
 635             for p in paired:
 636                 if (inspect_max_count
 637                     and len (self.file_links) > inspect_max_count):
 638
 639                     continue
 640
 641                 f2 = dir2 +  '/' + p
 642                 f1 = dir1 +  '/' + p
 643                 self.compare_files (f1, f2)
 644
 645     def compare_files (self, f1, f2):
 646         if f1.endswith ('signature'):
 647             self.compare_signature_files (f1, f2)
 648         elif f1.endswith ('midi'):
 649             self.compare_midi_files (f1, f2)
 650
 651     def compare_midi_files (self, f1, f2):
 652         name = os.path.split (f1)[1]
 653
 654         file_link = MidiFileLink (f1, f2)
 655         self.file_links[name] = file_link
 656
 657     def compare_signature_files (self, f1, f2):
 658         name = os.path.split (f1)[1]
 659         name = re.sub ('-[0-9]+.signature', '', name)
 660
 661         file_link = None
 662         try:
 663             file_link = self.file_links[name]
 664         except KeyError:
 665             file_link = SignatureFileLink ()
 666             self.file_links[name] = file_link
 667
 668         file_link.add_file_compare (f1, f2)
 669
 670     def write_text_result_page (self, filename, threshold):
 671         out = None
 672         if filename == '':
 673             out = sys.stdout
 674         else:
 675             print 'writing "%s"' % filename
 676             out = open_write_file (filename)
 677
 678         ## todo: support more scores.
 679         results = [(link.distance(), link)
 680                    for link in self.file_links.values ()]
 681         results.sort ()
 682         results.reverse ()
 683
 684
 685         for (score, link) in results:
 686             if score > threshold:
 687                 out.write (link.text_record_string ())
 688
 689         out.write ('\n\n')
 690         out.write ('%d below threshold\n' % len ([1 for s,l  in results
 691                                                     if threshold >=  s > 0.0]))
 692         out.write ('%d unchanged\n' % len ([1 for (s,l) in results if s == 0.0]))
 693
 694     def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
 695         self.write_text_result_page (dest_dir + '/index.txt', threshold)
 696
 697     def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
 698         dir1 = dir1.replace ('//', '/')
 699         dir2 = dir2.replace ('//', '/')
 700
 701         results = [(link.distance(), link)
 702                    for link in self.file_links.values ()]
 703         results.sort ()
 704         results.reverse ()
 705
 706         html = ''
 707         old_prefix = os.path.split (dir1)[1]
 708         for (score, link) in results:
 709             if score <= threshold:
 710                 continue
 711
 712             link.link_files_for_html (dir1, dir2, dest_dir)
 713             link.write_html_system_details (dir1, dir2, dest_dir)
 714
 715             html += link.html_record_string (dir1, dir2)
 716
 717
 718         short_dir1 = shorten_string (dir1)
 719         short_dir2 = shorten_string (dir2)
 720         html = '''<html>
 721 <table rules="rows" border bordercolor="blue">
 722 <tr>
 723 <th>distance</th>
 724 <th>%(short_dir1)s</th>
 725 <th>%(short_dir2)s</th>
 726 </tr>
 727 %(html)s
 728 </table>
 729 </html>''' % locals()
 730
 731         html += ('<p>')
 732         below_count  =len ([1 for s,l  in results
 733                             if threshold >=  s > 0.0])
 734
 735         if below_count:
 736             html += ('<p>%d below threshold</p>' % below_count)
 737
 738         html += ('<p>%d unchanged</p>'
 739                  % len ([1 for (s,l) in results if s == 0.0]))
 740
 741
 742         dest_file = dest_dir + '/index.html'
 743         open_write_file (dest_file).write (html)
 744
 745     def print_results (self, threshold):
 746         self.write_text_result_page ('', threshold)
 747
 748 def compare_trees (dir1, dir2, dest_dir, threshold):
 749     data = ComparisonData ()
 750     data.compare_trees (dir1, dir2)
 751     data.print_results (threshold)
 752
 753     if os.path.isdir (dest_dir):
 754         system ('rm -rf %s '% dest_dir)
 755
 756     data.create_html_result_page (dir1, dir2, dest_dir, threshold)
 757     data.create_text_result_page (dir1, dir2, dest_dir, threshold)
 758
 759 ################################################################
 760 # TESTING
 761
 762 def mkdir (x):
 763     if not os.path.isdir (x):
 764         print 'mkdir', x
 765         os.makedirs (x)
 766
 767 def link_file (x, y):
 768     mkdir (os.path.split (y)[0])
 769     try:
 770         os.link (x, y)
 771     except OSError, z:
 772         print 'OSError', x, y, z
 773         raise OSError
 774
 775 def open_write_file (x):
 776     d = os.path.split (x)[0]
 777     mkdir (d)
 778     return open (x, 'w')
 779
 780
 781 def system (x):
 782
 783     print 'invoking', x
 784     stat = os.system (x)
 785     assert stat == 0
 786
 787
 788 def test_paired_files ():
 789     print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
 790                         os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
 791
 792
 793 def test_compare_trees ():
 794     system ('rm -rf dir1 dir2')
 795     system ('mkdir dir1 dir2')
 796     system ('cp 20{-*.signature,.ly,.png} dir1')
 797     system ('cp 20{-*.signature,.ly,.png} dir2')
 798     system ('cp 20expr{-*.signature,.ly,.png} dir1')
 799     system ('cp 19{-*.signature,.ly,.png} dir2/')
 800     system ('cp 19{-*.signature,.ly,.png} dir1/')
 801     system ('cp 19-1.signature 19-sub-1.signature')
 802     system ('cp 19.ly 19-sub.ly')
 803     system ('cp 19.png 19-sub.png')
 804
 805     system ('cp 20multipage* dir1')
 806     system ('cp 20multipage* dir2')
 807     system ('cp 19multipage-1.signature dir2/20multipage-1.signature')
 808
 809
 810     system ('mkdir -p dir1/subdir/ dir2/subdir/')
 811     system ('cp 19-sub{-*.signature,.ly,.png} dir1/subdir/')
 812     system ('cp 19-sub{-*.signature,.ly,.png} dir2/subdir/')
 813     system ('cp 20grob{-*.signature,.ly,.png} dir2/')
 814     system ('cp 20grob{-*.signature,.ly,.png} dir1/')
 815
 816     ## introduce differences
 817     system ('cp 19-1.signature dir2/20-1.signature')
 818     system ('cp 19.png dir2/20.png')
 819     system ('cp 19multipage-page1.png dir2/20multipage-page1.png')
 820     system ('cp 20-1.signature dir2/subdir/19-sub-1.signature')
 821     system ('cp 20.png dir2/subdir/19-sub.png')
 822
 823     ## radical diffs.
 824     system ('cp 19-1.signature dir2/20grob-1.signature')
 825     system ('cp 19-1.signature dir2/20grob-2.signature')
 826     system ('cp 19multipage.midi dir1/midi-differ.midi')
 827     system ('cp 20multipage.midi dir2/midi-differ.midi')
 828
 829     compare_trees ('dir1', 'dir2', 'compare-dir1dir2', 0.5)
 830
 831
 832 def test_basic_compare ():
 833     ly_template = r"""
 834
 835 \version "2.10.0"
 836 #(set! toplevel-score-handler print-score-with-defaults)
 837  #(set! toplevel-music-handler
 838   (lambda (p m)
 839   (if (not (eq? (ly:music-property m 'void) #t))
 840      (print-score-with-defaults
 841      p (scorify-music m p)))))
 842
 843 \sourcefilename "my-source.ly"
 844
 845 %(papermod)s
 846 \header { tagline = ##f }
 847 \score {
 848 <<
 849 \new Staff \relative c {
 850   c4^"%(userstring)s" %(extragrob)s
 851   }
 852 \new Staff \relative c {
 853   c4^"%(userstring)s" %(extragrob)s
 854   }
 855 >>
 856 \layout{}
 857 }
 858
 859 """
 860
 861     dicts = [{ 'papermod' : '',
 862                'name' : '20',
 863                'extragrob': '',
 864                'userstring': 'test' },
 865              { 'papermod' : '#(set-global-staff-size 19.5)',
 866                'name' : '19',
 867                'extragrob': '',
 868                'userstring': 'test' },
 869              { 'papermod' : '',
 870                'name' : '20expr',
 871                'extragrob': '',
 872                'userstring': 'blabla' },
 873              { 'papermod' : '',
 874                'name' : '20grob',
 875                'extragrob': 'r2. \\break c1',
 876                'userstring': 'test' },
 877              ]
 878
 879     for d in dicts:
 880         open (d['name'] + '.ly','w').write (ly_template % d)
 881
 882     names = [d['name'] for d in dicts]
 883
 884     system ('lilypond -ddump-signatures --png -b eps ' + ' '.join (names))
 885
 886
 887     multipage_str = r'''
 888     #(set-default-paper-size "a6")
 889     \score {
 890       \relative {c1 \pageBreak c1 }
 891       \layout {}
 892       \midi {}
 893     }
 894     '''
 895
 896     open ('20multipage', 'w').write (multipage_str.replace ('c1', 'd1'))
 897     open ('19multipage', 'w').write ('#(set-global-staff-size 19.5)\n' + multipage_str)
 898     system ('lilypond -ddump-signatures --png 19multipage 20multipage ')
 899
 900     test_compare_signatures (names)
 901
 902 def test_compare_signatures (names, timing=False):
 903
 904     import time
 905
 906     times = 1
 907     if timing:
 908         times = 100
 909
 910     t0 = time.clock ()
 911
 912     count = 0
 913     for t in range (0, times):
 914         sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
 915         count += 1
 916
 917     if timing:
 918         print 'elapsed', (time.clock() - t0)/count
 919
 920
 921     t0 = time.clock ()
 922     count = 0
 923     combinations = {}
 924     for (n1, s1) in sigs.items():
 925         for (n2, s2) in sigs.items():
 926             combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
 927             count += 1
 928
 929     if timing:
 930         print 'elapsed', (time.clock() - t0)/count
 931
 932     results = combinations.items ()
 933     results.sort ()
 934     for k,v in results:
 935         print '%-20s' % k, v
 936
 937     assert combinations['20-20'] == (0.0,0.0,0.0)
 938     assert combinations['20-20expr'][0] > 0.0
 939     assert combinations['20-19'][2] < 10.0
 940     assert combinations['20-19'][2] > 0.0
 941
 942
 943 def run_tests ():
 944     dir = 'test-output-distance'
 945
 946     do_clean = not os.path.exists (dir)
 947
 948     print 'test results in ', dir
 949     if do_clean:
 950         system ('rm -rf ' + dir)
 951         system ('mkdir ' + dir)
 952
 953     os.chdir (dir)
 954     if do_clean:
 955         test_basic_compare ()
 956
 957     test_compare_trees ()
 958
 959 ################################################################
 960 #
 961
 962 def main ():
 963     p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
 964     p.usage = 'output-distance.py [options] tree1 tree2'
 965
 966     p.add_option ('', '--test-self',
 967                   dest="run_test",
 968                   action="store_true",
 969                   help='run test method')
 970
 971     p.add_option ('--max-count',
 972                   dest="max_count",
 973                   metavar="COUNT",
 974                   type="int",
 975                   default=0,
 976                   action="store",
 977                   help='only analyze COUNT signature pairs')
 978
 979     p.add_option ('', '--threshold',
 980                   dest="threshold",
 981                   default=0.3,
 982                   action="store",
 983                   type="float",
 984                   help='threshold for geometric distance')
 985
 986
 987     p.add_option ('-o', '--output-dir',
 988                   dest="output_dir",
 989                   default=None,
 990                   action="store",
 991                   type="string",
 992                   help='where to put the test results [tree2/compare-tree1tree2]')
 993
 994     (options, a) = p.parse_args ()
 995
 996     if options.run_test:
 997         run_tests ()
 998         sys.exit (0)
 999
1000     if len (a) != 2:
1001         p.print_usage()
1002         sys.exit (2)
1003
1004     global inspect_max_count
1005     inspect_max_count = options.max_count
1006
1007     name = options.output_dir
1008     if not name:
1009         name = a[0].replace ('/', '')
1010         name = os.path.join (a[1], 'compare-' + shorten_string (name))
1011
1012     compare_trees (a[0], a[1], name, options.threshold)
1013
1014 if __name__ == '__main__':
1015     main()
1016