Merge pull request #1 from emoon/refactor

Big refactor
Added proper Result type
No unwrapping inside the open dialog functions. It now returns a correct restult type instead
Added the nfd sources that is built using the gcc crate instead of having the user compile the code manually
Added DialogBuilder to make it nicer to construct dialogs with filters and paths
Added builder_open_jpg example which uses the builder code and only allows for opening of jpg files
Fixed issue focus issue for Mac dialogs: Outlined here mlabbe/nativefiledialog#7
Support for multi open + example

Author: saurvs

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "nfd"
-version = "0.0.1"
-authors = ["Saurav Sachidanand <[email protected]>"]
+version = "0.0.2"
+authors = ["Saurav Sachidanand <[email protected]>", "Daniel Collin <daniel@collin>"]
 
 license = "MIT"
 repository = "https://www.github.com/saurvs/nfd-rs"
@@ -11,5 +11,6 @@ keywords = ["file", "dialog", "ui"]
 
 build = "build.rs"
 
-[dependencies]
-libc = "0.2.7"
+[build-dependencies]
+gcc = "0.3"
+

README.md

@@ -2,12 +2,10 @@
 
 `nfd-rs` is a Rust binding to the library [nativefiledialog](https://github.com/mlabbe/nativefiledialog), that provides a convenient cross-platform interface to opening file dialogs on Linux, OS X and Windows.
 
-Currently, only single file and save dialogs are supported, and the crate has been tested only on OS X. And yes, APIs may break with newer versions.
+This crate has been tested on Mac, Window and Linux (Ubuntu 14.04) and supports single/mutliple and save dialogs, notice APIs may break with newer versions.
 
 ## Usage
 
-* Follow the instructions [here](https://github.com/mlabbe/nativefiledialog/blob/master/README.md) to build the libraries in C and an OS-specific language. Then, set the `NFD_LIB_DIR` environment variable to the path of the directory in which the libraries are stored.
-
 * Add the dependency `nfd` in your ```Cargo.toml```
   ```toml
   [dependencies]
@@ -18,18 +16,37 @@ Currently, only single file and save dialogs are supported, and the crate has be
   ```rust
   extern crate nfd;
 
-  use nfd::*;
+  use nfd::Response
 
   fn main() {
 
-    let result = open_file_dialog(None, None);
+    let result = nfd::open_file_dialog(None, None).unwrap_or_else(|e| {
+    	panic!(e);
+    });
 
     match result {
-        NFDResult::Okay(file_path) => println!("File path = {:?}", file_path),
-        NFDResult::Cancel => println!("User canceled"),
-        NFDResult::Error(error) => println!("Error: {}", error),
+        Response::Okay(file_path) => println!("File path = {:?}", file_path),
+        Response::Cancel => println!("User canceled"),
     }
+  }
+  ```
+
+* Open a multi file dialog using builder with jpg files as filter
+  ```rust
+  extern crate nfd;
 
+  use nfd::Response
+
+  fn main() {
+
+    let result = nfd::dialog_multiple().filter("jpg").open().unwrap_or_else(|e| {
+    	panic!(e);
+    });
+
+    match result {
+        Response::OkayMultiple(files) => println!("Files {:?}", files),
+        Response::Cancel => println!("User canceled"),
+    }
   }
   ```
 

build.rs

@@ -20,11 +20,51 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
 
+extern crate gcc;
 use std::env;
+use std::process::Command;
 
 fn main() {
-    let ndf_lib_dir = env::var("NFD_LIB_DIR").unwrap();
-    println!("cargo:rustc-link-search=native={}",ndf_lib_dir);
-    println!("cargo:rustc-link-lib=static=nfd");
-    println!("cargo:rustc-link-lib=framework=AppKit");
+    let mut cfg = gcc::Config::new();
+    let env = env::var("TARGET").unwrap();
+
+    cfg.file("nfd/src/nfd_common.c");
+
+    if env.contains("darwin") {
+        cfg.file("nfd/src/nfd_cocoa.m");
+        cfg.compile("libnfd.a");
+        println!("cargo:rustc-link-lib=framework=AppKit");
+    } else if env.contains("windows") {
+        cfg.file("nfd/src/nfd_win.cpp");
+        cfg.compile("libnfd.a");
+        println!("cargo:rustc-link-lib=ole32");
+        // MinGW doesn't link it by default
+        println!("cargo:rustc-link-lib=uuid");
+    } else {
+        let pkg_output = Command::new("pkg-config")
+            .arg("--cflags")
+            .arg("gtk+-3.0")
+            .arg("glib-2.0")
+            .arg("--libs")
+            .arg("glib-2.0")
+            .output();
+        match pkg_output {
+            Ok(output) => {
+                let t = String::from_utf8(output.stdout).unwrap();
+                let flags = t.split(" ");
+                for flag in flags {
+                    if flag != "\n" && flag != "" {
+                        cfg.flag(flag);
+                    }
+                }
+            }
+            _ => (),
+        }
+        cfg.file("nfd/src/nfd_gtk.c");
+        cfg.compile("libnfd.a");
+        println!("cargo:rustc-link-lib=gdk-3");
+        println!("cargo:rustc-link-lib=gtk-3");
+        println!("cargo:rustc-link-lib=glib-2.0");
+        println!("cargo:rustc-link-lib=gobject-2.0");
+    }
 }

examples/builder_open_jpg.rs

@@ -0,0 +1,15 @@
+extern crate nfd;
+
+use nfd::Response;
+
+fn main() {
+    let result = nfd::dialog().filter("jpg").open().unwrap_or_else(|e| {
+        panic!(e);
+    });
+
+    match result {
+        Response::Okay(file_path) => println!("File path = {:?}", file_path),
+        Response::Cancel => println!("User canceled"),
+        _ => (),
+    }
+}

examples/example.rs

@@ -22,14 +22,16 @@ THE SOFTWARE.
 
 extern crate nfd;
 
-use nfd::*;
+use nfd::Response;
 
 fn main() {
-    let result = open_file_dialog(None, None);
+    let result = nfd::open_file_dialog(None, None).unwrap_or_else(|e| {
+        panic!(e);
+    });
 
     match result {
-        NFDResult::Okay(file_path) => println!("File path = {:?}", file_path),
-        NFDResult::Cancel => println!("User canceled"),
-        NFDResult::Error(error) => println!("Error: {}", error),
+        Response::Okay(file_path) => println!("File path = {:?}", file_path),
+        Response::Cancel => println!("User canceled"),
+        _ => (),
     }
 }

examples/open_multiple.rs

@@ -0,0 +1,15 @@
+extern crate nfd;
+
+use nfd::Response;
+
+fn main() {
+    let result = nfd::dialog_multiple().open().unwrap_or_else(|e| {
+        panic!(e);
+    });
+
+    match result {
+        Response::OkayMultiple(files) => println!("File path = {:?}", files),
+        Response::Cancel => println!("User canceled"),
+        _ => (),
+    }
+}

nfd/LICENSE

@@ -0,0 +1,16 @@
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.
+

nfd/README.md

@@ -0,0 +1,137 @@
+# Native File Dialog #
+
+A tiny, neat C library that portably invokes native file open and save dialogs.  Write dialog code once and have it pop up native dialogs on all supported platforms.  Avoid linking large dependencies like wxWidgets and qt.
+
+Features:
+
+ - Lean C API, static library -- no ObjC, no C++, no STL.
+ - Zlib licensed.
+ - Consistent UTF-8 support on all platforms.
+ - Simple universal file filter syntax.
+ - Paid support available.
+ - Multiple file selection support.
+ - 64-bit and 32-bit friendly.
+ - GCC, Clang and Visual Studio supported.
+ - No third party dependencies.
+ - Support for Vista's modern `IFileDialog` on Windows.
+ - Support for non-deprecated Cocoa APIs on OS X.
+ - GTK+3 dialog on Linux.
+ - Tested, works alongside [http://www.libsdl.org](SDL2) on all platforms, for the game developers out there.
+
+# Example Usage #
+
+```C
+#include <nfd.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+int main( void )
+{
+    nfdchar_t *outPath = NULL;
+    nfdresult_t result = NFD_OpenDialog( NULL, NULL, &outPath );
+        
+    if ( result == NFD_OKAY ) {
+        puts("Success!");
+        puts(outPath);
+        free(outPath);
+    }
+    else if ( result == NFD_CANCEL ) {
+        puts("User pressed cancel.");
+    }
+    else {
+        printf("Error: %s\n", NFD_GetError() );
+    }
+
+    return 0;
+}
+```
+
+See [NFD.h](src/include/nfd.h) for more options.
+
+# Screenshots #
+
+![Windows 8 rendering an IFileOpenDialog](screens/open_win8.png?raw=true)
+![GTK3 on Linux](screens/open_gtk3.png?raw=true)
+![Cocoa on Yosemite](screens/open_cocoa.png?raw=true)
+
+
+## Building ##
+
+NFD uses [SCons](http://www.scons.org) for cross-platform builds.  After installing SCons, build it with:
+
+    cd src
+    scons debug=[0,1]
+
+Alternatively, you can avoid Scons by just including NFD files to your existing project:
+
+ 1. Add all header files in `src/` and `src/include` to your project.
+ 2. Add `src/include` to your include search path or copy it into your existing search path.
+ 3. Add `src/nfd_common.c` to your project.
+ 4. Add `src/nfd_<platform>` to your project, where `<platform>` is the NFD backend for the platform you are fixing to build.
+ 5. On Visual Studio, define `_CRT_SECURE_NO_WARNINGS` to avoid warnings.
+
+### Compiling Your Programs ###
+
+ 1. Add `src/include` to your include search path.
+ 2. Add `nfd.lib` to the list of list of static libraries to link against.
+ 3. Add `src/` to the library search path.
+
+On Linux, you must compile and link against GTK+.  Recommend use of `pkg-config --cflags --libs gtk+-3.0`.
+
+On Mac OS X, add `AppKit` to the list of frameworks.
+
+On Windows, ensure you are building against `comctl32.lib`.
+
+## Usage ##
+
+See `NFD.h` for API calls.  See `tests/*.c` for example code.
+
+See `tests/SConstruct` for a working build script that compiles on all platforms.
+
+## File Filter Syntax ##
+
+There is a form of file filtering in every file dialog, but no consistent means of supporting it.  NFD provides support for filtering files by groups of extensions, providing its own descriptions (where applicable) for the extensions.
+
+A wildcard filter is always added to every dialog.
+
+### Separators ###
+
+ - `;` Begin a new filter.
+ - `,` Add a separate type to the filter.
+
+#### Examples ####
+
+`txt` The default filter is for text files.  There is a wildcard option in a dropdown.
+
+`png,jpg;psd` The default filter is for png and jpg files.  A second filter is available for psd files.  There is a wildcard option in a dropdown.
+
+`NULL` Wildcard only.
+
+## Iterating Over PathSets ##
+
+See [test_opendialogmultiple.c](test/test_opendialogmultiple.c).
+
+# Known Limitations #
+
+I accept quality code patches, or will resolve these and other matters through support.
+
+ - No support for Windows XP's legacy dialogs such as `GetOpenFileName`.
+ - No support for file filter names -- ex: "Image Files" (*.png, *.jpg).  Nameless filters are supported, though.
+ - No support for selecting folders instead of files.
+ - On Linux, GTK+ cannot be uninitialized to save memory.  Launching a file dialog costs memory.  I am open to accepting an alternative `nfd_zenity.c` implementation which uses Zenity and pipes.
+
+# Copyright and Credit #
+
+Copyright &copy; 2014 [Frogtoss Games](http://www.frogtoss.com), Inc.
+File [LICENSE](LICENSE) covers all files in this repo.
+
+Native File Dialog by Michael Labbe
+<[email protected]>
+
+Tomasz Konojacki for [microutf8](http://puszcza.gnu.org.ua/software/microutf8/)
+
+## Support ##
+
+Directed support for this work is available from the original author under a paid agreement.
+
+[Contact Frogtoss Games](http://www.frogtoss.com/pages/contact.html).

nfd/src/common.h

@@ -0,0 +1,21 @@
+/*
+  Native File Dialog
+
+  Internal, common across platforms
+
+  http://www.frogtoss.com/labs
+ */
+
+
+#ifndef _NFD_COMMON_H
+#define _NFD_COMMON_H
+
+#define NFD_MAX_STRLEN 256
+#define _NFD_UNUSED(x) ((void)x)
+
+void *NFDi_Malloc( size_t bytes );
+void  NFDi_Free( void *ptr );
+void  NFDi_SetError( const char *msg );
+void  NFDi_SafeStrncpy( char *dst, const char *src, size_t maxCopy );
+
+#endif