1 /* GTK - The GIMP Toolkit
2 * gtkprintbackendfile.c: Default implementation of GtkPrintBackend
3 * for printing to a file
4 * Copyright (C) 2003, Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
23 #include <sys/types.h>
31 #include <cairo-pdf.h>
33 #include <cairo-svg.h>
35 #include <glib/gi18n-lib.h>
38 #include "gtk/gtkprinter-private.h"
40 #include "gtkprintbackendfile.h"
42 typedef struct _GtkPrintBackendFileClass GtkPrintBackendFileClass;
44 #define GTK_PRINT_BACKEND_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
45 #define GTK_IS_PRINT_BACKEND_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_FILE))
46 #define GTK_PRINT_BACKEND_FILE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
48 #define _STREAM_MAX_CHUNK_SIZE 8192
50 static GType print_backend_file_type = 0;
52 struct _GtkPrintBackendFileClass
54 GtkPrintBackendClass parent_class;
57 struct _GtkPrintBackendFile
59 GtkPrintBackend parent_instance;
70 static const gchar* formats[N_FORMATS] =
77 static GObjectClass *backend_parent_class;
79 static void gtk_print_backend_file_class_init (GtkPrintBackendFileClass *class);
80 static void gtk_print_backend_file_init (GtkPrintBackendFile *impl);
81 static void file_printer_get_settings_from_options (GtkPrinter *printer,
82 GtkPrinterOptionSet *options,
83 GtkPrintSettings *settings);
84 static GtkPrinterOptionSet *file_printer_get_options (GtkPrinter *printer,
85 GtkPrintSettings *settings,
86 GtkPageSetup *page_setup,
87 GtkPrintCapabilities capabilities);
88 static void file_printer_prepare_for_print (GtkPrinter *printer,
89 GtkPrintJob *print_job,
90 GtkPrintSettings *settings,
91 GtkPageSetup *page_setup);
92 static void gtk_print_backend_file_print_stream (GtkPrintBackend *print_backend,
95 GtkPrintJobCompleteFunc callback,
97 GDestroyNotify dnotify);
98 static cairo_surface_t * file_printer_create_cairo_surface (GtkPrinter *printer,
99 GtkPrintSettings *settings,
102 GIOChannel *cache_io);
104 static GList * file_printer_list_papers (GtkPrinter *printer);
105 static GtkPageSetup * file_printer_get_default_page_size (GtkPrinter *printer);
108 gtk_print_backend_file_register_type (GTypeModule *module)
110 const GTypeInfo print_backend_file_info =
112 sizeof (GtkPrintBackendFileClass),
113 NULL, /* base_init */
114 NULL, /* base_finalize */
115 (GClassInitFunc) gtk_print_backend_file_class_init,
116 NULL, /* class_finalize */
117 NULL, /* class_data */
118 sizeof (GtkPrintBackendFile),
120 (GInstanceInitFunc) gtk_print_backend_file_init,
123 print_backend_file_type = g_type_module_register_type (module,
124 GTK_TYPE_PRINT_BACKEND,
125 "GtkPrintBackendFile",
126 &print_backend_file_info, 0);
130 pb_module_init (GTypeModule *module)
132 gtk_print_backend_file_register_type (module);
136 pb_module_exit (void)
141 G_MODULE_EXPORT GtkPrintBackend *
142 pb_module_create (void)
144 return gtk_print_backend_file_new ();
148 * GtkPrintBackendFile
151 gtk_print_backend_file_get_type (void)
153 return print_backend_file_type;
157 * gtk_print_backend_file_new:
159 * Creates a new #GtkPrintBackendFile object. #GtkPrintBackendFile
160 * implements the #GtkPrintBackend interface with direct access to
161 * the filesystem using Unix/Linux API calls
163 * Return value: the new #GtkPrintBackendFile object
166 gtk_print_backend_file_new (void)
168 return g_object_new (GTK_TYPE_PRINT_BACKEND_FILE, NULL);
172 gtk_print_backend_file_class_init (GtkPrintBackendFileClass *class)
174 GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
176 backend_parent_class = g_type_class_peek_parent (class);
178 backend_class->print_stream = gtk_print_backend_file_print_stream;
179 backend_class->printer_create_cairo_surface = file_printer_create_cairo_surface;
180 backend_class->printer_get_options = file_printer_get_options;
181 backend_class->printer_get_settings_from_options = file_printer_get_settings_from_options;
182 backend_class->printer_prepare_for_print = file_printer_prepare_for_print;
183 backend_class->printer_list_papers = file_printer_list_papers;
184 backend_class->printer_get_default_page_size = file_printer_get_default_page_size;
187 /* return N_FORMATS if no explicit format in the settings */
189 format_from_settings (GtkPrintSettings *settings)
194 if (settings == NULL)
197 value = gtk_print_settings_get (settings,
198 GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT);
202 for (i = 0; i < N_FORMATS; ++i)
203 if (strcmp (value, formats[i]) == 0)
206 g_assert (i < N_FORMATS);
208 return (OutputFormat) i;
212 output_file_from_settings (GtkPrintSettings *settings,
213 const gchar *default_format)
218 uri = g_strdup (gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_OUTPUT_URI));
222 const gchar *extension, *basename, *output_dir;
223 gchar *name, *locale_name, *path;
226 extension = default_format;
231 format = format_from_settings (settings);
247 basename = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_OUTPUT_BASENAME);
248 if (basename == NULL)
249 basename = _("output");
251 name = g_strconcat (basename, ".", extension, NULL);
253 locale_name = g_filename_from_utf8 (name, -1, NULL, NULL, NULL);
256 if (locale_name != NULL)
258 output_dir = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_OUTPUT_DIR);
259 if (output_dir == NULL)
261 const gchar *document_dir = g_get_user_special_dir (G_USER_DIRECTORY_DOCUMENTS);
263 if (document_dir == NULL)
265 gchar *current_dir = g_get_current_dir ();
266 path = g_build_filename (current_dir, locale_name, NULL);
267 g_free (current_dir);
270 path = g_build_filename (document_dir, locale_name, NULL);
272 uri = g_filename_to_uri (path, NULL, NULL);
276 path = g_build_filename (output_dir, locale_name, NULL);
277 uri = g_filename_to_uri (path, NULL, NULL);
281 g_free (locale_name);
288 static cairo_status_t
289 _cairo_write (void *closure,
290 const unsigned char *data,
293 GIOChannel *io = (GIOChannel *)closure;
300 g_print ("FILE Backend: Writting %i byte chunk to temp file\n", length));
304 g_io_channel_write_chars (io, (const gchar *) data, length, &written, &error);
309 g_print ("FILE Backend: Error writting to temp file, %s\n", error->message));
311 g_error_free (error);
312 return CAIRO_STATUS_WRITE_ERROR;
316 g_print ("FILE Backend: Wrote %i bytes to temp file\n", written));
322 return CAIRO_STATUS_SUCCESS;
326 static cairo_surface_t *
327 file_printer_create_cairo_surface (GtkPrinter *printer,
328 GtkPrintSettings *settings,
331 GIOChannel *cache_io)
333 cairo_surface_t *surface;
335 const cairo_svg_version_t *versions;
336 int num_versions = 0;
338 format = format_from_settings (settings);
344 surface = cairo_pdf_surface_create_for_stream (_cairo_write, cache_io, width, height);
347 surface = cairo_ps_surface_create_for_stream (_cairo_write, cache_io, width, height);
350 surface = cairo_svg_surface_create_for_stream (_cairo_write, cache_io, width, height);
351 cairo_svg_get_versions (&versions, &num_versions);
352 if (num_versions > 0)
353 cairo_svg_surface_restrict_to_version (surface, versions[num_versions - 1]);
357 cairo_surface_set_fallback_resolution (surface,
358 2.0 * gtk_print_settings_get_printer_lpi (settings),
359 2.0 * gtk_print_settings_get_printer_lpi (settings));
365 GtkPrintBackend *backend;
366 GtkPrintJobCompleteFunc callback;
368 GFileOutputStream *target_io_stream;
370 GDestroyNotify dnotify;
373 /* expects GDK lock to be held */
375 file_print_cb_locked (GtkPrintBackendFile *print_backend,
379 _PrintStreamData *ps = (_PrintStreamData *) user_data;
381 if (ps->target_io_stream != NULL)
382 g_output_stream_close (G_OUTPUT_STREAM (ps->target_io_stream), NULL, NULL);
385 ps->callback (ps->job, ps->user_data, error);
388 ps->dnotify (ps->user_data);
390 gtk_print_job_set_status (ps->job,
391 (error != NULL)?GTK_PRINT_STATUS_FINISHED_ABORTED:GTK_PRINT_STATUS_FINISHED);
394 g_object_unref (ps->job);
400 file_print_cb (GtkPrintBackendFile *print_backend,
404 GDK_THREADS_ENTER ();
406 file_print_cb_locked (print_backend, error, user_data);
408 GDK_THREADS_LEAVE ();
412 file_write (GIOChannel *source,
416 gchar buf[_STREAM_MAX_CHUNK_SIZE];
419 GIOStatus read_status;
420 _PrintStreamData *ps = (_PrintStreamData *) user_data;
425 g_io_channel_read_chars (source,
427 _STREAM_MAX_CHUNK_SIZE,
431 if (read_status != G_IO_STATUS_ERROR)
435 g_output_stream_write_all (G_OUTPUT_STREAM (ps->target_io_stream),
443 if (error != NULL || read_status == G_IO_STATUS_EOF)
445 file_print_cb (GTK_PRINT_BACKEND_FILE (ps->backend), error, user_data);
450 g_print ("FILE Backend: %s\n", error->message));
452 g_error_free (error);
459 g_print ("FILE Backend: Writting %i byte chunk to target file\n", bytes_read));
465 gtk_print_backend_file_print_stream (GtkPrintBackend *print_backend,
468 GtkPrintJobCompleteFunc callback,
470 GDestroyNotify dnotify)
472 GError *internal_error = NULL;
473 _PrintStreamData *ps;
474 GtkPrintSettings *settings;
478 settings = gtk_print_job_get_settings (job);
480 ps = g_new0 (_PrintStreamData, 1);
481 ps->callback = callback;
482 ps->user_data = user_data;
483 ps->dnotify = dnotify;
484 ps->job = g_object_ref (job);
485 ps->backend = print_backend;
487 internal_error = NULL;
488 uri = output_file_from_settings (settings, NULL);
493 file = g_file_new_for_uri (uri);
494 ps->target_io_stream = g_file_replace (file, NULL, FALSE, G_FILE_CREATE_NONE, NULL, &internal_error);
496 g_object_unref (file);
500 if (internal_error != NULL)
502 file_print_cb_locked (GTK_PRINT_BACKEND_FILE (print_backend),
505 g_error_free (internal_error);
509 g_io_add_watch (data_io,
510 G_IO_IN | G_IO_PRI | G_IO_ERR | G_IO_HUP,
511 (GIOFunc) file_write,
516 gtk_print_backend_file_init (GtkPrintBackendFile *backend)
520 printer = g_object_new (GTK_TYPE_PRINTER,
521 "name", _("Print to File"),
527 gtk_printer_set_has_details (printer, TRUE);
528 gtk_printer_set_icon_name (printer, "document-save");
529 gtk_printer_set_is_active (printer, TRUE);
531 gtk_print_backend_add_printer (GTK_PRINT_BACKEND (backend), printer);
532 g_object_unref (printer);
534 gtk_print_backend_set_list_done (GTK_PRINT_BACKEND (backend));
539 GtkPrinterOptionSet *set;
540 } _OutputFormatChangedData;
543 set_printer_format_from_option_set (GtkPrinter *printer,
544 GtkPrinterOptionSet *set)
546 GtkPrinterOption *format_option;
550 format_option = gtk_printer_option_set_lookup (set, "output-file-format");
551 if (format_option && format_option->value)
553 value = format_option->value;
556 for (i = 0; i < N_FORMATS; ++i)
557 if (strcmp (value, formats[i]) == 0)
560 g_assert (i < N_FORMATS);
565 gtk_printer_set_accepts_pdf (printer, TRUE);
566 gtk_printer_set_accepts_ps (printer, FALSE);
569 gtk_printer_set_accepts_pdf (printer, FALSE);
570 gtk_printer_set_accepts_ps (printer, TRUE);
574 gtk_printer_set_accepts_pdf (printer, FALSE);
575 gtk_printer_set_accepts_ps (printer, FALSE);
583 file_printer_output_file_format_changed (GtkPrinterOption *format_option,
586 GtkPrinterOption *uri_option;
588 _OutputFormatChangedData *data = (_OutputFormatChangedData *) user_data;
590 if (! format_option->value)
593 uri_option = gtk_printer_option_set_lookup (data->set,
594 "gtk-main-page-custom-input");
596 if (uri_option && uri_option->value)
598 const gchar *uri = uri_option->value;
599 const gchar *dot = strrchr (uri, '.');
605 /* check if the file extension matches one of the known ones */
606 for (i = 0; i < N_FORMATS; i++)
607 if (strcmp (dot + 1, formats[i]) == 0)
610 if (i < N_FORMATS && strcmp (formats[i], format_option->value))
612 /* the file extension is known but doesn't match the
613 * selected one, strip it away
615 base = g_strndup (uri, dot - uri);
620 /* there's no file extension */
621 base = g_strdup (uri);
627 gchar *tmp = g_strdup_printf ("%s.%s", base, format_option->value);
629 gtk_printer_option_set (uri_option, tmp);
634 set_printer_format_from_option_set (data->printer, data->set);
637 static GtkPrinterOptionSet *
638 file_printer_get_options (GtkPrinter *printer,
639 GtkPrintSettings *settings,
640 GtkPageSetup *page_setup,
641 GtkPrintCapabilities capabilities)
643 GtkPrinterOptionSet *set;
644 GtkPrinterOption *option;
645 const gchar *n_up[] = {"1", "2", "4", "6", "9", "16" };
646 const gchar *pages_per_sheet = NULL;
647 const gchar *format_names[N_FORMATS] = { N_("PDF"), N_("Postscript"), N_("SVG") };
648 const gchar *supported_formats[N_FORMATS];
649 gchar *display_format_names[N_FORMATS];
653 gint current_format = 0;
654 _OutputFormatChangedData *format_changed_data;
656 format = format_from_settings (settings);
658 set = gtk_printer_option_set_new ();
660 option = gtk_printer_option_new ("gtk-n-up", _("Pages per _sheet:"), GTK_PRINTER_OPTION_TYPE_PICKONE);
661 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
662 (char **) n_up, (char **) n_up /* FIXME i18n (localised digits)! */);
664 pages_per_sheet = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_NUMBER_UP);
666 gtk_printer_option_set (option, pages_per_sheet);
668 gtk_printer_option_set (option, "1");
669 gtk_printer_option_set_add (set, option);
670 g_object_unref (option);
672 if (capabilities & (GTK_PRINT_CAPABILITY_GENERATE_PDF | GTK_PRINT_CAPABILITY_GENERATE_PS))
674 if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PDF)
676 if (format == FORMAT_PDF || format == N_FORMATS)
679 current_format = n_formats;
681 supported_formats[n_formats] = formats[FORMAT_PDF];
682 display_format_names[n_formats] = _(format_names[FORMAT_PDF]);
685 if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PS)
687 if (format == FORMAT_PS || format == N_FORMATS)
688 current_format = n_formats;
689 supported_formats[n_formats] = formats[FORMAT_PS];
690 display_format_names[n_formats] = _(format_names[FORMAT_PS]);
700 current_format = FORMAT_PDF;
703 current_format = FORMAT_PS;
706 current_format = FORMAT_SVG;
710 for (n_formats = 0; n_formats < N_FORMATS; ++n_formats)
712 supported_formats[n_formats] = formats[n_formats];
713 display_format_names[n_formats] = _(format_names[n_formats]);
717 uri = output_file_from_settings (settings, supported_formats[current_format]);
719 option = gtk_printer_option_new ("gtk-main-page-custom-input", _("File"),
720 GTK_PRINTER_OPTION_TYPE_FILESAVE);
721 gtk_printer_option_set_activates_default (option, TRUE);
722 gtk_printer_option_set (option, uri);
724 option->group = g_strdup ("GtkPrintDialogExtension");
725 gtk_printer_option_set_add (set, option);
729 option = gtk_printer_option_new ("output-file-format", _("_Output format"),
730 GTK_PRINTER_OPTION_TYPE_ALTERNATIVE);
731 option->group = g_strdup ("GtkPrintDialogExtension");
733 gtk_printer_option_choices_from_array (option, n_formats,
734 (char **) supported_formats,
735 display_format_names);
736 gtk_printer_option_set (option, supported_formats[current_format]);
737 gtk_printer_option_set_add (set, option);
739 set_printer_format_from_option_set (printer, set);
740 format_changed_data = g_new (_OutputFormatChangedData, 1);
741 format_changed_data->printer = printer;
742 format_changed_data->set = set;
743 g_signal_connect_data (option, "changed",
744 G_CALLBACK (file_printer_output_file_format_changed),
745 format_changed_data, (GClosureNotify)g_free, 0);
747 g_object_unref (option);
754 file_printer_get_settings_from_options (GtkPrinter *printer,
755 GtkPrinterOptionSet *options,
756 GtkPrintSettings *settings)
758 GtkPrinterOption *option;
760 option = gtk_printer_option_set_lookup (options, "gtk-main-page-custom-input");
761 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_URI, option->value);
763 option = gtk_printer_option_set_lookup (options, "output-file-format");
765 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT, option->value);
767 option = gtk_printer_option_set_lookup (options, "gtk-n-up");
769 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_NUMBER_UP, option->value);
771 option = gtk_printer_option_set_lookup (options, "gtk-n-up-layout");
773 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT, option->value);
777 file_printer_prepare_for_print (GtkPrinter *printer,
778 GtkPrintJob *print_job,
779 GtkPrintSettings *settings,
780 GtkPageSetup *page_setup)
784 GtkPageRange *ranges;
787 pages = gtk_print_settings_get_print_pages (settings);
788 gtk_print_job_set_pages (print_job, pages);
790 if (pages == GTK_PRINT_PAGES_RANGES)
791 ranges = gtk_print_settings_get_page_ranges (settings, &n_ranges);
798 gtk_print_job_set_page_ranges (print_job, ranges, n_ranges);
799 gtk_print_job_set_collate (print_job, gtk_print_settings_get_collate (settings));
800 gtk_print_job_set_reverse (print_job, gtk_print_settings_get_reverse (settings));
801 gtk_print_job_set_num_copies (print_job, gtk_print_settings_get_n_copies (settings));
802 gtk_print_job_set_n_up (print_job, gtk_print_settings_get_number_up (settings));
803 gtk_print_job_set_n_up_layout (print_job, gtk_print_settings_get_number_up_layout (settings));
805 scale = gtk_print_settings_get_scale (settings);
807 gtk_print_job_set_scale (print_job, scale / 100.0);
809 gtk_print_job_set_page_set (print_job, gtk_print_settings_get_page_set (settings));
810 gtk_print_job_set_rotate (print_job, TRUE);
814 file_printer_list_papers (GtkPrinter *printer)
816 GList *result = NULL;
818 GtkPageSetup *page_setup;
820 papers = gtk_paper_size_get_paper_sizes (TRUE);
822 for (p = papers; p; p = p->next)
824 GtkPaperSize *paper_size = p->data;
826 page_setup = gtk_page_setup_new ();
827 gtk_page_setup_set_paper_size (page_setup, paper_size);
828 gtk_paper_size_free (paper_size);
829 result = g_list_prepend (result, page_setup);
832 g_list_free (papers);
834 return g_list_reverse (result);
837 static GtkPageSetup *
838 file_printer_get_default_page_size (GtkPrinter *printer)
840 GtkPageSetup *result = NULL;