tickit_stringpos_limit_bytes(3)

set limit fields in string position counters

Section 3 libtickit-dev bookworm source

Description

TICKIT_STRINGPOS_LIMIT_BYTES

NAME

tickit_stringpos_limit_... - set limit fields in string position counters

SYNOPSIS

#include <tickit.h>

void tickit_stringpos_limit_bytes(TickitStringPos *pos, size_t bytes);
void tickit_stringpos_limit_codepoints(TickitStringPos *pos, int codepoints);
void tickit_stringpos_limit_graphemes(TickitStringPos *pos, int graphemes);
void tickit_stringpos_limit_columns(TickitStringPos *pos, int columns);
void tickit_stringpos_limit_none(TickitStringPos *pos);

#define INIT_TICKIT_STRINGPOS_LIMIT_BYTES(bytes)
#define INIT_TICKIT_STRINGPOS_LIMIT_CODEPOINTS(codepoints)
#define INIT_TICKIT_STRINGPOS_LIMIT_GRAPHEMES(grahpemes)
#define INIT_TICKIT_STRINGPOS_LIMIT_COLUMNS(columns)
#define INIT_TICKIT_STRINGPOS_LIMIT_NONE

Link with -ltickit.

DESCRIPTION

The first four of these functions each set one of the counter fields in pos to the given value, and the other three to -1. This is useful to create a limit counter to stop tickit_utf8_count(3) or tickit_utf8_countmore(3) at the given position. The final function initialises all four fields to -1.

Each is also available as a macro which can be used to initialise a new TickitStringPos variable.

TickitStringPos limit = INIT_TICKIT_STRINGPOS_LIMIT_BYTES(b);

RETURN VALUE

The functions all return no value. The macros expand to a struct initialiser expression.