THRIFT-3150 Add an option to make Read and Write methods private
Client: Go
Patch: Konstantin Shaposhnikov <k.shaposhnikov@gmail.com>, slightly modified by Jens Geyer
This closes #505
diff --git a/compiler/cpp/src/generate/t_go_generator.cc b/compiler/cpp/src/generate/t_go_generator.cc
index 0030d24..d5e29c2 100644
--- a/compiler/cpp/src/generate/t_go_generator.cc
+++ b/compiler/cpp/src/generate/t_go_generator.cc
@@ -94,6 +94,9 @@
if (iter != parsed_options.end()) {
package_flag = (iter->second);
}
+
+ iter = parsed_options.find("read_write_private");
+ read_write_private_ = (iter != parsed_options.end());
}
/**
@@ -278,6 +281,7 @@
private:
std::string gen_package_prefix_;
std::string gen_thrift_import_;
+ bool read_write_private_;
/**
* File streams
@@ -292,6 +296,8 @@
std::string package_name_;
std::string package_dir_;
+ std::string read_method_name_;
+ std::string write_method_name_;
std::set<std::string> commonInitialisms;
@@ -677,6 +683,15 @@
commonInitialisms.insert("XSRF");
commonInitialisms.insert("XSS");
+ // names of read and write methods
+ if (read_write_private_) {
+ read_method_name_ = "read";
+ write_method_name_ = "write";
+ } else {
+ read_method_name_ = "Read";
+ write_method_name_ = "Write";
+ }
+
while (true) {
// TODO: Do better error checking here.
MKDIR(package_dir_.c_str());
@@ -1358,7 +1373,7 @@
const vector<t_field*>& fields = tstruct->get_members();
vector<t_field*>::const_iterator f_iter;
string escaped_tstruct_name(escape_string(tstruct->get_name()));
- out << indent() << "func (p *" << tstruct_name << ") Read(iprot thrift.TProtocol) error {"
+ out << indent() << "func (p *" << tstruct_name << ") " << read_method_name_ << "(iprot thrift.TProtocol) error {"
<< endl;
indent_up();
out << indent() << "if _, err := iprot.ReadStructBegin(); err != nil {" << endl;
@@ -1504,7 +1519,7 @@
string name(tstruct->get_name());
const vector<t_field*>& fields = tstruct->get_sorted_members();
vector<t_field*>::const_iterator f_iter;
- indent(out) << "func (p *" << tstruct_name << ") Write(oprot thrift.TProtocol) error {" << endl;
+ indent(out) << "func (p *" << tstruct_name << ") " << write_method_name_ << "(oprot thrift.TProtocol) error {" << endl;
indent_up();
if (tstruct->is_union() && uses_countsetfields) {
std::string tstruct_name(publicize(tstruct->get_name()));
@@ -1881,7 +1896,7 @@
f_service_ << indent() << "}" << endl;
// Write to the stream
- f_service_ << indent() << "if err = args.Write(oprot); err != nil {" << endl;
+ f_service_ << indent() << "if err = args." << write_method_name_ << "(oprot); err != nil {" << endl;
indent_up();
f_service_ << indent() << " return" << endl;
indent_down();
@@ -1936,7 +1951,7 @@
<< " := thrift.NewTApplicationException(thrift.UNKNOWN_APPLICATION_EXCEPTION, "
"\"Unknown Exception\")" << endl;
f_service_ << indent() << " var " << error2 << " error" << endl;
- f_service_ << indent() << " " << error2 << ", err = " << error << ".Read(iprot)" << endl;
+ f_service_ << indent() << " " << error2 << ", err = " << error << "." << read_method_name_ << "(iprot)" << endl;
f_service_ << indent() << " if err != nil {" << endl;
f_service_ << indent() << " return" << endl;
f_service_ << indent() << " }" << endl;
@@ -1953,7 +1968,7 @@
f_service_ << indent() << " return" << endl;
f_service_ << indent() << "}" << endl;
f_service_ << indent() << "result := " << resultname << "{}" << endl;
- f_service_ << indent() << "if err = result.Read(iprot); err != nil {" << endl;
+ f_service_ << indent() << "if err = result." << read_method_name_ << "(iprot); err != nil {" << endl;
f_service_ << indent() << " return" << endl;
f_service_ << indent() << "}" << endl;
f_service_ << indent() << "if err = iprot.ReadMessageEnd(); err != nil {" << endl;
@@ -2305,7 +2320,7 @@
<< endl;
f_remote << indent() << "argvalue" << i << " := " << package_name_ << ".New" << tstruct_name
<< "()" << endl;
- f_remote << indent() << err2 << " := argvalue" << i << ".Read(" << jsProt << ")" << endl;
+ f_remote << indent() << err2 << " := argvalue" << i << "." << read_method_name_ << "(" << jsProt << ")" << endl;
f_remote << indent() << "if " << err2 << " != nil {" << endl;
f_remote << indent() << " Usage()" << endl;
f_remote << indent() << " return" << endl;
@@ -2505,7 +2520,7 @@
<< " := thrift.NewTApplicationException(thrift.UNKNOWN_METHOD, \"Unknown function "
"\" + name)" << endl;
f_service_ << indent() << " oprot.WriteMessageBegin(name, thrift.EXCEPTION, seqId)" << endl;
- f_service_ << indent() << " " << x << ".Write(oprot)" << endl;
+ f_service_ << indent() << " " << x << "." << write_method_name_ << "(oprot)" << endl;
f_service_ << indent() << " oprot.WriteMessageEnd()" << endl;
f_service_ << indent() << " oprot.Flush()" << endl;
f_service_ << indent() << " return false, " << x << endl;
@@ -2561,7 +2576,7 @@
"thrift.TException) {" << endl;
indent_up();
f_service_ << indent() << "args := " << argsname << "{}" << endl;
- f_service_ << indent() << "if err = args.Read(iprot); err != nil {" << endl;
+ f_service_ << indent() << "if err = args." << read_method_name_ << "(iprot); err != nil {" << endl;
f_service_ << indent() << " iprot.ReadMessageEnd()" << endl;
if (!tfunction->is_oneway()) {
f_service_ << indent()
@@ -2569,7 +2584,7 @@
<< endl;
f_service_ << indent() << " oprot.WriteMessageBegin(\"" << escape_string(tfunction->get_name())
<< "\", thrift.EXCEPTION, seqId)" << endl;
- f_service_ << indent() << " x.Write(oprot)" << endl;
+ f_service_ << indent() << " x." << write_method_name_ << "(oprot)" << endl;
f_service_ << indent() << " oprot.WriteMessageEnd()" << endl;
f_service_ << indent() << " oprot.Flush()" << endl;
}
@@ -2635,7 +2650,7 @@
<< ": \" + err2.Error())" << endl;
f_service_ << indent() << " oprot.WriteMessageBegin(\"" << escape_string(tfunction->get_name())
<< "\", thrift.EXCEPTION, seqId)" << endl;
- f_service_ << indent() << " x.Write(oprot)" << endl;
+ f_service_ << indent() << " x." << write_method_name_ << "(oprot)" << endl;
f_service_ << indent() << " oprot.WriteMessageEnd()" << endl;
f_service_ << indent() << " oprot.Flush()" << endl;
}
@@ -2667,7 +2682,7 @@
<< endl;
f_service_ << indent() << " err = err2" << endl;
f_service_ << indent() << "}" << endl;
- f_service_ << indent() << "if err2 = result.Write(oprot); err == nil && err2 != nil {" << endl;
+ f_service_ << indent() << "if err2 = result." << write_method_name_ << "(oprot); err == nil && err2 != nil {" << endl;
f_service_ << indent() << " err = err2" << endl;
f_service_ << indent() << "}" << endl;
f_service_ << indent() << "if err2 = oprot.WriteMessageEnd(); err == nil && err2 != nil {"
@@ -2820,7 +2835,7 @@
out << indent() << prefix << eq << (pointer_field ? "&" : "");
generate_go_struct_initializer(out, tstruct);
- out << indent() << "if err := " << prefix << ".Read(iprot); err != nil {" << endl;
+ out << indent() << "if err := " << prefix << "." << read_method_name_ << "(iprot); err != nil {" << endl;
out << indent() << " return thrift.PrependError(fmt.Sprintf(\"%T error reading struct: \", "
<< prefix << "), err)" << endl;
out << indent() << "}" << endl;
@@ -3049,7 +3064,7 @@
*/
void t_go_generator::generate_serialize_struct(ofstream& out, t_struct* tstruct, string prefix) {
(void)tstruct;
- out << indent() << "if err := " << prefix << ".Write(oprot); err != nil {" << endl;
+ out << indent() << "if err := " << prefix << "." << write_method_name_ << "(oprot); err != nil {" << endl;
out << indent() << " return thrift.PrependError(fmt.Sprintf(\"%T error writing struct: \", "
<< prefix << "), err)" << endl;
out << indent() << "}" << endl;
@@ -3535,4 +3550,6 @@
THRIFT_REGISTER_GENERATOR(go, "Go",
" package_prefix= Package prefix for generated files.\n" \
" thrift_import= Override thrift package import path (default:" + default_thrift_import + ")\n" \
- " package= Package name (default: inferred from thrift file name)\n")
+ " package= Package name (default: inferred from thrift file name)\n" \
+ " private_read_write:\n"
+ " Make read/write methods private, default is public Read/Write\n")
diff --git a/lib/go/test/DontExportRWTest.thrift b/lib/go/test/DontExportRWTest.thrift
new file mode 100644
index 0000000..39e5a6f
--- /dev/null
+++ b/lib/go/test/DontExportRWTest.thrift
@@ -0,0 +1,27 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+struct InnerStruct {
+ 1: required string id
+}
+
+struct TestStruct {
+ 1: required string id
+ 2: required InnerStruct inner
+}
diff --git a/lib/go/test/Makefile.am b/lib/go/test/Makefile.am
index aa3d95b..8cedfb0 100644
--- a/lib/go/test/Makefile.am
+++ b/lib/go/test/Makefile.am
@@ -34,7 +34,9 @@
RefAnnotationFieldsTest.thrift \
ErrorTest.thrift \
NamesTest.thrift \
- InitialismsTest.thrift
+ InitialismsTest.thrift \
+ DontExportRWTest.thrift \
+ dontexportrwtest/compile_test.go
mkdir -p gopath/src
grep -v list.*map.*list.*map $(THRIFTTEST) | grep -v 'set<Insanity>' > ThriftTest.thrift
$(THRIFT) $(THRIFTARGS) -r IncludesTest.thrift
@@ -49,9 +51,11 @@
$(THRIFT) $(THRIFTARGS) ErrorTest.thrift
$(THRIFT) $(THRIFTARGS) NamesTest.thrift
$(THRIFT) $(THRIFTARGS) InitialismsTest.thrift
+ $(THRIFT) $(THRIFTARGS),read_write_private DontExportRWTest.thrift
GOPATH=`pwd`/gopath $(GO) get code.google.com/p/gomock/gomock
ln -nfs ../../../thrift gopath/src/thrift
ln -nfs ../../tests gopath/src/tests
+ cp -r ./dontexportrwtest gopath/src
touch gopath
check: gopath
@@ -63,8 +67,9 @@
refannotationfieldstest \
errortest \
namestest \
- initialismstest
- GOPATH=`pwd`/gopath $(GO) test thrift tests
+ initialismstest \
+ dontexportrwtest
+ GOPATH=`pwd`/gopath $(GO) test thrift tests dontexportrwtest
clean-local:
$(RM) -r gopath ThriftTest.thrift gen-go
@@ -86,4 +91,5 @@
TypedefFieldTest.thrift \
ErrorTest.thrift \
NamesTest.thrift \
- InitialismsTest.thrift
+ InitialismsTest.thrift \
+ DontExportRWTest.thrift
diff --git a/lib/go/test/dontexportrwtest/compile_test.go b/lib/go/test/dontexportrwtest/compile_test.go
new file mode 100644
index 0000000..2b877e3
--- /dev/null
+++ b/lib/go/test/dontexportrwtest/compile_test.go
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package dontexportrwtest
+
+import (
+ "fmt"
+ "testing"
+)
+
+// Make sure that thrift generates non-exported read/write methods if
+// read_write_private option is specified
+func TestReadWriteMethodsArePrivate(t *testing.T) {
+ // This will only compile if read/write methods exist
+ s := NewTestStruct()
+ fmt.Sprintf("%v", s.read)
+ fmt.Sprintf("%v", s.write)
+
+ is := NewInnerStruct()
+ fmt.Sprintf("%v", is.read)
+ fmt.Sprintf("%v", is.write)
+}