1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107

//! <p align="center">
//!   <img alt="Cala" src="https://libcala.github.io/logo.svg">
//! </p>
//! <p align="center">
//! <a href="https://docs.rs/cala"><img src="https://docs.rs/cala/badge.svg"></a>
//! <a href="https://travis-ci.com/libcala/cala"><img src="https://api.travis-ci.com/libcala/cala.svg?branch=master" alt="Cala Build Status"></a>
//! <a href="https://crates.io/crates/cala"><img src="https://img.shields.io/crates/v/cala.svg" alt = "cala on crates.io"></a>
//! <a href="https://discord.gg/nXwF59K"><img src="https://img.shields.io/badge/discord-join%20server-green.svg" alt="Discord"></a>
//! <br>
//!   <strong><a href="https://libcala.github.io">Website</a> | <a href="https://github.com/libcala/cala">GitHub</a> | <a href="https://libcala.github.io/changelog">Changelog</a> | <a href="https://libcala.github.io/tutorials">Tutorials</a> </strong>
//! </p>
//!
//! # Getting Started
//! Each hardware interface can be enabled with a feature.  For example, If you
//! want to use the `draw` module and the `screen` module, you might put this in
//! your `Cargo.toml`:
//!
//! <p style="width:100%"><pre style="width:100%"><code style="width:100%"><span style="font-weight:bold;">[dependencies.cala]</span>
//! <span style="color:#0A0;font-weight:bold;">version</span> = <span style="color:#0A0">"0.8"</span>
//! <span style="color:#0A0;font-weight:bold;">features</span> = [<span style="color:#0A0">"draw"</span>, <span style="color:#0A0">"screen"</span>]</code></pre></p>
//!
//! Here's the boilerplate for your main.rs (you probably want to put modules
//! in separate files):
//!
//! ```rust,no_run
//! use std::cell::RefCell;
//! // When no features are enabled, only imports prelude traits.
//! use cala::*;
//!
//! enum State {
//!     A(RefCell<a::State>), // The only state
//! }
//!
//! async fn event_loop(state: &mut State) {
//!     use State::*;
//!     match state {
//!         A(state) => a::State::event_loop(state).await,
//!     }
//! }
//!
//! // Entry point
//! exec!(exec); // Set entry point for the app.
//! async fn exec() {
//!     let mut state = State::A(RefCell::new(a::State::new()));
//!     loop { event_loop(&mut state).await }
//! }
//!
//! mod a {
//!     //! State A's structure and event loop.
//!     use std::cell::RefCell;
//!     use cala::*;
//!
//!     // Data associated with state A.
//!     pub(super) struct State { }
//!
//!     impl State {
//!         pub(super) fn new() -> Self {
//!             State { }
//!         }
//!
//!         async fn dummy(state: &RefCell<Self>) {
//!         }
//!
//!         // State A's event loop
//!         pub(super) async fn event_loop(state: &RefCell<Self>) {
//!             // Leaving this empty will result in the async
//!             // executor going to sleep.
//!             [Self::dummy(state).fut()].select().await;
//!         }
//!     }
//! }
//! ```
//!
//! Module documentation may include simple tutorials.  More in depth tutorials
//! may be found <a href="https://libcala.github.io/tutorials">here</a>.

#![warn(missing_docs)]
#![doc(
    html_logo_url = "https://libcala.github.io/logo.svg",
    html_favicon_url = "https://libcala.github.io/icon.svg"
)]

/////////////////
//// Modules ////
/////////////////

// Private
mod hardware;
mod prelude;

pub use hardware::*;
pub use prelude::*;

// Hidden, because only used in macros.
#[doc(hidden)]
pub mod __hidden {
    #[cfg(feature = "draw")]
    pub use crate::hardware::draw::__hidden::draw_thread;
    #[cfg(feature = "exec")]
    pub use pasts::{CvarExec, Executor};
}

// mod icons; // FIXME Do something with the GUI icons

/////////////////////
//// End of File ////
/////////////////////