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:
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 from string import Template
22 jvpp_ifc_template = Template("""
23 package $base_package.$callback_facade_package;
26 * <p>Callback Java API representation of vpe.api.
27 * <br>It was generated by jvpp_callback_facade_gen.py based on $inputfile
28 * <br>(python representation of vpe.api generated by vppapigen).
30 public interface CallbackJVpp extends java.lang.AutoCloseable {
41 jvpp_impl_template = Template("""
42 package $base_package.$callback_facade_package;
45 * <p>Default implementation of CallbackJVpp interface.
46 * <br>It was generated by jvpp_callback_facade_gen.py based on $inputfile
47 * <br>(python representation of vpe.api generated by vppapigen).
49 public final class CallbackJVppFacade implements $base_package.$callback_facade_package.CallbackJVpp {
51 private final $base_package.JVpp jvpp;
52 private final java.util.Map<Integer, $base_package.$callback_package.JVppCallback> callbacks;
54 public CallbackJVppFacade(final $base_package.JVpp jvpp,
55 java.util.Map<Integer, $base_package.$callback_package.JVppCallback> callbacks) {
57 throw new java.lang.NullPointerException("jvpp is null");
60 this.callbacks = callbacks;
73 method_template = Template(
74 """ void $name($base_package.$dto_package.$request request, $base_package.$callback_package.$callback callback);""")
75 method_impl_template = Template(""" public final void $name($base_package.$dto_package.$request request, $base_package.$callback_package.$callback callback) {
76 synchronized (callbacks) {
77 callbacks.put(jvpp.$name(request), callback);
82 no_arg_method_template = Template(""" void $name($base_package.$callback_package.$callback callback);""")
83 no_arg_method_impl_template = Template(""" public final void $name($base_package.$callback_package.$callback callback) {
84 synchronized (callbacks) {
85 callbacks.put(jvpp.$name(), callback);
91 def generate_jvpp(func_list, base_package, dto_package, callback_package, callback_facade_package, inputfile):
92 """ Generates callback facade """
93 print "Generating JVpp callback facade"
95 if os.path.exists(callback_facade_package):
96 util.remove_folder(callback_facade_package)
98 os.mkdir(callback_facade_package)
102 for func in func_list:
104 if util.is_notification(func['name']) or util.is_ignored(func['name']):
105 # TODO handle notifications
108 camel_case_name = util.underscore_to_camelcase(func['name'])
109 camel_case_name_upper = util.underscore_to_camelcase_upper(func['name'])
110 if util.is_reply(camel_case_name):
113 # Strip suffix for dump calls
114 callback_type = get_request_name(camel_case_name_upper, func['name']) + callback_gen.callback_suffix
116 if len(func['args']) == 0:
117 methods.append(no_arg_method_template.substitute(name=camel_case_name,
118 base_package=base_package,
119 dto_package=dto_package,
120 callback_package=callback_package,
121 callback=callback_type))
122 methods_impl.append(no_arg_method_impl_template.substitute(name=camel_case_name,
123 base_package=base_package,
124 dto_package=dto_package,
125 callback_package=callback_package,
126 callback=callback_type))
128 methods.append(method_template.substitute(name=camel_case_name,
129 request=camel_case_name_upper,
130 base_package=base_package,
131 dto_package=dto_package,
132 callback_package=callback_package,
133 callback=callback_type))
134 methods_impl.append(method_impl_template.substitute(name=camel_case_name,
135 request=camel_case_name_upper,
136 base_package=base_package,
137 dto_package=dto_package,
138 callback_package=callback_package,
139 callback=callback_type))
141 join = os.path.join(callback_facade_package, "CallbackJVpp.java")
142 jvpp_file = open(join, 'w')
144 jvpp_ifc_template.substitute(inputfile=inputfile,
145 methods="\n".join(methods),
146 base_package=base_package,
147 dto_package=dto_package,
148 callback_facade_package=callback_facade_package))
152 jvpp_file = open(os.path.join(callback_facade_package, "CallbackJVppFacade.java"), 'w')
153 jvpp_file.write(jvpp_impl_template.substitute(inputfile=inputfile,
154 methods="\n".join(methods_impl),
155 base_package=base_package,
156 dto_package=dto_package,
157 callback_package=callback_package,
158 callback_facade_package=callback_facade_package))
162 generate_callback(func_list, base_package, dto_package, callback_package, callback_facade_package, inputfile)
165 jvpp_facade_callback_template = Template("""
166 package $base_package.$callback_facade_package;
169 * <p>JVppGlobalCallback implementation for Java Callback API.
170 * <br>It was generated by jvpp_callback_facade_gen.py based on $inputfile
171 * <br>(python representation of vpe.api generated by vppapigen).
173 public final class CallbackJVppFacadeCallback implements $base_package.$callback_package.JVppGlobalCallback {
175 private final java.util.Map<Integer, $base_package.$callback_package.JVppCallback> requests;
177 public CallbackJVppFacadeCallback(final java.util.Map<Integer, $base_package.$callback_package.JVppCallback> requestMap) {
178 this.requests = requestMap;
185 jvpp_facade_callback_method_template = Template("""
187 @SuppressWarnings("unchecked")
188 public void on$callback_dto($base_package.$dto_package.$callback_dto reply) {
190 $base_package.$callback_package.$callback callback;
191 synchronized(requests) {
192 callback = ($base_package.$callback_package.$callback) requests.remove(reply.context);
195 if(callback != null) {
196 callback.on$callback_dto(reply);
202 def generate_callback(func_list, base_package, dto_package, callback_package, callback_facade_package, inputfile):
204 for func in func_list:
206 if util.is_notification(func['name']) or util.is_ignored(func['name']):
207 # TODO handle notifications
210 camel_case_name_with_suffix = util.underscore_to_camelcase_upper(func['name'])
211 if not util.is_reply(camel_case_name_with_suffix):
214 callbacks.append(jvpp_facade_callback_method_template.substitute(base_package=base_package,
215 dto_package=dto_package,
216 callback_package=callback_package,
217 callback=util.remove_reply_suffix(camel_case_name_with_suffix) + callback_gen.callback_suffix,
218 callback_dto=camel_case_name_with_suffix))
220 jvpp_file = open(os.path.join(callback_facade_package, "CallbackJVppFacadeCallback.java"), 'w')
221 jvpp_file.write(jvpp_facade_callback_template.substitute(inputfile=inputfile,
222 base_package=base_package,
223 dto_package=dto_package,
224 callback_package=callback_package,
225 methods="".join(callbacks),
226 callback_facade_package=callback_facade_package))
231 # Returns request name or special one from unconventional_naming_rep_req map
232 def get_request_name(camel_case_dto_name, func_name):
233 if func_name in reverse_dict(util.unconventional_naming_rep_req):
234 request_name = util.underscore_to_camelcase_upper(reverse_dict(util.unconventional_naming_rep_req)[func_name])
236 request_name = camel_case_dto_name
237 return remove_suffix(request_name)
240 def reverse_dict(map):
241 return dict((v, k) for k, v in map.iteritems())
244 def remove_suffix(name):
245 if util.is_reply(name):
246 return util.remove_reply_suffix(name)
248 if util.is_dump(name):
249 return util.remove_suffix(name, util.dump_suffix)