3 * Copyright © 2013 Hans de Goede <hdegoede@redhat.com>
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.
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.
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
25 #if defined(HAVE_STRINGS_H)
32 #define strncasecmp _strnicmp
35 static size_t usbi_locale = 0;
37 /** \ingroup libusb_misc
38 * How to add a new \ref libusb_strerror() translation:
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
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:
52 * }, { / * Chinese (zh) * /
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>
63 static const char* usbi_locale_supported[] = { "en", "nl", "fr", "ru", "de" };
64 static const char* usbi_localized_errors[ARRAYSIZE(usbi_locale_supported)][LIBUSB_ERROR_COUNT] = {
69 "Access denied (insufficient permissions)",
70 "No such device (it may have been disconnected)",
73 "Operation timed out",
76 "System call interrupted (perhaps due to signal)",
77 "Insufficient memory",
78 "Operation not supported or unimplemented on this platform",
82 "Invoer-/uitvoerfout",
84 "Toegang geweigerd (onvoldoende toegangsrechten)",
85 "Apparaat bestaat niet (verbinding met apparaat verbroken?)",
87 "Apparaat of hulpbron is bezig",
91 "Onderbroken systeemaanroep",
92 "Onvoldoende geheugen beschikbaar",
93 "Bewerking wordt niet ondersteund",
95 }, { /* French (fr) */
97 "Erreur d'entrée/sortie",
99 "Accès refusé (permissions insuffisantes)",
100 "Périphérique introuvable (peut-être déconnecté)",
101 "Elément introuvable",
102 "Resource déjà occupée",
106 "Appel système abandonné (peut-être à cause d’un signal)",
107 "Mémoire insuffisante",
108 "Opération non supportée or non implémentée sur cette plateforme",
110 }, { /* Russian (ru) */
112 "Ошибка ввода/вывода",
114 "Доступ запрещён (не хватает прав)",
115 "Устройство отсутствует (возможно, оно было отсоединено)",
118 "Истекло время ожидания операции",
121 "Системный вызов прерван (возможно, сигналом)",
123 "Операция не поддерживается данной платформой",
126 }, { /* German (de) */
128 "Eingabe-/Ausgabefehler",
129 "Ungültiger Parameter",
130 "Keine Berechtigung (Zugriffsrechte fehlen)",
131 "Kein passendes Gerät gefunden (es könnte entfernt worden sein)",
132 "Entität nicht gefunden",
133 "Die Ressource ist belegt",
134 "Die Wartezeit für die Operation ist abgelaufen",
135 "Mehr Daten empfangen als erwartet",
136 "Datenübergabe unterbrochen (broken pipe)",
137 "Unterbrechung während des Betriebssystemaufrufs",
138 "Nicht genügend Hauptspeicher verfügbar",
139 "Die Operation wird nicht unterstützt oder ist auf dieser Platform nicht implementiert",
140 "Allgemeiner Fehler",
144 /** \ingroup libusb_misc
145 * Set the language, and only the language, not the encoding! used for
146 * translatable libusb messages.
148 * This takes a locale string in the default setlocale format: lang[-region]
149 * or lang[_country_region][.codeset]. Only the lang part of the string is
150 * used, and only 2 letter ISO 639-1 codes are accepted for it, such as "de".
151 * The optional region, country_region or codeset parts are ignored. This
152 * means that functions which return translatable strings will NOT honor the
153 * specified encoding.
154 * All strings returned are encoded as UTF-8 strings.
156 * If libusb_setlocale() is not called, all messages will be in English.
158 * The following functions return translatable strings: libusb_strerror().
159 * Note that the libusb log messages controlled through libusb_set_debug()
160 * are not translated, they are always in English.
162 * For POSIX UTF-8 environments if you want libusb to follow the standard
163 * locale settings, call libusb_setlocale(setlocale(LC_MESSAGES, NULL)),
164 * after your app has done its locale setup.
166 * \param locale locale-string in the form of lang[_country_region][.codeset]
167 * or lang[-region], where lang is a 2 letter ISO 639-1 code
168 * \returns LIBUSB_SUCCESS on success
169 * \returns LIBUSB_ERROR_INVALID_PARAM if the locale doesn't meet the requirements
170 * \returns LIBUSB_ERROR_NOT_FOUND if the requested language is not supported
171 * \returns a LIBUSB_ERROR code on other errors
174 int API_EXPORTED libusb_setlocale(const char *locale)
178 if ( (locale == NULL) || (strlen(locale) < 2)
179 || ((strlen(locale) > 2) && (locale[2] != '-') && (locale[2] != '_') && (locale[2] != '.')) )
180 return LIBUSB_ERROR_INVALID_PARAM;
182 for (i=0; i<ARRAYSIZE(usbi_locale_supported); i++) {
183 if (strncasecmp(usbi_locale_supported[i], locale, 2) == 0)
186 if (i >= ARRAYSIZE(usbi_locale_supported)) {
187 return LIBUSB_ERROR_NOT_FOUND;
192 return LIBUSB_SUCCESS;
195 /** \ingroup libusb_misc
196 * Returns a constant string with a short description of the given error code,
197 * this description is intended for displaying to the end user and will be in
198 * the language set by libusb_setlocale().
200 * The returned string is encoded in UTF-8.
202 * The messages always start with a capital letter and end without any dot.
203 * The caller must not free() the returned string.
205 * \param errcode the error code whose description is desired
206 * \returns a short description of the error code in UTF-8 encoding
208 DEFAULT_VISIBILITY const char* LIBUSB_CALL libusb_strerror(enum libusb_error errcode)
210 int errcode_index = -errcode;
212 if ((errcode_index < 0) || (errcode_index >= LIBUSB_ERROR_COUNT)) {
213 /* "Other Error", which should always be our last message, is returned */
214 errcode_index = LIBUSB_ERROR_COUNT - 1;
217 return usbi_localized_errors[usbi_locale][errcode_index];