]>
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 | * |
51 | * @since 0.2.0 | |
b5a8e848 UH |
52 | */ |
53 | SR_API const char *sr_strerror(int error_code) | |
54 | { | |
b5a8e848 | 55 | /* |
409a811b | 56 | * Note: All defined SR_* error macros from libsigrok.h must have |
b5a8e848 UH |
57 | * an entry in this function, as well as in sr_strerror_name(). |
58 | */ | |
59 | ||
60 | switch (error_code) { | |
61 | case SR_OK: | |
f05e7b7a | 62 | return "no error"; |
b5a8e848 | 63 | case SR_ERR: |
f05e7b7a | 64 | return "generic/unspecified error"; |
b5a8e848 | 65 | case SR_ERR_MALLOC: |
f05e7b7a | 66 | return "memory allocation error"; |
0223135b | 67 | case SR_ERR_ARG: |
f05e7b7a | 68 | return "invalid argument"; |
b5a8e848 | 69 | case SR_ERR_BUG: |
f05e7b7a | 70 | return "internal error"; |
b5a8e848 | 71 | case SR_ERR_SAMPLERATE: |
f05e7b7a | 72 | return "invalid samplerate"; |
0223135b | 73 | case SR_ERR_NA: |
f05e7b7a | 74 | return "not applicable"; |
409a811b | 75 | case SR_ERR_DEV_CLOSED: |
f05e7b7a | 76 | return "device closed but should be open"; |
3e62166e | 77 | case SR_ERR_TIMEOUT: |
f05e7b7a | 78 | return "timeout occurred"; |
3220827c UH |
79 | case SR_ERR_PROBE_GROUP: |
80 | return "no probe group specified"; | |
b5a8e848 | 81 | default: |
f05e7b7a | 82 | return "unknown error"; |
b5a8e848 | 83 | } |
b5a8e848 UH |
84 | } |
85 | ||
86 | /** | |
87 | * Return the "name" string of the given libsigrok error code. | |
88 | * | |
89 | * For example, the "name" of the SR_ERR_MALLOC error code is "SR_ERR_MALLOC", | |
90 | * the name of the SR_OK code is "SR_OK", and so on. | |
91 | * | |
92 | * This function can be used for various purposes where the "name" string of | |
93 | * a libsigrok error code is useful. | |
94 | * | |
95 | * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC. | |
9fb5f2df | 96 | * |
b5a8e848 UH |
97 | * @return A const string containing the "name" of the error code as string. |
98 | * The string must NOT be free'd by the caller! | |
9fb5f2df | 99 | * |
b5a8e848 | 100 | * @see sr_strerror |
9fb5f2df UH |
101 | * |
102 | * @since 0.2.0 | |
b5a8e848 UH |
103 | */ |
104 | SR_API const char *sr_strerror_name(int error_code) | |
105 | { | |
b5a8e848 | 106 | /* |
409a811b | 107 | * Note: All defined SR_* error macros from libsigrok.h must have |
b5a8e848 UH |
108 | * an entry in this function, as well as in sr_strerror(). |
109 | */ | |
110 | ||
111 | switch (error_code) { | |
112 | case SR_OK: | |
f05e7b7a | 113 | return "SR_OK"; |
b5a8e848 | 114 | case SR_ERR: |
f05e7b7a | 115 | return "SR_ERR"; |
b5a8e848 | 116 | case SR_ERR_MALLOC: |
f05e7b7a | 117 | return "SR_ERR_MALLOC"; |
0223135b | 118 | case SR_ERR_ARG: |
f05e7b7a | 119 | return "SR_ERR_ARG"; |
b5a8e848 | 120 | case SR_ERR_BUG: |
f05e7b7a | 121 | return "SR_ERR_BUG"; |
b5a8e848 | 122 | case SR_ERR_SAMPLERATE: |
f05e7b7a | 123 | return "SR_ERR_SAMPLERATE"; |
0223135b | 124 | case SR_ERR_NA: |
f05e7b7a | 125 | return "SR_ERR_NA"; |
409a811b | 126 | case SR_ERR_DEV_CLOSED: |
f05e7b7a | 127 | return "SR_ERR_DEV_CLOSED"; |
3e62166e | 128 | case SR_ERR_TIMEOUT: |
f05e7b7a | 129 | return "SR_ERR_TIMEOUT"; |
3220827c UH |
130 | case SR_ERR_PROBE_GROUP: |
131 | return "SR_PROBE_GROUP"; | |
b5a8e848 | 132 | default: |
f05e7b7a | 133 | return "unknown error code"; |
b5a8e848 | 134 | } |
b5a8e848 | 135 | } |
7b870c38 UH |
136 | |
137 | /** @} */ |