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}
16 \usepackage{bytefield}
24 PACKET_HEADER=r"""\begin{bytefield}{32}
28 PACKET_FOOTER=r"""\end{bytefield}
33 TEX_FOOTER = r"""\end{document}
36 def formatField(width, start, size):
41 areas.append({'start': start,
45 areas.append({'start': start,
50 for i in range(len(areas)-1):
51 if areas[i]['start'] < areas[i+1]['start']+areas[i+1]['size']:
52 areas[i]['bottom'] = False
53 areas[i+1]['top'] = False
56 def formatSimpleField(width, start, field):
57 areas = formatField(width, start, field['size'])
60 for i in range(len(areas)):
61 if areas[i]['size'] > namesz:
62 namesz = areas[i]['size']
64 areas[nameix]['name'] = field['name'][:int(areas[nameix]['size'] * charsPerBit)]
65 if field['name'] and len(areas) == 2 and areas[0].get('bottom',True):
66 if areas[0].get('name','') : ix = 1
68 if 6 <= int(areas[ix]['size'] * charsPerBit):
69 areas[ix]['name'] = '(cont)'
72 def formatPacket(width, fields):
77 if field.get('repeat', False):
78 if start > 0 and start < width:
79 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
82 if field.get('size',None):
83 areas.extend(formatSimpleField(width, start, field))
84 start = areas[-1]['start'] + areas[-1]['size']
85 elif field.get('minsize', None):
87 f['size'] = field['minsize']
88 areas.extend(formatSimpleField(width, start, f))
89 start = areas[-1]['start'] + areas[-1]['size']
90 if start >= width : start = 0
91 addareas = formatField(width, start, field['maxsize'] - field['minsize'])
95 start = areas[-1]['start'] + areas[-1]['size']
96 if start > 0 and start < width:
97 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
101 if start > 0 and start < width:
102 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
104 areas.extend([ { 'start': 0, 'size': width, 'bottom': False,
105 'name': field['name'] },
106 { 'start': 0, 'size': width, 'skip': True },
107 { 'start': 0, 'size': width, 'top': False } ])
109 if field.get('optional', False):
111 area['optional'] = True
112 if start > 0 and start < width:
113 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
116 if field.get('repeat'):
117 if start > 0 and start < width:
118 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
121 areas.append({ 'start': 0, 'size': width, 'dots': True })
122 da = areas[(areas[0].get('right', True) and (0,) or (1,))[0]:-1]
123 for i in range(len(da)):
124 if da[i].get('name','') :
128 if start == width : start = 0
131 while areas and (not(rows[-1]) or rows[-1][-1]['start'] + rows[-1][-1]['size'] < width):
132 if areas[0].get('right', True) == False:
133 # This is a fillup field. Check, wether to draw top:
135 areas[0]['top'] = False
136 elif rows[-2][-1].get('bottom', True) or not rows[-2][-1].get('right', True):
137 areas[0]['top'] = False
138 rows[-1].append(areas.pop(0))
144 s = s.replace('_', '\\_')
153 if area.get('left', True) : sides += "l"
154 if area.get('right', True) : sides += "r"
155 if area.get('top', True) : sides += "t"
156 if area.get('bottom', True) : sides += "b"
157 if sides == "lrtb" : sides = ""
158 else : sides = "[%s]" % sides
159 if area.get('filled', False):
160 line.append(r"\bitbox%s{%s}{\color[gray]{0.93}\rule{\width}{\height}}" % (sides, area['size']))
161 elif area.get('skip', False):
162 line.append(r"\skippedwords")
163 elif area.get('dots', False):
164 line.append(r"\wordbox[]{1}{$\vdots$\\[1ex]}")
166 name = texquote(area.get('name',''))
167 if name and area.get('optional', False):
169 line.append(r"\bitbox%s{%s}{\strut %s}" % (sides, area['size'], name))
170 lines.append(" & ".join(line))
171 return " \\\\\n".join(lines) + "\n"
173 COMMENT_RE = re.compile(r'//.*?$|/\*.*?\*/|"(?:\\.|[^\\"])*"', re.S | re.M)
175 def stripComments(text):
178 if s.startswith('//<pkgdraw:') or s.startswith('//>pkgdraw:'):
180 if s.startswith('/'):
183 return COMMENT_RE.sub(replacer, text)
185 SENF_INCLUDE_RE = re.compile(r"#\s*include\s*SENF_")
187 def quoteMacros(text):
188 return SENF_INCLUDE_RE.sub("PKGDRAW_", text).replace("SENF_PARSER_","PKGDRAW_PARSER_")
190 def cppExpand(text, cppopts, dir):
191 tmpf = tempfile.NamedTemporaryFile(dir=dir)
194 cmd = "gcc %s -E -o - -x c++-header %s" % (" ".join(cppopts), tmpf.name)
195 return os.popen(cmd).read()
198 'UInt8Parser' : {'size': 8 },
199 'UInt16Parser' : {'size': 16 },
200 'UInt24Parser' : {'size': 24 },
201 'UInt32Parser' : {'size': 32 },
202 'UInt64Parser' : {'size': 64 },
203 'Int8Parser' : {'size': 8 },
204 'Int16Parser' : {'size': 16 },
205 'Int24Parser' : {'size': 24 },
206 'Int32Parser' : {'size': 32 },
207 'Int64Parser' : {'size': 64 },
208 'UInt16LSBParser' : {'size': 16 },
209 'UInt24LSBParser' : {'size': 24 },
210 'UInt32LSBParser' : {'size': 32 },
211 'UInt64LSBParser' : {'size': 64 },
212 'Int16LSBParser' : {'size': 16 },
213 'Int24LSBParser' : {'size': 24 },
214 'Int32LSBParser' : {'size': 32 },
215 'Int64LSBParser' : {'size': 64 },
216 'MACAddressParser': {'size': 48 },
217 'INet4AddressParser' : {'size': 32 },
218 'INet6AddressParser' : {'size': 128 },
219 'VoidPacketParser' : {'size': 0 },
222 def parse_FIELD(args, flags):
223 args = [ arg.strip() for arg in args.split(',') ]
225 sys.stderr.write("Failed to parse FIELD: %s\n" % args)
227 field = dict(FIELD_TYPES.get(args[1].split(':')[-1], {}))
228 field['name'] = args[0]
231 def parse_PRIVATE_FIELD(args, flags):
232 return parse_FIELD(args, flags)
234 def parse_FIELD_RO(args, flags):
235 return parse_FIELD(args, flags)
237 def parse_BITFIELD(args, flags):
238 args = [ arg.strip() for arg in args.split(',') ]
240 sys.stderr.write("Failed to parse BITFIELD: %s\n" % args)
245 sys.stderr.write("Failed to parse BITFIELD: %s\n" % args)
247 return { 'size' : size, 'name' : args[0] }
249 def parse_PRIVATE_BITFIELD(args, flags):
250 return parse_BITFIELD(args, flags)
252 def parse_BITFIELD_RO(args, flags):
253 return parse_BITFIELD(args, flags)
255 def parse_SKIP(args, flags):
256 args = args.split(',')[0]
258 bytes = int(args.strip())
260 sys.stderr.write("Failed to parse SKIP: %s\n" % args)
262 return { 'size': 8*bytes, 'name': '' }
264 def parse_SKIP_BITS(args, flags):
266 bits = int(args.strip())
268 sys.stderr.write("Failed to parse SKIP_BITS: %s\n" % args)
270 return { 'size': bits, 'name': '' }
272 def parse_VECTOR(args, flags):
273 args = [ arg.strip() for arg in args.split(',') ]
275 sys.stderr.write("Failed to aprse VECTOR: %s\n" % args)
277 field = dict(FIELD_TYPES.get(args[-1].split(':')[-1], {}))
278 field['name'] = args[0]
279 field['repeat'] = True
282 def parse_LIST(args, flags):
283 return parse_VECTOR(args, flags)
285 VARIANT_FIELD_RE_STR = r"""
292 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
300 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
306 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
311 VARIANT_FIELD_RE = re.compile(VARIANT_FIELD_RE_STR, re.X)
312 VARIANT_FIELDS_RE = re.compile(",\s*((?:%s\s*)+)$" % VARIANT_FIELD_RE_STR, re.X)
314 def parse_VARIANT(args, flags):
315 name = args.split(',',1)[0].strip()
316 fields_match = VARIANT_FIELDS_RE.search(args)
318 return { 'name': name }
319 fields_str = fields_match.group(1)
323 for field_match in VARIANT_FIELD_RE.finditer(fields_str):
324 parser = ([ group for group in field_match.groups() if group ] + [ None ])[0]
325 field = dict(FIELD_TYPES.get(parser.split(':')[-1], {}))
326 if field.has_key('minsize'):
327 if minsize is None or field['minsize'] < minsize:
328 minsize = field['minsize']
329 if maxsize is None or field['maxsize'] > maxsize:
330 maxsize = field['maxsize']
331 elif field.has_key('size'):
332 if field['size'] == 0:
335 if minsize is None or field['size'] < minsize:
336 minsize = field['size']
337 if maxsize is None or field['size'] > maxsize:
338 maxsize = field['size']
339 if minsize is not None and minsize == maxsize:
340 return { 'name': name, 'size': minsize, 'optional': optional }
341 elif minsize is not None:
342 return { 'name': name, 'minsize': minsize, 'maxsize': maxsize, 'optional': optional }
344 return { 'name': name, 'optional': optional }
346 def parse_PRIVATE_VARIANT(args, flags):
347 return parse_VARIANT(args, flags)
349 def parse_INIT(args, flags):
352 PARSER_START_RE = re.compile(r"PKGDRAW_(FIXED_)?PARSER\s*\(\s*\)")
353 PARSER_END_RE = re.compile(r"PKGDRAW_PARSER_FINALIZE\s*\(([^)]*)\)\s*;")
354 PARSER_FIELD_RE = re.compile(r"(?:@@>pkgdraw:(.*)$\s*)?PKGDRAW_PARSER_([A-Z_]+)\s*\(([^;]*)\)\s*;(?:\s*@@<pkgdraw:(.*)$)?", re.M)
356 def scanPackets(data):
363 start = PARSER_START_RE.search(data, end)
364 if not start: return (packets, packetOrder)
366 end = PARSER_END_RE.search(data, start)
367 if not end: return (packets, packetOrder)
368 name=end.group(1).strip()
370 packets[name] = scanFields(data[start:end])
371 packetOrder.append(name)
372 minsize = maxsize = 0
373 for field in packets[name]:
374 if field.get('size', None) is not None:
375 maxsize += field['size']
376 elif field.get('minsize', None) is not None:
377 maxsize += field['maxsize']
378 if not field.get('optional', False):
379 if field.get('size', None) is not None:
380 minsize += field['size']
381 elif field.get('minsize', None) is not None:
382 minsize += field['minsize']
383 if minsize is not None and maxsize is not None:
384 if minsize == maxsize:
385 FIELD_TYPES[name] = { 'size' : minsize }
387 FIELD_TYPES[name] = { 'minsize' : minsize, 'maxsize' : maxsize }
389 def scanFields(data):
391 for match in PARSER_FIELD_RE.finditer(data):
393 flags = dict([ ([ arg.strip() for arg in flag.strip().split('=',1) ]+[True])[:2]
394 for flag in ((match.group(1) or '')+(match.group(4) or '')).split(',') ])
395 if flags.has_key('hide') : continue
396 parser = globals().get("parse_%s" % tp, None)
398 field = parser(match.group(3).strip(), flags)
400 if flags.has_key('name') : field['name'] = flags['name']
401 field['name'] = field['name'].strip('_')
402 if flags.has_key('size'):
403 if '-' in flags['size']:
404 field['minsize'], field['maxsize'] = map(int, flags['size'].split('-',1))
407 field['size'] = int(flags['size'])
408 if not field['name'] and fields and not fields[-1]['name'] \
409 and field.has_key('size') and fields[-1].has_key('size'):
410 fields[-1]['size'] += field['size']
414 sys.stderr.write("Unknown parser type: %s\n" % tp)
417 tmpdir = tempfile.mkdtemp(prefix="pkgdraw_")
421 shutil.rmtree(tmpdir)
423 signal.signal(signal.SIGINT, cleanup)
424 signal.signal(signal.SIGTERM, cleanup)
425 signal.signal(signal.SIGHUP, cleanup)
426 atexit.register(cleanup)
432 if len(args)<2 or args[0] == '--' or args[1] == '--':
433 sys.stderr.write("Usage: %s <header> <outfile> [<parser names>...] [-- <cpp options>...]\n"
440 while args and args[0] != '--' : names.append(args.pop(0))
441 if args : gccopts = args[1:]
443 data, order = scanPackets(cppExpand(quoteMacros(stripComments(file(source).read())),
444 gccopts, os.path.dirname(source)))
446 texf = file(os.path.join(tmpdir, "fields.tex"),"w")
447 texf.write(TEX_HEADER)
454 texf.write("\\textbf{%s}\n\\bigskip\\par\n" % texquote(name))
455 texf.write(PACKET_HEADER)
456 texf.write(makeTex(formatPacket(32, data[name])))
457 texf.write(PACKET_FOOTER)
459 texf.write(TEX_FOOTER)
462 if os.system("cd %s; %s/textogif -png -dpi 80 -res 0.25 fields >pkgdraw.log 2>&1"
463 % (tmpdir, basedir)) != 0:
464 sys.stderr.write("Conversion failed. See %s\n" % tmpdir)
467 file(target,"w").write(file(os.path.join(tmpdir, "fields.png")).read())