Campbell Barton
c434782e3a
Use a shorter/simpler license convention, stops the header taking so much space. Follow the SPDX license specification: https://spdx.org/licenses - C/C++/objc/objc++ - Python - Shell Scripts - CMake, GNUmakefile While most of the source tree has been included - `./extern/` was left out. - `./intern/cycles` & `./intern/atomic` are also excluded because they use different header conventions. doc/license/SPDX-license-identifiers.txt has been added to list SPDX all used identifiers. See P2788 for the script that automated these edits. Reviewed By: brecht, mont29, sergey Ref D14069
66 lines
1.8 KiB
C++
66 lines
1.8 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2001-2002 NaN Holding BV. All rights reserved. */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
* \brief A general argument parsing module.
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct bArgs;
|
|
typedef struct bArgs bArgs;
|
|
|
|
/**
|
|
* Returns the number of extra arguments consumed by the function.
|
|
* - 0 is normal value,
|
|
* - -1 stops parsing arguments, other negative indicates skip
|
|
*/
|
|
typedef int (*BA_ArgCallback)(int argc, const char **argv, void *data);
|
|
|
|
struct bArgs *BLI_args_create(int argc, const char **argv);
|
|
void BLI_args_destroy(struct bArgs *ba);
|
|
|
|
/** The pass to use for #BLI_args_add. */
|
|
void BLI_args_pass_set(struct bArgs *ba, int current_pass);
|
|
|
|
/**
|
|
* Pass starts at 1, -1 means valid all the time
|
|
* short_arg or long_arg can be null to specify no short or long versions
|
|
*/
|
|
void BLI_args_add(struct bArgs *ba,
|
|
const char *short_arg,
|
|
const char *long_arg,
|
|
const char *doc,
|
|
BA_ArgCallback cb,
|
|
void *data);
|
|
|
|
/**
|
|
* Short_case and long_case specify if those arguments are case specific
|
|
*/
|
|
void BLI_args_add_case(struct bArgs *ba,
|
|
const char *short_arg,
|
|
int short_case,
|
|
const char *long_arg,
|
|
int long_case,
|
|
const char *doc,
|
|
BA_ArgCallback cb,
|
|
void *data);
|
|
|
|
void BLI_args_parse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data);
|
|
|
|
void BLI_args_print_arg_doc(struct bArgs *ba, const char *arg);
|
|
void BLI_args_print_other_doc(struct bArgs *ba);
|
|
|
|
bool BLI_args_has_other_doc(const struct bArgs *ba);
|
|
|
|
void BLI_args_print(struct bArgs *ba);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|