pdb, libgimp: move the old file proc registering API to gimplegacy.[ch]

Also, #define GIMP_DISABLE_COMPAT_CRUFT in all GimpPlugIn related
files to prevent accidential use of the old API.

libgimp/gimp.c

@@ -90,6 +90,8 @@
 
 #include <locale.h>
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
 
 #include "libgimpbase/gimpbase-private.h"

libgimp/gimpfileops_pdb.c

@@ -297,7 +297,7 @@ gimp_file_save_thumbnail (gint32       image_ID,
 }
 
 /**
- * gimp_register_magic_load_handler:
+ * _gimp_register_magic_load_handler:
  * @procedure_name: The name of the procedure to be used for loading.
  * @extensions: comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").
  * @prefixes: comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").
@@ -311,7 +311,7 @@ gimp_file_save_thumbnail (gint32       image_ID,
  * Returns: TRUE on success.
  **/
 gboolean
-gimp_register_magic_load_handler (const gchar *procedure_name,
+_gimp_register_magic_load_handler (const gchar *procedure_name,
                                    const gchar *extensions,
                                    const gchar *prefixes,
                                    const gchar *magics)
@@ -345,7 +345,7 @@ gimp_register_magic_load_handler (const gchar *procedure_name,
 }
 
 /**
- * gimp_register_load_handler:
+ * _gimp_register_load_handler:
  * @procedure_name: The name of the procedure to be used for loading.
  * @extensions: comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").
  * @prefixes: comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").
@@ -358,7 +358,7 @@ gimp_register_magic_load_handler (const gchar *procedure_name,
  * Returns: TRUE on success.
  **/
 gboolean
-gimp_register_load_handler (const gchar *procedure_name,
+_gimp_register_load_handler (const gchar *procedure_name,
                              const gchar *extensions,
                              const gchar *prefixes)
 {
@@ -390,7 +390,7 @@ gimp_register_load_handler (const gchar *procedure_name,
 }
 
 /**
- * gimp_register_save_handler:
+ * _gimp_register_save_handler:
  * @procedure_name: The name of the procedure to be used for saving.
  * @extensions: comma separated list of extensions this handler can save (i.e. \"jpg,jpeg\").
  * @prefixes: comma separated list of prefixes this handler can save (i.e. \"http:,ftp:\").
@@ -403,7 +403,7 @@ gimp_register_load_handler (const gchar *procedure_name,
  * Returns: TRUE on success.
  **/
 gboolean
-gimp_register_save_handler (const gchar *procedure_name,
+_gimp_register_save_handler (const gchar *procedure_name,
                              const gchar *extensions,
                              const gchar *prefixes)
 {
@@ -435,7 +435,7 @@ gimp_register_save_handler (const gchar *procedure_name,
 }
 
 /**
- * gimp_register_file_handler_priority:
+ * _gimp_register_file_handler_priority:
  * @procedure_name: The name of the procedure to set the priority of.
  * @priority: The procedure priority.
  *
@@ -452,7 +452,7 @@ gimp_register_save_handler (const gchar *procedure_name,
  * Since: 2.10.6
  **/
 gboolean
-gimp_register_file_handler_priority (const gchar *procedure_name,
+_gimp_register_file_handler_priority (const gchar *procedure_name,
                                       gint         priority)
 {
   GimpPDB        *pdb = gimp_get_pdb ();
@@ -482,7 +482,7 @@ gimp_register_file_handler_priority (const gchar *procedure_name,
 }
 
 /**
- * gimp_register_file_handler_mime:
+ * _gimp_register_file_handler_mime:
  * @procedure_name: The name of the procedure to associate a MIME type with.
  * @mime_types: A comma-separated list of MIME types, such as \"image/jpeg\".
  *
@@ -500,7 +500,7 @@ gimp_register_file_handler_priority (const gchar *procedure_name,
  * Since: 2.2
  **/
 gboolean
-gimp_register_file_handler_mime (const gchar *procedure_name,
+_gimp_register_file_handler_mime (const gchar *procedure_name,
                                   const gchar *mime_types)
 {
   GimpPDB        *pdb = gimp_get_pdb ();
@@ -530,7 +530,7 @@ gimp_register_file_handler_mime (const gchar *procedure_name,
 }
 
 /**
- * gimp_register_file_handler_uri:
+ * _gimp_register_file_handler_uri:
  * @procedure_name: The name of the procedure to enable URIs for.
  *
  * Registers a file handler procedure as capable of handling URIs.
@@ -545,7 +545,7 @@ gimp_register_file_handler_mime (const gchar *procedure_name,
  * Since: 2.10
  **/
 gboolean
-gimp_register_file_handler_uri (const gchar *procedure_name)
+_gimp_register_file_handler_uri (const gchar *procedure_name)
 {
   GimpPDB        *pdb = gimp_get_pdb ();
   GimpValueArray *args;
@@ -573,7 +573,7 @@ gimp_register_file_handler_uri (const gchar *procedure_name)
 }
 
 /**
- * gimp_register_file_handler_raw:
+ * _gimp_register_file_handler_raw:
  * @procedure_name: The name of the procedure to enable raw handling for.
  *
  * Registers a file handler procedure as capable of handling raw camera
@@ -588,7 +588,7 @@ gimp_register_file_handler_uri (const gchar *procedure_name)
  * Since: 2.10
  **/
 gboolean
-gimp_register_file_handler_raw (const gchar *procedure_name)
+_gimp_register_file_handler_raw (const gchar *procedure_name)
 {
   GimpPDB        *pdb = gimp_get_pdb ();
   GimpValueArray *args;

libgimp/gimpfileops_pdb.h

@@ -49,22 +49,22 @@ gboolean gimp_file_save                      (GimpRunMode  run_mode,
                                                                const gchar *raw_filename);
 gboolean                 gimp_file_save_thumbnail             (gint32       image_ID,
                                                                const gchar *filename);
-gboolean gimp_register_magic_load_handler    (const gchar *procedure_name,
+G_GNUC_INTERNAL gboolean _gimp_register_magic_load_handler    (const gchar *procedure_name,
                                                                const gchar *extensions,
                                                                const gchar *prefixes,
                                                                const gchar *magics);
-gboolean gimp_register_load_handler          (const gchar *procedure_name,
+G_GNUC_INTERNAL gboolean _gimp_register_load_handler          (const gchar *procedure_name,
                                                                const gchar *extensions,
                                                                const gchar *prefixes);
-gboolean gimp_register_save_handler          (const gchar *procedure_name,
+G_GNUC_INTERNAL gboolean _gimp_register_save_handler          (const gchar *procedure_name,
                                                                const gchar *extensions,
                                                                const gchar *prefixes);
-gboolean gimp_register_file_handler_priority (const gchar *procedure_name,
+G_GNUC_INTERNAL gboolean _gimp_register_file_handler_priority (const gchar *procedure_name,
                                                                gint         priority);
-gboolean gimp_register_file_handler_mime     (const gchar *procedure_name,
+G_GNUC_INTERNAL gboolean _gimp_register_file_handler_mime     (const gchar *procedure_name,
                                                                const gchar *mime_types);
-gboolean gimp_register_file_handler_uri      (const gchar *procedure_name);
+G_GNUC_INTERNAL gboolean _gimp_register_file_handler_uri      (const gchar *procedure_name);
-gboolean gimp_register_file_handler_raw      (const gchar *procedure_name);
+G_GNUC_INTERNAL gboolean _gimp_register_file_handler_raw      (const gchar *procedure_name);
 gboolean                 gimp_register_thumbnail_loader       (const gchar *load_proc,
                                                                const gchar *thumb_proc);
 

libgimp/gimpfileprocedure.c

@@ -20,6 +20,8 @@
 
 #include "config.h"
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
 #include "gimpfileprocedure.h"
 

libgimp/gimplegacy.c

@@ -1223,6 +1223,179 @@ gimp_plugin_icon_register (const gchar   *procedure_name,
   return success;
 }
 
+/**
+ * gimp_register_magic_load_handler:
+ * @procedure_name: The name of the procedure to be used for loading.
+ * @extensions: comma separated list of extensions this handler can load (i.e. "jpg,jpeg").
+ * @prefixes: comma separated list of prefixes this handler can load (i.e. "http:,ftp:").
+ * @magics: comma separated list of magic file information this handler can load (i.e. "0,string,GIF").
+ *
+ * Registers a file load handler procedure.
+ *
+ * Registers a procedural database procedure to be called to load files
+ * of a particular file format using magic file information.
+ *
+ * Returns: TRUE on success.
+ **/
+gboolean
+gimp_register_magic_load_handler (const gchar *procedure_name,
+                                  const gchar *extensions,
+                                  const gchar *prefixes,
+                                  const gchar *magics)
+{
+  ASSERT_NO_PLUG_IN_EXISTS (G_STRFUNC);
+
+  return _gimp_register_magic_load_handler (procedure_name,
+                                            extensions, prefixes, magics);
+}
+
+/**
+ * gimp_register_load_handler:
+ * @procedure_name: The name of the procedure to be used for loading.
+ * @extensions: comma separated list of extensions this handler can load (i.e. "jpg,jpeg").
+ * @prefixes: comma separated list of prefixes this handler can load (i.e. "http:,ftp:").
+ *
+ * Registers a file load handler procedure.
+ *
+ * Registers a procedural database procedure to be called to load files
+ * of a particular file format.
+ *
+ * Returns: TRUE on success.
+ **/
+gboolean
+gimp_register_load_handler (const gchar *procedure_name,
+                            const gchar *extensions,
+                            const gchar *prefixes)
+{
+  ASSERT_NO_PLUG_IN_EXISTS (G_STRFUNC);
+
+  return _gimp_register_load_handler (procedure_name,
+                                      extensions, prefixes);
+}
+
+/**
+ * gimp_register_save_handler:
+ * @procedure_name: The name of the procedure to be used for saving.
+ * @extensions: comma separated list of extensions this handler can save (i.e. "jpg,jpeg").
+ * @prefixes: comma separated list of prefixes this handler can save (i.e. "http:,ftp:").
+ *
+ * Registers a file save handler procedure.
+ *
+ * Registers a procedural database procedure to be called to save files
+ * in a particular file format.
+ *
+ * Returns: TRUE on success.
+ **/
+gboolean
+gimp_register_save_handler (const gchar *procedure_name,
+                            const gchar *extensions,
+                            const gchar *prefixes)
+{
+  ASSERT_NO_PLUG_IN_EXISTS (G_STRFUNC);
+
+  return _gimp_register_save_handler (procedure_name,
+                                      extensions, prefixes);
+}
+
+/**
+ * gimp_register_file_handler_priority:
+ * @procedure_name: The name of the procedure to set the priority of.
+ * @priority: The procedure priority.
+ *
+ * Sets the priority of a file handler procedure.
+ *
+ * Sets the priority of a file handler procedure. When more than one
+ * procedure matches a given file, the procedure with the lowest
+ * priority is used; if more than one procedure has the lowest
+ * priority, it is unspecified which one of them is used. The default
+ * priority for file handler procedures is 0.
+ *
+ * Returns: TRUE on success.
+ *
+ * Since: 2.10.6
+ **/
+gboolean
+gimp_register_file_handler_priority (const gchar *procedure_name,
+                                     gint         priority)
+{
+  ASSERT_NO_PLUG_IN_EXISTS (G_STRFUNC);
+
+  return _gimp_register_file_handler_priority (procedure_name, priority);
+}
+
+/**
+ * gimp_register_file_handler_mime:
+ * @procedure_name: The name of the procedure to associate a MIME type with.
+ * @mime_types: A comma-separated list of MIME types, such as \"image/jpeg\".
+ *
+ * Associates MIME types with a file handler procedure.
+ *
+ * Registers MIME types for a file handler procedure. This allows GIMP
+ * to determine the MIME type of the file opened or saved using this
+ * procedure. It is recommended that only one MIME type is registered
+ * per file procedure; when registering more than one MIME type, GIMP
+ * will associate the first one with files opened or saved with this
+ * procedure.
+ *
+ * Returns: TRUE on success.
+ *
+ * Since: 2.2
+ **/
+gboolean
+gimp_register_file_handler_mime (const gchar *procedure_name,
+                                 const gchar *mime_types)
+{
+  ASSERT_NO_PLUG_IN_EXISTS (G_STRFUNC);
+
+  return _gimp_register_file_handler_mime (procedure_name, mime_types);
+}
+
+/**
+ * gimp_register_file_handler_uri:
+ * @procedure_name: The name of the procedure to enable URIs for.
+ *
+ * Registers a file handler procedure as capable of handling URIs.
+ *
+ * Registers a file handler procedure as capable of handling URIs. This
+ * allows GIMP to call the procedure directly for all kinds of URIs,
+ * and the 'filename' traditionally passed to file procedures turns
+ * into an URI.
+ *
+ * Returns: TRUE on success.
+ *
+ * Since: 2.10
+ **/
+gboolean
+gimp_register_file_handler_uri (const gchar *procedure_name)
+{
+  ASSERT_NO_PLUG_IN_EXISTS (G_STRFUNC);
+
+  return _gimp_register_file_handler_uri (procedure_name);
+}
+
+/**
+ * gimp_register_file_handler_raw:
+ * @procedure_name: The name of the procedure to enable raw handling for.
+ *
+ * Registers a file handler procedure as capable of handling raw camera
+ * files.
+ *
+ * Registers a file handler procedure as capable of handling raw
+ * digital camera files. Use this procedure only to register raw load
+ * handlers, calling it on a save handler will generate an error.
+ *
+ * Returns: TRUE on success.
+ *
+ * Since: 2.10
+ **/
+gboolean
+gimp_register_file_handler_raw (const gchar *procedure_name)
+{
+  ASSERT_NO_PLUG_IN_EXISTS (G_STRFUNC);
+
+  return _gimp_register_file_handler_raw (procedure_name);
+}
+
 /**
  * gimp_pdb_temp_name:
  *

libgimp/gimplegacy.h

@@ -309,6 +309,26 @@ gboolean   gimp_plugin_icon_register        (const gchar   *procedure_name,
                                              GimpIconType   icon_type,
                                              gconstpointer  icon_data);
 
+/* gimp_fileops API that should now be done by using GimpFileProcedure
+ */
+
+gboolean   gimp_register_magic_load_handler    (const gchar *procedure_name,
+                                                const gchar *extensions,
+                                                const gchar *prefixes,
+                                                const gchar *magics);
+gboolean   gimp_register_load_handler          (const gchar *procedure_name,
+                                                const gchar *extensions,
+                                                const gchar *prefixes);
+gboolean   gimp_register_save_handler          (const gchar *procedure_name,
+                                                const gchar *extensions,
+                                                const gchar *prefixes);
+gboolean   gimp_register_file_handler_priority (const gchar *procedure_name,
+                                                gint         priority);
+gboolean   gimp_register_file_handler_mime     (const gchar *procedure_name,
+                                                const gchar *mime_types);
+gboolean   gimp_register_file_handler_uri      (const gchar *procedure_name);
+gboolean   gimp_register_file_handler_raw      (const gchar *procedure_name);
+
 /* pdb stuff that should now be done using GimpPDB
  */
 

libgimp/gimploadprocedure.c

@@ -20,7 +20,10 @@
 
 #include "config.h"
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
+
 #include "gimploadprocedure.h"
 
 
@@ -123,33 +126,33 @@ gimp_load_procedure_install (GimpProcedure *procedure)
 
   if (gimp_file_procedure_get_magics (file_proc))
     {
-      gimp_register_magic_load_handler (gimp_procedure_get_name (procedure),
+      _gimp_register_magic_load_handler (gimp_procedure_get_name (procedure),
                                          gimp_file_procedure_get_extensions (file_proc),
                                          gimp_file_procedure_get_prefixes (file_proc),
                                          gimp_file_procedure_get_magics (file_proc));
     }
   else
     {
-      gimp_register_load_handler (gimp_procedure_get_name (procedure),
+      _gimp_register_load_handler (gimp_procedure_get_name (procedure),
                                    gimp_file_procedure_get_extensions (file_proc),
                                    gimp_file_procedure_get_prefixes (file_proc));
     }
 
   if (gimp_file_procedure_get_handles_uri (file_proc))
-    gimp_register_file_handler_uri (gimp_procedure_get_name (procedure));
+    _gimp_register_file_handler_uri (gimp_procedure_get_name (procedure));
 
   mime_types = gimp_file_procedure_get_mime_types (file_proc);
   if (mime_types)
-    gimp_register_file_handler_mime (gimp_procedure_get_name (procedure),
+    _gimp_register_file_handler_mime (gimp_procedure_get_name (procedure),
                                       mime_types);
 
   priority = gimp_file_procedure_get_priority (file_proc);
   if (priority != 0)
-    gimp_register_file_handler_priority (gimp_procedure_get_name (procedure),
+    _gimp_register_file_handler_priority (gimp_procedure_get_name (procedure),
                                           priority);
 
   if (load_proc->priv->handles_raw)
-    gimp_register_file_handler_raw (gimp_procedure_get_name (procedure));
+    _gimp_register_file_handler_raw (gimp_procedure_get_name (procedure));
 }
 
 static GimpValueArray *

libgimp/gimppdb.c

@@ -20,6 +20,8 @@
 
 #include "config.h"
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
 
 #include "libgimpbase/gimpprotocol.h"

libgimp/gimppdbprocedure.c

@@ -20,7 +20,10 @@
 
 #include "config.h"
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
+
 #include "gimppdb-private.h"
 #include "gimppdb_pdb.h"
 #include "gimppdbprocedure.h"

libgimp/gimpplugin-private.c

@@ -21,6 +21,8 @@
 
 #include "config.h"
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
 
 #include "libgimpbase/gimpprotocol.h"

libgimp/gimpplugin.c

@@ -24,6 +24,8 @@
 #include <errno.h>
 #include <string.h>
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
 
 #include "libgimpbase/gimpprotocol.h"

libgimp/gimpprocedure.c

@@ -23,6 +23,8 @@
 #include <stdarg.h>
 #include <sys/types.h>
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
 
 #include "libgimpbase/gimpprotocol.h"

libgimp/gimpsaveprocedure.c

@@ -20,7 +20,10 @@
 
 #include "config.h"
 
+#define GIMP_DISABLE_COMPAT_CRUFT
+
 #include "gimp.h"
+
 #include "gimpsaveprocedure.h"
 
 
@@ -124,21 +127,21 @@ gimp_save_procedure_install (GimpProcedure *procedure)
 
   GIMP_PROCEDURE_CLASS (parent_class)->install (procedure);
 
-  gimp_register_save_handler (gimp_procedure_get_name (procedure),
+  _gimp_register_save_handler (gimp_procedure_get_name (procedure),
                                gimp_file_procedure_get_extensions (file_proc),
                                gimp_file_procedure_get_prefixes (file_proc));
 
   if (gimp_file_procedure_get_handles_uri (file_proc))
-    gimp_register_file_handler_uri (gimp_procedure_get_name (procedure));
+    _gimp_register_file_handler_uri (gimp_procedure_get_name (procedure));
 
   mime_types = gimp_file_procedure_get_mime_types (file_proc);
   if (mime_types)
-    gimp_register_file_handler_mime (gimp_procedure_get_name (procedure),
+    _gimp_register_file_handler_mime (gimp_procedure_get_name (procedure),
                                       mime_types);
 
   priority = gimp_file_procedure_get_priority (file_proc);
   if (priority != 0)
-    gimp_register_file_handler_priority (gimp_procedure_get_name (procedure),
+    _gimp_register_file_handler_priority (gimp_procedure_get_name (procedure),
                                           priority);
 }
 

pdb/groups/fileops.pdb

@@ -453,6 +453,8 @@ HELP
 
     &std_pdb_misc;
 
+    $lib_private = 1;
+
     @inargs = (
         { name => 'procedure_name', type => 'string', non_empty => 1,
           desc => 'The name of the procedure to be used for loading' },
@@ -492,6 +494,8 @@ HELP
 
     &std_pdb_misc;
 
+    $lib_private = 1;
+
     @inargs = (
         { name => 'procedure_name', type => 'string', non_empty => 1,
           desc => 'The name of the procedure to be used for loading' },
@@ -529,6 +533,8 @@ HELP
 
     &std_pdb_misc;
 
+    $lib_private = 1;
+
     @inargs = (
         { name => 'procedure_name', type => 'string', non_empty => 1,
           desc => 'The name of the procedure to be used for saving' },
@@ -568,6 +574,8 @@ HELP
 
     &ell_pdb_misc('2018', '2.10.6');
 
+    $lib_private = 1;
+
     @inargs = (
         { name => 'procedure_name', type => 'string', non_empty => 1,
           desc => "The name of the procedure to set the priority of." },
@@ -601,6 +609,8 @@ HELP
 
     &mitch_pdb_misc('2012', '2.10');
 
+    $lib_private = 1;
+
     @inargs = (
         { name => 'procedure_name', type => 'string', non_empty => 1,
           desc => "The name of the procedure to enable URIs for." }
@@ -633,6 +643,8 @@ HELP
 
     &neo_pdb_misc('2004', '2.2');
 
+    $lib_private = 1;
+
     @inargs = (
         { name => 'procedure_name', type => 'string', non_empty => 1,
           desc => "The name of the procedure to associate a MIME type with." },
@@ -665,6 +677,8 @@ HELP
 
     &mitch_pdb_misc('2017', '2.10');
 
+    $lib_private = 1;
+
     @inargs = (
         { name => 'procedure_name', type => 'string', non_empty => 1,
           desc => "The name of the procedure to enable raw handling for." }