blob: fd5c96e0adcdab13519df20c26d9c701ac7d7130 [file] [log] [blame]
Tobin Ehlis33267fd2014-11-10 16:03:19 -07001#!/usr/bin/env python3
2#
Courtney Goeltzenleuchterfcbe16f2015-10-29 13:50:34 -06003# Copyright (C) 2015 Valve Corporation
Tobin Ehlis33267fd2014-11-10 16:03:19 -07004#
5# Permission is hereby granted, free of charge, to any person obtaining a
6# copy of this software and associated documentation files (the "Software"),
7# to deal in the Software without restriction, including without limitation
8# the rights to use, copy, modify, merge, publish, distribute, sublicense,
9# and/or sell copies of the Software, and to permit persons to whom the
10# Software is furnished to do so, subject to the following conditions:
11#
12# The above copyright notice and this permission notice shall be included
13# in all copies or substantial portions of the Software.
14#
15# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21# DEALINGS IN THE SOFTWARE.
Courtney Goeltzenleuchter05559522015-10-30 11:14:30 -060022#
23# Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
24# Author: Tobin Ehlis <tobin@lunarg.com>
25
Tobin Ehlis6442dca2014-10-22 15:13:53 -060026import argparse
27import os
28import sys
Michael Lentine33d96a32016-01-05 11:10:15 -060029import re
Tobin Ehlisa30e7e52015-07-06 14:02:36 -060030import vulkan
Tobin Ehlis08fafd02015-06-12 12:49:01 -060031from source_line_info import sourcelineinfo
Tobin Ehlis6442dca2014-10-22 15:13:53 -060032
Tobin Ehlis08fafd02015-06-12 12:49:01 -060033# vk_helper.py overview
34# This script generates code based on vulkan input header
35# It generate wrappers functions that can be used to display
Tobin Ehlis6442dca2014-10-22 15:13:53 -060036# structs in a human-readable txt format, as well as utility functions
37# to print enum values as strings
38
Tobin Ehlis6442dca2014-10-22 15:13:53 -060039def handle_args():
40 parser = argparse.ArgumentParser(description='Perform analysis of vogl trace.')
41 parser.add_argument('input_file', help='The input header file from which code will be generated.')
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060042 parser.add_argument('--rel_out_dir', required=False, default='vktrace_gen', help='Path relative to exec path to write output files. Will be created if needed.')
Tobin Ehlis6442dca2014-10-22 15:13:53 -060043 parser.add_argument('--abs_out_dir', required=False, default=None, help='Absolute path to write output files. Will be created if needed.')
44 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.')
45 parser.add_argument('--gen_struct_wrappers', required=False, action='store_true', default=False, help='Enable generation of struct wrapper classes.')
Jon Ashburnea65e492015-08-06 17:27:49 -060046 parser.add_argument('--gen_struct_sizes', required=False, action='store_true', default=False, help='Enable generation of struct sizes.')
Tobin Ehlis6442dca2014-10-22 15:13:53 -060047 parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.')
48 parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.')
49 #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.')
50 return parser.parse_args()
51
52# TODO : Ideally these data structs would be opaque to user and could be wrapped
53# in their own class(es) to make them friendly for data look-up
54# Dicts for Data storage
55# enum_val_dict[value_name] = dict keys are the string enum value names for all enums
56# |-------->['type'] = the type of enum class into which the value falls
57# |-------->['val'] = the value assigned to this particular value_name
58# '-------->['unique'] = bool designating if this enum 'val' is unique within this enum 'type'
59enum_val_dict = {}
60# enum_type_dict['type'] = the type or class of of enum
61# '----->['val_name1', 'val_name2'...] = each type references a list of val_names within this type
62enum_type_dict = {}
63# struct_dict['struct_basename'] = the base (non-typedef'd) name of the struct
64# |->[<member_num>] = members are stored via their integer placement in the struct
65# | |->['name'] = string name of this struct member
66# ... |->['full_type'] = complete type qualifier for this member
67# |->['type'] = base type for this member
68# |->['ptr'] = bool indicating if this member is ptr
69# |->['const'] = bool indicating if this member is const
70# |->['struct'] = bool indicating if this member is a struct type
71# |->['array'] = bool indicating if this member is an array
Tobin Ehlisbd6a9162015-03-13 07:18:05 -060072# |->['dyn_array'] = bool indicating if member is a dynamically sized array
73# '->['array_size'] = For dyn_array, member name used to size array, else int size for static array
Tobin Ehlis6442dca2014-10-22 15:13:53 -060074struct_dict = {}
75# typedef_fwd_dict stores mapping from orig_type_name -> new_type_name
76typedef_fwd_dict = {}
77# typedef_rev_dict stores mapping from new_type_name -> orig_type_name
78typedef_rev_dict = {} # store new_name -> orig_name mapping
79# types_dict['id_name'] = identifier name will map to it's type
80# '---->'type' = currently either 'struct' or 'enum'
81types_dict = {} # store orig_name -> type mapping
82
83
84# Class that parses header file and generates data structures that can
85# Then be used for other tasks
86class HeaderFileParser:
87 def __init__(self, header_file=None):
88 self.header_file = header_file
89 # store header data in various formats, see above for more info
90 self.enum_val_dict = {}
91 self.enum_type_dict = {}
92 self.struct_dict = {}
93 self.typedef_fwd_dict = {}
94 self.typedef_rev_dict = {}
95 self.types_dict = {}
Tobin Ehlis5178bd72015-03-06 10:38:25 -070096 self.last_struct_count_name = ''
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060097
Tobin Ehlis6442dca2014-10-22 15:13:53 -060098 def setHeaderFile(self, header_file):
99 self.header_file = header_file
100
101 def get_enum_val_dict(self):
102 return self.enum_val_dict
103
104 def get_enum_type_dict(self):
105 return self.enum_type_dict
106
107 def get_struct_dict(self):
108 return self.struct_dict
109
110 def get_typedef_fwd_dict(self):
111 return self.typedef_fwd_dict
112
113 def get_typedef_rev_dict(self):
114 return self.typedef_rev_dict
115
116 def get_types_dict(self):
117 return self.types_dict
118
119 # Parse header file into data structures
120 def parse(self):
121 # parse through the file, identifying different sections
122 parse_enum = False
123 parse_struct = False
124 member_num = 0
125 # TODO : Comment parsing is very fragile but handles 2 known files
126 block_comment = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700127 prev_count_name = ''
Ian Elliott7e40db92015-08-21 15:09:33 -0600128 exclude_struct_list = ['VkPlatformHandleXcbKHR', 'VkPlatformHandleX11KHR']
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600129 with open(self.header_file) as f:
130 for line in f:
131 if block_comment:
132 if '*/' in line:
133 block_comment = False
134 continue
135 if '/*' in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600136 if '*/' in line: # single line block comment
137 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600138 block_comment = True
139 elif 0 == len(line.split()):
140 #print("Skipping empty line")
141 continue
142 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700143 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600144 continue
145 elif 'typedef enum' in line:
146 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
147 #print("Found ENUM type %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600148 if '{' == base_type:
149 base_type = 'tmp_enum'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600150 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700151 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600152 self.types_dict[base_type] = 'enum'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600153 elif 'typedef struct' in line or 'typedef union' in line:
Jon Ashburnea65e492015-08-06 17:27:49 -0600154 if True in [ex_type in line for ex_type in exclude_struct_list]:
155 continue
Chia-I Wu44c99b62015-10-27 19:55:29 +0800156
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600157 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
Chia-I Wu44c99b62015-10-27 19:55:29 +0800158 if ' ' in base_type:
159 (ignored, base_type) = base_type.strip().split(None, 1)
160
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600161 #print("Found STRUCT type: %s" % base_type)
Cody Northrop22b7fae2015-08-11 11:21:48 -0600162 # Note: This really needs to be updated to handle one line struct definition, like
163 # typedef struct obj##_T { uint64_t handle; } obj;
164 if ('{' == base_type or not (' ' in base_type)):
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600165 base_type = 'tmp_struct'
Cody Northrop22b7fae2015-08-11 11:21:48 -0600166 parse_struct = True
167 self.types_dict[base_type] = 'struct'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600168# elif 'typedef union' in line:
169# (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
170# print("Found UNION type: %s" % base_type)
171# parse_struct = True
172# self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600173 elif '}' in line and (parse_enum or parse_struct):
174 if len(line.split()) > 1: # deals with embedded union in one struct
175 parse_enum = False
176 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700177 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600178 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600179 (cur_char, targ_type) = line.strip().split(None, 1)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600180 if 'tmp_struct' == base_type:
181 base_type = targ_type.strip(';')
Ian Elliott7e40db92015-08-21 15:09:33 -0600182 if True in [ex_type in base_type for ex_type in exclude_struct_list]:
183 del self.struct_dict['tmp_struct']
184 continue
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600185 #print("Found Actual Struct type %s" % base_type)
186 self.struct_dict[base_type] = self.struct_dict['tmp_struct']
187 self.struct_dict.pop('tmp_struct', 0)
188 self.types_dict[base_type] = 'struct'
189 self.types_dict.pop('tmp_struct', 0)
190 elif 'tmp_enum' == base_type:
191 base_type = targ_type.strip(';')
192 #print("Found Actual ENUM type %s" % base_type)
193 for n in self.enum_val_dict:
194 if 'tmp_enum' == self.enum_val_dict[n]['type']:
195 self.enum_val_dict[n]['type'] = base_type
196# self.enum_val_dict[base_type] = self.enum_val_dict['tmp_enum']
197# self.enum_val_dict.pop('tmp_enum', 0)
198 self.enum_type_dict[base_type] = self.enum_type_dict['tmp_enum']
199 self.enum_type_dict.pop('tmp_enum', 0)
200 self.types_dict[base_type] = 'enum'
201 self.types_dict.pop('tmp_enum', 0)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600202 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
203 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600204 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600205 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600206 #if 'VK_MAX_ENUM' not in line and '{' not in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600207 if True not in [ens in line for ens in ['{', '_MAX_ENUM', '_BEGIN_RANGE', '_END_RANGE', '_NUM = ', '_ENUM_RANGE']]:
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700208 self._add_enum(line, base_type, default_enum_val)
209 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600210 elif parse_struct:
211 if ';' in line:
212 self._add_struct(line, base_type, member_num)
213 member_num = member_num + 1
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600214
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600215 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700216 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600217 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700218 if '=' in line_txt:
219 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
220 else:
221 enum_name = line_txt.split(',')[0]
222 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600223 self.enum_val_dict[enum_name] = {}
224 self.enum_val_dict[enum_name]['type'] = enum_type
225 # strip comma and comment, then extra split in case of no comma w/ comments
226 enum_val = enum_val.strip().split(',', 1)[0]
227 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600228 # Perform conversion of VK_BIT macro
229 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
230 vk_bit_val = self.enum_val_dict[enum_name]['val']
231 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
232 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
233 else:
234 # account for negative values surrounded by parens
235 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700236 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600237 try:
238 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
239 int(self.enum_val_dict[enum_name]['val'], 0)
240 self.enum_val_dict[enum_name]['unique'] = True
241 #print("ENUM has num value")
242 except ValueError:
243 self.enum_val_dict[enum_name]['unique'] = False
244 #print("ENUM is not a number value")
245 # Update enum_type_dict as well
246 if not enum_type in self.enum_type_dict:
247 self.enum_type_dict[enum_type] = []
248 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700249
Jon Ashburnea65e492015-08-06 17:27:49 -0600250 # Return True if struct member is a dynamic array
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700251 # RULES : This is a bit quirky based on the API
252 # NOTE : Changes in API spec may cause these rules to change
253 # 1. There must be a previous uint var w/ 'count' in the name in the struct
254 # 2. Dynam array must have 'const' and '*' qualifiers
255 # 3a. Name of dynam array must end in 's' char OR
256 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
257 def _is_dynamic_array(self, full_type, name):
258 if '' != self.last_struct_count_name:
259 if 'const' in full_type and '*' in full_type:
260 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
261 return True
Chia-I Wud50a7d72015-10-26 20:48:51 +0800262
263 # VkWriteDescriptorSet
264 if self.last_struct_count_name == "descriptorCount":
265 return True
266
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700267 return False
268
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600269 # populate struct dicts based on struct lines
270 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
271 def _add_struct(self, line_txt, struct_type, num):
272 #print("Parsing struct line %s" % line_txt)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600273 if '{' == struct_type:
274 print("Parsing struct '{' w/ line %s" % line_txt)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600275 if not struct_type in self.struct_dict:
276 self.struct_dict[struct_type] = {}
277 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
278 # TODO : Handle bitfields more correctly
279 members = members.strip().split(':', 1)[0] # strip bitfield element
280 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700281 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600282 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700283 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600284 self.struct_dict[struct_type][num] = {}
285 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700286 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600287 if '*' in member_type:
288 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700289 # TODO : Need more general purpose way here to reduce down to basic type
290 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600291 member_type = member_type.strip('*')
292 else:
293 self.struct_dict[struct_type][num]['ptr'] = False
294 if 'const' in member_type:
295 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600296 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600297 else:
298 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700299 # TODO : There is a bug here where it seems that at the time we do this check,
300 # 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 -0600301 if is_type(member_type, 'struct'):
302 self.struct_dict[struct_type][num]['struct'] = True
303 else:
304 self.struct_dict[struct_type][num]['struct'] = False
305 self.struct_dict[struct_type][num]['type'] = member_type
306 if '[' in member_name:
307 (member_name, array_size) = member_name.split('[', 1)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600308 if 'char' in member_type:
309 self.struct_dict[struct_type][num]['array'] = False
310 self.struct_dict[struct_type][num]['array_size'] = 0
311 self.struct_dict[struct_type][num]['ptr'] = True
312 else:
313 self.struct_dict[struct_type][num]['array'] = True
314 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700315 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
316 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
317 self.struct_dict[struct_type][num]['array'] = True
318 self.struct_dict[struct_type][num]['dyn_array'] = True
319 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700320 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600321 self.struct_dict[struct_type][num]['array'] = False
322 self.struct_dict[struct_type][num]['array_size'] = 0
323 self.struct_dict[struct_type][num]['name'] = member_name
324
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700325# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600326def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600327 if identifier in types_dict and type_to_check == types_dict[identifier]:
328 return True
329 if identifier in typedef_rev_dict:
330 new_id = typedef_rev_dict[identifier]
331 if new_id in types_dict and type_to_check == types_dict[new_id]:
332 return True
333 return False
334
335# This is a validation function to verify that we can reproduce the original structs
336def recreate_structs():
337 for struct_name in struct_dict:
338 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
339 for mem_num in sorted(struct_dict[struct_name]):
340 sys.stdout.write(" ")
341 if struct_dict[struct_name][mem_num]['const']:
342 sys.stdout.write("const ")
343 #if struct_dict[struct_name][mem_num]['struct']:
344 # sys.stdout.write("struct ")
345 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
346 if struct_dict[struct_name][mem_num]['ptr']:
347 sys.stdout.write("*")
348 sys.stdout.write(" ")
349 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
350 if struct_dict[struct_name][mem_num]['array']:
351 sys.stdout.write("[")
352 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
353 sys.stdout.write("]")
354 sys.stdout.write(";\n")
355 sys.stdout.write("} ")
356 sys.stdout.write(typedef_fwd_dict[struct_name])
357 sys.stdout.write(";\n\n")
358
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600359#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600360# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600361def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600362 # Note: All struct types are now camel-case
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600363 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600364 char_idx = 0
365 struct_name = ''
366 for char in caps_struct_name:
367 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
368 struct_name += caps_struct_name[char_idx]
369 elif (caps_struct_name[char_idx] == '_'):
370 pass
371 else:
372 struct_name += caps_struct_name[char_idx].lower()
373 char_idx += 1
Chia-I Wu3432a0c2015-10-27 18:04:07 +0800374
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600375 return struct_name
376
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600377# class for writing common file elements
378# Here's how this class lays out a file:
379# COPYRIGHT
380# HEADER
381# BODY
382# FOOTER
383#
384# For each of these sections, there's a "set*" function
385# The class as a whole has a generate function which will write each section in order
386class CommonFileGen:
387 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
388 self.filename = filename
389 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
390 # TODO : Set a default copyright & footer at least
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600391
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600392 def setFilename(self, filename):
393 self.filename = filename
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600394
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600395 def setCopyright(self, c):
396 self.contents['copyright'] = c
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600397
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600398 def setHeader(self, h):
399 self.contents['header'] = h
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600400
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600401 def setBody(self, b):
402 self.contents['body'] = b
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600403
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600404 def setFooter(self, f):
405 self.contents['footer'] = f
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600406
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600407 def generate(self):
408 #print("Generate to file %s" % self.filename)
409 with open(self.filename, "w") as f:
410 f.write(self.contents['copyright'])
411 f.write(self.contents['header'])
412 f.write(self.contents['body'])
413 f.write(self.contents['footer'])
414
415# class for writing a wrapper class for structures
416# The wrapper class wraps the structs and includes utility functions for
417# setting/getting member values and displaying the struct data in various formats
418class StructWrapperGen:
419 def __init__(self, in_struct_dict, prefix, out_dir):
420 self.struct_dict = in_struct_dict
421 self.include_headers = []
Jon Ashburnea65e492015-08-06 17:27:49 -0600422 self.lineinfo = sourcelineinfo()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600423 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600424 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600425 self.api_prefix = "vk"
426 else:
427 self.api_prefix = prefix
428 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
429 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
430 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
431 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
432 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
433 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
434 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700435 self.no_addr = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600436 self.hfg = CommonFileGen(self.header_filename)
437 self.cfg = CommonFileGen(self.class_filename)
438 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700439 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700440 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600441 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
442 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600443 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700444 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600445 #print(self.header_filename)
446 self.header_txt = ""
447 self.definition_txt = ""
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600448
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600449 def set_include_headers(self, include_headers):
450 self.include_headers = include_headers
451
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700452 def set_no_addr(self, no_addr):
453 self.no_addr = no_addr
454 if self.no_addr:
455 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700456 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700457 else:
458 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700459 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700460
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600461 # Return class name for given struct name
462 def get_class_name(self, struct_name):
463 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
464 return class_name
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600465
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600466 def get_file_list(self):
467 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
468
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600469 # Generate class header file
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600470 def generateHeader(self):
471 self.hfg.setCopyright(self._generateCopyright())
472 self.hfg.setHeader(self._generateHeader())
473 self.hfg.setBody(self._generateClassDeclaration())
474 self.hfg.setFooter(self._generateFooter())
475 self.hfg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600476
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600477 # Generate class definition
478 def generateBody(self):
479 self.cfg.setCopyright(self._generateCopyright())
480 self.cfg.setHeader(self._generateCppHeader())
481 self.cfg.setBody(self._generateClassDefinition())
482 self.cfg.setFooter(self._generateFooter())
483 self.cfg.generate()
484
485 # Generate c-style .h file that contains functions for printing structs
486 def generateStringHelper(self):
487 print("Generating struct string helper")
488 self.shg.setCopyright(self._generateCopyright())
489 self.shg.setHeader(self._generateStringHelperHeader())
490 self.shg.setBody(self._generateStringHelperFunctions())
491 self.shg.generate()
492
Tobin Ehlis99f88672015-01-10 12:42:41 -0700493 # Generate cpp-style .h file that contains functions for printing structs
494 def generateStringHelperCpp(self):
495 print("Generating struct string helper cpp")
496 self.shcppg.setCopyright(self._generateCopyright())
497 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
498 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
499 self.shcppg.generate()
500
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700501 # Generate c-style .h file that contains functions for printing structs
502 def generateValidateHelper(self):
503 print("Generating struct validate helper")
504 self.vhg.setCopyright(self._generateCopyright())
505 self.vhg.setHeader(self._generateValidateHelperHeader())
506 self.vhg.setBody(self._generateValidateHelperFunctions())
507 self.vhg.generate()
508
Tobin Ehlis60354772015-03-12 14:50:40 -0600509 def generateSizeHelper(self):
510 print("Generating struct size helper")
511 self.size_helper_gen.setCopyright(self._generateCopyright())
512 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
513 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
514 self.size_helper_gen.generate()
515
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700516 def generateSizeHelperC(self):
517 print("Generating struct size helper c")
518 self.size_helper_c_gen.setCopyright(self._generateCopyright())
519 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
520 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
521 self.size_helper_c_gen.generate()
522
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600523 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700524 copyright = []
525 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
526 copyright.append('');
527 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600528 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700529 copyright.append(' *');
Courtney Goeltzenleuchterfcbe16f2015-10-29 13:50:34 -0600530 copyright.append(' * Copyright (C) 2015 Valive Corporation');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700531 copyright.append(' *');
532 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
533 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
534 copyright.append(' * to deal in the Software without restriction, including without limitation');
535 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
536 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
537 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
538 copyright.append(' *');
539 copyright.append(' * The above copyright notice and this permission notice shall be included');
540 copyright.append(' * in all copies or substantial portions of the Software.');
541 copyright.append(' *');
542 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
543 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
544 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
545 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
546 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
547 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
548 copyright.append(' * DEALINGS IN THE SOFTWARE.');
Jon Ashburnf2bad722015-11-03 11:57:00 -0700549 copyright.append(' *')
550 copyright.append(' * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>')
551 copyright.append(' * Author: Tobin Ehlis <tobin@lunarg.com>')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700552 copyright.append(' */');
553 copyright.append('');
554 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600555
556 def _generateCppHeader(self):
557 header = []
558 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600559 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 -0600560 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600561
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600562 def _generateClassDefinition(self):
563 class_def = []
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600564 if 'vk' == self.api:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600565 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700566 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600567 class_def.append("\n// %s class definition" % self.get_class_name(s))
568 class_def.append(self._generateConstructorDefinitions(s))
569 class_def.append(self._generateDestructorDefinitions(s))
570 class_def.append(self._generateDisplayDefinitions(s))
571 return "\n".join(class_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600572
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600573 def _generateConstructorDefinitions(self, s):
574 con_defs = []
575 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)))
576 # TODO : This is a shallow copy of ptrs
577 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]))
578 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]))
579 return "\n".join(con_defs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600580
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600581 def _generateDestructorDefinitions(self, s):
582 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600583
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600584 def _generateDynamicPrintFunctions(self):
585 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600586 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 -0600587 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600588 dp_funcs.append(" switch (sType)\n {")
589 for e in enum_type_dict:
590 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600591 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600592 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600593 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +0800594 if struct_name not in self.struct_dict:
595 continue
596
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600597 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600598 instance_name = "swc%i" % class_num
599 dp_funcs.append(" case %s:\n {" % (v))
600 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
601 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
602 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
603 dp_funcs.append(" }")
604 dp_funcs.append(" break;")
605 class_num += 1
606 dp_funcs.append(" }")
607 dp_funcs.append("}\n")
608 return "\n".join(dp_funcs)
609
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700610 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600611 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700612
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600613 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700614 return self._get_func_name(struct, 'print')
615
616 def _get_vh_func_name(self, struct):
617 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600618
Tobin Ehlis60354772015-03-12 14:50:40 -0600619 def _get_size_helper_func_name(self, struct):
620 return self._get_func_name(struct, 'size')
621
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600622 # Return elements to create formatted string for given struct member
623 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
624 struct_op = "->"
625 if not struct_ptr:
626 struct_op = "."
627 member_name = struct_member['name']
628 print_type = "p"
629 cast_type = ""
630 member_post = ""
631 array_index = ""
632 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700633 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700634 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
635 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
636 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600637 print_type = "s"
638 print_array = False
639 elif struct_member['array'] and not print_array:
640 # Just print base address of array when not full print_array
641 cast_type = "(void*)"
642 elif is_type(struct_member['type'], 'enum'):
643 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700644 if struct_member['ptr']:
645 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600646 print_type = "s"
647 elif is_type(struct_member['type'], 'struct'): # print struct address for now
648 cast_type = "(void*)"
649 if not struct_member['ptr']:
650 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -0600651 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600652 print_type = "s"
653 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700654 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600655 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600656 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
657 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700658 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600659 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600660 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700661 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
662 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600663 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 -0600664 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700665 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600666 print_type = "i"
667 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600668 pass
669 else:
670 #print("Unhandled struct type: %s" % struct_member['type'])
671 cast_type = "(void*)"
672 if print_array and struct_member['array']:
673 member_print_post = "[%u]"
674 array_index = " i,"
675 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700676 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 -0600677 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 -0700678 if self.no_addr and "p" == print_type:
679 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
680 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600681 return (print_out, print_arg)
682
683 def _generateStringHelperFunctions(self):
684 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700685 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700686 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700687 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
688 sh_funcs.append('')
689 sh_funcs.append('#if defined(_WIN32)')
690 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
691 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
692 sh_funcs.append('// work-around.')
693 sh_funcs.append('#define snprintf _snprintf')
694 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700695 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600696 p_out = ""
697 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700698 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 -0700699 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700700 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700701 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
702 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700703 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]))
704 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700705 num_stps = len(stp_list);
706 total_strlen_str = ''
707 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700708 sh_funcs.append(" char* tmpStr;")
709 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
710 sh_funcs.append(' strcpy(extra_indent, " ");')
711 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
712 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700713 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700714 # If it's an array, print all of the elements
715 # If it's a ptr, print thing it's pointing to
716 # Non-ptr struct case. Print the struct using its address
717 struct_deref = '&'
718 if 1 < stp_list[index]['full_type'].count('*'):
719 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700720 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700721 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700722 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700723 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
724 sh_funcs.append(' len = 256+strlen(tmpStr);')
725 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700726 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700727 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700728 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700729 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
730 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700731 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700732 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
733 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600734 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 -0700735 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700736 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
737 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
738 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700739 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700740 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 -0700741 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700742 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']))
743 sh_funcs.append(' }')
744 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
745 elif stp_list[index]['array']:
746 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
747 sh_funcs.append(' len = 256+strlen(tmpStr);')
748 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700749 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700750 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 -0700751 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700752 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 -0700753 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700754 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
755 sh_funcs.append(' len = 256+strlen(tmpStr);')
756 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700757 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700758 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 -0700759 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700760 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 -0700761 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700762 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
763 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700764 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600765 for m in sorted(self.struct_dict[s]):
766 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
767 p_out += p_out1
768 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600769 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700770 p_args += ");"
771 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700772 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700773 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
774 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
775 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
776 sh_funcs.append(' free(stp_strs[stp_index]);')
777 sh_funcs.append(' }')
778 sh_funcs.append(' }')
779 sh_funcs.append(' free(extra_indent);')
780 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600781 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700782 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
783 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
784 sh_funcs.append(" if (pStruct == NULL) {")
785 sh_funcs.append(" return NULL;")
786 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600787 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700788 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
789 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600790 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600791 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600792 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600793 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +0800794 if struct_name not in self.struct_dict:
795 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600796 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700797 sh_funcs.append(' case %s:\n {' % (v))
798 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
799 sh_funcs.append(' }')
800 sh_funcs.append(' break;')
801 sh_funcs.append(" default:")
802 sh_funcs.append(" return NULL;")
803 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600804 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700805 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700806
807 def _generateStringHelperFunctionsCpp(self):
808 # declare str & tmp str
809 # declare array of stringstreams for every struct ptr in current struct
810 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700811 # For every struct ptr, if non-Null, then set its string, else set to NULL str
812 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700813 # create and return final string
814 sh_funcs = []
815 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600816 # XXX - REMOVE this comment
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600817 lineinfo = sourcelineinfo()
818 sh_funcs.append('%s' % lineinfo.get())
Ian Elliottf6b168c2015-12-11 15:03:05 -0700819 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
820 'VkMirSurfaceCreateInfoKHR',
821 'VkWaylandSurfaceCreateInfoKHR',
822 'VkXlibSurfaceCreateInfoKHR']
823 if sys.platform == 'win32':
824 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
825 else:
826 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700827 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -0700828 if (typedef_fwd_dict[s] not in exclude_struct_list):
Michael Lentine33d96a32016-01-05 11:10:15 -0600829 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
830 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Ian Elliottf6b168c2015-12-11 15:03:05 -0700831 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
Michael Lentine33d96a32016-01-05 11:10:15 -0600832 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
833 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700834 sh_funcs.append('\n')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600835 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700836 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600837 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 -0700838 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 -0700839 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700840 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700841 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct') or self.struct_dict[s][m]['array']:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600842 # TODO: This is a tmp workaround
843 if 'ppActiveLayerNames' not in self.struct_dict[s][m]['name']:
844 stp_list.append(self.struct_dict[s][m])
Ian Elliottf6b168c2015-12-11 15:03:05 -0700845 if (typedef_fwd_dict[s] in exclude_struct_list):
846 continue
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600847 sh_funcs.append('%s' % lineinfo.get())
Michael Lentine33d96a32016-01-05 11:10:15 -0600848 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
849 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700850 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 -0600851 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700852 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600853 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700854 sh_funcs.append('%sstring final_str;' % (indent))
855 sh_funcs.append('%sstring tmp_str;' % (indent))
856 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700857 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700858 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700859 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600860 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700861 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700862 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700863 idx_ss_decl = False # Make sure to only decl this once
864 for index in range(num_stps):
865 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700866 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700867 addr_char = ''
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600868 if stp_list[index]['array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600869 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700870 if stp_list[index]['dyn_array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600871 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700872 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
873 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600874 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700875 array_count = '%s' % (stp_list[index]['array_size'])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600876 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700877 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
878 if not idx_ss_decl:
879 sh_funcs.append('%sstringstream index_ss;' % (indent))
880 idx_ss_decl = True
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600881 if (stp_list[index]['name'] == 'pQueueFamilyIndices'):
Ian Elliott05846062015-11-20 14:13:17 -0700882 if (typedef_fwd_dict[s] == 'VkSwapchainCreateInfoKHR'):
883 sh_funcs.append('%sif (pStruct->imageSharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent))
884 else:
885 sh_funcs.append('%sif (pStruct->sharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent))
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600886 indent += ' '
Mark Lobodzinski80971c62016-01-08 14:52:49 -0700887 if (stp_list[index]['name'] == 'pImageInfo'):
888 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER) ||' % (indent))
889 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER) ||' % (indent))
890 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) ||' % (indent))
891 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE)) {' % (indent))
892 indent += ' '
893 elif (stp_list[index]['name'] == 'pBufferInfo'):
894 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER) ||' % (indent))
895 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||' % (indent))
896 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||' % (indent))
897 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {' % (indent))
898 indent += ' '
899 elif (stp_list[index]['name'] == 'pTexelBufferView'):
900 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER) ||' % (indent))
901 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER)) {' % (indent))
902 indent += ' '
Tobin Ehlis793ad302015-04-03 12:01:11 -0600903 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
904 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700905 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600906 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700907 sh_funcs.append('%sindex_ss.str("");' % (indent))
908 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600909 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600910 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700911 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600912 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
913 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 -0700914 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 -0600915 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600916 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700917 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
918 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']))
919 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600920 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700921 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
922 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600923 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700924 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 -0600925 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600926 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600927 addr_char = ''
Courtney Goeltzenleuchter44981552015-10-23 15:48:32 -0600928 if stp_list[index]['type'] in vulkan.core.objects:
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600929 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "].handle = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
930 else:
931 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
932 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 -0600933 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700934 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600935 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700936 sh_funcs.append('%s}' % (indent))
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600937 indent = indent[4:]
938 sh_funcs.append('%s}' % (indent))
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600939 #endif
Mark Lobodzinski80971c62016-01-08 14:52:49 -0700940 if (stp_list[index]['name'] == 'pQueueFamilyIndices') or (stp_list[index]['name'] == 'pImageInfo') or (stp_list[index]['name'] == 'pBufferInfo') or (stp_list[index]['name'] == 'pTexelBufferView'):
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600941 indent = indent[4:]
942 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700943 elif (stp_list[index]['ptr']):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600944 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600945 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
946 indent += ' '
Tobin Ehlis99f88672015-01-10 12:42:41 -0700947 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600948 sh_funcs.append('%s' % lineinfo.get())
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600949 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700950 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700951 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
952 # TODO : This is a quick hack to handle these arrays of ptrs
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600953 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600954 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 -0700955 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600956 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700957 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 -0700958 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
959 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600960 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700961 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
962 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600963 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700964 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
965 sh_funcs.append(' ss[%u].str("");' % (index))
966 sh_funcs.append(' }')
967 sh_funcs.append(' else')
968 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700969 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600970 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700971 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
972 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
973 if self.no_addr:
974 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600975 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700976 else:
977 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 -0600978 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700979 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -0600980 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -0700981 index = 0
982 final_str = ''
983 for m in sorted(self.struct_dict[s]):
984 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
985 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
986 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600987 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700988 sh_funcs.append(' ss[%u].str("addr");' % (index))
989 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600990 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700991 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Jon Ashburnc669cc62015-07-09 15:02:25 -0600992 elif self.struct_dict[s][m]['array']:
993 sh_funcs.append('%s' % lineinfo.get())
994 sh_funcs.append(' ss[%u] << (void*)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700995 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600996 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700997 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700998 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600999 sh_funcs.append('%s' % lineinfo.get())
Jon Ashburnc669cc62015-07-09 15:02:25 -06001000 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -06001001 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001002 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis17f45a62015-04-28 17:27:16 -06001003 sh_funcs.append(' if (StreamControl::writeAddress)')
1004 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
1005 sh_funcs.append(' else')
1006 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis99f88672015-01-10 12:42:41 -07001007 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001008 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001009 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001010 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001011 sh_funcs.append(' ss[%u].str("addr");' % (index))
Tobin Ehlisa30e7e52015-07-06 14:02:36 -06001012 elif not self.struct_dict[s][m]['ptr'] and self.struct_dict[s][m]['type'] in vulkan.core.objects:
Chia-I Wue2fc5522015-10-26 20:04:44 +08001013 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis99f88672015-01-10 12:42:41 -07001014 else:
1015 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
1016 value_print = 'ss[%u].str()' % index
1017 index += 1
1018 else:
Tobin Ehlisce320942015-06-11 09:37:00 -06001019 # 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 -07001020 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001021 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -06001022 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
1023 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
1024 sh_funcs.append(' else')
1025 sh_funcs.append(' ss[%u].str("NULL");' % (index))
1026 value_print = 'ss[%u].str()' % index
1027 index += 1
1028 # For single enum just print the string representation
1029 else:
1030 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 -07001031 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
1032 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001033 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -07001034 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001035 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001036 sh_funcs.append(' final_str = %s;' % final_str)
1037 sh_funcs.append(' return final_str;\n}')
Michael Lentine33d96a32016-01-05 11:10:15 -06001038 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1039 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis291cd702015-01-20 09:48:48 -07001040 # Add function to return a string value for input void*
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001041 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -07001042 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001043 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -07001044 sh_funcs.append(" stringstream ss;")
1045 sh_funcs.append(' ss << toString;')
1046 sh_funcs.append(' string final_str = prefix + ss.str();')
1047 sh_funcs.append(" return final_str;")
1048 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001049 sh_funcs.append('%s' % lineinfo.get())
Tony Barbourb5d2c942015-07-14 13:34:05 -06001050 # Add function to return a string value for input uint64_t
1051 sh_funcs.append("string string_convert_helper(const uint64_t toString, const string prefix)\n{")
Tobin Ehlis08541742015-04-16 15:56:11 -06001052 sh_funcs.append(" using namespace StreamControl;")
1053 sh_funcs.append(" stringstream ss;")
1054 sh_funcs.append(' ss << toString;')
1055 sh_funcs.append(' string final_str = prefix + ss.str();')
1056 sh_funcs.append(" return final_str;")
1057 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001058 sh_funcs.append('%s' % lineinfo.get())
Ian Elliott7e40db92015-08-21 15:09:33 -06001059 # Add function to return a string value for input VkSurfaceFormatKHR*
1060 sh_funcs.append("string string_convert_helper(VkSurfaceFormatKHR toString, const string prefix)\n{")
1061 sh_funcs.append(' string final_str = prefix + "format = " + string_VkFormat(toString.format) + "format = " + string_VkColorSpaceKHR(toString.colorSpace);')
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001062 sh_funcs.append(" return final_str;")
1063 sh_funcs.append("}")
1064 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001065 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001066 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001067 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -07001068 sh_funcs.append(" if (pStruct == NULL) {\n")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001069 sh_funcs.append(" return string();")
Ian Elliott82800022015-02-25 17:40:38 -07001070 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001071 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001072 sh_funcs.append(' string indent = " ";')
1073 sh_funcs.append(' indent += prefix;')
1074 sh_funcs.append(" switch (sType)\n {")
1075 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001076 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001077 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001078 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001079 if struct_name not in self.struct_dict:
1080 continue
Tobin Ehlis99f88672015-01-10 12:42:41 -07001081 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001082 #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 -07001083 sh_funcs.append(' case %s:\n {' % (v))
1084 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
1085 sh_funcs.append(' }')
1086 sh_funcs.append(' break;')
1087 sh_funcs.append(" default:")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001088 sh_funcs.append(" return string();")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001089 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001090 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001091 sh_funcs.append("}")
1092 return "\n".join(sh_funcs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001093
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001094 def _genStructMemberPrint(self, member, s, array, struct_array):
1095 (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)
1096 extra_indent = ""
1097 if array:
1098 extra_indent = " "
1099 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
1100 struct_array.insert(0, self.struct_dict[s][member])
1101 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001102 # Special case for void* named "pNext"
1103 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001104 struct_array.insert(0, self.struct_dict[s][member])
1105 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
1106
1107 def _generateDisplayDefinitions(self, s):
1108 disp_def = []
1109 struct_array = []
1110 # Single-line struct print function
1111 disp_def.append("// Output 'structname = struct_address' on a single line")
1112 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
1113 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1114 disp_def.append("}\n")
1115 # Private helper function to print struct members
1116 disp_def.append("// Private helper function that displays the members of the wrapped struct")
1117 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
1118 i_declared = False
1119 for member in sorted(self.struct_dict[s]):
1120 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001121 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001122 # Can grab struct type off of header of struct pointed to
1123 # TODO : Handle Arrays
1124 if self.struct_dict[s][member]['array']:
1125 # Create for loop to print each element of array
1126 if not i_declared:
1127 disp_def.append(' uint32_t i;')
1128 i_declared = True
1129 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
1130 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
1131 disp_def.append(return_str)
1132 disp_def.append(' }')
1133 else:
1134 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
1135 disp_def.append(return_str)
1136 disp_def.append("}\n")
1137 i_declared = False
1138 # Basic print function to display struct members
1139 disp_def.append("// Output all struct elements, each on their own line")
1140 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
1141 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1142 disp_def.append(' this->display_struct_members();')
1143 disp_def.append("}\n")
1144 # Advanced print function to display current struct and contents of any pointed-to structs
1145 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1146 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1147 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1148 disp_def.append(' this->display_struct_members();')
1149 class_num = 0
1150 # TODO : Need to handle arrays of structs here
1151 for ms in struct_array:
1152 swc_name = "class%s" % str(class_num)
1153 if ms['array']:
1154 if not i_declared:
1155 disp_def.append(' uint32_t i;')
1156 i_declared = True
1157 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1158 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1159 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1160 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1161 disp_def.append(" %s.display_full_txt();" % (swc_name))
1162 #disp_def.append(' }')
1163 disp_def.append(' }')
1164 elif 'pNext' == ms['name']:
1165 # Need some code trickery here
1166 # I'm thinking have a generated function that takes pNext ptr value
1167 # then it checks sType and in large switch statement creates appropriate
1168 # wrapper class type and then prints contents
1169 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1170 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1171 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1172 disp_def.append(" }")
1173 else:
1174 if ms['ptr']:
1175 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1176 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1177 else:
1178 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1179 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1180 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1181 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1182 class_num += 1
1183 disp_def.append("}\n")
1184 return "\n".join(disp_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001185
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001186 def _generateStringHelperHeader(self):
1187 header = []
1188 header.append("//#includes, #defines, globals and such...\n")
1189 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001190 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001191 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001192 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001193 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001194 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001195
1196 def _generateStringHelperHeaderCpp(self):
1197 header = []
1198 header.append("//#includes, #defines, globals and such...\n")
1199 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001200 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001201 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001202 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001203 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001204 header.append('\n')
1205 header.append('namespace StreamControl\n')
1206 header.append('{\n')
1207 header.append('bool writeAddress = true;\n')
1208 header.append('template <typename T>\n')
1209 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1210 header.append('{\n')
1211 header.append(' if(writeAddress)\n')
1212 header.append(' {\n')
1213 header.append(' out.operator<<(pointer);\n')
1214 header.append(' }\n')
1215 header.append(' else\n')
1216 header.append(' {\n')
1217 header.append(' std::operator<<(out, "address");\n')
1218 header.append(' }\n')
1219 header.append(' return out;\n')
1220 header.append('}\n')
1221 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1222 header.append('{\n')
1223 header.append(' return std::operator<<(out, s);\n')
1224 header.append('}\n')
1225 header.append('}\n')
1226 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001227 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001228 return "".join(header)
1229
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001230 def _generateValidateHelperFunctions(self):
1231 sh_funcs = []
1232 # We do two passes, first pass just generates prototypes for all the functsions
Ian Elliottf6b168c2015-12-11 15:03:05 -07001233 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
1234 'VkMirSurfaceCreateInfoKHR',
1235 'VkWaylandSurfaceCreateInfoKHR',
1236 'VkXlibSurfaceCreateInfoKHR']
1237 if sys.platform == 'win32':
1238 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
1239 else:
1240 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001241 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -07001242 if (typedef_fwd_dict[s] not in exclude_struct_list):
Michael Lentine33d96a32016-01-05 11:10:15 -06001243 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1244 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Ian Elliottf6b168c2015-12-11 15:03:05 -07001245 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
Michael Lentine33d96a32016-01-05 11:10:15 -06001246 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1247 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001248 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001249 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -07001250 if (typedef_fwd_dict[s] in exclude_struct_list):
1251 continue
Michael Lentine33d96a32016-01-05 11:10:15 -06001252 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1253 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001254 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1255 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001256 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001257 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 -07001258 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 -07001259 # 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 -07001260 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1261 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001262 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 -07001263 else:
1264 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 -07001265 sh_funcs.append(" return 1;\n}")
Michael Lentine33d96a32016-01-05 11:10:15 -06001266 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1267 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001268
1269 return "\n".join(sh_funcs)
1270
1271 def _generateValidateHelperHeader(self):
1272 header = []
1273 header.append("//#includes, #defines, globals and such...\n")
1274 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001275 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001276 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001277 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001278 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001279 return "".join(header)
1280
Tobin Ehlis60354772015-03-12 14:50:40 -06001281 def _generateSizeHelperFunctions(self):
1282 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001283 # just generates prototypes for all the functions
Ian Elliottf6b168c2015-12-11 15:03:05 -07001284 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
1285 'VkMirSurfaceCreateInfoKHR',
1286 'VkWaylandSurfaceCreateInfoKHR',
1287 'VkXlibSurfaceCreateInfoKHR']
1288 if sys.platform == 'win32':
1289 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
1290 else:
1291 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001292 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -07001293 if (typedef_fwd_dict[s] not in exclude_struct_list):
Michael Lentine33d96a32016-01-05 11:10:15 -06001294 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1295 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Ian Elliottf6b168c2015-12-11 15:03:05 -07001296 sh_funcs.append('size_t %s(const %s* pStruct);' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
Michael Lentine33d96a32016-01-05 11:10:15 -06001297 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1298 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001299 return "\n".join(sh_funcs)
1300
1301
1302 def _generateSizeHelperFunctionsC(self):
1303 sh_funcs = []
1304 # generate function definitions
Jon Ashburn81b1d9c2015-12-29 14:21:25 -07001305 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
1306 'VkMirSurfaceCreateInfoKHR',
1307 'VkWaylandSurfaceCreateInfoKHR',
1308 'VkXlibSurfaceCreateInfoKHR']
1309 if sys.platform == 'win32':
1310 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
1311 else:
1312 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001313 for s in sorted(self.struct_dict):
Jon Ashburn81b1d9c2015-12-29 14:21:25 -07001314 if (typedef_fwd_dict[s] in exclude_struct_list):
1315 continue
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001316 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001317 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1318 indent = ' '
1319 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1320 sh_funcs.append('%sif (pStruct) {' % (indent))
1321 indent = ' '
1322 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1323 i_decl = False
1324 for m in sorted(self.struct_dict[s]):
1325 if m in skip_list:
1326 continue
1327 if self.struct_dict[s][m]['dyn_array']:
1328 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1329 if not is_type(self.struct_dict[s][m]['type'], 'struct') and not 'char' in self.struct_dict[s][m]['type'].lower():
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001330 if 'ppMemoryBarriers' == self.struct_dict[s][m]['name']:
Tobin Ehlis04112922015-03-16 10:44:40 -06001331 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001332 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 -06001333 else:
1334 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 -06001335 else: # This is an array of char* or array of struct ptrs
1336 if not i_decl:
1337 sh_funcs.append('%suint32_t i = 0;' % (indent))
1338 i_decl = True
1339 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1340 indent = ' '
1341 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1342 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']))
1343 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001344 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 -06001345 indent = ' '
1346 sh_funcs.append('%s}' % (indent))
1347 else:
1348 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1349 if not i_decl:
1350 sh_funcs.append('%suint32_t i = 0;' % (indent))
1351 i_decl = True
1352 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1353 indent = ' '
1354 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']))
1355 indent = ' '
1356 sh_funcs.append('%s}' % (indent))
1357 else:
1358 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1359 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1360 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001361 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 -06001362 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1363 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 -06001364 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Jon Ashburn81b1d9c2015-12-29 14:21:25 -07001365 if (self.struct_dict[s][m]['type'] != 'xcb_connection_t'):
1366 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
Tobin Ehlis60354772015-03-12 14:50:40 -06001367 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1368 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1369 skip_list.append(m+1)
1370 indent = ' '
1371 sh_funcs.append('%s}' % (indent))
1372 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001373 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
Ian Elliottba042332015-11-18 14:57:08 -07001374 if '_debug_' not in self.header_filename:
Jon Ashburnea65e492015-08-06 17:27:49 -06001375 for follow_chain in [True, False]:
1376 sh_funcs.append('%s' % self.lineinfo.get())
1377 if follow_chain:
1378 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1379 else:
1380 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1381 indent = ' '
1382 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1383 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
1384 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1385 if follow_chain:
1386 sh_funcs.append('%swhile (pNext) {' % (indent))
1387 indent = ' '
1388 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1389 indent += ' '
1390 for e in enum_type_dict:
1391 if 'StructureType' in e:
1392 for v in sorted(enum_type_dict[e]):
1393 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001394 if struct_name not in self.struct_dict:
1395 continue
1396
Jon Ashburnea65e492015-08-06 17:27:49 -06001397 sh_funcs.append('%scase %s:' % (indent, v))
1398 sh_funcs.append('%s{' % (indent))
1399 indent += ' '
1400 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1401 sh_funcs.append('%sbreak;' % (indent))
1402 indent = indent[:-4]
1403 sh_funcs.append('%s}' % (indent))
1404 sh_funcs.append('%sdefault:' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001405 indent += ' '
Jon Ashburnea65e492015-08-06 17:27:49 -06001406 sh_funcs.append('%sassert(0);' % (indent))
1407 sh_funcs.append('%sstructSize += 0;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001408 indent = indent[:-4]
Tobin Ehlis04112922015-03-16 10:44:40 -06001409 indent = indent[:-4]
1410 sh_funcs.append('%s}' % (indent))
Jon Ashburnea65e492015-08-06 17:27:49 -06001411 if follow_chain:
1412 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
1413 indent = indent[:-4]
1414 sh_funcs.append('%s}' % (indent))
1415 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001416 return "\n".join(sh_funcs)
1417
1418 def _generateSizeHelperHeader(self):
1419 header = []
1420 header.append("//#includes, #defines, globals and such...\n")
1421 for f in self.include_headers:
1422 header.append("#include <%s>\n" % f)
1423 header.append('\n// Function Prototypes\n')
1424 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001425 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001426 return "".join(header)
1427
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001428 def _generateSizeHelperHeaderC(self):
1429 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001430 header.append('#include "vk_struct_size_helper.h"')
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -07001431 header.append('#include "vulkan/vk_ext_debug_report.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001432 header.append('#include <string.h>')
1433 header.append('#include <assert.h>')
1434 header.append('\n// Function definitions\n')
1435 return "\n".join(header)
1436
1437
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001438 def _generateHeader(self):
1439 header = []
1440 header.append("//#includes, #defines, globals and such...\n")
1441 for f in self.include_headers:
1442 header.append("#include <%s>\n" % f)
1443 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001444
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001445 # Declarations
1446 def _generateConstructorDeclarations(self, s):
1447 constructors = []
1448 constructors.append(" %s();\n" % self.get_class_name(s))
1449 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1450 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1451 return "".join(constructors)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001452
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001453 def _generateDestructorDeclarations(self, s):
1454 return " virtual ~%s();\n" % self.get_class_name(s)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001455
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001456 def _generateDisplayDeclarations(self, s):
1457 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001458
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001459 def _generateGetSetDeclarations(self, s):
1460 get_set = []
1461 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1462 for member in sorted(self.struct_dict[s]):
1463 # TODO : Skipping array set/get funcs for now
1464 if self.struct_dict[s][member]['array']:
1465 continue
1466 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']))
1467 if not self.struct_dict[s][member]['const']:
1468 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']))
1469 return "".join(get_set)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001470
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001471 def _generatePrivateMembers(self, s):
1472 priv = []
1473 priv.append("\nprivate:\n")
1474 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1475 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1476 priv.append(" uint32_t m_indent;\n")
1477 priv.append(" const char m_dummy_prefix;\n")
1478 priv.append(" void display_struct_members();\n")
1479 return "".join(priv)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001480
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001481 def _generateClassDeclaration(self):
1482 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001483 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001484 class_decl.append("\n//class declaration")
1485 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1486 class_decl.append(self._generateConstructorDeclarations(s))
1487 class_decl.append(self._generateDestructorDeclarations(s))
1488 class_decl.append(self._generateDisplayDeclarations(s))
1489 class_decl.append(self._generateGetSetDeclarations(s))
1490 class_decl.append(self._generatePrivateMembers(s))
1491 class_decl.append("};\n")
1492 return "\n".join(class_decl)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001493
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001494 def _generateFooter(self):
1495 return "\n//any footer info for class\n"
1496
1497class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001498 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 -06001499 self.et_dict = enum_type_dict
1500 self.ev_dict = enum_val_dict
1501 self.tf_dict = typedef_fwd_dict
1502 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001503 self.out_sh_file = out_sh_file
1504 self.eshfg = CommonFileGen(self.out_sh_file)
1505 self.out_vh_file = out_vh_file
1506 self.evhfg = CommonFileGen(self.out_vh_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001507
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001508 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001509 self.eshfg.setHeader(self._generateSHHeader())
1510 self.eshfg.setBody(self._generateSHBody())
1511 self.eshfg.generate()
1512
1513 def generateEnumValidate(self):
1514 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001515 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001516 self.evhfg.generate()
1517
1518 def _generateVHBody(self):
1519 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001520 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001521 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001522 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1523 # 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 -06001524 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001525 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1526 body.append(' return 0;')
1527 body.append(' return 1;')
1528 body.append('}\n\n')
1529 else:
1530 body.append(' switch ((%s)input_value)\n {' % (fet))
1531 for e in sorted(self.et_dict[bet]):
1532 if (self.ev_dict[e]['unique']):
1533 body.append(' case %s:' % (e))
1534 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001535 return "\n".join(body)
1536
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001537 def _generateSHBody(self):
1538 body = []
1539# with open(self.out_file, "a") as hf:
1540 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001541 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001542 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001543 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 -06001544 for e in sorted(self.et_dict[bet]):
1545 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001546 body.append(' case %s:\n return "%s";' % (e, e))
1547 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001548 return "\n".join(body)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001549
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001550 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001551 header = []
1552 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001553 header.append('#ifdef _WIN32\n')
1554 header.append('#pragma warning( disable : 4065 )\n')
1555 header.append('#endif\n')
David Pinedo9316d3b2015-11-06 12:54:48 -07001556 header.append('#include <vulkan/%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001557 return "\n".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001558
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001559
1560class CMakeGen:
1561 def __init__(self, struct_wrapper=None, out_dir=None):
1562 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001563 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001564 self.add_lib_file_list = self.sw.get_file_list()
1565 self.out_dir = out_dir
1566 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1567 self.cmg = CommonFileGen(self.out_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001568
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001569 def generate(self):
1570 self.cmg.setBody(self._generateBody())
1571 self.cmg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001572
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001573 def _generateBody(self):
1574 body = []
1575 body.append("project(%s)" % os.path.basename(self.out_dir))
1576 body.append("cmake_minimum_required(VERSION 2.8)\n")
1577 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1578 body.append('set(COMPILE_FLAGS "-fpermissive")')
1579 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1580 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1581 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1582 return "\n".join(body)
1583
1584class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001585 def __init__(self, struct_dict, prefix, out_dir):
1586 self.struct_dict = struct_dict
1587 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001588 if prefix == "vulkan":
1589 self.api_prefix = "vk"
1590 else:
1591 self.api_prefix = prefix
1592 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001593 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001594
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001595 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001596 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001597 self.gvg.setHeader(self._generateHeader())
1598 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001599 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001600 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001601
1602 def set_include_headers(self, include_headers):
1603 self.include_headers = include_headers
1604
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001605 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001606 header = []
1607 header.append("//#includes, #defines, globals and such...\n")
1608 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001609 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001610 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001611 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001612 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001613 return "".join(header)
1614
1615 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001616 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001617
1618 # Return elements to create formatted string for given struct member
1619 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=""):
1620 struct_op = "->"
1621 pre_var_name = '"%s "' % struct_member['full_type']
1622 if not struct_ptr:
1623 struct_op = "."
1624 member_name = struct_member['name']
1625 print_type = "p"
1626 cast_type = ""
1627 member_post = ""
1628 array_index = ""
1629 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001630 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001631 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1632 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001633 print_array = False
1634 elif struct_member['array'] and not print_array:
1635 # Just print base address of array when not full print_array
1636 cast_type = "(void*)"
1637 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001638 if struct_member['ptr']:
1639 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001640 cast_type = "string_%s" % struct_member['type']
1641 print_type = "s"
1642 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1643 cast_type = "(void*)"
1644 if not struct_member['ptr']:
1645 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -06001646 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis83562882014-11-27 15:43:39 -07001647 print_type = "s"
1648 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001649 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001650 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001651 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1652 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001653 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001654 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001655 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001656 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1657 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001658 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 -07001659 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001660 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001661 print_type = "i"
1662 elif struct_member['ptr']:
1663 pass
1664 else:
1665 #print("Unhandled struct type: %s" % struct_member['type'])
1666 cast_type = "(void*)"
1667 if print_array and struct_member['array']:
1668 member_print_post = "[%u]"
1669 array_index = " i,"
1670 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001671 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 -06001672 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 -07001673 return (print_out, print_arg)
1674
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001675 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001676 gv_funcs = []
1677 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001678 array_func_list.append('vkbufferviewattachinfo')
1679 array_func_list.append('vkimageviewattachinfo')
1680 array_func_list.append('vksamplerimageviewinfo')
1681 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001682 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001683 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001684 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1685 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001686 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001687 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]))
1688 else:
1689 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 -07001690 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001691 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001692 p_out = ""
1693 p_args = ""
1694 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1695 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1696 pl_dict = {}
1697 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001698 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001699 for m in sorted(self.struct_dict[s]):
1700 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1701 stp_list.append(self.struct_dict[s][m])
1702 if 'pNext' == self.struct_dict[s][m]['name']:
1703 pl_dict[m] = ' PORT=\\"pNext\\"'
1704 else:
1705 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1706 struct_num += 1
1707 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]))
1708 num_stps = len(stp_list);
1709 total_strlen_str = ''
1710 if 0 != num_stps:
1711 gv_funcs.append(" char* tmpStr;\n")
1712 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001713 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1714 for index in range(num_stps):
1715 if (stp_list[index]['ptr']):
1716 if 'pDescriptorInfo' == stp_list[index]['name']:
1717 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1718 else:
1719 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1720 if 'pNext' == stp_list[index]['name']:
1721 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001722 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001723 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1724 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1725 gv_funcs.append(' free(tmpStr);\n')
1726 else:
1727 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 -06001728 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001729 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 -07001730 else:
1731 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1732 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1733 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1734 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001735 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001736 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1737 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1738 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1739 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1740 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1741 else:
1742 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1743 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1744 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1745 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1746 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1747 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1748 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1749 p_args = ", myNodeName, myNodeName, pStruct"
1750 for m in sorted(self.struct_dict[s]):
1751 plabel = ""
1752 if m in pl_dict:
1753 plabel = pl_dict[m]
1754 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1755 p_out += p_out1
1756 p_args += p_args1
1757 p_out += '</TABLE>>\\n];\\n\\n"'
1758 p_args += ");\n"
1759 gv_funcs.append(p_out)
1760 gv_funcs.append(p_args)
1761 if 0 != num_stps:
1762 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1763 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1764 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1765 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1766 gv_funcs.append(' }\n')
1767 gv_funcs.append(' }\n')
1768 gv_funcs.append(" return str;\n}\n")
1769 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001770 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001771 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001772 ptr_array = True
1773 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]))
1774 else:
1775 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 -07001776 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1777 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')
1778 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1779 gv_funcs.append(' sprintf(tmpStr, "');
1780 p_args = ""
1781 p_out = ""
1782 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07001783 plabel = ""
1784 (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 -07001785 if 0 == m: # Add array index notation at end of first row
1786 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 -07001787 p_args1 += ', i, i'
1788 p_out += p_out1
1789 p_args += p_args1
1790 p_out += '"'
1791 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001792 if ptr_array:
1793 p_args = p_args.replace('->', '[i]->')
1794 else:
1795 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07001796 gv_funcs.append(p_out);
1797 gv_funcs.append(p_args);
1798 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1799 gv_funcs.append(' }\n')
1800 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001801 gv_funcs.append(' return str;\n}\n')
1802 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001803 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001804 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001805 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001806 gv_funcs.append(" switch (sType)\n {\n")
1807 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001808 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07001809 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001810 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001811 if struct_name not in self.struct_dict:
1812 continue
1813
Tobin Ehlis83562882014-11-27 15:43:39 -07001814 print_func_name = self._get_gv_func_name(struct_name)
1815 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001816 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001817 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001818 if 'VkSemaphoreCreateInfo' in struct_name:
1819 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001820 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001821 elif 'VkSemaphoreOpenInfo' in struct_name:
1822 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001823 print_func_name = self._get_gv_func_name(struct_name)
1824 gv_funcs.append(' case %s:\n' % (v))
1825 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1826 #gv_funcs.append(' }\n')
1827 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08001828 gv_funcs.append(" default:\n")
1829 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001830 gv_funcs.append(" }\n")
1831 gv_funcs.append("}")
1832 return "".join(gv_funcs)
1833
1834
1835
1836
1837
1838# def _generateHeader(self):
1839# hdr = []
1840# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1841# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1842# hdr.append('edge [\n];\n')
1843# return "\n".join(hdr)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001844#
Tobin Ehlis83562882014-11-27 15:43:39 -07001845# def _generateBody(self):
1846# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001847# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001848# field_num = 1
1849# 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]))
1850# for m in sorted(self.struc_dict[s]):
1851# 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']))
1852# field_num += 2
1853# body.append('</TABLE>>\n];\n')
1854# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001855
1856def main(argv=None):
1857 opts = handle_args()
1858 # Parse input file and fill out global dicts
1859 hfp = HeaderFileParser(opts.input_file)
1860 hfp.parse()
1861 # TODO : Don't want these to be global, see note at top about wrapper classes
1862 global enum_val_dict
1863 global enum_type_dict
1864 global struct_dict
1865 global typedef_fwd_dict
1866 global typedef_rev_dict
1867 global types_dict
1868 enum_val_dict = hfp.get_enum_val_dict()
1869 enum_type_dict = hfp.get_enum_type_dict()
1870 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07001871 # 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 -06001872 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1873 typedef_rev_dict = hfp.get_typedef_rev_dict()
1874 types_dict = hfp.get_types_dict()
1875 #print(enum_val_dict)
1876 #print(typedef_dict)
1877 #print(struct_dict)
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001878 input_header = os.path.basename(opts.input_file)
1879 if 'vulkan.h' == input_header:
1880 input_header = "vulkan/vulkan.h"
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001881 prefix = os.path.basename(opts.input_file).strip(".h")
1882 if prefix == "vulkan":
1883 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001884 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001885 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001886 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001887 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001888 enum_sh_filename = os.path.abspath(enum_sh_filename)
1889 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1890 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1891 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001892 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001893 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001894 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001895 print("Generating enum validate helper to %s" % enum_vh_filename)
1896 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 -06001897 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001898 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001899 #for struct in struct_dict:
1900 #print(struct)
1901 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001902 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 -06001903 #print(sw.get_class_name(struct))
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001904 sw.set_include_headers([input_header,os.path.basename(enum_sh_filename),"stdint.h","inttypes.h", "stdio.h","stdlib.h"])
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001905 print("Generating struct wrapper header to %s" % sw.header_filename)
1906 sw.generateHeader()
1907 print("Generating struct wrapper class to %s" % sw.class_filename)
1908 sw.generateBody()
1909 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001910 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07001911 # Generate a 2nd helper file that excludes addrs
1912 sw.set_no_addr(True)
1913 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07001914 sw.set_no_addr(False)
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001915 sw.set_include_headers([input_header,os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h","iostream","sstream","string"])
Tobin Ehlis99f88672015-01-10 12:42:41 -07001916 sw.set_no_addr(True)
1917 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001918 sw.set_no_addr(False)
1919 sw.generateStringHelperCpp()
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001920 sw.set_include_headers(["stdio.h", "stdlib.h", input_header])
Tobin Ehlis60354772015-03-12 14:50:40 -06001921 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001922 sw.generateSizeHelperC()
Jon Ashburnea65e492015-08-06 17:27:49 -06001923 if opts.gen_struct_sizes:
1924 st = StructWrapperGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001925 st.set_include_headers(["stdio.h", "stdlib.h", input_header])
Jon Ashburnea65e492015-08-06 17:27:49 -06001926 st.generateSizeHelper()
1927 st.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001928 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001929 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001930 cmg.generate()
1931 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001932 gv = GraphVizGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001933 gv.set_include_headers([input_header,os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h", "inttypes.h"])
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001934 gv.generate()
1935 print("DONE!")
1936 #print(typedef_rev_dict)
1937 #print(types_dict)
1938 #recreate_structs()
1939
1940if __name__ == "__main__":
1941 sys.exit(main())