src/vpp-api/java/jvpp/gen/jvppgen/util.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, pprint
  17 from os import removedirs
  18
  19
  20 def underscore_to_camelcase(name):
  21     name = name.title().replace("_", "")
  22     return name[0].lower() + name[1:]
  23
  24
  25 def underscore_to_camelcase_upper(name):
  26     name = name.title().replace("_", "")
  27     return name[0].upper() + name[1:]
  28
  29
  30 def remove_folder(folder):
  31     """ Remove folder with all its files """
  32     for root, dirs, files in os.walk(folder, topdown=False):
  33         for name in files:
  34             os.remove(os.path.join(root, name))
  35         removedirs(folder)
  36
  37
  38 reply_suffixes = ("reply", "details")
  39
  40
  41 def is_reply(name):
  42     return name.lower().endswith(reply_suffixes)
  43
  44
  45 def is_details(name):
  46     return name.lower().endswith(reply_suffixes[1])
  47
  48
  49 def is_retval_field(name):
  50     return name == 'retval'
  51
  52 dump_suffix = "dump"
  53
  54
  55 def is_dump(name):
  56     return name.lower().endswith(dump_suffix)
  57
  58
  59 def get_reply_suffix(name):
  60     for reply_suffix in reply_suffixes:
  61         if name.lower().endswith(reply_suffix):
  62             return reply_suffix
  63
  64 # Mapping according to:
  65 # http://docs.oracle.com/javase/7/docs/technotes/guides/jni/spec/types.html
  66 #
  67 # Unsigned types are converted to signed java types that have the same size.
  68 # It is the API user responsibility to interpret them correctly.
  69 jni_2_java_type_mapping = {'u8': 'byte',
  70                            'u8[]': 'byte[]',
  71                            'i8': 'byte',
  72                            'i8[]': 'byte[]',
  73                            'u16': 'short',
  74                            'u16[]': 'short[]',
  75                            'i16': 'short',
  76                            'i16[]': 'short[]',
  77                            'u32': 'int',
  78                            'u32[]': 'int[]',
  79                            'i32': 'int',
  80                            'i32[]': 'int[]',
  81                            'u64': 'long',
  82                            'u64[]': 'long[]',
  83                            'i64': 'long',
  84                            'i64[]': 'long[]',
  85                            'f64': 'double',
  86                            'f64[]': 'double[]'
  87                            }
  88
  89 vpp_2_jni_type_mapping = {'u8': 'jbyte',
  90                           'u8[]': 'jbyteArray',
  91                           'i8': 'jbyte',
  92                           'i8[]': 'jbyteArray',
  93                           'u16': 'jshort',
  94                           'u16[]': 'jshortArray',
  95                           'i16': 'jshort',
  96                           'i16[]': 'jshortArray',
  97                           'u32': 'jint',
  98                           'u32[]': 'jintArray',
  99                           'i32': 'jint',
 100                           'i32[]': 'jintArray',
 101                           'u64': 'jlong',
 102                           'u64[]': 'jlongArray',
 103                           'i64': 'jlong',
 104                           'i64[]': 'jlongArray',
 105                           'f64': 'jdouble',
 106                           'f64[]': 'jdoubleArray'
 107                           }
 108
 109 # https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/types.html#type_signatures
 110 jni_2_signature_mapping = {'u8': 'B',
 111                            'u8[]': '[B',
 112                            'i8': 'B',
 113                            'i8[]': '[B',
 114                            'u16': 'S',
 115                            'u16[]': '[S',
 116                            'i16': 'S',
 117                            'i16[]': '[S',
 118                            'u32': 'I',
 119                            'u32[]': '[I',
 120                            'i32': 'I',
 121                            'i32[]': '[I',
 122                            'u64': 'J',
 123                            'u64[]': '[J',
 124                            'i64': 'J',
 125                            'i64[]': '[J',
 126                            'f64': 'D',
 127                            'f64[]': '[D'
 128                            }
 129
 130 # https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/functions.html#Get_type_Field_routines
 131 jni_field_accessors =  {'u8': 'ByteField',
 132                         'u8[]': 'ObjectField',
 133                         'i8': 'ByteField',
 134                         'i8[]': 'ObjectField',
 135                         'u16': 'ShortField',
 136                         'u16[]': 'ObjectField',
 137                         'i16': 'ShortField',
 138                         'i16[]': 'ObjectField',
 139                         'u32': 'IntField',
 140                         'u32[]': 'ObjectField',
 141                         'i32': 'IntField',
 142                         'i32[]': 'ObjectField',
 143                         'u64': 'LongField',
 144                         'u64[]': 'ObjectField',
 145                         'i64': 'LongField',
 146                         'i64[]': 'ObjectField',
 147                         'f64': 'DoubleField',
 148                         'f64[]': 'ObjectField'
 149                         }
 150
 151 # FIXME no convention in the naming of events (notifications) in vpe.api
 152 notifications_message_suffixes = ("event", "counters")
 153
 154 def is_notification(name):
 155     """ Returns true if the structure is a notification regardless of its no other use """
 156     return is_just_notification(name)
 157
 158
 159 def is_just_notification(name):
 160     """ Returns true if the structure is just a notification and has no other use """
 161     return name.lower().endswith(notifications_message_suffixes)
 162
 163
 164 def remove_reply_suffix(camel_case_name_with_suffix):
 165     return remove_suffix(camel_case_name_with_suffix, get_reply_suffix(camel_case_name_with_suffix))
 166
 167
 168 def remove_suffix(camel_case_name_with_suffix, suffix):
 169     if not suffix:
 170         return camel_case_name_with_suffix
 171     suffix_length = len(suffix)
 172     return camel_case_name_with_suffix[:-suffix_length] if suffix_length != 0 else camel_case_name_with_suffix
 173
 174
 175 def is_control_ping(camel_case_name_with_suffix):
 176     return camel_case_name_with_suffix.lower().startswith("controlping")
 177
 178
 179 def api_message_to_javadoc(api_message):
 180     """ Converts vpe.api message description to javadoc """
 181     str = pprint.pformat(api_message, indent=4, width=120, depth=None)
 182     return " * " + str.replace("\n", "\n * ")
 183
 184
 185 notification_dto_suffix = "Notification"
 186
 187
 188 def add_notification_suffix(camel_case_dto_name):
 189     camel_case_dto_name += notification_dto_suffix
 190     return camel_case_dto_name
 191
 192
 193 def is_array(java_type_as_string):
 194     return java_type_as_string.endswith("[]")
 195
 196 def is_want(name):
 197     return name.startswith("want_")