[gexiv2/wip/Jehan/issue-60-use-gerror] Issue #60: alt gexiv2_metadata_try_(g|s)et_tag_multiple() with GError.

[Jehan <jehanp src gnome org>]

commit a277b01d3540945e73b3dcd381c644ccbf8ae08c
Author: Jehan <jehan girinstud io>
Date:   Sun Nov 8 18:25:34 2020 +0100

    Issue #60: alt gexiv2_metadata_try_(g|s)et_tag_multiple() with GError.
    
    Raising GLib warning should not be done on tag errors because calling
    applications may prefer handling these errors differently (and adding a
    log handler for every dependency of a software is not flexible).
    It is much better design to return errors as optional GError.

 gexiv2/gexiv2-metadata-iptc.cpp  | 10 ++++---
 gexiv2/gexiv2-metadata-private.h |  8 +++---
 gexiv2/gexiv2-metadata-xmp.cpp   | 10 ++++---
 gexiv2/gexiv2-metadata.cpp       | 61 ++++++++++++++++++++++++++++++++--------
 gexiv2/gexiv2-metadata.h         | 34 ++++++++++++++++++++++
 5 files changed, 99 insertions(+), 24 deletions(-)
---
diff --git a/gexiv2/gexiv2-metadata-iptc.cpp b/gexiv2/gexiv2-metadata-iptc.cpp
index 24de73b..e06fdec 100644
--- a/gexiv2/gexiv2-metadata-iptc.cpp
+++ b/gexiv2/gexiv2-metadata-iptc.cpp
@@ -161,10 +161,11 @@ gboolean gexiv2_metadata_set_iptc_tag_string (GExiv2Metadata *self, const gchar*
     return FALSE;
 }
 
