// ISC License (ISC)
//
// Copyright (c) 2016, Austin Hellyer <hello@austinhellyer.me>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
// RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
// CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
// What is ISO 3166-3?
// | ISO 3166-3 is part of the ISO 3166 standard published by the International
// | Organization for Standardization (ISO), and defines codes for country
// | names which have been deleted from ISO 3166-1 since its first publication
// | in 1974.
// |
// | - [Wikipedia](http://en.wikipedia.org/wiki/ISO_3166-3)
//
// Originally by taiyaeix on GitHub.

mod codes;

use codes::former_country_codes;

/// Struct containing a Former Country Code's ISO 3166-1 information,
/// containing 3 pieces of information:
///
/// - alpha2: Two-character code for the country code;
/// - alpha3: Three-character code for the country code;
/// - num: Three digit code assigned to the country code.
///
/// This struct derives Clone and Debug.
#[derive(Clone, Debug)]
pub struct FormerCountryCodeCodes<'a> {
    alpha2: &'a str,
    alpha3: &'a str,
    num: &'a str,
}

/// Struct defining a Former Country Code as defined by ISO 3166-3. This
/// contains 5 pieces of information:
///
/// - code: Four-letter code assigned for former country name;
/// - codes_former: Field containing a FormerCountryCodeCodes struct;
/// - description: Reason why code was deprecated (eg: country merge, divided);
/// - name: The former country name;
/// - validity: The period in years of which this code was valid.
///
/// This struct derives Clone and Debug.
#[derive(Clone, Debug)]
pub struct FormerCountryCode<'a> {
    pub code: &'a str,
    pub codes_former: FormerCountryCodeCodes<'a>,
    pub description: &'a str,
    pub name: &'a str,
    pub validity: [i16; 2],
}

/// Returns an Option<Vec<FormerCountryCode>> of all FormerCountryCodes defined
/// by ISO 3166-3.
///
/// # Examples
///
/// An example of a valid usage:
///
/// ```
/// extern crate iso3166_3;
///
/// fn main() {
///     let countries = iso3166_3::all().unwrap();
/// }
/// ```
pub fn all<'a>() -> Option<Vec<FormerCountryCode<'a>>> {
    let codes: Vec<FormerCountryCode> = former_country_codes();

    if codes.len() > 0 {
        Some(codes)
    } else {
        None
    }
}

/// Returns an Option<FormerCountryCode> of the FormerCountryCode with the
/// given code.
///
/// # Examples
///
/// An example of a valid usage:
///
/// ```
/// extern crate iso3166_3;
///
/// fn main() {
///     let countries = iso3166_3::code("DDDE").unwrap();
/// }
/// ```
pub fn code<'a>(code_given: &str) -> Option<FormerCountryCode<'a>> {
    let mut code_ret: Option<FormerCountryCode> = None;

    for code in former_country_codes() {
        if code.code == code_given {
            code_ret = Some(code.clone());

            break;
        }
    }

    code_ret
}

/// Returns an Option<Vec<FormerCountryCode>> of ISO 3166-3 country codes that
/// were valid from a range of two given years.
///
/// # Examples
///
/// Retrieve codes valid from years 1974-1990:
///
/// ```
/// extern crate iso3166_3;
///
/// fn main() {
///     let countries = iso3166_3::validity(Some(1974), Some(1990)).unwrap();
/// }
/// ```
///
/// Retrieve codes valid from the year 1990 onward:
///
/// ```
/// extern crate iso3166_3;
///
/// fn main() {
///     let countries = iso3166_3::validity(Some(1990), None);
/// }
/// ```
///
/// Retrieve codes valid until 1998 and prior:
///
/// ```
/// extern crate iso3166_3;
///
/// fn main() {
///     let countries = iso3166_3::validity(None, Some(1998));
/// }
/// ```
pub fn validity<'a>(from: Option<i16>,
                    to: Option<i16>) -> Option<Vec<FormerCountryCode<'a>>> {
    let mut codes: Vec<FormerCountryCode> = vec![];

    let do_from: bool = from.is_some();
    let do_to: bool = to.is_some();

    let val_from: i16 = if do_from { from.unwrap() } else { 0 };
    let val_to: i16 = if do_to { to.unwrap() } else { 0 };

    for code in former_country_codes() {
        let matches: bool = if do_from && do_to {
            code.validity[0] >= val_from && code.validity[1] <= val_to
        } else if do_from {
            code.validity[0] >= val_from
        } else if do_to {
            code.validity[1] <= val_to
        } else {
            false
        };

        if matches {
            codes.push(code.clone());
        }
    }

    if codes.len() > 0 {
        Some(codes)
    } else {
        None
    }
}