vpp-api/java/jvpp/gen/jvppgen/callback_gen.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2016 Cisco and/or its affiliates.
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 import os
  17 import util
  18 from string import Template
  19
  20 from util import remove_suffix
  21
  22 callback_suffix = "Callback"
  23
  24 callback_template = Template("""
  25 package $plugin_package.$callback_package;
  26
  27 /**
  28  * <p>Represents callback for plugin's api file message.
  29  * <br>It was generated by callback_gen.py based on $inputfile preparsed data:
  30  * <pre>
  31 $docs
  32  * </pre>
  33  */
  34 public interface $cls_name extends $base_package.$callback_package.$callback_type {
  35
  36     $callback_method
  37
  38 }
  39 """)
  40
  41 global_callback_template = Template("""
  42 package $plugin_package.$callback_package;
  43
  44 /**
  45  * <p>Global aggregated callback interface.
  46  * <br>It was generated by callback_gen.py based on $inputfile
  47  * <br>(python representation of api file generated by vppapigen).
  48  */
  49 public interface JVpp${plugin_name}GlobalCallback extends $base_package.$callback_package.ControlPingCallback, $callbacks {
  50 }
  51 """)
  52
  53
  54 def generate_callbacks(func_list, base_package, plugin_package, plugin_name, callback_package, dto_package, inputfile):
  55     """ Generates callback interfaces """
  56     print "Generating Callback interfaces"
  57
  58     if not os.path.exists(callback_package):
  59         raise Exception("%s folder is missing" % callback_package)
  60
  61     callbacks = []
  62     for func in func_list:
  63
  64         camel_case_name_with_suffix = util.underscore_to_camelcase_upper(func['name'])
  65
  66         if util.is_ignored(func['name']) or util.is_control_ping(camel_case_name_with_suffix):
  67             continue
  68         if not util.is_reply(camel_case_name_with_suffix) and not util.is_notification(func['name']):
  69             continue
  70
  71         if util.is_reply(camel_case_name_with_suffix):
  72             camel_case_name = util.remove_reply_suffix(camel_case_name_with_suffix)
  73             callback_type = "JVppCallback"
  74         else:
  75             camel_case_name_with_suffix = util.add_notification_suffix(camel_case_name_with_suffix)
  76             camel_case_name = camel_case_name_with_suffix
  77             callback_type = "JVppNotificationCallback"
  78
  79         callbacks.append("{0}.{1}.{2}".format(plugin_package, callback_package, camel_case_name + callback_suffix))
  80         callback_path = os.path.join(callback_package, camel_case_name + callback_suffix + ".java")
  81         callback_file = open(callback_path, 'w')
  82
  83         reply_type = "%s.%s.%s" % (plugin_package, dto_package, camel_case_name_with_suffix)
  84         method = "void on{0}({1} reply);".format(camel_case_name_with_suffix, reply_type)
  85         callback_file.write(
  86             callback_template.substitute(inputfile=inputfile,
  87                                          docs=util.api_message_to_javadoc(func),
  88                                          cls_name=camel_case_name + callback_suffix,
  89                                          callback_method=method,
  90                                          base_package=base_package,
  91                                          plugin_package=plugin_package,
  92                                          callback_package=callback_package,
  93                                          callback_type=callback_type))
  94         callback_file.flush()
  95         callback_file.close()
  96
  97     callback_file = open(os.path.join(callback_package, "JVpp%sGlobalCallback.java" % plugin_name), 'w')
  98     callback_file.write(global_callback_template.substitute(inputfile=inputfile,
  99                                                             callbacks=", ".join(callbacks),
 100                                                             base_package=base_package,
 101                                                             plugin_package=plugin_package,
 102                                                             plugin_name=plugin_name,
 103                                                             callback_package=callback_package))
 104     callback_file.flush()
 105     callback_file.close()