transmission/libtransmission/tr-getopt.h

47 lines
1.4 KiB
C
Raw Normal View History

// This file Copyright © Mnemosyne LLC.
2022-08-08 18:05:39 +00:00
// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),
// or any future license endorsed by Mnemosyne LLC.
// License text can be found in the licenses/ folder.
#pragma once
/**
* @addtogroup utils Utilities
* @{
*/
/** @brief Similar to optind, this is the current index into argv */
extern int tr_optind;
struct tr_option
{
int val; /* the value to return from tr_getopt() */
char const* longName; /* --long-form */
char const* description; /* option's description for tr_getopt_usage() */
char const* shortName; /* short form */
2019-07-14 12:40:41 +00:00
bool has_arg; /* 0 for no argument, 1 for argument */
char const* argName; /* argument's description for tr_getopt_usage() */
};
enum
{
/* all options have been processed */
TR_OPT_DONE = 0,
/* a syntax error was detected, such as a missing
* argument for an option that requires one */
TR_OPT_ERR = -1,
/* an unknown option was reached */
TR_OPT_UNK = -2
};
/**
* @brief similar to `getopt()`
* @return `TR_GETOPT_DONE`, `TR_GETOPT_ERR`, `TR_GETOPT_UNK`, or the matching `tr_option`'s `val` field
*/
int tr_getopt(char const* usage, int argc, char const* const* argv, tr_option const* opts, char const** setme_optarg);
/** @brief prints the `Usage` help section to stdout */
void tr_getopt_usage(char const* app_name, char const* description, tr_option const* opts);
/** @} */