1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
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#include <string>
43
44namespace google {
45namespace protobuf {
46  class EnumDescriptor;
47}  // namespace protobuf
48
49namespace protobuf {
50
51// Returns the EnumDescriptor for enum type E, which must be a
52// proto-declared enum type.  Code generated by the protocol compiler
53// will include specializations of this template for each enum type declared.
54template <typename E>
55const EnumDescriptor* GetEnumDescriptor();
56
57namespace internal {
58
59// Helper for EnumType_Parse functions: try to parse the string 'name' as an
60// enum name of the given type, returning true and filling in value on success,
61// or returning false and leaving value unchanged on failure.
62LIBPROTOBUF_EXPORT bool ParseNamedEnum(const EnumDescriptor* descriptor,
63                    const string& name,
64                    int* value);
65
66template<typename EnumType>
67bool ParseNamedEnum(const EnumDescriptor* descriptor,
68                    const string& name,
69                    EnumType* value) {
70  int tmp;
71  if (!ParseNamedEnum(descriptor, name, &tmp)) return false;
72  *value = static_cast<EnumType>(tmp);
73  return true;
74}
75
76// Just a wrapper around printing the name of a value. The main point of this
77// function is not to be inlined, so that you can do this without including
78// descriptor.h.
79LIBPROTOBUF_EXPORT const string& NameOfEnum(const EnumDescriptor* descriptor, int value);
80
81}  // namespace internal
82}  // namespace protobuf
83
84}  // namespace google
85#endif  // GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
86