-gchar** gexiv2_metadata_get_iptc_tag_multiple (GExiv2Metadata *self, const gchar* tag) {
+gchar** gexiv2_metadata_get_iptc_tag_multiple (GExiv2Metadata *self, const gchar* tag, GError **error) {
     g_return_val_if_fail(GEXIV2_IS_METADATA (self), NULL);
     g_return_val_if_fail(tag != NULL, NULL);
     g_return_val_if_fail(self->priv->image.get() != NULL, NULL);
+    g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
     
     Exiv2::IptcData &iptc_data = self->priv->image->iptcData();
     
@@ -191,7 +192,7 @@ gchar** gexiv2_metadata_get_iptc_tag_multiple (GExiv2Metadata *self, const gchar
         
         return values;
     } catch (Exiv2::Error& e) {
-        LOG_ERROR(e);
+        g_set_error_literal (error, g_quark_from_string ("GExiv2"), e.code (), e.what ());
     }
     
     g_slist_free_full (list, g_free);
@@ -200,11 +201,12 @@ gchar** gexiv2_metadata_get_iptc_tag_multiple (GExiv2Metadata *self, const gchar
 }
 
 gboolean gexiv2_metadata_set_iptc_tag_multiple (GExiv2Metadata *self, const gchar* tag,
-    const gchar** values) {
+    const gchar** values, GError **error) {
     g_return_val_if_fail (GEXIV2_IS_METADATA (self), FALSE);
     g_return_val_if_fail(tag != NULL, FALSE);
     g_return_val_if_fail(values != NULL, FALSE);
     g_return_val_if_fail(self->priv->image.get() != NULL, FALSE);
+    g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
     
     Exiv2::IptcData& iptc_data = self->priv->image->iptcData();
     
@@ -232,7 +234,7 @@ gboolean gexiv2_metadata_set_iptc_tag_multiple (GExiv2Metadata *self, const gcha
         
         return TRUE;
     } catch (Exiv2::Error& e) {
-        LOG_ERROR(e);
+        g_set_error_literal (error, g_quark_from_string ("GExiv2"), e.code (), e.what ());
     }
     
     return FALSE;
diff --git a/gexiv2/gexiv2-metadata-private.h b/gexiv2/gexiv2-metadata-private.h
index d31fa99..989af0b 100644
--- a/gexiv2/gexiv2-metadata-private.h
+++ b/gexiv2/gexiv2-metadata-private.h
@@ -62,8 +62,8 @@ G_GNUC_INTERNAL gboolean              gexiv2_metadata_set_xmp_tag_string      
(GExiv2Metadata *se
 G_GNUC_INTERNAL gchar*                 gexiv2_metadata_get_xmp_tag_interpreted_string (GExiv2Metadata *self, 
const gchar* tag);
 G_GNUC_INTERNAL glong                  gexiv2_metadata_get_xmp_tag_long        (GExiv2Metadata *self, const 
gchar* tag);
 G_GNUC_INTERNAL gboolean               gexiv2_metadata_set_xmp_tag_long        (GExiv2Metadata *self, const 
gchar* tag, glong value);
-G_GNUC_INTERNAL gchar**                        gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self, 
const gchar* tag);
-G_GNUC_INTERNAL gboolean               gexiv2_metadata_set_xmp_tag_multiple (GExiv2Metadata *self, const 
gchar* tag, const gchar** values);
+G_GNUC_INTERNAL gchar**                        gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self, 
const gchar* tag, GError **error);
+G_GNUC_INTERNAL gboolean               gexiv2_metadata_set_xmp_tag_multiple (GExiv2Metadata *self, const 
gchar* tag, const gchar** values, GError **error);
 
 G_GNUC_INTERNAL const gchar*   gexiv2_metadata_get_xmp_tag_label               (const gchar* tag);
 G_GNUC_INTERNAL const gchar*   gexiv2_metadata_get_xmp_tag_description (const gchar* tag);
@@ -78,8 +78,8 @@ G_GNUC_INTERNAL gboolean              gexiv2_metadata_has_iptc_tag            
(GExiv2Metadata *self, c
 G_GNUC_INTERNAL gchar*                 gexiv2_metadata_get_iptc_tag_string     (GExiv2Metadata *self, const 
gchar* tag);
 G_GNUC_INTERNAL gboolean               gexiv2_metadata_set_iptc_tag_string     (GExiv2Metadata *self, const 
gchar* tag, const gchar* value);
 G_GNUC_INTERNAL gchar*                 gexiv2_metadata_get_iptc_tag_interpreted_string (GExiv2Metadata 
*self, const gchar* tag);
-G_GNUC_INTERNAL gchar**                        gexiv2_metadata_get_iptc_tag_multiple   (GExiv2Metadata 
*self, const gchar* tag);
-G_GNUC_INTERNAL gboolean               gexiv2_metadata_set_iptc_tag_multiple   (GExiv2Metadata *self, const 
gchar* tag, const gchar** values);
+G_GNUC_INTERNAL gchar**                        gexiv2_metadata_get_iptc_tag_multiple   (GExiv2Metadata 
*self, const gchar* tag, GError **error);
+G_GNUC_INTERNAL gboolean               gexiv2_metadata_set_iptc_tag_multiple   (GExiv2Metadata *self, const 
gchar* tag, const gchar** values, GError **error);
 
 G_GNUC_INTERNAL const gchar*   gexiv2_metadata_get_iptc_tag_label      (const gchar* tag);
 G_GNUC_INTERNAL const gchar*   gexiv2_metadata_get_iptc_tag_description        (const gchar* tag);
diff --git a/gexiv2/gexiv2-metadata-xmp.cpp b/gexiv2/gexiv2-metadata-xmp.cpp
index 784ad86..346c7d7 100644
--- a/gexiv2/gexiv2-metadata-xmp.cpp
+++ b/gexiv2/gexiv2-metadata-xmp.cpp
@@ -269,10 +269,11 @@ gboolean gexiv2_metadata_set_xmp_tag_long (GExiv2Metadata *self, const gchar* ta
     return FALSE;
 }
 
-gchar** gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self, const gchar* tag) {
+gchar** gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self, const gchar* tag, GError **error) {
     g_return_val_if_fail(GEXIV2_IS_METADATA (self), NULL);
     g_return_val_if_fail(tag != NULL, NULL);
     g_return_val_if_fail(self->priv->image.get() != NULL, NULL);
+    g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
     
     Exiv2::XmpData& xmp_data = self->priv->image->xmpData();
     
@@ -294,7 +295,7 @@ gchar** gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self, const gchar*
             return array;
         }
     } catch (Exiv2::Error& e) {
-        LOG_ERROR(e);
+        g_set_error_literal (error, g_quark_from_string ("GExiv2"), e.code (), e.what ());
     }
     
     gchar **array = g_new (gchar*, 1);
@@ -304,11 +305,12 @@ gchar** gexiv2_metadata_get_xmp_tag_multiple (GExiv2Metadata *self, const gchar*
 }
 
 gboolean gexiv2_metadata_set_xmp_tag_multiple (GExiv2Metadata *self, const gchar* tag, 
-    const gchar** values) {
+    const gchar** values, GError **error) {
     g_return_val_if_fail(GEXIV2_IS_METADATA (self), FALSE);
     g_return_val_if_fail(tag != NULL, FALSE);
     g_return_val_if_fail(values != NULL, FALSE);
     g_return_val_if_fail(self->priv->image.get() != NULL, FALSE);
+    g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
     
     Exiv2::XmpData& xmp_data = self->priv->image->xmpData();
     
@@ -330,7 +332,7 @@ gboolean gexiv2_metadata_set_xmp_tag_multiple (GExiv2Metadata *self, const gchar
         
         return TRUE;
     } catch (Exiv2::Error& e) {
-        LOG_ERROR(e);
+        g_set_error_literal (error, g_quark_from_string ("GExiv2"), e.code (), e.what ());
     }
     
     return FALSE;
diff --git a/gexiv2/gexiv2-metadata.cpp b/gexiv2/gexiv2-metadata.cpp
index 84a2c22..e11de81 100644
--- a/gexiv2/gexiv2-metadata.cpp
+++ b/gexiv2/gexiv2-metadata.cpp
@@ -962,35 +962,72 @@ gchar* gexiv2_metadata_get_tag_interpreted_string (GExiv2Metadata *self, const g
     return NULL;
 }
 
-gchar** gexiv2_metadata_get_tag_multiple(GExiv2Metadata *self, const gchar* tag) {
+gchar** gexiv2_metadata_try_get_tag_multiple(GExiv2Metadata *self, const gchar* tag, GError **error) {
     g_return_val_if_fail(GEXIV2_IS_METADATA(self), NULL);
     g_return_val_if_fail(tag != NULL, NULL);
     g_return_val_if_fail(self->priv->image.get() != NULL, NULL);
-    
+
     if (gexiv2_metadata_is_xmp_tag(tag))
-        return gexiv2_metadata_get_xmp_tag_multiple(self, tag);
-    
+        return gexiv2_metadata_get_xmp_tag_multiple(self, tag, error);
+
     if (gexiv2_metadata_is_iptc_tag(tag))
-        return gexiv2_metadata_get_iptc_tag_multiple(self, tag);
-    
+        return gexiv2_metadata_get_iptc_tag_multiple(self, tag, error);
+
     return NULL;
 }
 
-gboolean gexiv2_metadata_set_tag_multiple(GExiv2Metadata *self, const gchar* tag, const gchar** values) {
+gboolean gexiv2_metadata_try_set_tag_multiple(GExiv2Metadata *self, const gchar* tag, const gchar** values, 
GError **error) {
     g_return_val_if_fail(GEXIV2_IS_METADATA(self), FALSE);
     g_return_val_if_fail(tag != NULL, FALSE);
     g_return_val_if_fail(values != NULL, FALSE);
     g_return_val_if_fail(self->priv->image.get() != NULL, FALSE);
-    
+
     if (gexiv2_metadata_is_xmp_tag(tag))
-        return gexiv2_metadata_set_xmp_tag_multiple(self, tag, values);
-    
+        return gexiv2_metadata_set_xmp_tag_multiple(self, tag, values, error);
+
     if (gexiv2_metadata_is_iptc_tag(tag))
-        return gexiv2_metadata_set_iptc_tag_multiple(self, tag, values);
-    
+        return gexiv2_metadata_set_iptc_tag_multiple(self, tag, values, error);
+
     return FALSE;
 }
 
+gchar** gexiv2_metadata_get_tag_multiple(GExiv2Metadata *self, const gchar* tag) {
+    gchar  **tags  = NULL;
+    GError  *error = NULL;
+
+    g_return_val_if_fail(GEXIV2_IS_METADATA(self), NULL);
+    g_return_val_if_fail(tag != NULL, NULL);
+    g_return_val_if_fail(self->priv->image.get() != NULL, NULL);
+
+    tags = gexiv2_metadata_try_get_tag_multiple(self, tag, &error);
+
+    if (error) {
+        g_warning("%s", error->message);
+        g_clear_error(&error);
+    }
+
+    return tags;
+}
+
+gboolean gexiv2_metadata_set_tag_multiple(GExiv2Metadata *self, const gchar* tag, const gchar** values) {
+    GError   *error   = NULL;
+    gboolean  success = FALSE;
+
+    g_return_val_if_fail(GEXIV2_IS_METADATA(self), FALSE);
+    g_return_val_if_fail(tag != NULL, FALSE);
+    g_return_val_if_fail(values != NULL, FALSE);
+    g_return_val_if_fail(self->priv->image.get() != NULL, FALSE);
+
+    success = gexiv2_metadata_try_set_tag_multiple(self, tag, values, &error);
+
+    if (error) {
+        g_warning("%s", error->message);
+        g_clear_error(&error);
+    }
+
+    return success;
+}
+
 glong gexiv2_metadata_get_tag_long(GExiv2Metadata *self, const gchar* tag) {
     g_return_val_if_fail(GEXIV2_IS_METADATA(self), 0);
     g_return_val_if_fail(tag != NULL, 0);
diff --git a/gexiv2/gexiv2-metadata.h b/gexiv2/gexiv2-metadata.h
index f65db7e..b164ca0 100644
--- a/gexiv2/gexiv2-metadata.h
+++ b/gexiv2/gexiv2-metadata.h
@@ -562,6 +562,32 @@ glong                      gexiv2_metadata_get_tag_long            (GExiv2Metadata 
*self, const gchar* tag);
 gboolean               gexiv2_metadata_set_tag_long            (GExiv2Metadata *self, const gchar* tag, 
glong value);
 
 
+/**
+ * gexiv2_metadata_try_get_tag_multiple:
+ * @self: An instance of #GExiv2Metadata
+ * @tag: Exiv2 tag name
+ * @error: (allow-none): A return location for a #GError or %NULL
+ *
+ * The Exiv2 Tag Reference can be found at <ulink url="http://exiv2.org/metadata.html";></ulink>
+ *
+ * Returns: (transfer full) (allow-none) (array zero-terminated=1): The multiple string values of
+ * the tag
+ */
+gchar**                        gexiv2_metadata_try_get_tag_multiple    (GExiv2Metadata *self, const gchar* 
tag, GError **error);
+
+/**
+ * gexiv2_metadata_try_set_tag_multiple:
+ * @self: An instance of #GExiv2Metadata
+ * @tag: Exiv2 tag name
+ * @values: (array zero-terminated=1): An array of values to set or replace the existing value(s)
+ * @error: (allow-none): A return location for a #GError or %NULL
+ *
+ * The Exiv2 Tag Reference can be found at <ulink url="http://exiv2.org/metadata.html";></ulink>
+ *
+ * Returns: Boolean success value
+ */
+gboolean               gexiv2_metadata_try_set_tag_multiple    (GExiv2Metadata *self, const gchar* tag, 
const gchar** values, GError **error);
+
 /**
  * gexiv2_metadata_get_tag_multiple:
  * @self: An instance of #GExiv2Metadata
@@ -569,6 +595,10 @@ gboolean           gexiv2_metadata_set_tag_long            (GExiv2Metadata *self, const 
gchar* tag,
  *
  * The Exiv2 Tag Reference can be found at <ulink url="http://exiv2.org/metadata.html";></ulink>
  *
+ * In case of error, a GLib warning will be logged. Use instead
+ * gexiv2_metadata_try_get_tag_multiple() if you want to avoid this and
+ * control if and how the error is outputted.
+ *
  * Returns: (transfer full) (allow-none) (array zero-terminated=1): The multiple string values of
  * the tag
  */
@@ -582,6 +612,10 @@ gchar**                    gexiv2_metadata_get_tag_multiple        (GExiv2Metadata 
*self, const gchar* t
  *
  * The Exiv2 Tag Reference can be found at <ulink url="http://exiv2.org/metadata.html";></ulink>
  *
+ * In case of error, a GLib warning will be logged. Use instead
+ * gexiv2_metadata_try_set_tag_multiple() if you want to avoid this and
+ * control if and how the error is outputted.
+ *
  * Returns: Boolean success value
  */
 gboolean               gexiv2_metadata_set_tag_multiple        (GExiv2Metadata *self, const gchar* tag, 
const gchar** values);