3 import sys, re, signal, tempfile, os, os.path, shutil, atexit
5 basedir=os.path.abspath(os.path.split(sys.argv[0])[0])
9 TEX_HEADER = r"""\documentclass{scrartcl}
10 \usepackage[german]{babel}
11 \usepackage[latin1]{inputenc}
12 \usepackage[T1]{fontenc}
13 \usepackage{ae,aecompl}
14 \usepackage[active]{srcltx}
17 \usepackage{bytefield}
25 PACKET_HEADER=r"""\begin{bytefield}{32}
29 PACKET_FOOTER=r"""\end{bytefield}
34 TEX_FOOTER = r"""\end{document}
37 def formatField(width, start, size):
42 areas.append({'start': start,
46 areas.append({'start': start,
51 for i in range(len(areas)-1):
52 if areas[i]['start'] < areas[i+1]['start']+areas[i+1]['size']:
53 areas[i]['bottom'] = False
54 areas[i+1]['top'] = False
57 def formatSimpleField(width, start, field):
58 areas = formatField(width, start, field['size'])
61 for i in range(len(areas)):
62 if areas[i]['size'] > namesz:
63 namesz = areas[i]['size']
65 areas[nameix]['name'] = field['name'][:int(areas[nameix]['size'] * charsPerBit)]
66 if field['name'] and len(areas) == 2 and areas[0].get('bottom',True):
67 if areas[0].get('name','') : ix = 1
69 if 6 <= int(areas[ix]['size'] * charsPerBit):
70 areas[ix]['name'] = '(cont)'
73 def formatPacket(width, fields):
78 if field.get('repeat', False):
79 if start > 0 and start < width:
80 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
83 if field.get('size',None):
84 areas.extend(formatSimpleField(width, start, field))
85 start = areas[-1]['start'] + areas[-1]['size']
86 elif field.get('minsize', None):
88 f['size'] = field['minsize']
89 areas.extend(formatSimpleField(width, start, f))
90 start = areas[-1]['start'] + areas[-1]['size']
91 if start >= width : start = 0
92 addareas = formatField(width, start, field['maxsize'] - field['minsize'])
96 start = areas[-1]['start'] + areas[-1]['size']
97 if start > 0 and start < width:
98 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
102 if start > 0 and start < width:
103 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
105 areas.extend([ { 'start': 0, 'size': width, 'bottom': False,
106 'name': field['name'] },
107 { 'start': 0, 'size': width, 'skip': True },
108 { 'start': 0, 'size': width, 'top': False } ])
110 if field.get('optional', False):
112 area['optional'] = True
113 if start > 0 and start < width:
114 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
117 if field.get('repeat'):
118 if start > 0 and start < width:
119 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
122 areas.append({ 'start': 0, 'size': width, 'dots': True })
123 da = areas[(areas[0].get('right', True) and (0,) or (1,))[0]:-1]
124 for i in range(len(da)):
125 if da[i].get('name','') :
129 if start == width : start = 0
132 while areas and (not(rows[-1]) or rows[-1][-1]['start'] + rows[-1][-1]['size'] < width):
133 if areas[0].get('right', True) == False:
134 # This is a fillup field. Check, wether to draw top:
136 areas[0]['top'] = False
137 elif rows[-2][-1].get('bottom', True) or not rows[-2][-1].get('right', True):
138 areas[0]['top'] = False
139 rows[-1].append(areas.pop(0))
145 s = s.replace('_', '\\_')
154 if area.get('left', True) : sides += "l"
155 if area.get('right', True) : sides += "r"
156 if area.get('top', True) : sides += "t"
157 if area.get('bottom', True) : sides += "b"
158 if sides == "lrtb" : sides = ""
159 else : sides = "[%s]" % sides
160 if area.get('filled', False):
161 line.append(r"\bitbox%s{%s}{\color[gray]{0.93}\rule{\width}{\height}}" % (sides, area['size']))
162 elif area.get('skip', False):
163 line.append(r"\skippedwords")
164 elif area.get('dots', False):
165 line.append(r"\wordbox[]{1}{$\vdots$\\[1ex]}")
167 name = texquote(area.get('name',''))
168 if name and area.get('optional', False):
170 line.append(r"\bitbox%s{%s}{\strut %s}" % (sides, area['size'], name))
171 lines.append(" & ".join(line))
172 return " \\\\\n".join(lines) + "\n"
174 COMMENT_RE = re.compile(r'//.*?$|/\*.*?\*/|"(?:\\.|[^\\"])*"', re.S | re.M)
176 def stripComments(text):
179 if s.startswith('//<pkgdraw:') or s.startswith('//>pkgdraw:'):
181 if s.startswith('/'):
184 return COMMENT_RE.sub(replacer, text)
186 SENF_INCLUDE_RE = re.compile(r"#\s*include\s*SENF_")
188 def quoteMacros(text):
189 return SENF_INCLUDE_RE.sub("PKGDRAW_", text).replace("SENF_PARSER_","PKGDRAW_PARSER_")
191 def cppExpand(text, cppopts, dir):
192 tmpf = tempfile.NamedTemporaryFile(dir=dir)
195 cmd = "gcc %s -E -o - -x c++-header %s" % (" ".join(cppopts), tmpf.name)
196 return os.popen(cmd).read()
199 'UInt8Parser' : {'size': 8 },
200 'UInt16Parser' : {'size': 16 },
201 'UInt24Parser' : {'size': 24 },
202 'UInt32Parser' : {'size': 32 },
203 'UInt64Parser' : {'size': 64 },
204 'Int8Parser' : {'size': 8 },
205 'Int16Parser' : {'size': 16 },
206 'Int24Parser' : {'size': 24 },
207 'Int32Parser' : {'size': 32 },
208 'Int64Parser' : {'size': 64 },
209 'UInt16LSBParser' : {'size': 16 },
210 'UInt24LSBParser' : {'size': 24 },
211 'UInt32LSBParser' : {'size': 32 },
212 'UInt64LSBParser' : {'size': 64 },
213 'Int16LSBParser' : {'size': 16 },
214 'Int24LSBParser' : {'size': 24 },
215 'Int32LSBParser' : {'size': 32 },
216 'Int64LSBParser' : {'size': 64 },
217 'MACAddressParser': {'size': 48 },
218 'INet4AddressParser' : {'size': 32 },
219 'INet6AddressParser' : {'size': 128 },
220 'VoidPacketParser' : {'size': 0 },
223 def parse_FIELD(args, flags):
224 args = [ arg.strip() for arg in args.split(',') ]
226 sys.stderr.write("Failed to parse FIELD: %s\n" % args)
228 field = dict(FIELD_TYPES.get(args[1].split(':')[-1], {}))
229 field['name'] = args[0]
232 def parse_PRIVATE_FIELD(args, flags):
233 return parse_FIELD(args, flags)
235 def parse_FIELD_RO(args, flags):
236 return parse_FIELD(args, flags)
238 def parse_BITFIELD(args, flags):
239 args = [ arg.strip() for arg in args.split(',') ]
241 sys.stderr.write("Failed to parse BITFIELD: %s\n" % args)
246 sys.stderr.write("Failed to parse BITFIELD: %s\n" % args)
248 return { 'size' : size, 'name' : args[0] }
250 def parse_PRIVATE_BITFIELD(args, flags):
251 return parse_BITFIELD(args, flags)
253 def parse_BITFIELD_RO(args, flags):
254 return parse_BITFIELD(args, flags)
256 def parse_SKIP(args, flags):
257 args = args.split(',')[0]
259 bytes = int(args.strip())
261 sys.stderr.write("Failed to parse SKIP: %s\n" % args)
263 return { 'size': 8*bytes, 'name': '' }
265 def parse_SKIP_BITS(args, flags):
267 bits = int(args.strip())
269 sys.stderr.write("Failed to parse SKIP_BITS: %s\n" % args)
271 return { 'size': bits, 'name': '' }
273 def parse_VECTOR(args, flags):
274 args = [ arg.strip() for arg in args.split(',') ]
276 sys.stderr.write("Failed to aprse VECTOR: %s\n" % args)
278 field = dict(FIELD_TYPES.get(args[-1].split(':')[-1], {}))
279 field['name'] = args[0]
280 field['repeat'] = True
283 def parse_LIST(args, flags):
284 return parse_VECTOR(args, flags)
286 VARIANT_FIELD_RE_STR = r"""
293 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
301 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
307 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
312 VARIANT_FIELD_RE = re.compile(VARIANT_FIELD_RE_STR, re.X)
313 VARIANT_FIELDS_RE = re.compile(",\s*((?:%s\s*)+)$" % VARIANT_FIELD_RE_STR, re.X)
315 def parse_VARIANT(args, flags):
316 name = args.split(',',1)[0].strip()
317 fields_match = VARIANT_FIELDS_RE.search(args)
319 return { 'name': name }
320 fields_str = fields_match.group(1)
324 for field_match in VARIANT_FIELD_RE.finditer(fields_str):
325 parser = ([ group for group in field_match.groups() if group ] + [ None ])[0]
326 field = dict(FIELD_TYPES.get(parser.split(':')[-1], {}))
327 if field.has_key('minsize'):
328 if minsize is None or field['minsize'] < minsize:
329 minsize = field['minsize']
330 if maxsize is None or field['maxsize'] > maxsize:
331 maxsize = field['maxsize']
332 elif field.has_key('size'):
333 if field['size'] == 0:
336 if minsize is None or field['size'] < minsize:
337 minsize = field['size']
338 if maxsize is None or field['size'] > maxsize:
339 maxsize = field['size']
340 if minsize is not None and minsize == maxsize:
341 return { 'name': name, 'size': minsize, 'optional': optional }
342 elif minsize is not None:
343 return { 'name': name, 'minsize': minsize, 'maxsize': maxsize, 'optional': optional }
345 return { 'name': name, 'optional': optional }
347 def parse_PRIVATE_VARIANT(args, flags):
348 return parse_VARIANT(args, flags)
350 def parse_INIT(args, flags):
353 PARSER_START_RE = re.compile(r"PKGDRAW_(FIXED_)?PARSER\s*\(\s*\)")
354 PARSER_END_RE = re.compile(r"PKGDRAW_PARSER_FINALIZE\s*\(([^)]*)\)\s*;")
355 PARSER_FIELD_RE = re.compile(r"(?:@@>pkgdraw:(.*)$\s*)?PKGDRAW_PARSER_([A-Z_]+)\s*\(([^;]*)\)\s*;(?:\s*@@<pkgdraw:(.*)$)?", re.M)
357 def scanPackets(data):
364 start = PARSER_START_RE.search(data, end)
365 if not start: return (packets, packetOrder)
367 end = PARSER_END_RE.search(data, start)
368 if not end: return (packets, packetOrder)
369 name=end.group(1).strip()
371 packets[name] = scanFields(data[start:end])
372 packetOrder.append(name)
373 minsize = maxsize = 0
374 for field in packets[name]:
375 if field.get('size', None) is not None:
376 maxsize += field['size']
377 elif field.get('minsize', None) is not None:
378 maxsize += field['maxsize']
379 if not field.get('optional', False):
380 if field.get('size', None) is not None:
381 minsize += field['size']
382 elif field.get('minsize', None) is not None:
383 minsize += field['minsize']
384 if minsize is not None and maxsize is not None:
385 if minsize == maxsize:
386 FIELD_TYPES[name] = { 'size' : minsize }
388 FIELD_TYPES[name] = { 'minsize' : minsize, 'maxsize' : maxsize }
390 def scanFields(data):
392 for match in PARSER_FIELD_RE.finditer(data):
394 flags = dict([ ([ arg.strip() for arg in flag.strip().split('=',1) ]+[True])[:2]
395 for flag in ((match.group(1) or '')+(match.group(4) or '')).split(',') ])
396 if flags.has_key('hide') : continue
397 parser = globals().get("parse_%s" % tp, None)
399 field = parser(match.group(3).strip(), flags)
401 if flags.has_key('name') : field['name'] = flags['name']
402 field['name'] = field['name'].strip('_')
403 if flags.has_key('size'):
404 if '-' in flags['size']:
405 field['minsize'], field['maxsize'] = map(int, flags['size'].split('-',1))
408 field['size'] = int(flags['size'])
409 if not field['name'] and fields and not fields[-1]['name'] \
410 and field.has_key('size') and fields[-1].has_key('size'):
411 fields[-1]['size'] += field['size']
415 sys.stderr.write("Unknown parser type: %s\n" % tp)
418 tmpdir = tempfile.mkdtemp(prefix="pkgdraw_")
422 shutil.rmtree(tmpdir)
424 signal.signal(signal.SIGINT, cleanup)
425 signal.signal(signal.SIGTERM, cleanup)
426 signal.signal(signal.SIGHUP, cleanup)
427 atexit.register(cleanup)
433 if len(args)<2 or args[0] == '--' or args[1] == '--':
434 sys.stderr.write("Usage: %s <header> <outfile> [<parser names>...] [-- <cpp options>...]\n"
441 while args and args[0] != '--' : names.append(args.pop(0))
442 if args : gccopts = args[1:]
444 data, order = scanPackets(cppExpand(quoteMacros(stripComments(file(source).read())),
445 gccopts, os.path.dirname(source)))
447 texf = file(os.path.join(tmpdir, "fields.tex"),"w")
448 texf.write(TEX_HEADER)
455 texf.write("\\textbf{%s}\n\\bigskip\\par\n" % texquote(name))
456 texf.write(PACKET_HEADER)
457 texf.write(makeTex(formatPacket(32, data[name])))
458 texf.write(PACKET_FOOTER)
460 texf.write(TEX_FOOTER)
463 if os.system("cd %s; %s/textogif -png -dpi 80 -res 0.25 fields >pkgdraw.log 2>&1"
464 % (tmpdir, basedir)) != 0:
465 sys.stderr.write("Conversion failed. See %s\n" % tmpdir)
468 file(target,"w").write(file(os.path.join(tmpdir, "fields.png")).read())