BLI_args.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
struct bArgs;
 
#include <stdarg.h> /* For `va_list`. */
#include <stdbool.h>
 
#include "BLI_compiler_attrs.h"

using BA_ArgCallback = int (*)(int argc, const char **argv, void *data);
 
struct bArgs *BLI_args_create(int argc, const char **argv);
void BLI_args_destroy(struct bArgs *ba);
 
using bArgPrintFn = void (*)(void *user_data, const char *format, va_list args);
void BLI_args_printf(struct bArgs *ba, const char *format, ...);
void BLI_args_print_fn_set(struct bArgs *ba,
                           ATTR_PRINTF_FORMAT(2, 0) bArgPrintFn print_fn,
                           void *user_data);

void BLI_args_pass_set(struct bArgs *ba, int current_pass);

void BLI_args_add(struct bArgs *ba,
                  const char *short_arg,
                  const char *long_arg,
                  const char *doc,
                  BA_ArgCallback cb,
                  void *data);

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 *default_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(const struct bArgs *ba);