src/vpp-api/java/jvpp/gen/jvppgen/jvpp_common_gen.py

   1 #!/usr/bin/env python2
   2 #
   3 # Copyright (c) 2018 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 from string import Template
  16
  17 from jvpp_model import is_array
  18
  19
  20 def generate_fields(fields):
  21     return "\n".join(_FIELD_TEMPLATE.substitute(type=f.type.java_name_fqn, name=f.java_name) for f in fields)
  22
  23 _FIELD_TEMPLATE = Template("""    public $type $name;""")
  24
  25
  26 def generate_hash_code(fields):
  27     if len(fields) == 1 and is_array(fields[0]):
  28         return _HASH_CODE_SINGLE_ARRAY_TEMPLATE.substitute(array_field=fields[0].java_name)
  29     return _HASH_CODE_TEMPLATE.substitute(fields=", ".join(f.java_name for f in fields))
  30
  31 _HASH_CODE_TEMPLATE = Template("""
  32     @Override
  33     @io.fd.vpp.jvpp.coverity.SuppressFBWarnings("UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD")
  34     public int hashCode() {
  35         return java.util.Objects.hash($fields);
  36     }""")
  37
  38 _HASH_CODE_SINGLE_ARRAY_TEMPLATE = Template("""
  39     @Override
  40     @io.fd.vpp.jvpp.coverity.SuppressFBWarnings("UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD")
  41     public int hashCode() {
  42         return java.util.Arrays.hashCode($array_field);
  43     }""")
  44
  45
  46 def generate_equals(class_name, fields):
  47     comparisons = []
  48     for f in fields:
  49         if is_array(f):
  50             comparisons.append(_EQUALS_ARRAY_FIELD_TEMPLATE.substitute(field_name=f.java_name))
  51         else:
  52             comparisons.append(_EQUALS_FIELD_TEMPLATE.substitute(field_name=f.java_name))
  53
  54     if comparisons:
  55         comparisons.insert(0, _EQUALS_OTHER_TEMPLATE.substitute(cls_name=class_name))
  56     return _EQUALS_TEMPLATE.substitute(comparisons="\n".join(comparisons))
  57
  58 _EQUALS_TEMPLATE = Template("""
  59     @Override
  60     public boolean equals(final Object o) {
  61         if (this == o) {
  62             return true;
  63         }
  64         if (o == null || getClass() != o.getClass()) {
  65             return false;
  66         }
  67 $comparisons
  68
  69         return true;
  70     }""")
  71
  72 _EQUALS_OTHER_TEMPLATE = Template("""
  73         final $cls_name other = ($cls_name) o;
  74 """)
  75
  76 _EQUALS_FIELD_TEMPLATE = Template("""        if (!java.util.Objects.equals(this.$field_name, other.$field_name)) {
  77             return false;
  78         }""")
  79
  80 _EQUALS_ARRAY_FIELD_TEMPLATE = Template("""        if (!java.util.Arrays.equals(this.$field_name, other.$field_name)) {
  81             return false;
  82         }""")
  83
  84
  85 def generate_to_string(class_name, fields):
  86     to_string = []
  87     for f in fields:
  88         if is_array(f):
  89             to_string.append(_TO_STRING_ARRAY_FIELD_TEMPLATE.substitute(field_name=f.java_name))
  90         else:
  91             to_string.append(_TO_STRING_FIELD_TEMPLATE.substitute(field_name=f.java_name))
  92
  93     to_string_fields = " \"}\";"
  94     if to_string:
  95         to_string_fields = " + \", \" +\n".join(to_string) + " + \"}\";"
  96
  97     return _TO_STRING_TEMPLATE.substitute(
  98         class_name=class_name,
  99         to_string_fields=to_string_fields
 100     )
 101
 102 _TO_STRING_TEMPLATE = Template("""
 103     @Override
 104     public String toString() {
 105         return "$class_name{" +
 106 $to_string_fields
 107     }""")
 108
 109 _TO_STRING_FIELD_TEMPLATE = Template("""                \"$field_name=\" + $field_name""")
 110
 111 _TO_STRING_ARRAY_FIELD_TEMPLATE = Template(
 112     """                \"$field_name=\" + java.util.Arrays.toString($field_name)""")