clang/www/make_cxx_dr_status

   1 #! /usr/bin/env python3
   2 import sys, os, re, urllib.request
   3
   4
   5 clang_www_dir = os.path.dirname(__file__)
   6 default_issue_list_path = os.path.join(clang_www_dir, 'cwg_index.html')
   7 issue_list_url = "https://www.open-std.org/jtc1/sc22/wg21/docs/cwg_index.html"
   8 output = os.path.join(clang_www_dir, 'cxx_dr_status.html')
   9 dr_test_dir = os.path.join(clang_www_dir, '../test/CXX/drs')
  10
  11 class DR:
  12   def __init__(self, section, issue, url, status, title):
  13     self.section, self.issue, self.url, self.status, self.title = \
  14         section, issue, url, status, title
  15   def __repr__(self):
  16     return '%s (%s): %s' % (self.issue, self.status, self.title)
  17
  18 def parse(dr):
  19   try:
  20     section, issue_link, status, liaison, title = [
  21         col.split('>', 1)[1].split('</TD>')[0]
  22         for col in dr.split('</TR>', 1)[0].split('<TD')[1:]
  23     ]
  24   except Exception as ex:
  25     print(f"Parse error: {ex}\n{dr}", file=sys.stderr)
  26     sys.exit(1)
  27   _, url, issue = issue_link.split('"', 2)
  28   url = url.strip()
  29   issue = int(issue.split('>', 1)[1].split('<', 1)[0])
  30   title = title.replace('<issue_title>', '').replace('</issue_title>', '').replace('\r\n', '\n').strip()
  31   return DR(section, issue, url, status, title)
  32
  33 def collect_tests():
  34   status_re = re.compile(r'\bdr([0-9]+): (.*)')
  35   status_map = {}
  36   for test_cpp in os.listdir(dr_test_dir):
  37     if not test_cpp.endswith('.cpp'):
  38       continue
  39     test_cpp = os.path.join(dr_test_dir, test_cpp)
  40     found_any = False;
  41     for match in re.finditer(status_re, open(test_cpp, 'r').read()):
  42       dr_number = int(match.group(1))
  43       if dr_number in status_map:
  44         print("error: Comment for dr{} encountered more than once. Duplicate found in {}".format(dr_number, test_cpp))
  45         sys.exit(1)
  46       status_map[dr_number] = match.group(2)
  47       found_any = True
  48     if not found_any:
  49       print("warning:%s: no '// dr123: foo' comments in this file" % test_cpp, file=sys.stderr)
  50   return status_map
  51
  52 def get_issues(path):
  53   buffer = None
  54   if not path and os.path.exists(default_issue_list_path):
  55     path = default_issue_list_path
  56   try:
  57     if path is None:
  58       print('Fetching issue list from {}'.format(issue_list_url))
  59       with urllib.request.urlopen(issue_list_url) as f:
  60         buffer = f.read().decode('utf-8')
  61     else:
  62       print('Opening issue list from file {}'.format(path))
  63       with open(path, 'r') as f:
  64         buffer = f.read()
  65   except Exception as ex:
  66      print('Unable to read the core issue list', file=sys.stderr)
  67      print(ex, file=sys.stderr)
  68      sys.exit(1)
  69
  70   return sorted((parse(dr) for dr in buffer.split('<TR>')[2:]),
  71                 key = lambda dr: dr.issue)
  72
  73
  74 issue_list_path  = None
  75 if len(sys.argv) == 1:
  76   pass
  77 elif len(sys.argv) == 2:
  78   issue_list_path = sys.argv[1]
  79 else:
  80   print('Usage: {} [<path to cwg_index.html>]'.format(sys.argv[0]), file=sys.stderr)
  81   sys.exit(1)
  82
  83 status_map = collect_tests()
  84 drs = get_issues(issue_list_path)
  85 out_file = open(output, 'w')
  86 out_file.write('''\
  87 <!DOCTYPE html>
  88 <!-- This file is auto-generated by make_cxx_dr_status. Do not modify. -->
  89 <html>
  90 <head>
  91   <META http-equiv="Content-Type" content="text/html; charset=utf-8">
  92   <title>Clang - C++ Defect Report Status</title>
  93   <link type="text/css" rel="stylesheet" href="menu.css">
  94   <link type="text/css" rel="stylesheet" href="content.css">
  95   <style type="text/css">
  96     .none { background-color: #FFCCCC }
  97     .partial { background-color: #FFE0B0 }
  98     .unreleased { background-color: #FFFF99 }
  99     .full { background-color: #CCFF99 }
 100     .na { background-color: #DDDDDD }
 101     .open * { color: #AAAAAA }
 102     //.open { filter: opacity(0.2) }
 103     tr:target { background-color: #FFFFBB }
 104     th { background-color: #FFDDAA }
 105   </style>
 106 </head>
 107 <body>
 108
 109 <!--#include virtual="menu.html.incl"-->
 110
 111 <div id="content">
 112
 113 <!--*************************************************************************-->
 114 <h1>C++ Defect Report Support in Clang</h1>
 115 <!--*************************************************************************-->
 116
 117 <h2 id="cxxdr">C++ defect report implementation status</h2>
 118
 119 <p>This page tracks which C++ defect reports are implemented within Clang.</p>
 120
 121 <table width="689" border="1" cellspacing="0">
 122   <tr>
 123     <th>Number</th>
 124     <th>Status</th>
 125     <th>Issue title</th>
 126     <th>Available in Clang?</th>
 127   </tr>''')
 128
 129 latest_release = 17
 130
 131 def availability(issue):
 132   status = status_map.get(issue, 'unknown')
 133
 134   unresolved_status = ''
 135   if status.endswith(' open'):
 136     status = status[:-5]
 137     unresolved_status = 'open'
 138   elif status.endswith(' drafting'):
 139     status = status[:-9]
 140     unresolved_status = 'drafting'
 141   elif status.endswith(' review'):
 142     status = status[:-7]
 143     unresolved_status = 'review'
 144
 145   avail_suffix = ''
 146   if status.endswith(' c++11'):
 147     status = status[:-6]
 148     avail_suffix = ' (C++11 onwards)'
 149   elif status.endswith(' c++14'):
 150     status = status[:-6]
 151     avail_suffix = ' (C++14 onwards)'
 152   elif status.endswith(' c++17'):
 153     status = status[:-6]
 154     avail_suffix = ' (C++17 onwards)'
 155   elif status.endswith(' c++20'):
 156     status = status[:-6]
 157     avail_suffix = ' (C++20 onwards)'
 158   if status == 'unknown':
 159     avail = 'Unknown'
 160     avail_style = ' class="none"'
 161   elif re.match('^[0-9]+\.?[0-9]*', status):
 162     avail = 'Clang %s' % status
 163     if float(status) > latest_release:
 164       avail_style = ' class="unreleased"'
 165     else:
 166       avail_style = ' class="full"'
 167   elif status == 'yes':
 168     avail = 'Yes'
 169     avail_style = ' class="full"'
 170   elif status == 'partial':
 171     avail = 'Partial'
 172     avail_style = ' class="partial"'
 173   elif status == 'no':
 174     avail = 'No'
 175     avail_style = ' class="none"'
 176   elif status == 'na':
 177     avail = 'N/A'
 178     avail_style = ' class="na"'
 179   elif status == 'na lib':
 180     avail = 'N/A (Library DR)'
 181     avail_style = ' class="na"'
 182   elif status == 'na abi':
 183     avail = 'N/A (ABI constraint)'
 184     avail_style = ' class="na"'
 185   elif status.startswith('sup '):
 186     dup = status.split(' ', 1)[1]
 187     if dup.startswith('P'):
 188       avail = 'Superseded by <a href="https://wg21.link/%s">%s</a>' % (dup, dup)
 189       avail_style = ' class="na"'
 190     else:
 191       avail = 'Superseded by <a href="#%s">%s</a>' % (dup, dup)
 192       try:
 193         _, avail_style, _ = availability(int(dup))
 194       except:
 195         print("issue %s marked as sup %s" % (issue, dup), file=sys.stderr)
 196         avail_style = ' class="none"'
 197   elif status.startswith('dup '):
 198     dup = int(status.split(' ', 1)[1])
 199     avail = 'Duplicate of <a href="#%s">%s</a>' % (dup, dup)
 200     _, avail_style, _ = availability(dup)
 201   else:
 202     assert False, 'unknown status %s for issue %s' % (status, dr.issue)
 203   return (avail + avail_suffix, avail_style, unresolved_status)
 204
 205 count = {}
 206 for dr in drs:
 207   if dr.status in ('concepts',):
 208     # This refers to the old ("C++0x") concepts feature, which was not part
 209     # of any C++ International Standard or Technical Specification.
 210     continue
 211
 212   elif dr.status == 'extension':
 213     row_style = ' class="open"'
 214     avail = 'Extension'
 215     avail_style = ''
 216
 217   elif dr.status in ('open', 'drafting', 'review'):
 218     row_style = ' class="open"'
 219     avail, avail_style, unresolved_status = availability(dr.issue)
 220     if avail == 'Unknown':
 221       avail = 'Not resolved'
 222       avail_style = ''
 223     else:
 224       assert unresolved_status == dr.status, \
 225              "Issue %s is marked '%s', which differs from CWG index status '%s'" \
 226              % (dr.issue, unresolved_status, dr.status)
 227   else:
 228     row_style = ''
 229     avail, avail_style, unresolved_status = availability(dr.issue)
 230     assert not unresolved_status, \
 231            "Issue %s is marked '%s', even though it is resolved in CWG index" \
 232            % (dr.issue, unresolved_status)
 233
 234   if not avail.startswith('Sup') and not avail.startswith('Dup'):
 235     count[avail] = count.get(avail, 0) + 1
 236
 237   out_file.write('''
 238   <tr%s id="%s">
 239     <td><a href="https://cplusplus.github.io/CWG/issues/%s.html">%s</a></td>
 240     <td>%s</td>
 241     <td>%s</td>
 242     <td%s align="center">%s</td>
 243   </tr>''' % (row_style, dr.issue, dr.issue, dr.issue, dr.status, dr.title, avail_style, avail))
 244
 245 for status, num in sorted(count.items()):
 246   print("%s: %s" % (status, num), file=sys.stderr)
 247
 248 out_file.write('''\
 249 </table>
 250
 251 </div>
 252 </body>
 253 </html>
 254 ''')
 255 out_file.close()
 256