// License: see LICENSE file at root directory of `master` branch

//! # `sub-strs`
//!
//! ## Project
//!
//! - Repository: <https://bitbucket.org/haibison/sub-strs>
//! - License: Nice License 1.0.0 _(see LICENSE file at root directory of `master` branch)_
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! - Simple function for finding sub strings within a string: [`sub_strs()`][::sub_strs()].
//! - Case insensitive string: [`CainStr`][::CainStr].
//! - [`Glob`][::Glob]/[`GlobSet`][::GlobSet].
//!
//! ## Notes
//!
//! Documentation is built with all features. Some of them are optional. If you see components from other crates, you can view source to see
//! what features are required.
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//!
//! [::sub_strs()]: fn.sub_strs.html
//! [::CainStr]: struct.CainStr.html
//! [::Glob]: struct.Glob.html
//! [::GlobSet]: struct.GlobSet.html

#![warn(missing_docs)]
#![no_std]

// ╔═════════════════╗
// ║   IDENTIFIERS   ║
// ╚═════════════════╝

macro_rules! code_name  { () => { "sub-strs" }}
macro_rules! version    { () => { "0.24.0" }}

/// # Crate name
pub const NAME: &str = "sub-strs";

/// # Crate code name
pub const CODE_NAME: &str = code_name!();

/// # ID of this crate
pub const ID: &str = concat!(
    "81c8cd7c-bb6ff55c-04532796-0c5f8e78-dc58e220-de29f966-6cf5438c-b8e7d644-",
    "5599b650-c828cd64-75581638-1018c24e-1ae61d33-4eab6d5e-bb158f27-ecaf4911",
);

/// # Crate version
pub const VERSION: &str = version!();

/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2021, 3, 14);

/// # Tag, which can be used for logging...
pub const TAG: &str = concat!(code_name!(), "::81c8cd7c::", version!());

// ╔════════════════════╗
// ║   IMPLEMENTATION   ║
// ╚════════════════════╝

extern crate alloc;

#[cfg(feature="std")]
extern crate std;

/// # Makes new Error with formatted string, or without one
macro_rules! err {
    () => {
        crate::Error::new(line!(), module_path!(), None)
    };
    ($s: literal) => {
        crate::Error::new(line!(), module_path!(), Some(alloc::borrow::Cow::Borrowed($s)))
    };
    ($s: literal, $($arg: tt)+) => {
        crate::Error::new(line!(), module_path!(), Some(alloc::borrow::Cow::Owned(alloc::format!($s, $($arg)+))))
    };
}

#[test]
fn test_macro_err() {
    use alloc::borrow::Cow;

    macro_rules! s_test { () => { "test" }}

    fn eq(first: Error, second: Error) -> bool {
        first.line() == second.line() && first.module_path() == second.module_path() && first.msg() == second.msg()
    }

    assert!(eq(err!(), Error::new(line!(), module_path!(), None)));
    assert!(eq(err!("test"), Error::new(line!(), module_path!(), Some(Cow::Borrowed(s_test!())))));
    assert!(eq(err!("{s:?}", s=s_test!()), Error::new(line!(), module_path!(), Some(Cow::Owned(alloc::format!("{:?}", s_test!()))))));
}

#[test]
fn test_crate_version() {
    assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
}

pub mod version_info;

mod cain_str;
mod error;
mod glob;
mod glob_set;
mod sub_str_iter;

pub use cain_str::*;
pub use error::*;
pub use glob::*;
pub use glob_set::*;
pub use sub_str_iter::*;

/// # Result type used in this crate
pub type Result<T> = core::result::Result<T, Error>;
