buildscripts/output-distance.py

   1 #!@TARGET_PYTHON@
   2 import sys
   3 import optparse
   4 import os
   5 import math
   6
   7 ## so we can call directly as buildscripts/output-distance.py
   8 me_path = os.path.abspath (os.path.split (sys.argv[0])[0])
   9 sys.path.insert (0, me_path + '/../python/')
  10 sys.path.insert (0, me_path + '/../python/out/')
  11
  12
  13 X_AXIS = 0
  14 Y_AXIS = 1
  15 INFTY = 1e6
  16
  17 OUTPUT_EXPRESSION_PENALTY = 1
  18 ORPHAN_GROB_PENALTY = 1
  19 options = None
  20
  21 ################################################################
  22 # system interface.
  23 temp_dir = None
  24 class TempDirectory:
  25     def __init__ (self):
  26         import tempfile
  27         self.dir = tempfile.mkdtemp ()
  28         print 'dir is', self.dir
  29     def __del__ (self):
  30         print 'rm -rf %s' % self.dir
  31         os.system ('rm -rf %s' % self.dir )
  32     def __call__ (self):
  33         return self.dir
  34
  35
  36 def get_temp_dir  ():
  37     global temp_dir
  38     if not temp_dir:
  39         temp_dir = TempDirectory ()
  40     return temp_dir ()
  41
  42 def read_pipe (c):
  43     print 'pipe' , c
  44     return os.popen (c).read ()
  45
  46 def system (c):
  47     print 'system' , c
  48     s = os.system (c)
  49     if s :
  50         raise Exception ("failed")
  51     return
  52
  53 def shorten_string (s):
  54     threshold = 15
  55     if len (s) > 2*threshold:
  56         s = s[:threshold] + '..' + s[-threshold:]
  57     return s
  58
  59 def max_distance (x1, x2):
  60     dist = 0.0
  61
  62     for (p,q) in zip (x1, x2):
  63         dist = max (abs (p-q), dist)
  64
  65     return dist
  66
  67
  68 def compare_png_images (old, new, dest_dir):
  69     def png_dims (f):
  70         m = re.search ('([0-9]+) x ([0-9]+)', read_pipe ('file %s' % f))
  71
  72         return tuple (map (int, m.groups ()))
  73
  74     dest = os.path.join (dest_dir, new.replace ('.png', '.compare.jpeg'))
  75     try:
  76         dims1 = png_dims (old)
  77         dims2 = png_dims (new)
  78     except AttributeError:
  79         ## hmmm. what to do?
  80         system ('touch %(dest)s' % locals ())
  81         return
  82
  83     dims = (min (dims1[0], dims2[0]),
  84             min (dims1[1], dims2[1]))
  85
  86     dir = get_temp_dir ()
  87     system ('convert -depth 8 -crop %dx%d+0+0 %s %s/crop1.png' % (dims + (old, dir)))
  88     system ('convert -depth 8 -crop %dx%d+0+0 %s %s/crop2.png' % (dims + (new, dir)))
  89
  90     system ('compare -depth 8 %(dir)s/crop1.png %(dir)s/crop2.png %(dir)s/diff.png' % locals ())
  91
  92     system ("convert  -depth 8 %(dir)s/diff.png -blur 0x3 -negate -channel alpha,blue -type TrueColorMatte -fx 'intensity'    %(dir)s/matte.png" % locals ())
  93
  94     system ("composite -quality 65 %(dir)s/matte.png %(new)s %(dest)s" % locals ())
  95
  96
  97 ################################################################
  98 # interval/bbox arithmetic.
  99
 100 empty_interval = (INFTY, -INFTY)
 101 empty_bbox = (empty_interval, empty_interval)
 102
 103 def interval_is_empty (i):
 104     return i[0] > i[1]
 105
 106 def interval_length (i):
 107     return max (i[1]-i[0], 0)
 108
 109 def interval_union (i1, i2):
 110     return (min (i1[0], i2[0]),
 111             max (i1[1], i2[1]))
 112
 113 def interval_intersect (i1, i2):
 114     return (max (i1[0], i2[0]),
 115             min (i1[1], i2[1]))
 116
 117 def bbox_is_empty (b):
 118     return (interval_is_empty (b[0])
 119             or interval_is_empty (b[1]))
 120
 121 def bbox_union (b1, b2):
 122     return (interval_union (b1[X_AXIS], b2[X_AXIS]),
 123             interval_union (b2[Y_AXIS], b2[Y_AXIS]))
 124
 125 def bbox_intersection (b1, b2):
 126     return (interval_intersect (b1[X_AXIS], b2[X_AXIS]),
 127             interval_intersect (b2[Y_AXIS], b2[Y_AXIS]))
 128
 129 def bbox_area (b):
 130     return interval_length (b[X_AXIS]) * interval_length (b[Y_AXIS])
 131
 132 def bbox_diameter (b):
 133     return max (interval_length (b[X_AXIS]),
 134                 interval_length (b[Y_AXIS]))
 135
 136
 137 def difference_area (a, b):
 138     return bbox_area (a) - bbox_area (bbox_intersection (a,b))
 139
 140 class GrobSignature:
 141     def __init__ (self, exp_list):
 142         (self.name, self.origin, bbox_x,
 143          bbox_y, self.output_expression) = tuple (exp_list)
 144
 145         self.bbox = (bbox_x, bbox_y)
 146         self.centroid = (bbox_x[0] + bbox_x[1], bbox_y[0] + bbox_y[1])
 147
 148     def __repr__ (self):
 149         return '%s: (%.2f,%.2f), (%.2f,%.2f)\n' % (self.name,
 150                                                    self.bbox[0][0],
 151                                                    self.bbox[0][1],
 152                                                    self.bbox[1][0],
 153                                                    self.bbox[1][1])
 154
 155     def axis_centroid (self, axis):
 156         return apply (sum, self.bbox[axis])  / 2
 157
 158     def centroid_distance (self, other, scale):
 159         return max_distance (self.centroid, other.centroid) / scale
 160
 161     def bbox_distance (self, other):
 162         divisor = bbox_area (self.bbox) + bbox_area (other.bbox)
 163
 164         if divisor:
 165             return (difference_area (self.bbox, other.bbox) +
 166                     difference_area (other.bbox, self.bbox)) / divisor
 167         else:
 168             return 0.0
 169
 170     def expression_distance (self, other):
 171         if self.output_expression == other.output_expression:
 172             return 0
 173         else:
 174             return 1
 175
 176 ################################################################
 177 # single System.
 178
 179 class SystemSignature:
 180     def __init__ (self, grob_sigs):
 181         d = {}
 182         for g in grob_sigs:
 183             val = d.setdefault (g.name, [])
 184             val += [g]
 185
 186         self.grob_dict = d
 187         self.set_all_bbox (grob_sigs)
 188
 189     def set_all_bbox (self, grobs):
 190         self.bbox = empty_bbox
 191         for g in grobs:
 192             self.bbox = bbox_union (g.bbox, self.bbox)
 193
 194     def closest (self, grob_name, centroid):
 195         min_d = INFTY
 196         min_g = None
 197         try:
 198             grobs = self.grob_dict[grob_name]
 199
 200             for g in grobs:
 201                 d = max_distance (g.centroid, centroid)
 202                 if d < min_d:
 203                     min_d = d
 204                     min_g = g
 205
 206
 207             return min_g
 208
 209         except KeyError:
 210             return None
 211     def grobs (self):
 212         return reduce (lambda x,y: x+y, self.grob_dict.values(), [])
 213
 214 ################################################################
 215 ## comparison of systems.
 216
 217 class SystemLink:
 218     def __init__ (self, system1, system2):
 219         self.system1 = system1
 220         self.system2 = system2
 221
 222         self.link_list_dict = {}
 223         self.back_link_dict = {}
 224
 225
 226         ## pairs
 227         self.orphans = []
 228
 229         ## pair -> distance
 230         self.geo_distances = {}
 231
 232         ## pairs
 233         self.expression_changed = []
 234
 235         self._geometric_distance = None
 236         self._expression_change_count = None
 237         self._orphan_count = None
 238
 239         for g in system1.grobs ():
 240
 241             ## skip empty bboxes.
 242             if bbox_is_empty (g.bbox):
 243                 continue
 244
 245             closest = system2.closest (g.name, g.centroid)
 246
 247             self.link_list_dict.setdefault (closest, [])
 248             self.link_list_dict[closest].append (g)
 249             self.back_link_dict[g] = closest
 250
 251
 252     def calc_geometric_distance (self):
 253         total = 0.0
 254         for (g1,g2) in self.back_link_dict.items ():
 255             if g2:
 256                 d = g1.bbox_distance (g2)
 257                 if d:
 258                     self.geo_distances[(g1,g2)] = d
 259
 260                 total += d
 261
 262         self._geometric_distance = total
 263
 264     def calc_orphan_count (self):
 265         count = 0
 266         for (g1, g2) in self.back_link_dict.items ():
 267             if g2 == None:
 268                 self.orphans.append ((g1, None))
 269
 270                 count += 1
 271
 272         self._orphan_count = count
 273
 274     def calc_output_exp_distance (self):
 275         d = 0
 276         for (g1,g2) in self.back_link_dict.items ():
 277             if g2:
 278                 d += g1.expression_distance (g2)
 279
 280         self._expression_change_count = d
 281
 282     def output_expression_details_string (self):
 283         return ', '.join ([g1.name for g1 in self.expression_changed])
 284
 285     def geo_details_string (self):
 286         results = [(d, g1,g2) for ((g1, g2), d) in self.geo_distances.items()]
 287         results.sort ()
 288         results.reverse ()
 289
 290         return ', '.join (['%s: %f' % (g1.name, d) for (d, g1, g2) in results])
 291
 292     def orphan_details_string (self):
 293         return ', '.join (['%s-None' % g1.name for (g1,g2) in self.orphans if g2==None])
 294
 295     def geometric_distance (self):
 296         if self._geometric_distance == None:
 297             self.calc_geometric_distance ()
 298         return self._geometric_distance
 299
 300     def orphan_count (self):
 301         if self._orphan_count == None:
 302             self.calc_orphan_count ()
 303
 304         return self._orphan_count
 305
 306     def output_expression_change_count (self):
 307         if self._expression_change_count == None:
 308             self.calc_output_exp_distance ()
 309         return self._expression_change_count
 310
 311     def distance (self):
 312         return (self.output_expression_change_count (),
 313                 self.orphan_count (),
 314                 self.geometric_distance ())
 315
 316 def read_signature_file (name):
 317     print 'reading', name
 318
 319     entries = open (name).read ().split ('\n')
 320     def string_to_tup (s):
 321         return tuple (map (float, s.split (' ')))
 322
 323     def string_to_entry (s):
 324         fields = s.split('@')
 325         fields[2] = string_to_tup (fields[2])
 326         fields[3] = string_to_tup (fields[3])
 327
 328         return tuple (fields)
 329
 330     entries = [string_to_entry (e) for e in entries
 331                if e and not e.startswith ('#')]
 332
 333     grob_sigs = [GrobSignature (e) for e in entries]
 334     sig = SystemSignature (grob_sigs)
 335     return sig
 336
 337
 338 ################################################################
 339 # different systems of a .ly file.
 340
 341 hash_to_original_name = {}
 342
 343 class FileLink:
 344     def __init__ (self, f1, f2):
 345         self._distance = None
 346         self.file_names = (f1, f2)
 347
 348     def text_record_string (self):
 349         return '%-30f %-20s\n' % (self.distance (),
 350                                   self.name ())
 351     def calc_distance (self):
 352         return 0.0
 353
 354     def distance (self):
 355         if self._distance == None:
 356            self._distance = self.calc_distance ()
 357
 358         return self._distance
 359
 360     def source_file (self):
 361         for ext in ('.ly', '.ly.txt'):
 362             base = os.path.splitext (self.file_names[1])[0]
 363             f = base + ext
 364             if os.path.exists (f):
 365                 return f
 366
 367         return ''
 368
 369     def name (self):
 370         base = os.path.basename (self.file_names[1])
 371         base = os.path.splitext (base)[0]
 372         base = hash_to_original_name.get (base, base)
 373         base = os.path.splitext (base)[0]
 374         return base
 375
 376     def extension (self):
 377         return os.path.splitext (self.file_names[1])[1]
 378
 379     def link_files_for_html (self, dest_dir):
 380         for f in self.file_names:
 381             link_file (f, os.path.join (dest_dir, f))
 382
 383     def get_distance_details (self):
 384         return ''
 385
 386     def get_cell (self, oldnew):
 387         return ''
 388
 389     def get_file (self, oldnew):
 390         return self.file_names[oldnew]
 391
 392     def html_record_string (self, dest_dir):
 393         dist = self.distance()
 394
 395         details = self.get_distance_details ()
 396         if details:
 397             details_base = os.path.splitext (self.file_names[1])[0]
 398             details_base += '.details.html'
 399             fn = dest_dir + '/'  + details_base
 400             open_write_file (fn).write (details)
 401
 402             details = '<br>(<a href="%(details_base)s">details</a>)' % locals ()
 403
 404         cell1 = self.get_cell (0)
 405         cell2 = self.get_cell (1)
 406
 407         name = self.name () + self.extension ()
 408         file1 = self.get_file (0)
 409         file2 = self.get_file (1)
 410
 411         return '''<tr>
 412 <td>
 413 %(dist)f
 414 %(details)s
 415 </td>
 416 <td>%(cell1)s<br><font size=-2><a href="%(file1)s"><tt>%(name)s</tt></font></td>
 417 <td>%(cell2)s<br><font size=-2><a href="%(file2)s"><tt>%(name)s</tt></font></td>
 418 </tr>''' % locals ()
 419
 420
 421 class FileCompareLink (FileLink):
 422     def __init__ (self, f1, f2):
 423         FileLink.__init__ (self, f1, f2)
 424         self.contents = (self.get_content (self.file_names[0]),
 425                          self.get_content (self.file_names[1]))
 426
 427
 428     def calc_distance (self):
 429         ## todo: could use import MIDI to pinpoint
 430         ## what & where changed.
 431
 432         if self.contents[0] == self.contents[1]:
 433             return 0.0
 434         else:
 435             return 100.0;
 436
 437     def get_content (self, f):
 438         print 'reading', f
 439         s = open (f).read ()
 440         return s
 441
 442
 443
 444
 445 class GitFileCompareLink (FileCompareLink):
 446     def get_cell (self, oldnew):
 447         str = self.contents[oldnew]
 448
 449         # truncate long lines
 450         str = '\n'.join ([l[:80] for l in str.split ('\n')])
 451
 452
 453         str = '<font size="-2"><pre>%s</pre></font>' % str
 454         return str
 455
 456     def calc_distance (self):
 457         if self.contents[0] == self.contents[1]:
 458             d = 0.0
 459         else:
 460             d = 1.0001 *options.threshold
 461
 462         return d
 463
 464 class TextFileCompareLink (FileCompareLink):
 465     def calc_distance (self):
 466         import difflib
 467         diff = difflib.unified_diff (self.contents[0].strip().split ('\n'),
 468                                      self.contents[1].strip().split ('\n'),
 469                                      fromfiledate = self.file_names[0],
 470                                      tofiledate = self.file_names[1]
 471                                      )
 472
 473         self.diff_lines =  [l for l in diff]
 474         self.diff_lines = self.diff_lines[2:]
 475
 476         return math.sqrt (float (len ([l for l in self.diff_lines if l[0] in '-+'])))
 477
 478     def get_cell (self, oldnew):
 479         str = ''
 480         if oldnew == 1:
 481             str = '\n'.join ([d.replace ('\n','') for d in self.diff_lines])
 482         str = '<font size="-2"><pre>%s</pre></font>' % str
 483         return str
 484
 485
 486 class ProfileFileLink (FileCompareLink):
 487     def __init__ (self, f1, f2):
 488         FileCompareLink.__init__ (self, f1, f2)
 489         self.results = [{}, {}]
 490
 491     def get_cell (self, oldnew):
 492         str = ''
 493         for k in ('time', 'cells'):
 494             if oldnew==0:
 495                 str += '%-8s: %d\n' %  (k, int (self.results[oldnew][k]))
 496             else:
 497                 str += '%-8s: %8d (%5.3f)\n' % (k, int (self.results[oldnew][k]),
 498                                                 self.get_ratio (k))
 499
 500         return '<pre>%s</pre>' % str
 501
 502     def get_ratio (self, key):
 503         (v1,v2) = (self.results[0].get (key, -1),
 504                    self.results[1].get (key, -1))
 505
 506         if v1 <= 0 or v2 <= 0:
 507             return 0.0
 508
 509         return (v1 - v2) / float (v1+v2)
 510
 511     def calc_distance (self):
 512         for oldnew in (0,1):
 513             def note_info (m):
 514                 self.results[oldnew][m.group(1)] = float (m.group (2))
 515
 516             re.sub ('([a-z]+): ([-0-9.]+)\n',
 517                     note_info, self.contents[oldnew])
 518
 519         dist = 0.0
 520         factor = {
 521             'time': 1.0 ,
 522             'cells': 5.0,
 523             }
 524
 525         for k in ('time', 'cells'):
 526             real_val = math.tan (self.get_ratio (k) * 0.5 * math.pi)
 527             dist += math.exp (math.fabs (real_val) * factor[k])  - 1
 528
 529         dist = min (dist, 100)
 530         return dist
 531
 532
 533 class MidiFileLink (TextFileCompareLink):
 534     def get_content (self, oldnew):
 535         import midi
 536
 537         data = FileCompareLink.get_content (self, oldnew)
 538         midi = midi.parse (data)
 539         tracks = midi[1]
 540
 541         str = ''
 542         j = 0
 543         for t in tracks:
 544             str += 'track %d' % j
 545             j += 1
 546
 547             for e in t:
 548                 ev_str = repr (e)
 549                 if re.search ('LilyPond [0-9.]+', ev_str):
 550                     continue
 551
 552                 str += '  ev %s\n' % `e`
 553         return str
 554
 555
 556
 557 class SignatureFileLink (FileLink):
 558     def __init__ (self, f1, f2 ):
 559         FileLink.__init__ (self, f1, f2)
 560         self.system_links = {}
 561
 562     def add_system_link (self, link, number):
 563         self.system_links[number] = link
 564
 565     def calc_distance (self):
 566         d = 0.0
 567
 568         orphan_distance = 0.0
 569         for l in self.system_links.values ():
 570             d = max (d, l.geometric_distance ())
 571             orphan_distance += l.orphan_count ()
 572
 573         return d + orphan_distance
 574
 575
 576
 577     def add_file_compare (self, f1, f2):
 578         system_index = []
 579
 580         def note_system_index (m):
 581             system_index.append (int (m.group (1)))
 582             return ''
 583
 584         base1 = re.sub ("-([0-9]+).signature", note_system_index, f1)
 585         base2 = re.sub ("-([0-9]+).signature", note_system_index, f2)
 586
 587         self.base_names = (os.path.normpath (base1),
 588                            os.path.normpath (base2))
 589
 590         s1 = read_signature_file (f1)
 591         s2 = read_signature_file (f2)
 592
 593         link = SystemLink (s1, s2)
 594
 595         self.add_system_link (link, system_index[0])
 596
 597
 598     def create_images (self, dest_dir):
 599
 600         files_created = [[], []]
 601         for oldnew in (0, 1):
 602             pat = self.base_names[oldnew] + '.eps'
 603
 604             for f in glob.glob (pat):
 605                 infile = f
 606                 outfile = (dest_dir + '/' + f).replace ('.eps', '.png')
 607
 608                 mkdir (os.path.split (outfile)[0])
 609                 cmd = ('gs -sDEVICE=png16m -dGraphicsAlphaBits=4 -dTextAlphaBits=4 '
 610                        ' -r101 '
 611                        ' -sOutputFile=%(outfile)s -dNOSAFER -dEPSCrop -q -dNOPAUSE '
 612                        ' %(infile)s  -c quit '  % locals ())
 613
 614                 files_created[oldnew].append (outfile)
 615                 system (cmd)
 616
 617         return files_created
 618
 619     def link_files_for_html (self, dest_dir):
 620         FileLink.link_files_for_html (self, dest_dir)
 621         to_compare = [[], []]
 622
 623         exts = []
 624         if options.create_images:
 625             to_compare = self.create_images (dest_dir)
 626         else:
 627             exts += ['.png', '-page*png']
 628
 629         for ext in exts:
 630             for oldnew in (0,1):
 631                 for f in glob.glob (self.base_names[oldnew] + ext):
 632                     dst = dest_dir + '/' + f
 633                     link_file (f, dst)
 634
 635                     if f.endswith ('.png'):
 636                         to_compare[oldnew].append (f)
 637
 638         if options.compare_images:
 639             for (old, new) in zip (to_compare[0], to_compare[1]):
 640                 compare_png_images (old, new, dest_dir)
 641
 642
 643     def get_cell (self, oldnew):
 644         def img_cell (ly, img, name):
 645             if not name:
 646                 name = 'source'
 647             else:
 648                 name = '<tt>%s</tt>' % name
 649
 650             return '''
 651 <a href="%(img)s">
 652 <img src="%(img)s" style="border-style: none; max-width: 500px;">
 653 </a><br>
 654 ''' % locals ()
 655         def multi_img_cell (ly, imgs, name):
 656             if not name:
 657                 name = 'source'
 658             else:
 659                 name = '<tt>%s</tt>' % name
 660
 661             imgs_str = '\n'.join (['''<a href="%s">
 662 <img src="%s" style="border-style: none; max-width: 500px;">
 663 </a><br>''' % (img, img)
 664                                   for img in imgs])
 665
 666
 667             return '''
 668 %(imgs_str)s
 669 ''' % locals ()
 670
 671
 672
 673         def cell (base, name):
 674             pat = base + '-page*.png'
 675             pages = glob.glob (pat)
 676
 677             if pages:
 678                 return multi_img_cell (base + '.ly', sorted (pages), name)
 679             else:
 680                 return img_cell (base + '.ly', base + '.png', name)
 681
 682
 683
 684         str = cell (os.path.splitext (self.file_names[oldnew])[0], self.name ())
 685         if options.compare_images and oldnew == 1:
 686             str = str.replace ('.png', '.compare.jpeg')
 687
 688         return str
 689
 690
 691     def get_distance_details (self):
 692         systems = self.system_links.items ()
 693         systems.sort ()
 694
 695         html = ""
 696         for (c, link) in systems:
 697             e = '<td>%d</td>' % c
 698             for d in link.distance ():
 699                 e += '<td>%f</td>' % d
 700
 701             e = '<tr>%s</tr>' % e
 702
 703             html += e
 704
 705             e = '<td>%d</td>' % c
 706             for s in (link.output_expression_details_string (),
 707                       link.orphan_details_string (),
 708                       link.geo_details_string ()):
 709                 e += "<td>%s</td>" % s
 710
 711
 712             e = '<tr>%s</tr>' % e
 713             html += e
 714
 715         original = self.name ()
 716         html = '''<html>
 717 <head>
 718 <title>comparison details for %(original)s</title>
 719 </head>
 720 <body>
 721 <table border=1>
 722 <tr>
 723 <th>system</th>
 724 <th>output</th>
 725 <th>orphan</th>
 726 <th>geo</th>
 727 </tr>
 728
 729 %(html)s
 730 </table>
 731
 732 </body>
 733 </html>
 734 ''' % locals ()
 735         return html
 736
 737
 738 ################################################################
 739 # Files/directories
 740
 741 import glob
 742 import re
 743
 744 def compare_signature_files (f1, f2):
 745     s1 = read_signature_file (f1)
 746     s2 = read_signature_file (f2)
 747
 748     return SystemLink (s1, s2).distance ()
 749
 750 def paired_files (dir1, dir2, pattern):
 751     """
 752     Search DIR1 and DIR2 for PATTERN.
 753
 754     Return (PAIRED, MISSING-FROM-2, MISSING-FROM-1)
 755
 756     """
 757
 758     files = []
 759     for d in (dir1,dir2):
 760         found = [os.path.split (f)[1] for f in glob.glob (d + '/' + pattern)]
 761         found = dict ((f, 1) for f in found)
 762         files.append (found)
 763
 764     pairs = []
 765     missing = []
 766     for f in files[0].keys ():
 767         try:
 768             files[1].pop (f)
 769             pairs.append (f)
 770         except KeyError:
 771             missing.append (f)
 772
 773     return (pairs, files[1].keys (), missing)
 774
 775 class ComparisonData:
 776     def __init__ (self):
 777         self.result_dict = {}
 778         self.missing = []
 779         self.added = []
 780         self.file_links = {}
 781
 782     def read_sources (self):
 783
 784         ## ugh: drop the .ly.txt
 785         for (key, val) in self.file_links.items ():
 786
 787             def note_original (match, ln=val):
 788                 key = ln.name ()
 789                 hash_to_original_name[key] = match.group (1)
 790                 return ''
 791
 792             sf = val.source_file ()
 793             re.sub (r'\\sourcefilename "([^"]+)"',
 794                     note_original, open (sf).read ())
 795
 796     def compare_trees (self, dir1, dir2):
 797         self.compare_directories (dir1, dir2)
 798
 799         (root, dirs, files) = os.walk (dir1).next ()
 800         for d in dirs:
 801             d1 = os.path.join (dir1, d)
 802             d2 = os.path.join (dir2, d)
 803
 804             if os.path.islink (d1) or os.path.islink (d2):
 805                 continue
 806
 807             if os.path.isdir (d2):
 808                 self.compare_trees (d1, d2)
 809
 810     def compare_directories (self, dir1, dir2):
 811         for ext in ['signature',
 812                     'midi',
 813                     'log',
 814                     'profile',
 815                     'gittxt']:
 816             (paired, m1, m2) = paired_files (dir1, dir2, '*.' + ext)
 817
 818             self.missing += [(dir1, m) for m in m1]
 819             self.added += [(dir2, m) for m in m2]
 820
 821             for p in paired:
 822                 if (options.max_count
 823                     and len (self.file_links) > options.max_count):
 824                     continue
 825
 826                 f2 = dir2 +  '/' + p
 827                 f1 = dir1 +  '/' + p
 828                 self.compare_files (f1, f2)
 829
 830     def compare_files (self, f1, f2):
 831         if f1.endswith ('signature'):
 832             self.compare_signature_files (f1, f2)
 833         else:
 834             ext = os.path.splitext (f1)[1]
 835             klasses = {
 836                 '.midi': MidiFileLink,
 837                 '.log' : TextFileCompareLink,
 838                 '.profile': ProfileFileLink,
 839                 '.gittxt': GitFileCompareLink,
 840                 }
 841
 842             if klasses.has_key (ext):
 843                 self.compare_general_files (klasses[ext], f1, f2)
 844
 845     def compare_general_files (self, klass, f1, f2):
 846         name = os.path.split (f1)[1]
 847
 848         file_link = klass (f1, f2)
 849         self.file_links[name] = file_link
 850
 851     def compare_signature_files (self, f1, f2):
 852         name = os.path.split (f1)[1]
 853         name = re.sub ('-[0-9]+.signature', '', name)
 854
 855         file_link = None
 856         try:
 857             file_link = self.file_links[name]
 858         except KeyError:
 859             generic_f1 = re.sub ('-[0-9]+.signature', '.ly', f1)
 860             generic_f2 = re.sub ('-[0-9]+.signature', '.ly', f2)
 861             file_link = SignatureFileLink (generic_f1, generic_f2)
 862             self.file_links[name] = file_link
 863
 864         file_link.add_file_compare (f1, f2)
 865
 866     def write_changed (self, dest_dir, threshold):
 867         (changed, below, unchanged) = self.thresholded_results (threshold)
 868
 869         str = '\n'.join ([os.path.splitext (link.file_names[1])[0]
 870                         for link in changed])
 871         fn = dest_dir + '/changed.txt'
 872
 873         open_write_file (fn).write (str)
 874
 875     def thresholded_results (self, threshold):
 876         ## todo: support more scores.
 877         results = [(link.distance(), link)
 878                    for link in self.file_links.values ()]
 879         results.sort ()
 880         results.reverse ()
 881
 882         unchanged = [r for (d,r) in results if d == 0.0]
 883         below = [r for (d,r) in results if threshold >= d > 0.0]
 884         changed = [r for (d,r) in results if d > threshold]
 885
 886         return (changed, below, unchanged)
 887
 888     def write_text_result_page (self, filename, threshold):
 889         out = None
 890         if filename == '':
 891             out = sys.stdout
 892         else:
 893             print 'writing "%s"' % filename
 894             out = open_write_file (filename)
 895
 896         (changed, below, unchanged) = self.thresholded_results (threshold)
 897
 898
 899         for link in changed:
 900             out.write (link.text_record_string ())
 901
 902         out.write ('\n\n')
 903         out.write ('%d below threshold\n' % len (below))
 904         out.write ('%d unchanged\n' % len (unchanged))
 905
 906     def create_text_result_page (self, dir1, dir2, dest_dir, threshold):
 907         self.write_text_result_page (dest_dir + '/index.txt', threshold)
 908
 909     def create_html_result_page (self, dir1, dir2, dest_dir, threshold):
 910         dir1 = dir1.replace ('//', '/')
 911         dir2 = dir2.replace ('//', '/')
 912
 913         (changed, below, unchanged) = self.thresholded_results (threshold)
 914
 915
 916         html = ''
 917         old_prefix = os.path.split (dir1)[1]
 918         for link in changed:
 919             html += link.html_record_string (dest_dir)
 920
 921
 922         short_dir1 = shorten_string (dir1)
 923         short_dir2 = shorten_string (dir2)
 924         html = '''<html>
 925 <table rules="rows" border bordercolor="blue">
 926 <tr>
 927 <th>distance</th>
 928 <th>%(short_dir1)s</th>
 929 <th>%(short_dir2)s</th>
 930 </tr>
 931 %(html)s
 932 </table>
 933 </html>''' % locals()
 934
 935         html += ('<p>')
 936         below_count = len (below)
 937
 938         if below_count:
 939             html += ('<p>%d below threshold</p>' % below_count)
 940
 941         html += ('<p>%d unchanged</p>' % len (unchanged))
 942
 943         dest_file = dest_dir + '/index.html'
 944         open_write_file (dest_file).write (html)
 945
 946
 947         for link in changed:
 948             link.link_files_for_html (dest_dir)
 949
 950
 951     def print_results (self, threshold):
 952         self.write_text_result_page ('', threshold)
 953
 954 def compare_trees (dir1, dir2, dest_dir, threshold):
 955     data = ComparisonData ()
 956     data.compare_trees (dir1, dir2)
 957     data.read_sources ()
 958
 959
 960     data.print_results (threshold)
 961
 962     if os.path.isdir (dest_dir):
 963         system ('rm -rf %s '% dest_dir)
 964
 965     data.write_changed (dest_dir, threshold)
 966     data.create_html_result_page (dir1, dir2, dest_dir, threshold)
 967     data.create_text_result_page (dir1, dir2, dest_dir, threshold)
 968
 969 ################################################################
 970 # TESTING
 971
 972 def mkdir (x):
 973     if not os.path.isdir (x):
 974         print 'mkdir', x
 975         os.makedirs (x)
 976
 977 def link_file (x, y):
 978     mkdir (os.path.split (y)[0])
 979     try:
 980         print x, '->', y
 981         os.link (x, y)
 982     except OSError, z:
 983         print 'OSError', x, y, z
 984         raise OSError
 985
 986 def open_write_file (x):
 987     d = os.path.split (x)[0]
 988     mkdir (d)
 989     return open (x, 'w')
 990
 991
 992 def system (x):
 993
 994     print 'invoking', x
 995     stat = os.system (x)
 996     assert stat == 0
 997
 998
 999 def test_paired_files ():
