Merge remote-tracking branch 'iui/master' into iui

initial step to merge masche842 features/changes into iui

Author: masche842

.gitignore

@@ -1,6 +1,6 @@
-ui-sys/target
-ui-sys/Cargo.lock
+Cargo.lock
+*.swp
 ui/target
-ui/Cargo.lock
-.DS_Store
-*.bk
+ui-sys/target
+iui/target
+target

.travis.yml

@@ -1,16 +1,30 @@
 language: rust
-
 rust:
-  - stable
-  - beta
-  - nightly
-
-env:
-  - TEST_DIR=ui
-  - TEST_DIR=ui-sys
-
+    - stable
+    - beta
+    - nightly
 matrix:
   allow_failures:
     - rust: nightly
+before_install:
+    - sudo apt-get -qq update
+    - sudo apt-get install -y cmake
+    - sudo apt-get install -y libgtk-3-dev
+script:
+    - cd ui-sys
+    - cargo build --verbose --tests --examples
+    - cd ../iui
+    - cargo build --verbose --tests --examples
+after_success: |
+  [ $TRAVIS_BRANCH = master ] &&
+  [ $TRAVIS_PULL_REQUEST = false ] &&
+  cd $TRAVIS_BUILD_DIR/iui/ &&
+  cargo doc &&
+  echo "<meta http-equiv=refresh content=0;url=iui/index.html>" > target/doc/index.html &&
+  sudo pip install ghp-import &&
+  ghp-import -n target/doc &&
+  git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages
 
-script: cd $TEST_DIR && cargo build --verbose
+env:
+  global:
+    secure: dfPG6E3lrxnbah17u8S4xJmqFMhrAKoXNxQKGSnEoP3HjZL1NrFFsGCtGbIGPGyz02sCQ3U35nmuGHjUP9SOn+oRV6oQlBx41PPHULoDfsMKojEG80Uphjhd6rCXhdTG10EeIjqK+thNvbhnKXJoSPxe7rIk+r+z4HWHjQhxQuT6i4A6AsjvLGV1UI/WxCzrRFJohnaSyd/jx4/BgBd6XXsHzBvrjYSKSDrrBfJJwqrVchLozD6wSKTaTYdK9CSVGYx8S58Kx2m1j1Hk7FuuC6tqPtOARpwlNOX83p4PUMgZln74QzPN65Y2oYx5dszjflyAf5p264ltDwMLlygDTs92kilRCrznnP1iHgtrO3+aV2jwtRtqXB16JpeYKGFMkRtd3afWZ1SaMjU7s+6tVbSvlXg88GstZPqYYw7B4qYP1BGPX6UGiYMtpqH3Tm1Ne3lX3sPQYDFaV7vkd4JoS05vuHuGU+FERJRmaMAHjz2PCEhcgwnQTzL5LFKTcfNHEFv7NkQ8zPiJ7GELg9n2KnWiRhdB4JGUu8WB1LyYP6j3CQ9NwfBj0VGiH8Urgl9fC3IJnXQW3f284vk0VxBQnSdKILHsvdo8pe6INbDu97XOhzZNIc4jLZRT08aQe5Lk+3e7nGf0CCxFNQSlP6FFN7UP9c/Qvd4M3Ys5atBAryQ=

Cargo.toml

@@ -0,0 +1,6 @@
+[workspace]
+members = [
+    "ui-sys",
+    "ui",
+    "iui",
+]

README.md

