blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-09 17:19:03 -04:00
Code Issues Projects Releases Wiki Activity

rust: refactor module header summary info

Browse Source 
- refactor headers for Notcurses & NcDirect modules.
This commit is contained in:
joseLuís 2021-01-04 22:13:08 +01:00
parent 6938188b19
commit 1218e8fb7f
2 changed files with 143 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
rust/src/direct/mod.rs
View File

@ -1,65 +1,77 @@
//! `NcDirect`
// functions already exported by bindgen : 43
// ------------------------------------------
// (X) wont: 4
// (#) test: 0
// (W) wrap: 39 / 0
// ------------------------------------------
//W ncdirect_bg_default
//W ncdirect_bg_palindex
//W ncdirect_bg_rgb
//W ncdirect_box
//W ncdirect_canopen_images
//W ncdirect_canutf8
//W ncdirect_clear
//W ncdirect_cursor_disable
//W ncdirect_cursor_down
//W ncdirect_cursor_enable
//W ncdirect_cursor_left
//W ncdirect_cursor_move_yx
//W ncdirect_cursor_pop
//W ncdirect_cursor_push
//W ncdirect_cursor_right
//W ncdirect_cursor_up
//W ncdirect_cursor_yx
//W ncdirect_dim_x
//W ncdirect_dim_y
//W ncdirect_double_box
//W ncdirect_fg_default
//W ncdirect_fg_palindex
//W ncdirect_fg_rgb
//W ncdirect_flush
//W ncdirect_getc
//W ncdirect_hline_interp
//W ncdirect_init
//W ncdirect_inputready_fd
//W ncplane_on_styles
//W ncplane_off_styles
//W ncdirect_palette_size
// X ncdirect_printf_aligned
//W ncdirect_putstr
//W ncdirect_raster_frame
//W ncdirect_render_frame
//W ncdirect_render_image
//W ncdirect_rounded_box
//W ncplane_set_styles
//W ncdirect_stop
// X ncdirect_styles_off // deprecated
// X ncdirect_styles_on // deprecated
// X ncdirect_styles_set // deprecated
//W ncdirect_vline_interp
// --- ---------------------------------------------------------
// col 0:
// --------------
// 4 X: wont do
// ~: WIP
//
// functions manually reimplemented: 4
// ------------------------------------------
// (+) done: 4 / 0
// (W) wrap: 4 / 0
// (#) test: 0
// ------------------------------------------
//W+ ncdirect_bg_rgb8
//W+ ncdirect_fg_rgb8
//W+ ncdirect_getc_nblock
//W+ ncdirect_getc_nblocking
// col 1: 43
// --------------
// 39 f: ffi function imported by bindgen
// F: ffi function wrapped safely
// 4 r: static function reimplemented in Rust
//
// col 2: 43
// --------------
// 41 m: impl as an `NcDirect` method
// 2 M: impl for the `DirectMode` wrapper struct too
//
// col 3:
// --------------
// t: tests done for the ffi or reimplemented funtion
// T: tests done also for the m method
// Ŧ: tests done also for the M method wrapper struct
// --- ---------------------------------------------------------
//
// fm ncdirect_bg_default
// fm ncdirect_bg_palindex
// fm ncdirect_bg_rgb
// fm ncdirect_box
// fm ncdirect_canopen_images
// fm ncdirect_canutf8
// fm ncdirect_clear
// fm ncdirect_cursor_disable
// fm ncdirect_cursor_down
// fm ncdirect_cursor_enable
// fm ncdirect_cursor_left
// fm ncdirect_cursor_move_yx
// fm ncdirect_cursor_pop
// fm ncdirect_cursor_push
// fm ncdirect_cursor_right
// fm ncdirect_cursor_up
// fm ncdirect_cursor_yx
// fm ncdirect_dim_x
// fm ncdirect_dim_y
// fm ncdirect_double_box
// fm ncdirect_fg_default
// fm ncdirect_fg_palindex
// fm ncdirect_fg_rgb
// fm ncdirect_flush
// fm ncdirect_getc
// fm ncdirect_hline_interp
// fM ncdirect_init
// fm ncdirect_inputready_fd
// fm ncplane_on_styles
// fm ncplane_off_styles
// fm ncdirect_palette_size
//X ncdirect_printf_aligned
// fm ncdirect_putstr
// fm ncdirect_raster_frame
// fm ncdirect_render_frame
// fm ncdirect_render_image
// fm ncdirect_rounded_box
// fm ncplane_set_styles
// fM ncdirect_stop
//X ncdirect_styles_off // deprecated
//X ncdirect_styles_on // deprecated
//X ncdirect_styles_set // deprecated
// fm ncdirect_vline_interp
//
// rm ncdirect_bg_rgb8
// rm ncdirect_fg_rgb8
// rm ncdirect_getc_nblock
// rm ncdirect_getc_nblocking
#[cfg(test)]
mod test;

