1 #!/usr/bin/env python3 2 # 3 # Copyright (c) 2015-2016 The Khronos Group Inc. 4 # Copyright (c) 2015-2016 Valve Corporation 5 # Copyright (c) 2015-2016 LunarG, Inc. 6 # Copyright (c) 2015-2016 Google Inc. 7 # 8 # Licensed under the Apache License, Version 2.0 (the "License"); 9 # you may not use this file except in compliance with the License. 10 # You may obtain a copy of the License at 11 # 12 # http://www.apache.org/licenses/LICENSE-2.0 13 # 14 # Unless required by applicable law or agreed to in writing, software 15 # distributed under the License is distributed on an "AS IS" BASIS, 16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17 # See the License for the specific language governing permissions and 18 # limitations under the License. 19 # 20 # Author: Courtney Goeltzenleuchter <courtney (at] LunarG.com> 21 # Author: Tobin Ehlis <tobin (at] lunarg.com> 22 23 import argparse 24 import os 25 import sys 26 import re 27 import vulkan 28 from source_line_info import sourcelineinfo 29 30 # vk_helper.py overview 31 # This script generates code based on vulkan input header 32 # It generate wrappers functions that can be used to display 33 # structs in a human-readable txt format, as well as utility functions 34 # to print enum values as strings 35 36 def handle_args(): 37 parser = argparse.ArgumentParser(description='Perform analysis of vogl trace.') 38 parser.add_argument('input_file', help='The input header file from which code will be generated.') 39 parser.add_argument('--rel_out_dir', required=False, default='vktrace_gen', help='Path relative to exec path to write output files. Will be created if needed.') 40 parser.add_argument('--abs_out_dir', required=False, default=None, help='Absolute path to write output files. Will be created if needed.') 41 parser.add_argument('--gen_enum_string_helper', required=False, action='store_true', default=False, help='Enable generation of helper header file to print string versions of enums.') 42 parser.add_argument('--gen_struct_wrappers', required=False, action='store_true', default=False, help='Enable generation of struct wrapper classes.') 43 parser.add_argument('--gen_struct_sizes', required=False, action='store_true', default=False, help='Enable generation of struct sizes.') 44 parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.') 45 parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.') 46 #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.') 47 return parser.parse_args() 48 49 # TODO : Ideally these data structs would be opaque to user and could be wrapped 50 # in their own class(es) to make them friendly for data look-up 51 # Dicts for Data storage 52 # enum_val_dict[value_name] = dict keys are the string enum value names for all enums 53 # |-------->['type'] = the type of enum class into which the value falls 54 # |-------->['val'] = the value assigned to this particular value_name 55 # '-------->['unique'] = bool designating if this enum 'val' is unique within this enum 'type' 56 enum_val_dict = {} 57 # enum_type_dict['type'] = the type or class of of enum 58 # '----->['val_name1', 'val_name2'...] = each type references a list of val_names within this type 59 enum_type_dict = {} 60 # struct_dict['struct_basename'] = the base (non-typedef'd) name of the struct 61 # |->[<member_num>] = members are stored via their integer placement in the struct 62 # | |->['name'] = string name of this struct member 63 # ... |->['full_type'] = complete type qualifier for this member 64 # |->['type'] = base type for this member 65 # |->['ptr'] = bool indicating if this member is ptr 66 # |->['const'] = bool indicating if this member is const 67 # |->['struct'] = bool indicating if this member is a struct type 68 # |->['array'] = bool indicating if this member is an array 69 # |->['dyn_array'] = bool indicating if member is a dynamically sized array 70 # '->['array_size'] = For dyn_array, member name used to size array, else int size for static array 71 struct_dict = {} 72 struct_order_list = [] # struct names in order they're declared 73 # Store struct names that require #ifdef guards 74 # dict stores struct and enum definitions that are guarded by ifdef as the key 75 # and the txt of the ifdef is the value 76 ifdef_dict = {} 77 # typedef_fwd_dict stores mapping from orig_type_name -> new_type_name 78 typedef_fwd_dict = {} 79 # typedef_rev_dict stores mapping from new_type_name -> orig_type_name 80 typedef_rev_dict = {} # store new_name -> orig_name mapping 81 # types_dict['id_name'] = identifier name will map to it's type 82 # '---->'type' = currently either 'struct' or 'enum' 83 types_dict = {} # store orig_name -> type mapping 84 85 86 # Class that parses header file and generates data structures that can 87 # Then be used for other tasks 88 class HeaderFileParser: 89 def __init__(self, header_file=None): 90 self.header_file = header_file 91 # store header data in various formats, see above for more info 92 self.enum_val_dict = {} 93 self.enum_type_dict = {} 94 self.struct_dict = {} 95 self.typedef_fwd_dict = {} 96 self.typedef_rev_dict = {} 97 self.types_dict = {} 98 self.last_struct_count_name = '' 99 100 def setHeaderFile(self, header_file): 101 self.header_file = header_file 102 103 def get_enum_val_dict(self): 104 return self.enum_val_dict 105 106 def get_enum_type_dict(self): 107 return self.enum_type_dict 108 109 def get_struct_dict(self): 110 return self.struct_dict 111 112 def get_typedef_fwd_dict(self): 113 return self.typedef_fwd_dict 114 115 def get_typedef_rev_dict(self): 116 return self.typedef_rev_dict 117 118 def get_types_dict(self): 119 return self.types_dict 120 121 # Parse header file into data structures 122 def parse(self): 123 # parse through the file, identifying different sections 124 parse_enum = False 125 parse_struct = False 126 member_num = 0 127 # TODO : Comment parsing is very fragile but handles 2 known files 128 block_comment = False 129 prev_count_name = '' 130 ifdef_txt = '' 131 ifdef_active = 0 132 exclude_struct_list = ['VkPlatformHandleXcbKHR', 'VkPlatformHandleX11KHR'] 133 with open(self.header_file) as f: 134 for line in f: 135 if True in [ifd_txt in line for ifd_txt in ['#ifdef ', '#ifndef ']]: 136 ifdef_txt = line.split()[1] 137 ifdef_active = ifdef_active + 1 138 continue 139 if ifdef_active != 0 and '#endif' in line: 140 ifdef_active = ifdef_active - 1 141 if block_comment: 142 if '*/' in line: 143 block_comment = False 144 continue 145 if '/*' in line: 146 if '*/' in line: # single line block comment 147 continue 148 block_comment = True 149 elif 0 == len(line.split()): 150 #print("Skipping empty line") 151 continue 152 elif line.split()[0].strip().startswith("//"): 153 #print("Skipping commented line %s" % line) 154 continue 155 elif 'typedef enum' in line: 156 (ty_txt, en_txt, base_type) = line.strip().split(None, 2) 157 #print("Found ENUM type %s" % base_type) 158 if '{' == base_type: 159 base_type = 'tmp_enum' 160 parse_enum = True 161 default_enum_val = 0 162 self.types_dict[base_type] = 'enum' 163 elif 'typedef struct' in line or 'typedef union' in line: 164 if True in [ex_type in line for ex_type in exclude_struct_list]: 165 continue 166 167 (ty_txt, st_txt, base_type) = line.strip().split(None, 2) 168 if ' ' in base_type: 169 (ignored, base_type) = base_type.strip().split(None, 1) 170 171 #print("Found STRUCT type: %s" % base_type) 172 # Note: This really needs to be updated to handle one line struct definition, like 173 # typedef struct obj##_T { uint64_t handle; } obj; 174 if ('{' == base_type or not (' ' in base_type)): 175 base_type = 'tmp_struct' 176 parse_struct = True 177 self.types_dict[base_type] = 'struct' 178 # elif 'typedef union' in line: 179 # (ty_txt, st_txt, base_type) = line.strip().split(None, 2) 180 # print("Found UNION type: %s" % base_type) 181 # parse_struct = True 182 # self.types_dict[base_type] = 'struct' 183 elif '}' in line and (parse_enum or parse_struct): 184 if len(line.split()) > 1: # deals with embedded union in one struct 185 parse_enum = False 186 parse_struct = False 187 self.last_struct_count_name = '' 188 member_num = 0 189 (cur_char, targ_type) = line.strip().split(None, 1) 190 if 'tmp_struct' == base_type: 191 base_type = targ_type.strip(';') 192 if True in [ex_type in base_type for ex_type in exclude_struct_list]: 193 del self.struct_dict['tmp_struct'] 194 continue 195 #print("Found Actual Struct type %s" % base_type) 196 self.struct_dict[base_type] = self.struct_dict['tmp_struct'] 197 self.struct_dict.pop('tmp_struct', 0) 198 struct_order_list.append(base_type) 199 self.types_dict[base_type] = 'struct' 200 self.types_dict.pop('tmp_struct', 0) 201 elif 'tmp_enum' == base_type: 202 base_type = targ_type.strip(';') 203 #print("Found Actual ENUM type %s" % base_type) 204 for n in self.enum_val_dict: 205 if 'tmp_enum' == self.enum_val_dict[n]['type']: 206 self.enum_val_dict[n]['type'] = base_type 207 # self.enum_val_dict[base_type] = self.enum_val_dict['tmp_enum'] 208 # self.enum_val_dict.pop('tmp_enum', 0) 209 self.enum_type_dict[base_type] = self.enum_type_dict['tmp_enum'] 210 self.enum_type_dict.pop('tmp_enum', 0) 211 self.types_dict[base_type] = 'enum' 212 self.types_dict.pop('tmp_enum', 0) 213 if ifdef_active: 214 ifdef_dict[base_type] = ifdef_txt 215 self.typedef_fwd_dict[base_type] = targ_type.strip(';') 216 self.typedef_rev_dict[targ_type.strip(';')] = base_type 217 #print("fwd_dict: %s = %s" % (base_type, targ_type)) 218 elif parse_enum: 219 #if 'VK_MAX_ENUM' not in line and '{' not in line: 220 if True not in [ens in line for ens in ['{', '_MAX_ENUM', '_BEGIN_RANGE', '_END_RANGE', '_NUM = ', '_ENUM_RANGE']]: 221 self._add_enum(line, base_type, default_enum_val) 222 default_enum_val += 1 223 elif parse_struct: 224 if ';' in line: 225 self._add_struct(line, base_type, member_num) 226 member_num = member_num + 1 227 228 # populate enum dicts based on enum lines 229 def _add_enum(self, line_txt, enum_type, def_enum_val): 230 #print("Parsing enum line %s" % line_txt) 231 if '=' in line_txt: 232 (enum_name, eq_char, enum_val) = line_txt.split(None, 2) 233 else: 234 enum_name = line_txt.split(',')[0] 235 enum_val = str(def_enum_val) 236 self.enum_val_dict[enum_name] = {} 237 self.enum_val_dict[enum_name]['type'] = enum_type 238 # strip comma and comment, then extra split in case of no comma w/ comments 239 enum_val = enum_val.strip().split(',', 1)[0] 240 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0] 241 # Perform conversion of VK_BIT macro 242 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']: 243 vk_bit_val = self.enum_val_dict[enum_name]['val'] 244 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0) 245 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift) 246 else: 247 # account for negative values surrounded by parens 248 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-') 249 # Try to cast to int to determine if enum value is unique 250 try: 251 #print("ENUM val:", self.enum_val_dict[enum_name]['val']) 252 int(self.enum_val_dict[enum_name]['val'], 0) 253 self.enum_val_dict[enum_name]['unique'] = True 254 #print("ENUM has num value") 255 except ValueError: 256 self.enum_val_dict[enum_name]['unique'] = False 257 #print("ENUM is not a number value") 258 # Update enum_type_dict as well 259 if not enum_type in self.enum_type_dict: 260 self.enum_type_dict[enum_type] = [] 261 self.enum_type_dict[enum_type].append(enum_name) 262 263 # Return True if struct member is a dynamic array 264 # RULES : This is a bit quirky based on the API 265 # NOTE : Changes in API spec may cause these rules to change 266 # 1. There must be a previous uint var w/ 'count' in the name in the struct 267 # 2. Dynam array must have 'const' and '*' qualifiers 268 # 3a. Name of dynam array must end in 's' char OR 269 # 3b. Name of count var minus 'count' must be contained in name of dynamic array 270 def _is_dynamic_array(self, full_type, name): 271 exceptions = ['pEnabledFeatures', 'pWaitDstStageMask', 'pSampleMask'] 272 if name in exceptions: 273 return False 274 if '' != self.last_struct_count_name: 275 if 'const' in full_type and '*' in full_type: 276 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower(): 277 return True 278 279 # VkWriteDescriptorSet 280 if self.last_struct_count_name == "descriptorCount": 281 return True 282 283 return False 284 285 # populate struct dicts based on struct lines 286 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*" 287 def _add_struct(self, line_txt, struct_type, num): 288 #print("Parsing struct line %s" % line_txt) 289 if '{' == struct_type: 290 print("Parsing struct '{' w/ line %s" % line_txt) 291 if not struct_type in self.struct_dict: 292 self.struct_dict[struct_type] = {} 293 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments 294 # TODO : Handle bitfields more correctly 295 members = members.strip().split(':', 1)[0] # strip bitfield element 296 (member_type, member_name) = members.rsplit(None, 1) 297 # Store counts to help recognize and size dynamic arrays 298 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type: 299 self.last_struct_count_name = member_name 300 self.struct_dict[struct_type][num] = {} 301 self.struct_dict[struct_type][num]['full_type'] = member_type 302 self.struct_dict[struct_type][num]['dyn_array'] = False 303 if '*' in member_type: 304 self.struct_dict[struct_type][num]['ptr'] = True 305 # TODO : Need more general purpose way here to reduce down to basic type 306 member_type = member_type.replace(' const*', '') 307 member_type = member_type.strip('*') 308 else: 309 self.struct_dict[struct_type][num]['ptr'] = False 310 if 'const' in member_type: 311 self.struct_dict[struct_type][num]['const'] = True 312 member_type = member_type.replace('const', '').strip() 313 else: 314 self.struct_dict[struct_type][num]['const'] = False 315 # TODO : There is a bug here where it seems that at the time we do this check, 316 # the data is not in the types or typedef_rev_dict, so we never pass this if check 317 if is_type(member_type, 'struct'): 318 self.struct_dict[struct_type][num]['struct'] = True 319 else: 320 self.struct_dict[struct_type][num]['struct'] = False 321 self.struct_dict[struct_type][num]['type'] = member_type 322 if '[' in member_name: 323 (member_name, array_size) = member_name.split('[', 1) 324 #if 'char' in member_type: 325 # self.struct_dict[struct_type][num]['array'] = False 326 # self.struct_dict[struct_type][num]['array_size'] = 0 327 # self.struct_dict[struct_type][num]['ptr'] = True 328 #else: 329 self.struct_dict[struct_type][num]['array'] = True 330 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']') 331 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name): 332 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name)) 333 self.struct_dict[struct_type][num]['array'] = True 334 self.struct_dict[struct_type][num]['dyn_array'] = True 335 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name 336 elif not 'array' in self.struct_dict[struct_type][num]: 337 self.struct_dict[struct_type][num]['array'] = False 338 self.struct_dict[struct_type][num]['array_size'] = 0 339 self.struct_dict[struct_type][num]['name'] = member_name 340 341 # check if given identifier is of specified type_to_check 342 def is_type(identifier, type_to_check): 343 if identifier in types_dict and type_to_check == types_dict[identifier]: 344 return True 345 if identifier in typedef_rev_dict: 346 new_id = typedef_rev_dict[identifier] 347 if new_id in types_dict and type_to_check == types_dict[new_id]: 348 return True 349 return False 350 351 # This is a validation function to verify that we can reproduce the original structs 352 def recreate_structs(): 353 for struct_name in struct_dict: 354 sys.stdout.write("typedef struct %s\n{\n" % struct_name) 355 for mem_num in sorted(struct_dict[struct_name]): 356 sys.stdout.write(" ") 357 if struct_dict[struct_name][mem_num]['const']: 358 sys.stdout.write("const ") 359 #if struct_dict[struct_name][mem_num]['struct']: 360 # sys.stdout.write("struct ") 361 sys.stdout.write (struct_dict[struct_name][mem_num]['type']) 362 if struct_dict[struct_name][mem_num]['ptr']: 363 sys.stdout.write("*") 364 sys.stdout.write(" ") 365 sys.stdout.write(struct_dict[struct_name][mem_num]['name']) 366 if struct_dict[struct_name][mem_num]['array']: 367 sys.stdout.write("[") 368 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size']) 369 sys.stdout.write("]") 370 sys.stdout.write(";\n") 371 sys.stdout.write("} ") 372 sys.stdout.write(typedef_fwd_dict[struct_name]) 373 sys.stdout.write(";\n\n") 374 375 # 376 # TODO: Fix construction of struct name 377 def get_struct_name_from_struct_type(struct_type): 378 # Note: All struct types are now camel-case 379 # Debug Report has an inconsistency - so need special case. 380 if ("VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT" == struct_type): 381 return "VkDebugReportCallbackCreateInfoEXT" 382 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "") 383 char_idx = 0 384 struct_name = '' 385 for char in caps_struct_name: 386 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'): 387 struct_name += caps_struct_name[char_idx] 388 elif (caps_struct_name[char_idx] == '_'): 389 pass 390 else: 391 struct_name += caps_struct_name[char_idx].lower() 392 char_idx += 1 393 394 return struct_name 395 396 # Emit an ifdef if incoming func matches a platform identifier 397 def add_platform_wrapper_entry(list, func): 398 if (re.match(r'.*Xlib.*', func)): 399 list.append("#ifdef VK_USE_PLATFORM_XLIB_KHR") 400 if (re.match(r'.*Xcb.*', func)): 401 list.append("#ifdef VK_USE_PLATFORM_XCB_KHR") 402 if (re.match(r'.*Wayland.*', func)): 403 list.append("#ifdef VK_USE_PLATFORM_WAYLAND_KHR") 404 if (re.match(r'.*Mir.*', func)): 405 list.append("#ifdef VK_USE_PLATFORM_MIR_KHR") 406 if (re.match(r'.*Android.*', func)): 407 list.append("#ifdef VK_USE_PLATFORM_ANDROID_KHR") 408 if (re.match(r'.*Win32.*', func)): 409 list.append("#ifdef VK_USE_PLATFORM_WIN32_KHR") 410 411 # Emit an endif if incoming func matches a platform identifier 412 def add_platform_wrapper_exit(list, func): 413 if (re.match(r'.*Xlib.*', func)): 414 list.append("#endif //VK_USE_PLATFORM_XLIB_KHR") 415 if (re.match(r'.*Xcb.*', func)): 416 list.append("#endif //VK_USE_PLATFORM_XCB_KHR") 417 if (re.match(r'.*Wayland.*', func)): 418 list.append("#endif //VK_USE_PLATFORM_WAYLAND_KHR") 419 if (re.match(r'.*Mir.*', func)): 420 list.append("#endif //VK_USE_PLATFORM_MIR_KHR") 421 if (re.match(r'.*Android.*', func)): 422 list.append("#endif //VK_USE_PLATFORM_ANDROID_KHR") 423 if (re.match(r'.*Win32.*', func)): 424 list.append("#endif //VK_USE_PLATFORM_WIN32_KHR") 425 426 # class for writing common file elements 427 # Here's how this class lays out a file: 428 # COPYRIGHT 429 # HEADER 430 # BODY 431 # FOOTER 432 # 433 # For each of these sections, there's a "set*" function 434 # The class as a whole has a generate function which will write each section in order 435 class CommonFileGen: 436 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""): 437 self.filename = filename 438 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt} 439 # TODO : Set a default copyright & footer at least 440 441 def setFilename(self, filename): 442 self.filename = filename 443 444 def setCopyright(self, c): 445 self.contents['copyright'] = c 446 447 def setHeader(self, h): 448 self.contents['header'] = h 449 450 def setBody(self, b): 451 self.contents['body'] = b 452 453 def setFooter(self, f): 454 self.contents['footer'] = f 455 456 def generate(self): 457 #print("Generate to file %s" % self.filename) 458 with open(self.filename, "w") as f: 459 f.write(self.contents['copyright']) 460 f.write(self.contents['header']) 461 f.write(self.contents['body']) 462 f.write(self.contents['footer']) 463 464 # class for writing a wrapper class for structures 465 # The wrapper class wraps the structs and includes utility functions for 466 # setting/getting member values and displaying the struct data in various formats 467 class StructWrapperGen: 468 def __init__(self, in_struct_dict, prefix, out_dir): 469 self.struct_dict = in_struct_dict 470 self.include_headers = [] 471 self.lineinfo = sourcelineinfo() 472 self.api = prefix 473 if prefix.lower() == "vulkan": 474 self.api_prefix = "vk" 475 else: 476 self.api_prefix = prefix 477 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h") 478 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp") 479 self.safe_struct_header_filename = os.path.join(out_dir, self.api_prefix+"_safe_struct.h") 480 self.safe_struct_source_filename = os.path.join(out_dir, self.api_prefix+"_safe_struct.cpp") 481 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h") 482 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h") 483 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h") 484 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h") 485 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h") 486 self.no_addr = False 487 # Safe Struct (ss) header and source files 488 self.ssh = CommonFileGen(self.safe_struct_header_filename) 489 self.sss = CommonFileGen(self.safe_struct_source_filename) 490 self.hfg = CommonFileGen(self.header_filename) 491 self.cfg = CommonFileGen(self.class_filename) 492 self.shg = CommonFileGen(self.string_helper_filename) 493 self.shcppg = CommonFileGen(self.string_helper_cpp_filename) 494 self.vhg = CommonFileGen(self.validate_helper_filename) 495 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h") 496 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c") 497 self.size_helper_gen = CommonFileGen(self.size_helper_filename) 498 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename) 499 #print(self.header_filename) 500 self.header_txt = "" 501 self.definition_txt = "" 502 503 def set_include_headers(self, include_headers): 504 self.include_headers = include_headers 505 506 def set_no_addr(self, no_addr): 507 self.no_addr = no_addr 508 if self.no_addr: 509 self.shg = CommonFileGen(self.string_helper_no_addr_filename) 510 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename) 511 else: 512 self.shg = CommonFileGen(self.string_helper_filename) 513 self.shcppg = CommonFileGen(self.string_helper_cpp_filename) 514 515 # Return class name for given struct name 516 def get_class_name(self, struct_name): 517 class_name = struct_name.strip('_').lower() + "_struct_wrapper" 518 return class_name 519 520 def get_file_list(self): 521 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)] 522 523 # Generate class header file 524 def generateHeader(self): 525 self.hfg.setCopyright(self._generateCopyright()) 526 self.hfg.setHeader(self._generateHeader()) 527 self.hfg.setBody(self._generateClassDeclaration()) 528 self.hfg.setFooter(self._generateFooter()) 529 self.hfg.generate() 530 531 # Generate class definition 532 def generateBody(self): 533 self.cfg.setCopyright(self._generateCopyright()) 534 self.cfg.setHeader(self._generateCppHeader()) 535 self.cfg.setBody(self._generateClassDefinition()) 536 self.cfg.setFooter(self._generateFooter()) 537 self.cfg.generate() 538 539 # Safe Structs are versions of vulkan structs with non-const safe ptrs 540 # that make shadowing structures and clean-up of shadowed structures very simple 541 def generateSafeStructHeader(self): 542 self.ssh.setCopyright(self._generateCopyright()) 543 self.ssh.setHeader(self._generateSafeStructHeader()) 544 self.ssh.setBody(self._generateSafeStructDecls()) 545 self.ssh.generate() 546 547 def generateSafeStructs(self): 548 self.sss.setCopyright(self._generateCopyright()) 549 self.sss.setHeader(self._generateSafeStructSourceHeader()) 550 self.sss.setBody(self._generateSafeStructSource()) 551 self.sss.generate() 552 553 # Generate c-style .h file that contains functions for printing structs 554 def generateStringHelper(self): 555 print("Generating struct string helper") 556 self.shg.setCopyright(self._generateCopyright()) 557 self.shg.setHeader(self._generateStringHelperHeader()) 558 self.shg.setBody(self._generateStringHelperFunctions()) 559 self.shg.generate() 560 561 # Generate cpp-style .h file that contains functions for printing structs 562 def generateStringHelperCpp(self): 563 print("Generating struct string helper cpp") 564 self.shcppg.setCopyright(self._generateCopyright()) 565 self.shcppg.setHeader(self._generateStringHelperHeaderCpp()) 566 self.shcppg.setBody(self._generateStringHelperFunctionsCpp()) 567 self.shcppg.generate() 568 569 # Generate c-style .h file that contains functions for printing structs 570 def generateValidateHelper(self): 571 print("Generating struct validate helper") 572 self.vhg.setCopyright(self._generateCopyright()) 573 self.vhg.setHeader(self._generateValidateHelperHeader()) 574 self.vhg.setBody(self._generateValidateHelperFunctions()) 575 self.vhg.generate() 576 577 def generateSizeHelper(self): 578 print("Generating struct size helper") 579 self.size_helper_gen.setCopyright(self._generateCopyright()) 580 self.size_helper_gen.setHeader(self._generateSizeHelperHeader()) 581 self.size_helper_gen.setBody(self._generateSizeHelperFunctions()) 582 self.size_helper_gen.generate() 583 584 def generateSizeHelperC(self): 585 print("Generating struct size helper c") 586 self.size_helper_c_gen.setCopyright(self._generateCopyright()) 587 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC()) 588 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC()) 589 self.size_helper_c_gen.generate() 590 591 def _generateCopyright(self): 592 copyright = [] 593 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */'); 594 copyright.append(''); 595 copyright.append('/*'); 596 copyright.append(' * Vulkan'); 597 copyright.append(' *'); 598 copyright.append(' * Copyright (c) 2015-2016 The Khronos Group Inc.'); 599 copyright.append(' * Copyright (c) 2015-2016 Valve Corporation.'); 600 copyright.append(' * Copyright (c) 2015-2016 LunarG, Inc.'); 601 copyright.append(' * Copyright (c) 2015-2016 Google Inc.'); 602 copyright.append(' *'); 603 copyright.append(' * Licensed under the Apache License, Version 2.0 (the "License");'); 604 copyright.append(' * you may not use this file except in compliance with the License.'); 605 copyright.append(' * You may obtain a copy of the License at'); 606 copyright.append(' *'); 607 copyright.append(' * http://www.apache.org/licenses/LICENSE-2.0'); 608 copyright.append(' *'); 609 copyright.append(' * Unless required by applicable law or agreed to in writing, software'); 610 copyright.append(' * distributed under the License is distributed on an "AS IS" BASIS,'); 611 copyright.append(' * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.'); 612 copyright.append(' * See the License for the specific language governing permissions and'); 613 copyright.append(' * limitations under the License.'); 614 copyright.append(' *'); 615 copyright.append(' * Author: Courtney Goeltzenleuchter <courtney (at] LunarG.com>'); 616 copyright.append(' * Author: Tobin Ehlis <tobin (at] lunarg.com>'); 617 copyright.append(' */'); 618 copyright.append(''); 619 return "\n".join(copyright) 620 621 def _generateCppHeader(self): 622 header = [] 623 header.append("//#includes, #defines, globals and such...\n") 624 header.append("#include <stdio.h>\n#include <%s>\n#include <%s_enum_string_helper.h>\n" % (os.path.basename(self.header_filename), self.api_prefix)) 625 return "".join(header) 626 627 def _generateClassDefinition(self): 628 class_def = [] 629 if 'vk' == self.api: 630 class_def.append(self._generateDynamicPrintFunctions()) 631 for s in sorted(self.struct_dict): 632 class_def.append("\n// %s class definition" % self.get_class_name(s)) 633 class_def.append(self._generateConstructorDefinitions(s)) 634 class_def.append(self._generateDestructorDefinitions(s)) 635 class_def.append(self._generateDisplayDefinitions(s)) 636 return "\n".join(class_def) 637 638 def _generateConstructorDefinitions(self, s): 639 con_defs = [] 640 con_defs.append("%s::%s() : m_struct(), m_indent(0), m_dummy_prefix('\\0'), m_origStructAddr(NULL) {}" % (self.get_class_name(s), self.get_class_name(s))) 641 # TODO : This is a shallow copy of ptrs 642 con_defs.append("%s::%s(%s* pInStruct) : m_indent(0), m_dummy_prefix('\\0')\n{\n m_struct = *pInStruct;\n m_origStructAddr = pInStruct;\n}" % (self.get_class_name(s), self.get_class_name(s), typedef_fwd_dict[s])) 643 con_defs.append("%s::%s(const %s* pInStruct) : m_indent(0), m_dummy_prefix('\\0')\n{\n m_struct = *pInStruct;\n m_origStructAddr = pInStruct;\n}" % (self.get_class_name(s), self.get_class_name(s), typedef_fwd_dict[s])) 644 return "\n".join(con_defs) 645 646 def _generateDestructorDefinitions(self, s): 647 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s)) 648 649 def _generateDynamicPrintFunctions(self): 650 dp_funcs = [] 651 dp_funcs.append("\nvoid dynamic_display_full_txt(const void* pStruct, uint32_t indent)\n{\n // Cast to APP_INFO ptr initially just to pull sType off struct") 652 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n") 653 dp_funcs.append(" switch (sType)\n {") 654 for e in enum_type_dict: 655 class_num = 0 656 if "StructureType" in e: 657 for v in sorted(enum_type_dict[e]): 658 struct_name = get_struct_name_from_struct_type(v) 659 if struct_name not in self.struct_dict: 660 continue 661 662 class_name = self.get_class_name(struct_name) 663 instance_name = "swc%i" % class_num 664 dp_funcs.append(" case %s:\n {" % (v)) 665 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name)) 666 dp_funcs.append(" %s.set_indent(indent);" % (instance_name)) 667 dp_funcs.append(" %s.display_full_txt();" % (instance_name)) 668 dp_funcs.append(" }") 669 dp_funcs.append(" break;") 670 class_num += 1 671 dp_funcs.append(" }") 672 dp_funcs.append("}\n") 673 return "\n".join(dp_funcs) 674 675 def _get_func_name(self, struct, mid_str): 676 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_")) 677 678 def _get_sh_func_name(self, struct): 679 return self._get_func_name(struct, 'print') 680 681 def _get_vh_func_name(self, struct): 682 return self._get_func_name(struct, 'validate') 683 684 def _get_size_helper_func_name(self, struct): 685 return self._get_func_name(struct, 'size') 686 687 # Return elements to create formatted string for given struct member 688 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False): 689 struct_op = "->" 690 if not struct_ptr: 691 struct_op = "." 692 member_name = struct_member['name'] 693 print_type = "p" 694 cast_type = "" 695 member_post = "" 696 array_index = "" 697 member_print_post = "" 698 print_delimiter = "%" 699 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string 700 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now 701 member_post = "[0]" 702 print_type = "s" 703 print_array = False 704 elif struct_member['array'] and not print_array: 705 # Just print base address of array when not full print_array 706 print_delimiter = "0x%" 707 cast_type = "(void*)" 708 elif is_type(struct_member['type'], 'enum'): 709 cast_type = "string_%s" % struct_member['type'] 710 if struct_member['ptr']: 711 struct_var_name = "*" + struct_var_name 712 print_delimiter = "0x%" 713 print_type = "s" 714 elif is_type(struct_member['type'], 'struct'): # print struct address for now 715 print_delimiter = "0x%" 716 cast_type = "(void*)" 717 if not struct_member['ptr']: 718 cast_type = "(void*)&" 719 elif 'bool' in struct_member['type'].lower(): 720 print_type = "s" 721 member_post = ' ? "TRUE" : "FALSE"' 722 elif 'float' in struct_member['type']: 723 print_type = "f" 724 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower(): 725 print_type = '" PRId64 "' 726 elif 'uint8' in struct_member['type']: 727 print_type = "hu" 728 elif 'size' in struct_member['type'].lower(): 729 print_type = '" PRINTF_SIZE_T_SPECIFIER "' 730 print_delimiter = "" 731 elif True in [ui_str.lower() in struct_member['type'].lower() for ui_str in ['uint', 'flags', 'samplemask']]: 732 print_type = "u" 733 elif 'int' in struct_member['type']: 734 print_type = "i" 735 elif struct_member['ptr']: 736 print_delimiter = "0x%" 737 pass 738 else: 739 #print("Unhandled struct type: %s" % struct_member['type']) 740 print_delimiter = "0x%" 741 cast_type = "(void*)" 742 if print_array and struct_member['array']: 743 member_print_post = "[%u]" 744 array_index = " i," 745 member_post = "[i]" 746 print_out = "%%s%s%s = %s%s%s" % (member_name, member_print_post, print_delimiter, print_type, postfix) # section of print that goes inside of quotes 747 print_arg = ", %s,%s %s(%s%s%s)%s" % (pre_var_name, array_index, cast_type, struct_var_name, struct_op, member_name, member_post) # section of print passed to portion in quotes 748 if self.no_addr and "p" == print_type: 749 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes 750 print_arg = ", %s" % (pre_var_name) 751 return (print_out, print_arg) 752 753 def _generateStringHelperFunctions(self): 754 sh_funcs = [] 755 # We do two passes, first pass just generates prototypes for all the functsions 756 for s in sorted(self.struct_dict): 757 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s])) 758 sh_funcs.append('') 759 sh_funcs.append('#if defined(_WIN32)') 760 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with') 761 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a') 762 sh_funcs.append('// work-around.') 763 sh_funcs.append('#define snprintf _snprintf') 764 sh_funcs.append('#endif // _WIN32\n') 765 for s in sorted(self.struct_dict): 766 p_out = "" 767 p_args = "" 768 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs 769 # This pre-pass flags embedded structs and pNext 770 for m in sorted(self.struct_dict[s]): 771 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'): 772 stp_list.append(self.struct_dict[s][m]) 773 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix)\n{\n char* str;' % (self._get_sh_func_name(s), typedef_fwd_dict[s])) 774 sh_funcs.append(" size_t len;") 775 num_stps = len(stp_list); 776 total_strlen_str = '' 777 if 0 != num_stps: 778 sh_funcs.append(" char* tmpStr;") 779 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);') 780 sh_funcs.append(' strcpy(extra_indent, " ");') 781 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));') 782 sh_funcs.append(' char* stp_strs[%i];' % num_stps) 783 for index in range(num_stps): 784 # If it's an array, print all of the elements 785 # If it's a ptr, print thing it's pointing to 786 # Non-ptr struct case. Print the struct using its address 787 struct_deref = '&' 788 if 1 < stp_list[index]['full_type'].count('*'): 789 struct_deref = '' 790 if (stp_list[index]['ptr']): 791 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name']) 792 if 'pNext' == stp_list[index]['name']: 793 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);') 794 sh_funcs.append(' len = 256+strlen(tmpStr);') 795 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index) 796 if self.no_addr: 797 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index) 798 else: 799 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (0x%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index) 800 sh_funcs.append(' free(tmpStr);') 801 else: 802 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']: 803 # TODO : This is a quick hack to handle these arrays of ptrs 804 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name'])) 805 else: 806 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name'])) 807 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);') 808 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index)) 809 if self.no_addr: 810 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name'])) 811 else: 812 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (0x%%p)\\n%%s", prefix, (void*)pStruct->%s, tmpStr);' % (index, stp_list[index]['name'], stp_list[index]['name'])) 813 sh_funcs.append(' }') 814 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index)) 815 elif stp_list[index]['array']: 816 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name'])) 817 sh_funcs.append(' len = 256+strlen(tmpStr);') 818 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index)) 819 if self.no_addr: 820 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s[0] (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name'])) 821 else: 822 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s[0] (0x%%p)\\n%%s", prefix, (void*)&pStruct->%s[0], tmpStr);' % (index, stp_list[index]['name'], stp_list[index]['name'])) 823 else: 824 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name'])) 825 sh_funcs.append(' len = 256+strlen(tmpStr);') 826 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index)) 827 if self.no_addr: 828 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name'])) 829 else: 830 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (0x%%p)\\n%%s", prefix, (void*)&pStruct->%s, tmpStr);' % (index, stp_list[index]['name'], stp_list[index]['name'])) 831 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index 832 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str)) 833 sh_funcs.append(' str = (char*)malloc(len);') 834 sh_funcs.append(' snprintf(str, len, "') 835 for m in sorted(self.struct_dict[s]): 836 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m]) 837 p_out += p_out1 838 p_args += p_args1 839 p_out += '"' 840 p_args += ");" 841 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args) 842 if 0 != num_stps: 843 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1)) 844 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {') 845 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));') 846 sh_funcs.append(' free(stp_strs[stp_index]);') 847 sh_funcs.append(' }') 848 sh_funcs.append(' }') 849 sh_funcs.append(' free(extra_indent);') 850 sh_funcs.append(" return str;\n}") 851 # Add function to dynamically print out unknown struct 852 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{") 853 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct") 854 sh_funcs.append(" if (pStruct == NULL) {") 855 sh_funcs.append(" return NULL;") 856 sh_funcs.append(" }") 857 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;") 858 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);') 859 sh_funcs.append(" switch (sType)\n {") 860 for e in enum_type_dict: 861 if "StructureType" in e: 862 for v in sorted(enum_type_dict[e]): 863 struct_name = get_struct_name_from_struct_type(v) 864 if struct_name not in self.struct_dict: 865 continue 866 print_func_name = self._get_sh_func_name(struct_name) 867 sh_funcs.append(' case %s:\n {' % (v)) 868 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name)) 869 sh_funcs.append(' }') 870 sh_funcs.append(' break;') 871 sh_funcs.append(" default:") 872 sh_funcs.append(" return NULL;") 873 sh_funcs.append(" }") 874 sh_funcs.append("}") 875 return "\n".join(sh_funcs) 876 877 def _generateStringHelperFunctionsCpp(self): 878 # declare str & tmp str 879 # declare array of stringstreams for every struct ptr in current struct 880 # declare array of stringstreams for every non-string element in current struct 881 # For every struct ptr, if non-Null, then set its string, else set to NULL str 882 # For every non-string element, set its string stream 883 # create and return final string 884 sh_funcs = [] 885 # First generate prototypes for every struct 886 # XXX - REMOVE this comment 887 lineinfo = sourcelineinfo() 888 sh_funcs.append('%s' % lineinfo.get()) 889 for s in sorted(self.struct_dict): 890 # Wrap this in platform check since it may contain undefined structs or functions 891 add_platform_wrapper_entry(sh_funcs, typedef_fwd_dict[s]) 892 sh_funcs.append('std::string %s(const %s* pStruct, const std::string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s])) 893 add_platform_wrapper_exit(sh_funcs, typedef_fwd_dict[s]) 894 895 sh_funcs.append('\n') 896 sh_funcs.append('%s' % lineinfo.get()) 897 for s in sorted(self.struct_dict): 898 num_non_enum_elems = [(is_type(self.struct_dict[s][elem]['type'], 'enum') and not self.struct_dict[s][elem]['ptr']) for elem in self.struct_dict[s]].count(False) 899 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs 900 # This pre-pass flags embedded structs and pNext 901 for m in sorted(self.struct_dict[s]): 902 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct') or self.struct_dict[s][m]['array']: 903 # TODO: This is a tmp workaround 904 if 'ppActiveLayerNames' not in self.struct_dict[s][m]['name']: 905 stp_list.append(self.struct_dict[s][m]) 906 sh_funcs.append('%s' % lineinfo.get()) 907 908 # Wrap this in platform check since it may contain undefined structs or functions 909 add_platform_wrapper_entry(sh_funcs, typedef_fwd_dict[s]) 910 911 sh_funcs.append('std::string %s(const %s* pStruct, const std::string prefix)\n{' % (self._get_sh_func_name(s), typedef_fwd_dict[s])) 912 sh_funcs.append('%s' % lineinfo.get()) 913 indent = ' ' 914 sh_funcs.append('%susing namespace StreamControl;' % (indent)) 915 sh_funcs.append('%susing namespace std;' % (indent)) 916 sh_funcs.append('%sstring final_str;' % (indent)) 917 sh_funcs.append('%sstring tmp_str;' % (indent)) 918 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent)) 919 if (0 != num_non_enum_elems): 920 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems)) 921 num_stps = len(stp_list) 922 # First generate code for any embedded structs or arrays 923 if 0 < num_stps: 924 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps)) 925 idx_ss_decl = False # Make sure to only decl this once 926 for index in range(num_stps): 927 addr_char = '&' 928 if 1 < stp_list[index]['full_type'].count('*'): 929 addr_char = '' 930 if stp_list[index]['array']: 931 sh_funcs.append('%s' % lineinfo.get()) 932 if stp_list[index]['dyn_array']: 933 sh_funcs.append('%s' % lineinfo.get()) 934 array_count = 'pStruct->%s' % (stp_list[index]['array_size']) 935 else: 936 sh_funcs.append('%s' % lineinfo.get()) 937 array_count = '%s' % (stp_list[index]['array_size']) 938 sh_funcs.append('%s' % lineinfo.get()) 939 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index)) 940 if not idx_ss_decl: 941 sh_funcs.append('%sstringstream index_ss;' % (indent)) 942 idx_ss_decl = True 943 if (stp_list[index]['name'] == 'pQueueFamilyIndices'): 944 if (typedef_fwd_dict[s] == 'VkSwapchainCreateInfoKHR'): 945 sh_funcs.append('%sif (pStruct->imageSharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent)) 946 else: 947 sh_funcs.append('%sif (pStruct->sharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent)) 948 indent += ' ' 949 if (stp_list[index]['name'] == 'pImageInfo'): 950 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER) ||' % (indent)) 951 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER) ||' % (indent)) 952 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) ||' % (indent)) 953 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE)) {' % (indent)) 954 indent += ' ' 955 elif (stp_list[index]['name'] == 'pBufferInfo'): 956 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER) ||' % (indent)) 957 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||' % (indent)) 958 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||' % (indent)) 959 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {' % (indent)) 960 indent += ' ' 961 elif (stp_list[index]['name'] == 'pTexelBufferView'): 962 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER) ||' % (indent)) 963 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER)) {' % (indent)) 964 indent += ' ' 965 if stp_list[index]['dyn_array']: 966 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name'])) 967 indent += ' ' 968 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count)) 969 indent += ' ' 970 sh_funcs.append('%sindex_ss.str("");' % (indent)) 971 sh_funcs.append('%sindex_ss << i;' % (indent)) 972 if is_type(stp_list[index]['type'], 'enum'): 973 sh_funcs.append('%s' % lineinfo.get()) 974 addr_char = '' 975 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name']) 976 sh_funcs.append('%sss[%u] << string_%s(pStruct->%s[i]);' % (indent, index, stp_list[index]['type'], stp_list[index]['name'])) 977 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index)) 978 elif is_type(stp_list[index]['type'], 'struct'): 979 sh_funcs.append('%s' % lineinfo.get()) 980 sh_funcs.append('%sss[%u] << "0x" << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name'])) 981 sh_funcs.append('%stmp_str = %s(%spStruct->%s[i], extra_indent);' % (indent, self._get_sh_func_name(stp_list[index]['type']), addr_char, stp_list[index]['name'])) 982 if self.no_addr: 983 sh_funcs.append('%s' % lineinfo.get()) 984 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name'])) 985 else: 986 sh_funcs.append('%s' % lineinfo.get()) 987 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (" + ss[%u].str() + ")\\n" + tmp_str;' % (indent, index, stp_list[index]['name'], index)) 988 else: 989 sh_funcs.append('%s' % lineinfo.get()) 990 addr_char = '' 991 if stp_list[index]['ptr'] or 'UUID' in stp_list[index]['name']: 992 sh_funcs.append('%sss[%u] << "0x" << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name'])) 993 else: 994 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name'])) 995 if stp_list[index]['type'] in vulkan.core.objects: 996 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "].handle = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index)) 997 else: 998 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index)) 999 sh_funcs.append('%s' % lineinfo.get()) 1000 sh_funcs.append('%sss[%u].str("");' % (indent, index)) 1001 indent = indent[4:] 1002 sh_funcs.append('%s}' % (indent)) 1003 if stp_list[index]['dyn_array']: 1004 indent = indent[4:] 1005 sh_funcs.append('%s}' % (indent)) 1006 #endif 1007 if (stp_list[index]['name'] == 'pQueueFamilyIndices') or (stp_list[index]['name'] == 'pImageInfo') or (stp_list[index]['name'] == 'pBufferInfo') or (stp_list[index]['name'] == 'pTexelBufferView'): 1008 indent = indent[4:] 1009 sh_funcs.append('%s}' % (indent)) 1010 elif (stp_list[index]['ptr']): 1011 sh_funcs.append('%s' % lineinfo.get()) 1012 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name'])) 1013 indent += ' ' 1014 if 'pNext' == stp_list[index]['name']: 1015 sh_funcs.append('%s' % lineinfo.get()) 1016 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);') 1017 else: 1018 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']: 1019 # TODO : This is a quick hack to handle these arrays of ptrs 1020 sh_funcs.append('%s' % lineinfo.get()) 1021 sh_funcs.append(' tmp_str = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name'])) 1022 else: 1023 sh_funcs.append('%s' % lineinfo.get()) 1024 sh_funcs.append(' tmp_str = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name'])) 1025 sh_funcs.append(' ss[%u] << "0x" << %spStruct->%s;' % (index, addr_char, stp_list[index]['name'])) 1026 if self.no_addr: 1027 sh_funcs.append('%s' % lineinfo.get()) 1028 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name'])) 1029 else: 1030 sh_funcs.append('%s' % lineinfo.get()) 1031 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index)) 1032 sh_funcs.append(' ss[%u].str("");' % (index)) 1033 sh_funcs.append(' }') 1034 sh_funcs.append(' else') 1035 sh_funcs.append(' stp_strs[%u] = "";' % index) 1036 else: 1037 sh_funcs.append('%s' % lineinfo.get()) 1038 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name'])) 1039 sh_funcs.append(' ss[%u] << "0x" << %spStruct->%s;' % (index, addr_char, stp_list[index]['name'])) 1040 if self.no_addr: 1041 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name'])) 1042 sh_funcs.append('%s' % lineinfo.get()) 1043 else: 1044 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index)) 1045 sh_funcs.append('%s' % lineinfo.get()) 1046 sh_funcs.append(' ss[%u].str("");' % index) 1047 # Now print one-line info for all data members 1048 index = 0 1049 final_str = '' 1050 for m in sorted(self.struct_dict[s]): 1051 if not is_type(self.struct_dict[s][m]['type'], 'enum'): 1052 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']: 1053 if self.no_addr: 1054 sh_funcs.append('%s' % lineinfo.get()) 1055 sh_funcs.append(' ss[%u].str("addr");' % (index)) 1056 else: 1057 sh_funcs.append('%s' % lineinfo.get()) 1058 sh_funcs.append(' ss[%u] << "0x" << &pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1059 elif self.struct_dict[s][m]['array']: 1060 sh_funcs.append('%s' % lineinfo.get()) 1061 sh_funcs.append(' ss[%u] << "0x" << (void*)pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1062 elif 'bool' in self.struct_dict[s][m]['type'].lower(): 1063 sh_funcs.append('%s' % lineinfo.get()) 1064 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name'])) 1065 elif 'uint8' in self.struct_dict[s][m]['type'].lower(): 1066 sh_funcs.append('%s' % lineinfo.get()) 1067 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1068 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']: 1069 sh_funcs.append('%s' % lineinfo.get()) 1070 sh_funcs.append(' if (StreamControl::writeAddress)') 1071 sh_funcs.append(' ss[%u] << "0x" << pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1072 sh_funcs.append(' else') 1073 sh_funcs.append(' ss[%u].str("address");' % (index)) 1074 elif 'char' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']: 1075 sh_funcs.append('%s' % lineinfo.get()) 1076 sh_funcs.append(' if (pStruct->%s != NULL) {' % self.struct_dict[s][m]['name']) 1077 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1078 sh_funcs.append(' } else {') 1079 sh_funcs.append(' ss[%u] << "";' % index) 1080 sh_funcs.append(' }') 1081 else: 1082 if self.struct_dict[s][m]['ptr'] or \ 1083 'Vk' in self.struct_dict[s][m]['full_type'] or \ 1084 'PFN_vk' in self.struct_dict[s][m]['full_type']: 1085 sh_funcs.append('%s' % lineinfo.get()) 1086 sh_funcs.append(' ss[%u] << "0x" << pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1087 elif any (x in self.struct_dict[s][m]['name'].lower() for x in ("flag", "bit", "offset", "handle", "buffer", "object", "mask")) or \ 1088 'ID' in self.struct_dict[s][m]['name']: 1089 sh_funcs.append('%s: NB: Edit here to choose hex vs dec output by variable name' % lineinfo.get()) 1090 sh_funcs.append(' ss[%u] << "0x" << pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1091 else: 1092 sh_funcs.append('%s: NB Edit this section to choose hex vs dec output by variable name' % lineinfo.get()) 1093 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name'])) 1094 value_print = 'ss[%u].str()' % index 1095 index += 1 1096 else: 1097 # For an non-empty array of enums just print address w/ note that array will be displayed below 1098 if self.struct_dict[s][m]['ptr']: 1099 sh_funcs.append('%s' % lineinfo.get()) 1100 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name'])) 1101 sh_funcs.append(' ss[%u] << "0x" << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name'])) 1102 sh_funcs.append(' else') 1103 sh_funcs.append(' ss[%u].str("NULL");' % (index)) 1104 value_print = 'ss[%u].str()' % index 1105 index += 1 1106 # For single enum just print the string representation 1107 else: 1108 value_print = 'string_%s(pStruct->%s)' % (self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name']) 1109 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print) 1110 final_str = final_str[3:] # strip off the initial ' + ' 1111 if 0 != num_stps: # Append data for any embedded structs 1112 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))]) 1113 sh_funcs.append('%s' % lineinfo.get()) 1114 sh_funcs.append(' final_str = %s;' % final_str) 1115 sh_funcs.append(' return final_str;\n}') 1116 1117 # End of platform wrapped section 1118 add_platform_wrapper_exit(sh_funcs, typedef_fwd_dict[s]) 1119 1120 # Add function to return a string value for input void* 1121 sh_funcs.append('%s' % lineinfo.get()) 1122 sh_funcs.append("std::string string_convert_helper(const void* toString, const std::string prefix)\n{") 1123 sh_funcs.append(" using namespace StreamControl;") 1124 sh_funcs.append(" using namespace std;") 1125 sh_funcs.append(" stringstream ss;") 1126 sh_funcs.append(' ss << toString;') 1127 sh_funcs.append(' string final_str = prefix + ss.str();') 1128 sh_funcs.append(" return final_str;") 1129 sh_funcs.append("}") 1130 sh_funcs.append('%s' % lineinfo.get()) 1131 # Add function to return a string value for input uint64_t 1132 sh_funcs.append("std::string string_convert_helper(const uint64_t toString, const std::string prefix)\n{") 1133 sh_funcs.append(" using namespace StreamControl;") 1134 sh_funcs.append(" using namespace std;") 1135 sh_funcs.append(" stringstream ss;") 1136 sh_funcs.append(' ss << toString;') 1137 sh_funcs.append(' string final_str = prefix + ss.str();') 1138 sh_funcs.append(" return final_str;") 1139 sh_funcs.append("}") 1140 sh_funcs.append('%s' % lineinfo.get()) 1141 # Add function to return a string value for input VkSurfaceFormatKHR* 1142 sh_funcs.append("std::string string_convert_helper(VkSurfaceFormatKHR toString, const std::string prefix)\n{") 1143 sh_funcs.append(" using namespace std;") 1144 sh_funcs.append(' string final_str = prefix + "format = " + string_VkFormat(toString.format) + "format = " + string_VkColorSpaceKHR(toString.colorSpace);') 1145 sh_funcs.append(" return final_str;") 1146 sh_funcs.append("}") 1147 sh_funcs.append('%s' % lineinfo.get()) 1148 # Add function to dynamically print out unknown struct 1149 sh_funcs.append("std::string dynamic_display(const void* pStruct, const std::string prefix)\n{") 1150 sh_funcs.append(" using namespace std;") 1151 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct") 1152 sh_funcs.append(" if (pStruct == NULL) {\n") 1153 sh_funcs.append(" return string();") 1154 sh_funcs.append(" }\n") 1155 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;") 1156 sh_funcs.append(' string indent = " ";') 1157 sh_funcs.append(' indent += prefix;') 1158 sh_funcs.append(" switch (sType)\n {") 1159 for e in enum_type_dict: 1160 if "StructureType" in e: 1161 for v in sorted(enum_type_dict[e]): 1162 struct_name = get_struct_name_from_struct_type(v) 1163 if struct_name not in self.struct_dict: 1164 continue 1165 print_func_name = self._get_sh_func_name(struct_name) 1166 #sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s])) 1167 sh_funcs.append(' case %s:\n {' % (v)) 1168 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name)) 1169 sh_funcs.append(' }') 1170 sh_funcs.append(' break;') 1171 sh_funcs.append(" default:") 1172 sh_funcs.append(" return string();") 1173 sh_funcs.append('%s' % lineinfo.get()) 1174 sh_funcs.append(" }") 1175 sh_funcs.append("}") 1176 return "\n".join(sh_funcs) 1177 1178 def _genStructMemberPrint(self, member, s, array, struct_array): 1179 (p_out, p_arg) = self._get_struct_print_formatted(self.struct_dict[s][member], pre_var_name="&m_dummy_prefix", struct_var_name="m_struct", struct_ptr=False, print_array=True) 1180 extra_indent = "" 1181 if array: 1182 extra_indent = " " 1183 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now 1184 struct_array.insert(0, self.struct_dict[s][member]) 1185 elif self.struct_dict[s][member]['ptr']: 1186 # Special case for void* named "pNext" 1187 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']: 1188 struct_array.insert(0, self.struct_dict[s][member]) 1189 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array) 1190 1191 def _generateDisplayDefinitions(self, s): 1192 disp_def = [] 1193 struct_array = [] 1194 # Single-line struct print function 1195 disp_def.append("// Output 'structname = struct_address' on a single line") 1196 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s)) 1197 disp_def.append(' printf(" %%*s%s = 0x%%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s]) 1198 disp_def.append("}\n") 1199 # Private helper function to print struct members 1200 disp_def.append("// Private helper function that displays the members of the wrapped struct") 1201 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s)) 1202 i_declared = False 1203 for member in sorted(self.struct_dict[s]): 1204 # TODO : Need to display each member based on its type 1205 # TODO : Need to handle pNext which are structs, but of void* type 1206 # Can grab struct type off of header of struct pointed to 1207 # TODO : Handle Arrays 1208 if self.struct_dict[s][member]['array']: 1209 # Create for loop to print each element of array 1210 if not i_declared: 1211 disp_def.append(' uint32_t i;') 1212 i_declared = True 1213 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size']) 1214 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array) 1215 disp_def.append(return_str) 1216 disp_def.append(' }') 1217 else: 1218 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array) 1219 disp_def.append(return_str) 1220 disp_def.append("}\n") 1221 i_declared = False 1222 # Basic print function to display struct members 1223 disp_def.append("// Output all struct elements, each on their own line") 1224 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s)) 1225 disp_def.append(' printf("%%*s%s struct contents at 0x%%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s]) 1226 disp_def.append(' this->display_struct_members();') 1227 disp_def.append("}\n") 1228 # Advanced print function to display current struct and contents of any pointed-to structs 1229 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents") 1230 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s)) 1231 disp_def.append(' printf("%%*s%s struct contents at 0x%%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s]) 1232 disp_def.append(' this->display_struct_members();') 1233 class_num = 0 1234 # TODO : Need to handle arrays of structs here 1235 for ms in struct_array: 1236 swc_name = "class%s" % str(class_num) 1237 if ms['array']: 1238 if not i_declared: 1239 disp_def.append(' uint32_t i;') 1240 i_declared = True 1241 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size']) 1242 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name'])) 1243 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name'])) 1244 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name)) 1245 disp_def.append(" %s.display_full_txt();" % (swc_name)) 1246 #disp_def.append(' }') 1247 disp_def.append(' }') 1248 elif 'pNext' == ms['name']: 1249 # Need some code trickery here 1250 # I'm thinking have a generated function that takes pNext ptr value 1251 # then it checks sType and in large switch statement creates appropriate 1252 # wrapper class type and then prints contents 1253 disp_def.append(" if (m_struct.%s) {" % (ms['name'])) 1254 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");') 1255 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name'])) 1256 disp_def.append(" }") 1257 else: 1258 if ms['ptr']: 1259 disp_def.append(" if (m_struct.%s) {" % (ms['name'])) 1260 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name'])) 1261 else: 1262 disp_def.append(" if (&m_struct.%s) {" % (ms['name'])) 1263 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name'])) 1264 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name)) 1265 disp_def.append(" %s.display_full_txt();\n }" % (swc_name)) 1266 class_num += 1 1267 disp_def.append("}\n") 1268 return "\n".join(disp_def) 1269 1270 def _generateStringHelperHeader(self): 1271 header = [] 1272 header.append("//#includes, #defines, globals and such...\n") 1273 for f in self.include_headers: 1274 if 'vk_enum_string_helper' not in f: 1275 header.append("#include <%s>\n" % f) 1276 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n') 1277 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n") 1278 return "".join(header) 1279 1280 def _generateStringHelperHeaderCpp(self): 1281 header = [] 1282 header.append("//#includes, #defines, globals and such...\n") 1283 for f in self.include_headers: 1284 if 'vk_enum_string_helper' not in f: 1285 header.append("#include <%s>\n" % f) 1286 header.append('#include "vk_enum_string_helper.h"\n') 1287 header.append('namespace StreamControl\n') 1288 header.append('{\n') 1289 header.append('bool writeAddress = true;\n') 1290 header.append('template <typename T>\n') 1291 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n') 1292 header.append('{\n') 1293 header.append(' if(writeAddress)\n') 1294 header.append(' {\n') 1295 header.append(' out.operator<<(pointer);\n') 1296 header.append(' }\n') 1297 header.append(' else\n') 1298 header.append(' {\n') 1299 header.append(' std::operator<<(out, "address");\n') 1300 header.append(' }\n') 1301 header.append(' return out;\n') 1302 header.append('}\n') 1303 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n') 1304 header.append('{\n') 1305 header.append(' return std::operator<<(out, s);\n') 1306 header.append('}\n') 1307 header.append('}\n') 1308 header.append('\n') 1309 header.append("std::string dynamic_display(const void* pStruct, const std::string prefix);\n") 1310 return "".join(header) 1311 1312 def _generateValidateHelperFunctions(self): 1313 sh_funcs = [] 1314 # We do two passes, first pass just generates prototypes for all the functsions 1315 for s in sorted(self.struct_dict): 1316 1317 # Wrap this in platform check since it may contain undefined structs or functions 1318 add_platform_wrapper_entry(sh_funcs, typedef_fwd_dict[s]) 1319 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s])) 1320 add_platform_wrapper_exit(sh_funcs, typedef_fwd_dict[s]) 1321 1322 sh_funcs.append('\n') 1323 for s in sorted(self.struct_dict): 1324 1325 # Wrap this in platform check since it may contain undefined structs or functions 1326 add_platform_wrapper_entry(sh_funcs, typedef_fwd_dict[s]) 1327 1328 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s])) 1329 for m in sorted(self.struct_dict[s]): 1330 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct 1331 if is_type(self.struct_dict[s][m]['type'], 'enum') and not self.struct_dict[s][m]['ptr']: 1332 sh_funcs.append(' if (!validate_%s(pStruct->%s))\n return 0;' % (self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name'])) 1333 # TODO : Need a little refinement to this code to make sure type of struct matches expected input (ptr, const...) 1334 if is_type(self.struct_dict[s][m]['type'], 'struct'): 1335 if (self.struct_dict[s][m]['ptr']): 1336 sh_funcs.append(' if (pStruct->%s && !%s((const %s*)pStruct->%s))\n return 0;' % (self.struct_dict[s][m]['name'], self._get_vh_func_name(self.struct_dict[s][m]['type']), self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name'])) 1337 else: 1338 sh_funcs.append(' if (!%s((const %s*)&pStruct->%s))\n return 0;' % (self._get_vh_func_name(self.struct_dict[s][m]['type']), self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name'])) 1339 sh_funcs.append(" return 1;\n}") 1340 1341 # End of platform wrapped section 1342 add_platform_wrapper_exit(sh_funcs, typedef_fwd_dict[s]) 1343 1344 return "\n".join(sh_funcs) 1345 1346 def _generateValidateHelperHeader(self): 1347 header = [] 1348 header.append("//#includes, #defines, globals and such...\n") 1349 for f in self.include_headers: 1350 if 'vk_enum_validate_helper' not in f: 1351 header.append("#include <%s>\n" % f) 1352 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n') 1353 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n") 1354 return "".join(header) 1355 1356 def _generateSizeHelperFunctions(self): 1357 sh_funcs = [] 1358 # just generates prototypes for all the functions 1359 for s in sorted(self.struct_dict): 1360 1361 # Wrap this in platform check since it may contain undefined structs or functions 1362 add_platform_wrapper_entry(sh_funcs, typedef_fwd_dict[s]) 1363 sh_funcs.append('size_t %s(const %s* pStruct);' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s])) 1364 add_platform_wrapper_exit(sh_funcs, typedef_fwd_dict[s]) 1365 1366 return "\n".join(sh_funcs) 1367 1368 1369 def _generateSizeHelperFunctionsC(self): 1370 sh_funcs = [] 1371 # generate function definitions 1372 for s in sorted(self.struct_dict): 1373 1374 # Wrap this in platform check since it may contain undefined structs or functions 1375 add_platform_wrapper_entry(sh_funcs, typedef_fwd_dict[s]) 1376 1377 skip_list = [] # Used when struct elements need to be skipped because size already accounted for 1378 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s])) 1379 indent = ' ' 1380 sh_funcs.append('%ssize_t structSize = 0;' % (indent)) 1381 sh_funcs.append('%sif (pStruct) {' % (indent)) 1382 indent = ' ' 1383 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s])) 1384 i_decl = False 1385 for m in sorted(self.struct_dict[s]): 1386 if m in skip_list: 1387 continue 1388 if self.struct_dict[s][m]['dyn_array']: 1389 if self.struct_dict[s][m]['full_type'].count('*') > 1: 1390 if not is_type(self.struct_dict[s][m]['type'], 'struct') and not 'char' in self.struct_dict[s][m]['type'].lower(): 1391 if 'ppMemoryBarriers' == self.struct_dict[s][m]['name']: 1392 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct 1393 sh_funcs.append('%sstructSize += pStruct->%s*(sizeof(%s*) + sizeof(VkImageMemoryBarrier));' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type'])) 1394 else: 1395 sh_funcs.append('%sstructSize += pStruct->%s*(sizeof(%s*) + sizeof(%s));' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type'], self.struct_dict[s][m]['type'])) 1396 else: # This is an array of char* or array of struct ptrs 1397 if not i_decl: 1398 sh_funcs.append('%suint32_t i = 0;' % (indent)) 1399 i_decl = True 1400 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size'])) 1401 indent = ' ' 1402 if is_type(self.struct_dict[s][m]['type'], 'struct'): 1403 sh_funcs.append('%sstructSize += (sizeof(%s*) + %s(pStruct->%s[i]));' % (indent, self.struct_dict[s][m]['type'], self._get_size_helper_func_name(self.struct_dict[s][m]['type']), self.struct_dict[s][m]['name'])) 1404 else: 1405 sh_funcs.append('%sstructSize += (sizeof(char*) + (sizeof(char) * (1 + strlen(pStruct->%s[i]))));' % (indent, self.struct_dict[s][m]['name'])) 1406 indent = ' ' 1407 sh_funcs.append('%s}' % (indent)) 1408 else: 1409 if is_type(self.struct_dict[s][m]['type'], 'struct'): 1410 if not i_decl: 1411 sh_funcs.append('%suint32_t i = 0;' % (indent)) 1412 i_decl = True 1413 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size'])) 1414 indent = ' ' 1415 sh_funcs.append('%sstructSize += %s(&pStruct->%s[i]);' % (indent, self._get_size_helper_func_name(self.struct_dict[s][m]['type']), self.struct_dict[s][m]['name'])) 1416 indent = ' ' 1417 sh_funcs.append('%s}' % (indent)) 1418 else: 1419 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type'])) 1420 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']: 1421 if 'char' in self.struct_dict[s][m]['type'].lower(): 1422 sh_funcs.append('%sstructSize += (pStruct->%s != NULL) ? sizeof(%s)*(1+strlen(pStruct->%s)) : 0;' % (indent, self.struct_dict[s][m]['name'], self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name'])) 1423 elif is_type(self.struct_dict[s][m]['type'], 'struct'): 1424 sh_funcs.append('%sstructSize += %s(pStruct->%s);' % (indent, self._get_size_helper_func_name(self.struct_dict[s][m]['type']), self.struct_dict[s][m]['name'])) 1425 elif 'void' not in self.struct_dict[s][m]['type'].lower(): 1426 if (self.struct_dict[s][m]['type'] != 'xcb_connection_t'): 1427 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type'])) 1428 elif 'size_t' == self.struct_dict[s][m]['type'].lower(): 1429 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name'])) 1430 skip_list.append(m+1) 1431 indent = ' ' 1432 sh_funcs.append('%s}' % (indent)) 1433 sh_funcs.append("%sreturn structSize;\n}" % (indent)) 1434 1435 # End of platform wrapped section 1436 add_platform_wrapper_exit(sh_funcs, typedef_fwd_dict[s]) 1437 1438 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs) 1439 if '_debug_' not in self.header_filename: 1440 for follow_chain in [True, False]: 1441 sh_funcs.append('%s' % self.lineinfo.get()) 1442 if follow_chain: 1443 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{') 1444 else: 1445 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{') 1446 indent = ' ' 1447 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent)) 1448 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent)) 1449 sh_funcs.append('%ssize_t structSize = 0;' % (indent)) 1450 if follow_chain: 1451 sh_funcs.append('%swhile (pNext) {' % (indent)) 1452 indent = ' ' 1453 sh_funcs.append('%sswitch (pNext->sType) {' % (indent)) 1454 indent += ' ' 1455 for e in enum_type_dict: 1456 if 'StructureType' in e: 1457 for v in sorted(enum_type_dict[e]): 1458 struct_name = get_struct_name_from_struct_type(v) 1459 if struct_name not in self.struct_dict: 1460 continue 1461 1462 sh_funcs.append('%scase %s:' % (indent, v)) 1463 sh_funcs.append('%s{' % (indent)) 1464 indent += ' ' 1465 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name)) 1466 sh_funcs.append('%sbreak;' % (indent)) 1467 indent = indent[:-4] 1468 sh_funcs.append('%s}' % (indent)) 1469 sh_funcs.append('%sdefault:' % (indent)) 1470 indent += ' ' 1471 sh_funcs.append('%sassert(0);' % (indent)) 1472 sh_funcs.append('%sstructSize += 0;' % (indent)) 1473 indent = indent[:-4] 1474 indent = indent[:-4] 1475 sh_funcs.append('%s}' % (indent)) 1476 if follow_chain: 1477 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent)) 1478 indent = indent[:-4] 1479 sh_funcs.append('%s}' % (indent)) 1480 sh_funcs.append('%sreturn structSize;\n}' % indent) 1481 return "\n".join(sh_funcs) 1482 1483 def _generateSizeHelperHeader(self): 1484 header = [] 1485 header.append("//#includes, #defines, globals and such...\n") 1486 for f in self.include_headers: 1487 header.append("#include <%s>\n" % f) 1488 header.append('\n// Function Prototypes\n') 1489 header.append("size_t get_struct_chain_size(const void* pStruct);\n") 1490 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n") 1491 return "".join(header) 1492 1493 def _generateSizeHelperHeaderC(self): 1494 header = [] 1495 header.append('#include "vk_struct_size_helper.h"') 1496 header.append('#include <string.h>') 1497 header.append('#include <assert.h>') 1498 header.append('\n// Function definitions\n') 1499 return "\n".join(header) 1500 1501 1502 def _generateHeader(self): 1503 header = [] 1504 header.append("//#includes, #defines, globals and such...\n") 1505 for f in self.include_headers: 1506 header.append("#include <%s>\n" % f) 1507 return "".join(header) 1508 1509 # Declarations 1510 def _generateConstructorDeclarations(self, s): 1511 constructors = [] 1512 constructors.append(" %s();\n" % self.get_class_name(s)) 1513 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s])) 1514 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s])) 1515 return "".join(constructors) 1516 1517 def _generateDestructorDeclarations(self, s): 1518 return " virtual ~%s();\n" % self.get_class_name(s) 1519 1520 def _generateDisplayDeclarations(self, s): 1521 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n" 1522 1523 def _generateGetSetDeclarations(self, s): 1524 get_set = [] 1525 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n") 1526 for member in sorted(self.struct_dict[s]): 1527 # TODO : Skipping array set/get funcs for now 1528 if self.struct_dict[s][member]['array']: 1529 continue 1530 get_set.append(" %s get_%s() { return m_struct.%s; }\n" % (self.struct_dict[s][member]['full_type'], self.struct_dict[s][member]['name'], self.struct_dict[s][member]['name'])) 1531 if not self.struct_dict[s][member]['const']: 1532 get_set.append(" void set_%s(%s inValue) { m_struct.%s = inValue; }\n" % (self.struct_dict[s][member]['name'], self.struct_dict[s][member]['full_type'], self.struct_dict[s][member]['name'])) 1533 return "".join(get_set) 1534 1535 def _generatePrivateMembers(self, s): 1536 priv = [] 1537 priv.append("\nprivate:\n") 1538 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s]) 1539 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s]) 1540 priv.append(" uint32_t m_indent;\n") 1541 priv.append(" const char m_dummy_prefix;\n") 1542 priv.append(" void display_struct_members();\n") 1543 return "".join(priv) 1544 1545 def _generateClassDeclaration(self): 1546 class_decl = [] 1547 for s in sorted(self.struct_dict): 1548 class_decl.append("\n//class declaration") 1549 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s)) 1550 class_decl.append(self._generateConstructorDeclarations(s)) 1551 class_decl.append(self._generateDestructorDeclarations(s)) 1552 class_decl.append(self._generateDisplayDeclarations(s)) 1553 class_decl.append(self._generateGetSetDeclarations(s)) 1554 class_decl.append(self._generatePrivateMembers(s)) 1555 class_decl.append("};\n") 1556 return "\n".join(class_decl) 1557 1558 def _generateFooter(self): 1559 return "\n//any footer info for class\n" 1560 1561 def _getSafeStructName(self, struct): 1562 return "safe_%s" % (struct) 1563 1564 # If struct has sType or ptr members, generate safe type 1565 def _hasSafeStruct(self, s): 1566 exceptions = ['VkPhysicalDeviceFeatures', 'VkPipelineColorBlendStateCreateInfo', 'VkDebugMarkerMarkerInfoEXT'] 1567 if s in exceptions: 1568 return False 1569 if 'sType' == self.struct_dict[s][0]['name']: 1570 return True 1571 for m in self.struct_dict[s]: 1572 if self.struct_dict[s][m]['ptr']: 1573 return True 1574 return False 1575 1576 def _generateSafeStructHeader(self): 1577 header = [] 1578 header.append("//#includes, #defines, globals and such...\n") 1579 header.append('#pragma once\n') 1580 header.append('#include "vulkan/vulkan.h"') 1581 return "".join(header) 1582 1583 # If given ty is in obj list, or is a struct that contains anything in obj list, return True 1584 def _typeHasObject(self, ty, obj): 1585 if ty in obj: 1586 return True 1587 if is_type(ty, 'struct'): 1588 for m in self.struct_dict[ty]: 1589 if self.struct_dict[ty][m]['type'] in obj: 1590 return True 1591 return False 1592 1593 def _generateSafeStructDecls(self): 1594 ss_decls = [] 1595 for s in struct_order_list: 1596 if not self._hasSafeStruct(s): 1597 continue 1598 if s in ifdef_dict: 1599 ss_decls.append('#ifdef %s' % ifdef_dict[s]) 1600 ss_name = self._getSafeStructName(s) 1601 ss_decls.append("\nstruct %s {" % (ss_name)) 1602 for m in sorted(self.struct_dict[s]): 1603 m_type = self.struct_dict[s][m]['type'] 1604 if is_type(m_type, 'struct') and self._hasSafeStruct(m_type): 1605 m_type = self._getSafeStructName(m_type) 1606 if self.struct_dict[s][m]['array_size'] != 0 and not self.struct_dict[s][m]['dyn_array']: 1607 ss_decls.append(" %s %s[%s];" % (m_type, self.struct_dict[s][m]['name'], self.struct_dict[s][m]['array_size'])) 1608 elif self.struct_dict[s][m]['ptr'] and 'safe_' not in m_type and not self._typeHasObject(m_type, vulkan.object_non_dispatch_list):#m_type in ['char', 'float', 'uint32_t', 'void', 'VkPhysicalDeviceFeatures']: # We'll never overwrite char* so it can remain const 1609 ss_decls.append(" %s %s;" % (self.struct_dict[s][m]['full_type'], self.struct_dict[s][m]['name'])) 1610 elif self.struct_dict[s][m]['array']: 1611 ss_decls.append(" %s* %s;" % (m_type, self.struct_dict[s][m]['name'])) 1612 elif self.struct_dict[s][m]['ptr']: 1613 ss_decls.append(" %s* %s;" % (m_type, self.struct_dict[s][m]['name'])) 1614 else: 1615 ss_decls.append(" %s %s;" % (m_type, self.struct_dict[s][m]['name'])) 1616 ss_decls.append(" %s(const %s* pInStruct);" % (ss_name, s)) 1617 ss_decls.append(" %s(const %s& src);" % (ss_name, ss_name)) # Copy constructor 1618 ss_decls.append(" %s();" % (ss_name)) # Default constructor 1619 ss_decls.append(" ~%s();" % (ss_name)) 1620 ss_decls.append(" void initialize(const %s* pInStruct);" % (s)) 1621 ss_decls.append(" void initialize(const %s* src);" % (ss_name)) 1622 ss_decls.append(" %s *ptr() { return reinterpret_cast<%s *>(this); }" % (s, s)) 1623 ss_decls.append(" %s const *ptr() const { return reinterpret_cast<%s const *>(this); }" % (s, s)) 1624 ss_decls.append("};") 1625 if s in ifdef_dict: 1626 ss_decls.append('#endif') 1627 return "\n".join(ss_decls) 1628 1629 def _generateSafeStructSourceHeader(self): 1630 header = [] 1631 header.append("//#includes, #defines, globals and such...\n") 1632 header.append('#include "vk_safe_struct.h"\n#include <string.h>\n\n') 1633 return "".join(header) 1634 1635 def _generateSafeStructSource(self): 1636 ss_src = [] 1637 for s in struct_order_list: 1638 if not self._hasSafeStruct(s): 1639 continue 1640 if s in ifdef_dict: 1641 ss_src.append('#ifdef %s' % ifdef_dict[s]) 1642 ss_name = self._getSafeStructName(s) 1643 init_list = '' # list of members in struct constructor initializer 1644 init_func_txt = '' # Txt for initialize() function that takes struct ptr and inits members 1645 construct_txt = '' # Body of constuctor as well as body of initialize() func following init_func_txt 1646 destruct_txt = '' 1647 # VkWriteDescriptorSet is special case because pointers may be non-null but ignored 1648 # TODO : This is ugly, figure out better way to do this 1649 custom_construct_txt = {'VkWriteDescriptorSet' : 1650 ' switch (descriptorType) {\n' 1651 ' case VK_DESCRIPTOR_TYPE_SAMPLER:\n' 1652 ' case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:\n' 1653 ' case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:\n' 1654 ' case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:\n' 1655 ' case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:\n' 1656 ' if (descriptorCount && pInStruct->pImageInfo) {\n' 1657 ' pImageInfo = new VkDescriptorImageInfo[descriptorCount];\n' 1658 ' for (uint32_t i=0; i<descriptorCount; ++i) {\n' 1659 ' pImageInfo[i] = pInStruct->pImageInfo[i];\n' 1660 ' }\n' 1661 ' }\n' 1662 ' break;\n' 1663 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:\n' 1664 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:\n' 1665 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:\n' 1666 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:\n' 1667 ' if (descriptorCount && pInStruct->pBufferInfo) {\n' 1668 ' pBufferInfo = new VkDescriptorBufferInfo[descriptorCount];\n' 1669 ' for (uint32_t i=0; i<descriptorCount; ++i) {\n' 1670 ' pBufferInfo[i] = pInStruct->pBufferInfo[i];\n' 1671 ' }\n' 1672 ' }\n' 1673 ' break;\n' 1674 ' case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:\n' 1675 ' case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:\n' 1676 ' if (descriptorCount && pInStruct->pTexelBufferView) {\n' 1677 ' pTexelBufferView = new VkBufferView[descriptorCount];\n' 1678 ' for (uint32_t i=0; i<descriptorCount; ++i) {\n' 1679 ' pTexelBufferView[i] = pInStruct->pTexelBufferView[i];\n' 1680 ' }\n' 1681 ' }\n' 1682 ' break;\n' 1683 ' default:\n' 1684 ' break;\n' 1685 ' }\n'} 1686 for m in self.struct_dict[s]: 1687 m_name = self.struct_dict[s][m]['name'] 1688 m_type = self.struct_dict[s][m]['type'] 1689 if is_type(m_type, 'struct') and self._hasSafeStruct(m_type): 1690 m_type = self._getSafeStructName(m_type) 1691 if self.struct_dict[s][m]['ptr'] and 'safe_' not in m_type and not self._typeHasObject(m_type, vulkan.object_non_dispatch_list):# in ['char', 'float', 'uint32_t', 'void', 'VkPhysicalDeviceFeatures']) or 'pp' == self.struct_dict[s][m]['name'][0:1]: 1692 # Ptr types w/o a safe_struct, for non-null case need to allocate new ptr and copy data in 1693 if 'KHR' in ss_name or m_type in ['void', 'char']: 1694 # For these exceptions just copy initial value over for now 1695 init_list += '\n\t%s(pInStruct->%s),' % (m_name, m_name) 1696 init_func_txt += ' %s = pInStruct->%s;\n' % (m_name, m_name) 1697 else: 1698 init_list += '\n\t%s(nullptr),' % (m_name) 1699 init_func_txt += ' %s = nullptr;\n' % (m_name) 1700 if 'pNext' != m_name and 'void' not in m_type: 1701 if not self.struct_dict[s][m]['array']: 1702 construct_txt += ' if (pInStruct->%s) {\n' % (m_name) 1703 construct_txt += ' %s = new %s(*pInStruct->%s);\n' % (m_name, m_type, m_name) 1704 construct_txt += ' }\n' 1705 destruct_txt += ' if (%s)\n' % (m_name) 1706 destruct_txt += ' delete %s;\n' % (m_name) 1707 else: # new array and then init each element 1708 construct_txt += ' if (pInStruct->%s) {\n' % (m_name) 1709 construct_txt += ' %s = new %s[pInStruct->%s];\n' % (m_name, m_type, self.struct_dict[s][m]['array_size']) 1710 #construct_txt += ' std::copy (pInStruct->%s, pInStruct->%s+pInStruct->%s, %s);\n' % (m_name, m_name, self.struct_dict[s][m]['array_size'], m_name) 1711 construct_txt += ' memcpy ((void *)%s, (void *)pInStruct->%s, sizeof(%s)*pInStruct->%s);\n' % (m_name, m_name, m_type, self.struct_dict[s][m]['array_size']) 1712 construct_txt += ' }\n' 1713 destruct_txt += ' if (%s)\n' % (m_name) 1714 destruct_txt += ' delete[] %s;\n' % (m_name) 1715 elif self.struct_dict[s][m]['array']: 1716 # Init array ptr to NULL 1717 init_list += '\n\t%s(NULL),' % (m_name) 1718 init_func_txt += ' %s = NULL;\n' % (m_name) 1719 array_element = 'pInStruct->%s[i]' % (m_name) 1720 if is_type(self.struct_dict[s][m]['type'], 'struct') and self._hasSafeStruct(self.struct_dict[s][m]['type']): 1721 array_element = '%s(&pInStruct->%s[i])' % (self._getSafeStructName(self.struct_dict[s][m]['type']), m_name) 1722 construct_txt += ' if (%s && pInStruct->%s) {\n' % (self.struct_dict[s][m]['array_size'], m_name) 1723 construct_txt += ' %s = new %s[%s];\n' % (m_name, m_type, self.struct_dict[s][m]['array_size']) 1724 destruct_txt += ' if (%s)\n' % (m_name) 1725 destruct_txt += ' delete[] %s;\n' % (m_name) 1726 construct_txt += ' for (uint32_t i=0; i<%s; ++i) {\n' % (self.struct_dict[s][m]['array_size']) 1727 if 'safe_' in m_type: 1728 construct_txt += ' %s[i].initialize(&pInStruct->%s[i]);\n' % (m_name, m_name) 1729 else: 1730 construct_txt += ' %s[i] = %s;\n' % (m_name, array_element) 1731 construct_txt += ' }\n' 1732 construct_txt += ' }\n' 1733 elif self.struct_dict[s][m]['ptr']: 1734 construct_txt += ' if (pInStruct->%s)\n' % (m_name) 1735 construct_txt += ' %s = new %s(pInStruct->%s);\n' % (m_name, m_type, m_name) 1736 construct_txt += ' else\n' 1737 construct_txt += ' %s = NULL;\n' % (m_name) 1738 destruct_txt += ' if (%s)\n' % (m_name) 1739 destruct_txt += ' delete %s;\n' % (m_name) 1740 elif 'safe_' in m_type: # inline struct, need to pass in reference for constructor 1741 init_list += '\n\t%s(&pInStruct->%s),' % (m_name, m_name) 1742 init_func_txt += ' %s.initialize(&pInStruct->%s);\n' % (m_name, m_name) 1743 else: 1744 init_list += '\n\t%s(pInStruct->%s),' % (m_name, m_name) 1745 init_func_txt += ' %s = pInStruct->%s;\n' % (m_name, m_name) 1746 if '' != init_list: 1747 init_list = init_list[:-1] # hack off final comma 1748 if s in custom_construct_txt: 1749 construct_txt = custom_construct_txt[s] 1750 ss_src.append("\n%s::%s(const %s* pInStruct) : %s\n{\n%s}" % (ss_name, ss_name, s, init_list, construct_txt)) 1751 ss_src.append("\n%s::%s() {}" % (ss_name, ss_name)) 1752 # Create slight variation of init and construct txt for copy constructor that takes a src object reference vs. struct ptr 1753 copy_construct_init = init_func_txt.replace('pInStruct->', 'src.') 1754 copy_construct_txt = construct_txt.replace(' (pInStruct->', ' (src.') # Exclude 'if' blocks from next line 1755 copy_construct_txt = copy_construct_txt.replace('(pInStruct->', '(*src.') # Pass object to copy constructors 1756 copy_construct_txt = copy_construct_txt.replace('pInStruct->', 'src.') # Modify remaining struct refs for src object 1757 ss_src.append("\n%s::%s(const %s& src)\n{\n%s%s}" % (ss_name, ss_name, ss_name, copy_construct_init, copy_construct_txt)) # Copy constructor 1758 ss_src.append("\n%s::~%s()\n{\n%s}" % (ss_name, ss_name, destruct_txt)) 1759 ss_src.append("\nvoid %s::initialize(const %s* pInStruct)\n{\n%s%s}" % (ss_name, s, init_func_txt, construct_txt)) 1760 # Copy initializer uses same txt as copy constructor but has a ptr and not a reference 1761 init_copy = copy_construct_init.replace('src.', 'src->') 1762 init_construct = copy_construct_txt.replace('src.', 'src->') 1763 ss_src.append("\nvoid %s::initialize(const %s* src)\n{\n%s%s}" % (ss_name, ss_name, init_copy, init_construct)) 1764 if s in ifdef_dict: 1765 ss_src.append('#endif') 1766 return "\n".join(ss_src) 1767 1768 class EnumCodeGen: 1769 def __init__(self, enum_type_dict=None, enum_val_dict=None, typedef_fwd_dict=None, in_file=None, out_sh_file=None, out_vh_file=None): 1770 self.et_dict = enum_type_dict 1771 self.ev_dict = enum_val_dict 1772 self.tf_dict = typedef_fwd_dict 1773 self.in_file = in_file 1774 self.out_sh_file = out_sh_file 1775 self.eshfg = CommonFileGen(self.out_sh_file) 1776 self.out_vh_file = out_vh_file 1777 self.evhfg = CommonFileGen(self.out_vh_file) 1778 1779 def generateStringHelper(self): 1780 self.eshfg.setHeader(self._generateSHHeader()) 1781 self.eshfg.setBody(self._generateSHBody()) 1782 self.eshfg.generate() 1783 1784 def generateEnumValidate(self): 1785 self.evhfg.setHeader(self._generateSHHeader()) 1786 self.evhfg.setBody(self._generateVHBody()) 1787 self.evhfg.generate() 1788 1789 def _generateVHBody(self): 1790 body = [] 1791 for bet in sorted(self.et_dict): 1792 fet = self.tf_dict[bet] 1793 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet)) 1794 # TODO : This is not ideal, but allows for flag combinations. Need more rigorous validation of realistic flag combinations 1795 if 'flagbits' in bet.lower(): 1796 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet]))) 1797 body.append(' return 0;') 1798 body.append(' return 1;') 1799 body.append('}\n\n') 1800 else: 1801 body.append(' switch ((%s)input_value)\n {' % (fet)) 1802 for e in sorted(self.et_dict[bet]): 1803 if (self.ev_dict[e]['unique']): 1804 body.append(' case %s:' % (e)) 1805 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n') 1806 return "\n".join(body) 1807 1808 def _generateSHBody(self): 1809 body = [] 1810 # with open(self.out_file, "a") as hf: 1811 # bet == base_enum_type, fet == final_enum_type 1812 for bet in sorted(self.et_dict): 1813 fet = self.tf_dict[bet] 1814 body.append("static inline const char* string_%s(%s input_value)\n{\n switch ((%s)input_value)\n {" % (fet, fet, fet)) 1815 for e in sorted(self.et_dict[bet]): 1816 if (self.ev_dict[e]['unique']): 1817 body.append(' case %s:\n return "%s";' % (e, e)) 1818 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet)) 1819 return "\n".join(body) 1820 1821 def _generateSHHeader(self): 1822 header = [] 1823 header.append('#pragma once\n') 1824 header.append('#ifdef _WIN32\n') 1825 header.append('#pragma warning( disable : 4065 )\n') 1826 header.append('#endif\n') 1827 header.append('#include <vulkan/%s>\n\n\n' % self.in_file) 1828 return "\n".join(header) 1829 1830 1831 class CMakeGen: 1832 def __init__(self, struct_wrapper=None, out_dir=None): 1833 self.sw = struct_wrapper 1834 self.include_headers = [] 1835 self.add_lib_file_list = self.sw.get_file_list() 1836 self.out_dir = out_dir 1837 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt") 1838 self.cmg = CommonFileGen(self.out_file) 1839 1840 def generate(self): 1841 self.cmg.setBody(self._generateBody()) 1842 self.cmg.generate() 1843 1844 def _generateBody(self): 1845 body = [] 1846 body.append("project(%s)" % os.path.basename(self.out_dir)) 1847 body.append("cmake_minimum_required(VERSION 2.8)\n") 1848 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list)) 1849 body.append('set(COMPILE_FLAGS "-fpermissive")') 1850 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n') 1851 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n") 1852 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir)) 1853 return "\n".join(body) 1854 1855 class GraphVizGen: 1856 def __init__(self, struct_dict, prefix, out_dir): 1857 self.struct_dict = struct_dict 1858 self.api = prefix 1859 if prefix == "vulkan": 1860 self.api_prefix = "vk" 1861 else: 1862 self.api_prefix = prefix 1863 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h") 1864 self.gvg = CommonFileGen(self.out_file) 1865 1866 def generate(self): 1867 self.gvg.setCopyright("//This is the copyright\n") 1868 self.gvg.setHeader(self._generateHeader()) 1869 self.gvg.setBody(self._generateBody()) 1870 #self.gvg.setFooter('}') 1871 self.gvg.generate() 1872 1873 def set_include_headers(self, include_headers): 1874 self.include_headers = include_headers 1875 1876 def _generateHeader(self): 1877 header = [] 1878 header.append("//#includes, #defines, globals and such...\n") 1879 for f in self.include_headers: 1880 if 'vk_enum_string_helper' not in f: 1881 header.append("#include <%s>\n" % f) 1882 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n') 1883 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n") 1884 return "".join(header) 1885 1886 def _get_gv_func_name(self, struct): 1887 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_")) 1888 1889 # Return elements to create formatted string for given struct member 1890 def _get_struct_gv_print_formatted(self, struct_member, pre_var_name="", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False, port_label=""): 1891 struct_op = "->" 1892 pre_var_name = '"%s "' % struct_member['full_type'] 1893 if not struct_ptr: 1894 struct_op = "." 1895 member_name = struct_member['name'] 1896 print_type = "p" 1897 cast_type = "" 1898 member_post = "" 1899 array_index = "" 1900 member_print_post = "" 1901 print_delimiter = "%" 1902 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string 1903 print_type = "p" 1904 print_array = False 1905 elif struct_member['array'] and not print_array: 1906 # Just print base address of array when not full print_array 1907 cast_type = "(void*)" 1908 elif is_type(struct_member['type'], 'enum'): 1909 if struct_member['ptr']: 1910 struct_var_name = "*" + struct_var_name 1911 print_delimiter = "0x%" 1912 cast_type = "string_%s" % struct_member['type'] 1913 print_type = "s" 1914 elif is_type(struct_member['type'], 'struct'): # print struct address for now 1915 cast_type = "(void*)" 1916 print_delimiter = "0x%" 1917 if not struct_member['ptr']: 1918 cast_type = "(void*)&" 1919 elif 'bool' in struct_member['type'].lower(): 1920 print_type = "s" 1921 member_post = ' ? "TRUE" : "FALSE"' 1922 elif 'float' in struct_member['type']: 1923 print_type = "f" 1924 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower(): 1925 print_type = '" PRId64 "' 1926 elif 'uint8' in struct_member['type']: 1927 print_type = "hu" 1928 elif 'size' in struct_member['type'].lower(): 1929 print_type = '" PRINTF_SIZE_T_SPECIFIER "' 1930 print_delimiter = "" 1931 elif True in [ui_str.lower() in struct_member['type'].lower() for ui_str in ['uint', 'flags', 'samplemask']]: 1932 print_type = "u" 1933 elif 'int' in struct_member['type']: 1934 print_type = "i" 1935 elif struct_member['ptr']: 1936 print_delimiter = "0x%" 1937 pass 1938 else: 1939 #print("Unhandled struct type: %s" % struct_member['type']) 1940 print_delimiter = "0x%" 1941 cast_type = "(void*)" 1942 if print_array and struct_member['array']: 1943 member_print_post = "[%u]" 1944 array_index = " i," 1945 member_post = "[i]" 1946 print_out = "<TR><TD>%%s%s%s</TD><TD%s>%s%s%s</TD></TR>" % (member_name, member_print_post, port_label, print_delimiter, print_type, postfix) # section of print that goes inside of quotes 1947 print_arg = ", %s,%s %s(%s%s%s)%s\n" % (pre_var_name, array_index, cast_type, struct_var_name, struct_op, member_name, member_post) # section of print passed to portion in quotes 1948 return (print_out, print_arg) 1949 1950 def _generateBody(self): 1951 gv_funcs = [] 1952 array_func_list = [] # structs for which we'll generate an array version of their print function 1953 array_func_list.append('vkbufferviewattachinfo') 1954 array_func_list.append('vkimageviewattachinfo') 1955 array_func_list.append('vksamplerimageviewinfo') 1956 array_func_list.append('vkdescriptortypecount') 1957 # For first pass, generate prototype 1958 for s in sorted(self.struct_dict): 1959 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s])) 1960 if s.lower().strip("_") in array_func_list: 1961 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']: 1962 gv_funcs.append('char* %s_array(uint32_t count, const %s* const* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s])) 1963 else: 1964 gv_funcs.append('char* %s_array(uint32_t count, const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s])) 1965 gv_funcs.append('\n') 1966 for s in sorted(self.struct_dict): 1967 p_out = "" 1968 p_args = "" 1969 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs 1970 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up! 1971 pl_dict = {} 1972 struct_num = 0 1973 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs 1974 for m in sorted(self.struct_dict[s]): 1975 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'): 1976 stp_list.append(self.struct_dict[s][m]) 1977 if 'pNext' == self.struct_dict[s][m]['name']: 1978 pl_dict[m] = ' PORT=\\"pNext\\"' 1979 else: 1980 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num 1981 struct_num += 1 1982 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName)\n{\n char* str;\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s])) 1983 num_stps = len(stp_list); 1984 total_strlen_str = '' 1985 if 0 != num_stps: 1986 gv_funcs.append(" char* tmpStr;\n") 1987 gv_funcs.append(" char nodeName[100];\n") 1988 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps) 1989 for index in range(num_stps): 1990 if (stp_list[index]['ptr']): 1991 if 'pDescriptorInfo' == stp_list[index]['name']: 1992 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n') 1993 else: 1994 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name']) 1995 if 'pNext' == stp_list[index]['name']: 1996 gv_funcs.append(' sprintf(nodeName, "pNext_0x%p", (void*)pStruct->pNext);\n') 1997 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n') 1998 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index) 1999 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index) 2000 gv_funcs.append(' free(tmpStr);\n') 2001 else: 2002 gv_funcs.append(' sprintf(nodeName, "%s_0x%%p", (void*)pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name'])) 2003 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']: 2004 gv_funcs.append(' tmpStr = %s_array(pStruct->count, pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name'])) 2005 else: 2006 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name'])) 2007 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index)) 2008 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index)) 2009 gv_funcs.append(' }\n') 2010 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index)) 2011 elif stp_list[index]['array']: # TODO : For now just printing first element of array 2012 gv_funcs.append(' sprintf(nodeName, "%s_0x%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name'])) 2013 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name'])) 2014 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index)) 2015 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index)) 2016 else: 2017 gv_funcs.append(' sprintf(nodeName, "%s_0x%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name'])) 2018 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name'])) 2019 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index)) 2020 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index)) 2021 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index 2022 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str)) 2023 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (0x%p)</TD></TR>') 2024 p_args = ", myNodeName, myNodeName, pStruct" 2025 for m in sorted(self.struct_dict[s]): 2026 plabel = "" 2027 if m in pl_dict: 2028 plabel = pl_dict[m] 2029 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel) 2030 p_out += p_out1 2031 p_args += p_args1 2032 p_out += '</TABLE>>\\n];\\n\\n"' 2033 p_args += ");\n" 2034 gv_funcs.append(p_out) 2035 gv_funcs.append(p_args) 2036 if 0 != num_stps: 2037 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1)) 2038 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n') 2039 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n') 2040 gv_funcs.append(' free(stp_strs[stp_index]);\n') 2041 gv_funcs.append(' }\n') 2042 gv_funcs.append(' }\n') 2043 gv_funcs.append(" return str;\n}\n") 2044 if s.lower().strip("_") in array_func_list: 2045 ptr_array = False 2046 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']: 2047 ptr_array = True 2048 gv_funcs.append('char* %s_array(uint32_t count, const %s* const* pStruct, const char* myNodeName)\n{\n char* str;\n char tmpStr[1024];\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s])) 2049 else: 2050 gv_funcs.append('char* %s_array(uint32_t count, const %s* pStruct, const char* myNodeName)\n{\n char* str;\n char tmpStr[1024];\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s])) 2051 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n') 2052 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"3\\">%s (0x%p)</TD></TR>", myNodeName, myNodeName, pStruct);\n') 2053 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n') 2054 gv_funcs.append(' sprintf(tmpStr, "'); 2055 p_args = "" 2056 p_out = "" 2057 for m in sorted(self.struct_dict[s]): 2058 plabel = "" 2059 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel) 2060 if 0 == m: # Add array index notation at end of first row 2061 p_out1 = '%s<TD ROWSPAN=\\"%i\\" PORT=\\"slot%%u\\">%%u</TD></TR>' % (p_out1[:-5], len(self.struct_dict[s])) 2062 p_args1 += ', i, i' 2063 p_out += p_out1 2064 p_args += p_args1 2065 p_out += '"' 2066 p_args += ");\n" 2067 if ptr_array: 2068 p_args = p_args.replace('->', '[i]->') 2069 else: 2070 p_args = p_args.replace('->', '[i].') 2071 gv_funcs.append(p_out); 2072 gv_funcs.append(p_args); 2073 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n') 2074 gv_funcs.append(' }\n') 2075 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n') 2076 gv_funcs.append(' return str;\n}\n') 2077 # Add function to dynamically print out unknown struct 2078 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n") 2079 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n") 2080 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n") 2081 gv_funcs.append(" switch (sType)\n {\n") 2082 for e in enum_type_dict: 2083 if "StructureType" in e: 2084 for v in sorted(enum_type_dict[e]): 2085 struct_name = get_struct_name_from_struct_type(v) 2086 if struct_name not in self.struct_dict: 2087 continue 2088 2089 print_func_name = self._get_gv_func_name(struct_name) 2090 # TODO : Hand-coded fixes for some exceptions 2091 #if 'VkPipelineCbStateCreateInfo' in struct_name: 2092 # struct_name = 'VK_PIPELINE_CB_STATE' 2093 if 'VkSemaphoreCreateInfo' in struct_name: 2094 struct_name = 'VkSemaphoreCreateInfo' 2095 print_func_name = self._get_gv_func_name(struct_name) 2096 elif 'VkSemaphoreOpenInfo' in struct_name: 2097 struct_name = 'VkSemaphoreOpenInfo' 2098 print_func_name = self._get_gv_func_name(struct_name) 2099 gv_funcs.append(' case %s:\n' % (v)) 2100 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name)) 2101 #gv_funcs.append(' }\n') 2102 #gv_funcs.append(' break;\n') 2103 gv_funcs.append(" default:\n") 2104 gv_funcs.append(" return NULL;\n") 2105 gv_funcs.append(" }\n") 2106 gv_funcs.append("}") 2107 return "".join(gv_funcs) 2108 2109 2110 2111 2112 2113 # def _generateHeader(self): 2114 # hdr = [] 2115 # hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];') 2116 # hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];') 2117 # hdr.append('edge [\n];\n') 2118 # return "\n".join(hdr) 2119 # 2120 # def _generateBody(self): 2121 # body = [] 2122 # for s in sorted(self.struc_dict): 2123 # field_num = 1 2124 # body.append('"%s" [\nlabel = <<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0"> <TR><TD COLSPAN="2" PORT="f0">%s</TD></TR>' % (s, typedef_fwd_dict[s])) 2125 # for m in sorted(self.struc_dict[s]): 2126 # body.append('<TR><TD PORT="f%i">%s</TD><TD PORT="f%i">%s</TD></TR>' % (field_num, self.struc_dict[s][m]['full_type'], field_num+1, self.struc_dict[s][m]['name'])) 2127 # field_num += 2 2128 # body.append('</TABLE>>\n];\n') 2129 # return "".join(body) 2130 2131 def main(argv=None): 2132 opts = handle_args() 2133 # Parse input file and fill out global dicts 2134 hfp = HeaderFileParser(opts.input_file) 2135 hfp.parse() 2136 # TODO : Don't want these to be global, see note at top about wrapper classes 2137 global enum_val_dict 2138 global enum_type_dict 2139 global struct_dict 2140 global typedef_fwd_dict 2141 global typedef_rev_dict 2142 global types_dict 2143 enum_val_dict = hfp.get_enum_val_dict() 2144 enum_type_dict = hfp.get_enum_type_dict() 2145 struct_dict = hfp.get_struct_dict() 2146 # TODO : Would like to validate struct data here to verify that all of the bools for struct members are correct at this point 2147 typedef_fwd_dict = hfp.get_typedef_fwd_dict() 2148 typedef_rev_dict = hfp.get_typedef_rev_dict() 2149 types_dict = hfp.get_types_dict() 2150 #print(enum_val_dict) 2151 #print(typedef_dict) 2152 #print(struct_dict) 2153 input_header = os.path.basename(opts.input_file) 2154 if 'vulkan.h' == input_header: 2155 input_header = "vulkan/vulkan.h" 2156 2157 prefix = os.path.basename(opts.input_file).strip(".h") 2158 if prefix == "vulkan": 2159 prefix = "vk" 2160 if (opts.abs_out_dir is not None): 2161 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h") 2162 else: 2163 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h") 2164 enum_sh_filename = os.path.abspath(enum_sh_filename) 2165 if not os.path.exists(os.path.dirname(enum_sh_filename)): 2166 print("Creating output dir %s" % os.path.dirname(enum_sh_filename)) 2167 os.mkdir(os.path.dirname(enum_sh_filename)) 2168 if opts.gen_enum_string_helper: 2169 print("Generating enum string helper to %s" % enum_sh_filename) 2170 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h") 2171 print("Generating enum validate helper to %s" % enum_vh_filename) 2172 eg = EnumCodeGen(enum_type_dict, enum_val_dict, typedef_fwd_dict, os.path.basename(opts.input_file), enum_sh_filename, enum_vh_filename) 2173 eg.generateStringHelper() 2174 eg.generateEnumValidate() 2175 #for struct in struct_dict: 2176 #print(struct) 2177 if opts.gen_struct_wrappers: 2178 sw = StructWrapperGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename)) 2179 #print(sw.get_class_name(struct)) 2180 sw.set_include_headers([input_header,os.path.basename(enum_sh_filename),"stdint.h","cinttypes", "stdio.h","stdlib.h"]) 2181 print("Generating struct wrapper header to %s" % sw.header_filename) 2182 sw.generateHeader() 2183 print("Generating struct wrapper class to %s" % sw.class_filename) 2184 sw.generateBody() 2185 sw.generateStringHelper() 2186 sw.generateValidateHelper() 2187 # Generate a 2nd helper file that excludes addrs 2188 sw.set_no_addr(True) 2189 sw.generateStringHelper() 2190 sw.set_no_addr(False) 2191 sw.set_include_headers([input_header,os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h","iostream","sstream","string"]) 2192 sw.set_no_addr(True) 2193 sw.generateStringHelperCpp() 2194 sw.set_no_addr(False) 2195 sw.generateStringHelperCpp() 2196 sw.set_include_headers(["stdio.h", "stdlib.h", input_header]) 2197 sw.generateSizeHelper() 2198 sw.generateSizeHelperC() 2199 sw.generateSafeStructHeader() 2200 sw.generateSafeStructs() 2201 if opts.gen_struct_sizes: 2202 st = StructWrapperGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename)) 2203 st.set_include_headers(["stdio.h", "stdlib.h", input_header]) 2204 st.generateSizeHelper() 2205 st.generateSizeHelperC() 2206 if opts.gen_cmake: 2207 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename)) 2208 cmg.generate() 2209 if opts.gen_graphviz: 2210 gv = GraphVizGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename)) 2211 gv.set_include_headers([input_header,os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h", "cinttypes"]) 2212 gv.generate() 2213 print("DONE!") 2214 #print(typedef_rev_dict) 2215 #print(types_dict) 2216 #recreate_structs() 2217 2218 if __name__ == "__main__": 2219 sys.exit(main()) 2220
