Rework document types managing to avoid code duplication and actually

2005-07-05  Marco Pesenti Gritti  <mpg@redhat.com>

        * backend/Makefile.am:
        * backend/ev-document-factory.c:
        (mime_type_supported_by_gdk_pixbuf),
        (ev_document_type_get_from_mime),
        (ev_document_factory_get_document),
        (ev_document_factory_get_backend),
        (ev_document_factory_get_mime_types),
        (ev_document_factory_get_all_mime_types):
        * backend/ev-document-factory.h:
        * shell/Makefile.am:
        * shell/ev-document-types.c: (get_document_from_uri),
        (ev_document_types_get_document),
        (file_filter_add_mime_list_and_free),
        (ev_document_types_add_filters):
        * shell/ev-document-types.h:
        * shell/ev-job-xfer.c: (ev_job_xfer_run):
        * shell/ev-properties-dialog.c:
        (ev_properties_dialog_set_document):
        * shell/ev-window.c: (ev_window_cmd_file_open),
        (ev_window_cmd_save_as):
        * thumbnailer/evince-thumbnailer.c: (evince_thumbnail_pngenc_get):

        Rework document types managing to avoid code duplication
        and actually abstract from backend implementations.
        Also provide a minimal factory api that can be used by
        thumbnailer/properties.

1 files changed, 84 insertions, 264 deletions

diff --git a/shell/ev-document-types.c b/shell/ev-document-types.c
index 724412f..d2078c5 100644
--- a/shell/ev-document-types.c
+++ b/shell/ev-document-types.c
@@ -23,18 +23,7 @@
 #endif
 
 #include "ev-document-types.h"
-
-/* The various document type backends: */
-#include "ev-poppler.h"
-#include "pixbuf-document.h"
-#include "tiff-document.h"
-#include "ps-document.h"
-#ifdef ENABLE_DVI
-#include "dvi-document.h"
-#endif
-#ifdef ENABLE_DJVU
-#include "djvu-document.h"
-#endif
+#include "ev-document-factory.h"
 
 #include <string.h>
 #include <glib/gi18n.h>
@@ -43,116 +32,13 @@
 #include <libgnomevfs/gnome-vfs-ops.h>
 #include <gtk/gtkfilechooserdialog.h>
 
