jim_nvp Struct Reference

Name Value Pairs, aka: NVP. More...

Data Fields
const char *	name
int	value

Detailed Description

Name Value Pairs, aka: NVP.

• Given a string - return the associated int.
• Given a number - return the associated string.

Very useful when the number is not a simple index into an array of known string, or there may be multiple strings (aliases) that mean then same thing.

An NVP Table is terminated with ".name = NULL".

During the 'name2value' operation, if no matching string is found the pointer to the terminal element (with p->name == NULL) is returned.

Example:

    const struct jim_nvp yn[] = {
        { "yes", 1 },
        { "no" , 0 },
        { "yep", 1 },
        { "nope", 0 },
        { NULL, -1 },
    };
 
struct jim_nvp *result
e = jim_nvp_name2value(interp, yn, "y", &result);
       returns &yn[0];
e = jim_nvp_name2value(interp, yn, "n", &result);
       returns &yn[1];
e = jim_nvp_name2value(interp, yn, "Blah", &result);
       returns &yn[4];

During the number2name operation, the first matching value is returned.

Definition at line 59 of file jim-nvp.h.

Field Documentation

name

const char* jim_nvp::name

Definition at line 60 of file jim-nvp.h.

Referenced by arm_tpiu_swo_configure(), COMMAND_HANDLER(), dap_configure(), jim_get_nvp(), jim_nvp_name2value(), jim_nvp_name2value_nocase(), jim_nvp_name2value_nocase_simple(), jim_nvp_name2value_simple(), jim_nvp_value2name(), jim_nvp_value2name_simple(), target_configure(), and target_event_name().

value

int jim_nvp::value

Definition at line 61 of file jim-nvp.h.

Referenced by aarch64_jim_configure(), adiv5_jim_spot_configure(), arm_tpiu_swo_configure(), COMMAND_HANDLER(), dap_configure(), jim_nvp_value2name(), jim_nvp_value2name_simple(), jim_target_invoke_event(), and target_configure().

---

The documentation for this struct was generated from the following file:

• jim-nvp.h