blob: ec266c5345cfb73540f3847e4ebd2b72918ca054 [file] [log] [blame]
Tobin Ehlis5ade0692016-10-05 17:18:15 -06001#!/usr/bin/python3 -i
2
3import sys
4import xml.etree.ElementTree as etree
5import urllib2
Tobin Ehlis5ade0692016-10-05 17:18:15 -06006
7#############################
8# spec.py script
9#
10# Overview - this script is intended to generate validation error codes and message strings from the xhtml version of
11# the specification. In addition to generating the header file, it provides a number of corrollary services to aid in
12# generating/updating the header.
13#
14# Ideal flow - Not there currently, but the ideal flow for this script would be that you run the script, it pulls the
15# latest spec, compares it to the current set of generated error codes, and makes any updates as needed
16#
17# Current flow - the current flow acheives all of the ideal flow goals, but with more steps than are desired
18# 1. Get the spec - right now spec has to be manually generated or pulled from the web
19# 2. Generate header from spec - This is done in a single command line
20# 3. Generate database file from spec - Can be done along with step #2 above, the database file contains a list of
21# all error enums and message strings, along with some other info on if those errors are implemented/tested
22# 4. Update header using a given database file as the root and a new spec file as goal - This makes sure that existing
23# errors keep the same enum identifier while also making sure that new errors get a unique_id that continues on
24# from the end of the previous highest unique_id.
25#
26# TODO:
27# 1. Improve string matching to add more automation for figuring out which messages are changed vs. completely new
28#
29#
30#############################
31
32
33spec_filename = "vkspec.html" # can override w/ '-spec <filename>' option
34out_filename = "vk_validation_error_messages.h" # can override w/ '-out <filename>' option
35db_filename = "vk_validation_error_database.txt" # can override w/ '-gendb <filename>' option
36gen_db = False # set to True when '-gendb <filename>' option provided
37spec_compare = False # set to True with '-compare <db_filename>' option
38# This is the root spec link that is used in error messages to point users to spec sections
Tobin Ehlisbd0a9c62016-10-14 18:06:16 -060039#old_spec_url = "https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html"
40spec_url = "https://www.khronos.org/registry/vulkan/specs/1.0-extensions/xhtml/vkspec.html"
Tobin Ehlis5ade0692016-10-05 17:18:15 -060041# After the custom validation error message, this is the prefix for the standard message that includes the
42# spec valid usage language as well as the link to nearest section of spec to that language
43error_msg_prefix = "For more information refer to Vulkan Spec Section "
44ns = {'ns': 'http://www.w3.org/1999/xhtml'}
Mark Lobodzinski629d47b2016-10-18 13:34:58 -060045validation_error_enum_name = "VALIDATION_ERROR_"
Tobin Ehlis5ade0692016-10-05 17:18:15 -060046# Dict of new enum values that should be forced to remap to old handles, explicitly set by -remap option
47remap_dict = {}
48
49def printHelp():
50 print "Usage: python spec.py [-spec <specfile.html>] [-out <headerfile.h>] [-gendb <databasefile.txt>] [-compare <databasefile.txt>] [-update] [-remap <new_id-old_id,count>] [-help]"
51 print "\n Default script behavior is to parse the specfile and generate a header of unique error enums and corresponding error messages based on the specfile.\n"
52 print " Default specfile is from online at %s" % (spec_url)
53 print " Default headerfile is %s" % (out_filename)
54 print " Default databasefile is %s" % (db_filename)
55 print "\nIf '-gendb' option is specified then a database file is generated to default file or <databasefile.txt> if supplied. The database file stores"
56 print " the list of enums and their error messages."
57 print "\nIf '-compare' option is specified then the given database file will be read in as the baseline for generating the new specfile"
58 print "\nIf '-update' option is specified this triggers the master flow to automate updating header and database files using default db file as baseline"
59 print " and online spec file as the latest. The default header and database files will be updated in-place for review and commit to the git repo."
60 print "\nIf '-remap' option is specified it supplies forced remapping from new enum ids to old enum ids. This should only be specified along with -update"
61 print " option. Starting at newid and remapping to oldid, count ids will be remapped. Default count is '1' and use ':' to specify multiple remappings."
62
63class Specification:
64 def __init__(self):
65 self.tree = None
66 self.val_error_dict = {} # string for enum is key that references text for output message
67 self.error_db_dict = {} # dict of previous error values read in from database file
68 self.delimiter = '~^~' # delimiter for db file
69 self.copyright = """/* THIS FILE IS GENERATED. DO NOT EDIT. */
70
71/*
72 * Vulkan
73 *
74 * Copyright (c) 2016 Google Inc.
Mark Lobodzinski629d47b2016-10-18 13:34:58 -060075 * Copyright (c) 2016 LunarG, Inc.
Tobin Ehlis5ade0692016-10-05 17:18:15 -060076 *
77 * Licensed under the Apache License, Version 2.0 (the "License");
78 * you may not use this file except in compliance with the License.
79 * You may obtain a copy of the License at
80 *
81 * http://www.apache.org/licenses/LICENSE-2.0
82 *
83 * Unless required by applicable law or agreed to in writing, software
84 * distributed under the License is distributed on an "AS IS" BASIS,
85 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
86 * See the License for the specific language governing permissions and
87 * limitations under the License.
88 *
89 * Author: Tobin Ehlis <tobine@google.com>
90 */"""
91 def _checkInternetSpec(self):
92 """Verify that we can access the spec online"""
93 try:
94 online = urllib2.urlopen(spec_url,timeout=1)
95 return True
96 except urllib2.URLError as err:
97 return False
98 return False
99 def loadFile(self, online=True, spec_file=spec_filename):
100 """Load an API registry XML file into a Registry object and parse it"""
101 # Check if spec URL is available
102 if (online and self._checkInternetSpec()):
103 print "Using spec from online at %s" % (spec_url)
104 self.tree = etree.parse(urllib2.urlopen(spec_url))
105 else:
106 print "Using local spec %s" % (spec_file)
107 self.tree = etree.parse(spec_file)
108 #self.tree.write("tree_output.xhtml")
109 #self.tree = etree.parse("tree_output.xhtml")
110 self.parseTree()
111 def updateDict(self, updated_dict):
112 """Assign internal dict to use updated_dict"""
113 self.val_error_dict = updated_dict
114 def parseTree(self):
115 """Parse the registry Element, once created"""
116 print "Parsing spec file..."
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600117 unique_enum_id = 0
118 self.root = self.tree.getroot()
119 #print "ROOT: %s" % self.root
120 prev_heading = '' # Last seen section heading or sub-heading
121 prev_link = '' # Last seen link id within the spec
Tobin Ehlis85008cd2016-10-19 15:32:35 -0600122 error_strings = set() # Flag any exact duplicate error strings and skip them
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600123 for tag in self.root.iter(): # iterate down tree
124 # Grab most recent section heading and link
125 if tag.tag in ['{http://www.w3.org/1999/xhtml}h2', '{http://www.w3.org/1999/xhtml}h3']:
126 if tag.get('class') != 'title':
127 continue
128 #print "Found heading %s" % (tag.tag)
129 prev_heading = "".join(tag.itertext())
130 # Insert a space between heading number & title
131 sh_list = prev_heading.rsplit('.', 1)
132 prev_heading = '. '.join(sh_list)
133 prev_link = tag[0].get('id')
134 #print "Set prev_heading %s to have link of %s" % (prev_heading.encode("ascii", "ignore"), prev_link.encode("ascii", "ignore"))
135 elif tag.tag == '{http://www.w3.org/1999/xhtml}a': # grab any intermediate links
136 if tag.get('id') != None:
137 prev_link = tag.get('id')
Tobin Ehlis16b159c2016-10-25 06:33:27 -0600138 #print "Updated prev link to %s" % (prev_link)
Tobin Ehlis69ebddf2016-10-18 15:55:07 -0600139 elif tag.tag == '{http://www.w3.org/1999/xhtml}div' and tag.get('class') == 'sidebar':
140 # parse down sidebar to check for valid usage cases
141 valid_usage = False
142 for elem in tag.iter():
143 if elem.tag == '{http://www.w3.org/1999/xhtml}strong' and None != elem.text and 'Valid Usage' in elem.text:
144 valid_usage = True
145 elif valid_usage and elem.tag == '{http://www.w3.org/1999/xhtml}li': # grab actual valid usage requirements
146 error_msg_str = "%s '%s' which states '%s' (%s#%s)" % (error_msg_prefix, prev_heading, "".join(elem.itertext()).replace('\n', ''), spec_url, prev_link)
147 # Some txt has multiple spaces so split on whitespace and join w/ single space
148 error_msg_str = " ".join(error_msg_str.split())
Tobin Ehlis85008cd2016-10-19 15:32:35 -0600149 if error_msg_str in error_strings:
150 print "WARNING: SKIPPING adding repeat entry for string. Please review spec and file issue as appropriate. Repeat string is: %s" % (error_msg_str)
151 else:
152 error_strings.add(error_msg_str)
153 enum_str = "%s%05d" % (validation_error_enum_name, unique_enum_id)
154 # TODO : '\' chars in spec error messages are most likely bad spec txt that needs to be updated
155 self.val_error_dict[enum_str] = error_msg_str.encode("ascii", "ignore").replace("\\", "/")
156 unique_enum_id = unique_enum_id + 1
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600157 #print "Validation Error Dict has a total of %d unique errors and contents are:\n%s" % (unique_enum_id, self.val_error_dict)
158 def genHeader(self, header_file):
159 """Generate a header file based on the contents of a parsed spec"""
160 print "Generating header %s..." % (header_file)
161 file_contents = []
162 file_contents.append(self.copyright)
163 file_contents.append('\n#pragma once')
Tobin Ehlisbf98b692016-10-06 12:58:06 -0600164 file_contents.append('#include <unordered_map>')
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600165 file_contents.append('\n// enum values for unique validation error codes')
166 file_contents.append('// Corresponding validation error message for each enum is given in the mapping table below')
167 file_contents.append('// When a given error occurs, these enum values should be passed to the as the messageCode')
168 file_contents.append('// parameter to the PFN_vkDebugReportCallbackEXT function')
169 enum_decl = ['enum UNIQUE_VALIDATION_ERROR_CODE {']
Tobin Ehlisbf98b692016-10-06 12:58:06 -0600170 error_string_map = ['static std::unordered_map<int, char const *const> validation_error_map{']
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600171 for enum in sorted(self.val_error_dict):
172 #print "Header enum is %s" % (enum)
173 enum_decl.append(' %s = %d,' % (enum, int(enum.split('_')[-1])))
174 error_string_map.append(' {%s, "%s"},' % (enum, self.val_error_dict[enum]))
Mark Lobodzinski629d47b2016-10-18 13:34:58 -0600175 enum_decl.append(' %sMAX_ENUM = %d,' % (validation_error_enum_name, int(enum.split('_')[-1]) + 1))
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600176 enum_decl.append('};')
177 error_string_map.append('};')
178 file_contents.extend(enum_decl)
179 file_contents.append('\n// Mapping from unique validation error enum to the corresponding error message')
180 file_contents.append('// The error message should be appended to the end of a custom error message that is passed')
181 file_contents.append('// as the pMessage parameter to the PFN_vkDebugReportCallbackEXT function')
182 file_contents.extend(error_string_map)
183 #print "File contents: %s" % (file_contents)
184 with open(header_file, "w") as outfile:
185 outfile.write("\n".join(file_contents))
186 def analyze(self):
187 """Print out some stats on the valid usage dict"""
188 # Create dict for # of occurences of identical strings
189 str_count_dict = {}
190 unique_id_count = 0
191 for enum in self.val_error_dict:
192 err_str = self.val_error_dict[enum]
193 if err_str in str_count_dict:
Tobin Ehlis69ebddf2016-10-18 15:55:07 -0600194 print "Found repeat error string"
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600195 str_count_dict[err_str] = str_count_dict[err_str] + 1
196 else:
197 str_count_dict[err_str] = 1
198 unique_id_count = unique_id_count + 1
199 print "Processed %d unique_ids" % (unique_id_count)
200 repeat_string = 0
201 for es in str_count_dict:
202 if str_count_dict[es] > 1:
203 repeat_string = repeat_string + 1
Tobin Ehlis69ebddf2016-10-18 15:55:07 -0600204 print "String '%s' repeated %d times" % (es, repeat_string)
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600205 print "Found %d repeat strings" % (repeat_string)
206 def genDB(self, db_file):
207 """Generate a database of check_enum, check_coded?, testname, error_string"""
208 db_lines = []
209 # Write header for database file
210 db_lines.append("# This is a database file with validation error check information")
211 db_lines.append("# Comments are denoted with '#' char")
212 db_lines.append("# The format of the lines is:")
213 db_lines.append("# <error_enum>%s<check_implemented>%s<testname>%s<errormsg>" % (self.delimiter, self.delimiter, self.delimiter))
Mark Lobodzinski629d47b2016-10-18 13:34:58 -0600214 db_lines.append("# error_enum: Unique error enum for this check of format %s<uniqueid>" % validation_error_enum_name)
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600215 db_lines.append("# check_implemented: 'Y' if check has been implemented in layers, 'U' for unknown, or 'N' for not implemented")
216 db_lines.append("# testname: Name of validation test for this check, 'Unknown' for unknown, or 'None' if not implmented")
217 db_lines.append("# errormsg: The unique error message for this check that includes spec language and link")
218 for enum in sorted(self.val_error_dict):
219 # Default to unknown if check or test are implemented, then update below if appropriate
220 implemented = 'U'
221 testname = 'Unknown'
222 # If we have an existing db entry for this enum, use its implemented/testname values
223 if enum in self.error_db_dict:
224 implemented = self.error_db_dict[enum]['check_implemented']
225 testname = self.error_db_dict[enum]['testname']
226 #print "delimiter: %s, id: %s, str: %s" % (self.delimiter, enum, self.val_error_dict[enum])
227 # No existing entry so default to N for implemented and None for testname
228 db_lines.append("%s%s%s%s%s%s%s" % (enum, self.delimiter, implemented, self.delimiter, testname, self.delimiter, self.val_error_dict[enum]))
229 print "Generating database file %s" % (db_file)
230 with open(db_file, "w") as outfile:
231 outfile.write("\n".join(db_lines))
232 def readDB(self, db_file):
233 """Read a db file into a dict, format of each line is <enum><implemented Y|N?><testname><errormsg>"""
234 db_dict = {} # This is a simple db of just enum->errormsg, the same as is created from spec
235 max_id = 0
236 with open(db_file, "r") as infile:
237 for line in infile:
238 if line.startswith('#'):
239 continue
240 line = line.strip()
241 db_line = line.split(self.delimiter)
Tobin Ehlis802b16e2016-10-11 09:37:19 -0600242 if len(db_line) != 4:
243 print "ERROR: Bad database line doesn't have 4 elements: %s" % (line)
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600244 error_enum = db_line[0]
245 implemented = db_line[1]
246 testname = db_line[2]
247 error_str = db_line[3]
248 db_dict[error_enum] = error_str
249 # Also read complete database contents into our class var for later use
250 self.error_db_dict[error_enum] = {}
251 self.error_db_dict[error_enum]['check_implemented'] = implemented
252 self.error_db_dict[error_enum]['testname'] = testname
253 self.error_db_dict[error_enum]['error_string'] = error_str
254 unique_id = int(db_line[0].split('_')[-1])
255 if unique_id > max_id:
256 max_id = unique_id
257 return (db_dict, max_id)
258 # Compare unique ids from original database to data generated from updated spec
259 # 1. If a new id and error code exactly match original, great
260 # 2. If new id is not in original, but exact error code is, need to use original error code
261 # 3. If new id and new error are not in original, make sure new id picks up from end of original list
262 # 4. If new id in original, but error strings don't match then:
263 # 4a. If error string has exact match in original, update new to use original
264 # 4b. If error string not in original, may be updated error message, manually address
265 def compareDB(self, orig_db_dict, max_id):
266 """Compare orig database dict to new dict, report out findings, and return potential new dict for parsed spec"""
267 # First create reverse dicts of err_strings to IDs
268 next_id = max_id + 1
269 orig_err_to_id_dict = {}
270 # Create an updated dict in-place that will be assigned to self.val_error_dict when done
271 updated_val_error_dict = {}
272 for enum in orig_db_dict:
273 orig_err_to_id_dict[orig_db_dict[enum]] = enum
274 new_err_to_id_dict = {}
275 for enum in self.val_error_dict:
276 new_err_to_id_dict[self.val_error_dict[enum]] = enum
277 ids_parsed = 0
278 # Now parse through new dict and figure out what to do with non-matching things
279 for enum in sorted(self.val_error_dict):
280 ids_parsed = ids_parsed + 1
281 enum_list = enum.split('_') # grab sections of enum for use below
Tobin Ehlisbd0a9c62016-10-14 18:06:16 -0600282 # Any user-forced remap takes precendence
283 if enum_list[-1] in remap_dict:
284 enum_list[-1] = remap_dict[enum_list[-1]]
285 new_enum = "_".join(enum_list)
286 print "NOTE: Using user-supplied remap to force %s to be %s" % (enum, new_enum)
287 updated_val_error_dict[new_enum] = self.val_error_dict[enum]
288 elif enum in orig_db_dict:
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600289 if self.val_error_dict[enum] == orig_db_dict[enum]:
Tobin Ehlisbd0a9c62016-10-14 18:06:16 -0600290 print "Exact match for enum %s" % (enum)
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600291 # Nothing to see here
292 if enum in updated_val_error_dict:
293 print "ERROR: About to overwrite entry for %s" % (enum)
294 updated_val_error_dict[enum] = self.val_error_dict[enum]
295 elif self.val_error_dict[enum] in orig_err_to_id_dict:
296 # Same value w/ different error id, need to anchor to original id
Tobin Ehlisbd0a9c62016-10-14 18:06:16 -0600297 print "Need to switch new id %s to original id %s" % (enum, orig_err_to_id_dict[self.val_error_dict[enum]])
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600298 # Update id at end of new enum to be same id from original enum
299 enum_list[-1] = orig_err_to_id_dict[self.val_error_dict[enum]].split('_')[-1]
300 new_enum = "_".join(enum_list)
301 if new_enum in updated_val_error_dict:
302 print "ERROR: About to overwrite entry for %s" % (new_enum)
303 updated_val_error_dict[new_enum] = self.val_error_dict[enum]
304 else:
305 # No error match:
306 # First check if only link has changed, in which case keep ID but update message
307 orig_msg_list = orig_db_dict[enum].split('(', 1)
308 new_msg_list = self.val_error_dict[enum].split('(', 1)
309 if orig_msg_list[0] == new_msg_list[0]: # Msg is same bug link has changed, keep enum & update msg
310 print "NOTE: Found that only spec link changed for %s so keeping same id w/ new link" % (enum)
311 updated_val_error_dict[enum] = self.val_error_dict[enum]
Tobin Ehlisbd0a9c62016-10-14 18:06:16 -0600312 # This seems to be a new error so need to pick it up from end of original unique ids & flag for review
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600313 else:
314 enum_list[-1] = "%05d" % (next_id)
315 new_enum = "_".join(enum_list)
316 next_id = next_id + 1
317 print "MANUALLY VERIFY: Updated new enum %s to be unique %s. Make sure new error msg is actually unique and not just changed" % (enum, new_enum)
318 print " New error string: %s" % (self.val_error_dict[enum])
319 if new_enum in updated_val_error_dict:
320 print "ERROR: About to overwrite entry for %s" % (new_enum)
321 updated_val_error_dict[new_enum] = self.val_error_dict[enum]
322 else: # new enum is not in orig db
323 if self.val_error_dict[enum] in orig_err_to_id_dict:
Tobin Ehlisbd0a9c62016-10-14 18:06:16 -0600324 print "New enum %s not in orig dict, but exact error message matches original unique id %s" % (enum, orig_err_to_id_dict[self.val_error_dict[enum]])
Tobin Ehlis5ade0692016-10-05 17:18:15 -0600325 # Update new unique_id to use original
326 enum_list[-1] = orig_err_to_id_dict[self.val_error_dict[enum]].split('_')[-1]
327 new_enum = "_".join(enum_list)
328 if new_enum in updated_val_error_dict:
329 print "ERROR: About to overwrite entry for %s" % (new_enum)
330 updated_val_error_dict[new_enum] = self.val_error_dict[enum]
331 else:
332 enum_list[-1] = "%05d" % (next_id)
333 new_enum = "_".join(enum_list)
334 next_id = next_id + 1
335 print "Completely new id and error code, update new id from %s to unique %s" % (enum, new_enum)
336 if new_enum in updated_val_error_dict:
337 print "ERROR: About to overwrite entry for %s" % (new_enum)
338 updated_val_error_dict[new_enum] = self.val_error_dict[enum]
339 # Assign parsed dict to be the udpated dict based on db compare
340 print "In compareDB parsed %d entries" % (ids_parsed)
341 return updated_val_error_dict
342 def validateUpdateDict(self, update_dict):
343 """Compare original dict vs. update dict and make sure that all of the checks are still there"""
344 # Currently just make sure that the same # of checks as the original checks are there
345 #orig_ids = {}
346 orig_id_count = len(self.val_error_dict)
347 #update_ids = {}
348 update_id_count = len(update_dict)
349 if orig_id_count != update_id_count:
350 print "Original dict had %d unique_ids, but updated dict has %d!" % (orig_id_count, update_id_count)
351 return False
352 print "Original dict and updated dict both have %d unique_ids. Great!" % (orig_id_count)
353 return True
354 # TODO : include some more analysis
355
356# User passes in arg of form <new_id1>-<old_id1>[,count1]:<new_id2>-<old_id2>[,count2]:...
357# new_id# = the new enum id that was assigned to an error
358# old_id# = the previous enum id that was assigned to the same error
359# [,count#] = The number of ids to remap starting at new_id#=old_id# and ending at new_id[#+count#-1]=old_id[#+count#-1]
360# If not supplied, then ,1 is assumed, which will only update a single id
361def updateRemapDict(remap_string):
362 """Set up global remap_dict based on user input"""
363 remap_list = remap_string.split(":")
364 for rmap in remap_list:
365 count = 1 # Default count if none supplied
366 id_count_list = rmap.split(',')
367 if len(id_count_list) > 1:
368 count = int(id_count_list[1])
369 new_old_id_list = id_count_list[0].split('-')
370 for offset in range(count):
371 remap_dict["%05d" % (int(new_old_id_list[0]) + offset)] = "%05d" % (int(new_old_id_list[1]) + offset)
372 for new_id in sorted(remap_dict):
373 print "Set to remap new id %s to old id %s" % (new_id, remap_dict[new_id])
374
375if __name__ == "__main__":
376 i = 1
377 use_online = True # Attempt to grab spec from online by default
378 update_option = False
379 while (i < len(sys.argv)):
380 arg = sys.argv[i]
381 i = i + 1
382 if (arg == '-spec'):
383 spec_filename = sys.argv[i]
384 # If user specifies local specfile, skip online
385 use_online = False
386 i = i + 1
387 elif (arg == '-out'):
388 out_filename = sys.argv[i]
389 i = i + 1
390 elif (arg == '-gendb'):
391 gen_db = True
392 # Set filename if supplied, else use default
393 if i < len(sys.argv) and not sys.argv[i].startswith('-'):
394 db_filename = sys.argv[i]
395 i = i + 1
396 elif (arg == '-compare'):
397 db_filename = sys.argv[i]
398 spec_compare = True
399 i = i + 1
400 elif (arg == '-update'):
401 update_option = True
402 spec_compare = True
403 gen_db = True
404 elif (arg == '-remap'):
405 updateRemapDict(sys.argv[i])
406 i = i + 1
407 elif (arg in ['-help', '-h']):
408 printHelp()
409 sys.exit()
410 if len(remap_dict) > 1 and not update_option:
411 print "ERROR: '-remap' option can only be used along with '-update' option. Exiting."
412 sys.exit()
413 spec = Specification()
414 spec.loadFile(use_online, spec_filename)
415 #spec.parseTree()
416 #spec.genHeader(out_filename)
417 spec.analyze()
418 if (spec_compare):
419 # Read in old spec info from db file
420 (orig_db_dict, max_id) = spec.readDB(db_filename)
421 # New spec data should already be read into self.val_error_dict
422 updated_dict = spec.compareDB(orig_db_dict, max_id)
423 update_valid = spec.validateUpdateDict(updated_dict)
424 if update_valid:
425 spec.updateDict(updated_dict)
426 else:
427 sys.exit()
428 if (gen_db):
429 spec.genDB(db_filename)
430 print "Writing out file (-out) to '%s'" % (out_filename)
431 spec.genHeader(out_filename)
432
433##### Example dataset
434# <div class="sidebar">
435# <div class="titlepage">
436# <div>
437# <div>
438# <p class="title">
439# <strong>Valid Usage</strong> # When we get to this guy, we know we're under interesting sidebar
440# </p>
441# </div>
442# </div>
443# </div>
444# <div class="itemizedlist">
445# <ul class="itemizedlist" style="list-style-type: disc; ">
446# <li class="listitem">
447# <em class="parameter">
448# <code>device</code>
449# </em>
450# <span class="normative">must</span> be a valid
451# <code class="code">VkDevice</code> handle
452# </li>
453# <li class="listitem">
454# <em class="parameter">
455# <code>commandPool</code>
456# </em>
457# <span class="normative">must</span> be a valid
458# <code class="code">VkCommandPool</code> handle
459# </li>
460# <li class="listitem">
461# <em class="parameter">
462# <code>flags</code>
463# </em>
464# <span class="normative">must</span> be a valid combination of
465# <code class="code">
466# <a class="link" href="#VkCommandPoolResetFlagBits">VkCommandPoolResetFlagBits</a>
467# </code> values
468# </li>
469# <li class="listitem">
470# <em class="parameter">
471# <code>commandPool</code>
472# </em>
473# <span class="normative">must</span> have been created, allocated, or retrieved from
474# <em class="parameter">
475# <code>device</code>
476# </em>
477# </li>
478# <li class="listitem">All
479# <code class="code">VkCommandBuffer</code>
480# objects allocated from
481# <em class="parameter">
482# <code>commandPool</code>
483# </em>
484# <span class="normative">must</span> not currently be pending execution
485# </li>
486# </ul>
487# </div>
488# </div>
489##### Second example dataset
490# <div class="sidebar">
491# <div class="titlepage">
492# <div>
493# <div>
494# <p class="title">
495# <strong>Valid Usage</strong>
496# </p>
497# </div>
498# </div>
499# </div>
500# <div class="itemizedlist">
501# <ul class="itemizedlist" style="list-style-type: disc; ">
502# <li class="listitem">The <em class="parameter"><code>queueFamilyIndex</code></em> member of any given element of <em class="parameter"><code>pQueueCreateInfos</code></em> <span class="normative">must</span> be unique within <em class="parameter"><code>pQueueCreateInfos</code></em>
503# </li>
504# </ul>
505# </div>
506# </div>
507# <div class="sidebar">
508# <div class="titlepage">
509# <div>
510# <div>
511# <p class="title">
512# <strong>Valid Usage (Implicit)</strong>
513# </p>
514# </div>
515# </div>
516# </div>
517# <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
518#<em class="parameter"><code>sType</code></em> <span class="normative">must</span> be <code class="code">VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO</code>
519#</li><li class="listitem">
520#<em class="parameter"><code>pNext</code></em> <span class="normative">must</span> be <code class="literal">NULL</code>
521#</li><li class="listitem">
522#<em class="parameter"><code>flags</code></em> <span class="normative">must</span> be <code class="literal">0</code>
523#</li><li class="listitem">
524#<em class="parameter"><code>pQueueCreateInfos</code></em> <span class="normative">must</span> be a pointer to an array of <em class="parameter"><code>queueCreateInfoCount</code></em> valid <code class="code">VkDeviceQueueCreateInfo</code> structures
525#</li>