-typedef struct _EvDocumentType EvDocumentType;
-struct _EvDocumentType
-{
-	const char *mime_type;
-	GType (*document_type_factory_callback)();
-};
-
-const EvDocumentType document_types[] = {
-	/* PDF: */
-	{"application/pdf",            pdf_document_get_type},
-
-	/* Postscript: */
-	{"application/postscript",     ps_document_get_type},
-	{"application/x-gzpostscript", ps_document_get_type},
-	{"image/x-eps",                ps_document_get_type},
-
-#ifdef ENABLE_TIFF
-	/* Tiff: */
-	{"image/tiff",                 tiff_document_get_type},
-#endif
-
-#ifdef ENABLE_DJVU
-	/* djvu: */
-	{"image/vnd.djvu",             djvu_document_get_type},
-#endif		
-
-#ifdef ENABLE_DVI
-	/* dvi: */
-	{"application/x-dvi",          dvi_document_get_type},
-#endif
-};
-
-/* Would be nice to have this in gdk-pixbuf */
-static gboolean
-mime_type_supported_by_gdk_pixbuf (const gchar *mime_type)
-{
-	GSList *formats, *list;
-	gboolean retval = FALSE;
-
-	formats = gdk_pixbuf_get_formats ();
-
-	list = formats;
-	while (list) {
-		GdkPixbufFormat *format = list->data;
-		int i;
-		gchar **mime_types;
-
-		if (gdk_pixbuf_format_is_disabled (format))
-			continue;
-
-		mime_types = gdk_pixbuf_format_get_mime_types (format);
-
-		for (i = 0; mime_types[i] != NULL; i++) {
-			if (strcmp (mime_types[i], mime_type) == 0) {
-				retval = TRUE;
-				break;
-			}
-		}
-
-		if (retval)
-			break;
-
-		list = list->next;
-	}
-
-	g_slist_free (formats);
-
-	return retval;
-}
-
-
-static GType
-ev_document_type_from_from_mime (const char *mime_type)
-{
-	int i;
-	
-	g_return_val_if_fail (mime_type, G_TYPE_INVALID);
-
-	for (i = 0; i < G_N_ELEMENTS (document_types); i++) {
-		if (strcmp (mime_type, document_types[i].mime_type) == 0) {
-			g_assert (document_types[i].document_type_factory_callback != NULL);
-			return document_types[i].document_type_factory_callback();
-		}
-	}
-
-	if (mime_type_supported_by_gdk_pixbuf (mime_type)) {
-		return pixbuf_document_get_type ();
-	}
-
-	return G_TYPE_INVALID;
-}
-
-/**
- * ev_document_type_get_type:
- * @uri: String with uri
- * @slow: Do we need to check slow gnome-vfs mime type
- * @mime_type: If we've found handled type, the mime_type string is returned here.
- * @error: Information about error occured
- * 
- * Return value: G_TYPE_INVALID on error, G_TYPE_NONE when we are not sure about
- * mime type, and type of EvDocument implementation when we've found document.
- **/
-static GType
-ev_document_type_get_type (const char *uri, gboolean slow, gchar **mime_type, GError **error)
+static EvDocument *
+get_document_from_uri (const char *uri, gboolean slow, gchar **mime_type, GError **error)
 {
+	EvDocument *document;
         GnomeVFSFileInfo *info;
         GnomeVFSResult result;
 
-        GType type = G_TYPE_INVALID;
-	
         info = gnome_vfs_file_info_new ();
         result = gnome_vfs_get_file_info (uri, info,
 	    			          GNOME_VFS_FILE_INFO_GET_MIME_TYPE |
@@ -164,7 +50,7 @@ ev_document_type_get_type (const char *uri, gboolean slow, gchar **mime_type, GE
 			     0,
 			     gnome_vfs_result_to_string (result));			
 		gnome_vfs_file_info_unref (info);
-		return G_TYPE_INVALID;
+		return NULL;
         } 
 	
 	if (info->mime_type == NULL) {
@@ -173,195 +59,129 @@ ev_document_type_get_type (const char *uri, gboolean slow, gchar **mime_type, GE
     			     0,
 			     _("Unknown MIME Type"));
 		gnome_vfs_file_info_unref (info);
-		return slow ? G_TYPE_INVALID : G_TYPE_NONE;
+		return NULL;
 	}
 	
-	type = ev_document_type_from_from_mime (info->mime_type);
+	document = ev_document_factory_get_document (info->mime_type);
 	
-	if (type == G_TYPE_INVALID) {
+	if (document == NULL) {
 		g_set_error (error,
 			     EV_DOCUMENT_ERROR,	
 			     0,
 			     _("Unhandled MIME type: '%s'"), info->mime_type);
 		gnome_vfs_file_info_unref (info);
-		return slow ? G_TYPE_INVALID : G_TYPE_NONE;
+		return NULL;
 	}			
 
 	if (mime_type != NULL) {
 		    *mime_type = g_strdup (info->mime_type);
 	}
+
         gnome_vfs_file_info_unref (info);
 	
-        return type;
+        return document;
 }
 
-GType
-ev_document_type_lookup (const char *uri, gchar **mime_type, GError **error)
+EvDocument *
+ev_document_types_get_document (const char *uri, gchar **mime_type, GError **error)
 {
-	GType type = G_TYPE_INVALID;
+	EvDocument *document;
 	
-	type = ev_document_type_get_type (uri, FALSE, mime_type, error);
+	document = get_document_from_uri (uri, FALSE, mime_type, error);
 
-	if (type != G_TYPE_NONE)
-		return type;
+	if (document != NULL) {
+		return document;
+	}
 		
 	if (error) {
 		g_error_free (*error);
 		*error = NULL;
 	}
 
-	type = ev_document_type_get_type (uri, TRUE, mime_type, error);
+	document = get_document_from_uri (uri, TRUE, mime_type, error);
 
-	return type;
+	return document;
 }
 
-void 
-ev_document_types_add_filters (GtkWidget *chooser)
+static void
+file_filter_add_mime_list_and_free (GtkFileFilter *filter, GList *mime_types)
 {
-	GtkFileFilter *documents_filter;
-	GtkFileFilter *pdf_filter;
-	GtkFileFilter *ps_filter;
-	GtkFileFilter *pixbuf_filter;
-	GtkFileFilter *all_filter;
-#ifdef ENABLE_DJVU
-	GtkFileFilter *djvu_filter;
-#endif
-#ifdef ENABLE_DVI
-	GtkFileFilter *dvi_filter;
-#endif
-
-	documents_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (documents_filter,
-				  _("All Documents"));
-	gtk_file_filter_add_mime_type (documents_filter, "application/postscript");
-	gtk_file_filter_add_mime_type (documents_filter, "application/x-gzpostscript");
-	gtk_file_filter_add_mime_type (documents_filter, "image/x-eps");
-	gtk_file_filter_add_mime_type (documents_filter, "application/pdf");
-#ifdef ENABLE_DVI
-	gtk_file_filter_add_mime_type (documents_filter, "application/x-dvi");
-#endif
-	gtk_file_filter_add_pixbuf_formats (documents_filter);
-#ifdef ENABLE_DJVU
-	gtk_file_filter_add_mime_type (documents_filter, "image/vnd.djvu");
-#endif
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), documents_filter);
+	GList *l;
 
