blob: 430de12b6d2a8ad7e45f2d9ea4980d3d6d285068 [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 Ehlis08fafd02015-06-12 12:49:01 -060027from source_line_info import sourcelineinfo
Tobin Ehlis6442dca2014-10-22 15:13:53 -060028
Tobin Ehlis08fafd02015-06-12 12:49:01 -060029# vk_helper.py overview
30# This script generates code based on vulkan input header
31# It generate wrappers functions that can be used to display
Tobin Ehlis6442dca2014-10-22 15:13:53 -060032# structs in a human-readable txt format, as well as utility functions
33# to print enum values as strings
34
Tobin Ehlis6442dca2014-10-22 15:13:53 -060035def handle_args():
36 parser = argparse.ArgumentParser(description='Perform analysis of vogl trace.')
37 parser.add_argument('input_file', help='The input header file from which code will be generated.')
38 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.')
39 parser.add_argument('--abs_out_dir', required=False, default=None, help='Absolute path to write output files. Will be created if needed.')
40 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.')
41 parser.add_argument('--gen_struct_wrappers', required=False, action='store_true', default=False, help='Enable generation of struct wrapper classes.')
42 parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.')
43 parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.')
44 #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.')
45 return parser.parse_args()
46
47# TODO : Ideally these data structs would be opaque to user and could be wrapped
48# in their own class(es) to make them friendly for data look-up
49# Dicts for Data storage
50# enum_val_dict[value_name] = dict keys are the string enum value names for all enums
51# |-------->['type'] = the type of enum class into which the value falls
52# |-------->['val'] = the value assigned to this particular value_name
53# '-------->['unique'] = bool designating if this enum 'val' is unique within this enum 'type'
54enum_val_dict = {}
55# enum_type_dict['type'] = the type or class of of enum
56# '----->['val_name1', 'val_name2'...] = each type references a list of val_names within this type
57enum_type_dict = {}
58# struct_dict['struct_basename'] = the base (non-typedef'd) name of the struct
59# |->[<member_num>] = members are stored via their integer placement in the struct
60# | |->['name'] = string name of this struct member
61# ... |->['full_type'] = complete type qualifier for this member
62# |->['type'] = base type for this member
63# |->['ptr'] = bool indicating if this member is ptr
64# |->['const'] = bool indicating if this member is const
65# |->['struct'] = bool indicating if this member is a struct type
66# |->['array'] = bool indicating if this member is an array
Tobin Ehlisbd6a9162015-03-13 07:18:05 -060067# |->['dyn_array'] = bool indicating if member is a dynamically sized array
68# '->['array_size'] = For dyn_array, member name used to size array, else int size for static array
Tobin Ehlis6442dca2014-10-22 15:13:53 -060069struct_dict = {}
70# typedef_fwd_dict stores mapping from orig_type_name -> new_type_name
71typedef_fwd_dict = {}
72# typedef_rev_dict stores mapping from new_type_name -> orig_type_name
73typedef_rev_dict = {} # store new_name -> orig_name mapping
74# types_dict['id_name'] = identifier name will map to it's type
75# '---->'type' = currently either 'struct' or 'enum'
76types_dict = {} # store orig_name -> type mapping
77
78
79# Class that parses header file and generates data structures that can
80# Then be used for other tasks
81class HeaderFileParser:
82 def __init__(self, header_file=None):
83 self.header_file = header_file
84 # store header data in various formats, see above for more info
85 self.enum_val_dict = {}
86 self.enum_type_dict = {}
87 self.struct_dict = {}
88 self.typedef_fwd_dict = {}
89 self.typedef_rev_dict = {}
90 self.types_dict = {}
Tobin Ehlis5178bd72015-03-06 10:38:25 -070091 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -060092
93 def setHeaderFile(self, header_file):
94 self.header_file = header_file
95
96 def get_enum_val_dict(self):
97 return self.enum_val_dict
98
99 def get_enum_type_dict(self):
100 return self.enum_type_dict
101
102 def get_struct_dict(self):
103 return self.struct_dict
104
105 def get_typedef_fwd_dict(self):
106 return self.typedef_fwd_dict
107
108 def get_typedef_rev_dict(self):
109 return self.typedef_rev_dict
110
111 def get_types_dict(self):
112 return self.types_dict
113
114 # Parse header file into data structures
115 def parse(self):
116 # parse through the file, identifying different sections
117 parse_enum = False
118 parse_struct = False
119 member_num = 0
120 # TODO : Comment parsing is very fragile but handles 2 known files
121 block_comment = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700122 prev_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600123 with open(self.header_file) as f:
124 for line in f:
125 if block_comment:
126 if '*/' in line:
127 block_comment = False
128 continue
129 if '/*' in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600130 if '*/' in line: # single line block comment
131 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600132 block_comment = True
133 elif 0 == len(line.split()):
134 #print("Skipping empty line")
135 continue
136 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700137 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600138 continue
139 elif 'typedef enum' in line:
140 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
141 #print("Found ENUM type %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600142 if '{' == base_type:
143 base_type = 'tmp_enum'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600144 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700145 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600146 self.types_dict[base_type] = 'enum'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600147 elif 'typedef struct' in line or 'typedef union' in line:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600148 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
149 #print("Found STRUCT type: %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600150 if '{' == base_type:
151 base_type = 'tmp_struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600152 parse_struct = True
153 self.types_dict[base_type] = 'struct'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600154# elif 'typedef union' in line:
155# (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
156# print("Found UNION type: %s" % base_type)
157# parse_struct = True
158# self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600159 elif '}' in line and (parse_enum or parse_struct):
160 if len(line.split()) > 1: # deals with embedded union in one struct
161 parse_enum = False
162 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700163 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600164 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600165 (cur_char, targ_type) = line.strip().split(None, 1)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600166 if 'tmp_struct' == base_type:
167 base_type = targ_type.strip(';')
168 #print("Found Actual Struct type %s" % base_type)
169 self.struct_dict[base_type] = self.struct_dict['tmp_struct']
170 self.struct_dict.pop('tmp_struct', 0)
171 self.types_dict[base_type] = 'struct'
172 self.types_dict.pop('tmp_struct', 0)
173 elif 'tmp_enum' == base_type:
174 base_type = targ_type.strip(';')
175 #print("Found Actual ENUM type %s" % base_type)
176 for n in self.enum_val_dict:
177 if 'tmp_enum' == self.enum_val_dict[n]['type']:
178 self.enum_val_dict[n]['type'] = base_type
179# self.enum_val_dict[base_type] = self.enum_val_dict['tmp_enum']
180# self.enum_val_dict.pop('tmp_enum', 0)
181 self.enum_type_dict[base_type] = self.enum_type_dict['tmp_enum']
182 self.enum_type_dict.pop('tmp_enum', 0)
183 self.types_dict[base_type] = 'enum'
184 self.types_dict.pop('tmp_enum', 0)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600185 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
186 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600187 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600188 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600189 #if 'VK_MAX_ENUM' not in line and '{' not in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600190 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 -0700191 self._add_enum(line, base_type, default_enum_val)
192 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600193 elif parse_struct:
194 if ';' in line:
195 self._add_struct(line, base_type, member_num)
196 member_num = member_num + 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600197
198 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700199 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600200 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700201 if '=' in line_txt:
202 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
203 else:
204 enum_name = line_txt.split(',')[0]
205 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600206 self.enum_val_dict[enum_name] = {}
207 self.enum_val_dict[enum_name]['type'] = enum_type
208 # strip comma and comment, then extra split in case of no comma w/ comments
209 enum_val = enum_val.strip().split(',', 1)[0]
210 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600211 # Perform conversion of VK_BIT macro
212 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
213 vk_bit_val = self.enum_val_dict[enum_name]['val']
214 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
215 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
216 else:
217 # account for negative values surrounded by parens
218 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700219 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600220 try:
221 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
222 int(self.enum_val_dict[enum_name]['val'], 0)
223 self.enum_val_dict[enum_name]['unique'] = True
224 #print("ENUM has num value")
225 except ValueError:
226 self.enum_val_dict[enum_name]['unique'] = False
227 #print("ENUM is not a number value")
228 # Update enum_type_dict as well
229 if not enum_type in self.enum_type_dict:
230 self.enum_type_dict[enum_type] = []
231 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700232
233 # Return True of struct member is a dynamic array
234 # RULES : This is a bit quirky based on the API
235 # NOTE : Changes in API spec may cause these rules to change
236 # 1. There must be a previous uint var w/ 'count' in the name in the struct
237 # 2. Dynam array must have 'const' and '*' qualifiers
238 # 3a. Name of dynam array must end in 's' char OR
239 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
240 def _is_dynamic_array(self, full_type, name):
241 if '' != self.last_struct_count_name:
242 if 'const' in full_type and '*' in full_type:
243 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
244 return True
245 return False
246
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600247 # populate struct dicts based on struct lines
248 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
249 def _add_struct(self, line_txt, struct_type, num):
250 #print("Parsing struct line %s" % line_txt)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600251 if '{' == struct_type:
252 print("Parsing struct '{' w/ line %s" % line_txt)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600253 if not struct_type in self.struct_dict:
254 self.struct_dict[struct_type] = {}
255 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
256 # TODO : Handle bitfields more correctly
257 members = members.strip().split(':', 1)[0] # strip bitfield element
258 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700259 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600260 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700261 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600262 self.struct_dict[struct_type][num] = {}
263 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700264 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600265 if '*' in member_type:
266 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700267 # TODO : Need more general purpose way here to reduce down to basic type
268 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600269 member_type = member_type.strip('*')
270 else:
271 self.struct_dict[struct_type][num]['ptr'] = False
272 if 'const' in member_type:
273 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600274 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600275 else:
276 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700277 # TODO : There is a bug here where it seems that at the time we do this check,
278 # 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 -0600279 if is_type(member_type, 'struct'):
280 self.struct_dict[struct_type][num]['struct'] = True
281 else:
282 self.struct_dict[struct_type][num]['struct'] = False
283 self.struct_dict[struct_type][num]['type'] = member_type
284 if '[' in member_name:
285 (member_name, array_size) = member_name.split('[', 1)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600286 if 'char' in member_type:
287 self.struct_dict[struct_type][num]['array'] = False
288 self.struct_dict[struct_type][num]['array_size'] = 0
289 self.struct_dict[struct_type][num]['ptr'] = True
290 else:
291 self.struct_dict[struct_type][num]['array'] = True
292 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700293 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
294 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
295 self.struct_dict[struct_type][num]['array'] = True
296 self.struct_dict[struct_type][num]['dyn_array'] = True
297 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700298 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600299 self.struct_dict[struct_type][num]['array'] = False
300 self.struct_dict[struct_type][num]['array_size'] = 0
301 self.struct_dict[struct_type][num]['name'] = member_name
302
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700303# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600304def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600305 if identifier in types_dict and type_to_check == types_dict[identifier]:
306 return True
307 if identifier in typedef_rev_dict:
308 new_id = typedef_rev_dict[identifier]
309 if new_id in types_dict and type_to_check == types_dict[new_id]:
310 return True
311 return False
312
313# This is a validation function to verify that we can reproduce the original structs
314def recreate_structs():
315 for struct_name in struct_dict:
316 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
317 for mem_num in sorted(struct_dict[struct_name]):
318 sys.stdout.write(" ")
319 if struct_dict[struct_name][mem_num]['const']:
320 sys.stdout.write("const ")
321 #if struct_dict[struct_name][mem_num]['struct']:
322 # sys.stdout.write("struct ")
323 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
324 if struct_dict[struct_name][mem_num]['ptr']:
325 sys.stdout.write("*")
326 sys.stdout.write(" ")
327 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
328 if struct_dict[struct_name][mem_num]['array']:
329 sys.stdout.write("[")
330 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
331 sys.stdout.write("]")
332 sys.stdout.write(";\n")
333 sys.stdout.write("} ")
334 sys.stdout.write(typedef_fwd_dict[struct_name])
335 sys.stdout.write(";\n\n")
336
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600337#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600338# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600339def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600340 # Note: All struct types are now camel-case
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600341 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600342 char_idx = 0
343 struct_name = ''
344 for char in caps_struct_name:
345 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
346 struct_name += caps_struct_name[char_idx]
347 elif (caps_struct_name[char_idx] == '_'):
348 pass
349 else:
350 struct_name += caps_struct_name[char_idx].lower()
351 char_idx += 1
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600352 return struct_name
353
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600354# class for writing common file elements
355# Here's how this class lays out a file:
356# COPYRIGHT
357# HEADER
358# BODY
359# FOOTER
360#
361# For each of these sections, there's a "set*" function
362# The class as a whole has a generate function which will write each section in order
363class CommonFileGen:
364 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
365 self.filename = filename
366 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
367 # TODO : Set a default copyright & footer at least
368
369 def setFilename(self, filename):
370 self.filename = filename
371
372 def setCopyright(self, c):
373 self.contents['copyright'] = c
374
375 def setHeader(self, h):
376 self.contents['header'] = h
377
378 def setBody(self, b):
379 self.contents['body'] = b
380
381 def setFooter(self, f):
382 self.contents['footer'] = f
383
384 def generate(self):
385 #print("Generate to file %s" % self.filename)
386 with open(self.filename, "w") as f:
387 f.write(self.contents['copyright'])
388 f.write(self.contents['header'])
389 f.write(self.contents['body'])
390 f.write(self.contents['footer'])
391
392# class for writing a wrapper class for structures
393# The wrapper class wraps the structs and includes utility functions for
394# setting/getting member values and displaying the struct data in various formats
395class StructWrapperGen:
396 def __init__(self, in_struct_dict, prefix, out_dir):
397 self.struct_dict = in_struct_dict
398 self.include_headers = []
399 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600400 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600401 self.api_prefix = "vk"
402 else:
403 self.api_prefix = prefix
404 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
405 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
406 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
407 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
408 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
409 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
410 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700411 self.no_addr = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600412 self.hfg = CommonFileGen(self.header_filename)
413 self.cfg = CommonFileGen(self.class_filename)
414 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700415 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700416 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600417 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
418 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600419 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700420 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600421 #print(self.header_filename)
422 self.header_txt = ""
423 self.definition_txt = ""
424
425 def set_include_headers(self, include_headers):
426 self.include_headers = include_headers
427
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700428 def set_no_addr(self, no_addr):
429 self.no_addr = no_addr
430 if self.no_addr:
431 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700432 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700433 else:
434 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700435 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700436
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600437 # Return class name for given struct name
438 def get_class_name(self, struct_name):
439 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
440 return class_name
441
442 def get_file_list(self):
443 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
444
445 # Generate class header file
446 def generateHeader(self):
447 self.hfg.setCopyright(self._generateCopyright())
448 self.hfg.setHeader(self._generateHeader())
449 self.hfg.setBody(self._generateClassDeclaration())
450 self.hfg.setFooter(self._generateFooter())
451 self.hfg.generate()
452
453 # Generate class definition
454 def generateBody(self):
455 self.cfg.setCopyright(self._generateCopyright())
456 self.cfg.setHeader(self._generateCppHeader())
457 self.cfg.setBody(self._generateClassDefinition())
458 self.cfg.setFooter(self._generateFooter())
459 self.cfg.generate()
460
461 # Generate c-style .h file that contains functions for printing structs
462 def generateStringHelper(self):
463 print("Generating struct string helper")
464 self.shg.setCopyright(self._generateCopyright())
465 self.shg.setHeader(self._generateStringHelperHeader())
466 self.shg.setBody(self._generateStringHelperFunctions())
467 self.shg.generate()
468
Tobin Ehlis99f88672015-01-10 12:42:41 -0700469 # Generate cpp-style .h file that contains functions for printing structs
470 def generateStringHelperCpp(self):
471 print("Generating struct string helper cpp")
472 self.shcppg.setCopyright(self._generateCopyright())
473 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
474 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
475 self.shcppg.generate()
476
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700477 # Generate c-style .h file that contains functions for printing structs
478 def generateValidateHelper(self):
479 print("Generating struct validate helper")
480 self.vhg.setCopyright(self._generateCopyright())
481 self.vhg.setHeader(self._generateValidateHelperHeader())
482 self.vhg.setBody(self._generateValidateHelperFunctions())
483 self.vhg.generate()
484
Tobin Ehlis60354772015-03-12 14:50:40 -0600485 def generateSizeHelper(self):
486 print("Generating struct size helper")
487 self.size_helper_gen.setCopyright(self._generateCopyright())
488 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
489 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
490 self.size_helper_gen.generate()
491
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700492 def generateSizeHelperC(self):
493 print("Generating struct size helper c")
494 self.size_helper_c_gen.setCopyright(self._generateCopyright())
495 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
496 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
497 self.size_helper_c_gen.generate()
498
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600499 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700500 copyright = []
501 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
502 copyright.append('');
503 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600504 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700505 copyright.append(' *');
506 copyright.append(' * Copyright (C) 2014 LunarG, Inc.');
507 copyright.append(' *');
508 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
509 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
510 copyright.append(' * to deal in the Software without restriction, including without limitation');
511 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
512 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
513 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
514 copyright.append(' *');
515 copyright.append(' * The above copyright notice and this permission notice shall be included');
516 copyright.append(' * in all copies or substantial portions of the Software.');
517 copyright.append(' *');
518 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
519 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
520 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
521 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
522 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
523 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
524 copyright.append(' * DEALINGS IN THE SOFTWARE.');
525 copyright.append(' */');
526 copyright.append('');
527 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600528
529 def _generateCppHeader(self):
530 header = []
531 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600532 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 -0600533 return "".join(header)
534
535 def _generateClassDefinition(self):
536 class_def = []
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600537 if 'vk' == self.api: # Mantle doesn't have pNext to worry about
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600538 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700539 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600540 class_def.append("\n// %s class definition" % self.get_class_name(s))
541 class_def.append(self._generateConstructorDefinitions(s))
542 class_def.append(self._generateDestructorDefinitions(s))
543 class_def.append(self._generateDisplayDefinitions(s))
544 return "\n".join(class_def)
545
546 def _generateConstructorDefinitions(self, s):
547 con_defs = []
548 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)))
549 # TODO : This is a shallow copy of ptrs
550 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]))
551 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]))
552 return "\n".join(con_defs)
553
554 def _generateDestructorDefinitions(self, s):
555 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
556
557 def _generateDynamicPrintFunctions(self):
558 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600559 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 -0600560 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600561 dp_funcs.append(" switch (sType)\n {")
562 for e in enum_type_dict:
563 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600564 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600565 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600566 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600567 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600568 instance_name = "swc%i" % class_num
569 dp_funcs.append(" case %s:\n {" % (v))
570 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
571 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
572 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
573 dp_funcs.append(" }")
574 dp_funcs.append(" break;")
575 class_num += 1
576 dp_funcs.append(" }")
577 dp_funcs.append("}\n")
578 return "\n".join(dp_funcs)
579
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700580 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600581 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700582
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600583 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700584 return self._get_func_name(struct, 'print')
585
586 def _get_vh_func_name(self, struct):
587 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600588
Tobin Ehlis60354772015-03-12 14:50:40 -0600589 def _get_size_helper_func_name(self, struct):
590 return self._get_func_name(struct, 'size')
591
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600592 # Return elements to create formatted string for given struct member
593 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
594 struct_op = "->"
595 if not struct_ptr:
596 struct_op = "."
597 member_name = struct_member['name']
598 print_type = "p"
599 cast_type = ""
600 member_post = ""
601 array_index = ""
602 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700603 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700604 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
605 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
606 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600607 print_type = "s"
608 print_array = False
609 elif struct_member['array'] and not print_array:
610 # Just print base address of array when not full print_array
611 cast_type = "(void*)"
612 elif is_type(struct_member['type'], 'enum'):
613 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700614 if struct_member['ptr']:
615 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600616 print_type = "s"
617 elif is_type(struct_member['type'], 'struct'): # print struct address for now
618 cast_type = "(void*)"
619 if not struct_member['ptr']:
620 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -0600621 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600622 print_type = "s"
623 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700624 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600625 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600626 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
627 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700628 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600629 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600630 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700631 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
632 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600633 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 -0600634 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700635 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600636 print_type = "i"
637 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600638 pass
639 else:
640 #print("Unhandled struct type: %s" % struct_member['type'])
641 cast_type = "(void*)"
642 if print_array and struct_member['array']:
643 member_print_post = "[%u]"
644 array_index = " i,"
645 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700646 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 -0600647 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 -0700648 if self.no_addr and "p" == print_type:
649 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
650 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600651 return (print_out, print_arg)
652
653 def _generateStringHelperFunctions(self):
654 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700655 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700656 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700657 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
658 sh_funcs.append('')
659 sh_funcs.append('#if defined(_WIN32)')
660 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
661 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
662 sh_funcs.append('// work-around.')
663 sh_funcs.append('#define snprintf _snprintf')
664 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700665 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600666 p_out = ""
667 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700668 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 -0700669 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700670 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700671 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
672 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700673 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]))
674 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700675 num_stps = len(stp_list);
676 total_strlen_str = ''
677 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700678 sh_funcs.append(" char* tmpStr;")
679 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
680 sh_funcs.append(' strcpy(extra_indent, " ");')
681 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
682 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700683 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700684 # If it's an array, print all of the elements
685 # If it's a ptr, print thing it's pointing to
686 # Non-ptr struct case. Print the struct using its address
687 struct_deref = '&'
688 if 1 < stp_list[index]['full_type'].count('*'):
689 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700690 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700691 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700692 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700693 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
694 sh_funcs.append(' len = 256+strlen(tmpStr);')
695 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700696 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700697 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700698 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700699 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
700 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700701 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700702 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
703 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600704 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 -0700705 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700706 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
707 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
708 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700709 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700710 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 -0700711 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700712 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']))
713 sh_funcs.append(' }')
714 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
715 elif stp_list[index]['array']:
716 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
717 sh_funcs.append(' len = 256+strlen(tmpStr);')
718 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700719 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700720 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 -0700721 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700722 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 -0700723 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700724 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
725 sh_funcs.append(' len = 256+strlen(tmpStr);')
726 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700727 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700728 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 -0700729 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700730 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 -0700731 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700732 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
733 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700734 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600735 for m in sorted(self.struct_dict[s]):
736 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
737 p_out += p_out1
738 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600739 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700740 p_args += ");"
741 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700742 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700743 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
744 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
745 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
746 sh_funcs.append(' free(stp_strs[stp_index]);')
747 sh_funcs.append(' }')
748 sh_funcs.append(' }')
749 sh_funcs.append(' free(extra_indent);')
750 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600751 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700752 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
753 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
754 sh_funcs.append(" if (pStruct == NULL) {")
755 sh_funcs.append(" return NULL;")
756 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600757 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700758 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
759 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600760 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600761 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600762 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600763 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600764 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700765 sh_funcs.append(' case %s:\n {' % (v))
766 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
767 sh_funcs.append(' }')
768 sh_funcs.append(' break;')
769 sh_funcs.append(" default:")
770 sh_funcs.append(" return NULL;")
771 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600772 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700773 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700774
775 def _generateStringHelperFunctionsCpp(self):
776 # declare str & tmp str
777 # declare array of stringstreams for every struct ptr in current struct
778 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700779 # For every struct ptr, if non-Null, then set its string, else set to NULL str
780 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700781 # create and return final string
782 sh_funcs = []
783 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600784 # XXX - REMOVE this comment
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600785 lineinfo = sourcelineinfo()
786 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700787 for s in sorted(self.struct_dict):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700788 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
789 sh_funcs.append('\n')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600790 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700791 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600792 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 -0700793 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 -0700794 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700795 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700796 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 -0600797 # TODO: This is a tmp workaround
798 if 'ppActiveLayerNames' not in self.struct_dict[s][m]['name']:
799 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600800 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700801 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 -0600802 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700803 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600804 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700805 sh_funcs.append('%sstring final_str;' % (indent))
806 sh_funcs.append('%sstring tmp_str;' % (indent))
807 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700808 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700809 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700810 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600811 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700812 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700813 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700814 idx_ss_decl = False # Make sure to only decl this once
815 for index in range(num_stps):
816 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700817 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700818 addr_char = ''
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600819 if stp_list[index]['array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600820 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700821 if stp_list[index]['dyn_array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600822 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700823 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
824 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600825 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700826 array_count = '%s' % (stp_list[index]['array_size'])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600827 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700828 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
829 if not idx_ss_decl:
830 sh_funcs.append('%sstringstream index_ss;' % (indent))
831 idx_ss_decl = True
Tobin Ehlis793ad302015-04-03 12:01:11 -0600832 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
833 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700834 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600835 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700836 sh_funcs.append('%sindex_ss.str("");' % (indent))
837 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600838 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600839 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700840 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600841 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
842 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 -0700843 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 -0600844 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600845 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700846 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
847 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']))
848 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600849 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700850 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
851 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600852 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700853 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 -0600854 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600855 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600856 addr_char = ''
857 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
858 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 -0600859 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700860 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600861 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700862 sh_funcs.append('%s}' % (indent))
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600863 indent = indent[4:]
864 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700865 elif (stp_list[index]['ptr']):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600866 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600867 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
868 indent += ' '
Tobin Ehlis99f88672015-01-10 12:42:41 -0700869 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600870 sh_funcs.append('%s' % lineinfo.get())
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600871 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700872 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700873 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
874 # TODO : This is a quick hack to handle these arrays of ptrs
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600875 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600876 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 -0700877 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600878 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700879 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 -0700880 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
881 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600882 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700883 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
884 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600885 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700886 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
887 sh_funcs.append(' ss[%u].str("");' % (index))
888 sh_funcs.append(' }')
889 sh_funcs.append(' else')
890 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700891 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600892 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700893 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
894 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
895 if self.no_addr:
896 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600897 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700898 else:
899 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 -0600900 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700901 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -0600902 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -0700903 index = 0
904 final_str = ''
905 for m in sorted(self.struct_dict[s]):
906 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
907 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
908 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600909 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700910 sh_funcs.append(' ss[%u].str("addr");' % (index))
911 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600912 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700913 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Jon Ashburnc669cc62015-07-09 15:02:25 -0600914 elif self.struct_dict[s][m]['array']:
915 sh_funcs.append('%s' % lineinfo.get())
916 sh_funcs.append(' ss[%u] << (void*)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700917 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600918 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700919 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700920 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600921 sh_funcs.append('%s' % lineinfo.get())
Jon Ashburnc669cc62015-07-09 15:02:25 -0600922 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600923 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600924 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600925 sh_funcs.append(' if (StreamControl::writeAddress)')
926 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
927 sh_funcs.append(' else')
928 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700929 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600930 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700931 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700932 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700933 sh_funcs.append(' ss[%u].str("addr");' % (index))
934 else:
935 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
936 value_print = 'ss[%u].str()' % index
937 index += 1
938 else:
Tobin Ehlisce320942015-06-11 09:37:00 -0600939 # 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 -0700940 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600941 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600942 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
943 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
944 sh_funcs.append(' else')
945 sh_funcs.append(' ss[%u].str("NULL");' % (index))
946 value_print = 'ss[%u].str()' % index
947 index += 1
948 # For single enum just print the string representation
949 else:
950 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 -0700951 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
952 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700953 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -0700954 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600955 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700956 sh_funcs.append(' final_str = %s;' % final_str)
957 sh_funcs.append(' return final_str;\n}')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700958 # Add function to return a string value for input void*
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600959 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700960 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600961 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -0700962 sh_funcs.append(" stringstream ss;")
963 sh_funcs.append(' ss << toString;')
964 sh_funcs.append(' string final_str = prefix + ss.str();')
965 sh_funcs.append(" return final_str;")
966 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600967 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis08541742015-04-16 15:56:11 -0600968 # Add function to return a string value for input uint32_t
969 sh_funcs.append("string string_convert_helper(const uint32_t toString, const string prefix)\n{")
970 sh_funcs.append(" using namespace StreamControl;")
971 sh_funcs.append(" stringstream ss;")
972 sh_funcs.append(' ss << toString;')
973 sh_funcs.append(' string final_str = prefix + ss.str();')
974 sh_funcs.append(" return final_str;")
975 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600976 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700977 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600978 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700979 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -0700980 sh_funcs.append(" if (pStruct == NULL) {\n")
Jon Ashburn62a327c2015-02-25 12:45:23 -0700981 sh_funcs.append(" return NULL;")
Ian Elliott82800022015-02-25 17:40:38 -0700982 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600983 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700984 sh_funcs.append(' string indent = " ";')
985 sh_funcs.append(' indent += prefix;')
986 sh_funcs.append(" switch (sType)\n {")
987 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600988 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700989 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600990 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700991 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600992 #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 -0700993 sh_funcs.append(' case %s:\n {' % (v))
994 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
995 sh_funcs.append(' }')
996 sh_funcs.append(' break;')
997 sh_funcs.append(" default:")
998 sh_funcs.append(" return NULL;")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600999 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001000 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001001 sh_funcs.append("}")
1002 return "\n".join(sh_funcs)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001003
1004 def _genStructMemberPrint(self, member, s, array, struct_array):
1005 (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)
1006 extra_indent = ""
1007 if array:
1008 extra_indent = " "
1009 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
1010 struct_array.insert(0, self.struct_dict[s][member])
1011 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001012 # Special case for void* named "pNext"
1013 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001014 struct_array.insert(0, self.struct_dict[s][member])
1015 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
1016
1017 def _generateDisplayDefinitions(self, s):
1018 disp_def = []
1019 struct_array = []
1020 # Single-line struct print function
1021 disp_def.append("// Output 'structname = struct_address' on a single line")
1022 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
1023 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1024 disp_def.append("}\n")
1025 # Private helper function to print struct members
1026 disp_def.append("// Private helper function that displays the members of the wrapped struct")
1027 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
1028 i_declared = False
1029 for member in sorted(self.struct_dict[s]):
1030 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001031 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001032 # Can grab struct type off of header of struct pointed to
1033 # TODO : Handle Arrays
1034 if self.struct_dict[s][member]['array']:
1035 # Create for loop to print each element of array
1036 if not i_declared:
1037 disp_def.append(' uint32_t i;')
1038 i_declared = True
1039 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
1040 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
1041 disp_def.append(return_str)
1042 disp_def.append(' }')
1043 else:
1044 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
1045 disp_def.append(return_str)
1046 disp_def.append("}\n")
1047 i_declared = False
1048 # Basic print function to display struct members
1049 disp_def.append("// Output all struct elements, each on their own line")
1050 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
1051 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1052 disp_def.append(' this->display_struct_members();')
1053 disp_def.append("}\n")
1054 # Advanced print function to display current struct and contents of any pointed-to structs
1055 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1056 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1057 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1058 disp_def.append(' this->display_struct_members();')
1059 class_num = 0
1060 # TODO : Need to handle arrays of structs here
1061 for ms in struct_array:
1062 swc_name = "class%s" % str(class_num)
1063 if ms['array']:
1064 if not i_declared:
1065 disp_def.append(' uint32_t i;')
1066 i_declared = True
1067 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1068 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1069 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1070 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1071 disp_def.append(" %s.display_full_txt();" % (swc_name))
1072 #disp_def.append(' }')
1073 disp_def.append(' }')
1074 elif 'pNext' == ms['name']:
1075 # Need some code trickery here
1076 # I'm thinking have a generated function that takes pNext ptr value
1077 # then it checks sType and in large switch statement creates appropriate
1078 # wrapper class type and then prints contents
1079 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1080 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1081 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1082 disp_def.append(" }")
1083 else:
1084 if ms['ptr']:
1085 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1086 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1087 else:
1088 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1089 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1090 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1091 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1092 class_num += 1
1093 disp_def.append("}\n")
1094 return "\n".join(disp_def)
1095
1096 def _generateStringHelperHeader(self):
1097 header = []
1098 header.append("//#includes, #defines, globals and such...\n")
1099 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001100 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001101 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001102 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001103 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001104 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001105
1106 def _generateStringHelperHeaderCpp(self):
1107 header = []
1108 header.append("//#includes, #defines, globals and such...\n")
1109 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001110 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001111 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001112 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001113 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001114 header.append('\n')
1115 header.append('namespace StreamControl\n')
1116 header.append('{\n')
1117 header.append('bool writeAddress = true;\n')
1118 header.append('template <typename T>\n')
1119 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1120 header.append('{\n')
1121 header.append(' if(writeAddress)\n')
1122 header.append(' {\n')
1123 header.append(' out.operator<<(pointer);\n')
1124 header.append(' }\n')
1125 header.append(' else\n')
1126 header.append(' {\n')
1127 header.append(' std::operator<<(out, "address");\n')
1128 header.append(' }\n')
1129 header.append(' return out;\n')
1130 header.append('}\n')
1131 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1132 header.append('{\n')
1133 header.append(' return std::operator<<(out, s);\n')
1134 header.append('}\n')
1135 header.append('}\n')
1136 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001137 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001138 return "".join(header)
1139
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001140 def _generateValidateHelperFunctions(self):
1141 sh_funcs = []
1142 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001143 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001144 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1145 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001146 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001147 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1148 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001149 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001150 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 -07001151 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 -07001152 # 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 -07001153 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1154 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001155 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 -07001156 else:
1157 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 -07001158 sh_funcs.append(" return 1;\n}")
1159
1160 return "\n".join(sh_funcs)
1161
1162 def _generateValidateHelperHeader(self):
1163 header = []
1164 header.append("//#includes, #defines, globals and such...\n")
1165 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001166 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001167 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001168 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001169 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001170 return "".join(header)
1171
Tobin Ehlis60354772015-03-12 14:50:40 -06001172 def _generateSizeHelperFunctions(self):
1173 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001174 # just generates prototypes for all the functions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001175 for s in sorted(self.struct_dict):
Tobin Ehlis60354772015-03-12 14:50:40 -06001176 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 -07001177 return "\n".join(sh_funcs)
1178
1179
1180 def _generateSizeHelperFunctionsC(self):
1181 sh_funcs = []
1182 # generate function definitions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001183 for s in sorted(self.struct_dict):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001184 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001185 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1186 indent = ' '
1187 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1188 sh_funcs.append('%sif (pStruct) {' % (indent))
1189 indent = ' '
1190 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1191 i_decl = False
1192 for m in sorted(self.struct_dict[s]):
1193 if m in skip_list:
1194 continue
1195 if self.struct_dict[s][m]['dyn_array']:
1196 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1197 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 -06001198 if 'ppMemBarriers' == self.struct_dict[s][m]['name']:
1199 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001200 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 -06001201 else:
1202 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 -06001203 else: # This is an array of char* or array of struct ptrs
1204 if not i_decl:
1205 sh_funcs.append('%suint32_t i = 0;' % (indent))
1206 i_decl = True
1207 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1208 indent = ' '
1209 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1210 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']))
1211 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001212 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 -06001213 indent = ' '
1214 sh_funcs.append('%s}' % (indent))
1215 else:
1216 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1217 if not i_decl:
1218 sh_funcs.append('%suint32_t i = 0;' % (indent))
1219 i_decl = True
1220 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1221 indent = ' '
1222 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']))
1223 indent = ' '
1224 sh_funcs.append('%s}' % (indent))
1225 else:
1226 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1227 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1228 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001229 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 -06001230 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1231 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 -06001232 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis60354772015-03-12 14:50:40 -06001233 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1234 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1235 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1236 skip_list.append(m+1)
1237 indent = ' '
1238 sh_funcs.append('%s}' % (indent))
1239 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001240 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
1241 for follow_chain in [True, False]:
1242 if follow_chain:
1243 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1244 else:
1245 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1246 indent = ' '
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001247 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1248 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001249 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1250 if follow_chain:
1251 sh_funcs.append('%swhile (pNext) {' % (indent))
1252 indent = ' '
1253 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1254 indent += ' '
1255 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001256 if 'StructureType' in e:
Tobin Ehlis04112922015-03-16 10:44:40 -06001257 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001258 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis04112922015-03-16 10:44:40 -06001259 sh_funcs.append('%scase %s:' % (indent, v))
1260 sh_funcs.append('%s{' % (indent))
1261 indent += ' '
1262 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1263 sh_funcs.append('%sbreak;' % (indent))
1264 indent = indent[:-4]
1265 sh_funcs.append('%s}' % (indent))
1266 sh_funcs.append('%sdefault:' % (indent))
1267 indent += ' '
1268 sh_funcs.append('%sassert(0);' % (indent))
1269 sh_funcs.append('%sstructSize += 0;' % (indent))
1270 indent = indent[:-4]
1271 indent = indent[:-4]
1272 sh_funcs.append('%s}' % (indent))
1273 if follow_chain:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001274 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001275 indent = indent[:-4]
1276 sh_funcs.append('%s}' % (indent))
1277 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001278 return "\n".join(sh_funcs)
1279
1280 def _generateSizeHelperHeader(self):
1281 header = []
1282 header.append("//#includes, #defines, globals and such...\n")
1283 for f in self.include_headers:
1284 header.append("#include <%s>\n" % f)
1285 header.append('\n// Function Prototypes\n')
1286 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001287 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001288 return "".join(header)
1289
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001290 def _generateSizeHelperHeaderC(self):
1291 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001292 header.append('#include "vk_struct_size_helper.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001293 header.append('#include <string.h>')
1294 header.append('#include <assert.h>')
1295 header.append('\n// Function definitions\n')
1296 return "\n".join(header)
1297
1298
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001299 def _generateHeader(self):
1300 header = []
1301 header.append("//#includes, #defines, globals and such...\n")
1302 for f in self.include_headers:
1303 header.append("#include <%s>\n" % f)
1304 return "".join(header)
1305
1306 # Declarations
1307 def _generateConstructorDeclarations(self, s):
1308 constructors = []
1309 constructors.append(" %s();\n" % self.get_class_name(s))
1310 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1311 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1312 return "".join(constructors)
1313
1314 def _generateDestructorDeclarations(self, s):
1315 return " virtual ~%s();\n" % self.get_class_name(s)
1316
1317 def _generateDisplayDeclarations(self, s):
1318 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
1319
1320 def _generateGetSetDeclarations(self, s):
1321 get_set = []
1322 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1323 for member in sorted(self.struct_dict[s]):
1324 # TODO : Skipping array set/get funcs for now
1325 if self.struct_dict[s][member]['array']:
1326 continue
1327 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']))
1328 if not self.struct_dict[s][member]['const']:
1329 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']))
1330 return "".join(get_set)
1331
1332 def _generatePrivateMembers(self, s):
1333 priv = []
1334 priv.append("\nprivate:\n")
1335 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1336 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1337 priv.append(" uint32_t m_indent;\n")
1338 priv.append(" const char m_dummy_prefix;\n")
1339 priv.append(" void display_struct_members();\n")
1340 return "".join(priv)
1341
1342 def _generateClassDeclaration(self):
1343 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001344 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001345 class_decl.append("\n//class declaration")
1346 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1347 class_decl.append(self._generateConstructorDeclarations(s))
1348 class_decl.append(self._generateDestructorDeclarations(s))
1349 class_decl.append(self._generateDisplayDeclarations(s))
1350 class_decl.append(self._generateGetSetDeclarations(s))
1351 class_decl.append(self._generatePrivateMembers(s))
1352 class_decl.append("};\n")
1353 return "\n".join(class_decl)
1354
1355 def _generateFooter(self):
1356 return "\n//any footer info for class\n"
1357
1358class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001359 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 -06001360 self.et_dict = enum_type_dict
1361 self.ev_dict = enum_val_dict
1362 self.tf_dict = typedef_fwd_dict
1363 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001364 self.out_sh_file = out_sh_file
1365 self.eshfg = CommonFileGen(self.out_sh_file)
1366 self.out_vh_file = out_vh_file
1367 self.evhfg = CommonFileGen(self.out_vh_file)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001368
1369 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001370 self.eshfg.setHeader(self._generateSHHeader())
1371 self.eshfg.setBody(self._generateSHBody())
1372 self.eshfg.generate()
1373
1374 def generateEnumValidate(self):
1375 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001376 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001377 self.evhfg.generate()
1378
1379 def _generateVHBody(self):
1380 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001381 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001382 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001383 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1384 # 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 -06001385 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001386 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1387 body.append(' return 0;')
1388 body.append(' return 1;')
1389 body.append('}\n\n')
1390 else:
1391 body.append(' switch ((%s)input_value)\n {' % (fet))
1392 for e in sorted(self.et_dict[bet]):
1393 if (self.ev_dict[e]['unique']):
1394 body.append(' case %s:' % (e))
1395 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001396 return "\n".join(body)
1397
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001398 def _generateSHBody(self):
1399 body = []
1400# with open(self.out_file, "a") as hf:
1401 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001402 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001403 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001404 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 -06001405 for e in sorted(self.et_dict[bet]):
1406 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001407 body.append(' case %s:\n return "%s";' % (e, e))
1408 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001409 return "\n".join(body)
1410
1411 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001412 header = []
1413 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001414 header.append('#ifdef _WIN32\n')
1415 header.append('#pragma warning( disable : 4065 )\n')
1416 header.append('#endif\n')
Ian Elliottfeae4052015-02-18 12:38:04 -07001417 header.append('#include <%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001418 return "\n".join(header)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001419
1420
1421class CMakeGen:
1422 def __init__(self, struct_wrapper=None, out_dir=None):
1423 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001424 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001425 self.add_lib_file_list = self.sw.get_file_list()
1426 self.out_dir = out_dir
1427 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1428 self.cmg = CommonFileGen(self.out_file)
1429
1430 def generate(self):
1431 self.cmg.setBody(self._generateBody())
1432 self.cmg.generate()
1433
1434 def _generateBody(self):
1435 body = []
1436 body.append("project(%s)" % os.path.basename(self.out_dir))
1437 body.append("cmake_minimum_required(VERSION 2.8)\n")
1438 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1439 body.append('set(COMPILE_FLAGS "-fpermissive")')
1440 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1441 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1442 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1443 return "\n".join(body)
1444
1445class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001446 def __init__(self, struct_dict, prefix, out_dir):
1447 self.struct_dict = struct_dict
1448 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001449 if prefix == "vulkan":
1450 self.api_prefix = "vk"
1451 else:
1452 self.api_prefix = prefix
1453 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001454 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001455
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001456 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001457 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001458 self.gvg.setHeader(self._generateHeader())
1459 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001460 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001461 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001462
1463 def set_include_headers(self, include_headers):
1464 self.include_headers = include_headers
1465
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001466 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001467 header = []
1468 header.append("//#includes, #defines, globals and such...\n")
1469 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001470 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001471 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001472 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001473 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001474 return "".join(header)
1475
1476 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001477 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001478
1479 # Return elements to create formatted string for given struct member
1480 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=""):
1481 struct_op = "->"
1482 pre_var_name = '"%s "' % struct_member['full_type']
1483 if not struct_ptr:
1484 struct_op = "."
1485 member_name = struct_member['name']
1486 print_type = "p"
1487 cast_type = ""
1488 member_post = ""
1489 array_index = ""
1490 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001491 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001492 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1493 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001494 print_array = False
1495 elif struct_member['array'] and not print_array:
1496 # Just print base address of array when not full print_array
1497 cast_type = "(void*)"
1498 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001499 if struct_member['ptr']:
1500 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001501 cast_type = "string_%s" % struct_member['type']
1502 print_type = "s"
1503 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1504 cast_type = "(void*)"
1505 if not struct_member['ptr']:
1506 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -06001507 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis83562882014-11-27 15:43:39 -07001508 print_type = "s"
1509 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001510 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001511 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001512 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1513 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001514 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001515 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001516 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001517 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1518 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001519 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 -07001520 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001521 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001522 print_type = "i"
1523 elif struct_member['ptr']:
1524 pass
1525 else:
1526 #print("Unhandled struct type: %s" % struct_member['type'])
1527 cast_type = "(void*)"
1528 if print_array and struct_member['array']:
1529 member_print_post = "[%u]"
1530 array_index = " i,"
1531 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001532 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 -06001533 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 -07001534 return (print_out, print_arg)
1535
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001536 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001537 gv_funcs = []
1538 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001539 array_func_list.append('vkbufferviewattachinfo')
1540 array_func_list.append('vkimageviewattachinfo')
1541 array_func_list.append('vksamplerimageviewinfo')
1542 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001543 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001544 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001545 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1546 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001547 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001548 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]))
1549 else:
1550 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 -07001551 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001552 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001553 p_out = ""
1554 p_args = ""
1555 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1556 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1557 pl_dict = {}
1558 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001559 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001560 for m in sorted(self.struct_dict[s]):
1561 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1562 stp_list.append(self.struct_dict[s][m])
1563 if 'pNext' == self.struct_dict[s][m]['name']:
1564 pl_dict[m] = ' PORT=\\"pNext\\"'
1565 else:
1566 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1567 struct_num += 1
1568 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]))
1569 num_stps = len(stp_list);
1570 total_strlen_str = ''
1571 if 0 != num_stps:
1572 gv_funcs.append(" char* tmpStr;\n")
1573 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001574 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1575 for index in range(num_stps):
1576 if (stp_list[index]['ptr']):
1577 if 'pDescriptorInfo' == stp_list[index]['name']:
1578 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1579 else:
1580 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1581 if 'pNext' == stp_list[index]['name']:
1582 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001583 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001584 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1585 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1586 gv_funcs.append(' free(tmpStr);\n')
1587 else:
1588 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 -06001589 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001590 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 -07001591 else:
1592 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1593 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1594 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1595 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001596 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001597 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1598 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1599 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], 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 else:
1603 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1604 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1605 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1606 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1607 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1608 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1609 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1610 p_args = ", myNodeName, myNodeName, pStruct"
1611 for m in sorted(self.struct_dict[s]):
1612 plabel = ""
1613 if m in pl_dict:
1614 plabel = pl_dict[m]
1615 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1616 p_out += p_out1
1617 p_args += p_args1
1618 p_out += '</TABLE>>\\n];\\n\\n"'
1619 p_args += ");\n"
1620 gv_funcs.append(p_out)
1621 gv_funcs.append(p_args)
1622 if 0 != num_stps:
1623 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1624 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1625 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1626 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1627 gv_funcs.append(' }\n')
1628 gv_funcs.append(' }\n')
1629 gv_funcs.append(" return str;\n}\n")
1630 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001631 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001632 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001633 ptr_array = True
1634 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]))
1635 else:
1636 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 -07001637 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1638 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')
1639 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1640 gv_funcs.append(' sprintf(tmpStr, "');
1641 p_args = ""
1642 p_out = ""
1643 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07001644 plabel = ""
1645 (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 -07001646 if 0 == m: # Add array index notation at end of first row
1647 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 -07001648 p_args1 += ', i, i'
1649 p_out += p_out1
1650 p_args += p_args1
1651 p_out += '"'
1652 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001653 if ptr_array:
1654 p_args = p_args.replace('->', '[i]->')
1655 else:
1656 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07001657 gv_funcs.append(p_out);
1658 gv_funcs.append(p_args);
1659 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1660 gv_funcs.append(' }\n')
1661 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001662 gv_funcs.append(' return str;\n}\n')
1663 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001664 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001665 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001666 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001667 gv_funcs.append(" switch (sType)\n {\n")
1668 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001669 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07001670 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001671 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis83562882014-11-27 15:43:39 -07001672 print_func_name = self._get_gv_func_name(struct_name)
1673 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001674 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001675 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001676 if 'VkSemaphoreCreateInfo' in struct_name:
1677 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001678 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001679 elif 'VkSemaphoreOpenInfo' in struct_name:
1680 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001681 print_func_name = self._get_gv_func_name(struct_name)
1682 gv_funcs.append(' case %s:\n' % (v))
1683 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1684 #gv_funcs.append(' }\n')
1685 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08001686 gv_funcs.append(" default:\n")
1687 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001688 gv_funcs.append(" }\n")
1689 gv_funcs.append("}")
1690 return "".join(gv_funcs)
1691
1692
1693
1694
1695
1696# def _generateHeader(self):
1697# hdr = []
1698# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1699# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1700# hdr.append('edge [\n];\n')
1701# return "\n".join(hdr)
1702#
1703# def _generateBody(self):
1704# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001705# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001706# field_num = 1
1707# 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]))
1708# for m in sorted(self.struc_dict[s]):
1709# 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']))
1710# field_num += 2
1711# body.append('</TABLE>>\n];\n')
1712# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001713
1714def main(argv=None):
1715 opts = handle_args()
1716 # Parse input file and fill out global dicts
1717 hfp = HeaderFileParser(opts.input_file)
1718 hfp.parse()
1719 # TODO : Don't want these to be global, see note at top about wrapper classes
1720 global enum_val_dict
1721 global enum_type_dict
1722 global struct_dict
1723 global typedef_fwd_dict
1724 global typedef_rev_dict
1725 global types_dict
1726 enum_val_dict = hfp.get_enum_val_dict()
1727 enum_type_dict = hfp.get_enum_type_dict()
1728 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07001729 # 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 -06001730 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1731 typedef_rev_dict = hfp.get_typedef_rev_dict()
1732 types_dict = hfp.get_types_dict()
1733 #print(enum_val_dict)
1734 #print(typedef_dict)
1735 #print(struct_dict)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001736 prefix = os.path.basename(opts.input_file).strip(".h")
1737 if prefix == "vulkan":
1738 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001739 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001740 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001741 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001742 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001743 enum_sh_filename = os.path.abspath(enum_sh_filename)
1744 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1745 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1746 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001747 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001748 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001749 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001750 print("Generating enum validate helper to %s" % enum_vh_filename)
1751 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 -06001752 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001753 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001754 #for struct in struct_dict:
1755 #print(struct)
1756 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001757 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 -06001758 #print(sw.get_class_name(struct))
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001759 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 -06001760 print("Generating struct wrapper header to %s" % sw.header_filename)
1761 sw.generateHeader()
1762 print("Generating struct wrapper class to %s" % sw.class_filename)
1763 sw.generateBody()
1764 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001765 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07001766 # Generate a 2nd helper file that excludes addrs
1767 sw.set_no_addr(True)
1768 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07001769 sw.set_no_addr(False)
1770 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 -07001771 sw.set_no_addr(True)
1772 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001773 sw.set_no_addr(False)
1774 sw.generateStringHelperCpp()
Courtney Goeltzenleuchterf53c3cb2015-04-14 14:55:44 -06001775 sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
Tobin Ehlis60354772015-03-12 14:50:40 -06001776 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001777 sw.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001778 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001779 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001780 cmg.generate()
1781 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001782 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 -06001783 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 -06001784 gv.generate()
1785 print("DONE!")
1786 #print(typedef_rev_dict)
1787 #print(types_dict)
1788 #recreate_structs()
1789
1790if __name__ == "__main__":
1791 sys.exit(main())