Archives
/
notcurses
mirror of https://github.com/dankamongmen/notcurses
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

notcurses.h: move deprecated functions to end of file

Browse Source
pull/1573/head
nick black 3 years ago
parent 31ee680ea8
commit 8f2398132c
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
1 changed files with 267 additions and 268 deletions
Show Stats Download Patch File Download Diff File

535
include/notcurses/notcurses.h
Unescape Escape View File

@ -645,16 +645,10 @@ nccell_init(nccell* c){
memset(c, 0, sizeof(*c));
}
__attribute__ ((deprecated)) static inline void
cell_init(nccell* c){
nccell_init(c);
}
// Breaks the UTF-8 string in 'gcluster' down, setting up the nccell 'c'.
// Returns the number of bytes copied out of 'gcluster', or -1 on failure. The
// styling of the cell is left untouched, but any resources are released.
API int nccell_load(struct ncplane* n, nccell* c, const char* gcluster);
__attribute__ ((deprecated)) API int cell_load(struct ncplane* n, nccell* c, const char* gcluster);
// nccell_load(), plus blast the styling with 'attr' and 'channels'.
static inline int
@ -666,24 +660,13 @@ nccell_prime(struct ncplane* n, nccell* c, const char* gcluster,
return ret;
}
// nccell_load(), plus blast the styling with 'attr' and 'channels'.
__attribute__ ((deprecated)) static inline int
cell_prime(struct ncplane* n, nccell* c, const char* gcluster,
uint32_t stylemask, uint64_t channels){
return nccell_prime(n, c, gcluster, stylemask, channels);
}
// Duplicate 'c' into 'targ'; both must be/will be bound to 'n'. Returns -1 on
// failure, and 0 on success.
API int nccell_duplicate(struct ncplane* n, nccell* targ, const nccell* c);
__attribute__ ((deprecated)) API int cell_duplicate(struct ncplane* n, nccell* targ, const nccell* c);
// Release resources held by the nccell 'c'.
API void nccell_release(struct ncplane* n, nccell* c);
__attribute__ ((deprecated)) API void cell_release(struct ncplane* n, nccell* c);
#define NCSTYLE_MASK 0x03ffu
#define NCSTYLE_STANDOUT 0x0080u
#define NCSTYLE_UNDERLINE 0x0040u
@ -704,23 +687,12 @@ nccell_set_styles(nccell* c, unsigned stylebits){
c->stylemask = stylebits & NCSTYLE_MASK;
}
__attribute__ ((deprecated)) static inline void
cell_set_styles(nccell* c, unsigned stylebits){
nccell_set_styles(c, stylebits);
}
// Extract the style bits from the nccell.
static inline unsigned
nccell_styles(const nccell* c){
return c->stylemask;
}
// Extract the style bits from the nccell.
__attribute__ ((deprecated)) static inline unsigned
cell_styles(const nccell* c){
return nccell_styles(c);
}
// Add the specified styles (in the LSBs) to the nccell's existing spec,
// whether they're actively supported or not.
static inline void
@ -728,105 +700,57 @@ nccell_on_styles(nccell* c, unsigned stylebits){
c->stylemask |= (stylebits & NCSTYLE_MASK);
}
__attribute__ ((deprecated)) static inline void
cell_on_styles(nccell* c, unsigned stylebits){
nccell_on_styles(c, stylebits);
}
// Remove the specified styles (in the LSBs) from the nccell's existing spec.
static inline void
nccell_off_styles(nccell* c, unsigned stylebits){
c->stylemask &= ~(stylebits & NCSTYLE_MASK);
}
__attribute__ ((deprecated)) static inline void
cell_off_styles(nccell* c, unsigned stylebits){
nccell_off_styles(c, stylebits);
}
// Use the default color for the foreground.
static inline void
nccell_set_fg_default(nccell* c){
channels_set_fg_default(&c->channels);
}
__attribute__ ((deprecated)) static inline void
cell_set_fg_default(nccell* c){
nccell_set_fg_default(c);
}
// Use the default color for the background.
static inline void
nccell_set_bg_default(nccell* c){
channels_set_bg_default(&c->channels);
}
__attribute__ ((deprecated)) static inline void
cell_set_bg_default(nccell* c){
nccell_set_bg_default(c);
}
static inline int
nccell_set_fg_alpha(nccell* c, int alpha){
return channels_set_fg_alpha(&c->channels, alpha);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_alpha(nccell* c, int alpha){
return nccell_set_fg_alpha(c, alpha);
}
static inline int
nccell_set_bg_alpha(nccell* c, int alpha){
return channels_set_bg_alpha(&c->channels, alpha);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_alpha(nccell* c, int alpha){
return nccell_set_bg_alpha(c, alpha);
}
// Is the cell part of a multicolumn element?
static inline bool
nccell_double_wide_p(const nccell* c){
return (c->width >= 2);
}
__attribute__ ((deprecated)) static inline bool
cell_double_wide_p(const nccell* c){
return nccell_double_wide_p(c);
}
// Is this the right half of a wide character?
static inline bool
nccell_wide_right_p(const nccell* c){
return nccell_double_wide_p(c) && c->gcluster == 0;
}
__attribute__ ((deprecated)) static inline bool
cell_wide_right_p(const nccell* c){
return nccell_wide_right_p(c);
}
// Is this the left half of a wide character?
static inline bool
nccell_wide_left_p(const nccell* c){
return nccell_double_wide_p(c) && c->gcluster;
}
__attribute__ ((deprecated)) static inline bool
cell_wide_left_p(const nccell* c){
return nccell_wide_left_p(c);
}
// return a pointer to the NUL-terminated EGC referenced by 'c'. this pointer
// can be invalidated by any further operation on the plane 'n', so...watch out!
// returns NULL if called on a pixel graphic.
API const char* nccell_extended_gcluster(const struct ncplane* n, const nccell* c);
__attribute__ ((deprecated)) API const char*
cell_extended_gcluster(const struct ncplane* n, const nccell* c);
// copy the UTF8-encoded EGC out of the nccell. the result is not tied to any
// ncplane, and persists across erases / destruction.
ALLOC static inline char*
@ -834,11 +758,6 @@ nccell_strdup(const struct ncplane* n, const nccell* c){
return strdup(nccell_extended_gcluster(n, c));
}
__attribute__ ((deprecated)) ALLOC static inline char*
cell_strdup(const struct ncplane* n, const nccell* c){
return nccell_strdup(n, c);
}
// Extract the three elements of a nccell.
static inline char*
nccell_extract(const struct ncplane* n, const nccell* c,
@ -852,12 +771,6 @@ nccell_extract(const struct ncplane* n, const nccell* c,
return nccell_strdup(n, c);
}
__attribute__ ((deprecated)) static inline char*
cell_extract(const struct ncplane* n, const nccell* c,
uint16_t* stylemask, uint64_t* channels){
return nccell_extract(n, c, stylemask, channels);
}
// Returns true if the two nccells are distinct EGCs, attributes, or channels.
// The actual egcpool index needn't be the same--indeed, the planes needn't even
// be the same. Only the expanded EGC must be equal. The EGC must be bit-equal;
@ -875,12 +788,6 @@ nccellcmp(const struct ncplane* n1, const nccell* RESTRICT c1,
return strcmp(nccell_extended_gcluster(n1, c1), nccell_extended_gcluster(n2, c2));
}
__attribute__ ((deprecated)) static inline bool
cellcmp(const struct ncplane* n1, const nccell* RESTRICT c1,
const struct ncplane* n2, const nccell* RESTRICT c2){
return nccellcmp(n1, c1, n2, c2);
}
// Load a 7-bit char 'ch' into the nccell 'c'. Returns the number of bytes
// used, or -1 on error.
static inline int
@ -891,11 +798,6 @@ nccell_load_char(struct ncplane* n, nccell* c, char ch){
return nccell_load(n, c, gcluster);
}
__attribute__ ((deprecated)) static inline int
cell_load_char(struct ncplane* n, nccell* c, char ch){
return nccell_load_char(n, c, ch);
}
// Load a UTF-8 encoded EGC of up to 4 bytes into the nccell 'c'. Returns the
// number of bytes used, or -1 on error.
static inline int
@ -907,11 +809,6 @@ nccell_load_egc32(struct ncplane* n, nccell* c, uint32_t egc){
return nccell_load(n, c, gcluster);
}
__attribute__ ((deprecated)) static inline int
cell_load_egc32(struct ncplane* n, nccell* c, uint32_t egc){
return nccell_load_egc32(n, c, egc);
}
// These log levels consciously map cleanly to those of libav; Notcurses itself
// does not use this full granularity. The log level does not affect the opening
// and closing banners, which can be disabled via the notcurses_option struct's
@ -1276,11 +1173,6 @@ API ALLOC struct ncplane* ncplane_create(struct ncplane* n, const ncplane_option
// be the top, bottom, and root of this new pile.
API ALLOC struct ncplane* ncpile_create(struct notcurses* nc, const ncplane_options* nopts);
// This function will be removed in ABI3 in favor of ncplane_create().
// It persists in ABI2 only for backwards compatibility.
API ALLOC struct ncplane* ncplane_new(struct ncplane* n, int rows, int cols, int y, int x, void* opaque, const char* name)
__attribute__ ((deprecated));
// Suitable for use as a 'resizecb', this will resize the plane to the visual
// region's size. It is used for the standard plane.
API int ncplane_resize_maximize(struct ncplane* n);
@ -1609,10 +1501,6 @@ ncplane_halign(const struct ncplane* n, ncalign_e align, int c){
return notcurses_align(ncplane_dim_x(n), align, c);
}
static inline int
ncplane_align(const struct ncplane* n, ncalign_e align, int c)
__attribute__ ((deprecated));
static inline int
ncplane_align(const struct ncplane* n, ncalign_e align, int c){
return ncplane_halign(n, align, c);
@ -2090,67 +1978,36 @@ nccell_fg_rgb(const nccell* cl){
return channels_fg_rgb(cl->channels);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_rgb(const nccell* cl){
return nccell_fg_rgb(cl);
}
// Extract 24 bits of background RGB from 'cl', shifted to LSBs.
static inline uint32_t
nccell_bg_rgb(const nccell* cl){
return channels_bg_rgb(cl->channels);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_rgb(const nccell* cl){
return nccell_bg_rgb(cl);
}
// Extract 2 bits of foreground alpha from 'cl', shifted to LSBs.
static inline uint32_t
nccell_fg_alpha(const nccell* cl){
return channels_fg_alpha(cl->channels);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_alpha(const nccell* cl){
return nccell_fg_alpha(cl);
}
// Extract 2 bits of background alpha from 'cl', shifted to LSBs.
static inline uint32_t
nccell_bg_alpha(const nccell* cl){
return channels_bg_alpha(cl->channels);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_alpha(const nccell* cl){
return nccell_bg_alpha(cl);
}
// Extract 24 bits of foreground RGB from 'cl', split into components.
static inline uint32_t
nccell_fg_rgb8(const nccell* cl, unsigned* r, unsigned* g, unsigned* b){
return channels_fg_rgb8(cl->channels, r, g, b);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_rgb8(const nccell* cl, unsigned* r, unsigned* g, unsigned* b){
return nccell_fg_rgb8(cl, r, g, b);
}
// Extract 24 bits of background RGB from 'cl', split into components.
static inline uint32_t
nccell_bg_rgb8(const nccell* cl, unsigned* r, unsigned* g, unsigned* b){
return channels_bg_rgb8(cl->channels, r, g, b);
}
// Extract 24 bits of background RGB from 'cl', split into components.
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_rgb8(const nccell* cl, unsigned* r, unsigned* g, unsigned* b){
return nccell_bg_rgb8(cl, r, g, b);
}
// Set the r, g, and b cell for the foreground component of this 64-bit
// 'cl' variable, and mark it as not using the default color.
static inline int
@ -2158,33 +2015,18 @@ nccell_set_fg_rgb8(nccell* cl, int r, int g, int b){
return channels_set_fg_rgb8(&cl->channels, r, g, b);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_rgb8(nccell* cl, int r, int g, int b){
return nccell_set_fg_rgb8(cl, r, g, b);
}
// Same, but clipped to [0..255].
static inline void
nccell_set_fg_rgb8_clipped(nccell* cl, int r, int g, int b){
channels_set_fg_rgb8_clipped(&cl->channels, r, g, b);
}
__attribute__ ((deprecated)) static inline void
cell_set_fg_rgb8_clipped(nccell* cl, int r, int g, int b){
nccell_set_fg_rgb8_clipped(cl, r, g, b);
}
// Same, but with an assembled 24-bit RGB value.
static inline int
nccell_set_fg_rgb(nccell* c, uint32_t channel){
return channels_set_fg_rgb(&c->channels, channel);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_rgb(nccell* c, uint32_t channel){
return nccell_set_fg_rgb(c, channel);
}
// Set the cell's foreground palette index, set the foreground palette index
// bit, set it foreground-opaque, and clear the foreground default color bit.
static inline int
@ -2192,21 +2034,11 @@ nccell_set_fg_palindex(nccell* cl, int idx){
return channels_set_fg_palindex(&cl->channels, idx);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_palindex(nccell* cl, int idx){
return nccell_set_fg_palindex(cl, idx);
}
static inline uint32_t
nccell_fg_palindex(const nccell* cl){
return channels_fg_palindex(cl->channels);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_palindex(const nccell* cl){
return nccell_fg_palindex(cl);
}
// Set the r, g, and b cell for the background component of this 64-bit
// 'cl' variable, and mark it as not using the default color.
static inline int
@ -2214,22 +2046,12 @@ nccell_set_bg_rgb8(nccell* cl, int r, int g, int b){
return channels_set_bg_rgb8(&cl->channels, r, g, b);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_rgb8(nccell* cl, int r, int g, int b){
return nccell_set_bg_rgb8(cl, r, g, b);
}
// Same, but clipped to [0..255].
static inline void
nccell_set_bg_rgb8_clipped(nccell* cl, int r, int g, int b){
channels_set_bg_rgb8_clipped(&cl->channels, r, g, b);
}
__attribute__ ((deprecated)) static inline void
cell_set_bg_rgb8_clipped(nccell* cl, int r, int g, int b){
nccell_set_bg_rgb8_clipped(cl, r, g, b);
}
// Same, but with an assembled 24-bit RGB value. A value over 0xffffff
// will be rejected, with a non-zero return value.
static inline int
@ -2237,11 +2059,6 @@ nccell_set_bg_rgb(nccell* c, uint32_t channel){
return channels_set_bg_rgb(&c->channels, channel);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_rgb(nccell* c, uint32_t channel){
return nccell_set_bg_rgb(c, channel);
}
// Set the cell's background palette index, set the background palette index
// bit, set it background-opaque, and clear the background default color bit.
static inline int
@ -2249,42 +2066,22 @@ nccell_set_bg_palindex(nccell* cl, int idx){
return channels_set_bg_palindex(&cl->channels, idx);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_palindex(nccell* cl, int idx){
return nccell_set_bg_palindex(cl, idx);
}
static inline uint32_t
nccell_bg_palindex(const nccell* cl){
return channels_bg_palindex(cl->channels);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_palindex(const nccell* cl){
return nccell_bg_palindex(cl);
}
// Is the foreground using the "default foreground color"?
static inline bool
nccell_fg_default_p(const nccell* cl){
return channels_fg_default_p(cl->channels);
}
__attribute__ ((deprecated)) static inline bool
cell_fg_default_p(const nccell* cl){
return nccell_fg_default_p(cl);
}
static inline bool
nccell_fg_palindex_p(const nccell* cl){
return channels_fg_palindex_p(cl->channels);
}
__attribute__ ((deprecated)) static inline bool
cell_fg_palindex_p(const nccell* cl){
return nccell_fg_palindex_p(cl);
}
// Is the background using the "default background color"? The "default
// background color" must generally be used to take advantage of
// terminal-effected transparency.
@ -2293,21 +2090,11 @@ nccell_bg_default_p(const nccell* cl){
return channels_bg_default_p(cl->channels);
}
__attribute__ ((deprecated)) static inline bool
cell_bg_default_p(const nccell* cl){
return nccell_bg_default_p(cl);
}
static inline bool
nccell_bg_palindex_p(const nccell* cl){
return channels_bg_palindex_p(cl->channels);
}
__attribute__ ((deprecated)) static inline bool
cell_bg_palindex_p(const nccell* cl){
return nccell_bg_palindex_p(cl);
}
// Extract the 32-bit working background channel from an ncplane.
static inline uint32_t
ncplane_bchannel(const struct ncplane* n){
@ -2332,14 +2119,6 @@ API void ncplane_on_styles(struct ncplane* n, unsigned stylebits);
// Remove the specified styles from the ncplane's existing spec.
API void ncplane_off_styles(struct ncplane* n, unsigned stylebits);
// Deprecated forms of above.
API void ncplane_styles_set(struct ncplane* n, unsigned stylebits)
__attribute__ ((deprecated));
API void ncplane_styles_on(struct ncplane* n, unsigned stylebits)
__attribute__ ((deprecated));
API void ncplane_styles_off(struct ncplane* n, unsigned stylebits)
__attribute__ ((deprecated));
// Extract 24 bits of working foreground RGB from an ncplane, shifted to LSBs.
static inline uint32_t
ncplane_fg_rgb(const struct ncplane* n){
@ -2502,11 +2281,6 @@ API int nccells_rounded_box(struct ncplane* n, uint32_t styles, uint64_t channel
nccell* ul, nccell* ur, nccell* ll,
nccell* lr, nccell* hl, nccell* vl);
__attribute__ ((deprecated)) API int
cells_rounded_box(struct ncplane* n, uint32_t styles, uint64_t channels,
nccell* ul, nccell* ur, nccell* ll,
nccell* lr, nccell* hl, nccell* vl);
static inline int
ncplane_rounded_box(struct ncplane* n, uint32_t styles, uint64_t channels,
int ystop, int xstop, unsigned ctlword){
@ -2560,11 +2334,6 @@ API int nccells_double_box(struct ncplane* n, uint32_t styles, uint64_t channels
nccell* ul, nccell* ur, nccell* ll,
nccell* lr, nccell* hl, nccell* vl);
__attribute__ ((deprecated)) API int
cells_double_box(struct ncplane* n, uint32_t styles, uint64_t channels,
nccell* ul, nccell* ur, nccell* ll,
nccell* lr, nccell* hl, nccell* vl);
static inline int
ncplane_double_box(struct ncplane* n, uint32_t styles, uint64_t channels,
int ystop, int xstop, unsigned ctlword){
@ -2687,14 +2456,6 @@ API ALLOC uint32_t* ncplane_as_rgba(const struct ncplane* n, ncblitter_e blit,
int* pxdimy, int* pxdimx)
__attribute__ ((nonnull (1)));
// Deprecated in favor of ncplane_as_rgba. This will be removed in ABI3.
ALLOC __attribute__ ((deprecated)) __attribute__ ((nonnull (1)))
static inline uint32_t*
ncplane_rgba(const struct ncplane* n, ncblitter_e blit,
int begy, int begx, int leny, int lenx){
return ncplane_as_rgba(n, blit, begy, begx, leny, lenx, NULL, NULL);
}
// Get the size and ratio of ncvisual pixels to output cells along the y
// and x axes. The input size (in pixels) will be written to 'y' and 'x'.
// The scaling will be written to 'scaley' and 'scalex'. With these:
@ -2707,13 +2468,6 @@ API int ncvisual_blitter_geom(const struct notcurses* nc, const struct ncvisual*
int* scaley, int* scalex, ncblitter_e* blitter)
__attribute__ ((nonnull (1)));
__attribute__ ((deprecated)) static inline int
ncvisual_geom(const struct notcurses* nc, const struct ncvisual* n,
const struct ncvisual_options* vopts,
int* y, int* x, int* scaley, int* scalex){
return ncvisual_blitter_geom(nc, n, vopts, y, x, scaley, scalex, NULL);
}
// Destroy an ncvisual. Rendered elements will not be disrupted, but the visual
// can be neither decoded nor rendered any further.
API void ncvisual_destroy(struct ncvisual* ncv);
@ -2772,6 +2526,16 @@ API struct ncplane* ncvisual_render(struct notcurses* nc, struct ncvisual* ncv,
API ALLOC char* ncvisual_subtitle(const struct ncvisual* ncv)
__attribute__ ((nonnull (1)));
// Get the default *media* (not plot) blitter for this environment when using
// the specified scaling method. Currently, this means:
// - if lacking UTF-8, NCBLIT_1x1
// - otherwise, if not NCSCALE_STRETCH, NCBLIT_2x1
// - otherwise, if sextants are not known to be good, NCBLIT_2x2
// - otherwise NCBLIT_3x2
// NCBLIT_2x2 and NCBLIT_3x2 both distort the original aspect ratio, thus
// NCBLIT_2x1 is used outside of NCSCALE_STRETCH.
API ncblitter_e ncvisual_media_defblitter(const struct notcurses* nc, ncscale_e scale);
// Called for each frame rendered from 'ncv'. If anything but 0 is returned,
// the streaming operation ceases immediately, and that value is propagated out.
// The recommended absolute display time target is passed in 'tspec'.
@ -3018,10 +2782,6 @@ API void* nctablet_userptr(struct nctablet* t);
// Access the ncplane associated with nctablet 't', if one exists.
API struct ncplane* nctablet_plane(struct nctablet* t);
// Deprecated form of nctablet_plane().
API struct ncplane* nctablet_ncplane(struct nctablet* t)
__attribute__ ((deprecated));
// Takes an arbitrarily large number, and prints it into a fixed-size buffer by
// adding the necessary SI suffix. Usually, pass a |[IB]PREFIXSTRLEN+1|-sized
// buffer to generate up to |[IB]PREFIXCOLUMNS| columns' worth of EGCs. The
@ -3908,26 +3668,43 @@ API char* ncreader_contents(const struct ncreader* n)
API void ncreader_destroy(struct ncreader* n, char** contents);
// Dump selected Notcurses state to the supplied 'debugfp'. Output is freeform,
// and subject to change. It includes geometry of all planes, from all piles.
// newline-delimited, and subject to change. It includes geometry of all
// planes, from all piles. No line has more than 79 columns' worth of output.
API void notcurses_debug(const struct notcurses* nc, FILE* debugfp)
__attribute__ ((nonnull (1, 2)));
// Dump selected configuration capabilities to 'debugfp'. Output is freeform,
// and subject to change.
// newline-delimited, and subject to change.
API void notcurses_debug_caps(const struct notcurses* nc, FILE* debugfp)
__attribute__ ((nonnull (1, 2)));
// replaced by ncvisual_media_defblitter(). this original version never returns
// NCBLIT_3x2.
static inline ncblitter_e
ncvisual_default_blitter(bool utf8, ncscale_e scale)
__attribute__ ((deprecated));
// DEPRECATED MATERIAL, GOING AWAY IN ABI3
static inline ncblitter_e
__attribute__ ((deprecated)) static inline void
cell_init(nccell* c){
nccell_init(c);
}
__attribute__ ((deprecated)) API int cell_load(struct ncplane* n, nccell* c, const char* gcluster);
// nccell_load(), plus blast the styling with 'attr' and 'channels'.
__attribute__ ((deprecated)) static inline int
cell_prime(struct ncplane* n, nccell* c, const char* gcluster,
uint32_t stylemask, uint64_t channels){
return nccell_prime(n, c, gcluster, stylemask, channels);
}
__attribute__ ((deprecated)) API int cell_duplicate(struct ncplane* n, nccell* targ, const nccell* c);
__attribute__ ((deprecated)) API void cell_release(struct ncplane* n, nccell* c);
// replaced by ncvisual_media_defblitter(). this original version never returns
// NCBLIT_3x2. deprecated, going away in ABI3.
__attribute__ ((deprecated)) static inline ncblitter_e
ncvisual_default_blitter(bool utf8, ncscale_e scale){
if(utf8){
// NCBLIT_3x2/NCBLIT_2x2 are better image quality, especially for large
// images, but it's not the general default because it doesn't preserve
// images, but not the general default because they doesn't preserve
// aspect ratio (as does NCBLIT_2x1). NCSCALE_STRETCH throws away aspect
// ratio, and can safely use NCBLIT_3x2/2x2.
if(scale == NCSCALE_STRETCH){
@ -3938,15 +3715,237 @@ ncvisual_default_blitter(bool utf8, ncscale_e scale){
return NCBLIT_1x1;
}
// Get the default *media* (not plot) blitter for this environment when using
// the specified scaling method. Currently, this means:
// - if lacking UTF-8, NCBLIT_1x1
// - otherwise, if not NCSCALE_STRETCH, NCBLIT_2x1
// - otherwise, if sextants are not known to be good, NCBLIT_2x2
// - otherwise NCBLIT_3x2
// NCBLIT_2x2 and NCBLIT_3x2 both distort the original aspect ratio, thus
// NCBLIT_2x1 is used outside of NCSCALE_STRETCH.
API ncblitter_e ncvisual_media_defblitter(const struct notcurses* nc, ncscale_e scale);
__attribute__ ((deprecated)) static inline void
cell_set_styles(nccell* c, unsigned stylebits){
nccell_set_styles(c, stylebits);
}
// Extract the style bits from the nccell.
__attribute__ ((deprecated)) static inline unsigned
cell_styles(const nccell* c){
return nccell_styles(c);
}
__attribute__ ((deprecated)) static inline void
cell_on_styles(nccell* c, unsigned stylebits){
nccell_on_styles(c, stylebits);
}
__attribute__ ((deprecated)) static inline void
cell_off_styles(nccell* c, unsigned stylebits){
nccell_off_styles(c, stylebits);
}
__attribute__ ((deprecated)) static inline void
cell_set_fg_default(nccell* c){
nccell_set_fg_default(c);
}
__attribute__ ((deprecated)) static inline void
cell_set_bg_default(nccell* c){
nccell_set_bg_default(c);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_alpha(nccell* c, int alpha){
return nccell_set_fg_alpha(c, alpha);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_alpha(nccell* c, int alpha){
return nccell_set_bg_alpha(c, alpha);
}
__attribute__ ((deprecated)) static inline bool
cell_double_wide_p(const nccell* c){
return nccell_double_wide_p(c);
}
__attribute__ ((deprecated)) static inline bool
cell_wide_right_p(const nccell* c){
return nccell_wide_right_p(c);
}
__attribute__ ((deprecated)) static inline bool
cell_wide_left_p(const nccell* c){
return nccell_wide_left_p(c);
}
__attribute__ ((deprecated)) API const char*
cell_extended_gcluster(const struct ncplane* n, const nccell* c);
__attribute__ ((deprecated)) ALLOC static inline char*
cell_strdup(const struct ncplane* n, const nccell* c){
return nccell_strdup(n, c);
}
__attribute__ ((deprecated)) static inline char*
cell_extract(const struct ncplane* n, const nccell* c,
uint16_t* stylemask, uint64_t* channels){
return nccell_extract(n, c, stylemask, channels);
}
__attribute__ ((deprecated)) static inline bool
cellcmp(const struct ncplane* n1, const nccell* RESTRICT c1,
const struct ncplane* n2, const nccell* RESTRICT c2){
return nccellcmp(n1, c1, n2, c2);
}
__attribute__ ((deprecated)) static inline int
cell_load_char(struct ncplane* n, nccell* c, char ch){
return nccell_load_char(n, c, ch);
}
__attribute__ ((deprecated)) static inline int
cell_load_egc32(struct ncplane* n, nccell* c, uint32_t egc){
return nccell_load_egc32(n, c, egc);
}
// This function will be removed in ABI3 in favor of ncplane_create().
// It persists in ABI2 only for backwards compatibility.
API ALLOC struct ncplane* ncplane_new(struct ncplane* n, int rows, int cols, int y, int x, void* opaque, const char* name)
__attribute__ ((deprecated));
static inline int
ncplane_align(const struct ncplane* n, ncalign_e align, int c)
__attribute__ ((deprecated));
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_rgb(const nccell* cl){
return nccell_fg_rgb(cl);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_rgb(const nccell* cl){
return nccell_bg_rgb(cl);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_alpha(const nccell* cl){
return nccell_fg_alpha(cl);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_alpha(const nccell* cl){
return nccell_bg_alpha(cl);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_rgb8(const nccell* cl, unsigned* r, unsigned* g, unsigned* b){
return nccell_fg_rgb8(cl, r, g, b);
}
// Extract 24 bits of background RGB from 'cl', split into components.
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_rgb8(const nccell* cl, unsigned* r, unsigned* g, unsigned* b){
return nccell_bg_rgb8(cl, r, g, b);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_rgb8(nccell* cl, int r, int g, int b){
return nccell_set_fg_rgb8(cl, r, g, b);
}
__attribute__ ((deprecated)) static inline void
cell_set_fg_rgb8_clipped(nccell* cl, int r, int g, int b){
nccell_set_fg_rgb8_clipped(cl, r, g, b);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_rgb(nccell* c, uint32_t channel){
return nccell_set_fg_rgb(c, channel);
}
__attribute__ ((deprecated)) static inline int
cell_set_fg_palindex(nccell* cl, int idx){
return nccell_set_fg_palindex(cl, idx);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_fg_palindex(const nccell* cl){
return nccell_fg_palindex(cl);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_rgb8(nccell* cl, int r, int g, int b){
return nccell_set_bg_rgb8(cl, r, g, b);
}
__attribute__ ((deprecated)) static inline void
cell_set_bg_rgb8_clipped(nccell* cl, int r, int g, int b){
nccell_set_bg_rgb8_clipped(cl, r, g, b);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_rgb(nccell* c, uint32_t channel){
return nccell_set_bg_rgb(c, channel);
}
__attribute__ ((deprecated)) static inline int
cell_set_bg_palindex(nccell* cl, int idx){
return nccell_set_bg_palindex(cl, idx);
}
__attribute__ ((deprecated)) static inline uint32_t
cell_bg_palindex(const nccell* cl){
return nccell_bg_palindex(cl);
}
__attribute__ ((deprecated)) static inline bool
cell_fg_default_p(const nccell* cl){
return nccell_fg_default_p(cl);
}
__attribute__ ((deprecated)) static inline bool
cell_fg_palindex_p(const nccell* cl){
return nccell_fg_palindex_p(cl);
}
__attribute__ ((deprecated)) static inline bool
cell_bg_default_p(const nccell* cl){
return nccell_bg_default_p(cl);
}
__attribute__ ((deprecated)) static inline bool
cell_bg_palindex_p(const nccell* cl){
return nccell_bg_palindex_p(cl);
}
API void ncplane_styles_set(struct ncplane* n, unsigned stylebits)
__attribute__ ((deprecated));
API void ncplane_styles_on(struct ncplane* n, unsigned stylebits)
__attribute__ ((deprecated));
API void ncplane_styles_off(struct ncplane* n, unsigned stylebits)
__attribute__ ((deprecated));
__attribute__ ((deprecated)) API int
cells_rounded_box(struct ncplane* n, uint32_t styles, uint64_t channels,
nccell* ul, nccell* ur, nccell* ll,
nccell* lr, nccell* hl, nccell* vl);
__attribute__ ((deprecated)) API int
cells_double_box(struct ncplane* n, uint32_t styles, uint64_t channels,
nccell* ul, nccell* ur, nccell* ll,
nccell* lr, nccell* hl, nccell* vl);
// Deprecated in favor of ncplane_as_rgba. This will be removed in ABI3.
ALLOC __attribute__ ((deprecated)) __attribute__ ((nonnull (1)))
static inline uint32_t*
ncplane_rgba(const struct ncplane* n, ncblitter_e blit,
int begy, int begx, int leny, int lenx){
return ncplane_as_rgba(n, blit, begy, begx, leny, lenx, NULL, NULL);
}
__attribute__ ((deprecated)) static inline int
ncvisual_geom(const struct notcurses* nc, const struct ncvisual* n,
const struct ncvisual_options* vopts,
int* y, int* x, int* scaley, int* scalex){
return ncvisual_blitter_geom(nc, n, vopts, y, x, scaley, scalex, NULL);
}
// Deprecated form of nctablet_plane().
API struct ncplane* nctablet_ncplane(struct nctablet* t)
__attribute__ ((deprecated));
#undef ALLOC
#undef API

Write Preview
Loading…
Cancel
Save