tuifw-screen 0.26.0

Text User Interface Framework. Basic platform-independent text screen implementation.
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

#![feature(allocator_api)]

#![deny(warnings)]
#![doc(test(attr(deny(warnings))))]
#![doc(test(attr(allow(dead_code))))]
#![doc(test(attr(allow(unused_variables))))]

#![no_std]

extern crate alloc;

use alloc::alloc::Global;
use alloc::boxed::Box;
use core::alloc::Allocator;

pub use tuifw_screen_base::*;

/// # Safety
///
/// This function may initialize ncurses lib. It is safe iff no other code in application calls ncurses functions
/// while `Screen` instance is alive. This rule also applies to another `Screen` instance:
/// it is not safe to call `init`/`init_in` again until `Screen` created by previous call is dropped.
///
/// Also, iff compiled with `cfg(target_os="dos")` this method may not be invoked until it is guaranteed the memory addresses
/// in `0xB8000 .. 0xBBE80` are not used by Rust abstract machine.
///
/// It is impossible to garantee this conditions on a library level.
/// So this unsafity should be propagated through all wrappers to the final application.
pub unsafe fn init(max_size: Option<(u16, u16)>, error_alloc: Option<&'static dyn Allocator>) -> Result<Box<dyn Screen>, Error> {
    init_raw_in(max_size, error_alloc, Global)
}

/// # Safety
///
/// This function may initialize ncurses lib. It is safe iff no other code in application calls ncurses functions
/// while `Screen` instance is alive. This rule also applies to another `Screen` instance:
/// it is not safe to call `init`/`init_in` again until `Screen` created by previous call is dropped.
///
/// Also, iff compiled with `cfg(target_os="dos")` this method may not be invoked until it is guaranteed the memory addresses
/// in `0xB8000 .. 0xBBE80` are not used by Rust abstract machine.
///
/// It is impossible to garantee this conditions on a library level.
/// So this unsafity should be propagated through all wrappers to the final application.
pub unsafe fn init_in<A: Allocator + Clone + 'static>(
    max_size: Option<(u16, u16)>,
    error_alloc: Option<&'static dyn Allocator>,
    alloc: A
) -> Result<Box<dyn Screen>, Error> {
    init_raw_in(max_size, error_alloc, alloc)
}

#[cfg(target_os="dos")]
unsafe fn init_raw_in<A: Allocator + Clone>(
    max_size: Option<(u16, u16)>,
    error_alloc: Option<&'static dyn Allocator>,
    _alloc: A
) -> Result<Box<dyn Screen>, Error> {
    if let Some(max_size) = max_size {
        assert!(max_size.0 >= 80 && max_size.1 >= 25);
    }
    Ok(Box::new(tuifw_screen_dos::Screen::new(error_alloc)?))
}

#[cfg(all(not(target_os="dos"), windows))]
unsafe fn init_raw_in<A: Allocator + Clone + 'static>(
    max_size: Option<(u16, u16)>,
    error_alloc: Option<&'static dyn Allocator>,
    alloc: A
) -> Result<Box<dyn Screen>, Error> {
    Ok(Box::new(tuifw_screen_winapi::Screen::new_in(max_size, error_alloc, alloc)?))
}

#[cfg(all(not(target_os="dos"), not(windows)))]
unsafe fn init_raw_in<A: Allocator + Clone + 'static>(
    max_size: Option<(u16, u16)>,
    error_alloc: Option<&'static dyn Allocator>,
    alloc: A
) -> Result<Box<dyn Screen>, Error> {
    tuifw_screen_ncurses::init_in(max_size, error_alloc, alloc)
}