def generate_callbacks(func_list, base_package, plugin_package, plugin_name,
callback_package, dto_package, inputfile):
""" Generates callback interfaces """
print "Generating Callback interfaces"
if not os.path.exists(callback_package):
os.mkdir(callback_package)
callbacks = []
for func in func_list:
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(
func['name'])
if util.is_ignored(func['name']) or util.is_control_ping(
camel_case_name_with_suffix):
continue
if not util.is_reply(camel_case_name_with_suffix
) and not util.is_notification(func['name']):
continue
callback_type = "JVppCallback"
callbacks.append("{0}.{1}.{2}".format(
plugin_package, callback_package,
camel_case_name_with_suffix + callback_suffix))
callback_path = os.path.join(
callback_package,
camel_case_name_with_suffix + callback_suffix + ".java")
callback_file = open(callback_path, 'w')
reply_type = "%s.%s.%s" % (plugin_package, dto_package,
camel_case_name_with_suffix)
method = "void on{0}({1} reply);".format(camel_case_name_with_suffix,
reply_type)
callback_file.write(
callback_template.substitute(
inputfile=inputfile,
docs=util.api_message_to_javadoc(func),
cls_name=camel_case_name_with_suffix + callback_suffix,
callback_method=method,
base_package=base_package,
plugin_package=plugin_package,
callback_package=callback_package,
callback_type=callback_type))
callback_file.flush()
callback_file.close()
callback_file = open(
os.path.join(callback_package,
"JVpp%sGlobalCallback.java" % plugin_name), 'w')
callback_file.write(
global_callback_template.substitute(inputfile=inputfile,
callbacks=", ".join(callbacks),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
callback_package=callback_package))
callback_file.flush()
callback_file.close()
def generate_dtos(func_list, base_package, plugin_package, plugin_name, dto_package, inputfile):
""" Generates dto objects in a dedicated package """
print "Generating DTOs"
if not os.path.exists(dto_package):
os.mkdir(dto_package)
for func in func_list:
camel_case_dto_name = util.underscore_to_camelcase_upper(func['name'])
camel_case_method_name = util.underscore_to_camelcase(func['name'])
dto_path = os.path.join(dto_package, camel_case_dto_name + ".java")
if util.is_ignored(func['name']) or util.is_control_ping(camel_case_dto_name):
continue
fields = generate_dto_fields(camel_case_dto_name, func)
methods = generate_dto_base_methods(camel_case_dto_name, func)
base_type = ""
# Generate request/reply or dump/dumpReply even if structure can be used as notification
if not util.is_just_notification(func["name"]):
if util.is_reply(camel_case_dto_name):
description = "reply DTO"
request_dto_name = get_request_name(camel_case_dto_name, func['name'])
if util.is_details(camel_case_dto_name):
# FIXME assumption that dump calls end with "Dump" suffix. Not enforced in vpe.api
base_type += "JVppReply<%s.%s.%s>" % (plugin_package, dto_package, request_dto_name + "Dump")
generate_dump_reply_dto(request_dto_name, base_package, plugin_package, dto_package,
camel_case_dto_name, camel_case_method_name, func)
else:
base_type += "JVppReply<%s.%s.%s>" % (plugin_package, dto_package, request_dto_name)
else:
args = "" if fields is "" else "this"
methods += send_template.substitute(method_name=camel_case_method_name,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
args=args)
if util.is_dump(camel_case_dto_name):
base_type += "JVppDump"
description = "dump request DTO"
else:
base_type += "JVppRequest"
description = "request DTO"
write_dto_file(base_package, plugin_package, base_type, camel_case_dto_name, description, dto_package,
dto_path, fields, func, inputfile, methods)
# for structures that are also used as notifications, generate dedicated notification DTO
if util.is_notification(func["name"]):
base_type = "JVppNotification"
description = "notification DTO"
camel_case_dto_name = util.add_notification_suffix(camel_case_dto_name)
dto_path = os.path.join(dto_package, camel_case_dto_name + ".java")
methods = generate_dto_base_methods(camel_case_dto_name, func)
write_dto_file(base_package, plugin_package, base_type, camel_case_dto_name, description, dto_package,
dto_path, fields, func, inputfile, methods)
flush_dump_reply_dtos(inputfile)
def generate_callbacks(func_list, base_package, plugin_package, plugin_name,
callback_package, dto_package, inputfile, logger):
""" Generates callback interfaces """
logger.debug("Generating Callback interfaces for %s" % inputfile)
if not os.path.exists(callback_package):
os.mkdir(callback_package)
callbacks = []
for func in func_list:
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(
func['name'])
if util.is_control_ping(camel_case_name_with_suffix):
# Skip control_ping managed by jvpp registry.
continue
if util.is_dump(func['name']) or util.is_request(
func['name'], func_list):
continue
# Generate callbacks for all messages except for dumps and requests (handled by vpp, not client).
callback_type = "JVppCallback"
callbacks.append("{0}.{1}.{2}".format(
plugin_package, callback_package,
camel_case_name_with_suffix + callback_suffix))
callback_path = os.path.join(
callback_package,
camel_case_name_with_suffix + callback_suffix + ".java")
callback_file = open(callback_path, 'w')
reply_type = "%s.%s.%s" % (plugin_package, dto_package,
camel_case_name_with_suffix)
method = "void on{0}({1} reply);".format(camel_case_name_with_suffix,
reply_type)
callback_file.write(
callback_template.substitute(
inputfile=inputfile,
docs=util.api_message_to_javadoc(func),
cls_name=camel_case_name_with_suffix + callback_suffix,
callback_method=method,
base_package=base_package,
plugin_package=plugin_package,
callback_package=callback_package,
callback_type=callback_type))
callback_file.flush()
callback_file.close()
callback_file = open(
os.path.join(callback_package,
"JVpp%sGlobalCallback.java" % plugin_name), 'w')
callback_file.write(
global_callback_template.substitute(inputfile=inputfile,
callbacks=", ".join(callbacks),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
callback_package=callback_package))
callback_file.flush()
callback_file.close()
def generate_dtos(func_list, base_package, plugin_package, plugin_name,
dto_package, inputfile, logger):
""" Generates dto objects in a dedicated package """
logger.debug("Generating DTOs for %s" % inputfile)
if not os.path.exists(dto_package):
os.mkdir(dto_package)
for func in func_list:
camel_case_dto_name = util.underscore_to_camelcase_upper(func['name'])
camel_case_method_name = util.underscore_to_camelcase(func['name'])
dto_path = os.path.join(dto_package, camel_case_dto_name + ".java")
if util.is_control_ping(camel_case_dto_name):
continue
fields = generate_dto_fields(camel_case_dto_name, func)
methods = generate_dto_base_methods(camel_case_dto_name, func)
base_type = ""
if util.is_reply(camel_case_dto_name):
description = "reply DTO"
request_dto_name = util.remove_reply_suffix(camel_case_dto_name)
if util.is_details(camel_case_dto_name):
base_type += "JVppReply<%s.%s.%s>" % (
plugin_package, dto_package, request_dto_name + "Dump")
generate_dump_reply_dto(request_dto_name, base_package,
plugin_package, dto_package,
camel_case_dto_name,
camel_case_method_name, func)
else:
base_type += "JVppReply<%s.%s.%s>" % (
plugin_package, dto_package, request_dto_name)
elif util.is_dump(camel_case_dto_name) or util.is_request(
func['name'], func_list):
args = "" if fields is "" else "this"
methods += send_template.substitute(
method_name=camel_case_method_name,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
args=args)
if util.is_dump(camel_case_dto_name):
base_type += "JVppDump"
description = "dump request DTO"
else:
base_type += "JVppRequest"
description = "request DTO"
else:
description = "event DTO"
dto_path = os.path.join(dto_package, camel_case_dto_name + ".java")
write_dto_file(base_package, plugin_package, base_type,
camel_case_dto_name, description, dto_package, dto_path,
fields, func, inputfile, methods)
flush_dump_reply_dtos(inputfile)
def generate_callback(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
callback_facade_package, inputfile):
callbacks = []
for func in func_list:
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(
func['name'])
if util.is_ignored(func['name']) or util.is_control_ping(
camel_case_name_with_suffix):
continue
if util.is_reply(camel_case_name_with_suffix):
callbacks.append(
jvpp_facade_callback_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=util.remove_reply_suffix(
camel_case_name_with_suffix) +
callback_gen.callback_suffix,
callback_dto=camel_case_name_with_suffix))
if util.is_notification(func["name"]):
with_notification_suffix = util.add_notification_suffix(
camel_case_name_with_suffix)
callbacks.append(
jvpp_facade_callback_notification_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=with_notification_suffix +
callback_gen.callback_suffix,
callback_dto=with_notification_suffix))
jvpp_file = open(
os.path.join(callback_facade_package,
"CallbackJVpp%sFacadeCallback.java" % plugin_name), 'w')
jvpp_file.write(
jvpp_facade_callback_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_package=callback_package,
methods="".join(callbacks),
callback_facade_package=callback_facade_package))
jvpp_file.flush()
jvpp_file.close()
def generate_callback(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
callback_facade_package, inputfile):
callbacks = []
for func in func_list:
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(
func['name'])
if util.is_control_ping(camel_case_name_with_suffix):
# Skip control ping managed by jvpp registry.
continue
if util.is_dump(func['name']) or util.is_request(
func['name'], func_list):
continue
# Generate callbacks for all messages except for dumps and requests (handled by vpp, not client).
if util.is_reply(camel_case_name_with_suffix):
request_method = camel_case_name_with_suffix
callbacks.append(
jvpp_facade_callback_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=camel_case_name_with_suffix +
callback_gen.callback_suffix,
callback_dto=request_method))
else:
callbacks.append(
jvpp_facade_callback_notification_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=camel_case_name_with_suffix +
callback_gen.callback_suffix,
callback_dto=camel_case_name_with_suffix))
jvpp_file = open(
os.path.join(callback_facade_package,
"CallbackJVpp%sFacadeCallback.java" % plugin_name), 'w')
jvpp_file.write(
jvpp_facade_callback_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_package=callback_package,
methods="".join(callbacks),
callback_facade_package=callback_facade_package))
jvpp_file.flush()
jvpp_file.close()
def generate_class_cache(func_list, plugin_name):
class_references = []
find_class_invocations = []
delete_class_invocations = []
for f in func_list:
c_name = f['name']
class_name = util.underscore_to_camelcase_upper(c_name)
ref_name = util.underscore_to_camelcase(c_name)
if util.is_ignored(c_name) or util.is_control_ping(class_name):
continue
if util.is_reply(class_name):
class_references.append(
class_reference_template.substitute(ref_name=ref_name))
find_class_invocations.append(
find_class_invocation_template.substitute(
plugin_name=plugin_name,
ref_name=ref_name,
class_name=class_name))
delete_class_invocations.append(
delete_class_invocation_template.substitute(ref_name=ref_name))
elif util.is_notification(c_name):
class_references.append(
class_reference_template.substitute(
ref_name=util.add_notification_suffix(ref_name)))
find_class_invocations.append(
find_class_invocation_template.substitute(
plugin_name=plugin_name,
ref_name=util.add_notification_suffix(ref_name),
class_name=util.add_notification_suffix(class_name)))
delete_class_invocations.append(
delete_class_invocation_template.substitute(
ref_name=util.add_notification_suffix(ref_name)))
# add exception class to class cache
ref_name = 'callbackException'
class_name = 'io/fd/vpp/jvpp/VppCallbackException'
class_references.append(
class_reference_template.substitute(ref_name=ref_name))
find_class_invocations.append(
find_class_template.substitute(ref_name=ref_name,
class_name=class_name))
delete_class_invocations.append(
delete_class_invocation_template.substitute(ref_name=ref_name))
return class_cache_template.substitute(
class_references="".join(class_references),
find_class_invocations="".join(find_class_invocations),
delete_class_invocations="".join(delete_class_invocations))
def generate_handler_registration(func_list):
handler_registration = ["#define foreach_api_reply_handler \\\n"]
for f in func_list:
name = f['name']
camelcase_name = util.underscore_to_camelcase(f['name'])
if (not util.is_reply(camelcase_name) and not util.is_notification(name)) or util.is_ignored(name) \
or util.is_control_ping(camelcase_name):
continue
handler_registration.append(
handler_registration_template.substitute(name=name, crc=f['crc']))
return "".join(handler_registration)
def generate_handler_registration(func_list):
handler_registration = ["#define foreach_api_reply_handler \\\n"]
for f in func_list:
name = f['name']
camelcase_name = util.underscore_to_camelcase(name)
if util.is_control_ping(camelcase_name):
# Skip control ping managed by registry.
continue
if util.is_dump(name) or util.is_request(name, func_list):
continue
# Generate msg handler registration for all messages except for dumps and requests.
handler_registration.append(
handler_registration_template.substitute(name=name, crc=f['crc']))
return "".join(handler_registration)
def generate_jvpp(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
future_facade_package, inputfile):
""" Generates JVpp interface and JNI implementation """
print "Generating JVpp future facade"
if not os.path.exists(future_facade_package):
os.mkdir(future_facade_package)
methods = []
methods_impl = []
callbacks = []
for func in func_list:
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(
func['name'])
if util.is_ignored(func['name']) or util.is_control_ping(
camel_case_name_with_suffix):
continue
if not util.is_reply(camel_case_name_with_suffix
) and not util.is_notification(func['name']):
continue
camel_case_method_name = util.underscore_to_camelcase(func['name'])
if not util.is_notification(func["name"]):
camel_case_request_method_name = util.remove_reply_suffix(
util.underscore_to_camelcase(func['name']))
if util.is_details(camel_case_name_with_suffix):
camel_case_reply_name = get_standard_dump_reply_name(
util.underscore_to_camelcase_upper(func['name']),
func['name'])
callbacks.append(
jvpp_facade_details_callback_method_template.substitute(
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix,
callback_dto_field=camel_case_method_name,
callback_dto_reply_dump=camel_case_reply_name +
dto_gen.dump_dto_suffix,
future_package=future_facade_package))
methods.append(
future_jvpp_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name +
util.underscore_to_camelcase_upper(util.dump_suffix),
reply_name=camel_case_reply_name +
dto_gen.dump_dto_suffix,
request_name=util.remove_reply_suffix(
camel_case_reply_name) +
util.underscore_to_camelcase_upper(util.dump_suffix)))
methods_impl.append(
future_jvpp_dump_method_impl_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name +
util.underscore_to_camelcase_upper(util.dump_suffix),
reply_name=camel_case_reply_name +
dto_gen.dump_dto_suffix,
request_name=util.remove_reply_suffix(
camel_case_reply_name) +
util.underscore_to_camelcase_upper(util.dump_suffix)))
else:
request_name = util.underscore_to_camelcase_upper(util.unconventional_naming_rep_req[func['name']]) \
if func['name'] in util.unconventional_naming_rep_req else util.remove_reply_suffix(camel_case_name_with_suffix)
methods.append(
future_jvpp_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name,
reply_name=camel_case_name_with_suffix,
request_name=request_name))
methods_impl.append(
future_jvpp_method_impl_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name,
reply_name=camel_case_name_with_suffix,
request_name=request_name))
callbacks.append(
jvpp_facade_callback_method_template.substitute(
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix))
if util.is_notification(func["name"]):
callbacks.append(
jvpp_facade_callback_notification_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
callback_dto=util.add_notification_suffix(
camel_case_name_with_suffix)))
jvpp_file = open(
os.path.join(future_facade_package,
"FutureJVpp%sFacadeCallback.java" % plugin_name), 'w')
jvpp_file.write(
jvpp_facade_callback_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_package=callback_package,
methods="".join(callbacks),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
jvpp_file = open(
os.path.join(future_facade_package, "FutureJVpp%s.java" % plugin_name),
'w')
jvpp_file.write(
future_jvpp_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
notification_package=notification_package,
methods="".join(methods),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
jvpp_file = open(
os.path.join(future_facade_package,
"FutureJVpp%sFacade.java" % plugin_name), 'w')
jvpp_file.write(
future_jvpp_facade_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
methods="".join(methods_impl),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
def generate_jvpp(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
callback_facade_package, inputfile):
""" Generates callback facade """
print "Generating JVpp callback facade"
if os.path.exists(callback_facade_package):
util.remove_folder(callback_facade_package)
os.mkdir(callback_facade_package)
methods = []
methods_impl = []
for func in func_list:
if util.is_notification(func['name']) or util.is_ignored(func['name']):
continue
camel_case_name = util.underscore_to_camelcase(func['name'])
camel_case_name_upper = util.underscore_to_camelcase_upper(
func['name'])
if util.is_reply(camel_case_name) or util.is_control_ping(
camel_case_name):
continue
# Strip suffix for dump calls
callback_type = get_request_name(
camel_case_name_upper, func['name']) + callback_gen.callback_suffix
if len(func['args']) == 0:
methods.append(
no_arg_method_template.substitute(
name=camel_case_name,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
methods_impl.append(
no_arg_method_impl_template.substitute(
name=camel_case_name,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
else:
methods.append(
method_template.substitute(name=camel_case_name,
request=camel_case_name_upper,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
methods_impl.append(
method_impl_template.substitute(
name=camel_case_name,
request=camel_case_name_upper,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
join = os.path.join(callback_facade_package,
"CallbackJVpp%s.java" % plugin_name)
jvpp_file = open(join, 'w')
jvpp_file.write(
jvpp_ifc_template.substitute(
inputfile=inputfile,
methods="\n".join(methods),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_facade_package=callback_facade_package))
jvpp_file.flush()
jvpp_file.close()
jvpp_file = open(
os.path.join(callback_facade_package,
"CallbackJVpp%sFacade.java" % plugin_name), 'w')
jvpp_file.write(
jvpp_impl_template.substitute(
inputfile=inputfile,
methods="\n".join(methods_impl),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_package=callback_package,
callback_facade_package=callback_facade_package))
jvpp_file.flush()
jvpp_file.close()
generate_callback(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
callback_facade_package, inputfile)
def generate_notification_registry(func_list, base_package, plugin_package,
plugin_name, notification_package,
callback_package, dto_package, inputfile):
""" Generates notification registry interface and implementation """
print "Generating Notification interfaces and implementation"
if not os.path.exists(notification_package):
os.mkdir(notification_package)
callbacks = []
register_callback_methods = []
register_callback_methods_impl = []
handler_methods = []
for func in func_list:
if not util.is_reply(func['name']) and not util.is_notification(
func['name']):
continue
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(
func['name'])
if util.is_control_ping(camel_case_name_with_suffix):
continue
notification_dto = camel_case_name_with_suffix
callback_ifc = camel_case_name_with_suffix + callback_gen.callback_suffix
fully_qualified_callback_ifc = "{0}.{1}.{2}".format(
plugin_package, callback_package, callback_ifc)
callbacks.append(fully_qualified_callback_ifc)
# TODO create NotificationListenerRegistration and return that instead of AutoCloseable to better indicate
# that the registration should be closed
register_callback_methods.append(
"java.lang.AutoCloseable register{0}({1} callback);".format(
callback_ifc, fully_qualified_callback_ifc))
register_callback_methods_impl.append(
register_callback_impl_template.substitute(
plugin_package=plugin_package,
callback_package=callback_package,
dto_package=dto_package,
notification=camel_case_name_with_suffix,
callback=callback_ifc))
handler_methods.append(
handler_impl_template.substitute(
base_package=base_package,
plugin_package=plugin_package,
callback_package=callback_package,
dto_package=dto_package,
notification=notification_dto,
notification_reply=camel_case_name_with_suffix,
callback=callback_ifc))
callback_file = open(
os.path.join(notification_package,
"%sEventRegistry.java" % plugin_name), 'w')
callback_file.write(
notification_registry_template.substitute(
inputfile=inputfile,
register_callback_methods="\n ".join(register_callback_methods),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
notification_package=notification_package))
callback_file.flush()
callback_file.close()
callback_file = open(
os.path.join(notification_package,
"Global%sEventCallback.java" % plugin_name), 'w')
global_notification_callback_callbacks = ""
if (callbacks):
global_notification_callback_callbacks = " extends " + ", ".join(
callbacks)
callback_file.write(
global_notification_callback_template.substitute(
inputfile=inputfile,
callbacks=global_notification_callback_callbacks,
plugin_package=plugin_package,
plugin_name=plugin_name,
notification_package=notification_package))
callback_file.flush()
callback_file.close()
callback_file = open(
os.path.join(notification_package,
"%sEventRegistryImpl.java" % plugin_name), 'w')
callback_file.write(
notification_registry_impl_template.substitute(
inputfile=inputfile,
callback_package=callback_package,
dto_package=dto_package,
register_callback_methods="".join(register_callback_methods_impl),
handler_methods="".join(handler_methods),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
notification_package=notification_package))
callback_file.flush()
callback_file.close()
callback_file = open(
os.path.join(notification_package,
"%sEventRegistryProvider.java" % plugin_name), 'w')
callback_file.write(
notification_provider_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
notification_package=notification_package))
callback_file.flush()
callback_file.close()
def generate_jvpp(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
future_facade_package, inputfile):
""" Generates JVpp interface and JNI implementation """
print "Generating JVpp future facade"
if not os.path.exists(future_facade_package):
os.mkdir(future_facade_package)
methods = []
methods_impl = []
# Generate methods for sending messages.
for func in func_list:
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(
func['name'])
if util.is_control_ping(camel_case_name_with_suffix):
# Skip control ping managed by jvpp registry.
continue
# Process replies instead of requests (optimization).
if not util.is_reply(camel_case_name_with_suffix):
# Do not generate send methods for messages that do not have replies.
continue
camel_case_request_method_name = util.remove_reply_suffix(
util.underscore_to_camelcase(func['name']))
if util.is_details(camel_case_name_with_suffix):
camel_case_reply_name = util.underscore_to_camelcase_upper(
func['name'])
methods.append(
future_jvpp_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name +
util.underscore_to_camelcase_upper(util.dump_suffix),
reply_name=camel_case_reply_name + dto_gen.dump_dto_suffix,
request_name=util.remove_reply_suffix(
camel_case_reply_name) +
util.underscore_to_camelcase_upper(util.dump_suffix)))
methods_impl.append(
future_jvpp_dump_method_impl_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name +
util.underscore_to_camelcase_upper(util.dump_suffix),
reply_name=camel_case_reply_name + dto_gen.dump_dto_suffix,
request_name=util.remove_reply_suffix(
camel_case_reply_name) +
util.underscore_to_camelcase_upper(util.dump_suffix)))
else:
request_name = util.remove_reply_suffix(
camel_case_name_with_suffix)
methods.append(
future_jvpp_method_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name,
reply_name=camel_case_name_with_suffix,
request_name=request_name))
methods_impl.append(
future_jvpp_method_impl_template.substitute(
plugin_package=plugin_package,
dto_package=dto_package,
method_name=camel_case_request_method_name,
reply_name=camel_case_name_with_suffix,
request_name=request_name))
jvpp_file = open(
os.path.join(future_facade_package, "FutureJVpp%s.java" % plugin_name),
'w')
jvpp_file.write(
future_jvpp_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
notification_package=notification_package,
methods="".join(methods),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
jvpp_file = open(
os.path.join(future_facade_package,
"FutureJVpp%sFacade.java" % plugin_name), 'w')
jvpp_file.write(
future_jvpp_facade_template.substitute(
inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
methods="".join(methods_impl),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
generate_callback(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
future_facade_package, inputfile)
def generate_jvpp(func_list, base_package, dto_package, callback_package, notification_package, future_facade_package, inputfile):
""" Generates JVpp interface and JNI implementation """
print "Generating JVpp future facade"
if not os.path.exists(future_facade_package):
raise Exception("%s folder is missing" % future_facade_package)
methods = []
methods_impl = []
callbacks = []
for func in func_list:
if util.is_ignored(func['name']):
continue
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(func['name'])
if not util.is_reply(camel_case_name_with_suffix) and not util.is_notification(func['name']):
continue
camel_case_method_name = util.underscore_to_camelcase(func['name'])
if not util.is_notification(func["name"]):
camel_case_request_method_name = util.remove_reply_suffix(util.underscore_to_camelcase(func['name']))
if util.is_details(camel_case_name_with_suffix):
camel_case_reply_name = get_standard_dump_reply_name(util.underscore_to_camelcase_upper(func['name']),
func['name'])
callbacks.append(jvpp_facade_details_callback_method_template.substitute(base_package=base_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix,
callback_dto_field=camel_case_method_name,
callback_dto_reply_dump=camel_case_reply_name + dto_gen.dump_dto_suffix,
future_package=future_facade_package))
methods.append(future_jvpp_method_template.substitute(base_package=base_package,
dto_package=dto_package,
method_name=camel_case_request_method_name +
util.underscore_to_camelcase_upper(util.dump_suffix),
reply_name=camel_case_reply_name + dto_gen.dump_dto_suffix,
request_name=util.remove_reply_suffix(camel_case_reply_name) +
util.underscore_to_camelcase_upper(util.dump_suffix)))
methods_impl.append(future_jvpp_method_impl_template.substitute(base_package=base_package,
dto_package=dto_package,
method_name=camel_case_request_method_name +
util.underscore_to_camelcase_upper(util.dump_suffix),
reply_name=camel_case_reply_name + dto_gen.dump_dto_suffix,
request_name=util.remove_reply_suffix(camel_case_reply_name) +
util.underscore_to_camelcase_upper(util.dump_suffix)))
else:
request_name = util.underscore_to_camelcase_upper(util.unconventional_naming_rep_req[func['name']]) \
if func['name'] in util.unconventional_naming_rep_req else util.remove_reply_suffix(camel_case_name_with_suffix)
methods.append(future_jvpp_method_template.substitute(base_package=base_package,
dto_package=dto_package,
method_name=camel_case_request_method_name,
reply_name=camel_case_name_with_suffix,
request_name=request_name))
methods_impl.append(future_jvpp_method_impl_template.substitute(base_package=base_package,
dto_package=dto_package,
method_name=camel_case_request_method_name,
reply_name=camel_case_name_with_suffix,
request_name=request_name))
# Callback handler is a bit special and a different template has to be used
if util.is_control_ping(camel_case_name_with_suffix):
callbacks.append(jvpp_facade_control_ping_method_template.substitute(base_package=base_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix,
future_package=future_facade_package))
else:
callbacks.append(jvpp_facade_callback_method_template.substitute(base_package=base_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix))
if util.is_notification(func["name"]):
callbacks.append(jvpp_facade_callback_notification_method_template.substitute(base_package=base_package,
dto_package=dto_package,
callback_dto=util.add_notification_suffix(camel_case_name_with_suffix)))
jvpp_file = open(os.path.join(future_facade_package, "FutureJVppFacadeCallback.java"), 'w')
jvpp_file.write(jvpp_facade_callback_template.substitute(inputfile=inputfile,
base_package=base_package,
dto_package=dto_package,
notification_package=notification_package,
callback_package=callback_package,
methods="".join(callbacks),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
jvpp_file = open(os.path.join(future_facade_package, "FutureJVpp.java"), 'w')
jvpp_file.write(future_jvpp_template.substitute(inputfile=inputfile,
base_package=base_package,
methods="".join(methods),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
jvpp_file = open(os.path.join(future_facade_package, "FutureJVppFacade.java"), 'w')
jvpp_file.write(future_jvpp_facade_template.substitute(inputfile=inputfile,
base_package=base_package,
dto_package=dto_package,
methods="".join(methods_impl),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
def generate_jvpp(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
callback_facade_package, inputfile, logger):
""" Generates callback facade """
logger.debug("Generating JVpp callback facade for %s" % inputfile)
if os.path.exists(callback_facade_package):
util.remove_folder(callback_facade_package)
os.mkdir(callback_facade_package)
methods = []
methods_impl = []
# Generate methods for sending messages.
for func in func_list:
camel_case_name = util.underscore_to_camelcase(func['name'])
camel_case_name_upper = util.underscore_to_camelcase_upper(
func['name'])
if util.is_reply(camel_case_name) or util.is_control_ping(
camel_case_name):
continue
# Strip suffix for dump calls
callback_type = get_request_name(camel_case_name_upper)
if util.is_dump(camel_case_name_upper):
callback_type += "Details"
elif util.is_request(func['name'], func_list):
callback_type += "Reply"
else:
# Skip messages that do not not have replies (e.g events/counters).
continue
callback_type += callback_gen.callback_suffix
if len(func['args']) == 0:
methods.append(
no_arg_method_template.substitute(
name=camel_case_name,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
methods_impl.append(
no_arg_method_impl_template.substitute(
name=camel_case_name,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
else:
methods.append(
method_template.substitute(name=camel_case_name,
request=camel_case_name_upper,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
methods_impl.append(
method_impl_template.substitute(
name=camel_case_name,
request=camel_case_name_upper,
base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_package=callback_package,
callback=callback_type))
join = os.path.join(callback_facade_package,
"CallbackJVpp%s.java" % plugin_name)
jvpp_file = open(join, 'w')
jvpp_file.write(
jvpp_ifc_template.substitute(
inputfile=inputfile,
methods="\n".join(methods),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_facade_package=callback_facade_package))
jvpp_file.flush()
jvpp_file.close()
jvpp_file = open(
os.path.join(callback_facade_package,
"CallbackJVpp%sFacade.java" % plugin_name), 'w')
jvpp_file.write(
jvpp_impl_template.substitute(
inputfile=inputfile,
methods="\n".join(methods_impl),
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_package=callback_package,
callback_facade_package=callback_facade_package))
jvpp_file.flush()
jvpp_file.close()
generate_callback(func_list, base_package, plugin_package, plugin_name,
dto_package, callback_package, notification_package,
callback_facade_package, inputfile)
