blob: 92a21c08e1a4523bdc7a51b024fb799b97f2dccb [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
Tobin Ehlisa30e7e52015-07-06 14:02:36 -060029import vulkan
Tobin Ehlis08fafd02015-06-12 12:49:01 -060030from source_line_info import sourcelineinfo
Tobin Ehlis6442dca2014-10-22 15:13:53 -060031
Tobin Ehlis08fafd02015-06-12 12:49:01 -060032# vk_helper.py overview
33# This script generates code based on vulkan input header
34# It generate wrappers functions that can be used to display
Tobin Ehlis6442dca2014-10-22 15:13:53 -060035# structs in a human-readable txt format, as well as utility functions
36# to print enum values as strings
37
Tobin Ehlis6442dca2014-10-22 15:13:53 -060038def handle_args():
39 parser = argparse.ArgumentParser(description='Perform analysis of vogl trace.')
40 parser.add_argument('input_file', help='The input header file from which code will be generated.')
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060041 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 -060042 parser.add_argument('--abs_out_dir', required=False, default=None, help='Absolute path to write output files. Will be created if needed.')
43 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.')
44 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 -060045 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 -060046 parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.')
47 parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.')
48 #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.')
49 return parser.parse_args()
50
51# TODO : Ideally these data structs would be opaque to user and could be wrapped
52# in their own class(es) to make them friendly for data look-up
53# Dicts for Data storage
54# enum_val_dict[value_name] = dict keys are the string enum value names for all enums
55# |-------->['type'] = the type of enum class into which the value falls
56# |-------->['val'] = the value assigned to this particular value_name
57# '-------->['unique'] = bool designating if this enum 'val' is unique within this enum 'type'
58enum_val_dict = {}
59# enum_type_dict['type'] = the type or class of of enum
60# '----->['val_name1', 'val_name2'...] = each type references a list of val_names within this type
61enum_type_dict = {}
62# struct_dict['struct_basename'] = the base (non-typedef'd) name of the struct
63# |->[<member_num>] = members are stored via their integer placement in the struct
64# | |->['name'] = string name of this struct member
65# ... |->['full_type'] = complete type qualifier for this member
66# |->['type'] = base type for this member
67# |->['ptr'] = bool indicating if this member is ptr
68# |->['const'] = bool indicating if this member is const
69# |->['struct'] = bool indicating if this member is a struct type
70# |->['array'] = bool indicating if this member is an array
Tobin Ehlisbd6a9162015-03-13 07:18:05 -060071# |->['dyn_array'] = bool indicating if member is a dynamically sized array
72# '->['array_size'] = For dyn_array, member name used to size array, else int size for static array
Tobin Ehlis6442dca2014-10-22 15:13:53 -060073struct_dict = {}
74# typedef_fwd_dict stores mapping from orig_type_name -> new_type_name
75typedef_fwd_dict = {}
76# typedef_rev_dict stores mapping from new_type_name -> orig_type_name
77typedef_rev_dict = {} # store new_name -> orig_name mapping
78# types_dict['id_name'] = identifier name will map to it's type
79# '---->'type' = currently either 'struct' or 'enum'
80types_dict = {} # store orig_name -> type mapping
81
82
83# Class that parses header file and generates data structures that can
84# Then be used for other tasks
85class HeaderFileParser:
86 def __init__(self, header_file=None):
87 self.header_file = header_file
88 # store header data in various formats, see above for more info
89 self.enum_val_dict = {}
90 self.enum_type_dict = {}
91 self.struct_dict = {}
92 self.typedef_fwd_dict = {}
93 self.typedef_rev_dict = {}
94 self.types_dict = {}
Tobin Ehlis5178bd72015-03-06 10:38:25 -070095 self.last_struct_count_name = ''
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060096
Tobin Ehlis6442dca2014-10-22 15:13:53 -060097 def setHeaderFile(self, header_file):
98 self.header_file = header_file
99
100 def get_enum_val_dict(self):
101 return self.enum_val_dict
102
103 def get_enum_type_dict(self):
104 return self.enum_type_dict
105
106 def get_struct_dict(self):
107 return self.struct_dict
108
109 def get_typedef_fwd_dict(self):
110 return self.typedef_fwd_dict
111
112 def get_typedef_rev_dict(self):
113 return self.typedef_rev_dict
114
115 def get_types_dict(self):
116 return self.types_dict
117
118 # Parse header file into data structures
119 def parse(self):
120 # parse through the file, identifying different sections
121 parse_enum = False
122 parse_struct = False
123 member_num = 0
124 # TODO : Comment parsing is very fragile but handles 2 known files
125 block_comment = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700126 prev_count_name = ''
Ian Elliott7e40db92015-08-21 15:09:33 -0600127 exclude_struct_list = ['VkPlatformHandleXcbKHR', 'VkPlatformHandleX11KHR']
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600128 with open(self.header_file) as f:
129 for line in f:
130 if block_comment:
131 if '*/' in line:
132 block_comment = False
133 continue
134 if '/*' in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600135 if '*/' in line: # single line block comment
136 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600137 block_comment = True
138 elif 0 == len(line.split()):
139 #print("Skipping empty line")
140 continue
141 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700142 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600143 continue
144 elif 'typedef enum' in line:
145 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
146 #print("Found ENUM type %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600147 if '{' == base_type:
148 base_type = 'tmp_enum'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600149 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700150 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600151 self.types_dict[base_type] = 'enum'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600152 elif 'typedef struct' in line or 'typedef union' in line:
Jon Ashburnea65e492015-08-06 17:27:49 -0600153 if True in [ex_type in line for ex_type in exclude_struct_list]:
154 continue
Chia-I Wu44c99b62015-10-27 19:55:29 +0800155
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600156 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
Chia-I Wu44c99b62015-10-27 19:55:29 +0800157 if ' ' in base_type:
158 (ignored, base_type) = base_type.strip().split(None, 1)
159
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600160 #print("Found STRUCT type: %s" % base_type)
Cody Northrop22b7fae2015-08-11 11:21:48 -0600161 # Note: This really needs to be updated to handle one line struct definition, like
162 # typedef struct obj##_T { uint64_t handle; } obj;
163 if ('{' == base_type or not (' ' in base_type)):
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600164 base_type = 'tmp_struct'
Cody Northrop22b7fae2015-08-11 11:21:48 -0600165 parse_struct = True
166 self.types_dict[base_type] = 'struct'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600167# elif 'typedef union' in line:
168# (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
169# print("Found UNION type: %s" % base_type)
170# parse_struct = True
171# self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600172 elif '}' in line and (parse_enum or parse_struct):
173 if len(line.split()) > 1: # deals with embedded union in one struct
174 parse_enum = False
175 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700176 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600177 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600178 (cur_char, targ_type) = line.strip().split(None, 1)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600179 if 'tmp_struct' == base_type:
180 base_type = targ_type.strip(';')
Ian Elliott7e40db92015-08-21 15:09:33 -0600181 if True in [ex_type in base_type for ex_type in exclude_struct_list]:
182 del self.struct_dict['tmp_struct']
183 continue
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600184 #print("Found Actual Struct type %s" % base_type)
185 self.struct_dict[base_type] = self.struct_dict['tmp_struct']
186 self.struct_dict.pop('tmp_struct', 0)
187 self.types_dict[base_type] = 'struct'
188 self.types_dict.pop('tmp_struct', 0)
189 elif 'tmp_enum' == base_type:
190 base_type = targ_type.strip(';')
191 #print("Found Actual ENUM type %s" % base_type)
192 for n in self.enum_val_dict:
193 if 'tmp_enum' == self.enum_val_dict[n]['type']:
194 self.enum_val_dict[n]['type'] = base_type
195# self.enum_val_dict[base_type] = self.enum_val_dict['tmp_enum']
196# self.enum_val_dict.pop('tmp_enum', 0)
197 self.enum_type_dict[base_type] = self.enum_type_dict['tmp_enum']
198 self.enum_type_dict.pop('tmp_enum', 0)
199 self.types_dict[base_type] = 'enum'
200 self.types_dict.pop('tmp_enum', 0)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600201 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
202 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600203 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600204 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600205 #if 'VK_MAX_ENUM' not in line and '{' not in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600206 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 -0700207 self._add_enum(line, base_type, default_enum_val)
208 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600209 elif parse_struct:
210 if ';' in line:
211 self._add_struct(line, base_type, member_num)
212 member_num = member_num + 1
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600213
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600214 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700215 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600216 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700217 if '=' in line_txt:
218 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
219 else:
220 enum_name = line_txt.split(',')[0]
221 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600222 self.enum_val_dict[enum_name] = {}
223 self.enum_val_dict[enum_name]['type'] = enum_type
224 # strip comma and comment, then extra split in case of no comma w/ comments
225 enum_val = enum_val.strip().split(',', 1)[0]
226 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600227 # Perform conversion of VK_BIT macro
228 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
229 vk_bit_val = self.enum_val_dict[enum_name]['val']
230 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
231 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
232 else:
233 # account for negative values surrounded by parens
234 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700235 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600236 try:
237 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
238 int(self.enum_val_dict[enum_name]['val'], 0)
239 self.enum_val_dict[enum_name]['unique'] = True
240 #print("ENUM has num value")
241 except ValueError:
242 self.enum_val_dict[enum_name]['unique'] = False
243 #print("ENUM is not a number value")
244 # Update enum_type_dict as well
245 if not enum_type in self.enum_type_dict:
246 self.enum_type_dict[enum_type] = []
247 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700248
Jon Ashburnea65e492015-08-06 17:27:49 -0600249 # Return True if struct member is a dynamic array
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700250 # RULES : This is a bit quirky based on the API
251 # NOTE : Changes in API spec may cause these rules to change
252 # 1. There must be a previous uint var w/ 'count' in the name in the struct
253 # 2. Dynam array must have 'const' and '*' qualifiers
254 # 3a. Name of dynam array must end in 's' char OR
255 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
256 def _is_dynamic_array(self, full_type, name):
257 if '' != self.last_struct_count_name:
258 if 'const' in full_type and '*' in full_type:
259 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
260 return True
Chia-I Wud50a7d72015-10-26 20:48:51 +0800261
262 # VkWriteDescriptorSet
263 if self.last_struct_count_name == "descriptorCount":
264 return True
265
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700266 return False
267
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600268 # populate struct dicts based on struct lines
269 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
270 def _add_struct(self, line_txt, struct_type, num):
271 #print("Parsing struct line %s" % line_txt)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600272 if '{' == struct_type:
273 print("Parsing struct '{' w/ line %s" % line_txt)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600274 if not struct_type in self.struct_dict:
275 self.struct_dict[struct_type] = {}
276 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
277 # TODO : Handle bitfields more correctly
278 members = members.strip().split(':', 1)[0] # strip bitfield element
279 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700280 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600281 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700282 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600283 self.struct_dict[struct_type][num] = {}
284 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700285 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600286 if '*' in member_type:
287 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700288 # TODO : Need more general purpose way here to reduce down to basic type
289 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600290 member_type = member_type.strip('*')
291 else:
292 self.struct_dict[struct_type][num]['ptr'] = False
293 if 'const' in member_type:
294 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600295 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600296 else:
297 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700298 # TODO : There is a bug here where it seems that at the time we do this check,
299 # 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 -0600300 if is_type(member_type, 'struct'):
301 self.struct_dict[struct_type][num]['struct'] = True
302 else:
303 self.struct_dict[struct_type][num]['struct'] = False
304 self.struct_dict[struct_type][num]['type'] = member_type
305 if '[' in member_name:
306 (member_name, array_size) = member_name.split('[', 1)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600307 if 'char' in member_type:
308 self.struct_dict[struct_type][num]['array'] = False
309 self.struct_dict[struct_type][num]['array_size'] = 0
310 self.struct_dict[struct_type][num]['ptr'] = True
311 else:
312 self.struct_dict[struct_type][num]['array'] = True
313 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700314 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
315 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
316 self.struct_dict[struct_type][num]['array'] = True
317 self.struct_dict[struct_type][num]['dyn_array'] = True
318 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700319 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600320 self.struct_dict[struct_type][num]['array'] = False
321 self.struct_dict[struct_type][num]['array_size'] = 0
322 self.struct_dict[struct_type][num]['name'] = member_name
323
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700324# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600325def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600326 if identifier in types_dict and type_to_check == types_dict[identifier]:
327 return True
328 if identifier in typedef_rev_dict:
329 new_id = typedef_rev_dict[identifier]
330 if new_id in types_dict and type_to_check == types_dict[new_id]:
331 return True
332 return False
333
334# This is a validation function to verify that we can reproduce the original structs
335def recreate_structs():
336 for struct_name in struct_dict:
337 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
338 for mem_num in sorted(struct_dict[struct_name]):
339 sys.stdout.write(" ")
340 if struct_dict[struct_name][mem_num]['const']:
341 sys.stdout.write("const ")
342 #if struct_dict[struct_name][mem_num]['struct']:
343 # sys.stdout.write("struct ")
344 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
345 if struct_dict[struct_name][mem_num]['ptr']:
346 sys.stdout.write("*")
347 sys.stdout.write(" ")
348 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
349 if struct_dict[struct_name][mem_num]['array']:
350 sys.stdout.write("[")
351 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
352 sys.stdout.write("]")
353 sys.stdout.write(";\n")
354 sys.stdout.write("} ")
355 sys.stdout.write(typedef_fwd_dict[struct_name])
356 sys.stdout.write(";\n\n")
357
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600358#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600359# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600360def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600361 # Note: All struct types are now camel-case
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600362 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600363 char_idx = 0
364 struct_name = ''
365 for char in caps_struct_name:
366 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
367 struct_name += caps_struct_name[char_idx]
368 elif (caps_struct_name[char_idx] == '_'):
369 pass
370 else:
371 struct_name += caps_struct_name[char_idx].lower()
372 char_idx += 1
Chia-I Wu3432a0c2015-10-27 18:04:07 +0800373
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600374 return struct_name
375
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600376# class for writing common file elements
377# Here's how this class lays out a file:
378# COPYRIGHT
379# HEADER
380# BODY
381# FOOTER
382#
383# For each of these sections, there's a "set*" function
384# The class as a whole has a generate function which will write each section in order
385class CommonFileGen:
386 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
387 self.filename = filename
388 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
389 # TODO : Set a default copyright & footer at least
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600390
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600391 def setFilename(self, filename):
392 self.filename = filename
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600393
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600394 def setCopyright(self, c):
395 self.contents['copyright'] = c
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600396
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600397 def setHeader(self, h):
398 self.contents['header'] = h
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600399
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600400 def setBody(self, b):
401 self.contents['body'] = b
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600402
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600403 def setFooter(self, f):
404 self.contents['footer'] = f
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600405
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600406 def generate(self):
407 #print("Generate to file %s" % self.filename)
408 with open(self.filename, "w") as f:
409 f.write(self.contents['copyright'])
410 f.write(self.contents['header'])
411 f.write(self.contents['body'])
412 f.write(self.contents['footer'])
413
414# class for writing a wrapper class for structures
415# The wrapper class wraps the structs and includes utility functions for
416# setting/getting member values and displaying the struct data in various formats
417class StructWrapperGen:
418 def __init__(self, in_struct_dict, prefix, out_dir):
419 self.struct_dict = in_struct_dict
420 self.include_headers = []
Jon Ashburnea65e492015-08-06 17:27:49 -0600421 self.lineinfo = sourcelineinfo()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600422 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600423 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600424 self.api_prefix = "vk"
425 else:
426 self.api_prefix = prefix
427 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
428 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
429 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
430 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
431 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
432 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
433 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700434 self.no_addr = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600435 self.hfg = CommonFileGen(self.header_filename)
436 self.cfg = CommonFileGen(self.class_filename)
437 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700438 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700439 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600440 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
441 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600442 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700443 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600444 #print(self.header_filename)
445 self.header_txt = ""
446 self.definition_txt = ""
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600447
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600448 def set_include_headers(self, include_headers):
449 self.include_headers = include_headers
450
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700451 def set_no_addr(self, no_addr):
452 self.no_addr = no_addr
453 if self.no_addr:
454 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700455 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700456 else:
457 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700458 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700459
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600460 # Return class name for given struct name
461 def get_class_name(self, struct_name):
462 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
463 return class_name
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600464
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600465 def get_file_list(self):
466 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
467
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600468 # Generate class header file
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600469 def generateHeader(self):
470 self.hfg.setCopyright(self._generateCopyright())
471 self.hfg.setHeader(self._generateHeader())
472 self.hfg.setBody(self._generateClassDeclaration())
473 self.hfg.setFooter(self._generateFooter())
474 self.hfg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600475
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600476 # Generate class definition
477 def generateBody(self):
478 self.cfg.setCopyright(self._generateCopyright())
479 self.cfg.setHeader(self._generateCppHeader())
480 self.cfg.setBody(self._generateClassDefinition())
481 self.cfg.setFooter(self._generateFooter())
482 self.cfg.generate()
483
484 # Generate c-style .h file that contains functions for printing structs
485 def generateStringHelper(self):
486 print("Generating struct string helper")
487 self.shg.setCopyright(self._generateCopyright())
488 self.shg.setHeader(self._generateStringHelperHeader())
489 self.shg.setBody(self._generateStringHelperFunctions())
490 self.shg.generate()
491
Tobin Ehlis99f88672015-01-10 12:42:41 -0700492 # Generate cpp-style .h file that contains functions for printing structs
493 def generateStringHelperCpp(self):
494 print("Generating struct string helper cpp")
495 self.shcppg.setCopyright(self._generateCopyright())
496 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
497 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
498 self.shcppg.generate()
499
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700500 # Generate c-style .h file that contains functions for printing structs
501 def generateValidateHelper(self):
502 print("Generating struct validate helper")
503 self.vhg.setCopyright(self._generateCopyright())
504 self.vhg.setHeader(self._generateValidateHelperHeader())
505 self.vhg.setBody(self._generateValidateHelperFunctions())
506 self.vhg.generate()
507
Tobin Ehlis60354772015-03-12 14:50:40 -0600508 def generateSizeHelper(self):
509 print("Generating struct size helper")
510 self.size_helper_gen.setCopyright(self._generateCopyright())
511 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
512 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
513 self.size_helper_gen.generate()
514
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700515 def generateSizeHelperC(self):
516 print("Generating struct size helper c")
517 self.size_helper_c_gen.setCopyright(self._generateCopyright())
518 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
519 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
520 self.size_helper_c_gen.generate()
521
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600522 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700523 copyright = []
524 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
525 copyright.append('');
526 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600527 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700528 copyright.append(' *');
Courtney Goeltzenleuchterfcbe16f2015-10-29 13:50:34 -0600529 copyright.append(' * Copyright (C) 2015 Valive Corporation');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700530 copyright.append(' *');
531 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
532 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
533 copyright.append(' * to deal in the Software without restriction, including without limitation');
534 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
535 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
536 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
537 copyright.append(' *');
538 copyright.append(' * The above copyright notice and this permission notice shall be included');
539 copyright.append(' * in all copies or substantial portions of the Software.');
540 copyright.append(' *');
541 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
542 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
543 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
544 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
545 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
546 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
547 copyright.append(' * DEALINGS IN THE SOFTWARE.');
Jon Ashburnf2bad722015-11-03 11:57:00 -0700548 copyright.append(' *')
549 copyright.append(' * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>')
550 copyright.append(' * Author: Tobin Ehlis <tobin@lunarg.com>')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700551 copyright.append(' */');
552 copyright.append('');
553 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600554
555 def _generateCppHeader(self):
556 header = []
557 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600558 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 -0600559 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600560
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600561 def _generateClassDefinition(self):
562 class_def = []
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600563 if 'vk' == self.api:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600564 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700565 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600566 class_def.append("\n// %s class definition" % self.get_class_name(s))
567 class_def.append(self._generateConstructorDefinitions(s))
568 class_def.append(self._generateDestructorDefinitions(s))
569 class_def.append(self._generateDisplayDefinitions(s))
570 return "\n".join(class_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600571
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600572 def _generateConstructorDefinitions(self, s):
573 con_defs = []
574 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)))
575 # TODO : This is a shallow copy of ptrs
576 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]))
577 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]))
578 return "\n".join(con_defs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600579
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600580 def _generateDestructorDefinitions(self, s):
581 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600582
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600583 def _generateDynamicPrintFunctions(self):
584 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600585 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 -0600586 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600587 dp_funcs.append(" switch (sType)\n {")
588 for e in enum_type_dict:
589 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600590 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600591 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600592 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +0800593 if struct_name not in self.struct_dict:
594 continue
595
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600596 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600597 instance_name = "swc%i" % class_num
598 dp_funcs.append(" case %s:\n {" % (v))
599 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
600 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
601 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
602 dp_funcs.append(" }")
603 dp_funcs.append(" break;")
604 class_num += 1
605 dp_funcs.append(" }")
606 dp_funcs.append("}\n")
607 return "\n".join(dp_funcs)
608
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700609 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600610 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700611
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600612 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700613 return self._get_func_name(struct, 'print')
614
615 def _get_vh_func_name(self, struct):
616 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600617
Tobin Ehlis60354772015-03-12 14:50:40 -0600618 def _get_size_helper_func_name(self, struct):
619 return self._get_func_name(struct, 'size')
620
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600621 # Return elements to create formatted string for given struct member
622 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
623 struct_op = "->"
624 if not struct_ptr:
625 struct_op = "."
626 member_name = struct_member['name']
627 print_type = "p"
628 cast_type = ""
629 member_post = ""
630 array_index = ""
631 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700632 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700633 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
634 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
635 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600636 print_type = "s"
637 print_array = False
638 elif struct_member['array'] and not print_array:
639 # Just print base address of array when not full print_array
640 cast_type = "(void*)"
641 elif is_type(struct_member['type'], 'enum'):
642 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700643 if struct_member['ptr']:
644 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600645 print_type = "s"
646 elif is_type(struct_member['type'], 'struct'): # print struct address for now
647 cast_type = "(void*)"
648 if not struct_member['ptr']:
649 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -0600650 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600651 print_type = "s"
652 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700653 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600654 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600655 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
656 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700657 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600658 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600659 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700660 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
661 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600662 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 -0600663 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700664 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600665 print_type = "i"
666 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600667 pass
668 else:
669 #print("Unhandled struct type: %s" % struct_member['type'])
670 cast_type = "(void*)"
671 if print_array and struct_member['array']:
672 member_print_post = "[%u]"
673 array_index = " i,"
674 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700675 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 -0600676 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 -0700677 if self.no_addr and "p" == print_type:
678 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
679 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600680 return (print_out, print_arg)
681
682 def _generateStringHelperFunctions(self):
683 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700684 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700685 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700686 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
687 sh_funcs.append('')
688 sh_funcs.append('#if defined(_WIN32)')
689 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
690 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
691 sh_funcs.append('// work-around.')
692 sh_funcs.append('#define snprintf _snprintf')
693 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700694 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600695 p_out = ""
696 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700697 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 -0700698 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700699 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700700 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
701 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700702 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]))
703 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700704 num_stps = len(stp_list);
705 total_strlen_str = ''
706 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700707 sh_funcs.append(" char* tmpStr;")
708 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
709 sh_funcs.append(' strcpy(extra_indent, " ");')
710 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
711 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700712 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700713 # If it's an array, print all of the elements
714 # If it's a ptr, print thing it's pointing to
715 # Non-ptr struct case. Print the struct using its address
716 struct_deref = '&'
717 if 1 < stp_list[index]['full_type'].count('*'):
718 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700719 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700720 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700721 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700722 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
723 sh_funcs.append(' len = 256+strlen(tmpStr);')
724 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700725 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700726 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700727 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700728 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
729 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700730 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700731 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
732 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600733 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 -0700734 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700735 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
736 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
737 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700738 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700739 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name']))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700740 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700741 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (%%p)\\n%%s", prefix, (void*)pStruct->%s, tmpStr);' % (index, stp_list[index]['name'], stp_list[index]['name']))
742 sh_funcs.append(' }')
743 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
744 elif stp_list[index]['array']:
745 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
746 sh_funcs.append(' len = 256+strlen(tmpStr);')
747 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700748 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700749 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 -0700750 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700751 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 -0700752 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700753 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
754 sh_funcs.append(' len = 256+strlen(tmpStr);')
755 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700756 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700757 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 -0700758 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700759 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 -0700760 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700761 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
762 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700763 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600764 for m in sorted(self.struct_dict[s]):
765 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
766 p_out += p_out1
767 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600768 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700769 p_args += ");"
770 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700771 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700772 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
773 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
774 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
775 sh_funcs.append(' free(stp_strs[stp_index]);')
776 sh_funcs.append(' }')
777 sh_funcs.append(' }')
778 sh_funcs.append(' free(extra_indent);')
779 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600780 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700781 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
782 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
783 sh_funcs.append(" if (pStruct == NULL) {")
784 sh_funcs.append(" return NULL;")
785 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600786 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700787 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
788 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600789 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600790 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600791 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600792 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +0800793 if struct_name not in self.struct_dict:
794 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600795 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700796 sh_funcs.append(' case %s:\n {' % (v))
797 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
798 sh_funcs.append(' }')
799 sh_funcs.append(' break;')
800 sh_funcs.append(" default:")
801 sh_funcs.append(" return NULL;")
802 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600803 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700804 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700805
806 def _generateStringHelperFunctionsCpp(self):
807 # declare str & tmp str
808 # declare array of stringstreams for every struct ptr in current struct
809 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700810 # For every struct ptr, if non-Null, then set its string, else set to NULL str
811 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700812 # create and return final string
813 sh_funcs = []
814 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600815 # XXX - REMOVE this comment
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600816 lineinfo = sourcelineinfo()
817 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700818 for s in sorted(self.struct_dict):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700819 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
820 sh_funcs.append('\n')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600821 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700822 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600823 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 -0700824 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 -0700825 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700826 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700827 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 -0600828 # TODO: This is a tmp workaround
829 if 'ppActiveLayerNames' not in self.struct_dict[s][m]['name']:
830 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600831 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700832 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 -0600833 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700834 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600835 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700836 sh_funcs.append('%sstring final_str;' % (indent))
837 sh_funcs.append('%sstring tmp_str;' % (indent))
838 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700839 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700840 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700841 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600842 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700843 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700844 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700845 idx_ss_decl = False # Make sure to only decl this once
846 for index in range(num_stps):
847 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700848 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700849 addr_char = ''
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600850 if stp_list[index]['array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600851 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700852 if stp_list[index]['dyn_array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600853 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700854 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
855 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600856 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700857 array_count = '%s' % (stp_list[index]['array_size'])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600858 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700859 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
860 if not idx_ss_decl:
861 sh_funcs.append('%sstringstream index_ss;' % (indent))
862 idx_ss_decl = True
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600863 if (stp_list[index]['name'] == 'pQueueFamilyIndices'):
Ian Elliott05846062015-11-20 14:13:17 -0700864 if (typedef_fwd_dict[s] == 'VkSwapchainCreateInfoKHR'):
865 sh_funcs.append('%sif (pStruct->imageSharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent))
866 else:
867 sh_funcs.append('%sif (pStruct->sharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent))
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600868 indent += ' '
Tobin Ehlis793ad302015-04-03 12:01:11 -0600869 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
870 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700871 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600872 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700873 sh_funcs.append('%sindex_ss.str("");' % (indent))
874 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600875 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600876 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700877 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600878 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
879 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 -0700880 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 -0600881 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600882 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700883 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
884 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']))
885 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600886 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700887 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
888 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600889 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700890 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 -0600891 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600892 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600893 addr_char = ''
Courtney Goeltzenleuchter44981552015-10-23 15:48:32 -0600894 if stp_list[index]['type'] in vulkan.core.objects:
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600895 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "].handle = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
896 else:
897 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
898 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 -0600899 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700900 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600901 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700902 sh_funcs.append('%s}' % (indent))
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600903 indent = indent[4:]
904 sh_funcs.append('%s}' % (indent))
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600905 #endif
906 if (stp_list[index]['name'] == 'pQueueFamilyIndices'):
907 indent = indent[4:]
908 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700909 elif (stp_list[index]['ptr']):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600910 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600911 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
912 indent += ' '
Tobin Ehlis99f88672015-01-10 12:42:41 -0700913 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600914 sh_funcs.append('%s' % lineinfo.get())
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600915 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700916 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700917 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
918 # TODO : This is a quick hack to handle these arrays of ptrs
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600919 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600920 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 -0700921 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600922 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700923 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 -0700924 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
925 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600926 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700927 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
928 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600929 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700930 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
931 sh_funcs.append(' ss[%u].str("");' % (index))
932 sh_funcs.append(' }')
933 sh_funcs.append(' else')
934 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700935 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600936 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700937 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
938 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
939 if self.no_addr:
940 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600941 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700942 else:
943 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 -0600944 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700945 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -0600946 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -0700947 index = 0
948 final_str = ''
949 for m in sorted(self.struct_dict[s]):
950 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
951 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
952 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600953 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700954 sh_funcs.append(' ss[%u].str("addr");' % (index))
955 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600956 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700957 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Jon Ashburnc669cc62015-07-09 15:02:25 -0600958 elif self.struct_dict[s][m]['array']:
959 sh_funcs.append('%s' % lineinfo.get())
960 sh_funcs.append(' ss[%u] << (void*)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700961 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600962 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700963 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700964 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600965 sh_funcs.append('%s' % lineinfo.get())
Jon Ashburnc669cc62015-07-09 15:02:25 -0600966 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600967 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600968 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600969 sh_funcs.append(' if (StreamControl::writeAddress)')
970 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
971 sh_funcs.append(' else')
972 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700973 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600974 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -0700975 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700976 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700977 sh_funcs.append(' ss[%u].str("addr");' % (index))
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600978 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 +0800979 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700980 else:
981 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
982 value_print = 'ss[%u].str()' % index
983 index += 1
984 else:
Tobin Ehlisce320942015-06-11 09:37:00 -0600985 # 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 -0700986 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600987 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600988 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
989 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
990 sh_funcs.append(' else')
991 sh_funcs.append(' ss[%u].str("NULL");' % (index))
992 value_print = 'ss[%u].str()' % index
993 index += 1
994 # For single enum just print the string representation
995 else:
996 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 -0700997 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
998 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700999 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -07001000 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001001 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001002 sh_funcs.append(' final_str = %s;' % final_str)
1003 sh_funcs.append(' return final_str;\n}')
Tobin Ehlis291cd702015-01-20 09:48:48 -07001004 # Add function to return a string value for input void*
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001005 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -07001006 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001007 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -07001008 sh_funcs.append(" stringstream ss;")
1009 sh_funcs.append(' ss << toString;')
1010 sh_funcs.append(' string final_str = prefix + ss.str();')
1011 sh_funcs.append(" return final_str;")
1012 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001013 sh_funcs.append('%s' % lineinfo.get())
Tony Barbourb5d2c942015-07-14 13:34:05 -06001014 # Add function to return a string value for input uint64_t
1015 sh_funcs.append("string string_convert_helper(const uint64_t toString, const string prefix)\n{")
Tobin Ehlis08541742015-04-16 15:56:11 -06001016 sh_funcs.append(" using namespace StreamControl;")
1017 sh_funcs.append(" stringstream ss;")
1018 sh_funcs.append(' ss << toString;')
1019 sh_funcs.append(' string final_str = prefix + ss.str();')
1020 sh_funcs.append(" return final_str;")
1021 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001022 sh_funcs.append('%s' % lineinfo.get())
Ian Elliott7e40db92015-08-21 15:09:33 -06001023 # Add function to return a string value for input VkSurfaceFormatKHR*
1024 sh_funcs.append("string string_convert_helper(VkSurfaceFormatKHR toString, const string prefix)\n{")
1025 sh_funcs.append(' string final_str = prefix + "format = " + string_VkFormat(toString.format) + "format = " + string_VkColorSpaceKHR(toString.colorSpace);')
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001026 sh_funcs.append(" return final_str;")
1027 sh_funcs.append("}")
1028 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001029 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001030 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001031 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -07001032 sh_funcs.append(" if (pStruct == NULL) {\n")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001033 sh_funcs.append(" return string();")
Ian Elliott82800022015-02-25 17:40:38 -07001034 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001035 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001036 sh_funcs.append(' string indent = " ";')
1037 sh_funcs.append(' indent += prefix;')
1038 sh_funcs.append(" switch (sType)\n {")
1039 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001040 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001041 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001042 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001043 if struct_name not in self.struct_dict:
1044 continue
Tobin Ehlis99f88672015-01-10 12:42:41 -07001045 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001046 #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 -07001047 sh_funcs.append(' case %s:\n {' % (v))
1048 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
1049 sh_funcs.append(' }')
1050 sh_funcs.append(' break;')
1051 sh_funcs.append(" default:")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001052 sh_funcs.append(" return string();")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001053 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001054 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001055 sh_funcs.append("}")
1056 return "\n".join(sh_funcs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001057
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001058 def _genStructMemberPrint(self, member, s, array, struct_array):
1059 (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)
1060 extra_indent = ""
1061 if array:
1062 extra_indent = " "
1063 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
1064 struct_array.insert(0, self.struct_dict[s][member])
1065 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001066 # Special case for void* named "pNext"
1067 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001068 struct_array.insert(0, self.struct_dict[s][member])
1069 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
1070
1071 def _generateDisplayDefinitions(self, s):
1072 disp_def = []
1073 struct_array = []
1074 # Single-line struct print function
1075 disp_def.append("// Output 'structname = struct_address' on a single line")
1076 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
1077 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1078 disp_def.append("}\n")
1079 # Private helper function to print struct members
1080 disp_def.append("// Private helper function that displays the members of the wrapped struct")
1081 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
1082 i_declared = False
1083 for member in sorted(self.struct_dict[s]):
1084 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001085 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001086 # Can grab struct type off of header of struct pointed to
1087 # TODO : Handle Arrays
1088 if self.struct_dict[s][member]['array']:
1089 # Create for loop to print each element of array
1090 if not i_declared:
1091 disp_def.append(' uint32_t i;')
1092 i_declared = True
1093 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
1094 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
1095 disp_def.append(return_str)
1096 disp_def.append(' }')
1097 else:
1098 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
1099 disp_def.append(return_str)
1100 disp_def.append("}\n")
1101 i_declared = False
1102 # Basic print function to display struct members
1103 disp_def.append("// Output all struct elements, each on their own line")
1104 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
1105 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1106 disp_def.append(' this->display_struct_members();')
1107 disp_def.append("}\n")
1108 # Advanced print function to display current struct and contents of any pointed-to structs
1109 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1110 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1111 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1112 disp_def.append(' this->display_struct_members();')
1113 class_num = 0
1114 # TODO : Need to handle arrays of structs here
1115 for ms in struct_array:
1116 swc_name = "class%s" % str(class_num)
1117 if ms['array']:
1118 if not i_declared:
1119 disp_def.append(' uint32_t i;')
1120 i_declared = True
1121 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1122 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1123 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1124 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1125 disp_def.append(" %s.display_full_txt();" % (swc_name))
1126 #disp_def.append(' }')
1127 disp_def.append(' }')
1128 elif 'pNext' == ms['name']:
1129 # Need some code trickery here
1130 # I'm thinking have a generated function that takes pNext ptr value
1131 # then it checks sType and in large switch statement creates appropriate
1132 # wrapper class type and then prints contents
1133 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1134 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1135 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1136 disp_def.append(" }")
1137 else:
1138 if ms['ptr']:
1139 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1140 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1141 else:
1142 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1143 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1144 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1145 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1146 class_num += 1
1147 disp_def.append("}\n")
1148 return "\n".join(disp_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001149
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001150 def _generateStringHelperHeader(self):
1151 header = []
1152 header.append("//#includes, #defines, globals and such...\n")
1153 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001154 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001155 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001156 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001157 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001158 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001159
1160 def _generateStringHelperHeaderCpp(self):
1161 header = []
1162 header.append("//#includes, #defines, globals and such...\n")
1163 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001164 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001165 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001166 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001167 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001168 header.append('\n')
1169 header.append('namespace StreamControl\n')
1170 header.append('{\n')
1171 header.append('bool writeAddress = true;\n')
1172 header.append('template <typename T>\n')
1173 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1174 header.append('{\n')
1175 header.append(' if(writeAddress)\n')
1176 header.append(' {\n')
1177 header.append(' out.operator<<(pointer);\n')
1178 header.append(' }\n')
1179 header.append(' else\n')
1180 header.append(' {\n')
1181 header.append(' std::operator<<(out, "address");\n')
1182 header.append(' }\n')
1183 header.append(' return out;\n')
1184 header.append('}\n')
1185 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1186 header.append('{\n')
1187 header.append(' return std::operator<<(out, s);\n')
1188 header.append('}\n')
1189 header.append('}\n')
1190 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001191 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001192 return "".join(header)
1193
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001194 def _generateValidateHelperFunctions(self):
1195 sh_funcs = []
1196 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001197 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001198 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1199 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001200 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001201 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1202 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001203 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001204 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 -07001205 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 -07001206 # 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 -07001207 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1208 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001209 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 -07001210 else:
1211 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 -07001212 sh_funcs.append(" return 1;\n}")
1213
1214 return "\n".join(sh_funcs)
1215
1216 def _generateValidateHelperHeader(self):
1217 header = []
1218 header.append("//#includes, #defines, globals and such...\n")
1219 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001220 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001221 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001222 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001223 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001224 return "".join(header)
1225
Tobin Ehlis60354772015-03-12 14:50:40 -06001226 def _generateSizeHelperFunctions(self):
1227 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001228 # just generates prototypes for all the functions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001229 for s in sorted(self.struct_dict):
Tobin Ehlis60354772015-03-12 14:50:40 -06001230 sh_funcs.append('size_t %s(const %s* pStruct);' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001231 return "\n".join(sh_funcs)
1232
1233
1234 def _generateSizeHelperFunctionsC(self):
1235 sh_funcs = []
1236 # generate function definitions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001237 for s in sorted(self.struct_dict):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001238 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001239 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1240 indent = ' '
1241 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1242 sh_funcs.append('%sif (pStruct) {' % (indent))
1243 indent = ' '
1244 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1245 i_decl = False
1246 for m in sorted(self.struct_dict[s]):
1247 if m in skip_list:
1248 continue
1249 if self.struct_dict[s][m]['dyn_array']:
1250 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1251 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 +08001252 if 'ppMemoryBarriers' == self.struct_dict[s][m]['name']:
Tobin Ehlis04112922015-03-16 10:44:40 -06001253 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001254 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 -06001255 else:
1256 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 -06001257 else: # This is an array of char* or array of struct ptrs
1258 if not i_decl:
1259 sh_funcs.append('%suint32_t i = 0;' % (indent))
1260 i_decl = True
1261 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1262 indent = ' '
1263 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1264 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']))
1265 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001266 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 -06001267 indent = ' '
1268 sh_funcs.append('%s}' % (indent))
1269 else:
1270 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1271 if not i_decl:
1272 sh_funcs.append('%suint32_t i = 0;' % (indent))
1273 i_decl = True
1274 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1275 indent = ' '
1276 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']))
1277 indent = ' '
1278 sh_funcs.append('%s}' % (indent))
1279 else:
1280 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1281 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1282 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001283 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 -06001284 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1285 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 -06001286 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis60354772015-03-12 14:50:40 -06001287 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1288 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1289 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1290 skip_list.append(m+1)
1291 indent = ' '
1292 sh_funcs.append('%s}' % (indent))
1293 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001294 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
Ian Elliottba042332015-11-18 14:57:08 -07001295 if '_debug_' not in self.header_filename:
Jon Ashburnea65e492015-08-06 17:27:49 -06001296 for follow_chain in [True, False]:
1297 sh_funcs.append('%s' % self.lineinfo.get())
1298 if follow_chain:
1299 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1300 else:
1301 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1302 indent = ' '
1303 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1304 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
1305 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1306 if follow_chain:
1307 sh_funcs.append('%swhile (pNext) {' % (indent))
1308 indent = ' '
1309 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1310 indent += ' '
1311 for e in enum_type_dict:
1312 if 'StructureType' in e:
1313 for v in sorted(enum_type_dict[e]):
1314 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001315 if struct_name not in self.struct_dict:
1316 continue
1317
Jon Ashburnea65e492015-08-06 17:27:49 -06001318 sh_funcs.append('%scase %s:' % (indent, v))
1319 sh_funcs.append('%s{' % (indent))
1320 indent += ' '
1321 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1322 sh_funcs.append('%sbreak;' % (indent))
1323 indent = indent[:-4]
1324 sh_funcs.append('%s}' % (indent))
1325 sh_funcs.append('%sdefault:' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001326 indent += ' '
Jon Ashburnea65e492015-08-06 17:27:49 -06001327 sh_funcs.append('%sassert(0);' % (indent))
1328 sh_funcs.append('%sstructSize += 0;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001329 indent = indent[:-4]
Tobin Ehlis04112922015-03-16 10:44:40 -06001330 indent = indent[:-4]
1331 sh_funcs.append('%s}' % (indent))
Jon Ashburnea65e492015-08-06 17:27:49 -06001332 if follow_chain:
1333 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
1334 indent = indent[:-4]
1335 sh_funcs.append('%s}' % (indent))
1336 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001337 return "\n".join(sh_funcs)
1338
1339 def _generateSizeHelperHeader(self):
1340 header = []
1341 header.append("//#includes, #defines, globals and such...\n")
1342 for f in self.include_headers:
1343 header.append("#include <%s>\n" % f)
1344 header.append('\n// Function Prototypes\n')
1345 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001346 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001347 return "".join(header)
1348
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001349 def _generateSizeHelperHeaderC(self):
1350 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001351 header.append('#include "vk_struct_size_helper.h"')
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -07001352 header.append('#include "vulkan/vk_ext_debug_report.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001353 header.append('#include <string.h>')
1354 header.append('#include <assert.h>')
1355 header.append('\n// Function definitions\n')
1356 return "\n".join(header)
1357
1358
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001359 def _generateHeader(self):
1360 header = []
1361 header.append("//#includes, #defines, globals and such...\n")
1362 for f in self.include_headers:
1363 header.append("#include <%s>\n" % f)
1364 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001365
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001366 # Declarations
1367 def _generateConstructorDeclarations(self, s):
1368 constructors = []
1369 constructors.append(" %s();\n" % self.get_class_name(s))
1370 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1371 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1372 return "".join(constructors)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001373
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001374 def _generateDestructorDeclarations(self, s):
1375 return " virtual ~%s();\n" % self.get_class_name(s)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001376
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001377 def _generateDisplayDeclarations(self, s):
1378 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001379
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001380 def _generateGetSetDeclarations(self, s):
1381 get_set = []
1382 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1383 for member in sorted(self.struct_dict[s]):
1384 # TODO : Skipping array set/get funcs for now
1385 if self.struct_dict[s][member]['array']:
1386 continue
1387 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']))
1388 if not self.struct_dict[s][member]['const']:
1389 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']))
1390 return "".join(get_set)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001391
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001392 def _generatePrivateMembers(self, s):
1393 priv = []
1394 priv.append("\nprivate:\n")
1395 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1396 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1397 priv.append(" uint32_t m_indent;\n")
1398 priv.append(" const char m_dummy_prefix;\n")
1399 priv.append(" void display_struct_members();\n")
1400 return "".join(priv)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001401
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001402 def _generateClassDeclaration(self):
1403 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001404 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001405 class_decl.append("\n//class declaration")
1406 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1407 class_decl.append(self._generateConstructorDeclarations(s))
1408 class_decl.append(self._generateDestructorDeclarations(s))
1409 class_decl.append(self._generateDisplayDeclarations(s))
1410 class_decl.append(self._generateGetSetDeclarations(s))
1411 class_decl.append(self._generatePrivateMembers(s))
1412 class_decl.append("};\n")
1413 return "\n".join(class_decl)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001414
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001415 def _generateFooter(self):
1416 return "\n//any footer info for class\n"
1417
1418class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001419 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 -06001420 self.et_dict = enum_type_dict
1421 self.ev_dict = enum_val_dict
1422 self.tf_dict = typedef_fwd_dict
1423 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001424 self.out_sh_file = out_sh_file
1425 self.eshfg = CommonFileGen(self.out_sh_file)
1426 self.out_vh_file = out_vh_file
1427 self.evhfg = CommonFileGen(self.out_vh_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001428
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001429 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001430 self.eshfg.setHeader(self._generateSHHeader())
1431 self.eshfg.setBody(self._generateSHBody())
1432 self.eshfg.generate()
1433
1434 def generateEnumValidate(self):
1435 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001436 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001437 self.evhfg.generate()
1438
1439 def _generateVHBody(self):
1440 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001441 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001442 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001443 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1444 # 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 -06001445 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001446 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1447 body.append(' return 0;')
1448 body.append(' return 1;')
1449 body.append('}\n\n')
1450 else:
1451 body.append(' switch ((%s)input_value)\n {' % (fet))
1452 for e in sorted(self.et_dict[bet]):
1453 if (self.ev_dict[e]['unique']):
1454 body.append(' case %s:' % (e))
1455 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001456 return "\n".join(body)
1457
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001458 def _generateSHBody(self):
1459 body = []
1460# with open(self.out_file, "a") as hf:
1461 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001462 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001463 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001464 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 -06001465 for e in sorted(self.et_dict[bet]):
1466 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001467 body.append(' case %s:\n return "%s";' % (e, e))
1468 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001469 return "\n".join(body)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001470
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001471 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001472 header = []
1473 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001474 header.append('#ifdef _WIN32\n')
1475 header.append('#pragma warning( disable : 4065 )\n')
1476 header.append('#endif\n')
David Pinedo9316d3b2015-11-06 12:54:48 -07001477 header.append('#include <vulkan/%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001478 return "\n".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001479
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001480
1481class CMakeGen:
1482 def __init__(self, struct_wrapper=None, out_dir=None):
1483 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001484 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001485 self.add_lib_file_list = self.sw.get_file_list()
1486 self.out_dir = out_dir
1487 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1488 self.cmg = CommonFileGen(self.out_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001489
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001490 def generate(self):
1491 self.cmg.setBody(self._generateBody())
1492 self.cmg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001493
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001494 def _generateBody(self):
1495 body = []
1496 body.append("project(%s)" % os.path.basename(self.out_dir))
1497 body.append("cmake_minimum_required(VERSION 2.8)\n")
1498 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1499 body.append('set(COMPILE_FLAGS "-fpermissive")')
1500 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1501 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1502 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1503 return "\n".join(body)
1504
1505class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001506 def __init__(self, struct_dict, prefix, out_dir):
1507 self.struct_dict = struct_dict
1508 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001509 if prefix == "vulkan":
1510 self.api_prefix = "vk"
1511 else:
1512 self.api_prefix = prefix
1513 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001514 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001515
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001516 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001517 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001518 self.gvg.setHeader(self._generateHeader())
1519 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001520 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001521 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001522
1523 def set_include_headers(self, include_headers):
1524 self.include_headers = include_headers
1525
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001526 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001527 header = []
1528 header.append("//#includes, #defines, globals and such...\n")
1529 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001530 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001531 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001532 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001533 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001534 return "".join(header)
1535
1536 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001537 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001538
1539 # Return elements to create formatted string for given struct member
1540 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=""):
1541 struct_op = "->"
1542 pre_var_name = '"%s "' % struct_member['full_type']
1543 if not struct_ptr:
1544 struct_op = "."
1545 member_name = struct_member['name']
1546 print_type = "p"
1547 cast_type = ""
1548 member_post = ""
1549 array_index = ""
1550 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001551 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001552 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1553 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001554 print_array = False
1555 elif struct_member['array'] and not print_array:
1556 # Just print base address of array when not full print_array
1557 cast_type = "(void*)"
1558 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001559 if struct_member['ptr']:
1560 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001561 cast_type = "string_%s" % struct_member['type']
1562 print_type = "s"
1563 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1564 cast_type = "(void*)"
1565 if not struct_member['ptr']:
1566 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -06001567 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis83562882014-11-27 15:43:39 -07001568 print_type = "s"
1569 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001570 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001571 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001572 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1573 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001574 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001575 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001576 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001577 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1578 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001579 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 -07001580 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001581 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001582 print_type = "i"
1583 elif struct_member['ptr']:
1584 pass
1585 else:
1586 #print("Unhandled struct type: %s" % struct_member['type'])
1587 cast_type = "(void*)"
1588 if print_array and struct_member['array']:
1589 member_print_post = "[%u]"
1590 array_index = " i,"
1591 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001592 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 -06001593 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 -07001594 return (print_out, print_arg)
1595
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001596 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001597 gv_funcs = []
1598 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001599 array_func_list.append('vkbufferviewattachinfo')
1600 array_func_list.append('vkimageviewattachinfo')
1601 array_func_list.append('vksamplerimageviewinfo')
1602 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001603 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001604 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001605 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1606 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001607 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001608 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]))
1609 else:
1610 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 -07001611 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001612 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001613 p_out = ""
1614 p_args = ""
1615 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1616 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1617 pl_dict = {}
1618 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001619 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001620 for m in sorted(self.struct_dict[s]):
1621 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1622 stp_list.append(self.struct_dict[s][m])
1623 if 'pNext' == self.struct_dict[s][m]['name']:
1624 pl_dict[m] = ' PORT=\\"pNext\\"'
1625 else:
1626 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1627 struct_num += 1
1628 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]))
1629 num_stps = len(stp_list);
1630 total_strlen_str = ''
1631 if 0 != num_stps:
1632 gv_funcs.append(" char* tmpStr;\n")
1633 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001634 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1635 for index in range(num_stps):
1636 if (stp_list[index]['ptr']):
1637 if 'pDescriptorInfo' == stp_list[index]['name']:
1638 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1639 else:
1640 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1641 if 'pNext' == stp_list[index]['name']:
1642 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001643 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001644 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1645 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1646 gv_funcs.append(' free(tmpStr);\n')
1647 else:
1648 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 -06001649 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001650 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 -07001651 else:
1652 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1653 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1654 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1655 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001656 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001657 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1658 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1659 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1660 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1661 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1662 else:
1663 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1664 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1665 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1666 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1667 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1668 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1669 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1670 p_args = ", myNodeName, myNodeName, pStruct"
1671 for m in sorted(self.struct_dict[s]):
1672 plabel = ""
1673 if m in pl_dict:
1674 plabel = pl_dict[m]
1675 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1676 p_out += p_out1
1677 p_args += p_args1
1678 p_out += '</TABLE>>\\n];\\n\\n"'
1679 p_args += ");\n"
1680 gv_funcs.append(p_out)
1681 gv_funcs.append(p_args)
1682 if 0 != num_stps:
1683 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1684 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1685 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1686 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1687 gv_funcs.append(' }\n')
1688 gv_funcs.append(' }\n')
1689 gv_funcs.append(" return str;\n}\n")
1690 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001691 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001692 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001693 ptr_array = True
1694 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]))
1695 else:
1696 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 -07001697 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1698 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')
1699 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1700 gv_funcs.append(' sprintf(tmpStr, "');
1701 p_args = ""
1702 p_out = ""
1703 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07001704 plabel = ""
1705 (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 -07001706 if 0 == m: # Add array index notation at end of first row
1707 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 -07001708 p_args1 += ', i, i'
1709 p_out += p_out1
1710 p_args += p_args1
1711 p_out += '"'
1712 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001713 if ptr_array:
1714 p_args = p_args.replace('->', '[i]->')
1715 else:
1716 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07001717 gv_funcs.append(p_out);
1718 gv_funcs.append(p_args);
1719 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1720 gv_funcs.append(' }\n')
1721 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001722 gv_funcs.append(' return str;\n}\n')
1723 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001724 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001725 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001726 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001727 gv_funcs.append(" switch (sType)\n {\n")
1728 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001729 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07001730 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001731 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001732 if struct_name not in self.struct_dict:
1733 continue
1734
Tobin Ehlis83562882014-11-27 15:43:39 -07001735 print_func_name = self._get_gv_func_name(struct_name)
1736 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001737 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001738 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001739 if 'VkSemaphoreCreateInfo' in struct_name:
1740 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001741 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001742 elif 'VkSemaphoreOpenInfo' in struct_name:
1743 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001744 print_func_name = self._get_gv_func_name(struct_name)
1745 gv_funcs.append(' case %s:\n' % (v))
1746 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1747 #gv_funcs.append(' }\n')
1748 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08001749 gv_funcs.append(" default:\n")
1750 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001751 gv_funcs.append(" }\n")
1752 gv_funcs.append("}")
1753 return "".join(gv_funcs)
1754
1755
1756
1757
1758
1759# def _generateHeader(self):
1760# hdr = []
1761# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1762# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1763# hdr.append('edge [\n];\n')
1764# return "\n".join(hdr)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001765#
Tobin Ehlis83562882014-11-27 15:43:39 -07001766# def _generateBody(self):
1767# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001768# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001769# field_num = 1
1770# 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]))
1771# for m in sorted(self.struc_dict[s]):
1772# 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']))
1773# field_num += 2
1774# body.append('</TABLE>>\n];\n')
1775# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001776
1777def main(argv=None):
1778 opts = handle_args()
1779 # Parse input file and fill out global dicts
1780 hfp = HeaderFileParser(opts.input_file)
1781 hfp.parse()
1782 # TODO : Don't want these to be global, see note at top about wrapper classes
1783 global enum_val_dict
1784 global enum_type_dict
1785 global struct_dict
1786 global typedef_fwd_dict
1787 global typedef_rev_dict
1788 global types_dict
1789 enum_val_dict = hfp.get_enum_val_dict()
1790 enum_type_dict = hfp.get_enum_type_dict()
1791 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07001792 # 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 -06001793 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1794 typedef_rev_dict = hfp.get_typedef_rev_dict()
1795 types_dict = hfp.get_types_dict()
1796 #print(enum_val_dict)
1797 #print(typedef_dict)
1798 #print(struct_dict)
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001799 input_header = os.path.basename(opts.input_file)
1800 if 'vulkan.h' == input_header:
1801 input_header = "vulkan/vulkan.h"
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001802 prefix = os.path.basename(opts.input_file).strip(".h")
1803 if prefix == "vulkan":
1804 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001805 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001806 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001807 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001808 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001809 enum_sh_filename = os.path.abspath(enum_sh_filename)
1810 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1811 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1812 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001813 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001814 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001815 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001816 print("Generating enum validate helper to %s" % enum_vh_filename)
1817 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 -06001818 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001819 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001820 #for struct in struct_dict:
1821 #print(struct)
1822 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001823 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 -06001824 #print(sw.get_class_name(struct))
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001825 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 -06001826 print("Generating struct wrapper header to %s" % sw.header_filename)
1827 sw.generateHeader()
1828 print("Generating struct wrapper class to %s" % sw.class_filename)
1829 sw.generateBody()
1830 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001831 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07001832 # Generate a 2nd helper file that excludes addrs
1833 sw.set_no_addr(True)
1834 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07001835 sw.set_no_addr(False)
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001836 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 -07001837 sw.set_no_addr(True)
1838 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001839 sw.set_no_addr(False)
1840 sw.generateStringHelperCpp()
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07001841 sw.set_include_headers(["stdio.h", "stdlib.h", input_header])
Tobin Ehlis60354772015-03-12 14:50:40 -06001842 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001843 sw.generateSizeHelperC()
Jon Ashburnea65e492015-08-06 17:27:49 -06001844 if opts.gen_struct_sizes:
1845 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 -07001846 st.set_include_headers(["stdio.h", "stdlib.h", input_header])
Jon Ashburnea65e492015-08-06 17:27:49 -06001847 st.generateSizeHelper()
1848 st.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001849 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001850 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001851 cmg.generate()
1852 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001853 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 -07001854 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 -06001855 gv.generate()
1856 print("DONE!")
1857 #print(typedef_rev_dict)
1858 #print(types_dict)
1859 #recreate_structs()
1860
1861if __name__ == "__main__":
1862 sys.exit(main())