generated_enum_reflection.h 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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. // Author: jasonh@google.com (Jason Hsueh)
  31. //
  32. // This header is logically internal, but is made public because it is used
  33. // from protocol-compiler-generated code, which may reside in other components.
  34. // It provides reflection support for generated enums, and is included in
  35. // generated .pb.h files and should have minimal dependencies. The methods are
  36. // implemented in generated_message_reflection.cc.
  37. #ifndef GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
  38. #define GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__
  39. #include <string>
  40. #include <google/protobuf/stubs/template_util.h>
  41. namespace google {
  42. namespace protobuf {
  43. class EnumDescriptor;
  44. } // namespace protobuf
  45. namespace protobuf {
  46. // This type trait can be used to cause templates to only match proto2 enum
  47. // types.
  48. template <typename T> struct is_proto_enum : ::google::protobuf::internal::false_type {};
  49. // Returns the EnumDescriptor for enum type E, which must be a
  50. // proto-declared enum type. Code generated by the protocol compiler
  51. // will include specializations of this template for each enum type declared.
  52. template <typename E>
  53. const EnumDescriptor* GetEnumDescriptor();
  54. namespace internal {
  55. // Helper for EnumType_Parse functions: try to parse the string 'name' as an
  56. // enum name of the given type, returning true and filling in value on success,
  57. // or returning false and leaving value unchanged on failure.
  58. LIBPROTOBUF_EXPORT bool ParseNamedEnum(const EnumDescriptor* descriptor,
  59. const string& name,
  60. int* value);
  61. template<typename EnumType>
  62. bool ParseNamedEnum(const EnumDescriptor* descriptor,
  63. const string& name,
  64. EnumType* value) {
  65. int tmp;
  66. if (!ParseNamedEnum(descriptor, name, &tmp)) return false;
  67. *value = static_cast<EnumType>(tmp);
  68. return true;
  69. }
  70. // Just a wrapper around printing the name of a value. The main point of this
  71. // function is not to be inlined, so that you can do this without including
  72. // descriptor.h.
  73. LIBPROTOBUF_EXPORT const string& NameOfEnum(const EnumDescriptor* descriptor, int value);
  74. } // namespace internal
  75. } // namespace protobuf
  76. } // namespace google
  77. #endif // GOOGLE_PROTOBUF_GENERATED_ENUM_REFLECTION_H__