tcod 0.15.0

//! The console emulator handles the rendering of the game screen and the keyboard input
//!
//! It provides the necessary traits and types for working with the different console types,
//! including the [Console](./trait.Console.html) trait and the
//! [Root](./struct.Root.html) and [Offscreen](./struct.Offscreen.html) console types.
//! It's worth mentioning that only one `Root` console may exist at any given time, and it has to
//! be initialized at the start of the program.
//!
//! # Examples
//!
//! Initializing the `Root` console and creating an `Offscreen` console:
//!
//! ```no_run
//! use tcod::console::{Root, Offscreen};
//!
//! let mut root = Root::initializer().init();
//! let (width, height) = (80, 30);
//! let mut offscreen = Offscreen::new(width, height);
//! ```
//!
//! A typical `tcod-rs` program's basic structure would look something like this:
//!
//! ```no_run
//! use tcod::console::Root;
//!
//! fn main() {
//!     let mut root = Root::initializer().init(); // Replace with custom initialization code
//!
//!     while !root.window_closed() {
//!         // Handling user input
//!         // Updating the gamestate
//!         // Rendering the results
//!     }
//! }
//! ```
//!
//! For detailed examples on the user input handling and rendering see the
//! [Root](./struct.Root.html) struct's documentation.
//!
//!
//! ## Additional Information
//!
//! The `Root` and `Console` types are also reexported in the root module (`tcod`) under the names
//! `RootConsole` and `OffscreenConsole`, making the following code sample equivalent to the
//! previous one:
//!
//! ```no_run
//! use tcod::{RootConsole, OffscreenConsole};
//!
//! let mut root = RootConsole::initializer().init();
//! let (width, height) = (80, 30);
//! let mut offscreen = OffscreenConsole::new(width, height);
//! ```
//! This applies to all the examples in the rest of the modules documentation.

use std::ptr;
use std::str;

use std::marker::PhantomData;
use std::mem::transmute;
use std::path::Path;

use bindings::ffi::{self, TCOD_bkgnd_flag_t, TCOD_renderer_t, TCOD_font_flags_t, TCOD_alignment_t};
use bindings::{AsNative, FromNative, c_bool, CString};

use colors::Color;
use input::{Key, KeyPressFlags};

/// A type representing secondary consoles
///
/// `Offscreen` consoles allow you draw on secondary consoles as you would on `Root` consoles, and then
/// `blit` their contents onto other consoles (including `Root`). There are some limitations
/// compared to `Root` consoles, however:
///
/// * Functions manipulating the main window or handling user input are limited to the `Root`
/// console
/// * `Offscreen` consoles may not be `flushed` to the screen directly
///
/// # Examples
///
/// Creating an `Offscreen` console
///
/// ```no_run
/// use tcod::console::Offscreen;
///
/// let width = 80;
/// let height = 20;
/// let offscreen = Offscreen::new(width, height);
/// ```
///
/// Blitting an `Offscreen` console to the `Root` console:
///
/// ```no_run
/// use tcod::console as console;
/// use tcod::console::{Root, Offscreen};
///
/// fn main() {
///     let mut root = Root::initializer().init();
///
///     let mut direct = Offscreen::new(20, 20);
///     console::blit(&direct, (0, 0), (20, 20), &mut root, (0, 0), 1.0, 1.0);
/// }
///
/// ```
///
/// See the documentation for [blit](./fn.blit.html) for a detailed description of the function parameters
/// and a more in-depth example.
pub struct Offscreen {
    con: ffi::TCOD_console_t,
}

impl Drop for Offscreen {
    fn drop(&mut self) {
        unsafe {
            ffi::TCOD_console_delete(self.con);
        }
    }
}

impl Offscreen {
    /// Creates a new `Offscreen` console instance
    pub fn new(width: i32, height: i32) -> Offscreen {
        assert!(width > 0 && height > 0);
        unsafe {
            Offscreen { con: ffi::TCOD_console_new(width, height) }
        }
    }

}

// ! libtcod is not thread-safe, this may have some side effects but none have been seen yet
// ! This is primary so that Offscreen consoles can be used as specs resources
unsafe impl Send for Offscreen {}

/// The console representing the main window of the application
///
/// This is the only console type capable of handling user input and flushing its contents onto the screen.
/// There may only be one Root console at any given time, and it should be initialized at the start of the program.
///
/// # Examples
///
/// ## Handling user input
/// `tcod-rs` provides two ways of handling user input: blocking or non-blocking. The following
/// exaple will show the blocking method
///
/// ```no_run
/// use tcod::console::Root;
/// use tcod::input::Key;
/// use tcod::input::KeyCode::{Up, Down, Left, Right};
///
/// fn main() {
///     let mut root = Root::initializer().init();
///
///     let keypress = root.wait_for_keypress(true);
///     match keypress.code {
///         Up => {}, // Handle arrow key up
///         Down => {}, // Arrow key down
///         Left => {},
///         Right => {},
///         _ => {}
///     }
/// }
/// ```
///
/// For a detailed description of possible values of `keypress.key` values see the
/// [Key](../input/enum.Key.html) and [KeyCode](../input/enum.KeyCode.html) enums.
///
/// ## Rendering
/// `libtcod` provides a wide variety of functions for changing how the console output looks like,
/// including: changing the text and background colors, text alignment, etc. It also has
/// several functions that are used to output text on consoles. For a complete list of both,
/// see the [Console](./trait.Console.html) trait's documentation. The basic structure of the
/// rendering code:
///
/// ```no_run
/// use tcod::console::{Console, Root};
///
/// fn main() {
///     let mut root = Root::initializer().init();
///
///     root.clear();
///     // Output style manipulation
///     // Calling the output functions
///     root.flush();
/// }
/// ```

