summaryrefslogtreecommitdiffstats
path: root/src/vpp-api/java/jvpp/gen/jvppgen/jvpp_common_gen.py
blob: 73615ca71783ba62abaf371b2b096f95a03df75f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
#!/usr/bin/env python2
#
# Copyright (c) 2018 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from string import Template

from jvpp_model import is_array


def generate_fields(fields):
    return "\n".join(_FIELD_TEMPLATE.substitute(type=f.type.java_name_fqn, name=f.java_name) for f in fields)

_FIELD_TEMPLATE = Template("""    public $type $name;""")


def generate_hash_code(fields):
    if len(fields) == 1 and is_array(fields[0]):
        return _HASH_CODE_SINGLE_ARRAY_TEMPLATE.substitute(array_field=fields[0].java_name)
    return _HASH_CODE_TEMPLATE.substitute(fields=", ".join(f.java_name for f in fields))

_HASH_CODE_TEMPLATE = Template("""
    @Override
    @io.fd.vpp.jvpp.coverity.SuppressFBWarnings("UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD")
    public int hashCode() {
        return java.util.Objects.hash($fields);
    }""")

_HASH_CODE_SINGLE_ARRAY_TEMPLATE = Template("""
    @Override
    @io.fd.vpp.jvpp.coverity.SuppressFBWarnings("UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD")
    public int hashCode() {
        return java.util.Arrays.hashCode($array_field);
    }""")


def generate_equals(class_name, fields):
    comparisons = []
    for f in fields:
        if is_array(f):
            comparisons.append(_EQUALS_ARRAY_FIELD_TEMPLATE.substitute(field_name=f.java_name))
        else:
            comparisons.append(_EQUALS_FIELD_TEMPLATE.substitute(field_name=f.java_name))

    if comparisons:
        comparisons.insert(0, _EQUALS_OTHER_TEMPLATE.substitute(cls_name=class_name))
    return _EQUALS_TEMPLATE.substitute(comparisons="\n".join(comparisons))

_EQUALS_TEMPLATE = Template("""
    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
$comparisons

        return true;
    }""")

_EQUALS_OTHER_TEMPLATE = Template("""
        final $cls_name other = ($cls_name) o;
""")

_EQUALS_FIELD_TEMPLATE = Template("""        if (!java.util.Objects.equals(this.$field_name, other.$field_name)) {
            return false;
        }""")

_EQUALS_ARRAY_FIELD_TEMPLATE = Template("""        if (!java.util.Arrays.equals(this.$field_name, other.$field_name)) {
            return false;
        }""")


def generate_to_string(class_name, fields):
    to_string = []
    for f in fields:
        if is_array(f):
            to_string.append(_TO_STRING_ARRAY_FIELD_TEMPLATE.substitute(field_name=f.java_name))
        else:
            to_string.append(_TO_STRING_FIELD_TEMPLATE.substitute(field_name=f.java_name))

    to_string_fields = " \"}\";"
    if to_string:
        to_string_fields = " + \", \" +\n".join(to_string) + " + \"}\";"

    return _TO_STRING_TEMPLATE.substitute(
        class_name=class_name,
        to_string_fields=to_string_fields
    )

_TO_STRING_TEMPLATE = Template("""
    @Override
    public String toString() {
        return "$class_name{" +
$to_string_fields
    }""")

_TO_STRING_FIELD_TEMPLATE = Template("""                \"$field_name=\" + $field_name""")

_TO_STRING_ARRAY_FIELD_TEMPLATE = Template(
    """                \"$field_name=\" + java.util.Arrays.toString($field_name)""")