diff options
Diffstat (limited to 'source/blender/blenlib/BLI_args.h')
| -rw-r--r-- | source/blender/blenlib/BLI_args.h | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/source/blender/blenlib/BLI_args.h b/source/blender/blenlib/BLI_args.h index cc4d65980c9..4cdb35dd675 100644 --- a/source/blender/blenlib/BLI_args.h +++ b/source/blender/blenlib/BLI_args.h @@ -1,6 +1,4 @@ -/** - * A general argument parsing module - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -32,28 +30,33 @@ #ifndef BLI_ARGS_H #define BLI_ARGS_H +/** \file BLI_args.h + * \ingroup bli + * \brief A general argument parsing module. + */ + 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, char **argv, void *data); +typedef int (*BA_ArgCallback)(int argc, const char **argv, void *data); -struct bArgs *BLI_argsInit(int argc, char **argv); +struct bArgs *BLI_argsInit(int argc, const char **argv); void BLI_argsFree(struct bArgs *ba); /* 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_argsAdd(struct bArgs *ba, int pass, char *short_arg, char *long_arg, char *doc, BA_ArgCallback cb, void *data); +void BLI_argsAdd(struct bArgs *ba, int pass, 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_argsAddCase(struct bArgs *ba, int pass, char *short_arg, int short_case, char *long_arg, int long_case, char *doc, BA_ArgCallback cb, void *data); +void BLI_argsAddCase(struct bArgs *ba, int pass, const char *short_arg, int short_case, const char *long_arg, int long_case, const char *doc, BA_ArgCallback cb, void *data); void BLI_argsParse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data); -void BLI_argsPrintArgDoc(struct bArgs *ba, char *arg); +void BLI_argsPrintArgDoc(struct bArgs *ba, const char *arg); void BLI_argsPrintOtherDoc(struct bArgs *ba); void BLI_argsPrint(struct bArgs *ba); -char **BLI_argsArgv(struct bArgs *ba); +const char **BLI_argsArgv(struct bArgs *ba); #endif |