1 /* GTK - The GIMP Toolkit
2 * gtkprintbackend.h: Abstract printer backend interfaces
3 * Copyright (C) 2003, Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
27 #include "gtkmodules.h"
28 #include "gtkmarshalers.h"
29 #include "gtkprivate.h"
30 #include "gtkprintbackend.h"
33 #define GTK_PRINT_BACKEND_GET_PRIVATE(o) \
34 (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendPrivate))
36 static void gtk_print_backend_dispose (GObject *object);
37 static void gtk_print_backend_set_property (GObject *object,
41 static void gtk_print_backend_get_property (GObject *object,
46 struct _GtkPrintBackendPrivate
49 guint printer_list_requested : 1;
50 guint printer_list_done : 1;
51 GtkPrintBackendStatus status;
52 char **auth_info_required;
61 PRINTER_STATUS_CHANGED,
66 static guint signals[LAST_SIGNAL] = { 0 };
74 static GObjectClass *backend_parent_class;
77 gtk_print_backend_error_quark (void)
79 static GQuark quark = 0;
81 quark = g_quark_from_static_string ("gtk-print-backend-error-quark");
85 /*****************************************
86 * GtkPrintBackendModule modules *
87 *****************************************/
89 typedef struct _GtkPrintBackendModule GtkPrintBackendModule;
90 typedef struct _GtkPrintBackendModuleClass GtkPrintBackendModuleClass;
92 struct _GtkPrintBackendModule
94 GTypeModule parent_instance;
98 void (*init) (GTypeModule *module);
100 GtkPrintBackend* (*create) (void);
105 struct _GtkPrintBackendModuleClass
107 GTypeModuleClass parent_class;
110 G_DEFINE_TYPE (GtkPrintBackendModule, _gtk_print_backend_module, G_TYPE_TYPE_MODULE)
111 #define GTK_TYPE_PRINT_BACKEND_MODULE (_gtk_print_backend_module_get_type ())
112 #define GTK_PRINT_BACKEND_MODULE(module) (G_TYPE_CHECK_INSTANCE_CAST ((module), GTK_TYPE_PRINT_BACKEND_MODULE, GtkPrintBackendModule))
114 static GSList *loaded_backends;
117 gtk_print_backend_module_load (GTypeModule *module)
119 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
120 gpointer initp, exitp, createp;
122 pb_module->library = g_module_open (pb_module->path, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
123 if (!pb_module->library)
125 g_warning ("%s", g_module_error());
129 /* extract symbols from the lib */
130 if (!g_module_symbol (pb_module->library, "pb_module_init",
132 !g_module_symbol (pb_module->library, "pb_module_exit",
134 !g_module_symbol (pb_module->library, "pb_module_create",
137 g_warning ("%s", g_module_error());
138 g_module_close (pb_module->library);
143 pb_module->init = initp;
144 pb_module->exit = exitp;
145 pb_module->create = createp;
147 /* call the printbackend's init function to let it */
148 /* setup anything it needs to set up. */
149 pb_module->init (module);
155 gtk_print_backend_module_unload (GTypeModule *module)
157 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
161 g_module_close (pb_module->library);
162 pb_module->library = NULL;
164 pb_module->init = NULL;
165 pb_module->exit = NULL;
166 pb_module->create = NULL;
169 /* This only will ever be called if an error occurs during
173 gtk_print_backend_module_finalize (GObject *object)
175 GtkPrintBackendModule *module = GTK_PRINT_BACKEND_MODULE (object);
177 g_free (module->path);
179 G_OBJECT_CLASS (_gtk_print_backend_module_parent_class)->finalize (object);
183 _gtk_print_backend_module_class_init (GtkPrintBackendModuleClass *class)
185 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
186 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
188 module_class->load = gtk_print_backend_module_load;
189 module_class->unload = gtk_print_backend_module_unload;
191 gobject_class->finalize = gtk_print_backend_module_finalize;
195 gtk_print_backend_set_property (GObject *object,
200 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
201 GtkPrintBackendPrivate *priv;
203 priv = backend->priv = GTK_PRINT_BACKEND_GET_PRIVATE (backend);
208 priv->status = g_value_get_int (value);
211 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
217 gtk_print_backend_get_property (GObject *object,
222 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
223 GtkPrintBackendPrivate *priv;
225 priv = backend->priv = GTK_PRINT_BACKEND_GET_PRIVATE (backend);
230 g_value_set_int (value, priv->status);
233 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
239 _gtk_print_backend_module_init (GtkPrintBackendModule *pb_module)
243 static GtkPrintBackend *
244 _gtk_print_backend_module_create (GtkPrintBackendModule *pb_module)
248 if (g_type_module_use (G_TYPE_MODULE (pb_module)))
250 pb = pb_module->create ();
251 g_type_module_unuse (G_TYPE_MODULE (pb_module));
257 static GtkPrintBackend *
258 _gtk_print_backend_create (const gchar *backend_name)
263 GtkPrintBackendModule *pb_module;
266 for (l = loaded_backends; l != NULL; l = l->next)
270 if (strcmp (G_TYPE_MODULE (pb_module)->name, backend_name) == 0)
271 return _gtk_print_backend_module_create (pb_module);
275 if (g_module_supported ())
277 full_name = g_strconcat ("printbackend-", backend_name, NULL);
278 module_path = _gtk_find_module (full_name, "printbackends");
283 pb_module = g_object_new (GTK_TYPE_PRINT_BACKEND_MODULE, NULL);
285 g_type_module_set_name (G_TYPE_MODULE (pb_module), backend_name);
286 pb_module->path = g_strdup (module_path);
288 loaded_backends = g_slist_prepend (loaded_backends,
291 pb = _gtk_print_backend_module_create (pb_module);
293 /* Increase use-count so that we don't unload print backends.
294 * There is a problem with module unloading in the cups module,
295 * see cups_dispatch_watch_finalize for details.
297 g_type_module_use (G_TYPE_MODULE (pb_module));
300 g_free (module_path);
307 * gtk_printer_backend_load_modules:
309 * Return value: (element-type GtkPrintBackend) (transfer container):
312 gtk_print_backend_load_modules (void)
315 GtkPrintBackend *backend;
319 GtkSettings *settings;
323 settings = gtk_settings_get_default ();
325 g_object_get (settings, "gtk-print-backends", &setting, NULL);
327 setting = g_strdup (GTK_PRINT_BACKENDS);
329 backends = g_strsplit (setting, ",", -1);
331 for (i = 0; backends[i]; i++)
333 g_strchug (backends[i]);
334 g_strchomp (backends[i]);
335 backend = _gtk_print_backend_create (backends[i]);
338 result = g_list_append (result, backend);
341 g_strfreev (backends);
347 /*****************************************
349 *****************************************/
351 G_DEFINE_TYPE (GtkPrintBackend, gtk_print_backend, G_TYPE_OBJECT)
353 static void fallback_printer_request_details (GtkPrinter *printer);
354 static gboolean fallback_printer_mark_conflicts (GtkPrinter *printer,
355 GtkPrinterOptionSet *options);
356 static gboolean fallback_printer_get_hard_margins (GtkPrinter *printer,
361 static GList * fallback_printer_list_papers (GtkPrinter *printer);
362 static GtkPageSetup * fallback_printer_get_default_page_size (GtkPrinter *printer);
363 static GtkPrintCapabilities fallback_printer_get_capabilities (GtkPrinter *printer);
364 static void request_password (GtkPrintBackend *backend,
365 gpointer auth_info_required,
366 gpointer auth_info_default,
367 gpointer auth_info_display,
368 gpointer auth_info_visible,
369 const gchar *prompt);
372 gtk_print_backend_class_init (GtkPrintBackendClass *class)
374 GObjectClass *object_class;
375 object_class = (GObjectClass *) class;
377 backend_parent_class = g_type_class_peek_parent (class);
379 object_class->dispose = gtk_print_backend_dispose;
380 object_class->set_property = gtk_print_backend_set_property;
381 object_class->get_property = gtk_print_backend_get_property;
383 class->printer_request_details = fallback_printer_request_details;
384 class->printer_mark_conflicts = fallback_printer_mark_conflicts;
385 class->printer_get_hard_margins = fallback_printer_get_hard_margins;
386 class->printer_list_papers = fallback_printer_list_papers;
387 class->printer_get_default_page_size = fallback_printer_get_default_page_size;
388 class->printer_get_capabilities = fallback_printer_get_capabilities;
389 class->request_password = request_password;
391 g_object_class_install_property (object_class,
393 g_param_spec_int ("status",
395 "The status of the print backend",
396 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
397 GTK_PRINT_BACKEND_STATUS_UNAVAILABLE,
398 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
399 GTK_PARAM_READWRITE));
401 g_type_class_add_private (class, sizeof (GtkPrintBackendPrivate));
403 signals[PRINTER_LIST_CHANGED] =
404 g_signal_new (I_("printer-list-changed"),
405 G_TYPE_FROM_CLASS (class),
407 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_changed),
409 g_cclosure_marshal_VOID__VOID,
411 signals[PRINTER_LIST_DONE] =
412 g_signal_new (I_("printer-list-done"),
413 G_TYPE_FROM_CLASS (class),
415 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_done),
417 g_cclosure_marshal_VOID__VOID,
419 signals[PRINTER_ADDED] =
420 g_signal_new (I_("printer-added"),
421 G_TYPE_FROM_CLASS (class),
423 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_added),
425 g_cclosure_marshal_VOID__OBJECT,
426 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
427 signals[PRINTER_REMOVED] =
428 g_signal_new (I_("printer-removed"),
429 G_TYPE_FROM_CLASS (class),
431 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_removed),
433 g_cclosure_marshal_VOID__OBJECT,
434 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
435 signals[PRINTER_STATUS_CHANGED] =
436 g_signal_new (I_("printer-status-changed"),
437 G_TYPE_FROM_CLASS (class),
439 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_status_changed),
441 g_cclosure_marshal_VOID__OBJECT,
442 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
443 signals[REQUEST_PASSWORD] =
444 g_signal_new (I_("request-password"),
445 G_TYPE_FROM_CLASS (class),
447 G_STRUCT_OFFSET (GtkPrintBackendClass, request_password),
449 _gtk_marshal_VOID__POINTER_POINTER_POINTER_POINTER_STRING,
450 G_TYPE_NONE, 5, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_STRING);
454 gtk_print_backend_init (GtkPrintBackend *backend)
456 GtkPrintBackendPrivate *priv;
458 priv = backend->priv = GTK_PRINT_BACKEND_GET_PRIVATE (backend);
460 priv->printers = g_hash_table_new_full (g_str_hash, g_str_equal,
461 (GDestroyNotify) g_free,
462 (GDestroyNotify) g_object_unref);
463 priv->auth_info_required = NULL;
464 priv->auth_info = NULL;
468 gtk_print_backend_dispose (GObject *object)
470 GtkPrintBackend *backend;
471 GtkPrintBackendPrivate *priv;
473 backend = GTK_PRINT_BACKEND (object);
474 priv = backend->priv;
476 /* We unref the printers in dispose, not in finalize so that
477 * we can break refcount cycles with gtk_print_backend_destroy
481 g_hash_table_destroy (priv->printers);
482 priv->printers = NULL;
485 backend_parent_class->dispose (object);
490 fallback_printer_request_details (GtkPrinter *printer)
495 fallback_printer_mark_conflicts (GtkPrinter *printer,
496 GtkPrinterOptionSet *options)
502 fallback_printer_get_hard_margins (GtkPrinter *printer,
512 fallback_printer_list_papers (GtkPrinter *printer)
517 static GtkPageSetup *
518 fallback_printer_get_default_page_size (GtkPrinter *printer)
523 static GtkPrintCapabilities
524 fallback_printer_get_capabilities (GtkPrinter *printer)
531 printer_hash_to_sorted_active_list (const gchar *key,
537 printer = GTK_PRINTER (value);
539 if (gtk_printer_get_name (printer) == NULL)
542 if (!gtk_printer_is_active (printer))
545 *out_list = g_list_insert_sorted (*out_list, value, (GCompareFunc) gtk_printer_compare);
550 gtk_print_backend_add_printer (GtkPrintBackend *backend,
553 GtkPrintBackendPrivate *priv;
555 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
557 priv = backend->priv;
562 g_hash_table_insert (priv->printers,
563 g_strdup (gtk_printer_get_name (printer)),
564 g_object_ref (printer));
568 gtk_print_backend_remove_printer (GtkPrintBackend *backend,
571 GtkPrintBackendPrivate *priv;
573 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
574 priv = backend->priv;
579 g_hash_table_remove (priv->printers,
580 gtk_printer_get_name (printer));
584 gtk_print_backend_set_list_done (GtkPrintBackend *backend)
586 if (!backend->priv->printer_list_done)
588 backend->priv->printer_list_done = TRUE;
589 g_signal_emit (backend, signals[PRINTER_LIST_DONE], 0);
595 * gtk_print_backend_get_printer_list:
597 * Return value: (element-type GtkPrinter) (transfer container):
600 gtk_print_backend_get_printer_list (GtkPrintBackend *backend)
602 GtkPrintBackendPrivate *priv;
605 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
607 priv = backend->priv;
610 if (priv->printers != NULL)
611 g_hash_table_foreach (priv->printers,
612 (GHFunc) printer_hash_to_sorted_active_list,
615 if (!priv->printer_list_requested && priv->printers != NULL)
617 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list)
618 GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list (backend);
619 priv->printer_list_requested = TRUE;
626 gtk_print_backend_printer_list_is_done (GtkPrintBackend *print_backend)
628 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (print_backend), TRUE);
630 return print_backend->priv->printer_list_done;
634 gtk_print_backend_find_printer (GtkPrintBackend *backend,
635 const gchar *printer_name)
637 GtkPrintBackendPrivate *priv;
640 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
642 priv = backend->priv;
645 printer = g_hash_table_lookup (priv->printers, printer_name);
653 gtk_print_backend_print_stream (GtkPrintBackend *backend,
656 GtkPrintJobCompleteFunc callback,
658 GDestroyNotify dnotify)
660 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
662 GTK_PRINT_BACKEND_GET_CLASS (backend)->print_stream (backend,
671 gtk_print_backend_set_password (GtkPrintBackend *backend,
672 gchar **auth_info_required,
675 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
677 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password)
678 GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password (backend, auth_info_required, auth_info);
682 store_entry (GtkEntry *entry,
685 gchar **data = (gchar **) user_data;
689 memset (*data, 0, strlen (*data));
693 *data = g_strdup (gtk_entry_get_text (entry));
697 password_dialog_response (GtkWidget *dialog,
699 GtkPrintBackend *backend)
701 GtkPrintBackendPrivate *priv = backend->priv;
704 if (response_id == GTK_RESPONSE_OK)
705 gtk_print_backend_set_password (backend, priv->auth_info_required, priv->auth_info);
707 gtk_print_backend_set_password (backend, priv->auth_info_required, NULL);
709 for (i = 0; i < g_strv_length (priv->auth_info_required); i++)
710 if (priv->auth_info[i] != NULL)
712 memset (priv->auth_info[i], 0, strlen (priv->auth_info[i]));
713 g_free (priv->auth_info[i]);
714 priv->auth_info[i] = NULL;
716 g_free (priv->auth_info);
717 priv->auth_info = NULL;
719 g_strfreev (priv->auth_info_required);
721 gtk_widget_destroy (dialog);
723 g_object_unref (backend);
727 request_password (GtkPrintBackend *backend,
728 gpointer auth_info_required,
729 gpointer auth_info_default,
730 gpointer auth_info_display,
731 gpointer auth_info_visible,
734 GtkPrintBackendPrivate *priv = backend->priv;
735 GtkWidget *dialog, *box, *main_box, *label, *icon, *vbox, *entry;
736 GtkWidget *focus = NULL;
740 gchar **ai_required = (gchar **) auth_info_required;
741 gchar **ai_default = (gchar **) auth_info_default;
742 gchar **ai_display = (gchar **) auth_info_display;
743 gboolean *ai_visible = (gboolean *) auth_info_visible;
745 priv->auth_info_required = g_strdupv (ai_required);
746 length = g_strv_length (ai_required);
747 priv->auth_info = g_new0 (gchar *, length);
749 dialog = gtk_dialog_new_with_buttons ( _("Authentication"), NULL, GTK_DIALOG_MODAL,
750 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
751 GTK_STOCK_OK, GTK_RESPONSE_OK,
754 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
755 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
757 main_box = gtk_hbox_new (FALSE, 0);
760 icon = gtk_image_new_from_stock (GTK_STOCK_DIALOG_AUTHENTICATION, GTK_ICON_SIZE_DIALOG);
761 gtk_misc_set_alignment (GTK_MISC (icon), 0.5, 0.0);
762 gtk_misc_set_padding (GTK_MISC (icon), 6, 6);
766 vbox = gtk_vbox_new (FALSE, 0);
767 gtk_widget_set_size_request (GTK_WIDGET (vbox), 320, -1);
770 label = gtk_label_new (NULL);
771 markup = g_markup_printf_escaped ("<span weight=\"bold\" size=\"large\">%s</span>", prompt);
772 gtk_label_set_markup (GTK_LABEL (label), markup);
773 gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
774 gtk_widget_set_size_request (GTK_WIDGET (label), 320, -1);
779 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox), main_box, TRUE, FALSE, 0);
781 gtk_box_pack_start (GTK_BOX (main_box), icon, FALSE, FALSE, 6);
782 gtk_box_pack_start (GTK_BOX (main_box), vbox, FALSE, FALSE, 6);
784 gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, TRUE, 6);
787 for (i = 0; i < length; i++)
789 priv->auth_info[i] = g_strdup (ai_default[i]);
790 if (ai_display[i] != NULL)
792 box = gtk_hbox_new (TRUE, 0);
794 label = gtk_label_new (ai_display[i]);
795 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
797 entry = gtk_entry_new ();
800 if (ai_default[i] != NULL)
801 gtk_entry_set_text (GTK_ENTRY (entry), ai_default[i]);
803 gtk_entry_set_visibility (GTK_ENTRY (entry), ai_visible[i]);
804 gtk_entry_set_activates_default (GTK_ENTRY (entry), TRUE);
806 gtk_box_pack_start (GTK_BOX (vbox), box, FALSE, TRUE, 6);
808 gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
809 gtk_box_pack_start (GTK_BOX (box), entry, TRUE, TRUE, 0);
811 g_signal_connect (entry, "changed",
812 G_CALLBACK (store_entry), &(priv->auth_info[i]));
818 gtk_widget_grab_focus (focus);
822 g_object_ref (backend);
823 g_signal_connect (G_OBJECT (dialog), "response",
824 G_CALLBACK (password_dialog_response), backend);
826 gtk_widget_show_all (dialog);
830 gtk_print_backend_destroy (GtkPrintBackend *print_backend)
832 /* The lifecycle of print backends and printers are tied, such that
833 * the backend owns the printers, but the printers also ref the backend.
834 * This is so that if the app has a reference to a printer its backend
835 * will be around. However, this results in a cycle, which we break
836 * with this call, which causes the print backend to release its printers.
838 g_object_run_dispose (G_OBJECT (print_backend));
842 #define __GTK_PRINT_BACKEND_C__
843 #include "gtkaliasdef.c"