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: 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
42namespace google {
43namespace protobuf {
44  namespace compiler {
45    namespace java {
46      class Context;           // context.h
47      class ClassNameResolver; // name_resolver.h
48    }
49  }
50  namespace io {
51    class Printer;             // printer.h
52  }
53}
54
55namespace protobuf {
56namespace compiler {
57namespace java {
58
59class EnumGenerator {
60 public:
61  explicit EnumGenerator(const EnumDescriptor* descriptor,
62                         bool immutable_api,
63                         Context* context);
64  ~EnumGenerator();
65
66  void Generate(io::Printer* printer);
67
68 private:
69  const EnumDescriptor* descriptor_;
70
71  // The proto language allows multiple enum constants to have the same numeric
72  // value.  Java, however, does not allow multiple enum constants to be
73  // considered equivalent.  We treat the first defined constant for any
74  // given numeric value as "canonical" and the rest as aliases of that
75  // canonical value.
76  vector<const EnumValueDescriptor*> canonical_values_;
77
78  struct Alias {
79    const EnumValueDescriptor* value;
80    const EnumValueDescriptor* canonical_value;
81  };
82  vector<Alias> aliases_;
83
84  bool immutable_api_;
85
86  Context* context_;
87  ClassNameResolver* name_resolver_;
88
89  bool CanUseEnumValues();
90
91  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumGenerator);
92};
93
94}  // namespace java
95}  // namespace compiler
96}  // namespace protobuf
97
98}  // namespace google
99#endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_H__
100