[gimp] pdb: deprecate the drawable and vectors parasite APIs



commit 7314d3fe4f760fab25dec4fb10580754367aa99a
Author: Michael Natterer <mitch gimp org>
Date:   Fri Jul 9 10:36:17 2010 +0200

    pdb: deprecate the drawable and vectors parasite APIs

 app/pdb/parasite-cmds.c       |   48 +++++++++++++++++++-------------------
 libgimp/gimpparasite_pdb.c    |   45 +++++++++++-----------------------
 libgimp/gimpparasite_pdb.h    |    2 +
 tools/pdbgen/pdb/parasite.pdb |   52 ++++++----------------------------------
 4 files changed, 49 insertions(+), 98 deletions(-)
---
diff --git a/app/pdb/parasite-cmds.c b/app/pdb/parasite-cmds.c
index ebf76ea..83d9128 100644
--- a/app/pdb/parasite-cmds.c
+++ b/app/pdb/parasite-cmds.c
@@ -967,12 +967,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-drawable-parasite-find");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-drawable-parasite-find",
-                                     "Look up a parasite in a drawable",
-                                     "Finds and returns the parasite that was previously attached to a drawable.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-find' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-find' instead.",
                                      "Jay Cox",
                                      "Jay Cox",
                                      "1998",
-                                     NULL);
+                                     "gimp-item-parasite-find");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_drawable_id ("drawable",
                                                             "drawable",
@@ -1002,12 +1002,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-drawable-parasite-attach");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-drawable-parasite-attach",
-                                     "Add a parasite to a drawable.",
-                                     "This procedure attaches a parasite to a drawable. It has no return values.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-attach' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-attach' instead.",
                                      "Jay Cox",
                                      "Jay Cox",
                                      "1998",
-                                     NULL);
+                                     "gimp-item-parasite-attach");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_drawable_id ("drawable",
                                                             "drawable",
@@ -1030,12 +1030,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-drawable-parasite-detach");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-drawable-parasite-detach",
-                                     "Removes a parasite from a drawable.",
-                                     "This procedure detaches a parasite from a drawable. It has no return values.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-detach' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-detach' instead.",
                                      "Jay Cox",
                                      "Jay Cox",
                                      "1998",
-                                     NULL);
+                                     "gimp-item-parasite-detach");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_drawable_id ("drawable",
                                                             "drawable",
@@ -1060,12 +1060,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-drawable-parasite-list");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-drawable-parasite-list",
-                                     "List all parasites.",
-                                     "Returns a list of all currently attached parasites.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-list' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-list' instead.",
                                      "Marc Lehmann",
                                      "Marc Lehmann",
                                      "1999",
-                                     NULL);
+                                     "gimp-item-parasite-list");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_drawable_id ("drawable",
                                                             "drawable",
@@ -1094,12 +1094,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-vectors-parasite-find");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-vectors-parasite-find",
-                                     "Look up a parasite in a vectors object",
-                                     "Finds and returns the parasite that was previously attached to a vectors object.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-find' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-find' instead.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2006",
-                                     NULL);
+                                     "gimp-item-parasite-find");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_vectors_id ("vectors",
                                                            "vectors",
@@ -1129,12 +1129,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-vectors-parasite-attach");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-vectors-parasite-attach",
-                                     "Add a parasite to a vectors object",
-                                     "This procedure attaches a parasite to a vectors object. It has no return values.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-attach' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-attach' instead.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2006",
-                                     NULL);
+                                     "gimp-item-parasite-attach");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_vectors_id ("vectors",
                                                            "vectors",
@@ -1157,12 +1157,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-vectors-parasite-detach");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-vectors-parasite-detach",
-                                     "Removes a parasite from a vectors object",
-                                     "This procedure detaches a parasite from a vectors object. It has no return values.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-detach' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-detach' instead.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2006",
-                                     NULL);
+                                     "gimp-item-parasite-detach");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_vectors_id ("vectors",
                                                            "vectors",
@@ -1187,12 +1187,12 @@ register_parasite_procs (GimpPDB *pdb)
                                "gimp-vectors-parasite-list");
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-vectors-parasite-list",
-                                     "List all parasites.",
-                                     "Returns a list of all currently attached parasites.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-list' instead.",
+                                     "This procedure is deprecated! Use 'gimp-item-parasite-list' instead.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2006",
-                                     NULL);
+                                     "gimp-item-parasite-list");
   gimp_procedure_add_argument (procedure,
                                gimp_param_spec_vectors_id ("vectors",
                                                            "vectors",
diff --git a/libgimp/gimpparasite_pdb.c b/libgimp/gimpparasite_pdb.c
index 9711f4d..7ab7257 100644
--- a/libgimp/gimpparasite_pdb.c
+++ b/libgimp/gimpparasite_pdb.c
@@ -23,6 +23,9 @@
 #include "config.h"
 
 #include "gimp.h"
+#undef GIMP_DISABLE_DEPRECATED
+#undef __GIMP_PARASITE_PDB_H__
+#include "gimpparasite_pdb.h"
 
 
 /**
@@ -467,10 +470,7 @@ gimp_item_parasite_list (gint32    item_ID,
  * @drawable_ID: The drawable.
  * @name: The name of the parasite to find.
  *
- * Look up a parasite in a drawable
- *
- * Finds and returns the parasite that was previously attached to a
- * drawable.
+ * This procedure is deprecated! Use gimp_item_parasite_find() instead.
  *
  * Returns: The found parasite.
  */
@@ -501,10 +501,8 @@ gimp_drawable_parasite_find (gint32       drawable_ID,
  * @drawable_ID: The drawable.
  * @parasite: The parasite to attach to a drawable.
  *
- * Add a parasite to a drawable.
- *
- * This procedure attaches a parasite to a drawable. It has no return
- * values.
+ * This procedure is deprecated! Use gimp_item_parasite_attach()
+ * instead.
  *
  * Returns: TRUE on success.
  */
@@ -534,10 +532,8 @@ gimp_drawable_parasite_attach (gint32              drawable_ID,
  * @drawable_ID: The drawable.
  * @name: The name of the parasite to detach from a drawable.
  *
- * Removes a parasite from a drawable.
- *
- * This procedure detaches a parasite from a drawable. It has no return
- * values.
+ * This procedure is deprecated! Use gimp_item_parasite_detach()
+ * instead.
  *
  * Returns: TRUE on success.
  */
@@ -568,9 +564,7 @@ gimp_drawable_parasite_detach (gint32       drawable_ID,
  * @num_parasites: The number of attached parasites.
  * @parasites: The names of currently attached parasites.
  *
- * List all parasites.
- *
- * Returns a list of all currently attached parasites.
+ * This procedure is deprecated! Use gimp_item_parasite_list() instead.
  *
  * Returns: TRUE on success.
  */
@@ -612,10 +606,7 @@ gimp_drawable_parasite_list (gint32    drawable_ID,
  * @vectors_ID: The vectors object.
  * @name: The name of the parasite to find.
  *
- * Look up a parasite in a vectors object
- *
- * Finds and returns the parasite that was previously attached to a
- * vectors object.
+ * This procedure is deprecated! Use gimp_item_parasite_find() instead.
  *
  * Returns: The found parasite.
  *
@@ -648,10 +639,8 @@ gimp_vectors_parasite_find (gint32       vectors_ID,
  * @vectors_ID: The vectors object.
  * @parasite: The parasite to attach to a vectors object.
  *
- * Add a parasite to a vectors object
- *
- * This procedure attaches a parasite to a vectors object. It has no
- * return values.
+ * This procedure is deprecated! Use gimp_item_parasite_attach()
+ * instead.
  *
  * Returns: TRUE on success.
  *
@@ -683,10 +672,8 @@ gimp_vectors_parasite_attach (gint32              vectors_ID,
  * @vectors_ID: The vectors object.
  * @name: The name of the parasite to detach from a vectors object.
  *
- * Removes a parasite from a vectors object
- *
- * This procedure detaches a parasite from a vectors object. It has no
- * return values.
+ * This procedure is deprecated! Use gimp_item_parasite_detach()
+ * instead.
  *
  * Returns: TRUE on success.
  *
@@ -719,9 +706,7 @@ gimp_vectors_parasite_detach (gint32       vectors_ID,
  * @num_parasites: The number of attached parasites.
  * @parasites: The names of currently attached parasites.
  *
- * List all parasites.
- *
- * Returns a list of all currently attached parasites.
+ * This procedure is deprecated! Use gimp_item_parasite_list() instead.
  *
  * Returns: TRUE on success.
  *
diff --git a/libgimp/gimpparasite_pdb.h b/libgimp/gimpparasite_pdb.h
index 07a826d..45bc077 100644
--- a/libgimp/gimpparasite_pdb.h
+++ b/libgimp/gimpparasite_pdb.h
@@ -51,6 +51,7 @@ gboolean      gimp_item_parasite_detach     (gint32                item_ID,
 gboolean      gimp_item_parasite_list       (gint32                item_ID,
                                              gint                 *num_parasites,
                                              gchar              ***parasites);
+#ifndef GIMP_DISABLE_DEPRECATED
 GimpParasite* gimp_drawable_parasite_find   (gint32                drawable_ID,
                                              const gchar          *name);
 gboolean      gimp_drawable_parasite_attach (gint32                drawable_ID,
@@ -69,6 +70,7 @@ gboolean      gimp_vectors_parasite_detach  (gint32                vectors_ID,
 gboolean      gimp_vectors_parasite_list    (gint32                vectors_ID,
                                              gint                 *num_parasites,
                                              gchar              ***parasites);
+#endif /* GIMP_DISABLE_DEPRECATED */
 
 
 G_END_DECLS
diff --git a/tools/pdbgen/pdb/parasite.pdb b/tools/pdbgen/pdb/parasite.pdb
index fd9408e..41365dd 100644
--- a/tools/pdbgen/pdb/parasite.pdb
+++ b/tools/pdbgen/pdb/parasite.pdb
@@ -333,12 +333,7 @@ CODE
 }
 
 sub drawable_parasite_find {
-    $blurb = 'Look up a parasite in a drawable';
-
-    $help = <<'HELP';
-Finds and returns the parasite that was previously attached to a drawable.
-HELP
-
+    &std_pdb_deprecated ('gimp-item-parasite-find');
     &jay_pdb_misc('1998');
 
     @inargs = (
@@ -367,12 +362,7 @@ CODE
 }
 
 sub drawable_parasite_attach {
-    $blurb = 'Add a parasite to a drawable.';
-
-    $help = <<'HELP';
-This procedure attaches a parasite to a drawable. It has no return values.
-HELP
-
+    &std_pdb_deprecated ('gimp-item-parasite-attach');
     &jay_pdb_misc('1998');
 
     @inargs = (
@@ -392,12 +382,7 @@ CODE
 }
 
 sub drawable_parasite_detach {
-    $blurb = 'Removes a parasite from a drawable.';
-
-    $help = <<'HELP';
-This procedure detaches a parasite from a drawable. It has no return values.
-HELP
-
+    &std_pdb_deprecated ('gimp-item-parasite-detach');
     &jay_pdb_misc('1998');
 
     @inargs = (
@@ -417,9 +402,7 @@ CODE
 }
 
 sub drawable_parasite_list {
-    $blurb = 'List all parasites.';
-    $help  = 'Returns a list of all currently attached parasites.';
-
+    &std_pdb_deprecated ('gimp-item-parasite-list');
     &marc_pdb_misc('1999');
 
     @inargs = (
@@ -443,13 +426,7 @@ CODE
 }
 
 sub vectors_parasite_find {
-    $blurb = 'Look up a parasite in a vectors object';
-
-    $help = <<'HELP';
-Finds and returns the parasite that was previously attached
-to a vectors object.
-HELP
-
+    &std_pdb_deprecated ('gimp-item-parasite-find');
     &mitch_pdb_misc('2006', '2.4');
 
     @inargs = (
@@ -478,12 +455,7 @@ CODE
 }
 
 sub vectors_parasite_attach {
-    $blurb = 'Add a parasite to a vectors object';
-
-    $help = <<'HELP';
-This procedure attaches a parasite to a vectors object. It has no return values.
-HELP
-
+    &std_pdb_deprecated ('gimp-item-parasite-attach');
     &mitch_pdb_misc('2006', '2.4');
 
     @inargs = (
@@ -503,13 +475,7 @@ CODE
 }
 
 sub vectors_parasite_detach {
-    $blurb = 'Removes a parasite from a vectors object';
-
-    $help = <<'HELP';
-This procedure detaches a parasite from a vectors object.
-It has no return values.
-HELP
-
+    &std_pdb_deprecated ('gimp-item-parasite-detach');
     &mitch_pdb_misc('2006', '2.4');
 
     @inargs = (
@@ -529,9 +495,7 @@ CODE
 }
 
 sub vectors_parasite_list {
-    $blurb = 'List all parasites.';
-    $help  = 'Returns a list of all currently attached parasites.';
-
+    &std_pdb_deprecated ('gimp-item-parasite-list');
     &mitch_pdb_misc('2006', '2.4');
 
     @inargs = (



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]