Make protobuf-codegen separate crate

Fixes #234

Author: stepancheg

Cargo.toml

@@ -4,6 +4,7 @@ members = [
     "protoc/test-protoc",
     "protoc-rust",
     "protobuf",
+    "protobuf-codegen",
     "protobuf-test",
     "perftest/vs-cxx",
     "perftest/bytes",

protobuf-codegen/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "protobuf-codegen"
+version = "1.4.1"
+authors = ["Stepan Koltsov <stepan.koltsov@gmail.com>"]
+
+[dependencies.protobuf]
+path = "../protobuf"
+
+[[bin]]
+
+name = "protoc-gen-rust"
+path = "src/bin/protoc-gen-rust.rs"
+test = false
+
+[[bin]]
+
+name = "protobuf-bin-gen-rust-do-not-use"
+path = "src/bin/protobuf-bin-gen-rust-do-not-use.rs"
+test = false
+

protobuf/protobuf-bin-gen-rust-do-not-use.rs protobuf-codegen/src/bin/protobuf-bin-gen-rust-do-not-use.rs

@@ -1,4 +1,5 @@
 extern crate protobuf;
+extern crate protobuf_codegen;
 
 use std::fs::*;
 use std::io::Read;
@@ -7,7 +8,7 @@ use std::path::Path;
 
 use protobuf::parse_from_reader;
 use protobuf::descriptor::*;
-use protobuf::codegen::*;
+use protobuf_codegen::*;
 
 
 fn write_file(bin: &str) {

protobuf-codegen/src/bin/protoc-gen-rust.rs

@@ -0,0 +1,5 @@
+extern crate protobuf_codegen;
+
+fn main() {
+    protobuf_codegen::protoc_gen_rust_main();
+}

protobuf/src/code_writer.rs protobuf-codegen/src/code_writer.rs

@@ -4,7 +4,7 @@
 use std::io::Write;
 
 // TODO: should not use wire_format here
-use wire_format;
+use protobuf::wire_format;
 
 /// Field visibility.
 pub enum Visibility {

protobuf/src/codegen/enums.rs protobuf-codegen/src/enums.rs

@@ -1,8 +1,9 @@
 use std::collections::HashSet;
 
-use descriptor::*;
-use descriptorx::*;
-use code_writer::*;
+use protobuf::descriptor::*;
+use protobuf::descriptorx::*;
+
+use super::code_writer::*;
 
 
 #[derive(Clone)]

protobuf/src/codegen/extensions.rs protobuf-codegen/src/extensions.rs

@@ -1,6 +1,6 @@
-use descriptor::*;
-use descriptorx::*;
-use code_writer::CodeWriter;
+use protobuf::descriptor::*;
+use protobuf::descriptorx::*;
+use super::code_writer::CodeWriter;
 use super::rust_types_values::*;
 
 

protobuf/src/codegen/field.rs protobuf-codegen/src/field.rs

@@ -1,19 +1,19 @@
-use descriptor::*;
-use descriptorx::*;
-use rustproto;
-use wire_format;
-use rt;
-use rust;
-use text_format;
-use code_writer::CodeWriter;
-use types::ProtobufType;
-use reflect::ProtobufValue;
-
-use ext::ExtFieldOptional;
+use protobuf::descriptor::*;
+use protobuf::descriptorx::*;
+use protobuf::rustproto; // TODO: should probably live here
+use protobuf::wire_format;
+use protobuf::rt;
+use protobuf::rust;
+use protobuf::text_format;
+use protobuf::types::ProtobufType;
+use protobuf::reflect::ProtobufValue;
+
+use protobuf::ext::ExtFieldOptional;
 
 use super::message::*;
 use super::rust_types_values::*;
 use super::enums::*;
+use super::code_writer::CodeWriter;
 
 
 
@@ -26,7 +26,12 @@ fn type_is_copy(field_type: FieldDescriptorProto_Type) -> bool {
     }
 }
 
-impl FieldDescriptorProto_Type {
+trait FieldDescriptorProtoTypeExt {
+    fn read(&self, is: &str) -> String;
+    fn is_s_varint(&self) -> bool;
+}
+
+impl FieldDescriptorProtoTypeExt for FieldDescriptorProto_Type {
     fn read(&self, is: &str) -> String {
         format!("{}.read_{}()", is, protobuf_name(*self))
     }
@@ -42,7 +47,7 @@ impl FieldDescriptorProto_Type {
 }
 
 fn field_type_wire_type(field_type: FieldDescriptorProto_Type) -> wire_format::WireType {
-    use stream::wire_format::*;
+    use protobuf::stream::wire_format::*;
     match field_type {
         FieldDescriptorProto_Type::TYPE_INT32 => WireTypeVarint,
         FieldDescriptorProto_Type::TYPE_INT64 => WireTypeVarint,

protobuf/src/codegen/mod.rs protobuf-codegen/src/lib.rs

@@ -1,14 +1,12 @@
-// TODO: move into separate crate
-#![doc(hidden)]
+extern crate protobuf;
 
 use std::collections::hash_map::HashMap;
 use std::fmt::Write;
 
-use descriptor::*;
-use core::Message;
-use compiler_plugin;
-use code_writer::CodeWriter;
-use descriptorx::*;
+use protobuf::descriptor::*;
+use protobuf::Message;
+use protobuf::compiler_plugin;
+use protobuf::descriptorx::*;
 
 mod message;
 mod enums;
@@ -17,10 +15,12 @@ mod well_known_types;
 mod field;
 mod extensions;
 
+pub mod code_writer;
+
 use self::message::*;
 use self::enums::*;
 use self::extensions::*;
-
+use self::code_writer::CodeWriter;
 
 fn escape_byte(s: &mut String, b: u8) {
     if b == b'\n' {
@@ -33,7 +33,7 @@ fn escape_byte(s: &mut String, b: u8) {
         write!(s, "\\{}", b as char).unwrap();
     } else if b == b'\0' {
         write!(s, "\\0").unwrap();
-    // ASCII printable except space
+        // ASCII printable except space
     } else if b > 0x20 && b < 0x7f {
         write!(s, "{}", b as char).unwrap();
     } else {
@@ -99,10 +99,10 @@ fn gen_file(
 
     if scope.get_messages().is_empty() && scope.get_enums().is_empty() &&
         file.get_extension().is_empty()
-    {
-        // protoc generates empty file descriptors for directories: skip them
-        return None;
-    }
+        {
+            // protoc generates empty file descriptors for directories: skip them
+            return None;
+        }
 
     let mut v = Vec::new();
 

protobuf/src/codegen/message.rs protobuf-codegen/src/message.rs

@@ -1,12 +1,11 @@
-use descriptor::*;
-use descriptorx::*;
-use code_writer::*;
-use rustproto;
+use protobuf::descriptor::*;
+use protobuf::descriptorx::*;
+use protobuf::rustproto;
 
 use super::enums::*;
 use super::rust_types_values::*;
 use super::field::*;
-
+use super::code_writer::*;
 
 
 /// Message info for codegen

protobuf/src/codegen/rust_types_values.rs protobuf-codegen/src/rust_types_values.rs

@@ -1,8 +1,8 @@
 use std::fmt;
 use std::cmp;
 
-use descriptor::*;
-use descriptorx::*;
+use protobuf::descriptor::*;
+use protobuf::descriptorx::*;
 use super::well_known_types::is_well_known_type_full;
 
 

protobuf/src/codegen/well_known_types.rs protobuf-codegen/src/well_known_types.rs

@@ -19,15 +19,3 @@ with-bytes = ["bytes"]
 
 [dependencies]
 bytes = { version = "0.*", optional = true }
-
-[[bin]]
-
-name = "protoc-gen-rust"
-path = "protoc-gen-rust.rs"
-test = false
-
-[[bin]]
-
-name = "protobuf-bin-gen-rust-do-not-use"
-path = "protobuf-bin-gen-rust-do-not-use.rs"
-test = false

protobuf/Cargo.toml

@@ -1,28 +1,6 @@
 ## How to develop rust-protobuf itself
 
-### ./build.sh
+`cargo test --all` to build everything.
 
-Compile the project.
-
-### ./regenerate.sh
-
-Generate .rs files from .proto files, that needed
-internally in rust-protobuf.
-
-### rust test lib/protobuf.rs
-
-Execute the test suite.
-
-### ./full-rebuild.sh
-
-* build project
-* regenerate .rs files
-* build project again to ensure that generated files are correct
-* run tests
-
-This is primary script for development.
-
-### ./checkout-generated.sh
-
-Revert generated files to git version. Use if generated
-files are incorrect.
+If code generator is changed, code needs to be regenerated, see
+`regenerate.sh`.

protobuf/README.md

@@ -8,15 +8,15 @@ die() {
 cd $(dirname $0)
 
 # Build protoc-gen-rust
-./build.sh
+cargo build --manifest-path ../protobuf-codegen/Cargo.toml
 
 protoc_ver=$(protoc --version)
 case "$protoc_ver" in
     "libprotoc 3"*)
         # Generate from descriptor.proto
         ./regenerate.sh
         # Build again with regenerated descriptor.proto
-        ./build.sh
+        cargo build --all
         ;;
     "libprotoc 2"*)
 		echo "do not regenerate with proto 2"
@@ -26,6 +26,6 @@ case "$protoc_ver" in
         ;;
 esac
 
-./../protobuf-test/test.sh
+../protobuf-test/test.sh
 
 # vim: set ts=4 sw=4 et:

protobuf/build.sh

@@ -38,13 +38,11 @@ pub use chars::Chars;
 // generated
 pub mod descriptor;
 pub mod plugin;
-mod rustproto;
+pub mod rustproto;
 
 mod core;
 pub mod rt;
 pub mod lazy;
-pub mod code_writer;
-pub mod codegen;
 pub mod compiler_plugin;
 mod repeated;
 mod singular;
@@ -67,7 +65,8 @@ mod zigzag;
 mod paginate;
 mod unknown;
 mod strx;
-mod rust;
+#[doc(hidden)] // used by codegen
+pub mod rust;
 mod cached_size;
 mod varint;
 #[cfg(feature = "bytes")]
@@ -82,7 +81,6 @@ mod buf_read_iter;
 mod protobuf {
     pub use descriptor;
     pub use descriptorx;
-    pub use codegen;
     pub use reflect;
     pub use core::*;
     pub use error::*;

protobuf/full-rebuild.sh

@@ -15,4 +15,5 @@ doctest = false
 [dependencies]
 protoc   = { path = "../protoc", version = "1.4.1" }
 protobuf = { path = "../protobuf", version = "1.4.1" }
+protobuf-codegen = { path = "../protobuf-codegen", version = "1.4.1" }
 tempdir  = "0.3"

protobuf/protoc-gen-rust.rs

@@ -2,6 +2,7 @@ extern crate tempdir;
 
 extern crate protoc;
 extern crate protobuf;
+extern crate protobuf_codegen;
 
 use std::io;
 use std::io::Read;
@@ -73,7 +74,7 @@ pub fn run(args: Args) -> Result<()> {
         ));
     }
 
-    let gen_result = protobuf::codegen::gen(fds.get_file(), &files_to_generate);
+    let gen_result = protobuf_codegen::gen(fds.get_file(), &files_to_generate);
 
     for r in gen_result {
         let r: protobuf::compiler_plugin::GenResult = r;

protobuf/src/lib.rs

@@ -4,8 +4,8 @@ cd $(dirname $0)
 
 (
     echo "building protoc-gen-rust"
-    cd ../protobuf
-    cargo build --features=$RUST_PROTOBUF_FEATURES --bin=protoc-gen-rust
+    cd ../protobuf-codegen
+    cargo build --bin=protoc-gen-rust
 )
 
 echo "cargo check in test-protoc"