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 options = None
  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 __init__ (self):
 317         self._distance = None
 318
 319     def text_record_string (self):
 320         return '%-30f %-20s\n' % (self.distance (),
 321                                   self.name ())
 322     def calc_distance (self):
 323         return 0.0
 324
 325     def distance (self):
 326         if self._distance == None:
 327            self._distance = self.calc_distance ()
 328
 329         return self._distance
 330
 331     def name (self):
 332         return ''
 333
 334     def link_files_for_html (self, old_dir, new_dir, dest_dir):
 335         pass
 336
 337     def write_html_system_details (self, dir1, dir2, dest_dir):
 338         pass
 339
 340     def html_record_string (self,  old_dir, new_dir):
 341         return ''
 342
 343 class FileCompareLink (FileLink):
 344     def __init__ (self, f1, f2):
 345         FileLink.__init__ (self)
 346         self.files = (f1, f2)
 347         self.contents = (self.get_content (self.files[0]),
 348                          self.get_content (self.files[1]))
 349
 350     def name (self):
 351         name = os.path.basename (self.files[0])
 352         name = os.path.splitext (name)[0]
 353         return name
 354
 355     def calc_distance (self):
 356         ## todo: could use import MIDI to pinpoint
 357         ## what & where changed.
 358
 359         if self.contents[0] == self.contents[1]:
 360             return 0.0
 361         else:
 362             return 100.0;
 363
 364     def html_record_string (self, d1, d2):
 365         (dist, f1, f2) = (self.distance(),) + self.files
 366
 367         return '''<tr>
 368 <td>
 369 %(dist)f
 370 </td>
 371 <td><a href="%(f1)s"><tt>%(f1)s</tt></td>
 372 <td><a href="%(f2)s"><tt>%(f2)s</tt></td>
 373 </tr>''' % locals ()
 374
 375     def get_content (self, f):
 376         print 'reading', f
 377         s = open (f).read ()
 378         return s
 379
 380 class ProfileFileLink (FileCompareLink):
 381     def calc_distance (self):
 382         r = [{},{}]
 383         for oldnew in (0,1):
 384             def note_info (m):
 385                 r[oldnew][m.group(1)] = float (m.group (2))
 386
 387             re.sub ('([a-z]+): ([-0-9.]+)\n',
 388                     note_info, self.contents[oldnew])
 389
 390         dist = 0.0
 391         for k in ('time', 'cells'):
 392             (v1,v2) = (r[0].get (k ,0),
 393                        r[1].get (k ,0))
 394             if v1 + v2 <= 0:
 395                 continue
 396
 397             ratio = v2 / float (v1+v2)
 398             if ratio < 0.25 or ratio > 0.75:
 399                 dist += 1
 400
 401         return dist
 402
 403
 404 class TextFileCompareLink (FileCompareLink):
 405     def calc_distance (self):
 406         import difflib
 407         diff = difflib.unified_diff (self.contents[0].split ('\n'),
 408                                      self.contents[1].split ('\n'),
 409                                      fromfiledate = self.files[0],
 410                                      tofiledate = self.files[1]
 411                                      )
 412
 413         self.diff_lines =  [l for l in diff]
 414         return float (len (self.diff_lines))
 415
 416     def link_files_for_html (self, old_dir, new_dir, dest_dir):
 417         str = '\n'.join ([d.replace ('\n','') for d in self.diff_lines])
 418         f = os.path.join (new_dir, self.name ()) + '.diff.txt'
 419         f = os.path.join (dest_dir, f)
 420         open_write_file (f).write (str)
 421
 422     def html_record_string (self, d1, d2):
 423         return '''<tr>
 424 <td>
 425 %f
 426 </td>
 427 <td><tt>%s</tt></td>
 428 <td><a href="%s.diff.txt"><tt>%s</tt></a></td>
 429 </tr>''' % (self.distance(),
 430             self.files[0],
 431             os.path.join (d2, self.name ()),
 432             self.files[1])
 433
 434 class MidiFileLink (FileCompareLink):
 435     def get_content (self, f):
 436         s = FileCompareLink.get_content (self, f)
 437         s = re.sub ('LilyPond [0-9.]+', '', s)
 438         return s
 439
 440 class SignatureFileLink (FileLink):
 441     def __init__ (self):
 442         FileLink.__init__ (self)
 443         self.original_name = ''
 444         self.base_names = ('','')
 445         self.system_links = {}
 446
 447     def name (self):
 448         return os.path.splitext (self.original_name)[0]
 449
 450     def add_system_link (self, link, number):
 451         self.system_links[number] = link
 452
 453     def calc_distance (self):
 454         d = 0.0
 455
 456         orphan_distance = 0.0
 457         for l in self.system_links.values ():
 458             d = max (d, l.geometric_distance ())
 459             orphan_distance += l.orphan_count ()
 460
 461         return d + orphan_distance
 462
 463     def source_file (self):
 464         for ext in ('.ly', '.ly.txt'):
 465             if os.path.exists (self.base_names[1] + ext):
 466                 return self.base_names[1] + ext
 467         return ''
 468
 469     def add_file_compare (self, f1, f2):
 470         system_index = []
 471
 472         def note_system_index (m):
 473             system_index.append (int (m.group (1)))
 474             return ''
 475
 476         base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
 477         base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
 478
 479         self.base_names = (os.path.normpath (base1),
 480                            os.path.normpath (base2))
 481
 482         def note_original (match):
 483             self.original_name = match.group (1)
 484             return ''
 485
 486         if not self.original_name:
 487             self.original_name = os.path.split (base1)[1]
 488
 489             ## ugh: drop the .ly.txt
 490             for ext in ('.ly', '.ly.txt'):
 491                 try:
 492                     re.sub (r'\\sourcefilename "([^"]+)"',
 493                             note_original, open (base1 + ext).read ())
 494                 except IOError:
 495                     pass
 496
 497         s1 = read_signature_file (f1)
 498         s2 = read_signature_file (f2)
 499
 500         link = SystemLink (s1, s2)
 501
 502         self.add_system_link (link, system_index[0])
 503
 504
 505     def create_images (self, old_dir, new_dir, dest_dir):
 506
 507         files_created = [[], []]
 508         for oldnew in (0, 1):
 509             pat = self.base_names[oldnew] + '.eps'
 510
 511             for f in glob.glob (pat):
 512                 infile = f
 513                 outfile = (dest_dir + '/' + f).replace ('.eps', '.png')
 514
 515                 mkdir (os.path.split (outfile)[0])
 516                 cmd = ('gs -sDEVICE=png16m -dGraphicsAlphaBits=4 -dTextAlphaBits=4 '
 517                        ' -r101 '
 518                        ' -sOutputFile=%(outfile)s -dNOSAFER -dEPSCrop -q -dNOPAUSE '
 519                        ' %(infile)s  -c quit '  % locals ())
 520
 521                 files_created[oldnew].append (outfile)
 522                 system (cmd)
 523
 524         return files_created
 525
 526     def link_files_for_html (self, old_dir, new_dir, dest_dir):
 527         to_compare = [[], []]
 528
 529         exts = ['.ly']
 530         if options.create_images:
 531             to_compare = self.create_images (old_dir, new_dir, dest_dir)
 532         else:
 533             exts += ['.png', '-page*png']
 534
 535         for ext in exts:
 536             for oldnew in (0,1):
 537                 for f in glob.glob (self.base_names[oldnew] + ext):
 538                     dst = dest_dir + '/' + f
 539                     link_file (f, dst)
 540
 541                     if f.endswith ('.png'):
 542                         to_compare[oldnew].append (f)
 543
 544         if options.compare_images:
 545             for (old, new) in zip (to_compare[0], to_compare[1]):
 546                 compare_png_images (old, new, dest_dir)
 547
 548
 549     def html_record_string (self,  old_dir, new_dir):
 550         def img_cell (ly, img, name):
 551             if not name:
 552                 name = 'source'
 553             else:
 554                 name = '<tt>%s</tt>' % name
 555
 556             return '''
 557 <td align="center">
 558 <a href="%(img)s">
 559 <img src="%(img)s" style="border-style: none; max-width: 500px;">
 560 </a><br>
 561 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
 562 </font>
 563 </td>
 564 ''' % locals ()
 565         def multi_img_cell (ly, imgs, name):
 566             if not name:
 567                 name = 'source'
 568             else:
 569                 name = '<tt>%s</tt>' % name
 570
 571             imgs_str = '\n'.join (['''<a href="%s">
 572 <img src="%s" style="border-style: none; max-width: 500px;">
 573 </a><br>''' % (img, img)
 574                                   for img in imgs])
 575
 576
 577             return '''
 578 <td align="center">
 579 %(imgs_str)s
 580 <font size="-2">(<a href="%(ly)s">%(name)s</a>)
 581 </font>
 582 </td>
 583 ''' % locals ()
 584
 585
 586
 587         def cell (base, name):
 588             pat = base + '-page*.png'
 589             pages = glob.glob (pat)
 590
 591             if pages:
 592                 return multi_img_cell (base + '.ly', sorted (pages), name)
 593             else:
 594                 return img_cell (base + '.ly', base + '.png', name)
 595
 596
 597         html_2  = self.base_names[1] + '.html'
 598         name = self.original_name
 599
 600         cell_1 = cell (self.base_names[0], name)
 601         cell_2 = cell (self.base_names[1], name)
 602         if options.compare_images:
 603             cell_2 = cell_2.replace ('.png', '.compare.jpeg')
 604
 605         html_entry = '''
 606 <tr>
 607 <td>
 608 %f<br>
 609 (<a href="%s">details</a>)
 610 </td>
 611
 612 %s
 613 %s
 614 </tr>
 615 ''' % (self.distance (), html_2, cell_1, cell_2)
 616
 617         return html_entry
 618
 619
 620     def html_system_details_string (self):
 621         systems = self.system_links.items ()
 622         systems.sort ()
 623
 624         html = ""
 625         for (c, link) in systems:
 626             e = '<td>%d</td>' % c
 627             for d in link.distance ():
 628                 e += '<td>%f</td>' % d
 629
 630             e = '<tr>%s</tr>' % e
 631
 632             html += e
 633
 634             e = '<td>%d</td>' % c
 635             for s in (link.output_expression_details_string (),
 636                       link.orphan_details_string (),
 637                       link.geo_details_string ()):
 638                 e += "<td>%s</td>" % s
 639
 640
 641             e = '<tr>%s</tr>' % e
 642             html += e
 643
 644         original = self.original_name
 645         html = '''<html>
 646 <head>
 647 <title>comparison details for %(original)s</title>
 648 </head>
 649 <body>
 650 <table border=1>
 651 <tr>
 652 <th>system</th>
 653 <th>output</th>
 654 <th>orphan</th>
 655 <th>geo</th>
 656 </tr>
 657
 658 %(html)s
 659 </table>
 660
 661 </body>
 662 </html>
 663 ''' % locals ()
 664         return html
 665
 666     def write_html_system_details (self, dir1, dir2, dest_dir):
 667         dest_file =  os.path.join (dest_dir, self.base_names[1] + '.html')
 668
 669         details = open_write_file (dest_file)
 670         details.write (self.html_system_details_string ())
 671
 672 ################################################################
 673 # Files/directories
 674
 675 import glob
 676 import re
 677
 678 def compare_signature_files (f1, f2):
 679     s1 = read_signature_file (f1)
 680     s2 = read_signature_file (f2)
 681
 682     return SystemLink (s1, s2).distance ()
 683
 684 def paired_files (dir1, dir2, pattern):
 685     """
 686     Search DIR1 and DIR2 for PATTERN.
 687
 688     Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
 689
 690     """
 691
 692     files1 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir1 + '/' + pattern))
 693     files2 = dict ((os.path.split (f)[1], 1) for f in glob.glob (dir2 + '/' + pattern))
 694
 695     pairs = []
 696     missing = []
 697     for f in files1.keys ():
 698         try:
 699             files2.pop (f)
 700             pairs.append (f)
 701         except KeyError:
 702             missing.append (f)
 703
 704     return (pairs, files2.keys (), missing)
 705
 706 class ComparisonData:
 707     def __init__ (self):
 708         self.result_dict = {}
 709         self.missing = []
 710         self.added = []
 711         self.file_links = {}
 712
 713     def compare_trees (self, dir1, dir2):
 714         self.compare_directories (dir1, dir2)
 715
 716         (root, dirs, files) = os.walk (dir1).next ()
 717         for d in dirs:
 718             d1 = os.path.join (dir1, d)
 719             d2 = os.path.join (dir2, d)
 720
 721             if os.path.islink (d1) or os.path.islink (d2):
 722                 continue
 723
 724             if os.path.isdir (d2):
 725                 self.compare_trees (d1, d2)
 726
 727     def compare_directories (self, dir1, dir2):
 728         for ext in ['signature', 'midi', 'log', 'profile']:
 729             (paired, m1, m2) = paired_files (dir1, dir2, '*.' + ext)
 730
 731             self.missing += [(dir1, m) for m in m1]
 732             self.added += [(dir2, m) for m in m2]
 733
 734             for p in paired:
 735                 if (options.max_count
 736                     and len (self.file_links) > options.max_count):
 737
 738                     continue
 739
 740                 f2 = dir2 +  '/' + p
 741                 f1 = dir1 +  '/' + p
 742                 self.compare_files (f1, f2)
 743
 744     def compare_files (self, f1, f2):
 745         if f1.endswith ('signature'):
 746             self.compare_signature_files (f1, f2)
 747         else:
 748             ext = os.path.splitext (f1)[1]
 749             klasses = {
 750                 '.midi': MidiFileLink,
 751                 '.log' : TextFileCompareLink,
 752                 '.profile': ProfileFileLink,
 753                 }
 754
 755             if klasses.has_key (ext):
 756                 self.compare_general_files (klasses[ext], f1, f2)
 757
 758     def compare_general_files (self, klass, f1, f2):
 759         name = os.path.split (f1)[1]
 760
 761         file_link = klass (f1, f2)
 762         self.file_links[name] = file_link
 763
 764     def compare_signature_files (self, f1, f2):
 765         name = os.path.split (f1)[1]
 766         name = re.sub ('-[0-9]+.signature', '', name)
 767
 768         file_link = None
 769         try:
 770             file_link = self.file_links[name]
 771         except KeyError:
 772             file_link = SignatureFileLink ()
 773             self.file_links[name] = file_link
 774
 775         file_link.add_file_compare (f1, f2)
 776
 777     def remove_changed (self, dir, threshold):
 778         (changed, below, unchanged) = self.thresholded_results (threshold)
 779         for link in changed:
 780             try:
 781                 system ('rm -f %s*' % link.base_names[1])
 782             except AttributeError: ### UGH.
 783                 system ('rm -f %s/%s*' % (dir, link.name ()))
 784     def thresholded_results (self, threshold):
 785         ## todo: support more scores.
 786         results = [(link.distance(), link)
 787                    for link in self.file_links.values ()]
 788         results.sort ()
 789         results.reverse ()
 790
 791         unchanged = [r for (d,r) in results if d == 0.0]
 792         below = [r for (d,r) in results if threshold >= d > 0.0]
 793         changed = [r for (d,r) in results if d > threshold]
 794
 795         return (changed, below, unchanged)
 796
 797     def write_text_result_page (self, filename, threshold):
 798         out = None
 799         if filename == '':
 800             out = sys.stdout
 801         else:
 802             print 'writing "%s"' % filename
 803             out = open_write_file (filename)
 804
 805         (changed, below, unchanged) = self.thresholded_results (threshold)
 806
 807
 808         for link in changed:
 809             out.write (link.text_record_string ())
 810
 811         out.write ('\n\n')
 812         out.write ('%d below threshold\n' % len (below))
 813         out.write ('%d unchanged\n' % len (unchanged))
 814
 815     def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
 816         self.write_text_result_page (dest_dir + '/index.txt', threshold)
 817
 818     def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
 819         dir1 = dir1.replace ('//', '/')
 820         dir2 = dir2.replace ('//', '/')
 821
 822         (changed, below, unchanged) = self.thresholded_results (threshold)
 823
 824
 825         html = ''
 826         old_prefix = os.path.split (dir1)[1]
 827         for link in changed:
 828             link.link_files_for_html (dir1, dir2, dest_dir)
 829             link.write_html_system_details (dir1, dir2, dest_dir)
 830
 831             html += link.html_record_string (dir1, dir2)
 832
 833
 834         short_dir1 = shorten_string (dir1)
 835         short_dir2 = shorten_string (dir2)
 836         html = '''<html>
 837 <table rules="rows" border bordercolor="blue">
 838 <tr>
 839 <th>distance</th>
 840 <th>%(short_dir1)s</th>
 841 <th>%(short_dir2)s</th>
 842 </tr>
 843 %(html)s
 844 </table>
 845 </html>''' % locals()
 846
 847         html += ('<p>')
 848         below_count = len (below)
 849
 850         if below_count:
 851             html += ('<p>%d below threshold</p>' % below_count)
 852
 853         html += ('<p>%d unchanged</p>' % len (unchanged))
 854
 855         dest_file = dest_dir + '/index.html'
 856         open_write_file (dest_file).write (html)
 857
 858     def print_results (self, threshold):
 859         self.write_text_result_page ('', threshold)
 860
 861 def compare_trees (dir1, dir2, dest_dir, threshold):
 862     data = ComparisonData ()
 863     data.compare_trees (dir1, dir2)
 864     data.print_results (threshold)
 865
 866     if options.remove_changed:
 867         data.remove_changed (dir2, threshold)
 868         return
 869
 870     if os.path.isdir (dest_dir):
 871         system ('rm -rf %s '% dest_dir)
 872
 873     data.create_html_result_page (dir1, dir2, dest_dir, threshold)
 874     data.create_text_result_page (dir1, dir2, dest_dir, threshold)
 875
 876 ################################################################
 877 # TESTING
 878
 879 def mkdir (x):
 880     if not os.path.isdir (x):
 881         print 'mkdir', x
 882         os.makedirs (x)
 883
 884 def link_file (x, y):
 885     mkdir (os.path.split (y)[0])
 886     try:
 887         os.link (x, y)
 888     except OSError, z:
 889         print 'OSError', x, y, z
 890         raise OSError
 891
 892 def open_write_file (x):
 893     d = os.path.split (x)[0]
 894     mkdir (d)
 895     return open (x, 'w')
 896
 897
 898 def system (x):
 899
 900     print 'invoking', x
 901     stat = os.system (x)
 902     assert stat == 0
 903
 904
 905 def test_paired_files ():
 906     print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
 907                         os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
 908
 909
 910 def test_compare_trees ():
 911     system ('rm -rf dir1 dir2')
 912     system ('mkdir dir1 dir2')
 913     system ('cp 20{-*.signature,.ly,.png,.eps,.log,.profile} dir1')
 914     system ('cp 20{-*.signature,.ly,.png,.eps,.log,.profile} dir2')
 915     system ('cp 20expr{-*.signature,.ly,.png,.eps,.log,.profile} dir1')
 916     system ('cp 19{-*.signature,.ly,.png,.eps,.log,.profile} dir2/')
 917     system ('cp 19{-*.signature,.ly,.png,.eps,.log,.profile} dir1/')
 918     system ('cp 19-1.signature 19-sub-1.signature')
 919     system ('cp 19.ly 19-sub.ly')
 920     system ('cp 19.profile 19-sub.profile')
 921     system ('cp 19.log 19-sub.log')
 922     system ('cp 19.png 19-sub.png')
 923     system ('cp 19.eps 19-sub.eps')
 924
 925     system ('cp 20multipage* dir1')
 926     system ('cp 20multipage* dir2')
 927     system ('cp 19multipage-1.signature dir2/20multipage-1.signature')
 928
 929
 930     system ('mkdir -p dir1/subdir/ dir2/subdir/')
 931     system ('cp 19-sub{-*.signature,.ly,.png,.eps,.log,.profile} dir1/subdir/')
 932     system ('cp 19-sub{-*.signature,.ly,.png,.eps,.log,.profile} dir2/subdir/')
 933     system ('cp 20grob{-*.signature,.ly,.png,.eps,.log,.profile} dir2/')
 934     system ('cp 20grob{-*.signature,.ly,.png,.eps,.log,.profile} dir1/')
 935
 936     ## introduce differences
 937     system ('cp 19-1.signature dir2/20-1.signature')
 938     system ('cp 19.profile dir2/20.profile')
 939     system ('cp 19.png dir2/20.png')
 940     system ('cp 19multipage-page1.png dir2/20multipage-page1.png')
 941     system ('cp 20-1.signature dir2/subdir/19-sub-1.signature')
 942     system ('cp 20.png dir2/subdir/19-sub.png')
 943
 944     ## radical diffs.
 945     system ('cp 19-1.signature dir2/20grob-1.signature')
 946     system ('cp 19-1.signature dir2/20grob-2.signature')
 947     system ('cp 19multipage.midi dir1/midi-differ.midi')
 948     system ('cp 20multipage.midi dir2/midi-differ.midi')
 949     system ('cp 19multipage.log dir1/log-differ.log')
 950     system ('cp 19multipage.log dir2/log-differ.log &&  echo different >> dir2/log-differ.log &&  echo different >> dir2/log-differ.log')
 951
 952     compare_trees ('dir1', 'dir2', 'compare-dir1dir2', 0.5)
 953
 954
 955 def test_basic_compare ():
 956     ly_template = r"""
 957
 958 \version "2.10.0"
 959 #(define default-toplevel-book-handler
 960   print-book-with-defaults-as-systems )
 961
 962 #(ly:set-option (quote no-point-and-click))
 963
 964 \sourcefilename "my-source.ly"
 965
 966 %(papermod)s
 967 \header { tagline = ##f }
 968 \score {
 969 <<
 970 \new Staff \relative c {
 971   c4^"%(userstring)s" %(extragrob)s
 972   }
 973 \new Staff \relative c {
 974   c4^"%(userstring)s" %(extragrob)s
 975   }
 976 >>
 977 \layout{}
 978 }
 979
 980 """
 981
 982     dicts = [{ 'papermod' : '',
 983                'name' : '20',
 984                'extragrob': '',
 985                'userstring': 'test' },
 986              { 'papermod' : '#(set-global-staff-size 19.5)',
 987                'name' : '19',
 988                'extragrob': '',
 989                'userstring': 'test' },
 990              { 'papermod' : '',
 991                'name' : '20expr',
 992                'extragrob': '',
 993                'userstring': 'blabla' },
 994              { 'papermod' : '',
 995                'name' : '20grob',
 996                'extragrob': 'r2. \\break c1',
 997                'userstring': 'test' },
 998              ]
 999
