cpp_enum.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  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: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. #ifndef GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__
  34. #define GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__
  35. #include <map>
  36. #include <set>
  37. #include <string>
  38. #include <google/protobuf/compiler/cpp/cpp_options.h>
  39. #include <google/protobuf/descriptor.h>
  40. namespace google {
  41. namespace protobuf {
  42. namespace io {
  43. class Printer; // printer.h
  44. }
  45. }
  46. namespace protobuf {
  47. namespace compiler {
  48. namespace cpp {
  49. class EnumGenerator {
  50. public:
  51. // See generator.cc for the meaning of dllexport_decl.
  52. EnumGenerator(const EnumDescriptor* descriptor, const Options& options);
  53. ~EnumGenerator();
  54. // Header stuff.
  55. // Fills the name to use when declaring the enum. This is for use when
  56. // generating other .proto.h files. This code should be placed within the
  57. // enum's package namespace, but NOT within any class, even for nested
  58. // enums. A given key in enum_names will map from an enum class name to the
  59. // EnumDescriptor that was responsible for its inclusion in the map. This can
  60. // be used to associate the descriptor with the code generated for it.
  61. void FillForwardDeclaration(
  62. std::map<string, const EnumDescriptor*>* enum_names);
  63. // Generate header code defining the enum. This code should be placed
  64. // within the enum's package namespace, but NOT within any class, even for
  65. // nested enums.
  66. void GenerateDefinition(io::Printer* printer);
  67. // Generate specialization of GetEnumDescriptor<MyEnum>().
  68. // Precondition: in ::google::protobuf namespace.
  69. void GenerateGetEnumDescriptorSpecializations(io::Printer* printer);
  70. // For enums nested within a message, generate code to import all the enum's
  71. // symbols (e.g. the enum type name, all its values, etc.) into the class's
  72. // namespace. This should be placed inside the class definition in the
  73. // header.
  74. void GenerateSymbolImports(io::Printer* printer);
  75. // Source file stuff.
  76. // Generate non-inline methods related to the enum, such as IsValidValue().
  77. // Goes in the .cc file. EnumDescriptors are stored in an array, idx is
  78. // the index in this array that corresponds with this enum.
  79. void GenerateMethods(int idx, io::Printer* printer);
  80. private:
  81. const EnumDescriptor* descriptor_;
  82. const string classname_;
  83. const Options& options_;
  84. // whether to generate the *_ARRAYSIZE constant.
  85. const bool generate_array_size_;
  86. friend class FileGenerator;
  87. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator);
  88. };
  89. } // namespace cpp
  90. } // namespace compiler
  91. } // namespace protobuf
  92. } // namespace google
  93. #endif // GOOGLE_PROTOBUF_COMPILER_CPP_ENUM_H__