struct RootId {
    id: ffi::TCOD_console_t
}

unsafe impl Sync for RootId {}

static ROOT_ID: RootId = RootId { id: 0 as ffi::TCOD_console_t };

pub struct Root {
    // This is here to prevent the explicit creation of Root consoles.
    _blocker: PhantomData<Root>
}

impl Root {
    /// Returns an instance of a RootInitializer object, which can be used to
    /// customize the initialization of the Root console. Note that only
    /// `RootInitializer::init` will return the actual `Root` console instance.
    /// For a full list of initialization options, see the
    /// [RootInitializer](./struct.RootInitializer.html) documentation.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use tcod::console::Root;
    ///
    /// let mut root = Root::initializer()
    ///     .size(80, 20)
    ///     .title("Example")
    ///     .fullscreen(true)
    ///     .init();
    /// ```
    ///
     pub fn initializer<'a>() -> RootInitializer<'a> {
        RootInitializer::new()
    }

    /// Returns with true when the `Root` console is in fullscreen mode.
    pub fn is_fullscreen(&self) -> bool {
        unsafe {
            ffi::TCOD_console_is_fullscreen() != 0
        }
    }

    /// Toggles between windowed and fullscreen mode.
    pub fn set_fullscreen(&mut self, fullscreen: bool) {
        unsafe {
            ffi::TCOD_console_set_fullscreen(fullscreen as u8);
        }
    }

    /// Returns true if the `Root` console is currently active.
    pub fn is_active(&self) -> bool {
        unsafe {
            ffi::TCOD_console_is_active() != 0
        }
    }

    /// Returns true if the `Root` console has focus.
    pub fn has_focus(&self) -> bool {
        unsafe {
            ffi::TCOD_console_has_mouse_focus() != 0
        }
    }


    /// Returns the current fade amount (previously set by `set_fade`).
    pub fn get_fade(&self) -> u8 {
        unsafe {
            ffi::TCOD_console_get_fade()
        }
    }

    /// Returns the current fade color (previously set by `set_fade`).
    pub fn get_fading_color(&self) -> Color {
        unsafe {
            FromNative::from_native(
                ffi::TCOD_console_get_fading_color())
        }
    }

    /// This function defines the fading parameters, allowing to easily fade the game screen to/from a color.
    /// Once they are defined, the fading parameters are valid for ever.
    /// You don't have to call setFade for each rendered frame (unless you change the fading parameters).
    pub fn set_fade(&mut self, fade: u8, fading_color: Color) {
        unsafe {
            ffi::TCOD_console_set_fade(fade, *fading_color.as_native());
        }
    }

    /// This function will wait for a keypress event from the user, returning the [KeyState](../input/struct.KeyState.html)
    /// that represents the event. If `flush` is true, all pending keypresses are flushed from the
    /// keyboard buffer. If false, it returns the first element from it.
    pub fn wait_for_keypress(&mut self, flush: bool) -> Key {
        let tcod_key = unsafe {
            ffi::TCOD_console_wait_for_keypress(flush as c_bool)
        };
        tcod_key.into()
    }

    /// This function checks if the user pressed a key. It returns the
    /// [KeyState](../input/struct.KeyState.html) representing the
    /// event if they have, or `None` if they have not.
    pub fn check_for_keypress(&self, status: KeyPressFlags) -> Option<Key> {
        let tcod_key = unsafe {
            ffi::TCOD_console_check_for_keypress(status.bits() as i32)
        };
        if tcod_key.vk == ffi::TCOD_keycode_t::TCODK_NONE {
            return None;
        }
        Some(tcod_key.into())
    }

    /// Returns with true if the `Root` console has been closed.
    pub fn window_closed(&self) -> bool {
        unsafe {
            ffi::TCOD_console_is_window_closed() != 0
        }
    }

    /// Flushes the contents of the `Root` console onto the screen.
    pub fn flush(&mut self) {
        unsafe {
            ffi::TCOD_console_flush();
        }
    }

    /// Sets the main window's title to the string specified in the argument.
    pub fn set_window_title<T>(&mut self, title: T) where T: AsRef<str> {
        unsafe {
            let c_title = CString::new(title.as_ref().as_bytes()).unwrap();
            ffi::TCOD_console_set_window_title(c_title.as_ptr());
        }
    }

    /// Embeds libtcod credits in a console.
    /// Returns true when the credits screen is finished.

    pub fn render_credits(&self, x : i32, y: i32, alpha: bool) -> bool {
        unsafe {
            let result = ffi::TCOD_console_credits_render(x, y, alpha as c_bool);
            result != 0
        }

    }

    /// Maps a single ASCII code to a character in a bitmap font.
    ///
    /// # Arguments
    ///
    /// * `ascii_code`: The ASCII code to map
    /// * `font_char_x/font_char_y`: The coordinate of the character in the
    /// bitmap font (in characters, not pixels)
    pub fn map_ascii_code_to_font(&mut self,
                                  ascii_code: i32,
                                  font_char_x: i32,
                                  font_char_y: i32) {
        unsafe {
            ffi::TCOD_console_map_ascii_code_to_font(
                ascii_code,
                font_char_x,
                font_char_y
            );
        }
    }

