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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

// Copyright 2013-2016, The Gtk-rs Project Developers.
// See the COPYRIGHT file at the top-level directory of this distribution.
// Licensed under the MIT license, see the LICENSE file or <http://opensource.org/licenses/MIT>

//! # **glib**, **gobject** and **gio** bindings for Rust
//!
//! This library contains
//!
//! - bindings to some essential GLib, GObject, GIO types and APIs,
//!
//! - common building blocks used in both handmade and machine generated
//! bindings to GTK+ and other GLib-based libraries.
//!
//! It is the foundation for higher level libraries with uniform Rusty (safe and
//! strongly typed) APIs. It avoids exposing GLib-specific data types where
//! possible and is not meant to provide comprehensive GLib bindings, which
//! would often amount to duplicating the Rust Standard Library or other utility
//! crates.
//!
//! The library is a work in progress: expect missing functionality and breaking
//! changes.
//!
//! # Dynamic typing
//!
//! Most types in the GLib family have type identifiers
//! ([`Type`](types/enum.Type.html)). Their corresponding Rust types implement
//! the [`StaticType`](types/trait.StaticType.html) trait.
//!
//! Dynamically typed [`Value`](value/index.html) can carry values of any `T:
//! StaticType`.
//!
//! [`Variant`](variant/index.html) can carry values of `T: StaticVariantType`.
//!
//! # Errors
//!
//! Errors are represented by [`Error`](error/struct.Error.html), which can
//! carry values from various [error
//! domains](error/trait.ErrorDomain.html#implementors) (such as
//! [`FileError`](enum.FileError.html)).
//!
//! # Objects
//!
//! Each class and interface has a corresponding smart pointer struct
//! representing an instance of that type (e.g. `Object` for `GObject`,
//! `gtk::Widget` for `GtkWidget`). They are reference counted and feature
//! interior mutability similarly to Rust's `Rc<RefCell<T>>` idiom.
//! Consequently, cloning objects is cheap and their methods never require
//! mutable borrows. Two smart pointers are equal iff they point to the same
//! object.
//!
//! The root of the object hierarchy is [`Object`](object/struct.Object.html).
//! Inheritance and subtyping is denoted with the [`IsA`](object/trait.IsA.html)
//! marker trait. The [`Cast`](object/trait.Cast.html) trait enables upcasting
//! and downcasting.
//!
//! Interfaces and non-leaf classes also have corresponding traits (e.g.
//! `ObjectExt` and `gtk::WidgetExt`), which are blanketly implemented for all
//! their subtypes.
//!
//! # Under the hood
//!
//! GLib-based libraries largely operate on pointers to various boxed or
//! reference counted structures so the bindings have to implement corresponding
//! smart pointers (wrappers), which encapsulate resource management and safety
//! checks. Such wrappers are defined via the
//! [`glib_wrapper!`](macro.glib_wrapper!.html) macro, which uses abstractions
//! defined in the [`wrapper`](wrapper/index.html), [`boxed`](boxed/index.html),
//! [`shared`](shared/index.html) and [`object`](object/index.html) modules.
//!
//! The [`translate`](translate/index.html) module defines and partly implements
//! conversions between high level Rust types (including the aforementioned
//! wrappers) and their FFI counterparts.

#[macro_use]
extern crate bitflags;
extern crate libc;
extern crate glib_sys as ffi;
extern crate gobject_sys as gobject_ffi;

pub use bytes::Bytes;
pub use error::Error;
pub use file_error::FileError;
pub use object::{
    Cast,
    IsA,
    Object,
    ObjectExt,
};
pub use signal::{
    signal_handler_block,
    signal_handler_unblock,
    signal_stop_emission,
    signal_stop_emission_by_name
};
pub use source::{
    CallbackGuard,
    Continue,
    idle_add,
    timeout_add,
    timeout_add_seconds,
    source_remove,
    Id as SourceId,
};
pub use types::{
    StaticType,
    Type,
};
pub use value::{
    ToValue,
    TypedValue,
    Value,
};
pub use variant::{
    StaticVariantType,
    ToVariant,
    Variant,
};
pub use variant_type::{
    VariantTy,
    VariantType,
};
pub use time_val::{
    TimeVal,
    get_current_time,
};
pub use enums::{
    UserDirectory,
};

pub const KEY_FILE_DESKTOP_GROUP: &'static str = ffi::G_KEY_FILE_DESKTOP_GROUP;
pub const KEY_FILE_DESKTOP_KEY_ACTIONS: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_ACTIONS;
pub const KEY_FILE_DESKTOP_KEY_CATEGORIES: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_CATEGORIES;
pub const KEY_FILE_DESKTOP_KEY_COMMENT: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_COMMENT;
pub const KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE;
pub const KEY_FILE_DESKTOP_KEY_EXEC: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_EXEC;
pub const KEY_FILE_DESKTOP_KEY_FULLNAME: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_FULLNAME;
pub const KEY_FILE_DESKTOP_KEY_GENERIC_NAME: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME;
pub const KEY_FILE_DESKTOP_KEY_GETTEXT_DOMAIN: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_GETTEXT_DOMAIN;
pub const KEY_FILE_DESKTOP_KEY_HIDDEN: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_HIDDEN;
pub const KEY_FILE_DESKTOP_KEY_ICON: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_ICON;
pub const KEY_FILE_DESKTOP_KEY_KEYWORDS: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_KEYWORDS;
pub const KEY_FILE_DESKTOP_KEY_MIME_TYPE: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_MIME_TYPE;
pub const KEY_FILE_DESKTOP_KEY_NAME: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_NAME;
pub const KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN;
pub const KEY_FILE_DESKTOP_KEY_NO_DISPLAY: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY;
pub const KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN;
pub const KEY_FILE_DESKTOP_KEY_PATH: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_PATH;
pub const KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY;
pub const KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS;
pub const KEY_FILE_DESKTOP_KEY_TERMINAL: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_TERMINAL;
pub const KEY_FILE_DESKTOP_KEY_TRY_EXEC: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_TRY_EXEC;
pub const KEY_FILE_DESKTOP_KEY_TYPE: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_TYPE;
pub const KEY_FILE_DESKTOP_KEY_URL: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_URL;
pub const KEY_FILE_DESKTOP_KEY_VERSION: &'static str = ffi::G_KEY_FILE_DESKTOP_KEY_VERSION;
pub const KEY_FILE_DESKTOP_TYPE_APPLICATION: &'static str = ffi::G_KEY_FILE_DESKTOP_TYPE_APPLICATION;
pub const KEY_FILE_DESKTOP_TYPE_DIRECTORY: &'static str = ffi::G_KEY_FILE_DESKTOP_TYPE_DIRECTORY;
pub const KEY_FILE_DESKTOP_TYPE_LINK: &'static str = ffi::G_KEY_FILE_DESKTOP_TYPE_LINK;

#[macro_use]
pub mod wrapper;
#[macro_use]
pub mod boxed;
#[macro_use]
pub mod shared;
#[macro_use]
pub mod object;

pub use auto::*;
mod auto;

mod bytes;
pub mod error;
mod enums;
mod file_error;
mod key_file;
pub mod prelude;
pub mod signal;
mod source;
mod time_val;
pub mod translate;
pub mod types;
pub mod utils;
pub mod value;
pub mod variant;
mod variant_type;