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#ifndef GOOGLE_PROTOBUF_COMPILER_CSHARP_FIELD_BASE_H__
32#define GOOGLE_PROTOBUF_COMPILER_CSHARP_FIELD_BASE_H__
33
34#include <string>
35#include <google/protobuf/stubs/strutil.h>
36
37#include <google/protobuf/compiler/code_generator.h>
38#include <google/protobuf/compiler/csharp/csharp_source_generator_base.h>
39#include <google/protobuf/descriptor.h>
40#include <google/protobuf/io/printer.h>
41
42namespace google {
43namespace protobuf {
44namespace compiler {
45namespace csharp {
46
47class FieldGeneratorBase : public SourceGeneratorBase {
48 public:
49 FieldGeneratorBase(const FieldDescriptor* descriptor,
50 int presenceIndex,
51 const Options* options);
52 ~FieldGeneratorBase();
53
54 FieldGeneratorBase(const FieldGeneratorBase&) = delete;
55 FieldGeneratorBase& operator=(const FieldGeneratorBase&) = delete;
56
57 virtual void GenerateCloningCode(io::Printer* printer) = 0;
58 virtual void GenerateFreezingCode(io::Printer* printer);
59 virtual void GenerateCodecCode(io::Printer* printer);
60 virtual void GenerateExtensionCode(io::Printer* printer);
61 virtual void GenerateMembers(io::Printer* printer) = 0;
62 virtual void GenerateMergingCode(io::Printer* printer) = 0;
63 virtual void GenerateParsingCode(io::Printer* printer) = 0;
64 virtual void GenerateParsingCode(io::Printer* printer, bool use_parse_context);
65 virtual void GenerateSerializationCode(io::Printer* printer) = 0;
66 virtual void GenerateSerializationCode(io::Printer* printer, bool use_write_context);
67 virtual void GenerateSerializedSizeCode(io::Printer* printer) = 0;
68
69 virtual void WriteHash(io::Printer* printer) = 0;
70 virtual void WriteEquals(io::Printer* printer) = 0;
71 // Currently unused, as we use reflection to generate JSON
72 virtual void WriteToString(io::Printer* printer) = 0;
73
74 protected:
75 const FieldDescriptor* descriptor_;
76 const int presenceIndex_;
77 std::map<std::string, std::string> variables_;
78
79 void AddDeprecatedFlag(io::Printer* printer);
80 void AddNullCheck(io::Printer* printer);
81 void AddNullCheck(io::Printer* printer, const std::string& name);
82
83 void AddPublicMemberAttributes(io::Printer* printer);
84 void SetCommonOneofFieldVariables(
85 std::map<std::string, std::string>* variables);
86
87 std::string oneof_property_name();
88 std::string oneof_case_name();
89 std::string oneof_name();
90 std::string property_name();
91 std::string name();
92 std::string type_name();
93 std::string type_name(const FieldDescriptor* descriptor);
94 bool has_default_value();
95 std::string default_value();
96 std::string default_value(const FieldDescriptor* descriptor);
97 std::string number();
98 std::string capitalized_type_name();
99
100 private:
101 void SetCommonFieldVariables(std::map<std::string, std::string>* variables);
102 std::string GetStringDefaultValueInternal(const FieldDescriptor* descriptor);
103 std::string GetBytesDefaultValueInternal(const FieldDescriptor* descriptor);
104};
105
106} // namespace csharp
107} // namespace compiler
108} // namespace protobuf
109} // namespace google
110
111#endif // GOOGLE_PROTOBUF_COMPILER_CSHARP_FIELD_BASE_H__
112
113