    /// Maps consecutive ASCII codes to consecutive characters in a bitmap font.
    ///
    /// # Arguments
    ///
    /// * `ascii_code`: The first ASCII code to map
    /// * 'nb_codes`: Number of conescutive ASCII codes to map
    /// * `font_char_x/font_char_y`: The coordinate of the character in the
    /// bitmap font (in characters, not pixels) corresponding to the first ASCII
    /// code
    pub fn map_ascii_codes_to_font(&mut self,
                                   ascii_code: i32,
                                   nb_codes: i32,
                                   font_char_x: i32,
                                   font_char_y: i32) {
        unsafe {
            ffi::TCOD_console_map_ascii_codes_to_font(
                ascii_code,
                nb_codes,
                font_char_x,
                font_char_y
            );
        }
    }

    /// Maps ASCII codes from a string to consecutive characters in a bitmap font.
    ///
    /// # Arguments
    ///
    /// * `s`: String containing ASCII codes to map
    /// * `font_char_x/font_char_y`: The coordinate of the character in the
    /// bitmap font (in characters, not pixels) corresponding to the first ASCII
    /// code in the string
    pub fn map_string_to_font(&mut self,
                              s: &str,
                              font_char_x: i32,
                              font_char_y: i32) {
        unsafe {
            let string = CString::new(s).ok().expect("Could not convert the given \
                                                      string to a C string.");
            ffi::TCOD_console_map_string_to_font(
                string.as_ptr(),
                font_char_x,
                font_char_y
            );
        }
    }

    fn set_custom_font(font_path: &Path,
                       font_layout: FontLayout,
                       font_type: FontType,
                       nb_char_horizontal: i32,
                       nb_char_vertical: i32) {
        unsafe {
            let filename = font_path.to_str().expect("Invalid font path");
            let path = CString::new(filename).ok().expect("Font path could not be converted \
                                                           to a C string");
            ffi::TCOD_console_set_custom_font(
                path.as_ptr(), (font_layout as i32) | (font_type as i32),
                nb_char_horizontal, nb_char_vertical);
        }
    }

}

/// Helper struct for the `Root` console initialization
///
/// This is the type that should be used to initialize the `Root` console (either directly or
/// indirectly, by calling `Root::initializer`). It uses method chaining to provide an easy-to-use
/// interface. It exposes the following configuration options for the `Root` console:
///
/// * `size`: this determines the size of the console window in characters
/// * `title`: the main window's title
/// * `fullscreen`: determines if the main window will start in fullscreen mode
/// * `font`: selects a bitmap font and sets its layout. See [FontLayout](./enum.FontLayout.html)
/// for the possible layouts. The `path` argument can be a
/// [`str`](http://doc.rust-lang.org/std/primitive.str.html),
/// [`Path`](http://doc.rust-lang.org/std/path/struct.Path.html),
/// [`String`](http://doc.rust-lang.org/std/string/struct.String.html) or anything else that
/// implements [`AsRef<Path>`](http://doc.rust-lang.org/std/convert/trait.AsRef.html).
/// * `font_type`: only use this if you want to use a greyscale font. See
/// [FontType](./enum.FontType.html) for the possible values.
/// * `font_dimensions`: the dimensions for the given bitmap font. This is automatically
/// deduced from the font layout, only use this if you really need it (providing wrong values will
/// ruin the font display).
/// * `renderer`: sets the console renderer. See the [Renderer](./enum.Renderer.html) enum for the
/// valid options.
///
/// The initializer provides sane defaults even there are no options explicitly specified, but it
/// is recommended to at least set the size and the window title.
///
/// # Examples
///
/// Initializing the `Root` console using `Root::initializer` instead of explicitly creating a
/// `RootInitializer` instance:
///
/// ```no_run
/// use tcod::console::{Root, FontLayout, Renderer};
///
/// fn main() {
///     let mut root = Root::initializer()
///         .size(80, 20)
///         .title("Example")
///         .fullscreen(true)
///         .font("terminal.png", FontLayout::AsciiInCol)
///         .renderer(Renderer::GLSL)
///         .init();
/// }
/// ```
pub struct RootInitializer<'a> {
    width: i32,
    height: i32,
    title: Box<AsRef<str> + 'a>,
    is_fullscreen: bool,
    font_path: Box<AsRef<Path> + 'a>,
    font_layout: FontLayout,
    font_type: FontType,
    font_dimensions: (i32, i32),
    console_renderer: Renderer
}

