javanano_field.h revision 5cc242074f189837b38e7768b57ccfb0bca258df 
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_FIELD_H__
36#define GOOGLE_PROTOBUF_COMPILER_JAVA_FIELD_H__
37
38#include <string>
39#include <google/protobuf/stubs/common.h>
40#include <google/protobuf/descriptor.h>
41#include <google/protobuf/compiler/javanano/javanano_params.h>
42
43namespace google {
44namespace protobuf {
45  namespace io {
46    class Printer;             // printer.h
47  }
48}
49
50namespace protobuf {
51namespace compiler {
52namespace javanano {
53
54class FieldGenerator {
55 public:
56  FieldGenerator(const Params& params) : params_(params) {}
57  virtual ~FieldGenerator();
58
59  virtual bool SavedDefaultNeeded() const;
60  virtual void GenerateInitSavedDefaultCode(io::Printer* printer) const;
61
62  // Generates code for Java fields and methods supporting this field.
63  // If this field needs a saved default (SavedDefaultNeeded() is true),
64  // then @lazy_init controls how the static field for that default value
65  // and its initialization code should be generated. If @lazy_init is
66  // true, the static field is not declared final and the initialization
67  // code is generated only when GenerateInitSavedDefaultCode is called;
68  // otherwise, the static field is declared final and initialized inline.
69  // GenerateInitSavedDefaultCode will not be called in the latter case.
70  virtual void GenerateMembers(
71      io::Printer* printer, bool lazy_init) const = 0;
72
73  virtual void GenerateClearCode(io::Printer* printer) const = 0;
74  virtual void GenerateMergingCode(io::Printer* printer) const = 0;
75
76  // Generates code to merge from packed serialized form. The default
77  // implementation will fail; subclasses which can handle packed serialized
78  // forms will override this and print appropriate code to the printer.
79  virtual void GenerateMergingCodeFromPacked(io::Printer* printer) const;
80
81  virtual void GenerateSerializationCode(io::Printer* printer) const = 0;
82  virtual void GenerateSerializedSizeCode(io::Printer* printer) const = 0;
83  virtual void GenerateEqualsCode(io::Printer* printer) const = 0;
84  virtual void GenerateHashCodeCode(io::Printer* printer) const = 0;
85
86 protected:
87  const Params& params_;
88 private:
89  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGenerator);
90};
91
92// Convenience class which constructs FieldGenerators for a Descriptor.
93class FieldGeneratorMap {
94 public:
95  explicit FieldGeneratorMap(const Descriptor* descriptor, const Params &params);
96  ~FieldGeneratorMap();
97
98  const FieldGenerator& get(const FieldDescriptor* field) const;
99  int total_bits() const { return total_bits_; }
100  bool saved_defaults_needed() const { return saved_defaults_needed_; }
101
102 private:
103  const Descriptor* descriptor_;
104  scoped_array<scoped_ptr<FieldGenerator> > field_generators_;
105  int total_bits_;
106  bool saved_defaults_needed_;
107
108  static FieldGenerator* MakeGenerator(const FieldDescriptor* field,
109      const Params &params, int* next_has_bit_index);
110
111  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorMap);
112};
113
114}  // namespace javanano
115}  // namespace compiler
116}  // namespace protobuf
117
118}  // namespace google
119#endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_FIELD_H__
120