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_PHP_GENERATOR_H__
32 #define GOOGLE_PROTOBUF_COMPILER_PHP_GENERATOR_H__
33
34 #include <google/protobuf/compiler/code_generator.h>
35 #include <google/protobuf/descriptor.h>
36
37 #include <string>
38
39 #include <google/protobuf/port_def.inc>
40
41 namespace google {
42 namespace protobuf {
43 namespace compiler {
44 namespace php {
45
46 class PROTOC_EXPORT Generator : public CodeGenerator {
47 public:
48 virtual bool Generate(
49 const FileDescriptor* file,
50 const string& parameter,
51 GeneratorContext* generator_context,
52 string* error) const override;
53
54 bool GenerateAll(const std::vector<const FileDescriptor*>& files,
55 const std::string& parameter,
56 GeneratorContext* generator_context,
57 std::string* error) const override;
58
GetSupportedFeatures()59 uint64_t GetSupportedFeatures() const override {
60 return FEATURE_PROTO3_OPTIONAL;
61 }
62
63 private:
64 bool Generate(
65 const FileDescriptor* file,
66 bool is_descriptor,
67 bool aggregate_metadata,
68 const std::set<string>& aggregate_metadata_prefixes,
69 GeneratorContext* generator_context,
70 string* error) const;
71 };
72
73 // To skip reserved keywords in php, some generated classname are prefixed.
74 // Other code generators may need following API to figure out the actual
75 // classname.
76 PROTOC_EXPORT std::string GeneratedClassName(const Descriptor* desc);
77 PROTOC_EXPORT std::string GeneratedClassName(const EnumDescriptor* desc);
78 PROTOC_EXPORT std::string GeneratedClassName(const ServiceDescriptor* desc);
79
IsWrapperType(const FieldDescriptor * descriptor)80 inline bool IsWrapperType(const FieldDescriptor* descriptor) {
81 return descriptor->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE &&
82 descriptor->message_type()->file()->name() == "google/protobuf/wrappers.proto";
83 }
84
85 } // namespace php
86 } // namespace compiler
87 } // namespace protobuf
88 } // namespace google
89
90 #include <google/protobuf/port_undef.inc>
91
92 #endif // GOOGLE_PROTOBUF_COMPILER_PHP_GENERATOR_H__
93