impl<'a> RootInitializer<'a> {
    pub fn new() -> RootInitializer<'a> {
        RootInitializer {
            width: 80,
            height: 25,
            title: Box::new("Main Window"),
            is_fullscreen: false,
            font_path: Box::new("terminal.png"),
            font_layout: FontLayout::AsciiInCol,
            font_type: FontType::Default,
            font_dimensions: (0, 0),
            console_renderer: Renderer::SDL
        }
    }

    pub fn size(&mut self, width: i32, height: i32) -> &mut RootInitializer<'a> {
        self.width = width;
        self.height = height;
        self
    }

    pub fn title<T>(&mut self, title: T) -> &mut RootInitializer<'a> where T: AsRef<str> + 'a {
        assert!(title.as_ref().is_ascii());
        self.title = Box::new(title);
        self
    }

    pub fn fullscreen(&mut self, is_fullscreen: bool) -> &mut RootInitializer<'a> {
        self.is_fullscreen = is_fullscreen;
        self
    }

    pub fn font<P>(&mut self, path: P, font_layout: FontLayout) -> &mut RootInitializer<'a> where P: AsRef<Path> + 'a {
        self.font_path = Box::new(path);
        self.font_layout = font_layout;
        self
    }

    pub fn font_type(&mut self, font_type: FontType) -> &mut RootInitializer<'a> {
        self.font_type = font_type;
        self
    }

    pub fn font_dimensions(&mut self, horizontal: i32, vertical: i32) -> &mut RootInitializer<'a> {
        self.font_dimensions = (horizontal, vertical);
        self
    }

    pub fn renderer(&mut self, renderer: Renderer) -> &mut RootInitializer<'a> {
        self.console_renderer = renderer;
        self
    }

    pub fn init(&self) -> Root {
        assert!(self.width > 0 && self.height > 0);

        match self.font_dimensions {
            (horizontal, vertical) => {
                Root::set_custom_font((*self.font_path).as_ref(),
                                      self.font_layout, self.font_type,
                                      horizontal, vertical)
            }
        }

        unsafe {
            let c_title = CString::new((*self.title).as_ref().as_bytes()).unwrap();
            ffi::TCOD_console_init_root(self.width, self.height,
                                        c_title.as_ptr(),
                                        self.is_fullscreen as c_bool,
                                        self.console_renderer.into());
        }
        Root { _blocker: PhantomData }
    }
}

pub trait TcodString {
    fn as_ascii(&self) -> Option<&[u8]>;
}

impl TcodString for str {
    fn as_ascii(&self) -> Option<&[u8]> {
        match self.is_ascii() {
            true => Some(self.as_ref()),
            false => None,
        }
    }
}

impl<'a> TcodString for &'a str {
    fn as_ascii(&self) -> Option<&[u8]> {
        (*self).as_ascii()
    }
}

impl TcodString for String {
    fn as_ascii(&self) -> Option<&[u8]> {
        AsRef::<str>::as_ref(self).as_ascii()
    }
}

impl<'a> TcodString for &'a String {
    fn as_ascii(&self) -> Option<&[u8]> {
        AsRef::<str>::as_ref(self).as_ascii()
    }
}

pub trait AsciiLiteral {}
impl AsciiLiteral for [u8] {}

// AsciiLiteral is implemented for fixed-size arrays up to length 32, same as the current
// Rust standard library trait implementation for fixed-size arrays (13 June 2015)
impl AsciiLiteral for [u8; 0] {}
impl AsciiLiteral for [u8; 1] {}
impl AsciiLiteral for [u8; 2] {}
impl AsciiLiteral for [u8; 3] {}
impl AsciiLiteral for [u8; 4] {}
impl AsciiLiteral for [u8; 5] {}
impl AsciiLiteral for [u8; 6] {}
impl AsciiLiteral for [u8; 7] {}
impl AsciiLiteral for [u8; 8] {}
impl AsciiLiteral for [u8; 9] {}
impl AsciiLiteral for [u8; 10] {}
impl AsciiLiteral for [u8; 11] {}
impl AsciiLiteral for [u8; 12] {}
impl AsciiLiteral for [u8; 13] {}
impl AsciiLiteral for [u8; 14] {}
impl AsciiLiteral for [u8; 15] {}
impl AsciiLiteral for [u8; 16] {}
impl AsciiLiteral for [u8; 17] {}
impl AsciiLiteral for [u8; 18] {}
impl AsciiLiteral for [u8; 19] {}
impl AsciiLiteral for [u8; 20] {}
impl AsciiLiteral for [u8; 21] {}
impl AsciiLiteral for [u8; 22] {}
impl AsciiLiteral for [u8; 23] {}
impl AsciiLiteral for [u8; 24] {}
impl AsciiLiteral for [u8; 25] {}
impl AsciiLiteral for [u8; 26] {}
impl AsciiLiteral for [u8; 27] {}
impl AsciiLiteral for [u8; 28] {}
impl AsciiLiteral for [u8; 29] {}
impl AsciiLiteral for [u8; 30] {}
impl AsciiLiteral for [u8; 31] {}
impl AsciiLiteral for [u8; 32] {}

impl<'a, T> AsciiLiteral for &'a T where T: AsciiLiteral {}

impl<T> TcodString for T where T: AsRef<[u8]> + AsciiLiteral {
    fn as_ascii(&self) -> Option<&[u8]> {
        Some(self.as_ref())
    }
}

#[inline]
fn to_wstring(text: &[u8]) -> Vec<char> {
    let mut ret = str::from_utf8(text).unwrap().chars().collect::<Vec<_>>();
    ret.push('\0');
    ret
}

