[rust] refactor Notcurses & NcDirect wrapping approach
- remove `Nc` & `NcD` wrappers, to move them to notcurses-rs library. - update the summary header format for Notcurses and NcDirect - update docs and examplespull/1637/head
joseLuís
3 years ago
parent
73fc4ea935
commit
129e208438
@ -1,67 +0,0 @@
|
||||
//! `NcD` wrapper struct and traits implementations.
|
||||
|
||||
use std::ops::{Deref, DerefMut};
|
||||
|
||||
use crate::{raw_wrap, NcDirect, NcResult};
|
||||
|
||||
/// Safe wrapper around [NcDirect], minimal notcurses instance for styling text.
|
||||
#[derive(Debug)]
|
||||
pub struct NcD<'a> {
|
||||
pub(crate) raw: &'a mut NcDirect,
|
||||
}
|
||||
|
||||
impl<'a> AsRef<NcDirect> for NcD<'a> {
|
||||
fn as_ref(&self) -> &NcDirect {
|
||||
self.raw
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> AsMut<NcDirect> for NcD<'a> {
|
||||
fn as_mut(&mut self) -> &mut NcDirect {
|
||||
self.raw
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> Deref for NcD<'a> {
|
||||
type Target = NcDirect;
|
||||
|
||||
fn deref(&self) -> &Self::Target {
|
||||
self.as_ref()
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> DerefMut for NcD<'a> {
|
||||
fn deref_mut(&mut self) -> &mut Self::Target {
|
||||
self.as_mut()
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> Drop for NcD<'a> {
|
||||
/// Destroys the NcD context.
|
||||
fn drop(&mut self) {
|
||||
let _ = self.raw.stop();
|
||||
}
|
||||
}
|
||||
|
||||
/// # Constructors and methods overriden from NcDirect
|
||||
impl<'a> NcD<'a> {
|
||||
// wrap constructors
|
||||
|
||||
/// New NcD (without banners).
|
||||
pub fn new() -> NcResult<Self> {
|
||||
raw_wrap![NcDirect::new()]
|
||||
}
|
||||
|
||||
/// New NcD, expects `NCOPTION_*` flags.
|
||||
pub fn with_flags(flags: u64) -> NcResult<Self> {
|
||||
raw_wrap![NcDirect::with_flags(flags)]
|
||||
}
|
||||
|
||||
// disable destructor
|
||||
|
||||
/// Since NcD already implements [Drop](#impl-Drop),
|
||||
/// this function is made no-op.
|
||||
pub fn stop(&mut self) -> NcResult<()> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
@ -1,137 +0,0 @@
|
||||
//! `Nc` wrapper struct and traits implementations.
|
||||
|
||||
use std::ops::{Deref, DerefMut};
|
||||
|
||||
use crate::{
|
||||
raw_wrap, NcAlign, NcBlitter, NcDim, NcLogLevel, NcResult, NcScale, Notcurses, NotcursesOptions,
|
||||
};
|
||||
|
||||
/// Safe wrapper around [Notcurses], the main struct of the TUI library.
|
||||
#[derive(Debug)]
|
||||
pub struct Nc<'a> {
|
||||
pub(crate) raw: &'a mut Notcurses,
|
||||
}
|
||||
|
||||
impl<'a> AsRef<Notcurses> for Nc<'a> {
|
||||
fn as_ref(&self) -> &Notcurses {
|
||||
self.raw
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> AsMut<Notcurses> for Nc<'a> {
|
||||
fn as_mut(&mut self) -> &mut Notcurses {
|
||||
self.raw
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> Deref for Nc<'a> {
|
||||
type Target = Notcurses;
|
||||
|
||||
fn deref(&self) -> &Self::Target {
|
||||
self.as_ref()
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> DerefMut for Nc<'a> {
|
||||
fn deref_mut(&mut self) -> &mut Self::Target {
|
||||
self.as_mut()
|
||||
}
|
||||
}
|
||||
|
||||
impl<'a> Drop for Nc<'a> {
|
||||
/// Destroys the Nc context.
|
||||
fn drop(&mut self) {
|
||||
let _ = self.raw.stop();
|
||||
}
|
||||
}
|
||||
|
||||
/// # Constructors and methods overriden from Notcurses
|
||||
impl<'a> Nc<'a> {
|
||||
// wrap constructors
|
||||
|
||||
/// New Nc (without banners).
|
||||
pub fn new() -> NcResult<Self> {
|
||||
raw_wrap![Notcurses::new()]
|
||||
}
|
||||
|
||||
/// New Nc, with banners.
|
||||
pub fn with_banners() -> NcResult<Self> {
|
||||
raw_wrap![Notcurses::with_banners()]
|
||||
}
|
||||
|
||||
/// New Nc, without an alternate screen (nor banners).
|
||||
pub fn without_altscreen() -> NcResult<Self> {
|
||||
raw_wrap![Notcurses::without_altscreen()]
|
||||
}
|
||||
|
||||
/// New Nc, expects `NCOPTION_*` flags.
|
||||
pub fn with_flags(flags: u64) -> NcResult<Self> {
|
||||
raw_wrap![Notcurses::with_flags(flags)]
|
||||
}
|
||||
|
||||
/// New Nc, expects [NotcursesOptions].
|
||||
pub fn with_options(options: NotcursesOptions) -> NcResult<Self> {
|
||||
raw_wrap![Notcurses::with_options(options)]
|
||||
}
|
||||
|
||||
/// New Nc, expects [NcLogLevel] and flags.
|
||||
pub fn with_debug(loglevel: NcLogLevel, flags: u64) -> NcResult<Self> {
|
||||
raw_wrap![Notcurses::with_debug(loglevel, flags)]
|
||||
}
|
||||
|
||||
// disable destructor
|
||||
|
||||
/// Since Nc already implements [Drop](#impl-Drop),
|
||||
/// this function is made no-op.
|
||||
pub fn stop(&mut self) -> NcResult<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
// wrap associated functions
|
||||
|
||||
/// Returns the offset into `availcols` at which `cols` ought be output given
|
||||
/// the requirements of `align`.
|
||||
pub fn align(availcols: NcDim, align: NcAlign, cols: NcDim) -> NcResult<()> {
|
||||
Notcurses::align(availcols, align, cols)
|
||||
}
|
||||
|
||||
/// Gets the name of an [NcBlitter] blitter.
|
||||
pub fn str_blitter(blitter: NcBlitter) -> String {
|
||||
Notcurses::str_blitter(blitter)
|
||||
}
|
||||
|
||||
/// Gets the name of an [NcScale] scaling mode.
|
||||
pub fn str_scalemode(scalemode: NcScale) -> String {
|
||||
Notcurses::str_scalemode(scalemode)
|
||||
}
|
||||
|
||||
/// Returns an [NcBlitter] from a string representation.
|
||||
pub fn lex_blitter(op: &str) -> NcResult<NcBlitter> {
|
||||
Notcurses::lex_blitter(op)
|
||||
}
|
||||
|
||||
/// Lexes a margin argument according to the standard Notcurses definition.
|
||||
///
|
||||
/// There can be either a single number, which will define all margins equally,
|
||||
/// or there can be four numbers separated by commas.
|
||||
///
|
||||
pub fn lex_margins(op: &str, options: &mut NotcursesOptions) -> NcResult<()> {
|
||||
Notcurses::lex_margins(op, options)
|
||||
}
|
||||
|
||||
/// Returns an [NcScale] from a string representation.
|
||||
pub fn lex_scalemode(op: &str) -> NcResult<NcScale> {
|
||||
Notcurses::lex_scalemode(op)
|
||||
}
|
||||
|
||||
/// Returns a human-readable string describing the running Nc version.
|
||||
pub fn version() -> String {
|
||||
Notcurses::version()
|
||||
}
|
||||
|
||||
/// Returns the running Notcurses version components
|
||||
/// (major, minor, patch, tweak).
|
||||
pub fn version_components() -> (u32, u32, u32, u32) {
|
||||
Notcurses::version_components()
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue