error.h

Go to the documentation of this file.

/*
 * This work is licensed under a Creative Commons 
 * Attribution-Noncommercial-Share Alike 3.0 United States License.
 * 
 *    http://creativecommons.org/licenses/by-nc-sa/3.0/us/
 * 
 * You are free:
 * 
 *    to Share - to copy, distribute, display, and perform the work
 *    to Remix - to make derivative works
 * 
 * Under the following conditions:
 * 
 *    Attribution. You must attribute the work in the manner specified by the
 *    author or licensor (but not in any way that suggests that they endorse you
 *    or your use of the work).
 * 
 *    Noncommercial. You may not use this work for commercial purposes.
 * 
 *    Share Alike. If you alter, transform, or build upon this work, you may
 *    distribute the resulting work only under the same or similar license to
 *    this one.
 * 
 * For any reuse or distribution, you must make clear to others the license
 * terms of this work. The best way to do this is by including this header.
 * 
 * Any of the above conditions can be waived if you get permission from the
 * copyright holder.
 * 
 * Apart from the remix rights granted under this license, nothing in this
 * license impairs or restricts the author's moral rights.
 */


#ifndef ERROR_H
#define ERROR_H


#include <jwsc/config.h>

#include <stdlib.h>
#include <inttypes.h>


#ifdef __cplusplus
namespace jwsc {
extern "C" {
#endif


typedef enum
{
    ERROR_NO_MEMORY,     
    ERROR_IO,            
    ERROR_INV_ARG,       
    ERROR_CALC,          
    ERROR_NOT_READY,     
    ERROR_SOCKET,        
    ERROR_CONNECT        
}
Error_type;


typedef struct
{
    Error_type type;

    char* msg;

    char* file;

    unsigned int line;

    int code;
}
Error;


extern Error* error_no_memory;


Error* create_error
(
    Error_type   type, 
    const char*  file,
    unsigned int line,
    const char*  msg
);


void free_error(Error* e);


void print_error(const char* prefix, const Error* e);


void print_error_exit(const char* prefix, const Error* e);


void print_error_msg(const char* prefix, const char* msg);


void print_error_msg_exit(const char* prefix, const char* msg);


void print_errno(const char* prefix);


void print_errno_exit(const char* prefix);


uint32_t get_num_unhandled_errors();


#define  JWSC_EARG(msg)  create_error(ERROR_INV_ARG, __FILE__, __LINE__, msg)


#define  JWSC_EIO(msg)  create_error(ERROR_IO, __FILE__, __LINE__, msg)


#define  JWSC_ECALC(msg)  create_error(ERROR_CALC, __FILE__, __LINE__, msg)


#ifdef __cplusplus
}
}
#endif


#endif