Chyron Management

Create and manage the Chyron. More...

Functions
void	activate_all_chyron_keys (Chyron *chyron)
	Deactivate chyron key.
void	activate_chyron_key (Chyron *chyron, uint k)
	Activate chyron key.
void	compile_chyron (Chyron *chyron)
	construct the chyron string from the chyron structure
void	deactivate_all_chyron_keys (Chyron *chyron)
	Deactivate all chyron keys.
void	deactivate_chyron_key (Chyron *chyron, uint k)
	Deactivate chyron key.
Chyron *	destroy_chyron (Chyron *chyron)
	Destroy Chyron structure.
void	display_chyron (UiSurface *sfc, uint w, Chyron *chyron, uint line, uint col)
	Display chyron on the specified line and column of the surface.
int	get_chyron_key (Chyron *chyron, uint x)
	Get keycode from chyron.
bool	is_set_chyron_key (Chyron *chyron, uint k)
	Check if function key label is set.
uint	mbstr_to_cellstr (UiCell *cmplx_buf, const char *str, const UiCell *cell_base, uint *p, const uint atmost)
	Convert multibyte string to complex character array.
Chyron *	new_chyron ()
	Create and initialize Chyron structure.
void	set_chyron_key (Chyron *chyron, uint k, char *s, uint kc)
	Set chyron key with default color pair (cp_nt_rev).
void	set_chyron_key_cb (Chyron *chyron, uint k, char *s, uint kc, UiCell cell_base)
	Set chyron key with color pair (cp).
void	unset_chyron_key (Chyron *chyron, uint k)
	Unset chyron key.

Detailed Description

Create and manage the Chyron.

Function Documentation

activate_all_chyron_keys()

void activate_all_chyron_keys

(

Chyron *

chyron

)

Deactivate chyron key.

deactivate_chyron_key

Parameters

chyron	structure
k	chyron_key index

Definition at line 1078 of file dwin.c.

                                              {
    for (int k = 0; k < CHYRON_KEYS; k++)
        chyron->key[k]->active = true;
}

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

activate_chyron_key()

void activate_chyron_key	(	Chyron *	chyron,
		uint	k )

Activate chyron key.

activate_chyron_key

Parameters

chyron	structure
k	chyron_key index

Definition at line 1069 of file dwin.c.

                                                 {
    chyron->key[k]->active = true;
}

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

compile_chyron()

void compile_chyron

(

Chyron *

chyron

)

construct the chyron string from the chyron structure

compile_chyron

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 1110 of file dwin.c.

                                    {
    uint end_pos = 0;
    uint k = 0;
    uint pos = 0;
    UiCell cell_base = cell_nt_rev;
    UiCell *cx;
    char tmp_str[MAXLEN];
    while (k < CHYRON_KEYS) {
        if (chyron->key[k]->text[0] == '\0' || !chyron->key[k]->active) {
            k++;
            continue;
        }
        cell_base = chyron->key[k]->cell_base;
        if (end_pos == 0) {
            cx = chyron->cmplx_buf;
            mbstr_to_cellstr(cx,
                             " ",
                             &cell_base,
                             &pos,
                             MAXLEN - 1);
        } else {
            mbstr_to_cellstr(chyron->cmplx_buf,
                             "|",
                             &cell_base,
                             &pos,
                             MAXLEN - 1);
        }
        cx = chyron->cmplx_buf;
        mbstr_to_cellstr(cx, chyron->key[k]->text, &cell_base, &pos, MAXLEN - 1);
        end_pos = pos;
        chyron->l = end_pos;
        chyron->key[k]->end_pos = end_pos;
        ssnprintf(tmp_str, MAXLEN - 1, "k=%d, text=%s, end_pos=%d", k,
                  chyron->key[k]->text, chyron->key[k]->end_pos);
        k++;
    }
    mbstr_to_cellstr(chyron->cmplx_buf, " ", &cell_base, &pos, MAXLEN - 1);
    chyron->l = end_pos;
}

References ChyronKey::active, ChyronKey::cell_base, cell_nt_rev, Chyron::cmplx_buf, ChyronKey::end_pos, Chyron::key, Chyron::l, mbstr_to_cellstr(), ssnprintf(), and ChyronKey::text.

Referenced by action_disposition(), answer_yn(), display_error(), field_editor(), form_engine(), form_post(), form_process(), init_pick(), Perror(), pick_engine(), and picker().

Here is the call graph for this function:

Here is the caller graph for this function:

deactivate_all_chyron_keys()

void deactivate_all_chyron_keys

(

Chyron *

chyron

)

Deactivate all chyron keys.

deactivate_all_chyron_keys

Parameters

chyron

structure

Definition at line 1096 of file dwin.c.

                                                {
    for (int k = 0; k < CHYRON_KEYS; k++)
        chyron->key[k]->active = false;
}

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

deactivate_chyron_key()

void deactivate_chyron_key	(	Chyron *	chyron,
		uint	k )

Deactivate chyron key.

deactivate_chyron_key

Parameters

chyron	structure
k	chyron_key index

Definition at line 1088 of file dwin.c.

                                                   {
    chyron->key[k]->active = false;
}

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

destroy_chyron()

Chyron * destroy_chyron

(

Chyron *

chyron

)

Destroy Chyron structure.

destroy_chyron

Parameters

chyron

pointer to Chyron structure

Returns

nullptr

