[libsigrok.git] / error.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include "libsigrok.h"

/**
 * @file
 *
 * Error handling in libsigrok.
 */

/**
 * @defgroup grp_error Error handling
 *
 * Error handling in libsigrok.
 *
 * libsigrok functions usually return @ref SR_OK upon success, or a negative
 * error code on failure.
 *
 * @{
 */

/**
 * Return a human-readable error string for the given libsigrok error code.
 *
 * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
 *
 * @return A const string containing a short, human-readable (English)
 *         description of the error, such as "memory allocation error".
 *         The string must NOT be free'd by the caller!
 *
 * @see sr_strerror_name
 *
 * @since 0.2.0
 */
SR_API const char *sr_strerror(int error_code)
{
	const char *str;

	/*
	 * Note: All defined SR_* error macros from libsigrok.h must have
	 * an entry in this function, as well as in sr_strerror_name().
	 */

	switch (error_code) {
	case SR_OK:
		str = "no error";
		break;
	case SR_ERR:
		str = "generic/unspecified error";
		break;
	case SR_ERR_MALLOC:
		str = "memory allocation error";
		break;
	case SR_ERR_ARG:
		str = "invalid argument";
		break;
	case SR_ERR_BUG:
		str = "internal error";
		break;
	case SR_ERR_SAMPLERATE:
		str = "invalid samplerate";
		break;
	case SR_ERR_NA:
		str = "not applicable";
		break;
	case SR_ERR_DEV_CLOSED:
		str = "device closed but should be open";
		break;
	default:
		str = "unknown error";
		break;
	}

	return str;
}

/**
 * Return the "name" string of the given libsigrok error code.
 *
 * For example, the "name" of the SR_ERR_MALLOC error code is "SR_ERR_MALLOC",
 * the name of the SR_OK code is "SR_OK", and so on.
 *
 * This function can be used for various purposes where the "name" string of
 * a libsigrok error code is useful.
 *
 * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
 *
 * @return A const string containing the "name" of the error code as string.
 *         The string must NOT be free'd by the caller!
 *
 * @see sr_strerror
 *
 * @since 0.2.0
 */
SR_API const char *sr_strerror_name(int error_code)
{
	const char *str;

	/*
	 * Note: All defined SR_* error macros from libsigrok.h must have
	 * an entry in this function, as well as in sr_strerror().
	 */

	switch (error_code) {
	case SR_OK:
		str = "SR_OK";
		break;
	case SR_ERR:
		str = "SR_ERR";
		break;
	case SR_ERR_MALLOC:
		str = "SR_ERR_MALLOC";
		break;
	case SR_ERR_ARG:
		str = "SR_ERR_ARG";
		break;
	case SR_ERR_BUG:
		str = "SR_ERR_BUG";
		break;
	case SR_ERR_SAMPLERATE:
		str = "SR_ERR_SAMPLERATE";
		break;
	case SR_ERR_NA:
		str = "SR_ERR_NA";
		break;
	case SR_ERR_DEV_CLOSED:
		str = "SR_ERR_DEV_CLOSED";
		break;
	default:
		str = "unknown error code";
		break;
	}

	return str;
}

/** @} */
Commit	Line	Data
b5a8e848	1	/*
50985c20	2	* This file is part of the libsigrok project.
b5a8e848 UH	3	*
	4	* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include "libsigrok.h"
	22
393fb9cb UH	23	/**
	24	* @file
	25	*
	26	* Error handling in libsigrok.
	27	*/
	28
7b870c38 UH	29	/**
	30	* @defgroup grp_error Error handling
	31	*
	32	* Error handling in libsigrok.
	33	*
f21193fa UH	34	* libsigrok functions usually return @ref SR_OK upon success, or a negative
	35	* error code on failure.
	36	*
7b870c38 UH	37	* @{
	38	*/
	39