-	ps_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (ps_filter, _("PostScript Documents"));
-	gtk_file_filter_add_mime_type (ps_filter, "application/postscript");
-	gtk_file_filter_add_mime_type (ps_filter, "application/x-gzpostscript");
-	gtk_file_filter_add_mime_type (ps_filter, "image/x-eps");
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), ps_filter);
-
-	pdf_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (pdf_filter, _("PDF Documents"));
-	gtk_file_filter_add_mime_type (pdf_filter, "application/pdf");
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), pdf_filter);
-
-#ifdef ENABLE_DVI
-	dvi_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (dvi_filter, _("DVI Documents"));
-	gtk_file_filter_add_mime_type (dvi_filter, "application/x-dvi");
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), dvi_filter);
-#endif
-
-	pixbuf_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (pixbuf_filter, _("Images"));
-	gtk_file_filter_add_pixbuf_formats (pixbuf_filter);
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), pixbuf_filter);
-
-#ifdef ENABLE_DJVU
-	djvu_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (djvu_filter, _("Djvu Documents"));
-	gtk_file_filter_add_mime_type (djvu_filter, "image/vnd.djvu");
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), djvu_filter);
-#endif	
-	
-	all_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (all_filter, _("All Files"));
-	gtk_file_filter_add_pattern (all_filter, "*");
+	for (l = mime_types; l != NULL; l = l->next) {
+		gtk_file_filter_add_mime_type (filter, l->data);
+	}
 
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), all_filter);
-	gtk_file_chooser_set_filter (GTK_FILE_CHOOSER (chooser), documents_filter);
+	g_list_foreach (mime_types, (GFunc)g_free, NULL);
+	g_list_free (mime_types);
 }
 
 void 
-ev_document_types_add_filters_for_type (GtkWidget *chooser, GType type)
+ev_document_types_add_filters (GtkWidget *chooser, EvDocument *document)
 {
-	GtkFileFilter *documents_filter;
-	GtkFileFilter *pdf_filter;
-	GtkFileFilter *ps_filter;
-	GtkFileFilter *pixbuf_filter;
-	GtkFileFilter *all_filter;
-#ifdef ENABLE_DJVU
-	GtkFileFilter *djvu_filter;
-#endif
-#ifdef ENABLE_DVI
-	GtkFileFilter *dvi_filter;
-#endif
+	EvBackend backend = 0;
+	GList *mime_types;
+	GtkFileFilter *filter;
 	GtkFileFilter *default_filter;
 
-	documents_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (documents_filter,
-				  _("All Documents"));
-	gtk_file_filter_add_mime_type (documents_filter, "application/postscript");
-	gtk_file_filter_add_mime_type (documents_filter, "application/x-gzpostscript");
-	gtk_file_filter_add_mime_type (documents_filter, "image/x-eps");
-	gtk_file_filter_add_mime_type (documents_filter, "application/pdf");
-#ifdef ENABLE_DVI
-	gtk_file_filter_add_mime_type (documents_filter, "application/x-dvi");
-#endif
-	gtk_file_filter_add_pixbuf_formats (documents_filter);
-#ifdef ENABLE_DJVU
-	gtk_file_filter_add_mime_type (documents_filter, "image/vnd.djvu");
-#endif
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), documents_filter);
+	if (document != NULL) {
+		backend = ev_document_factory_get_backend (document);
+	}
+
+	default_filter = filter = gtk_file_filter_new ();
+	gtk_file_filter_set_name (filter, _("All Documents"));
+	mime_types = ev_document_factory_get_all_mime_types ();
+	file_filter_add_mime_list_and_free (filter, mime_types);
+	gtk_file_filter_add_pixbuf_formats (filter);
+	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
+
+	if (document == NULL || backend == EV_BACKEND_PS) {
+		default_filter = filter = gtk_file_filter_new ();
+		gtk_file_filter_set_name (filter, _("PostScript Documents"));
+		mime_types = ev_document_factory_get_mime_types (EV_BACKEND_PS);
+		file_filter_add_mime_list_and_free (filter, mime_types);
+		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
+	}
+
+	if (document == NULL || backend == EV_BACKEND_PDF) {
+		default_filter = filter = gtk_file_filter_new ();
+		gtk_file_filter_set_name (filter, _("PDF Documents"));
+		mime_types = ev_document_factory_get_mime_types (EV_BACKEND_PDF);
+		file_filter_add_mime_list_and_free (filter, mime_types);
+		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
+	}
+
+	if (document == NULL || backend == EV_BACKEND_PIXBUF) {
+		default_filter = filter = gtk_file_filter_new ();
+		gtk_file_filter_set_name (filter, _("Images"));
+		gtk_file_filter_add_pixbuf_formats (filter);
+		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
+	}
 
