blob: 7d201253f87731ec4585f1b6e43c48330f495d36 [file] [log] [blame]
Tobin Ehlis3ed06942014-11-10 16:03:19 -07001#!/usr/bin/env python3
2#
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06003# VK
Tobin Ehlis3ed06942014-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 Ehlisee33fa52014-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 Goeltzenleuchter9cc421e2015-04-08 15:36:08 -060030# Initially it's intended to support Mantle and VK headers and
Tobin Ehlisee33fa52014-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 Ehlisf57562c2015-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 Ehlisee33fa52014-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 Ehlis91cc24a2015-03-06 10:38:25 -070092 self.last_struct_count_name = ''
Tobin Ehlisee33fa52014-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 Ehlis91cc24a2015-03-06 10:38:25 -0700123 prev_count_name = ''
Tobin Ehlisee33fa52014-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 Ashburna0ddc902015-01-09 09:11:44 -0700136 #print("Skipping commented line %s" % line)
Tobin Ehlisee33fa52014-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 Ashburna0ddc902015-01-09 09:11:44 -0700142 default_enum_val = 0
Tobin Ehlisee33fa52014-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 Ashburna0ddc902015-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 Ehlisee33fa52014-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 Ehlis91cc24a2015-03-06 10:38:25 -0700158 self.last_struct_count_name = ''
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600159 member_num = 0
Tobin Ehlisee33fa52014-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 Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600163 #print("fwd_dict: %s = %s" % (base_type, targ_type))
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600164 elif parse_enum:
Courtney Goeltzenleuchter9cc421e2015-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 Ashburna0ddc902015-01-09 09:11:44 -0700167 self._add_enum(line, base_type, default_enum_val)
168 default_enum_val += 1
Tobin Ehlisee33fa52014-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 Ehlisee33fa52014-10-22 15:13:53 -0600173
174 # populate enum dicts based on enum lines
Jon Ashburna0ddc902015-01-09 09:11:44 -0700175 def _add_enum(self, line_txt, enum_type, def_enum_val):
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600176 #print("Parsing enum line %s" % line_txt)
Jon Ashburna0ddc902015-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 Ehlisee33fa52014-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 Ehlis3ed9f8f2015-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 Ehlis5e848502014-12-05 12:13:07 -0700195 # Try to cast to int to determine if enum value is unique
Tobin Ehlisee33fa52014-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 Ehlis91cc24a2015-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 Ehlisee33fa52014-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 Ehlis91cc24a2015-03-06 10:38:25 -0700233 # Store counts to help recognize and size dynamic arrays
Tobin Ehlise653c2d2015-04-15 16:01:16 -0600234 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700235 self.last_struct_count_name = member_name
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600236 self.struct_dict[struct_type][num] = {}
237 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700238 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600239 if '*' in member_type:
240 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis91cc24a2015-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 Ehlisee33fa52014-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 Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600248 member_type = member_type.replace('const', '').strip()
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600249 else:
250 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis6f7029b2014-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 Ehlisee33fa52014-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)
260 self.struct_dict[struct_type][num]['array'] = True
261 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700262 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
263 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
264 self.struct_dict[struct_type][num]['array'] = True
265 self.struct_dict[struct_type][num]['dyn_array'] = True
266 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisd1c0e662015-02-26 12:57:08 -0700267 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600268 self.struct_dict[struct_type][num]['array'] = False
269 self.struct_dict[struct_type][num]['array_size'] = 0
270 self.struct_dict[struct_type][num]['name'] = member_name
271
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700272# check if given identifier is of specified type_to_check
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600273def is_type(identifier, type_to_check):
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600274 if identifier in types_dict and type_to_check == types_dict[identifier]:
275 return True
276 if identifier in typedef_rev_dict:
277 new_id = typedef_rev_dict[identifier]
278 if new_id in types_dict and type_to_check == types_dict[new_id]:
279 return True
280 return False
281
282# This is a validation function to verify that we can reproduce the original structs
283def recreate_structs():
284 for struct_name in struct_dict:
285 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
286 for mem_num in sorted(struct_dict[struct_name]):
287 sys.stdout.write(" ")
288 if struct_dict[struct_name][mem_num]['const']:
289 sys.stdout.write("const ")
290 #if struct_dict[struct_name][mem_num]['struct']:
291 # sys.stdout.write("struct ")
292 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
293 if struct_dict[struct_name][mem_num]['ptr']:
294 sys.stdout.write("*")
295 sys.stdout.write(" ")
296 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
297 if struct_dict[struct_name][mem_num]['array']:
298 sys.stdout.write("[")
299 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
300 sys.stdout.write("]")
301 sys.stdout.write(";\n")
302 sys.stdout.write("} ")
303 sys.stdout.write(typedef_fwd_dict[struct_name])
304 sys.stdout.write(";\n\n")
305
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600306#
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600307# TODO: Fix construction of struct name
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600308def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600309 # Note: All struct types are now camel-case
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600310 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600311 char_idx = 0
312 struct_name = ''
313 for char in caps_struct_name:
314 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
315 struct_name += caps_struct_name[char_idx]
316 elif (caps_struct_name[char_idx] == '_'):
317 pass
318 else:
319 struct_name += caps_struct_name[char_idx].lower()
320 char_idx += 1
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600321 return struct_name
322
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600323# class for writing common file elements
324# Here's how this class lays out a file:
325# COPYRIGHT
326# HEADER
327# BODY
328# FOOTER
329#
330# For each of these sections, there's a "set*" function
331# The class as a whole has a generate function which will write each section in order
332class CommonFileGen:
333 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
334 self.filename = filename
335 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
336 # TODO : Set a default copyright & footer at least
337
338 def setFilename(self, filename):
339 self.filename = filename
340
341 def setCopyright(self, c):
342 self.contents['copyright'] = c
343
344 def setHeader(self, h):
345 self.contents['header'] = h
346
347 def setBody(self, b):
348 self.contents['body'] = b
349
350 def setFooter(self, f):
351 self.contents['footer'] = f
352
353 def generate(self):
354 #print("Generate to file %s" % self.filename)
355 with open(self.filename, "w") as f:
356 f.write(self.contents['copyright'])
357 f.write(self.contents['header'])
358 f.write(self.contents['body'])
359 f.write(self.contents['footer'])
360
361# class for writing a wrapper class for structures
362# The wrapper class wraps the structs and includes utility functions for
363# setting/getting member values and displaying the struct data in various formats
364class StructWrapperGen:
365 def __init__(self, in_struct_dict, prefix, out_dir):
366 self.struct_dict = in_struct_dict
367 self.include_headers = []
368 self.api = prefix
Courtney Goeltzenleuchtercbf13812015-04-14 16:30:53 -0600369 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600370 self.api_prefix = "vk"
371 else:
372 self.api_prefix = prefix
373 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
374 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
375 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
376 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
377 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
378 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
379 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700380 self.no_addr = False
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600381 self.hfg = CommonFileGen(self.header_filename)
382 self.cfg = CommonFileGen(self.class_filename)
383 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700384 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700385 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600386 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
387 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlisff765b02015-03-12 14:50:40 -0600388 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700389 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600390 #print(self.header_filename)
391 self.header_txt = ""
392 self.definition_txt = ""
393
394 def set_include_headers(self, include_headers):
395 self.include_headers = include_headers
396
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700397 def set_no_addr(self, no_addr):
398 self.no_addr = no_addr
399 if self.no_addr:
400 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700401 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700402 else:
403 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700404 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700405
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600406 # Return class name for given struct name
407 def get_class_name(self, struct_name):
408 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
409 return class_name
410
411 def get_file_list(self):
412 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
413
414 # Generate class header file
415 def generateHeader(self):
416 self.hfg.setCopyright(self._generateCopyright())
417 self.hfg.setHeader(self._generateHeader())
418 self.hfg.setBody(self._generateClassDeclaration())
419 self.hfg.setFooter(self._generateFooter())
420 self.hfg.generate()
421
422 # Generate class definition
423 def generateBody(self):
424 self.cfg.setCopyright(self._generateCopyright())
425 self.cfg.setHeader(self._generateCppHeader())
426 self.cfg.setBody(self._generateClassDefinition())
427 self.cfg.setFooter(self._generateFooter())
428 self.cfg.generate()
429
430 # Generate c-style .h file that contains functions for printing structs
431 def generateStringHelper(self):
432 print("Generating struct string helper")
433 self.shg.setCopyright(self._generateCopyright())
434 self.shg.setHeader(self._generateStringHelperHeader())
435 self.shg.setBody(self._generateStringHelperFunctions())
436 self.shg.generate()
437
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700438 # Generate cpp-style .h file that contains functions for printing structs
439 def generateStringHelperCpp(self):
440 print("Generating struct string helper cpp")
441 self.shcppg.setCopyright(self._generateCopyright())
442 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
443 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
444 self.shcppg.generate()
445
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700446 # Generate c-style .h file that contains functions for printing structs
447 def generateValidateHelper(self):
448 print("Generating struct validate helper")
449 self.vhg.setCopyright(self._generateCopyright())
450 self.vhg.setHeader(self._generateValidateHelperHeader())
451 self.vhg.setBody(self._generateValidateHelperFunctions())
452 self.vhg.generate()
453
Tobin Ehlisff765b02015-03-12 14:50:40 -0600454 def generateSizeHelper(self):
455 print("Generating struct size helper")
456 self.size_helper_gen.setCopyright(self._generateCopyright())
457 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
458 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
459 self.size_helper_gen.generate()
460
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700461 def generateSizeHelperC(self):
462 print("Generating struct size helper c")
463 self.size_helper_c_gen.setCopyright(self._generateCopyright())
464 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
465 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
466 self.size_helper_c_gen.generate()
467
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600468 def _generateCopyright(self):
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700469 copyright = []
470 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
471 copyright.append('');
472 copyright.append('/*');
Ian Elliotte3b10452015-04-15 11:15:13 -0600473 copyright.append(' * Vulkan');
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700474 copyright.append(' *');
475 copyright.append(' * Copyright (C) 2014 LunarG, Inc.');
476 copyright.append(' *');
477 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
478 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
479 copyright.append(' * to deal in the Software without restriction, including without limitation');
480 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
481 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
482 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
483 copyright.append(' *');
484 copyright.append(' * The above copyright notice and this permission notice shall be included');
485 copyright.append(' * in all copies or substantial portions of the Software.');
486 copyright.append(' *');
487 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
488 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
489 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
490 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
491 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
492 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
493 copyright.append(' * DEALINGS IN THE SOFTWARE.');
494 copyright.append(' */');
495 copyright.append('');
496 return "\n".join(copyright)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600497
498 def _generateCppHeader(self):
499 header = []
500 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600501 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 Ehlisee33fa52014-10-22 15:13:53 -0600502 return "".join(header)
503
504 def _generateClassDefinition(self):
505 class_def = []
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600506 if 'vk' == self.api: # Mantle doesn't have pNext to worry about
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600507 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmannc55cfa12015-03-30 16:29:56 -0700508 for s in sorted(self.struct_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600509 class_def.append("\n// %s class definition" % self.get_class_name(s))
510 class_def.append(self._generateConstructorDefinitions(s))
511 class_def.append(self._generateDestructorDefinitions(s))
512 class_def.append(self._generateDisplayDefinitions(s))
513 return "\n".join(class_def)
514
515 def _generateConstructorDefinitions(self, s):
516 con_defs = []
517 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)))
518 # TODO : This is a shallow copy of ptrs
519 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]))
520 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]))
521 return "\n".join(con_defs)
522
523 def _generateDestructorDefinitions(self, s):
524 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
525
526 def _generateDynamicPrintFunctions(self):
527 dp_funcs = []
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600528 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 Goeltzenleuchter382489d2015-04-10 08:34:15 -0600529 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600530 dp_funcs.append(" switch (sType)\n {")
531 for e in enum_type_dict:
532 class_num = 0
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600533 if "StructureType" in e:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600534 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600535 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600536 class_name = self.get_class_name(struct_name)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600537 instance_name = "swc%i" % class_num
538 dp_funcs.append(" case %s:\n {" % (v))
539 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
540 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
541 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
542 dp_funcs.append(" }")
543 dp_funcs.append(" break;")
544 class_num += 1
545 dp_funcs.append(" }")
546 dp_funcs.append("}\n")
547 return "\n".join(dp_funcs)
548
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700549 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600550 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700551
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600552 def _get_sh_func_name(self, struct):
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700553 return self._get_func_name(struct, 'print')
554
555 def _get_vh_func_name(self, struct):
556 return self._get_func_name(struct, 'validate')
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600557
Tobin Ehlisff765b02015-03-12 14:50:40 -0600558 def _get_size_helper_func_name(self, struct):
559 return self._get_func_name(struct, 'size')
560
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600561 # Return elements to create formatted string for given struct member
562 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
563 struct_op = "->"
564 if not struct_ptr:
565 struct_op = "."
566 member_name = struct_member['name']
567 print_type = "p"
568 cast_type = ""
569 member_post = ""
570 array_index = ""
571 member_print_post = ""
Tobin Ehlisbf0146e2015-02-11 14:24:02 -0700572 print_delimiter = "%"
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700573 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
574 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
575 member_post = "[0]"
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600576 print_type = "s"
577 print_array = False
578 elif struct_member['array'] and not print_array:
579 # Just print base address of array when not full print_array
580 cast_type = "(void*)"
581 elif is_type(struct_member['type'], 'enum'):
582 cast_type = "string_%s" % struct_member['type']
Jon Ashburna0ddc902015-01-09 09:11:44 -0700583 if struct_member['ptr']:
584 struct_var_name = "*" + struct_var_name
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600585 print_type = "s"
586 elif is_type(struct_member['type'], 'struct'): # print struct address for now
587 cast_type = "(void*)"
588 if not struct_member['ptr']:
589 cast_type = "(void*)&"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700590 elif 'bool' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600591 print_type = "s"
592 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700593 elif 'float' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600594 print_type = "f"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600595 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
596 print_type = '" PRId64 "'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700597 elif 'uint8' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600598 print_type = "hu"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600599 elif 'size' in struct_member['type'].lower():
Tobin Ehlisbf0146e2015-02-11 14:24:02 -0700600 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
601 print_delimiter = ""
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600602 elif True in [ui_str.lower() in struct_member['type'].lower() for ui_str in ['uint', 'flags', 'samplemask']]:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600603 print_type = "u"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700604 elif 'int' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600605 print_type = "i"
606 elif struct_member['ptr']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600607 pass
608 else:
609 #print("Unhandled struct type: %s" % struct_member['type'])
610 cast_type = "(void*)"
611 if print_array and struct_member['array']:
612 member_print_post = "[%u]"
613 array_index = " i,"
614 member_post = "[i]"
Tobin Ehlisbf0146e2015-02-11 14:24:02 -0700615 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 Ehlisee33fa52014-10-22 15:13:53 -0600616 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 Ehlis07fe9ab2014-11-25 17:43:26 -0700617 if self.no_addr and "p" == print_type:
618 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
619 print_arg = ", %s" % (pre_var_name)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600620 return (print_out, print_arg)
621
622 def _generateStringHelperFunctions(self):
623 sh_funcs = []
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700624 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700625 for s in sorted(self.struct_dict):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700626 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
627 sh_funcs.append('')
628 sh_funcs.append('#if defined(_WIN32)')
629 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
630 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
631 sh_funcs.append('// work-around.')
632 sh_funcs.append('#define snprintf _snprintf')
633 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmannc55cfa12015-03-30 16:29:56 -0700634 for s in sorted(self.struct_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600635 p_out = ""
636 p_args = ""
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700637 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700638 # This pre-pass flags embedded structs and pNext
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700639 for m in sorted(self.struct_dict[s]):
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700640 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
641 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700642 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]))
643 sh_funcs.append(" size_t len;")
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700644 num_stps = len(stp_list);
645 total_strlen_str = ''
646 if 0 != num_stps:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700647 sh_funcs.append(" char* tmpStr;")
648 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
649 sh_funcs.append(' strcpy(extra_indent, " ");')
650 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
651 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700652 for index in range(num_stps):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700653 # If it's an array, print all of the elements
654 # If it's a ptr, print thing it's pointing to
655 # Non-ptr struct case. Print the struct using its address
656 struct_deref = '&'
657 if 1 < stp_list[index]['full_type'].count('*'):
658 struct_deref = ''
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700659 if (stp_list[index]['ptr']):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700660 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700661 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700662 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
663 sh_funcs.append(' len = 256+strlen(tmpStr);')
664 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700665 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700666 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700667 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700668 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
669 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700670 else:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -0700671 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
672 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchter24591b62015-04-02 22:54:15 -0600673 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
Tobin Ehlisd1c0e662015-02-26 12:57:08 -0700674 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700675 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
676 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
677 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700678 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700679 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name']))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700680 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700681 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']))
682 sh_funcs.append(' }')
683 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
684 elif stp_list[index]['array']:
685 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
686 sh_funcs.append(' len = 256+strlen(tmpStr);')
687 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700688 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700689 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s[0] (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name']))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700690 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700691 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 Ehlis6f7029b2014-11-11 12:28:12 -0700692 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700693 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
694 sh_funcs.append(' len = 256+strlen(tmpStr);')
695 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700696 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700697 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%s%s (addr)\\n%%s", prefix, tmpStr);' % (index, stp_list[index]['name']))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700698 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700699 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 Ehlis6f7029b2014-11-11 12:28:12 -0700700 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700701 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
702 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchtercde421c2014-12-01 09:31:17 -0700703 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600704 for m in sorted(self.struct_dict[s]):
705 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
706 p_out += p_out1
707 p_args += p_args1
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600708 p_out += '"'
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700709 p_args += ");"
710 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700711 if 0 != num_stps:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700712 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
713 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
714 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
715 sh_funcs.append(' free(stp_strs[stp_index]);')
716 sh_funcs.append(' }')
717 sh_funcs.append(' }')
718 sh_funcs.append(' free(extra_indent);')
719 sh_funcs.append(" return str;\n}")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600720 # Add function to dynamically print out unknown struct
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700721 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
722 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
723 sh_funcs.append(" if (pStruct == NULL) {")
724 sh_funcs.append(" return NULL;")
725 sh_funcs.append(" }")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600726 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700727 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
728 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600729 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600730 if "StructureType" in e:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600731 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600732 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600733 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700734 sh_funcs.append(' case %s:\n {' % (v))
735 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
736 sh_funcs.append(' }')
737 sh_funcs.append(' break;')
738 sh_funcs.append(" default:")
739 sh_funcs.append(" return NULL;")
740 sh_funcs.append(" }")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600741 sh_funcs.append("}")
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700742 return "\n".join(sh_funcs)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700743
744 def _generateStringHelperFunctionsCpp(self):
745 # declare str & tmp str
746 # declare array of stringstreams for every struct ptr in current struct
747 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700748 # For every struct ptr, if non-Null, then set its string, else set to NULL str
749 # For every non-string element, set its string stream
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700750 # create and return final string
751 sh_funcs = []
752 # First generate prototypes for every struct
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600753 # XXX - REMOVE this comment
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700754 for s in sorted(self.struct_dict):
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700755 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
756 sh_funcs.append('\n')
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700757 for s in sorted(self.struct_dict):
Tobin Ehlis3d742282015-06-11 09:37:00 -0600758 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 Ehlis434db7c2015-01-10 12:42:41 -0700759 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700760 # This pre-pass flags embedded structs and pNext
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700761 for m in sorted(self.struct_dict[s]):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700762 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 Ehlis434db7c2015-01-10 12:42:41 -0700763 stp_list.append(self.struct_dict[s][m])
764 sh_funcs.append('string %s(const %s* pStruct, const string prefix)\n{' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700765 indent = ' '
Tobin Ehlis4a636a12015-04-09 09:19:36 -0600766 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700767 sh_funcs.append('%sstring final_str;' % (indent))
768 sh_funcs.append('%sstring tmp_str;' % (indent))
769 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700770 if (0 != num_non_enum_elems):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700771 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700772 num_stps = len(stp_list)
Tobin Ehlis3d742282015-06-11 09:37:00 -0600773 # First generate code for any embedded structs or arrays
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700774 if 0 < num_stps:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700775 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700776 idx_ss_decl = False # Make sure to only decl this once
777 for index in range(num_stps):
778 addr_char = '&'
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700779 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700780 addr_char = ''
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700781 if (stp_list[index]['array']):
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600782 #sh_funcs.append('/* A */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700783 if stp_list[index]['dyn_array']:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600784 #sh_funcs.append('/* AA */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700785 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
786 else:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600787 #sh_funcs.append('/* AB */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700788 array_count = '%s' % (stp_list[index]['array_size'])
789 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
790 if not idx_ss_decl:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600791 #sh_funcs.append('/* AC */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700792 sh_funcs.append('%sstringstream index_ss;' % (indent))
793 idx_ss_decl = True
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600794 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
795 indent += ' '
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700796 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600797 indent += ' '
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700798 sh_funcs.append('%sindex_ss.str("");' % (indent))
799 sh_funcs.append('%sindex_ss << i;' % (indent))
Tobin Ehlis3d742282015-06-11 09:37:00 -0600800 if is_type(stp_list[index]['type'], 'enum'):
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600801 #sh_funcs.append('/* AD */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700802 addr_char = ''
Tobin Ehlis3d742282015-06-11 09:37:00 -0600803 #value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
804 sh_funcs.append('%sss[%u] << string_%s(pStruct->%s[i]);' % (indent, index, stp_list[index]['type'], stp_list[index]['name']))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700805 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
Tobin Ehlis3d742282015-06-11 09:37:00 -0600806 elif is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600807 #sh_funcs.append('/* AD */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700808 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
809 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']))
810 if self.no_addr:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600811 #sh_funcs.append('/* ADA */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700812 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
813 else:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600814 #sh_funcs.append('/* ADB */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700815 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 Ehlis3d742282015-06-11 09:37:00 -0600816 else:
817 #sh_funcs.append('/* AD */');
818 addr_char = ''
819 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
820 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700821 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600822 indent = indent[4:]
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700823 sh_funcs.append('%s}' % (indent))
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600824 indent = indent[4:]
825 sh_funcs.append('%s}' % (indent))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700826 elif (stp_list[index]['ptr']):
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600827 #sh_funcs.append('/* B */');
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700828 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
829 if 'pNext' == stp_list[index]['name']:
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600830 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700831 else:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -0700832 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
833 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchter24591b62015-04-02 22:54:15 -0600834 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 Ehlisd1c0e662015-02-26 12:57:08 -0700835 else:
836 sh_funcs.append(' tmp_str = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700837 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
838 if self.no_addr:
839 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
840 else:
841 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
842 sh_funcs.append(' ss[%u].str("");' % (index))
843 sh_funcs.append(' }')
844 sh_funcs.append(' else')
845 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700846 else:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600847 #sh_funcs.append('/* C */');
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700848 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
849 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
850 if self.no_addr:
851 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
852 else:
853 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
854 sh_funcs.append(' ss[%u].str("");' % index)
Tobin Ehlis3d742282015-06-11 09:37:00 -0600855 # Now print one-line info for all data members
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700856 index = 0
857 final_str = ''
858 for m in sorted(self.struct_dict[s]):
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700859 deref = ''
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700860 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
861 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
862 if self.no_addr:
863 sh_funcs.append(' ss[%u].str("addr");' % (index))
864 else:
865 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700866 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700867 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700868 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700869 sh_funcs.append(' ss[%u] << (uint32_t)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlisf46627e2015-04-28 17:27:16 -0600870 elif 'void' in self.struct_dict[s][m]['type'].lower() and self.struct_dict[s][m]['ptr']:
871 sh_funcs.append(' if (StreamControl::writeAddress)')
872 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
873 sh_funcs.append(' else')
874 sh_funcs.append(' ss[%u].str("address");' % (index))
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700875 else:
876 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700877 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700878 sh_funcs.append(' ss[%u].str("addr");' % (index))
879 else:
880 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
881 value_print = 'ss[%u].str()' % index
882 index += 1
883 else:
Tobin Ehlis3d742282015-06-11 09:37:00 -0600884 # For an non-empty array of enums just print address w/ note that array will be displayed below
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700885 if self.struct_dict[s][m]['ptr']:
Tobin Ehlis3d742282015-06-11 09:37:00 -0600886 sh_funcs.append(' if (pStruct->%s)' % (self.struct_dict[s][m]['name']))
887 sh_funcs.append(' ss[%u] << pStruct->%s << " (See individual array values below)";' % (index, self.struct_dict[s][m]['name']))
888 sh_funcs.append(' else')
889 sh_funcs.append(' ss[%u].str("NULL");' % (index))
890 value_print = 'ss[%u].str()' % index
891 index += 1
892 # For single enum just print the string representation
893 else:
894 value_print = 'string_%s(pStruct->%s)' % (self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name'])
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700895 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
896 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700897 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700898 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
899 sh_funcs.append(' final_str = %s;' % final_str)
900 sh_funcs.append(' return final_str;\n}')
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700901 # Add function to return a string value for input void*
902 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlis4a636a12015-04-09 09:19:36 -0600903 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700904 sh_funcs.append(" stringstream ss;")
905 sh_funcs.append(' ss << toString;')
906 sh_funcs.append(' string final_str = prefix + ss.str();')
907 sh_funcs.append(" return final_str;")
908 sh_funcs.append("}")
Tobin Ehlisc99cb0d2015-04-16 15:56:11 -0600909 # Add function to return a string value for input uint32_t
910 sh_funcs.append("string string_convert_helper(const uint32_t toString, const string prefix)\n{")
911 sh_funcs.append(" using namespace StreamControl;")
912 sh_funcs.append(" stringstream ss;")
913 sh_funcs.append(' ss << toString;')
914 sh_funcs.append(' string final_str = prefix + ss.str();')
915 sh_funcs.append(" return final_str;")
916 sh_funcs.append("}")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700917 # Add function to dynamically print out unknown struct
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600918 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700919 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliotta5a0a172015-02-25 17:40:38 -0700920 sh_funcs.append(" if (pStruct == NULL) {\n")
Jon Ashburn49398b32015-02-25 12:45:23 -0700921 sh_funcs.append(" return NULL;")
Ian Elliotta5a0a172015-02-25 17:40:38 -0700922 sh_funcs.append(" }\n")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600923 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700924 sh_funcs.append(' string indent = " ";')
925 sh_funcs.append(' indent += prefix;')
926 sh_funcs.append(" switch (sType)\n {")
927 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600928 if "StructureType" in e:
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700929 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600930 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700931 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600932 #sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700933 sh_funcs.append(' case %s:\n {' % (v))
934 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
935 sh_funcs.append(' }')
936 sh_funcs.append(' break;')
937 sh_funcs.append(" default:")
938 sh_funcs.append(" return NULL;")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600939 sh_funcs.append(" }")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700940 sh_funcs.append("}")
941 return "\n".join(sh_funcs)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600942
943 def _genStructMemberPrint(self, member, s, array, struct_array):
944 (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)
945 extra_indent = ""
946 if array:
947 extra_indent = " "
948 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
949 struct_array.insert(0, self.struct_dict[s][member])
950 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700951 # Special case for void* named "pNext"
952 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600953 struct_array.insert(0, self.struct_dict[s][member])
954 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
955
956 def _generateDisplayDefinitions(self, s):
957 disp_def = []
958 struct_array = []
959 # Single-line struct print function
960 disp_def.append("// Output 'structname = struct_address' on a single line")
961 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
962 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
963 disp_def.append("}\n")
964 # Private helper function to print struct members
965 disp_def.append("// Private helper function that displays the members of the wrapped struct")
966 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
967 i_declared = False
968 for member in sorted(self.struct_dict[s]):
969 # TODO : Need to display each member based on its type
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600970 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600971 # Can grab struct type off of header of struct pointed to
972 # TODO : Handle Arrays
973 if self.struct_dict[s][member]['array']:
974 # Create for loop to print each element of array
975 if not i_declared:
976 disp_def.append(' uint32_t i;')
977 i_declared = True
978 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
979 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
980 disp_def.append(return_str)
981 disp_def.append(' }')
982 else:
983 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
984 disp_def.append(return_str)
985 disp_def.append("}\n")
986 i_declared = False
987 # Basic print function to display struct members
988 disp_def.append("// Output all struct elements, each on their own line")
989 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
990 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
991 disp_def.append(' this->display_struct_members();')
992 disp_def.append("}\n")
993 # Advanced print function to display current struct and contents of any pointed-to structs
994 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
995 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
996 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
997 disp_def.append(' this->display_struct_members();')
998 class_num = 0
999 # TODO : Need to handle arrays of structs here
1000 for ms in struct_array:
1001 swc_name = "class%s" % str(class_num)
1002 if ms['array']:
1003 if not i_declared:
1004 disp_def.append(' uint32_t i;')
1005 i_declared = True
1006 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
1007 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
1008 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1009 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1010 disp_def.append(" %s.display_full_txt();" % (swc_name))
1011 #disp_def.append(' }')
1012 disp_def.append(' }')
1013 elif 'pNext' == ms['name']:
1014 # Need some code trickery here
1015 # I'm thinking have a generated function that takes pNext ptr value
1016 # then it checks sType and in large switch statement creates appropriate
1017 # wrapper class type and then prints contents
1018 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1019 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
1020 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
1021 disp_def.append(" }")
1022 else:
1023 if ms['ptr']:
1024 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1025 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1026 else:
1027 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1028 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1029 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1030 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1031 class_num += 1
1032 disp_def.append("}\n")
1033 return "\n".join(disp_def)
1034
1035 def _generateStringHelperHeader(self):
1036 header = []
1037 header.append("//#includes, #defines, globals and such...\n")
1038 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001039 if 'vk_enum_string_helper' not in f:
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001040 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001041 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001042 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001043 return "".join(header)
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001044
1045 def _generateStringHelperHeaderCpp(self):
1046 header = []
1047 header.append("//#includes, #defines, globals and such...\n")
1048 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001049 if 'vk_enum_string_helper' not in f:
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001050 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001051 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001052 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlis4a636a12015-04-09 09:19:36 -06001053 header.append('\n')
1054 header.append('namespace StreamControl\n')
1055 header.append('{\n')
1056 header.append('bool writeAddress = true;\n')
1057 header.append('template <typename T>\n')
1058 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1059 header.append('{\n')
1060 header.append(' if(writeAddress)\n')
1061 header.append(' {\n')
1062 header.append(' out.operator<<(pointer);\n')
1063 header.append(' }\n')
1064 header.append(' else\n')
1065 header.append(' {\n')
1066 header.append(' std::operator<<(out, "address");\n')
1067 header.append(' }\n')
1068 header.append(' return out;\n')
1069 header.append('}\n')
1070 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1071 header.append('{\n')
1072 header.append(' return std::operator<<(out, s);\n')
1073 header.append('}\n')
1074 header.append('}\n')
1075 header.append('\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001076 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001077 return "".join(header)
1078
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001079 def _generateValidateHelperFunctions(self):
1080 sh_funcs = []
1081 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001082 for s in sorted(self.struct_dict):
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001083 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1084 sh_funcs.append('\n')
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001085 for s in sorted(self.struct_dict):
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001086 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1087 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001088 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001089 if is_type(self.struct_dict[s][m]['type'], 'enum') and not self.struct_dict[s][m]['ptr']:
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001090 sh_funcs.append(' if (!validate_%s(pStruct->%s))\n return 0;' % (self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name']))
Jon Ashburnaad29362015-01-12 15:46:51 -07001091 # TODO : Need a little refinement to this code to make sure type of struct matches expected input (ptr, const...)
Tobin Ehlise719e022014-12-18 09:29:58 -07001092 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1093 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlis516aa842015-02-24 15:39:04 -07001094 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 Ehlise719e022014-12-18 09:29:58 -07001095 else:
1096 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 Ehlis6cd06372014-12-17 17:44:50 -07001097 sh_funcs.append(" return 1;\n}")
1098
1099 return "\n".join(sh_funcs)
1100
1101 def _generateValidateHelperHeader(self):
1102 header = []
1103 header.append("//#includes, #defines, globals and such...\n")
1104 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001105 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001106 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001107 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001108 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001109 return "".join(header)
1110
Tobin Ehlisff765b02015-03-12 14:50:40 -06001111 def _generateSizeHelperFunctions(self):
1112 sh_funcs = []
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001113 # just generates prototypes for all the functions
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001114 for s in sorted(self.struct_dict):
Tobin Ehlisff765b02015-03-12 14:50:40 -06001115 sh_funcs.append('size_t %s(const %s* pStruct);' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001116 return "\n".join(sh_funcs)
1117
1118
1119 def _generateSizeHelperFunctionsC(self):
1120 sh_funcs = []
1121 # generate function definitions
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001122 for s in sorted(self.struct_dict):
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001123 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlisff765b02015-03-12 14:50:40 -06001124 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1125 indent = ' '
1126 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1127 sh_funcs.append('%sif (pStruct) {' % (indent))
1128 indent = ' '
1129 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1130 i_decl = False
1131 for m in sorted(self.struct_dict[s]):
1132 if m in skip_list:
1133 continue
1134 if self.struct_dict[s][m]['dyn_array']:
1135 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1136 if not is_type(self.struct_dict[s][m]['type'], 'struct') and not 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001137 if 'ppMemBarriers' == self.struct_dict[s][m]['name']:
1138 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001139 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 Ehlis91b2b642015-03-16 10:44:40 -06001140 else:
1141 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 Ehlisff765b02015-03-12 14:50:40 -06001142 else: # This is an array of char* or array of struct ptrs
1143 if not i_decl:
1144 sh_funcs.append('%suint32_t i = 0;' % (indent))
1145 i_decl = True
1146 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1147 indent = ' '
1148 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1149 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']))
1150 else:
Tobin Ehlisf57562c2015-03-13 07:18:05 -06001151 sh_funcs.append('%sstructSize += (sizeof(char*) + (sizeof(char) * (1 + strlen(pStruct->%s[i]))));' % (indent, self.struct_dict[s][m]['name']))
Tobin Ehlisff765b02015-03-12 14:50:40 -06001152 indent = ' '
1153 sh_funcs.append('%s}' % (indent))
1154 else:
1155 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1156 if not i_decl:
1157 sh_funcs.append('%suint32_t i = 0;' % (indent))
1158 i_decl = True
1159 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1160 indent = ' '
1161 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']))
1162 indent = ' '
1163 sh_funcs.append('%s}' % (indent))
1164 else:
1165 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1166 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1167 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisf57562c2015-03-13 07:18:05 -06001168 sh_funcs.append('%sstructSize += sizeof(%s)*(1+strlen(pStruct->%s));' % (indent, self.struct_dict[s][m]['type'], self.struct_dict[s][m]['name']))
Tobin Ehlisff765b02015-03-12 14:50:40 -06001169 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1170 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 Ehlis91b2b642015-03-16 10:44:40 -06001171 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisff765b02015-03-12 14:50:40 -06001172 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1173 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1174 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1175 skip_list.append(m+1)
1176 indent = ' '
1177 sh_funcs.append('%s}' % (indent))
1178 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001179 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
1180 for follow_chain in [True, False]:
1181 if follow_chain:
1182 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1183 else:
1184 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1185 indent = ' '
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001186 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1187 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001188 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1189 if follow_chain:
1190 sh_funcs.append('%swhile (pNext) {' % (indent))
1191 indent = ' '
1192 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1193 indent += ' '
1194 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001195 if 'StructureType' in e:
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001196 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001197 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001198 sh_funcs.append('%scase %s:' % (indent, v))
1199 sh_funcs.append('%s{' % (indent))
1200 indent += ' '
1201 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1202 sh_funcs.append('%sbreak;' % (indent))
1203 indent = indent[:-4]
1204 sh_funcs.append('%s}' % (indent))
1205 sh_funcs.append('%sdefault:' % (indent))
1206 indent += ' '
1207 sh_funcs.append('%sassert(0);' % (indent))
1208 sh_funcs.append('%sstructSize += 0;' % (indent))
1209 indent = indent[:-4]
1210 indent = indent[:-4]
1211 sh_funcs.append('%s}' % (indent))
1212 if follow_chain:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001213 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001214 indent = indent[:-4]
1215 sh_funcs.append('%s}' % (indent))
1216 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlisff765b02015-03-12 14:50:40 -06001217 return "\n".join(sh_funcs)
1218
1219 def _generateSizeHelperHeader(self):
1220 header = []
1221 header.append("//#includes, #defines, globals and such...\n")
1222 for f in self.include_headers:
1223 header.append("#include <%s>\n" % f)
1224 header.append('\n// Function Prototypes\n')
1225 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001226 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlisff765b02015-03-12 14:50:40 -06001227 return "".join(header)
1228
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001229 def _generateSizeHelperHeaderC(self):
1230 header = []
Courtney Goeltzenleuchtercbf13812015-04-14 16:30:53 -06001231 header.append('#include "vk_struct_size_helper.h"')
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001232 header.append('#include <string.h>')
1233 header.append('#include <assert.h>')
1234 header.append('\n// Function definitions\n')
1235 return "\n".join(header)
1236
1237
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001238 def _generateHeader(self):
1239 header = []
1240 header.append("//#includes, #defines, globals and such...\n")
1241 for f in self.include_headers:
1242 header.append("#include <%s>\n" % f)
1243 return "".join(header)
1244
1245 # Declarations
1246 def _generateConstructorDeclarations(self, s):
1247 constructors = []
1248 constructors.append(" %s();\n" % self.get_class_name(s))
1249 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1250 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1251 return "".join(constructors)
1252
1253 def _generateDestructorDeclarations(self, s):
1254 return " virtual ~%s();\n" % self.get_class_name(s)
1255
1256 def _generateDisplayDeclarations(self, s):
1257 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
1258
1259 def _generateGetSetDeclarations(self, s):
1260 get_set = []
1261 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1262 for member in sorted(self.struct_dict[s]):
1263 # TODO : Skipping array set/get funcs for now
1264 if self.struct_dict[s][member]['array']:
1265 continue
1266 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']))
1267 if not self.struct_dict[s][member]['const']:
1268 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']))
1269 return "".join(get_set)
1270
1271 def _generatePrivateMembers(self, s):
1272 priv = []
1273 priv.append("\nprivate:\n")
1274 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1275 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1276 priv.append(" uint32_t m_indent;\n")
1277 priv.append(" const char m_dummy_prefix;\n")
1278 priv.append(" void display_struct_members();\n")
1279 return "".join(priv)
1280
1281 def _generateClassDeclaration(self):
1282 class_decl = []
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001283 for s in sorted(self.struct_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001284 class_decl.append("\n//class declaration")
1285 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1286 class_decl.append(self._generateConstructorDeclarations(s))
1287 class_decl.append(self._generateDestructorDeclarations(s))
1288 class_decl.append(self._generateDisplayDeclarations(s))
1289 class_decl.append(self._generateGetSetDeclarations(s))
1290 class_decl.append(self._generatePrivateMembers(s))
1291 class_decl.append("};\n")
1292 return "\n".join(class_decl)
1293
1294 def _generateFooter(self):
1295 return "\n//any footer info for class\n"
1296
1297class EnumCodeGen:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001298 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 Ehlisee33fa52014-10-22 15:13:53 -06001299 self.et_dict = enum_type_dict
1300 self.ev_dict = enum_val_dict
1301 self.tf_dict = typedef_fwd_dict
1302 self.in_file = in_file
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001303 self.out_sh_file = out_sh_file
1304 self.eshfg = CommonFileGen(self.out_sh_file)
1305 self.out_vh_file = out_vh_file
1306 self.evhfg = CommonFileGen(self.out_vh_file)
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001307
1308 def generateStringHelper(self):
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001309 self.eshfg.setHeader(self._generateSHHeader())
1310 self.eshfg.setBody(self._generateSHBody())
1311 self.eshfg.generate()
1312
1313 def generateEnumValidate(self):
1314 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001315 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001316 self.evhfg.generate()
1317
1318 def _generateVHBody(self):
1319 body = []
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001320 for bet in sorted(self.et_dict):
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001321 fet = self.tf_dict[bet]
Tobin Ehlis2972ec72015-04-15 17:04:03 -06001322 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1323 # TODO : This is not ideal, but allows for flag combinations. Need more rigorous validation of realistic flag combinations
Tobin Ehlis3ed9f8f2015-04-22 13:59:43 -06001324 if 'flagbits' in bet.lower():
Tobin Ehlis2972ec72015-04-15 17:04:03 -06001325 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1326 body.append(' return 0;')
1327 body.append(' return 1;')
1328 body.append('}\n\n')
1329 else:
1330 body.append(' switch ((%s)input_value)\n {' % (fet))
1331 for e in sorted(self.et_dict[bet]):
1332 if (self.ev_dict[e]['unique']):
1333 body.append(' case %s:' % (e))
1334 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001335 return "\n".join(body)
1336
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001337 def _generateSHBody(self):
1338 body = []
1339# with open(self.out_file, "a") as hf:
1340 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001341 for bet in sorted(self.et_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001342 fet = self.tf_dict[bet]
Ian Elliotta742a622015-02-18 12:38:04 -07001343 body.append("static inline const char* string_%s(%s input_value)\n{\n switch ((%s)input_value)\n {" % (fet, fet, fet))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001344 for e in sorted(self.et_dict[bet]):
1345 if (self.ev_dict[e]['unique']):
Tobin Ehlis45bc7f82015-01-16 15:13:34 -07001346 body.append(' case %s:\n return "%s";' % (e, e))
1347 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001348 return "\n".join(body)
1349
1350 def _generateSHHeader(self):
Ian Elliott81ac44c2015-01-13 17:52:38 -07001351 header = []
1352 header.append('#pragma once\n')
Ian Elliottede4a2e2015-04-28 16:11:24 -06001353 header.append('#ifdef _WIN32\n')
1354 header.append('#pragma warning( disable : 4065 )\n')
1355 header.append('#endif\n')
Ian Elliotta742a622015-02-18 12:38:04 -07001356 header.append('#include <%s>\n\n\n' % self.in_file)
Ian Elliott81ac44c2015-01-13 17:52:38 -07001357 return "\n".join(header)
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001358
1359
1360class CMakeGen:
1361 def __init__(self, struct_wrapper=None, out_dir=None):
1362 self.sw = struct_wrapper
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001363 self.include_headers = []
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001364 self.add_lib_file_list = self.sw.get_file_list()
1365 self.out_dir = out_dir
1366 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1367 self.cmg = CommonFileGen(self.out_file)
1368
1369 def generate(self):
1370 self.cmg.setBody(self._generateBody())
1371 self.cmg.generate()
1372
1373 def _generateBody(self):
1374 body = []
1375 body.append("project(%s)" % os.path.basename(self.out_dir))
1376 body.append("cmake_minimum_required(VERSION 2.8)\n")
1377 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1378 body.append('set(COMPILE_FLAGS "-fpermissive")')
1379 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1380 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1381 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1382 return "\n".join(body)
1383
1384class GraphVizGen:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001385 def __init__(self, struct_dict, prefix, out_dir):
1386 self.struct_dict = struct_dict
1387 self.api = prefix
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001388 if prefix == "vulkan":
1389 self.api_prefix = "vk"
1390 else:
1391 self.api_prefix = prefix
1392 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001393 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001394
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001395 def generate(self):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001396 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001397 self.gvg.setHeader(self._generateHeader())
1398 self.gvg.setBody(self._generateBody())
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001399 #self.gvg.setFooter('}')
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001400 self.gvg.generate()
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001401
1402 def set_include_headers(self, include_headers):
1403 self.include_headers = include_headers
1404
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001405 def _generateHeader(self):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001406 header = []
1407 header.append("//#includes, #defines, globals and such...\n")
1408 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001409 if 'vk_enum_string_helper' not in f:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001410 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001411 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001412 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001413 return "".join(header)
1414
1415 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001416 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001417
1418 # Return elements to create formatted string for given struct member
1419 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=""):
1420 struct_op = "->"
1421 pre_var_name = '"%s "' % struct_member['full_type']
1422 if not struct_ptr:
1423 struct_op = "."
1424 member_name = struct_member['name']
1425 print_type = "p"
1426 cast_type = ""
1427 member_post = ""
1428 array_index = ""
1429 member_print_post = ""
Tobin Ehlisbf0146e2015-02-11 14:24:02 -07001430 print_delimiter = "%"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001431 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1432 print_type = "p"
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001433 print_array = False
1434 elif struct_member['array'] and not print_array:
1435 # Just print base address of array when not full print_array
1436 cast_type = "(void*)"
1437 elif is_type(struct_member['type'], 'enum'):
Jon Ashburna0ddc902015-01-09 09:11:44 -07001438 if struct_member['ptr']:
1439 struct_var_name = "*" + struct_var_name
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001440 cast_type = "string_%s" % struct_member['type']
1441 print_type = "s"
1442 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1443 cast_type = "(void*)"
1444 if not struct_member['ptr']:
1445 cast_type = "(void*)&"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001446 elif 'bool' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001447 print_type = "s"
1448 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001449 elif 'float' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001450 print_type = "f"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001451 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1452 print_type = '" PRId64 "'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001453 elif 'uint8' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001454 print_type = "hu"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001455 elif 'size' in struct_member['type'].lower():
Tobin Ehlisbf0146e2015-02-11 14:24:02 -07001456 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1457 print_delimiter = ""
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001458 elif True in [ui_str.lower() in struct_member['type'].lower() for ui_str in ['uint', 'flags', 'samplemask']]:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001459 print_type = "u"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001460 elif 'int' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001461 print_type = "i"
1462 elif struct_member['ptr']:
1463 pass
1464 else:
1465 #print("Unhandled struct type: %s" % struct_member['type'])
1466 cast_type = "(void*)"
1467 if print_array and struct_member['array']:
1468 member_print_post = "[%u]"
1469 array_index = " i,"
1470 member_post = "[i]"
Tobin Ehlisbf0146e2015-02-11 14:24:02 -07001471 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 Goeltzenleuchter382489d2015-04-10 08:34:15 -06001472 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 Ehlisa701ef02014-11-27 15:43:39 -07001473 return (print_out, print_arg)
1474
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001475 def _generateBody(self):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001476 gv_funcs = []
1477 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001478 array_func_list.append('vkbufferviewattachinfo')
1479 array_func_list.append('vkimageviewattachinfo')
1480 array_func_list.append('vksamplerimageviewinfo')
1481 array_func_list.append('vkdescriptortypecount')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001482 # For first pass, generate prototype
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001483 for s in sorted(self.struct_dict):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001484 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1485 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001486 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001487 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]))
1488 else:
1489 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 Ehlisa701ef02014-11-27 15:43:39 -07001490 gv_funcs.append('\n')
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001491 for s in sorted(self.struct_dict):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001492 p_out = ""
1493 p_args = ""
1494 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1495 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1496 pl_dict = {}
1497 struct_num = 0
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001498 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001499 for m in sorted(self.struct_dict[s]):
1500 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1501 stp_list.append(self.struct_dict[s][m])
1502 if 'pNext' == self.struct_dict[s][m]['name']:
1503 pl_dict[m] = ' PORT=\\"pNext\\"'
1504 else:
1505 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1506 struct_num += 1
1507 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]))
1508 num_stps = len(stp_list);
1509 total_strlen_str = ''
1510 if 0 != num_stps:
1511 gv_funcs.append(" char* tmpStr;\n")
1512 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001513 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1514 for index in range(num_stps):
1515 if (stp_list[index]['ptr']):
1516 if 'pDescriptorInfo' == stp_list[index]['name']:
1517 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1518 else:
1519 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1520 if 'pNext' == stp_list[index]['name']:
1521 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001522 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001523 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1524 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1525 gv_funcs.append(' free(tmpStr);\n')
1526 else:
1527 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -06001528 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001529 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 Ehlisa701ef02014-11-27 15:43:39 -07001530 else:
1531 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1532 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1533 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1534 gv_funcs.append(' }\n')
Chia-I Wu81f46672014-12-16 00:36:58 +08001535 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001536 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1537 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1538 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1539 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1540 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1541 else:
1542 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1543 gv_funcs.append(' tmpStr = %s(&pStruct->%s, 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 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1547 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1548 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1549 p_args = ", myNodeName, myNodeName, pStruct"
1550 for m in sorted(self.struct_dict[s]):
1551 plabel = ""
1552 if m in pl_dict:
1553 plabel = pl_dict[m]
1554 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1555 p_out += p_out1
1556 p_args += p_args1
1557 p_out += '</TABLE>>\\n];\\n\\n"'
1558 p_args += ");\n"
1559 gv_funcs.append(p_out)
1560 gv_funcs.append(p_args)
1561 if 0 != num_stps:
1562 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1563 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1564 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1565 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1566 gv_funcs.append(' }\n')
1567 gv_funcs.append(' }\n')
1568 gv_funcs.append(" return str;\n}\n")
1569 if s.lower().strip("_") in array_func_list:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001570 ptr_array = False
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001571 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001572 ptr_array = True
1573 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]))
1574 else:
1575 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 Ehlisa701ef02014-11-27 15:43:39 -07001576 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1577 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')
1578 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1579 gv_funcs.append(' sprintf(tmpStr, "');
1580 p_args = ""
1581 p_out = ""
1582 for m in sorted(self.struct_dict[s]):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001583 plabel = ""
1584 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001585 if 0 == m: # Add array index notation at end of first row
1586 p_out1 = '%s<TD ROWSPAN=\\"%i\\" PORT=\\"slot%%u\\">%%u</TD></TR>' % (p_out1[:-5], len(self.struct_dict[s]))
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001587 p_args1 += ', i, i'
1588 p_out += p_out1
1589 p_args += p_args1
1590 p_out += '"'
1591 p_args += ");\n"
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001592 if ptr_array:
1593 p_args = p_args.replace('->', '[i]->')
1594 else:
1595 p_args = p_args.replace('->', '[i].')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001596 gv_funcs.append(p_out);
1597 gv_funcs.append(p_args);
1598 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1599 gv_funcs.append(' }\n')
1600 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001601 gv_funcs.append(' return str;\n}\n')
1602 # Add function to dynamically print out unknown struct
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001603 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001604 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001605 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001606 gv_funcs.append(" switch (sType)\n {\n")
1607 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001608 if "StructureType" in e:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001609 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001610 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001611 print_func_name = self._get_gv_func_name(struct_name)
1612 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001613 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001614 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001615 if 'VkSemaphoreCreateInfo' in struct_name:
1616 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001617 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001618 elif 'VkSemaphoreOpenInfo' in struct_name:
1619 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001620 print_func_name = self._get_gv_func_name(struct_name)
1621 gv_funcs.append(' case %s:\n' % (v))
1622 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1623 #gv_funcs.append(' }\n')
1624 #gv_funcs.append(' break;\n')
Chia-I Wu84d7f5c2014-12-16 00:43:20 +08001625 gv_funcs.append(" default:\n")
1626 gv_funcs.append(" return NULL;\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001627 gv_funcs.append(" }\n")
1628 gv_funcs.append("}")
1629 return "".join(gv_funcs)
1630
1631
1632
1633
1634
1635# def _generateHeader(self):
1636# hdr = []
1637# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1638# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1639# hdr.append('edge [\n];\n')
1640# return "\n".join(hdr)
1641#
1642# def _generateBody(self):
1643# body = []
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001644# for s in sorted(self.struc_dict):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001645# field_num = 1
1646# 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]))
1647# for m in sorted(self.struc_dict[s]):
1648# 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']))
1649# field_num += 2
1650# body.append('</TABLE>>\n];\n')
1651# return "".join(body)
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001652
1653def main(argv=None):
1654 opts = handle_args()
1655 # Parse input file and fill out global dicts
1656 hfp = HeaderFileParser(opts.input_file)
1657 hfp.parse()
1658 # TODO : Don't want these to be global, see note at top about wrapper classes
1659 global enum_val_dict
1660 global enum_type_dict
1661 global struct_dict
1662 global typedef_fwd_dict
1663 global typedef_rev_dict
1664 global types_dict
1665 enum_val_dict = hfp.get_enum_val_dict()
1666 enum_type_dict = hfp.get_enum_type_dict()
1667 struct_dict = hfp.get_struct_dict()
Tobin Ehlis6f7029b2014-11-11 12:28:12 -07001668 # TODO : Would like to validate struct data here to verify that all of the bools for struct members are correct at this point
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001669 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1670 typedef_rev_dict = hfp.get_typedef_rev_dict()
1671 types_dict = hfp.get_types_dict()
1672 #print(enum_val_dict)
1673 #print(typedef_dict)
1674 #print(struct_dict)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001675 prefix = os.path.basename(opts.input_file).strip(".h")
1676 if prefix == "vulkan":
1677 prefix = "vk"
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001678 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001679 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001680 else:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001681 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001682 enum_sh_filename = os.path.abspath(enum_sh_filename)
1683 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1684 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1685 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001686 if opts.gen_enum_string_helper:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001687 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001688 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001689 print("Generating enum validate helper to %s" % enum_vh_filename)
1690 eg = EnumCodeGen(enum_type_dict, enum_val_dict, typedef_fwd_dict, os.path.basename(opts.input_file), enum_sh_filename, enum_vh_filename)
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001691 eg.generateStringHelper()
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001692 eg.generateEnumValidate()
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001693 #for struct in struct_dict:
1694 #print(struct)
1695 if opts.gen_struct_wrappers:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001696 sw = StructWrapperGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001697 #print(sw.get_class_name(struct))
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001698 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 Ehlisee33fa52014-10-22 15:13:53 -06001699 print("Generating struct wrapper header to %s" % sw.header_filename)
1700 sw.generateHeader()
1701 print("Generating struct wrapper class to %s" % sw.class_filename)
1702 sw.generateBody()
1703 sw.generateStringHelper()
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001704 sw.generateValidateHelper()
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -07001705 # Generate a 2nd helper file that excludes addrs
1706 sw.set_no_addr(True)
1707 sw.generateStringHelper()
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001708 sw.set_no_addr(False)
1709 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 Ehlis434db7c2015-01-10 12:42:41 -07001710 sw.set_no_addr(True)
1711 sw.generateStringHelperCpp()
Tobin Ehlis91cc24a2015-03-06 10:38:25 -07001712 sw.set_no_addr(False)
1713 sw.generateStringHelperCpp()
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001714 sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
Tobin Ehlisff765b02015-03-12 14:50:40 -06001715 sw.generateSizeHelper()
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001716 sw.generateSizeHelperC()
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001717 if opts.gen_cmake:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001718 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001719 cmg.generate()
1720 if opts.gen_graphviz:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001721 gv = GraphVizGen(struct_dict, os.path.basename(opts.input_file).strip(".h"), os.path.dirname(enum_sh_filename))
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001722 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 Ehlisee33fa52014-10-22 15:13:53 -06001723 gv.generate()
1724 print("DONE!")
1725 #print(typedef_rev_dict)
1726 #print(types_dict)
1727 #recreate_structs()
1728
1729if __name__ == "__main__":
1730 sys.exit(main())