131
rust/src/notcurses/mod.rs
View File

@ -1,65 +1,78 @@
//! `Notcurses`
// functions already exported by bindgen : 42
// ------------------------------------------
// (#) test: 10
// (W) wrap: 41 / 1
// ------------------------------------------
//W notcurses_at_yx
//W notcurses_bottom
//W# notcurses_canchangecolor
//W# notcurses_canfade
//W# notcurses_canopen_images
//W# notcurses_canopen_videos
//W# notcurses_cansixel
//W# notcurses_cansextant
//W# notcurses_cantruecolor
//W# notcurses_canutf8
//W notcurses_cursor_disable
//W notcurses_cursor_enable
//W# notcurses_debug
//W# notcurses_drop_planes
//W notcurses_getc
//W# notcurses_init
//W notcurses_inputready_fd
//W notcurses_lex_blitter
//W notcurses_lex_margins
//W notcurses_lex_scalemode
//W notcurses_linesigs_disable
//W notcurses_linesigs_enable
//W notcurses_mouse_disable
//W notcurses_mouse_enable
//W notcurses_palette_size
//W notcurses_refresh
//W notcurses_render
//W notcurses_render_to_buffer
//W notcurses_render_to_file
//W notcurses_stats
//W notcurses_stats_alloc
//W notcurses_stats_reset
//W notcurses_stdplane
//W notcurses_stdplane_const
//W# notcurses_stop
//W notcurses_str_blitter
//W notcurses_str_scalemode
//W notcurses_supported_styles
//W notcurses_top
//~ notcurses_ucs32_to_utf8 (not needed in rust)
//W# notcurses_version
//W notcurses_version_components
// --- -------------------------------------------------------------------------
// col 0:
// --------------
// 1 X: wont do
// 2 ~: WIP
//
// functions manually reimplemented: 6
// -----------------------------------------
// (+) done: 6 / 0
// (#) test: 1
// (W) wrap: 4 / 0
// -----------------------------------------
//W# notcurses_align
//W+ notcurses_getc_blocking
//W+ notcurses_getc_nblock
//~+ notcurses_stddim_yx // multiple mutable references errors
//~+ notcurses_stddim_yx_const //
//W+ notcurses_term_dim_yx
// col 1: 48
// --------------
// 42 f: ffi function imported by bindgen
// F: ffi function wrapped safely
// 6 r: static function reimplemented in Rust
//
// col 2: 45
// --------------
// 38 m: impl as a `Notcurses` method
// 7 M: impl for the `FullMode` wrapper struct too
//
// col 3: 14
// --------------
// 14 t: tests done for the ffi or reimplemented funtion
// T: tests done also for the m method
// Ŧ: tests done also for the M method wrapper struct
// --- -------------------------------------------------------------------------
//
// fm notcurses_at_yx
// fm notcurses_bottom
// fmt notcurses_canchangecolor
// fmt notcurses_canfade
// fmt notcurses_canopen_images
// fmt notcurses_canopen_videos
// fmt notcurses_cansixel
// fmt notcurses_cansextant
// fmt notcurses_cantruecolor
// fmt notcurses_canutf8
// fm notcurses_cursor_disable
// fm notcurses_cursor_enable
// fmt notcurses_debug
// fmt notcurses_drop_planes
// fm notcurses_getc
// fMt notcurses_init
// fm notcurses_inputready_fd
// fM notcurses_lex_blitter
// fM notcurses_lex_margins
// fM notcurses_lex_scalemode
// fm notcurses_linesigs_disable
// fm notcurses_linesigs_enable
// fm notcurses_mouse_disable
// fm notcurses_mouse_enable
// fm notcurses_palette_size
// fm notcurses_refresh
// fm notcurses_render
// fm notcurses_render_to_buffer
// fm notcurses_render_to_file
// fm notcurses_stats
// fm notcurses_stats_alloc
// fm notcurses_stats_reset
// fm notcurses_stdplane
// fm notcurses_stdplane_const
// fMt notcurses_stop
// fM notcurses_str_blitter
// fM notcurses_str_scalemode
// fm notcurses_supported_styles
// fm notcurses_top
//X notcurses_ucs32_to_utf8 (not needed in rust)
// fMt notcurses_version
// fM notcurses_version_components
//
// rMt notcurses_align
// rm notcurses_getc_blocking
// rm notcurses_getc_nblock
//~r notcurses_stddim_yx // multiple mutable references errors
//~r notcurses_stddim_yx_const //
// rm notcurses_term_dim_yx
#[cfg(test)]
mod test;