/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--

Zeros

Copyright (C) 2019-2022  Anonymous

There are several releases over multiple years,
they are listed as ranges, such as: "2019-2022".

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/

//! # Keccak implementation
//!
//! ## Project
//!
//! - Repository: <https://bitbucket.org/de-marco/zeros>
//! - License: GNU Lesser General Public License, either version 3, or (at your option) any later version.
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! This project provides _some_ hash functions from [Keccak].
//!
//! ## References
//!
//! - Specifications: <https://keccak.team/keccak_specs_summary.html>
//! - Test data: <https://csrc.nist.gov/projects/cryptographic-standards-and-guidelines/example-values>
//!
//! ## Notes
//!
//! - Currently only little-endian systems are supported. We don't have access or knowledge to test on big-endian systems.
//! - Internal state stores data on [`u64`]. So it works best on systems supporting `u64` natively.
//! - In addition to NIST's test data, the libray has passed millions of sample hashes generated by [OpenSSL].
//! - 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.
//!
//! ## Usage
//!
//! - For small data: [`Hash::hash()`][enum:Hash-fn:hash].
//! - For large data: [`Keccak`][struct:Keccak].
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//! [Keccak]: https://keccak.team
//! [OpenSSL]: https://www.openssl.org
//!
//! [fn:sha3_224]: fn.sha3_224.html
//! [fn:sha3_256]: fn.sha3_256.html
//! [fn:shake128]: fn.shake128.html
//! [struct:Keccak]: struct.Keccak.html
//! [enum:Hash-fn:hash]: enum.Hash.html#method.hash

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

#![cfg_attr(
    feature="simd",
    feature(portable_simd),
    deprecated(note="`simd` feature is just for _tests_! When [`Simd`](https://doc.rust-lang.org/core/simd/struct.Simd.html) is stabilized, it will be removed.")
)]

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

macro_rules! code_name  { () => { "zeros" }}
macro_rules! version    { () => { "13.2.0" }}

/// # Crate name
pub const NAME: &str = "Zeros";

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

/// # ID of this crate
pub const ID: &str = concat!(
    "85ede580-25ef8822-72185cb5-6608f8ae-3c960bc1-75e3ab78-6d1f8a8a-55eb5c40-",
    "f0b681d6-13275f82-d587a89e-9de72f64-3951a1b0-79f48b29-de4a6330-817a600f",
);

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

/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2022, 12, 28);

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

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

#[macro_use]
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!()))))));
}

#[macro_use]
mod error;

pub mod chacha;
pub mod io;
pub mod version_info;

mod keccak;
mod zeros;

#[cfg(feature="std")]
mod hash_reader;
#[cfg(feature="std")]
mod hash_writer;
#[cfg(not(feature="std"))]
mod write;

pub use crate::{
    error::*,
    zeros::*,
};

#[allow(deprecated)]
#[cfg(feature="std")]
pub use crate::{
    hash_reader::*,
    hash_writer::*,
};

#[cfg(not(feature="std"))]
pub (crate) use crate::write::*;

#[cfg(target_endian="little")]
pub use crate::keccak::*;

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

/// # Result for I/O functions
#[cfg(feature="std")]
pub type IoResult<T> = core::result::Result<T, std::io::Error>;

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