//! Topological structs: vertex, edge, wire, face, shell, and solid
//!
//! ## Examples
//! The following sample code is a description of a topological tetrahedron as a solid model
//! by this package.
//! ```
//! // Load topological structures with empty geometries.
//! truck_topology::prelude!((), (), ());
//!
//! // Create vertices. A tetrahedron has four vertices.
//! let v = Vertex::news(&[(); 4]);
//!
//! // Create edges. Vertex is implemented the Copy trait.
//! let edge = [
//!     Edge::new(&v[0], &v[1], ()),
//!     Edge::new(&v[0], &v[2], ()),
//!     Edge::new(&v[0], &v[3], ()),
//!     Edge::new(&v[1], &v[2], ()),
//!     Edge::new(&v[1], &v[3], ()),
//!     Edge::new(&v[2], &v[3], ()),
//! ];
//!
//! // Create boundaries of faces as the wire.
//! // Edge is implemented the Copy trait.
//! let wire = vec![
//!     wire![&edge[0], &edge[3], &edge[1].inverse()],
//!     wire![&edge[1], &edge[5], &edge[2].inverse()],
//!     wire![&edge[2], &edge[4].inverse(), &edge[0].inverse()],
//!     wire![&edge[3], &edge[5], &edge[4].inverse()],
//! ];
//!
//! // Create faces by the boundary wires.
//! // The boundary of face must be simple and closed.
//! let mut face: Vec<Face> = wire.into_iter().map(|wire| Face::new(vec![wire], ())).collect();
//! face[3].invert();
//!
//! // Create shell of faces. Shell can be created by `Vec<Face>``.
//! let shell: Shell = face.into();
//!
//! // Create a tetrahedron solid by the boundary shell.
//! // The boundaries of a solid must be closed and oriented.
//! let solid = Solid::new(vec![shell]);
//! ```
//! ## Elements and containers
//! Main structures in `truck_topology` consist 4 topological elements and 2 topological containers.
//! ### Topological elements
//! The following structures are topological elements.
//!
//! * [`Vertex`](./struct.Vertex.html)
//! * [`Edge`](./struct.Edge.html)
//! * [`Face`](./struct.Face.html)
//! * [`Solid`](./struct.Solid.html)
//!
//! Except `Solid`, each topological element has a unique `id` for each instance.
//! In higher-level packages, by mapping this `id` to geometric information, you can draw a solid shape.
//! ### Topological containers
//! The following structures are topological container.
//!
//! * [`Wire`](./struct.Wire.html)
//! * [`Shell`](./struct.Shell.html)
//!
//! The entities of `Wire` and `Shell` are `std::collections::VecDeque<Edge>` and `std::vec::Vec<Face>`,
//! respectively, and many methods inherited by `Deref` and `DerefMut`.
//! These containers are used for creating higher-dimensional topological elements and checked the
//! regularity (e.g. connectivity, closedness, and so on) before creating these elements.
//! ## Features
//! * `nightly` – Use features available only in a `nightly` toolchain.
//! * `rclite` – Use of `rclite::Arc` instead of `std::syn::Arc`. The latter
//!   uses more memory and is potentially slower than the former. On by default.

#![cfg_attr(not(debug_assertions), deny(warnings))]
#![deny(clippy::all, rust_2018_idioms)]
#![warn(
    missing_docs,
    missing_debug_implementations,
    trivial_casts,
    trivial_numeric_casts,
    unsafe_code,
    unstable_features,
    unused_import_braces,
    unused_qualifications
)]

use parking_lot::Mutex;
use std::collections::VecDeque;
use std::fmt::{Debug, Formatter};
use std::hash::{Hash, Hasher};
use truck_base::{id::ID, tolerance::*};
use truck_geotrait::*;

#[cfg(feature = "rclite")]
use rclite::Arc;
#[cfg(not(feature = "rclite"))]
use std::sync::Arc;

const SEARCH_PARAMETER_TRIALS: usize = 100;

/// Vertex, the minimum topological unit.
///
/// The constructor `Vertex::new()` creates a different vertex each time.
/// These vertices are uniquely identified by their `id`.
/// ```
/// use truck_topology::Vertex;
/// let v0 = Vertex::new(()); // one vertex
/// let v1 = Vertex::new(()); // another vertex
/// assert_ne!(v0, v1); // two vertices are different
/// ```
#[derive(Debug)]
pub struct Vertex<P> {
    point: Arc<Mutex<P>>,
}