/// Defines the common functionality between `Root` and `Offscreen` consoles
///
/// # Examples
/// Printing text with explicit alignment:
///
/// ```no_run
/// use tcod::console::{Console, Root, BackgroundFlag, TextAlignment};
///
/// let mut root = Root::initializer().size(80, 50).init();
///
/// root.print_ex(1, 1, BackgroundFlag::None, TextAlignment::Left,
///               "Text aligned to left.");
///
/// root.print_ex(78, 1, BackgroundFlag::None, TextAlignment::Right,
///               "Text aligned to right.");
///
/// root.print_ex(40, 15, BackgroundFlag::None, TextAlignment::Center,
///               "And this bit of text is centered.");
///
/// root.print_ex(40, 19, BackgroundFlag::None, TextAlignment::Center,
///               "Press any key to quit.");
/// ```
pub trait Console : AsNative<ffi::TCOD_console_t> {
    /// Returns the default text alignment for the `Console` instance. For all the possible
    /// text alignment options, see the documentation for
    /// [TextAlignment](./enum.TextAlignment.html).
    fn get_alignment(&self) -> TextAlignment {
        let alignment = unsafe {
            ffi::TCOD_console_get_alignment(*self.as_native())
        };
        unsafe { transmute(alignment) }
    }

    /// Sets the default text alignment for the console. For all the possible
    /// text alignment options, see the documentation for
    /// [TextAlignment](./enum.TextAlignment.html).
    fn set_alignment(&mut self, alignment: TextAlignment) {
        unsafe {
            ffi::TCOD_console_set_alignment(*self.as_native(), alignment.into());
        }
    }

    /// Sets a key color that will be ignored when [blitting](./fn.blit.html) the contents
    /// of this console onto an other (essentially a transparent background color).
    fn set_key_color(&mut self, color: Color) {
        unsafe {
            ffi::TCOD_console_set_key_color(*self.as_native(), *color.as_native());
        }
    }

    /// Returns the width of the console in characters.
    fn width(&self) -> i32 {
        unsafe {
            ffi::TCOD_console_get_width(*self.as_native())
        }
    }

    /// Returns the height of the console in characters.
    fn height(&self) -> i32 {
        unsafe {
            ffi::TCOD_console_get_height(*self.as_native())
        }
    }

    /// Return the console's default background color. This is used in
    /// several other methods, like: `clear`, `put_char`, etc.
    fn get_default_background(&mut self) -> Color {
        unsafe {
            FromNative::from_native(
                ffi::TCOD_console_get_default_background(*self.as_native()))
        }
    }

    /// Sets the console's default background color. This is used in several other methods,
    /// like: `clear`, `put_char`, etc.
    fn set_default_background(&mut self, color: Color) {
        unsafe {
            ffi::TCOD_console_set_default_background(*self.as_native(), *color.as_native());
        }
    }

    /// Sets the console's default foreground color. This is used in several printing functions.
    fn set_default_foreground(&mut self, color: Color) {
        unsafe {
            ffi::TCOD_console_set_default_foreground(*self.as_native(), *color.as_native());
        }
    }

    /// Returns the background color of the cell at the specified coordinates.
    fn get_char_background(&self, x: i32, y: i32) -> Color {
        unsafe {
            FromNative::from_native(
                ffi::TCOD_console_get_char_background(*self.as_native(), x, y))
        }
    }

    /// Returns the foreground color of the cell at the specified coordinates.
    fn get_char_foreground(&self, x: i32, y: i32) -> Color {
        unsafe {
            FromNative::from_native(
                ffi::TCOD_console_get_char_foreground(*self.as_native(), x, y))
        }
    }

    /// Returns the console's current background flag. For a detailed explanation
    /// of the possible values, see [BackgroundFlag](./enum.BackgroundFlag.html).
    fn get_background_flag(&self) -> BackgroundFlag {
        let flag = unsafe {
            ffi::TCOD_console_get_background_flag(*self.as_native())
        };
        unsafe { transmute(flag) }
    }

    /// Sets the console's current background flag. For a detailed explanation
    /// of the possible values, see [BackgroundFlag](./enum.BackgroundFlag.html).
    fn set_background_flag(&mut self, background_flag: BackgroundFlag) {
        unsafe {
            ffi::TCOD_console_set_background_flag(*self.as_native(),
                                                  background_flag.into());
        }
    }

    /// Returns the ASCII value of the cell located at `x, y`
    fn get_char(&self, x: i32, y: i32) -> char {
        let ffi_char = unsafe {
            ffi::TCOD_console_get_char(*self.as_native(), x, y)
        };
        assert!(ffi_char >= 0 && ffi_char < 256);
        ffi_char as u8 as char
    }

    /// Modifies the ASCII value of the cell located at `x, y`.
    fn set_char(&mut self, x: i32, y: i32, c: char) {
        assert!(x >= 0 && y >= 0);
        unsafe {
            ffi::TCOD_console_set_char(*self.as_native(), x, y, c as i32)
        }
    }

    /// Changes the background color of the specified cell
    fn set_char_background(&mut self, x: i32, y: i32,
                           color: Color,
                           background_flag: BackgroundFlag) {
        assert!(x >= 0 && y >= 0);
        unsafe {
            ffi::TCOD_console_set_char_background(*self.as_native(),
                                                  x, y,
                                                  *color.as_native(),
                                                  background_flag.into())
        }
    }

    /// Changes the foreground color of the specified cell
    fn set_char_foreground(&mut self, x: i32, y: i32, color: Color) {
        assert!(x >= 0 && y >= 0);
        unsafe {
            ffi::TCOD_console_set_char_foreground(*self.as_native(),
                                                  x, y,
                                                  *color.as_native());
        }
    }

