From e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 22:34:10 +0200 Subject: Adding upstream version 4.2.2. Signed-off-by: Daniel Baumann --- tools/wireshark_gen.py | 2789 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2789 insertions(+) create mode 100755 tools/wireshark_gen.py (limited to 'tools/wireshark_gen.py') diff --git a/tools/wireshark_gen.py b/tools/wireshark_gen.py new file mode 100755 index 00000000..cf16f1f1 --- /dev/null +++ b/tools/wireshark_gen.py @@ -0,0 +1,2789 @@ +# -*- python -*- +# +# wireshark_gen.py (part of idl2wrs) +# +# Author : Frank Singleton (frank.singleton@ericsson.com) +# +# Copyright (C) 2001 Frank Singleton, Ericsson Inc. +# +# This file is a backend to "omniidl", used to generate "Wireshark" +# dissectors from CORBA IDL descriptions. The output language generated +# is "C". It will generate code to use the GIOP/IIOP get_CDR_XXX API. +# +# Please see packet-giop.h in Wireshark distro for API description. +# Wireshark is available at https://www.wireshark.org/ +# +# Omniidl is part of the OmniOrb distribution, and is available at +# http://omniorb.sourceforge.net +# +# SPDX-License-Identifier: GPL-2.0-or-later + + +# Description: +# +# Omniidl Back-end which parses an IDL list of "Operation" nodes +# passed from wireshark_be2.py and generates "C" code for compiling +# as a dissector for Wireshark. +# +# +# Strategy (sneaky but ...) +# +# problem: I don't know what variables to declare until AFTER the helper functions +# have been built, so ... +# +# There are 2 passes through genHelpers, the first one is there just to +# make sure the fn_hash data struct is populated properly. +# The second pass is the real thing, generating code and declaring +# variables (from the 1st pass) properly. + + +"""Wireshark IDL compiler back-end.""" + +from __future__ import print_function + +import collections +import tempfile +import string +import random + +from omniidl import idlast, idltype, idlutil, output + + +# Output class, generates "C" src code for the sub-dissector +# +# in: +# +# +# self - me +# st - output stream +# node - a reference to an Operations object. +# name - scoped name (Module::Module::Interface:: .. ::Operation + + + +# TODO -- FS +# +# 1. generate hf[] data for searchable fields (but what is searchable?) [done, could be improved] +# 2. add item instead of add_text() [done] +# 3. sequence handling [done] +# 4. User Exceptions [done] +# 5. Fix arrays, and structs containing arrays [done] +# 6. Handle pragmas. +# 7. Exception can be common to many operations, so handle them outside the +# operation helper functions [done] +# 8. Automatic variable declaration [done, improve, still get some collisions.add variable delegator function ] +# For example, mutlidimensional arrays. +# 9. wchar and wstring handling [giop API needs improving] +# 10. Support Fixed [done] +# 11. Support attributes (get/set) [started, needs language mapping option, perhaps wireshark GUI option +# to set the attribute function prefix or suffix ? ] For now the prefix is "_get" and "_set" +# eg: attribute string apple => _get_apple and _set_apple +# +# 12. Implement IDL "union" code [done] +# 13. Implement support for plugins [done] +# 14. Don't generate code for empty operations (cf: exceptions without members) +# 15. Generate code to display Enums numerically and symbolically [done] +# 16. Place structs/unions in subtrees [done] +# 17. Recursive struct and union handling [done] +# 18. Improve variable naming for display (eg: structs, unions etc) [done] +# +# Also test, Test, TEST + + +# Strategy: +# For every operation and attribute do +# For return val and all parameters do +# find basic IDL type for each parameter +# output get_CDR_xxx +# output exception handling code +# output attribute handling code + + +class wireshark_gen_C: + + # Some string constants for our templates + c_u_octet8 = "guint64 u_octet8;" + c_s_octet8 = "gint64 s_octet8;" + c_u_octet4 = "guint32 u_octet4;" + c_s_octet4 = "gint32 s_octet4;" + c_u_octet2 = "guint16 u_octet2;" + c_s_octet2 = "gint16 s_octet2;" + c_u_octet1 = "guint8 u_octet1;" + c_s_octet1 = "gint8 s_octet1;" + + c_float = "gfloat my_float;" + c_double = "gdouble my_double;" + + c_seq = "const gchar *seq = NULL;" # pointer to buffer of gchars + c_i = "guint32 i_" # loop index + c_i_lim = "guint32 u_octet4_loop_" # loop limit + c_u_disc = "guint32 disc_u_" # unsigned int union discriminant variable name (enum) + c_s_disc = "gint32 disc_s_" # signed int union discriminant variable name (other cases, except Enum) + + def __init__(self, st, protocol_name, dissector_name, description, debug=False, aggressive=False): + self.DEBUG = debug + self.AGGRESSIVE = aggressive + + self.st = output.Stream(tempfile.TemporaryFile(mode="w"), 4) # for first pass only + + self.st_save = st # where 2nd pass should go + self.protoname = protocol_name # Protocol Name (eg: ECHO) + self.dissname = dissector_name # Dissector name (eg: echo) + self.description = description # Detailed Protocol description (eg: Echo IDL Example) + self.exlist = [] # list of exceptions used in operations. + #self.curr_sname # scoped name of current opnode or exnode I am visiting, used for generating "C" var declares + self.fn_hash = {} # top level hash to contain key = function/exception and val = list of variable declarations + # ie a hash of lists + self.fn_hash_built = 0 # flag to indicate the 1st pass is complete, and the fn_hash is correctly + # populated with operations/vars and exceptions/vars + + def genCode(self, oplist, atlist, enlist, stlist, unlist): # operation, attribute, enums, struct and union lists + """Main entry point, controls sequence of generated code.""" + + # sneaky .. call it now, to populate the fn_hash + # so when I come to that exception later, I have the variables to + # declare already. + + # need to reverse the lists, so that the functions of the current IDL + # is properly processed, otherwise the first name wise declaration of + # an include is taken for the function generation. Same counts for + # structs and unions. + oplist = oplist[::-1] + stlist = stlist[::-1] + enlist = enlist[::-1] + unlist = unlist[::-1] + + + self.genHelpers(oplist, stlist, unlist) + self.genExceptionHelpers(oplist) + self.genAttributeHelpers(atlist) + + self.fn_hash_built = 1 # DONE, so now I know , see genOperation() + + self.st = self.st_save + self.genHeader() # initial dissector comments + self.genWrsCopyright() + self.genGPL() + self.genIncludes() + self.genPrototype() + self.genProtocol() + self.genDeclares(oplist, atlist, enlist, stlist, unlist) + if len(atlist) > 0: + self.genAtList(atlist) # string constant declares for Attributes + if len(enlist) > 0: + self.genEnList(enlist) # string constant declares for Enums + if len(unlist) > 0: + self.genUnList(unlist) + + self.genExceptionHelpers(oplist) # helper function to decode user exceptions that have members + self.genExceptionDelegator(oplist) # finds the helper function to decode a user exception + if len(atlist) > 0: + self.genAttributeHelpers(atlist) # helper function to decode "attributes" + + self.genHelpers(oplist, stlist, unlist) # operation, struct and union decode helper functions + + self.genMainEntryStart(oplist) + self.genOpDelegator(oplist) + self.genAtDelegator(atlist) + self.genMainEntryEnd() + + self.gen_proto_register(oplist, atlist, stlist, unlist) + self.gen_proto_reg_handoff(oplist) + # All the dissectors are now built-in + #self.gen_plugin_register() + if self.DEBUG: + self.dumpvars() # debug + self.genModelines() + + def genHeader(self): + """Generate Standard Wireshark Header Comments""" + self.st.out(self.template_Header, dissector_name=self.dissname) + if self.DEBUG: + print("//XXX genHeader") + + def genWrsCopyright(self): + if self.DEBUG: + print("//XXX genWrsCopyright") + self.st.out(self.template_wireshark_copyright) + + def genModelines(self): + if self.DEBUG: + print("//XXX genModelines") + + self.st.out(self.template_Modelines) + + def genGPL(self): + if self.DEBUG: + print("//XXX genGPL") + + self.st.out(self.template_GPL) + + def genIncludes(self): + if self.DEBUG: + print("//XXX genIncludes") + + self.st.out(self.template_Includes) + + def genOpDeclares(self, op): + """" Generate hf variables for operation filters + + in: opnode ( an operation node) + """ + + if self.DEBUG: + print("//XXX genOpDeclares") + print("//XXX return type = ", op.returnType().kind()) + + sname = self.namespace(op, "_") + rt = op.returnType() + + if rt.kind() != idltype.tk_void: + if rt.kind() == idltype.tk_alias: # a typdef return val possibly ? + #self.get_CDR_alias(rt, rt.name()) + if rt.unalias().kind() == idltype.tk_sequence: + self.st.out(self.template_hf, name=sname + "_return_loop") + if self.isSeqNativeType(rt.unalias().seqType()) or self.AGGRESSIVE: + self.st.out(self.template_hf, name=sname + "_return") + elif (rt.unalias().kind() != idltype.tk_struct and + rt.unalias().kind() != idltype.tk_objref and + rt.unalias().kind() != idltype.tk_any): + self.st.out(self.template_hf, name=sname + "_return") + + elif (rt.kind() != idltype.tk_struct and + rt.kind() != idltype.tk_objref and + rt.kind() != idltype.tk_union and + rt.kind() != idltype.tk_any): + self.st.out(self.template_hf, name=sname + "_return") + + for p in op.parameters(): + if p.paramType().unalias().kind() == idltype.tk_sequence: + self.st.out(self.template_hf, name=sname + "_" + p.identifier() + "_loop") + if (self.isSeqNativeType(p.paramType().unalias().seqType())) or self.AGGRESSIVE: + self.st.out(self.template_hf, name=sname + "_" + p.identifier()) + elif (p.paramType().unalias().kind() != idltype.tk_any and + p.paramType().unalias().kind() != idltype.tk_struct and + p.paramType().unalias().kind() != idltype.tk_objref and + p.paramType().unalias().kind() != idltype.tk_union): + if p.paramType().unalias().kind() == idltype.tk_wchar: + self.st.out(self.template_hf, name=sname + "_" + p.identifier() + "_len") + self.st.out(self.template_hf, name=sname + "_" + p.identifier()) + + def genAtDeclares(self, at): + """Generate hf variables for attributes + + in: at ( an attribute) + """ + + if self.DEBUG: + print("//XXX genAtDeclares") + + for decl in at.declarators(): + sname = self.namespace(decl, "_") + + self.st.out(self.template_hf, name="get" + "_" + sname + "_" + decl.identifier()) + if self.AGGRESSIVE: + self.st.out(self.template_hf, name="get" + "_" + sname + "_" + decl.identifier()+"_loop") + if not at.readonly(): + self.st.out(self.template_hf, name="set" + "_" + sname + "_" + decl.identifier()) + if self.AGGRESSIVE: + self.st.out(self.template_hf, name="set" + "_" + sname + "_" + decl.identifier()+"_loop") + + def genStDeclares(self, st): + """Generate hf variables for structs + + in: st ( a struct) + """ + + if self.DEBUG: + print("//XXX genStDeclares") + + sname = self.namespace(st, "_") + + for m in st.members(): + if (self.isSeqNativeType(m.memberType()) + or m.memberType().unalias().kind() == idltype.tk_sequence + or m.memberType().unalias().kind() == idltype.tk_alias): + for decl in m.declarators(): + if m.memberType().unalias().kind() == idltype.tk_sequence: + self.st.out(self.template_hf, name=sname + "_" + decl.identifier() + "_loop") + if (self.isSeqNativeType(m.memberType().unalias().seqType())) or self.AGGRESSIVE: + self.st.out(self.template_hf, name=sname + "_" + decl.identifier()) + else: + if m.memberType().unalias().kind() == idltype.tk_wchar: + self.st.out(self.template_hf, name=sname + "_" + decl.identifier() + "_len") + self.st.out(self.template_hf, name=sname + "_" + decl.identifier()) + + def genExDeclares(self, ex): + """Generate hf variables for user exception filters + + in: exnode ( an exception node) + """ + + if self.DEBUG: + print("//XXX genExDeclares") + + sname = self.namespace(ex, "_") + + for m in ex.members(): + for decl in m.declarators(): + if m.memberType().unalias().kind() == idltype.tk_sequence: + if self.isSeqNativeType(m.memberType().unalias().seqType()): + self.st.out(self.template_hf, name=sname + "_" + decl.identifier()) + self.st.out(self.template_hf, name=sname + "_" + decl.identifier() + "_loop") + elif m.memberType().unalias().kind() != idltype.tk_struct: + self.st.out(self.template_hf, name=sname + "_" + decl.identifier()) + + def genUnionDeclares(self, un): + """Generate hf variables for union filters + + in: un ( an union) + """ + + if self.DEBUG: + print("//XXX genUnionDeclares") + + sname = self.namespace(un, "_") + self.st.out(self.template_hf, name=sname + "_" + un.identifier()) + + for uc in un.cases(): # for all UnionCase objects in this union + # TODO: Is this loop necessary? cl is not used + for cl in uc.labels(): # for all Caselabel objects in this UnionCase + if uc.caseType().unalias().kind() == idltype.tk_sequence: + self.st.out(self.template_hf, name=sname + "_" + uc.declarator().identifier() + "_loop") + if self.isSeqNativeType(uc.caseType().unalias().seqType()): + self.st.out(self.template_hf, name=sname + "_" + uc.declarator().identifier()) + elif self.isSeqNativeType(uc.caseType()): + if uc.caseType().unalias().kind() == idltype.tk_wchar: + self.st.out(self.template_hf, name=sname + "_" + uc.declarator().identifier() + "_len") + self.st.out(self.template_hf, name=sname + "_" + uc.declarator().identifier()) + + def genExpertInfoDeclares(self): + """Generate ei variables for expert info filters""" + if self.DEBUG: + print("//XXX genExpertInfoDeclares") + + self.st.out(self.template_proto_register_ei_filters, dissector_name=self.dissname) + + def genDeclares(self, oplist, atlist, enlist, stlist, unlist): + """generate function prototypes if required + + Currently this is used for struct and union helper function declarations. + """ + + if self.DEBUG: + print("//XXX genDeclares") + + # prototype for operation filters + self.st.out(self.template_hf_operations) + + # operation specific filters + if len(oplist) > 0: + self.st.out(self.template_proto_register_op_filter_comment) + for op in oplist: + self.genOpDeclares(op) + + # attribute filters + if len(atlist) > 0: + self.st.out(self.template_proto_register_at_filter_comment) + for at in atlist: + self.genAtDeclares(at) + + # struct filters + if len(stlist) > 0: + self.st.out(self.template_proto_register_st_filter_comment) + for st in stlist: + self.genStDeclares(st) + + # exception List filters + exlist = self.get_exceptionList(oplist) # grab list of exception nodes + if len(exlist) > 0: + self.st.out(self.template_proto_register_ex_filter_comment) + for ex in exlist: + if ex.members(): # only if has members + self.genExDeclares(ex) + + # union filters + if len(unlist) > 0: + self.st.out(self.template_proto_register_un_filter_comment) + for un in unlist: + self.genUnionDeclares(un) + + # expert info filters + self.genExpertInfoDeclares() + + # prototype for start_dissecting() + + self.st.out(self.template_prototype_start_dissecting) + + # struct prototypes + + if len(stlist): + self.st.out(self.template_prototype_struct_start) + for st in stlist: + #print st.repoId() + sname = self.namespace(st, "_") + self.st.out(self.template_prototype_struct_body, stname=st.repoId(), name=sname) + + self.st.out(self.template_prototype_struct_end) + + # union prototypes + if len(unlist): + self.st.out(self.template_prototype_union_start) + for un in unlist: + sname = self.namespace(un, "_") + self.st.out(self.template_prototype_union_body, unname=un.repoId(), name=sname) + self.st.out(self.template_prototype_union_end) + + def genPrototype(self): + self.st.out(self.template_prototype, dissector_name=self.dissname) + + def genProtocol(self): + self.st.out(self.template_protocol, dissector_name=self.dissname) + self.st.out(self.template_init_boundary) + + + def genMainEntryStart(self, oplist): + self.st.out(self.template_main_dissector_start, dissname=self.dissname, disprot=self.protoname) + self.st.inc_indent() + self.st.out(self.template_main_dissector_switch_msgtype_start) + self.st.out(self.template_main_dissector_switch_msgtype_start_request_reply) + self.st.inc_indent() + + def genMainEntryEnd(self): + + self.st.out(self.template_main_dissector_switch_msgtype_end_request_reply) + self.st.dec_indent() + self.st.out(self.template_main_dissector_switch_msgtype_all_other_msgtype) + self.st.dec_indent() + self.st.out(self.template_main_dissector_end) + + + # NOTE: Mapping of attributes to operation(function) names is tricky. + # + # The actual accessor function names are language-mapping specific. The attribute name + # is subject to OMG IDL's name scoping rules; the accessor function names are + # guaranteed not to collide with any legal operation names specifiable in OMG IDL. + # + # eg: + # + # static const char get_Penguin_Echo_get_width_at[] = "get_width" ; + # static const char set_Penguin_Echo_set_width_at[] = "set_width" ; + # + # or: + # + # static const char get_Penguin_Echo_get_width_at[] = "_get_width" ; + # static const char set_Penguin_Echo_set_width_at[] = "_set_width" ; + # + # TODO: Implement some language dependent templates to handle naming conventions + # language <=> attribute. for C, C++. Java etc + # + # OR, just add a runtime GUI option to select language binding for attributes -- FS + + def genAtList(self, atlist): + """in: atlist + + out: C code for IDL attribute decalarations. + + ie: def genAtlist(self,atlist,language) + """ + + self.st.out(self.template_comment_attributes_start) + + for n in atlist: + for i in n.declarators(): # + sname = self.namespace(i, "_") + atname = i.identifier() + self.st.out(self.template_attributes_declare_Java_get, sname=sname, atname=atname) + if not n.readonly(): + self.st.out(self.template_attributes_declare_Java_set, sname=sname, atname=atname) + + self.st.out(self.template_comment_attributes_end) + + def genEnList(self, enlist): + """in: enlist + + out: C code for IDL Enum decalarations using "static const value_string" template + """ + + self.st.out(self.template_comment_enums_start) + + for enum in enlist: + sname = self.namespace(enum, "_") + + self.st.out(self.template_comment_enum_comment, ename=enum.repoId()) + self.st.out(self.template_value_string_start, valstringname=sname) + for enumerator in enum.enumerators(): + self.st.out(self.template_value_string_entry, + intval=str(self.valFromEnum(enum, enumerator)), + description=enumerator.identifier()) + + #atname = n.identifier() + self.st.out(self.template_value_string_end, valstringname=sname) + + self.st.out(self.template_comment_enums_end) + + def genUnList(self, unlist): + """in: unlist + + out: C code for IDL Union declarations using "static const value_string template + """ + + + for un in unlist: + if un.switchType().kind() == idltype.tk_enum: + continue # skip enums since they already have value-strings + sname = self.namespace(un, "_") + self.st.out(self.template_value_string_start, valstringname=sname) + for uc in un.cases(): + for cl in uc.labels(): + val = cl.value() + self.st.out(self.template_value_string_entry, + intval=str(val), + description=uc.declarator().identifier()) + self.st.out(self.template_value_string_end, valstringname=sname) + + + + + def genExceptionDelegator(self, oplist): + """in: oplist + + out: C code for User exception delegator + """ + + self.st.out(self.template_main_exception_delegator_start) + self.st.inc_indent() + + exlist = self.get_exceptionList(oplist) # grab list of ALL UNIQUE exception nodes + + for ex in exlist: + if self.DEBUG: + print("//XXX Exception ", ex.repoId()) + print("//XXX Exception Identifier", ex.identifier()) + print("//XXX Exception Scoped Name", ex.scopedName()) + + if ex.members(): # only if has members + sname = self.namespace(ex, "_") + self.st.out(self.template_ex_delegate_code, sname=sname, exname=ex.repoId()) + + self.st.dec_indent() + self.st.out(self.template_main_exception_delegator_end) + + def genAttributeHelpers(self, atlist): + """Generate private helper functions to decode Attributes. + + in: atlist + + For readonly attribute - generate get_xxx() + If NOT readonly attribute - also generate set_xxx() + """ + + if self.DEBUG: + print("//XXX genAttributeHelpers: atlist = ", atlist) + + self.st.out(self.template_attribute_helpers_start) + + for attrib in atlist: + for decl in attrib.declarators(): + self.genAtHelper(attrib, decl, "get") # get accessor + if not attrib.readonly(): + self.genAtHelper(attrib, decl, "set") # set accessor + + self.st.out(self.template_attribute_helpers_end) + + def genAtHelper(self, attrib, decl, order): + """Generate private helper functions to decode an attribute + + in: at - attribute node + in: decl - declarator belonging to this attribute + in: order - to generate a "get" or "set" helper + """ + + if self.DEBUG: + print("//XXX genAtHelper") + + sname = order + "_" + self.namespace(decl, "_") # must use set or get prefix to avoid collision + self.curr_sname = sname # update current opnode/exnode scoped name + + if not self.fn_hash_built: + self.fn_hash[sname] = [] # init empty list as val for this sname key + # but only if the fn_hash is not already built + + self.st.out(self.template_attribute_helper_function_start, sname=sname, atname=decl.repoId()) + self.st.inc_indent() + attr_type = attrib.attrType() + if self.DEBUG: + print("//XXX attrib = ", attrib) + print("//XXX attrib.attrType.unalias.kind = ", attr_type.unalias().kind()) + + if self.isItemVarType(attr_type): + self.st.out(self.template_proto_item) + + if len(self.fn_hash[sname]) > 0: + self.st.out(self.template_helper_function_vars_start) + self.dumpCvars(sname) + self.st.out(self.template_helper_function_vars_end_item) + + self.getCDR(attr_type, sname + "_" + decl.identifier()) + + self.st.dec_indent() + self.st.out(self.template_attribute_helper_function_end) + + def genExceptionHelpers(self, oplist): + """Generate private helper functions to decode Exceptions used + within operations + + in: oplist + """ + + exlist = self.get_exceptionList(oplist) # grab list of exception nodes + if self.DEBUG: + print("//XXX genExceptionHelpers: exlist = ", exlist) + + self.st.out(self.template_exception_helpers_start) + for ex in exlist: + if ex.members(): # only if has members + #print("//XXX Exception = " + ex.identifier()) + self.genExHelper(ex) + + self.st.out(self.template_exception_helpers_end) + + def genExHelper(self, ex): + """Generate private helper functions to decode User Exceptions + + in: exnode ( an exception node) + """ + + if self.DEBUG: + print("//XXX genExHelper") + + # check to see if we need an item + need_item = False + for m in ex.members(): + if self.isItemVarType(m.memberType()): + need_item = True + break + + sname = self.namespace(ex, "_") + self.curr_sname = sname # update current opnode/exnode scoped name + if not self.fn_hash_built: + self.fn_hash[sname] = [] # init empty list as val for this sname key + # but only if the fn_hash is not already built + + self.st.out(self.template_exception_helper_function_start, sname=sname, exname=ex.repoId()) + self.st.inc_indent() + if need_item: + self.st.out(self.template_proto_item) + + if len(self.fn_hash[sname]) > 0: + self.st.out(self.template_helper_function_vars_start) + self.dumpCvars(sname) + if need_item: + self.st.out(self.template_helper_function_vars_end_item) + else: + self.st.out(self.template_helper_function_vars_end) + + for m in ex.members(): + if self.DEBUG: + print("//XXX genExhelper, member = ", m, "member type = ", m.memberType()) + + for decl in m.declarators(): + if self.DEBUG: + print("//XXX genExhelper, d = ", decl) + + if decl.sizes(): # an array + arr_nonce = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(12)) + indices = self.get_indices_from_sizes(decl.sizes()) + string_indices = '%i ' % indices # convert int to string + self.st.out(self.template_get_CDR_array_comment, aname=decl.identifier(), asize=string_indices) + self.st.out(self.template_get_CDR_array_start, nonce=arr_nonce, aname=decl.identifier(), aval=string_indices) + self.st.inc_indent() + self.addvar(self.c_i + decl.identifier() + ";") + + self.st.inc_indent() + self.getCDR(m.memberType(), sname + "_" + decl.identifier()) + + self.st.dec_indent() + self.st.dec_indent() + self.st.out(self.template_get_CDR_array_end, nonce=arr_nonce) + + else: + self.getCDR(m.memberType(), sname + "_" + decl.identifier()) + + self.st.dec_indent() + self.st.out(self.template_exception_helper_function_end) + + def genHelpers(self, oplist, stlist, unlist): + """Generate private helper functions + + Generate private helper functions for each IDL operation. + Generate private helper functions for each IDL struct. + Generate private helper functions for each IDL union. + + + in: oplist, stlist, unlist + """ + + for op in oplist: + self.genOperation(op) + for st in stlist: + self.genStructHelper(st) + for un in unlist: + self.genUnionHelper(un) + + def genOperation(self, opnode): + """Generate private helper functions for a specific IDL operation. + + in: opnode + """ + + if self.DEBUG: + print("//XXX genOperation called") + print("//opnode =", opnode) + print("//repoid =", opnode.repoId()) + + sname = self.namespace(opnode, "_") + if not self.fn_hash_built: + self.fn_hash[sname] = [] # init empty list as val for this sname key + # but only if the fn_hash is not already built + + self.curr_sname = sname # update current opnode's scoped name + opname = opnode.identifier() + + self.st.out(self.template_helper_function_comment, repoid=opnode.repoId()) + + self.st.out(self.template_helper_function_start, sname=sname) + self.st.inc_indent() + + if len(self.fn_hash[sname]) > 0: + self.st.out(self.template_helper_function_vars_start) + self.dumpCvars(sname) + self.st.out(self.template_helper_function_vars_end_item) + + self.st.out(self.template_helper_switch_msgtype_start) + + self.st.out(self.template_helper_switch_msgtype_request_start) + self.st.inc_indent() + self.genOperationRequest(opnode) + self.st.out(self.template_helper_switch_msgtype_request_end) + self.st.dec_indent() + + self.st.out(self.template_helper_switch_msgtype_reply_start) + self.st.inc_indent() + + self.st.out(self.template_helper_switch_rep_status_start) + + self.st.out(self.template_helper_switch_msgtype_reply_no_exception_start) + self.st.inc_indent() + self.genOperationReply(opnode) + self.st.out(self.template_helper_switch_msgtype_reply_no_exception_end) + self.st.dec_indent() + + self.st.out(self.template_helper_switch_msgtype_reply_user_exception_start) + self.st.inc_indent() + self.genOpExceptions(opnode) + self.st.out(self.template_helper_switch_msgtype_reply_user_exception_end) + self.st.dec_indent() + + self.st.out(self.template_helper_switch_msgtype_reply_default_start, dissector_name=self.dissname) + self.st.out(self.template_helper_switch_msgtype_reply_default_end) + + self.st.out(self.template_helper_switch_rep_status_end) + + self.st.dec_indent() + + self.st.out(self.template_helper_switch_msgtype_default_start, dissector_name=self.dissname) + self.st.out(self.template_helper_switch_msgtype_default_end) + + self.st.out(self.template_helper_switch_msgtype_end) + self.st.dec_indent() + + self.st.out(self.template_helper_function_end, sname=sname) + + def genOperationRequest(self, opnode): + """Decode function parameters for a GIOP request message""" + for p in opnode.parameters(): + if p.is_in(): + if self.DEBUG: + print("//XXX parameter = ", p) + print("//XXX parameter type = ", p.paramType()) + print("//XXX parameter type kind = ", p.paramType().kind()) + + self.getCDR(p.paramType(), self.curr_sname + "_" + p.identifier()) + + def genOperationReply(self, opnode): + """Decode function parameters for a GIOP reply message""" + rt = opnode.returnType() # get return type + if self.DEBUG: + print("//XXX genOperationReply") + print("//XXX opnode = ", opnode) + print("//XXX return type = ", rt) + print("//XXX return type.unalias = ", rt.unalias()) + print("//XXX return type.kind() = ", rt.kind()) + + sname = self.namespace(opnode, "_") + + if rt.kind() == idltype.tk_alias: # a typdef return val possibly ? + #self.getCDR(rt.decl().alias().aliasType(),"dummy") # return value maybe a typedef + self.get_CDR_alias(rt, sname + "_return") + #self.get_CDR_alias(rt, rt.name()) + + else: + self.getCDR(rt, sname + "_return") # return value is NOT an alias + + for p in opnode.parameters(): + if p.is_out(): # out or inout + self.getCDR(p.paramType(), self.curr_sname + "_" + p.identifier()) + + #self.st.dec_indent() + + # TODO: this method seems unnecessary + def genOpExceptions(self, opnode): + for ex in opnode.raises(): + if ex.members(): + #print ex.members() + for m in ex.members(): + t = 0 + #print m.memberType(), m.memberType().kind() + + def genOpDelegator(self, oplist): + """Delegator for Operations""" + if len(oplist) == 0: + self.st.out(self.template_no_ops_to_delegate) + for op in oplist: + iname = "/".join(op.scopedName()[:-1]) + opname = op.identifier() + sname = self.namespace(op, "_") + self.st.out(self.template_op_delegate_code, interface=iname, sname=sname, opname=opname) + + def genAtDelegator(self, atlist): + """Delegator for Attributes""" + for a in atlist: + for i in a.declarators(): + sname = self.namespace(i, "_") + self.st.out(self.template_at_delegate_code_get, sname=sname) + if not a.readonly(): + self.st.out(self.template_at_delegate_code_set, sname=sname) + + def addvar(self, var): + """Add a variable declaration to the hash of list""" + if var not in self.fn_hash[self.curr_sname]: + self.fn_hash[self.curr_sname].append(var) + + def dumpvars(self): + """Print the variable declaration from the hash of list""" + for fn in self.fn_hash.keys(): + print("FN = " + fn) + for v in self.fn_hash[fn]: + print("-> " + v) + + def dumpCvars(self, sname): + """Print the "C" variable declaration from the hash of list + for a given scoped operation name (eg: tux_penguin_eat)""" + for v in self.fn_hash[sname]: + self.st.out(v) + + def valFromEnum(self, enumNode, enumeratorNode): + """Given an enum node, and a enumerator node, return the enumerator's numerical value. + + eg: enum Color {red,green,blue} should return + val = 1 for green + """ + + if self.DEBUG: + print("//XXX valFromEnum, enumNode = ", enumNode, " from ", enumNode.repoId()) + print("//XXX valFromEnum, enumeratorNode = ", enumeratorNode, " from ", enumeratorNode.repoId()) + + if isinstance(enumeratorNode, idlast.Enumerator): + value = enumNode.enumerators().index(enumeratorNode) + return value + + +# tk_null = 0 +# tk_void = 1 +# tk_short = 2 +# tk_long = 3 +# tk_ushort = 4 +# tk_ulong = 5 +# tk_float = 6 +# tk_double = 7 +# tk_boolean = 8 +# tk_char = 9 +# tk_octet = 10 +# tk_any = 11 +# tk_TypeCode = 12 +# tk_Principal = 13 +# tk_objref = 14 +# tk_struct = 15 +# tk_union = 16 +# tk_enum = 17 +# tk_string = 18 +# tk_sequence = 19 +# tk_array = 20 +# tk_alias = 21 +# tk_except = 22 +# tk_longlong = 23 +# tk_ulonglong = 24 +# tk_longdouble = 25 +# tk_wchar = 26 +# tk_wstring = 27 +# tk_fixed = 28 +# tk_value = 29 +# tk_value_box = 30 +# tk_native = 31 +# tk_abstract_interface = 32 + + def isSeqNativeType(self, type): + """Return true for "native" datatypes that will generate a direct proto_tree_add_xxx + call for a sequence. Used to determine if a separate hf variable is needed for + the loop over the sequence""" + + pt = type.unalias().kind() # param CDR type + + if self.DEBUG: + print("//XXX isSeqNativeType: kind = ", pt) + + if pt == idltype.tk_ulong: + return 1 + elif pt == idltype.tk_longlong: + return 1 + elif pt == idltype.tk_ulonglong: + return 1 + elif pt == idltype.tk_short: + return 1 + elif pt == idltype.tk_long: + return 1 + elif pt == idltype.tk_ushort: + return 1 + elif pt == idltype.tk_float: + return 1 + elif pt == idltype.tk_double: + return 1 + elif pt == idltype.tk_boolean: + return 1 + elif pt == idltype.tk_octet: + return 1 + elif pt == idltype.tk_enum: + return 1 + elif pt == idltype.tk_string: + return 1 + elif pt == idltype.tk_wstring: + return 1 + elif pt == idltype.tk_wchar: + return 1 + elif pt == idltype.tk_char: + return 1 + else: + return 0 + + def isItemVarType(self, type): + + pt = type.unalias().kind() # param CDR type + + if self.DEBUG: + print("//XXX isItemVarType: kind = ", pt) + inner_pt = None + if pt in [idltype.tk_struct, idltype.tk_fixed, idltype.tk_any]: + return 1 + elif pt == idltype.tk_alias: + inner_pt = type.decl().alias().aliasType().unalias().kind() + elif pt == idltype.tk_sequence: + inner_pt = type.unalias().seqType().unalias().kind() + elif pt == idltype.tk_array: + inner_pt == type.decl().alias().aliasType().unalias().kind() + if inner_pt is not None and inner_pt in \ + [idltype.tk_struct, idltype.tk_fixed, idltype.tk_any]: + return 1 + elif inner_pt in [idltype.tk_alias, idltype.tk_sequence,\ + idltype.tk_array]: + return self.isItemVarType(inner_pt) + return 0 + + def getCDR(self, type, name="fred"): + """This is the main "iterator" function. It takes a node, and tries to output + a get_CDR_XXX accessor method(s). It can call itself multiple times + if it finds nested structures etc.""" + + pt = type.unalias().kind() # param CDR type + pn = name # param name + + if self.DEBUG: + print("//XXX getCDR: kind = ", pt) + print("//XXX getCDR: name = ", pn) + + if pt == idltype.tk_ulong: + self.get_CDR_ulong(pn) + elif pt == idltype.tk_longlong: + self.get_CDR_longlong(pn) + elif pt == idltype.tk_ulonglong: + self.get_CDR_ulonglong(pn) + elif pt == idltype.tk_void: + self.get_CDR_void(pn) + elif pt == idltype.tk_short: + self.get_CDR_short(pn) + elif pt == idltype.tk_long: + self.get_CDR_long(pn) + elif pt == idltype.tk_ushort: + self.get_CDR_ushort(pn) + elif pt == idltype.tk_float: + self.get_CDR_float(pn) + elif pt == idltype.tk_double: + self.get_CDR_double(pn) + elif pt == idltype.tk_fixed: + self.get_CDR_fixed(type.unalias(), pn) + elif pt == idltype.tk_boolean: + self.get_CDR_boolean(pn) + elif pt == idltype.tk_char: + self.get_CDR_char(pn) + elif pt == idltype.tk_octet: + self.get_CDR_octet(pn) + elif pt == idltype.tk_any: + self.get_CDR_any(pn) + elif pt == idltype.tk_string: + self.get_CDR_string(pn) + elif pt == idltype.tk_wstring: + self.get_CDR_wstring(pn) + elif pt == idltype.tk_wchar: + self.get_CDR_wchar(pn) + elif pt == idltype.tk_enum: + #print type.decl() + self.get_CDR_enum(pn, type) + #self.get_CDR_enum(pn) + + elif pt == idltype.tk_struct: + self.get_CDR_struct(type, pn) + elif pt == idltype.tk_TypeCode: # will I ever get here ? + self.get_CDR_TypeCode(pn) + elif pt == idltype.tk_sequence: + if type.unalias().seqType().kind() == idltype.tk_octet: + self.get_CDR_sequence_octet(type, pn) + else: + self.get_CDR_sequence(type, pn) + elif pt == idltype.tk_objref: + self.get_CDR_objref(type, pn) + elif pt == idltype.tk_array: + pass # Supported elsewhere + elif pt == idltype.tk_union: + self.get_CDR_union(type, pn) + elif pt == idltype.tk_alias: + if self.DEBUG: + print("//XXXXX Alias type XXXXX ", type) + self.get_CDR_alias(type, pn) + else: + self.genWARNING("Unknown typecode = " + '%i ' % pt) # put comment in source code + + def get_CDR_ulong(self, pn): + self.st.out(self.template_get_CDR_ulong, hfname=pn) + + def get_CDR_short(self, pn): + self.st.out(self.template_get_CDR_short, hfname=pn) + + def get_CDR_void(self, pn): + self.st.out(self.template_get_CDR_void, hfname=pn) + + def get_CDR_long(self, pn): + self.st.out(self.template_get_CDR_long, hfname=pn) + + def get_CDR_ushort(self, pn): + self.st.out(self.template_get_CDR_ushort, hfname=pn) + + def get_CDR_float(self, pn): + self.st.out(self.template_get_CDR_float, hfname=pn) + + def get_CDR_double(self, pn): + self.st.out(self.template_get_CDR_double, hfname=pn) + + def get_CDR_longlong(self, pn): + self.st.out(self.template_get_CDR_longlong, hfname=pn) + + def get_CDR_ulonglong(self, pn): + self.st.out(self.template_get_CDR_ulonglong, hfname=pn) + + def get_CDR_boolean(self, pn): + self.st.out(self.template_get_CDR_boolean, hfname=pn) + + def get_CDR_fixed(self, type, pn): + if self.DEBUG: + print("//XXXX calling get_CDR_fixed, type = ", type) + print("//XXXX calling get_CDR_fixed, type.digits() = ", type.digits()) + print("//XXXX calling get_CDR_fixed, type.scale() = ", type.scale()) + + string_digits = '%i ' % type.digits() # convert int to string + string_scale = '%i ' % type.scale() # convert int to string + string_length = '%i ' % self.dig_to_len(type.digits()) # how many octets to hilight for a number of digits + + self.st.out(self.template_get_CDR_fixed, hfname=pn, digits=string_digits, scale=string_scale, length=string_length) + self.addvar(self.c_seq) + + def get_CDR_char(self, pn): + self.st.out(self.template_get_CDR_char, hfname=pn) + + def get_CDR_octet(self, pn): + self.st.out(self.template_get_CDR_octet, hfname=pn) + + def get_CDR_any(self, pn): + self.st.out(self.template_get_CDR_any, varname=pn) + + def get_CDR_enum(self, pn, type): + #self.st.out(self.template_get_CDR_enum, hfname=pn) + sname = self.namespace(type.unalias(), "_") + self.st.out(self.template_get_CDR_enum_symbolic, valstringarray=sname, hfname=pn) + self.addvar(self.c_u_octet4) + + def get_CDR_string(self, pn): + self.st.out(self.template_get_CDR_string, hfname=pn) + + def get_CDR_wstring(self, pn): + self.st.out(self.template_get_CDR_wstring, hfname=pn) + self.addvar(self.c_u_octet4) + self.addvar(self.c_seq) + + def get_CDR_wchar(self, pn): + self.st.out(self.template_get_CDR_wchar, hfname=pn) + self.addvar(self.c_s_octet1) + self.addvar(self.c_seq) + + def get_CDR_TypeCode(self, pn): + self.st.out(self.template_get_CDR_TypeCode, varname=pn) + self.addvar(self.c_u_octet4) + + def get_CDR_objref(self, type, pn): + self.st.out(self.template_get_CDR_object) + + def get_CDR_union(self, type, pn): + if self.DEBUG: + print("//XXX Union type =", type, " pn = ", pn) + print("//XXX Union type.decl()", type.decl()) + print("//XXX Union Scoped Name", type.scopedName()) + + # If I am a typedef union {..}; node then find the union node + + if isinstance(type.decl(), idlast.Declarator): + ntype = type.decl().alias().aliasType().decl() + else: + ntype = type.decl() # I am a union node + + if self.DEBUG: + print("//XXX Union ntype =", ntype) + + sname = self.namespace(ntype, "_") + self.st.out(self.template_union_start, name=sname) + + # Output a call to the union helper function so I can handle recursive union also. + + self.st.out(self.template_decode_union, name=sname) + + self.st.out(self.template_union_end, name=sname) + + def getCDR_hf(self, type, desc, filter, hf_name="fred", value_str=None): + """This takes a node, and tries to output the appropriate item for the + hf array.""" + pt = type.unalias().kind() # param CDR type + pn = hf_name # param name + + if self.DEBUG: + print("//XXX getCDR_hf: kind = ", pt) + print("//XXX getCDR_hf: name = ", pn) + + if pt == idltype.tk_ulong: + self.get_CDR_ulong_hf(pn, desc, filter, self.dissname, value_str) + elif pt == idltype.tk_longlong: + self.get_CDR_longlong_hf(pn, desc, filter, self.dissname, value_str) + elif pt == idltype.tk_ulonglong: + self.get_CDR_ulonglong_hf(pn, desc, filter, self.dissname, value_str) + elif pt == idltype.tk_void: + pass # no hf_ variables needed + elif pt == idltype.tk_short: + self.get_CDR_short_hf(pn, desc, filter, self.dissname, value_str) + elif pt == idltype.tk_long: + self.get_CDR_long_hf(pn, desc, filter, self.dissname, value_str) + elif pt == idltype.tk_ushort: + self.get_CDR_ushort_hf(pn, desc, filter, self.dissname, value_str) + elif pt == idltype.tk_float: + self.get_CDR_float_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_double: + self.get_CDR_double_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_fixed: + self.get_CDR_fixed_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_boolean: + self.get_CDR_boolean_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_char: + self.get_CDR_char_hf(pn, desc, filter, self.dissname, value_str) + elif pt == idltype.tk_octet: + self.get_CDR_octet_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_any: + pass # no hf_ variables needed + elif pt == idltype.tk_string: + self.get_CDR_string_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_wstring: + self.get_CDR_wstring_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_wchar: + self.get_CDR_wchar_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_enum: + self.get_CDR_enum_hf(pn, type, desc, filter, self.dissname) + elif pt == idltype.tk_struct: + pass # no hf_ variables needed (should be already contained in struct members) + elif pt == idltype.tk_TypeCode: # will I ever get here ? + self.get_CDR_TypeCode_hf(pn, desc, filter, self.dissname) + elif pt == idltype.tk_sequence: + if type.unalias().seqType().kind() == idltype.tk_octet: + self.get_CDR_sequence_octet_hf(type, pn, desc, filter, self.dissname) + else: + self.get_CDR_sequence_hf(type, pn, desc, filter, self.dissname) + elif pt == idltype.tk_objref: + pass # no object specific hf_ variables used, use generic ones from giop dissector + elif pt == idltype.tk_array: + pass # Supported elsewhere + elif pt == idltype.tk_union: + pass # no hf_ variables needed (should be already contained in union members) + elif pt == idltype.tk_alias: + if self.DEBUG: + print("//XXXXX Alias type hf //XXXXX ", type) + self.get_CDR_alias_hf(type, desc, filter, pn) + else: + self.genWARNING("Unknown typecode = " + '%i ' % pt) # put comment in source code + + def get_CDR_ulong_hf(self, pn, desc, filter, diss, value_str=None): + if value_str: + self.st.out(self.template_get_CDR_ulong_symbolic_hf, valstringarray=value_str, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + else: + self.st.out(self.template_get_CDR_ulong_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_short_hf(self, pn, desc, filter, diss, value_str=None): + if value_str: + self.st.out(self.template_get_CDR_short_symbolic_hf, valstringarray=value_str, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + else: + self.st.out(self.template_get_CDR_short_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_long_hf(self, pn, desc, filter, diss, value_str=None): + if value_str: + self.st.out(self.template_get_CDR_long_symbolic_hf, valstringarray=value_str, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + else: + self.st.out(self.template_get_CDR_long_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_ushort_hf(self, pn, desc, filter, diss, value_str=None): + if value_str: + self.st.out(self.template_get_CDR_ushort_symbolic_hf, valstringarray=value_str, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + else: + self.st.out(self.template_get_CDR_ushort_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_float_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_float_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_double_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_double_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_fixed_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_fixed_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_longlong_hf(self, pn, desc, filter, diss, value_str=None): + if value_str: + self.st.out(self.template_get_CDR_longlong_symbolic_hf, valstringarray=value_str, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + else: + self.st.out(self.template_get_CDR_longlong_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_ulonglong_hf(self, pn, desc, filter, diss, value_str=None): + if value_str: + self.st.out(self.template_get_CDR_ulonglong_symbolic_hf, valstringarray=value_str, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + else: + self.st.out(self.template_get_CDR_ulonglong_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_boolean_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_boolean_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_char_hf(self, pn, desc, filter, diss, value_str=None): + if value_str: + self.st.out(self.template_get_CDR_char_symbolic_hf, valstringarray=value_str, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + else: + self.st.out(self.template_get_CDR_char_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_octet_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_octet_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_enum_hf(self, pn, type, desc, filter, diss): + sname = self.namespace(type.unalias(), "_") + self.st.out(self.template_get_CDR_enum_symbolic_hf, valstringarray=sname, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_string_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_string_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_wstring_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_wstring_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) +# self.addvar(self.c_u_octet4) +# self.addvar(self.c_seq) + + def get_CDR_wchar_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_wchar_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) +# self.addvar(self.c_s_octet1) +# self.addvar(self.c_seq) + + def get_CDR_TypeCode_hf(self, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_TypeCode_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_sequence_octet_hf(self, type, pn, desc, filter, diss): + self.st.out(self.template_get_CDR_sequence_octet_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + + def get_CDR_sequence_hf(self,type,pn,desc,filter,diss): + self.st.out(self.template_get_CDR_sequence_hf, hfname=pn, dissector_name=diss, descname=desc, filtername=filter) + if self.isSeqNativeType(type.unalias().seqType()): + self.getCDR_hf(type.unalias().seqType(), desc, filter, pn) + + def get_CDR_alias_hf(self, type, desc, filter, pn): + if self.DEBUG: + print("//XXX get_CDR_alias_hf, type = ", type, " pn = ", pn) + print("//XXX get_CDR_alias_hf, type.decl() = ", type.decl()) + print("//XXX get_CDR_alias_hf, type.decl().alias() = ", type.decl().alias()) + + decl = type.decl() # get declarator object + + if decl.sizes(): # a typedef array + #indices = self.get_indices_from_sizes(decl.sizes()) + #string_indices = '%i ' % indices # convert int to string + #self.st.out(self.template_get_CDR_array_comment, aname=pn, asize=string_indices) + + #self.st.out(self.template_get_CDR_array_start, aname=pn, aval=string_indices) + #self.addvar(self.c_i + pn + ";") + #self.st.inc_indent() + self.getCDR_hf(type.decl().alias().aliasType(), desc, filter, pn) + + #self.st.dec_indent() + #self.st.out(self.template_get_CDR_array_end) + + else: # a simple typdef + if self.DEBUG: + print("//XXX get_CDR_alias_hf, type = ", type, " pn = ", pn) + print("//XXX get_CDR_alias_hf, type.decl() = ", type.decl()) + + #self.getCDR_hf(type.unalias(), desc, filter, decl.identifier() ) + self.getCDR_hf(type.unalias(), desc, filter, pn) + + def genUnionHelper(self, un): + """Code to generate Union Helper functions + + in: un - a union node + """ + + if self.DEBUG: + print("//XXX genUnionHelper called") + print("//XXX Union type =", un) + print("//XXX Union type.switchType()", un.switchType()) + print("//XXX Union Scoped Name", un.scopedName()) + print("//XXX Union switchType.unalias", un.switchType().unalias()) + print("//XXX Union switchType.unalias.kind", un.switchType().unalias().kind()) + + # check to see if we need an item + un_need_item = False + if un.switchType().unalias().kind() == idltype.tk_enum: + for uc in un.cases(): # for all UnionCase objects in this union + if self.DEBUG: + print("//XXX checking", uc) + if self.isItemVarType(uc.caseType()): + if uc.caseType().unalias().kind() == idltype.tk_sequence: + if uc.caseType().unalias().seqType().kind() == idltype.tk_struct: + un_need_item = True + else: + un_need_item = True + if self.AGGRESSIVE: + un_need_item = True + + if self.DEBUG: + print("//XXX need_item =", un_need_item) + + sname = self.namespace(un, "_") + self.curr_sname = sname # update current opnode/exnode/stnode/unnode scoped name + if not self.fn_hash_built: + self.fn_hash[sname] = [] # init empty list as val for this sname key + # but only if the fn_hash is not already built + + if un_need_item: + self.st.out(self.template_union_helper_function_start_with_item, sname=sname, unname=un.repoId()) + else: + self.st.out(self.template_union_helper_function_start, sname=sname, unname=un.repoId()) + self.st.inc_indent() + + if len(self.fn_hash[sname]) > 0: + self.st.out(self.template_helper_function_vars_start) + self.dumpCvars(sname) + self.st.out(self.template_helper_function_vars_end_item) + + st = un.switchType().unalias() # may be typedef switch type, so find real type + + self.st.out(self.template_comment_union_code_start, uname=un.repoId()) + + self.getCDR(st, sname + "_" + un.identifier()) + + # Depending on what kind of discriminant I come accross (enum,integer,char, + # short, boolean), make sure I cast the return value of the get_XXX accessor + # to an appropriate value. Omniidl idlast.CaseLabel.value() accessor will + # return an integer, or an Enumerator object that is then converted to its + # integer equivalent. + # + # + # NOTE - May be able to skip some of this stuff, but leave it in for now -- FS + # + + if st.kind() == idltype.tk_enum: + std = st.decl() + self.st.out(self.template_comment_union_code_discriminant, uname=std.repoId()) + + # count the number of cases to ensure variable is needed + num = 0 + num_defaults = 0 + for uc in un.cases(): # for all UnionCase objects in this union + num += len(uc.labels()) + for cl in uc.labels(): + if cl.default(): + num_defaults += 1 + + if num != 1 or num_defaults != 1: + self.st.out(self.template_union_code_save_discriminant_enum, discname=un.identifier()) + self.addvar(self.c_s_disc + un.identifier() + ";") + + elif st.kind() == idltype.tk_long: + self.st.out(self.template_union_code_save_discriminant_long, discname=un.identifier()) + self.addvar(self.c_s_disc + un.identifier() + ";") + + elif st.kind() == idltype.tk_ulong: + self.st.out(self.template_union_code_save_discriminant_ulong, discname=un.identifier()) + self.addvar(self.c_s_disc + un.identifier() + ";") + + elif st.kind() == idltype.tk_short: + self.st.out(self.template_union_code_save_discriminant_short, discname=un.identifier()) + self.addvar(self.c_s_disc + un.identifier() + ";") + + elif st.kind() == idltype.tk_ushort: + self.st.out(self.template_union_code_save_discriminant_ushort, discname=un.identifier()) + self.addvar(self.c_s_disc + un.identifier() + ";") + + elif st.kind() == idltype.tk_boolean: + self.st.out(self.template_union_code_save_discriminant_boolean, discname=un.identifier()) + self.addvar(self.c_s_disc + un.identifier() + ";") + + elif st.kind() == idltype.tk_char: + self.st.out(self.template_union_code_save_discriminant_char, discname=un.identifier()) + self.addvar(self.c_s_disc + un.identifier() + ";") + + else: + print("//XXX Unknown st.kind() = ", st.kind()) + + # Loop over all cases in this union + + for uc in un.cases(): # for all UnionCase objects in this union + for cl in uc.labels(): # for all Caselabel objects in this UnionCase + + # get integer value, even if discriminant is + # an Enumerator node + + if isinstance(cl.value(), idlast.Enumerator): + if self.DEBUG: + print("//XXX clv.identifier()", cl.value().identifier()) + print("//XXX clv.repoId()", cl.value().repoId()) + print("//XXX clv.scopedName()", cl.value().scopedName()) + + # find index of enumerator in enum declaration + # eg: RED is index 0 in enum Colors { RED, BLUE, GREEN } + + clv = self.valFromEnum(std, cl.value()) + + else: + clv = cl.value() + + #print "//XXX clv = ",clv + + # if char, don't convert to int, but put inside single quotes so that it is understood by C. + # eg: if (disc == 'b').. + # + # TODO : handle \xxx chars generically from a function or table lookup rather than + # a whole bunch of "if" statements. -- FS + + if st.kind() == idltype.tk_char: + if clv == '\n': + string_clv = "'\\n'" + elif clv == '\t': + string_clv = "'\\t'" + else: + string_clv = "'" + clv + "'" + else: + string_clv = '%i ' % clv + + # If default case, then skp comparison with discriminator + + if not cl.default(): + self.st.out(self.template_comment_union_code_label_compare_start, + discname=un.identifier(), labelval=string_clv) + self.st.inc_indent() + else: + self.st.out(self.template_comment_union_code_label_default_start) + + self.getCDR(uc.caseType(), sname + "_" + uc.declarator().identifier()) + + if not cl.default(): + self.st.dec_indent() + self.st.out(self.template_comment_union_code_label_compare_end) + else: + self.st.out(self.template_comment_union_code_label_default_end) + + self.st.dec_indent() + self.st.out(self.template_union_helper_function_end) + + def get_CDR_alias(self, type, pn): + """Currently, get_CDR_alias is geared to finding typedef""" + if self.DEBUG: + print("//XXX get_CDR_alias, type = ", type, " pn = ", pn) + print("//XXX get_CDR_alias, type.decl() = ", type.decl()) + print("//XXX get_CDR_alias, type.decl().alias() = ", type.decl().alias()) + + decl = type.decl() # get declarator object + + if decl.sizes(): # a typedef array + indices = self.get_indices_from_sizes(decl.sizes()) + string_indices = '%i ' % indices # convert int to string + self.st.out(self.template_get_CDR_array_comment, aname=pn, asize=string_indices) + + arr_nonce = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(12)) + self.st.out(self.template_get_CDR_array_start, nonce=arr_nonce, aname=pn, aval=string_indices) + self.st.inc_indent() + self.addvar(self.c_i + pn + ";") + self.st.inc_indent() + self.getCDR(type.decl().alias().aliasType(), pn) + + self.st.dec_indent() + self.st.dec_indent() + self.st.out(self.template_get_CDR_array_end, nonce=arr_nonce) + + else: # a simple typdef + if self.DEBUG: + print("//XXX type", type.__dict__) + print("//XXX type.unalias()", type.unalias().__dict__) + print("//XXX type.unalias().kind()", type.unalias().kind()) + print("//XXX type.decl()", type.decl().__dict__) + self.getCDR(type.unalias(), pn) + + def get_CDR_struct(self, type, pn): + """Handle structs, including recursive""" + + # If I am a typedef struct {..}; node then find the struct node + + if isinstance(type.decl(), idlast.Declarator): + ntype = type.decl().alias().aliasType().decl() + else: + ntype = type.decl() # I am a struct node + + sname = self.namespace(ntype, "_") + self.st.out(self.template_structure_start, name=sname) + + # Output a call to the struct helper function so I can handle recursive structs also. + + self.st.out(self.template_decode_struct, name=sname) + + self.st.out(self.template_structure_end, name=sname) + + def genStructHelper(self, st): + """Generate private helper functions to decode a struct + + in: stnode ( a struct node) + """ + + if self.DEBUG: + print("//XXX genStructHelper") + + sname = self.namespace(st, "_") + self.curr_sname = sname # update current opnode/exnode/stnode scoped name + if not self.fn_hash_built: + self.fn_hash[sname] = [] # init empty list as val for this sname key + # but only if the fn_hash is not already built + + self.st.out(self.template_struct_helper_function_start, sname=sname, stname=st.repoId()) + self.st.inc_indent() + + if len(self.fn_hash[sname]) > 0: + self.st.out(self.template_helper_function_vars_start) + self.dumpCvars(sname) + self.st.out(self.template_helper_function_vars_end_item) + + for m in st.members(): + for decl in m.declarators(): + if decl.sizes(): # an array + arr_nonce = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(12)) + indices = self.get_indices_from_sizes(decl.sizes()) + string_indices = '%i ' % indices # convert int to string + self.st.out(self.template_get_CDR_array_comment, aname=decl.identifier(), asize=string_indices) + self.st.out(self.template_get_CDR_array_start, nonce=arr_nonce, aname=decl.identifier(), aval=string_indices) + self.st.inc_indent() + self.addvar(self.c_i + decl.identifier() + ";") + + self.st.inc_indent() + self.getCDR(m.memberType(), sname + "_" + decl.identifier()) + self.st.dec_indent() + self.st.dec_indent() + self.st.out(self.template_get_CDR_array_end, nonce=arr_nonce) + + else: + self.getCDR(m.memberType(), sname + "_" + decl.identifier()) + + self.st.dec_indent() + self.st.out(self.template_struct_helper_function_end) + + def get_CDR_sequence(self,type,pn): + """Generate code to access a sequence of a type""" + if self.DEBUG: + print("//XXX get_CDR_sequence") + self.st.out(self.template_get_CDR_sequence_length, seqname=pn) + seq_nonce = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(12)) + self.st.out(self.template_get_CDR_sequence_loop_start, nonce=seq_nonce, seqname=pn) + self.addvar(self.c_i_lim + pn + ";") + self.addvar(self.c_i + pn + ";") + + self.st.inc_indent() + self.st.inc_indent() + self.getCDR(type.unalias().seqType(), pn) # and start all over with the type + self.st.dec_indent() + self.st.dec_indent() + + self.st.out(self.template_get_CDR_sequence_loop_end, nonce=seq_nonce) + + def get_CDR_sequence_octet(self, type, pn): + """Generate code to access a sequence of octet""" + if self.DEBUG: + print("//XXX get_CDR_sequence_octet") + + self.st.out(self.template_get_CDR_sequence_length, seqname=pn) + self.st.out(self.template_get_CDR_sequence_octet, seqname=pn) + self.addvar(self.c_i_lim + pn + ";") + self.addvar("const guint8 * binary_seq_" + pn + ";") + self.addvar("gchar * text_seq_" + pn + ";") + + @staticmethod + def namespace(node, sep): + """in - op node + + out - scoped operation name, using sep character instead of "::" + + eg: Penguin::Echo::echoWString => Penguin_Echo_echoWString if sep = "_" + """ + + sname = idlutil.ccolonName(node.scopedName()).replace('::', sep) + #print("//XXX namespace: sname = " + sname) + return sname + + def gen_plugin_register(self): + """generate code for plugin initialisation""" + self.st.out(self.template_plugin_register, description=self.description, + protocol_name=self.protoname, dissector_name=self.dissname) + + # TODO - make this a command line option + # + # -e explicit + # -h heuristic + + def gen_proto_reg_handoff(self, oplist): + """generate register_giop_user_module code, and register only + unique interfaces that contain operations. Also output + a heuristic register in case we want to use that.""" + + self.st.out(self.template_proto_reg_handoff_start, dissector_name=self.dissname) + self.st.inc_indent() + + for iname in self.get_intlist(oplist): + self.st.out(self.template_proto_reg_handoff_body, dissector_name=self.dissname, + protocol_name=self.protoname, interface=iname) + + self.st.out(self.template_proto_reg_handoff_heuristic, dissector_name=self.dissname, + protocol_name=self.protoname) + self.st.dec_indent() + + self.st.out(self.template_proto_reg_handoff_end) + + def genOp_hf(self, op): + """generate hf_ array element for operation, attribute, enums, struct and union lists""" + sname = self.namespace(op, "_") + opname = sname[sname.find("_")+1:] + opname = opname[:opname.find("_")] + rt = op.returnType() + + if rt.kind() != idltype.tk_void: + if rt.kind() == idltype.tk_alias: # a typdef return val possibly ? + self.getCDR_hf(rt, rt.name(), + opname + "." + op.identifier() + ".return", sname + "_return") + else: + self.getCDR_hf(rt, "Return value", + opname + "." + op.identifier() + ".return", sname + "_return") + + for p in op.parameters(): + self.getCDR_hf(p.paramType(), + p.identifier(), + opname + "." + op.identifier() + "." + p.identifier(), + sname + "_" + p.identifier()) + + def genAt_hf(self, at): + for decl in at.declarators(): + sname = self.namespace(decl, "_") + atname = sname[sname.find("_")+1:] + atname = atname[:atname.find("_")] + + self.getCDR_hf(at.attrType(), decl.identifier(), + atname + "." + decl.identifier() + ".get", "get" + "_" + sname + "_" + decl.identifier()) + if not at.readonly(): + self.getCDR_hf(at.attrType(), decl.identifier(), + atname + "." + decl.identifier() + ".set", "set" + "_" + sname + "_" + decl.identifier()) + + def genSt_hf(self, st): + sname = self.namespace(st, "_") + stname = sname[sname.find("_")+1:] + stname = stname[:stname.find("_")] + for m in st.members(): + for decl in m.declarators(): + self.getCDR_hf(m.memberType(), st.identifier() + "_" + decl.identifier(), + st.identifier() + "." + decl.identifier(), sname + "_" + decl.identifier()) + + def genEx_hf(self, ex): + sname = self.namespace(ex, "_") + exname = sname[sname.find("_")+1:] + exname = exname[:exname.find("_")] + for m in ex.members(): + for decl in m.declarators(): + self.getCDR_hf(m.memberType(), ex.identifier() + "_" + decl.identifier(), + exname + "." + ex.identifier() + "_" + decl.identifier(), sname + "_" + decl.identifier()) + + def genUnion_hf(self, un): + sname = self.namespace(un, "_") + unname = sname[:sname.rfind("_")] + unname = unname.replace("_", ".") + if self.DEBUG: + print("//XXX genUnion_hf") + print("// sname =", sname) + print("// uname =", unname) + + self.getCDR_hf(un.switchType().unalias(), un.identifier(), + unname + "." + un.identifier(), sname + "_" + un.identifier(), sname) + + for uc in un.cases(): # for all UnionCase objects in this union + # TODO: is this loop necessary? + for cl in uc.labels(): # for all Caselabel objects in this UnionCase + self.getCDR_hf(uc.caseType(), un.identifier() + "_" + uc.declarator().identifier(), + unname + "." + un.identifier() + "." + uc.declarator().identifier(), + sname + "_" + uc.declarator().identifier()) + + def gen_proto_register(self, oplist, atlist, stlist, unlist): + """generate proto_register_ code, + + in - oplist[], atlist[], stline[], unlist[] + """ + + self.st.out(self.template_proto_register_start, dissector_name=self.dissname) + + # operation specific filters + self.st.out(self.template_proto_register_op_filter_comment) + for op in oplist: + self.genOp_hf(op) + + # attribute filters + self.st.out(self.template_proto_register_at_filter_comment) + for at in atlist: + self.genAt_hf(at) + + # struct filters + self.st.out(self.template_proto_register_st_filter_comment) + for st in stlist: + if st.members(): # only if has members + self.genSt_hf(st) + + # exception List filters + exlist = self.get_exceptionList(oplist) # grab list of exception nodes + self.st.out(self.template_proto_register_ex_filter_comment) + for ex in exlist: + if ex.members(): # only if has members + self.genEx_hf(ex) + + # Union filters + self.st.out(self.template_proto_register_un_filter_comment) + for un in unlist: + self.genUnion_hf(un) + + self.st.out(self.template_proto_register_end, description=self.description, + protocol_name=self.protoname, dissector_name=self.dissname) + + @staticmethod + def get_intlist(oplist): + """in - oplist[] + + out - a list of unique interface names. This will be used in + register_giop_user_module(dissect_giop_auto, "TEST IDL", "Penguin/Echo" ); so the operation + name must be removed from the scope. And we also only want unique interfaces. + """ + + int_hash = {} # holds a hash of unique interfaces + for op in oplist: + sc = op.scopedName() # eg: penguin,tux,bite + sc1 = sc[:-1] + sn = idlutil.slashName(sc1) # penguin/tux + if sn not in int_hash: + int_hash[sn] = 0 # dummy val, but at least key is unique + ret = list(int_hash.keys()) + ret.sort() + return ret + + def get_exceptionList(self, oplist): + """in - oplist[] + + out - a list of exception nodes (unique). This will be used in + to generate dissect_exception_XXX functions. + """ + + ex_hash = collections.OrderedDict() # holds a hash of unique exceptions. + for op in oplist: + for ex in op.raises(): + if ex not in ex_hash: + ex_hash[ex] = 0 # dummy val, but at least key is unique + if self.DEBUG: + print("//XXX Exception = " + ex.identifier()) + ret = list(ex_hash.keys()) + return ret + + @staticmethod + def get_indices_from_sizes(sizelist): + """Simple function to take a list of array sizes and find the total number of elements + + + eg: temp[4][3] = 12 elements + """ + + val = 1 + for i in sizelist: + val = val * i + + return val + + @staticmethod + def dig_to_len(dignum): + """Determine how many octets contain requested number + of digits for an "fixed" IDL type "on the wire" """ + return (dignum/2) + 1 + + def genTODO(self, message): + self.st.out(self.template_debug_TODO, message=message) + + def genWARNING(self, message): + self.st.out(self.template_debug_WARNING, message=message) + + + # Templates for C code + + template_helper_function_comment = """\ +/* + * @repoid@ + */""" + template_helper_function_vars_start = """\ +/* Operation specific Variable declarations Begin */""" + + template_helper_function_vars_end = """\ +/* Operation specific Variable declarations End */ +""" + template_helper_function_vars_end_item = """\ +/* Operation specific Variable declarations End */ +""" + + template_helper_function_start = """\ +static void +decode_@sname@(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, proto_item *item _U_, int *offset _U_, MessageHeader *header, const gchar *operation _U_, gboolean stream_is_big_endian _U_) +{""" + + template_helper_function_end = """\ +} +""" + + template_proto_reg_handoff_start = """\ +/* register me as handler for these interfaces */ +void proto_reg_handoff_giop_@dissector_name@(void) +{""" + + template_proto_reg_handoff_body = """\ +/* Register for Explicit Dissection */ +register_giop_user_module(dissect_@dissector_name@, \"@protocol_name@\", \"@interface@\", proto_@dissector_name@ ); /* explicit dissector */ +""" + + template_proto_reg_handoff_heuristic = """\ +/* Register for Heuristic Dissection */ +register_giop_user(dissect_@dissector_name@, \"@protocol_name@\" ,proto_@dissector_name@); /* heuristic dissector */ +""" + + template_proto_reg_handoff_end = """\ +} +""" + + template_prototype = """ +void proto_register_giop_@dissector_name@(void); +void proto_reg_handoff_giop_@dissector_name@(void);""" + + # Initialize the protocol + +# template_protocol = """ +#/* Initialise the protocol and subtree pointers */ +#static int proto_@dissector_name@ = -1; +#static gint ett_@dissector_name@ = -1; +#""" + template_protocol = """ +/* Initialise the protocol and subtree pointers */ +static int proto_@dissector_name@ = -1; +static gint ett_@dissector_name@ = -1; +static int ett_giop_struct = -1; +static int ett_giop_sequence = -1; +static int ett_giop_array = -1; +static int ett_giop_union = -1; +""" + + template_init_boundary = """ +/* Initialise the initial Alignment */ +static guint32 boundary = GIOP_HEADER_SIZE; /* initial value */""" + + # plugin_register and plugin_reg_handoff templates + + template_plugin_register = """ +#if 0 + +WS_DLL_PUBLIC_DEF void +plugin_register(void) +{ + if (proto_@dissector_name@ == -1) { + proto_register_giop_@dissector_name@(); + } +} + +WS_DLL_PUBLIC_DEF void +plugin_reg_handoff(void){ + proto_register_handoff_giop_@dissector_name@(); +} +#endif +""" + + template_proto_register_start = """ +/* Register the protocol with Wireshark */ +void proto_register_giop_@dissector_name@(void) +{ + /* setup list of header fields */ + static hf_register_info hf[] = { + /* field that indicates the currently ongoing request/reply exchange */ + {&hf_operationrequest, {"Request_Operation","giop-@dissector_name@.Request_Operation",FT_STRING,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_proto_register_end = """ + }; + + static ei_register_info ei[] = { + { &ei_@dissector_name@_unknown_giop_msg, { "giop-@dissector_name@.unknown_giop_msg", PI_PROTOCOL, PI_WARN, "Unknown GIOP message", EXPFILL }}, + { &ei_@dissector_name@_unknown_exception, { "giop-@dissector_name@.unknown_exception", PI_PROTOCOL, PI_WARN, "Unknown exception", EXPFILL }}, + { &ei_@dissector_name@_unknown_reply_status, { "giop-@dissector_name@.unknown_reply_status", PI_PROTOCOL, PI_WARN, "Unknown reply status", EXPFILL }}, + }; + + /* setup protocol subtree array */ + + static gint *ett[] = { + &ett_@dissector_name@, + &ett_giop_struct, + &ett_giop_sequence, + &ett_giop_array, + &ett_giop_union, + }; + + expert_module_t* expert_@dissector_name@; + + + /* Register the protocol name and description */ + proto_@dissector_name@ = proto_register_protocol(\"@description@\" , \"GIOP/@protocol_name@\", \"giop-@dissector_name@\" ); + proto_register_field_array(proto_@dissector_name@, hf, array_length(hf)); + proto_register_subtree_array(ett, array_length(ett)); + + expert_@dissector_name@ = expert_register_protocol(proto_@dissector_name@); + expert_register_field_array(expert_@dissector_name@, ei, array_length(ei)); +} +""" + + template_proto_register_op_filter_comment = """\ + /* Operation filters */""" + + template_proto_register_at_filter_comment = """\ + /* Attribute filters */""" + + template_proto_register_st_filter_comment = """\ + /* Struct filters */""" + + template_proto_register_ex_filter_comment = """\ + /* User exception filters */""" + + template_proto_register_un_filter_comment = """\ + /* Union filters */""" + + template_proto_register_ei_filters = """\ + /* Expert info filters */ +static expert_field ei_@dissector_name@_unknown_giop_msg = EI_INIT; +static expert_field ei_@dissector_name@_unknown_exception = EI_INIT; +static expert_field ei_@dissector_name@_unknown_reply_status = EI_INIT; +""" + + # template for delegation code + + template_op_delegate_code = """\ +if (strcmp(operation, "@opname@") == 0 + && (!idlname || strcmp(idlname, \"@interface@\") == 0)) { + item = process_RequestOperation(tvb, pinfo, ptree, header, operation); /* fill-up Request_Operation field & info column */ + tree = start_dissecting(tvb, pinfo, ptree, offset); + decode_@sname@(tvb, pinfo, tree, item, offset, header, operation, stream_is_big_endian); + return TRUE; +} +""" + template_no_ops_to_delegate = """\ +// NOTE: this should only appear if your IDL has absolutely no operations +if (!idlname) { + return FALSE; +} +""" + # Templates for the helper functions + + template_helper_switch_msgtype_start = """\ +switch(header->message_type) {""" + + template_helper_switch_msgtype_default_start = """\ +default: + /* Unknown GIOP Message */ + expert_add_info_format(pinfo, item, &ei_@dissector_name@_unknown_giop_msg, "Unknown GIOP message %d", header->message_type);""" + + template_helper_switch_msgtype_default_end = """\ + break;""" + + template_helper_switch_msgtype_end = """\ +} /* switch(header->message_type) */""" + + template_helper_switch_msgtype_request_start = """\ +case Request:""" + + template_helper_switch_msgtype_request_end = """\ +break;""" + + template_helper_switch_msgtype_reply_start = """\ +case Reply:""" + + template_helper_switch_msgtype_reply_no_exception_start = """\ +case NO_EXCEPTION:""" + + template_helper_switch_msgtype_reply_no_exception_end = """\ +break;""" + + template_helper_switch_msgtype_reply_user_exception_start = """\ +case USER_EXCEPTION:""" + + template_helper_switch_msgtype_reply_user_exception_end = """\ +break;""" + + template_helper_switch_msgtype_reply_default_start = """\ +default: + /* Unknown Exception */ + expert_add_info_format(pinfo, item, &ei_@dissector_name@_unknown_exception, "Unknown exception %d", header->rep_status);""" + + template_helper_switch_msgtype_reply_default_end = """\ + break;""" + + template_helper_switch_msgtype_reply_end = """\ +break;""" + + template_helper_switch_rep_status_start = """\ +switch(header->rep_status) {""" + + template_helper_switch_rep_status_default_start = """\ +default: + /* Unknown Reply Status */ + expert_add_info_format(pinfo, item, &ei_@dissector_name@_unknown_reply_status, "Unknown reply status %d", header->rep_status);""" + + template_helper_switch_rep_status_default_end = """\ + break;""" + + template_helper_switch_rep_status_end = """\ +} /* switch(header->rep_status) */ + +break;""" + + # Templates for get_CDR_xxx accessors + + template_get_CDR_ulong = """\ +proto_tree_add_uint(tree, hf_@hfname@, tvb, *offset-4, 4, get_CDR_ulong(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_short = """\ +proto_tree_add_int(tree, hf_@hfname@, tvb, *offset-2, 2, get_CDR_short(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_void = """\ +/* Function returns void */ +""" + template_get_CDR_long = """\ +proto_tree_add_int(tree, hf_@hfname@, tvb, *offset-4, 4, get_CDR_long(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_ushort = """\ +proto_tree_add_uint(tree, hf_@hfname@, tvb, *offset-2, 2, get_CDR_ushort(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_float = """\ +proto_tree_add_float(tree, hf_@hfname@, tvb, *offset-4, 4, get_CDR_float(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_double = """\ +proto_tree_add_double(tree, hf_@hfname@, tvb, *offset-8, 8, get_CDR_double(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_longlong = """\ +proto_tree_add_int64(tree, hf_@hfname@, tvb, *offset-8, 8, get_CDR_long_long(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_ulonglong = """\ +proto_tree_add_uint64(tree, hf_@hfname@, tvb, *offset-8, 8, get_CDR_ulong_long(tvb,offset,stream_is_big_endian, boundary)); +""" + template_get_CDR_boolean = """\ +proto_tree_add_boolean(tree, hf_@hfname@, tvb, *offset-1, 1, get_CDR_boolean(tvb,offset)); +""" + template_get_CDR_char = """\ +proto_tree_add_uint(tree, hf_@hfname@, tvb, *offset-1, 1, get_CDR_char(tvb,offset)); +""" + template_get_CDR_octet = """\ +proto_tree_add_uint(tree, hf_@hfname@, tvb, *offset-1, 1, get_CDR_octet(tvb,offset)); +""" + template_get_CDR_any = """\ +get_CDR_any(tvb, pinfo, tree, item, offset, stream_is_big_endian, boundary, header); +""" + template_get_CDR_fixed = """\ +get_CDR_fixed(tvb, pinfo, item, &seq, offset, @digits@, @scale@); +proto_tree_add_string_format_value(tree, hf_@hfname@, tvb, *offset-@length@, @length@, seq, "< @digits@, @scale@> = %s", seq); +""" + template_get_CDR_enum_symbolic = """\ +u_octet4 = get_CDR_enum(tvb,offset,stream_is_big_endian, boundary); +proto_tree_add_uint(tree, hf_@hfname@, tvb, *offset-4, 4, u_octet4); +""" + template_get_CDR_string = """\ +giop_add_CDR_string(tree, tvb, offset, stream_is_big_endian, boundary, hf_@hfname@); +""" + template_get_CDR_wstring = """\ +u_octet4 = get_CDR_wstring(tvb, &seq, offset, stream_is_big_endian, boundary, header); +proto_tree_add_string(tree, hf_@hfname@, tvb, *offset-u_octet4, u_octet4, (u_octet4 > 0) ? seq : \"\"); +""" + template_get_CDR_wchar = """\ +s_octet1 = get_CDR_wchar(tvb, &seq, offset, header); +if (tree) { + if (s_octet1 > 0) + proto_tree_add_uint(tree, hf_@hfname@_len, tvb, *offset-1-s_octet1, 1, s_octet1); + + if (s_octet1 < 0) + s_octet1 = -s_octet1; + + if (s_octet1 > 0) + proto_tree_add_string(tree, hf_@hfname@, tvb, *offset-s_octet1, s_octet1, seq); +} +""" + template_get_CDR_TypeCode = """\ +u_octet4 = get_CDR_typeCode(tvb, pinfo, tree, offset, stream_is_big_endian, boundary, header); +""" + + template_get_CDR_object = """\ +get_CDR_object(tvb, pinfo, tree, offset, stream_is_big_endian, boundary); +""" + + template_get_CDR_sequence_length = """\ +u_octet4_loop_@seqname@ = get_CDR_ulong(tvb, offset, stream_is_big_endian, boundary); +proto_tree_add_uint(tree, hf_@seqname@_loop, tvb,*offset-4, 4, u_octet4_loop_@seqname@); +""" + template_get_CDR_sequence_length_item = """\ +u_octet4_loop_@seqname@ = get_CDR_ulong(tvb, offset, stream_is_big_endian, boundary); +item = proto_tree_add_uint(tree, hf_@seqname@_loop, tvb,*offset-4, 4, u_octet4_loop_@seqname@); +""" + template_get_CDR_sequence_loop_start = """\ +{ + proto_tree *tree_bak_@nonce@ = tree; + tree = proto_tree_add_subtree(tree, tvb, *offset, -1, ett_giop_sequence, NULL, "sequence @seqname@"); + for (i_@seqname@=0; i_@seqname@ < u_octet4_loop_@seqname@; i_@seqname@++) { +""" + template_get_CDR_sequence_loop_end = """\ + } + tree = tree_bak_@nonce@; +} +""" + + template_get_CDR_sequence_octet = """\ +if (u_octet4_loop_@seqname@ > 0 && tree) { + get_CDR_octet_seq(tvb, &binary_seq_@seqname@, offset, + u_octet4_loop_@seqname@); + text_seq_@seqname@ = make_printable_string(binary_seq_@seqname@, + u_octet4_loop_@seqname@); + proto_tree_add_bytes_format_value(tree, hf_@seqname@, tvb, *offset - u_octet4_loop_@seqname@, + u_octet4_loop_@seqname@, binary_seq_@seqname@, \"%s\", text_seq_@seqname@); +} +""" + template_get_CDR_array_start = """\ +{ + proto_tree *tree_bak_@nonce@ = tree; + tree = proto_tree_add_subtree(tree, tvb, *offset, -1, ett_giop_array, NULL, "array @aname@"); + for (i_@aname@=0; i_@aname@ < @aval@; i_@aname@++) { +""" + template_get_CDR_array_end = """\ + } + tree = tree_bak_@nonce@; +} +""" + template_get_CDR_array_comment = """\ +/* Array: @aname@[ @asize@] */ +""" + template_structure_start = """\ +{ /* Begin struct \"@name@\" */ +proto_tree *struct_tree = proto_tree_add_subtree(tree, tvb, *offset, -1, ett_giop_struct, NULL, "struct @name@"); +""" + template_structure_end = """\ +} /* End struct \"@name@\" */""" + + template_union_start = """\ +{ /* Begin union \"@name@\" */ +proto_tree *union_tree = proto_tree_add_subtree(tree, tvb, *offset, -1, ett_giop_union, NULL, "union @name@"); +""" + template_union_end = """\ +} /* End union \"@name@\" */""" + + # Templates for get_CDR_xxx_hf accessors + + template_get_CDR_ulong_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT32,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_ulong_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT32,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_short_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_INT16,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_short_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_INT16,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_long_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_INT32,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_long_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_INT32,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_ushort_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT16,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_ushort_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT16,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_float_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_FLOAT,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_double_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_DOUBLE,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_fixed_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_STRING,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_longlong_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_INT64,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_longlong_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_INT64,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_ulonglong_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT64,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_ulonglong_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT64,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_boolean_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_BOOLEAN,8,NULL,0x01,NULL,HFILL}},""" + + template_get_CDR_char_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT8,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_char_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT8,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_octet_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT8,BASE_HEX,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_enum_symbolic_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT32,BASE_DEC,VALS(@valstringarray@),0x0,NULL,HFILL}},""" + + template_get_CDR_string_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_STRING,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_wstring_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_STRING,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_wchar_hf = """\ + {&hf_@hfname@_len, {"@descname@ Length","giop-@dissector_name@.@filtername@.len",FT_UINT8,BASE_DEC,NULL,0x0,NULL,HFILL}}, + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_STRING,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_TypeCode_hf = """\ + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_UINT32,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_sequence_hf = """\ + {&hf_@hfname@_loop, {"Seq length of @descname@","giop-@dissector_name@.@filtername@.size",FT_UINT32,BASE_DEC,NULL,0x0,NULL,HFILL}},""" + + template_get_CDR_sequence_octet_hf = """\ + {&hf_@hfname@_loop, {"Seq length of @descname@","giop-@dissector_name@.@filtername@.size",FT_UINT32,BASE_DEC,NULL,0x0,NULL,HFILL}}, + {&hf_@hfname@, {"@descname@","giop-@dissector_name@.@filtername@",FT_BYTES,BASE_NONE,NULL,0x0,NULL,HFILL}},""" + + template_Header = """\ +/* packet-@dissector_name@.c + * + * Routines for IDL dissection + * + * Autogenerated from idl2wrs + * Copyright 2001 Frank Singleton + */ + +""" + + template_wireshark_copyright = """\ +/* + * Wireshark - Network traffic analyzer + * By Gerald Combs + * Copyright 1998 Gerald Combs + */ +""" + + template_GPL = """\ +/* + * SPDX-License-Identifier: GPL-2.0-or-later + */ +""" + + template_Modelines = """\ +/* + * Editor modelines - https://www.wireshark.org/tools/modelines.html + * + * Local Variables: + * c-basic-offset: 4 + * tab-width: 8 + * indent-tabs-mode: nil + * End: + * + * ex: set shiftwidth=4 tabstop=8 expandtab: + * :indentSize=4:tabSize=8:noTabs=true: + */""" + + template_Includes = """\ + +#include "config.h" + +#include +#include +#include +#include +#include + +#include "ws_diag_control.h" +#include "ws_compiler_tests.h" + +#ifdef _MSC_VER +/* disable warning: "unreference local variable" */ +#pragma warning(disable:4101) +#endif + +/* XXX this should be autogenerated, or the warnings fixed in the generator */ +DIAG_OFF(unused-function) +DIAG_OFF(unused-variable) +#if WS_IS_AT_LEAST_GNUC_VERSION(6,0) +DIAG_OFF(unused-const-variable) +#endif""" + + template_main_dissector_start = """\ +/* + * Called once we accept the packet as being for us; it sets the + * Protocol and Info columns and creates the top-level protocol + * tree item. + */ +static proto_tree * +start_dissecting(tvbuff_t *tvb, packet_info *pinfo, proto_tree *ptree, int *offset) +{ + + proto_item *ti = NULL; + proto_tree *tree = NULL; /* init later, inside if(tree) */ + + col_set_str(pinfo->cinfo, COL_PROTOCOL, \"@disprot@\"); + + /* + * Do not clear COL_INFO, as nothing is being written there by + * this dissector yet. So leave it as is from the GIOP dissector. + * TODO: add something useful to COL_INFO + * col_clear(pinfo->cinfo, COL_INFO); + */ + + if (ptree) { + ti = proto_tree_add_item(ptree, proto_@dissname@, tvb, *offset, tvb_reported_length_remaining(tvb, *offset), ENC_NA); + tree = proto_item_add_subtree(ti, ett_@dissname@); + } + return tree; +} + +static proto_item* +process_RequestOperation(tvbuff_t *tvb, packet_info *pinfo, proto_tree *ptree, MessageHeader *header, const gchar *operation) +{ + proto_item *pi; + if(header->message_type == Reply) { + /* fill-up info column */ + col_append_fstr(pinfo->cinfo, COL_INFO, " op = %s",operation); + } + /* fill-up the field */ + pi=proto_tree_add_string(ptree, hf_operationrequest, tvb, 0, 0, operation); + proto_item_set_generated(pi); + return pi; +} + +static gboolean +dissect_@dissname@(tvbuff_t *tvb, packet_info *pinfo, proto_tree *ptree, int *offset, MessageHeader *header, const gchar *operation, gchar *idlname) +{ + proto_item *item _U_; + proto_tree *tree _U_; + gboolean stream_is_big_endian = is_big_endian(header); /* get endianess */ + + /* If we have a USER Exception, then decode it and return */ + if ((header->message_type == Reply) && (header->rep_status == USER_EXCEPTION)) { + return decode_user_exception(tvb, pinfo, ptree, offset, header, operation, stream_is_big_endian); + } +""" + + template_main_dissector_switch_msgtype_start = """\ +switch(header->message_type) { +""" + template_main_dissector_switch_msgtype_start_request_reply = """\ +case Request: +case Reply: +""" + template_main_dissector_switch_msgtype_end_request_reply = """\ +break; +""" + template_main_dissector_switch_msgtype_all_other_msgtype = """\ +case CancelRequest: +case LocateRequest: +case LocateReply: +case CloseConnection: +case MessageError: +case Fragment: + return FALSE; /* not handled yet */ + +default: + return FALSE; /* not handled yet */ + +} /* switch */ +""" + template_main_dissector_end = """\ + + return FALSE; + +} /* End of main dissector */ +""" + + +#-------------------------------------------------------------# +# Exception handling templates # +#-------------------------------------------------------------# + + template_exception_helpers_start = """\ +/* Begin Exception Helper Functions */ + +""" + template_exception_helpers_end = """\ + +/* End Exception Helper Functions */ +""" + + template_main_exception_delegator_start = """\ +/* + * Main delegator for exception handling + * + */ +static gboolean +decode_user_exception(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *ptree _U_, int *offset _U_, MessageHeader *header, const gchar *operation _U_, gboolean stream_is_big_endian _U_) +{ + proto_tree *tree _U_; + + if (!header->exception_id) + return FALSE; +""" + + template_ex_delegate_code = """\ +if (strcmp(header->exception_id, "@exname@") == 0) { + tree = start_dissecting(tvb, pinfo, ptree, offset); + decode_ex_@sname@(tvb, pinfo, tree, offset, header, operation, stream_is_big_endian); /* @exname@ */ + return TRUE; +} +""" + + template_main_exception_delegator_end = """ + return FALSE; /* user exception not found */ +} +""" + + template_exception_helper_function_start = """\ +/* Exception = @exname@ */ +static void +decode_ex_@sname@(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, int *offset _U_, MessageHeader *header _U_, const gchar *operation _U_, gboolean stream_is_big_endian _U_) +{ +""" + + template_exception_helper_function_end = """\ +} +""" + + template_struct_helper_function_start = """\ +/* Struct = @stname@ */ +static void +decode_@sname@_st(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, proto_item *item _U_, int *offset _U_, MessageHeader *header _U_, const gchar *operation _U_, gboolean stream_is_big_endian _U_) +{ +""" + + template_struct_helper_function_end = """\ +} +""" + + template_union_helper_function_start = """\ +/* Union = @unname@ */ +static void +decode_@sname@_un(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, int *offset _U_, MessageHeader *header _U_, const gchar *operation _U_, gboolean stream_is_big_endian _U_) +{ +""" + + template_union_helper_function_start_with_item = """\ +/* Union = @unname@ */ +static void +decode_@sname@_un(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, int *offset _U_, MessageHeader *header _U_, const gchar *operation _U_, gboolean stream_is_big_endian _U_) +{ + proto_item* item = NULL; +""" + + template_union_helper_function_end = """\ +} +""" + +#-------------------------------------------------------------# +# Value string templates # +#-------------------------------------------------------------# + + template_value_string_start = """\ +static const value_string @valstringname@[] = { +""" + template_value_string_entry = """\ + { @intval@, \"@description@\" },""" + + template_value_string_end = """\ + { 0, NULL }, +}; +""" + +#-------------------------------------------------------------# +# Enum handling templates # +#-------------------------------------------------------------# + + template_comment_enums_start = """\ +/* + * IDL Enums Start + */ +""" + template_comment_enums_end = """\ +/* + * IDL Enums End + */ +""" + template_comment_enum_comment = """\ +/* + * Enum = @ename@ + */""" + +#-------------------------------------------------------------# +# Attribute handling templates # +#-------------------------------------------------------------# + + template_comment_attributes_start = """\ +/* + * IDL Attributes Start + */ +""" + + # get/set accessor method names are language mapping dependent. + + template_attributes_declare_Java_get = """static const char get_@sname@_at[] = \"_get_@atname@\" ;""" + template_attributes_declare_Java_set = """static const char set_@sname@_at[] = \"_set_@atname@\" ;""" + + template_comment_attributes_end = """ +/* + * IDL Attributes End + */ +""" + + + # template for Attribute delegation code + # + # Note: _get_xxx() should only be called for Reply with NO_EXCEPTION + # Note: _set_xxx() should only be called for Request + + template_at_delegate_code_get = """\ +if (strcmp(operation, get_@sname@_at) == 0 && (header->message_type == Reply) && (header->rep_status == NO_EXCEPTION) ) { + tree = start_dissecting(tvb, pinfo, ptree, offset); + decode_get_@sname@_at(tvb, pinfo, tree, offset, header, operation, stream_is_big_endian); + return TRUE; +} +""" + template_at_delegate_code_set = """\ +if (strcmp(operation, set_@sname@_at) == 0 && (header->message_type == Request) ) { + tree = start_dissecting(tvb, pinfo, ptree, offset); + decode_set_@sname@_at(tvb, pinfo, tree, offset, header, operation, stream_is_big_endian); + return TRUE; +} +""" + template_attribute_helpers_start = """\ +/* Begin Attribute Helper Functions */ +""" + template_attribute_helpers_end = """\ + +/* End Attribute Helper Functions */ +""" + + template_attribute_helper_function_start = """\ + +/* Attribute = @atname@ */ +static void +decode_@sname@_at(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, int *offset _U_, MessageHeader *header _U_, const gchar *operation _U_, gboolean stream_is_big_endian _U_) +{ +""" + + template_attribute_helper_function_end = """\ +} +""" + +#-------------------------------------------------------------# +# Debugging templates # +#-------------------------------------------------------------# + + # Template for outputting TODO "C" comments + # so user know I need to improve something. + + template_debug_TODO = """\ + +/* TODO - @message@ */ +""" + # Template for outputting WARNING "C" comments + # so user know if I have found a problem. + + template_debug_WARNING = """\ +/* WARNING - @message@ */ +""" + +#-------------------------------------------------------------# +# IDL Union templates # +#-------------------------------------------------------------# + + template_comment_union_code_start = """\ +/* + * IDL Union Start - @uname@ + */ +""" + template_comment_union_code_end = """ +/* + * IDL union End - @uname@ + */ +""" + template_comment_union_code_discriminant = """\ +/* + * IDL Union - Discriminant - @uname@ + */ +""" + + # Cast Unions types to something appropriate + # Enum value cast to guint32, all others cast to gint32 + # as omniidl accessor returns integer or Enum. + + template_union_code_save_discriminant_enum = """\ +disc_s_@discname@ = (gint32) u_octet4; /* save Enum Value discriminant and cast to gint32 */ +""" + template_union_code_save_discriminant_long = """\ +*offset -= 4; // rewind +disc_s_@discname@ = (gint32) get_CDR_long(tvb,offset,stream_is_big_endian, boundary); /* save gint32 discriminant and cast to gint32 */ +""" + + template_union_code_save_discriminant_ulong = """\ +*offset -= 4; // rewind +disc_s_@discname@ = (gint32) get_CDR_ulong(tvb,offset,stream_is_big_endian, boundary); /* save guint32 discriminant and cast to gint32 */ +""" + template_union_code_save_discriminant_short = """\ +*offset -= 2; // rewind +disc_s_@discname@ = (gint32) get_CDR_short(tvb,offset,stream_is_big_endian, boundary); /* save gint16 discriminant and cast to gint32 */ +""" + + template_union_code_save_discriminant_ushort = """\ +*offset -= 2; // rewind +disc_s_@discname@ = (gint32) get_CDR_ushort(tvb,offset,stream_is_big_endian, boundary); /* save gint16 discriminant and cast to gint32 */ +""" + template_union_code_save_discriminant_char = """\ +*offset -= 1; // rewind +disc_s_@discname@ = (gint32) get_CDR_char(tvb,offset); /* save guint1 discriminant and cast to gint32 */ +""" + template_union_code_save_discriminant_boolean = """\ +*offset -= 1; // rewind +disc_s_@discname@ = (gint32) get_CDR_boolean(tvb, offset); /* save guint1 discriminant and cast to gint32 */ +""" + template_comment_union_code_label_compare_start = """\ +if (disc_s_@discname@ == @labelval@) { +""" + template_comment_union_code_label_compare_end = """\ + return; /* End Compare for this discriminant type */ +} +""" + + template_comment_union_code_label_default_start = """ +/* Default Union Case Start */ +""" + template_comment_union_code_label_default_end = """\ +/* Default Union Case End */ +""" + + # Templates for function prototypes. + # This is used in genDeclares() for declaring function prototypes + # for structs and union helper functions. + + template_hf_operations = """ +static int hf_operationrequest = -1;/* Request_Operation field */ +""" + + template_hf = """\ +static int hf_@name@ = -1;""" + + template_prototype_start_dissecting = """ +static proto_tree *start_dissecting(tvbuff_t *tvb, packet_info *pinfo, proto_tree *ptree, int *offset); + +""" + template_prototype_struct_start = """\ +/* Struct prototype declaration Start */ +""" + template_prototype_struct_end = """\ +/* Struct prototype declaration End */ +""" + template_prototype_struct_body = """\ +/* Struct = @stname@ */ +static void decode_@name@_st(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, proto_item *item _U_, int *offset _U_, MessageHeader *header _U_, const gchar *operation _U_, gboolean stream_is_big_endian _U_); +""" + template_decode_struct = """\ +decode_@name@_st(tvb, pinfo, struct_tree, item, offset, header, operation, stream_is_big_endian);""" + + template_prototype_union_start = """\ +/* Union prototype declaration Start */""" + + template_prototype_union_end = """\ +/* Union prototype declaration End */""" + + template_prototype_union_body = """ +/* Union = @unname@ */ +static void decode_@name@_un(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, int *offset _U_, MessageHeader *header _U_, const gchar *operation _U_, gboolean stream_is_big_endian _U_); +""" + template_decode_union = """\ +decode_@name@_un(tvb, pinfo, union_tree, offset, header, operation, stream_is_big_endian); +""" + template_proto_item = """\ +proto_item *item = (proto_item*) wmem_alloc0(wmem_packet_scope(), sizeof(proto_item)); +""" + +# +# Editor modelines - https://www.wireshark.org/tools/modelines.html +# +# Local variables: +# c-basic-offset: 4 +# indent-tabs-mode: nil +# End: +# +# vi: set shiftwidth=4 expandtab: +# :indentSize=4:noTabs=true: +# -- cgit v1.2.3