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