    /// This function modifies every property of the given cell:
    ///
    /// 1. Updates its background color according to the console's default and `background_flag`,
    /// see [BackgroundFlag](./enum.BackgroundFlag.html).
    /// 2. Updates its foreground color based on the default color set in the console
    /// 3. Sets its ASCII value to `glyph`
    fn put_char(&mut self,
                x: i32, y: i32, glyph: char,
                background_flag: BackgroundFlag) {
        assert!(x >= 0 && y >= 0);
        unsafe {
            ffi::TCOD_console_put_char(*self.as_native(),
                                       x, y, glyph as i32,
                                       background_flag.into());
        }
    }

    /// Updates every propert of the given cell using explicit colors for the
    /// background and foreground.
    fn put_char_ex(&mut self,
                   x: i32, y: i32, glyph: char,
                   foreground: Color, background: Color) {
        assert!(x >= 0 && y >= 0);
        unsafe {
            ffi::TCOD_console_put_char_ex(*self.as_native(),
                                          x, y, glyph as i32,
                                          *foreground.as_native(),
                                          *background.as_native());
        }
    }

    /// Clears the console with its default background color
    fn clear(&mut self) {
        unsafe {
            ffi::TCOD_console_clear(*self.as_native());
        }
    }

    /// Prints the text at the specified location. The position of the `x` and `y`
    /// coordinates depend on the [TextAlignment](./enum.TextAlignment.html) set in the console:
    ///
    /// * `TextAlignment::Left`: leftmost character of the string
    /// * `TextAlignment::Center`: center character of the sting
    /// * `TextAlignment::Right`: rightmost character of the string
    fn print<T>(&mut self, x: i32, y: i32, text: T) where Self: Sized, T: AsRef<[u8]> + TcodString {
        assert!(x >= 0 && y >= 0);
        if let Some(text) = text.as_ascii() {
            let c_text = CString::new(text).unwrap();
            unsafe {
                ffi::TCOD_console_print(*self.as_native(), x, y, c_text.as_ptr());
            }
        } else {
            let c_text = to_wstring(text.as_ref());
            unsafe {
                ffi::TCOD_console_print_utf(*self.as_native(), x, y, c_text.as_ptr() as *const i32);
            }
        }
    }

    /// Prints the text at the specified location in a rectangular area with
    /// the dimensions: (width; height). If the text is longer than the width the
    /// newlines will be inserted.
    fn print_rect<T>(&mut self,
                  x: i32, y: i32,
                  width: i32, height: i32,
                  text: T) where Self: Sized, T: AsRef<[u8]> + TcodString {
        assert!(x >= 0 && y >= 0);
        if let Some(text) = text.as_ascii() {
            let c_text = CString::new(text).unwrap();
            unsafe {
                ffi::TCOD_console_print_rect(*self.as_native(), x, y, width, height, c_text.as_ptr());
            }
        } else {
            let c_text = to_wstring(text.as_ref());
            unsafe {
                ffi::TCOD_console_print_rect_utf(*self.as_native(), x, y, width, height, c_text.as_ptr() as *const i32);
            }
        }
    }

    /// Prints the text at the specified location with an explicit
    /// [BackgroundFlag](./enum.BackgroundFlag.html) and
    /// [TextAlignment](./enum.TextAlignment.html).
    fn print_ex<T>(&mut self,
                x: i32, y: i32,
                background_flag: BackgroundFlag,
                alignment: TextAlignment,
                text: T) where Self: Sized, T: AsRef<[u8]> + TcodString {
        assert!(x >= 0 && y >= 0);
        if let Some(text) = text.as_ascii() {
            let c_text = CString::new(text).unwrap();
            unsafe {
                ffi::TCOD_console_print_ex(*self.as_native(), x, y,
                                           background_flag.into(),
                                           alignment.into(),
                                           c_text.as_ptr());
            }
        } else {
            let c_text = to_wstring(text.as_ref());
            unsafe {
                ffi::TCOD_console_print_ex_utf(*self.as_native(), x, y,
                                               background_flag.into(),
                                               alignment.into(),
                                               c_text.as_ptr() as *const i32);
            }
        }
    }

    /// Combines the functions of `print_ex` and `print_rect`
    fn print_rect_ex<T>(&mut self,
                        x: i32, y: i32,
                        width: i32, height: i32,
                        background_flag: BackgroundFlag,
                        alignment: TextAlignment,
                        text: T) where Self: Sized, T: AsRef<[u8]> + TcodString {
        assert!(x >= 0 && y >= 0);
        if let Some(text) = text.as_ascii() {
            let c_text = CString::new(text).unwrap();
            unsafe {
                ffi::TCOD_console_print_rect_ex(*self.as_native(), x, y, width, height,
                                                background_flag.into(), alignment.into(),
                                                c_text.as_ptr());
            }
        } else {
            let c_text = to_wstring(text.as_ref());
            unsafe {
                ffi::TCOD_console_print_rect_ex_utf(*self.as_native(), x, y, width, height,
                                                    background_flag.into(), alignment.into(),
                                                    c_text.as_ptr() as *const i32);
            }
        }
    }

    /// Compute the height of a wrapped text printed using `print_rect` or `print_rect_ex`.
    fn get_height_rect<T>(&self,
                          x: i32, y: i32,
                          width: i32, height: i32,
                          text: T) -> i32 where Self: Sized, T: AsRef<[u8]> + TcodString {
        assert!(x >= 0 && y >= 0);
        if let Some(text) = text.as_ascii() {
            let c_text = CString::new(text).unwrap();
            unsafe {
                ffi::TCOD_console_get_height_rect(*self.as_native(), x, y, width, height,
                                                  c_text.as_ptr())
            }
        } else {
            let c_text = to_wstring(text.as_ref());
            unsafe {
                ffi::TCOD_console_get_height_rect_utf(*self.as_native(), x, y, width, height,
                                                      c_text.as_ptr() as *const i32)
            }
        }
    }


