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 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 field.get('repeat'):
114 if start > 0 and start < width:
115 areas.append({ 'start': start, 'size': width-start, 'bottom': False,
118 areas.append({ 'start': 0, 'size': width, 'dots': True })
119 da = areas[(areas[0].get('right', True) and (0,) or (1,))[0]:-1]
120 for i in range(len(da)):
121 if da[i].get('name','') :
125 if start == width : start = 0
128 while areas and (not(rows[-1]) or rows[-1][-1]['start'] + rows[-1][-1]['size'] < width):
129 if areas[0].get('right', True) == False:
130 # This is a fillup field. Check, wether to draw top:
132 areas[0]['top'] = False
133 elif rows[-2][-1].get('bottom', True):
134 areas[0]['top'] = False
135 rows[-1].append(areas.pop(0))
141 s = s.replace('_', '\\_')
150 if area.get('left', True) : sides += "l"
151 if area.get('right', True) : sides += "r"
152 if area.get('top', True) : sides += "t"
153 if area.get('bottom', True) : sides += "b"
154 if sides == "lrtb" : sides = ""
155 else : sides = "[%s]" % sides
156 if area.get('filled', False):
157 line.append(r"\bitbox%s{%s}{\color[gray]{0.7}\rule{\width}{\height}}" % (sides, area['size']))
158 elif area.get('skip', False):
159 line.append(r"\skippedwords")
160 elif area.get('dots', False):
161 line.append(r"\wordbox[]{1}{$\vdots$\\[1ex]}")
163 name = texquote(area.get('name',''))
164 if name and area.get('optional', False):
166 line.append(r"\bitbox%s{%s}{\strut %s}" % (sides, area['size'], name))
167 lines.append(" & ".join(line))
168 return " \\\\\n".join(lines) + "\n"
170 COMMENT_RE = re.compile(r'//.*?$|/\*.*?\*/|"(?:\\.|[^\\"])*"', re.S | re.M)
172 def stripComments(text):
175 if s.startswith('//<pkgdraw:') or s.startswith('//>pkgdraw:'):
177 if s.startswith('/'):
180 return COMMENT_RE.sub(replacer, text)
183 'UInt8Parser' : {'size': 8 },
184 'UInt16Parser' : {'size': 16 },
185 'UInt24Parser' : {'size': 24 },
186 'UInt32Parser' : {'size': 32 },
187 'UInt64Parser' : {'size': 64 },
188 'Int8Parser' : {'size': 8 },
189 'Int16Parser' : {'size': 16 },
190 'Int24Parser' : {'size': 24 },
191 'Int32Parser' : {'size': 32 },
192 'Int64Parser' : {'size': 64 },
193 'UInt16LSBParser' : {'size': 16 },
194 'UInt24LSBParser' : {'size': 24 },
195 'UInt32LSBParser' : {'size': 32 },
196 'UInt64LSBParser' : {'size': 64 },
197 'Int16LSBParser' : {'size': 16 },
198 'Int24LSBParser' : {'size': 24 },
199 'Int32LSBParser' : {'size': 32 },
200 'Int64LSBParser' : {'size': 64 },
201 'MACAddressParser': {'size': 48 },
202 'INet4AddressParser' : {'size': 32 },
203 'INet6AddressParser' : {'size': 128 },
204 'VoidPacketParser' : {'size': 0 },
207 def parse_FIELD(args, flags):
208 args = [ arg.strip() for arg in args.split(',') ]
210 sys.stderr.write("Failed to parse FIELD: %s\n" % args)
212 field = dict(FIELD_TYPES.get(args[1].split(':')[-1], {}))
213 field['name'] = args[0]
216 def parse_PRIVATE_FIELD(args, flags):
217 return parse_FIELD(args, flags)
219 def parse_FIELD_RO(args, flags):
220 return parse_FIELD(args, flags)
222 def parse_BITFIELD(args, flags):
223 args = [ arg.strip() for arg in args.split(',') ]
225 sys.stderr.write("Failed to parse BITFIELD: %s\n" % args)
230 sys.stderr.write("Failed to parse BITFIELD: %s\n" % args)
232 return { 'size' : size, 'name' : args[0] }
234 def parse_PRIVATE_BITFIELD(args, flags):
235 return parse_BITFIELD(args, flags)
237 def parse_BITFIELD_RO(args, flags):
238 return parse_BITFIELD(args, flags)
240 def parse_SKIP(args, flags):
241 args = args.split(',')[0]
243 bytes = int(args.strip())
245 sys.stderr.write("Failed to parse SKIP: %s\n" % args)
247 return { 'size': 8*bytes, 'name': '' }
249 def parse_SKIP_BITS(args, flags):
251 bits = int(args.strip())
253 sys.stderr.write("Failed to parse SKIP_BITS: %s\n" % args)
255 return { 'size': bits, 'name': '' }
257 def parse_VECTOR(args, flags):
258 args = [ arg.strip() for arg in args.split(',') ]
260 sys.stderr.write("Failed to aprse VECTOR: %s\n" % args)
262 field = dict(FIELD_TYPES.get(args[-1].split(':')[-1], {}))
263 field['name'] = args[0]
264 field['repeat'] = True
267 def parse_LIST(args, flags):
268 return parse_VECTOR(args, flags)
270 VARIANT_FIELD_RE_STR = r"""
277 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
285 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
291 key\(\s*[^,]*,\s*([a-zA-Z0-9_:]+)\s*\)
296 VARIANT_FIELD_RE = re.compile(VARIANT_FIELD_RE_STR, re.X)
297 VARIANT_FIELDS_RE = re.compile(",\s*((?:%s\s*)+)$" % VARIANT_FIELD_RE_STR, re.X)
299 def parse_VARIANT(args, flags):
300 name = args.split(',',1)[0].strip()
301 fields_match = VARIANT_FIELDS_RE.search(args)
303 return { 'name': name }
304 fields_str = fields_match.group(1)
308 for field_match in VARIANT_FIELD_RE.finditer(fields_str):
309 parser = ([ group for group in field_match.groups() if group ] + [ None ])[0]
310 field = dict(FIELD_TYPES.get(parser.split(':')[-1], {}))
311 if field.has_key('minsize'):
312 if minsize is None or field['minsize'] < minsize:
313 minsize = field['minsize']
314 if maxsize is None or field['maxsize'] > maxsize:
315 maxsize = field['maxsize']
316 elif field.has_key('size'):
317 if field['size'] == 0:
320 if minsize is None or field['size'] < minsize:
321 minsize = field['size']
322 if maxsize is None or field['size'] > maxsize:
323 maxsize = field['size']
324 if minsize is not None and minsize == maxsize:
325 return { 'name': name, 'size': minsize, 'optional': optional }
326 elif minsize is not None:
327 return { 'name': name, 'minsize': minsize, 'maxsize': maxsize, 'optional': optional }
329 return { 'name': name, 'optional': optional }
331 def parse_PRIVATE_VARIANT(args, flags):
332 return parse_VARIANT(args, flags)
334 def parse_INIT(args, flags):
337 PARSER_START_RE = re.compile(r"#\s*include\s+SENF_(FIXED_)?PARSER\s*\(\s*\)")
338 PARSER_END_RE = re.compile(r"SENF_PARSER_FINALIZE\s*\(([^)]*)\)\s*;")
339 PARSER_FIELD_RE = re.compile(r"(?://>pkgdraw:(.*)$\s*)?SENF_PARSER_([A-Z_]+)\s*\(([^;]*)\)\s*;(?:\s*//<pkgdraw:(.*)$)?", re.M)
341 def scanPackets(data):
345 start = PARSER_START_RE.search(data, end)
346 if not start: return packets
348 end = PARSER_END_RE.search(data, start)
349 if not end: return packets
350 name=end.group(1).strip()
352 packets[name] = scanFields(data[start:end])
354 def scanFields(data):
356 for match in PARSER_FIELD_RE.finditer(data):
358 flags = dict([ ([ arg.strip() for arg in flag.strip().split('=',1) ]+[True])[:2]
359 for flag in ((match.group(1) or '')+(match.group(4) or '')).split(',') ])
360 if flags.has_key('hide') : continue
361 parser = globals().get("parse_%s" % tp, None)
363 field = parser(match.group(3).strip(), flags)
365 if flags.has_key('name') : field['name'] = flags['name']
366 field['name'] = field['name'].strip('_')
369 sys.stderr.write("Unknown parser type: %s\n" % tp)
372 tmpdir = tempfile.mkdtemp(prefix="pkgdraw_")
376 shutil.rmtree(tmpdir)
378 signal.signal(signal.SIGINT, cleanup)
379 signal.signal(signal.SIGTERM, cleanup)
380 signal.signal(signal.SIGHUP, cleanup)
381 atexit.register(cleanup)
383 data = scanPackets(stripComments(sys.stdin.read()))
385 texf = file(os.path.join(tmpdir, "fields.tex"),"w")
386 texf.write(TEX_HEADER)
388 if len(sys.argv) > 1:
395 texf.write("\\textbf{%s}\n\\bigskip\\par\n" % texquote(name))
396 texf.write(PACKET_HEADER)
397 texf.write(makeTex(formatPacket(32, data[name])))
398 texf.write(PACKET_FOOTER)
400 texf.write(TEX_FOOTER)
403 if os.system("cd %s; %s/textogif -png -dpi 80 -res 0.25 fields >pkgdraw.log 2>&1"
404 % (tmpdir, basedir)) != 0:
405 sys.stderr.write("Conversion failed. See %s\n" % tmpdir)
408 sys.stdout.write(file(os.path.join(tmpdir, "fields.png")).read())