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