b5a8e848 UH	40	/**
	41	* Return a human-readable error string for the given libsigrok error code.
	42	*
	43	* @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
9fb5f2df	44	*
b5a8e848 UH	45	* @return A const string containing a short, human-readable (English)
	46	* description of the error, such as "memory allocation error".
	47	* The string must NOT be free'd by the caller!
9fb5f2df	48	*
b5a8e848	49	* @see sr_strerror_name
9fb5f2df UH	50	*
9fb5f2df UH	51	* @since 0.2.0
b5a8e848 UH	52	*/
	53	SR_API const char *sr_strerror(int error_code)
	54	{
	55	const char *str;
	56
	57	/*
409a811b	58	* Note: All defined SR_* error macros from libsigrok.h must have
b5a8e848 UH	59	* an entry in this function, as well as in sr_strerror_name().
	60	*/
	61
	62	switch (error_code) {
	63	case SR_OK:
	64	str = "no error";
	65	break;
	66	case SR_ERR:
	67	str = "generic/unspecified error";
	68	break;
	69	case SR_ERR_MALLOC:
	70	str = "memory allocation error";
	71	break;
0223135b UH	72	case SR_ERR_ARG:
	73	str = "invalid argument";
	74	break;
b5a8e848 UH	75	case SR_ERR_BUG:
	76	str = "internal error";
	77	break;
	78	case SR_ERR_SAMPLERATE:
	79	str = "invalid samplerate";
	80	break;
0223135b UH	81	case SR_ERR_NA:
	82	str = "not applicable";
	83	break;
409a811b UH	84	case SR_ERR_DEV_CLOSED:
	85	str = "device closed but should be open";
	86	break;
b5a8e848 UH	87	default:
	88	str = "unknown error";
	89	break;
	90	}
	91
	92	return str;
	93	}
	94
	95	/**
	96	* Return the "name" string of the given libsigrok error code.
	97	*
	98	* For example, the "name" of the SR_ERR_MALLOC error code is "SR_ERR_MALLOC",
	99	* the name of the SR_OK code is "SR_OK", and so on.
	100	*
	101	* This function can be used for various purposes where the "name" string of
	102	* a libsigrok error code is useful.
	103	*
	104	* @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
9fb5f2df	105	*
b5a8e848 UH	106	* @return A const string containing the "name" of the error code as string.
b5a8e848 UH	107	* The string must NOT be free'd by the caller!
9fb5f2df	108	*
b5a8e848	109	* @see sr_strerror
9fb5f2df UH	110	*
9fb5f2df UH	111	* @since 0.2.0
b5a8e848 UH	112	*/
	113	SR_API const char *sr_strerror_name(int error_code)
	114	{
	115	const char *str;
	116
	117	/*
409a811b	118	* Note: All defined SR_* error macros from libsigrok.h must have
b5a8e848 UH	119	* an entry in this function, as well as in sr_strerror().
	120	*/
	121
	122	switch (error_code) {
	123	case SR_OK:
	124	str = "SR_OK";
	125	break;
	126	case SR_ERR:
	127	str = "SR_ERR";
	128	break;
	129	case SR_ERR_MALLOC:
	130	str = "SR_ERR_MALLOC";
	131	break;
0223135b UH	132	case SR_ERR_ARG:
	133	str = "SR_ERR_ARG";
	134	break;
b5a8e848 UH	135	case SR_ERR_BUG:
	136	str = "SR_ERR_BUG";
	137	break;
	138	case SR_ERR_SAMPLERATE:
	139	str = "SR_ERR_SAMPLERATE";
	140	break;
0223135b UH	141	case SR_ERR_NA:
	142	str = "SR_ERR_NA";
	143	break;
409a811b UH	144	case SR_ERR_DEV_CLOSED:
	145	str = "SR_ERR_DEV_CLOSED";
	146	break;
b5a8e848 UH	147	default:
	148	str = "unknown error code";
	149	break;
	150	}
	151
	152	return str;
	153	}
7b870c38 UH	154
7b870c38 UH	155	/** @} */