blob: 9cf8c04f388dc79a00974fb57e549d9b9b003b95 [file] [log] [blame]
Tobin Ehlis33267fd2014-11-10 16:03:19 -07001#!/usr/bin/env python3
2#
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06003# VK
Tobin Ehlis33267fd2014-11-10 16:03:19 -07004#
5# Copyright (C) 2014 LunarG, Inc.
6#
7# Permission is hereby granted, free of charge, to any person obtaining a
8# copy of this software and associated documentation files (the "Software"),
9# to deal in the Software without restriction, including without limitation
10# the rights to use, copy, modify, merge, publish, distribute, sublicense,
11# and/or sell copies of the Software, and to permit persons to whom the
12# Software is furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included
15# in all copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23# DEALINGS IN THE SOFTWARE.
Tobin Ehlis6442dca2014-10-22 15:13:53 -060024import argparse
25import os
26import sys
Tobin Ehlisa30e7e52015-07-06 14:02:36 -060027import vulkan
Tobin Ehlis08fafd02015-06-12 12:49:01 -060028from source_line_info import sourcelineinfo
Tobin Ehlis6442dca2014-10-22 15:13:53 -060029
Tobin Ehlis08fafd02015-06-12 12:49:01 -060030# 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
Tobin Ehlis6442dca2014-10-22 15:13:53 -060033# structs in a human-readable txt format, as well as utility functions
34# to print enum values as strings
35
Tobin Ehlis6442dca2014-10-22 15:13:53 -060036def 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.')
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060039 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.')
Tobin Ehlis6442dca2014-10-22 15:13:53 -060040 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.')
Jon Ashburnea65e492015-08-06 17:27:49 -060043 parser.add_argument('--gen_struct_sizes', required=False, action='store_true', default=False, help='Enable generation of struct sizes.')
Tobin Ehlis6442dca2014-10-22 15:13:53 -060044 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'
56enum_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
59enum_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
Tobin Ehlisbd6a9162015-03-13 07:18:05 -060069# |->['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
Tobin Ehlis6442dca2014-10-22 15:13:53 -060071struct_dict = {}
72# typedef_fwd_dict stores mapping from orig_type_name -> new_type_name
73typedef_fwd_dict = {}
74# typedef_rev_dict stores mapping from new_type_name -> orig_type_name
75typedef_rev_dict = {} # store new_name -> orig_name mapping
76# types_dict['id_name'] = identifier name will map to it's type
77# '---->'type' = currently either 'struct' or 'enum'
78types_dict = {} # store orig_name -> type mapping
79
80
81# Class that parses header file and generates data structures that can
82# Then be used for other tasks
83class HeaderFileParser:
84 def __init__(self, header_file=None):
85 self.header_file = header_file
86 # store header data in various formats, see above for more info
87 self.enum_val_dict = {}
88 self.enum_type_dict = {}
89 self.struct_dict = {}
90 self.typedef_fwd_dict = {}
91 self.typedef_rev_dict = {}
92 self.types_dict = {}
Tobin Ehlis5178bd72015-03-06 10:38:25 -070093 self.last_struct_count_name = ''
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060094
Tobin Ehlis6442dca2014-10-22 15:13:53 -060095 def setHeaderFile(self, header_file):
96 self.header_file = header_file
97
98 def get_enum_val_dict(self):
99 return self.enum_val_dict
100
101 def get_enum_type_dict(self):
102 return self.enum_type_dict
103
104 def get_struct_dict(self):
105 return self.struct_dict
106
107 def get_typedef_fwd_dict(self):
108 return self.typedef_fwd_dict
109
110 def get_typedef_rev_dict(self):
111 return self.typedef_rev_dict
112
113 def get_types_dict(self):
114 return self.types_dict
115
116 # Parse header file into data structures
117 def parse(self):
118 # parse through the file, identifying different sections
119 parse_enum = False
120 parse_struct = False
121 member_num = 0
122 # TODO : Comment parsing is very fragile but handles 2 known files
123 block_comment = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700124 prev_count_name = ''
Ian Elliott7e40db92015-08-21 15:09:33 -0600125 exclude_struct_list = ['VkPlatformHandleXcbKHR', 'VkPlatformHandleX11KHR']
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600126 with open(self.header_file) as f:
127 for line in f:
128 if block_comment:
129 if '*/' in line:
130 block_comment = False
131 continue
132 if '/*' in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600133 if '*/' in line: # single line block comment
134 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600135 block_comment = True
136 elif 0 == len(line.split()):
137 #print("Skipping empty line")
138 continue
139 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700140 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600141 continue
142 elif 'typedef enum' in line:
143 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
144 #print("Found ENUM type %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600145 if '{' == base_type:
146 base_type = 'tmp_enum'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600147 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700148 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600149 self.types_dict[base_type] = 'enum'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600150 elif 'typedef struct' in line or 'typedef union' in line:
Jon Ashburnea65e492015-08-06 17:27:49 -0600151 if True in [ex_type in line for ex_type in exclude_struct_list]:
152 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600153 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
154 #print("Found STRUCT type: %s" % base_type)
Cody Northrop22b7fae2015-08-11 11:21:48 -0600155 # Note: This really needs to be updated to handle one line struct definition, like
156 # typedef struct obj##_T { uint64_t handle; } obj;
157 if ('{' == base_type or not (' ' in base_type)):
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600158 base_type = 'tmp_struct'
Cody Northrop22b7fae2015-08-11 11:21:48 -0600159 parse_struct = True
160 self.types_dict[base_type] = 'struct'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600161# elif 'typedef union' in line:
162# (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
163# print("Found UNION type: %s" % base_type)
164# parse_struct = True
165# self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600166 elif '}' in line and (parse_enum or parse_struct):
167 if len(line.split()) > 1: # deals with embedded union in one struct
168 parse_enum = False
169 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700170 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600171 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600172 (cur_char, targ_type) = line.strip().split(None, 1)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600173 if 'tmp_struct' == base_type:
174 base_type = targ_type.strip(';')
Ian Elliott7e40db92015-08-21 15:09:33 -0600175 if True in [ex_type in base_type for ex_type in exclude_struct_list]:
176 del self.struct_dict['tmp_struct']
177 continue
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600178 #print("Found Actual Struct type %s" % base_type)
179 self.struct_dict[base_type] = self.struct_dict['tmp_struct']
180 self.struct_dict.pop('tmp_struct', 0)
181 self.types_dict[base_type] = 'struct'
182 self.types_dict.pop('tmp_struct', 0)
183 elif 'tmp_enum' == base_type:
184 base_type = targ_type.strip(';')
185 #print("Found Actual ENUM type %s" % base_type)
186 for n in self.enum_val_dict:
187 if 'tmp_enum' == self.enum_val_dict[n]['type']:
188 self.enum_val_dict[n]['type'] = base_type
189# self.enum_val_dict[base_type] = self.enum_val_dict['tmp_enum']
190# self.enum_val_dict.pop('tmp_enum', 0)
191 self.enum_type_dict[base_type] = self.enum_type_dict['tmp_enum']
192 self.enum_type_dict.pop('tmp_enum', 0)
193 self.types_dict[base_type] = 'enum'
194 self.types_dict.pop('tmp_enum', 0)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600195 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
196 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600197 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600198 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600199 #if 'VK_MAX_ENUM' not in line and '{' not in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600200 if True not in [ens in line for ens in ['{', '_MAX_ENUM', '_BEGIN_RANGE', '_END_RANGE', '_NUM = ', '_ENUM_RANGE']]:
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700201 self._add_enum(line, base_type, default_enum_val)
202 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600203 elif parse_struct:
204 if ';' in line:
205 self._add_struct(line, base_type, member_num)
206 member_num = member_num + 1
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600207
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600208 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700209 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600210 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700211 if '=' in line_txt:
212 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
213 else:
214 enum_name = line_txt.split(',')[0]
215 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600216 self.enum_val_dict[enum_name] = {}
217 self.enum_val_dict[enum_name]['type'] = enum_type
218 # strip comma and comment, then extra split in case of no comma w/ comments
219 enum_val = enum_val.strip().split(',', 1)[0]
220 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600221 # Perform conversion of VK_BIT macro
222 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
223 vk_bit_val = self.enum_val_dict[enum_name]['val']
224 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
225 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
226 else:
227 # account for negative values surrounded by parens
228 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700229 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600230 try:
231 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
232 int(self.enum_val_dict[enum_name]['val'], 0)
233 self.enum_val_dict[enum_name]['unique'] = True
234 #print("ENUM has num value")
235 except ValueError:
236 self.enum_val_dict[enum_name]['unique'] = False
237 #print("ENUM is not a number value")
238 # Update enum_type_dict as well
239 if not enum_type in self.enum_type_dict:
240 self.enum_type_dict[enum_type] = []
241 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700242
Jon Ashburnea65e492015-08-06 17:27:49 -0600243 # Return True if struct member is a dynamic array
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700244 # RULES : This is a bit quirky based on the API
245 # NOTE : Changes in API spec may cause these rules to change
246 # 1. There must be a previous uint var w/ 'count' in the name in the struct
247 # 2. Dynam array must have 'const' and '*' qualifiers
248 # 3a. Name of dynam array must end in 's' char OR
249 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
250 def _is_dynamic_array(self, full_type, name):
251 if '' != self.last_struct_count_name:
252 if 'const' in full_type and '*' in full_type:
253 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
254 return True
255 return False
256
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600257 # populate struct dicts based on struct lines
258 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
259 def _add_struct(self, line_txt, struct_type, num):
260 #print("Parsing struct line %s" % line_txt)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600261 if '{' == struct_type:
262 print("Parsing struct '{' w/ line %s" % line_txt)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600263 if not struct_type in self.struct_dict:
264 self.struct_dict[struct_type] = {}
265 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
266 # TODO : Handle bitfields more correctly
267 members = members.strip().split(':', 1)[0] # strip bitfield element
268 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700269 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600270 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700271 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600272 self.struct_dict[struct_type][num] = {}
273 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700274 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600275 if '*' in member_type:
276 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700277 # TODO : Need more general purpose way here to reduce down to basic type
278 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600279 member_type = member_type.strip('*')
280 else:
281 self.struct_dict[struct_type][num]['ptr'] = False
282 if 'const' in member_type:
283 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600284 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600285 else:
286 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700287 # TODO : There is a bug here where it seems that at the time we do this check,
288 # the data is not in the types or typedef_rev_dict, so we never pass this if check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600289 if is_type(member_type, 'struct'):
290 self.struct_dict[struct_type][num]['struct'] = True
291 else:
292 self.struct_dict[struct_type][num]['struct'] = False
293 self.struct_dict[struct_type][num]['type'] = member_type
294 if '[' in member_name:
295 (member_name, array_size) = member_name.split('[', 1)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600296 if 'char' in member_type:
297 self.struct_dict[struct_type][num]['array'] = False
298 self.struct_dict[struct_type][num]['array_size'] = 0
299 self.struct_dict[struct_type][num]['ptr'] = True
300 else:
301 self.struct_dict[struct_type][num]['array'] = True
302 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700303 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
304 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
305 self.struct_dict[struct_type][num]['array'] = True
306 self.struct_dict[struct_type][num]['dyn_array'] = True
307 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700308 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600309 self.struct_dict[struct_type][num]['array'] = False
310 self.struct_dict[struct_type][num]['array_size'] = 0
311 self.struct_dict[struct_type][num]['name'] = member_name
312
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700313# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600314def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600315 if identifier in types_dict and type_to_check == types_dict[identifier]:
316 return True
317 if identifier in typedef_rev_dict:
318 new_id = typedef_rev_dict[identifier]
319 if new_id in types_dict and type_to_check == types_dict[new_id]:
320 return True
321 return False
322
323# This is a validation function to verify that we can reproduce the original structs
324def recreate_structs():
325 for struct_name in struct_dict:
326 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
327 for mem_num in sorted(struct_dict[struct_name]):
328 sys.stdout.write(" ")
329 if struct_dict[struct_name][mem_num]['const']:
330 sys.stdout.write("const ")
331 #if struct_dict[struct_name][mem_num]['struct']:
332 # sys.stdout.write("struct ")
333 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
334 if struct_dict[struct_name][mem_num]['ptr']:
335 sys.stdout.write("*")
336 sys.stdout.write(" ")
337 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
338 if struct_dict[struct_name][mem_num]['array']:
339 sys.stdout.write("[")
340 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
341 sys.stdout.write("]")
342 sys.stdout.write(";\n")
343 sys.stdout.write("} ")
344 sys.stdout.write(typedef_fwd_dict[struct_name])
345 sys.stdout.write(";\n\n")
346
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600347#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600348# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600349def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600350 # Note: All struct types are now camel-case
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600351 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600352 char_idx = 0
353 struct_name = ''
354 for char in caps_struct_name:
355 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
356 struct_name += caps_struct_name[char_idx]
357 elif (caps_struct_name[char_idx] == '_'):
358 pass
359 else:
360 struct_name += caps_struct_name[char_idx].lower()
361 char_idx += 1
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600362 return struct_name
363
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600364# class for writing common file elements
365# Here's how this class lays out a file:
366# COPYRIGHT
367# HEADER
368# BODY
369# FOOTER
370#
371# For each of these sections, there's a "set*" function
372# The class as a whole has a generate function which will write each section in order
373class CommonFileGen:
374 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
375 self.filename = filename
376 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
377 # TODO : Set a default copyright & footer at least
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600378
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600379 def setFilename(self, filename):
380 self.filename = filename
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600381
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600382 def setCopyright(self, c):
383 self.contents['copyright'] = c
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600384
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600385 def setHeader(self, h):
386 self.contents['header'] = h
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600387
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600388 def setBody(self, b):
389 self.contents['body'] = b
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600390
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600391 def setFooter(self, f):
392 self.contents['footer'] = f
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600393
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600394 def generate(self):
395 #print("Generate to file %s" % self.filename)
396 with open(self.filename, "w") as f:
397 f.write(self.contents['copyright'])
398 f.write(self.contents['header'])
399 f.write(self.contents['body'])
400 f.write(self.contents['footer'])
401
402# class for writing a wrapper class for structures
403# The wrapper class wraps the structs and includes utility functions for
404# setting/getting member values and displaying the struct data in various formats
405class StructWrapperGen:
406 def __init__(self, in_struct_dict, prefix, out_dir):
407 self.struct_dict = in_struct_dict
408 self.include_headers = []
Jon Ashburnea65e492015-08-06 17:27:49 -0600409 self.lineinfo = sourcelineinfo()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600410 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600411 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600412 self.api_prefix = "vk"
413 else:
414 self.api_prefix = prefix
415 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
416 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
417 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
418 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
419 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
420 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
421 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700422 self.no_addr = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600423 self.hfg = CommonFileGen(self.header_filename)
424 self.cfg = CommonFileGen(self.class_filename)
425 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700426 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700427 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600428 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
429 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600430 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700431 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600432 #print(self.header_filename)
433 self.header_txt = ""
434 self.definition_txt = ""
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600435
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600436 def set_include_headers(self, include_headers):
437 self.include_headers = include_headers
438
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700439 def set_no_addr(self, no_addr):
440 self.no_addr = no_addr
441 if self.no_addr:
442 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700443 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700444 else:
445 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700446 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700447
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600448 # Return class name for given struct name
449 def get_class_name(self, struct_name):
450 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
451 return class_name
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600452
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600453 def get_file_list(self):
454 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
455
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600456 # Generate class header file
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600457 def generateHeader(self):
458 self.hfg.setCopyright(self._generateCopyright())
459 self.hfg.setHeader(self._generateHeader())
460 self.hfg.setBody(self._generateClassDeclaration())
461 self.hfg.setFooter(self._generateFooter())
462 self.hfg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600463
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600464 # Generate class definition
465 def generateBody(self):
466 self.cfg.setCopyright(self._generateCopyright())
467 self.cfg.setHeader(self._generateCppHeader())
468 self.cfg.setBody(self._generateClassDefinition())
469 self.cfg.setFooter(self._generateFooter())
470 self.cfg.generate()
471
472 # Generate c-style .h file that contains functions for printing structs
473 def generateStringHelper(self):
474 print("Generating struct string helper")
475 self.shg.setCopyright(self._generateCopyright())
476 self.shg.setHeader(self._generateStringHelperHeader())
477 self.shg.setBody(self._generateStringHelperFunctions())
478 self.shg.generate()
479
Tobin Ehlis99f88672015-01-10 12:42:41 -0700480 # Generate cpp-style .h file that contains functions for printing structs
481 def generateStringHelperCpp(self):
482 print("Generating struct string helper cpp")
483 self.shcppg.setCopyright(self._generateCopyright())
484 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
485 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
486 self.shcppg.generate()
487
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700488 # Generate c-style .h file that contains functions for printing structs
489 def generateValidateHelper(self):
490 print("Generating struct validate helper")
491 self.vhg.setCopyright(self._generateCopyright())
492 self.vhg.setHeader(self._generateValidateHelperHeader())
493 self.vhg.setBody(self._generateValidateHelperFunctions())
494 self.vhg.generate()
495
Tobin Ehlis60354772015-03-12 14:50:40 -0600496 def generateSizeHelper(self):
497 print("Generating struct size helper")
498 self.size_helper_gen.setCopyright(self._generateCopyright())
499 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
500 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
501 self.size_helper_gen.generate()
502
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700503 def generateSizeHelperC(self):
504 print("Generating struct size helper c")
505 self.size_helper_c_gen.setCopyright(self._generateCopyright())
506 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
507 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
508 self.size_helper_c_gen.generate()
509
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600510 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700511 copyright = []
512 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
513 copyright.append('');
514 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600515 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700516 copyright.append(' *');
517 copyright.append(' * Copyright (C) 2014 LunarG, Inc.');
518 copyright.append(' *');
519 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
520 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
521 copyright.append(' * to deal in the Software without restriction, including without limitation');
522 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
523 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
524 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
525 copyright.append(' *');
526 copyright.append(' * The above copyright notice and this permission notice shall be included');
527 copyright.append(' * in all copies or substantial portions of the Software.');
528 copyright.append(' *');
529 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
530 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
531 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
532 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
533 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
534 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
535 copyright.append(' * DEALINGS IN THE SOFTWARE.');
536 copyright.append(' */');
537 copyright.append('');
538 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600539
540 def _generateCppHeader(self):
541 header = []
542 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600543 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))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600544 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600545
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600546 def _generateClassDefinition(self):
547 class_def = []
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600548 if 'vk' == self.api:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600549 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700550 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600551 class_def.append("\n// %s class definition" % self.get_class_name(s))
552 class_def.append(self._generateConstructorDefinitions(s))
553 class_def.append(self._generateDestructorDefinitions(s))
554 class_def.append(self._generateDisplayDefinitions(s))
555 return "\n".join(class_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600556
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600557 def _generateConstructorDefinitions(self, s):
558 con_defs = []
559 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)))
560 # TODO : This is a shallow copy of ptrs
561 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]))
562 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]))
563 return "\n".join(con_defs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600564
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600565 def _generateDestructorDefinitions(self, s):
566 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600567
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600568 def _generateDynamicPrintFunctions(self):
569 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600570 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")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600571 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600572 dp_funcs.append(" switch (sType)\n {")
573 for e in enum_type_dict:
574 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600575 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600576 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600577 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600578 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600579 instance_name = "swc%i" % class_num
580 dp_funcs.append(" case %s:\n {" % (v))
581 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
582 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
583 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
584 dp_funcs.append(" }")
585 dp_funcs.append(" break;")
586 class_num += 1
587 dp_funcs.append(" }")
588 dp_funcs.append("}\n")
589 return "\n".join(dp_funcs)
590
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700591 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600592 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700593
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600594 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700595 return self._get_func_name(struct, 'print')
596
597 def _get_vh_func_name(self, struct):
598 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600599
Tobin Ehlis60354772015-03-12 14:50:40 -0600600 def _get_size_helper_func_name(self, struct):
601 return self._get_func_name(struct, 'size')
602
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600603 # Return elements to create formatted string for given struct member
604 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
605 struct_op = "->"
606 if not struct_ptr:
607 struct_op = "."
608 member_name = struct_member['name']
609 print_type = "p"
610 cast_type = ""
611 member_post = ""
612 array_index = ""
613 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700614 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700615 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
616 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
617 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600618 print_type = "s"
619 print_array = False
620 elif struct_member['array'] and not print_array:
621 # Just print base address of array when not full print_array
622 cast_type = "(void*)"
623 elif is_type(struct_member['type'], 'enum'):
624 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700625 if struct_member['ptr']:
626 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600627 print_type = "s"
628 elif is_type(struct_member['type'], 'struct'): # print struct address for now
629 cast_type = "(void*)"
630 if not struct_member['ptr']:
631 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -0600632 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600633 print_type = "s"
634 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700635 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600636 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600637 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
638 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700639 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600640 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600641 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700642 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
643 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600644 elif True in [ui_str.lower() in struct_member['type'].lower() for ui_str in ['uint', 'flags', 'samplemask']]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600645 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700646 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600647 print_type = "i"
648 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600649 pass
650 else:
651 #print("Unhandled struct type: %s" % struct_member['type'])
652 cast_type = "(void*)"
653 if print_array and struct_member['array']:
654 member_print_post = "[%u]"
655 array_index = " i,"
656 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700657 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
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600658 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
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700659 if self.no_addr and "p" == print_type:
660 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
661 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600662 return (print_out, print_arg)
663
664 def _generateStringHelperFunctions(self):
665 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700666 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700667 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700668 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
669 sh_funcs.append('')
670 sh_funcs.append('#if defined(_WIN32)')
671 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
672 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
673 sh_funcs.append('// work-around.')
674 sh_funcs.append('#define snprintf _snprintf')
675 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700676 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600677 p_out = ""
678 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700679 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700680 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700681 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700682 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
683 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700684 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]))
685 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700686 num_stps = len(stp_list);
687 total_strlen_str = ''
688 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700689 sh_funcs.append(" char* tmpStr;")
690 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
691 sh_funcs.append(' strcpy(extra_indent, " ");')
692 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
693 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700694 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700695 # If it's an array, print all of the elements
696 # If it's a ptr, print thing it's pointing to
697 # Non-ptr struct case. Print the struct using its address
698 struct_deref = '&'
699 if 1 < stp_list[index]['full_type'].count('*'):
700 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700701 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700702 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700703 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700704 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
705 sh_funcs.append(' len = 256+strlen(tmpStr);')
706 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700707 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700708 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700709 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700710 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
711 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700712 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700713 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
714 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600715 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700716 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700717 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
718 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
719 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700720 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700721 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name']))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700722 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700723 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (%%p)\\n%%s", prefix, (void*)pStruct->%s, tmpStr);' % (index, stp_list[index]['name'], stp_list[index]['name']))
724 sh_funcs.append(' }')
725 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
726 elif stp_list[index]['array']:
727 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
728 sh_funcs.append(' len = 256+strlen(tmpStr);')
729 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700730 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700731 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s[0] (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name']))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700732 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700733 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s[0] (%%p)\\n%%s", prefix, (void*)&pStruct->%s[0], tmpStr);' % (index, stp_list[index]['name'], stp_list[index]['name']))
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700734 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700735 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
736 sh_funcs.append(' len = 256+strlen(tmpStr);')
737 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700738 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700739 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name']))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700740 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700741 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (%%p)\\n%%s", prefix, (void*)&pStruct->%s, tmpStr);' % (index, stp_list[index]['name'], stp_list[index]['name']))
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700742 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700743 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
744 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700745 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600746 for m in sorted(self.struct_dict[s]):
747 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
748 p_out += p_out1
749 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600750 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700751 p_args += ");"
752 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700753 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700754 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
755 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
756 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
757 sh_funcs.append(' free(stp_strs[stp_index]);')
758 sh_funcs.append(' }')
759 sh_funcs.append(' }')
760 sh_funcs.append(' free(extra_indent);')
761 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600762 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700763 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
764 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
765 sh_funcs.append(" if (pStruct == NULL) {")
766 sh_funcs.append(" return NULL;")
767 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600768 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700769 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
770 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600771 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600772 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600773 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600774 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600775 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700776 sh_funcs.append(' case %s:\n {' % (v))
777 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
778 sh_funcs.append(' }')
779 sh_funcs.append(' break;')
780 sh_funcs.append(" default:")
781 sh_funcs.append(" return NULL;")
782 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600783 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700784 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700785
786 def _generateStringHelperFunctionsCpp(self):
787 # declare str & tmp str
788 # declare array of stringstreams for every struct ptr in current struct
789 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700790 # For every struct ptr, if non-Null, then set its string, else set to NULL str
791 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700792 # create and return final string
793 sh_funcs = []
794 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600795 # XXX - REMOVE this comment
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600796 lineinfo = sourcelineinfo()
797 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700798 for s in sorted(self.struct_dict):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700799 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
800 sh_funcs.append('\n')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600801 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700802 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600803 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)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700804 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700805 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700806 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700807 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']:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600808 # TODO: This is a tmp workaround
809 if 'ppActiveLayerNames' not in self.struct_dict[s][m]['name']:
810 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600811 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700812 sh_funcs.append('string %s(const %s* pStruct, const string prefix)\n{' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600813 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700814 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600815 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700816 sh_funcs.append('%sstring final_str;' % (indent))
817 sh_funcs.append('%sstring tmp_str;' % (indent))
818 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700819 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700820 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700821 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600822 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700823 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700824 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700825 idx_ss_decl = False # Make sure to only decl this once
826 for index in range(num_stps):
827 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700828 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700829 addr_char = ''
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600830 if stp_list[index]['array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600831 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700832 if stp_list[index]['dyn_array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600833 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700834 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
835 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600836 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700837 array_count = '%s' % (stp_list[index]['array_size'])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600838 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700839 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
840 if not idx_ss_decl:
841 sh_funcs.append('%sstringstream index_ss;' % (indent))
842 idx_ss_decl = True
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600843 if (stp_list[index]['name'] == 'pQueueFamilyIndices'):
844 sh_funcs.append('%sif (pStruct->sharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent))
845 indent += ' '
Tobin Ehlis793ad302015-04-03 12:01:11 -0600846 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
847 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700848 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600849 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700850 sh_funcs.append('%sindex_ss.str("");' % (indent))
851 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600852 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600853 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700854 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600855 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
856 sh_funcs.append('%sss[%u] << string_%s(pStruct->%s[i]);' % (indent, index, stp_list[index]['type'], stp_list[index]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700857 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
Tobin Ehlisce320942015-06-11 09:37:00 -0600858 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600859 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700860 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
861 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']))
862 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600863 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700864 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
865 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600866 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700867 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (" + ss[%u].str() + ")\\n" + tmp_str;' % (indent, index, stp_list[index]['name'], index))
Tobin Ehlisce320942015-06-11 09:37:00 -0600868 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600869 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600870 addr_char = ''
Courtney Goeltzenleuchter44981552015-10-23 15:48:32 -0600871 if stp_list[index]['type'] in vulkan.core.objects:
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600872 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "].handle = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
873 else:
874 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
875 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600876 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700877 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600878 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700879 sh_funcs.append('%s}' % (indent))
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600880 indent = indent[4:]
881 sh_funcs.append('%s}' % (indent))
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600882 #endif
883 if (stp_list[index]['name'] == 'pQueueFamilyIndices'):
884 indent = indent[4:]
885 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700886 elif (stp_list[index]['ptr']):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600887 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600888 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
889 indent += ' '
Tobin Ehlis99f88672015-01-10 12:42:41 -0700890 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600891 sh_funcs.append('%s' % lineinfo.get())
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600892 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700893 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700894 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
895 # TODO : This is a quick hack to handle these arrays of ptrs
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600896 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600897 sh_funcs.append(' tmp_str = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700898 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600899 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700900 sh_funcs.append(' tmp_str = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700901 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
902 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600903 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700904 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
905 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600906 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700907 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
908 sh_funcs.append(' ss[%u].str("");' % (index))
909 sh_funcs.append(' }')
910 sh_funcs.append(' else')
911 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700912 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600913 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700914 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
915 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
916 if self.no_addr:
917 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600918 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700919 else:
920 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600921 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700922 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -0600923 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -0700924 index = 0
925 final_str = ''
926 for m in sorted(self.struct_dict[s]):
927 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
928 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
929 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600930 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700931 sh_funcs.append(' ss[%u].str("addr");' % (index))
932 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600933 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700934 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Jon Ashburnc669cc62015-07-09 15:02:25 -0600935 elif self.struct_dict[s][m]['array']:
936 sh_funcs.append('%s' % lineinfo.get())
937 sh_funcs.append(' ss[%u] << (void*)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700938 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600939 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700940 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700941 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600942 sh_funcs.append('%s' % lineinfo.get())
Jon Ashburnc669cc62015-07-09 15:02:25 -0600943 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600944 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600945 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600946 sh_funcs.append(' if (StreamControl::writeAddress)')
947 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
948 sh_funcs.append(' else')
949 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700950 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600951 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700952 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700953 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700954 sh_funcs.append(' ss[%u].str("addr");' % (index))
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600955 elif not self.struct_dict[s][m]['ptr'] and self.struct_dict[s][m]['type'] in vulkan.core.objects:
956 sh_funcs.append(' ss[%u] << pStruct->%s.handle;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700957 else:
958 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
959 value_print = 'ss[%u].str()' % index
960 index += 1
961 else:
Tobin Ehlisce320942015-06-11 09:37:00 -0600962 # For an non-empty array of enums just print address w/ note that array will be displayed below
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700963 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600964 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600965 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
966 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
967 sh_funcs.append(' else')
968 sh_funcs.append(' ss[%u].str("NULL");' % (index))
969 value_print = 'ss[%u].str()' % index
970 index += 1
971 # For single enum just print the string representation
972 else:
973 value_print = 'string_%s(pStruct->%s)' % (self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name'])
Tobin Ehlis99f88672015-01-10 12:42:41 -0700974 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
975 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700976 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -0700977 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600978 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700979 sh_funcs.append(' final_str = %s;' % final_str)
980 sh_funcs.append(' return final_str;\n}')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700981 # Add function to return a string value for input void*
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600982 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700983 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600984 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -0700985 sh_funcs.append(" stringstream ss;")
986 sh_funcs.append(' ss << toString;')
987 sh_funcs.append(' string final_str = prefix + ss.str();')
988 sh_funcs.append(" return final_str;")
989 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600990 sh_funcs.append('%s' % lineinfo.get())
Tony Barbourb5d2c942015-07-14 13:34:05 -0600991 # Add function to return a string value for input uint64_t
992 sh_funcs.append("string string_convert_helper(const uint64_t toString, const string prefix)\n{")
Tobin Ehlis08541742015-04-16 15:56:11 -0600993 sh_funcs.append(" using namespace StreamControl;")
994 sh_funcs.append(" stringstream ss;")
995 sh_funcs.append(' ss << toString;')
996 sh_funcs.append(' string final_str = prefix + ss.str();')
997 sh_funcs.append(" return final_str;")
998 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600999 sh_funcs.append('%s' % lineinfo.get())
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001000 #### TODO: Get the following function moved to be in "vk_enum_string_helper.h"
Ian Elliott7e40db92015-08-21 15:09:33 -06001001 # Add function to return a string value for input VkSurfaceFormatKHR*
1002 sh_funcs.append("static inline const char* string_VkColorSpaceKHR(VkColorSpaceKHR input_value)\n{")
1003 sh_funcs.append(" switch ((VkColorSpaceKHR)input_value)")
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001004 sh_funcs.append(" {")
Ian Elliott7e40db92015-08-21 15:09:33 -06001005 sh_funcs.append(" case VK_COLORSPACE_SRGB_NONLINEAR_KHR:")
1006 sh_funcs.append(" return \"VK_COLORSPACE_SRGB_NONLINEAR_KHR\";")
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001007 sh_funcs.append(" default:")
Ian Elliott7e40db92015-08-21 15:09:33 -06001008 sh_funcs.append(" return \"Unhandled VkColorSpaceKHR\";")
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001009 sh_funcs.append(" }")
1010 sh_funcs.append("}")
1011 sh_funcs.append('%s' % lineinfo.get())
Ian Elliott7e40db92015-08-21 15:09:33 -06001012 # Add function to return a string value for input VkSurfaceFormatKHR*
1013 sh_funcs.append("string string_convert_helper(VkSurfaceFormatKHR toString, const string prefix)\n{")
1014 sh_funcs.append(' string final_str = prefix + "format = " + string_VkFormat(toString.format) + "format = " + string_VkColorSpaceKHR(toString.colorSpace);')
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001015 sh_funcs.append(" return final_str;")
1016 sh_funcs.append("}")
1017 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001018 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001019 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001020 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -07001021 sh_funcs.append(" if (pStruct == NULL) {\n")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001022 sh_funcs.append(" return string();")
Ian Elliott82800022015-02-25 17:40:38 -07001023 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001024 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001025 sh_funcs.append(' string indent = " ";')
1026 sh_funcs.append(' indent += prefix;')
1027 sh_funcs.append(" switch (sType)\n {")
1028 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001029 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001030 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001031 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001032 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001033 #sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
Tobin Ehlis99f88672015-01-10 12:42:41 -07001034 sh_funcs.append(' case %s:\n {' % (v))
1035 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
1036 sh_funcs.append(' }')
1037 sh_funcs.append(' break;')
1038 sh_funcs.append(" default:")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001039 sh_funcs.append(" return string();")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001040 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001041 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001042 sh_funcs.append("}")
1043 return "\n".join(sh_funcs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001044
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001045 def _genStructMemberPrint(self, member, s, array, struct_array):
1046 (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)
1047 extra_indent = ""
1048 if array:
1049 extra_indent = " "
1050 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
1051 struct_array.insert(0, self.struct_dict[s][member])
1052 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001053 # Special case for void* named "pNext"
1054 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001055 struct_array.insert(0, self.struct_dict[s][member])
1056 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
1057
1058 def _generateDisplayDefinitions(self, s):
1059 disp_def = []
1060 struct_array = []
1061 # Single-line struct print function
1062 disp_def.append("// Output 'structname = struct_address' on a single line")
1063 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
1064 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1065 disp_def.append("}\n")
1066 # Private helper function to print struct members
1067 disp_def.append("// Private helper function that displays the members of the wrapped struct")
1068 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
1069 i_declared = False
1070 for member in sorted(self.struct_dict[s]):
1071 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001072 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001073 # Can grab struct type off of header of struct pointed to
1074 # TODO : Handle Arrays
1075 if self.struct_dict[s][member]['array']:
1076 # Create for loop to print each element of array
1077 if not i_declared:
1078 disp_def.append(' uint32_t i;')
1079 i_declared = True
1080 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
1081 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
1082 disp_def.append(return_str)
1083 disp_def.append(' }')
1084 else:
1085 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
1086 disp_def.append(return_str)
1087 disp_def.append("}\n")
1088 i_declared = False
1089 # Basic print function to display struct members
1090 disp_def.append("// Output all struct elements, each on their own line")
1091 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
1092 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1093 disp_def.append(' this->display_struct_members();')
1094 disp_def.append("}\n")
1095 # Advanced print function to display current struct and contents of any pointed-to structs
1096 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1097 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1098 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1099 disp_def.append(' this->display_struct_members();')
1100 class_num = 0
1101 # TODO : Need to handle arrays of structs here
1102 for ms in struct_array:
1103 swc_name = "class%s" % str(class_num)
1104 if ms['array']:
1105 if not i_declared:
1106 disp_def.append(' uint32_t i;')
1107 i_declared = True
1108 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1109 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1110 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1111 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1112 disp_def.append(" %s.display_full_txt();" % (swc_name))
1113 #disp_def.append(' }')
1114 disp_def.append(' }')
1115 elif 'pNext' == ms['name']:
1116 # Need some code trickery here
1117 # I'm thinking have a generated function that takes pNext ptr value
1118 # then it checks sType and in large switch statement creates appropriate
1119 # wrapper class type and then prints contents
1120 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1121 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1122 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1123 disp_def.append(" }")
1124 else:
1125 if ms['ptr']:
1126 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1127 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1128 else:
1129 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1130 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1131 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1132 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1133 class_num += 1
1134 disp_def.append("}\n")
1135 return "\n".join(disp_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001136
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001137 def _generateStringHelperHeader(self):
1138 header = []
1139 header.append("//#includes, #defines, globals and such...\n")
1140 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001141 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001142 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001143 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001144 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001145 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001146
1147 def _generateStringHelperHeaderCpp(self):
1148 header = []
1149 header.append("//#includes, #defines, globals and such...\n")
1150 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001151 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001152 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001153 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001154 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001155 header.append('\n')
1156 header.append('namespace StreamControl\n')
1157 header.append('{\n')
1158 header.append('bool writeAddress = true;\n')
1159 header.append('template <typename T>\n')
1160 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1161 header.append('{\n')
1162 header.append(' if(writeAddress)\n')
1163 header.append(' {\n')
1164 header.append(' out.operator<<(pointer);\n')
1165 header.append(' }\n')
1166 header.append(' else\n')
1167 header.append(' {\n')
1168 header.append(' std::operator<<(out, "address");\n')
1169 header.append(' }\n')
1170 header.append(' return out;\n')
1171 header.append('}\n')
1172 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1173 header.append('{\n')
1174 header.append(' return std::operator<<(out, s);\n')
1175 header.append('}\n')
1176 header.append('}\n')
1177 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001178 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001179 return "".join(header)
1180
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001181 def _generateValidateHelperFunctions(self):
1182 sh_funcs = []
1183 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001184 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001185 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1186 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001187 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001188 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1189 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001190 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001191 if is_type(self.struct_dict[s][m]['type'], 'enum') and not self.struct_dict[s][m]['ptr']:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001192 sh_funcs.append(' if (!validate_%s(pStruct->%s))\n return 0;' % (self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name']))
Jon Ashburn27e02a62015-01-12 15:46:51 -07001193 # TODO : Need a little refinement to this code to make sure type of struct matches expected input (ptr, const...)
Tobin Ehlisce12ad62014-12-18 09:29:58 -07001194 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1195 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001196 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']))
Tobin Ehlisce12ad62014-12-18 09:29:58 -07001197 else:
1198 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']))
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001199 sh_funcs.append(" return 1;\n}")
1200
1201 return "\n".join(sh_funcs)
1202
1203 def _generateValidateHelperHeader(self):
1204 header = []
1205 header.append("//#includes, #defines, globals and such...\n")
1206 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001207 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001208 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001209 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001210 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001211 return "".join(header)
1212
Tobin Ehlis60354772015-03-12 14:50:40 -06001213 def _generateSizeHelperFunctions(self):
1214 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001215 # just generates prototypes for all the functions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001216 for s in sorted(self.struct_dict):
Tobin Ehlis60354772015-03-12 14:50:40 -06001217 sh_funcs.append('size_t %s(const %s* pStruct);' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001218 return "\n".join(sh_funcs)
1219
1220
1221 def _generateSizeHelperFunctionsC(self):
1222 sh_funcs = []
1223 # generate function definitions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001224 for s in sorted(self.struct_dict):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001225 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001226 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1227 indent = ' '
1228 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1229 sh_funcs.append('%sif (pStruct) {' % (indent))
1230 indent = ' '
1231 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1232 i_decl = False
1233 for m in sorted(self.struct_dict[s]):
1234 if m in skip_list:
1235 continue
1236 if self.struct_dict[s][m]['dyn_array']:
1237 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1238 if not is_type(self.struct_dict[s][m]['type'], 'struct') and not 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis04112922015-03-16 10:44:40 -06001239 if 'ppMemBarriers' == self.struct_dict[s][m]['name']:
1240 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001241 sh_funcs.append('%sstructSize += pStruct->%s*(sizeof(%s*) + sizeof(VkImageMemoryBarrier));' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
Tobin Ehlis04112922015-03-16 10:44:40 -06001242 else:
1243 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']))
Tobin Ehlis60354772015-03-12 14:50:40 -06001244 else: # This is an array of char* or array of struct ptrs
1245 if not i_decl:
1246 sh_funcs.append('%suint32_t i = 0;' % (indent))
1247 i_decl = True
1248 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1249 indent = ' '
1250 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1251 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']))
1252 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001253 sh_funcs.append('%sstructSize += (sizeof(char*) + (sizeof(char) * (1 + strlen(pStruct->%s[i]))));' % (indent, self.struct_dict[s][m]['name']))
Tobin Ehlis60354772015-03-12 14:50:40 -06001254 indent = ' '
1255 sh_funcs.append('%s}' % (indent))
1256 else:
1257 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1258 if not i_decl:
1259 sh_funcs.append('%suint32_t i = 0;' % (indent))
1260 i_decl = True
1261 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1262 indent = ' '
1263 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']))
1264 indent = ' '
1265 sh_funcs.append('%s}' % (indent))
1266 else:
1267 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1268 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1269 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001270 sh_funcs.append('%sstructSize += sizeof(%s)*(1+strlen(pStruct->%s));' % (indent, self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name']))
Tobin Ehlis60354772015-03-12 14:50:40 -06001271 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1272 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']))
Tobin Ehlis04112922015-03-16 10:44:40 -06001273 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis60354772015-03-12 14:50:40 -06001274 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1275 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1276 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1277 skip_list.append(m+1)
1278 indent = ' '
1279 sh_funcs.append('%s}' % (indent))
1280 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001281 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
Ian Elliott7e40db92015-08-21 15:09:33 -06001282 if 'khr' not in self.header_filename and '_debug_' not in self.header_filename:
Jon Ashburnea65e492015-08-06 17:27:49 -06001283 for follow_chain in [True, False]:
1284 sh_funcs.append('%s' % self.lineinfo.get())
1285 if follow_chain:
1286 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1287 else:
1288 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1289 indent = ' '
1290 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1291 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
1292 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1293 if follow_chain:
1294 sh_funcs.append('%swhile (pNext) {' % (indent))
1295 indent = ' '
1296 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1297 indent += ' '
1298 for e in enum_type_dict:
1299 if 'StructureType' in e:
1300 for v in sorted(enum_type_dict[e]):
1301 struct_name = get_struct_name_from_struct_type(v)
1302 sh_funcs.append('%scase %s:' % (indent, v))
1303 sh_funcs.append('%s{' % (indent))
1304 indent += ' '
1305 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1306 sh_funcs.append('%sbreak;' % (indent))
1307 indent = indent[:-4]
1308 sh_funcs.append('%s}' % (indent))
1309 sh_funcs.append('%sdefault:' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001310 indent += ' '
Jon Ashburnea65e492015-08-06 17:27:49 -06001311 sh_funcs.append('%sassert(0);' % (indent))
1312 sh_funcs.append('%sstructSize += 0;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001313 indent = indent[:-4]
Tobin Ehlis04112922015-03-16 10:44:40 -06001314 indent = indent[:-4]
1315 sh_funcs.append('%s}' % (indent))
Jon Ashburnea65e492015-08-06 17:27:49 -06001316 if follow_chain:
1317 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
1318 indent = indent[:-4]
1319 sh_funcs.append('%s}' % (indent))
1320 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001321 return "\n".join(sh_funcs)
1322
1323 def _generateSizeHelperHeader(self):
1324 header = []
1325 header.append("//#includes, #defines, globals and such...\n")
1326 for f in self.include_headers:
1327 header.append("#include <%s>\n" % f)
1328 header.append('\n// Function Prototypes\n')
1329 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001330 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001331 return "".join(header)
1332
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001333 def _generateSizeHelperHeaderC(self):
1334 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001335 header.append('#include "vk_struct_size_helper.h"')
Ian Elliott7e40db92015-08-21 15:09:33 -06001336 header.append('#include "vk_ext_khr_swapchain.h"')
1337 header.append('#include "vk_ext_khr_device_swapchain.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001338 header.append('#include <string.h>')
1339 header.append('#include <assert.h>')
1340 header.append('\n// Function definitions\n')
1341 return "\n".join(header)
1342
1343
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001344 def _generateHeader(self):
1345 header = []
1346 header.append("//#includes, #defines, globals and such...\n")
1347 for f in self.include_headers:
1348 header.append("#include <%s>\n" % f)
1349 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001350
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001351 # Declarations
1352 def _generateConstructorDeclarations(self, s):
1353 constructors = []
1354 constructors.append(" %s();\n" % self.get_class_name(s))
1355 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1356 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1357 return "".join(constructors)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001358
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001359 def _generateDestructorDeclarations(self, s):
1360 return " virtual ~%s();\n" % self.get_class_name(s)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001361
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001362 def _generateDisplayDeclarations(self, s):
1363 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001364
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001365 def _generateGetSetDeclarations(self, s):
1366 get_set = []
1367 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1368 for member in sorted(self.struct_dict[s]):
1369 # TODO : Skipping array set/get funcs for now
1370 if self.struct_dict[s][member]['array']:
1371 continue
1372 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']))
1373 if not self.struct_dict[s][member]['const']:
1374 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']))
1375 return "".join(get_set)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001376
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001377 def _generatePrivateMembers(self, s):
1378 priv = []
1379 priv.append("\nprivate:\n")
1380 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1381 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1382 priv.append(" uint32_t m_indent;\n")
1383 priv.append(" const char m_dummy_prefix;\n")
1384 priv.append(" void display_struct_members();\n")
1385 return "".join(priv)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001386
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001387 def _generateClassDeclaration(self):
1388 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001389 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001390 class_decl.append("\n//class declaration")
1391 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1392 class_decl.append(self._generateConstructorDeclarations(s))
1393 class_decl.append(self._generateDestructorDeclarations(s))
1394 class_decl.append(self._generateDisplayDeclarations(s))
1395 class_decl.append(self._generateGetSetDeclarations(s))
1396 class_decl.append(self._generatePrivateMembers(s))
1397 class_decl.append("};\n")
1398 return "\n".join(class_decl)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001399
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001400 def _generateFooter(self):
1401 return "\n//any footer info for class\n"
1402
1403class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001404 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):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001405 self.et_dict = enum_type_dict
1406 self.ev_dict = enum_val_dict
1407 self.tf_dict = typedef_fwd_dict
1408 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001409 self.out_sh_file = out_sh_file
1410 self.eshfg = CommonFileGen(self.out_sh_file)
1411 self.out_vh_file = out_vh_file
1412 self.evhfg = CommonFileGen(self.out_vh_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001413
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001414 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001415 self.eshfg.setHeader(self._generateSHHeader())
1416 self.eshfg.setBody(self._generateSHBody())
1417 self.eshfg.generate()
1418
1419 def generateEnumValidate(self):
1420 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001421 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001422 self.evhfg.generate()
1423
1424 def _generateVHBody(self):
1425 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001426 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001427 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001428 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1429 # TODO : This is not ideal, but allows for flag combinations. Need more rigorous validation of realistic flag combinations
Tobin Ehlisd3350652015-04-22 13:59:43 -06001430 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001431 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1432 body.append(' return 0;')
1433 body.append(' return 1;')
1434 body.append('}\n\n')
1435 else:
1436 body.append(' switch ((%s)input_value)\n {' % (fet))
1437 for e in sorted(self.et_dict[bet]):
1438 if (self.ev_dict[e]['unique']):
1439 body.append(' case %s:' % (e))
1440 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001441 return "\n".join(body)
1442
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001443 def _generateSHBody(self):
1444 body = []
1445# with open(self.out_file, "a") as hf:
1446 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001447 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001448 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001449 body.append("static inline const char* string_%s(%s input_value)\n{\n switch ((%s)input_value)\n {" % (fet, fet, fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001450 for e in sorted(self.et_dict[bet]):
1451 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001452 body.append(' case %s:\n return "%s";' % (e, e))
1453 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001454 return "\n".join(body)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001455
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001456 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001457 header = []
1458 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001459 header.append('#ifdef _WIN32\n')
1460 header.append('#pragma warning( disable : 4065 )\n')
1461 header.append('#endif\n')
Ian Elliottfeae4052015-02-18 12:38:04 -07001462 header.append('#include <%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001463 return "\n".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001464
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001465
1466class CMakeGen:
1467 def __init__(self, struct_wrapper=None, out_dir=None):
1468 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001469 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001470 self.add_lib_file_list = self.sw.get_file_list()
1471 self.out_dir = out_dir
1472 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1473 self.cmg = CommonFileGen(self.out_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001474
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001475 def generate(self):
1476 self.cmg.setBody(self._generateBody())
1477 self.cmg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001478
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001479 def _generateBody(self):
1480 body = []
1481 body.append("project(%s)" % os.path.basename(self.out_dir))
1482 body.append("cmake_minimum_required(VERSION 2.8)\n")
1483 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1484 body.append('set(COMPILE_FLAGS "-fpermissive")')
1485 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1486 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1487 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1488 return "\n".join(body)
1489
1490class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001491 def __init__(self, struct_dict, prefix, out_dir):
1492 self.struct_dict = struct_dict
1493 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001494 if prefix == "vulkan":
1495 self.api_prefix = "vk"
1496 else:
1497 self.api_prefix = prefix
1498 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001499 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001500
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001501 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001502 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001503 self.gvg.setHeader(self._generateHeader())
1504 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001505 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001506 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001507
1508 def set_include_headers(self, include_headers):
1509 self.include_headers = include_headers
1510
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001511 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001512 header = []
1513 header.append("//#includes, #defines, globals and such...\n")
1514 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001515 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001516 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001517 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001518 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001519 return "".join(header)
1520
1521 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001522 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001523
1524 # Return elements to create formatted string for given struct member
1525 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=""):
1526 struct_op = "->"
1527 pre_var_name = '"%s "' % struct_member['full_type']
1528 if not struct_ptr:
1529 struct_op = "."
1530 member_name = struct_member['name']
1531 print_type = "p"
1532 cast_type = ""
1533 member_post = ""
1534 array_index = ""
1535 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001536 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001537 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1538 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001539 print_array = False
1540 elif struct_member['array'] and not print_array:
1541 # Just print base address of array when not full print_array
1542 cast_type = "(void*)"
1543 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001544 if struct_member['ptr']:
1545 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001546 cast_type = "string_%s" % struct_member['type']
1547 print_type = "s"
1548 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1549 cast_type = "(void*)"
1550 if not struct_member['ptr']:
1551 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -06001552 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis83562882014-11-27 15:43:39 -07001553 print_type = "s"
1554 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001555 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001556 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001557 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1558 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001559 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001560 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001561 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001562 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1563 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001564 elif True in [ui_str.lower() in struct_member['type'].lower() for ui_str in ['uint', 'flags', 'samplemask']]:
Tobin Ehlis83562882014-11-27 15:43:39 -07001565 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001566 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001567 print_type = "i"
1568 elif struct_member['ptr']:
1569 pass
1570 else:
1571 #print("Unhandled struct type: %s" % struct_member['type'])
1572 cast_type = "(void*)"
1573 if print_array and struct_member['array']:
1574 member_print_post = "[%u]"
1575 array_index = " i,"
1576 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001577 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
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001578 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
Tobin Ehlis83562882014-11-27 15:43:39 -07001579 return (print_out, print_arg)
1580
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001581 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001582 gv_funcs = []
1583 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001584 array_func_list.append('vkbufferviewattachinfo')
1585 array_func_list.append('vkimageviewattachinfo')
1586 array_func_list.append('vksamplerimageviewinfo')
1587 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001588 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001589 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001590 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1591 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001592 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001593 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]))
1594 else:
1595 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]))
Tobin Ehlis83562882014-11-27 15:43:39 -07001596 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001597 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001598 p_out = ""
1599 p_args = ""
1600 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1601 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1602 pl_dict = {}
1603 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001604 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001605 for m in sorted(self.struct_dict[s]):
1606 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1607 stp_list.append(self.struct_dict[s][m])
1608 if 'pNext' == self.struct_dict[s][m]['name']:
1609 pl_dict[m] = ' PORT=\\"pNext\\"'
1610 else:
1611 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1612 struct_num += 1
1613 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]))
1614 num_stps = len(stp_list);
1615 total_strlen_str = ''
1616 if 0 != num_stps:
1617 gv_funcs.append(" char* tmpStr;\n")
1618 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001619 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1620 for index in range(num_stps):
1621 if (stp_list[index]['ptr']):
1622 if 'pDescriptorInfo' == stp_list[index]['name']:
1623 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1624 else:
1625 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1626 if 'pNext' == stp_list[index]['name']:
1627 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001628 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001629 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1630 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1631 gv_funcs.append(' free(tmpStr);\n')
1632 else:
1633 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
Tobin Ehlis793ad302015-04-03 12:01:11 -06001634 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001635 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']))
Tobin Ehlis83562882014-11-27 15:43:39 -07001636 else:
1637 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1638 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1639 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1640 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001641 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001642 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1643 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1644 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1645 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1646 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1647 else:
1648 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1649 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1650 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1651 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1652 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1653 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1654 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1655 p_args = ", myNodeName, myNodeName, pStruct"
1656 for m in sorted(self.struct_dict[s]):
1657 plabel = ""
1658 if m in pl_dict:
1659 plabel = pl_dict[m]
1660 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1661 p_out += p_out1
1662 p_args += p_args1
1663 p_out += '</TABLE>>\\n];\\n\\n"'
1664 p_args += ");\n"
1665 gv_funcs.append(p_out)
1666 gv_funcs.append(p_args)
1667 if 0 != num_stps:
1668 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1669 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1670 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1671 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1672 gv_funcs.append(' }\n')
1673 gv_funcs.append(' }\n')
1674 gv_funcs.append(" return str;\n}\n")
1675 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001676 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001677 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001678 ptr_array = True
1679 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]))
1680 else:
1681 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]))
Tobin Ehlis83562882014-11-27 15:43:39 -07001682 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1683 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"3\\">%s (%p)</TD></TR>", myNodeName, myNodeName, pStruct);\n')
1684 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1685 gv_funcs.append(' sprintf(tmpStr, "');
1686 p_args = ""
1687 p_out = ""
1688 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07001689 plabel = ""
1690 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001691 if 0 == m: # Add array index notation at end of first row
1692 p_out1 = '%s<TD ROWSPAN=\\"%i\\" PORT=\\"slot%%u\\">%%u</TD></TR>' % (p_out1[:-5], len(self.struct_dict[s]))
Tobin Ehlis83562882014-11-27 15:43:39 -07001693 p_args1 += ', i, i'
1694 p_out += p_out1
1695 p_args += p_args1
1696 p_out += '"'
1697 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001698 if ptr_array:
1699 p_args = p_args.replace('->', '[i]->')
1700 else:
1701 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07001702 gv_funcs.append(p_out);
1703 gv_funcs.append(p_args);
1704 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1705 gv_funcs.append(' }\n')
1706 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001707 gv_funcs.append(' return str;\n}\n')
1708 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001709 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001710 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001711 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001712 gv_funcs.append(" switch (sType)\n {\n")
1713 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001714 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07001715 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001716 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis83562882014-11-27 15:43:39 -07001717 print_func_name = self._get_gv_func_name(struct_name)
1718 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001719 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001720 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001721 if 'VkSemaphoreCreateInfo' in struct_name:
1722 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001723 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001724 elif 'VkSemaphoreOpenInfo' in struct_name:
1725 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001726 print_func_name = self._get_gv_func_name(struct_name)
1727 gv_funcs.append(' case %s:\n' % (v))
1728 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1729 #gv_funcs.append(' }\n')
1730 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08001731 gv_funcs.append(" default:\n")
1732 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001733 gv_funcs.append(" }\n")
1734 gv_funcs.append("}")
1735 return "".join(gv_funcs)
1736
1737
1738
1739
1740
1741# def _generateHeader(self):
1742# hdr = []
1743# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1744# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1745# hdr.append('edge [\n];\n')
1746# return "\n".join(hdr)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001747#
Tobin Ehlis83562882014-11-27 15:43:39 -07001748# def _generateBody(self):
1749# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001750# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001751# field_num = 1
1752# 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]))
1753# for m in sorted(self.struc_dict[s]):
1754# 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']))
1755# field_num += 2
1756# body.append('</TABLE>>\n];\n')
1757# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001758
1759def main(argv=None):
1760 opts = handle_args()
1761 # Parse input file and fill out global dicts
1762 hfp = HeaderFileParser(opts.input_file)
1763 hfp.parse()
1764 # TODO : Don't want these to be global, see note at top about wrapper classes
1765 global enum_val_dict
1766 global enum_type_dict
1767 global struct_dict
1768 global typedef_fwd_dict
1769 global typedef_rev_dict
1770 global types_dict
1771 enum_val_dict = hfp.get_enum_val_dict()
1772 enum_type_dict = hfp.get_enum_type_dict()
1773 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07001774 # TODO : Would like to validate struct data here to verify that all of the bools for struct members are correct at this point
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001775 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1776 typedef_rev_dict = hfp.get_typedef_rev_dict()
1777 types_dict = hfp.get_types_dict()
1778 #print(enum_val_dict)
1779 #print(typedef_dict)
1780 #print(struct_dict)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001781 prefix = os.path.basename(opts.input_file).strip(".h")
1782 if prefix == "vulkan":
1783 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001784 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001785 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001786 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001787 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001788 enum_sh_filename = os.path.abspath(enum_sh_filename)
1789 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1790 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1791 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001792 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001793 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001794 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001795 print("Generating enum validate helper to %s" % enum_vh_filename)
1796 eg = EnumCodeGen(enum_type_dict, enum_val_dict, typedef_fwd_dict, os.path.basename(opts.input_file), enum_sh_filename, enum_vh_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001797 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001798 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001799 #for struct in struct_dict:
1800 #print(struct)
1801 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001802 sw = StructWrapperGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001803 #print(sw.get_class_name(struct))
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001804 sw.set_include_headers([os.path.basename(opts.input_file),os.path.basename(enum_sh_filename),"stdint.h","inttypes.h", "stdio.h","stdlib.h"])
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001805 print("Generating struct wrapper header to %s" % sw.header_filename)
1806 sw.generateHeader()
1807 print("Generating struct wrapper class to %s" % sw.class_filename)
1808 sw.generateBody()
1809 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001810 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07001811 # Generate a 2nd helper file that excludes addrs
1812 sw.set_no_addr(True)
1813 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07001814 sw.set_no_addr(False)
1815 sw.set_include_headers([os.path.basename(opts.input_file),os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h","iostream","sstream","string"])
Tobin Ehlis99f88672015-01-10 12:42:41 -07001816 sw.set_no_addr(True)
1817 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001818 sw.set_no_addr(False)
1819 sw.generateStringHelperCpp()
Courtney Goeltzenleuchterf53c3cb2015-04-14 14:55:44 -06001820 sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
Tobin Ehlis60354772015-03-12 14:50:40 -06001821 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001822 sw.generateSizeHelperC()
Jon Ashburnea65e492015-08-06 17:27:49 -06001823 if opts.gen_struct_sizes:
1824 st = StructWrapperGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
1825 st.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
1826 st.generateSizeHelper()
1827 st.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001828 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001829 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001830 cmg.generate()
1831 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001832 gv = GraphVizGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001833 gv.set_include_headers([os.path.basename(opts.input_file),os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h", "inttypes.h"])
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001834 gv.generate()
1835 print("DONE!")
1836 #print(typedef_rev_dict)
1837 #print(types_dict)
1838 #recreate_structs()
1839
1840if __name__ == "__main__":
1841 sys.exit(main())