blob: 14ccaeff37c8c3b2ae7c2d249657e7806c8d2279 [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 Ehlis5e848502014-12-05 12:13:07 -0700187 # account for negative values surrounded by parens
188 self.enum_val_dict[enum_name]['val'] = self.enum_val_dict[enum_name]['val'].strip(')').replace('-(', '-')
189 # Try to cast to int to determine if enum value is unique
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600190 try:
191 #print("ENUM val:", self.enum_val_dict[enum_name]['val'])
192 int(self.enum_val_dict[enum_name]['val'], 0)
193 self.enum_val_dict[enum_name]['unique'] = True
194 #print("ENUM has num value")
195 except ValueError:
196 self.enum_val_dict[enum_name]['unique'] = False
197 #print("ENUM is not a number value")
198 # Update enum_type_dict as well
199 if not enum_type in self.enum_type_dict:
200 self.enum_type_dict[enum_type] = []
201 self.enum_type_dict[enum_type].append(enum_name)
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700202
203 # Return True of struct member is a dynamic array
204 # RULES : This is a bit quirky based on the API
205 # NOTE : Changes in API spec may cause these rules to change
206 # 1. There must be a previous uint var w/ 'count' in the name in the struct
207 # 2. Dynam array must have 'const' and '*' qualifiers
208 # 3a. Name of dynam array must end in 's' char OR
209 # 3b. Name of count var minus 'count' must be contained in name of dynamic array
210 def _is_dynamic_array(self, full_type, name):
211 if '' != self.last_struct_count_name:
212 if 'const' in full_type and '*' in full_type:
213 if name.endswith('s') or self.last_struct_count_name.lower().replace('count', '') in name.lower():
214 return True
215 return False
216
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600217 # populate struct dicts based on struct lines
218 # TODO : Handle ":" bitfield, "**" ptr->ptr and "const type*const*"
219 def _add_struct(self, line_txt, struct_type, num):
220 #print("Parsing struct line %s" % line_txt)
221 if not struct_type in self.struct_dict:
222 self.struct_dict[struct_type] = {}
223 members = line_txt.strip().split(';', 1)[0] # first strip semicolon & comments
224 # TODO : Handle bitfields more correctly
225 members = members.strip().split(':', 1)[0] # strip bitfield element
226 (member_type, member_name) = members.rsplit(None, 1)
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700227 # Store counts to help recognize and size dynamic arrays
Tobin Ehlise653c2d2015-04-15 16:01:16 -0600228 if 'count' in member_name.lower() and 'samplecount' != member_name.lower() and 'uint' in member_type:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700229 self.last_struct_count_name = member_name
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600230 self.struct_dict[struct_type][num] = {}
231 self.struct_dict[struct_type][num]['full_type'] = member_type
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700232 self.struct_dict[struct_type][num]['dyn_array'] = False
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600233 if '*' in member_type:
234 self.struct_dict[struct_type][num]['ptr'] = True
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700235 # TODO : Need more general purpose way here to reduce down to basic type
236 member_type = member_type.replace(' const*', '')
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600237 member_type = member_type.strip('*')
238 else:
239 self.struct_dict[struct_type][num]['ptr'] = False
240 if 'const' in member_type:
241 self.struct_dict[struct_type][num]['const'] = True
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600242 member_type = member_type.replace('const', '').strip()
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600243 else:
244 self.struct_dict[struct_type][num]['const'] = False
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700245 # TODO : There is a bug here where it seems that at the time we do this check,
246 # 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 -0600247 if is_type(member_type, 'struct'):
248 self.struct_dict[struct_type][num]['struct'] = True
249 else:
250 self.struct_dict[struct_type][num]['struct'] = False
251 self.struct_dict[struct_type][num]['type'] = member_type
252 if '[' in member_name:
253 (member_name, array_size) = member_name.split('[', 1)
254 self.struct_dict[struct_type][num]['array'] = True
255 self.struct_dict[struct_type][num]['array_size'] = array_size.strip(']')
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700256 elif self._is_dynamic_array(self.struct_dict[struct_type][num]['full_type'], member_name):
257 #print("Found dynamic array %s of size %s" % (member_name, self.last_struct_count_name))
258 self.struct_dict[struct_type][num]['array'] = True
259 self.struct_dict[struct_type][num]['dyn_array'] = True
260 self.struct_dict[struct_type][num]['array_size'] = self.last_struct_count_name
Tobin Ehlisd1c0e662015-02-26 12:57:08 -0700261 elif not 'array' in self.struct_dict[struct_type][num]:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600262 self.struct_dict[struct_type][num]['array'] = False
263 self.struct_dict[struct_type][num]['array_size'] = 0
264 self.struct_dict[struct_type][num]['name'] = member_name
265
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700266# check if given identifier is of specified type_to_check
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600267def is_type(identifier, type_to_check):
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600268 if identifier in types_dict and type_to_check == types_dict[identifier]:
269 return True
270 if identifier in typedef_rev_dict:
271 new_id = typedef_rev_dict[identifier]
272 if new_id in types_dict and type_to_check == types_dict[new_id]:
273 return True
274 return False
275
276# This is a validation function to verify that we can reproduce the original structs
277def recreate_structs():
278 for struct_name in struct_dict:
279 sys.stdout.write("typedef struct %s\n{\n" % struct_name)
280 for mem_num in sorted(struct_dict[struct_name]):
281 sys.stdout.write(" ")
282 if struct_dict[struct_name][mem_num]['const']:
283 sys.stdout.write("const ")
284 #if struct_dict[struct_name][mem_num]['struct']:
285 # sys.stdout.write("struct ")
286 sys.stdout.write (struct_dict[struct_name][mem_num]['type'])
287 if struct_dict[struct_name][mem_num]['ptr']:
288 sys.stdout.write("*")
289 sys.stdout.write(" ")
290 sys.stdout.write(struct_dict[struct_name][mem_num]['name'])
291 if struct_dict[struct_name][mem_num]['array']:
292 sys.stdout.write("[")
293 sys.stdout.write(struct_dict[struct_name][mem_num]['array_size'])
294 sys.stdout.write("]")
295 sys.stdout.write(";\n")
296 sys.stdout.write("} ")
297 sys.stdout.write(typedef_fwd_dict[struct_name])
298 sys.stdout.write(";\n\n")
299
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600300#
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600301# TODO: Fix construction of struct name
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600302def get_struct_name_from_struct_type(struct_type):
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600303 # Note: All struct types are now camel-case
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600304 caps_struct_name = struct_type.replace("_STRUCTURE_TYPE", "")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600305 char_idx = 0
306 struct_name = ''
307 for char in caps_struct_name:
308 if (0 == char_idx) or (caps_struct_name[char_idx-1] == '_'):
309 struct_name += caps_struct_name[char_idx]
310 elif (caps_struct_name[char_idx] == '_'):
311 pass
312 else:
313 struct_name += caps_struct_name[char_idx].lower()
314 char_idx += 1
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600315 return struct_name
316
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600317# class for writing common file elements
318# Here's how this class lays out a file:
319# COPYRIGHT
320# HEADER
321# BODY
322# FOOTER
323#
324# For each of these sections, there's a "set*" function
325# The class as a whole has a generate function which will write each section in order
326class CommonFileGen:
327 def __init__(self, filename=None, copyright_txt="", header_txt="", body_txt="", footer_txt=""):
328 self.filename = filename
329 self.contents = {'copyright': copyright_txt, 'header': header_txt, 'body': body_txt, 'footer': footer_txt}
330 # TODO : Set a default copyright & footer at least
331
332 def setFilename(self, filename):
333 self.filename = filename
334
335 def setCopyright(self, c):
336 self.contents['copyright'] = c
337
338 def setHeader(self, h):
339 self.contents['header'] = h
340
341 def setBody(self, b):
342 self.contents['body'] = b
343
344 def setFooter(self, f):
345 self.contents['footer'] = f
346
347 def generate(self):
348 #print("Generate to file %s" % self.filename)
349 with open(self.filename, "w") as f:
350 f.write(self.contents['copyright'])
351 f.write(self.contents['header'])
352 f.write(self.contents['body'])
353 f.write(self.contents['footer'])
354
355# class for writing a wrapper class for structures
356# The wrapper class wraps the structs and includes utility functions for
357# setting/getting member values and displaying the struct data in various formats
358class StructWrapperGen:
359 def __init__(self, in_struct_dict, prefix, out_dir):
360 self.struct_dict = in_struct_dict
361 self.include_headers = []
362 self.api = prefix
Courtney Goeltzenleuchtercbf13812015-04-14 16:30:53 -0600363 if prefix.lower() == "vulkan":
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600364 self.api_prefix = "vk"
365 else:
366 self.api_prefix = prefix
367 self.header_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.h")
368 self.class_filename = os.path.join(out_dir, self.api_prefix+"_struct_wrappers.cpp")
369 self.string_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper.h")
370 self.string_helper_no_addr_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr.h")
371 self.string_helper_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_cpp.h")
372 self.string_helper_no_addr_cpp_filename = os.path.join(out_dir, self.api_prefix+"_struct_string_helper_no_addr_cpp.h")
373 self.validate_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_validate_helper.h")
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700374 self.no_addr = False
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600375 self.hfg = CommonFileGen(self.header_filename)
376 self.cfg = CommonFileGen(self.class_filename)
377 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700378 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700379 self.vhg = CommonFileGen(self.validate_helper_filename)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600380 self.size_helper_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.h")
381 self.size_helper_c_filename = os.path.join(out_dir, self.api_prefix+"_struct_size_helper.c")
Tobin Ehlisff765b02015-03-12 14:50:40 -0600382 self.size_helper_gen = CommonFileGen(self.size_helper_filename)
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700383 self.size_helper_c_gen = CommonFileGen(self.size_helper_c_filename)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600384 #print(self.header_filename)
385 self.header_txt = ""
386 self.definition_txt = ""
387
388 def set_include_headers(self, include_headers):
389 self.include_headers = include_headers
390
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700391 def set_no_addr(self, no_addr):
392 self.no_addr = no_addr
393 if self.no_addr:
394 self.shg = CommonFileGen(self.string_helper_no_addr_filename)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700395 self.shcppg = CommonFileGen(self.string_helper_no_addr_cpp_filename)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700396 else:
397 self.shg = CommonFileGen(self.string_helper_filename)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700398 self.shcppg = CommonFileGen(self.string_helper_cpp_filename)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700399
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600400 # Return class name for given struct name
401 def get_class_name(self, struct_name):
402 class_name = struct_name.strip('_').lower() + "_struct_wrapper"
403 return class_name
404
405 def get_file_list(self):
406 return [os.path.basename(self.header_filename), os.path.basename(self.class_filename), os.path.basename(self.string_helper_filename)]
407
408 # Generate class header file
409 def generateHeader(self):
410 self.hfg.setCopyright(self._generateCopyright())
411 self.hfg.setHeader(self._generateHeader())
412 self.hfg.setBody(self._generateClassDeclaration())
413 self.hfg.setFooter(self._generateFooter())
414 self.hfg.generate()
415
416 # Generate class definition
417 def generateBody(self):
418 self.cfg.setCopyright(self._generateCopyright())
419 self.cfg.setHeader(self._generateCppHeader())
420 self.cfg.setBody(self._generateClassDefinition())
421 self.cfg.setFooter(self._generateFooter())
422 self.cfg.generate()
423
424 # Generate c-style .h file that contains functions for printing structs
425 def generateStringHelper(self):
426 print("Generating struct string helper")
427 self.shg.setCopyright(self._generateCopyright())
428 self.shg.setHeader(self._generateStringHelperHeader())
429 self.shg.setBody(self._generateStringHelperFunctions())
430 self.shg.generate()
431
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700432 # Generate cpp-style .h file that contains functions for printing structs
433 def generateStringHelperCpp(self):
434 print("Generating struct string helper cpp")
435 self.shcppg.setCopyright(self._generateCopyright())
436 self.shcppg.setHeader(self._generateStringHelperHeaderCpp())
437 self.shcppg.setBody(self._generateStringHelperFunctionsCpp())
438 self.shcppg.generate()
439
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700440 # Generate c-style .h file that contains functions for printing structs
441 def generateValidateHelper(self):
442 print("Generating struct validate helper")
443 self.vhg.setCopyright(self._generateCopyright())
444 self.vhg.setHeader(self._generateValidateHelperHeader())
445 self.vhg.setBody(self._generateValidateHelperFunctions())
446 self.vhg.generate()
447
Tobin Ehlisff765b02015-03-12 14:50:40 -0600448 def generateSizeHelper(self):
449 print("Generating struct size helper")
450 self.size_helper_gen.setCopyright(self._generateCopyright())
451 self.size_helper_gen.setHeader(self._generateSizeHelperHeader())
452 self.size_helper_gen.setBody(self._generateSizeHelperFunctions())
453 self.size_helper_gen.generate()
454
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700455 def generateSizeHelperC(self):
456 print("Generating struct size helper c")
457 self.size_helper_c_gen.setCopyright(self._generateCopyright())
458 self.size_helper_c_gen.setHeader(self._generateSizeHelperHeaderC())
459 self.size_helper_c_gen.setBody(self._generateSizeHelperFunctionsC())
460 self.size_helper_c_gen.generate()
461
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600462 def _generateCopyright(self):
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700463 copyright = []
464 copyright.append('/* THIS FILE IS GENERATED. DO NOT EDIT. */');
465 copyright.append('');
466 copyright.append('/*');
Ian Elliotte3b10452015-04-15 11:15:13 -0600467 copyright.append(' * Vulkan');
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -0700468 copyright.append(' *');
469 copyright.append(' * Copyright (C) 2014 LunarG, Inc.');
470 copyright.append(' *');
471 copyright.append(' * Permission is hereby granted, free of charge, to any person obtaining a');
472 copyright.append(' * copy of this software and associated documentation files (the "Software"),');
473 copyright.append(' * to deal in the Software without restriction, including without limitation');
474 copyright.append(' * the rights to use, copy, modify, merge, publish, distribute, sublicense,');
475 copyright.append(' * and/or sell copies of the Software, and to permit persons to whom the');
476 copyright.append(' * Software is furnished to do so, subject to the following conditions:');
477 copyright.append(' *');
478 copyright.append(' * The above copyright notice and this permission notice shall be included');
479 copyright.append(' * in all copies or substantial portions of the Software.');
480 copyright.append(' *');
481 copyright.append(' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR');
482 copyright.append(' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,');
483 copyright.append(' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL');
484 copyright.append(' * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER');
485 copyright.append(' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING');
486 copyright.append(' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER');
487 copyright.append(' * DEALINGS IN THE SOFTWARE.');
488 copyright.append(' */');
489 copyright.append('');
490 return "\n".join(copyright)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600491
492 def _generateCppHeader(self):
493 header = []
494 header.append("//#includes, #defines, globals and such...\n")
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600495 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 -0600496 return "".join(header)
497
498 def _generateClassDefinition(self):
499 class_def = []
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600500 if 'vk' == self.api: # Mantle doesn't have pNext to worry about
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600501 class_def.append(self._generateDynamicPrintFunctions())
Peter Lohrmannc55cfa12015-03-30 16:29:56 -0700502 for s in sorted(self.struct_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600503 class_def.append("\n// %s class definition" % self.get_class_name(s))
504 class_def.append(self._generateConstructorDefinitions(s))
505 class_def.append(self._generateDestructorDefinitions(s))
506 class_def.append(self._generateDisplayDefinitions(s))
507 return "\n".join(class_def)
508
509 def _generateConstructorDefinitions(self, s):
510 con_defs = []
511 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)))
512 # TODO : This is a shallow copy of ptrs
513 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]))
514 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]))
515 return "\n".join(con_defs)
516
517 def _generateDestructorDefinitions(self, s):
518 return "%s::~%s() {}" % (self.get_class_name(s), self.get_class_name(s))
519
520 def _generateDynamicPrintFunctions(self):
521 dp_funcs = []
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600522 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 -0600523 dp_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600524 dp_funcs.append(" switch (sType)\n {")
525 for e in enum_type_dict:
526 class_num = 0
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600527 if "StructureType" in e:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600528 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600529 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600530 class_name = self.get_class_name(struct_name)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600531 instance_name = "swc%i" % class_num
532 dp_funcs.append(" case %s:\n {" % (v))
533 dp_funcs.append(" %s %s((%s*)pStruct);" % (class_name, instance_name, struct_name))
534 dp_funcs.append(" %s.set_indent(indent);" % (instance_name))
535 dp_funcs.append(" %s.display_full_txt();" % (instance_name))
536 dp_funcs.append(" }")
537 dp_funcs.append(" break;")
538 class_num += 1
539 dp_funcs.append(" }")
540 dp_funcs.append("}\n")
541 return "\n".join(dp_funcs)
542
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700543 def _get_func_name(self, struct, mid_str):
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -0600544 return "%s_%s_%s" % (self.api_prefix, mid_str, struct.lower().strip("_"))
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700545
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600546 def _get_sh_func_name(self, struct):
Tobin Ehlis6cd06372014-12-17 17:44:50 -0700547 return self._get_func_name(struct, 'print')
548
549 def _get_vh_func_name(self, struct):
550 return self._get_func_name(struct, 'validate')
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600551
Tobin Ehlisff765b02015-03-12 14:50:40 -0600552 def _get_size_helper_func_name(self, struct):
553 return self._get_func_name(struct, 'size')
554
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600555 # Return elements to create formatted string for given struct member
556 def _get_struct_print_formatted(self, struct_member, pre_var_name="prefix", postfix = "\\n", struct_var_name="pStruct", struct_ptr=True, print_array=False):
557 struct_op = "->"
558 if not struct_ptr:
559 struct_op = "."
560 member_name = struct_member['name']
561 print_type = "p"
562 cast_type = ""
563 member_post = ""
564 array_index = ""
565 member_print_post = ""
Tobin Ehlisbf0146e2015-02-11 14:24:02 -0700566 print_delimiter = "%"
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700567 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
568 if member_name.startswith('pp'): # TODO : Only printing first element of dynam array of char* for now
569 member_post = "[0]"
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600570 print_type = "s"
571 print_array = False
572 elif struct_member['array'] and not print_array:
573 # Just print base address of array when not full print_array
574 cast_type = "(void*)"
575 elif is_type(struct_member['type'], 'enum'):
576 cast_type = "string_%s" % struct_member['type']
Jon Ashburna0ddc902015-01-09 09:11:44 -0700577 if struct_member['ptr']:
578 struct_var_name = "*" + struct_var_name
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600579 print_type = "s"
580 elif is_type(struct_member['type'], 'struct'): # print struct address for now
581 cast_type = "(void*)"
582 if not struct_member['ptr']:
583 cast_type = "(void*)&"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700584 elif 'bool' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600585 print_type = "s"
586 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700587 elif 'float' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600588 print_type = "f"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600589 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
590 print_type = '" PRId64 "'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700591 elif 'uint8' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600592 print_type = "hu"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600593 elif 'size' in struct_member['type'].lower():
Tobin Ehlisbf0146e2015-02-11 14:24:02 -0700594 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
595 print_delimiter = ""
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600596 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 -0600597 print_type = "u"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700598 elif 'int' in struct_member['type']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600599 print_type = "i"
600 elif struct_member['ptr']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600601 pass
602 else:
603 #print("Unhandled struct type: %s" % struct_member['type'])
604 cast_type = "(void*)"
605 if print_array and struct_member['array']:
606 member_print_post = "[%u]"
607 array_index = " i,"
608 member_post = "[i]"
Tobin Ehlisbf0146e2015-02-11 14:24:02 -0700609 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 -0600610 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 -0700611 if self.no_addr and "p" == print_type:
612 print_out = "%%s%s%s = addr\\n" % (member_name, member_print_post) # section of print that goes inside of quotes
613 print_arg = ", %s" % (pre_var_name)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600614 return (print_out, print_arg)
615
616 def _generateStringHelperFunctions(self):
617 sh_funcs = []
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700618 # We do two passes, first pass just generates prototypes for all the functsions
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700619 for s in sorted(self.struct_dict):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700620 sh_funcs.append('char* %s(const %s* pStruct, const char* prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
621 sh_funcs.append('')
622 sh_funcs.append('#if defined(_WIN32)')
623 sh_funcs.append('// Microsoft did not implement C99 in Visual Studio; but started adding it with')
624 sh_funcs.append('// VS2013. However, VS2013 still did not have snprintf(). The following is a')
625 sh_funcs.append('// work-around.')
626 sh_funcs.append('#define snprintf _snprintf')
627 sh_funcs.append('#endif // _WIN32\n')
Peter Lohrmannc55cfa12015-03-30 16:29:56 -0700628 for s in sorted(self.struct_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600629 p_out = ""
630 p_args = ""
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700631 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 -0700632 # This pre-pass flags embedded structs and pNext
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700633 for m in sorted(self.struct_dict[s]):
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700634 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
635 stp_list.append(self.struct_dict[s][m])
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700636 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]))
637 sh_funcs.append(" size_t len;")
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700638 num_stps = len(stp_list);
639 total_strlen_str = ''
640 if 0 != num_stps:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700641 sh_funcs.append(" char* tmpStr;")
642 sh_funcs.append(' char* extra_indent = (char*)malloc(strlen(prefix) + 3);')
643 sh_funcs.append(' strcpy(extra_indent, " ");')
644 sh_funcs.append(' strncat(extra_indent, prefix, strlen(prefix));')
645 sh_funcs.append(' char* stp_strs[%i];' % num_stps)
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700646 for index in range(num_stps):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700647 # If it's an array, print all of the elements
648 # If it's a ptr, print thing it's pointing to
649 # Non-ptr struct case. Print the struct using its address
650 struct_deref = '&'
651 if 1 < stp_list[index]['full_type'].count('*'):
652 struct_deref = ''
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700653 if (stp_list[index]['ptr']):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700654 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700655 if 'pNext' == stp_list[index]['name']:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700656 sh_funcs.append(' tmpStr = dynamic_display((void*)pStruct->pNext, prefix);')
657 sh_funcs.append(' len = 256+strlen(tmpStr);')
658 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % index)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700659 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700660 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (addr)\\n%%s", prefix, tmpStr);' % index)
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700661 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700662 sh_funcs.append(' snprintf(stp_strs[%i], len, " %%spNext (%%p)\\n%%s", prefix, (void*)pStruct->pNext, tmpStr);' % index)
663 sh_funcs.append(' free(tmpStr);')
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700664 else:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -0700665 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
666 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchter24591b62015-04-02 22:54:15 -0600667 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 -0700668 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700669 sh_funcs.append(' tmpStr = %s(pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
670 sh_funcs.append(' len = 256+strlen(tmpStr)+strlen(prefix);')
671 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700672 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700673 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 -0700674 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700675 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']))
676 sh_funcs.append(' }')
677 sh_funcs.append(" else\n stp_strs[%i] = \"\";" % (index))
678 elif stp_list[index]['array']:
679 sh_funcs.append(' tmpStr = %s(&pStruct->%s[0], extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
680 sh_funcs.append(' len = 256+strlen(tmpStr);')
681 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700682 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700683 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 -0700684 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700685 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 -0700686 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700687 sh_funcs.append(' tmpStr = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
688 sh_funcs.append(' len = 256+strlen(tmpStr);')
689 sh_funcs.append(' stp_strs[%i] = (char*)malloc(len);' % (index))
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -0700690 if self.no_addr:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700691 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 -0700692 else:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700693 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 -0700694 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700695 sh_funcs.append(' len = %ssizeof(char)*1024;' % (total_strlen_str))
696 sh_funcs.append(' str = (char*)malloc(len);')
Courtney Goeltzenleuchtercde421c2014-12-01 09:31:17 -0700697 sh_funcs.append(' snprintf(str, len, "')
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600698 for m in sorted(self.struct_dict[s]):
699 (p_out1, p_args1) = self._get_struct_print_formatted(self.struct_dict[s][m])
700 p_out += p_out1
701 p_args += p_args1
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600702 p_out += '"'
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700703 p_args += ");"
704 sh_funcs[-1] = '%s%s%s' % (sh_funcs[-1], p_out, p_args)
Tobin Ehlis6f7029b2014-11-11 12:28:12 -0700705 if 0 != num_stps:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700706 sh_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {' % (num_stps-1))
707 sh_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {')
708 sh_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));')
709 sh_funcs.append(' free(stp_strs[stp_index]);')
710 sh_funcs.append(' }')
711 sh_funcs.append(' }')
712 sh_funcs.append(' free(extra_indent);')
713 sh_funcs.append(" return str;\n}")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600714 # Add function to dynamically print out unknown struct
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700715 sh_funcs.append("char* dynamic_display(const void* pStruct, const char* prefix)\n{")
716 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
717 sh_funcs.append(" if (pStruct == NULL) {")
718 sh_funcs.append(" return NULL;")
719 sh_funcs.append(" }")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600720 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700721 sh_funcs.append(' char indent[100];\n strcpy(indent, " ");\n strcat(indent, prefix);')
722 sh_funcs.append(" switch (sType)\n {")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600723 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600724 if "StructureType" in e:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600725 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600726 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600727 print_func_name = self._get_sh_func_name(struct_name)
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700728 sh_funcs.append(' case %s:\n {' % (v))
729 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
730 sh_funcs.append(' }')
731 sh_funcs.append(' break;')
732 sh_funcs.append(" default:")
733 sh_funcs.append(" return NULL;")
734 sh_funcs.append(" }")
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600735 sh_funcs.append("}")
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700736 return "\n".join(sh_funcs)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700737
738 def _generateStringHelperFunctionsCpp(self):
739 # declare str & tmp str
740 # declare array of stringstreams for every struct ptr in current struct
741 # declare array of stringstreams for every non-string element in current struct
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700742 # For every struct ptr, if non-Null, then set its string, else set to NULL str
743 # For every non-string element, set its string stream
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700744 # create and return final string
745 sh_funcs = []
746 # First generate prototypes for every struct
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600747 # XXX - REMOVE this comment
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700748 for s in sorted(self.struct_dict):
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700749 sh_funcs.append('string %s(const %s* pStruct, const string prefix);' % (self._get_sh_func_name(s), typedef_fwd_dict[s]))
750 sh_funcs.append('\n')
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700751 for s in sorted(self.struct_dict):
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700752 num_non_enum_elems = [is_type(self.struct_dict[s][elem]['type'], 'enum') for elem in self.struct_dict[s]].count(False)
753 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 -0700754 # This pre-pass flags embedded structs and pNext
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700755 for m in sorted(self.struct_dict[s]):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700756 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 -0700757 stp_list.append(self.struct_dict[s][m])
758 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 -0700759 indent = ' '
Tobin Ehlis4a636a12015-04-09 09:19:36 -0600760 sh_funcs.append('%susing namespace StreamControl;' % (indent))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700761 sh_funcs.append('%sstring final_str;' % (indent))
762 sh_funcs.append('%sstring tmp_str;' % (indent))
763 sh_funcs.append('%sstring extra_indent = " " + prefix;' % (indent))
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700764 if (0 != num_non_enum_elems):
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700765 sh_funcs.append('%sstringstream ss[%u];' % (indent, num_non_enum_elems))
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700766 num_stps = len(stp_list)
767 # First generate code for any embedded structs
768 if 0 < num_stps:
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700769 sh_funcs.append('%sstring stp_strs[%u];' % (indent, num_stps))
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700770 idx_ss_decl = False # Make sure to only decl this once
771 for index in range(num_stps):
772 addr_char = '&'
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700773 if 1 < stp_list[index]['full_type'].count('*'):
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700774 addr_char = ''
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700775 if (stp_list[index]['array']):
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600776 #sh_funcs.append('/* A */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700777 if stp_list[index]['dyn_array']:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600778 #sh_funcs.append('/* AA */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700779 array_count = 'pStruct->%s' % (stp_list[index]['array_size'])
780 else:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600781 #sh_funcs.append('/* AB */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700782 array_count = '%s' % (stp_list[index]['array_size'])
783 sh_funcs.append('%sstp_strs[%u] = "";' % (indent, index))
784 if not idx_ss_decl:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600785 #sh_funcs.append('/* AC */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700786 sh_funcs.append('%sstringstream index_ss;' % (indent))
787 idx_ss_decl = True
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600788 sh_funcs.append('%sif (pStruct->%s) {' % (indent, stp_list[index]['name']))
789 indent += ' '
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700790 sh_funcs.append('%sfor (uint32_t i = 0; i < %s; i++) {' % (indent, array_count))
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600791 indent += ' '
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700792 sh_funcs.append('%sindex_ss.str("");' % (indent))
793 sh_funcs.append('%sindex_ss << i;' % (indent))
794 if not is_type(stp_list[index]['type'], 'struct'):
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600795 #sh_funcs.append('/* AD */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700796 addr_char = ''
797 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
798 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] = " + ss[%u].str() + "\\n";' % (indent, index, stp_list[index]['name'], index))
799 else:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600800 #sh_funcs.append('/* AD */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700801 sh_funcs.append('%sss[%u] << %spStruct->%s[i];' % (indent, index, addr_char, stp_list[index]['name']))
802 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']))
803 if self.no_addr:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600804 #sh_funcs.append('/* ADA */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700805 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (addr)\\n" + tmp_str;' % (indent, index, stp_list[index]['name']))
806 else:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600807 #sh_funcs.append('/* ADB */');
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700808 sh_funcs.append('%sstp_strs[%u] += " " + prefix + "%s[" + index_ss.str() + "] (" + ss[%u].str() + ")\\n" + tmp_str;' % (indent, index, stp_list[index]['name'], index))
809 sh_funcs.append('%sss[%u].str("");' % (indent, index))
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600810 indent = indent[4:]
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700811 sh_funcs.append('%s}' % (indent))
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600812 indent = indent[4:]
813 sh_funcs.append('%s}' % (indent))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700814 elif (stp_list[index]['ptr']):
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600815 #sh_funcs.append('/* B */');
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700816 sh_funcs.append(' if (pStruct->%s) {' % stp_list[index]['name'])
817 if 'pNext' == stp_list[index]['name']:
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600818 sh_funcs.append(' tmp_str = dynamic_display((void*)pStruct->pNext, prefix);')
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700819 else:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -0700820 if stp_list[index]['name'] in ['pImageViews', 'pBufferViews']:
821 # TODO : This is a quick hack to handle these arrays of ptrs
Courtney Goeltzenleuchter24591b62015-04-02 22:54:15 -0600822 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 -0700823 else:
824 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 -0700825 sh_funcs.append(' ss[%u] << %spStruct->%s;' % (index, addr_char, stp_list[index]['name']))
826 if self.no_addr:
827 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (addr)\\n" + tmp_str;' % (index, stp_list[index]['name']))
828 else:
829 sh_funcs.append(' stp_strs[%u] = " " + prefix + "%s (" + ss[%u].str() + ")\\n" + tmp_str;' % (index, stp_list[index]['name'], index))
830 sh_funcs.append(' ss[%u].str("");' % (index))
831 sh_funcs.append(' }')
832 sh_funcs.append(' else')
833 sh_funcs.append(' stp_strs[%u] = "";' % index)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700834 else:
Tobin Ehlisa74d53a2015-04-17 13:26:33 -0600835 #sh_funcs.append('/* C */');
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700836 sh_funcs.append(' tmp_str = %s(&pStruct->%s, extra_indent);' % (self._get_sh_func_name(stp_list[index]['type']), stp_list[index]['name']))
837 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 # Now print non-enum data members
844 index = 0
845 final_str = ''
846 for m in sorted(self.struct_dict[s]):
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700847 deref = ''
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700848 if not is_type(self.struct_dict[s][m]['type'], 'enum'):
849 if is_type(self.struct_dict[s][m]['type'], 'struct') and not self.struct_dict[s][m]['ptr']:
850 if self.no_addr:
851 sh_funcs.append(' ss[%u].str("addr");' % (index))
852 else:
853 sh_funcs.append(' ss[%u] << &pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700854 elif 'bool' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700855 sh_funcs.append(' ss[%u].str(pStruct->%s ? "TRUE" : "FALSE");' % (index, self.struct_dict[s][m]['name']))
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700856 elif 'uint8' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700857 sh_funcs.append(' ss[%u] << (uint32_t)pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
858 else:
859 (po, pa) = self._get_struct_print_formatted(self.struct_dict[s][m])
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700860 if "addr" in po: # or self.struct_dict[s][m]['ptr']:
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700861 sh_funcs.append(' ss[%u].str("addr");' % (index))
862 else:
863 sh_funcs.append(' ss[%u] << pStruct->%s;' % (index, self.struct_dict[s][m]['name']))
864 value_print = 'ss[%u].str()' % index
865 index += 1
866 else:
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700867 if self.struct_dict[s][m]['ptr']:
868 deref = '*'
869 value_print = 'string_%s(%spStruct->%s)' % (self.struct_dict[s][m]['type'], deref, self.struct_dict[s][m]['name'])
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700870 final_str += ' + prefix + "%s = " + %s + "\\n"' % (self.struct_dict[s][m]['name'], value_print)
871 final_str = final_str[3:] # strip off the initial ' + '
Tobin Ehlis91cc24a2015-03-06 10:38:25 -0700872 if 0 != num_stps: # Append data for any embedded structs
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700873 final_str += " + %s" % " + ".join(['stp_strs[%u]' % n for n in reversed(range(num_stps))])
874 sh_funcs.append(' final_str = %s;' % final_str)
875 sh_funcs.append(' return final_str;\n}')
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700876 # Add function to return a string value for input void*
877 sh_funcs.append("string string_convert_helper(const void* toString, const string prefix)\n{")
Tobin Ehlis4a636a12015-04-09 09:19:36 -0600878 sh_funcs.append(" using namespace StreamControl;")
Tobin Ehlisd204b1a2015-01-20 09:48:48 -0700879 sh_funcs.append(" stringstream ss;")
880 sh_funcs.append(' ss << toString;')
881 sh_funcs.append(' string final_str = prefix + ss.str();')
882 sh_funcs.append(" return final_str;")
883 sh_funcs.append("}")
Tobin Ehlisc99cb0d2015-04-16 15:56:11 -0600884 # Add function to return a string value for input uint32_t
885 sh_funcs.append("string string_convert_helper(const uint32_t toString, const string prefix)\n{")
886 sh_funcs.append(" using namespace StreamControl;")
887 sh_funcs.append(" stringstream ss;")
888 sh_funcs.append(' ss << toString;')
889 sh_funcs.append(' string final_str = prefix + ss.str();')
890 sh_funcs.append(" return final_str;")
891 sh_funcs.append("}")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700892 # Add function to dynamically print out unknown struct
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600893 sh_funcs.append("string dynamic_display(const void* pStruct, const string prefix)\n{")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700894 sh_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct")
Ian Elliotta5a0a172015-02-25 17:40:38 -0700895 sh_funcs.append(" if (pStruct == NULL) {\n")
Jon Ashburn49398b32015-02-25 12:45:23 -0700896 sh_funcs.append(" return NULL;")
Ian Elliotta5a0a172015-02-25 17:40:38 -0700897 sh_funcs.append(" }\n")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600898 sh_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700899 sh_funcs.append(' string indent = " ";')
900 sh_funcs.append(' indent += prefix;')
901 sh_funcs.append(" switch (sType)\n {")
902 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600903 if "StructureType" in e:
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700904 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600905 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700906 print_func_name = self._get_sh_func_name(struct_name)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600907 #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 -0700908 sh_funcs.append(' case %s:\n {' % (v))
909 sh_funcs.append(' return %s((%s*)pStruct, indent);' % (print_func_name, struct_name))
910 sh_funcs.append(' }')
911 sh_funcs.append(' break;')
912 sh_funcs.append(" default:")
913 sh_funcs.append(" return NULL;")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600914 sh_funcs.append(" }")
Tobin Ehlis434db7c2015-01-10 12:42:41 -0700915 sh_funcs.append("}")
916 return "\n".join(sh_funcs)
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600917
918 def _genStructMemberPrint(self, member, s, array, struct_array):
919 (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)
920 extra_indent = ""
921 if array:
922 extra_indent = " "
923 if is_type(self.struct_dict[s][member]['type'], 'struct'): # print struct address for now
924 struct_array.insert(0, self.struct_dict[s][member])
925 elif self.struct_dict[s][member]['ptr']:
Tobin Ehlis2f3726c2015-01-15 17:51:52 -0700926 # Special case for void* named "pNext"
927 if "void" in self.struct_dict[s][member]['type'] and "pNext" == self.struct_dict[s][member]['name']:
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600928 struct_array.insert(0, self.struct_dict[s][member])
929 return (' %sprintf("%%*s %s", m_indent, ""%s);' % (extra_indent, p_out, p_arg), struct_array)
930
931 def _generateDisplayDefinitions(self, s):
932 disp_def = []
933 struct_array = []
934 # Single-line struct print function
935 disp_def.append("// Output 'structname = struct_address' on a single line")
936 disp_def.append("void %s::display_single_txt()\n{" % self.get_class_name(s))
937 disp_def.append(' printf(" %%*s%s = %%p", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
938 disp_def.append("}\n")
939 # Private helper function to print struct members
940 disp_def.append("// Private helper function that displays the members of the wrapped struct")
941 disp_def.append("void %s::display_struct_members()\n{" % self.get_class_name(s))
942 i_declared = False
943 for member in sorted(self.struct_dict[s]):
944 # TODO : Need to display each member based on its type
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600945 # TODO : Need to handle pNext which are structs, but of void* type
Tobin Ehlisee33fa52014-10-22 15:13:53 -0600946 # Can grab struct type off of header of struct pointed to
947 # TODO : Handle Arrays
948 if self.struct_dict[s][member]['array']:
949 # Create for loop to print each element of array
950 if not i_declared:
951 disp_def.append(' uint32_t i;')
952 i_declared = True
953 disp_def.append(' for (i = 0; i<%s; i++) {' % self.struct_dict[s][member]['array_size'])
954 (return_str, struct_array) = self._genStructMemberPrint(member, s, True, struct_array)
955 disp_def.append(return_str)
956 disp_def.append(' }')
957 else:
958 (return_str, struct_array) = self._genStructMemberPrint(member, s, False, struct_array)
959 disp_def.append(return_str)
960 disp_def.append("}\n")
961 i_declared = False
962 # Basic print function to display struct members
963 disp_def.append("// Output all struct elements, each on their own line")
964 disp_def.append("void %s::display_txt()\n{" % self.get_class_name(s))
965 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
966 disp_def.append(' this->display_struct_members();')
967 disp_def.append("}\n")
968 # Advanced print function to display current struct and contents of any pointed-to structs
969 disp_def.append("// Output all struct elements, and for any structs pointed to, print complete contents")
970 disp_def.append("void %s::display_full_txt()\n{" % self.get_class_name(s))
971 disp_def.append(' printf("%%*s%s struct contents at %%p:\\n", m_indent, "", (void*)m_origStructAddr);' % typedef_fwd_dict[s])
972 disp_def.append(' this->display_struct_members();')
973 class_num = 0
974 # TODO : Need to handle arrays of structs here
975 for ms in struct_array:
976 swc_name = "class%s" % str(class_num)
977 if ms['array']:
978 if not i_declared:
979 disp_def.append(' uint32_t i;')
980 i_declared = True
981 disp_def.append(' for (i = 0; i<%s; i++) {' % ms['array_size'])
982 #disp_def.append(" if (m_struct.%s[i]) {" % (ms['name']))
983 disp_def.append(" %s %s(&(m_struct.%s[i]));" % (self.get_class_name(ms['type']), swc_name, ms['name']))
984 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
985 disp_def.append(" %s.display_full_txt();" % (swc_name))
986 #disp_def.append(' }')
987 disp_def.append(' }')
988 elif 'pNext' == ms['name']:
989 # Need some code trickery here
990 # I'm thinking have a generated function that takes pNext ptr value
991 # then it checks sType and in large switch statement creates appropriate
992 # wrapper class type and then prints contents
993 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
994 #disp_def.append(' printf("%*s This is where we would call dynamic print function\\n", m_indent, "");')
995 disp_def.append(' dynamic_display_full_txt(m_struct.%s, m_indent);' % (ms['name']))
996 disp_def.append(" }")
997 else:
998 if ms['ptr']:
999 disp_def.append(" if (m_struct.%s) {" % (ms['name']))
1000 disp_def.append(" %s %s(m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1001 else:
1002 disp_def.append(" if (&m_struct.%s) {" % (ms['name']))
1003 disp_def.append(" %s %s(&m_struct.%s);" % (self.get_class_name(ms['type']), swc_name, ms['name']))
1004 disp_def.append(" %s.set_indent(m_indent + 4);" % (swc_name))
1005 disp_def.append(" %s.display_full_txt();\n }" % (swc_name))
1006 class_num += 1
1007 disp_def.append("}\n")
1008 return "\n".join(disp_def)
1009
1010 def _generateStringHelperHeader(self):
1011 header = []
1012 header.append("//#includes, #defines, globals and such...\n")
1013 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001014 if 'vk_enum_string_helper' not in f:
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001015 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001016 header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001017 header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001018 return "".join(header)
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001019
1020 def _generateStringHelperHeaderCpp(self):
1021 header = []
1022 header.append("//#includes, #defines, globals and such...\n")
1023 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001024 if 'vk_enum_string_helper' not in f:
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001025 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001026 header.append('#include "vk_enum_string_helper.h"\n')
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001027 header.append('using namespace std;\n\n// Function Prototypes\n')
Tobin Ehlis4a636a12015-04-09 09:19:36 -06001028 header.append('\n')
1029 header.append('namespace StreamControl\n')
1030 header.append('{\n')
1031 header.append('bool writeAddress = true;\n')
1032 header.append('template <typename T>\n')
1033 header.append('std::ostream& operator<< (std::ostream &out, T const* pointer)\n')
1034 header.append('{\n')
1035 header.append(' if(writeAddress)\n')
1036 header.append(' {\n')
1037 header.append(' out.operator<<(pointer);\n')
1038 header.append(' }\n')
1039 header.append(' else\n')
1040 header.append(' {\n')
1041 header.append(' std::operator<<(out, "address");\n')
1042 header.append(' }\n')
1043 header.append(' return out;\n')
1044 header.append('}\n')
1045 header.append('std::ostream& operator<<(std::ostream &out, char const*const s)\n')
1046 header.append('{\n')
1047 header.append(' return std::operator<<(out, s);\n')
1048 header.append('}\n')
1049 header.append('}\n')
1050 header.append('\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001051 header.append("string dynamic_display(const void* pStruct, const string prefix);\n")
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001052 return "".join(header)
1053
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001054 def _generateValidateHelperFunctions(self):
1055 sh_funcs = []
1056 # We do two passes, first pass just generates prototypes for all the functsions
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001057 for s in sorted(self.struct_dict):
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001058 sh_funcs.append('uint32_t %s(const %s* pStruct);' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1059 sh_funcs.append('\n')
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001060 for s in sorted(self.struct_dict):
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001061 sh_funcs.append('uint32_t %s(const %s* pStruct)\n{' % (self._get_vh_func_name(s), typedef_fwd_dict[s]))
1062 for m in sorted(self.struct_dict[s]):
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001063 # TODO : Need to handle arrays of enums like in VkRenderPassCreateInfo struct
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001064 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 -07001065 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 -07001066 # 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 -07001067 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1068 if (self.struct_dict[s][m]['ptr']):
Tobin Ehlis516aa842015-02-24 15:39:04 -07001069 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 -07001070 else:
1071 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 -07001072 sh_funcs.append(" return 1;\n}")
1073
1074 return "\n".join(sh_funcs)
1075
1076 def _generateValidateHelperHeader(self):
1077 header = []
1078 header.append("//#includes, #defines, globals and such...\n")
1079 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001080 if 'vk_enum_validate_helper' not in f:
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001081 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001082 header.append('#include "vk_enum_validate_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001083 #header.append("char* dynamic_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001084 return "".join(header)
1085
Tobin Ehlisff765b02015-03-12 14:50:40 -06001086 def _generateSizeHelperFunctions(self):
1087 sh_funcs = []
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001088 # just generates prototypes for all the functions
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001089 for s in sorted(self.struct_dict):
Tobin Ehlisff765b02015-03-12 14:50:40 -06001090 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 -07001091 return "\n".join(sh_funcs)
1092
1093
1094 def _generateSizeHelperFunctionsC(self):
1095 sh_funcs = []
1096 # generate function definitions
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001097 for s in sorted(self.struct_dict):
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001098 skip_list = [] # Used when struct elements need to be skipped b/c size already accounted for
Tobin Ehlisff765b02015-03-12 14:50:40 -06001099 sh_funcs.append('size_t %s(const %s* pStruct)\n{' % (self._get_size_helper_func_name(s), typedef_fwd_dict[s]))
1100 indent = ' '
1101 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1102 sh_funcs.append('%sif (pStruct) {' % (indent))
1103 indent = ' '
1104 sh_funcs.append('%sstructSize = sizeof(%s);' % (indent, typedef_fwd_dict[s]))
1105 i_decl = False
1106 for m in sorted(self.struct_dict[s]):
1107 if m in skip_list:
1108 continue
1109 if self.struct_dict[s][m]['dyn_array']:
1110 if self.struct_dict[s][m]['full_type'].count('*') > 1:
1111 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 -06001112 if 'ppMemBarriers' == self.struct_dict[s][m]['name']:
1113 # TODO : For now be conservative and consider all memBarrier ptrs as largest possible struct
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001114 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 -06001115 else:
1116 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 -06001117 else: # This is an array of char* or array of struct ptrs
1118 if not i_decl:
1119 sh_funcs.append('%suint32_t i = 0;' % (indent))
1120 i_decl = True
1121 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1122 indent = ' '
1123 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1124 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']))
1125 else:
Tobin Ehlisf57562c2015-03-13 07:18:05 -06001126 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 -06001127 indent = ' '
1128 sh_funcs.append('%s}' % (indent))
1129 else:
1130 if is_type(self.struct_dict[s][m]['type'], 'struct'):
1131 if not i_decl:
1132 sh_funcs.append('%suint32_t i = 0;' % (indent))
1133 i_decl = True
1134 sh_funcs.append('%sfor (i = 0; i < pStruct->%s; i++) {' % (indent, self.struct_dict[s][m]['array_size']))
1135 indent = ' '
1136 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']))
1137 indent = ' '
1138 sh_funcs.append('%s}' % (indent))
1139 else:
1140 sh_funcs.append('%sstructSize += pStruct->%s*sizeof(%s);' % (indent, self.struct_dict[s][m]['array_size'], self.struct_dict[s][m]['type']))
1141 elif self.struct_dict[s][m]['ptr'] and 'pNext' != self.struct_dict[s][m]['name']:
1142 if 'char' in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisf57562c2015-03-13 07:18:05 -06001143 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 -06001144 elif is_type(self.struct_dict[s][m]['type'], 'struct'):
1145 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 -06001146 elif 'void' not in self.struct_dict[s][m]['type'].lower():
Tobin Ehlisff765b02015-03-12 14:50:40 -06001147 sh_funcs.append('%sstructSize += sizeof(%s);' % (indent, self.struct_dict[s][m]['type']))
1148 elif 'size_t' == self.struct_dict[s][m]['type'].lower():
1149 sh_funcs.append('%sstructSize += pStruct->%s;' % (indent, self.struct_dict[s][m]['name']))
1150 skip_list.append(m+1)
1151 indent = ' '
1152 sh_funcs.append('%s}' % (indent))
1153 sh_funcs.append("%sreturn structSize;\n}" % (indent))
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001154 # Now generate generic functions to loop over entire struct chain (or just handle single generic structs)
1155 for follow_chain in [True, False]:
1156 if follow_chain:
1157 sh_funcs.append('size_t get_struct_chain_size(const void* pStruct)\n{')
1158 else:
1159 sh_funcs.append('size_t get_dynamic_struct_size(const void* pStruct)\n{')
1160 indent = ' '
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001161 sh_funcs.append('%s// Just use VkApplicationInfo as struct until actual type is resolved' % (indent))
1162 sh_funcs.append('%sVkApplicationInfo* pNext = (VkApplicationInfo*)pStruct;' % (indent))
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001163 sh_funcs.append('%ssize_t structSize = 0;' % (indent))
1164 if follow_chain:
1165 sh_funcs.append('%swhile (pNext) {' % (indent))
1166 indent = ' '
1167 sh_funcs.append('%sswitch (pNext->sType) {' % (indent))
1168 indent += ' '
1169 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001170 if 'StructureType' in e:
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001171 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001172 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001173 sh_funcs.append('%scase %s:' % (indent, v))
1174 sh_funcs.append('%s{' % (indent))
1175 indent += ' '
1176 sh_funcs.append('%sstructSize += %s((%s*)pNext);' % (indent, self._get_size_helper_func_name(struct_name), struct_name))
1177 sh_funcs.append('%sbreak;' % (indent))
1178 indent = indent[:-4]
1179 sh_funcs.append('%s}' % (indent))
1180 sh_funcs.append('%sdefault:' % (indent))
1181 indent += ' '
1182 sh_funcs.append('%sassert(0);' % (indent))
1183 sh_funcs.append('%sstructSize += 0;' % (indent))
1184 indent = indent[:-4]
1185 indent = indent[:-4]
1186 sh_funcs.append('%s}' % (indent))
1187 if follow_chain:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001188 sh_funcs.append('%spNext = (VkApplicationInfo*)pNext->pNext;' % (indent))
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001189 indent = indent[:-4]
1190 sh_funcs.append('%s}' % (indent))
1191 sh_funcs.append('%sreturn structSize;\n}' % indent)
Tobin Ehlisff765b02015-03-12 14:50:40 -06001192 return "\n".join(sh_funcs)
1193
1194 def _generateSizeHelperHeader(self):
1195 header = []
1196 header.append("//#includes, #defines, globals and such...\n")
1197 for f in self.include_headers:
1198 header.append("#include <%s>\n" % f)
1199 header.append('\n// Function Prototypes\n')
1200 header.append("size_t get_struct_chain_size(const void* pStruct);\n")
Tobin Ehlis91b2b642015-03-16 10:44:40 -06001201 header.append("size_t get_dynamic_struct_size(const void* pStruct);\n")
Tobin Ehlisff765b02015-03-12 14:50:40 -06001202 return "".join(header)
1203
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001204 def _generateSizeHelperHeaderC(self):
1205 header = []
Courtney Goeltzenleuchtercbf13812015-04-14 16:30:53 -06001206 header.append('#include "vk_struct_size_helper.h"')
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001207 header.append('#include <string.h>')
1208 header.append('#include <assert.h>')
1209 header.append('\n// Function definitions\n')
1210 return "\n".join(header)
1211
1212
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001213 def _generateHeader(self):
1214 header = []
1215 header.append("//#includes, #defines, globals and such...\n")
1216 for f in self.include_headers:
1217 header.append("#include <%s>\n" % f)
1218 return "".join(header)
1219
1220 # Declarations
1221 def _generateConstructorDeclarations(self, s):
1222 constructors = []
1223 constructors.append(" %s();\n" % self.get_class_name(s))
1224 constructors.append(" %s(%s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1225 constructors.append(" %s(const %s* pInStruct);\n" % (self.get_class_name(s), typedef_fwd_dict[s]))
1226 return "".join(constructors)
1227
1228 def _generateDestructorDeclarations(self, s):
1229 return " virtual ~%s();\n" % self.get_class_name(s)
1230
1231 def _generateDisplayDeclarations(self, s):
1232 return " void display_txt();\n void display_single_txt();\n void display_full_txt();\n"
1233
1234 def _generateGetSetDeclarations(self, s):
1235 get_set = []
1236 get_set.append(" void set_indent(uint32_t indent) { m_indent = indent; }\n")
1237 for member in sorted(self.struct_dict[s]):
1238 # TODO : Skipping array set/get funcs for now
1239 if self.struct_dict[s][member]['array']:
1240 continue
1241 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']))
1242 if not self.struct_dict[s][member]['const']:
1243 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']))
1244 return "".join(get_set)
1245
1246 def _generatePrivateMembers(self, s):
1247 priv = []
1248 priv.append("\nprivate:\n")
1249 priv.append(" %s m_struct;\n" % typedef_fwd_dict[s])
1250 priv.append(" const %s* m_origStructAddr;\n" % typedef_fwd_dict[s])
1251 priv.append(" uint32_t m_indent;\n")
1252 priv.append(" const char m_dummy_prefix;\n")
1253 priv.append(" void display_struct_members();\n")
1254 return "".join(priv)
1255
1256 def _generateClassDeclaration(self):
1257 class_decl = []
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001258 for s in sorted(self.struct_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001259 class_decl.append("\n//class declaration")
1260 class_decl.append("class %s\n{\npublic:" % self.get_class_name(s))
1261 class_decl.append(self._generateConstructorDeclarations(s))
1262 class_decl.append(self._generateDestructorDeclarations(s))
1263 class_decl.append(self._generateDisplayDeclarations(s))
1264 class_decl.append(self._generateGetSetDeclarations(s))
1265 class_decl.append(self._generatePrivateMembers(s))
1266 class_decl.append("};\n")
1267 return "\n".join(class_decl)
1268
1269 def _generateFooter(self):
1270 return "\n//any footer info for class\n"
1271
1272class EnumCodeGen:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001273 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 -06001274 self.et_dict = enum_type_dict
1275 self.ev_dict = enum_val_dict
1276 self.tf_dict = typedef_fwd_dict
1277 self.in_file = in_file
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001278 self.out_sh_file = out_sh_file
1279 self.eshfg = CommonFileGen(self.out_sh_file)
1280 self.out_vh_file = out_vh_file
1281 self.evhfg = CommonFileGen(self.out_vh_file)
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001282
1283 def generateStringHelper(self):
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001284 self.eshfg.setHeader(self._generateSHHeader())
1285 self.eshfg.setBody(self._generateSHBody())
1286 self.eshfg.generate()
1287
1288 def generateEnumValidate(self):
1289 self.evhfg.setHeader(self._generateSHHeader())
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001290 self.evhfg.setBody(self._generateVHBody())
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001291 self.evhfg.generate()
1292
1293 def _generateVHBody(self):
1294 body = []
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001295 for bet in sorted(self.et_dict):
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001296 fet = self.tf_dict[bet]
Tobin Ehlis2972ec72015-04-15 17:04:03 -06001297 body.append("static inline uint32_t validate_%s(%s input_value)\n{" % (fet, fet))
1298 # TODO : This is not ideal, but allows for flag combinations. Need more rigorous validation of realistic flag combinations
1299 if 'flags' in bet.lower():
1300 body.append(' if (input_value > (%s))' % (' | '.join(self.et_dict[bet])))
1301 body.append(' return 0;')
1302 body.append(' return 1;')
1303 body.append('}\n\n')
1304 else:
1305 body.append(' switch ((%s)input_value)\n {' % (fet))
1306 for e in sorted(self.et_dict[bet]):
1307 if (self.ev_dict[e]['unique']):
1308 body.append(' case %s:' % (e))
1309 body.append(' return 1;\n default:\n return 0;\n }\n}\n\n')
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001310 return "\n".join(body)
1311
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001312 def _generateSHBody(self):
1313 body = []
1314# with open(self.out_file, "a") as hf:
1315 # bet == base_enum_type, fet == final_enum_type
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001316 for bet in sorted(self.et_dict):
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001317 fet = self.tf_dict[bet]
Ian Elliotta742a622015-02-18 12:38:04 -07001318 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 -06001319 for e in sorted(self.et_dict[bet]):
1320 if (self.ev_dict[e]['unique']):
Tobin Ehlis45bc7f82015-01-16 15:13:34 -07001321 body.append(' case %s:\n return "%s";' % (e, e))
1322 body.append(' default:\n return "Unhandled %s";\n }\n}\n\n' % (fet))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001323 return "\n".join(body)
1324
1325 def _generateSHHeader(self):
Ian Elliott81ac44c2015-01-13 17:52:38 -07001326 header = []
1327 header.append('#pragma once\n')
Ian Elliotta742a622015-02-18 12:38:04 -07001328 header.append('#include <%s>\n\n\n' % self.in_file)
Ian Elliott81ac44c2015-01-13 17:52:38 -07001329 return "\n".join(header)
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001330
1331
1332class CMakeGen:
1333 def __init__(self, struct_wrapper=None, out_dir=None):
1334 self.sw = struct_wrapper
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001335 self.include_headers = []
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001336 self.add_lib_file_list = self.sw.get_file_list()
1337 self.out_dir = out_dir
1338 self.out_file = os.path.join(self.out_dir, "CMakeLists.txt")
1339 self.cmg = CommonFileGen(self.out_file)
1340
1341 def generate(self):
1342 self.cmg.setBody(self._generateBody())
1343 self.cmg.generate()
1344
1345 def _generateBody(self):
1346 body = []
1347 body.append("project(%s)" % os.path.basename(self.out_dir))
1348 body.append("cmake_minimum_required(VERSION 2.8)\n")
1349 body.append("add_library(${PROJECT_NAME} %s)\n" % " ".join(self.add_lib_file_list))
1350 body.append('set(COMPILE_FLAGS "-fpermissive")')
1351 body.append('set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}")\n')
1352 body.append("include_directories(${SRC_DIR}/thirdparty/${GEN_API}/inc/)\n")
1353 body.append("target_include_directories (%s PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})\n" % os.path.basename(self.out_dir))
1354 return "\n".join(body)
1355
1356class GraphVizGen:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001357 def __init__(self, struct_dict, prefix, out_dir):
1358 self.struct_dict = struct_dict
1359 self.api = prefix
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001360 if prefix == "vulkan":
1361 self.api_prefix = "vk"
1362 else:
1363 self.api_prefix = prefix
1364 self.out_file = os.path.join(out_dir, self.api_prefix+"_struct_graphviz_helper.h")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001365 self.gvg = CommonFileGen(self.out_file)
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001366
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001367 def generate(self):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001368 self.gvg.setCopyright("//This is the copyright\n")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001369 self.gvg.setHeader(self._generateHeader())
1370 self.gvg.setBody(self._generateBody())
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001371 #self.gvg.setFooter('}')
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001372 self.gvg.generate()
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001373
1374 def set_include_headers(self, include_headers):
1375 self.include_headers = include_headers
1376
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001377 def _generateHeader(self):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001378 header = []
1379 header.append("//#includes, #defines, globals and such...\n")
1380 for f in self.include_headers:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001381 if 'vk_enum_string_helper' not in f:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001382 header.append("#include <%s>\n" % f)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001383 #header.append('#include "vk_enum_string_helper.h"\n\n// Function Prototypes\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001384 header.append("\nchar* dynamic_gv_display(const void* pStruct, const char* prefix);\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001385 return "".join(header)
1386
1387 def _get_gv_func_name(self, struct):
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001388 return "%s_gv_print_%s" % (self.api_prefix, struct.lower().strip("_"))
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001389
1390 # Return elements to create formatted string for given struct member
1391 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=""):
1392 struct_op = "->"
1393 pre_var_name = '"%s "' % struct_member['full_type']
1394 if not struct_ptr:
1395 struct_op = "."
1396 member_name = struct_member['name']
1397 print_type = "p"
1398 cast_type = ""
1399 member_post = ""
1400 array_index = ""
1401 member_print_post = ""
Tobin Ehlisbf0146e2015-02-11 14:24:02 -07001402 print_delimiter = "%"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001403 if struct_member['array'] and 'char' in struct_member['type'].lower(): # just print char array as string
1404 print_type = "p"
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001405 print_array = False
1406 elif struct_member['array'] and not print_array:
1407 # Just print base address of array when not full print_array
1408 cast_type = "(void*)"
1409 elif is_type(struct_member['type'], 'enum'):
Jon Ashburna0ddc902015-01-09 09:11:44 -07001410 if struct_member['ptr']:
1411 struct_var_name = "*" + struct_var_name
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001412 cast_type = "string_%s" % struct_member['type']
1413 print_type = "s"
1414 elif is_type(struct_member['type'], 'struct'): # print struct address for now
1415 cast_type = "(void*)"
1416 if not struct_member['ptr']:
1417 cast_type = "(void*)&"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001418 elif 'bool' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001419 print_type = "s"
1420 member_post = ' ? "TRUE" : "FALSE"'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001421 elif 'float' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001422 print_type = "f"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001423 elif 'uint64' in struct_member['type'] or 'gpusize' in struct_member['type'].lower():
1424 print_type = '" PRId64 "'
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001425 elif 'uint8' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001426 print_type = "hu"
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001427 elif 'size' in struct_member['type'].lower():
Tobin Ehlisbf0146e2015-02-11 14:24:02 -07001428 print_type = '" PRINTF_SIZE_T_SPECIFIER "'
1429 print_delimiter = ""
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001430 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 -07001431 print_type = "u"
Tobin Ehlis2f3726c2015-01-15 17:51:52 -07001432 elif 'int' in struct_member['type']:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001433 print_type = "i"
1434 elif struct_member['ptr']:
1435 pass
1436 else:
1437 #print("Unhandled struct type: %s" % struct_member['type'])
1438 cast_type = "(void*)"
1439 if print_array and struct_member['array']:
1440 member_print_post = "[%u]"
1441 array_index = " i,"
1442 member_post = "[i]"
Tobin Ehlisbf0146e2015-02-11 14:24:02 -07001443 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 -06001444 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 -07001445 return (print_out, print_arg)
1446
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001447 def _generateBody(self):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001448 gv_funcs = []
1449 array_func_list = [] # structs for which we'll generate an array version of their print function
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001450 array_func_list.append('vkbufferviewattachinfo')
1451 array_func_list.append('vkimageviewattachinfo')
1452 array_func_list.append('vksamplerimageviewinfo')
1453 array_func_list.append('vkdescriptortypecount')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001454 # For first pass, generate prototype
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001455 for s in sorted(self.struct_dict):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001456 gv_funcs.append('char* %s(const %s* pStruct, const char* myNodeName);\n' % (self._get_gv_func_name(s), typedef_fwd_dict[s]))
1457 if s.lower().strip("_") in array_func_list:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001458 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001459 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]))
1460 else:
1461 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 -07001462 gv_funcs.append('\n')
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001463 for s in sorted(self.struct_dict):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001464 p_out = ""
1465 p_args = ""
1466 stp_list = [] # stp == "struct to print" a list of structs for this API call that should be printed as structs
1467 # the fields below are a super-hacky way for now to get port labels into GV output, TODO : Clean this up!
1468 pl_dict = {}
1469 struct_num = 0
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001470 # This isn't great but this pre-pass flags structs w/ pNext and other struct ptrs
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001471 for m in sorted(self.struct_dict[s]):
1472 if 'pNext' == self.struct_dict[s][m]['name'] or is_type(self.struct_dict[s][m]['type'], 'struct'):
1473 stp_list.append(self.struct_dict[s][m])
1474 if 'pNext' == self.struct_dict[s][m]['name']:
1475 pl_dict[m] = ' PORT=\\"pNext\\"'
1476 else:
1477 pl_dict[m] = ' PORT=\\"struct%i\\"' % struct_num
1478 struct_num += 1
1479 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]))
1480 num_stps = len(stp_list);
1481 total_strlen_str = ''
1482 if 0 != num_stps:
1483 gv_funcs.append(" char* tmpStr;\n")
1484 gv_funcs.append(" char nodeName[100];\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001485 gv_funcs.append(' char* stp_strs[%i];\n' % num_stps)
1486 for index in range(num_stps):
1487 if (stp_list[index]['ptr']):
1488 if 'pDescriptorInfo' == stp_list[index]['name']:
1489 gv_funcs.append(' if (pStruct->pDescriptorInfo && (0 != pStruct->descriptorCount)) {\n')
1490 else:
1491 gv_funcs.append(' if (pStruct->%s) {\n' % stp_list[index]['name'])
1492 if 'pNext' == stp_list[index]['name']:
1493 gv_funcs.append(' sprintf(nodeName, "pNext_%p", (void*)pStruct->pNext);\n')
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001494 gv_funcs.append(' tmpStr = dynamic_gv_display((void*)pStruct->pNext, nodeName);\n')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001495 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % index)
1496 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":pNext -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % index)
1497 gv_funcs.append(' free(tmpStr);\n')
1498 else:
1499 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 -06001500 if stp_list[index]['name'] in ['pTypeCount', 'pSamplerImageViews']:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001501 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 -07001502 else:
1503 gv_funcs.append(' tmpStr = %s(pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1504 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1505 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1506 gv_funcs.append(' }\n')
Chia-I Wu81f46672014-12-16 00:36:58 +08001507 gv_funcs.append(" else\n stp_strs[%i] = \"\";\n" % (index))
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001508 elif stp_list[index]['array']: # TODO : For now just printing first element of array
1509 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s[0]);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1510 gv_funcs.append(' tmpStr = %s(&pStruct->%s[0], nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1511 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1512 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1513 else:
1514 gv_funcs.append(' sprintf(nodeName, "%s_%%p", (void*)&pStruct->%s);\n' % (stp_list[index]['name'], stp_list[index]['name']))
1515 gv_funcs.append(' tmpStr = %s(&pStruct->%s, nodeName);\n' % (self._get_gv_func_name(stp_list[index]['type']), stp_list[index]['name']))
1516 gv_funcs.append(' stp_strs[%i] = (char*)malloc(256+strlen(tmpStr)+strlen(nodeName)+strlen(myNodeName));\n' % (index))
1517 gv_funcs.append(' sprintf(stp_strs[%i], "%%s\\n\\"%%s\\":struct%i -> \\"%%s\\" [];\\n", tmpStr, myNodeName, nodeName);\n' % (index, index))
1518 total_strlen_str += 'strlen(stp_strs[%i]) + ' % index
1519 gv_funcs.append(' str = (char*)malloc(%ssizeof(char)*2048);\n' % (total_strlen_str))
1520 gv_funcs.append(' sprintf(str, "\\"%s\\" [\\nlabel = <<TABLE BORDER=\\"0\\" CELLBORDER=\\"1\\" CELLSPACING=\\"0\\"><TR><TD COLSPAN=\\"2\\">%s (%p)</TD></TR>')
1521 p_args = ", myNodeName, myNodeName, pStruct"
1522 for m in sorted(self.struct_dict[s]):
1523 plabel = ""
1524 if m in pl_dict:
1525 plabel = pl_dict[m]
1526 (p_out1, p_args1) = self._get_struct_gv_print_formatted(self.struct_dict[s][m], port_label=plabel)
1527 p_out += p_out1
1528 p_args += p_args1
1529 p_out += '</TABLE>>\\n];\\n\\n"'
1530 p_args += ");\n"
1531 gv_funcs.append(p_out)
1532 gv_funcs.append(p_args)
1533 if 0 != num_stps:
1534 gv_funcs.append(' for (int32_t stp_index = %i; stp_index >= 0; stp_index--) {\n' % (num_stps-1))
1535 gv_funcs.append(' if (0 < strlen(stp_strs[stp_index])) {\n')
1536 gv_funcs.append(' strncat(str, stp_strs[stp_index], strlen(stp_strs[stp_index]));\n')
1537 gv_funcs.append(' free(stp_strs[stp_index]);\n')
1538 gv_funcs.append(' }\n')
1539 gv_funcs.append(' }\n')
1540 gv_funcs.append(" return str;\n}\n")
1541 if s.lower().strip("_") in array_func_list:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001542 ptr_array = False
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001543 if s.lower().strip("_") in ['vkbufferviewattachinfo', 'vkimageviewattachinfo']:
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001544 ptr_array = True
1545 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]))
1546 else:
1547 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 -07001548 gv_funcs.append(' str = (char*)malloc(sizeof(char)*1024*count);\n')
1549 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')
1550 gv_funcs.append(' for (uint32_t i=0; i < count; i++) {\n')
1551 gv_funcs.append(' sprintf(tmpStr, "');
1552 p_args = ""
1553 p_out = ""
1554 for m in sorted(self.struct_dict[s]):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001555 plabel = ""
1556 (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 -07001557 if 0 == m: # Add array index notation at end of first row
1558 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 -07001559 p_args1 += ', i, i'
1560 p_out += p_out1
1561 p_args += p_args1
1562 p_out += '"'
1563 p_args += ");\n"
Tobin Ehlisd1c0e662015-02-26 12:57:08 -07001564 if ptr_array:
1565 p_args = p_args.replace('->', '[i]->')
1566 else:
1567 p_args = p_args.replace('->', '[i].')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001568 gv_funcs.append(p_out);
1569 gv_funcs.append(p_args);
1570 gv_funcs.append(' strncat(str, tmpStr, strlen(tmpStr));\n')
1571 gv_funcs.append(' }\n')
1572 gv_funcs.append(' strncat(str, "</TABLE>>\\n];\\n\\n", 20);\n')
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001573 gv_funcs.append(' return str;\n}\n')
1574 # Add function to dynamically print out unknown struct
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -06001575 gv_funcs.append("char* dynamic_gv_display(const void* pStruct, const char* nodeName)\n{\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001576 gv_funcs.append(" // Cast to APP_INFO ptr initially just to pull sType off struct\n")
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001577 gv_funcs.append(" VkStructureType sType = ((VkApplicationInfo*)pStruct)->sType;\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001578 gv_funcs.append(" switch (sType)\n {\n")
1579 for e in enum_type_dict:
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001580 if "StructureType" in e:
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001581 for v in sorted(enum_type_dict[e]):
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -06001582 struct_name = get_struct_name_from_struct_type(v)
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001583 print_func_name = self._get_gv_func_name(struct_name)
1584 # TODO : Hand-coded fixes for some exceptions
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001585 #if 'VkPipelineCbStateCreateInfo' in struct_name:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001586 # struct_name = 'VK_PIPELINE_CB_STATE'
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001587 if 'VkSemaphoreCreateInfo' in struct_name:
1588 struct_name = 'VkSemaphoreCreateInfo'
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001589 print_func_name = self._get_gv_func_name(struct_name)
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001590 elif 'VkSemaphoreOpenInfo' in struct_name:
1591 struct_name = 'VkSemaphoreOpenInfo'
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001592 print_func_name = self._get_gv_func_name(struct_name)
1593 gv_funcs.append(' case %s:\n' % (v))
1594 gv_funcs.append(' return %s((%s*)pStruct, nodeName);\n' % (print_func_name, struct_name))
1595 #gv_funcs.append(' }\n')
1596 #gv_funcs.append(' break;\n')
Chia-I Wu84d7f5c2014-12-16 00:43:20 +08001597 gv_funcs.append(" default:\n")
1598 gv_funcs.append(" return NULL;\n")
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001599 gv_funcs.append(" }\n")
1600 gv_funcs.append("}")
1601 return "".join(gv_funcs)
1602
1603
1604
1605
1606
1607# def _generateHeader(self):
1608# hdr = []
1609# hdr.append('digraph g {\ngraph [\nrankdir = "LR"\n];')
1610# hdr.append('node [\nfontsize = "16"\nshape = "plaintext"\n];')
1611# hdr.append('edge [\n];\n')
1612# return "\n".join(hdr)
1613#
1614# def _generateBody(self):
1615# body = []
Peter Lohrmannc55cfa12015-03-30 16:29:56 -07001616# for s in sorted(self.struc_dict):
Tobin Ehlisa701ef02014-11-27 15:43:39 -07001617# field_num = 1
1618# 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]))
1619# for m in sorted(self.struc_dict[s]):
1620# 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']))
1621# field_num += 2
1622# body.append('</TABLE>>\n];\n')
1623# return "".join(body)
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001624
1625def main(argv=None):
1626 opts = handle_args()
1627 # Parse input file and fill out global dicts
1628 hfp = HeaderFileParser(opts.input_file)
1629 hfp.parse()
1630 # TODO : Don't want these to be global, see note at top about wrapper classes
1631 global enum_val_dict
1632 global enum_type_dict
1633 global struct_dict
1634 global typedef_fwd_dict
1635 global typedef_rev_dict
1636 global types_dict
1637 enum_val_dict = hfp.get_enum_val_dict()
1638 enum_type_dict = hfp.get_enum_type_dict()
1639 struct_dict = hfp.get_struct_dict()
Tobin Ehlis6f7029b2014-11-11 12:28:12 -07001640 # 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 -06001641 typedef_fwd_dict = hfp.get_typedef_fwd_dict()
1642 typedef_rev_dict = hfp.get_typedef_rev_dict()
1643 types_dict = hfp.get_types_dict()
1644 #print(enum_val_dict)
1645 #print(typedef_dict)
1646 #print(struct_dict)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001647 prefix = os.path.basename(opts.input_file).strip(".h")
1648 if prefix == "vulkan":
1649 prefix = "vk"
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001650 if (opts.abs_out_dir is not None):
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001651 enum_sh_filename = os.path.join(opts.abs_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001652 else:
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001653 enum_sh_filename = os.path.join(os.getcwd(), opts.rel_out_dir, prefix+"_enum_string_helper.h")
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001654 enum_sh_filename = os.path.abspath(enum_sh_filename)
1655 if not os.path.exists(os.path.dirname(enum_sh_filename)):
1656 print("Creating output dir %s" % os.path.dirname(enum_sh_filename))
1657 os.mkdir(os.path.dirname(enum_sh_filename))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001658 if opts.gen_enum_string_helper:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001659 print("Generating enum string helper to %s" % enum_sh_filename)
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06001660 enum_vh_filename = os.path.join(os.path.dirname(enum_sh_filename), prefix+"_enum_validate_helper.h")
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001661 print("Generating enum validate helper to %s" % enum_vh_filename)
1662 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 -06001663 eg.generateStringHelper()
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001664 eg.generateEnumValidate()
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001665 #for struct in struct_dict:
1666 #print(struct)
1667 if opts.gen_struct_wrappers:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001668 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 -06001669 #print(sw.get_class_name(struct))
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -06001670 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 -06001671 print("Generating struct wrapper header to %s" % sw.header_filename)
1672 sw.generateHeader()
1673 print("Generating struct wrapper class to %s" % sw.class_filename)
1674 sw.generateBody()
1675 sw.generateStringHelper()
Tobin Ehlis6cd06372014-12-17 17:44:50 -07001676 sw.generateValidateHelper()
Tobin Ehlis07fe9ab2014-11-25 17:43:26 -07001677 # Generate a 2nd helper file that excludes addrs
1678 sw.set_no_addr(True)
1679 sw.generateStringHelper()
Tobin Ehlis434db7c2015-01-10 12:42:41 -07001680 sw.set_no_addr(False)
1681 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 -07001682 sw.set_no_addr(True)
1683 sw.generateStringHelperCpp()
Tobin Ehlis91cc24a2015-03-06 10:38:25 -07001684 sw.set_no_addr(False)
1685 sw.generateStringHelperCpp()
Courtney Goeltzenleuchtera8c06282015-04-14 14:55:44 -06001686 sw.set_include_headers(["stdio.h", "stdlib.h", "vulkan.h"])
Tobin Ehlisff765b02015-03-12 14:50:40 -06001687 sw.generateSizeHelper()
Peter Lohrmann3a9c63a2015-04-03 11:43:06 -07001688 sw.generateSizeHelperC()
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001689 if opts.gen_cmake:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001690 cmg = CMakeGen(sw, os.path.dirname(enum_sh_filename))
Tobin Ehlisee33fa52014-10-22 15:13:53 -06001691 cmg.generate()
1692 if opts.gen_graphviz:
Tobin Ehlisbe8dded2014-12-17 07:20:23 -07001693 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 -06001694 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 -06001695 gv.generate()
1696 print("DONE!")
1697 #print(typedef_rev_dict)
1698 #print(types_dict)
1699 #recreate_structs()
1700
1701if __name__ == "__main__":
1702 sys.exit(main())