    /// Fill a rectangle with the default background colour.
    ///
    /// If `clear` is true, set each cell's character to space (ASCII 32).
    fn rect(&mut self,
            x: i32, y: i32,
            width: i32, height: i32,
            clear: bool,
            background_flag: BackgroundFlag) {
        assert!(x >= 0);
        assert!(y >= 0);
        assert!(width >= 0);
        assert!(height >= 0);
        assert!(x + width <= self.width());
        assert!(y + height <= self.height());
        unsafe {
            ffi::TCOD_console_rect(*self.as_native(), x, y, width, height, clear as c_bool, background_flag.into());
        }
    }

    /// Draw a horizontal line.
    ///
    /// Uses `tcod::chars::HLINE` (ASCII 196) as the line character and
    /// console's default background and foreground colours.
    fn horizontal_line(&mut self, x: i32, y: i32, length: i32, background_flag: BackgroundFlag) {
        assert!(x >= 0 && y >= 0 && y < self.height());
        assert!(length >= 1 && length + x <= self.width());
        unsafe {
            ffi::TCOD_console_hline(*self.as_native(), x, y, length, background_flag.into());
        }
    }

    /// Draw a vertical line.
    ///
    /// Uses `tcod::chars::VLINE` (ASCII 179) as the line character and
    /// console's default background and foreground colours.
    fn vertical_line(&mut self, x: i32, y: i32, length: i32, background_flag: BackgroundFlag) {
        assert!(x >= 0, y >= 0 && x < self.width());
        assert!(length >= 1 && length + y <= self.height());
        unsafe {
            ffi::TCOD_console_vline(*self.as_native(), x, y, length, background_flag.into());
        }
    }

    /// Draw a window frame with an optional title.
    ///
    /// Draws a rectangle (using the rect method) using the suplied background
    /// flag, then draws a rectangle with the console's default foreground
    /// colour.
    ///
    /// If the `title` is specified, it will be printed on top of the rectangle
    /// using inverted colours.
    fn print_frame<T>(&mut self, x: i32, y: i32, width: i32, height: i32,
                     clear: bool, background_flag: BackgroundFlag, title: Option<T>) where Self: Sized, T: AsRef<str> {
        assert!(x >= 0 && y >= 0 && width >= 0 && height >= 0);
        assert!(x + width <= self.width() && y + height <= self.height());
        // NOTE: we need to run `CString::new` and `as_ptr` in two
        // separate steps. If we did it all at once, the `CString`
        // would get dropped too early and we'd get a dangling
        // pointer.
        let title = title.map(|s| {
                assert!(s.as_ref().is_ascii());
                CString::new(s.as_ref().as_bytes()).unwrap()
        });
        // NOTE: `map_or` takes the option by value, which would cause
        // a premature drop again. The `as_ref` here prevents that
        // from happening.
        let c_title = title.as_ref().map_or(ptr::null(), |s| s.as_ptr());
        unsafe {
            ffi::TCOD_console_print_frame(*self.as_native(), x, y, width, height,
                                          clear as c_bool, background_flag.into(),
                                          c_title);
        }
    }
}

/// Blits the contents of one console onto an other
///
/// It takes a region from a given console (with an arbitrary location, width and height) and superimposes
/// it on the destination console (at the given location).
/// Note that when blitting, the source console's key color (set by `set_key_color`) will
/// be ignored, making it possible to blit non-rectangular regions.
///
/// # Arguments
///
/// * `source_console`: the type implementing the [Console](./trait.Console.html) trait we want to
/// take the blitted region from
/// * `source_x`, `source_y`: the coordinates of the blitted region's top left corner on the source
/// console
/// * `source_width`, `source_height`: the width and height of the blitted region. With a value of
/// 0, the width and height of the source console will be used.
/// * `destination_console`: the type implementing the [Console](./trait.Console.html) trait we want
/// to blit to
/// * `destination_x`, `destination_y`: the coordinated of the blitted region's top left corner on
/// the destination console
/// * `foreground_alpha`, `background_alpha`: the foreground and background opacity
///
/// # Examples
///
/// Using `blit` with concrete types and `Console` trait objects:
///
/// ```no_run
/// use tcod::console as console;
/// use tcod::console::{Console, Root, Offscreen};
///
/// fn main() {
///     let mut root = Root::initializer().init();
///
///     let mut direct = Offscreen::new(20, 20);
///     let mut boxed_direct = Box::new(Offscreen::new(20, 20));
///     let mut trait_object: &Console = &Offscreen::new(20, 20);
///     let mut boxed_trait: Box<Console> = Box::new(Offscreen::new(20, 20));
///
///     console::blit(&direct, (0, 0), (20, 20), &mut root, (0, 0), 1.0, 1.0);
///     console::blit(&boxed_direct, (0, 0), (20, 20), &mut root, (20, 0), 1.0, 1.0);
///     console::blit(&trait_object, (0, 0), (20, 20), &mut root, (0, 20), 1.0, 1.0);
///     console::blit(&boxed_trait, (0, 0), (20, 20), &mut root, (20, 20), 1.0, 1.0);
/// }
///
/// ```
pub fn blit<T, U>(source_console: &T,
                  (source_x, source_y): (i32, i32),
                  (source_width, source_height): (i32, i32),
                  destination_console: &mut U,
                  (destination_x, destination_y): (i32, i32),
                  foreground_alpha: f32, background_alpha: f32)
    where T: Console,
          U: Console {
    assert!(source_x >= 0 && source_y >= 0 &&
            source_width >= 0 && source_height >= 0); // If width or height is 0, the source width/height is used.

    unsafe {
        ffi::TCOD_console_blit(*source_console.as_native(),
                               source_x, source_y, source_width, source_height,
                               *destination_console.as_native(),
                               destination_x, destination_y,
                               foreground_alpha, background_alpha);
    }
}

