blob: b52129a7d9b3d30ab697350cda5440c0b3f5be3d [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.')
39 parser.add_argument('--rel_out_dir', required=False, default='glave_gen', help='Path relative to exec path to write output files. Will be created if needed.')
40 parser.add_argument('--abs_out_dir', required=False, default=None, help='Absolute path to write output files. Will be created if needed.')
41 parser.add_argument('--gen_enum_string_helper', required=False, action='store_true', default=False, help='Enable generation of helper header file to print string versions of enums.')
42 parser.add_argument('--gen_struct_wrappers', required=False, action='store_true', default=False, help='Enable generation of struct wrapper classes.')
43 parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.')
44 parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.')
45 #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.')
46 return parser.parse_args()
47
48# TODO : Ideally these data structs would be opaque to user and could be wrapped
49# in their own class(es) to make them friendly for data look-up
50# Dicts for Data storage
51# enum_val_dict[value_name] = dict keys are the string enum value names for all enums
52# |-------->['type'] = the type of enum class into which the value falls
53# |-------->['val'] = the value assigned to this particular value_name
54# '-------->['unique'] = bool designating if this enum 'val' is unique within this enum 'type'
55enum_val_dict = {}
56# enum_type_dict['type'] = the type or class of of enum
57# '----->['val_name1', 'val_name2'...] = each type references a list of val_names within this type
58enum_type_dict = {}
59# struct_dict['struct_basename'] = the base (non-typedef'd) name of the struct
60# |->[<member_num>] = members are stored via their integer placement in the struct
61# | |->['name'] = string name of this struct member
62# ... |->['full_type'] = complete type qualifier for this member
63# |->['type'] = base type for this member
64# |->['ptr'] = bool indicating if this member is ptr
65# |->['const'] = bool indicating if this member is const
66# |->['struct'] = bool indicating if this member is a struct type
67# |->['array'] = bool indicating if this member is an array
Tobin Ehlisbd6a9162015-03-13 07:18:05 -060068# |->['dyn_array'] = bool indicating if member is a dynamically sized array
69# '->['array_size'] = For dyn_array, member name used to size array, else int size for static array
Tobin Ehlis6442dca2014-10-22 15:13:53 -060070struct_dict = {}
71# typedef_fwd_dict stores mapping from orig_type_name -> new_type_name
72typedef_fwd_dict = {}
73# typedef_rev_dict stores mapping from new_type_name -> orig_type_name
74typedef_rev_dict = {} # store new_name -> orig_name mapping
75# types_dict['id_name'] = identifier name will map to it's type
76# '---->'type' = currently either 'struct' or 'enum'
77types_dict = {} # store orig_name -> type mapping
78
79
80# Class that parses header file and generates data structures that can
81# Then be used for other tasks
82class HeaderFileParser:
83 def __init__(self, header_file=None):
84 self.header_file = header_file
85 # store header data in various formats, see above for more info
86 self.enum_val_dict = {}
87 self.enum_type_dict = {}
88 self.struct_dict = {}
89 self.typedef_fwd_dict = {}
90 self.typedef_rev_dict = {}
91 self.types_dict = {}
Tobin Ehlis5178bd72015-03-06 10:38:25 -070092 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -060093
94 def setHeaderFile(self, header_file):
95 self.header_file = header_file
96
97 def get_enum_val_dict(self):
98 return self.enum_val_dict
99
100 def get_enum_type_dict(self):
101 return self.enum_type_dict
102
103 def get_struct_dict(self):
104 return self.struct_dict
105
106 def get_typedef_fwd_dict(self):
107 return self.typedef_fwd_dict
108
109 def get_typedef_rev_dict(self):
110 return self.typedef_rev_dict
111
112 def get_types_dict(self):
113 return self.types_dict
114
115 # Parse header file into data structures
116 def parse(self):
117 # parse through the file, identifying different sections
118 parse_enum = False
119 parse_struct = False
120 member_num = 0
121 # TODO : Comment parsing is very fragile but handles 2 known files
122 block_comment = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700123 prev_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600124 with open(self.header_file) as f:
125 for line in f:
126 if block_comment:
127 if '*/' in line:
128 block_comment = False
129 continue
130 if '/*' in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600131 if '*/' in line: # single line block comment
132 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600133 block_comment = True
134 elif 0 == len(line.split()):
135 #print("Skipping empty line")
136 continue
137 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700138 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600139 continue
140 elif 'typedef enum' in line:
141 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
142 #print("Found ENUM type %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600143 if '{' == base_type:
144 base_type = 'tmp_enum'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600145 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700146 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600147 self.types_dict[base_type] = 'enum'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600148 elif 'typedef struct' in line or 'typedef union' in line:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600149 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
150 #print("Found STRUCT type: %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600151 if '{' == base_type:
152 base_type = 'tmp_struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600153 parse_struct = True
154 self.types_dict[base_type] = 'struct'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600155# elif 'typedef union' in line:
156# (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
157# print("Found UNION type: %s" % base_type)
158# parse_struct = True
159# self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600160 elif '}' in line and (parse_enum or parse_struct):
161 if len(line.split()) > 1: # deals with embedded union in one struct
162 parse_enum = False
163 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700164 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600165 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600166 (cur_char, targ_type) = line.strip().split(None, 1)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600167 if 'tmp_struct' == base_type:
168 base_type = targ_type.strip(';')
169 #print("Found Actual Struct type %s" % base_type)
170 self.struct_dict[base_type] = self.struct_dict['tmp_struct']
171 self.struct_dict.pop('tmp_struct', 0)
172 self.types_dict[base_type] = 'struct'
173 self.types_dict.pop('tmp_struct', 0)
174 elif 'tmp_enum' == base_type:
175 base_type = targ_type.strip(';')
176 #print("Found Actual ENUM type %s" % base_type)
177 for n in self.enum_val_dict:
178 if 'tmp_enum' == self.enum_val_dict[n]['type']:
179 self.enum_val_dict[n]['type'] = base_type
180# self.enum_val_dict[base_type] = self.enum_val_dict['tmp_enum']
181# self.enum_val_dict.pop('tmp_enum', 0)
182 self.enum_type_dict[base_type] = self.enum_type_dict['tmp_enum']
183 self.enum_type_dict.pop('tmp_enum', 0)
184 self.types_dict[base_type] = 'enum'
185 self.types_dict.pop('tmp_enum', 0)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600186 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
187 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600188 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600189 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600190 #if 'VK_MAX_ENUM' not in line and '{' not in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600191 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 -0700192 self._add_enum(line, base_type, default_enum_val)
193 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600194 elif parse_struct:
195 if ';' in line:
196 self._add_struct(line, base_type, member_num)
197 member_num = member_num + 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600198
199 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700200 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600201 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700202 if '=' in line_txt:
203 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
204 else:
205 enum_name = line_txt.split(',')[0]
206 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600207 self.enum_val_dict[enum_name] = {}
208 self.enum_val_dict[enum_name]['type'] = enum_type
209 # strip comma and comment, then extra split in case of no comma w/ comments
210 enum_val = enum_val.strip().split(',', 1)[0]
211 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600212 # Perform conversion of VK_BIT macro
213 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
214 vk_bit_val = self.enum_val_dict[enum_name]['val']
215 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
216 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
217 else:
218 # account for negative values surrounded by parens
219 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700220 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600221 try:
222 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
223 int(self.enum_val_dict[enum_name]['val'], 0)
224 self.enum_val_dict[enum_name]['unique'] = True
225 #print("ENUM has num value")
226 except ValueError:
227 self.enum_val_dict[enum_name]['unique'] = False
228 #print("ENUM is not a number value")
229 # Update enum_type_dict as well
230 if not enum_type in self.enum_type_dict:
231 self.enum_type_dict[enum_type] = []
232 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700233
234 # Return True of struct member is a dynamic array
235 # RULES : This is a bit quirky based on the API
236 # NOTE : Changes in API spec may cause these rules to change
237 # 1. There must be a previous uint var w/ 'count' in the name in the struct
238 # 2. Dynam array must have 'const' and '*' qualifiers
239 # 3a. Name of dynam array must end in 's' char OR
240 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
241 def _is_dynamic_array(self, full_type, name):
242 if '' != self.last_struct_count_name:
243 if 'const' in full_type and '*' in full_type:
244 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
245 return True
246 return False
247
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600248 # populate struct dicts based on struct lines
249 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
250 def _add_struct(self, line_txt, struct_type, num):
251 #print("Parsing struct line %s" % line_txt)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600252 if '{' == struct_type:
253 print("Parsing struct '{' w/ line %s" % line_txt)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600254 if not struct_type in self.struct_dict:
255 self.struct_dict[struct_type] = {}
256 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
257 # TODO : Handle bitfields more correctly
258 members = members.strip().split(':', 1)[0] # strip bitfield element
259 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700260 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600261 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700262 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600263 self.struct_dict[struct_type][num] = {}
264 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700265 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600266 if '*' in member_type:
267 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700268 # TODO : Need more general purpose way here to reduce down to basic type
269 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600270 member_type = member_type.strip('*')
271 else:
272 self.struct_dict[struct_type][num]['ptr'] = False
273 if 'const' in member_type:
274 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600275 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600276 else:
277 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700278 # TODO : There is a bug here where it seems that at the time we do this check,
279 # 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 -0600280 if is_type(member_type, 'struct'):
281 self.struct_dict[struct_type][num]['struct'] = True
282 else:
283 self.struct_dict[struct_type][num]['struct'] = False
284 self.struct_dict[struct_type][num]['type'] = member_type
285 if '[' in member_name:
286 (member_name, array_size) = member_name.split('[', 1)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600287 if 'char' in member_type:
288 self.struct_dict[struct_type][num]['array'] = False
289 self.struct_dict[struct_type][num]['array_size'] = 0
290 self.struct_dict[struct_type][num]['ptr'] = True
291 else:
292 self.struct_dict[struct_type][num]['array'] = True
293 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700294 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
295 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
296 self.struct_dict[struct_type][num]['array'] = True
297 self.struct_dict[struct_type][num]['dyn_array'] = True
298 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700299 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600300 self.struct_dict[struct_type][num]['array'] = False
301 self.struct_dict[struct_type][num]['array_size'] = 0
302 self.struct_dict[struct_type][num]['name'] = member_name
303
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700304# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600305def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600306 if identifier in types_dict and type_to_check == types_dict[identifier]:
307 return True
308 if identifier in typedef_rev_dict:
309 new_id = typedef_rev_dict[identifier]
310 if new_id in types_dict and type_to_check == types_dict[new_id]:
311 return True
312 return False
313
314# This is a validation function to verify that we can reproduce the original structs
315def recreate_structs():
316 for struct_name in struct_dict:
317 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
318 for mem_num in sorted(struct_dict[struct_name]):
319 sys.stdout.write(" ")
320 if struct_dict[struct_name][mem_num]['const']:
321 sys.stdout.write("const ")
322 #if struct_dict[struct_name][mem_num]['struct']:
323 # sys.stdout.write("struct ")
324 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
325 if struct_dict[struct_name][mem_num]['ptr']:
326 sys.stdout.write("*")
327 sys.stdout.write(" ")
328 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
329 if struct_dict[struct_name][mem_num]['array']:
330 sys.stdout.write("[")
331 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
332 sys.stdout.write("]")
333 sys.stdout.write(";\n")
334 sys.stdout.write("} ")
335 sys.stdout.write(typedef_fwd_dict[struct_name])
336 sys.stdout.write(";\n\n")
337
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600338#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600339# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600340def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600341 # Note: All struct types are now camel-case
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600342 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600343 char_idx = 0
344 struct_name = ''
345 for char in caps_struct_name:
346 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
347 struct_name += caps_struct_name[char_idx]
348 elif (caps_struct_name[char_idx] == '_'):
349 pass
350 else:
351 struct_name += caps_struct_name[char_idx].lower()
352 char_idx += 1
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600353 return struct_name
354
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600355# class for writing common file elements
356# Here's how this class lays out a file:
357# COPYRIGHT
358# HEADER
359# BODY
360# FOOTER
361#
362# For each of these sections, there's a "set*" function
363# The class as a whole has a generate function which will write each section in order
364class CommonFileGen:
365 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
366 self.filename = filename
367 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
368 # TODO : Set a default copyright & footer at least
369
370 def setFilename(self, filename):
371 self.filename = filename
372
373 def setCopyright(self, c):
374 self.contents['copyright'] = c
375
376 def setHeader(self, h):
377 self.contents['header'] = h
378
379 def setBody(self, b):
380 self.contents['body'] = b
381
382 def setFooter(self, f):
383 self.contents['footer'] = f
384
385 def generate(self):
386 #print("Generate to file %s" % self.filename)
387 with open(self.filename, "w") as f:
388 f.write(self.contents['copyright'])
389 f.write(self.contents['header'])
390 f.write(self.contents['body'])
391 f.write(self.contents['footer'])
392
393# class for writing a wrapper class for structures
394# The wrapper class wraps the structs and includes utility functions for
395# setting/getting member values and displaying the struct data in various formats
396class StructWrapperGen:
397 def __init__(self, in_struct_dict, prefix, out_dir):
398 self.struct_dict = in_struct_dict
399 self.include_headers = []
400 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600401 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600402 self.api_prefix = "vk"
403 else:
404 self.api_prefix = prefix
405 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
406 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
407 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
408 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
409 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
410 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
411 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700412 self.no_addr = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600413 self.hfg = CommonFileGen(self.header_filename)
414 self.cfg = CommonFileGen(self.class_filename)
415 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700416 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700417 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600418 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
419 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600420 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700421 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600422 #print(self.header_filename)
423 self.header_txt = ""
424 self.definition_txt = ""
425
426 def set_include_headers(self, include_headers):
427 self.include_headers = include_headers
428
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700429 def set_no_addr(self, no_addr):
430 self.no_addr = no_addr
431 if self.no_addr:
432 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700433 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700434 else:
435 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700436 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700437
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600438 # Return class name for given struct name
439 def get_class_name(self, struct_name):
440 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
441 return class_name
442
443 def get_file_list(self):
444 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
445
446 # Generate class header file
447 def generateHeader(self):
448 self.hfg.setCopyright(self._generateCopyright())
449 self.hfg.setHeader(self._generateHeader())
450 self.hfg.setBody(self._generateClassDeclaration())
451 self.hfg.setFooter(self._generateFooter())
452 self.hfg.generate()
453
454 # Generate class definition
455 def generateBody(self):
456 self.cfg.setCopyright(self._generateCopyright())
457 self.cfg.setHeader(self._generateCppHeader())
458 self.cfg.setBody(self._generateClassDefinition())
459 self.cfg.setFooter(self._generateFooter())
460 self.cfg.generate()
461
462 # Generate c-style .h file that contains functions for printing structs
463 def generateStringHelper(self):
464 print("Generating struct string helper")
465 self.shg.setCopyright(self._generateCopyright())
466 self.shg.setHeader(self._generateStringHelperHeader())
467 self.shg.setBody(self._generateStringHelperFunctions())
468 self.shg.generate()
469
Tobin Ehlis99f88672015-01-10 12:42:41 -0700470 # Generate cpp-style .h file that contains functions for printing structs
471 def generateStringHelperCpp(self):
472 print("Generating struct string helper cpp")
473 self.shcppg.setCopyright(self._generateCopyright())
474 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
475 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
476 self.shcppg.generate()
477
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700478 # Generate c-style .h file that contains functions for printing structs
479 def generateValidateHelper(self):
480 print("Generating struct validate helper")
481 self.vhg.setCopyright(self._generateCopyright())
482 self.vhg.setHeader(self._generateValidateHelperHeader())
483 self.vhg.setBody(self._generateValidateHelperFunctions())
484 self.vhg.generate()
485
Tobin Ehlis60354772015-03-12 14:50:40 -0600486 def generateSizeHelper(self):
487 print("Generating struct size helper")
488 self.size_helper_gen.setCopyright(self._generateCopyright())
489 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
490 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
491 self.size_helper_gen.generate()
492
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700493 def generateSizeHelperC(self):
494 print("Generating struct size helper c")
495 self.size_helper_c_gen.setCopyright(self._generateCopyright())
496 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
497 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
498 self.size_helper_c_gen.generate()
499
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600500 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700501 copyright = []
502 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
503 copyright.append('');
504 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600505 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700506 copyright.append(' *');
507 copyright.append(' * Copyright (C) 2014 LunarG, Inc.');
508 copyright.append(' *');
509 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
510 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
511 copyright.append(' * to deal in the Software without restriction, including without limitation');
512 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
513 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
514 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
515 copyright.append(' *');
516 copyright.append(' * The above copyright notice and this permission notice shall be included');
517 copyright.append(' * in all copies or substantial portions of the Software.');
518 copyright.append(' *');
519 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
520 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
521 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
522 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
523 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
524 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
525 copyright.append(' * DEALINGS IN THE SOFTWARE.');
526 copyright.append(' */');
527 copyright.append('');
528 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600529
530 def _generateCppHeader(self):
531 header = []
532 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600533 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 -0600534 return "".join(header)
535
536 def _generateClassDefinition(self):
537 class_def = []
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600538 if 'vk' == self.api: # Mantle doesn't have pNext to worry about
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600539 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700540 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600541 class_def.append("\n// %s class definition" % self.get_class_name(s))
542 class_def.append(self._generateConstructorDefinitions(s))
543 class_def.append(self._generateDestructorDefinitions(s))
544 class_def.append(self._generateDisplayDefinitions(s))
545 return "\n".join(class_def)
546
547 def _generateConstructorDefinitions(self, s):
548 con_defs = []
549 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)))
550 # TODO : This is a shallow copy of ptrs
551 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]))
552 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]))
553 return "\n".join(con_defs)
554
555 def _generateDestructorDefinitions(self, s):
556 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
557
558 def _generateDynamicPrintFunctions(self):
559 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600560 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 -0600561 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600562 dp_funcs.append(" switch (sType)\n {")
563 for e in enum_type_dict:
564 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600565 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600566 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600567 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600568 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600569 instance_name = "swc%i" % class_num
570 dp_funcs.append(" case %s:\n {" % (v))
571 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
572 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
573 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
574 dp_funcs.append(" }")
575 dp_funcs.append(" break;")
576 class_num += 1
577 dp_funcs.append(" }")
578 dp_funcs.append("}\n")
579 return "\n".join(dp_funcs)
580
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700581 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600582 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700583
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600584 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700585 return self._get_func_name(struct, 'print')
586
587 def _get_vh_func_name(self, struct):
588 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600589
Tobin Ehlis60354772015-03-12 14:50:40 -0600590 def _get_size_helper_func_name(self, struct):
591 return self._get_func_name(struct, 'size')
592
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600593 # Return elements to create formatted string for given struct member
594 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
595 struct_op = "->"
596 if not struct_ptr:
597 struct_op = "."
598 member_name = struct_member['name']
599 print_type = "p"
600 cast_type = ""
601 member_post = ""
602 array_index = ""
603 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700604 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700605 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
606 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
607 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600608 print_type = "s"
609 print_array = False
610 elif struct_member['array'] and not print_array:
611 # Just print base address of array when not full print_array
612 cast_type = "(void*)"
613 elif is_type(struct_member['type'], 'enum'):
614 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700615 if struct_member['ptr']:
616 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600617 print_type = "s"
618 elif is_type(struct_member['type'], 'struct'): # print struct address for now
619 cast_type = "(void*)"
620 if not struct_member['ptr']:
621 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -0600622 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600623 print_type = "s"
624 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700625 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600626 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600627 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
628 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700629 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600630 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600631 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700632 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
633 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600634 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 -0600635 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700636 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600637 print_type = "i"
638 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600639 pass
640 else:
641 #print("Unhandled struct type: %s" % struct_member['type'])
642 cast_type = "(void*)"
643 if print_array and struct_member['array']:
644 member_print_post = "[%u]"
645 array_index = " i,"
646 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700647 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 -0600648 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 -0700649 if self.no_addr and "p" == print_type:
650 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
651 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600652 return (print_out, print_arg)
653
654 def _generateStringHelperFunctions(self):
655 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700656 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700657 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700658 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
659 sh_funcs.append('')
660 sh_funcs.append('#if defined(_WIN32)')
661 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
662 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
663 sh_funcs.append('// work-around.')
664 sh_funcs.append('#define snprintf _snprintf')
665 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700666 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600667 p_out = ""
668 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700669 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 -0700670 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700671 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700672 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
673 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700674 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]))
675 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700676 num_stps = len(stp_list);
677 total_strlen_str = ''
678 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700679 sh_funcs.append(" char* tmpStr;")
680 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
681 sh_funcs.append(' strcpy(extra_indent, " ");')
682 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
683 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700684 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700685 # If it's an array, print all of the elements
686 # If it's a ptr, print thing it's pointing to
687 # Non-ptr struct case. Print the struct using its address
688 struct_deref = '&'
689 if 1 < stp_list[index]['full_type'].count('*'):
690 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700691 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700692 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700693 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700694 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
695 sh_funcs.append(' len = 256+strlen(tmpStr);')
696 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700697 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700698 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700699 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700700 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
701 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700702 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700703 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
704 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600705 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 -0700706 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700707 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
708 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
709 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700710 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700711 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 -0700712 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700713 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']))
714 sh_funcs.append(' }')
715 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
716 elif stp_list[index]['array']:
717 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
718 sh_funcs.append(' len = 256+strlen(tmpStr);')
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[0] (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[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 -0700724 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700725 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
726 sh_funcs.append(' len = 256+strlen(tmpStr);')
727 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700728 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700729 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 -0700730 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700731 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 -0700732 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700733 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
734 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700735 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600736 for m in sorted(self.struct_dict[s]):
737 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
738 p_out += p_out1
739 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600740 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700741 p_args += ");"
742 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700743 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700744 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
745 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
746 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
747 sh_funcs.append(' free(stp_strs[stp_index]);')
748 sh_funcs.append(' }')
749 sh_funcs.append(' }')
750 sh_funcs.append(' free(extra_indent);')
751 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600752 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700753 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
754 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
755 sh_funcs.append(" if (pStruct == NULL) {")
756 sh_funcs.append(" return NULL;")
757 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600758 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700759 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
760 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600761 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600762 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600763 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600764 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600765 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700766 sh_funcs.append(' case %s:\n {' % (v))
767 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
768 sh_funcs.append(' }')
769 sh_funcs.append(' break;')
770 sh_funcs.append(" default:")
771 sh_funcs.append(" return NULL;")
772 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600773 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700774 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700775
776 def _generateStringHelperFunctionsCpp(self):
777 # declare str & tmp str
778 # declare array of stringstreams for every struct ptr in current struct
779 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700780 # For every struct ptr, if non-Null, then set its string, else set to NULL str
781 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700782 # create and return final string
783 sh_funcs = []
784 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600785 # XXX - REMOVE this comment
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600786 lineinfo = sourcelineinfo()
787 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700788 for s in sorted(self.struct_dict):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700789 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
790 sh_funcs.append('\n')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600791 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700792 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600793 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 -0700794 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 -0700795 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700796 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700797 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 -0600798 # TODO: This is a tmp workaround
799 if 'ppActiveLayerNames' not in self.struct_dict[s][m]['name']:
800 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600801 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700802 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 -0600803 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700804 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600805 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700806 sh_funcs.append('%sstring final_str;' % (indent))
807 sh_funcs.append('%sstring tmp_str;' % (indent))
808 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700809 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700810 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700811 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600812 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700813 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700814 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700815 idx_ss_decl = False # Make sure to only decl this once
816 for index in range(num_stps):
817 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700818 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700819 addr_char = ''
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600820 if stp_list[index]['array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600821 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700822 if stp_list[index]['dyn_array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600823 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700824 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
825 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600826 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700827 array_count = '%s' % (stp_list[index]['array_size'])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600828 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700829 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
830 if not idx_ss_decl:
831 sh_funcs.append('%sstringstream index_ss;' % (indent))
832 idx_ss_decl = True
Tobin Ehlis793ad302015-04-03 12:01:11 -0600833 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
834 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700835 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600836 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700837 sh_funcs.append('%sindex_ss.str("");' % (indent))
838 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600839 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600840 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700841 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600842 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
843 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 -0700844 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 -0600845 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600846 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700847 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
848 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']))
849 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600850 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700851 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
852 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600853 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700854 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 -0600855 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600856 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600857 addr_char = ''
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600858 if stp_list[index]['type'] in vulkan.core.objects:
859 sh_funcs.append('%sss[%u] << %spStruct->%s[i].handle;' % (indent, index, addr_char, stp_list[index]['name']))
860 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "].handle = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
861 else:
862 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
863 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 -0600864 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700865 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600866 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700867 sh_funcs.append('%s}' % (indent))
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600868 indent = indent[4:]
869 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700870 elif (stp_list[index]['ptr']):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600871 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600872 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
873 indent += ' '
Tobin Ehlis99f88672015-01-10 12:42:41 -0700874 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600875 sh_funcs.append('%s' % lineinfo.get())
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600876 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700877 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700878 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
879 # TODO : This is a quick hack to handle these arrays of ptrs
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600880 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600881 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 -0700882 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600883 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700884 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 -0700885 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
886 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600887 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700888 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
889 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600890 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700891 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
892 sh_funcs.append(' ss[%u].str("");' % (index))
893 sh_funcs.append(' }')
894 sh_funcs.append(' else')
895 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700896 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600897 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700898 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
899 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
900 if self.no_addr:
901 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600902 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700903 else:
904 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 -0600905 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700906 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -0600907 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -0700908 index = 0
909 final_str = ''
910 for m in sorted(self.struct_dict[s]):
911 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
912 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
913 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600914 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700915 sh_funcs.append(' ss[%u].str("addr");' % (index))
916 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600917 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700918 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Jon Ashburnc669cc62015-07-09 15:02:25 -0600919 elif self.struct_dict[s][m]['array']:
920 sh_funcs.append('%s' % lineinfo.get())
921 sh_funcs.append(' ss[%u] << (void*)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700922 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600923 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700924 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700925 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600926 sh_funcs.append('%s' % lineinfo.get())
Jon Ashburnc669cc62015-07-09 15:02:25 -0600927 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600928 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600929 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600930 sh_funcs.append(' if (StreamControl::writeAddress)')
931 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
932 sh_funcs.append(' else')
933 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700934 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600935 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700936 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700937 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700938 sh_funcs.append(' ss[%u].str("addr");' % (index))
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600939 elif not self.struct_dict[s][m]['ptr'] and self.struct_dict[s][m]['type'] in vulkan.core.objects:
940 sh_funcs.append(' ss[%u] << pStruct->%s.handle;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700941 else:
942 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
943 value_print = 'ss[%u].str()' % index
944 index += 1
945 else:
Tobin Ehlisce320942015-06-11 09:37:00 -0600946 # 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 -0700947 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600948 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600949 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
950 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
951 sh_funcs.append(' else')
952 sh_funcs.append(' ss[%u].str("NULL");' % (index))
953 value_print = 'ss[%u].str()' % index
954 index += 1
955 # For single enum just print the string representation
956 else:
957 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 -0700958 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
959 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700960 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -0700961 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600962 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700963 sh_funcs.append(' final_str = %s;' % final_str)
964 sh_funcs.append(' return final_str;\n}')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700965 # Add function to return a string value for input void*
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600966 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700967 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600968 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -0700969 sh_funcs.append(" stringstream ss;")
970 sh_funcs.append(' ss << toString;')
971 sh_funcs.append(' string final_str = prefix + ss.str();')
972 sh_funcs.append(" return final_str;")
973 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600974 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis08541742015-04-16 15:56:11 -0600975 # Add function to return a string value for input uint32_t
976 sh_funcs.append("string string_convert_helper(const uint32_t toString, const string prefix)\n{")
977 sh_funcs.append(" using namespace StreamControl;")
978 sh_funcs.append(" stringstream ss;")
979 sh_funcs.append(' ss << toString;')
980 sh_funcs.append(' string final_str = prefix + ss.str();')
981 sh_funcs.append(" return final_str;")
982 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600983 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700984 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600985 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700986 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -0700987 sh_funcs.append(" if (pStruct == NULL) {\n")
Jon Ashburn62a327c2015-02-25 12:45:23 -0700988 sh_funcs.append(" return NULL;")
Ian Elliott82800022015-02-25 17:40:38 -0700989 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600990 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700991 sh_funcs.append(' string indent = " ";')
992 sh_funcs.append(' indent += prefix;')
993 sh_funcs.append(" switch (sType)\n {")
994 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600995 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700996 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600997 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700998 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600999 #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 -07001000 sh_funcs.append(' case %s:\n {' % (v))
1001 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
1002 sh_funcs.append(' }')
1003 sh_funcs.append(' break;')
1004 sh_funcs.append(" default:")
1005 sh_funcs.append(" return NULL;")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001006 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001007 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001008 sh_funcs.append("}")
1009 return "\n".join(sh_funcs)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001010
1011 def _genStructMemberPrint(self, member, s, array, struct_array):
1012 (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)
1013 extra_indent = ""
1014 if array:
1015 extra_indent = " "
1016 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
1017 struct_array.insert(0, self.struct_dict[s][member])
1018 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001019 # Special case for void* named "pNext"
1020 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001021 struct_array.insert(0, self.struct_dict[s][member])
1022 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
1023
1024 def _generateDisplayDefinitions(self, s):
1025 disp_def = []
1026 struct_array = []
1027 # Single-line struct print function
1028 disp_def.append("// Output 'structname = struct_address' on a single line")
1029 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
1030 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1031 disp_def.append("}\n")
1032 # Private helper function to print struct members
1033 disp_def.append("// Private helper function that displays the members of the wrapped struct")
1034 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
1035 i_declared = False
1036 for member in sorted(self.struct_dict[s]):
1037 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001038 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001039 # Can grab struct type off of header of struct pointed to
1040 # TODO : Handle Arrays
1041 if self.struct_dict[s][member]['array']:
1042 # Create for loop to print each element of array
1043 if not i_declared:
1044 disp_def.append(' uint32_t i;')
1045 i_declared = True
1046 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
1047 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
1048 disp_def.append(return_str)
1049 disp_def.append(' }')
1050 else:
1051 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
1052 disp_def.append(return_str)
1053 disp_def.append("}\n")
1054 i_declared = False
1055 # Basic print function to display struct members
1056 disp_def.append("// Output all struct elements, each on their own line")
1057 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
1058 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1059 disp_def.append(' this->display_struct_members();')
1060 disp_def.append("}\n")
1061 # Advanced print function to display current struct and contents of any pointed-to structs
1062 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1063 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1064 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1065 disp_def.append(' this->display_struct_members();')
1066 class_num = 0
1067 # TODO : Need to handle arrays of structs here
1068 for ms in struct_array:
1069 swc_name = "class%s" % str(class_num)
1070 if ms['array']:
1071 if not i_declared:
1072 disp_def.append(' uint32_t i;')
1073 i_declared = True
1074 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1075 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1076 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1077 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1078 disp_def.append(" %s.display_full_txt();" % (swc_name))
1079 #disp_def.append(' }')
1080 disp_def.append(' }')
1081 elif 'pNext' == ms['name']:
1082 # Need some code trickery here
1083 # I'm thinking have a generated function that takes pNext ptr value
1084 # then it checks sType and in large switch statement creates appropriate
1085 # wrapper class type and then prints contents
1086 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1087 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1088 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1089 disp_def.append(" }")
1090 else:
1091 if ms['ptr']:
1092 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1093 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1094 else:
1095 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1096 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1097 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1098 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1099 class_num += 1
1100 disp_def.append("}\n")
1101 return "\n".join(disp_def)
1102
1103 def _generateStringHelperHeader(self):
1104 header = []
1105 header.append("//#includes, #defines, globals and such...\n")
1106 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001107 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001108 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001109 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001110 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001111 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001112
1113 def _generateStringHelperHeaderCpp(self):
1114 header = []
1115 header.append("//#includes, #defines, globals and such...\n")
1116 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001117 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001118 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001119 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001120 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001121 header.append('\n')
1122 header.append('namespace StreamControl\n')
1123 header.append('{\n')
1124 header.append('bool writeAddress = true;\n')
1125 header.append('template <typename T>\n')
1126 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1127 header.append('{\n')
1128 header.append(' if(writeAddress)\n')
1129 header.append(' {\n')
1130 header.append(' out.operator<<(pointer);\n')
1131 header.append(' }\n')
1132 header.append(' else\n')
1133 header.append(' {\n')
1134 header.append(' std::operator<<(out, "address");\n')
1135 header.append(' }\n')
1136 header.append(' return out;\n')
1137 header.append('}\n')
1138 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1139 header.append('{\n')
1140 header.append(' return std::operator<<(out, s);\n')
1141 header.append('}\n')
1142 header.append('}\n')
1143 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001144 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001145 return "".join(header)
1146
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001147 def _generateValidateHelperFunctions(self):
1148 sh_funcs = []
1149 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001150 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001151 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1152 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001153 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001154 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1155 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001156 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001157 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 -07001158 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 -07001159 # 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 -07001160 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1161 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001162 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 -07001163 else:
1164 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 -07001165 sh_funcs.append(" return 1;\n}")
1166
1167 return "\n".join(sh_funcs)
1168
1169 def _generateValidateHelperHeader(self):
1170 header = []
1171 header.append("//#includes, #defines, globals and such...\n")
1172 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001173 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001174 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001175 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001176 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001177 return "".join(header)
1178
Tobin Ehlis60354772015-03-12 14:50:40 -06001179 def _generateSizeHelperFunctions(self):
1180 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001181 # just generates prototypes for all the functions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001182 for s in sorted(self.struct_dict):
Tobin Ehlis60354772015-03-12 14:50:40 -06001183 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 -07001184 return "\n".join(sh_funcs)
1185
1186
1187 def _generateSizeHelperFunctionsC(self):
1188 sh_funcs = []
1189 # generate function definitions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001190 for s in sorted(self.struct_dict):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001191 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001192 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1193 indent = ' '
1194 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1195 sh_funcs.append('%sif (pStruct) {' % (indent))
1196 indent = ' '
1197 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1198 i_decl = False
1199 for m in sorted(self.struct_dict[s]):
1200 if m in skip_list:
1201 continue
1202 if self.struct_dict[s][m]['dyn_array']:
1203 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1204 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 -06001205 if 'ppMemBarriers' == self.struct_dict[s][m]['name']:
1206 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001207 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 -06001208 else:
1209 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 -06001210 else: # This is an array of char* or array of struct ptrs
1211 if not i_decl:
1212 sh_funcs.append('%suint32_t i = 0;' % (indent))
1213 i_decl = True
1214 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1215 indent = ' '
1216 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1217 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']))
1218 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001219 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 -06001220 indent = ' '
1221 sh_funcs.append('%s}' % (indent))
1222 else:
1223 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1224 if not i_decl:
1225 sh_funcs.append('%suint32_t i = 0;' % (indent))
1226 i_decl = True
1227 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1228 indent = ' '
1229 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']))
1230 indent = ' '
1231 sh_funcs.append('%s}' % (indent))
1232 else:
1233 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1234 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1235 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001236 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 -06001237 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1238 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 -06001239 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis60354772015-03-12 14:50:40 -06001240 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1241 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1242 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1243 skip_list.append(m+1)
1244 indent = ' '
1245 sh_funcs.append('%s}' % (indent))
1246 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001247 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
1248 for follow_chain in [True, False]:
1249 if follow_chain:
1250 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1251 else:
1252 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1253 indent = ' '
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001254 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1255 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001256 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1257 if follow_chain:
1258 sh_funcs.append('%swhile (pNext) {' % (indent))
1259 indent = ' '
1260 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1261 indent += ' '
1262 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001263 if 'StructureType' in e:
Tobin Ehlis04112922015-03-16 10:44:40 -06001264 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001265 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis04112922015-03-16 10:44:40 -06001266 sh_funcs.append('%scase %s:' % (indent, v))
1267 sh_funcs.append('%s{' % (indent))
1268 indent += ' '
1269 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1270 sh_funcs.append('%sbreak;' % (indent))
1271 indent = indent[:-4]
1272 sh_funcs.append('%s}' % (indent))
1273 sh_funcs.append('%sdefault:' % (indent))
1274 indent += ' '
1275 sh_funcs.append('%sassert(0);' % (indent))
1276 sh_funcs.append('%sstructSize += 0;' % (indent))
1277 indent = indent[:-4]
1278 indent = indent[:-4]
1279 sh_funcs.append('%s}' % (indent))
1280 if follow_chain:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001281 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001282 indent = indent[:-4]
1283 sh_funcs.append('%s}' % (indent))
1284 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001285 return "\n".join(sh_funcs)
1286
1287 def _generateSizeHelperHeader(self):
1288 header = []
1289 header.append("//#includes, #defines, globals and such...\n")
1290 for f in self.include_headers:
1291 header.append("#include <%s>\n" % f)
1292 header.append('\n// Function Prototypes\n')
1293 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001294 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001295 return "".join(header)
1296
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001297 def _generateSizeHelperHeaderC(self):
1298 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001299 header.append('#include "vk_struct_size_helper.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001300 header.append('#include <string.h>')
1301 header.append('#include <assert.h>')
1302 header.append('\n// Function definitions\n')
1303 return "\n".join(header)
1304
1305
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001306 def _generateHeader(self):
1307 header = []
1308 header.append("//#includes, #defines, globals and such...\n")
1309 for f in self.include_headers:
1310 header.append("#include <%s>\n" % f)
1311 return "".join(header)
1312
1313 # Declarations
1314 def _generateConstructorDeclarations(self, s):
1315 constructors = []
1316 constructors.append(" %s();\n" % self.get_class_name(s))
1317 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1318 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1319 return "".join(constructors)
1320
1321 def _generateDestructorDeclarations(self, s):
1322 return " virtual ~%s();\n" % self.get_class_name(s)
1323
1324 def _generateDisplayDeclarations(self, s):
1325 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
1326
1327 def _generateGetSetDeclarations(self, s):
1328 get_set = []
1329 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1330 for member in sorted(self.struct_dict[s]):
1331 # TODO : Skipping array set/get funcs for now
1332 if self.struct_dict[s][member]['array']:
1333 continue
1334 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']))
1335 if not self.struct_dict[s][member]['const']:
1336 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']))
1337 return "".join(get_set)
1338
1339 def _generatePrivateMembers(self, s):
1340 priv = []
1341 priv.append("\nprivate:\n")
1342 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1343 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1344 priv.append(" uint32_t m_indent;\n")
1345 priv.append(" const char m_dummy_prefix;\n")
1346 priv.append(" void display_struct_members();\n")
1347 return "".join(priv)
1348
1349 def _generateClassDeclaration(self):
1350 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001351 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001352 class_decl.append("\n//class declaration")
1353 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1354 class_decl.append(self._generateConstructorDeclarations(s))
1355 class_decl.append(self._generateDestructorDeclarations(s))
1356 class_decl.append(self._generateDisplayDeclarations(s))
1357 class_decl.append(self._generateGetSetDeclarations(s))
1358 class_decl.append(self._generatePrivateMembers(s))
1359 class_decl.append("};\n")
1360 return "\n".join(class_decl)
1361
1362 def _generateFooter(self):
1363 return "\n//any footer info for class\n"
1364
1365class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001366 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 -06001367 self.et_dict = enum_type_dict
1368 self.ev_dict = enum_val_dict
1369 self.tf_dict = typedef_fwd_dict
1370 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001371 self.out_sh_file = out_sh_file
1372 self.eshfg = CommonFileGen(self.out_sh_file)
1373 self.out_vh_file = out_vh_file
1374 self.evhfg = CommonFileGen(self.out_vh_file)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001375
1376 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001377 self.eshfg.setHeader(self._generateSHHeader())
1378 self.eshfg.setBody(self._generateSHBody())
1379 self.eshfg.generate()
1380
1381 def generateEnumValidate(self):
1382 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001383 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001384 self.evhfg.generate()
1385
1386 def _generateVHBody(self):
1387 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001388 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001389 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001390 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1391 # 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 -06001392 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001393 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1394 body.append(' return 0;')
1395 body.append(' return 1;')
1396 body.append('}\n\n')
1397 else:
1398 body.append(' switch ((%s)input_value)\n {' % (fet))
1399 for e in sorted(self.et_dict[bet]):
1400 if (self.ev_dict[e]['unique']):
1401 body.append(' case %s:' % (e))
1402 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001403 return "\n".join(body)
1404
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001405 def _generateSHBody(self):
1406 body = []
1407# with open(self.out_file, "a") as hf:
1408 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001409 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001410 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001411 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 -06001412 for e in sorted(self.et_dict[bet]):
1413 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001414 body.append(' case %s:\n return "%s";' % (e, e))
1415 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001416 return "\n".join(body)
1417
1418 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001419 header = []
1420 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001421 header.append('#ifdef _WIN32\n')
1422 header.append('#pragma warning( disable : 4065 )\n')
1423 header.append('#endif\n')
Ian Elliottfeae4052015-02-18 12:38:04 -07001424 header.append('#include <%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001425 return "\n".join(header)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001426
1427
1428class CMakeGen:
1429 def __init__(self, struct_wrapper=None, out_dir=None):
1430 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001431 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001432 self.add_lib_file_list = self.sw.get_file_list()
1433 self.out_dir = out_dir
1434 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1435 self.cmg = CommonFileGen(self.out_file)
1436
1437 def generate(self):
1438 self.cmg.setBody(self._generateBody())
1439 self.cmg.generate()
1440
1441 def _generateBody(self):
1442 body = []
1443 body.append("project(%s)" % os.path.basename(self.out_dir))
1444 body.append("cmake_minimum_required(VERSION 2.8)\n")
1445 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1446 body.append('set(COMPILE_FLAGS "-fpermissive")')
1447 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1448 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1449 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1450 return "\n".join(body)
1451
1452class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001453 def __init__(self, struct_dict, prefix, out_dir):
1454 self.struct_dict = struct_dict
1455 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001456 if prefix == "vulkan":
1457 self.api_prefix = "vk"
1458 else:
1459 self.api_prefix = prefix
1460 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001461 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001462
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001463 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001464 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001465 self.gvg.setHeader(self._generateHeader())
1466 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001467 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001468 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001469
1470 def set_include_headers(self, include_headers):
1471 self.include_headers = include_headers
1472
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001473 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001474 header = []
1475 header.append("//#includes, #defines, globals and such...\n")
1476 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001477 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001478 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001479 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001480 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001481 return "".join(header)
1482
1483 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001484 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001485
1486 # Return elements to create formatted string for given struct member
1487 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=""):
1488 struct_op = "->"
1489 pre_var_name = '"%s "' % struct_member['full_type']
1490 if not struct_ptr:
1491 struct_op = "."
1492 member_name = struct_member['name']
1493 print_type = "p"
1494 cast_type = ""
1495 member_post = ""
1496 array_index = ""
1497 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001498 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001499 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1500 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001501 print_array = False
1502 elif struct_member['array'] and not print_array:
1503 # Just print base address of array when not full print_array
1504 cast_type = "(void*)"
1505 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001506 if struct_member['ptr']:
1507 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001508 cast_type = "string_%s" % struct_member['type']
1509 print_type = "s"
1510 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1511 cast_type = "(void*)"
1512 if not struct_member['ptr']:
1513 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -06001514 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis83562882014-11-27 15:43:39 -07001515 print_type = "s"
1516 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001517 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001518 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001519 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1520 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001521 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001522 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001523 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001524 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1525 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001526 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 -07001527 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001528 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001529 print_type = "i"
1530 elif struct_member['ptr']:
1531 pass
1532 else:
1533 #print("Unhandled struct type: %s" % struct_member['type'])
1534 cast_type = "(void*)"
1535 if print_array and struct_member['array']:
1536 member_print_post = "[%u]"
1537 array_index = " i,"
1538 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001539 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 -06001540 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 -07001541 return (print_out, print_arg)
1542
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001543 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001544 gv_funcs = []
1545 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001546 array_func_list.append('vkbufferviewattachinfo')
1547 array_func_list.append('vkimageviewattachinfo')
1548 array_func_list.append('vksamplerimageviewinfo')
1549 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001550 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001551 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001552 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1553 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001554 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001555 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]))
1556 else:
1557 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 -07001558 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001559 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001560 p_out = ""
1561 p_args = ""
1562 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1563 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1564 pl_dict = {}
1565 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001566 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001567 for m in sorted(self.struct_dict[s]):
1568 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1569 stp_list.append(self.struct_dict[s][m])
1570 if 'pNext' == self.struct_dict[s][m]['name']:
1571 pl_dict[m] = ' PORT=\\"pNext\\"'
1572 else:
1573 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1574 struct_num += 1
1575 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]))
1576 num_stps = len(stp_list);
1577 total_strlen_str = ''
1578 if 0 != num_stps:
1579 gv_funcs.append(" char* tmpStr;\n")
1580 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001581 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1582 for index in range(num_stps):
1583 if (stp_list[index]['ptr']):
1584 if 'pDescriptorInfo' == stp_list[index]['name']:
1585 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1586 else:
1587 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1588 if 'pNext' == stp_list[index]['name']:
1589 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001590 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001591 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1592 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1593 gv_funcs.append(' free(tmpStr);\n')
1594 else:
1595 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 -06001596 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001597 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 -07001598 else:
1599 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1600 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1601 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1602 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001603 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001604 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1605 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1606 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1607 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1608 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1609 else:
1610 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1611 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1612 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1613 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1614 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1615 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1616 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1617 p_args = ", myNodeName, myNodeName, pStruct"
1618 for m in sorted(self.struct_dict[s]):
1619 plabel = ""
1620 if m in pl_dict:
1621 plabel = pl_dict[m]
1622 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1623 p_out += p_out1
1624 p_args += p_args1
1625 p_out += '</TABLE>>\\n];\\n\\n"'
1626 p_args += ");\n"
1627 gv_funcs.append(p_out)
1628 gv_funcs.append(p_args)
1629 if 0 != num_stps:
1630 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1631 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1632 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1633 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1634 gv_funcs.append(' }\n')
1635 gv_funcs.append(' }\n')
1636 gv_funcs.append(" return str;\n}\n")
1637 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001638 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001639 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001640 ptr_array = True
1641 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]))
1642 else:
1643 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 -07001644 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1645 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')
1646 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1647 gv_funcs.append(' sprintf(tmpStr, "');
1648 p_args = ""
1649 p_out = ""
1650 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07001651 plabel = ""
1652 (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 -07001653 if 0 == m: # Add array index notation at end of first row
1654 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 -07001655 p_args1 += ', i, i'
1656 p_out += p_out1
1657 p_args += p_args1
1658 p_out += '"'
1659 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001660 if ptr_array:
1661 p_args = p_args.replace('->', '[i]->')
1662 else:
1663 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07001664 gv_funcs.append(p_out);
1665 gv_funcs.append(p_args);
1666 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1667 gv_funcs.append(' }\n')
1668 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001669 gv_funcs.append(' return str;\n}\n')
1670 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001671 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001672 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001673 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001674 gv_funcs.append(" switch (sType)\n {\n")
1675 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001676 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07001677 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001678 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis83562882014-11-27 15:43:39 -07001679 print_func_name = self._get_gv_func_name(struct_name)
1680 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001681 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001682 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001683 if 'VkSemaphoreCreateInfo' in struct_name:
1684 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001685 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001686 elif 'VkSemaphoreOpenInfo' in struct_name:
1687 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001688 print_func_name = self._get_gv_func_name(struct_name)
1689 gv_funcs.append(' case %s:\n' % (v))
1690 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1691 #gv_funcs.append(' }\n')
1692 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08001693 gv_funcs.append(" default:\n")
1694 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001695 gv_funcs.append(" }\n")
1696 gv_funcs.append("}")
1697 return "".join(gv_funcs)
1698
1699
1700
1701
1702
1703# def _generateHeader(self):
1704# hdr = []
1705# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1706# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1707# hdr.append('edge [\n];\n')
1708# return "\n".join(hdr)
1709#
1710# def _generateBody(self):
1711# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001712# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001713# field_num = 1
1714# 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]))
1715# for m in sorted(self.struc_dict[s]):
1716# 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']))
1717# field_num += 2
1718# body.append('</TABLE>>\n];\n')
1719# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001720
1721def main(argv=None):
1722 opts = handle_args()
1723 # Parse input file and fill out global dicts
1724 hfp = HeaderFileParser(opts.input_file)
1725 hfp.parse()
1726 # TODO : Don't want these to be global, see note at top about wrapper classes
1727 global enum_val_dict
1728 global enum_type_dict
1729 global struct_dict
1730 global typedef_fwd_dict
1731 global typedef_rev_dict
1732 global types_dict
1733 enum_val_dict = hfp.get_enum_val_dict()
1734 enum_type_dict = hfp.get_enum_type_dict()
1735 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07001736 # 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 -06001737 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1738 typedef_rev_dict = hfp.get_typedef_rev_dict()
1739 types_dict = hfp.get_types_dict()
1740 #print(enum_val_dict)
1741 #print(typedef_dict)
1742 #print(struct_dict)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001743 prefix = os.path.basename(opts.input_file).strip(".h")
1744 if prefix == "vulkan":
1745 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001746 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001747 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001748 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001749 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001750 enum_sh_filename = os.path.abspath(enum_sh_filename)
1751 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1752 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1753 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001754 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001755 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001756 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001757 print("Generating enum validate helper to %s" % enum_vh_filename)
1758 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 -06001759 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001760 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001761 #for struct in struct_dict:
1762 #print(struct)
1763 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001764 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 -06001765 #print(sw.get_class_name(struct))
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001766 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 -06001767 print("Generating struct wrapper header to %s" % sw.header_filename)
1768 sw.generateHeader()
1769 print("Generating struct wrapper class to %s" % sw.class_filename)
1770 sw.generateBody()
1771 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001772 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07001773 # Generate a 2nd helper file that excludes addrs
1774 sw.set_no_addr(True)
1775 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07001776 sw.set_no_addr(False)
1777 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 -07001778 sw.set_no_addr(True)
1779 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001780 sw.set_no_addr(False)
1781 sw.generateStringHelperCpp()
Courtney Goeltzenleuchterf53c3cb2015-04-14 14:55:44 -06001782 sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
Tobin Ehlis60354772015-03-12 14:50:40 -06001783 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001784 sw.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001785 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001786 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001787 cmg.generate()
1788 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001789 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 -06001790 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 -06001791 gv.generate()
1792 print("DONE!")
1793 #print(typedef_rev_dict)
1794 #print(types_dict)
1795 #recreate_structs()
1796
1797if __name__ == "__main__":
1798 sys.exit(main())