Update crate meta-data, docs, build-nng feature, patched cty

- build-nng feature from Nathan: https://gitlab.com/neachdainn/nng-rs/blob/master/nng-sys/build.rs

Author: jeikabu

Cargo.toml

@@ -1,22 +1,23 @@
 [package]
-name = "runng-sys"
-version = "0.5.0"
-authors = ["Jake W <[email protected]>"]
+name = "nng-sys"
+version = "1.1.1-rc.1"
+authors = ["Nathan Kent <[email protected]>", "Jake W <[email protected]>"]
 
-description = "Bindings to nng (Nanomsg-Next-Generation) aka Nanomsg2"
-#keywords = ["nng", "nanomsg", "zeromq"]
-#categories = ["network-programming", "external-ffi-bindings", "os"]
+description = "Bindings to NNG (Nanomsg-Next-Generation) aka Nanomsg2"
+keywords = ["nng", "nanomsg", "zeromq"]
+categories = ["network-programming", "external-ffi-bindings", "os"]
 license = "MIT"
-repository = "https://github.com/jeikabu/runng"
+repository = "https://github.com/jeikabu/nng-rust"
 readme = "README.md"
 edition = "2018"
 
 [badges]
-appveyor = { repository = "jake-ruyi/runng", branch = "master", service = "github" }
-travis-ci = { repository = "jeikabu/runng", branch = "master" }
+appveyor = { repository = "jake-ruyi/nng-rust", branch = "master", service = "github" }
+travis-ci = { repository = "jeikabu/nng-rust", branch = "master" }
 
 [features]
-default = ["nng-stats"]
+default = ["build-nng", "nng-stats"]
+build-nng = []
 # Cmake generators
 cmake-ninja = [] # Ninja
 cmake-vs2017 = [] # Visual Studio 15 2017
@@ -31,6 +32,9 @@ legacy-111-rc4 = []
 [dependencies]
 cty = "0.1"
 
+[patch.crates-io]
+cty = { git = 'https://github.com/jeikabu/cty' }
+
 [build-dependencies]
 cmake = "0.1"
 bindgen = "0.47"

LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright 2018 Staysail Systems, Inc. <[email protected]>
+Copyright 2018 Capitar IT Group BV <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom
+the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

README.md

@@ -1,18 +1,22 @@
 
