getopts.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_LIB_USER_SPACE_GETOPTS_H__
#define __MOTR_LIB_USER_SPACE_GETOPTS_H__

#include "lib/types.h"

enum m0_getopts_opt_type {
        GOT_VOID,
        GOT_NUMBER,
        GOT_SCALED,
        GOT_STRING,
        GOT_FORMAT,
        GOT_FLAG,
        GOT_HELP
};

struct m0_getopts_opt {
        enum m0_getopts_opt_type go_type;
        char                     go_opt;
        const char              *go_desc;
        union m0_getopts_union {
                void   (*got_void)(void);
                void   (*got_number)(int64_t num);
                void   (*got_scaled)(m0_bcount_t num);
                void   (*got_string)(const char *string);
                struct {
                        const char *f_string;
                        void       *f_out;
                }        got_fmt;
                bool    *got_flag;
        } go_u;
};

int m0_getopts(const char *progname, int argc, char *const *argv,
               const struct m0_getopts_opt *opts, unsigned nr);

#define M0_GETOPTS(progname, argc, argv, ...)                           \
        m0_getopts((progname), (argc), (argv),                          \
                (const struct m0_getopts_opt []){ __VA_ARGS__ },        \
           ARRAY_SIZE(((const struct m0_getopts_opt []){ __VA_ARGS__ })))

#define M0_VOIDARG(ch, desc, func) {            \
        .go_type = GOT_VOID,                    \
        .go_opt  = (ch),                        \
        .go_desc = (desc),                      \
        .go_u    = { .got_void = (func) }       \
}

#define M0_NUMBERARG(ch, desc, func) {          \
        .go_type = GOT_NUMBER,                  \
        .go_opt  = (ch),                        \
        .go_desc = (desc),                      \
        .go_u    = { .got_number = (func) }     \
}

#define M0_SCALEDARG(ch, desc, func) {          \
        .go_type = GOT_SCALED,                  \
        .go_opt  = (ch),                        \
        .go_desc = (desc),                      \
        .go_u    = { .got_scaled = (func) }     \
}

#define M0_STRINGARG(ch, desc, func) {          \
        .go_type = GOT_STRING,                  \
        .go_opt  = (ch),                        \
        .go_desc = (desc),                      \
        .go_u    = { .got_string = (func) }     \
}

#define M0_FORMATARG(ch, desc, fmt, ptr) {                      \
        .go_type = GOT_FORMAT,                                  \
        .go_opt  = (ch),                                        \
        .go_desc = (desc),                                      \
        .go_u    = {                                            \
                .got_fmt = {                                    \
                        .f_string = (fmt), .f_out = (ptr)       \
                }                                               \
        }                                                       \
}

#define M0_FLAGARG(ch, desc, ptr) {             \
        .go_type = GOT_FLAG,                    \
        .go_opt  = (ch),                        \
        .go_desc = (desc),                      \
        .go_u    = { .got_flag = (ptr) }        \
}

#define M0_HELPARG(ch) {                        \
        .go_type = GOT_HELP,                    \
        .go_opt  = (ch),                        \
        .go_desc = "display this help and exit",\
        .go_u    = { .got_void = NULL }         \
}

#endif /* __MOTR_LIB_USER_SPACE_GETOPTS_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */