Chyron Management

Create and manage the Chyron. More...

Functions
Chyron *	new_chyron ()
	Create and initialize Chyron structure.
Chyron *	destroy_chyron (Chyron *chyron)
	Destroy Chyron structure.
bool	is_set_chyron_key (Chyron *chyron, int k)
	Check if function key label is set.
void	set_chyron_key_cp (Chyron *chyron, int k, char *s, int kc, int cp)
	Set chyron key.
void	unset_chyron_key (Chyron *chyron, int k)
	Unset chyron key.
void	compile_chyron (Chyron *chyron)
	construct the chyron string from the chyron structure
int	mb_to_cc (cchar_t *cmplx_buf, char *str, attr_t attr, int cpx, int *pos, int maxlen)
	Convert multibyte string to complex character array.
int	get_chyron_key (Chyron *chyron, int x)
	Get keycode from chyron.
cchar_t *	mk_cmplx_buf (const char *s)
	Create complex character buffer from multibyte string.

Detailed Description

Create and manage the Chyron.

Function Documentation

compile_chyron()

void compile_chyron

(

Chyron *

chyron

)

construct the chyron string from the chyron structure

Parameters

chyron

The chyron string is constructed by concatenating the labels of the set keys, separated by " | ". The end_pos values for each key are set to determine the zones for mouse clicks. When a mouse click occurs, the get_chyron_key function uses the end_pos values to determine which key was clicked based on the X position of the click.

Definition at line 268 of file dwin.c.

                                    {
    int end_pos = 0;
    int k = 0;
    int pos = 0;
    int cp = cp_reverse;
    cchar_t *cx;
    while (k < CHYRON_KEYS) {
        if (chyron->key[k]->text[0] == '\0') {
            k++;
            continue;
        }
        if (end_pos == 0) {
            cx = chyron->cmplx_buf;
            mb_to_cc(cx, " ", WA_NORMAL, cp_reverse, &pos, MAXLEN - 1);
        } else {
            mb_to_cc(chyron->cmplx_buf, "|", WA_NORMAL, cp_reverse, &pos,
                     MAXLEN - 1);
        }
        cx = chyron->cmplx_buf;
        cp = chyron->key[k]->cp;
        mb_to_cc(cx, chyron->key[k]->text, WA_NORMAL, cp, &pos, MAXLEN - 1);
        end_pos = pos;
        chyron->l = end_pos;
        chyron->key[k]->end_pos = end_pos;
        k++;
    }
    mb_to_cc(chyron->cmplx_buf, " ", WA_NORMAL, cp, &pos, MAXLEN - 1);
    chyron->l = end_pos;
}

References Chyron::cmplx_buf, ChyronKey::cp, cp_reverse, ChyronKey::end_pos, Chyron::key, Chyron::l, mb_to_cc(), and ChyronKey::text.

Referenced by action_disposition(), answer_yn(), display_error(), display_page(), field_editor(), form_display_fields(), form_post(), form_process(), Perror(), pick_engine(), and wait_mk_chyron().

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_chyron()

Chyron * destroy_chyron

(

Chyron *

chyron

)

Destroy Chyron structure.

Parameters

chyron

pointer to Chyron structure

Returns

nullptr

Definition at line 198 of file dwin.c.

                                       {
    int i;
 
    if (!chyron)
        return nullptr;
    for (i = 0; i < CHYRON_KEYS; i++) {
        if (chyron->key[i])
            free(chyron->key[i]);
        chyron->key[i] = nullptr;
    }
    free(chyron);
    chyron = nullptr;
    return chyron;
}

References Chyron::key.

Referenced by action_disposition(), answer_yn(), display_error(), init_form(), Perror(), pick_engine(), and wait_destroy().

Here is the caller graph for this function:

get_chyron_key()

int get_chyron_key	(	Chyron *	chyron,
		int	x )

Get keycode from chyron.

Parameters

chyron	structure
x	Mouse X position

Returns

Keycode

Note

This function uses the end_pos values set in compile_chyron to determine which key was clicked

The chyron functions provide xwgetch() with a mechanism to translate mouse click positions into key codes based on the labels set in the chyron structure. When a mouse click occurs, xwgetch() can call get_chyron_key() with the X position of the click to determine which function key was clicked, allowing for dynamic and customizable function key behavior in the chyron area of the interface.

Definition at line 369 of file dwin.c.

                                          {
    int i;
    for (i = 0; chyron->key[i]->end_pos != -1; i++)
        if (x < chyron->key[i]->end_pos)
            break;
    return chyron->key[i]->keycode;
}

References ChyronKey::end_pos, Chyron::key, and ChyronKey::keycode.

Referenced by xwgetch().

Here is the caller graph for this function:

is_set_chyron_key()

bool is_set_chyron_key	(	Chyron *	chyron,
		int	k )

Check if function key label is set.

Parameters

chyron	structure
k	Function key index (0-19)

Returns

true if set, false if not set

Definition at line 217 of file dwin.c.

                                              {
    if (chyron->key[k]->text[0] != '\0')
        return true;
    else
        return false;
}

References Chyron::key, and ChyronKey::text.

Referenced by form_post(), and form_process().

Here is the caller graph for this function:

mb_to_cc()

int mb_to_cc	(	cchar_t *	cmplx_buf,
		char *	str,
		attr_t	attr,
		int	cpx,
		int *	pos,
		int	maxlen )

Convert multibyte string to complex character array.

Parameters

cmplx_buf	Output buffer for complex characters
str	Input multibyte string
attr	Attributes to apply to the complex characters
cpx	Color pair index for the complex characters
pos	Pointer to current position in the output buffer, updated as characters are added
maxlen	Maximum length of the output buffer

