1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! Wry is a Cross-platform WebView rendering library.
//!
//! There are two main ways to build WebView windows: [`Application`] and build by yourself.
//!
//! # Building WebView windows through [`Application`]
//!
//! [`Application`] is the recommended way to build the WebView windows. It provides easy to use and
//! unified APIs across all platforms. To get started, you simply create an [`Application`] first:
//!
//! ```no_run
//! let application = Application::new()?;
//! ```
//!
//! Once you have your application instance, you can create the WebView window by calling
//! [`Application::create_window`]. You can provide [`WebViewAttributes`] and [`Callback`] as
//! arguments to configure the WebView window. If you don't have any preference, you could just set
//! them with `Default::default()` and `None`.
//!
//! ```no_run
//!     let attributes = WebViewAttributes {
//!         title: String::from("Wryyyyyyyyyyyyyyy"),
//!         // Initialization scripts can be used to define javascript functions and variables.
//!         initialization_script: vec![String::from("breads = NaN"), String::from("menacing = 'ゴ'")],
//!         ..Default::default()
//!     };
//!     // Callback defines a rust function to be called on javascript side later. Below is a function
//!     // which will print the list of parameters after 8th calls.
//!     let callback = Callback {
//!         name: String::from("world"),
//!         function: Box::new(|dispatcher, sequence, requests| {
//!             // Dispatcher is a channel sender for you to dispatch script to the javascript world
//!             // and evaluate it. This is useful when you want to perform any action in javascript.
//!             dispatcher
//!                 .dispatch_script("console.log(menacing);")
//!                 .unwrap();
//!             // Sequence is a number counting how many times this function being called.
//!             if sequence < 8 {
//!                 println!("{} seconds has passed.", sequence);
//!             } else {
//!                 // Requests is a vector of parameters passed from the caller.
//!                 println!("{:?}", requests);
//!             }
//!             0
//!         }),
//!     };
//!     app.create_window(attributes, Some(vec![callback]))?;
//! ```
//!
//! Run the application with run in the end. This will consume the instance and run the application
//! on current thread.
//!
//! ```no_run
//! application.run();
//! ```
//!
//! # Building WebView windows by yourself
//!
//! If you want to control whole windows creation and events handling, you can use
//! [`WebViewBuilder`] / [`WebView`] and [platform] module to build it all by yourself. [platform]
//! module re-exports [winit] for you to build the window across all platforms except Linux. We still
//! need Gtk's library to build the WebView, so it's [gtk-rs] on Linux.
//!
//! [`Application`]: crate::Application
//! [`Application::create_window`]: crate::Application::create_window
//! [`Application::run`]: crate::Application::run
//! [`WebViewAttributes`]: crate::WebViewAttributes
//! [`Callback`]: crate::Callback
//! [`WebViewBuilder`]: crate::WebViewBuilder
//! [platform]: crate::platform
//! [winit]: https://crates.io/crates/winit
//! [gtk-rs]: https://crates.io/crates/gtk
//!

#[macro_use]
extern crate serde;
#[macro_use]
extern crate thiserror;
#[cfg(target_os = "macos")]
#[macro_use]
extern crate objc;

mod application;
pub mod platform;
mod webview;

pub use application::{Application, Callback, WebViewAttributes};
pub use webview::{Dispatcher, WebView, WebViewBuilder};

use std::sync::mpsc::SendError;

use url::ParseError;

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Error, Debug)]
pub enum Error {
    #[cfg(target_os = "linux")]
    #[error(transparent)]
    GlibError(#[from] glib::Error),
    #[cfg(target_os = "linux")]
    #[error(transparent)]
    GlibBoolError(#[from] glib::BoolError),
    #[error("Failed to initialize the script")]
    InitScriptError,
    #[error(transparent)]
    NulError(#[from] std::ffi::NulError),
    #[cfg(not(target_os = "linux"))]
    #[error(transparent)]
    OsError(#[from] winit::error::OsError),
    #[error(transparent)]
    SenderError(#[from] SendError<String>),
    #[error(transparent)]
    UrlError(#[from] ParseError),
    #[cfg(target_os = "windows")]
    #[error("Windows error: {0:?}")]
    WinrtError(windows::Error),
}

#[cfg(target_os = "windows")]
impl From<windows::Error> for Error {
    fn from(error: windows::Error) -> Self {
        Error::WinrtError(error)
    }
}