mirl 9.2.0

#![warn(missing_docs)]
#![warn(clippy::pedantic)]
#![warn(clippy::nursery)]
#![warn(missing_debug_implementations)]
#![warn(missing_copy_implementations)]
#![warn(trivial_casts)]
#![warn(trivial_numeric_casts)]
#![warn(unreachable_pub)]
#![warn(clippy::expect_used)]
#![warn(clippy::todo)]
#![allow(clippy::cast_precision_loss)]
#![allow(clippy::cast_possible_truncation)]
#![allow(clippy::cast_sign_loss)]
#![allow(clippy::wildcard_imports)]
#![allow(clippy::needless_doctest_main)]
#![allow(clippy::cast_possible_wrap)]
#![allow(clippy::struct_excessive_bools)]
#![allow(clippy::inline_always)]
#![allow(clippy::overly_complex_bool_expr)]
#![allow(clippy::too_many_lines)]
#![allow(clippy::fn_params_excessive_bools)]
#![allow(clippy::format_push_string)] // TODO: Replace all format string assign instances with write!
#![allow(internal_features)]
#![feature(const_trait_impl)]
#![feature(const_ops)]
#![feature(const_convert)]
#![feature(const_try)]
#![feature(core_intrinsics)]
#![feature(const_option_ops)]
#![feature(core_float_math)]
#![feature(f128)]
#![feature(f16)]
#![feature(min_specialization)]
#![feature(iter_advance_by)]
//#![feature(lazy_type_alias)] // This may be performance intensive
#![feature(type_alias_impl_trait)]
#![allow(incomplete_features)] // Incomplete: specialization, generic_const_exprs, const_closures
#![feature(const_cmp)]
#![feature(try_trait_v2)]
#![feature(const_default)]
#![feature(const_destruct)]
#![feature(rustc_allow_const_fn_unstable)]
#![feature(decl_macro)]
#![feature(str_internals)]
#![feature(const_eval_select)]
#![feature(const_for)]
#![feature(const_heap)]
// #![feature(const_closures)]
#![feature(generic_const_exprs)]
// #![feature(specialization)]
// #![feature(vec_try_remove)] // Miri does not recognize this feature
//#![feature(const_heap)]
#![cfg_attr(not(feature = "std"), no_std)]
//! Miners
//! Rust
//! Lib
//! Mirl (Mirl sounded better than Mrl)
//!
//! How to get started:
//! ```
//! #[cfg(test)]
//! #[cfg(not(feature = "minifb"))]
//! compile_error!("`minifb` flag needs to be set");
//!
//! use mirl::platform::windowing::traits::*;
//! fn main() {
//!     let mut buffer = mirl::prelude::Buffer::new_empty((800, 600));
//!     // The supported are `minifb`, `glfw`, and experimentally `console`
//!     let mut window = mirl::prelude::minifb::Framework::new(
//!         "Example window",
//!         mirl::prelude::WindowSettings::default(&buffer),
//!     )
//!     .unwrap();
//!     while window.is_open() {
//!         buffer.clear();
//!
//!         // Draw here, use mirl::render for simple presets/helper functions
//!
//!         window.update(&buffer);
//!     }
//! }
//! ```
//! For a debugging window lib "similar" to `Dear ImGui` you can use the `dear_mirl_gui` crate (which is `RmMode`)
//!
//! This lib has got a ton to offer but the main attractions are in here:
//! ## Window/Rendering Bundle (flags: `minifb`/`glfw`/`all_backends`):
//!
//! - [Frameworks](crate::platform::windowing::traits) - What are they capable of? (for [`crate::platform::minifb::Framework`] or [`crate::platform::glfw::Framework`])
//! - [Buffer] - The central struct many other functions rely on
//! - [Rendering](crate::render) - Render simple shapes
//! - [Platform](crate::platform) - Other neat stuff like [`crate::platform::keycodes::KeyCode`]/[`crate::platform::MouseButton`], or [`crate::platform::ScreenNormalizer`]
//! - [System interaction](crate::system::action) - Functions that are untypical for usual applications like moving the window, getting/setting the z position, or hiding a window from the taskbar
//! - [Color Stuff](crate::graphics) - What is rendering without color manipulation?
//! - [Modular File System](crate::platform::file_system::FileSystem) - A custom file system wrapper to support file accessing on web and natively
//! - [Rust functionality extension](crate::extensions) - Adding to rust what should've been there in the first place, especially tuple operations

