java/full/enum.h

0001 // Protocol Buffers - Google's data interchange format
0002 // Copyright 2008 Google Inc.  All rights reserved.
0003 //
0004 // Use of this source code is governed by a BSD-style
0005 // license that can be found in the LICENSE file or at
0006 // https://developers.google.com/open-source/licenses/bsd
0007
0008 // Author: kenton@google.com (Kenton Varda)
0009 //  Based on original Protocol Buffers design by
0010 //  Sanjay Ghemawat, Jeff Dean, and others.
0011
0012 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_H__
0013 #define GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_H__
0014
0015 #include <string>
0016 #include <vector>
0017
0018 #include "google/protobuf/compiler/java/generator_factory.h"
0019 #include "google/protobuf/descriptor.h"
0020
0021 namespace google {
0022 namespace protobuf {
0023 namespace compiler {
0024 namespace java {
0025 class Context;            // context.h
0026 class ClassNameResolver;  // name_resolver.h
0027 }  // namespace java
0028 }  // namespace compiler
0029 namespace io {
0030 class Printer;  // printer.h
0031 }
0032 }  // namespace protobuf
0033 }  // namespace google
0034
0035 namespace google {
0036 namespace protobuf {
0037 namespace compiler {
0038 namespace java {
0039
0040 // This class is in the immutable/ directory, but since the mutable API for
0041 // enums is nearly identical to the immutable one, we also use this for mutable
0042 // enums.  It is used for all enums except lite enums.
0043 class EnumNonLiteGenerator : public EnumGenerator {
0044  public:
0045   EnumNonLiteGenerator(const EnumDescriptor* descriptor, bool immutable_api,
0046                        Context* context);
0047   EnumNonLiteGenerator(const EnumNonLiteGenerator&) = delete;
0048   EnumNonLiteGenerator& operator=(const EnumNonLiteGenerator&) = delete;
0049
0050   void Generate(io::Printer* printer) override;
0051
0052  private:
0053   const EnumDescriptor* descriptor_;
0054
0055   // The proto language allows multiple enum constants to have the same
0056   // numeric value.  Java, however, does not allow multiple enum constants to
0057   // be considered equivalent.  We treat the first defined constant for any
0058   // given numeric value as "canonical" and the rest as aliases of that
0059   // canonical value.
0060   std::vector<const EnumValueDescriptor*> canonical_values_;
0061
0062   struct Alias {
0063     const EnumValueDescriptor* value;
0064     const EnumValueDescriptor* canonical_value;
0065   };
0066   std::vector<Alias> aliases_;
0067
0068   bool immutable_api_;
0069
0070   Context* context_;
0071   ClassNameResolver* name_resolver_;
0072
0073   bool CanUseEnumValues();
0074
0075 };
0076
0077 }  // namespace java
0078 }  // namespace compiler
0079 }  // namespace protobuf
0080 }  // namespace google
0081
0082 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_H__