leechbar 0.5.4

use image::DynamicImage;
use util::color::Color;
use error::BarError;
use bar;

/// The bar configuration.
///
/// This is used to configure the bar. After configuration, the bar can be created using the
/// [`spawn`] method.
///
/// # Examples
///
/// Basic usage:
///
/// ```rust,no_run
/// use leechbar::{BarBuilder, Color};
///
/// // All method calls that take parameters are optional
/// BarBuilder::new()
///     .background_color(Color::new(255, 0, 255, 255))
///     .foreground_color(Color::new(0, 255, 0, 255))
///     .font("Fira Mono Medium 14")
///     .output("DVI-1")
///     .name("MyBar")
///     .height(30)
///     .spawn()
///     .unwrap();
/// ```
///
/// [`spawn`]: struct.BarBuilder.html#method.spawn
#[derive(Clone)]
pub struct BarBuilder {
    pub(crate) background_image: Option<DynamicImage>,
    pub(crate) background_color: Color,
    pub(crate) foreground_color: Color,
    pub(crate) output: Option<String>,
    pub(crate) font: Option<String>,
    pub(crate) name: String,
    pub(crate) height: u16,
    pub(crate) text_yoffset: i16,
    _new_lock: (),
}

impl BarBuilder {
    /// Create a new instance of the `BarBuilder` with default parameters.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::BarBuilder;
    ///
    /// let builder = BarBuilder::new();
    /// ```
    pub fn new() -> Self {
        BarBuilder::default()
    }

    /// Change the default foreground color.
    ///
    /// **Default:** White (255, 255, 255, 255)
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::{BarBuilder, Color};
    ///
    /// let color = Color::new(255, 0, 255, 0);
    /// let builder = BarBuilder::new().foreground_color(color);
    /// ```
    pub fn foreground_color(mut self, color: Color) -> Self {
        self.foreground_color = color;
        self
    }

    /// Change the default background color.
    ///
    /// **Default:** Black (0, 0, 0, 255)
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::{BarBuilder, Color};
    ///
    /// let color = Color::new(255, 0, 255, 0);
    /// let builder = BarBuilder::new().background_color(color);
    /// ```
    pub fn background_color(mut self, color: Color) -> Self {
        self.background_color = color;
        self
    }

    /// Change the default background image.
    ///
    /// This takes an image and sets it as the default background for the bar. The image is not
    /// resized or modified in any way, so it is required to manually adjust it to fit the
    /// specified bar geometry.
    ///
    /// **Default:** No background image.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// # extern crate leechbar;
    /// extern crate image;
    /// use leechbar::BarBuilder;
    ///
    /// # fn main () {
    /// let image = image::open("./img.png").unwrap();
    /// let builder = BarBuilder::new().background_image(image);
    /// # }
    /// ```
    pub fn background_image(mut self, image: DynamicImage) -> Self {
        self.background_image = Some(image);
        self
    }

    /// Change the default name of the bar.
    ///
    /// This name is used by your Window Manager.
    ///
    /// **Default:** `leechbar`
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::BarBuilder;
    ///
    /// let builder = BarBuilder::new().name("Leechbar");
    /// ```
    pub fn name<T: Into<String>>(mut self, name: T) -> Self {
        self.name = name.into();
        self
    }

    /// Change the default font of the bar.
    ///
    /// This font is used for each block unless manually overwritten.
    ///
    /// **Default:** Default pango font.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::BarBuilder;
    ///
    /// let builder = BarBuilder::new().font("Fira Sans Medium 13");
    /// ```
    pub fn font<T: Into<String>>(mut self, font: T) -> Self {
        self.font = Some(font.into());
        self
    }

    /// Change the default height of the bar.
    ///
    /// This specifies the vertical height used in pixels.
    ///
    /// **Default:** `30`
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::BarBuilder;
    ///
    /// let builder = BarBuilder::new().height(25);
    /// ```
    pub fn height(mut self, height: u16) -> Self {
        self.height = height;
        self
    }

    /// Change the default output the bar should be displayed on.
    ///
    /// This uses RANDR to get the output with the specified name. An example value for a DVI
    /// output would be `DVI-0`.
    ///
    /// If not specified the primary output is selected.
    ///
    /// **Default:** Primary output.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::BarBuilder;
    ///
    /// let builder = BarBuilder::new().output("DVI-0");
    /// ```
    pub fn output<T: Into<String>>(mut self, output: T) -> Self {
        self.output = Some(output.into());
        self
    }

    /// Change the default vertical text offset of the bar.
    /// Positive values move the text downwards.
    ///
    /// This is overridden by the component's vertical offset if present.
    ///
    /// **Default:** `0`
    ///
    /// # Examples
    ///
    /// ```rust
    /// use leechbar::BarBuilder;
    ///
    /// let builder = BarBuilder::new().text_yoffset(-4);
    /// ```
    pub fn text_yoffset(mut self, text_yoffset: i16) -> Self {
        self.text_yoffset = text_yoffset;
        self
    }

    /// Spawn the bar with the currently configured settings.
    ///
    /// This creates a window and registers it as a bar on Xorg.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use leechbar::BarBuilder;
    ///
    /// let bar = BarBuilder::new().spawn().unwrap();
    /// ```
    pub fn spawn(self) -> Result<bar::Bar, BarError> {
        let bar = bar::Bar::new(self)?;
        Ok(bar)
    }
}

impl Default for BarBuilder {
    fn default() -> Self {
        BarBuilder {
            background_image: None,
            background_color: Color::new(0, 0, 0, 255),
            foreground_color: Color::new(255, 255, 255, 255),
            output: None,
            name: "leechbar".into(),
            font: None,
            height: 30,
            text_yoffset: 0,
            _new_lock: (),
        }
    }
}