vpp-api/java/jvpp/gen/jvpp_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 # l
  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
  17 import argparse
  18 import importlib
  19 import sys
  20 import os
  21 import json
  22
  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
  32
  33 # Invocation:
  34 # ~/Projects/vpp/vpp-api/jvpp/gen$ mkdir -p java/io/fd/vpp/jvpp && cd java/io/fd/vpp/jvpp
  35 # ~/Projects/vpp/vpp-api/jvpp/gen/java/io/fd/vpp/jvpp$ ../../../../jvpp_gen.py -idefs_api_vpp_papi.py
  36 #
  37 # Compilation:
  38 # ~/Projects/vpp/vpp-api/jvpp/gen/java/io/fd/vpp/jvpp$ javac *.java dto/*.java callback/*.java
  39 #
  40 # where
  41 # defs_api_vpp_papi.py - vpe.api in python format (generated by vppapigen)
  42
  43 parser = argparse.ArgumentParser(description='VPP Java API generator')
  44 parser.add_argument('-i', action="store", dest="inputfiles", nargs='+')
  45 parser.add_argument('--plugin_name', action="store", dest="plugin_name")
  46 args = parser.parse_args()
  47
  48 sys.path.append(".")
  49
  50 print "Generating Java API for %s" % args.inputfiles
  51 print "inputfiles %s" % args.inputfiles
  52 plugin_name = args.plugin_name
  53 print "plugin_name %s" % plugin_name
  54
  55 cfg = {}
  56
  57 for inputfile in args.inputfiles:
  58     _cfg = json.load(open(inputfile, 'r'))
  59     if 'types' in cfg:
  60         cfg['types'].extend(_cfg['types'])
  61     else:
  62         cfg['types'] = _cfg['types']
  63     if 'messages' in cfg:
  64         cfg['messages'].extend(_cfg['messages'])
  65     else:
  66         cfg['messages'] = _cfg['messages']
  67
  68
  69 def is_request_field(field_name):
  70     return field_name not in {'_vl_msg_id', 'client_index', 'context'}
  71
  72
  73 def is_response_field(field_name):
  74     return field_name not in {'_vl_msg_id'}
  75
  76
  77 def get_args(t, filter):
  78     arg_list = []
  79     for i in t:
  80         if is_crc(i):
  81             continue
  82         if not filter(i[1]):
  83             continue
  84         arg_list.append(i[1])
  85     return arg_list
  86
  87
  88 def get_types(t, filter):
  89     types_list = []
  90     lengths_list = []
  91     crc = None
  92     for i in t:
  93         if is_crc(i):
  94             crc = ('crc', i['crc'][2:])
  95             continue
  96         if not filter(i[1]):
  97             continue
  98         if len(i) is 3:  # array type
  99             types_list.append(i[0] + '[]')
 100             lengths_list.append((i[2], False))
 101         elif len(i) is 4:  # variable length array type
 102             types_list.append(i[0] + '[]')
 103             lengths_list.append((i[3], True))
 104         else:  # primitive type
 105             types_list.append(i[0])
 106             lengths_list.append((0, False))
 107     return types_list, lengths_list, crc
 108
 109
 110 def is_crc(arg):
 111     """ Check whether the argument inside message definition is just crc """
 112     return 'crc' in arg
 113
 114
 115 def get_definitions(defs):
 116     # Pass 1
 117     func_list = []
 118     func_name = {}
 119     for a in defs:
 120         java_name = util.underscore_to_camelcase(a[0])
 121
 122         # For replies include all the arguments except message_id
 123         if util.is_reply(java_name):
 124             types, lengths, crc = get_types(a[1:], is_response_field)
 125             func_name[a[0]] = dict(
 126                 [('name', a[0]), ('java_name', java_name),
 127                  ('args', get_args(a[1:], is_response_field)), ('full_args', get_args(a[1:], lambda x: True)),
 128                  ('types', types), ('lengths', lengths), crc])
 129         # For requests skip message_id, client_id and context
 130         else:
 131             types, lengths, crc = get_types(a[1:], is_request_field)
 132             func_name[a[0]] = dict(
 133                 [('name', a[0]), ('java_name', java_name),
 134                  ('args', get_args(a[1:], is_request_field)), ('full_args', get_args(a[1:], lambda x: True)),
 135                  ('types', types), ('lengths', lengths), crc])
 136
 137         # Indexed by name
 138         func_list.append(func_name[a[0]])
 139     return func_list, func_name
 140
 141
 142 base_package = 'io.fd.vpp.jvpp'
 143 plugin_package = base_package + '.' + plugin_name
 144 types_package = 'types'
 145 dto_package = 'dto'
 146 callback_package = 'callback'
 147 notification_package = 'notification'
 148 future_package = 'future'
 149 # TODO find better package name
 150 callback_facade_package = 'callfacade'
 151
 152 types_list, types_name = get_definitions(cfg['types'])
 153
 154 types_gen.generate_types(types_list, plugin_package, types_package, args.inputfiles)
 155
 156 func_list, func_name = get_definitions(cfg['messages'])
 157
 158 dto_gen.generate_dtos(func_list, base_package, plugin_package, plugin_name.title(), dto_package, args.inputfiles)
 159 jvpp_impl_gen.generate_jvpp(func_list, base_package, plugin_package, plugin_name, dto_package, args.inputfiles)
 160 callback_gen.generate_callbacks(func_list, base_package, plugin_package, plugin_name.title(), callback_package, dto_package, args.inputfiles)
 161 notification_gen.generate_notification_registry(func_list, base_package, plugin_package, plugin_name.title(), notification_package, callback_package, dto_package, args.inputfiles)
 162 jvpp_c_gen.generate_jvpp(func_list, plugin_name, args.inputfiles)
 163 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)
 164 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)
 165
 166 print "Java API for %s generated successfully" % args.inputfiles