From 5380f417dcee6f4c4951b1b6098d84ffdcb90a9f Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Fri, 21 Jun 2019 11:03:59 +0100 Subject: [PATCH 1/2] gunidecomp: Fix a (nullable) annotation which should be (optional) Signed-off-by: Philip Withnall Helps: #872 --- glib/gunidecomp.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/glib/gunidecomp.c b/glib/gunidecomp.c index b85351883..3afd156c1 100644 --- a/glib/gunidecomp.c +++ b/glib/gunidecomp.c @@ -685,7 +685,7 @@ g_unichar_compose (gunichar a, * g_unichar_fully_decompose: * @ch: a Unicode character. * @compat: whether perform canonical or compatibility decomposition - * @result: (nullable): location to store decomposed result, or %NULL + * @result: (optional) (out caller-allocates): location to store decomposed result, or %NULL * @result_len: length of @result * * Computes the canonical or compatibility decomposition of a From 8f6e5f1b01e1bbc2cbb8f76d291be347748cacad Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Fri, 21 Jun 2019 11:05:11 +0100 Subject: [PATCH 2/2] gutf8: Add various missing (transfer) annotations Signed-off-by: Philip Withnall Fixes: #872 --- glib/gutf8.c | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/glib/gutf8.c b/glib/gutf8.c index 291534fc8..a19f72044 100644 --- a/glib/gutf8.c +++ b/glib/gutf8.c @@ -136,7 +136,7 @@ const gchar * const g_utf8_skip = utf8_skip_data; * is made to see if the character found is actually valid other than * it starts with an appropriate byte. * - * Returns: a pointer to the found character or %NULL. + * Returns: (transfer none) (nullable): a pointer to the found character or %NULL. */ gchar * g_utf8_find_prev_char (const char *str, @@ -167,7 +167,7 @@ g_utf8_find_prev_char (const char *str, * @end is non-%NULL, the return value will be %NULL if the end of the string * is reached. * - * Returns: (nullable): a pointer to the found character or %NULL if @end is + * Returns: (transfer none) (nullable): a pointer to the found character or %NULL if @end is * set and is reached */ gchar * @@ -199,7 +199,7 @@ g_utf8_find_next_char (const gchar *p, * it starts with an appropriate byte. If @p might be the first * character of the string, you must use g_utf8_find_prev_char() instead. * - * Returns: a pointer to the found character + * Returns: (transfer none) (not nullable): a pointer to the found character */ gchar * g_utf8_prev_char (const gchar *p) @@ -275,7 +275,7 @@ g_utf8_strlen (const gchar *p, * Copies a substring out of a UTF-8 encoded string. * The substring will contain @end_pos - @start_pos characters. * - * Returns: a newly allocated copy of the requested + * Returns: (transfer full): a newly allocated copy of the requested * substring. Free with g_free() when no longer needed. * * Since: 2.30 @@ -344,7 +344,7 @@ g_utf8_get_char (const gchar *p) * This limitation exists as this function is called frequently during * text rendering and therefore has to be as fast as possible. * - * Returns: the resulting pointer + * Returns: (transfer none): the resulting pointer */ gchar * g_utf8_offset_to_pointer (const gchar *str, @@ -412,7 +412,7 @@ g_utf8_pointer_to_offset (const gchar *str, /** * g_utf8_strncpy: - * @dest: buffer to fill with characters from @src + * @dest: (transfer none): buffer to fill with characters from @src * @src: UTF-8 encoded string * @n: character count * @@ -424,7 +424,7 @@ g_utf8_pointer_to_offset (const gchar *str, * Note you must ensure @dest is at least 4 * @n to fit the * largest possible UTF-8 characters * - * Returns: @dest + * Returns: (transfer none): @dest */ gchar * g_utf8_strncpy (gchar *dest, @@ -518,7 +518,7 @@ g_unichar_to_utf8 (gunichar c, * in a UTF-8 encoded string, while limiting the search to @len bytes. * If @len is -1, allow unbounded search. * - * Returns: %NULL if the string does not contain the character, + * Returns: (transfer none) (nullable): %NULL if the string does not contain the character, * otherwise, a pointer to the start of the leftmost occurrence * of the character in the string. */ @@ -546,7 +546,7 @@ g_utf8_strchr (const char *p, * in a UTF-8 encoded string, while limiting the search to @len bytes. * If @len is -1, allow unbounded search. * - * Returns: %NULL if the string does not contain the character, + * Returns: (transfer none) (nullable): %NULL if the string does not contain the character, * otherwise, a pointer to the start of the rightmost occurrence * of the character in the string. */ @@ -709,7 +709,7 @@ g_utf8_get_char_validated (const gchar *p, * but does no error checking on the input. A trailing 0 character * will be added to the string after the converted text. * - * Returns: a pointer to a newly allocated UCS-4 string. + * Returns: (transfer full): a pointer to a newly allocated UCS-4 string. * This value must be freed with g_free(). */ gunichar * @@ -834,7 +834,7 @@ try_malloc_n (gsize n_blocks, gsize n_block_bytes, GError **error) * representation as UCS-4. A trailing 0 character will be added to the * string after the converted text. * - * Returns: a pointer to a newly allocated UCS-4 string. + * Returns: (transfer full): a pointer to a newly allocated UCS-4 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -915,7 +915,7 @@ g_utf8_to_ucs4 (const gchar *str, * Convert a string from a 32-bit fixed width representation as UCS-4. * to UTF-8. The result will be terminated with a 0 byte. * - * Returns: a pointer to a newly allocated UTF-8 string. + * Returns: (transfer full): a pointer to a newly allocated UTF-8 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. In that case, @items_read * will be set to the position of the first invalid input character. @@ -1002,7 +1002,7 @@ g_ucs4_to_utf8 (const gunichar *str, * be correctly interpreted as UTF-16, i.e. it doesn't contain * things unpaired surrogates. * - * Returns: a pointer to a newly allocated UTF-8 string. + * Returns: (transfer full): a pointer to a newly allocated UTF-8 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. **/ @@ -1146,7 +1146,7 @@ g_utf16_to_utf8 (const gunichar2 *str, * Convert a string from UTF-16 to UCS-4. The result will be * nul-terminated. * - * Returns: a pointer to a newly allocated UCS-4 string. + * Returns: (transfer full): a pointer to a newly allocated UCS-4 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -1284,7 +1284,7 @@ g_utf16_to_ucs4 (const gunichar2 *str, * Convert a string from UTF-8 to UTF-16. A 0 character will be * added to the result after the converted text. * - * Returns: a pointer to a newly allocated UTF-16 string. + * Returns: (transfer full): a pointer to a newly allocated UTF-16 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -1400,7 +1400,7 @@ g_utf8_to_utf16 (const gchar *str, * Convert a string from UCS-4 to UTF-16. A 0 character will be * added to the result after the converted text. * - * Returns: a pointer to a newly allocated UTF-16 string. + * Returns: (transfer full): a pointer to a newly allocated UTF-16 string. * This value must be freed with g_free(). If an error occurs, * %NULL will be returned and @error set. */ @@ -1752,7 +1752,7 @@ g_unichar_validate (gunichar ch) * newly-allocated memory, which should be freed with g_free() when * no longer needed. * - * Returns: a newly-allocated string which is the reverse of @str + * Returns: (transfer full): a newly-allocated string which is the reverse of @str * * Since: 2.2 */