Returns

Number of bytes processed from the input string

This function converts a multibyte string to an array of complex characters (cchar_t) that can be used with NCurses functions. It handles multibyte characters and applies the specified color pair to each character. The pos parameter is updated to reflect the current position in the output buffer, and the function ensures that it does not exceed the maximum length.

Definition at line 321 of file dwin.c.

                         {
    int i = 0, len = 0;
    const char *s;
    cchar_t cc = {0};
    wchar_t wstr[2] = {L'\0', L'\0'};
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    attr = WA_NORMAL;
    if (*pos >= maxlen - 1)
        return 0;
    while (str[i] != '\0') {
        s = &str[i];
        len = mbrtowc(wstr, s, MB_CUR_MAX, &mbstate);
        if (len <= 0) {
            wstr[0] = L'?';
            wstr[1] = L'\0';
            len = 1;
        }
        wstr[1] = L'\0';
        if (*pos >= maxlen - 1)
            break;
        if (setcchar(&cc, wstr, attr, cpx, nullptr) != ERR) {
            if (len > 0 && (*pos + len) < MAXLEN - 1)
                cmplx_buf[(*pos)++] = cc;
        }
        i += len;
    }
    wstr[0] = L'\0';
    wstr[1] = L'\0';
    setcchar(&cc, wstr, attr, cpx, nullptr);
    cmplx_buf[*pos] = cc;
    return *pos;
}

Referenced by compile_chyron().

Here is the caller graph for this function:

mk_cmplx_buf()

cchar_t * mk_cmplx_buf

(

const char *

s

)

Create complex character buffer from multibyte string.

Parameters

s	Input multibyte string

Returns

Pointer to complex character buffer

This function creates a complex character buffer from a multibyte string. It allocates memory for the buffer and converts the multibyte string to complex characters using the mb_to_cc function. The color pair used for the complex characters is cp_norm. The caller is responsible for freeing the allocated buffer when it is no longer needed.

Definition at line 386 of file dwin.c.

                                     {
    cchar_t *cmplx_buf = (cchar_t *)calloc(MAXLEN, sizeof(cchar_t));
    int j = 0;
    int len;
    attr_t attr = WA_NORMAL;
    int cpx = cp_win;
    wchar_t wc = L'\0';
    cchar_t cc = {0};
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    len = mbrtowc(&wc, s, MB_CUR_MAX, &mbstate);
    if (len <= 0) {
        wc = L'?';
        len = 1;
    }
    if (setcchar(&cc, &wc, attr, cpx, nullptr) != ERR) {
        if (len > 0 && (j + len) < MAXLEN - 1) {
            cmplx_buf[j++] = cc;
        }
    }
    return cmplx_buf;
}

References cp_win.

new_chyron()

Chyron * new_chyron

(

)

Create and initialize Chyron structure.

Returns

pointer to new Chyron structure

This function allocates memory for a new Chyron structure and initializes the key pointers. Each key pointer is allocated memory for a ChyronKey structure. The Chyron structure is used to manage function key labels and their associated keycodes for mouse click handling in the chyron area of the interface.

Note

The use of calloc ensures that the allocated memory is initialized to zero, which means that the text for each key will be initialized to an empty string and the keycodes will be initialized to zero. This allows the is_set_chyron_key function to check if a key is set by checking if the first character of the text is not '\0'. If any memory allocation fails, the function will call abend to handle the error and return nullptr.

Definition at line 183 of file dwin.c.

                     {
    Chyron *chyron = (Chyron *)calloc(1, sizeof(Chyron));
    if (!chyron) {
        abend(-1, "calloc chyron failed");
        return nullptr;
    }
    for (int i = 0; i < CHYRON_KEYS; i++)
        chyron->key[i] = (ChyronKey *)calloc(1, sizeof(ChyronKey));
    return chyron;
}

References abend(), and Chyron::key.

Referenced by action_disposition(), answer_yn(), display_error(), form_display_fields(), Perror(), pick_engine(), and wait_mk_chyron().

Here is the call graph for this function:

Here is the caller graph for this function:

set_chyron_key_cp()

void set_chyron_key_cp	(	Chyron *	chyron,
		int	k,
		char *	s,
		int	kc,
		int	cp )

Set chyron key.

Parameters

chyron	structure
k	chyron key index (0-19)
s	chyron key label
kc	chyron key code
cp	color pair index for the key label

This function sets the label and keycode for a chyron key. The label is copied into the chyron structure, and the keycode is stored for later retrieval when theire is a mouse click. The compile_chyron function uses the keycode values to determine which key was clicked based on the mouse X position. If the label string is empty, the key is unset by setting the first character of the text to '\0'.

Definition at line 237 of file dwin.c.

                                                                       {
    if (*s != '\0')
        ssnprintf(chyron->key[k]->text, CHYRON_KEY_MAXLEN - 1, "%s", s);
    else
        chyron->key[k]->text[0] = '\0';
    chyron->key[k]->keycode = kc;
    chyron->key[k]->cp = cp;
}

References ChyronKey::cp, Chyron::key, ChyronKey::keycode, ssnprintf(), and ChyronKey::text.

Referenced by field_editor(), and form_process().

Here is the call graph for this function:

Here is the caller graph for this function:

unset_chyron_key()

void unset_chyron_key	(	Chyron *	chyron,
		int	k )

Unset chyron key.

Parameters

chyron	structure
k	chyron_key index

Definition at line 258 of file dwin.c.

{ chyron->key[k]->text[0] = '\0'; }

References Chyron::key, and ChyronKey::text.

Referenced by form_post(), and form_process().

Here is the caller graph for this function: