920e709069
When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608
78 lines
2.2 KiB
C
78 lines
2.2 KiB
C
/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
* \brief A general argument parsing module.
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct bArgs;
|
|
typedef struct bArgs bArgs;
|
|
|
|
#include <stdarg.h> /* For `va_list`. */
|
|
#include <stdbool.h>
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
/**
|
|
* 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);
|
|
|
|
typedef void (*bArgPrintFn)(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);
|
|
|
|
/** 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 *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);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|