icalerror.h

Go to the documentation of this file.

/*======================================================================
  FILE: icalerror.h
  CREATOR: eric 09 May 1999

 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
======================================================================*/

#ifndef ICALERROR_H
#define ICALERROR_H

#include "libical_ical_export.h"

#include <stdbool.h>

#ifndef _MSC_VER
#pragma GCC visibility push(default)
#endif

typedef enum icalerrorenum
{
    ICAL_NO_ERROR = 0,

    ICAL_BADARG_ERROR,

    ICAL_NEWFAILED_ERROR,

    ICAL_ALLOCATION_ERROR,

    ICAL_THREADING_ERROR,

    ICAL_MALFORMEDDATA_ERROR,

    ICAL_PARSE_ERROR,

    ICAL_INTERNAL_ERROR, /* Like assert --internal consist. prob */

    ICAL_FILE_ERROR,

    ICAL_USAGE_ERROR,

    ICAL_UNIMPLEMENTED_ERROR,

    ICAL_UNKNOWN_ERROR /* Used for problems in input to icalerror_strerror() */
} icalerrorenum;
#ifndef _MSC_VER
#pragma GCC visibility pop
#endif

typedef enum icalerrorstate
{
    ICAL_ERROR_FATAL,

    ICAL_ERROR_NONFATAL,

    ICAL_ERROR_DEFAULT,

    ICAL_ERROR_UNKNOWN
} icalerrorstate;

LIBICAL_ICAL_EXPORT icalerrorenum *icalerror_icalerrno(void);

#define icalerrno (*(icalerror_icalerrno()))

LIBICAL_ICAL_EXPORT void icalerror_set_errno(icalerrorenum x);

LIBICAL_ICAL_EXPORT const char *icalerror_strerror(icalerrorenum e);

LIBICAL_ICAL_EXPORT const char *icalerror_perror(void);

LIBICAL_ICAL_EXPORT void icalerror_set_error_state(icalerrorenum error, icalerrorstate state);

LIBICAL_ICAL_EXPORT icalerrorstate icalerror_get_error_state(icalerrorenum error);

LIBICAL_ICAL_EXPORT icalerrorenum icalerror_error_from_string(const char *str);

LIBICAL_ICAL_EXPORT void icalerror_set_errors_are_fatal(bool fatal);

LIBICAL_ICAL_EXPORT bool icalerror_get_errors_are_fatal(void);

LIBICAL_ICAL_EXPORT void icalerror_clear_errno(void);
/* String interfaces to set an error to NONFATAL and restore it to its original value */

LIBICAL_ICAL_EXPORT icalerrorstate icalerror_supress(const char *error);

LIBICAL_ICAL_EXPORT void icalerror_restore(const char *error, icalerrorstate es);

LIBICAL_ICAL_EXPORT void icalerror_backtrace(void);

#endif /* !ICALERROR_H */