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 #include <map>
36 #include <string>
37
38 #include <google/protobuf/compiler/javanano/javanano_params.h>
39 #include <google/protobuf/compiler/javanano/javanano_enum.h>
40 #include <google/protobuf/compiler/javanano/javanano_helpers.h>
41 #include <google/protobuf/io/printer.h>
42 #include <google/protobuf/descriptor.pb.h>
43 #include <google/protobuf/stubs/strutil.h>
44
45 namespace google {
46 namespace protobuf {
47 namespace compiler {
48 namespace javanano {
49
EnumGenerator(const EnumDescriptor * descriptor,const Params & params)50 EnumGenerator::EnumGenerator(const EnumDescriptor* descriptor, const Params& params)
51 : params_(params), descriptor_(descriptor) {
52 for (int i = 0; i < descriptor_->value_count(); i++) {
53 const EnumValueDescriptor* value = descriptor_->value(i);
54 const EnumValueDescriptor* canonical_value =
55 descriptor_->FindValueByNumber(value->number());
56
57 if (value == canonical_value) {
58 canonical_values_.push_back(value);
59 } else {
60 Alias alias;
61 alias.value = value;
62 alias.canonical_value = canonical_value;
63 aliases_.push_back(alias);
64 }
65 }
66 }
67
~EnumGenerator()68 EnumGenerator::~EnumGenerator() {}
69
Generate(io::Printer * printer)70 void EnumGenerator::Generate(io::Printer* printer) {
71 printer->Print(
72 "\n"
73 "// enum $classname$\n",
74 "classname", descriptor_->name());
75
76 const string classname = RenameJavaKeywords(descriptor_->name());
77
78 // Start of container interface
79 // If generating intdefs, we use the container interface as the intdef if
80 // present. Otherwise, we just make an empty @interface parallel to the
81 // constants.
82 bool use_intdef = params_.generate_intdefs();
83 bool use_shell_class = params_.java_enum_style();
84 if (use_intdef) {
85 // @IntDef annotation so tools can enforce correctness
86 // Annotations will be discarded by the compiler
87 printer->Print("@java.lang.annotation.Retention("
88 "java.lang.annotation.RetentionPolicy.SOURCE)\n"
89 "@android.support.annotation.IntDef({\n");
90 printer->Indent();
91 for (int i = 0; i < canonical_values_.size(); i++) {
92 const string constant_name =
93 RenameJavaKeywords(canonical_values_[i]->name());
94 if (use_shell_class) {
95 printer->Print("$classname$.$name$,\n",
96 "classname", classname,
97 "name", constant_name);
98 } else {
99 printer->Print("$name$,\n", "name", constant_name);
100 }
101 }
102 printer->Outdent();
103 printer->Print("})\n");
104 }
105 if (use_shell_class || use_intdef) {
106 printer->Print(
107 "public $at_for_intdef$interface $classname$ {\n",
108 "classname", classname,
109 "at_for_intdef", use_intdef ? "@" : "");
110 if (use_shell_class) {
111 printer->Indent();
112 } else {
113 printer->Print("}\n\n");
114 }
115 }
116
117 // Canonical values
118 for (int i = 0; i < canonical_values_.size(); i++) {
119 printer->Print(
120 "public static final int $name$ = $canonical_value$;\n",
121 "name", RenameJavaKeywords(canonical_values_[i]->name()),
122 "canonical_value", SimpleItoa(canonical_values_[i]->number()));
123 }
124
125 // Aliases
126 for (int i = 0; i < aliases_.size(); i++) {
127 printer->Print(
128 "public static final int $name$ = $canonical_name$;\n",
129 "name", RenameJavaKeywords(aliases_[i].value->name()),
130 "canonical_name", RenameJavaKeywords(aliases_[i].canonical_value->name()));
131 }
132
133 // End of container interface
134 if (use_shell_class) {
135 printer->Outdent();
136 printer->Print("}\n");
137 }
138 }
139
140 } // namespace javanano
141 } // namespace compiler
142 } // namespace protobuf
143 } // namespace google
144