error.c

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