[gimp] libgimp: add gimp_procedure_set_attribution()
- From: Michael Natterer <mitch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] libgimp: add gimp_procedure_set_attribution()
- Date: Thu, 1 Aug 2019 22:36:07 +0000 (UTC)
commit b511cf34cfb91a7bd2e2459906270939d19a5ac9
Author: Michael Natterer <mitch gimp org>
Date: Fri Aug 2 00:35:17 2019 +0200
libgimp: add gimp_procedure_set_attribution()
Also rename "author" to "authors" and add some docs.
libgimp/gimpprocedure-private.c | 2 +-
libgimp/gimpprocedure.c | 192 ++++++++++++++++++++++++++++++++++++----
libgimp/gimpprocedure.h | 12 +--
plug-ins/common/goat-exercise.c | 10 ++-
plug-ins/help/help.c | 28 +++---
5 files changed, 206 insertions(+), 38 deletions(-)
---
diff --git a/libgimp/gimpprocedure-private.c b/libgimp/gimpprocedure-private.c
index 3d1958a436..8d26f28d40 100644
--- a/libgimp/gimpprocedure-private.c
+++ b/libgimp/gimpprocedure-private.c
@@ -60,7 +60,7 @@ _gimp_procedure_register (GimpProcedure *procedure)
proc_install.name = (gchar *) gimp_procedure_get_name (procedure);
proc_install.blurb = (gchar *) gimp_procedure_get_blurb (procedure);
proc_install.help = (gchar *) gimp_procedure_get_help (procedure);
- proc_install.author = (gchar *) gimp_procedure_get_author (procedure);
+ proc_install.author = (gchar *) gimp_procedure_get_authors (procedure);
proc_install.copyright = (gchar *) gimp_procedure_get_copyright (procedure);
proc_install.date = (gchar *) gimp_procedure_get_date (procedure);
proc_install.menu_label = (gchar *) gimp_procedure_get_menu_label (procedure);
diff --git a/libgimp/gimpprocedure.c b/libgimp/gimpprocedure.c
index f217cc5995..e82adf1093 100644
--- a/libgimp/gimpprocedure.c
+++ b/libgimp/gimpprocedure.c
@@ -63,7 +63,7 @@ struct _GimpProcedurePrivate
gchar *blurb; /* Short procedure description */
gchar *help; /* Detailed help instructions */
gchar *help_id;
- gchar *author; /* Author field */
+ gchar *authors; /* Authors field */
gchar *copyright; /* Copyright field */
gchar *date; /* Date field */
gchar *image_types;
@@ -130,6 +130,9 @@ gimp_procedure_finalize (GObject *object)
gimp_procedure_free_strings (procedure);
+ g_clear_pointer (&procedure->priv->authors, g_free);
+ g_clear_pointer (&procedure->priv->copyright, g_free);
+ g_clear_pointer (&procedure->priv->date, g_free);
g_clear_pointer (&procedure->priv->image_types, g_free);
g_clear_pointer (&procedure->priv->icon_data, g_free);
@@ -222,6 +225,14 @@ gimp_procedure_new (GimpPlugIn *plug_in,
return procedure;
}
+/**
+ * gimp_procedure_get_plug_in:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: (transfer none): The #GimpPlugIn given in gimp_procedure_new().
+ *
+ * Since: 3.0
+ **/
GimpPlugIn *
gimp_procedure_get_plug_in (GimpProcedure *procedure)
{
@@ -230,6 +241,14 @@ gimp_procedure_get_plug_in (GimpProcedure *procedure)
return procedure->priv->plug_in;
}
+/**
+ * gimp_procedure_get_name:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's name given in gimp_procedure_new().
+ *
+ * Since: 3.0
+ **/
const gchar *
gimp_procedure_get_name (GimpProcedure *procedure)
{
@@ -238,6 +257,14 @@ gimp_procedure_get_name (GimpProcedure *procedure)
return procedure->priv->name;
}
+/**
+ * gimp_procedure_get_proc_type:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's type given in gimp_procedure_new().
+ *
+ * Since: 3.0
+ **/
GimpPDBProcType
gimp_procedure_get_proc_type (GimpProcedure *procedure)
{
@@ -251,10 +278,7 @@ gimp_procedure_set_strings (GimpProcedure *procedure,
const gchar *menu_label,
const gchar *blurb,
const gchar *help,
- const gchar *help_id,
- const gchar *author,
- const gchar *copyright,
- const gchar *date)
+ const gchar *help_id)
{
g_return_if_fail (GIMP_IS_PROCEDURE (procedure));
@@ -264,11 +288,17 @@ gimp_procedure_set_strings (GimpProcedure *procedure,
procedure->priv->blurb = g_strdup (blurb);
procedure->priv->help = g_strdup (help);
procedure->priv->help_id = g_strdup (help_id);
- procedure->priv->author = g_strdup (author);
- procedure->priv->copyright = g_strdup (copyright);
- procedure->priv->date = g_strdup (date);
}
+/**
+ * gimp_procedure_get_menu_label:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's menu label given in
+ * gimp_procedure_set_strings().
+ *
+ * Since: 3.0
+ **/
const gchar *
gimp_procedure_get_menu_label (GimpProcedure *procedure)
{
@@ -277,6 +307,15 @@ gimp_procedure_get_menu_label (GimpProcedure *procedure)
return procedure->priv->menu_label;
}
+/**
+ * gimp_procedure_get_blurb:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's blurb given in
+ * gimp_procedure_set_strings().
+ *
+ * Since: 3.0
+ **/
const gchar *
gimp_procedure_get_blurb (GimpProcedure *procedure)
{
@@ -285,6 +324,15 @@ gimp_procedure_get_blurb (GimpProcedure *procedure)
return procedure->priv->blurb;
}
+/**
+ * gimp_procedure_get_help:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's help text given in
+ * gimp_procedure_set_strings().
+ *
+ * Since: 3.0
+ **/
const gchar *
gimp_procedure_get_help (GimpProcedure *procedure)
{
@@ -293,6 +341,15 @@ gimp_procedure_get_help (GimpProcedure *procedure)
return procedure->priv->help;
}
+/**
+ * gimp_procedure_get_help_id:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's help ID given in
+ * gimp_procedure_set_strings().
+ *
+ * Since: 3.0
+ **/
const gchar *
gimp_procedure_get_help_id (GimpProcedure *procedure)
{
@@ -301,14 +358,60 @@ gimp_procedure_get_help_id (GimpProcedure *procedure)
return procedure->priv->help_id;
}
+/**
+ * gimp_procedure_set_attribution:
+ * @procedure: A #GimpProcedure.
+ * @authors: The @procedure's author(s).
+ * @copyright: The @procedure's copyright.
+ * @data: The @procedure's date (written or pushished).
+ *
+ * Sets various attribution strings on @procedure.
+ *
+ * Since: 3.0
+ **/
+void
+gimp_procedure_set_attribution (GimpProcedure *procedure,
+ const gchar *authors,
+ const gchar *copyright,
+ const gchar *date)
+{
+ g_return_if_fail (GIMP_IS_PROCEDURE (procedure));
+
+ g_free (procedure->priv->authors);
+ g_free (procedure->priv->copyright);
+ g_free (procedure->priv->date);
+
+ procedure->priv->authors = g_strdup (authors);
+ procedure->priv->copyright = g_strdup (copyright);
+ procedure->priv->date = g_strdup (date);
+}
+
+/**
+ * gimp_procedure_get_author:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's authors given in
+ * gimp_procedure_set_attribution().
+ *
+ * Since: 3.0
+ **/
const gchar *
-gimp_procedure_get_author (GimpProcedure *procedure)
+gimp_procedure_get_authors (GimpProcedure *procedure)
{
g_return_val_if_fail (GIMP_IS_PROCEDURE (procedure), NULL);
- return procedure->priv->author;
+ return procedure->priv->authors;
}
+/**
+ * gimp_procedure_get_copyright:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's copyright given in
+ * gimp_procedure_set_attribution().
+ *
+ * Since: 3.0
+ **/
const gchar *
gimp_procedure_get_copyright (GimpProcedure *procedure)
{
@@ -317,6 +420,15 @@ gimp_procedure_get_copyright (GimpProcedure *procedure)
return procedure->priv->copyright;
}
+/**
+ * gimp_procedure_get_date:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: The procedure's date given in
+ * gimp_procedure_set_attribution().
+ *
+ * Since: 3.0
+ **/
const gchar *
gimp_procedure_get_date (GimpProcedure *procedure)
{
@@ -422,17 +534,46 @@ gimp_procedure_get_icon (GimpProcedure *procedure,
return procedure->priv->icon_type;
}
+/**
+ * gimp_procedure_add_menu_path:
+ * @procedure: A #GimpProcedure.
+ * @menu_path: The @procedure's additional menu path.
+ *
+ * Adds a menu path to te procedure. Only procedures which have a menu
+ * label can add a menu path.
+ *
+ * Menu paths are untranslated paths to menus and submenus with the
+ * syntax:
+ *
+ * <Prefix>/Path/To/Submenu
+ *
+ * for instance:
+ *
+ * <Image>/Layer/Transform
+ *
+ * Since: 3.0
+ **/
void
gimp_procedure_add_menu_path (GimpProcedure *procedure,
const gchar *menu_path)
{
g_return_if_fail (GIMP_IS_PROCEDURE (procedure));
g_return_if_fail (menu_path != NULL);
+ g_return_if_fail (procedure->priv->menu_label != NULL);
procedure->priv->menu_paths = g_list_append (procedure->priv->menu_paths,
g_strdup (menu_path));
}
+/**
+ * gimp_procedure_get_menu_paths:
+ * @procedure: A #GimpProcedure.
+ *
+ * Returns: (transfer none) (element-type gchar*): the @procedure's
+ * menu paths as added with gimp_procedure_add_menu_path().
+ *
+ * Since: 3.0
+ **/
GList *
gimp_procedure_get_menu_paths (GimpProcedure *procedure)
{
@@ -449,7 +590,7 @@ gimp_procedure_get_menu_paths (GimpProcedure *procedure)
* Add a new argument to @procedure according to @pspec specifications.
* The arguments will be ordered according to the call order to
* gimp_procedure_add_argument().
- */
+ **/
void
gimp_procedure_add_argument (GimpProcedure *procedure,
GParamSpec *pspec)
@@ -475,7 +616,7 @@ gimp_procedure_add_argument (GimpProcedure *procedure,
* Add a new return value to @procedure according to @pspec
* specifications. The returned values will be ordered according to the
* call order to * gimp_procedure_add_return_value().
- */
+ **/
void
gimp_procedure_add_return_value (GimpProcedure *procedure,
GParamSpec *pspec)
@@ -493,6 +634,17 @@ gimp_procedure_add_return_value (GimpProcedure *procedure,
procedure->priv->n_values++;
}
+/**
+ * gimp_procedure_get_arguments:
+ * @procedure: A #GimpProcedure.
+ * @n_arguments: (out) Returns the number of arguments.
+ *
+ * Returns: (transfer none) (array n-elements=n_arguments): An array
+ * of @GParamSpec in the order added with
+ * gimp_procedure_add_argument().
+ *
+ * Since: 3.0
+ **/
GParamSpec **
gimp_procedure_get_arguments (GimpProcedure *procedure,
gint *n_arguments)
@@ -505,6 +657,17 @@ gimp_procedure_get_arguments (GimpProcedure *procedure,
return procedure->priv->args;
}
+/**
+ * gimp_procedure_get_return_values:
+ * @procedure: A #GimpProcedure.
+ * @n_return_values: (out) Returns the number of return values.
+ *
+ * Returns: (transfer none) (array n-elements=n_return_values): An array
+ * of @GParamSpec in the order added with
+ * gimp_procedure_add_return_value().
+ *
+ * Since: 3.0
+ **/
GParamSpec **
gimp_procedure_get_return_values (GimpProcedure *procedure,
gint *n_return_values)
@@ -553,7 +716,7 @@ gimp_procedure_new_arguments (GimpProcedure *procedure)
*
* Returns: the expected #GimpValueArray as could be returned by a
* #GimpRunFunc.
- */
+ **/
GimpValueArray *
gimp_procedure_new_return_values (GimpProcedure *procedure,
GimpPDBStatusType status,
@@ -703,9 +866,6 @@ gimp_procedure_free_strings (GimpProcedure *procedure)
g_clear_pointer (&procedure->priv->blurb, g_free);
g_clear_pointer (&procedure->priv->help, g_free);
g_clear_pointer (&procedure->priv->help_id, g_free);
- g_clear_pointer (&procedure->priv->author, g_free);
- g_clear_pointer (&procedure->priv->copyright, g_free);
- g_clear_pointer (&procedure->priv->date, g_free);
}
static gboolean
diff --git a/libgimp/gimpprocedure.h b/libgimp/gimpprocedure.h
index 1ca72cb78e..e26f2dd777 100644
--- a/libgimp/gimpprocedure.h
+++ b/libgimp/gimpprocedure.h
@@ -90,16 +90,18 @@ void gimp_procedure_set_strings (GimpProcedure *procedure
const gchar *menu_label,
const gchar *blurb,
const gchar *help,
- const gchar *help_id,
- const gchar *author,
- const gchar *copyright,
- const gchar *date);
+ const gchar *help_id);
const gchar * gimp_procedure_get_menu_label (GimpProcedure *procedure);
const gchar * gimp_procedure_get_blurb (GimpProcedure *procedure);
const gchar * gimp_procedure_get_help (GimpProcedure *procedure);
const gchar * gimp_procedure_get_help_id (GimpProcedure *procedure);
-const gchar * gimp_procedure_get_author (GimpProcedure *procedure);
+
+void gimp_procedure_set_attribution (GimpProcedure *procedure,
+ const gchar *authors,
+ const gchar *copyright,
+ const gchar *date);
+const gchar * gimp_procedure_get_authors (GimpProcedure *procedure);
const gchar * gimp_procedure_get_copyright (GimpProcedure *procedure);
const gchar * gimp_procedure_get_date (GimpProcedure *procedure);
diff --git a/plug-ins/common/goat-exercise.c b/plug-ins/common/goat-exercise.c
index 92195b5b12..a6077a2b06 100644
--- a/plug-ins/common/goat-exercise.c
+++ b/plug-ins/common/goat-exercise.c
@@ -107,10 +107,12 @@ goat_create_procedure (GimpPlugIn *plug_in,
N_("Goat-exercise"),
N_("Exercise a goat"),
"takes a goat for a walk",
- PLUG_IN_PROC,
- "Øyvind Kolås <pippin gimp org>",
- "Øyvind Kolås <pippin gimp org>",
- "21march 2012");
+ PLUG_IN_PROC);
+
+ gimp_procedure_set_attribution (procedure,
+ "Øyvind Kolås <pippin gimp org>",
+ "Øyvind Kolås <pippin gimp org>",
+ "21march 2012");
gimp_procedure_set_image_types (procedure,
"RGB*, INDEXED*, GRAY*");
diff --git a/plug-ins/help/help.c b/plug-ins/help/help.c
index 99180c0984..df6a31bee3 100644
--- a/plug-ins/help/help.c
+++ b/plug-ins/help/help.c
@@ -139,12 +139,14 @@ help_create_procedure (GimpPlugIn *plug_in,
NULL,
"", /* FIXME */
"", /* FIXME */
- NULL,
- "Sven Neumann <sven gimp org>, "
- "Michael Natterer <mitch gimp org>, "
- "Henrik Brix Andersen <brix gimp org>",
- "Sven Neumann, Michael Natterer & Henrik Brix Andersen",
- "1999-2008");
+ NULL);
+
+ gimp_procedure_set_attribution (procedure,
+ "Sven Neumann <sven gimp org>, "
+ "Michael Natterer <mitch gimp org>, "
+ "Henrik Brix Andersen <brix gimp org>",
+ "Sven Neumann, Michael Natterer & Henrik Brix Andersen",
+ "1999-2008");
gimp_procedure_add_argument (procedure,
gimp_param_spec_int32 ("num-domain-names",
@@ -235,12 +237,14 @@ help_temp_proc_install (GimpPlugIn *plug_in)
NULL,
"DON'T USE THIS ONE",
"(Temporary procedure)",
- NULL,
- "Sven Neumann <sven gimp org>, "
- "Michael Natterer <mitch gimp org>"
- "Henrik Brix Andersen <brix gimp org",
- "Sven Neumann, Michael Natterer & Henrik Brix Andersen",
- "1999-2008");
+ NULL);
+
+ gimp_procedure_set_attribution (procedure,
+ "Sven Neumann <sven gimp org>, "
+ "Michael Natterer <mitch gimp org>"
+ "Henrik Brix Andersen <brix gimp org",
+ "Sven Neumann, Michael Natterer & Henrik Brix Andersen",
+ "1999-2008");
gimp_procedure_add_argument (procedure,
g_param_spec_string ("help-proc",
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