/// Edge, which consists two vertices.
///
/// The constructors `Edge::new()`, `Edge::try_new()`, and `Edge::new_unchecked()`
/// create a different edge each time, even if the end vertices are the same one.
/// An edge is uniquely identified by their `id`.
/// ```
/// use truck_topology::*;
/// let v = Vertex::news(&[(), ()]);
/// let edge0 = Edge::new(&v[0], &v[1], ());
/// let edge1 = Edge::new(&v[0], &v[1], ());
/// assert_ne!(edge0.id(), edge1.id());
/// ```
#[derive(Debug)]
pub struct Edge<P, C> {
    vertices: (Vertex<P>, Vertex<P>),
    orientation: bool,
    curve: Arc<Mutex<C>>,
}

/// Wire, a path or cycle which consists some edges.
///
/// The entity of this struct is `VecDeque<Edge>` and almost methods are inherited from
/// `VecDeque<Edge>` by `Deref` and `DerefMut` traits.
#[derive(Debug)]
pub struct Wire<P, C> {
    edge_list: VecDeque<Edge<P, C>>,
}

/// Face, attached to a simple and closed wire.
///
/// The constructors `Face::new()`, `Face::try_new()`, and `Face::new_unchecked()`
/// create a different faces each time, even if the boundary wires are the same one.
/// A face is uniquely identified by their `id`.
/// ```
/// use truck_topology::*;
/// let v = Vertex::news(&[(), ()]);
/// let edge0 = Edge::new(&v[0], &v[1], ());
/// let edge1 = Edge::new(&v[1], &v[0], ());
/// let wire = wire![&edge0, &edge1];
/// let face0 = Face::new(vec![wire.clone()], ());
/// let face1 = Face::new(vec![wire], ());
/// assert_ne!(face0.id(), face1.id());
/// ```
#[derive(Debug)]
pub struct Face<P, C, S> {
    boundaries: Vec<Wire<P, C>>,
    orientation: bool,
    surface: Arc<Mutex<S>>,
}

/// Shell, a connected compounded faces.
///
/// The entity of this struct is `Vec<Face>` and almost methods are inherited from
/// `Vec<Face>` by `Deref` and `DerefMut` traits.
#[derive(Debug)]
pub struct Shell<P, C, S> {
    face_list: Vec<Face<P, C, S>>,
}

/// Solid, attached to a closed shells.
#[derive(Clone, Debug)]
pub struct Solid<P, C, S> {
    boundaries: Vec<Shell<P, C, S>>,
}

/// `Result` with crate's errors.
pub type Result<T> = std::result::Result<T, errors::Error>;

trait RemoveTry<T> {
    fn remove_try(self) -> T;
}

impl<T> RemoveTry<T> for Result<T> {
    #[inline(always)]
    fn remove_try(self) -> T { self.unwrap_or_else(|e| panic!("{}", e)) }
}

/// The id of vertex. `Copy` trait is implemented.
/// # Details
/// Since this struct is implemented `Copy` trait,
/// it is useful to use as a key of hashmaps.
/// ```
/// use truck_topology::*;
/// use std::collections::HashMap;
///
/// let v = Vertex::new(0);
/// let v_id = v.id();
///
/// let mut entity_map = HashMap::new();
/// let mut id_map = HashMap::new();
///
/// entity_map.insert(v.clone(), 0); // v must be cloned for sign up the hashmap.
/// id_map.insert(v_id, 0); // v_id is implemented Copy trait!
/// ```
/// The id does not changed even if the value of point changes.
/// ```
/// use truck_topology::*;
/// let v = Vertex::new(0);
///
/// let entity = v.point();
/// let v_id: VertexID<usize> = v.id();
///
/// // Change the point!
/// v.set_point(1);
///
/// assert_ne!(entity, v.point());
/// assert_eq!(v_id, v.id());
/// ```
pub type VertexID<P> = ID<Mutex<P>>;

/// The id that does not depend on the direction of the edge.
/// # Examples
/// ```
/// use truck_topology::*;
/// let v = Vertex::news(&[(), ()]);
/// let edge0 = Edge::new(&v[0], &v[1], ());
/// let edge1 = edge0.inverse();
/// assert_ne!(edge0, edge1);
/// assert_eq!(edge0.id(), edge1.id());
/// ```
pub type EdgeID<C> = ID<Mutex<C>>;