-	if (type == PS_TYPE_DOCUMENT) {
-        	ps_filter = gtk_file_filter_new ();
-		gtk_file_filter_set_name (ps_filter, _("PostScript Documents"));
-		gtk_file_filter_add_mime_type (ps_filter, "application/postscript");
-		gtk_file_filter_add_mime_type (ps_filter, "application/x-gzpostscript");
-		gtk_file_filter_add_mime_type (ps_filter, "image/x-eps");
-		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), ps_filter);
-		default_filter = ps_filter;
-	} else if (type == PDF_TYPE_DOCUMENT) {
-		pdf_filter = gtk_file_filter_new ();
-		gtk_file_filter_set_name (pdf_filter, _("PDF Documents"));
-		gtk_file_filter_add_mime_type (pdf_filter, "application/pdf");
-		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), pdf_filter);
-		default_filter = pdf_filter;
 #ifdef ENABLE_DVI
-	} else if (type == DVI_TYPE_DOCUMENT) {
-    	    	dvi_filter = gtk_file_filter_new ();
-		gtk_file_filter_set_name (dvi_filter, _("DVI Documents"));
-		gtk_file_filter_add_mime_type (dvi_filter, "application/x-dvi");
-		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), dvi_filter);
-		default_filter = dvi_filter;
+	if (document == NULL || backend == EV_BACKEND_DVI) {
+		default_filter = filter = gtk_file_filter_new ();
+		gtk_file_filter_set_name (filter, _("DVI Documents"));
+		mime_types = ev_document_factory_get_mime_types (EV_BACKEND_DVI);
+		file_filter_add_mime_list_and_free (filter, mime_types);
+		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
+	}
 #endif
-	} else if (type == PIXBUF_TYPE_DOCUMENT) {
-		pixbuf_filter = gtk_file_filter_new ();
-		gtk_file_filter_set_name (pixbuf_filter, _("Images"));
-		gtk_file_filter_add_pixbuf_formats (pixbuf_filter);
-		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), pixbuf_filter);
-		default_filter = pixbuf_filter;
+
 #ifdef ENABLE_DJVU
-	} else if (type == DJVU_TYPE_DOCUMENT) {
-		djvu_filter = gtk_file_filter_new ();
-		gtk_file_filter_set_name (djvu_filter, _("Djvu Documents"));
-	    	gtk_file_filter_add_mime_type (djvu_filter, "image/vnd.djvu");
-	    	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), djvu_filter);
-		default_filter = djvu_filter;
-#endif	
-	} else {
-		default_filter = documents_filter;
+	if (document == NULL || backend == EV_BACKEND_DJVU) {
+		default_filter = filter = gtk_file_filter_new ();
+		gtk_file_filter_set_name (filter, _("Djvu Documents"));
+		mime_types = ev_document_factory_get_mime_types (EV_BACKEND_DJVU);
+		file_filter_add_mime_list_and_free (filter, mime_types);
+		gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 	}
+#endif	
 
-	all_filter = gtk_file_filter_new ();
-	gtk_file_filter_set_name (all_filter, _("All Files"));
-	gtk_file_filter_add_pattern (all_filter, "*");
+	filter = gtk_file_filter_new ();
+	gtk_file_filter_set_name (filter, _("All Files"));
+	gtk_file_filter_add_pattern (filter, "*");
+	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 
-	gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), all_filter);
 	gtk_file_chooser_set_filter (GTK_FILE_CHOOSER (chooser), default_filter);
 }
-