• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #include <string>
43 
44 #include <google/protobuf/generated_enum_util.h>
45 #include <google/protobuf/port.h>
46 
47 #ifdef SWIG
48 #error "You cannot SWIG proto headers"
49 #endif
50 
51 #include <google/protobuf/port_def.inc>
52 
53 namespace google {
54 namespace protobuf {
55 class EnumDescriptor;
56 }  // namespace protobuf
57 }  // namespace google
58 
59 namespace google {
60 namespace protobuf {
61 
62 // Returns the EnumDescriptor for enum type E, which must be a
63 // proto-declared enum type.  Code generated by the protocol compiler
64 // will include specializations of this template for each enum type declared.
65 template <typename E>
66 const EnumDescriptor* GetEnumDescriptor();
67 
68 namespace internal {
69 
70 // Helper for EnumType_Parse functions: try to parse the string 'name' as
71 // an enum name of the given type, returning true and filling in value on
72 // success, or returning false and leaving value unchanged on failure.
73 PROTOBUF_EXPORT bool ParseNamedEnum(const EnumDescriptor* descriptor,
74                                     const std::string& name, int* value);
75 
76 template <typename EnumType>
ParseNamedEnum(const EnumDescriptor * descriptor,const std::string & name,EnumType * value)77 bool ParseNamedEnum(const EnumDescriptor* descriptor, const std::string& name,
78                     EnumType* value) {
79   int tmp;
80   if (!ParseNamedEnum(descriptor, name, &tmp)) return false;
81   *value = static_cast<EnumType>(tmp);
82   return true;
83 }
84 
85 // Just a wrapper around printing the name of a value. The main point of this
86 // function is not to be inlined, so that you can do this without including
87 // descriptor.h.
88 PROTOBUF_EXPORT const std::string& NameOfEnum(const EnumDescriptor* descriptor,
89                                               int value);
90 
91 }  // namespace internal
92 }  // namespace protobuf
93 }  // namespace google
94 
95 #include <google/protobuf/port_undef.inc>
96 
97 #endif  // GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
98