clap_error.h

Go to the documentation of this file.

 
#ifndef CLAP_ERROR_H
#define CLAP_ERROR_H
 
#include <stdbool.h>
#include <stdarg.h>
#include <clap/clap_export.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Error codes */
#define CLAP_ERR_NONE                0
#define CLAP_ERR_INVALID_ARGUMENT    1
#define CLAP_ERR_MISSING_VALUE       2
#define CLAP_ERR_TYPE_CONVERSION     3
#define CLAP_ERR_INVALID_CHOICE      4
#define CLAP_ERR_MUTUALLY_EXCLUSIVE  5
#define CLAP_ERR_REQUIRED_MISSING    6
#define CLAP_ERR_UNRECOGNIZED        7
#define CLAP_ERR_TOO_MANY_ARGS       8
#define CLAP_ERR_TOO_FEW_ARGS        9
#define CLAP_ERR_MEMORY             10
#define CLAP_ERR_SUBCOMMAND_FAILED  11
#define CLAP_ERR_DEPENDENCY_VIOLATION 12
#define CLAP_ERR_CUSTOM             100
 
typedef struct clap_error_s {
    int code;                       
    char message[512];              
    const char *argument_name;      
    const char *invalid_value;      
    const char *subcommand_name;    
} clap_error_t;
 
CLAP_EXPORT void clap_error_set(clap_error_t *error, int code, const char *format, ...);
 
CLAP_EXPORT int clap_error_code(const clap_error_t *error);
 
CLAP_EXPORT const char* clap_error_message(const clap_error_t *error);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CLAP_ERROR_H */