1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc. All rights reserved.
3// https://developers.google.com/protocol-buffers/
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
9// * Redistributions of source code must retain the above copyright
10// notice, this list of conditions and the following disclaimer.
11// * Redistributions in binary form must reproduce the above
12// copyright notice, this list of conditions and the following disclaimer
13// in the documentation and/or other materials provided with the
14// distribution.
15// * Neither the name of Google Inc. nor the names of its
16// contributors may be used to endorse or promote products derived from
17// this software without specific prior written permission.
18//
19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31// Author: jasonh@google.com (Jason Hsueh)
32//
33// This header is logically internal, but is made public because it is used
34// from protocol-compiler-generated code, which may reside in other components.
35// It provides reflection support for generated enums, and is included in
36// generated .pb.h files and should have minimal dependencies. The methods are
37// implemented in generated_message_reflection.cc.
38
39#ifndef GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
40#define GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
41
42
43#include <string>
44
45#include <google/protobuf/port.h>
46#include <google/protobuf/stubs/strutil.h>
47#include <google/protobuf/generated_enum_util.h>
48
49#ifdef SWIG
50#error "You cannot SWIG proto headers"
51#endif
52
53// Must be included last.
54#include <google/protobuf/port_def.inc>
55
56namespace google {
57namespace protobuf {
58class EnumDescriptor;
59} // namespace protobuf
60} // namespace google
61
62namespace google {
63namespace protobuf {
64
65// Returns the EnumDescriptor for enum type E, which must be a
66// proto-declared enum type. Code generated by the protocol compiler
67// will include specializations of this template for each enum type declared.
68template <typename E>
69const EnumDescriptor* GetEnumDescriptor();
70
71namespace internal {
72
73// Helper for EnumType_Parse functions: try to parse the string 'name' as
74// an enum name of the given type, returning true and filling in value on
75// success, or returning false and leaving value unchanged on failure.
76PROTOBUF_EXPORT bool ParseNamedEnum(const EnumDescriptor* descriptor,
77 ConstStringParam name, int* value);
78
79template <typename EnumType>
80bool ParseNamedEnum(const EnumDescriptor* descriptor, ConstStringParam name,
81 EnumType* value) {
82 int tmp;
83 if (!ParseNamedEnum(descriptor, name, value: &tmp)) return false;
84 *value = static_cast<EnumType>(tmp);
85 return true;
86}
87
88// Just a wrapper around printing the name of a value. The main point of this
89// function is not to be inlined, so that you can do this without including
90// descriptor.h.
91PROTOBUF_EXPORT const std::string& NameOfEnum(const EnumDescriptor* descriptor,
92 int value);
93
94} // namespace internal
95} // namespace protobuf
96} // namespace google
97
98#include <google/protobuf/port_undef.inc>
99
100#endif // GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
101