@@ -1,7 +1,95 @@
-# libui-rs
+# Improved User Interface
+## A cross-platform UI toolkit for Rust based on libui
+[![libui-rs build status](https://api.travis-ci.org/LeoTindall/libui-rs.svg?branch=master)](https://travis-ci.org/LeoTindall/libui-rs/)
+[![issue resolution badge](https://isitmaintained.com/badge/resolution/LeoTindall/libui-rs.svg)](https://isitmaintained.com/project/LeoTindall/libui-rs)
+[![open issues badge](https://isitmaintained.com/badge/open/LeoTindall/libui-rs.svg)](https://isitmaintained.com/project/LeoTindall/libui-rs)
+![actively developed badge](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
 
-[![Build Status](https://travis-ci.org/lord/libui-rs.svg?branch=master)](https://travis-ci.org/lord/libui-rs)
+iui: [![iui crates.io version badge](https://img.shields.io/crates/v/iui.svg)](https://crates.io/crates/iui/)
+[![docs.rs for iui](https://docs.rs/iui/badge.svg)](https://docs.rs/iui)
+ui-sys: [![ui-sys crates.io version badge](https://img.shields.io/crates/v/ui-sys.svg)](https://crates.io/crates/ui-sys/)
+[![docs.rs for ui-sys](https://docs.rs/ui-sys/badge.svg)](https://docs.rs/ui)
 
-These are work-in-progress Rust bindings to the minimalistic native UI library [libui][libui].
+`iui` is a simple, small, easy to distribute GUI library, a Rusty user interface library that binds to platform native APIs.
+These are work-in-progress bindings to the minimalistic native UI library [libui][libui] via the `ui-sys` bindings crate.
 
-Fork of the original Rust bindings by [Patrick Walton](https://github.com/andlabs/libui).
+Add `iui` to your project with:
+
+```toml
+iui = "0.2"
+```
+
+## Organization
+
+`iui` is the safe Rust wrapper, to be used by most users.
+`ui` is the old version of the safe wrapper. Don't use this.
+`ui-sys` is the raw unsafe bindings to the `libui` C code. Requires `cmake` so it can build `libui`.
+`libui` is included as a submodule. You will need CMake to build `libui` itself.
+
+Based on work by [@pcwalton](https://github.com/pcwalton/). Licensed MIT.
+
+## Example
+
+![Three example GUI applications running on Linux](themed.png)
+
+```rust
+extern crate iui;
+use iui::prelude::*;
+use iui::controls::{Label, Button, VerticalBox, Group};
+
+fn main() {
+    // Initialize the UI library
+    let ui = UI::init().expect("Couldn't initialize UI library");
+    // Create a window into which controls can be placed
+    let mut win = Window::new(&ui, "Test App", 200, 200, WindowType::NoMenubar);
+
+    // Create a vertical layout to hold the controls
+    let mut vbox = VerticalBox::new(&ui);
+    vbox.set_padded(&ui, true);
+
+    let mut group_vbox = VerticalBox::new(&ui);
+    let mut group = Group::new(&ui, "Group");
+
+    // Create two buttons to place in the window
+    let mut button = Button::new(&ui, "Button");
+    button.on_clicked(&ui, {
+        let ui = ui.clone();
+        move |btn| {
+            btn.set_text(&ui, "Clicked!");
+        }
+    });
+
+    let mut quit_button = Button::new(&ui, "Quit");
+    quit_button.on_clicked(&ui, {
+        let ui = ui.clone();
+        move |_| {
+            ui.quit();
+        }
+    });
+
+    // Create a new label. Note that labels don't auto-wrap!
+    let mut label_text = String::new();
+    label_text.push_str("There is a ton of text in this label.\n");
+    label_text.push_str("Pretty much every unicode character is supported.\n");
+    label_text.push_str("🎉 用户界面 사용자 인터페이스");
+    let label = Label::new(&ui, &label_text);
+
+    vbox.append(&ui, label, LayoutStrategy::Stretchy);
+    group_vbox.append(&ui, button, LayoutStrategy::Compact);
+    group_vbox.append(&ui, quit_button, LayoutStrategy::Compact);
+    group.set_child(&ui, group_vbox);
+    vbox.append(&ui, group, LayoutStrategy::Compact);
+
+    // Actually put the button in the window
+    win.set_child(&ui, vbox);
+    // Show the window
+    win.show(&ui);
+    // Run the application
+    ui.main();
+}
+```
+
+## Testing Note
+Travis does not connect video devices to their testing environments, so the tests cannot be run. Therefore, the "tests" only check compilation.
+
+[libui]: https://github.com/andlabs/libui

iui/Cargo.toml

@@ -0,0 +1,49 @@
+[package]
+name = "iui"
+version = "0.2.0"
+authors = ["Leo Tindall <[email protected]>"]
+
+# A short blurb about the package. This is not rendered in any format when
+# uploaded to crates.io (aka this is not markdown).
+description = "Simple, small, easy to distribute GUI bindings."
+
+# These URLs point to more information about the package. These are
+# intended to be webviews of the relevant data, not necessarily compatible
+# with VCS tools and the like.
+documentation = "https://docs.rs/iui/"
+repository = "https://github.com/LeoTindall/libui-rs"
+
+# This points to a file under the package root (relative to this `Cargo.toml`).
+# The contents of this file are stored and indexed in the registry.
+# crates.io will render this file and place the result on the crate's page.
+readme = "../README.md"
+
+# This is a list of up to five keywords that describe this crate. Keywords
+# are searchable on crates.io, and you may choose any words that would
+# help someone find this crate.
+keywords = ["windows", "gtk", "gui", "user_interface", "macos"]
+
+# This is a list of up to five categories where this crate would fit.
+# Categories are a fixed list available at crates.io/category_slugs, and
+# they must match exactly.
+categories = ["gui", "os::macos-apis", "os::unix-apis", "os::windows-apis"]
+license = "MIT"
+
+[badges]
+# Travis CI: `repository` in format "<user>/<project>" is required.
+# `branch` is optional; default is `master`
+travis-ci = { repository = "LeoTindall/libui-rs", branch = "master" }
+
+# Is it maintained resolution time: `repository` is required.
+is-it-maintained-issue-resolution = { repository = "LeoTindall/libui-rs" }
+
+# Is it maintained percentage of open issues: `repository` is required.
+is-it-maintained-open-issues = { repository = "LeoTindall/libui-rs" }
+
+maintenance = { status = "actively-developed" }
+
+[dependencies]
+bitflags = "0.7"
+libc = "0.2"
+failure = "0.1.1"
+ui-sys = "0.1.1"

iui/examples/basic.rs

@@ -0,0 +1,54 @@
+extern crate iui;
+use iui::prelude::*;
+use iui::controls::{Label, Button, VerticalBox, Group};
+
+fn main() {
+    // Initialize the UI library
+    let ui = UI::init().expect("Couldn't initialize UI library");
+    // Create a window into which controls can be placed
+    let mut win = Window::new(&ui, "Test App", 200, 200, WindowType::NoMenubar);
+    
+    // Create a vertical layout to hold the controls
+    let mut vbox = VerticalBox::new(&ui);
+    vbox.set_padded(&ui, true);
+
+    let mut group_vbox = VerticalBox::new(&ui);
+    let mut group = Group::new(&ui, "Group");
+
+    // Create two buttons to place in the window
+    let mut button = Button::new(&ui, "Button");
+    button.on_clicked(&ui, {
+        let ui = ui.clone();
+        move |btn| {
+            btn.set_text(&ui, "Clicked!");
+        }
+    });
+
+    let mut quit_button = Button::new(&ui, "Quit");
+    quit_button.on_clicked(&ui, {
+        let ui = ui.clone();
+        move |_| {
+            ui.quit();
+        }
+    });
+
+    // Create a new label. Note that labels don't auto-wrap!
+    let mut label_text = String::new();
+    label_text.push_str("There is a ton of text in this label.\n");
+    label_text.push_str("Pretty much every unicode character is supported.\n");
+    label_text.push_str("🎉 用户界面 사용자 인터페이스");
+    let label = Label::new(&ui, &label_text);
+
+    vbox.append(&ui, label, LayoutStrategy::Stretchy);
+    group_vbox.append(&ui, button, LayoutStrategy::Compact);
+    group_vbox.append(&ui, quit_button, LayoutStrategy::Compact);
+    group.set_child(&ui, group_vbox);
+    vbox.append(&ui, group, LayoutStrategy::Compact);
+
+    // Actually put the button in the window
+    win.set_child(&ui, vbox);
+    // Show the window
+    win.show(&ui);
+    // Run the application
+    ui.main();
+}

iui/examples/files.rs

@@ -0,0 +1,48 @@
+//! Demonstrates the use of the Window::save_file() call to get a filename via a friendly GUI,
+//! and the Window::modal_err() call to display modal dialog boxes.
+
+extern crate iui;
+use iui::prelude::*;
+use iui::controls::{VerticalBox, MultilineEntry, Button};
+use std::io::prelude::*;
+use std::error::Error;
+use std::fs::File;
+
+fn main() {
+    // Initialize the UI
+    let ui = UI::init().unwrap();
+
+    // Create the input controls
+    let entry = MultilineEntry::new(&ui);
+    let mut button = Button::new(&ui, "Save Buffer");
+
+    // Set up the application's layout
+    let mut window = Window::new(&ui, "Save Buffer to File", 640, 480, WindowType::NoMenubar);
+    let mut vbox = VerticalBox::new(&ui);
+    vbox.append(&ui, entry.clone(), LayoutStrategy::Stretchy);
+    vbox.append(&ui, button.clone(), LayoutStrategy::Compact);
+    window.set_child(&ui, vbox);
+    window.show(&ui);
+
+    // When the button is clicked, get the name of a file and then write the entry's contents to it.
+    // Note the in real code you should spin off a thread to do the actual writing, do it between UI events,
+    // or use Tokio. Even with minmal content, this method shows noticable lag.
+    button.on_clicked(&ui, {
+        let ui = ui.clone();
+        move |_| {
+            if let Some(path) = window.save_file(&ui) {
+                let mut file = match File::create(&path) {
+                    Err(why) => { window.modal_err(&ui, "I/O Error", &format!("Could not open file {}: {}", path.display(), why.description())); return; }
+                    Ok(f) => f
+                };
+                match file.write_all(entry.value(&ui).as_bytes()) {
+                    Err(why) => { window.modal_err(&ui, "I/O Error", &format!("Could not write to file {}: {}", path.display(), why.description())); return; }
+                    Ok(_) => ()
+                };
+            }    
+        }
+    });
+
+    ui.main();
+
+}