doc/api: mention "UTF-8" in char/string comparison functions

ReleaseNotes.adoc

@@ -24,7 +24,7 @@ https://weechat.org/files/changelog/ChangeLog-devel.html[ChangeLog]
 === Return code of string comparison functions
 
 The following functions now return arithmetic result of subtracting the last
-compared char in string2 from the last compared char in string1:
+compared UTF-8 char in string2 from the last compared UTF-8 char in string1:
 
 * string_charcmp
 * string_charcasecmp

doc/en/weechat_plugin_api.en.adoc

@@ -710,8 +710,8 @@ Arguments:
 * _string1_: first string for comparison
 * _string2_: second string for comparison
 
-Return value: arithmetic result of subtracting the first char in _string2_ from
-the first char in _string1_:
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+from the first UTF-8 char in _string1_:
 
 * < 0 if char1 < char2
 * 0 if char1 == char2
@@ -750,8 +750,9 @@ Arguments:
 * _string1_: first string for comparison
 * _string2_: second string for comparison
 
-Return value: arithmetic result of subtracting the first char in _string2_
-(converted to lowercase) from the first char in _string1_ (converted to lowercase):
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+(converted to lowercase) from the first UTF-8 char in _string1_ (converted to
+lowercase):
 
 * < 0 if char1 < char2
 * 0 if char1 == char2
@@ -790,8 +791,8 @@ Arguments:
 * _string1_: first string for comparison
 * _string2_: second string for comparison
 
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 * < 0 if string1 < string2
@@ -836,8 +837,8 @@ Arguments:
 [NOTE]
 Values 29 and 30 are used by some protocols like IRC.
 
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 * < 0 if string1 < string2
@@ -878,8 +879,8 @@ Arguments:
 * _string2_: second string for comparison
 * _max_: max chars to compare
 
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 * < 0 if string1 < string2
@@ -923,8 +924,8 @@ Arguments:
 [NOTE]
 Values 29 and 30 are used by some protocols like IRC.
 
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 * < 0 if string1 < string2
@@ -968,9 +969,10 @@ Behavior has changed in version 3.8 when _case_sensitive_ is set to 0: now all
 uppercase letters are properly converted to lowercase (by calling function
 `towlower`), in addition to the range `A` to `Z`.
 
-Return value: arithmetic result of subtracting the last compared char in
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
 _string2_ (converted to lowercase if _case_sentitive_ is set to 0) from the last
-compared char in _string1_ (converted to lowercase if _case_sensitive_ is set to 0):
+compared UTF-8 char in _string1_ (converted to lowercase if _case_sensitive_ is
+set to 0):
 
 * < 0 if string1 < string2
 * 0 if string1 == string2

doc/fr/weechat_plugin_api.fr.adoc

@@ -724,8 +724,8 @@ Paramètres :
 * _string1_ : première chaîne pour la comparaison
 * _string2_ : seconde chaîne pour la comparaison
 
-Valeur de retour : résultat de la soustraction du premier caractère dans _string2_
-du premier caractère dans _string1_ :
+Valeur de retour : résultat de la soustraction du premier caractère UTF-8 dans
+_string2_ du premier caractère UTF-8 dans _string1_ :
 
 * < 0 si char1 < char2
 * 0 si char1 == char2
@@ -764,8 +764,9 @@ Paramètres :
 * _string1_ : première chaîne pour la comparaison
 * _string2_ : seconde chaîne pour la comparaison
 
-Valeur de retour : résultat de la soustraction du premier caractère dans _string2_
-(converti en minuscule) du premier caractère dans _string1_ (converti en minuscule) :
+Valeur de retour : résultat de la soustraction du premier caractère UTF-8 dans
+_string2_ (converti en minuscule) du premier caractère UTF-8 dans _string1_
+(converti en minuscule) :
 
 * < 0 si char1 < char2
 * 0 si char1 == char2
@@ -804,8 +805,8 @@ Paramètres :
 * _string1_ : première chaîne à comparer
 * _string2_ : seconde chaîne à comparer
 
-Valeur de retour : résultat de la soustraction du dernier caractère comparé
-dans _string2_ (converti en minuscule) du dernier caractère comparé dans
+Valeur de retour : résultat de la soustraction du dernier caractère UTF-8 comparé
+dans _string2_ (converti en minuscule) du dernier caractère UTF-8 comparé dans
 _string1_ (converti en minuscule) :
 
 * < 0 si string1 < string2
@@ -850,8 +851,8 @@ Paramètres :
 [NOTE]
 Les valeurs 29 et 30 sont utilisés par quelques protocoles comme IRC.
 