1000     for d in dicts:
1001         open (d['name'] + '.ly','w').write (ly_template % d)
1002
1003     names = [d['name'] for d in dicts]
1004
1005     system ('lilypond -ddump-profile -dseparate-log-files -ddump-signatures --png -b eps ' + ' '.join (names))
1006
1007
1008     multipage_str = r'''
1009     #(set-default-paper-size "a6")
1010     \score {
1011       \relative {c1 \pageBreak c1 }
1012       \layout {}
1013       \midi {}
1014     }
1015     '''
1016
1017     open ('20multipage', 'w').write (multipage_str.replace ('c1', 'd1'))
1018     open ('19multipage', 'w').write ('#(set-global-staff-size 19.5)\n' + multipage_str)
1019     system ('lilypond -dseparate-log-files -ddump-signatures --png 19multipage 20multipage ')
1020
1021     test_compare_signatures (names)
1022
1023 def test_compare_signatures (names, timing=False):
1024
1025     import time
1026
1027     times = 1
1028     if timing:
1029         times = 100
1030
1031     t0 = time.clock ()
1032
1033     count = 0
1034     for t in range (0, times):
1035         sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
1036         count += 1
1037
1038     if timing:
1039         print 'elapsed', (time.clock() - t0)/count
1040
1041
1042     t0 = time.clock ()
1043     count = 0
1044     combinations = {}
1045     for (n1, s1) in sigs.items():
1046         for (n2, s2) in sigs.items():
1047             combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
1048             count += 1
1049
1050     if timing:
1051         print 'elapsed', (time.clock() - t0)/count
1052
1053     results = combinations.items ()
1054     results.sort ()
1055     for k,v in results:
1056         print '%-20s' % k, v
1057
1058     assert combinations['20-20'] == (0.0,0.0,0.0)
1059     assert combinations['20-20expr'][0] > 0.0
1060     assert combinations['20-19'][2] < 10.0
1061     assert combinations['20-19'][2] > 0.0
1062
1063
1064 def run_tests ():
1065     dir = 'test-output-distance'
1066
1067     do_clean = not os.path.exists (dir)
1068
1069     print 'test results in ', dir
1070     if do_clean:
1071         system ('rm -rf ' + dir)
1072         system ('mkdir ' + dir)
1073
1074     os.chdir (dir)
1075     if do_clean:
1076         test_basic_compare ()
1077
1078     test_compare_trees ()
1079
1080 ################################################################
1081 #
1082
1083 def main ():
1084     p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
1085     p.usage = 'output-distance.py [options] tree1 tree2'
1086
1087     p.add_option ('', '--test-self',
1088                   dest="run_test",
1089                   action="store_true",
1090                   help='run test method')
1091
1092     p.add_option ('--max-count',
1093                   dest="max_count",
1094                   metavar="COUNT",
1095                   type="int",
1096                   default=0,
1097                   action="store",
1098                   help='only analyze COUNT signature pairs')
1099
1100     p.add_option ('', '--threshold',
1101                   dest="threshold",
1102                   default=0.3,
1103                   action="store",
1104                   type="float",
1105                   help='threshold for geometric distance')
1106
1107
1108     p.add_option ('--remove-changed',
1109                   dest="remove_changed",
1110                   default=False,
1111                   action="store_true",
1112                   help="Remove all files from tree2 that are over the threshold.")
1113
1114     p.add_option ('--no-compare-images',
1115                   dest="compare_images",
1116                   default=True,
1117                   action="store_false",
1118                   help="Don't run graphical comparisons")
1119
1120     p.add_option ('--create-images',
1121                   dest="create_images",
1122                   default=False,
1123                   action="store_true",
1124                   help="Create PNGs from EPSes")
1125
1126     p.add_option ('-o', '--output-dir',
1127                   dest="output_dir",
1128                   default=None,
1129                   action="store",
1130                   type="string",
1131                   help='where to put the test results [tree2/compare-tree1tree2]')
1132
1133     global options
1134     (options, a) = p.parse_args ()
1135
1136     if options.run_test:
1137         run_tests ()
1138         sys.exit (0)
1139
1140     if len (a) != 2:
1141         p.print_usage()
1142         sys.exit (2)
1143
1144     name = options.output_dir
1145     if not name:
1146         name = a[0].replace ('/', '')
1147         name = os.path.join (a[1], 'compare-' + shorten_string (name))
1148
1149     compare_trees (a[0], a[1], name, options.threshold)
1150
1151 if __name__ == '__main__':
1152     main()
1153