1000     print paired_files (os.environ["HOME"] + "/src/lilypond/scripts/",
1001                         os.environ["HOME"] + "/src/lilypond-stable/buildscripts/", '*.py')
1002
1003
1004 def test_compare_trees ():
1005     system ('rm -rf dir1 dir2')
1006     system ('mkdir dir1 dir2')
1007     system ('cp 20{-*.signature,.ly,.png,.eps,.log,.profile} dir1')
1008     system ('cp 20{-*.signature,.ly,.png,.eps,.log,.profile} dir2')
1009     system ('cp 20expr{-*.signature,.ly,.png,.eps,.log,.profile} dir1')
1010     system ('cp 19{-*.signature,.ly,.png,.eps,.log,.profile} dir2/')
1011     system ('cp 19{-*.signature,.ly,.png,.eps,.log,.profile} dir1/')
1012     system ('cp 19-1.signature 19.sub-1.signature')
1013     system ('cp 19.ly 19.sub.ly')
1014     system ('cp 19.profile 19.sub.profile')
1015     system ('cp 19.log 19.sub.log')
1016     system ('cp 19.png 19.sub.png')
1017     system ('cp 19.eps 19.sub.eps')
1018
1019     system ('cp 20multipage* dir1')
1020     system ('cp 20multipage* dir2')
1021     system ('cp 19multipage-1.signature dir2/20multipage-1.signature')
1022
1023
1024     system ('mkdir -p dir1/subdir/ dir2/subdir/')
1025     system ('cp 19.sub{-*.signature,.ly,.png,.eps,.log,.profile} dir1/subdir/')
1026     system ('cp 19.sub{-*.signature,.ly,.png,.eps,.log,.profile} dir2/subdir/')
1027     system ('cp 20grob{-*.signature,.ly,.png,.eps,.log,.profile} dir2/')
1028     system ('cp 20grob{-*.signature,.ly,.png,.eps,.log,.profile} dir1/')
1029     system ('echo HEAD is 1 > dir1/tree.gittxt')
1030     system ('echo HEAD is 2 > dir2/tree.gittxt')
1031
1032     ## introduce differences
1033     system ('cp 19-1.signature dir2/20-1.signature')
1034     system ('cp 19.profile dir2/20.profile')
1035     system ('cp 19.png dir2/20.png')
1036     system ('cp 19multipage-page1.png dir2/20multipage-page1.png')
1037     system ('cp 20-1.signature dir2/subdir/19.sub-1.signature')
1038     system ('cp 20.png dir2/subdir/19.sub.png')
1039     system ("sed 's/: /: 1/g'  20.profile > dir2/subdir/19.sub.profile")
1040
1041     ## radical diffs.
1042     system ('cp 19-1.signature dir2/20grob-1.signature')
1043     system ('cp 19-1.signature dir2/20grob-2.signature')
1044     system ('cp 19multipage.midi dir1/midi-differ.midi')
1045     system ('cp 20multipage.midi dir2/midi-differ.midi')
1046     system ('cp 19multipage.log dir1/log-differ.log')
1047     system ('cp 19multipage.log dir2/log-differ.log &&  echo different >> dir2/log-differ.log &&  echo different >> dir2/log-differ.log')
1048
1049     compare_trees ('dir1', 'dir2', 'compare-dir1dir2', options.threshold)
1050
1051
1052 def test_basic_compare ():
1053     ly_template = r"""
1054
1055 \version "2.10.0"
1056 #(define default-toplevel-book-handler
1057   print-book-with-defaults-as-systems )
1058
1059 #(ly:set-option (quote no-point-and-click))
1060
1061 \sourcefilename "my-source.ly"
1062
1063 %(papermod)s
1064 \header { tagline = ##f }
1065 \score {
1066 <<
1067 \new Staff \relative c {
1068   c4^"%(userstring)s" %(extragrob)s
1069   }
1070 \new Staff \relative c {
1071   c4^"%(userstring)s" %(extragrob)s
1072   }
1073 >>
1074 \layout{}
1075 }
1076
1077 """
1078
1079     dicts = [{ 'papermod' : '',
1080                'name' : '20',
1081                'extragrob': '',
1082                'userstring': 'test' },
1083              { 'papermod' : '#(set-global-staff-size 19.5)',
1084                'name' : '19',
1085                'extragrob': '',
1086                'userstring': 'test' },
1087              { 'papermod' : '',
1088                'name' : '20expr',
1089                'extragrob': '',
1090                'userstring': 'blabla' },
1091              { 'papermod' : '',
1092                'name' : '20grob',
1093                'extragrob': 'r2. \\break c1',
1094                'userstring': 'test' },
1095              ]
1096
1097     for d in dicts:
1098         open (d['name'] + '.ly','w').write (ly_template % d)
1099
1100     names = [d['name'] for d in dicts]
1101
1102     system ('lilypond -ddump-profile -dseparate-log-files -ddump-signatures --png -b eps ' + ' '.join (names))
1103
1104
1105     multipage_str = r'''
1106     #(set-default-paper-size "a6")
1107     \score {
1108       \relative {c1 \pageBreak c1 }
1109       \layout {}
1110       \midi {}
1111     }
1112     '''
1113
1114     open ('20multipage.ly', 'w').write (multipage_str.replace ('c1', 'd1'))
1115     open ('19multipage.ly', 'w').write ('#(set-global-staff-size 19.5)\n' + multipage_str)
1116     system ('lilypond -dseparate-log-files -ddump-signatures --png 19multipage 20multipage ')
1117
1118     test_compare_signatures (names)
1119
1120 def test_compare_signatures (names, timing=False):
1121
1122     import time
1123
1124     times = 1
1125     if timing:
1126         times = 100
1127
1128     t0 = time.clock ()
1129
1130     count = 0
1131     for t in range (0, times):
1132         sigs = dict ((n, read_signature_file ('%s-1.signature' % n)) for n in names)
1133         count += 1
1134
1135     if timing:
1136         print 'elapsed', (time.clock() - t0)/count
1137
1138
1139     t0 = time.clock ()
1140     count = 0
1141     combinations = {}
1142     for (n1, s1) in sigs.items():
1143         for (n2, s2) in sigs.items():
1144             combinations['%s-%s' % (n1, n2)] = SystemLink (s1,s2).distance ()
1145             count += 1
1146
1147     if timing:
1148         print 'elapsed', (time.clock() - t0)/count
1149
1150     results = combinations.items ()
1151     results.sort ()
1152     for k,v in results:
1153         print '%-20s' % k, v
1154
1155     assert combinations['20-20'] == (0.0,0.0,0.0)
1156     assert combinations['20-20expr'][0] > 0.0
1157     assert combinations['20-19'][2] < 10.0
1158     assert combinations['20-19'][2] > 0.0
1159
1160
1161 def run_tests ():
1162     dir = 'test-output-distance'
1163
1164     do_clean = not os.path.exists (dir)
1165
1166     print 'test results in ', dir
1167     if do_clean:
1168         system ('rm -rf ' + dir)
1169         system ('mkdir ' + dir)
1170
1171     os.chdir (dir)
1172     if do_clean:
1173         test_basic_compare ()
1174
1175     test_compare_trees ()
1176
1177 ################################################################
1178 #
1179
1180 def main ():
1181     p = optparse.OptionParser ("output-distance - compare LilyPond formatting runs")
1182     p.usage = 'output-distance.py [options] tree1 tree2'
1183
1184     p.add_option ('', '--test-self',
1185                   dest="run_test",
1186                   action="store_true",
1187                   help='run test method')
1188
1189     p.add_option ('--max-count',
1190                   dest="max_count",
1191                   metavar="COUNT",
1192                   type="int",
1193                   default=0,
1194                   action="store",
1195                   help='only analyze COUNT signature pairs')
1196
1197     p.add_option ('', '--threshold',
1198                   dest="threshold",
1199                   default=0.3,
1200                   action="store",
1201                   type="float",
1202                   help='threshold for geometric distance')
1203
1204     p.add_option ('--no-compare-images',
1205                   dest="compare_images",
1206                   default=True,
1207                   action="store_false",
1208                   help="Don't run graphical comparisons")
1209
1210     p.add_option ('--create-images',
1211                   dest="create_images",
1212                   default=False,
1213                   action="store_true",
1214                   help="Create PNGs from EPSes")
1215
1216     p.add_option ('-o', '--output-dir',
1217                   dest="output_dir",
1218                   default=None,
1219                   action="store",
1220                   type="string",
1221                   help='where to put the test results [tree2/compare-tree1tree2]')
1222
1223     global options
1224     (options, a) = p.parse_args ()
1225
1226     if options.run_test:
1227         run_tests ()
1228         sys.exit (0)
1229
1230     if len (a) != 2:
1231         p.print_usage()
1232         sys.exit (2)
1233
1234     name = options.output_dir
1235     if not name:
1236         name = a[0].replace ('/', '')
1237         name = os.path.join (a[1], 'compare-' + shorten_string (name))
1238
1239     compare_trees (a[0], a[1], name, options.threshold)
1240
1241 if __name__ == '__main__':
1242     main()
1243