error.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */
 
/*
 * Copyright 2018-2022 Joel E. Anderson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __STUMPLESS_ERROR_H
#  define __STUMPLESS_ERROR_H
 
#include <stdbool.h>
#include <stdio.h>
#include <stumpless/config.h>
#include <stumpless/generator.h>
 
#  ifdef __cplusplus
extern "C" {
#  endif
 
#define STUMPLESS_FOREACH_ERROR(ERROR)  \
\
  ERROR(STUMPLESS_ADDRESS_FAILURE, 0) \
\
  ERROR(STUMPLESS_ARGUMENT_EMPTY, 1)  \
\
  ERROR(STUMPLESS_ARGUMENT_TOO_BIG, 2)  \
\
  ERROR(STUMPLESS_DUPLICATE_ELEMENT, 3) \
\
  ERROR(STUMPLESS_ELEMENT_NOT_FOUND, 4) \
\
  ERROR(STUMPLESS_FILE_OPEN_FAILURE, 5) \
\
  ERROR(STUMPLESS_FILE_WRITE_FAILURE, 6)  \
\
  ERROR(STUMPLESS_INDEX_OUT_OF_BOUNDS, 7) \
\
  ERROR(STUMPLESS_INVALID_FACILITY, 8)  \
\
  ERROR(STUMPLESS_INVALID_ID, 9)  \
\
  ERROR(STUMPLESS_INVALID_SEVERITY, 10) \
\
  ERROR(STUMPLESS_MEMORY_ALLOCATION_FAILURE, 11)  \
\
  ERROR(STUMPLESS_NETWORK_PROTOCOL_UNSUPPORTED, 12) \
\
  ERROR(STUMPLESS_PARAM_NOT_FOUND, 13)  \
\
  ERROR(STUMPLESS_SOCKET_BIND_FAILURE, 14)  \
\
  ERROR(STUMPLESS_SOCKET_CONNECT_FAILURE, 15) \
\
  ERROR(STUMPLESS_SOCKET_FAILURE, 16) \
\
  ERROR(STUMPLESS_SOCKET_SEND_FAILURE, 17)  \
\
  ERROR(STUMPLESS_STREAM_WRITE_FAILURE, 18) \
\
  ERROR(STUMPLESS_TARGET_INCOMPATIBLE, 19)  \
\
  ERROR(STUMPLESS_TARGET_UNSUPPORTED, 20) \
\
  ERROR(STUMPLESS_TRANSPORT_PROTOCOL_UNSUPPORTED, 21) \
\
  ERROR(STUMPLESS_WINDOWS_EVENT_LOG_CLOSE_FAILURE, 22)  \
\
  ERROR(STUMPLESS_WINDOWS_EVENT_LOG_OPEN_FAILURE, 23) \
\
  ERROR(STUMPLESS_INVALID_ENCODING, 24) \
\
  ERROR(STUMPLESS_GETHOSTNAME_FAILURE, 25 ) \
\
  ERROR(STUMPLESS_FUNCTION_TARGET_FAILURE, 26 ) \
\
  ERROR( STUMPLESS_JOURNALD_FAILURE, 27 ) \
\
  ERROR( STUMPLESS_WINDOWS_FAILURE, 28 )
 
 
enum stumpless_error_id {
  STUMPLESS_FOREACH_ERROR(STUMPLESS_GENERATE_ENUM)
};
 
 
struct stumpless_error {
  enum stumpless_error_id id; 
  const char *message; 
  int code; 
  const char *code_type; 
};
 
STUMPLESS_PUBLIC_FUNCTION
const struct stumpless_error *
stumpless_get_error( void );
 
STUMPLESS_PUBLIC_FUNCTION
enum stumpless_error_id
stumpless_get_error_id( const struct stumpless_error *err );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_error_id_string( enum stumpless_error_id id );
 
STUMPLESS_PUBLIC_FUNCTION
FILE *
stumpless_get_error_stream( void );
 
STUMPLESS_PUBLIC_FUNCTION
bool
stumpless_has_error( void );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_perror( const char *prefix );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_set_error_stream( FILE *stream );
 
#  ifdef __cplusplus
}                               /* extern "C" */
#  endif
 
#endif                          /* __STUMPLESS_ERROR_H */