-# runng-sys
-
-Rust FFI bindings to [NNG](https://github.com/nanomsg/nng) (generated with [bindgen](https://rust-lang.github.io/rust-bindgen/introduction.html)):
+Rust FFI bindings to [NNG](https://github.com/nanomsg/nng):
 
 > NNG, like its predecessors nanomsg (and to some extent ZeroMQ), is a lightweight, broker-less library, offering a simple API to solve common recurring messaging problems, such as publish/subscribe, RPC-style request/reply, or service discovery. The API frees the programmer from worrying about details like connection management, retries, and other common considerations, so that they can focus on the application instead of the plumbing.
 
+[![docs.rs](https://docs.rs/nng-sys/badge.svg)](https://docs.rs/nng-sys)
+[![crates.io](http://img.shields.io/crates/v/nng-sys.svg)](http://crates.io/crates/nng-sys)
+![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Rustc 1.31+](https://img.shields.io/badge/rustc-1.31+-lightgray.svg)
+[![travis](https://travis-ci.org/jeikabu/nng-rust.svg?branch=master)](https://travis-ci.org/jeikabu/nng-rust)
+[![appveyor](https://ci.appveyor.com/api/projects/status/96x8onexj6vyxgjp/branch/master?svg=true)](https://ci.appveyor.com/project/jake-ruyi/nng-rust/branch/master)
 
 ## Usage
 
 Version of this crate tracks NNG: `<NNG_version>-rc.<crate_version>` (e.g. `1.1.1-rc.2`).
 
-To use the __latest crate__ for the most recent __stable version of NNG__ (1.1.1), in `Cargo.toml`:
+To use the __latest crate__ for the most recent __stable version of NNG__ (1.1.1), in `Cargo.toml`:  
 ```toml
-runng-sys = "1.1.1-rc"
+nng-sys = "1.1.1-rc"
 ```
 
 Requirements:
@@ -21,33 +25,31 @@ Requirements:
     - On Windows: default generator is [ninja](https://ninja-build.org/) and must also be in `PATH`
 - [libclang](https://rust-lang.github.io/rust-bindgen/requirements.html)
 
-For a more ergonomic API to NNG see [runng](https://crates.io/crates/runng).
-
 ## Features
 
+- `build-nng`: use cmake to build NNG from source (enabled by default)
 - `cmake-ninja`: use cmake generator "Ninja"
 - `cmake-vs2017`: use cmake generator "Visual Studio 15 2017"
 - `cmake-vs2017-win64`: use cmake generator "Visual Studio 15 2017 Win64"
 - `nng-stats`: enable NNG stats `NNG_ENABLE_STATS` (enabled by default)
-- `nng-tls`: enable TLS `NNG_ENABLE_TLS` (requires mbedTLS, disabled by default)
+- `nng-tls`: enable TLS `NNG_ENABLE_TLS` (requires mbedTLS)
 
-For example, to disable stats and use Ninja cmake generator:
+For example, to disable stats and use Ninja cmake generator, in your `Cargo.toml`:
 ```toml
-[dependencies.runng-sys]
+[dependencies.nng-sys]
 version = "1.1.1-rc"
 default-features = false
 features = ["cmake-ninja"]
 ```
 
 ## Examples
 ```rust
-use runng_sys::*;
+use nng_sys::*;
 use std::{ffi::CString, ptr::null_mut};
 
-#[test]
 fn example() {
     unsafe {
-        let url = CString::new("inproc://test").unwrap();
+        let url = CString::new("inproc://nng_sys/tests/example").unwrap();
         let url = url.as_bytes_with_nul().as_ptr() as *const std::os::raw::c_char;
 
         // Reply socket

build.rs

@@ -2,6 +2,59 @@ use cmake::Config;
 use std::{env, path::PathBuf};
 
 fn main() {
+    if cfg!(feature = "build-nng") {
+        let dst = cmake();
+        // Check output of `cargo build --verbose`, should see something like:
+        // -L native=/path/runng/target/debug/build/runng-sys-abc1234/out
+        // That contains output from cmake
+        println!(
+            "cargo:rustc-link-search=native={}",
+            dst.join("lib").display()
+        );
+        println!(
+            "cargo:rustc-link-search=native={}",
+            dst.join("lib64").display()
+        );
+
+        // Tell rustc to use nng static library
+        println!("cargo:rustc-link-lib=static=nng");
+    } else {
+        println!("cargo:rustc-link-lib=dylib=nng");
+    }
+
+    // https://rust-lang-nursery.github.io/rust-bindgen
+    // https://docs.rs/bindgen
+    let mut builder = bindgen::Builder::default()
+        // This is needed if use `#include <nng.h>` instead of `#include "path/nng.h"` in wrapper.h
+        //.clang_arg("-Inng/src/")
+        .header("wrapper.h");
+
+    if !cfg!(feature = "legacy-111-rc4") {
+        builder = builder
+            .whitelist_type("nng_.*")
+            .whitelist_function("nng_.*")
+            .whitelist_var("NNG_.*")
+            // Generate `pub const NNG_UNIT_EVENTS` instead of `nng_unit_enum_NNG_UNIT_EVENTS`
+            .prepend_enum_name(false)
+            // Generate `pub enum ...` instead of multiple `pub const ...`
+            .rustified_enum("nng_.*_enum")
+            // Enum special cases:
+            .rustified_enum("nng_pipe_ev")
+            .rustified_enum("nng_sockaddr_family")
+            .rustified_enum("nng_zt_status")
+            // no_std support
+            // https://rust-embedded.github.io/book/interoperability/c-with-rust.html#automatically-generating-the-interface
+            .ctypes_prefix("cty")
+            .use_core();
+    }
+    let bindings = builder.generate().expect("Unable to generate bindings");
+    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+    bindings
+        .write_to_file(out_path.join("bindings.rs"))
+        .expect("Couldn't write bindings");
+}
+
+fn cmake() -> PathBuf {
     // Compile-time features
     let generator = if cfg!(feature = "cmake-ninja") {
         "Ninja"
@@ -10,6 +63,7 @@ fn main() {
     } else if cfg!(feature = "cmake-vs2017-win64") {
         "Visual Studio 15 2017 Win64"
     } else {
+        // Default generators
         if cfg!(target_family = "unix") {
             "Unix Makefiles"
         } else {
@@ -28,58 +82,12 @@ fn main() {
     };
 
     // Run cmake to build nng
-    let dst = Config::new("nng")
+    Config::new("nng")
         .generator(generator)
         .define("CMAKE_BUILD_TYPE", "Release")
         .define("NNG_TESTS", "OFF")
         .define("NNG_TOOLS", "OFF")
         .define("NNG_ENABLE_STATS", stats)
         .define("NNG_ENABLE_TLS", tls)
-        .build();
-
-    // Check output of `cargo build --verbose`, should see something like:
-    // -L native=/path/runng/target/debug/build/runng-sys-abc1234/out
-    // That contains output from cmake
-    println!(
-        "cargo:rustc-link-search=native={}",
-        dst.join("lib").display()
-    );
-    println!(
-        "cargo:rustc-link-search=native={}",
-        dst.join("lib64").display()
-    );
-
-    // Tell rustc to use nng static library
-    println!("cargo:rustc-link-lib=static=nng");
-
-    // https://rust-lang-nursery.github.io/rust-bindgen
-    // https://docs.rs/bindgen
-    let mut builder = bindgen::Builder::default()
-        .header("wrapper.h")
-        // This is needed if use `#include <nng.h>` instead of `#include "path/nng.h"`
-        //.clang_arg("-Inng/src/")
-        ;
-    if !cfg!(feature = "legacy-111-rc4") {
-        builder = builder
-            .whitelist_type("nng_.*")
-            .whitelist_function("nng_.*")
-            .whitelist_var("NNG_.*")
-            // Generate `pub const NNG_UNIT_EVENTS` instead of `nng_unit_enum_NNG_UNIT_EVENTS`
-            .prepend_enum_name(false)
-            // Generate `pub enum ...` instead of multiple `pub const ...`
-            .rustified_enum("nng_.*_enum")
-            // Enum special cases:
-            .rustified_enum("nng_pipe_ev")
-            .rustified_enum("nng_sockaddr_family")
-            .rustified_enum("nng_zt_status")
-            // nostd support
-            // https://rust-embedded.github.io/book/interoperability/c-with-rust.html#automatically-generating-the-interface
-            .ctypes_prefix("cty")
-            .use_core();
-    }
-    let bindings = builder.generate().expect("Unable to generate bindings");
-    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
-    bindings
-        .write_to_file(out_path.join("bindings.rs"))
-        .expect("Couldn't write bindings");
+        .build()
 }

src/lib.rs

@@ -1,3 +1,51 @@
+/*!
+
+## Examples
+
+```rust
+use nng_sys::*;
+use std::{ffi::CString, ptr::null_mut};
+
+fn example() {
+    unsafe {
+        let url = CString::new("inproc://nng_sys/tests/example").unwrap();
+        let url = url.as_bytes_with_nul().as_ptr() as *const std::os::raw::c_char;
+
+        // Reply socket
+        let mut rep_socket = nng_socket { id: 0 };
+        nng_rep0_open(&mut rep_socket);
+        nng_listen(rep_socket, url, null_mut(), 0);
+
+        // Request socket
+        let mut req_socket = nng_socket { id: 0 };
+        nng_req0_open(&mut req_socket);
+        nng_dial(req_socket, url, null_mut(), 0);
+
+        // Send message
+        let mut req_msg: *mut nng_msg = null_mut();
+        nng_msg_alloc(&mut req_msg, 0);
+        // Add a value to the body of the message
+        let val = 0x12345678;
+        nng_msg_append_u32(req_msg, val);
+        nng_sendmsg(req_socket, req_msg, 0);
+
+        // Receive it
+        let mut recv_msg: *mut nng_msg = null_mut();
+        nng_recvmsg(rep_socket, &mut recv_msg, 0);
+        // Remove our value from the body of the received message
+        let mut recv_val: u32 = 0;
+        nng_msg_trim_u32(recv_msg, &mut recv_val);
+        assert_eq!(val, recv_val);
+        // Can't do this because nng uses network order (big-endian)
+        //assert_eq!(val, *(nng_msg_body(recv_msg) as *const u32));
+
+        nng_close(req_socket);
+        nng_close(rep_socket);
+    }
+}
+```
+ */
+
 // Suppress the flurry of warnings caused by using "C" naming conventions
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]

tests/tests.rs

@@ -1,13 +1,12 @@
 #[cfg(test)]
 mod tests {
 
-    use runng_sys::*;
+    use nng_sys::*;
     use std::{ffi::CString, ptr::null_mut};
 
-    #[test]
     fn example() {
         unsafe {
-            let url = CString::new("inproc://runng-sys/tests/example").unwrap();
+            let url = CString::new("inproc://nng_sys/tests/example").unwrap();
             let url = url.as_bytes_with_nul().as_ptr() as *const std::os::raw::c_char;
 
             // Reply socket
@@ -46,7 +45,7 @@ mod tests {
     #[test]
     fn basic() {
         unsafe {
-            let url = CString::new("inproc://runng-sys/tests/basic").unwrap();
+            let url = CString::new("inproc://nng_sys/tests/basic").unwrap();
             let url = url.as_bytes_with_nul().as_ptr() as *const std::os::raw::c_char;
 
             // Reply socket