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.
23 from jvppgen import types_gen
24 from jvppgen import callback_gen
25 from jvppgen import notification_gen
26 from jvppgen import dto_gen
27 from jvppgen import jvpp_callback_facade_gen
28 from jvppgen import jvpp_future_facade_gen
29 from jvppgen import jvpp_impl_gen
30 from jvppgen import jvpp_c_gen
31 from jvppgen import util
33 blacklist = [ "memclnt.api", "flowperpkt.api" ]
36 # ~/Projects/vpp/vpp-api/jvpp/gen$ mkdir -p java/io/fd/vpp/jvpp && cd java/io/fd/vpp/jvpp
37 # ~/Projects/vpp/vpp-api/jvpp/gen/java/io/fd/vpp/jvpp$ ../../../../jvpp_gen.py -idefs_api_vpp_papi.py
40 # ~/Projects/vpp/vpp-api/jvpp/gen/java/io/fd/vpp/jvpp$ javac *.java dto/*.java callback/*.java
43 # defs_api_vpp_papi.py - vpe.api in python format (generated by vppapigen)
45 parser = argparse.ArgumentParser(description='VPP Java API generator')
46 parser.add_argument('-i', action="store", dest="inputfiles", nargs='+')
47 parser.add_argument('--plugin_name', action="store", dest="plugin_name")
48 parser.add_argument('--root_dir', action="store", dest="root_dir")
49 args = parser.parse_args()
54 print "Generating Java API for %s" % args.inputfiles
55 print "inputfiles %s" % args.inputfiles
56 plugin_name = args.plugin_name
57 print "plugin_name %s" % plugin_name
61 base_package = 'io.fd.vpp.jvpp'
62 plugin_package = base_package + '.' + plugin_name
63 root_dir = os.path.abspath(args.root_dir)
64 print "root_dir %s" % root_dir
65 work_dir = root_dir + "/target/" + plugin_package.replace(".","/")
70 if not os.path.isdir(work_dir):
75 for inputfile in args.inputfiles:
76 if any(substring in inputfile for substring in blacklist):
77 print "WARNING: Imput file %s blacklisted" % inputfile
79 _cfg = json.load(open(cwd + "/" + inputfile, 'r'))
81 cfg['types'].extend(_cfg['types'])
83 cfg['types'] = _cfg['types']
85 cfg['messages'].extend(_cfg['messages'])
87 cfg['messages'] = _cfg['messages']
90 def is_request_field(field_name):
91 return field_name not in {'_vl_msg_id', 'client_index', 'context'}
94 def is_response_field(field_name):
95 return field_name not in {'_vl_msg_id'}
98 def get_args(t, filter):
106 arg_types.append(i[0])
107 arg_names.append(i[1])
108 return arg_types, arg_names
111 def get_types(t, filter):
117 crc = ('crc', i['crc'][2:])
121 if len(i) is 3: # array type
122 types_list.append(i[0] + '[]')
123 lengths_list.append((i[2], False))
124 elif len(i) is 4: # variable length array type
125 types_list.append(i[0] + '[]')
126 lengths_list.append((i[3], True))
127 else: # primitive type
128 types_list.append(i[0])
129 lengths_list.append((0, False))
130 return types_list, lengths_list, crc
134 """ Check whether the argument inside message definition is just crc """
138 def get_definitions(defs):
143 java_name = util.underscore_to_camelcase(a[0])
145 # For replies include all the arguments except message_id
146 if util.is_reply(java_name):
147 types, lengths, crc = get_types(a[1:], is_response_field)
148 args = get_args(a[1:], is_response_field)
149 func_name[a[0]] = dict(
150 [('name', a[0]), ('java_name', java_name),
151 ('args', args[1]), ('arg_types', args[0]),
152 ('types', types), ('lengths', lengths), crc])
153 # For requests skip message_id, client_id and context
155 types, lengths, crc = get_types(a[1:], is_request_field)
156 args = get_args(a[1:], is_request_field)
157 func_name[a[0]] = dict(
158 [('name', a[0]), ('java_name', java_name),
159 ('args', args[1]), ('arg_types', args[0]),
160 ('types', types), ('lengths', lengths), crc])
163 func_list.append(func_name[a[0]])
164 return func_list, func_name
167 types_package = 'types'
169 callback_package = 'callback'
170 notification_package = 'notification'
171 future_package = 'future'
172 # TODO find better package name
173 callback_facade_package = 'callfacade'
175 types_list, types_name = get_definitions(cfg['types'])
177 types_gen.generate_types(types_list, plugin_package, types_package, args.inputfiles)
179 func_list, func_name = get_definitions(cfg['messages'])
181 dto_gen.generate_dtos(func_list, base_package, plugin_package, plugin_name.title(), dto_package, args.inputfiles)
182 jvpp_impl_gen.generate_jvpp(func_list, base_package, plugin_package, plugin_name, dto_package, args.inputfiles)
183 callback_gen.generate_callbacks(func_list, base_package, plugin_package, plugin_name.title(), callback_package, dto_package, args.inputfiles)
184 notification_gen.generate_notification_registry(func_list, base_package, plugin_package, plugin_name.title(), notification_package, callback_package, dto_package, args.inputfiles)
185 jvpp_c_gen.generate_jvpp(func_list, plugin_name, args.inputfiles, root_dir)
186 jvpp_future_facade_gen.generate_jvpp(func_list, base_package, plugin_package, plugin_name.title(), dto_package, callback_package, notification_package, future_package, args.inputfiles)
187 jvpp_callback_facade_gen.generate_jvpp(func_list, base_package, plugin_package, plugin_name.title(), dto_package, callback_package, notification_package, callback_facade_package, args.inputfiles)
189 print "Java API for %s generated successfully" % args.inputfiles