Home | History | Annotate | Download | only in libusb
      1 /*
      2  * libusb strerror code
      3  * Copyright  2013 Hans de Goede <hdegoede (at) redhat.com>
      4  *
      5  * This library is free software; you can redistribute it and/or
      6  * modify it under the terms of the GNU Lesser General Public
      7  * License as published by the Free Software Foundation; either
      8  * version 2.1 of the License, or (at your option) any later version.
      9  *
     10  * This library is distributed in the hope that it will be useful,
     11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
     12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     13  * Lesser General Public License for more details.
     14  *
     15  * You should have received a copy of the GNU Lesser General Public
     16  * License along with this library; if not, write to the Free Software
     17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
     18  */
     19 
     20 #include <config.h>
     21 
     22 #include <locale.h>
     23 #include <stdlib.h>
     24 #include <string.h>
     25 #if defined(HAVE_STRINGS_H)
     26 #include <strings.h>
     27 #endif
     28 
     29 #include "libusbi.h"
     30 
     31 #if defined(_MSC_VER)
     32 #define strncasecmp _strnicmp
     33 #endif
     34 
     35 static size_t usbi_locale = 0;
     36 
     37 /** \ingroup libusb_misc
     38  * How to add a new \ref libusb_strerror() translation:
     39  * <ol>
     40  * <li> Download the latest \c strerror.c from:<br>
     41  *      https://raw.github.com/libusb/libusb/master/libusb/sterror.c </li>
     42  * <li> Open the file in an UTF-8 capable editor </li>
     43  * <li> Add the 2 letter <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1</a>
     44  *      code for your locale at the end of \c usbi_locale_supported[]<br>
     45  *    Eg. for Chinese, you would add "zh" so that:
     46  *    \code... usbi_locale_supported[] = { "en", "nl", "fr" };\endcode
     47  *    becomes:
     48  *    \code... usbi_locale_supported[] = { "en", "nl", "fr", "zh" };\endcode </li>
     49  * <li> Copy the <tt>{ / * English (en) * / ... }</tt> section and add it at the end of \c usbi_localized_errors<br>
     50  *    Eg. for Chinese, the last section of \c usbi_localized_errors could look like:
     51  *    \code
     52  *     }, { / * Chinese (zh) * /
     53  *         "Success",
     54  *         ...
     55  *         "Other error",
     56  *     }
     57  * };\endcode </li>
     58  * <li> Translate each of the English messages from the section you copied into your language </li>
     59  * <li> Save the file (in UTF-8 format) and send it to \c libusb-devel\@lists.sourceforge.net </li>
     60  * </ol>
     61  */
     62 
     63 static const char* usbi_locale_supported[] = { "en", "nl", "fr", "ru" };
     64 static const char* usbi_localized_errors[ARRAYSIZE(usbi_locale_supported)][LIBUSB_ERROR_COUNT] = {
     65 	{ /* English (en) */
     66 		"Success",
     67 		"Input/Output Error",
     68 		"Invalid parameter",
     69 		"Access denied (insufficient permissions)",
     70 		"No such device (it may have been disconnected)",
     71 		"Entity not found",
     72 		"Resource busy",
     73 		"Operation timed out",
     74 		"Overflow",
     75 		"Pipe error",
     76 		"System call interrupted (perhaps due to signal)",
     77 		"Insufficient memory",
     78 		"Operation not supported or unimplemented on this platform",
     79 		"Other error",
     80 	}, { /* Dutch (nl) */
     81 		"Gelukt",
     82 		"Invoer-/uitvoerfout",
     83 		"Ongeldig argument",
     84 		"Toegang geweigerd (onvoldoende toegangsrechten)",
     85 		"Apparaat bestaat niet (verbinding met apparaat verbroken?)",
     86 		"Niet gevonden",
     87 		"Apparaat of hulpbron is bezig",
     88 		"Bewerking verlopen",
     89 		"Waarde is te groot",
     90 		"Gebroken pijp",
     91 		"Onderbroken systeemaanroep",
     92 		"Onvoldoende geheugen beschikbaar",
     93 		"Bewerking wordt niet ondersteund",
     94 		"Andere fout",
     95 	}, { /* French (fr) */
     96 		"Succs",
     97 		"Erreur d'entre/sortie",
     98 		"Paramtre invalide",
     99 		"Accs refus (permissions insuffisantes)",
    100 		"Priphrique introuvable (peut-tre dconnect)",
    101 		"Elment introuvable",
    102 		"Resource dj occupe",
    103 		"Operation expire",
    104 		"Dbordement",
    105 		"Erreur de pipe",
    106 		"Appel systme abandonn (peut-tre  cause dun signal)",
    107 		"Mmoire insuffisante",
    108 		"Opration non supporte or non implmente sur cette plateforme",
    109 		"Autre erreur",
    110 	}, { /* Russian (ru) */
    111 		"",
    112 		" /",
    113 		" ",
    114 		"  (  )",
    115 		"  (,   )",
    116 		"  ",
    117 		" ",
    118 		"   ",
    119 		"",
    120 		" ",
    121 		"   (, )",
    122 		" ",
    123 		"    ",
    124 		" "
    125 	}
    126 };
    127 
    128 /** \ingroup libusb_misc
    129  * Set the language, and only the language, not the encoding! used for
    130  * translatable libusb messages.
    131  *
    132  * This takes a locale string in the default setlocale format: lang[-region]
    133  * or lang[_country_region][.codeset]. Only the lang part of the string is
    134  * used, and only 2 letter ISO 639-1 codes are accepted for it, such as "de".
    135  * The optional region, country_region or codeset parts are ignored. This
    136  * means that functions which return translatable strings will NOT honor the
    137  * specified encoding.
    138  * All strings returned are encoded as UTF-8 strings.
    139  *
    140  * If libusb_setlocale() is not called, all messages will be in English.
    141  *
    142  * The following functions return translatable strings: libusb_strerror().
    143  * Note that the libusb log messages controlled through libusb_set_debug()
    144  * are not translated, they are always in English.
    145  *
    146  * For POSIX UTF-8 environments if you want libusb to follow the standard
    147  * locale settings, call libusb_setlocale(setlocale(LC_MESSAGES, NULL)),
    148  * after your app has done its locale setup.
    149  *
    150  * \param locale locale-string in the form of lang[_country_region][.codeset]
    151  * or lang[-region], where lang is a 2 letter ISO 639-1 code
    152  * \returns LIBUSB_SUCCESS on success
    153  * \returns LIBUSB_ERROR_INVALID_PARAM if the locale doesn't meet the requirements
    154  * \returns LIBUSB_ERROR_NOT_FOUND if the requested language is not supported
    155  * \returns a LIBUSB_ERROR code on other errors
    156  */
    157 
    158 int API_EXPORTED libusb_setlocale(const char *locale)
    159 {
    160 	size_t i;
    161 
    162 	if ( (locale == NULL) || (strlen(locale) < 2)
    163 	  || ((strlen(locale) > 2) && (locale[2] != '-') && (locale[2] != '_') && (locale[2] != '.')) )
    164 		return LIBUSB_ERROR_INVALID_PARAM;
    165 
    166 	for (i=0; i<ARRAYSIZE(usbi_locale_supported); i++) {
    167 		if (strncasecmp(usbi_locale_supported[i], locale, 2) == 0)
    168 			break;
    169 	}
    170 	if (i >= ARRAYSIZE(usbi_locale_supported)) {
    171 		return LIBUSB_ERROR_NOT_FOUND;
    172 	}
    173 
    174 	usbi_locale = i;
    175 
    176 	return LIBUSB_SUCCESS;
    177 }
    178 
    179 /** \ingroup libusb_misc
    180  * Returns a constant string with a short description of the given error code,
    181  * this description is intended for displaying to the end user and will be in
    182  * the language set by libusb_setlocale().
    183  *
    184  * The returned string is encoded in UTF-8.
    185  *
    186  * The messages always start with a capital letter and end without any dot.
    187  * The caller must not free() the returned string.
    188  *
    189  * \param errcode the error code whose description is desired
    190  * \returns a short description of the error code in UTF-8 encoding
    191  */
    192 DEFAULT_VISIBILITY const char* LIBUSB_CALL libusb_strerror(enum libusb_error errcode)
    193 {
    194 	int errcode_index = -errcode;
    195 
    196 	if ((errcode_index < 0) || (errcode_index >= LIBUSB_ERROR_COUNT)) {
    197 		/* "Other Error", which should always be our last message, is returned */
    198 		errcode_index = LIBUSB_ERROR_COUNT - 1;
    199 	}
    200 
    201 	return usbi_localized_errors[usbi_locale][errcode_index];
    202 }
    203