blob: dc54243fee0caafab2f89017bde6e1aa4f4a7ac5 [file] [log] [blame]
Tobin Ehlis33267fd2014-11-10 16:03:19 -07001#!/usr/bin/env python3
2#
Karl Schultz8e42f402016-02-02 19:32:33 -07003# Copyright (c) 2015-2016 The Khronos Group Inc.
4# Copyright (c) 2015-2016 Valve Corporation
5# Copyright (c) 2015-2016 LunarG, Inc.
6# Copyright (c) 2015-2016 Google Inc.
Tobin Ehlis33267fd2014-11-10 16:03:19 -07007#
Jon Ashburn3ebf1252016-04-19 11:30:31 -06008# Licensed under the Apache License, Version 2.0 (the "License");
9# you may not use this file except in compliance with the License.
10# You may obtain a copy of the License at
Tobin Ehlis33267fd2014-11-10 16:03:19 -070011#
Jon Ashburn3ebf1252016-04-19 11:30:31 -060012# http://www.apache.org/licenses/LICENSE-2.0
Tobin Ehlis33267fd2014-11-10 16:03:19 -070013#
Jon Ashburn3ebf1252016-04-19 11:30:31 -060014# Unless required by applicable law or agreed to in writing, software
15# distributed under the License is distributed on an "AS IS" BASIS,
16# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17# See the License for the specific language governing permissions and
18# limitations under the License.
Courtney Goeltzenleuchter05559522015-10-30 11:14:30 -060019#
20# Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
21# Author: Tobin Ehlis <tobin@lunarg.com>
22
Tobin Ehlis6442dca2014-10-22 15:13:53 -060023import argparse
24import os
25import sys
Michael Lentine33d96a32016-01-05 11:10:15 -060026import re
Tobin Ehlisa30e7e52015-07-06 14:02:36 -060027import vulkan
Tobin Ehlis08fafd02015-06-12 12:49:01 -060028from source_line_info import sourcelineinfo
Tobin Ehlis6442dca2014-10-22 15:13:53 -060029
Tobin Ehlis08fafd02015-06-12 12:49:01 -060030# vk_helper.py overview
31# This script generates code based on vulkan input header
32# It generate wrappers functions that can be used to display
Tobin Ehlis6442dca2014-10-22 15:13:53 -060033# structs in a human-readable txt format, as well as utility functions
34# to print enum values as strings
35
Tobin Ehlis6442dca2014-10-22 15:13:53 -060036def handle_args():
37 parser = argparse.ArgumentParser(description='Perform analysis of vogl trace.')
38 parser.add_argument('input_file', help='The input header file from which code will be generated.')
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060039 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 -060040 parser.add_argument('--abs_out_dir', required=False, default=None, help='Absolute path to write output files. Will be created if needed.')
41 parser.add_argument('--gen_enum_string_helper', required=False, action='store_true', default=False, help='Enable generation of helper header file to print string versions of enums.')
42 parser.add_argument('--gen_struct_wrappers', required=False, action='store_true', default=False, help='Enable generation of struct wrapper classes.')
Jon Ashburnea65e492015-08-06 17:27:49 -060043 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 -060044 parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.')
45 parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.')
46 #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.')
47 return parser.parse_args()
48
49# TODO : Ideally these data structs would be opaque to user and could be wrapped
50# in their own class(es) to make them friendly for data look-up
51# Dicts for Data storage
52# enum_val_dict[value_name] = dict keys are the string enum value names for all enums
53# |-------->['type'] = the type of enum class into which the value falls
54# |-------->['val'] = the value assigned to this particular value_name
55# '-------->['unique'] = bool designating if this enum 'val' is unique within this enum 'type'
56enum_val_dict = {}
57# enum_type_dict['type'] = the type or class of of enum
58# '----->['val_name1', 'val_name2'...] = each type references a list of val_names within this type
59enum_type_dict = {}
60# struct_dict['struct_basename'] = the base (non-typedef'd) name of the struct
61# |->[<member_num>] = members are stored via their integer placement in the struct
62# | |->['name'] = string name of this struct member
63# ... |->['full_type'] = complete type qualifier for this member
64# |->['type'] = base type for this member
65# |->['ptr'] = bool indicating if this member is ptr
66# |->['const'] = bool indicating if this member is const
67# |->['struct'] = bool indicating if this member is a struct type
68# |->['array'] = bool indicating if this member is an array
Tobin Ehlisbd6a9162015-03-13 07:18:05 -060069# |->['dyn_array'] = bool indicating if member is a dynamically sized array
70# '->['array_size'] = For dyn_array, member name used to size array, else int size for static array
Tobin Ehlis6442dca2014-10-22 15:13:53 -060071struct_dict = {}
Tobin Ehlis37649692016-02-10 15:32:46 -070072struct_order_list = [] # struct names in order they're declared
73# Store struct names that require #ifdef guards
74# dict stores struct and enum definitions that are guarded by ifdef as the key
75# and the txt of the ifdef is the value
76ifdef_dict = {}
Tobin Ehlis6442dca2014-10-22 15:13:53 -060077# typedef_fwd_dict stores mapping from orig_type_name -> new_type_name
78typedef_fwd_dict = {}
79# typedef_rev_dict stores mapping from new_type_name -> orig_type_name
80typedef_rev_dict = {} # store new_name -> orig_name mapping
81# types_dict['id_name'] = identifier name will map to it's type
82# '---->'type' = currently either 'struct' or 'enum'
83types_dict = {} # store orig_name -> type mapping
84
85
86# Class that parses header file and generates data structures that can
87# Then be used for other tasks
88class HeaderFileParser:
89 def __init__(self, header_file=None):
90 self.header_file = header_file
91 # store header data in various formats, see above for more info
92 self.enum_val_dict = {}
93 self.enum_type_dict = {}
94 self.struct_dict = {}
95 self.typedef_fwd_dict = {}
96 self.typedef_rev_dict = {}
97 self.types_dict = {}
Tobin Ehlis5178bd72015-03-06 10:38:25 -070098 self.last_struct_count_name = ''
Mark Lobodzinski28b8f022015-08-27 15:30:29 -060099
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600100 def setHeaderFile(self, header_file):
101 self.header_file = header_file
102
103 def get_enum_val_dict(self):
104 return self.enum_val_dict
105
106 def get_enum_type_dict(self):
107 return self.enum_type_dict
108
109 def get_struct_dict(self):
110 return self.struct_dict
111
112 def get_typedef_fwd_dict(self):
113 return self.typedef_fwd_dict
114
115 def get_typedef_rev_dict(self):
116 return self.typedef_rev_dict
117
118 def get_types_dict(self):
119 return self.types_dict
120
121 # Parse header file into data structures
122 def parse(self):
123 # parse through the file, identifying different sections
124 parse_enum = False
125 parse_struct = False
126 member_num = 0
127 # TODO : Comment parsing is very fragile but handles 2 known files
128 block_comment = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700129 prev_count_name = ''
Tobin Ehlis37649692016-02-10 15:32:46 -0700130 ifdef_txt = ''
131 ifdef_active = 0
Ian Elliott7e40db92015-08-21 15:09:33 -0600132 exclude_struct_list = ['VkPlatformHandleXcbKHR', 'VkPlatformHandleX11KHR']
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600133 with open(self.header_file) as f:
134 for line in f:
Tobin Ehlis37649692016-02-10 15:32:46 -0700135 if True in [ifd_txt in line for ifd_txt in ['#ifdef ', '#ifndef ']]:
136 ifdef_txt = line.split()[1]
137 ifdef_active = ifdef_active + 1
138 continue
139 if ifdef_active != 0 and '#endif' in line:
140 ifdef_active = ifdef_active - 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600141 if block_comment:
142 if '*/' in line:
143 block_comment = False
144 continue
145 if '/*' in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600146 if '*/' in line: # single line block comment
147 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600148 block_comment = True
149 elif 0 == len(line.split()):
150 #print("Skipping empty line")
151 continue
152 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700153 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600154 continue
155 elif 'typedef enum' in line:
156 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
157 #print("Found ENUM type %s" % base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600158 if '{' == base_type:
159 base_type = 'tmp_enum'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600160 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700161 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600162 self.types_dict[base_type] = 'enum'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600163 elif 'typedef struct' in line or 'typedef union' in line:
Jon Ashburnea65e492015-08-06 17:27:49 -0600164 if True in [ex_type in line for ex_type in exclude_struct_list]:
165 continue
Chia-I Wu44c99b62015-10-27 19:55:29 +0800166
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600167 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
Chia-I Wu44c99b62015-10-27 19:55:29 +0800168 if ' ' in base_type:
169 (ignored, base_type) = base_type.strip().split(None, 1)
170
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600171 #print("Found STRUCT type: %s" % base_type)
Cody Northrop22b7fae2015-08-11 11:21:48 -0600172 # Note: This really needs to be updated to handle one line struct definition, like
173 # typedef struct obj##_T { uint64_t handle; } obj;
174 if ('{' == base_type or not (' ' in base_type)):
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600175 base_type = 'tmp_struct'
Cody Northrop22b7fae2015-08-11 11:21:48 -0600176 parse_struct = True
177 self.types_dict[base_type] = 'struct'
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600178# elif 'typedef union' in line:
179# (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
180# print("Found UNION type: %s" % base_type)
181# parse_struct = True
182# self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600183 elif '}' in line and (parse_enum or parse_struct):
184 if len(line.split()) > 1: # deals with embedded union in one struct
185 parse_enum = False
186 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700187 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600188 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600189 (cur_char, targ_type) = line.strip().split(None, 1)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600190 if 'tmp_struct' == base_type:
191 base_type = targ_type.strip(';')
Ian Elliott7e40db92015-08-21 15:09:33 -0600192 if True in [ex_type in base_type for ex_type in exclude_struct_list]:
193 del self.struct_dict['tmp_struct']
194 continue
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600195 #print("Found Actual Struct type %s" % base_type)
196 self.struct_dict[base_type] = self.struct_dict['tmp_struct']
197 self.struct_dict.pop('tmp_struct', 0)
Tobin Ehlis37649692016-02-10 15:32:46 -0700198 struct_order_list.append(base_type)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600199 self.types_dict[base_type] = 'struct'
200 self.types_dict.pop('tmp_struct', 0)
201 elif 'tmp_enum' == base_type:
202 base_type = targ_type.strip(';')
203 #print("Found Actual ENUM type %s" % base_type)
204 for n in self.enum_val_dict:
205 if 'tmp_enum' == self.enum_val_dict[n]['type']:
206 self.enum_val_dict[n]['type'] = base_type
207# self.enum_val_dict[base_type] = self.enum_val_dict['tmp_enum']
208# self.enum_val_dict.pop('tmp_enum', 0)
209 self.enum_type_dict[base_type] = self.enum_type_dict['tmp_enum']
210 self.enum_type_dict.pop('tmp_enum', 0)
211 self.types_dict[base_type] = 'enum'
212 self.types_dict.pop('tmp_enum', 0)
Tobin Ehlis37649692016-02-10 15:32:46 -0700213 if ifdef_active:
214 ifdef_dict[base_type] = ifdef_txt
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600215 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
216 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600217 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600218 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600219 #if 'VK_MAX_ENUM' not in line and '{' not in line:
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600220 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 -0700221 self._add_enum(line, base_type, default_enum_val)
222 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600223 elif parse_struct:
224 if ';' in line:
225 self._add_struct(line, base_type, member_num)
226 member_num = member_num + 1
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600227
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600228 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700229 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600230 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700231 if '=' in line_txt:
232 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
233 else:
234 enum_name = line_txt.split(',')[0]
235 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600236 self.enum_val_dict[enum_name] = {}
237 self.enum_val_dict[enum_name]['type'] = enum_type
238 # strip comma and comment, then extra split in case of no comma w/ comments
239 enum_val = enum_val.strip().split(',', 1)[0]
240 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600241 # Perform conversion of VK_BIT macro
242 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
243 vk_bit_val = self.enum_val_dict[enum_name]['val']
244 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
245 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
246 else:
247 # account for negative values surrounded by parens
248 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700249 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600250 try:
251 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
252 int(self.enum_val_dict[enum_name]['val'], 0)
253 self.enum_val_dict[enum_name]['unique'] = True
254 #print("ENUM has num value")
255 except ValueError:
256 self.enum_val_dict[enum_name]['unique'] = False
257 #print("ENUM is not a number value")
258 # Update enum_type_dict as well
259 if not enum_type in self.enum_type_dict:
260 self.enum_type_dict[enum_type] = []
261 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700262
Jon Ashburnea65e492015-08-06 17:27:49 -0600263 # Return True if struct member is a dynamic array
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700264 # RULES : This is a bit quirky based on the API
265 # NOTE : Changes in API spec may cause these rules to change
266 # 1. There must be a previous uint var w/ 'count' in the name in the struct
267 # 2. Dynam array must have 'const' and '*' qualifiers
268 # 3a. Name of dynam array must end in 's' char OR
269 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
270 def _is_dynamic_array(self, full_type, name):
Tobin Ehlis37649692016-02-10 15:32:46 -0700271 exceptions = ['pEnabledFeatures', 'pWaitDstStageMask', 'pSampleMask']
272 if name in exceptions:
273 return False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700274 if '' != self.last_struct_count_name:
275 if 'const' in full_type and '*' in full_type:
276 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
277 return True
Chia-I Wud50a7d72015-10-26 20:48:51 +0800278
279 # VkWriteDescriptorSet
280 if self.last_struct_count_name == "descriptorCount":
281 return True
282
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700283 return False
284
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600285 # populate struct dicts based on struct lines
286 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
287 def _add_struct(self, line_txt, struct_type, num):
288 #print("Parsing struct line %s" % line_txt)
Courtney Goeltzenleuchter82e72392015-07-10 09:06:56 -0600289 if '{' == struct_type:
290 print("Parsing struct '{' w/ line %s" % line_txt)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600291 if not struct_type in self.struct_dict:
292 self.struct_dict[struct_type] = {}
293 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
294 # TODO : Handle bitfields more correctly
295 members = members.strip().split(':', 1)[0] # strip bitfield element
296 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700297 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600298 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700299 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600300 self.struct_dict[struct_type][num] = {}
301 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700302 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600303 if '*' in member_type:
304 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700305 # TODO : Need more general purpose way here to reduce down to basic type
306 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600307 member_type = member_type.strip('*')
308 else:
309 self.struct_dict[struct_type][num]['ptr'] = False
310 if 'const' in member_type:
311 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600312 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600313 else:
314 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700315 # TODO : There is a bug here where it seems that at the time we do this check,
316 # 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 -0600317 if is_type(member_type, 'struct'):
318 self.struct_dict[struct_type][num]['struct'] = True
319 else:
320 self.struct_dict[struct_type][num]['struct'] = False
321 self.struct_dict[struct_type][num]['type'] = member_type
322 if '[' in member_name:
323 (member_name, array_size) = member_name.split('[', 1)
Tobin Ehlis37649692016-02-10 15:32:46 -0700324 #if 'char' in member_type:
325 # self.struct_dict[struct_type][num]['array'] = False
326 # self.struct_dict[struct_type][num]['array_size'] = 0
327 # self.struct_dict[struct_type][num]['ptr'] = True
328 #else:
329 self.struct_dict[struct_type][num]['array'] = True
330 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700331 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
332 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
333 self.struct_dict[struct_type][num]['array'] = True
334 self.struct_dict[struct_type][num]['dyn_array'] = True
335 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700336 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600337 self.struct_dict[struct_type][num]['array'] = False
338 self.struct_dict[struct_type][num]['array_size'] = 0
339 self.struct_dict[struct_type][num]['name'] = member_name
340
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700341# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600342def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600343 if identifier in types_dict and type_to_check == types_dict[identifier]:
344 return True
345 if identifier in typedef_rev_dict:
346 new_id = typedef_rev_dict[identifier]
347 if new_id in types_dict and type_to_check == types_dict[new_id]:
348 return True
349 return False
350
351# This is a validation function to verify that we can reproduce the original structs
352def recreate_structs():
353 for struct_name in struct_dict:
354 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
355 for mem_num in sorted(struct_dict[struct_name]):
356 sys.stdout.write(" ")
357 if struct_dict[struct_name][mem_num]['const']:
358 sys.stdout.write("const ")
359 #if struct_dict[struct_name][mem_num]['struct']:
360 # sys.stdout.write("struct ")
361 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
362 if struct_dict[struct_name][mem_num]['ptr']:
363 sys.stdout.write("*")
364 sys.stdout.write(" ")
365 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
366 if struct_dict[struct_name][mem_num]['array']:
367 sys.stdout.write("[")
368 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
369 sys.stdout.write("]")
370 sys.stdout.write(";\n")
371 sys.stdout.write("} ")
372 sys.stdout.write(typedef_fwd_dict[struct_name])
373 sys.stdout.write(";\n\n")
374
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600375#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600376# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600377def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600378 # Note: All struct types are now camel-case
Karl Schultz7b74e112016-02-12 13:50:13 -0700379 # Debug Report has an inconsistency - so need special case.
380 if ("VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT" == struct_type):
381 return "VkDebugReportCallbackCreateInfoEXT"
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600382 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600383 char_idx = 0
384 struct_name = ''
385 for char in caps_struct_name:
386 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
387 struct_name += caps_struct_name[char_idx]
388 elif (caps_struct_name[char_idx] == '_'):
389 pass
390 else:
391 struct_name += caps_struct_name[char_idx].lower()
392 char_idx += 1
Chia-I Wu3432a0c2015-10-27 18:04:07 +0800393
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600394 return struct_name
395
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600396# class for writing common file elements
397# Here's how this class lays out a file:
398# COPYRIGHT
399# HEADER
400# BODY
401# FOOTER
402#
403# For each of these sections, there's a "set*" function
404# The class as a whole has a generate function which will write each section in order
405class CommonFileGen:
406 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
407 self.filename = filename
408 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
409 # TODO : Set a default copyright & footer at least
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600410
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600411 def setFilename(self, filename):
412 self.filename = filename
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600413
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600414 def setCopyright(self, c):
415 self.contents['copyright'] = c
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600416
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600417 def setHeader(self, h):
418 self.contents['header'] = h
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600419
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600420 def setBody(self, b):
421 self.contents['body'] = b
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600422
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600423 def setFooter(self, f):
424 self.contents['footer'] = f
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600425
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600426 def generate(self):
427 #print("Generate to file %s" % self.filename)
428 with open(self.filename, "w") as f:
429 f.write(self.contents['copyright'])
430 f.write(self.contents['header'])
431 f.write(self.contents['body'])
432 f.write(self.contents['footer'])
433
434# class for writing a wrapper class for structures
435# The wrapper class wraps the structs and includes utility functions for
436# setting/getting member values and displaying the struct data in various formats
437class StructWrapperGen:
438 def __init__(self, in_struct_dict, prefix, out_dir):
439 self.struct_dict = in_struct_dict
440 self.include_headers = []
Jon Ashburnea65e492015-08-06 17:27:49 -0600441 self.lineinfo = sourcelineinfo()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600442 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600443 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600444 self.api_prefix = "vk"
445 else:
446 self.api_prefix = prefix
447 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
448 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
Tobin Ehlis37649692016-02-10 15:32:46 -0700449 self.safe_struct_header_filename = os.path.join(out_dir, self.api_prefix+"_safe_struct.h")
450 self.safe_struct_source_filename = os.path.join(out_dir, self.api_prefix+"_safe_struct.cpp")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600451 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
452 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
453 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
454 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
455 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700456 self.no_addr = False
Tobin Ehlis37649692016-02-10 15:32:46 -0700457 # Safe Struct (ss) header and source files
458 self.ssh = CommonFileGen(self.safe_struct_header_filename)
459 self.sss = CommonFileGen(self.safe_struct_source_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600460 self.hfg = CommonFileGen(self.header_filename)
461 self.cfg = CommonFileGen(self.class_filename)
462 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700463 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700464 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600465 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
466 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600467 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700468 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600469 #print(self.header_filename)
470 self.header_txt = ""
471 self.definition_txt = ""
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600472
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600473 def set_include_headers(self, include_headers):
474 self.include_headers = include_headers
475
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700476 def set_no_addr(self, no_addr):
477 self.no_addr = no_addr
478 if self.no_addr:
479 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700480 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700481 else:
482 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700483 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700484
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600485 # Return class name for given struct name
486 def get_class_name(self, struct_name):
487 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
488 return class_name
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600489
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600490 def get_file_list(self):
491 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
492
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600493 # Generate class header file
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600494 def generateHeader(self):
495 self.hfg.setCopyright(self._generateCopyright())
496 self.hfg.setHeader(self._generateHeader())
497 self.hfg.setBody(self._generateClassDeclaration())
498 self.hfg.setFooter(self._generateFooter())
499 self.hfg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600500
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600501 # Generate class definition
502 def generateBody(self):
503 self.cfg.setCopyright(self._generateCopyright())
504 self.cfg.setHeader(self._generateCppHeader())
505 self.cfg.setBody(self._generateClassDefinition())
506 self.cfg.setFooter(self._generateFooter())
507 self.cfg.generate()
508
Tobin Ehlis37649692016-02-10 15:32:46 -0700509 # Safe Structs are versions of vulkan structs with non-const safe ptrs
510 # that make shadowing structures and clean-up of shadowed structures very simple
511 def generateSafeStructHeader(self):
512 self.ssh.setCopyright(self._generateCopyright())
513 self.ssh.setHeader(self._generateSafeStructHeader())
514 self.ssh.setBody(self._generateSafeStructDecls())
515 self.ssh.generate()
516
517 def generateSafeStructs(self):
518 self.sss.setCopyright(self._generateCopyright())
519 self.sss.setHeader(self._generateSafeStructSourceHeader())
520 self.sss.setBody(self._generateSafeStructSource())
521 self.sss.generate()
522
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600523 # Generate c-style .h file that contains functions for printing structs
524 def generateStringHelper(self):
525 print("Generating struct string helper")
526 self.shg.setCopyright(self._generateCopyright())
527 self.shg.setHeader(self._generateStringHelperHeader())
528 self.shg.setBody(self._generateStringHelperFunctions())
529 self.shg.generate()
530
Tobin Ehlis99f88672015-01-10 12:42:41 -0700531 # Generate cpp-style .h file that contains functions for printing structs
532 def generateStringHelperCpp(self):
533 print("Generating struct string helper cpp")
534 self.shcppg.setCopyright(self._generateCopyright())
535 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
536 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
537 self.shcppg.generate()
538
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700539 # Generate c-style .h file that contains functions for printing structs
540 def generateValidateHelper(self):
541 print("Generating struct validate helper")
542 self.vhg.setCopyright(self._generateCopyright())
543 self.vhg.setHeader(self._generateValidateHelperHeader())
544 self.vhg.setBody(self._generateValidateHelperFunctions())
545 self.vhg.generate()
546
Tobin Ehlis60354772015-03-12 14:50:40 -0600547 def generateSizeHelper(self):
548 print("Generating struct size helper")
549 self.size_helper_gen.setCopyright(self._generateCopyright())
550 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
551 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
552 self.size_helper_gen.generate()
553
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700554 def generateSizeHelperC(self):
555 print("Generating struct size helper c")
556 self.size_helper_c_gen.setCopyright(self._generateCopyright())
557 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
558 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
559 self.size_helper_c_gen.generate()
560
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600561 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700562 copyright = []
563 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
564 copyright.append('');
565 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600566 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700567 copyright.append(' *');
Karl Schultz8e42f402016-02-02 19:32:33 -0700568 copyright.append(' * Copyright (c) 2015-2016 The Khronos Group Inc.');
569 copyright.append(' * Copyright (c) 2015-2016 Valve Corporation.');
570 copyright.append(' * Copyright (c) 2015-2016 LunarG, Inc.');
571 copyright.append(' * Copyright (c) 2015-2016 Google Inc.');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700572 copyright.append(' *');
Jon Ashburn3ebf1252016-04-19 11:30:31 -0600573 copyright.append(' * Licensed under the Apache License, Version 2.0 (the "License");');
574 copyright.append(' * you may not use this file except in compliance with the License.');
575 copyright.append(' * You may obtain a copy of the License at');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700576 copyright.append(' *');
Jon Ashburn3ebf1252016-04-19 11:30:31 -0600577 copyright.append(' * http://www.apache.org/licenses/LICENSE-2.0');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700578 copyright.append(' *');
Jon Ashburn3ebf1252016-04-19 11:30:31 -0600579 copyright.append(' * Unless required by applicable law or agreed to in writing, software');
580 copyright.append(' * distributed under the License is distributed on an "AS IS" BASIS,');
581 copyright.append(' * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.');
582 copyright.append(' * See the License for the specific language governing permissions and');
583 copyright.append(' * limitations under the License.');
Karl Schultz8e42f402016-02-02 19:32:33 -0700584 copyright.append(' *');
585 copyright.append(' * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>');
586 copyright.append(' * Author: Tobin Ehlis <tobin@lunarg.com>');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700587 copyright.append(' */');
588 copyright.append('');
589 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600590
591 def _generateCppHeader(self):
592 header = []
593 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600594 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 -0600595 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600596
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600597 def _generateClassDefinition(self):
598 class_def = []
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600599 if 'vk' == self.api:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600600 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700601 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600602 class_def.append("\n// %s class definition" % self.get_class_name(s))
603 class_def.append(self._generateConstructorDefinitions(s))
604 class_def.append(self._generateDestructorDefinitions(s))
605 class_def.append(self._generateDisplayDefinitions(s))
606 return "\n".join(class_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600607
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600608 def _generateConstructorDefinitions(self, s):
609 con_defs = []
610 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)))
611 # TODO : This is a shallow copy of ptrs
612 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]))
613 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]))
614 return "\n".join(con_defs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600615
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600616 def _generateDestructorDefinitions(self, s):
617 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
Mark Lobodzinski28b8f022015-08-27 15:30:29 -0600618
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600619 def _generateDynamicPrintFunctions(self):
620 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600621 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 -0600622 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600623 dp_funcs.append(" switch (sType)\n {")
624 for e in enum_type_dict:
625 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600626 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600627 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600628 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +0800629 if struct_name not in self.struct_dict:
630 continue
631
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600632 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600633 instance_name = "swc%i" % class_num
634 dp_funcs.append(" case %s:\n {" % (v))
635 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
636 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
637 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
638 dp_funcs.append(" }")
639 dp_funcs.append(" break;")
640 class_num += 1
641 dp_funcs.append(" }")
642 dp_funcs.append("}\n")
643 return "\n".join(dp_funcs)
644
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700645 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600646 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700647
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600648 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700649 return self._get_func_name(struct, 'print')
650
651 def _get_vh_func_name(self, struct):
652 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600653
Tobin Ehlis60354772015-03-12 14:50:40 -0600654 def _get_size_helper_func_name(self, struct):
655 return self._get_func_name(struct, 'size')
656
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600657 # Return elements to create formatted string for given struct member
658 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
659 struct_op = "->"
660 if not struct_ptr:
661 struct_op = "."
662 member_name = struct_member['name']
663 print_type = "p"
664 cast_type = ""
665 member_post = ""
666 array_index = ""
667 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700668 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700669 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
670 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
671 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600672 print_type = "s"
673 print_array = False
674 elif struct_member['array'] and not print_array:
675 # Just print base address of array when not full print_array
676 cast_type = "(void*)"
677 elif is_type(struct_member['type'], 'enum'):
678 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700679 if struct_member['ptr']:
680 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600681 print_type = "s"
682 elif is_type(struct_member['type'], 'struct'): # print struct address for now
683 cast_type = "(void*)"
684 if not struct_member['ptr']:
685 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -0600686 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600687 print_type = "s"
688 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700689 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600690 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600691 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
692 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700693 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600694 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600695 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700696 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
697 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600698 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 -0600699 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700700 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600701 print_type = "i"
702 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600703 pass
704 else:
705 #print("Unhandled struct type: %s" % struct_member['type'])
706 cast_type = "(void*)"
707 if print_array and struct_member['array']:
708 member_print_post = "[%u]"
709 array_index = " i,"
710 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700711 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 -0600712 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 -0700713 if self.no_addr and "p" == print_type:
714 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
715 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600716 return (print_out, print_arg)
717
718 def _generateStringHelperFunctions(self):
719 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700720 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700721 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700722 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
723 sh_funcs.append('')
724 sh_funcs.append('#if defined(_WIN32)')
725 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
726 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
727 sh_funcs.append('// work-around.')
728 sh_funcs.append('#define snprintf _snprintf')
729 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700730 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600731 p_out = ""
732 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700733 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 -0700734 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700735 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700736 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
737 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700738 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]))
739 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700740 num_stps = len(stp_list);
741 total_strlen_str = ''
742 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700743 sh_funcs.append(" char* tmpStr;")
744 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
745 sh_funcs.append(' strcpy(extra_indent, " ");')
746 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
747 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700748 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700749 # If it's an array, print all of the elements
750 # If it's a ptr, print thing it's pointing to
751 # Non-ptr struct case. Print the struct using its address
752 struct_deref = '&'
753 if 1 < stp_list[index]['full_type'].count('*'):
754 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700755 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700756 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700757 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700758 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
759 sh_funcs.append(' len = 256+strlen(tmpStr);')
760 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700761 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700762 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700763 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700764 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
765 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700766 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700767 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
768 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600769 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 -0700770 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700771 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
772 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
773 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700774 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700775 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 -0700776 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700777 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']))
778 sh_funcs.append(' }')
779 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
780 elif stp_list[index]['array']:
781 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
782 sh_funcs.append(' len = 256+strlen(tmpStr);')
783 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700784 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700785 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 -0700786 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700787 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 -0700788 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700789 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
790 sh_funcs.append(' len = 256+strlen(tmpStr);')
791 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700792 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700793 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 -0700794 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700795 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 -0700796 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700797 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
798 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700799 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600800 for m in sorted(self.struct_dict[s]):
801 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
802 p_out += p_out1
803 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600804 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700805 p_args += ");"
806 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700807 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700808 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
809 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
810 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
811 sh_funcs.append(' free(stp_strs[stp_index]);')
812 sh_funcs.append(' }')
813 sh_funcs.append(' }')
814 sh_funcs.append(' free(extra_indent);')
815 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600816 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700817 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
818 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
819 sh_funcs.append(" if (pStruct == NULL) {")
820 sh_funcs.append(" return NULL;")
821 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600822 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700823 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
824 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600825 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600826 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600827 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600828 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +0800829 if struct_name not in self.struct_dict:
830 continue
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600831 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700832 sh_funcs.append(' case %s:\n {' % (v))
833 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
834 sh_funcs.append(' }')
835 sh_funcs.append(' break;')
836 sh_funcs.append(" default:")
837 sh_funcs.append(" return NULL;")
838 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600839 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700840 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700841
842 def _generateStringHelperFunctionsCpp(self):
843 # declare str & tmp str
844 # declare array of stringstreams for every struct ptr in current struct
845 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700846 # For every struct ptr, if non-Null, then set its string, else set to NULL str
847 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700848 # create and return final string
849 sh_funcs = []
850 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600851 # XXX - REMOVE this comment
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600852 lineinfo = sourcelineinfo()
853 sh_funcs.append('%s' % lineinfo.get())
Ian Elliottf6b168c2015-12-11 15:03:05 -0700854 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
855 'VkMirSurfaceCreateInfoKHR',
856 'VkWaylandSurfaceCreateInfoKHR',
857 'VkXlibSurfaceCreateInfoKHR']
858 if sys.platform == 'win32':
859 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
860 else:
861 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700862 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -0700863 if (typedef_fwd_dict[s] not in exclude_struct_list):
Michael Lentine33d96a32016-01-05 11:10:15 -0600864 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
865 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Cody Northrop0a179fe2016-02-24 12:28:41 -0700866 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
867 sh_funcs.append("#ifdef VK_USE_PLATFORM_WIN32_KHR")
Ian Elliottf6b168c2015-12-11 15:03:05 -0700868 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
Cody Northrop0a179fe2016-02-24 12:28:41 -0700869 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
870 sh_funcs.append("#endif //VK_USE_PLATFORM_WIN32_KHR")
Michael Lentine33d96a32016-01-05 11:10:15 -0600871 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
872 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700873 sh_funcs.append('\n')
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600874 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -0700875 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600876 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 -0700877 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 -0700878 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700879 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700880 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 -0600881 # TODO: This is a tmp workaround
882 if 'ppActiveLayerNames' not in self.struct_dict[s][m]['name']:
883 stp_list.append(self.struct_dict[s][m])
Ian Elliottf6b168c2015-12-11 15:03:05 -0700884 if (typedef_fwd_dict[s] in exclude_struct_list):
885 continue
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600886 sh_funcs.append('%s' % lineinfo.get())
Michael Lentine33d96a32016-01-05 11:10:15 -0600887 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
888 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Cody Northrop0a179fe2016-02-24 12:28:41 -0700889 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
890 sh_funcs.append("#ifdef VK_USE_PLATFORM_WIN32_KHR")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700891 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 -0600892 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700893 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600894 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700895 sh_funcs.append('%sstring final_str;' % (indent))
896 sh_funcs.append('%sstring tmp_str;' % (indent))
897 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700898 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700899 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700900 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600901 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700902 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700903 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700904 idx_ss_decl = False # Make sure to only decl this once
905 for index in range(num_stps):
906 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700907 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700908 addr_char = ''
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600909 if stp_list[index]['array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600910 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700911 if stp_list[index]['dyn_array']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600912 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700913 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
914 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600915 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700916 array_count = '%s' % (stp_list[index]['array_size'])
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600917 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700918 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
919 if not idx_ss_decl:
920 sh_funcs.append('%sstringstream index_ss;' % (indent))
921 idx_ss_decl = True
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600922 if (stp_list[index]['name'] == 'pQueueFamilyIndices'):
Ian Elliott05846062015-11-20 14:13:17 -0700923 if (typedef_fwd_dict[s] == 'VkSwapchainCreateInfoKHR'):
924 sh_funcs.append('%sif (pStruct->imageSharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent))
925 else:
926 sh_funcs.append('%sif (pStruct->sharingMode == VK_SHARING_MODE_CONCURRENT) {' % (indent))
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600927 indent += ' '
Mark Lobodzinski80971c62016-01-08 14:52:49 -0700928 if (stp_list[index]['name'] == 'pImageInfo'):
929 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER) ||' % (indent))
930 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER) ||' % (indent))
931 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) ||' % (indent))
932 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE)) {' % (indent))
933 indent += ' '
934 elif (stp_list[index]['name'] == 'pBufferInfo'):
935 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER) ||' % (indent))
936 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||' % (indent))
937 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||' % (indent))
938 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {' % (indent))
939 indent += ' '
940 elif (stp_list[index]['name'] == 'pTexelBufferView'):
941 sh_funcs.append('%sif ((pStruct->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER) ||' % (indent))
942 sh_funcs.append('%s (pStruct->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER)) {' % (indent))
943 indent += ' '
Michael Lentine0a369f62016-02-03 16:51:46 -0600944 if stp_list[index]['dyn_array']:
945 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
946 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700947 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600948 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700949 sh_funcs.append('%sindex_ss.str("");' % (indent))
950 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600951 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600952 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700953 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600954 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
955 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 -0700956 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 -0600957 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600958 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700959 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
960 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']))
961 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600962 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700963 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
964 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600965 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700966 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 -0600967 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600968 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -0600969 addr_char = ''
Karl Schultzcb855192016-03-04 15:20:27 -0700970 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
Courtney Goeltzenleuchter44981552015-10-23 15:48:32 -0600971 if stp_list[index]['type'] in vulkan.core.objects:
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600972 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "].handle = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
973 else:
Tobin Ehlisa30e7e52015-07-06 14:02:36 -0600974 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 -0600975 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700976 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600977 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700978 sh_funcs.append('%s}' % (indent))
Michael Lentine0a369f62016-02-03 16:51:46 -0600979 if stp_list[index]['dyn_array']:
980 indent = indent[4:]
981 sh_funcs.append('%s}' % (indent))
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600982 #endif
Mark Lobodzinski80971c62016-01-08 14:52:49 -0700983 if (stp_list[index]['name'] == 'pQueueFamilyIndices') or (stp_list[index]['name'] == 'pImageInfo') or (stp_list[index]['name'] == 'pBufferInfo') or (stp_list[index]['name'] == 'pTexelBufferView'):
Mark Lobodzinski74dfa182015-08-11 09:35:02 -0600984 indent = indent[4:]
985 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700986 elif (stp_list[index]['ptr']):
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600987 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisf03e8cd2015-06-30 15:28:00 -0600988 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
989 indent += ' '
Tobin Ehlis99f88672015-01-10 12:42:41 -0700990 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600991 sh_funcs.append('%s' % lineinfo.get())
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600992 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700993 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700994 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
995 # TODO : This is a quick hack to handle these arrays of ptrs
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600996 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600997 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 -0700998 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -0600999 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001000 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 -07001001 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
1002 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001003 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001004 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
1005 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001006 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001007 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
1008 sh_funcs.append(' ss[%u].str("");' % (index))
1009 sh_funcs.append(' }')
1010 sh_funcs.append(' else')
1011 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001012 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001013 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001014 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
1015 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
1016 if self.no_addr:
1017 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001018 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001019 else:
1020 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 -06001021 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001022 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -06001023 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -07001024 index = 0
1025 final_str = ''
1026 for m in sorted(self.struct_dict[s]):
1027 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
1028 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
1029 if self.no_addr:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001030 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001031 sh_funcs.append(' ss[%u].str("addr");' % (index))
1032 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001033 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001034 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Jon Ashburnc669cc62015-07-09 15:02:25 -06001035 elif self.struct_dict[s][m]['array']:
1036 sh_funcs.append('%s' % lineinfo.get())
1037 sh_funcs.append(' ss[%u] << (void*)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001038 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001039 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001040 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001041 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001042 sh_funcs.append('%s' % lineinfo.get())
Jon Ashburnc669cc62015-07-09 15:02:25 -06001043 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -06001044 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001045 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis17f45a62015-04-28 17:27:16 -06001046 sh_funcs.append(' if (StreamControl::writeAddress)')
1047 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
1048 sh_funcs.append(' else')
1049 sh_funcs.append(' ss[%u].str("address");' % (index))
Mark Youngd46f6e92016-01-27 17:46:16 -07001050 elif 'char' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
1051 sh_funcs.append('%s' % lineinfo.get())
Jon Ashburn34edc122016-03-10 14:21:09 -07001052 sh_funcs.append(' if (pStruct->%s != NULL) {' % self.struct_dict[s][m]['name'])
1053 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
1054 sh_funcs.append(' } else {')
1055 sh_funcs.append(' ss[%u] << "";' % index)
1056 sh_funcs.append(' }')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001057 else:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001058 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001059 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001060 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001061 sh_funcs.append(' ss[%u].str("addr");' % (index))
Tobin Ehlisa30e7e52015-07-06 14:02:36 -06001062 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 +08001063 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis99f88672015-01-10 12:42:41 -07001064 else:
1065 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
1066 value_print = 'ss[%u].str()' % index
1067 index += 1
1068 else:
Tobin Ehlisce320942015-06-11 09:37:00 -06001069 # 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 -07001070 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001071 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlisce320942015-06-11 09:37:00 -06001072 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
1073 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
1074 sh_funcs.append(' else')
1075 sh_funcs.append(' ss[%u].str("NULL");' % (index))
1076 value_print = 'ss[%u].str()' % index
1077 index += 1
1078 # For single enum just print the string representation
1079 else:
1080 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 -07001081 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
1082 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001083 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -07001084 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001085 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001086 sh_funcs.append(' final_str = %s;' % final_str)
1087 sh_funcs.append(' return final_str;\n}')
Cody Northrop0a179fe2016-02-24 12:28:41 -07001088 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
1089 sh_funcs.append("#endif //VK_USE_PLATFORM_WIN32_KHR")
Michael Lentine33d96a32016-01-05 11:10:15 -06001090 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1091 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis291cd702015-01-20 09:48:48 -07001092 # Add function to return a string value for input void*
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001093 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis291cd702015-01-20 09:48:48 -07001094 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001095 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -07001096 sh_funcs.append(" stringstream ss;")
1097 sh_funcs.append(' ss << toString;')
1098 sh_funcs.append(' string final_str = prefix + ss.str();')
1099 sh_funcs.append(" return final_str;")
1100 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001101 sh_funcs.append('%s' % lineinfo.get())
Tony Barbourb5d2c942015-07-14 13:34:05 -06001102 # Add function to return a string value for input uint64_t
1103 sh_funcs.append("string string_convert_helper(const uint64_t toString, const string prefix)\n{")
Tobin Ehlis08541742015-04-16 15:56:11 -06001104 sh_funcs.append(" using namespace StreamControl;")
1105 sh_funcs.append(" stringstream ss;")
1106 sh_funcs.append(' ss << toString;')
1107 sh_funcs.append(' string final_str = prefix + ss.str();')
1108 sh_funcs.append(" return final_str;")
1109 sh_funcs.append("}")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001110 sh_funcs.append('%s' % lineinfo.get())
Ian Elliott7e40db92015-08-21 15:09:33 -06001111 # Add function to return a string value for input VkSurfaceFormatKHR*
1112 sh_funcs.append("string string_convert_helper(VkSurfaceFormatKHR toString, const string prefix)\n{")
1113 sh_funcs.append(' string final_str = prefix + "format = " + string_VkFormat(toString.format) + "format = " + string_VkColorSpaceKHR(toString.colorSpace);')
Ian Elliott2b6b68a2015-08-07 14:11:14 -06001114 sh_funcs.append(" return final_str;")
1115 sh_funcs.append("}")
1116 sh_funcs.append('%s' % lineinfo.get())
Tobin Ehlis99f88672015-01-10 12:42:41 -07001117 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001118 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001119 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -07001120 sh_funcs.append(" if (pStruct == NULL) {\n")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001121 sh_funcs.append(" return string();")
Ian Elliott82800022015-02-25 17:40:38 -07001122 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001123 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001124 sh_funcs.append(' string indent = " ";')
1125 sh_funcs.append(' indent += prefix;')
1126 sh_funcs.append(" switch (sType)\n {")
1127 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001128 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001129 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001130 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001131 if struct_name not in self.struct_dict:
1132 continue
Tobin Ehlis99f88672015-01-10 12:42:41 -07001133 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001134 #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 -07001135 sh_funcs.append(' case %s:\n {' % (v))
1136 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
1137 sh_funcs.append(' }')
1138 sh_funcs.append(' break;')
1139 sh_funcs.append(" default:")
Michael Lentinefb3b23b2015-10-23 12:40:50 -07001140 sh_funcs.append(" return string();")
Tobin Ehlis08fafd02015-06-12 12:49:01 -06001141 sh_funcs.append('%s' % lineinfo.get())
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001142 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001143 sh_funcs.append("}")
1144 return "\n".join(sh_funcs)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001145
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001146 def _genStructMemberPrint(self, member, s, array, struct_array):
1147 (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)
1148 extra_indent = ""
1149 if array:
1150 extra_indent = " "
1151 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
1152 struct_array.insert(0, self.struct_dict[s][member])
1153 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001154 # Special case for void* named "pNext"
1155 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001156 struct_array.insert(0, self.struct_dict[s][member])
1157 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
1158
1159 def _generateDisplayDefinitions(self, s):
1160 disp_def = []
1161 struct_array = []
1162 # Single-line struct print function
1163 disp_def.append("// Output 'structname = struct_address' on a single line")
1164 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
1165 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1166 disp_def.append("}\n")
1167 # Private helper function to print struct members
1168 disp_def.append("// Private helper function that displays the members of the wrapped struct")
1169 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
1170 i_declared = False
1171 for member in sorted(self.struct_dict[s]):
1172 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001173 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001174 # Can grab struct type off of header of struct pointed to
1175 # TODO : Handle Arrays
1176 if self.struct_dict[s][member]['array']:
1177 # Create for loop to print each element of array
1178 if not i_declared:
1179 disp_def.append(' uint32_t i;')
1180 i_declared = True
1181 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
1182 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
1183 disp_def.append(return_str)
1184 disp_def.append(' }')
1185 else:
1186 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
1187 disp_def.append(return_str)
1188 disp_def.append("}\n")
1189 i_declared = False
1190 # Basic print function to display struct members
1191 disp_def.append("// Output all struct elements, each on their own line")
1192 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
1193 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1194 disp_def.append(' this->display_struct_members();')
1195 disp_def.append("}\n")
1196 # Advanced print function to display current struct and contents of any pointed-to structs
1197 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1198 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1199 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1200 disp_def.append(' this->display_struct_members();')
1201 class_num = 0
1202 # TODO : Need to handle arrays of structs here
1203 for ms in struct_array:
1204 swc_name = "class%s" % str(class_num)
1205 if ms['array']:
1206 if not i_declared:
1207 disp_def.append(' uint32_t i;')
1208 i_declared = True
1209 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1210 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1211 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1212 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1213 disp_def.append(" %s.display_full_txt();" % (swc_name))
1214 #disp_def.append(' }')
1215 disp_def.append(' }')
1216 elif 'pNext' == ms['name']:
1217 # Need some code trickery here
1218 # I'm thinking have a generated function that takes pNext ptr value
1219 # then it checks sType and in large switch statement creates appropriate
1220 # wrapper class type and then prints contents
1221 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1222 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1223 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1224 disp_def.append(" }")
1225 else:
1226 if ms['ptr']:
1227 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1228 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1229 else:
1230 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1231 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1232 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1233 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1234 class_num += 1
1235 disp_def.append("}\n")
1236 return "\n".join(disp_def)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001237
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001238 def _generateStringHelperHeader(self):
1239 header = []
1240 header.append("//#includes, #defines, globals and such...\n")
1241 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001242 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001243 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001244 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001245 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001246 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001247
1248 def _generateStringHelperHeaderCpp(self):
1249 header = []
1250 header.append("//#includes, #defines, globals and such...\n")
1251 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001252 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001253 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001254 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001255 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001256 header.append('\n')
1257 header.append('namespace StreamControl\n')
1258 header.append('{\n')
1259 header.append('bool writeAddress = true;\n')
1260 header.append('template <typename T>\n')
1261 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1262 header.append('{\n')
1263 header.append(' if(writeAddress)\n')
1264 header.append(' {\n')
1265 header.append(' out.operator<<(pointer);\n')
1266 header.append(' }\n')
1267 header.append(' else\n')
1268 header.append(' {\n')
1269 header.append(' std::operator<<(out, "address");\n')
1270 header.append(' }\n')
1271 header.append(' return out;\n')
1272 header.append('}\n')
1273 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1274 header.append('{\n')
1275 header.append(' return std::operator<<(out, s);\n')
1276 header.append('}\n')
1277 header.append('}\n')
1278 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001279 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001280 return "".join(header)
1281
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001282 def _generateValidateHelperFunctions(self):
1283 sh_funcs = []
1284 # We do two passes, first pass just generates prototypes for all the functsions
Ian Elliottf6b168c2015-12-11 15:03:05 -07001285 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
1286 'VkMirSurfaceCreateInfoKHR',
1287 'VkWaylandSurfaceCreateInfoKHR',
1288 'VkXlibSurfaceCreateInfoKHR']
1289 if sys.platform == 'win32':
1290 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
1291 else:
1292 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001293 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -07001294 if (typedef_fwd_dict[s] not in exclude_struct_list):
Michael Lentine33d96a32016-01-05 11:10:15 -06001295 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1296 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Cody Northrop0a179fe2016-02-24 12:28:41 -07001297 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
1298 sh_funcs.append("#ifdef VK_USE_PLATFORM_WIN32_KHR")
Ian Elliottf6b168c2015-12-11 15:03:05 -07001299 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
Cody Northrop0a179fe2016-02-24 12:28:41 -07001300 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
1301 sh_funcs.append("#endif //VK_USE_PLATFORM_WIN32_KHR")
Michael Lentine33d96a32016-01-05 11:10:15 -06001302 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1303 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001304 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001305 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -07001306 if (typedef_fwd_dict[s] in exclude_struct_list):
1307 continue
Michael Lentine33d96a32016-01-05 11:10:15 -06001308 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1309 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Cody Northrop0a179fe2016-02-24 12:28:41 -07001310 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
1311 sh_funcs.append("#ifdef VK_USE_PLATFORM_WIN32_KHR")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001312 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1313 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001314 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001315 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 -07001316 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 -07001317 # 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 -07001318 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1319 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001320 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 -07001321 else:
1322 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 -07001323 sh_funcs.append(" return 1;\n}")
Cody Northrop0a179fe2016-02-24 12:28:41 -07001324 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
1325 sh_funcs.append("#endif //VK_USE_PLATFORM_WIN32_KHR")
Michael Lentine33d96a32016-01-05 11:10:15 -06001326 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1327 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001328
1329 return "\n".join(sh_funcs)
1330
1331 def _generateValidateHelperHeader(self):
1332 header = []
1333 header.append("//#includes, #defines, globals and such...\n")
1334 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001335 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001336 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001337 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001338 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001339 return "".join(header)
1340
Tobin Ehlis60354772015-03-12 14:50:40 -06001341 def _generateSizeHelperFunctions(self):
1342 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001343 # just generates prototypes for all the functions
Ian Elliottf6b168c2015-12-11 15:03:05 -07001344 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
1345 'VkMirSurfaceCreateInfoKHR',
1346 'VkWaylandSurfaceCreateInfoKHR',
1347 'VkXlibSurfaceCreateInfoKHR']
1348 if sys.platform == 'win32':
1349 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
1350 else:
1351 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001352 for s in sorted(self.struct_dict):
Ian Elliottf6b168c2015-12-11 15:03:05 -07001353 if (typedef_fwd_dict[s] not in exclude_struct_list):
Michael Lentine33d96a32016-01-05 11:10:15 -06001354 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1355 sh_funcs.append("#ifdef VK_USE_PLATFORM_XCB_KHR")
Cody Northrop0a179fe2016-02-24 12:28:41 -07001356 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
1357 sh_funcs.append("#ifdef VK_USE_PLATFORM_WIN32_KHR")
Ian Elliottf6b168c2015-12-11 15:03:05 -07001358 sh_funcs.append('size_t %s(const %s* pStruct);' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
Cody Northrop0a179fe2016-02-24 12:28:41 -07001359 if (re.match(r'.*Win32.*', typedef_fwd_dict[s])):
1360 sh_funcs.append("#endif //VK_USE_PLATFORM_WIN32_KHR")
Michael Lentine33d96a32016-01-05 11:10:15 -06001361 if (re.match(r'.*Xcb.*', typedef_fwd_dict[s])):
1362 sh_funcs.append("#endif //VK_USE_PLATFORM_XCB_KHR")
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001363 return "\n".join(sh_funcs)
1364
1365
1366 def _generateSizeHelperFunctionsC(self):
1367 sh_funcs = []
1368 # generate function definitions
Jon Ashburn81b1d9c2015-12-29 14:21:25 -07001369 exclude_struct_list = ['VkAndroidSurfaceCreateInfoKHR',
1370 'VkMirSurfaceCreateInfoKHR',
1371 'VkWaylandSurfaceCreateInfoKHR',
1372 'VkXlibSurfaceCreateInfoKHR']
1373 if sys.platform == 'win32':
1374 exclude_struct_list.append('VkXcbSurfaceCreateInfoKHR')
1375 else:
1376 exclude_struct_list.append('VkWin32SurfaceCreateInfoKHR')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001377 for s in sorted(self.struct_dict):
Jon Ashburn81b1d9c2015-12-29 14:21:25 -07001378 if (typedef_fwd_dict[s] in exclude_struct_list):
1379 continue
Tobin Ehlis6dd0fc32016-02-12 14:37:09 -07001380 skip_list = [] # Used when struct elements need to be skipped because size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001381 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1382 indent = ' '
1383 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1384 sh_funcs.append('%sif (pStruct) {' % (indent))
1385 indent = ' '
1386 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1387 i_decl = False
1388 for m in sorted(self.struct_dict[s]):
1389 if m in skip_list:
1390 continue
1391 if self.struct_dict[s][m]['dyn_array']:
1392 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1393 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 +08001394 if 'ppMemoryBarriers' == self.struct_dict[s][m]['name']:
Tobin Ehlis04112922015-03-16 10:44:40 -06001395 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001396 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 -06001397 else:
1398 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 -06001399 else: # This is an array of char* or array of struct ptrs
1400 if not i_decl:
1401 sh_funcs.append('%suint32_t i = 0;' % (indent))
1402 i_decl = True
1403 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1404 indent = ' '
1405 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1406 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']))
1407 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001408 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 -06001409 indent = ' '
1410 sh_funcs.append('%s}' % (indent))
1411 else:
1412 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1413 if not i_decl:
1414 sh_funcs.append('%suint32_t i = 0;' % (indent))
1415 i_decl = True
1416 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1417 indent = ' '
1418 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']))
1419 indent = ' '
1420 sh_funcs.append('%s}' % (indent))
1421 else:
1422 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1423 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1424 if 'char' in self.struct_dict[s][m]['type'].lower():
Karl Schultzc3f09632016-01-27 16:03:49 -07001425 sh_funcs.append('%sstructSize += (pStruct->%s != NULL) ? sizeof(%s)*(1+strlen(pStruct->%s)) : 0;' % (indent, self.struct_dict[s][m]['name'], self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name']))
Tobin Ehlis60354772015-03-12 14:50:40 -06001426 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1427 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 -06001428 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Jon Ashburn81b1d9c2015-12-29 14:21:25 -07001429 if (self.struct_dict[s][m]['type'] != 'xcb_connection_t'):
1430 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
Tobin Ehlis60354772015-03-12 14:50:40 -06001431 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1432 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1433 skip_list.append(m+1)
1434 indent = ' '
1435 sh_funcs.append('%s}' % (indent))
1436 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001437 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
Ian Elliottba042332015-11-18 14:57:08 -07001438 if '_debug_' not in self.header_filename:
Jon Ashburnea65e492015-08-06 17:27:49 -06001439 for follow_chain in [True, False]:
1440 sh_funcs.append('%s' % self.lineinfo.get())
1441 if follow_chain:
1442 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1443 else:
1444 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1445 indent = ' '
1446 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1447 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
1448 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1449 if follow_chain:
1450 sh_funcs.append('%swhile (pNext) {' % (indent))
1451 indent = ' '
1452 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1453 indent += ' '
1454 for e in enum_type_dict:
1455 if 'StructureType' in e:
1456 for v in sorted(enum_type_dict[e]):
1457 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08001458 if struct_name not in self.struct_dict:
1459 continue
1460
Jon Ashburnea65e492015-08-06 17:27:49 -06001461 sh_funcs.append('%scase %s:' % (indent, v))
1462 sh_funcs.append('%s{' % (indent))
1463 indent += ' '
1464 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1465 sh_funcs.append('%sbreak;' % (indent))
1466 indent = indent[:-4]
1467 sh_funcs.append('%s}' % (indent))
1468 sh_funcs.append('%sdefault:' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001469 indent += ' '
Jon Ashburnea65e492015-08-06 17:27:49 -06001470 sh_funcs.append('%sassert(0);' % (indent))
1471 sh_funcs.append('%sstructSize += 0;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001472 indent = indent[:-4]
Tobin Ehlis04112922015-03-16 10:44:40 -06001473 indent = indent[:-4]
1474 sh_funcs.append('%s}' % (indent))
Jon Ashburnea65e492015-08-06 17:27:49 -06001475 if follow_chain:
1476 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
1477 indent = indent[:-4]
1478 sh_funcs.append('%s}' % (indent))
1479 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001480 return "\n".join(sh_funcs)
1481
1482 def _generateSizeHelperHeader(self):
1483 header = []
1484 header.append("//#includes, #defines, globals and such...\n")
1485 for f in self.include_headers:
1486 header.append("#include <%s>\n" % f)
1487 header.append('\n// Function Prototypes\n')
1488 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001489 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001490 return "".join(header)
1491
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001492 def _generateSizeHelperHeaderC(self):
1493 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001494 header.append('#include "vk_struct_size_helper.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001495 header.append('#include <string.h>')
1496 header.append('#include <assert.h>')
1497 header.append('\n// Function definitions\n')
1498 return "\n".join(header)
1499
1500
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001501 def _generateHeader(self):
1502 header = []
1503 header.append("//#includes, #defines, globals and such...\n")
1504 for f in self.include_headers:
1505 header.append("#include <%s>\n" % f)
1506 return "".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001507
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001508 # Declarations
1509 def _generateConstructorDeclarations(self, s):
1510 constructors = []
1511 constructors.append(" %s();\n" % self.get_class_name(s))
1512 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1513 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1514 return "".join(constructors)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001515
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001516 def _generateDestructorDeclarations(self, s):
1517 return " virtual ~%s();\n" % self.get_class_name(s)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001518
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001519 def _generateDisplayDeclarations(self, s):
1520 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001521
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001522 def _generateGetSetDeclarations(self, s):
1523 get_set = []
1524 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1525 for member in sorted(self.struct_dict[s]):
1526 # TODO : Skipping array set/get funcs for now
1527 if self.struct_dict[s][member]['array']:
1528 continue
1529 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']))
1530 if not self.struct_dict[s][member]['const']:
1531 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']))
1532 return "".join(get_set)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001533
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001534 def _generatePrivateMembers(self, s):
1535 priv = []
1536 priv.append("\nprivate:\n")
1537 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1538 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1539 priv.append(" uint32_t m_indent;\n")
1540 priv.append(" const char m_dummy_prefix;\n")
1541 priv.append(" void display_struct_members();\n")
1542 return "".join(priv)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001543
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001544 def _generateClassDeclaration(self):
1545 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001546 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001547 class_decl.append("\n//class declaration")
1548 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1549 class_decl.append(self._generateConstructorDeclarations(s))
1550 class_decl.append(self._generateDestructorDeclarations(s))
1551 class_decl.append(self._generateDisplayDeclarations(s))
1552 class_decl.append(self._generateGetSetDeclarations(s))
1553 class_decl.append(self._generatePrivateMembers(s))
1554 class_decl.append("};\n")
1555 return "\n".join(class_decl)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001556
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001557 def _generateFooter(self):
1558 return "\n//any footer info for class\n"
1559
Tobin Ehlis37649692016-02-10 15:32:46 -07001560 def _getSafeStructName(self, struct):
1561 return "safe_%s" % (struct)
1562
1563 # If struct has sType or ptr members, generate safe type
1564 def _hasSafeStruct(self, s):
1565 exceptions = ['VkPhysicalDeviceFeatures', 'VkPipelineColorBlendStateCreateInfo']
1566 if s in exceptions:
1567 return False
1568 if 'sType' == self.struct_dict[s][0]['name']:
1569 return True
1570 for m in self.struct_dict[s]:
1571 if self.struct_dict[s][m]['ptr']:
1572 return True
1573 return False
1574
1575 def _generateSafeStructHeader(self):
1576 header = []
1577 header.append("//#includes, #defines, globals and such...\n")
1578 header.append('#include "vulkan/vulkan.h"')
1579 return "".join(header)
1580
1581 # If given ty is in obj list, or is a struct that contains anything in obj list, return True
1582 def _typeHasObject(self, ty, obj):
1583 if ty in obj:
1584 return True
1585 if is_type(ty, 'struct'):
1586 for m in self.struct_dict[ty]:
1587 if self.struct_dict[ty][m]['type'] in obj:
1588 return True
1589 return False
1590
1591 def _generateSafeStructDecls(self):
1592 ss_decls = []
1593 for s in struct_order_list:
1594 if not self._hasSafeStruct(s):
1595 continue
1596 if s in ifdef_dict:
1597 ss_decls.append('#ifdef %s' % ifdef_dict[s])
1598 ss_name = self._getSafeStructName(s)
1599 ss_decls.append("\nstruct %s {" % (ss_name))
1600 for m in sorted(self.struct_dict[s]):
1601 m_type = self.struct_dict[s][m]['type']
1602 if is_type(m_type, 'struct') and self._hasSafeStruct(m_type):
1603 m_type = self._getSafeStructName(m_type)
1604 if self.struct_dict[s][m]['array_size'] != 0 and not self.struct_dict[s][m]['dyn_array']:
1605 ss_decls.append(" %s %s[%s];" % (m_type, self.struct_dict[s][m]['name'], self.struct_dict[s][m]['array_size']))
1606 elif self.struct_dict[s][m]['ptr'] and 'safe_' not in m_type and not self._typeHasObject(m_type, vulkan.object_non_dispatch_list):#m_type in ['char', 'float', 'uint32_t', 'void', 'VkPhysicalDeviceFeatures']: # We'll never overwrite char* so it can remain const
1607 ss_decls.append(" %s %s;" % (self.struct_dict[s][m]['full_type'], self.struct_dict[s][m]['name']))
1608 elif self.struct_dict[s][m]['array']:
1609 ss_decls.append(" %s* %s;" % (m_type, self.struct_dict[s][m]['name']))
1610 elif self.struct_dict[s][m]['ptr']:
1611 ss_decls.append(" %s* %s;" % (m_type, self.struct_dict[s][m]['name']))
1612 else:
1613 ss_decls.append(" %s %s;" % (m_type, self.struct_dict[s][m]['name']))
1614 ss_decls.append(" %s(const %s* pInStruct);" % (ss_name, s))
1615 ss_decls.append(" %s();" % (ss_name))
1616 ss_decls.append(" ~%s();" % (ss_name))
1617 ss_decls.append(" void initialize(const %s* pInStruct);" % (s))
1618 ss_decls.append("};")
1619 if s in ifdef_dict:
1620 ss_decls.append('#endif')
1621 return "\n".join(ss_decls)
1622
1623 def _generateSafeStructSourceHeader(self):
1624 header = []
1625 header.append("//#includes, #defines, globals and such...\n")
Tobin Ehlis5f4cef12016-04-01 13:51:33 -06001626 header.append('#include "vk_safe_struct.h"\n#include <string.h>\n\n')
Tobin Ehlis37649692016-02-10 15:32:46 -07001627 return "".join(header)
1628
1629 def _generateSafeStructSource(self):
1630 ss_src = []
1631 for s in struct_order_list:
1632 if not self._hasSafeStruct(s):
1633 continue
1634 if s in ifdef_dict:
1635 ss_src.append('#ifdef %s' % ifdef_dict[s])
1636 ss_name = self._getSafeStructName(s)
1637 init_list = '' # list of members in struct constructor initializer
1638 init_func_txt = '' # Txt for initialize() function that takes struct ptr and inits members
Tobin Ehlis5f4cef12016-04-01 13:51:33 -06001639 construct_txt = '' # Body of constuctor as well as body of initialize() func following init_func_txt
Tobin Ehlis37649692016-02-10 15:32:46 -07001640 destruct_txt = ''
Tobin Ehlis6dd0fc32016-02-12 14:37:09 -07001641 # VkWriteDescriptorSet is special case because pointers may be non-null but ignored
1642 # TODO : This is ugly, figure out better way to do this
1643 custom_construct_txt = {'VkWriteDescriptorSet' :
1644 ' switch (descriptorType) {\n'
1645 ' case VK_DESCRIPTOR_TYPE_SAMPLER:\n'
1646 ' case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:\n'
1647 ' case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:\n'
1648 ' case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:\n'
1649 ' case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:\n'
1650 ' if (descriptorCount && pInStruct->pImageInfo) {\n'
1651 ' pImageInfo = new VkDescriptorImageInfo[descriptorCount];\n'
1652 ' for (uint32_t i=0; i<descriptorCount; ++i) {\n'
1653 ' pImageInfo[i] = pInStruct->pImageInfo[i];\n'
1654 ' }\n'
1655 ' }\n'
1656 ' break;\n'
1657 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:\n'
1658 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:\n'
1659 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:\n'
1660 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:\n'
1661 ' if (descriptorCount && pInStruct->pBufferInfo) {\n'
1662 ' pBufferInfo = new VkDescriptorBufferInfo[descriptorCount];\n'
1663 ' for (uint32_t i=0; i<descriptorCount; ++i) {\n'
1664 ' pBufferInfo[i] = pInStruct->pBufferInfo[i];\n'
1665 ' }\n'
1666 ' }\n'
1667 ' break;\n'
1668 ' case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:\n'
1669 ' case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:\n'
1670 ' if (descriptorCount && pInStruct->pTexelBufferView) {\n'
1671 ' pTexelBufferView = new VkBufferView[descriptorCount];\n'
1672 ' for (uint32_t i=0; i<descriptorCount; ++i) {\n'
1673 ' pTexelBufferView[i] = pInStruct->pTexelBufferView[i];\n'
1674 ' }\n'
1675 ' }\n'
1676 ' break;\n'
Tobin Ehlisd183b2d2016-02-16 12:08:54 -07001677 ' default:\n'
1678 ' break;\n'
Tobin Ehlis6dd0fc32016-02-12 14:37:09 -07001679 ' }\n'}
Tobin Ehlis37649692016-02-10 15:32:46 -07001680 for m in self.struct_dict[s]:
1681 m_name = self.struct_dict[s][m]['name']
1682 m_type = self.struct_dict[s][m]['type']
1683 if is_type(m_type, 'struct') and self._hasSafeStruct(m_type):
1684 m_type = self._getSafeStructName(m_type)
1685 if self.struct_dict[s][m]['ptr'] and 'safe_' not in m_type and not self._typeHasObject(m_type, vulkan.object_non_dispatch_list):# in ['char', 'float', 'uint32_t', 'void', 'VkPhysicalDeviceFeatures']) or 'pp' == self.struct_dict[s][m]['name'][0:1]:
Tobin Ehlis5f4cef12016-04-01 13:51:33 -06001686 # Ptr types w/o a safe_struct, for non-null case need to allocate new ptr and copy data in
1687 if 'KHR' in ss_name or m_type in ['void', 'char']:
1688 # For these exceptions just copy initial value over for now
1689 init_list += '\n\t%s(pInStruct->%s),' % (m_name, m_name)
1690 init_func_txt += ' %s = pInStruct->%s;\n' % (m_name, m_name)
1691 else:
1692 init_list += '\n\t%s(nullptr),' % (m_name)
1693 init_func_txt += ' %s = nullptr;\n' % (m_name)
1694 if 'pNext' != m_name and 'void' not in m_type:
1695 if not self.struct_dict[s][m]['array']:
1696 construct_txt += ' if (pInStruct->%s) {\n' % (m_name)
1697 construct_txt += ' %s = new %s(*pInStruct->%s);\n' % (m_name, m_type, m_name)
1698 construct_txt += ' }\n'
1699 destruct_txt += ' if (%s)\n' % (m_name)
1700 destruct_txt += ' delete %s;\n' % (m_name)
1701 else: # new array and then init each element
1702 construct_txt += ' if (pInStruct->%s) {\n' % (m_name)
1703 construct_txt += ' %s = new %s[pInStruct->%s];\n' % (m_name, m_type, self.struct_dict[s][m]['array_size'])
1704 #construct_txt += ' std::copy (pInStruct->%s, pInStruct->%s+pInStruct->%s, %s);\n' % (m_name, m_name, self.struct_dict[s][m]['array_size'], m_name)
1705 construct_txt += ' memcpy ((void *)%s, (void *)pInStruct->%s, sizeof(%s)*pInStruct->%s);\n' % (m_name, m_name, m_type, self.struct_dict[s][m]['array_size'])
1706 construct_txt += ' }\n'
1707 destruct_txt += ' if (%s)\n' % (m_name)
1708 destruct_txt += ' delete[] %s;\n' % (m_name)
Tobin Ehlis37649692016-02-10 15:32:46 -07001709 elif self.struct_dict[s][m]['array']:
Tobin Ehlis6dd0fc32016-02-12 14:37:09 -07001710 # Init array ptr to NULL
1711 init_list += '\n\t%s(NULL),' % (m_name)
1712 init_func_txt += ' %s = NULL;\n' % (m_name)
Tobin Ehlis37649692016-02-10 15:32:46 -07001713 array_element = 'pInStruct->%s[i]' % (m_name)
1714 if is_type(self.struct_dict[s][m]['type'], 'struct') and self._hasSafeStruct(self.struct_dict[s][m]['type']):
1715 array_element = '%s(&pInStruct->%s[i])' % (self._getSafeStructName(self.struct_dict[s][m]['type']), m_name)
1716 construct_txt += ' if (%s && pInStruct->%s) {\n' % (self.struct_dict[s][m]['array_size'], m_name)
1717 construct_txt += ' %s = new %s[%s];\n' % (m_name, m_type, self.struct_dict[s][m]['array_size'])
1718 destruct_txt += ' if (%s)\n' % (m_name)
1719 destruct_txt += ' delete[] %s;\n' % (m_name)
1720 construct_txt += ' for (uint32_t i=0; i<%s; ++i) {\n' % (self.struct_dict[s][m]['array_size'])
1721 if 'safe_' in m_type:
1722 construct_txt += ' %s[i].initialize(&pInStruct->%s[i]);\n' % (m_name, m_name)
1723 else:
1724 construct_txt += ' %s[i] = %s;\n' % (m_name, array_element)
1725 construct_txt += ' }\n'
Tobin Ehlis37649692016-02-10 15:32:46 -07001726 construct_txt += ' }\n'
1727 elif self.struct_dict[s][m]['ptr']:
1728 construct_txt += ' if (pInStruct->%s)\n' % (m_name)
1729 construct_txt += ' %s = new %s(pInStruct->%s);\n' % (m_name, m_type, m_name)
1730 construct_txt += ' else\n'
1731 construct_txt += ' %s = NULL;\n' % (m_name)
1732 destruct_txt += ' if (%s)\n' % (m_name)
1733 destruct_txt += ' delete %s;\n' % (m_name)
1734 elif 'safe_' in m_type: # inline struct, need to pass in reference for constructor
1735 init_list += '\n\t%s(&pInStruct->%s),' % (m_name, m_name)
1736 init_func_txt += ' %s.initialize(&pInStruct->%s);\n' % (m_name, m_name)
1737 else:
1738 init_list += '\n\t%s(pInStruct->%s),' % (m_name, m_name)
Tobin Ehlis6dd0fc32016-02-12 14:37:09 -07001739 init_func_txt += ' %s = pInStruct->%s;\n' % (m_name, m_name)
Tobin Ehlis37649692016-02-10 15:32:46 -07001740 if '' != init_list:
1741 init_list = init_list[:-1] # hack off final comma
Tobin Ehlis6dd0fc32016-02-12 14:37:09 -07001742 if s in custom_construct_txt:
1743 construct_txt = custom_construct_txt[s]
Tobin Ehlis37649692016-02-10 15:32:46 -07001744 ss_src.append("\n%s::%s(const %s* pInStruct) : %s\n{\n%s}" % (ss_name, ss_name, s, init_list, construct_txt))
1745 ss_src.append("\n%s::%s() {}" % (ss_name, ss_name))
1746 ss_src.append("\n%s::~%s()\n{\n%s}" % (ss_name, ss_name, destruct_txt))
1747 ss_src.append("\nvoid %s::initialize(const %s* pInStruct)\n{\n%s%s}" % (ss_name, s, init_func_txt, construct_txt))
1748 if s in ifdef_dict:
1749 ss_src.append('#endif')
1750 return "\n".join(ss_src)
1751
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001752class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001753 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 -06001754 self.et_dict = enum_type_dict
1755 self.ev_dict = enum_val_dict
1756 self.tf_dict = typedef_fwd_dict
1757 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001758 self.out_sh_file = out_sh_file
1759 self.eshfg = CommonFileGen(self.out_sh_file)
1760 self.out_vh_file = out_vh_file
1761 self.evhfg = CommonFileGen(self.out_vh_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001762
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001763 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001764 self.eshfg.setHeader(self._generateSHHeader())
1765 self.eshfg.setBody(self._generateSHBody())
1766 self.eshfg.generate()
1767
1768 def generateEnumValidate(self):
1769 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001770 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001771 self.evhfg.generate()
1772
1773 def _generateVHBody(self):
1774 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001775 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001776 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001777 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1778 # 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 -06001779 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001780 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1781 body.append(' return 0;')
1782 body.append(' return 1;')
1783 body.append('}\n\n')
1784 else:
1785 body.append(' switch ((%s)input_value)\n {' % (fet))
1786 for e in sorted(self.et_dict[bet]):
1787 if (self.ev_dict[e]['unique']):
1788 body.append(' case %s:' % (e))
1789 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001790 return "\n".join(body)
1791
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001792 def _generateSHBody(self):
1793 body = []
1794# with open(self.out_file, "a") as hf:
1795 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001796 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001797 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001798 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 -06001799 for e in sorted(self.et_dict[bet]):
1800 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001801 body.append(' case %s:\n return "%s";' % (e, e))
1802 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001803 return "\n".join(body)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001804
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001805 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001806 header = []
1807 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001808 header.append('#ifdef _WIN32\n')
1809 header.append('#pragma warning( disable : 4065 )\n')
1810 header.append('#endif\n')
David Pinedo9316d3b2015-11-06 12:54:48 -07001811 header.append('#include <vulkan/%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001812 return "\n".join(header)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001813
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001814
1815class CMakeGen:
1816 def __init__(self, struct_wrapper=None, out_dir=None):
1817 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001818 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001819 self.add_lib_file_list = self.sw.get_file_list()
1820 self.out_dir = out_dir
1821 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1822 self.cmg = CommonFileGen(self.out_file)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001823
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001824 def generate(self):
1825 self.cmg.setBody(self._generateBody())
1826 self.cmg.generate()
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06001827
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001828 def _generateBody(self):
1829 body = []
1830 body.append("project(%s)" % os.path.basename(self.out_dir))
1831 body.append("cmake_minimum_required(VERSION 2.8)\n")
1832 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1833 body.append('set(COMPILE_FLAGS "-fpermissive")')
1834 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1835 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1836 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1837 return "\n".join(body)
1838
1839class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001840 def __init__(self, struct_dict, prefix, out_dir):
1841 self.struct_dict = struct_dict
1842 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001843 if prefix == "vulkan":
1844 self.api_prefix = "vk"
1845 else:
1846 self.api_prefix = prefix
1847 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001848 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001849
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001850 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001851 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001852 self.gvg.setHeader(self._generateHeader())
1853 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001854 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001855 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001856
1857 def set_include_headers(self, include_headers):
1858 self.include_headers = include_headers
1859
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001860 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001861 header = []
1862 header.append("//#includes, #defines, globals and such...\n")
1863 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001864 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001865 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001866 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001867 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001868 return "".join(header)
1869
1870 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001871 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001872
1873 # Return elements to create formatted string for given struct member
1874 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=""):
1875 struct_op = "->"
1876 pre_var_name = '"%s "' % struct_member['full_type']
1877 if not struct_ptr:
1878 struct_op = "."
1879 member_name = struct_member['name']
1880 print_type = "p"
1881 cast_type = ""
1882 member_post = ""
1883 array_index = ""
1884 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001885 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001886 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1887 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001888 print_array = False
1889 elif struct_member['array'] and not print_array:
1890 # Just print base address of array when not full print_array
1891 cast_type = "(void*)"
1892 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001893 if struct_member['ptr']:
1894 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001895 cast_type = "string_%s" % struct_member['type']
1896 print_type = "s"
1897 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1898 cast_type = "(void*)"
1899 if not struct_member['ptr']:
1900 cast_type = "(void*)&"
Courtney Goeltzenleuchtercd2a0992015-07-09 11:44:38 -06001901 elif 'bool' in struct_member['type'].lower():
Tobin Ehlis83562882014-11-27 15:43:39 -07001902 print_type = "s"
1903 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001904 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001905 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001906 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1907 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001908 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001909 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001910 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001911 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1912 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001913 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 -07001914 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001915 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001916 print_type = "i"
1917 elif struct_member['ptr']:
1918 pass
1919 else:
1920 #print("Unhandled struct type: %s" % struct_member['type'])
1921 cast_type = "(void*)"
1922 if print_array and struct_member['array']:
1923 member_print_post = "[%u]"
1924 array_index = " i,"
1925 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001926 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 -06001927 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 -07001928 return (print_out, print_arg)
1929
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001930 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001931 gv_funcs = []
1932 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001933 array_func_list.append('vkbufferviewattachinfo')
1934 array_func_list.append('vkimageviewattachinfo')
1935 array_func_list.append('vksamplerimageviewinfo')
1936 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001937 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001938 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001939 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1940 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001941 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001942 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]))
1943 else:
1944 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 -07001945 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001946 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001947 p_out = ""
1948 p_args = ""
1949 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1950 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1951 pl_dict = {}
1952 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001953 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001954 for m in sorted(self.struct_dict[s]):
1955 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1956 stp_list.append(self.struct_dict[s][m])
1957 if 'pNext' == self.struct_dict[s][m]['name']:
1958 pl_dict[m] = ' PORT=\\"pNext\\"'
1959 else:
1960 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1961 struct_num += 1
1962 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]))
1963 num_stps = len(stp_list);
1964 total_strlen_str = ''
1965 if 0 != num_stps:
1966 gv_funcs.append(" char* tmpStr;\n")
1967 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001968 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1969 for index in range(num_stps):
1970 if (stp_list[index]['ptr']):
1971 if 'pDescriptorInfo' == stp_list[index]['name']:
1972 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1973 else:
1974 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1975 if 'pNext' == stp_list[index]['name']:
1976 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001977 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001978 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1979 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1980 gv_funcs.append(' free(tmpStr);\n')
1981 else:
1982 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 -06001983 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001984 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 -07001985 else:
1986 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1987 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1988 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1989 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001990 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001991 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1992 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1993 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1994 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1995 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1996 else:
1997 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1998 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1999 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
2000 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
2001 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
2002 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
2003 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
2004 p_args = ", myNodeName, myNodeName, pStruct"
2005 for m in sorted(self.struct_dict[s]):
2006 plabel = ""
2007 if m in pl_dict:
2008 plabel = pl_dict[m]
2009 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
2010 p_out += p_out1
2011 p_args += p_args1
2012 p_out += '</TABLE>>\\n];\\n\\n"'
2013 p_args += ");\n"
2014 gv_funcs.append(p_out)
2015 gv_funcs.append(p_args)
2016 if 0 != num_stps:
2017 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
2018 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
2019 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
2020 gv_funcs.append(' free(stp_strs[stp_index]);\n')
2021 gv_funcs.append(' }\n')
2022 gv_funcs.append(' }\n')
2023 gv_funcs.append(" return str;\n}\n")
2024 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07002025 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06002026 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07002027 ptr_array = True
2028 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]))
2029 else:
2030 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 -07002031 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
2032 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')
2033 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
2034 gv_funcs.append(' sprintf(tmpStr, "');
2035 p_args = ""
2036 p_out = ""
2037 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07002038 plabel = ""
2039 (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 -07002040 if 0 == m: # Add array index notation at end of first row
2041 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 -07002042 p_args1 += ', i, i'
2043 p_out += p_out1
2044 p_args += p_args1
2045 p_out += '"'
2046 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07002047 if ptr_array:
2048 p_args = p_args.replace('->', '[i]->')
2049 else:
2050 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07002051 gv_funcs.append(p_out);
2052 gv_funcs.append(p_args);
2053 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
2054 gv_funcs.append(' }\n')
2055 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07002056 gv_funcs.append(' return str;\n}\n')
2057 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06002058 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07002059 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06002060 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07002061 gv_funcs.append(" switch (sType)\n {\n")
2062 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06002063 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07002064 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06002065 struct_name = get_struct_name_from_struct_type(v)
Chia-I Wu736324e2015-10-26 20:42:12 +08002066 if struct_name not in self.struct_dict:
2067 continue
2068
Tobin Ehlis83562882014-11-27 15:43:39 -07002069 print_func_name = self._get_gv_func_name(struct_name)
2070 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06002071 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06002072 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06002073 if 'VkSemaphoreCreateInfo' in struct_name:
2074 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07002075 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06002076 elif 'VkSemaphoreOpenInfo' in struct_name:
2077 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07002078 print_func_name = self._get_gv_func_name(struct_name)
2079 gv_funcs.append(' case %s:\n' % (v))
2080 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
2081 #gv_funcs.append(' }\n')
2082 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08002083 gv_funcs.append(" default:\n")
2084 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07002085 gv_funcs.append(" }\n")
2086 gv_funcs.append("}")
2087 return "".join(gv_funcs)
2088
2089
2090
2091
2092
2093# def _generateHeader(self):
2094# hdr = []
2095# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
2096# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
2097# hdr.append('edge [\n];\n')
2098# return "\n".join(hdr)
Mark Lobodzinski28b8f022015-08-27 15:30:29 -06002099#
Tobin Ehlis83562882014-11-27 15:43:39 -07002100# def _generateBody(self):
2101# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07002102# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07002103# field_num = 1
2104# 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]))
2105# for m in sorted(self.struc_dict[s]):
2106# 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']))
2107# field_num += 2
2108# body.append('</TABLE>>\n];\n')
2109# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06002110
2111def main(argv=None):
2112 opts = handle_args()
2113 # Parse input file and fill out global dicts
2114 hfp = HeaderFileParser(opts.input_file)
2115 hfp.parse()
2116 # TODO : Don't want these to be global, see note at top about wrapper classes
2117 global enum_val_dict
2118 global enum_type_dict
2119 global struct_dict
2120 global typedef_fwd_dict
2121 global typedef_rev_dict
2122 global types_dict
2123 enum_val_dict = hfp.get_enum_val_dict()
2124 enum_type_dict = hfp.get_enum_type_dict()
2125 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07002126 # 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 -06002127 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
2128 typedef_rev_dict = hfp.get_typedef_rev_dict()
2129 types_dict = hfp.get_types_dict()
2130 #print(enum_val_dict)
2131 #print(typedef_dict)
2132 #print(struct_dict)
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07002133 input_header = os.path.basename(opts.input_file)
2134 if 'vulkan.h' == input_header:
2135 input_header = "vulkan/vulkan.h"
Jon Ashburn54e24602016-02-01 17:02:38 -07002136
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06002137 prefix = os.path.basename(opts.input_file).strip(".h")
2138 if prefix == "vulkan":
2139 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06002140 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06002141 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06002142 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06002143 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07002144 enum_sh_filename = os.path.abspath(enum_sh_filename)
2145 if not os.path.exists(os.path.dirname(enum_sh_filename)):
2146 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
2147 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06002148 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07002149 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06002150 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07002151 print("Generating enum validate helper to %s" % enum_vh_filename)
2152 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 -06002153 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07002154 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06002155 #for struct in struct_dict:
2156 #print(struct)
2157 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07002158 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 -06002159 #print(sw.get_class_name(struct))
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07002160 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 -06002161 print("Generating struct wrapper header to %s" % sw.header_filename)
2162 sw.generateHeader()
2163 print("Generating struct wrapper class to %s" % sw.class_filename)
2164 sw.generateBody()
2165 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07002166 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07002167 # Generate a 2nd helper file that excludes addrs
2168 sw.set_no_addr(True)
2169 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07002170 sw.set_no_addr(False)
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07002171 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 -07002172 sw.set_no_addr(True)
2173 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07002174 sw.set_no_addr(False)
2175 sw.generateStringHelperCpp()
Jeremy Hayesdf3f2052015-11-26 13:32:58 -07002176 sw.set_include_headers(["stdio.h", "stdlib.h", input_header])
Tobin Ehlis60354772015-03-12 14:50:40 -06002177 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07002178 sw.generateSizeHelperC()
Tobin Ehlis37649692016-02-10 15:32:46 -07002179 sw.generateSafeStructHeader()
2180 sw.generateSafeStructs()
Jon Ashburnea65e492015-08-06 17:27:49 -06002181 if opts.gen_struct_sizes:
2182 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 -07002183 st.set_include_headers(["stdio.h", "stdlib.h", input_header])
Jon Ashburnea65e492015-08-06 17:27:49 -06002184 st.generateSizeHelper()
2185 st.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06002186 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07002187 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06002188 cmg.generate()
2189 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07002190 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 -07002191 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 -06002192 gv.generate()
2193 print("DONE!")
2194 #print(typedef_rev_dict)
2195 #print(types_dict)
2196 #recreate_structs()
2197
2198if __name__ == "__main__":
2199 sys.exit(main())