sys_getopt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SYS_GETOPT_H_
#define ZEPHYR_INCLUDE_SYS_GETOPT_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/kernel.h>
 
struct sys_getopt_state {
        int opterr;   /* if error message should be printed */
        int optind;   /* index into parent argv vector */
        int optopt;   /* character checked for validity */
        int optreset; /* reset getopt */
        char *optarg; /* argument associated with option */
 
        char *place; /* option letter processing */
 
#if CONFIG_GETOPT_LONG
        int nonopt_start;
        int nonopt_end;
#endif
};
 
extern int sys_getopt_optreset; /* reset getopt */
extern char *sys_getopt_optarg;
extern int sys_getopt_opterr;
extern int sys_getopt_optind;
extern int sys_getopt_optopt;
 
#define sys_getopt_no_argument       0
#define sys_getopt_required_argument 1
#define sys_getopt_optional_argument 2
 
struct sys_getopt_option {
        /* name of long option */
        const char *name;
        /*
         * one of no_argument, required_argument, and optional_argument:
         * whether option takes an argument
         */
        int has_arg;
        /* if not NULL, set *flag to val when option found */
        int *flag;
        /* if flag not NULL, value to set *flag to; else return value */
        int val;
};
 
/* Function initializes getopt_state structure for current thread */
void sys_getopt_init(void);
 
/* Function returns getopt_state structure for the current thread. */
struct sys_getopt_state *sys_getopt_state_get(void);

int sys_getopt(int nargc, char *const nargv[], const char *ostr);

int sys_getopt_long(int nargc, char *const *nargv, const char *options,
                    const struct sys_getopt_option *long_options, int *idx);

int sys_getopt_long_only(int nargc, char *const *nargv, const char *options,
                         const struct sys_getopt_option *long_options, int *idx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SYS_GETOPT_H_ */