aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/google/protobuf/unknown_enum_impl.h
blob: 7c68ad6c4f19d2806e135253190328b75e797ab1 (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef GOOGLE_PROTOBUF_UTIL_UNKNOWN_ENUM_IMPL_H__
#define GOOGLE_PROTOBUF_UTIL_UNKNOWN_ENUM_IMPL_H__

#include <stdlib.h>

#include <google/protobuf/stubs/common.h>
#include <google/protobuf/bridge/compatibility_mode_support.h>

namespace google {
namespace protobuf {

// google/protobuf/message.h
class Message;

namespace util {

// NOTE: You should not call these functions directly.  Instead use either
// HAS_UNKNOWN_ENUM() or GET_UNKNOWN_ENUM(), defined in the public header.
// The macro-versions operate in a type-safe manner and behave appropriately
// for the proto version of the message, whereas these versions assume a
// specific proto version and allow the caller to pass in any arbitrary integer
// value as a field number.
//
// Returns whether the message has unrecognized the enum value for a given
// field. It also stores the value into the unknown_value parameter if the
// function returns true and the pointer is not NULL.
//
// In proto2, invalid enum values will be treated as unknown fields. This
// function checks that case.
bool HasUnknownEnum(const Message& message, int32 field_number,
                    int32* unknown_value = NULL);
// Same as above, but returns all unknown enums.
bool GetRepeatedEnumUnknowns(const Message& message, int32 field_number,
                             vector<int32>* unknown_values = NULL);
// In proto1, invalue enum values are stored in the same way as valid enum
// values.
// TODO(karner): Delete this once the migration to proto2 is complete.
bool HasUnknownEnumProto1(const Message& message, int32 field_number,
                          int32* unknown_value);
// Same as above, but returns all unknown enums.
bool GetRepeatedEnumUnknownsProto1(const Message& message, int32 field_number,
                                   vector<int32>* unknown_values);
// Invokes the appropriate version based on whether the message is proto1
// or proto2.
template <typename T>
bool HasUnknownEnum_Template(const T& message, int32 field_number,
                             int32* unknown_value = NULL) {
  if (internal::is_base_of<bridge::internal::Proto1CompatibleMessage, T>::value ||
      !internal::is_base_of<ProtocolMessage, T>::value) {
    return HasUnknownEnum(message, field_number, unknown_value);
  } else {
    return HasUnknownEnumProto1(message, field_number, unknown_value);
  }
}
// Invokes the appropriate version based on whether the message is proto1
// or proto2.
template <typename T>
bool GetRepeatedEnumUnknowns_Template(
    const T& message, int32 field_number,
    vector<int32>* unknown_values = NULL) {
  if (internal::is_base_of<bridge::internal::Proto1CompatibleMessage, T>::value ||
      !internal::is_base_of<ProtocolMessage, T>::value) {
    return GetRepeatedEnumUnknowns(message, field_number, unknown_values);
  } else {
    return GetRepeatedEnumUnknownsProto1(message, field_number,
                                         unknown_values);
  }
}

// NOTE: You should not call these functions directly.  Instead use
// CLEAR_UNKNOWN_ENUM(), defined in the public header.  The macro-versions
// operate in a type-safe manner and behave appropriately for the proto
// version of the message, whereas these versions assume a specific proto
// version and allow the caller to pass in any arbitrary integer value as a
// field number.
//
// Clears the unknown entries of the given field of the message.
void ClearUnknownEnum(Message* message, int32 field_number);
// In proto1, clears the field if the value is out of range.
// TODO(karner): Delete this or make it proto2-only once the migration
// to proto2 is complete.
void ClearUnknownEnumProto1(Message* message, int32 field_number);
template <typename T>
void ClearUnknownEnum_Template(T* message, int32 field_number) {
  if (internal::is_base_of<bridge::internal::Proto1CompatibleMessage, T>::value ||
      !internal::is_base_of<ProtocolMessage, T>::value) {
    ClearUnknownEnum(message, field_number);
  } else {
    ClearUnknownEnumProto1(message, field_number);
  }
}

// NOTE: You should not call these functions directly.  Instead use
// SET_UNKNOWN_ENUM(), defined in the public header.  The macro-versions
// operate in a type-safe manner and behave appropriately for the proto
// version of the message, whereas these versions assume a specific proto
// version and allow the caller to pass in any arbitrary integer value as a
// field number.
//
// Sets the given value in the unknown fields of the message.
void SetUnknownEnum(Message* message, int32 field_number, int32 unknown_value);
// In proto1, invalue enum values are stored in the same way as valid enum
// values.
// TODO(karner): Delete this once the migration to proto2 is complete.
void SetUnknownEnumProto1(Message* message, int32 field_number,
                          int32 unknown_value);
// Invokes the appropriate version based on whether the message is proto1
// or proto2.
template <typename T>
void SetUnknownEnum_Template(T* message, int32 field_number,
                             int32 unknown_value) {
  if (internal::is_base_of<bridge::internal::Proto1CompatibleMessage, T>::value ||
      !internal::is_base_of<ProtocolMessage, T>::value) {
    SetUnknownEnum(message, field_number, unknown_value);
  } else {
    SetUnknownEnumProto1(message, field_number, unknown_value);
  }
}

}  // namespace util
}  // namespace protobuf

}  // namespace google
#endif  // GOOGLE_PROTOBUF_UTIL_UNKNOWN_ENUM_IMPL_H__