jvpp: do not hardcode event sufixes (VPP-940)
[vpp.git] / src / vpp-api / java / jvpp / gen / jvppgen / jvpp_callback_facade_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, util
17 from string import Template
18
19 import callback_gen
20
21 jvpp_ifc_template = Template("""
22 package $plugin_package.$callback_facade_package;
23
24 /**
25  * <p>Callback Java API representation of $plugin_package plugin.
26  * <br>It was generated by jvpp_callback_facade_gen.py based on $inputfile
27  * <br>(python representation of api file generated by vppapigen).
28  */
29 public interface CallbackJVpp${plugin_name} extends $base_package.$notification_package.EventRegistryProvider, java.lang.AutoCloseable {
30
31     // TODO add send
32
33 $methods
34 }
35 """)
36
37 jvpp_impl_template = Template("""
38 package $plugin_package.$callback_facade_package;
39
40 /**
41  * <p>Default implementation of Callback${plugin_name}JVpp interface.
42  * <br>It was generated by jvpp_callback_facade_gen.py based on $inputfile
43  * <br>(python representation of api file generated by vppapigen).
44  */
45 public final class CallbackJVpp${plugin_name}Facade implements CallbackJVpp${plugin_name} {
46
47     private final $plugin_package.JVpp${plugin_name} jvpp;
48     private final java.util.Map<Integer, $base_package.$callback_package.JVppCallback> callbacks;
49     private final $plugin_package.$notification_package.${plugin_name}EventRegistryImpl eventRegistry = new $plugin_package.$notification_package.${plugin_name}EventRegistryImpl();
50     /**
51      * <p>Create CallbackJVpp${plugin_name}Facade object for provided JVpp instance.
52      * Constructor internally creates CallbackJVppFacadeCallback class for processing callbacks
53      * and then connects to provided JVpp instance
54      *
55      * @param jvpp provided $base_package.JVpp instance
56      *
57      * @throws java.io.IOException in case instance cannot connect to JVPP
58      */
59     public CallbackJVpp${plugin_name}Facade(final $base_package.JVppRegistry registry, final $plugin_package.JVpp${plugin_name} jvpp) throws java.io.IOException {
60         this.jvpp = java.util.Objects.requireNonNull(jvpp,"jvpp is null");
61         this.callbacks = new java.util.HashMap<>();
62         java.util.Objects.requireNonNull(registry, "JVppRegistry should not be null");
63         registry.register(jvpp, new CallbackJVpp${plugin_name}FacadeCallback(this.callbacks, eventRegistry));
64     }
65
66     @Override
67     public $plugin_package.$notification_package.${plugin_name}EventRegistry getEventRegistry() {
68         return eventRegistry;
69     }
70
71     @Override
72     public void close() throws Exception {
73         jvpp.close();
74     }
75
76     // TODO add send()
77
78 $methods
79 }
80 """)
81
82 method_template = Template(
83     """    void $name($plugin_package.$dto_package.$request request, $plugin_package.$callback_package.$callback callback) throws $base_package.VppInvocationException;""")
84
85 method_impl_template = Template("""    public final void $name($plugin_package.$dto_package.$request request, $plugin_package.$callback_package.$callback callback) throws $base_package.VppInvocationException {
86         synchronized (callbacks) {
87             callbacks.put(jvpp.$name(request), callback);
88         }
89     }
90 """)
91
92 no_arg_method_template = Template("""    void $name($plugin_package.$callback_package.$callback callback) throws $base_package.VppInvocationException;""")
93 no_arg_method_impl_template = Template("""    public final void $name($plugin_package.$callback_package.$callback callback) throws $base_package.VppInvocationException {
94         synchronized (callbacks) {
95             callbacks.put(jvpp.$name(), callback);
96         }
97     }
98 """)
99
100
101 def generate_jvpp(func_list, base_package, plugin_package, plugin_name, dto_package, callback_package, notification_package, callback_facade_package, inputfile):
102     """ Generates callback facade """
103     print "Generating JVpp callback facade"
104
105     if os.path.exists(callback_facade_package):
106         util.remove_folder(callback_facade_package)
107
108     os.mkdir(callback_facade_package)
109
110     methods = []
111     methods_impl = []
112
113     # Generate methods for sending messages.
114     for func in func_list:
115         camel_case_name = util.underscore_to_camelcase(func['name'])
116         camel_case_name_upper = util.underscore_to_camelcase_upper(func['name'])
117         if util.is_reply(camel_case_name) or util.is_control_ping(camel_case_name):
118             continue
119
120         # Strip suffix for dump calls
121         callback_type = get_request_name(camel_case_name_upper)
122         if util.is_dump(camel_case_name_upper):
123             callback_type += "Details"
124         elif util.is_request(func['name'], func_list):
125             callback_type += "Reply"
126         else:
127             # Skip messages that do not not have replies (e.g events/counters).
128             continue
129         callback_type += callback_gen.callback_suffix
130
131         if len(func['args']) == 0:
132             methods.append(no_arg_method_template.substitute(name=camel_case_name,
133                                                              base_package=base_package,
134                                                              plugin_package=plugin_package,
135                                                              dto_package=dto_package,
136                                                              callback_package=callback_package,
137                                                              callback=callback_type))
138             methods_impl.append(no_arg_method_impl_template.substitute(name=camel_case_name,
139                                                                        base_package=base_package,
140                                                                        plugin_package=plugin_package,
141                                                                        dto_package=dto_package,
142                                                                        callback_package=callback_package,
143                                                                        callback=callback_type))
144         else:
145             methods.append(method_template.substitute(name=camel_case_name,
146                                                       request=camel_case_name_upper,
147                                                       base_package=base_package,
148                                                       plugin_package=plugin_package,
149                                                       dto_package=dto_package,
150                                                       callback_package=callback_package,
151                                                       callback=callback_type))
152             methods_impl.append(method_impl_template.substitute(name=camel_case_name,
153                                                                 request=camel_case_name_upper,
154                                                                 base_package=base_package,
155                                                                 plugin_package=plugin_package,
156                                                                 dto_package=dto_package,
157                                                                 callback_package=callback_package,
158                                                                 callback=callback_type))
159
160     join = os.path.join(callback_facade_package, "CallbackJVpp%s.java" % plugin_name)
161     jvpp_file = open(join, 'w')
162     jvpp_file.write(
163         jvpp_ifc_template.substitute(inputfile=inputfile,
164                                      methods="\n".join(methods),
165                                      base_package=base_package,
166                                      plugin_package=plugin_package,
167                                      plugin_name=plugin_name,
168                                      dto_package=dto_package,
169                                      notification_package=notification_package,
170                                      callback_facade_package=callback_facade_package))
171     jvpp_file.flush()
172     jvpp_file.close()
173
174     jvpp_file = open(os.path.join(callback_facade_package, "CallbackJVpp%sFacade.java" % plugin_name), 'w')
175     jvpp_file.write(jvpp_impl_template.substitute(inputfile=inputfile,
176                                                   methods="\n".join(methods_impl),
177                                                   base_package=base_package,
178                                                   plugin_package=plugin_package,
179                                                   plugin_name=plugin_name,
180                                                   dto_package=dto_package,
181                                                   notification_package=notification_package,
182                                                   callback_package=callback_package,
183                                                   callback_facade_package=callback_facade_package))
184     jvpp_file.flush()
185     jvpp_file.close()
186
187     generate_callback(func_list, base_package, plugin_package, plugin_name, dto_package, callback_package, notification_package, callback_facade_package, inputfile)
188
189
190 jvpp_facade_callback_template = Template("""
191 package $plugin_package.$callback_facade_package;
192
193 /**
194  * <p>Implementation of JVppGlobalCallback interface for Java Callback API.
195  * <br>It was generated by jvpp_callback_facade_gen.py based on $inputfile
196  * <br>(python representation of api file generated by vppapigen).
197  */
198 public final class CallbackJVpp${plugin_name}FacadeCallback implements $plugin_package.$callback_package.JVpp${plugin_name}GlobalCallback {
199
200     private final java.util.Map<Integer, $base_package.$callback_package.JVppCallback> requests;
201     private final $plugin_package.$notification_package.Global${plugin_name}EventCallback eventCallback;
202     private static final java.util.logging.Logger LOG = java.util.logging.Logger.getLogger(CallbackJVpp${plugin_name}FacadeCallback.class.getName());
203
204     public CallbackJVpp${plugin_name}FacadeCallback(final java.util.Map<Integer, $base_package.$callback_package.JVppCallback> requestMap,
205                                       final $plugin_package.$notification_package.Global${plugin_name}EventCallback eventCallback) {
206         this.requests = requestMap;
207         this.eventCallback = eventCallback;
208     }
209
210     @Override
211     public void onError($base_package.VppCallbackException reply) {
212
213         $base_package.$callback_package.JVppCallback failedCall;
214         synchronized(requests) {
215             failedCall = requests.remove(reply.getCtxId());
216         }
217
218         if(failedCall != null) {
219             try {
220                 failedCall.onError(reply);
221             } catch(RuntimeException ex) {
222                 ex.addSuppressed(reply);
223                 LOG.log(java.util.logging.Level.WARNING, String.format("Callback: %s failed while handling exception: %s", failedCall, reply), ex);
224             }
225         }
226     }
227
228     @Override
229     @SuppressWarnings("unchecked")
230     public void onControlPingReply(final $base_package.$dto_package.ControlPingReply reply) {
231
232         $base_package.$callback_package.ControlPingCallback callback;
233         final int replyId = reply.context;
234         synchronized(requests) {
235             callback = ($base_package.$callback_package.ControlPingCallback) requests.remove(replyId);
236         }
237
238         if(callback != null) {
239             callback.onControlPingReply(reply);
240         }
241     }
242
243 $methods
244 }
245 """)
246
247 jvpp_facade_callback_method_template = Template("""
248     @Override
249     @SuppressWarnings("unchecked")
250     public void on$callback_dto(final $plugin_package.$dto_package.$callback_dto reply) {
251
252         $plugin_package.$callback_package.$callback callback;
253         final int replyId = reply.context;
254         if (LOG.isLoggable(java.util.logging.Level.FINE)) {
255             LOG.fine(String.format("Received $callback_dto event message: %s", reply));
256         }
257         synchronized(requests) {
258             callback = ($plugin_package.$callback_package.$callback) requests.remove(replyId);
259         }
260
261         if(callback != null) {
262             callback.on$callback_dto(reply);
263         }
264     }
265 """)
266
267 jvpp_facade_callback_notification_method_template = Template("""
268     @Override
269     @SuppressWarnings("unchecked")
270     public void on$callback_dto($plugin_package.$dto_package.$callback_dto notification) {
271         if (LOG.isLoggable(java.util.logging.Level.FINE)) {
272             LOG.fine(String.format("Received $callback_dto event message: %s", notification));
273         }
274         eventCallback.on$callback_dto(notification);
275     }
276 """)
277
278
279 def generate_callback(func_list, base_package, plugin_package, plugin_name, dto_package, callback_package, notification_package, callback_facade_package, inputfile):
280     callbacks = []
281     for func in func_list:
282         camel_case_name_with_suffix = util.underscore_to_camelcase_upper(func['name'])
283
284         if util.is_control_ping(camel_case_name_with_suffix):
285             # Skip control ping managed by jvpp registry.
286             continue
287         if util.is_dump(func['name']) or util.is_request(func['name'], func_list):
288             continue
289
290         # Generate callbacks for all messages except for dumps and requests (handled by vpp, not client).
291         if util.is_reply(camel_case_name_with_suffix):
292             request_method = camel_case_name_with_suffix
293             callbacks.append(jvpp_facade_callback_method_template.substitute(plugin_package=plugin_package,
294                                                                              dto_package=dto_package,
295                                                                              callback_package=callback_package,
296                                                                              callback=camel_case_name_with_suffix + callback_gen.callback_suffix,
297                                                                              callback_dto=request_method))
298         else:
299             callbacks.append(jvpp_facade_callback_notification_method_template.substitute(plugin_package=plugin_package,
300                                                                                           dto_package=dto_package,
301                                                                                           callback_package=callback_package,
302                                                                                           callback=camel_case_name_with_suffix + callback_gen.callback_suffix,
303                                                                                           callback_dto=camel_case_name_with_suffix))
304
305     jvpp_file = open(os.path.join(callback_facade_package, "CallbackJVpp%sFacadeCallback.java" % plugin_name), 'w')
306     jvpp_file.write(jvpp_facade_callback_template.substitute(inputfile=inputfile,
307                                                              base_package=base_package,
308                                                              plugin_package=plugin_package,
309                                                              plugin_name=plugin_name,
310                                                              dto_package=dto_package,
311                                                              notification_package=notification_package,
312                                                              callback_package=callback_package,
313                                                              methods="".join(callbacks),
314                                                              callback_facade_package=callback_facade_package))
315     jvpp_file.flush()
316     jvpp_file.close()
317
318
319 # Returns request name
320 def get_request_name(camel_case_dto_name):
321     return remove_suffix(camel_case_dto_name)
322
323
324 def remove_suffix(name):
325     if util.is_reply(name):
326         return util.remove_reply_suffix(name)
327     else:
328         if util.is_dump(name):
329             return util.remove_suffix(name, util.dump_suffix)
330         else:
331             return name