impl<'a, T: Console + ?Sized> Console for &'a T {}

impl<T: Console + ?Sized> Console for Box<T> {}

impl AsNative<ffi::TCOD_console_t> for Root {
    unsafe fn as_native(&self) -> &ffi::TCOD_console_t {
        &ROOT_ID.id
    }
    
    unsafe fn as_native_mut(&mut self) -> &mut ffi::TCOD_console_t {
        unimplemented!();
    }
}

impl AsNative<ffi::TCOD_console_t> for Offscreen {
    unsafe fn as_native(&self) -> &ffi::TCOD_console_t {
        &self.con
    }
    
    unsafe fn as_native_mut(&mut self) -> &mut ffi::TCOD_console_t {
        &mut self.con
    }
}

impl Console for Root {}
impl Console for Offscreen {}

/// Represents the text alignment in console instances.
#[repr(u32)]
#[derive(Copy, Clone)]
pub enum TextAlignment {
    Left   = ffi::TCOD_alignment_t::TCOD_LEFT as u32,
    Right  = ffi::TCOD_alignment_t::TCOD_RIGHT as u32,
    Center = ffi::TCOD_alignment_t::TCOD_CENTER as u32,
}
native_enum_convert!(TextAlignment, TCOD_alignment_t);

/// This flag determines how a cell's existing background color will be modified by a new one
///
/// See [libtcod's documentation](http://doryen.eptalys.net/data/libtcod/doc/1.5.2/html2/console_bkgnd_flag_t.html)
/// for a detailed description of the different values.
#[repr(u32)]
#[derive(Copy, Clone, Debug)]
pub enum BackgroundFlag {
    None = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_NONE as u32,
    Set = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_SET as u32,
    Multiply = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_MULTIPLY as u32,
    Lighten = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_LIGHTEN as u32,
    Darken = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_DARKEN as u32,
    Screen = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_SCREEN as u32,
    ColorDodge = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_COLOR_DODGE as u32,
    ColorBurn = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_COLOR_BURN as u32,
    Add = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_ADD as u32,
    AddA = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_ADDA as u32,
    Burn = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_BURN as u32,
    Overlay = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_OVERLAY as u32,
    Alph = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_ALPH as u32,
    Default = ffi::TCOD_bkgnd_flag_t::TCOD_BKGND_DEFAULT as u32
}
native_enum_convert!(BackgroundFlag, TCOD_bkgnd_flag_t);

/// All the possible renderers used by the `Root` console
#[repr(u32)]
#[derive(Copy, Clone)]
pub enum Renderer {
    GLSL   = ffi::TCOD_renderer_t::TCOD_RENDERER_GLSL as u32,
    OpenGL = ffi::TCOD_renderer_t::TCOD_RENDERER_OPENGL as u32,
    SDL    = ffi::TCOD_renderer_t::TCOD_RENDERER_SDL as u32,
}
native_enum_convert!(Renderer, TCOD_renderer_t);

/// All the possible font layouts that can be used for custom bitmap fonts
#[repr(u32)]
#[derive(Copy, Clone)]
pub enum FontLayout {
    AsciiInCol = ffi::TCOD_font_flags_t::TCOD_FONT_LAYOUT_ASCII_INCOL as u32,
    AsciiInRow = ffi::TCOD_font_flags_t::TCOD_FONT_LAYOUT_ASCII_INROW as u32,
    Tcod       = ffi::TCOD_font_flags_t::TCOD_FONT_LAYOUT_TCOD as u32,
}
native_enum_convert!(FontLayout, TCOD_font_flags_t);

#[repr(u32)]
#[derive(Copy, Clone)]
pub enum FontType {
    Default = 0,
    Greyscale = ffi::TCOD_font_flags_t::TCOD_FONT_TYPE_GREYSCALE as u32,
}
native_enum_convert!(FontType, TCOD_font_flags_t);



#[cfg(test)]
mod test {
    use std::path::Path;
    use super::Root;
    use super::FontLayout::AsciiInCol;

    #[test]
    fn test_custom_font_as_static_str() {
        Root::initializer().font("terminal.png", AsciiInCol);
    }

    #[test]
    fn test_custom_font_as_path() {
        Root::initializer().font(Path::new("terminal.png"), AsciiInCol);

    }

    #[test]
    fn test_custom_font_as_string() {
        Root::initializer().font("terminal.png".to_owned(), AsciiInCol);
    }

    #[test]
    fn test_custom_font_as_str() {
        let string = "terminal.png".to_owned();
        let s: &str = &string;
        Root::initializer().font(s, AsciiInCol);
    }
}