/// Directional stuff -> NESW, N NE E SE S SW W NW
pub mod directions;

/// Stuff that should exist by default yet doesn't; use `mirl::extensions::*;` to import all of 'em
pub mod extensions;
/// Stuff related to graphics -> Color manipulation
///
/// For rendering use [`mirl::render`](crate::render)
pub mod graphics;

/// Math and collision focused stuff
pub mod math;

/// Stuff I didn't know how to categorize -> Expect these objects to be moved in the future
pub mod misc;
/// Window creation/managing, file system creation/managing
///
/// For actually rendering stuff, use [`mirl::render`](crate::render)
///
/// For basic collision, use [`mirl::math::collision`](crate::math::collision)
pub mod platform;
/// Rendering stuff, simple but powerful (on [`mirl::prelude::Buffer`](crate::prelude::Buffer))
///
/// For color stuff, use [`mirl::graphics`](crate::graphics)
pub mod render;
#[cfg(feature = "std")]
/// Text related stuff
pub mod text;
#[cfg(feature = "std")]
/// Time related stuff
pub mod time;

/// Terminal stuff
#[cfg(feature = "std")]
#[cfg(not(target_arch = "wasm32"))]
pub mod console;

/// Unified os specific features
#[cfg(feature = "system")]
pub mod system;

/// Functions for interacting with computers outside this one
pub mod network;

/// Useful constants -> std contains some of these internally yet doesn't expose them for anyone else to use
pub mod constants;
#[cfg(feature = "std")]
/// Enables the rust traceback by setting the environment variable `RUST_BACKTRACE` to `1`
pub fn enable_traceback() {
    unsafe {
        std::env::set_var("RUST_BACKTRACE", "1");
    }
}
#[cfg(feature = "std")]
/// Enables the extended rust traceback by setting the environment variable `RUST_BACKTRACE` to `full`
pub fn enable_traceback_detailed() {
    unsafe {
        std::env::set_var("RUST_BACKTRACE", "full");
    }
}
#[cfg(feature = "std")]
/// Disables the rust traceback by setting the environment variable `RUST_BACKTRACE` to `0`
pub fn disable_traceback() {
    unsafe {
        std::env::set_var("RUST_BACKTRACE", "0");
    }
}
#[cfg(feature = "std")]
// // This little fella is so often used that it only makes sense to reexport it
#[deprecated = "Please use `mirl::prelude::Buffer` instead"]
pub use prelude::Buffer;

/// Defaults
pub mod prelude;

/// Settings to be applied throughout the lib
pub mod settings;

/// A reexport of all available/used dependencies
pub mod dependencies;

// TODO:
// - Clipboard support
// - Sound support
// - Networking support?
// - (Full) Linux Compatibility
// - Compression of svg fils inside `mirl::platform::mouse::svg`:
//  - Svg object deduplication using relative transformation
//  - Zip for a size reduction from current ~470kb to ~90kb
// - Split files:
//  - mirl::graphics
//  - mirl::platform::mouse
//  - mirl::extensions::math
//  - mirl::system::action::windows_actions
//  - key_manager and mouse_manager in mirl::platform::shared
// - Add shapes to mirl::math::geometry and add more dimension support for existing shapes
// - Resolve other `TODO` sprinkled around the lib
// - Move `mirl::extensions` into their own crate
// - Move `mirl::render` + `mirl::graphics` + `mirl::windowing` into their own crate?

// TODON'T:
// - Mac support

mod compile_time_dependency_errors;

// Web support
// Incompatible: ahash, device_query