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

examples: directmode text

Browse Source
This commit is contained in:
nick black 2021-01-06 14:38:16 -05:00 committed by Nick Black
parent 30db4af874
commit ae1463245d
3 changed files with 48 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,4 +1,5 @@
build/
doc/examples/book
obj-x86_64-linux-gnu
python/.eggs/
python/build/

47
doc/examples/src/directmode.md
View File

@ -7,4 +7,49 @@ rendering; output is intended to appear immediately (subject to buffering). It
is still necessary to have a valid `TERM` environment variable identifying a
valid terminfo database entry for the running terminal.
Enter direct mode with a call to `ncdirect_init()`.
The authoritative reference for direct mode is the `notcurses_directmode(3)`
man page.
Enter direct mode with a call to `ncdirect_init()`. It takes three arguments:
`struct ncdirect* ncdirect_init(const char* termtype, FILE* fp, uint64_t flags);`
You can usually simply pass `NULL`, `NULL`, and 0. This will use the terminal
entry specified by the `TERM` environment variable, and write to `stdout`. If
the terminfo entry cannot be loaded, `ncdirect_init()` will fail. Otherwise,
the active style (italics, reverse video, etc.) will be reset to the default,
and all `ncdirect` functions are available to use. When done with the context,
call `ncdirect_stop()` to release its resources, and restore the terminal's
preserved status.
The cursor is not moved by initialization. If your program was invoked as
`ncdirect-demo` from an interactive shell, the cursor is most likely to be
on the first column of the line following your command prompt, exactly where
a program like `ls` would start its output.
**example initializing+releasing ncdirect, printing some colored text**
**picture of output**
The terminal will scroll on output just like it normally does, and if you have
a scrollback buffer, any output you generate will be present there. Remember:
direct mode simply *styles* standard output. With that said, the cursor can be
freely controlled in direct mode, and moved arbitrarily within the viewing
region. Dimensions of the terminal can be acquired with `ncdirect_dim_y()` and
`ncdirect_dim_x()` (if you initialized direct mode with a file not attached to
a terminal, Notcurses will simulate a 80x24 canvas). The cursor's location is
found with `ncdirect_cursor_yx()` (this function fails if run on a
non-terminal, or if the terminal does not support this capability).
**ncdirect_ cursor functions**
The cursor can be moved relative to its current location, or absolutely within
the terminal's boundaries. The location can also be pushed and popped (''FIXME''
why don't we synthesize this in the absence of `sc/rc`? why is this exposed at
all? do some terminals support `sc` but not cursor location discovery?).
The cursor can be hidden and made visible once more with `ncdirect_cursor_disable()`
and `ncdirect_cursor_enable()`. Unlike rendered mode, the cursor is not hidden
by default at initialization.
**example scrolling a screen's worth of text**
**picture before and after run**

2
src/poc/direct.c
View File

@ -14,7 +14,7 @@ int main(void){
return EXIT_FAILURE;
}
struct ncdirect* n; // see bug #391
if((n = ncdirect_init(NULL, stdout, 0)) == NULL){
if((n = ncdirect_init(NULL, NULL, 0)) == NULL){
return EXIT_FAILURE;
}
int dimy = ncdirect_dim_y(n);