/simpletypesystem/trunk : contents of src/Error.h at revision 27

: (revision 27)

To get this branch, use:

bzr branch
http://gegoxaren.bato24.eu/bzr/simpletypesystem/trunk

/*
Copyright (c) 2013-2014 Gustav Hartvigsson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

/** @file */

#ifndef __H_ERROR__
#define __H_ERROR__

#include "baseobject.h"
#include "defs.h"
#include "utils.h"
#include "Func.h"
#include <limits.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

BEGIN_DECLS

/**
 * An opaque datastructure that holds the SError's private data.
 */
typedef struct _SErrorPrivate SErrorPrivate;


/**
 * An SError is a data structure that inherits from SBaseObjectInstance.
 * 
 * An SError represents an error that can occur.
 */
typedef struct _SError {
  SObject parent;
  SErrorPrivate * priv; /** Pimple pointer to the private data. */
  
} SError;

/**
 * The error class is not changed, no extra methods are needed.
 */
typedef struct _SErrorClass {
  SObjectClass parent_class;
  
} SErrorClass;

/** @brief
 * The different error types.
 */
typedef enum {
  S_ERROR_NONE = 0, /**< Not on error */
  S_ERROR_INPUT_OUTPUT, /**< An I/O error */
  S_ERROR_OVERFLOW, /**< An Overflow error */
  S_ERROR_OTHER = INT_MAX - 1, /**< Some unknowned error */
  S_ERROR_NULL = INT_MAX /**< An NULL error */
} SErrorType;


/**
 * the constructor for the an SError
 */
SError * s_error_new (SErrorType error, char * message);

/**
 * This function calles the deinitize method of the object.
 */
void s_error_free (SError * self);

/**
 * This function returns the ErrorType of on object.
 */
SErrorType s_error_get_error_type (SError * self);

/**
 * This function prints the current error to stdout.
 */
void s_error_print_error (SError * self);

END_DECLS

#endif

5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	1	/*
5.2.7 by Gustav Hartvigsson * Switched licence to a more permisive one.	2	Copyright (c) 2013-2014 Gustav Hartvigsson
	3
	4	Permission is hereby granted, free of charge, to any person obtaining a copy
	5	of this software and associated documentation files (the "Software"), to deal
	6	in the Software without restriction, including without limitation the rights
	7	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	8	copies of the Software, and to permit persons to whom the Software is
	9	furnished to do so, subject to the following conditions:
	10
	11	The above copyright notice and this permission notice shall be included in
	12	all copies or substantial portions of the Software.
	13
	14	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	15	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	16	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	17	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	18	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	19	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	20	THE SOFTWARE.
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	21	*/
	22
	23	/** @file */
3 by Gustav Hartvigsson Fixed a few things...	24
	25	#ifndef __H_ERROR__
	26	#define __H_ERROR__
	27
	28	#include "baseobject.h"
5.2.8 by Gustav Hartvigsson * Copied over LinkedList and DynamicArray from c_sdl_js	29	#include "defs.h"
22 by Gustav Hartvigsson * Made code compile	30	#include "utils.h"
22 by Gustav Hartvigsson * Made code compile	31	#include "Func.h"
3 by Gustav Hartvigsson Fixed a few things...	32	#include <limits.h>
	33	#include <stdlib.h>
	34	#include <stdio.h>
	35	#include <string.h>
	36
22 by Gustav Hartvigsson * Made code compile	37	BEGIN_DECLS
22 by Gustav Hartvigsson * Made code compile	38
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	39	/**
	40	* An opaque datastructure that holds the SError's private data.
	41	*/
3 by Gustav Hartvigsson Fixed a few things...	42	typedef struct _SErrorPrivate SErrorPrivate;
3 by Gustav Hartvigsson Fixed a few things...	43
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	44
	45	/**
19 by Gustav Hartvigsson * Woops	46	* An SError is a data structure that inherits from SBaseObjectInstance.
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	47	*
	48	* An SError represents an error that can occur.
	49	*/
3 by Gustav Hartvigsson Fixed a few things...	50	typedef struct _SError {
22 by Gustav Hartvigsson * Made code compile	51	SObject parent;
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	52	SErrorPrivate * priv; /** Pimple pointer to the private data. */
3 by Gustav Hartvigsson Fixed a few things...	53
	54	} SError;
	55
	56	/**
	57	* The error class is not changed, no extra methods are needed.
	58	*/
	59	typedef struct _SErrorClass {
22 by Gustav Hartvigsson * Made code compile	60	SObjectClass parent_class;
3 by Gustav Hartvigsson Fixed a few things...	61
	62	} SErrorClass;
	63
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	64	/** @brief
	65	* The different error types.
	66	*/
3 by Gustav Hartvigsson Fixed a few things...	67	typedef enum {
8 by Gustav Hartvigsson * Fixed a DoxyGen error documentation error of an enum.	68	S_ERROR_NONE = 0, /*< Not on error /
	69	S_ERROR_INPUT_OUTPUT, /*< An I/O error /
	70	S_ERROR_OVERFLOW, /*< An Overflow error /
	71	S_ERROR_OTHER = INT_MAX - 1, /*< Some unknowned error /
	72	S_ERROR_NULL = INT_MAX /*< An NULL error /
3 by Gustav Hartvigsson Fixed a few things...	73	} SErrorType;
	74
	75
	76	/**
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	77	* the constructor for the an SError
3 by Gustav Hartvigsson Fixed a few things...	78	*/
	79	SError * s_error_new (SErrorType error, char * message);
	80
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	81	/**
	82	* This function calles the deinitize method of the object.
	83	*/
3 by Gustav Hartvigsson Fixed a few things...	84	void s_error_free (SError * self);
3 by Gustav Hartvigsson Fixed a few things...	85
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	86	/**
	87	* This function returns the ErrorType of on object.
	88	*/
3 by Gustav Hartvigsson Fixed a few things...	89	SErrorType s_error_get_error_type (SError * self);
3 by Gustav Hartvigsson Fixed a few things...	90
5.1.1 by Gustav Hartvigsson * Started work on making the code more prasable by DoxyGen.	91	/**
	92	* This function prints the current error to stdout.
	93	*/
3 by Gustav Hartvigsson Fixed a few things...	94	void s_error_print_error (SError * self);
3 by Gustav Hartvigsson Fixed a few things...	95
22 by Gustav Hartvigsson * Made code compile	96	END_DECLS
22 by Gustav Hartvigsson * Made code compile	97
3 by Gustav Hartvigsson Fixed a few things...	98	#endif