jim-nvp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause-Views */
 
/* Jim - A small embeddable Tcl interpreter
 *
 * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
 * Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
 * Copyright 2005 patthoyts - Pat Thoyts <patthoyts@users.sf.net>
 * Copyright 2008 oharboe - Øyvind Harboe - oyvind.harboe@zylin.com
 * Copyright 2008 Andrew Lunn <andrew@lunn.ch>
 * Copyright 2008 Duane Ellis <openocd@duaneellis.com>
 * Copyright 2008 Uwe Klein <uklein@klein-messgeraete.de>
 * Copyright 2008 Steve Bennett <steveb@workware.net.au>
 * Copyright 2009 Nico Coesel <ncoesel@dealogic.nl>
 * Copyright 2009 Zachary T Welch zw@superlucidity.net
 * Copyright 2009 David Brownell
 * Copyright (c) 2005-2011 Jim Tcl Project. All rights reserved.
 */
 
#ifndef OPENOCD_HELPER_JIM_NVP_H
#define OPENOCD_HELPER_JIM_NVP_H
 
#include <jim.h>
 
struct jim_nvp {
    const char *name;
    int value;
};
 
int jim_get_nvp(Jim_Interp *interp,
        Jim_Obj *objptr,
        const struct jim_nvp *nvp_table,
        const struct jim_nvp **result);
 
/* Name Value Pairs Operations */
struct jim_nvp *jim_nvp_name2value_simple(const struct jim_nvp *nvp_table, const char *name);
struct jim_nvp *jim_nvp_name2value_nocase_simple(const struct jim_nvp *nvp_table, const char *name);
struct jim_nvp *jim_nvp_value2name_simple(const struct jim_nvp *nvp_table, int v);
 
int jim_nvp_name2value(Jim_Interp *interp,
        const struct jim_nvp *nvp_table,
        const char *name,
        struct jim_nvp **result);
int jim_nvp_name2value_nocase(Jim_Interp *interp,
        const struct jim_nvp *nvp_table,
        const char *name,
        struct jim_nvp **result);
int jim_nvp_value2name(Jim_Interp *interp, const struct jim_nvp *nvp_table, int value, struct jim_nvp **result);
 
int jim_nvp_name2value_obj(Jim_Interp *interp,
        const struct jim_nvp *nvp_table,
        Jim_Obj *name_obj,
        struct jim_nvp **result);
int jim_nvp_name2value_obj_nocase(Jim_Interp *interp,
        const struct jim_nvp *nvp_table,
        Jim_Obj *name_obj,
        struct jim_nvp **result);
int jim_nvp_value2name_obj(Jim_Interp *interp,
        const struct jim_nvp *nvp_table,
        Jim_Obj *value_obj,
        struct jim_nvp **result);
 
void jim_set_result_nvp_unknown(Jim_Interp *interp,
        Jim_Obj *param_name,
        Jim_Obj *param_value,
        const struct jim_nvp *nvp_table);
 
const char *jim_debug_argv_string(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
 
 
struct jim_getopt_info {
    Jim_Interp *interp;
    int argc;
    Jim_Obj *const *argv;
    int isconfigure;        /* non-zero if configure */
};
 
int jim_getopt_setup(struct jim_getopt_info *goi,
        Jim_Interp *interp,
        int argc,
        Jim_Obj *const *argv);
 
 
void jim_getopt_debug(struct jim_getopt_info *goi);
 
int jim_getopt_obj(struct jim_getopt_info *goi, Jim_Obj **puthere);
 
int jim_getopt_string(struct jim_getopt_info *goi, const char **puthere, int *len);
 
int jim_getopt_double(struct jim_getopt_info *goi, double *puthere);
 
int jim_getopt_wide(struct jim_getopt_info *goi, jim_wide *puthere);
 
int jim_getopt_nvp(struct jim_getopt_info *goi, const struct jim_nvp *lookup, struct jim_nvp **puthere);
 
void jim_getopt_nvp_unknown(struct jim_getopt_info *goi, const struct jim_nvp *lookup, int hadprefix);
 
 
int jim_getopt_enum(struct jim_getopt_info *goi, const char *const *lookup, int *puthere);
 
#endif /* OPENOCD_HELPER_JIM_NVP_H */