gdnative 0.3.0

//! # Rust bindings for the Godot game engine
//!
//! ## Reference-counting and mutability
//!
//! All non trivially copyable godot types exposed in this crate are
//! internally reference-counted and allow mutable aliasing.
//! In rust parlance this means that a type such as `gdnative::ByteArray`
//! is functionally equivalent to a `Rc<Cell<Vec<u8>>>` rather than `Vec<u8>`.
//!
//! Since it is easy to expect container types to allocate a copy of their content
//! when using the `Clone` trait, most of these types do not implement `Clone` and
//! instead provide a `new_ref(&self) -> Self` method to create references to the
//! same collection or object.

#[doc(hidden)]
pub extern crate libc;
#[doc(hidden)]
pub extern crate gdnative_sys as sys;
#[macro_use]
extern crate bitflags;

pub extern crate gdnative_geom as geom;

mod macros;
#[macro_use]
mod class;
mod object;
mod internal;
mod property;
mod godot_type;
mod color;
mod variant;
mod variant_array;
mod dictionary;
mod rid;
mod generated;
mod node_path;
mod string;
mod byte_array;
mod int32_array;
mod float32_array;
mod string_array;
mod vector2_array;
mod vector3_array;
mod color_array;

pub use internal::*;
pub use property::*;
pub use class::*;
pub use godot_type::*;
pub use variant::*;
pub use variant_array::*;
pub use dictionary::*;
pub use geom::*;
pub use color::*;
pub use rid::*;
pub use node_path::*;
pub use generated::*;
pub use string::*;
pub use byte_array::*;
pub use int32_array::*;
pub use float32_array::*;
pub use string_array::*;
pub use vector2_array::*;
pub use vector3_array::*;
pub use color_array::*;
pub use object::GodotObject;

use std::mem;

#[doc(hidden)]
pub static mut GODOT_API: Option<GodotApi> = None;
#[inline]
#[doc(hidden)]
pub fn get_api() -> &'static GodotApi {
    unsafe { GODOT_API.as_ref().expect("API not bound") }
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum GodotError {
    Failed = sys::godot_error::GODOT_FAILED as u32,
    Unavailable = sys::godot_error::GODOT_ERR_UNAVAILABLE as u32,
    Unconfigured = sys::godot_error::GODOT_ERR_UNCONFIGURED as u32,
    Unothorized = sys::godot_error::GODOT_ERR_UNAUTHORIZED as u32,
    PrameterRange = sys::godot_error::GODOT_ERR_PARAMETER_RANGE_ERROR as u32,
    OutOfMemory = sys::godot_error::GODOT_ERR_OUT_OF_MEMORY as u32,
    FileNotFound = sys::godot_error::GODOT_ERR_FILE_NOT_FOUND as u32,
    FileBadDrive = sys::godot_error::GODOT_ERR_FILE_BAD_DRIVE as u32,
    FileBadPath = sys::godot_error::GODOT_ERR_FILE_BAD_PATH as u32,
    FileNoPermission = sys::godot_error::GODOT_ERR_FILE_NO_PERMISSION as u32,
    FileAlreadyInUse = sys::godot_error::GODOT_ERR_FILE_ALREADY_IN_USE as u32,
    FileCantOpen = sys::godot_error::GODOT_ERR_FILE_CANT_OPEN as u32,
    FileCantWrite = sys::godot_error::GODOT_ERR_FILE_CANT_WRITE as u32,
    FileCantRead = sys::godot_error::GODOT_ERR_FILE_CANT_READ as u32,
    FileUnrecognized = sys::godot_error::GODOT_ERR_FILE_UNRECOGNIZED as u32,
    FileCorrupt = sys::godot_error::GODOT_ERR_FILE_CORRUPT as u32,
    FileMissingDependency = sys::godot_error::GODOT_ERR_FILE_MISSING_DEPENDENCIES as u32,
    FileEof = sys::godot_error::GODOT_ERR_FILE_EOF as u32,
    CantOpen = sys::godot_error::GODOT_ERR_CANT_OPEN as u32,
    CantCreate = sys::godot_error::GODOT_ERR_CANT_CREATE as u32,
    QueryFailed = sys::godot_error::GODOT_ERR_QUERY_FAILED as u32,
    AlreadyInUse = sys::godot_error::GODOT_ERR_ALREADY_IN_USE as u32,
    Locked = sys::godot_error::GODOT_ERR_LOCKED as u32,
    TimeOut = sys::godot_error::GODOT_ERR_TIMEOUT as u32,
    CantConnect = sys::godot_error::GODOT_ERR_CANT_CONNECT as u32,
    CantResolve = sys::godot_error::GODOT_ERR_CANT_RESOLVE as u32,
    ConnectionError = sys::godot_error::GODOT_ERR_CONNECTION_ERROR as u32,
    CantAcquireResource = sys::godot_error::GODOT_ERR_CANT_ACQUIRE_RESOURCE as u32,
    CantFork = sys::godot_error::GODOT_ERR_CANT_FORK as u32,
    InvalidData = sys::godot_error::GODOT_ERR_INVALID_DATA as u32,
    InvalidParameter = sys::godot_error::GODOT_ERR_INVALID_PARAMETER as u32,
    AlreadyExists = sys::godot_error::GODOT_ERR_ALREADY_EXISTS as u32,
    DoesNotExist = sys::godot_error::GODOT_ERR_DOES_NOT_EXIST as u32,
    DatabaseCantRead = sys::godot_error::GODOT_ERR_DATABASE_CANT_READ as u32,
    DatabaseCantWrite = sys::godot_error::GODOT_ERR_DATABASE_CANT_WRITE as u32,
    CompilationFailed = sys::godot_error::GODOT_ERR_COMPILATION_FAILED as u32,
    MethodNotFound = sys::godot_error::GODOT_ERR_METHOD_NOT_FOUND as u32,
    LinkFailed = sys::godot_error::GODOT_ERR_LINK_FAILED as u32,
    ScriptFailed = sys::godot_error::GODOT_ERR_SCRIPT_FAILED as u32,
    CyclicLink = sys::godot_error::GODOT_ERR_CYCLIC_LINK as u32,
    InvalidDeclaration = sys::godot_error::GODOT_ERR_INVALID_DECLARATION as u32,
    DuplicateSymbol = sys::godot_error::GODOT_ERR_DUPLICATE_SYMBOL as u32,
    ParseError = sys::godot_error::GODOT_ERR_PARSE_ERROR as u32,
    Busy = sys::godot_error::GODOT_ERR_BUSY as u32,
    Skip = sys::godot_error::GODOT_ERR_SKIP as u32,
    Help = sys::godot_error::GODOT_ERR_HELP as u32,
    Bug = sys::godot_error::GODOT_ERR_BUG as u32,
    PrinterOnFire = sys::godot_error::GODOT_ERR_PRINTER_ON_FIRE as u32,
}

pub type GodotResult = Result<(), GodotError>;

pub fn result_from_sys(err: sys::godot_error) -> GodotResult {
    if err == sys::godot_error::GODOT_OK {
        return Ok(());
    }

    Err(unsafe { mem::transmute(err) })
}