src/error.c

   1 /*
   2  * This file is part of the libsigrok project.
   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 <config.h>
  22 #include <libsigrok/libsigrok.h>
  23
  24 /**
  25  * @file
  26  *
  27  * Error handling in libsigrok.
  28  */
  29
  30 /**
  31  * @defgroup grp_error Error handling
  32  *
  33  * Error handling in libsigrok.
  34  *
  35  * libsigrok functions usually return @ref SR_OK upon success, or a negative
  36  * error code on failure.
  37  *
  38  * @{
  39  */
  40
  41 /**
  42  * Return a human-readable error string for the given libsigrok error code.
  43  *
  44  * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
  45  *
  46  * @return A const string containing a short, human-readable (English)
  47  *         description of the error, such as "memory allocation error".
  48  *         The string must NOT be free'd by the caller!
  49  *
  50  * @see sr_strerror_name
  51  *
  52  * @since 0.2.0
  53  */
  54 SR_API const char *sr_strerror(int error_code)
  55 {
  56         /*
  57          * Note: All defined SR_* error macros from libsigrok.h must have
  58          * an entry in this function, as well as in sr_strerror_name().
  59          */
  60
  61         switch (error_code) {
  62         case SR_OK:
  63                 return "no error";
  64         case SR_ERR:
  65                 return "generic/unspecified error";
  66         case SR_ERR_MALLOC:
  67                 return "memory allocation error";
  68         case SR_ERR_ARG:
  69                 return "invalid argument";
  70         case SR_ERR_BUG:
  71                 return "internal error";
  72         case SR_ERR_SAMPLERATE:
  73                 return "invalid samplerate";
  74         case SR_ERR_NA:
  75                 return "not applicable";
  76         case SR_ERR_DEV_CLOSED:
  77                 return "device closed but should be open";
  78         case SR_ERR_TIMEOUT:
  79                 return "timeout occurred";
  80         case SR_ERR_CHANNEL_GROUP:
  81                 return "no channel group specified";
  82         case SR_ERR_DATA:
  83                 return "data is invalid";
  84         case SR_ERR_IO:
  85                 return "input/output error";
  86         default:
  87                 return "unknown error";
  88         }
  89 }
  90
  91 /**
  92  * Return the "name" string of the given libsigrok error code.
  93  *
  94  * For example, the "name" of the SR_ERR_MALLOC error code is "SR_ERR_MALLOC",
  95  * the name of the SR_OK code is "SR_OK", and so on.
  96  *
  97  * This function can be used for various purposes where the "name" string of
  98  * a libsigrok error code is useful.
  99  *
 100  * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
 101  *
 102  * @return A const string containing the "name" of the error code as string.
 103  *         The string must NOT be free'd by the caller!
 104  *
 105  * @see sr_strerror
 106  *
 107  * @since 0.2.0
 108  */
 109 SR_API const char *sr_strerror_name(int error_code)
 110 {
 111         /*
 112          * Note: All defined SR_* error macros from libsigrok.h must have
 113          * an entry in this function, as well as in sr_strerror().
 114          */
 115
 116         switch (error_code) {
 117         case SR_OK:
 118                 return "SR_OK";
 119         case SR_ERR:
 120                 return "SR_ERR";
 121         case SR_ERR_MALLOC:
 122                 return "SR_ERR_MALLOC";
 123         case SR_ERR_ARG:
 124                 return "SR_ERR_ARG";
 125         case SR_ERR_BUG:
 126                 return "SR_ERR_BUG";
 127         case SR_ERR_SAMPLERATE:
 128                 return "SR_ERR_SAMPLERATE";
 129         case SR_ERR_NA:
 130                 return "SR_ERR_NA";
 131         case SR_ERR_DEV_CLOSED:
 132                 return "SR_ERR_DEV_CLOSED";
 133         case SR_ERR_TIMEOUT:
 134                 return "SR_ERR_TIMEOUT";
 135         case SR_ERR_CHANNEL_GROUP:
 136                 return "SR_ERR_CHANNEL_GROUP";
 137         case SR_ERR_DATA:
 138                 return "SR_ERR_DATA";
 139         case SR_ERR_IO:
 140                 return "SR_ERR_IO";
 141         default:
 142                 return "unknown error code";
 143         }
 144 }
 145
 146 /** @} */