Definition at line 984 of file dwin.c.

                                       {
    uint 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(), and pick_engine().

Here is the caller graph for this function:

display_chyron()

void display_chyron	(	UiSurface *	sfc,
		uint	w,
		Chyron *	chyron,
		uint	line,
		uint	col )

Display chyron on the specified line and column of the surface.

display_chyron

Parameters

sfc	Pointer to the UiSurface structure
w	Window index (WIN or BOX)
chyron	Pointer to the Chyron structure
line	Line number where the chyron should be displayed
col	Column number where the chyron should start

This function displays the compiled chyron string on the specified line and column of the given surface. It first moves the cursor to the specified position, clears to the end of the line, and then writes the chyron string. Finally, it moves the cursor back to the specified column for user input.

Definition at line 1163 of file dwin.c.

                                                                                 {
    ui_wmove(sfc, w, line, 0);
    ui_wclrtoeol(sfc, w);
    ui_wmove(sfc, w, line, 0);
    ui_mvwadd_wchstr(sfc, w, line, 0, chyron->cmplx_buf);
    ui_wmove(sfc, w, line, col);
    return;
}

References Chyron::cmplx_buf, ui_mvwadd_wchstr(), ui_wclrtoeol(), and ui_wmove().

Referenced by action_disposition(), answer_yn(), display_error(), field_editor(), form_engine(), form_post(), form_process(), Perror(), and picker().

Here is the call graph for this function:

Here is the caller graph for this function:

get_chyron_key()

int get_chyron_key	(	Chyron *	chyron,
		uint	x )

Get keycode from chyron.

get_chyron_key

Parameters

chyron	structure
x	Mouse X position

Returns

Keycode

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 1186 of file dwin.c.

                                           {
    uint i = 0;
    uint k = -1;
    while (i < CHYRON_KEYS - 1) {
        if (chyron->key[i]->text[0] != '\0' && chyron->key[i]->active)
            if (chyron->key[i]->end_pos >= x) {
                k = i;
                break;
            }
        i++;
    }
    return chyron->key[k]->keycode;
}

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

Referenced by field_editor(), form_post(), form_process(), and picker().

Here is the caller graph for this function:

is_set_chyron_key()

bool is_set_chyron_key	(	Chyron *	chyron,
		uint	k )

Check if function key label is set.

is_set_chyron_key

Parameters

chyron	structure
k	Function key index (0-19)

Returns

true if set, false if not set

Definition at line 1005 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:

mbstr_to_cellstr()

uint mbstr_to_cellstr	(	UiCell *	cmplx_buf,
		const char *	str,
		const UiCell *	cell_base,
		uint *	p,
		const uint	atmost )

Convert multibyte string to complex character array.

mbstr_to_cellstr

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 480 of file dwin.c.

                                                                                                               {
    ushort cp;
    uint p1 = 0;
    uint *pos = &p1;
    if (p)
        pos = p;
    uint i = 0, len = 0;
    const char *s;
    attr_t style;
    UiCell cc;
    wchar_t wstr[5];
    ui_getcchar(cell_base, &wstr[0], &style, &cp, nullptr);
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    if (pos && *pos >= atmost - 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 > atmost)
            break;
        if (ui_setcchar(&cc, wstr, style, cp, nullptr) != ERR) {
            if (len > 0 && (*pos + len) < atmost)
                cmplx_buf[(*pos)++] = cc;
        }
        i += len;
    }
    wstr[0] = L'\0';
    wstr[1] = L'\0';
    ui_setcchar(&cc, wstr, style, cp, nullptr);
    cmplx_buf[*pos] = cc;
    return *pos;
}

References ui_getcchar(), and ui_setcchar().

Referenced by compile_chyron(), form_display_accept_field(), form_display_field(), and form_display_fields().

Here is the call graph for this function:

Here is the caller graph for this function:

new_chyron()

Chyron * new_chyron

(

)

Create and initialize Chyron structure.

new_chyron

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. 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 947 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));
        if (!chyron->key[i]) {
            abend(-1, "calloc chyron->key[i] failed");
            return nullptr;
        }
    }
    return chyron;
}

References abend(), and Chyron::key.

Referenced by action_disposition(), answer_yn(), display_error(), form_engine(), init_pick(), and Perror().

Here is the call graph for this function:

Here is the caller graph for this function:

set_chyron_key()

void set_chyron_key	(	Chyron *	chyron,
		uint	k,
		char *	s,
		uint	kc )

Set chyron key with default color pair (cp_nt_rev).

set_chyron_key

Parameters

chyron	structure
k	chyron key index (0-19)
s	chyron key label
kc	chyron key code

This function sets the label and keycode for a function key in the chyron structure. It uses the default color pair cp_nt_rev for the key label. If the input string s is not empty, it copies the string into the chyron key's text field. If the input string is empty, it sets the first character of the text field to '\0' to indicate that the key is not set. The keycode is stored in the chyron key's keycode field, and the color pair index is set to cp_nt_rev.

Definition at line 1045 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]->active = true;
    chyron->key[k]->cell_base = cell_nt_rev;
}

References ChyronKey::active, ChyronKey::cell_base, cell_nt_rev, Chyron::key, ChyronKey::keycode, ssnprintf(), and ChyronKey::text.

Referenced by action_disposition(), answer_yn(), display_error(), form_engine(), init_pick(), and Perror().

Here is the call graph for this function:

Here is the caller graph for this function:

set_chyron_key_cb()

void set_chyron_key_cb	(	Chyron *	chyron,
		uint	k,
		char *	s,
		uint	kc,
		UiCell	cell_base )

Set chyron key with color pair (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 is like set_chyron_key, except it includes a color pair numbers

Definition at line 1021 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]->active = true;
    chyron->key[k]->cell_base = cell_base;
}

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

Referenced by field_editor(), form_engine(), and picker().

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,
		uint	k )

Unset chyron key.

unset_chyron_key

Parameters

chyron	structure
k	chyron_key index

Definition at line 1060 of file dwin.c.

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

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