src/third_party/protobuf/src/google/protobuf/compiler/java/java_enum.h

   1 // Protocol Buffers - Google's data interchange format
   2 // Copyright 2008 Google Inc.  All rights reserved.
   3 // http://code.google.com/p/protobuf/
   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: kenton@google.com (Kenton Varda)
  32 //  Based on original Protocol Buffers design by
  33 //  Sanjay Ghemawat, Jeff Dean, and others.
  34
  35 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_H__
  36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_H__
  37
  38 #include <string>
  39 #include <vector>
  40 #include <google/protobuf/descriptor.h>
  41
  42 namespace google {
  43 namespace protobuf {
  44   namespace io {
  45     class Printer;             // printer.h
  46   }
  47 }
  48
  49 namespace protobuf {
  50 namespace compiler {
  51 namespace java {
  52
  53 class EnumGenerator {
  54  public:
  55   explicit EnumGenerator(const EnumDescriptor* descriptor);
  56   ~EnumGenerator();
  57
  58   void Generate(io::Printer* printer);
  59
  60  private:
  61   const EnumDescriptor* descriptor_;
  62
  63   // The proto language allows multiple enum constants to have the same numeric
  64   // value.  Java, however, does not allow multiple enum constants to be
  65   // considered equivalent.  We treat the first defined constant for any
  66   // given numeric value as "canonical" and the rest as aliases of that
  67   // canonical value.
  68   vector<const EnumValueDescriptor*> canonical_values_;
  69
  70   struct Alias {
  71     const EnumValueDescriptor* value;
  72     const EnumValueDescriptor* canonical_value;
  73   };
  74   vector<Alias> aliases_;
  75
  76   bool CanUseEnumValues();
  77
  78   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator);
  79 };
  80
  81 }  // namespace java
  82 }  // namespace compiler
  83 }  // namespace protobuf
  84
  85 }  // namespace google
  86 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_H__