blob: 9e5b2e6302383ca14352f6ba9ddd9c9a3069a3ce [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:
130 block_comment = True
131 elif 0 == len(line.split()):
132 #print("Skipping empty line")
133 continue
134 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700135 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600136 continue
137 elif 'typedef enum' in line:
138 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
139 #print("Found ENUM type %s" % base_type)
140 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700141 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600142 self.types_dict[base_type] = 'enum'
143 elif 'typedef struct' in line:
144 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
145 #print("Found STRUCT type: %s" % base_type)
146 parse_struct = True
147 self.types_dict[base_type] = 'struct'
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700148 elif 'typedef union' in line:
149 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
150 #print("Found UNION type: %s" % base_type)
151 parse_struct = True
152 self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600153 elif '}' in line and (parse_enum or parse_struct):
154 if len(line.split()) > 1: # deals with embedded union in one struct
155 parse_enum = False
156 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700157 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600158 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600159 (cur_char, targ_type) = line.strip().split(None, 1)
160 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
161 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600162 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600163 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600164 #if 'VK_MAX_ENUM' not in line and '{' not in line:
165 if True not in [ens in line for ens in ['{', 'VK_MAX_ENUM', '_RANGE']]:
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700166 self._add_enum(line, base_type, default_enum_val)
167 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600168 elif parse_struct:
169 if ';' in line:
170 self._add_struct(line, base_type, member_num)
171 member_num = member_num + 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600172
173 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700174 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600175 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700176 if '=' in line_txt:
177 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
178 else:
179 enum_name = line_txt.split(',')[0]
180 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600181 self.enum_val_dict[enum_name] = {}
182 self.enum_val_dict[enum_name]['type'] = enum_type
183 # strip comma and comment, then extra split in case of no comma w/ comments
184 enum_val = enum_val.strip().split(',', 1)[0]
185 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600186 # Perform conversion of VK_BIT macro
187 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
188 vk_bit_val = self.enum_val_dict[enum_name]['val']
189 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
190 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
191 else:
192 # account for negative values surrounded by parens
193 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700194 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600195 try:
196 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
197 int(self.enum_val_dict[enum_name]['val'], 0)
198 self.enum_val_dict[enum_name]['unique'] = True
199 #print("ENUM has num value")
200 except ValueError:
201 self.enum_val_dict[enum_name]['unique'] = False
202 #print("ENUM is not a number value")
203 # Update enum_type_dict as well
204 if not enum_type in self.enum_type_dict:
205 self.enum_type_dict[enum_type] = []
206 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700207
208 # Return True of struct member is a dynamic array
209 # RULES : This is a bit quirky based on the API
210 # NOTE : Changes in API spec may cause these rules to change
211 # 1. There must be a previous uint var w/ 'count' in the name in the struct
212 # 2. Dynam array must have 'const' and '*' qualifiers
213 # 3a. Name of dynam array must end in 's' char OR
214 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
215 def _is_dynamic_array(self, full_type, name):
216 if '' != self.last_struct_count_name:
217 if 'const' in full_type and '*' in full_type:
218 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
219 return True
220 return False
221
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600222 # populate struct dicts based on struct lines
223 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
224 def _add_struct(self, line_txt, struct_type, num):
225 #print("Parsing struct line %s" % line_txt)
226 if not struct_type in self.struct_dict:
227 self.struct_dict[struct_type] = {}
228 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
229 # TODO : Handle bitfields more correctly
230 members = members.strip().split(':', 1)[0] # strip bitfield element
231 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700232 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600233 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700234 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600235 self.struct_dict[struct_type][num] = {}
236 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700237 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600238 if '*' in member_type:
239 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700240 # TODO : Need more general purpose way here to reduce down to basic type
241 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600242 member_type = member_type.strip('*')
243 else:
244 self.struct_dict[struct_type][num]['ptr'] = False
245 if 'const' in member_type:
246 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600247 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600248 else:
249 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700250 # TODO : There is a bug here where it seems that at the time we do this check,
251 # 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 -0600252 if is_type(member_type, 'struct'):
253 self.struct_dict[struct_type][num]['struct'] = True
254 else:
255 self.struct_dict[struct_type][num]['struct'] = False
256 self.struct_dict[struct_type][num]['type'] = member_type
257 if '[' in member_name:
258 (member_name, array_size) = member_name.split('[', 1)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600259 if 'char' in member_type:
260 self.struct_dict[struct_type][num]['array'] = False
261 self.struct_dict[struct_type][num]['array_size'] = 0
262 self.struct_dict[struct_type][num]['ptr'] = True
263 else:
264 self.struct_dict[struct_type][num]['array'] = True
265 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700266 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
267 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
268 self.struct_dict[struct_type][num]['array'] = True
269 self.struct_dict[struct_type][num]['dyn_array'] = True
270 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700271 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600272 self.struct_dict[struct_type][num]['array'] = False
273 self.struct_dict[struct_type][num]['array_size'] = 0
274 self.struct_dict[struct_type][num]['name'] = member_name
275
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700276# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600277def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600278 if identifier in types_dict and type_to_check == types_dict[identifier]:
279 return True
280 if identifier in typedef_rev_dict:
281 new_id = typedef_rev_dict[identifier]
282 if new_id in types_dict and type_to_check == types_dict[new_id]:
283 return True
284 return False
285
286# This is a validation function to verify that we can reproduce the original structs
287def recreate_structs():
288 for struct_name in struct_dict:
289 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
290 for mem_num in sorted(struct_dict[struct_name]):
291 sys.stdout.write(" ")
292 if struct_dict[struct_name][mem_num]['const']:
293 sys.stdout.write("const ")
294 #if struct_dict[struct_name][mem_num]['struct']:
295 # sys.stdout.write("struct ")
296 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
297 if struct_dict[struct_name][mem_num]['ptr']:
298 sys.stdout.write("*")
299 sys.stdout.write(" ")
300 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
301 if struct_dict[struct_name][mem_num]['array']:
302 sys.stdout.write("[")
303 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
304 sys.stdout.write("]")
305 sys.stdout.write(";\n")
306 sys.stdout.write("} ")
307 sys.stdout.write(typedef_fwd_dict[struct_name])
308 sys.stdout.write(";\n\n")
309
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600310#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600311# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600312def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600313 # Note: All struct types are now camel-case
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600314 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600315 char_idx = 0
316 struct_name = ''
317 for char in caps_struct_name:
318 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
319 struct_name += caps_struct_name[char_idx]
320 elif (caps_struct_name[char_idx] == '_'):
321 pass
322 else:
323 struct_name += caps_struct_name[char_idx].lower()
324 char_idx += 1
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600325 return struct_name
326
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600327# class for writing common file elements
328# Here's how this class lays out a file:
329# COPYRIGHT
330# HEADER
331# BODY
332# FOOTER
333#
334# For each of these sections, there's a "set*" function
335# The class as a whole has a generate function which will write each section in order
336class CommonFileGen:
337 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
338 self.filename = filename
339 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
340 # TODO : Set a default copyright & footer at least
341
342 def setFilename(self, filename):
343 self.filename = filename
344
345 def setCopyright(self, c):
346 self.contents['copyright'] = c
347
348 def setHeader(self, h):
349 self.contents['header'] = h
350
351 def setBody(self, b):
352 self.contents['body'] = b
353
354 def setFooter(self, f):
355 self.contents['footer'] = f
356
357 def generate(self):
358 #print("Generate to file %s" % self.filename)
359 with open(self.filename, "w") as f:
360 f.write(self.contents['copyright'])
361 f.write(self.contents['header'])
362 f.write(self.contents['body'])
363 f.write(self.contents['footer'])
364
365# class for writing a wrapper class for structures
366# The wrapper class wraps the structs and includes utility functions for
367# setting/getting member values and displaying the struct data in various formats
368class StructWrapperGen:
369 def __init__(self, in_struct_dict, prefix, out_dir):
370 self.struct_dict = in_struct_dict
371 self.include_headers = []
372 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600373 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600374 self.api_prefix = "vk"
375 else:
376 self.api_prefix = prefix
377 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
378 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
379 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
380 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
381 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
382 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
383 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700384 self.no_addr = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600385 self.hfg = CommonFileGen(self.header_filename)
386 self.cfg = CommonFileGen(self.class_filename)
387 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700388 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700389 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600390 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
391 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600392 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700393 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600394 #print(self.header_filename)
395 self.header_txt = ""
396 self.definition_txt = ""
397
398 def set_include_headers(self, include_headers):
399 self.include_headers = include_headers
400
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700401 def set_no_addr(self, no_addr):
402 self.no_addr = no_addr
403 if self.no_addr:
404 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700405 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700406 else:
407 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700408 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700409
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600410 # Return class name for given struct name
411 def get_class_name(self, struct_name):
412 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
413 return class_name
414
415 def get_file_list(self):
416 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
417
418 # Generate class header file
419 def generateHeader(self):
420 self.hfg.setCopyright(self._generateCopyright())
421 self.hfg.setHeader(self._generateHeader())
422 self.hfg.setBody(self._generateClassDeclaration())
423 self.hfg.setFooter(self._generateFooter())
424 self.hfg.generate()
425
426 # Generate class definition
427 def generateBody(self):
428 self.cfg.setCopyright(self._generateCopyright())
429 self.cfg.setHeader(self._generateCppHeader())
430 self.cfg.setBody(self._generateClassDefinition())
431 self.cfg.setFooter(self._generateFooter())
432 self.cfg.generate()
433
434 # Generate c-style .h file that contains functions for printing structs
435 def generateStringHelper(self):
436 print("Generating struct string helper")
437 self.shg.setCopyright(self._generateCopyright())
438 self.shg.setHeader(self._generateStringHelperHeader())
439 self.shg.setBody(self._generateStringHelperFunctions())
440 self.shg.generate()
441
Tobin Ehlis99f88672015-01-10 12:42:41 -0700442 # Generate cpp-style .h file that contains functions for printing structs
443 def generateStringHelperCpp(self):
444 print("Generating struct string helper cpp")
445 self.shcppg.setCopyright(self._generateCopyright())
446 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
447 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
448 self.shcppg.generate()
449
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700450 # Generate c-style .h file that contains functions for printing structs
451 def generateValidateHelper(self):
452 print("Generating struct validate helper")
453 self.vhg.setCopyright(self._generateCopyright())
454 self.vhg.setHeader(self._generateValidateHelperHeader())
455 self.vhg.setBody(self._generateValidateHelperFunctions())
456 self.vhg.generate()
457
Tobin Ehlis60354772015-03-12 14:50:40 -0600458 def generateSizeHelper(self):
459 print("Generating struct size helper")
460 self.size_helper_gen.setCopyright(self._generateCopyright())
461 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
462 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
463 self.size_helper_gen.generate()
464
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700465 def generateSizeHelperC(self):
466 print("Generating struct size helper c")
467 self.size_helper_c_gen.setCopyright(self._generateCopyright())
468 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
469 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
470 self.size_helper_c_gen.generate()
471
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600472 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700473 copyright = []
474 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
475 copyright.append('');
476 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600477 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700478 copyright.append(' *');
479 copyright.append(' * Copyright (C) 2014 LunarG, Inc.');
480 copyright.append(' *');
481 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
482 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
483 copyright.append(' * to deal in the Software without restriction, including without limitation');
484 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
485 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
486 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
487 copyright.append(' *');
488 copyright.append(' * The above copyright notice and this permission notice shall be included');
489 copyright.append(' * in all copies or substantial portions of the Software.');
490 copyright.append(' *');
491 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
492 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
493 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
494 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
495 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
496 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
497 copyright.append(' * DEALINGS IN THE SOFTWARE.');
498 copyright.append(' */');
499 copyright.append('');
500 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600501
502 def _generateCppHeader(self):
503 header = []
504 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600505 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 -0600506 return "".join(header)
507
508 def _generateClassDefinition(self):
509 class_def = []
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600510 if 'vk' == self.api: # Mantle doesn't have pNext to worry about
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600511 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700512 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600513 class_def.append("\n// %s class definition" % self.get_class_name(s))
514 class_def.append(self._generateConstructorDefinitions(s))
515 class_def.append(self._generateDestructorDefinitions(s))
516 class_def.append(self._generateDisplayDefinitions(s))
517 return "\n".join(class_def)
518
519 def _generateConstructorDefinitions(self, s):
520 con_defs = []
521 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)))
522 # TODO : This is a shallow copy of ptrs
523 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]))
524 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]))
525 return "\n".join(con_defs)
526
527 def _generateDestructorDefinitions(self, s):
528 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
529
530 def _generateDynamicPrintFunctions(self):
531 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600532 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 -0600533 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600534 dp_funcs.append(" switch (sType)\n {")
535 for e in enum_type_dict:
536 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600537 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600538 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600539 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600540 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600541 instance_name = "swc%i" % class_num
542 dp_funcs.append(" case %s:\n {" % (v))
543 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
544 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
545 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
546 dp_funcs.append(" }")
547 dp_funcs.append(" break;")
548 class_num += 1
549 dp_funcs.append(" }")
550 dp_funcs.append("}\n")
551 return "\n".join(dp_funcs)
552
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700553 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600554 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700555
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600556 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700557 return self._get_func_name(struct, 'print')
558
559 def _get_vh_func_name(self, struct):
560 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600561
Tobin Ehlis60354772015-03-12 14:50:40 -0600562 def _get_size_helper_func_name(self, struct):
563 return self._get_func_name(struct, 'size')
564
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600565 # Return elements to create formatted string for given struct member
566 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
567 struct_op = "->"
568 if not struct_ptr:
569 struct_op = "."
570 member_name = struct_member['name']
571 print_type = "p"
572 cast_type = ""
573 member_post = ""
574 array_index = ""
575 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700576 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700577 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
578 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
579 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600580 print_type = "s"
581 print_array = False
582 elif struct_member['array'] and not print_array:
583 # Just print base address of array when not full print_array
584 cast_type = "(void*)"
585 elif is_type(struct_member['type'], 'enum'):
586 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700587 if struct_member['ptr']:
588 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600589 print_type = "s"
590 elif is_type(struct_member['type'], 'struct'): # print struct address for now
591 cast_type = "(void*)"
592 if not struct_member['ptr']:
593 cast_type = "(void*)&"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700594 elif 'bool' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600595 print_type = "s"
596 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700597 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600598 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600599 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
600 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700601 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600602 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600603 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700604 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
605 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600606 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 -0600607 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700608 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600609 print_type = "i"
610 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600611 pass
612 else:
613 #print("Unhandled struct type: %s" % struct_member['type'])
614 cast_type = "(void*)"
615 if print_array and struct_member['array']:
616 member_print_post = "[%u]"
617 array_index = " i,"
618 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700619 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 -0600620 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 -0700621 if self.no_addr and "p" == print_type:
622 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
623 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600624 return (print_out, print_arg)
625
626 def _generateStringHelperFunctions(self):
627 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700628 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700629 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700630 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
631 sh_funcs.append('')
632 sh_funcs.append('#if defined(_WIN32)')
633 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
634 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
635 sh_funcs.append('// work-around.')
636 sh_funcs.append('#define snprintf _snprintf')
637 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700638 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600639 p_out = ""
640 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700641 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 -0700642 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700643 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700644 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
645 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700646 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]))
647 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700648 num_stps = len(stp_list);
649 total_strlen_str = ''
650 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700651 sh_funcs.append(" char* tmpStr;")
652 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
653 sh_funcs.append(' strcpy(extra_indent, " ");')
654 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
655 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700656 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700657 # If it's an array, print all of the elements
658 # If it's a ptr, print thing it's pointing to
659 # Non-ptr struct case. Print the struct using its address
660 struct_deref = '&'
661 if 1 < stp_list[index]['full_type'].count('*'):
662 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700663 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700664 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700665 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700666 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
667 sh_funcs.append(' len = 256+strlen(tmpStr);')
668 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700669 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700670 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700671 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700672 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
673 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700674 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700675 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
676 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600677 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 -0700678 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700679 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
680 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
681 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700682 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700683 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 -0700684 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700685 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']))
686 sh_funcs.append(' }')
687 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
688 elif stp_list[index]['array']:
689 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
690 sh_funcs.append(' len = 256+strlen(tmpStr);')
691 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700692 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700693 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 -0700694 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700695 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 -0700696 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700697 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
698 sh_funcs.append(' len = 256+strlen(tmpStr);')
699 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700700 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700701 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 -0700702 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700703 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 -0700704 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700705 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
706 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700707 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600708 for m in sorted(self.struct_dict[s]):
709 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
710 p_out += p_out1
711 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600712 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700713 p_args += ");"
714 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700715 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700716 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
717 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
718 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
719 sh_funcs.append(' free(stp_strs[stp_index]);')
720 sh_funcs.append(' }')
721 sh_funcs.append(' }')
722 sh_funcs.append(' free(extra_indent);')
723 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600724 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700725 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
726 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
727 sh_funcs.append(" if (pStruct == NULL) {")
728 sh_funcs.append(" return NULL;")
729 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600730 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700731 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
732 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600733 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600734 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600735 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600736 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600737 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700738 sh_funcs.append(' case %s:\n {' % (v))
739 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
740 sh_funcs.append(' }')
741 sh_funcs.append(' break;')
742 sh_funcs.append(" default:")
743 sh_funcs.append(" return NULL;")
744 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600745 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700746 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700747
748 def _generateStringHelperFunctionsCpp(self):
749 # declare str & tmp str
750 # declare array of stringstreams for every struct ptr in current struct
751 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700752 # For every struct ptr, if non-Null, then set its string, else set to NULL str
753 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700754 # create and return final string
755 sh_funcs = []
756 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600757 # XXX - REMOVE this comment
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600758 lineinfo = sourcelineinfo()
759 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700760 for s in sorted(self.struct_dict):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700761 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
762 sh_funcs.append('\n')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600763 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700764 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600765 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 -0700766 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 -0700767 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700768 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700769 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']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700770 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600771 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700772 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 -0600773 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700774 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600775 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700776 sh_funcs.append('%sstring final_str;' % (indent))
777 sh_funcs.append('%sstring tmp_str;' % (indent))
778 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700779 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700780 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700781 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600782 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700783 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700784 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700785 idx_ss_decl = False # Make sure to only decl this once
786 for index in range(num_stps):
787 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700788 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700789 addr_char = ''
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600790 if stp_list[index]['array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600791 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700792 if stp_list[index]['dyn_array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600793 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700794 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
795 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600796 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700797 array_count = '%s' % (stp_list[index]['array_size'])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600798 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700799 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
800 if not idx_ss_decl:
801 sh_funcs.append('%sstringstream index_ss;' % (indent))
802 idx_ss_decl = True
Tobin Ehlis793ad302015-04-03 12:01:11 -0600803 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
804 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700805 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600806 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700807 sh_funcs.append('%sindex_ss.str("");' % (indent))
808 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600809 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600810 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700811 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600812 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
813 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 -0700814 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 -0600815 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600816 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700817 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
818 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']))
819 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600820 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700821 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
822 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600823 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700824 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 -0600825 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600826 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600827 addr_char = ''
828 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
829 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 -0600830 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700831 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600832 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700833 sh_funcs.append('%s}' % (indent))
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600834 indent = indent[4:]
835 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700836 elif (stp_list[index]['ptr']):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600837 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600838 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
839 indent += ' '
Tobin Ehlis99f88672015-01-10 12:42:41 -0700840 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600841 sh_funcs.append('%s' % lineinfo.get())
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600842 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700843 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700844 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
845 # TODO : This is a quick hack to handle these arrays of ptrs
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600846 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600847 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 -0700848 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600849 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700850 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 -0700851 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
852 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600853 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700854 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
855 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600856 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700857 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
858 sh_funcs.append(' ss[%u].str("");' % (index))
859 sh_funcs.append(' }')
860 sh_funcs.append(' else')
861 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700862 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600863 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700864 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
865 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
866 if self.no_addr:
867 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600868 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700869 else:
870 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 -0600871 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700872 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -0600873 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -0700874 index = 0
875 final_str = ''
876 for m in sorted(self.struct_dict[s]):
877 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
878 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
879 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600880 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700881 sh_funcs.append(' ss[%u].str("addr");' % (index))
882 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600883 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700884 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700885 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600886 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700887 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700888 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600889 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700890 sh_funcs.append(' ss[%u] << (uint32_t)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600891 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600892 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600893 sh_funcs.append(' if (StreamControl::writeAddress)')
894 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
895 sh_funcs.append(' else')
896 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700897 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600898 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700899 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700900 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700901 sh_funcs.append(' ss[%u].str("addr");' % (index))
902 else:
903 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
904 value_print = 'ss[%u].str()' % index
905 index += 1
906 else:
Tobin Ehlisce320942015-06-11 09:37:00 -0600907 # 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 -0700908 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600909 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600910 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
911 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
912 sh_funcs.append(' else')
913 sh_funcs.append(' ss[%u].str("NULL");' % (index))
914 value_print = 'ss[%u].str()' % index
915 index += 1
916 # For single enum just print the string representation
917 else:
918 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 -0700919 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
920 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700921 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -0700922 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600923 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700924 sh_funcs.append(' final_str = %s;' % final_str)
925 sh_funcs.append(' return final_str;\n}')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700926 # Add function to return a string value for input void*
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600927 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700928 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600929 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -0700930 sh_funcs.append(" stringstream ss;")
931 sh_funcs.append(' ss << toString;')
932 sh_funcs.append(' string final_str = prefix + ss.str();')
933 sh_funcs.append(" return final_str;")
934 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600935 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis08541742015-04-16 15:56:11 -0600936 # Add function to return a string value for input uint32_t
937 sh_funcs.append("string string_convert_helper(const uint32_t toString, const string prefix)\n{")
938 sh_funcs.append(" using namespace StreamControl;")
939 sh_funcs.append(" stringstream ss;")
940 sh_funcs.append(' ss << toString;')
941 sh_funcs.append(' string final_str = prefix + ss.str();')
942 sh_funcs.append(" return final_str;")
943 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600944 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700945 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600946 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700947 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -0700948 sh_funcs.append(" if (pStruct == NULL) {\n")
Jon Ashburn62a327c2015-02-25 12:45:23 -0700949 sh_funcs.append(" return NULL;")
Ian Elliott82800022015-02-25 17:40:38 -0700950 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600951 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700952 sh_funcs.append(' string indent = " ";')
953 sh_funcs.append(' indent += prefix;')
954 sh_funcs.append(" switch (sType)\n {")
955 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600956 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700957 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600958 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700959 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600960 #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 -0700961 sh_funcs.append(' case %s:\n {' % (v))
962 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
963 sh_funcs.append(' }')
964 sh_funcs.append(' break;')
965 sh_funcs.append(" default:")
966 sh_funcs.append(" return NULL;")
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600967 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600968 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700969 sh_funcs.append("}")
970 return "\n".join(sh_funcs)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600971
972 def _genStructMemberPrint(self, member, s, array, struct_array):
973 (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)
974 extra_indent = ""
975 if array:
976 extra_indent = " "
977 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
978 struct_array.insert(0, self.struct_dict[s][member])
979 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700980 # Special case for void* named "pNext"
981 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600982 struct_array.insert(0, self.struct_dict[s][member])
983 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
984
985 def _generateDisplayDefinitions(self, s):
986 disp_def = []
987 struct_array = []
988 # Single-line struct print function
989 disp_def.append("// Output 'structname = struct_address' on a single line")
990 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
991 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
992 disp_def.append("}\n")
993 # Private helper function to print struct members
994 disp_def.append("// Private helper function that displays the members of the wrapped struct")
995 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
996 i_declared = False
997 for member in sorted(self.struct_dict[s]):
998 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600999 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001000 # Can grab struct type off of header of struct pointed to
1001 # TODO : Handle Arrays
1002 if self.struct_dict[s][member]['array']:
1003 # Create for loop to print each element of array
1004 if not i_declared:
1005 disp_def.append(' uint32_t i;')
1006 i_declared = True
1007 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
1008 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
1009 disp_def.append(return_str)
1010 disp_def.append(' }')
1011 else:
1012 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
1013 disp_def.append(return_str)
1014 disp_def.append("}\n")
1015 i_declared = False
1016 # Basic print function to display struct members
1017 disp_def.append("// Output all struct elements, each on their own line")
1018 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
1019 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1020 disp_def.append(' this->display_struct_members();')
1021 disp_def.append("}\n")
1022 # Advanced print function to display current struct and contents of any pointed-to structs
1023 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1024 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1025 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1026 disp_def.append(' this->display_struct_members();')
1027 class_num = 0
1028 # TODO : Need to handle arrays of structs here
1029 for ms in struct_array:
1030 swc_name = "class%s" % str(class_num)
1031 if ms['array']:
1032 if not i_declared:
1033 disp_def.append(' uint32_t i;')
1034 i_declared = True
1035 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1036 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1037 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1038 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1039 disp_def.append(" %s.display_full_txt();" % (swc_name))
1040 #disp_def.append(' }')
1041 disp_def.append(' }')
1042 elif 'pNext' == ms['name']:
1043 # Need some code trickery here
1044 # I'm thinking have a generated function that takes pNext ptr value
1045 # then it checks sType and in large switch statement creates appropriate
1046 # wrapper class type and then prints contents
1047 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1048 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1049 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1050 disp_def.append(" }")
1051 else:
1052 if ms['ptr']:
1053 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1054 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1055 else:
1056 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1057 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1058 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1059 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1060 class_num += 1
1061 disp_def.append("}\n")
1062 return "\n".join(disp_def)
1063
1064 def _generateStringHelperHeader(self):
1065 header = []
1066 header.append("//#includes, #defines, globals and such...\n")
1067 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001068 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001069 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001070 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001071 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001072 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001073
1074 def _generateStringHelperHeaderCpp(self):
1075 header = []
1076 header.append("//#includes, #defines, globals and such...\n")
1077 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001078 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001079 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001080 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001081 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001082 header.append('\n')
1083 header.append('namespace StreamControl\n')
1084 header.append('{\n')
1085 header.append('bool writeAddress = true;\n')
1086 header.append('template <typename T>\n')
1087 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1088 header.append('{\n')
1089 header.append(' if(writeAddress)\n')
1090 header.append(' {\n')
1091 header.append(' out.operator<<(pointer);\n')
1092 header.append(' }\n')
1093 header.append(' else\n')
1094 header.append(' {\n')
1095 header.append(' std::operator<<(out, "address");\n')
1096 header.append(' }\n')
1097 header.append(' return out;\n')
1098 header.append('}\n')
1099 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1100 header.append('{\n')
1101 header.append(' return std::operator<<(out, s);\n')
1102 header.append('}\n')
1103 header.append('}\n')
1104 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001105 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001106 return "".join(header)
1107
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001108 def _generateValidateHelperFunctions(self):
1109 sh_funcs = []
1110 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001111 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001112 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1113 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001114 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001115 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1116 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001117 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001118 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 -07001119 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 -07001120 # 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 -07001121 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1122 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001123 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 -07001124 else:
1125 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 -07001126 sh_funcs.append(" return 1;\n}")
1127
1128 return "\n".join(sh_funcs)
1129
1130 def _generateValidateHelperHeader(self):
1131 header = []
1132 header.append("//#includes, #defines, globals and such...\n")
1133 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001134 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001135 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001136 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001137 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001138 return "".join(header)
1139
Tobin Ehlis60354772015-03-12 14:50:40 -06001140 def _generateSizeHelperFunctions(self):
1141 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001142 # just generates prototypes for all the functions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001143 for s in sorted(self.struct_dict):
Tobin Ehlis60354772015-03-12 14:50:40 -06001144 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 -07001145 return "\n".join(sh_funcs)
1146
1147
1148 def _generateSizeHelperFunctionsC(self):
1149 sh_funcs = []
1150 # generate function definitions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001151 for s in sorted(self.struct_dict):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001152 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001153 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1154 indent = ' '
1155 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1156 sh_funcs.append('%sif (pStruct) {' % (indent))
1157 indent = ' '
1158 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1159 i_decl = False
1160 for m in sorted(self.struct_dict[s]):
1161 if m in skip_list:
1162 continue
1163 if self.struct_dict[s][m]['dyn_array']:
1164 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1165 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 -06001166 if 'ppMemBarriers' == self.struct_dict[s][m]['name']:
1167 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001168 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 -06001169 else:
1170 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 -06001171 else: # This is an array of char* or array of struct ptrs
1172 if not i_decl:
1173 sh_funcs.append('%suint32_t i = 0;' % (indent))
1174 i_decl = True
1175 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1176 indent = ' '
1177 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1178 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']))
1179 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001180 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 -06001181 indent = ' '
1182 sh_funcs.append('%s}' % (indent))
1183 else:
1184 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1185 if not i_decl:
1186 sh_funcs.append('%suint32_t i = 0;' % (indent))
1187 i_decl = True
1188 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1189 indent = ' '
1190 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']))
1191 indent = ' '
1192 sh_funcs.append('%s}' % (indent))
1193 else:
1194 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1195 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1196 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001197 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 -06001198 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1199 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 -06001200 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis60354772015-03-12 14:50:40 -06001201 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1202 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1203 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1204 skip_list.append(m+1)
1205 indent = ' '
1206 sh_funcs.append('%s}' % (indent))
1207 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001208 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
1209 for follow_chain in [True, False]:
1210 if follow_chain:
1211 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1212 else:
1213 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1214 indent = ' '
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001215 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1216 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001217 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1218 if follow_chain:
1219 sh_funcs.append('%swhile (pNext) {' % (indent))
1220 indent = ' '
1221 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1222 indent += ' '
1223 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001224 if 'StructureType' in e:
Tobin Ehlis04112922015-03-16 10:44:40 -06001225 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001226 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis04112922015-03-16 10:44:40 -06001227 sh_funcs.append('%scase %s:' % (indent, v))
1228 sh_funcs.append('%s{' % (indent))
1229 indent += ' '
1230 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1231 sh_funcs.append('%sbreak;' % (indent))
1232 indent = indent[:-4]
1233 sh_funcs.append('%s}' % (indent))
1234 sh_funcs.append('%sdefault:' % (indent))
1235 indent += ' '
1236 sh_funcs.append('%sassert(0);' % (indent))
1237 sh_funcs.append('%sstructSize += 0;' % (indent))
1238 indent = indent[:-4]
1239 indent = indent[:-4]
1240 sh_funcs.append('%s}' % (indent))
1241 if follow_chain:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001242 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001243 indent = indent[:-4]
1244 sh_funcs.append('%s}' % (indent))
1245 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001246 return "\n".join(sh_funcs)
1247
1248 def _generateSizeHelperHeader(self):
1249 header = []
1250 header.append("//#includes, #defines, globals and such...\n")
1251 for f in self.include_headers:
1252 header.append("#include <%s>\n" % f)
1253 header.append('\n// Function Prototypes\n')
1254 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001255 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001256 return "".join(header)
1257
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001258 def _generateSizeHelperHeaderC(self):
1259 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001260 header.append('#include "vk_struct_size_helper.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001261 header.append('#include <string.h>')
1262 header.append('#include <assert.h>')
1263 header.append('\n// Function definitions\n')
1264 return "\n".join(header)
1265
1266
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001267 def _generateHeader(self):
1268 header = []
1269 header.append("//#includes, #defines, globals and such...\n")
1270 for f in self.include_headers:
1271 header.append("#include <%s>\n" % f)
1272 return "".join(header)
1273
1274 # Declarations
1275 def _generateConstructorDeclarations(self, s):
1276 constructors = []
1277 constructors.append(" %s();\n" % self.get_class_name(s))
1278 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1279 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1280 return "".join(constructors)
1281
1282 def _generateDestructorDeclarations(self, s):
1283 return " virtual ~%s();\n" % self.get_class_name(s)
1284
1285 def _generateDisplayDeclarations(self, s):
1286 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
1287
1288 def _generateGetSetDeclarations(self, s):
1289 get_set = []
1290 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1291 for member in sorted(self.struct_dict[s]):
1292 # TODO : Skipping array set/get funcs for now
1293 if self.struct_dict[s][member]['array']:
1294 continue
1295 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']))
1296 if not self.struct_dict[s][member]['const']:
1297 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']))
1298 return "".join(get_set)
1299
1300 def _generatePrivateMembers(self, s):
1301 priv = []
1302 priv.append("\nprivate:\n")
1303 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1304 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1305 priv.append(" uint32_t m_indent;\n")
1306 priv.append(" const char m_dummy_prefix;\n")
1307 priv.append(" void display_struct_members();\n")
1308 return "".join(priv)
1309
1310 def _generateClassDeclaration(self):
1311 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001312 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001313 class_decl.append("\n//class declaration")
1314 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1315 class_decl.append(self._generateConstructorDeclarations(s))
1316 class_decl.append(self._generateDestructorDeclarations(s))
1317 class_decl.append(self._generateDisplayDeclarations(s))
1318 class_decl.append(self._generateGetSetDeclarations(s))
1319 class_decl.append(self._generatePrivateMembers(s))
1320 class_decl.append("};\n")
1321 return "\n".join(class_decl)
1322
1323 def _generateFooter(self):
1324 return "\n//any footer info for class\n"
1325
1326class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001327 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 -06001328 self.et_dict = enum_type_dict
1329 self.ev_dict = enum_val_dict
1330 self.tf_dict = typedef_fwd_dict
1331 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001332 self.out_sh_file = out_sh_file
1333 self.eshfg = CommonFileGen(self.out_sh_file)
1334 self.out_vh_file = out_vh_file
1335 self.evhfg = CommonFileGen(self.out_vh_file)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001336
1337 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001338 self.eshfg.setHeader(self._generateSHHeader())
1339 self.eshfg.setBody(self._generateSHBody())
1340 self.eshfg.generate()
1341
1342 def generateEnumValidate(self):
1343 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001344 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001345 self.evhfg.generate()
1346
1347 def _generateVHBody(self):
1348 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001349 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001350 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001351 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1352 # 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 -06001353 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001354 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1355 body.append(' return 0;')
1356 body.append(' return 1;')
1357 body.append('}\n\n')
1358 else:
1359 body.append(' switch ((%s)input_value)\n {' % (fet))
1360 for e in sorted(self.et_dict[bet]):
1361 if (self.ev_dict[e]['unique']):
1362 body.append(' case %s:' % (e))
1363 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001364 return "\n".join(body)
1365
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001366 def _generateSHBody(self):
1367 body = []
1368# with open(self.out_file, "a") as hf:
1369 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001370 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001371 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001372 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 -06001373 for e in sorted(self.et_dict[bet]):
1374 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001375 body.append(' case %s:\n return "%s";' % (e, e))
1376 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001377 return "\n".join(body)
1378
1379 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001380 header = []
1381 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001382 header.append('#ifdef _WIN32\n')
1383 header.append('#pragma warning( disable : 4065 )\n')
1384 header.append('#endif\n')
Ian Elliottfeae4052015-02-18 12:38:04 -07001385 header.append('#include <%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001386 return "\n".join(header)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001387
1388
1389class CMakeGen:
1390 def __init__(self, struct_wrapper=None, out_dir=None):
1391 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001392 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001393 self.add_lib_file_list = self.sw.get_file_list()
1394 self.out_dir = out_dir
1395 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1396 self.cmg = CommonFileGen(self.out_file)
1397
1398 def generate(self):
1399 self.cmg.setBody(self._generateBody())
1400 self.cmg.generate()
1401
1402 def _generateBody(self):
1403 body = []
1404 body.append("project(%s)" % os.path.basename(self.out_dir))
1405 body.append("cmake_minimum_required(VERSION 2.8)\n")
1406 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1407 body.append('set(COMPILE_FLAGS "-fpermissive")')
1408 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1409 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1410 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1411 return "\n".join(body)
1412
1413class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001414 def __init__(self, struct_dict, prefix, out_dir):
1415 self.struct_dict = struct_dict
1416 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001417 if prefix == "vulkan":
1418 self.api_prefix = "vk"
1419 else:
1420 self.api_prefix = prefix
1421 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001422 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001423
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001424 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001425 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001426 self.gvg.setHeader(self._generateHeader())
1427 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001428 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001429 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001430
1431 def set_include_headers(self, include_headers):
1432 self.include_headers = include_headers
1433
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001434 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001435 header = []
1436 header.append("//#includes, #defines, globals and such...\n")
1437 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001438 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001439 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001440 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001441 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001442 return "".join(header)
1443
1444 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001445 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001446
1447 # Return elements to create formatted string for given struct member
1448 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=""):
1449 struct_op = "->"
1450 pre_var_name = '"%s "' % struct_member['full_type']
1451 if not struct_ptr:
1452 struct_op = "."
1453 member_name = struct_member['name']
1454 print_type = "p"
1455 cast_type = ""
1456 member_post = ""
1457 array_index = ""
1458 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001459 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001460 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1461 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001462 print_array = False
1463 elif struct_member['array'] and not print_array:
1464 # Just print base address of array when not full print_array
1465 cast_type = "(void*)"
1466 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001467 if struct_member['ptr']:
1468 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001469 cast_type = "string_%s" % struct_member['type']
1470 print_type = "s"
1471 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1472 cast_type = "(void*)"
1473 if not struct_member['ptr']:
1474 cast_type = "(void*)&"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001475 elif 'bool' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001476 print_type = "s"
1477 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001478 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001479 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001480 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1481 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001482 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001483 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001484 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001485 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1486 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001487 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 -07001488 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001489 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001490 print_type = "i"
1491 elif struct_member['ptr']:
1492 pass
1493 else:
1494 #print("Unhandled struct type: %s" % struct_member['type'])
1495 cast_type = "(void*)"
1496 if print_array and struct_member['array']:
1497 member_print_post = "[%u]"
1498 array_index = " i,"
1499 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001500 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 -06001501 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 -07001502 return (print_out, print_arg)
1503
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001504 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001505 gv_funcs = []
1506 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001507 array_func_list.append('vkbufferviewattachinfo')
1508 array_func_list.append('vkimageviewattachinfo')
1509 array_func_list.append('vksamplerimageviewinfo')
1510 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001511 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001512 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001513 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1514 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001515 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001516 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]))
1517 else:
1518 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 -07001519 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001520 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001521 p_out = ""
1522 p_args = ""
1523 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1524 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1525 pl_dict = {}
1526 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001527 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001528 for m in sorted(self.struct_dict[s]):
1529 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1530 stp_list.append(self.struct_dict[s][m])
1531 if 'pNext' == self.struct_dict[s][m]['name']:
1532 pl_dict[m] = ' PORT=\\"pNext\\"'
1533 else:
1534 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1535 struct_num += 1
1536 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]))
1537 num_stps = len(stp_list);
1538 total_strlen_str = ''
1539 if 0 != num_stps:
1540 gv_funcs.append(" char* tmpStr;\n")
1541 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001542 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1543 for index in range(num_stps):
1544 if (stp_list[index]['ptr']):
1545 if 'pDescriptorInfo' == stp_list[index]['name']:
1546 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1547 else:
1548 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1549 if 'pNext' == stp_list[index]['name']:
1550 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001551 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001552 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1553 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1554 gv_funcs.append(' free(tmpStr);\n')
1555 else:
1556 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 -06001557 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001558 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 -07001559 else:
1560 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1561 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1562 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1563 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001564 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001565 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1566 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1567 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1568 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1569 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1570 else:
1571 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1572 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1573 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1574 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1575 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1576 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1577 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1578 p_args = ", myNodeName, myNodeName, pStruct"
1579 for m in sorted(self.struct_dict[s]):
1580 plabel = ""
1581 if m in pl_dict:
1582 plabel = pl_dict[m]
1583 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1584 p_out += p_out1
1585 p_args += p_args1
1586 p_out += '</TABLE>>\\n];\\n\\n"'
1587 p_args += ");\n"
1588 gv_funcs.append(p_out)
1589 gv_funcs.append(p_args)
1590 if 0 != num_stps:
1591 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1592 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1593 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1594 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1595 gv_funcs.append(' }\n')
1596 gv_funcs.append(' }\n')
1597 gv_funcs.append(" return str;\n}\n")
1598 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001599 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001600 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001601 ptr_array = True
1602 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]))
1603 else:
1604 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 -07001605 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1606 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')
1607 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1608 gv_funcs.append(' sprintf(tmpStr, "');
1609 p_args = ""
1610 p_out = ""
1611 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07001612 plabel = ""
1613 (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 -07001614 if 0 == m: # Add array index notation at end of first row
1615 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 -07001616 p_args1 += ', i, i'
1617 p_out += p_out1
1618 p_args += p_args1
1619 p_out += '"'
1620 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001621 if ptr_array:
1622 p_args = p_args.replace('->', '[i]->')
1623 else:
1624 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07001625 gv_funcs.append(p_out);
1626 gv_funcs.append(p_args);
1627 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1628 gv_funcs.append(' }\n')
1629 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001630 gv_funcs.append(' return str;\n}\n')
1631 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001632 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001633 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001634 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001635 gv_funcs.append(" switch (sType)\n {\n")
1636 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001637 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07001638 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001639 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis83562882014-11-27 15:43:39 -07001640 print_func_name = self._get_gv_func_name(struct_name)
1641 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001642 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001643 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001644 if 'VkSemaphoreCreateInfo' in struct_name:
1645 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001646 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001647 elif 'VkSemaphoreOpenInfo' in struct_name:
1648 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001649 print_func_name = self._get_gv_func_name(struct_name)
1650 gv_funcs.append(' case %s:\n' % (v))
1651 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1652 #gv_funcs.append(' }\n')
1653 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08001654 gv_funcs.append(" default:\n")
1655 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001656 gv_funcs.append(" }\n")
1657 gv_funcs.append("}")
1658 return "".join(gv_funcs)
1659
1660
1661
1662
1663
1664# def _generateHeader(self):
1665# hdr = []
1666# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1667# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1668# hdr.append('edge [\n];\n')
1669# return "\n".join(hdr)
1670#
1671# def _generateBody(self):
1672# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001673# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001674# field_num = 1
1675# 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]))
1676# for m in sorted(self.struc_dict[s]):
1677# 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']))
1678# field_num += 2
1679# body.append('</TABLE>>\n];\n')
1680# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001681
1682def main(argv=None):
1683 opts = handle_args()
1684 # Parse input file and fill out global dicts
1685 hfp = HeaderFileParser(opts.input_file)
1686 hfp.parse()
1687 # TODO : Don't want these to be global, see note at top about wrapper classes
1688 global enum_val_dict
1689 global enum_type_dict
1690 global struct_dict
1691 global typedef_fwd_dict
1692 global typedef_rev_dict
1693 global types_dict
1694 enum_val_dict = hfp.get_enum_val_dict()
1695 enum_type_dict = hfp.get_enum_type_dict()
1696 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07001697 # 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 -06001698 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1699 typedef_rev_dict = hfp.get_typedef_rev_dict()
1700 types_dict = hfp.get_types_dict()
1701 #print(enum_val_dict)
1702 #print(typedef_dict)
1703 #print(struct_dict)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001704 prefix = os.path.basename(opts.input_file).strip(".h")
1705 if prefix == "vulkan":
1706 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001707 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001708 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001709 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001710 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001711 enum_sh_filename = os.path.abspath(enum_sh_filename)
1712 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1713 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1714 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001715 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001716 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001717 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001718 print("Generating enum validate helper to %s" % enum_vh_filename)
1719 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 -06001720 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001721 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001722 #for struct in struct_dict:
1723 #print(struct)
1724 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001725 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 -06001726 #print(sw.get_class_name(struct))
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001727 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 -06001728 print("Generating struct wrapper header to %s" % sw.header_filename)
1729 sw.generateHeader()
1730 print("Generating struct wrapper class to %s" % sw.class_filename)
1731 sw.generateBody()
1732 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001733 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07001734 # Generate a 2nd helper file that excludes addrs
1735 sw.set_no_addr(True)
1736 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07001737 sw.set_no_addr(False)
1738 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 -07001739 sw.set_no_addr(True)
1740 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001741 sw.set_no_addr(False)
1742 sw.generateStringHelperCpp()
Courtney Goeltzenleuchterf53c3cb2015-04-14 14:55:44 -06001743 sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
Tobin Ehlis60354772015-03-12 14:50:40 -06001744 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001745 sw.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001746 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001747 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001748 cmg.generate()
1749 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001750 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 -06001751 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 -06001752 gv.generate()
1753 print("DONE!")
1754 #print(typedef_rev_dict)
1755 #print(types_dict)
1756 #recreate_structs()
1757
1758if __name__ == "__main__":
1759 sys.exit(main())