blob: 4a7dce5144390674a226effc35bb651f4f999b97 [file] [log] [blame]
Tobin Ehlis33267fd2014-11-10 16:03:19 -07001#!/usr/bin/env python3
2#
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06003# VK
Tobin Ehlis33267fd2014-11-10 16:03:19 -07004#
5# Copyright (C) 2014 LunarG, Inc.
6#
7# Permission is hereby granted, free of charge, to any person obtaining a
8# copy of this software and associated documentation files (the "Software"),
9# to deal in the Software without restriction, including without limitation
10# the rights to use, copy, modify, merge, publish, distribute, sublicense,
11# and/or sell copies of the Software, and to permit persons to whom the
12# Software is furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included
15# in all copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23# DEALINGS IN THE SOFTWARE.
Tobin Ehlis6442dca2014-10-22 15:13:53 -060024import argparse
25import os
26import sys
27
28# code_gen.py overview
29# This script generates code based on input headers
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -060030# Initially it's intended to support Mantle and VK headers and
Tobin Ehlis6442dca2014-10-22 15:13:53 -060031# generate wrappers functions that can be used to display
32# structs in a human-readable txt format, as well as utility functions
33# to print enum values as strings
34
35
36def 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.')
39 parser.add_argument('--rel_out_dir', required=False, default='glave_gen', help='Path relative to exec path to write output files. Will be created if needed.')
40 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.')
43 parser.add_argument('--gen_cmake', required=False, action='store_true', default=False, help='Enable generation of cmake file for generated code.')
44 parser.add_argument('--gen_graphviz', required=False, action='store_true', default=False, help='Enable generation of graphviz dot file.')
45 #parser.add_argument('--test', action='store_true', default=False, help='Run simple test.')
46 return parser.parse_args()
47
48# TODO : Ideally these data structs would be opaque to user and could be wrapped
49# in their own class(es) to make them friendly for data look-up
50# Dicts for Data storage
51# enum_val_dict[value_name] = dict keys are the string enum value names for all enums
52# |-------->['type'] = the type of enum class into which the value falls
53# |-------->['val'] = the value assigned to this particular value_name
54# '-------->['unique'] = bool designating if this enum 'val' is unique within this enum 'type'
55enum_val_dict = {}
56# enum_type_dict['type'] = the type or class of of enum
57# '----->['val_name1', 'val_name2'...] = each type references a list of val_names within this type
58enum_type_dict = {}
59# struct_dict['struct_basename'] = the base (non-typedef'd) name of the struct
60# |->[<member_num>] = members are stored via their integer placement in the struct
61# | |->['name'] = string name of this struct member
62# ... |->['full_type'] = complete type qualifier for this member
63# |->['type'] = base type for this member
64# |->['ptr'] = bool indicating if this member is ptr
65# |->['const'] = bool indicating if this member is const
66# |->['struct'] = bool indicating if this member is a struct type
67# |->['array'] = bool indicating if this member is an array
Tobin Ehlisbd6a9162015-03-13 07:18:05 -060068# |->['dyn_array'] = bool indicating if member is a dynamically sized array
69# '->['array_size'] = For dyn_array, member name used to size array, else int size for static array
Tobin Ehlis6442dca2014-10-22 15:13:53 -060070struct_dict = {}
71# typedef_fwd_dict stores mapping from orig_type_name -> new_type_name
72typedef_fwd_dict = {}
73# typedef_rev_dict stores mapping from new_type_name -> orig_type_name
74typedef_rev_dict = {} # store new_name -> orig_name mapping
75# types_dict['id_name'] = identifier name will map to it's type
76# '---->'type' = currently either 'struct' or 'enum'
77types_dict = {} # store orig_name -> type mapping
78
79
80# Class that parses header file and generates data structures that can
81# Then be used for other tasks
82class HeaderFileParser:
83 def __init__(self, header_file=None):
84 self.header_file = header_file
85 # store header data in various formats, see above for more info
86 self.enum_val_dict = {}
87 self.enum_type_dict = {}
88 self.struct_dict = {}
89 self.typedef_fwd_dict = {}
90 self.typedef_rev_dict = {}
91 self.types_dict = {}
Tobin Ehlis5178bd72015-03-06 10:38:25 -070092 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -060093
94 def setHeaderFile(self, header_file):
95 self.header_file = header_file
96
97 def get_enum_val_dict(self):
98 return self.enum_val_dict
99
100 def get_enum_type_dict(self):
101 return self.enum_type_dict
102
103 def get_struct_dict(self):
104 return self.struct_dict
105
106 def get_typedef_fwd_dict(self):
107 return self.typedef_fwd_dict
108
109 def get_typedef_rev_dict(self):
110 return self.typedef_rev_dict
111
112 def get_types_dict(self):
113 return self.types_dict
114
115 # Parse header file into data structures
116 def parse(self):
117 # parse through the file, identifying different sections
118 parse_enum = False
119 parse_struct = False
120 member_num = 0
121 # TODO : Comment parsing is very fragile but handles 2 known files
122 block_comment = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700123 prev_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600124 with open(self.header_file) as f:
125 for line in f:
126 if block_comment:
127 if '*/' in line:
128 block_comment = False
129 continue
130 if '/*' in line:
131 block_comment = True
132 elif 0 == len(line.split()):
133 #print("Skipping empty line")
134 continue
135 elif line.split()[0].strip().startswith("//"):
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700136 #print("Skipping commented line %s" % line)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600137 continue
138 elif 'typedef enum' in line:
139 (ty_txt, en_txt, base_type) = line.strip().split(None, 2)
140 #print("Found ENUM type %s" % base_type)
141 parse_enum = True
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700142 default_enum_val = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600143 self.types_dict[base_type] = 'enum'
144 elif 'typedef struct' in line:
145 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
146 #print("Found STRUCT type: %s" % base_type)
147 parse_struct = True
148 self.types_dict[base_type] = 'struct'
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700149 elif 'typedef union' in line:
150 (ty_txt, st_txt, base_type) = line.strip().split(None, 2)
151 #print("Found UNION type: %s" % base_type)
152 parse_struct = True
153 self.types_dict[base_type] = 'struct'
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600154 elif '}' in line and (parse_enum or parse_struct):
155 if len(line.split()) > 1: # deals with embedded union in one struct
156 parse_enum = False
157 parse_struct = False
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700158 self.last_struct_count_name = ''
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600159 member_num = 0
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600160 (cur_char, targ_type) = line.strip().split(None, 1)
161 self.typedef_fwd_dict[base_type] = targ_type.strip(';')
162 self.typedef_rev_dict[targ_type.strip(';')] = base_type
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600163 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600164 elif parse_enum:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600165 #if 'VK_MAX_ENUM' not in line and '{' not in line:
166 if True not in [ens in line for ens in ['{', 'VK_MAX_ENUM', '_RANGE']]:
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700167 self._add_enum(line, base_type, default_enum_val)
168 default_enum_val += 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600169 elif parse_struct:
170 if ';' in line:
171 self._add_struct(line, base_type, member_num)
172 member_num = member_num + 1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600173
174 # populate enum dicts based on enum lines
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700175 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600176 #print("Parsing enum line %s" % line_txt)
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700177 if '=' in line_txt:
178 (enum_name, eq_char, enum_val) = line_txt.split(None, 2)
179 else:
180 enum_name = line_txt.split(',')[0]
181 enum_val = str(def_enum_val)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600182 self.enum_val_dict[enum_name] = {}
183 self.enum_val_dict[enum_name]['type'] = enum_type
184 # strip comma and comment, then extra split in case of no comma w/ comments
185 enum_val = enum_val.strip().split(',', 1)[0]
186 self.enum_val_dict[enum_name]['val'] = enum_val.split()[0]
Tobin Ehlisd3350652015-04-22 13:59:43 -0600187 # Perform conversion of VK_BIT macro
188 if 'VK_BIT' in self.enum_val_dict[enum_name]['val']:
189 vk_bit_val = self.enum_val_dict[enum_name]['val']
190 bit_shift = int(vk_bit_val[vk_bit_val.find('(')+1:vk_bit_val.find(')')], 0)
191 self.enum_val_dict[enum_name]['val'] = str(1 << bit_shift)
192 else:
193 # account for negative values surrounded by parens
194 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
Tobin Ehlis43ebcac2014-12-05 12:13:07 -0700195 # Try to cast to int to determine if enum value is unique
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600196 try:
197 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
198 int(self.enum_val_dict[enum_name]['val'], 0)
199 self.enum_val_dict[enum_name]['unique'] = True
200 #print("ENUM has num value")
201 except ValueError:
202 self.enum_val_dict[enum_name]['unique'] = False
203 #print("ENUM is not a number value")
204 # Update enum_type_dict as well
205 if not enum_type in self.enum_type_dict:
206 self.enum_type_dict[enum_type] = []
207 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700208
209 # Return True of struct member is a dynamic array
210 # RULES : This is a bit quirky based on the API
211 # NOTE : Changes in API spec may cause these rules to change
212 # 1. There must be a previous uint var w/ 'count' in the name in the struct
213 # 2. Dynam array must have 'const' and '*' qualifiers
214 # 3a. Name of dynam array must end in 's' char OR
215 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
216 def _is_dynamic_array(self, full_type, name):
217 if '' != self.last_struct_count_name:
218 if 'const' in full_type and '*' in full_type:
219 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
220 return True
221 return False
222
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600223 # populate struct dicts based on struct lines
224 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
225 def _add_struct(self, line_txt, struct_type, num):
226 #print("Parsing struct line %s" % line_txt)
227 if not struct_type in self.struct_dict:
228 self.struct_dict[struct_type] = {}
229 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
230 # TODO : Handle bitfields more correctly
231 members = members.strip().split(':', 1)[0] # strip bitfield element
232 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700233 # Store counts to help recognize and size dynamic arrays
Tobin Ehlisb4934382015-04-15 16:01:16 -0600234 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700235 self.last_struct_count_name = member_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600236 self.struct_dict[struct_type][num] = {}
237 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700238 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600239 if '*' in member_type:
240 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700241 # TODO : Need more general purpose way here to reduce down to basic type
242 member_type = member_type.replace(' const*', '')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600243 member_type = member_type.strip('*')
244 else:
245 self.struct_dict[struct_type][num]['ptr'] = False
246 if 'const' in member_type:
247 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600248 member_type = member_type.replace('const', '').strip()
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600249 else:
250 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700251 # TODO : There is a bug here where it seems that at the time we do this check,
252 # 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 -0600253 if is_type(member_type, 'struct'):
254 self.struct_dict[struct_type][num]['struct'] = True
255 else:
256 self.struct_dict[struct_type][num]['struct'] = False
257 self.struct_dict[struct_type][num]['type'] = member_type
258 if '[' in member_name:
259 (member_name, array_size) = member_name.split('[', 1)
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600260 if 'char' in member_type:
261 self.struct_dict[struct_type][num]['array'] = False
262 self.struct_dict[struct_type][num]['array_size'] = 0
263 self.struct_dict[struct_type][num]['ptr'] = True
264 else:
265 self.struct_dict[struct_type][num]['array'] = True
266 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700267 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
268 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
269 self.struct_dict[struct_type][num]['array'] = True
270 self.struct_dict[struct_type][num]['dyn_array'] = True
271 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700272 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600273 self.struct_dict[struct_type][num]['array'] = False
274 self.struct_dict[struct_type][num]['array_size'] = 0
275 self.struct_dict[struct_type][num]['name'] = member_name
276
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700277# check if given identifier is of specified type_to_check
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600278def is_type(identifier, type_to_check):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600279 if identifier in types_dict and type_to_check == types_dict[identifier]:
280 return True
281 if identifier in typedef_rev_dict:
282 new_id = typedef_rev_dict[identifier]
283 if new_id in types_dict and type_to_check == types_dict[new_id]:
284 return True
285 return False
286
287# This is a validation function to verify that we can reproduce the original structs
288def recreate_structs():
289 for struct_name in struct_dict:
290 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
291 for mem_num in sorted(struct_dict[struct_name]):
292 sys.stdout.write(" ")
293 if struct_dict[struct_name][mem_num]['const']:
294 sys.stdout.write("const ")
295 #if struct_dict[struct_name][mem_num]['struct']:
296 # sys.stdout.write("struct ")
297 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
298 if struct_dict[struct_name][mem_num]['ptr']:
299 sys.stdout.write("*")
300 sys.stdout.write(" ")
301 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
302 if struct_dict[struct_name][mem_num]['array']:
303 sys.stdout.write("[")
304 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
305 sys.stdout.write("]")
306 sys.stdout.write(";\n")
307 sys.stdout.write("} ")
308 sys.stdout.write(typedef_fwd_dict[struct_name])
309 sys.stdout.write(";\n\n")
310
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600311#
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600312# TODO: Fix construction of struct name
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600313def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600314 # Note: All struct types are now camel-case
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600315 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600316 char_idx = 0
317 struct_name = ''
318 for char in caps_struct_name:
319 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
320 struct_name += caps_struct_name[char_idx]
321 elif (caps_struct_name[char_idx] == '_'):
322 pass
323 else:
324 struct_name += caps_struct_name[char_idx].lower()
325 char_idx += 1
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600326 return struct_name
327
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600328# class for writing common file elements
329# Here's how this class lays out a file:
330# COPYRIGHT
331# HEADER
332# BODY
333# FOOTER
334#
335# For each of these sections, there's a "set*" function
336# The class as a whole has a generate function which will write each section in order
337class CommonFileGen:
338 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
339 self.filename = filename
340 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
341 # TODO : Set a default copyright & footer at least
342
343 def setFilename(self, filename):
344 self.filename = filename
345
346 def setCopyright(self, c):
347 self.contents['copyright'] = c
348
349 def setHeader(self, h):
350 self.contents['header'] = h
351
352 def setBody(self, b):
353 self.contents['body'] = b
354
355 def setFooter(self, f):
356 self.contents['footer'] = f
357
358 def generate(self):
359 #print("Generate to file %s" % self.filename)
360 with open(self.filename, "w") as f:
361 f.write(self.contents['copyright'])
362 f.write(self.contents['header'])
363 f.write(self.contents['body'])
364 f.write(self.contents['footer'])
365
366# class for writing a wrapper class for structures
367# The wrapper class wraps the structs and includes utility functions for
368# setting/getting member values and displaying the struct data in various formats
369class StructWrapperGen:
370 def __init__(self, in_struct_dict, prefix, out_dir):
371 self.struct_dict = in_struct_dict
372 self.include_headers = []
373 self.api = prefix
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -0600374 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600375 self.api_prefix = "vk"
376 else:
377 self.api_prefix = prefix
378 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
379 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
380 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
381 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
382 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
383 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
384 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700385 self.no_addr = False
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600386 self.hfg = CommonFileGen(self.header_filename)
387 self.cfg = CommonFileGen(self.class_filename)
388 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700389 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700390 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600391 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
392 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlis60354772015-03-12 14:50:40 -0600393 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700394 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600395 #print(self.header_filename)
396 self.header_txt = ""
397 self.definition_txt = ""
398
399 def set_include_headers(self, include_headers):
400 self.include_headers = include_headers
401
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700402 def set_no_addr(self, no_addr):
403 self.no_addr = no_addr
404 if self.no_addr:
405 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700406 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700407 else:
408 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700409 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700410
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600411 # Return class name for given struct name
412 def get_class_name(self, struct_name):
413 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
414 return class_name
415
416 def get_file_list(self):
417 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
418
419 # Generate class header file
420 def generateHeader(self):
421 self.hfg.setCopyright(self._generateCopyright())
422 self.hfg.setHeader(self._generateHeader())
423 self.hfg.setBody(self._generateClassDeclaration())
424 self.hfg.setFooter(self._generateFooter())
425 self.hfg.generate()
426
427 # Generate class definition
428 def generateBody(self):
429 self.cfg.setCopyright(self._generateCopyright())
430 self.cfg.setHeader(self._generateCppHeader())
431 self.cfg.setBody(self._generateClassDefinition())
432 self.cfg.setFooter(self._generateFooter())
433 self.cfg.generate()
434
435 # Generate c-style .h file that contains functions for printing structs
436 def generateStringHelper(self):
437 print("Generating struct string helper")
438 self.shg.setCopyright(self._generateCopyright())
439 self.shg.setHeader(self._generateStringHelperHeader())
440 self.shg.setBody(self._generateStringHelperFunctions())
441 self.shg.generate()
442
Tobin Ehlis99f88672015-01-10 12:42:41 -0700443 # Generate cpp-style .h file that contains functions for printing structs
444 def generateStringHelperCpp(self):
445 print("Generating struct string helper cpp")
446 self.shcppg.setCopyright(self._generateCopyright())
447 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
448 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
449 self.shcppg.generate()
450
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700451 # Generate c-style .h file that contains functions for printing structs
452 def generateValidateHelper(self):
453 print("Generating struct validate helper")
454 self.vhg.setCopyright(self._generateCopyright())
455 self.vhg.setHeader(self._generateValidateHelperHeader())
456 self.vhg.setBody(self._generateValidateHelperFunctions())
457 self.vhg.generate()
458
Tobin Ehlis60354772015-03-12 14:50:40 -0600459 def generateSizeHelper(self):
460 print("Generating struct size helper")
461 self.size_helper_gen.setCopyright(self._generateCopyright())
462 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
463 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
464 self.size_helper_gen.generate()
465
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700466 def generateSizeHelperC(self):
467 print("Generating struct size helper c")
468 self.size_helper_c_gen.setCopyright(self._generateCopyright())
469 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
470 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
471 self.size_helper_c_gen.generate()
472
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600473 def _generateCopyright(self):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700474 copyright = []
475 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
476 copyright.append('');
477 copyright.append('/*');
Ian Elliott0977abc2015-04-15 11:15:13 -0600478 copyright.append(' * Vulkan');
Peter Lohrmann4a8d8912015-04-03 11:43:06 -0700479 copyright.append(' *');
480 copyright.append(' * Copyright (C) 2014 LunarG, Inc.');
481 copyright.append(' *');
482 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
483 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
484 copyright.append(' * to deal in the Software without restriction, including without limitation');
485 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
486 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
487 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
488 copyright.append(' *');
489 copyright.append(' * The above copyright notice and this permission notice shall be included');
490 copyright.append(' * in all copies or substantial portions of the Software.');
491 copyright.append(' *');
492 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
493 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
494 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
495 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
496 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
497 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
498 copyright.append(' * DEALINGS IN THE SOFTWARE.');
499 copyright.append(' */');
500 copyright.append('');
501 return "\n".join(copyright)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600502
503 def _generateCppHeader(self):
504 header = []
505 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600506 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 -0600507 return "".join(header)
508
509 def _generateClassDefinition(self):
510 class_def = []
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600511 if 'vk' == self.api: # Mantle doesn't have pNext to worry about
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600512 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700513 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600514 class_def.append("\n// %s class definition" % self.get_class_name(s))
515 class_def.append(self._generateConstructorDefinitions(s))
516 class_def.append(self._generateDestructorDefinitions(s))
517 class_def.append(self._generateDisplayDefinitions(s))
518 return "\n".join(class_def)
519
520 def _generateConstructorDefinitions(self, s):
521 con_defs = []
522 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)))
523 # TODO : This is a shallow copy of ptrs
524 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]))
525 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]))
526 return "\n".join(con_defs)
527
528 def _generateDestructorDefinitions(self, s):
529 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
530
531 def _generateDynamicPrintFunctions(self):
532 dp_funcs = []
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600533 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 -0600534 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600535 dp_funcs.append(" switch (sType)\n {")
536 for e in enum_type_dict:
537 class_num = 0
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600538 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600539 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600540 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600541 class_name = self.get_class_name(struct_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600542 instance_name = "swc%i" % class_num
543 dp_funcs.append(" case %s:\n {" % (v))
544 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
545 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
546 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
547 dp_funcs.append(" }")
548 dp_funcs.append(" break;")
549 class_num += 1
550 dp_funcs.append(" }")
551 dp_funcs.append("}\n")
552 return "\n".join(dp_funcs)
553
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700554 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -0600555 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700556
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600557 def _get_sh_func_name(self, struct):
Tobin Ehlis14ff0852014-12-17 17:44:50 -0700558 return self._get_func_name(struct, 'print')
559
560 def _get_vh_func_name(self, struct):
561 return self._get_func_name(struct, 'validate')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600562
Tobin Ehlis60354772015-03-12 14:50:40 -0600563 def _get_size_helper_func_name(self, struct):
564 return self._get_func_name(struct, 'size')
565
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600566 # Return elements to create formatted string for given struct member
567 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
568 struct_op = "->"
569 if not struct_ptr:
570 struct_op = "."
571 member_name = struct_member['name']
572 print_type = "p"
573 cast_type = ""
574 member_post = ""
575 array_index = ""
576 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -0700577 print_delimiter = "%"
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700578 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
579 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
580 member_post = "[0]"
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600581 print_type = "s"
582 print_array = False
583 elif struct_member['array'] and not print_array:
584 # Just print base address of array when not full print_array
585 cast_type = "(void*)"
586 elif is_type(struct_member['type'], 'enum'):
587 cast_type = "string_%s" % struct_member['type']
Jon Ashburnfe6113c2015-01-09 09:11:44 -0700588 if struct_member['ptr']:
589 struct_var_name = "*" + struct_var_name
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600590 print_type = "s"
591 elif is_type(struct_member['type'], 'struct'): # print struct address for now
592 cast_type = "(void*)"
593 if not struct_member['ptr']:
594 cast_type = "(void*)&"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700595 elif 'bool' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600596 print_type = "s"
597 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700598 elif 'float' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600599 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600600 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
601 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700602 elif 'uint8' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600603 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600604 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -0700605 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
606 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600607 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 -0600608 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700609 elif 'int' in struct_member['type']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600610 print_type = "i"
611 elif struct_member['ptr']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600612 pass
613 else:
614 #print("Unhandled struct type: %s" % struct_member['type'])
615 cast_type = "(void*)"
616 if print_array and struct_member['array']:
617 member_print_post = "[%u]"
618 array_index = " i,"
619 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -0700620 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 -0600621 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 -0700622 if self.no_addr and "p" == print_type:
623 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
624 print_arg = ", %s" % (pre_var_name)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600625 return (print_out, print_arg)
626
627 def _generateStringHelperFunctions(self):
628 sh_funcs = []
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700629 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlis291cd702015-01-20 09:48:48 -0700630 for s in sorted(self.struct_dict):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700631 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
632 sh_funcs.append('')
633 sh_funcs.append('#if defined(_WIN32)')
634 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
635 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
636 sh_funcs.append('// work-around.')
637 sh_funcs.append('#define snprintf _snprintf')
638 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -0700639 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600640 p_out = ""
641 p_args = ""
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700642 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 -0700643 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700644 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700645 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
646 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700647 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]))
648 sh_funcs.append(" size_t len;")
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700649 num_stps = len(stp_list);
650 total_strlen_str = ''
651 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700652 sh_funcs.append(" char* tmpStr;")
653 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
654 sh_funcs.append(' strcpy(extra_indent, " ");')
655 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
656 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700657 for index in range(num_stps):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700658 # If it's an array, print all of the elements
659 # If it's a ptr, print thing it's pointing to
660 # Non-ptr struct case. Print the struct using its address
661 struct_deref = '&'
662 if 1 < stp_list[index]['full_type'].count('*'):
663 struct_deref = ''
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700664 if (stp_list[index]['ptr']):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700665 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700666 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700667 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
668 sh_funcs.append(' len = 256+strlen(tmpStr);')
669 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700670 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700671 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700672 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700673 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
674 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700675 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700676 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
677 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600678 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 -0700679 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700680 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
681 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
682 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700683 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700684 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 -0700685 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700686 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']))
687 sh_funcs.append(' }')
688 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
689 elif stp_list[index]['array']:
690 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
691 sh_funcs.append(' len = 256+strlen(tmpStr);')
692 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700693 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700694 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 -0700695 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700696 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 -0700697 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700698 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
699 sh_funcs.append(' len = 256+strlen(tmpStr);')
700 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlisd49efcb2014-11-25 17:43:26 -0700701 if self.no_addr:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700702 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 -0700703 else:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700704 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 -0700705 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700706 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
707 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchterbbd0a362014-12-01 09:31:17 -0700708 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600709 for m in sorted(self.struct_dict[s]):
710 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
711 p_out += p_out1
712 p_args += p_args1
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600713 p_out += '"'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700714 p_args += ");"
715 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis5a487e52014-11-11 12:28:12 -0700716 if 0 != num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700717 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
718 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
719 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
720 sh_funcs.append(' free(stp_strs[stp_index]);')
721 sh_funcs.append(' }')
722 sh_funcs.append(' }')
723 sh_funcs.append(' free(extra_indent);')
724 sh_funcs.append(" return str;\n}")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600725 # Add function to dynamically print out unknown struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700726 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
727 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
728 sh_funcs.append(" if (pStruct == NULL) {")
729 sh_funcs.append(" return NULL;")
730 sh_funcs.append(" }")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600731 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700732 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
733 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600734 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600735 if "StructureType" in e:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600736 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600737 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600738 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700739 sh_funcs.append(' case %s:\n {' % (v))
740 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
741 sh_funcs.append(' }')
742 sh_funcs.append(' break;')
743 sh_funcs.append(" default:")
744 sh_funcs.append(" return NULL;")
745 sh_funcs.append(" }")
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600746 sh_funcs.append("}")
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700747 return "\n".join(sh_funcs)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700748
749 def _generateStringHelperFunctionsCpp(self):
750 # declare str & tmp str
751 # declare array of stringstreams for every struct ptr in current struct
752 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700753 # For every struct ptr, if non-Null, then set its string, else set to NULL str
754 # For every non-string element, set its string stream
Tobin Ehlis99f88672015-01-10 12:42:41 -0700755 # create and return final string
756 sh_funcs = []
757 # First generate prototypes for every struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600758 # XXX - REMOVE this comment
Tobin Ehlis291cd702015-01-20 09:48:48 -0700759 for s in sorted(self.struct_dict):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700760 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
761 sh_funcs.append('\n')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700762 for s in sorted(self.struct_dict):
Tobin Ehlisce320942015-06-11 09:37:00 -0600763 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 -0700764 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 -0700765 # This pre-pass flags embedded structs and pNext
Tobin Ehlis291cd702015-01-20 09:48:48 -0700766 for m in sorted(self.struct_dict[s]):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700767 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct') or self.struct_dict[s][m]['array']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700768 stp_list.append(self.struct_dict[s][m])
769 sh_funcs.append('string %s(const %s* pStruct, const string prefix)\n{' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700770 indent = ' '
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600771 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700772 sh_funcs.append('%sstring final_str;' % (indent))
773 sh_funcs.append('%sstring tmp_str;' % (indent))
774 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlis291cd702015-01-20 09:48:48 -0700775 if (0 != num_non_enum_elems):
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700776 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700777 num_stps = len(stp_list)
Tobin Ehlisce320942015-06-11 09:37:00 -0600778 # First generate code for any embedded structs or arrays
Tobin Ehlis99f88672015-01-10 12:42:41 -0700779 if 0 < num_stps:
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700780 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700781 idx_ss_decl = False # Make sure to only decl this once
782 for index in range(num_stps):
783 addr_char = '&'
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700784 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis99f88672015-01-10 12:42:41 -0700785 addr_char = ''
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600786 if (stp_list[index]['array'] and 'char' not in stp_list[index]['type']):
787 sh_funcs.append('/* A */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700788 if stp_list[index]['dyn_array']:
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600789 sh_funcs.append('/* AA */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700790 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
791 else:
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600792 sh_funcs.append('/* AB */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700793 array_count = '%s' % (stp_list[index]['array_size'])
794 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
795 if not idx_ss_decl:
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600796 sh_funcs.append('/* AC */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700797 sh_funcs.append('%sstringstream index_ss;' % (indent))
798 idx_ss_decl = True
Tobin Ehlis793ad302015-04-03 12:01:11 -0600799 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
800 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700801 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600802 indent += ' '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700803 sh_funcs.append('%sindex_ss.str("");' % (indent))
804 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlisce320942015-06-11 09:37:00 -0600805 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600806 #sh_funcs.append('/* AD */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700807 addr_char = ''
Tobin Ehlisce320942015-06-11 09:37:00 -0600808 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
809 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 -0700810 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 -0600811 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600812 #sh_funcs.append('/* AD */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700813 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
814 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']))
815 if self.no_addr:
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600816 sh_funcs.append('/* AEA */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700817 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
818 else:
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600819 sh_funcs.append('/* AEB */');
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700820 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 -0600821 else:
822 #sh_funcs.append('/* AD */');
823 addr_char = ''
824 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
825 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700826 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlis793ad302015-04-03 12:01:11 -0600827 indent = indent[4:]
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700828 sh_funcs.append('%s}' % (indent))
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600829 indent = indent[4:]
830 sh_funcs.append('%s}' % (indent))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700831 elif (stp_list[index]['ptr']):
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600832 sh_funcs.append('/* B */');
Tobin Ehlis99f88672015-01-10 12:42:41 -0700833 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
834 if 'pNext' == stp_list[index]['name']:
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600835 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis99f88672015-01-10 12:42:41 -0700836 else:
Tobin Ehlisb8013a22015-02-26 12:57:08 -0700837 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
838 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchtereeae16b2015-04-02 22:54:15 -0600839 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 -0700840 else:
841 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 -0700842 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
843 if self.no_addr:
844 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
845 else:
846 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
847 sh_funcs.append(' ss[%u].str("");' % (index))
848 sh_funcs.append(' }')
849 sh_funcs.append(' else')
850 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700851 else:
Tobin Ehlisc62cb892015-04-17 13:26:33 -0600852 #sh_funcs.append('/* C */');
Tobin Ehlis99f88672015-01-10 12:42:41 -0700853 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
854 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
855 if self.no_addr:
856 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
857 else:
858 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
859 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlisce320942015-06-11 09:37:00 -0600860 # Now print one-line info for all data members
Tobin Ehlis99f88672015-01-10 12:42:41 -0700861 index = 0
862 final_str = ''
863 for m in sorted(self.struct_dict[s]):
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700864 deref = ''
Tobin Ehlis99f88672015-01-10 12:42:41 -0700865 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
866 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
867 if self.no_addr:
868 sh_funcs.append(' ss[%u].str("addr");' % (index))
869 else:
870 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700871 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis99f88672015-01-10 12:42:41 -0700872 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700873 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis99f88672015-01-10 12:42:41 -0700874 sh_funcs.append(' ss[%u] << (uint32_t)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis17f45a62015-04-28 17:27:16 -0600875 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
876 sh_funcs.append(' if (StreamControl::writeAddress)')
877 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
878 sh_funcs.append(' else')
879 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis99f88672015-01-10 12:42:41 -0700880 else:
881 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700882 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700883 sh_funcs.append(' ss[%u].str("addr");' % (index))
884 else:
885 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
886 value_print = 'ss[%u].str()' % index
887 index += 1
888 else:
Tobin Ehlisce320942015-06-11 09:37:00 -0600889 # 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 -0700890 if self.struct_dict[s][m]['ptr']:
Tobin Ehlisce320942015-06-11 09:37:00 -0600891 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
892 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
893 sh_funcs.append(' else')
894 sh_funcs.append(' ss[%u].str("NULL");' % (index))
895 value_print = 'ss[%u].str()' % index
896 index += 1
897 # For single enum just print the string representation
898 else:
899 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 -0700900 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
901 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis5178bd72015-03-06 10:38:25 -0700902 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis99f88672015-01-10 12:42:41 -0700903 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
904 sh_funcs.append(' final_str = %s;' % final_str)
905 sh_funcs.append(' return final_str;\n}')
Tobin Ehlis291cd702015-01-20 09:48:48 -0700906 # Add function to return a string value for input void*
907 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlise78dbd82015-04-09 09:19:36 -0600908 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlis291cd702015-01-20 09:48:48 -0700909 sh_funcs.append(" stringstream ss;")
910 sh_funcs.append(' ss << toString;')
911 sh_funcs.append(' string final_str = prefix + ss.str();')
912 sh_funcs.append(" return final_str;")
913 sh_funcs.append("}")
Tobin Ehlis08541742015-04-16 15:56:11 -0600914 # Add function to return a string value for input uint32_t
915 sh_funcs.append("string string_convert_helper(const uint32_t toString, const string prefix)\n{")
916 sh_funcs.append(" using namespace StreamControl;")
917 sh_funcs.append(" stringstream ss;")
918 sh_funcs.append(' ss << toString;')
919 sh_funcs.append(' string final_str = prefix + ss.str();')
920 sh_funcs.append(" return final_str;")
921 sh_funcs.append("}")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700922 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600923 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700924 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliott82800022015-02-25 17:40:38 -0700925 sh_funcs.append(" if (pStruct == NULL) {\n")
Jon Ashburn62a327c2015-02-25 12:45:23 -0700926 sh_funcs.append(" return NULL;")
Ian Elliott82800022015-02-25 17:40:38 -0700927 sh_funcs.append(" }\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600928 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700929 sh_funcs.append(' string indent = " ";')
930 sh_funcs.append(' indent += prefix;')
931 sh_funcs.append(" switch (sType)\n {")
932 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600933 if "StructureType" in e:
Tobin Ehlis99f88672015-01-10 12:42:41 -0700934 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -0600935 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis99f88672015-01-10 12:42:41 -0700936 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600937 #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 -0700938 sh_funcs.append(' case %s:\n {' % (v))
939 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
940 sh_funcs.append(' }')
941 sh_funcs.append(' break;')
942 sh_funcs.append(" default:")
943 sh_funcs.append(" return NULL;")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600944 sh_funcs.append(" }")
Tobin Ehlis99f88672015-01-10 12:42:41 -0700945 sh_funcs.append("}")
946 return "\n".join(sh_funcs)
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600947
948 def _genStructMemberPrint(self, member, s, array, struct_array):
949 (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)
950 extra_indent = ""
951 if array:
952 extra_indent = " "
953 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
954 struct_array.insert(0, self.struct_dict[s][member])
955 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis7e65d752015-01-15 17:51:52 -0700956 # Special case for void* named "pNext"
957 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600958 struct_array.insert(0, self.struct_dict[s][member])
959 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
960
961 def _generateDisplayDefinitions(self, s):
962 disp_def = []
963 struct_array = []
964 # Single-line struct print function
965 disp_def.append("// Output 'structname = struct_address' on a single line")
966 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
967 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
968 disp_def.append("}\n")
969 # Private helper function to print struct members
970 disp_def.append("// Private helper function that displays the members of the wrapped struct")
971 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
972 i_declared = False
973 for member in sorted(self.struct_dict[s]):
974 # TODO : Need to display each member based on its type
Mark Lobodzinski17caf572015-01-29 08:55:56 -0600975 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlis6442dca2014-10-22 15:13:53 -0600976 # Can grab struct type off of header of struct pointed to
977 # TODO : Handle Arrays
978 if self.struct_dict[s][member]['array']:
979 # Create for loop to print each element of array
980 if not i_declared:
981 disp_def.append(' uint32_t i;')
982 i_declared = True
983 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
984 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
985 disp_def.append(return_str)
986 disp_def.append(' }')
987 else:
988 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
989 disp_def.append(return_str)
990 disp_def.append("}\n")
991 i_declared = False
992 # Basic print function to display struct members
993 disp_def.append("// Output all struct elements, each on their own line")
994 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
995 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
996 disp_def.append(' this->display_struct_members();')
997 disp_def.append("}\n")
998 # Advanced print function to display current struct and contents of any pointed-to structs
999 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
1000 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
1001 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
1002 disp_def.append(' this->display_struct_members();')
1003 class_num = 0
1004 # TODO : Need to handle arrays of structs here
1005 for ms in struct_array:
1006 swc_name = "class%s" % str(class_num)
1007 if ms['array']:
1008 if not i_declared:
1009 disp_def.append(' uint32_t i;')
1010 i_declared = True
1011 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1012 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1013 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1014 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1015 disp_def.append(" %s.display_full_txt();" % (swc_name))
1016 #disp_def.append(' }')
1017 disp_def.append(' }')
1018 elif 'pNext' == ms['name']:
1019 # Need some code trickery here
1020 # I'm thinking have a generated function that takes pNext ptr value
1021 # then it checks sType and in large switch statement creates appropriate
1022 # wrapper class type and then prints contents
1023 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1024 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1025 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1026 disp_def.append(" }")
1027 else:
1028 if ms['ptr']:
1029 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1030 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1031 else:
1032 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1033 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1034 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1035 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1036 class_num += 1
1037 disp_def.append("}\n")
1038 return "\n".join(disp_def)
1039
1040 def _generateStringHelperHeader(self):
1041 header = []
1042 header.append("//#includes, #defines, globals and such...\n")
1043 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001044 if 'vk_enum_string_helper' not in f:
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001045 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001046 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001047 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001048 return "".join(header)
Tobin Ehlis99f88672015-01-10 12:42:41 -07001049
1050 def _generateStringHelperHeaderCpp(self):
1051 header = []
1052 header.append("//#includes, #defines, globals and such...\n")
1053 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001054 if 'vk_enum_string_helper' not in f:
Tobin Ehlis99f88672015-01-10 12:42:41 -07001055 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001056 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis99f88672015-01-10 12:42:41 -07001057 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlise78dbd82015-04-09 09:19:36 -06001058 header.append('\n')
1059 header.append('namespace StreamControl\n')
1060 header.append('{\n')
1061 header.append('bool writeAddress = true;\n')
1062 header.append('template <typename T>\n')
1063 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1064 header.append('{\n')
1065 header.append(' if(writeAddress)\n')
1066 header.append(' {\n')
1067 header.append(' out.operator<<(pointer);\n')
1068 header.append(' }\n')
1069 header.append(' else\n')
1070 header.append(' {\n')
1071 header.append(' std::operator<<(out, "address");\n')
1072 header.append(' }\n')
1073 header.append(' return out;\n')
1074 header.append('}\n')
1075 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1076 header.append('{\n')
1077 header.append(' return std::operator<<(out, s);\n')
1078 header.append('}\n')
1079 header.append('}\n')
1080 header.append('\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001081 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis99f88672015-01-10 12:42:41 -07001082 return "".join(header)
1083
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001084 def _generateValidateHelperFunctions(self):
1085 sh_funcs = []
1086 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001087 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001088 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1089 sh_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001090 for s in sorted(self.struct_dict):
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001091 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1092 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001093 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001094 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 -07001095 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 -07001096 # 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 -07001097 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1098 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlisf4a3ac52015-02-24 15:39:04 -07001099 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 -07001100 else:
1101 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 -07001102 sh_funcs.append(" return 1;\n}")
1103
1104 return "\n".join(sh_funcs)
1105
1106 def _generateValidateHelperHeader(self):
1107 header = []
1108 header.append("//#includes, #defines, globals and such...\n")
1109 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001110 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001111 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001112 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001113 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001114 return "".join(header)
1115
Tobin Ehlis60354772015-03-12 14:50:40 -06001116 def _generateSizeHelperFunctions(self):
1117 sh_funcs = []
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001118 # just generates prototypes for all the functions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001119 for s in sorted(self.struct_dict):
Tobin Ehlis60354772015-03-12 14:50:40 -06001120 sh_funcs.append('size_t %s(const %s* pStruct);' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001121 return "\n".join(sh_funcs)
1122
1123
1124 def _generateSizeHelperFunctionsC(self):
1125 sh_funcs = []
1126 # generate function definitions
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001127 for s in sorted(self.struct_dict):
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001128 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlis60354772015-03-12 14:50:40 -06001129 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1130 indent = ' '
1131 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1132 sh_funcs.append('%sif (pStruct) {' % (indent))
1133 indent = ' '
1134 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1135 i_decl = False
1136 for m in sorted(self.struct_dict[s]):
1137 if m in skip_list:
1138 continue
1139 if self.struct_dict[s][m]['dyn_array']:
1140 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1141 if not is_type(self.struct_dict[s][m]['type'], 'struct') and not 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis04112922015-03-16 10:44:40 -06001142 if 'ppMemBarriers' == self.struct_dict[s][m]['name']:
1143 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001144 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 -06001145 else:
1146 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 -06001147 else: # This is an array of char* or array of struct ptrs
1148 if not i_decl:
1149 sh_funcs.append('%suint32_t i = 0;' % (indent))
1150 i_decl = True
1151 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1152 indent = ' '
1153 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1154 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']))
1155 else:
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001156 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 -06001157 indent = ' '
1158 sh_funcs.append('%s}' % (indent))
1159 else:
1160 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1161 if not i_decl:
1162 sh_funcs.append('%suint32_t i = 0;' % (indent))
1163 i_decl = True
1164 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1165 indent = ' '
1166 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']))
1167 indent = ' '
1168 sh_funcs.append('%s}' % (indent))
1169 else:
1170 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1171 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1172 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisbd6a9162015-03-13 07:18:05 -06001173 sh_funcs.append('%sstructSize += sizeof(%s)*(1+strlen(pStruct->%s));' % (indent, self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name']))
Tobin Ehlis60354772015-03-12 14:50:40 -06001174 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1175 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 -06001176 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis60354772015-03-12 14:50:40 -06001177 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1178 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1179 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1180 skip_list.append(m+1)
1181 indent = ' '
1182 sh_funcs.append('%s}' % (indent))
1183 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001184 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
1185 for follow_chain in [True, False]:
1186 if follow_chain:
1187 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1188 else:
1189 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1190 indent = ' '
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001191 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1192 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001193 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1194 if follow_chain:
1195 sh_funcs.append('%swhile (pNext) {' % (indent))
1196 indent = ' '
1197 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1198 indent += ' '
1199 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001200 if 'StructureType' in e:
Tobin Ehlis04112922015-03-16 10:44:40 -06001201 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001202 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis04112922015-03-16 10:44:40 -06001203 sh_funcs.append('%scase %s:' % (indent, v))
1204 sh_funcs.append('%s{' % (indent))
1205 indent += ' '
1206 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1207 sh_funcs.append('%sbreak;' % (indent))
1208 indent = indent[:-4]
1209 sh_funcs.append('%s}' % (indent))
1210 sh_funcs.append('%sdefault:' % (indent))
1211 indent += ' '
1212 sh_funcs.append('%sassert(0);' % (indent))
1213 sh_funcs.append('%sstructSize += 0;' % (indent))
1214 indent = indent[:-4]
1215 indent = indent[:-4]
1216 sh_funcs.append('%s}' % (indent))
1217 if follow_chain:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001218 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
Tobin Ehlis04112922015-03-16 10:44:40 -06001219 indent = indent[:-4]
1220 sh_funcs.append('%s}' % (indent))
1221 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlis60354772015-03-12 14:50:40 -06001222 return "\n".join(sh_funcs)
1223
1224 def _generateSizeHelperHeader(self):
1225 header = []
1226 header.append("//#includes, #defines, globals and such...\n")
1227 for f in self.include_headers:
1228 header.append("#include <%s>\n" % f)
1229 header.append('\n// Function Prototypes\n')
1230 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis04112922015-03-16 10:44:40 -06001231 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlis60354772015-03-12 14:50:40 -06001232 return "".join(header)
1233
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001234 def _generateSizeHelperHeaderC(self):
1235 header = []
Courtney Goeltzenleuchterdba79982015-04-14 16:30:53 -06001236 header.append('#include "vk_struct_size_helper.h"')
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001237 header.append('#include <string.h>')
1238 header.append('#include <assert.h>')
1239 header.append('\n// Function definitions\n')
1240 return "\n".join(header)
1241
1242
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001243 def _generateHeader(self):
1244 header = []
1245 header.append("//#includes, #defines, globals and such...\n")
1246 for f in self.include_headers:
1247 header.append("#include <%s>\n" % f)
1248 return "".join(header)
1249
1250 # Declarations
1251 def _generateConstructorDeclarations(self, s):
1252 constructors = []
1253 constructors.append(" %s();\n" % self.get_class_name(s))
1254 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1255 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1256 return "".join(constructors)
1257
1258 def _generateDestructorDeclarations(self, s):
1259 return " virtual ~%s();\n" % self.get_class_name(s)
1260
1261 def _generateDisplayDeclarations(self, s):
1262 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
1263
1264 def _generateGetSetDeclarations(self, s):
1265 get_set = []
1266 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1267 for member in sorted(self.struct_dict[s]):
1268 # TODO : Skipping array set/get funcs for now
1269 if self.struct_dict[s][member]['array']:
1270 continue
1271 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']))
1272 if not self.struct_dict[s][member]['const']:
1273 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']))
1274 return "".join(get_set)
1275
1276 def _generatePrivateMembers(self, s):
1277 priv = []
1278 priv.append("\nprivate:\n")
1279 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1280 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1281 priv.append(" uint32_t m_indent;\n")
1282 priv.append(" const char m_dummy_prefix;\n")
1283 priv.append(" void display_struct_members();\n")
1284 return "".join(priv)
1285
1286 def _generateClassDeclaration(self):
1287 class_decl = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001288 for s in sorted(self.struct_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001289 class_decl.append("\n//class declaration")
1290 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1291 class_decl.append(self._generateConstructorDeclarations(s))
1292 class_decl.append(self._generateDestructorDeclarations(s))
1293 class_decl.append(self._generateDisplayDeclarations(s))
1294 class_decl.append(self._generateGetSetDeclarations(s))
1295 class_decl.append(self._generatePrivateMembers(s))
1296 class_decl.append("};\n")
1297 return "\n".join(class_decl)
1298
1299 def _generateFooter(self):
1300 return "\n//any footer info for class\n"
1301
1302class EnumCodeGen:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001303 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 -06001304 self.et_dict = enum_type_dict
1305 self.ev_dict = enum_val_dict
1306 self.tf_dict = typedef_fwd_dict
1307 self.in_file = in_file
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001308 self.out_sh_file = out_sh_file
1309 self.eshfg = CommonFileGen(self.out_sh_file)
1310 self.out_vh_file = out_vh_file
1311 self.evhfg = CommonFileGen(self.out_vh_file)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001312
1313 def generateStringHelper(self):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001314 self.eshfg.setHeader(self._generateSHHeader())
1315 self.eshfg.setBody(self._generateSHBody())
1316 self.eshfg.generate()
1317
1318 def generateEnumValidate(self):
1319 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001320 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001321 self.evhfg.generate()
1322
1323 def _generateVHBody(self):
1324 body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001325 for bet in sorted(self.et_dict):
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001326 fet = self.tf_dict[bet]
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001327 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1328 # 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 -06001329 if 'flagbits' in bet.lower():
Tobin Ehlis9d8ba362015-04-15 17:04:03 -06001330 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1331 body.append(' return 0;')
1332 body.append(' return 1;')
1333 body.append('}\n\n')
1334 else:
1335 body.append(' switch ((%s)input_value)\n {' % (fet))
1336 for e in sorted(self.et_dict[bet]):
1337 if (self.ev_dict[e]['unique']):
1338 body.append(' case %s:' % (e))
1339 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001340 return "\n".join(body)
1341
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001342 def _generateSHBody(self):
1343 body = []
1344# with open(self.out_file, "a") as hf:
1345 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001346 for bet in sorted(self.et_dict):
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001347 fet = self.tf_dict[bet]
Ian Elliottfeae4052015-02-18 12:38:04 -07001348 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 -06001349 for e in sorted(self.et_dict[bet]):
1350 if (self.ev_dict[e]['unique']):
Tobin Ehlis10777032015-01-16 15:13:34 -07001351 body.append(' case %s:\n return "%s";' % (e, e))
1352 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001353 return "\n".join(body)
1354
1355 def _generateSHHeader(self):
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001356 header = []
1357 header.append('#pragma once\n')
Ian Elliottc779c7e2015-04-28 16:11:24 -06001358 header.append('#ifdef _WIN32\n')
1359 header.append('#pragma warning( disable : 4065 )\n')
1360 header.append('#endif\n')
Ian Elliottfeae4052015-02-18 12:38:04 -07001361 header.append('#include <%s>\n\n\n' % self.in_file)
Ian Elliott2d4ab1e2015-01-13 17:52:38 -07001362 return "\n".join(header)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001363
1364
1365class CMakeGen:
1366 def __init__(self, struct_wrapper=None, out_dir=None):
1367 self.sw = struct_wrapper
Tobin Ehlis83562882014-11-27 15:43:39 -07001368 self.include_headers = []
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001369 self.add_lib_file_list = self.sw.get_file_list()
1370 self.out_dir = out_dir
1371 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1372 self.cmg = CommonFileGen(self.out_file)
1373
1374 def generate(self):
1375 self.cmg.setBody(self._generateBody())
1376 self.cmg.generate()
1377
1378 def _generateBody(self):
1379 body = []
1380 body.append("project(%s)" % os.path.basename(self.out_dir))
1381 body.append("cmake_minimum_required(VERSION 2.8)\n")
1382 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1383 body.append('set(COMPILE_FLAGS "-fpermissive")')
1384 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1385 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1386 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1387 return "\n".join(body)
1388
1389class GraphVizGen:
Tobin Ehlis83562882014-11-27 15:43:39 -07001390 def __init__(self, struct_dict, prefix, out_dir):
1391 self.struct_dict = struct_dict
1392 self.api = prefix
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001393 if prefix == "vulkan":
1394 self.api_prefix = "vk"
1395 else:
1396 self.api_prefix = prefix
1397 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001398 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlis83562882014-11-27 15:43:39 -07001399
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001400 def generate(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001401 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001402 self.gvg.setHeader(self._generateHeader())
1403 self.gvg.setBody(self._generateBody())
Tobin Ehlis83562882014-11-27 15:43:39 -07001404 #self.gvg.setFooter('}')
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001405 self.gvg.generate()
Tobin Ehlis83562882014-11-27 15:43:39 -07001406
1407 def set_include_headers(self, include_headers):
1408 self.include_headers = include_headers
1409
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001410 def _generateHeader(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001411 header = []
1412 header.append("//#includes, #defines, globals and such...\n")
1413 for f in self.include_headers:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001414 if 'vk_enum_string_helper' not in f:
Tobin Ehlis83562882014-11-27 15:43:39 -07001415 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001416 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001417 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001418 return "".join(header)
1419
1420 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001421 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlis83562882014-11-27 15:43:39 -07001422
1423 # Return elements to create formatted string for given struct member
1424 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=""):
1425 struct_op = "->"
1426 pre_var_name = '"%s "' % struct_member['full_type']
1427 if not struct_ptr:
1428 struct_op = "."
1429 member_name = struct_member['name']
1430 print_type = "p"
1431 cast_type = ""
1432 member_post = ""
1433 array_index = ""
1434 member_print_post = ""
Tobin Ehlisb0497852015-02-11 14:24:02 -07001435 print_delimiter = "%"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001436 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1437 print_type = "p"
Tobin Ehlis83562882014-11-27 15:43:39 -07001438 print_array = False
1439 elif struct_member['array'] and not print_array:
1440 # Just print base address of array when not full print_array
1441 cast_type = "(void*)"
1442 elif is_type(struct_member['type'], 'enum'):
Jon Ashburnfe6113c2015-01-09 09:11:44 -07001443 if struct_member['ptr']:
1444 struct_var_name = "*" + struct_var_name
Tobin Ehlis83562882014-11-27 15:43:39 -07001445 cast_type = "string_%s" % struct_member['type']
1446 print_type = "s"
1447 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1448 cast_type = "(void*)"
1449 if not struct_member['ptr']:
1450 cast_type = "(void*)&"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001451 elif 'bool' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001452 print_type = "s"
1453 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001454 elif 'float' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001455 print_type = "f"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001456 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1457 print_type = '" PRId64 "'
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001458 elif 'uint8' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001459 print_type = "hu"
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001460 elif 'size' in struct_member['type'].lower():
Tobin Ehlisb0497852015-02-11 14:24:02 -07001461 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1462 print_delimiter = ""
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001463 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 -07001464 print_type = "u"
Tobin Ehlis7e65d752015-01-15 17:51:52 -07001465 elif 'int' in struct_member['type']:
Tobin Ehlis83562882014-11-27 15:43:39 -07001466 print_type = "i"
1467 elif struct_member['ptr']:
1468 pass
1469 else:
1470 #print("Unhandled struct type: %s" % struct_member['type'])
1471 cast_type = "(void*)"
1472 if print_array and struct_member['array']:
1473 member_print_post = "[%u]"
1474 array_index = " i,"
1475 member_post = "[i]"
Tobin Ehlisb0497852015-02-11 14:24:02 -07001476 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 -06001477 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 -07001478 return (print_out, print_arg)
1479
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001480 def _generateBody(self):
Tobin Ehlis83562882014-11-27 15:43:39 -07001481 gv_funcs = []
1482 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001483 array_func_list.append('vkbufferviewattachinfo')
1484 array_func_list.append('vkimageviewattachinfo')
1485 array_func_list.append('vksamplerimageviewinfo')
1486 array_func_list.append('vkdescriptortypecount')
Tobin Ehlis83562882014-11-27 15:43:39 -07001487 # For first pass, generate prototype
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001488 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001489 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1490 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001491 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001492 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]))
1493 else:
1494 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 -07001495 gv_funcs.append('\n')
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001496 for s in sorted(self.struct_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001497 p_out = ""
1498 p_args = ""
1499 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1500 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1501 pl_dict = {}
1502 struct_num = 0
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001503 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlis83562882014-11-27 15:43:39 -07001504 for m in sorted(self.struct_dict[s]):
1505 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1506 stp_list.append(self.struct_dict[s][m])
1507 if 'pNext' == self.struct_dict[s][m]['name']:
1508 pl_dict[m] = ' PORT=\\"pNext\\"'
1509 else:
1510 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1511 struct_num += 1
1512 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]))
1513 num_stps = len(stp_list);
1514 total_strlen_str = ''
1515 if 0 != num_stps:
1516 gv_funcs.append(" char* tmpStr;\n")
1517 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001518 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1519 for index in range(num_stps):
1520 if (stp_list[index]['ptr']):
1521 if 'pDescriptorInfo' == stp_list[index]['name']:
1522 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1523 else:
1524 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1525 if 'pNext' == stp_list[index]['name']:
1526 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001527 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001528 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1529 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1530 gv_funcs.append(' free(tmpStr);\n')
1531 else:
1532 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 -06001533 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001534 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 -07001535 else:
1536 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1537 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1538 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1539 gv_funcs.append(' }\n')
Chia-I Wu3bf80a62014-12-16 00:36:58 +08001540 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlis83562882014-11-27 15:43:39 -07001541 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1542 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1543 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1544 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1545 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1546 else:
1547 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1548 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1549 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1550 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1551 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1552 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1553 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1554 p_args = ", myNodeName, myNodeName, pStruct"
1555 for m in sorted(self.struct_dict[s]):
1556 plabel = ""
1557 if m in pl_dict:
1558 plabel = pl_dict[m]
1559 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1560 p_out += p_out1
1561 p_args += p_args1
1562 p_out += '</TABLE>>\\n];\\n\\n"'
1563 p_args += ");\n"
1564 gv_funcs.append(p_out)
1565 gv_funcs.append(p_args)
1566 if 0 != num_stps:
1567 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1568 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1569 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1570 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1571 gv_funcs.append(' }\n')
1572 gv_funcs.append(' }\n')
1573 gv_funcs.append(" return str;\n}\n")
1574 if s.lower().strip("_") in array_func_list:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001575 ptr_array = False
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001576 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001577 ptr_array = True
1578 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]))
1579 else:
1580 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 -07001581 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1582 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')
1583 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1584 gv_funcs.append(' sprintf(tmpStr, "');
1585 p_args = ""
1586 p_out = ""
1587 for m in sorted(self.struct_dict[s]):
Tobin Ehlis83562882014-11-27 15:43:39 -07001588 plabel = ""
1589 (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 -07001590 if 0 == m: # Add array index notation at end of first row
1591 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 -07001592 p_args1 += ', i, i'
1593 p_out += p_out1
1594 p_args += p_args1
1595 p_out += '"'
1596 p_args += ");\n"
Tobin Ehlisb8013a22015-02-26 12:57:08 -07001597 if ptr_array:
1598 p_args = p_args.replace('->', '[i]->')
1599 else:
1600 p_args = p_args.replace('->', '[i].')
Tobin Ehlis83562882014-11-27 15:43:39 -07001601 gv_funcs.append(p_out);
1602 gv_funcs.append(p_args);
1603 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1604 gv_funcs.append(' }\n')
1605 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlis83562882014-11-27 15:43:39 -07001606 gv_funcs.append(' return str;\n}\n')
1607 # Add function to dynamically print out unknown struct
Mark Lobodzinski17caf572015-01-29 08:55:56 -06001608 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001609 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001610 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001611 gv_funcs.append(" switch (sType)\n {\n")
1612 for e in enum_type_dict:
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001613 if "StructureType" in e:
Tobin Ehlis83562882014-11-27 15:43:39 -07001614 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchter95487bc2015-04-14 18:48:46 -06001615 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis83562882014-11-27 15:43:39 -07001616 print_func_name = self._get_gv_func_name(struct_name)
1617 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001618 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001619 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001620 if 'VkSemaphoreCreateInfo' in struct_name:
1621 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001622 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001623 elif 'VkSemaphoreOpenInfo' in struct_name:
1624 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlis83562882014-11-27 15:43:39 -07001625 print_func_name = self._get_gv_func_name(struct_name)
1626 gv_funcs.append(' case %s:\n' % (v))
1627 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1628 #gv_funcs.append(' }\n')
1629 #gv_funcs.append(' break;\n')
Chia-I Wubfa3fea2014-12-16 00:43:20 +08001630 gv_funcs.append(" default:\n")
1631 gv_funcs.append(" return NULL;\n")
Tobin Ehlis83562882014-11-27 15:43:39 -07001632 gv_funcs.append(" }\n")
1633 gv_funcs.append("}")
1634 return "".join(gv_funcs)
1635
1636
1637
1638
1639
1640# def _generateHeader(self):
1641# hdr = []
1642# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1643# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1644# hdr.append('edge [\n];\n')
1645# return "\n".join(hdr)
1646#
1647# def _generateBody(self):
1648# body = []
Peter Lohrmann49ea1842015-03-30 16:29:56 -07001649# for s in sorted(self.struc_dict):
Tobin Ehlis83562882014-11-27 15:43:39 -07001650# field_num = 1
1651# 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]))
1652# for m in sorted(self.struc_dict[s]):
1653# 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']))
1654# field_num += 2
1655# body.append('</TABLE>>\n];\n')
1656# return "".join(body)
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001657
1658def main(argv=None):
1659 opts = handle_args()
1660 # Parse input file and fill out global dicts
1661 hfp = HeaderFileParser(opts.input_file)
1662 hfp.parse()
1663 # TODO : Don't want these to be global, see note at top about wrapper classes
1664 global enum_val_dict
1665 global enum_type_dict
1666 global struct_dict
1667 global typedef_fwd_dict
1668 global typedef_rev_dict
1669 global types_dict
1670 enum_val_dict = hfp.get_enum_val_dict()
1671 enum_type_dict = hfp.get_enum_type_dict()
1672 struct_dict = hfp.get_struct_dict()
Tobin Ehlis5a487e52014-11-11 12:28:12 -07001673 # 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 -06001674 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1675 typedef_rev_dict = hfp.get_typedef_rev_dict()
1676 types_dict = hfp.get_types_dict()
1677 #print(enum_val_dict)
1678 #print(typedef_dict)
1679 #print(struct_dict)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001680 prefix = os.path.basename(opts.input_file).strip(".h")
1681 if prefix == "vulkan":
1682 prefix = "vk"
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001683 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001684 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001685 else:
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001686 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001687 enum_sh_filename = os.path.abspath(enum_sh_filename)
1688 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1689 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1690 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001691 if opts.gen_enum_string_helper:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001692 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -06001693 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001694 print("Generating enum validate helper to %s" % enum_vh_filename)
1695 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 -06001696 eg.generateStringHelper()
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001697 eg.generateEnumValidate()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001698 #for struct in struct_dict:
1699 #print(struct)
1700 if opts.gen_struct_wrappers:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001701 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 -06001702 #print(sw.get_class_name(struct))
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001703 sw.set_include_headers([os.path.basename(opts.input_file),os.path.basename(enum_sh_filename),"stdint.h","inttypes.h", "stdio.h","stdlib.h"])
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001704 print("Generating struct wrapper header to %s" % sw.header_filename)
1705 sw.generateHeader()
1706 print("Generating struct wrapper class to %s" % sw.class_filename)
1707 sw.generateBody()
1708 sw.generateStringHelper()
Tobin Ehlis14ff0852014-12-17 17:44:50 -07001709 sw.generateValidateHelper()
Tobin Ehlisd49efcb2014-11-25 17:43:26 -07001710 # Generate a 2nd helper file that excludes addrs
1711 sw.set_no_addr(True)
1712 sw.generateStringHelper()
Tobin Ehlis99f88672015-01-10 12:42:41 -07001713 sw.set_no_addr(False)
1714 sw.set_include_headers([os.path.basename(opts.input_file),os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h","iostream","sstream","string"])
Tobin Ehlis99f88672015-01-10 12:42:41 -07001715 sw.set_no_addr(True)
1716 sw.generateStringHelperCpp()
Tobin Ehlis5178bd72015-03-06 10:38:25 -07001717 sw.set_no_addr(False)
1718 sw.generateStringHelperCpp()
Courtney Goeltzenleuchterf53c3cb2015-04-14 14:55:44 -06001719 sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
Tobin Ehlis60354772015-03-12 14:50:40 -06001720 sw.generateSizeHelper()
Peter Lohrmann4a8d8912015-04-03 11:43:06 -07001721 sw.generateSizeHelperC()
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001722 if opts.gen_cmake:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001723 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001724 cmg.generate()
1725 if opts.gen_graphviz:
Tobin Ehlis7c47fc42014-12-17 07:20:23 -07001726 gv = GraphVizGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -06001727 gv.set_include_headers([os.path.basename(opts.input_file),os.path.basename(enum_sh_filename),"stdint.h","stdio.h","stdlib.h", "inttypes.h"])
Tobin Ehlis6442dca2014-10-22 15:13:53 -06001728 gv.generate()
1729 print("DONE!")
1730 #print(typedef_rev_dict)
1731 #print(types_dict)
1732 #recreate_structs()
1733
1734if __name__ == "__main__":
1735 sys.exit(main())