-Valeur de retour : résultat de la soustraction du dernier caractère comparé
-dans _string2_ (converti en minuscule) du dernier caractère comparé dans
+Valeur de retour : résultat de la soustraction du dernier caractère UTF-8 comparé
+dans _string2_ (converti en minuscule) du dernier caractère UTF-8 comparé dans
 _string1_ (converti en minuscule) :
 
 * < 0 si string1 < string2
@@ -892,8 +893,8 @@ Paramètres :
 * _string2_ : seconde chaîne à comparer
 * _max_ : nombre maximum de caractères à comparer
 
-Valeur de retour : résultat de la soustraction du dernier caractère comparé
-dans _string2_ (converti en minuscule) du dernier caractère comparé dans
+Valeur de retour : résultat de la soustraction du dernier caractère UTF-8 comparé
+dans _string2_ (converti en minuscule) du dernier caractère UTF-8 comparé dans
 _string1_ (converti en minuscule) :
 
 * < 0 si string1 < string2
@@ -937,8 +938,8 @@ Paramètres :
 [NOTE]
 Les valeurs 29 et 30 sont utilisés par quelques protocoles comme IRC.
 
-Valeur de retour : résultat de la soustraction du dernier caractère comparé
-dans _string2_ (converti en minuscule) du dernier caractère comparé dans
+Valeur de retour : résultat de la soustraction du dernier caractère UTF-8 comparé
+dans _string2_ (converti en minuscule) du dernier caractère UTF-8 comparé dans
 _string1_ (converti en minuscule) :
 
 * < 0 si string1 < string2
@@ -983,9 +984,9 @@ positionné à 0 : désormais toutes les lettres en majuscules sont correctemen
 converties en minuscules (par appel à la fonction `towlower`), en plus de
 l'intervalle de `A` à `Z`.
 
-Valeur de retour : résultat de la soustraction du dernier caractère comparé
+Valeur de retour : résultat de la soustraction du dernier caractère UTF-8 comparé
 dans _string2_ (converti en minuscule si _case_sensitive_ est positionné à 0)
