libnotcurses-sys 3.9.1

Low-level Rust bindings for the notcurses C library.
Documentation 
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

//! `NcTree` widget

// functions already exported by bindgen : 11
// ------------------------------------------
// (#) test:  0
// (W) wrap: 10
// ------------------------------------------
//W  nctree_add
//W  nctree_create
//W  nctree_destroy
//W  nctree_del
//W  nctree_focused
//~  nctree_goto
//W  nctree_next
//W  nctree_offer_input
//W  nctree_plane
//W  nctree_prev
//W  nctree_redraw

use core::ffi::{c_int, c_void};

use crate::{c_api::ffi, NcPlane};

mod methods;

/// High-level hierarchical line-based data.
///
/// `NcTree`s organize static hierarchical items, and allow them to be browsed.
///
/// An NcTree cannot be empty, count must be non-zero.
///
/// - Each item can have arbitrary subitems.
/// - Items can be collapsed and expanded.
/// - The display supports scrolling and searching.
/// - Items cannot be added or removed, however; they must be provided in their
///   entirety at creation time.
///
/// NOTE: `NcTree` shares many properties with `NcReel`. Unlike the latter,
/// `NcTree`s support arbitrary hierarchical levels, but they do not allow
/// elements to come and go across the lifetime of the widget.
///
/// `type in C: nctree (struct)`
pub type NcTree = ffi::nctree;

/// Item for [`NcTree`].
///
/// each item has a curry, and zero or more subitems.
pub type NcTreeItem = ffi::nctree_item;

/// Options struct for [`NcTree`].
pub type NcTreeOptions = ffi::nctree_options;

// e.g.:
//
// ```c
// int treecb(struct ncplane* n, void* curry, int pos){
//   ncplane_printf_yx(n, 0, 0, "item: %s pos: %d",
//                     static_cast<const char*>(curry), pos);
//   return 0;
// }
// ```

/// An [NcTreeItem] callback function (unsafe).
pub type NcTreeItemCbUnsafe = unsafe extern "C" fn(*mut NcPlane, *mut c_void, c_int) -> c_int;

/// An [NcTreeItem] callback function.
pub type NcTreeItemCb = fn(&mut NcPlane, &str, i32);

// WIP TODO: create callback type and conversion functions
//
// /// Converts [NcTreeItemCbUnsafe] to [NcTreeItemCb].
// pub fn nctreeitemcb_to_rust(resizecb: Option<NcTreeItemCbUnsafe>) -> Option<NcTreeItemCb> {
//     if let Some(cb) = resizecb {
//         return Some(unsafe { core::mem::transmute(cb) });
//     } else {
//         None
//     }
// }
//
// /// Converts [NcTreeItemCb] to [NcTreeItemCbUnsafe].
// ///
// // waiting for https://github.com/rust-lang/rust/issues/53605
// // to make this function const, and then NcPlaneOptions constructors.
// pub fn nctreeitemcb_to_c(resizecb: Option<NcTreeItemCb>) -> Option<NcTreeItemCbUnsafe> {
//     if let Some(cb) = resizecb {
//         return Some(unsafe { core::mem::transmute(cb) });
//     } else {
//         None
//     }
// }