/// The id that does not depend on the direction of the face.
/// # Examples
/// ```
/// use truck_topology::*;
/// let v = Vertex::news(&[(); 3]);
/// let wire = Wire::from(vec![
///     Edge::new(&v[0], &v[1], ()),
///     Edge::new(&v[1], &v[2], ()),
///     Edge::new(&v[2], &v[0], ()),
/// ]);
/// let face0 = Face::new(vec![wire.clone()], ());
/// let face1 = face0.inverse();
/// let face2 = Face::new(vec![wire], ());
/// assert_ne!(face0, face1);
/// assert_ne!(face0, face2);
/// assert_eq!(face0.id(), face1.id());
/// assert_ne!(face0.id(), face2.id());
/// ```
pub type FaceID<S> = ID<Mutex<S>>;

/// configuration for vertex display format.
#[derive(Clone, Copy, Debug)]
pub enum VertexDisplayFormat {
    /// Display all data like `Vertex { id: 0x123456789ab, entity: [0.0, 1.0] }`.
    Full,
    /// Display id like `Vertex(0x123456789ab)`.
    IDTuple,
    /// Display entity point like `Vertex([0.0, 1.0])`.
    PointTuple,
    /// Display only entity point like `[0.0, 1.0]`.
    AsPoint,
}

/// Configuration for edge display format.
#[derive(Clone, Copy, Debug)]
pub enum EdgeDisplayFormat {
    /// Display all data like `Edge { id: 0x123456789ab, vertices: (0, 1), entity: BSplineCurve {..} }`.
    Full {
        /// vertex display format
        vertex_format: VertexDisplayFormat,
    },
    /// Display vertices tuple and id like `Edge { id: 0x123456789ab, vertices: (0, 1) }`.
    VerticesTupleAndID {
        /// vertex display format
        vertex_format: VertexDisplayFormat,
    },
    /// Display end vertices tuple and entity curve like `Edge { vertices: (1, 0), entity: BSplineCurve {..} }`.
    VerticesTupleAndCurve {
        /// vertex display format
        vertex_format: VertexDisplayFormat,
    },
    /// Display only end vertices like `Edge(0, 1)`.
    VerticesTupleStruct {
        /// vertex display format
        vertex_format: VertexDisplayFormat,
    },
    /// Display only end vertices like `(0, 1)`.
    VerticesTuple {
        /// vertex display format
        vertex_format: VertexDisplayFormat,
    },
    /// Display only entity curve like `BSplineCurve {..}`.
    AsCurve,
}

/// Configuration for wire display format.
#[derive(Clone, Copy, Debug)]
pub enum WireDisplayFormat {
    /// Display tuple struct of edge list like `Wire([Edge {..}, Edge {..}, ..])`.
    EdgesListTuple {
        /// edge display format
        edge_format: EdgeDisplayFormat,
    },
    /// Display as edge list like `[Edge {..}, Edge {..}, ..]`.
    EdgesList {
        /// edge display format
        edge_format: EdgeDisplayFormat,
    },
    /// Display as vertex list like `[Vertex {..}, Vertex {..}, ..]`.
    VerticesList {
        /// vertex display format
        vertex_format: VertexDisplayFormat,
    },
}

/// Configuration for face display format
#[derive(Clone, Copy, Debug)]
pub enum FaceDisplayFormat {
    /// Display all data like `Face { id: 0x123456789ab, boundaries: [Wire(..), Wire(..)], entity: BSplineSurface {..} }`.
    Full {
        /// display format for boundary wire
        wire_format: WireDisplayFormat,
    },
    /// Display boundary and id like `Face { id: 0x123456789ab, boundaries: [Wire(..), Wire(..)] }`.
    BoundariesAndID {
        /// display format for boundary wire
        wire_format: WireDisplayFormat,
    },
    /// Display boundary and entity surface like `Face { boundaries: [Wire(..), Wire(..)], entity: BSplineSurface {..} }`.
    BoundariesAndSurface {
        /// display format for boundary wire
        wire_format: WireDisplayFormat,
    },
    /// Display boundary loops list tuple like `Face([Wire(..), Wire(..)])`.
    LoopsListTuple {
        /// display format for boundary wire
        wire_format: WireDisplayFormat,
    },
    /// Display boundary loops list like `[Wire(..), Wire(..)]`.
    LoopsList {
        /// display format for boundary wire
        wire_format: WireDisplayFormat,
    },
    /// Display as surface like `BSplineSurface {..}`.
    AsSurface,
}

/// Configuration for shell display format
#[derive(Clone, Copy, Debug)]
pub enum ShellDisplayFormat {
    /// Display as faces list tuple struct like `Shell([Face {..}, Face {..}, ..])`.
    FacesListTuple {
        /// face display format
        face_format: FaceDisplayFormat,
    },
    /// Display as faces list like `[Face {..}, Face {..}, ..]`.
    FacesList {
        /// face display format
        face_format: FaceDisplayFormat,
    },
}

/// Configuration for solid display format
#[derive(Clone, Copy, Debug)]
pub enum SolidDisplayFormat {
    /// Display solid struct like `Solid { boundaries: [Shell(..), Shell(..), ..] }`.
    Struct {
        /// shell display format
        shell_format: ShellDisplayFormat,
    },
    /// Display as boundary shell list tuple struct like `Solid([Shell(..), Shell(..), ..])`.
    ShellsListTuple {
        /// shell display format
        shell_format: ShellDisplayFormat,
    },
    /// Display as boundary shell list like `[Shell(..), Shell(..), ..]`.
    ShellsList {
        /// shell display format
        shell_format: ShellDisplayFormat,
    },
}

pub mod compress;
mod edge;
/// classifies the errors that can occur in this crate.
pub mod errors;
/// Defines the boundary iterator.
pub mod face;
/// classifies shell conditions and defines the face iterators.
pub mod shell;
mod solid;
mod vertex;
/// define the edge iterators and the vertex iterator.
pub mod wire;

/// Display structs for debug or display topological elements
pub mod format {
    use crate::*;

    /// struct for debug formatting
    #[allow(missing_debug_implementations)]
    #[derive(Clone, Copy)]
    pub struct DebugDisplay<'a, T, Format> {
        pub(super) entity: &'a T,
        pub(super) format: Format,
    }

    #[derive(Clone)]
    pub(super) struct MutexFmt<'a, T>(pub &'a Mutex<T>);

    impl<T: Debug> Debug for MutexFmt<'_, T> {
        fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
            f.write_fmt(format_args!("{:?}", self.0.lock()))
        }
    }
}
use format::*;

/// This module is an example of code generated by the macro [`prelude`].
///
/// This module is generated by the following code.
/// ```
/// mod prelude_macro {
///     // empty geometries
///     struct Point;
///     struct Curve;
///     struct Surface;
///
///     // import topological structures with empty geometries
///     truck_topology::prelude!(Point, Curve, Surface, pub);
/// }
/// ```
pub mod imported;

/// Creates a Vec containing the arguments.
///
/// # Example
/// ```
/// use truck_topology::*;
/// let v: Vec<Vertex<()>> = Vertex::news([(); 3]);
/// let wire: Wire<(), ()> = wire![
///     Edge::new(&v[0], &v[1], ()),
///     Edge::new(&v[1], &v[2], ()),
///     Edge::new(&v[2], &v[0], ()),
/// ];
/// ```
#[macro_export]
macro_rules! wire { ($($t:tt)*) => { $crate::Wire::from_iter([$($t)*]) }; }

/// Creates a Vec containing the arguments.
///
/// # Example
/// ```
/// use truck_topology::*;
/// let v: Vec<Vertex<()>> = Vertex::news([(); 4]);
/// let wire0: Wire<(), ()> = wire![
///     Edge::new(&v[0], &v[1], ()),
///     Edge::new(&v[1], &v[2], ()),
///     Edge::new(&v[2], &v[0], ()),
/// ];
/// let wire1: Wire<(), ()> = wire![
///     wire0[0].inverse(),
///     Edge::new(&v[0], &v[3], ()),
///     Edge::new(&v[3], &v[1], ()),
/// ];
/// let shell = shell![
///     Face::new(vec![wire0], ()),
///     Face::new(vec![wire1], ()),
/// ];
/// ```
#[macro_export]
macro_rules! shell { ($($t:tt)*) => { $crate::Shell::from_iter([$($t)*]) }; }