-du dernier caractère comparé dans _string1_ (converti en minuscule si
+du dernier caractère UTF-8 comparé dans _string1_ (converti en minuscule si
 _case_sensitive_ est positionné à 0) :
 
 * < 0 si string1 < string2

doc/it/weechat_plugin_api.it.adoc

@@ -754,8 +754,8 @@ Argomenti:
 * _string2_: seconda stringa da comparare
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the first char in _string2_ from
-the first char in _string1_:
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+from the first UTF-8 char in _string1_:
 
 // TRANSLATION MISSING
 * < 0 if char1 < char2
@@ -798,8 +798,8 @@ Argomenti:
 * _string2_: seconda stringa da comparare
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the first char in _string2_
-(converted to lowercase) from the first char in _string1_ (converted to lowercase):
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+(converted to lowercase) from the first UTF-8 char in _string1_ (converted to lowercase):
 
 // TRANSLATION MISSING
 * < 0 if char1 < char2
@@ -843,8 +843,8 @@ Argomenti:
 * _string2_: seconda stringa da comparare
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -892,8 +892,8 @@ Argomenti:
 I valori 29 e 30 vengono usati da alcuni protocolli come IRC.
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -939,8 +939,8 @@ Argomenti:
 * _max_: numero massimo di caratteri da comparare
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -987,8 +987,8 @@ Argomenti:
 I valori 29 e 30 vengono usati da alcuni protocolli come IRC.
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -1037,9 +1037,10 @@ uppercase letters are properly converted to lowercase (by calling function
 `towlower`), in addition to the range `A` to `Z`.
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
 _string2_ (converted to lowercase if _case_sentitive_ is set to 0) from the last
-compared char in _string1_ (converted to lowercase if _case_sensitive_ is set to 0):
+compared UTF-8 char in _string1_ (converted to lowercase if _case_sensitive_ is
+set to 0):
 
 // TRANSLATION MISSING
 * < 0 if string1 < string2

doc/ja/weechat_plugin_api.ja.adoc

@@ -729,8 +729,8 @@ int weechat_string_charcmp (const char *string1, const char *string2);
 * _string2_: 2 番目の比較文字列
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the first char in _string2_ from
-the first char in _string1_:
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+from the first UTF-8 char in _string1_:
 
 // TRANSLATION MISSING
 * < 0 if char1 < char2
@@ -772,8 +772,9 @@ int weechat_string_charcasecmp (const char *string1, const char *string2);
 * _string2_: 2 番目の比較文字列
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the first char in _string2_
-(converted to lowercase) from the first char in _string1_ (converted to lowercase):
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+(converted to lowercase) from the first UTF-8 char in _string1_ (converted to
+lowercase):
 
 // TRANSLATION MISSING
 * < 0 if char1 < char2
@@ -816,8 +817,8 @@ int weechat_strcasecmp (const char *string1, const char *string2);
 * _string2_: 2 番目の比較対象の文字列
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -863,8 +864,8 @@ int weechat_strcasecmp_range (const char *string1, const char *string2, int rang
 29 と 30 は IRC など一部のプロトコルで使います。
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -909,8 +910,8 @@ int weechat_strncasecmp (const char *string1, const char *string2, int max);
 * _max_: 比較する文字数の最大値
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -956,8 +957,8 @@ int weechat_strncasecmp_range (const char *string1, const char *string2, int max
 29 と 30 は IRC など一部のプロトコルで使います。
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -1005,9 +1006,10 @@ uppercase letters are properly converted to lowercase (by calling function
 `towlower`), in addition to the range `A` to `Z`.
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
 _string2_ (converted to lowercase if _case_sentitive_ is set to 0) from the last
-compared char in _string1_ (converted to lowercase if _case_sensitive_ is set to 0):
+compared UTF-8 char in _string1_ (converted to lowercase if _case_sensitive_ is
+set to 0):
 
 // TRANSLATION MISSING
 * < 0 if string1 < string2

doc/sr/weechat_plugin_api.sr.adoc

@@ -690,8 +690,8 @@ int weechat_string_charcmp (const char *string1, const char *string2);
 * _string2_: други стринг за поређење
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the first char in _string2_ from
-the first char in _string1_:
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+from the first UTF-8 char in _string1_:
 
 // TRANSLATION MISSING
 * < 0 if char1 < char2
@@ -733,8 +733,9 @@ int weechat_string_charcasecmp (const char *string1, const char *string2);
 * _string2_: други стринг за поређење
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the first char in _string2_
-(converted to lowercase) from the first char in _string1_ (converted to lowercase):
+Return value: arithmetic result of subtracting the first UTF-8 char in _string2_
+(converted to lowercase) from the first UTF-8 char in _string1_ (converted to
+lowercase):
 
 // TRANSLATION MISSING
 * < 0 if char1 < char2
@@ -779,8 +780,8 @@ int weechat_strcasecmp (const char *string1, const char *string2);
 Повратна вредност:
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -826,8 +827,8 @@ int weechat_strcasecmp_range (const char *string1, const char *string2, int rang
 Вредности 29 и 30 користе неки протоколи, као што је IRC.
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -872,8 +873,8 @@ int weechat_strncasecmp (const char *string1, const char *string2, int max);
 * _max_: максимални број карактера који се пореде
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -918,8 +919,8 @@ int weechat_strncasecmp_range (const char *string1, const char *string2, int max
 Вредности 29 и 30 користе неки протоколи, као што је IRC.
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
-_string2_ (converted to lowercase) from the last compared char in _string1_
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
+_string2_ (converted to lowercase) from the last compared UTF-8 char in _string1_
 (converted to lowercase):
 
 // TRANSLATION MISSING
@@ -967,9 +968,10 @@ uppercase letters are properly converted to lowercase (by calling function
 `towlower`), in addition to the range `A` to `Z`.
 
 // TRANSLATION MISSING
-Return value: arithmetic result of subtracting the last compared char in
+Return value: arithmetic result of subtracting the last compared UTF-8 char in
 _string2_ (converted to lowercase if _case_sentitive_ is set to 0) from the last
-compared char in _string1_ (converted to lowercase if _case_sensitive_ is set to 0):
+compared UTF-8 char in _string1_ (converted to lowercase if _case_sensitive_ is
+set to 0):
 
 // TRANSLATION MISSING
 * < 0 if string1 < string2

src/core/wee-string.c

@@ -396,8 +396,8 @@ string_toupper (const char *string)
 /*
  * Compares two chars (case sensitive).
  *
- * Returns: arithmetic result of subtracting the first char in string2
- * from the first char in string1:
+ * Returns: arithmetic result of subtracting the first UTF-8 char in string2
+ * from the first UTF-8 char in string1:
  *   < 0: string1 < string2
  *     0: string1 == string2
  *   > 0: string1 > string2
@@ -412,8 +412,8 @@ string_charcmp (const char *string1, const char *string2)
 /*
  * Compares two chars (case insensitive).
  *
- * Returns: arithmetic result of subtracting the first char in string2
- * (converted to lowercase) from the first char in string1 (converted
+ * Returns: arithmetic result of subtracting the first UTF-8 char in string2
+ * (converted to lowercase) from the first UTF-8 char in string1 (converted
  * to lowercase):
  *   < 0: string1 < string2
  *     0: string1 == string2
@@ -460,9 +460,9 @@ string_charcasecmp (const char *string1, const char *string2)
  *   - range = 30: A-Z [ \ ] ^ ==> a-z { | } ~
  *   (ranges 29 and 30 are used by some protocols like IRC)
  *
- * Returns: arithmetic result of subtracting the last compared char in string2
- * (converted to lowercase) from the last compared char in string1 (converted
- * to lowercase):
+ * Returns: arithmetic result of subtracting the last compared UTF-8 char in
+ * string2 (converted to lowercase) from the last compared UTF-8 char in
+ * string1 (converted to lowercase):
  *   < 0: string1 < string2
  *     0: string1 == string2
  *   > 0: string1 > string2
@@ -487,9 +487,9 @@ string_charcasecmp_range (const char *string1, const char *string2, int range)
 /*
  * Compares two strings (case insensitive).
  *
- * Returns: arithmetic result of subtracting the last compared char in string2
- * (converted to lowercase) from the last compared char in string1 (converted
- * to lowercase):
+ * Returns: arithmetic result of subtracting the last compared UTF-8 char in
+ * string2 (converted to lowercase) from the last compared UTF-8 char in
+ * string1 (converted to lowercase):
  *   < 0: string1 < string2
  *     0: string1 == string2
  *   > 0: string1 > string2
@@ -525,9 +525,9 @@ string_strcasecmp (const char *string1, const char *string2)
  *   - range = 30: A-Z [ \ ] ^ ==> a-z { | } ~
  *   (ranges 29 and 30 are used by some protocols like IRC)
  *
- * Returns: arithmetic result of subtracting the last compared char in string2
- * (converted to lowercase) from the last compared char in string1 (converted
- * to lowercase):
+ * Returns: arithmetic result of subtracting the last compared UTF-8 char in
+ * string2 (converted to lowercase) from the last compared UTF-8 char in
+ * string1 (converted to lowercase):
  *   < 0: string1 < string2
  *     0: string1 == string2
  *   > 0: string1 > string2
@@ -554,9 +554,9 @@ string_strcasecmp_range (const char *string1, const char *string2, int range)
 /*
  * Compares two strings with max length (case insensitive).
  *
- * Returns: arithmetic result of subtracting the last compared char in string2
- * (converted to lowercase) from the last compared char in string1 (converted
- * to lowercase):
+ * Returns: arithmetic result of subtracting the last compared UTF-8 char in
+ * string2 (converted to lowercase) from the last compared UTF-8 char in
+ * string1 (converted to lowercase):
  *   < 0: string1 < string2
  *     0: string1 == string2
  *   > 0: string1 > string2
@@ -597,9 +597,9 @@ string_strncasecmp (const char *string1, const char *string2, int max)
  *   - range = 30: A-Z [ \ ] ^ ==> a-z { | } ~
  *   (ranges 29 and 30 are used by some protocols like IRC)
  *
- * Returns: arithmetic result of subtracting the last compared char in string2
- * (converted to lowercase) from the last compared char in string1 (converted
- * to lowercase):
+ * Returns: arithmetic result of subtracting the last compared UTF-8 char in
+ * string2 (converted to lowercase) from the last compared UTF-8 char in
+ * string1 (converted to lowercase):
  *   < 0: string1 < string2
  *     0: string1 == string2
  *   > 0: string1 > string2
@@ -632,10 +632,10 @@ string_strncasecmp_range (const char *string1, const char *string2, int max,
 /*
  * Compares two strings, ignoring some chars.
  *
- * Returns: arithmetic result of subtracting the last compared char in string2
- * (converted to lowercase if case_sensitive is set to 0) from the last
- * compared char in string1 (converted to lowercase if case_sensitive is set
- * to 0):
+ * Returns: arithmetic result of subtracting the last compared UTF-8 char in
+ * string2 (converted to lowercase if case_sensitive is set to 0) from the last
+ * compared UTF-8 char in string1 (converted to lowercase if case_sensitive is
+ * set to 0):
  *   < 0: string1 < string2
  *     0: string1 == string2
  *   > 0: string1 > string2