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, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
25 #include <sys/types.h>
33 #include <cairo-pdf.h>
35 #include <cairo-svg.h>
37 #include <glib/gi18n-lib.h>
40 #include "gtk/gtkprinter-private.h"
42 #include "gtkprintbackendfile.h"
44 typedef struct _GtkPrintBackendFileClass GtkPrintBackendFileClass;
46 #define GTK_PRINT_BACKEND_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
47 #define GTK_IS_PRINT_BACKEND_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_FILE))
48 #define GTK_PRINT_BACKEND_FILE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
50 #define _STREAM_MAX_CHUNK_SIZE 8192
52 static GType print_backend_file_type = 0;
54 struct _GtkPrintBackendFileClass
56 GtkPrintBackendClass parent_class;
59 struct _GtkPrintBackendFile
61 GtkPrintBackend parent_instance;
72 static const gchar* formats[N_FORMATS] =
79 static GObjectClass *backend_parent_class;
81 static void gtk_print_backend_file_class_init (GtkPrintBackendFileClass *class);
82 static void gtk_print_backend_file_init (GtkPrintBackendFile *impl);
83 static void file_printer_get_settings_from_options (GtkPrinter *printer,
84 GtkPrinterOptionSet *options,
85 GtkPrintSettings *settings);
86 static GtkPrinterOptionSet *file_printer_get_options (GtkPrinter *printer,
87 GtkPrintSettings *settings,
88 GtkPageSetup *page_setup,
89 GtkPrintCapabilities capabilities);
90 static void file_printer_prepare_for_print (GtkPrinter *printer,
91 GtkPrintJob *print_job,
92 GtkPrintSettings *settings,
93 GtkPageSetup *page_setup);
94 static void gtk_print_backend_file_print_stream (GtkPrintBackend *print_backend,
97 GtkPrintJobCompleteFunc callback,
99 GDestroyNotify dnotify);
100 static cairo_surface_t * file_printer_create_cairo_surface (GtkPrinter *printer,
101 GtkPrintSettings *settings,
104 GIOChannel *cache_io);
106 static GList * file_printer_list_papers (GtkPrinter *printer);
107 static GtkPageSetup * file_printer_get_default_page_size (GtkPrinter *printer);
110 gtk_print_backend_file_register_type (GTypeModule *module)
112 const GTypeInfo print_backend_file_info =
114 sizeof (GtkPrintBackendFileClass),
115 NULL, /* base_init */
116 NULL, /* base_finalize */
117 (GClassInitFunc) gtk_print_backend_file_class_init,
118 NULL, /* class_finalize */
119 NULL, /* class_data */
120 sizeof (GtkPrintBackendFile),
122 (GInstanceInitFunc) gtk_print_backend_file_init,
125 print_backend_file_type = g_type_module_register_type (module,
126 GTK_TYPE_PRINT_BACKEND,
127 "GtkPrintBackendFile",
128 &print_backend_file_info, 0);
132 pb_module_init (GTypeModule *module)
134 gtk_print_backend_file_register_type (module);
138 pb_module_exit (void)
143 G_MODULE_EXPORT GtkPrintBackend *
144 pb_module_create (void)
146 return gtk_print_backend_file_new ();
150 * GtkPrintBackendFile
153 gtk_print_backend_file_get_type (void)
155 return print_backend_file_type;
159 * gtk_print_backend_file_new:
161 * Creates a new #GtkPrintBackendFile object. #GtkPrintBackendFile
162 * implements the #GtkPrintBackend interface with direct access to
163 * the filesystem using Unix/Linux API calls
165 * Return value: the new #GtkPrintBackendFile object
168 gtk_print_backend_file_new (void)
170 return g_object_new (GTK_TYPE_PRINT_BACKEND_FILE, NULL);
174 gtk_print_backend_file_class_init (GtkPrintBackendFileClass *class)
176 GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
178 backend_parent_class = g_type_class_peek_parent (class);
180 backend_class->print_stream = gtk_print_backend_file_print_stream;
181 backend_class->printer_create_cairo_surface = file_printer_create_cairo_surface;
182 backend_class->printer_get_options = file_printer_get_options;
183 backend_class->printer_get_settings_from_options = file_printer_get_settings_from_options;
184 backend_class->printer_prepare_for_print = file_printer_prepare_for_print;
185 backend_class->printer_list_papers = file_printer_list_papers;
186 backend_class->printer_get_default_page_size = file_printer_get_default_page_size;
189 /* return N_FORMATS if no explicit format in the settings */
191 format_from_settings (GtkPrintSettings *settings)
196 if (settings == NULL)
199 value = gtk_print_settings_get (settings,
200 GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT);
204 for (i = 0; i < N_FORMATS; ++i)
205 if (strcmp (value, formats[i]) == 0)
208 g_assert (i < N_FORMATS);
210 return (OutputFormat) i;
214 output_file_from_settings (GtkPrintSettings *settings,
215 const gchar *default_format)
220 uri = g_strdup (gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_OUTPUT_URI));
224 const gchar *extension;
225 gchar *name, *locale_name, *path;
228 extension = default_format;
233 format = format_from_settings (settings);
249 /* default filename used for print-to-file */
250 name = g_strdup_printf (_("output.%s"), extension);
251 locale_name = g_filename_from_utf8 (name, -1, NULL, NULL, NULL);
254 if (locale_name != NULL)
256 const gchar *document_dir = g_get_user_special_dir (G_USER_DIRECTORY_DOCUMENTS);
258 if (document_dir == NULL)
260 gchar *current_dir = g_get_current_dir ();
261 path = g_build_filename (current_dir, locale_name, NULL);
262 g_free (current_dir);
265 path = g_build_filename (document_dir, locale_name, NULL);
267 uri = g_filename_to_uri (path, NULL, NULL);
269 g_free (locale_name);
277 static cairo_status_t
278 _cairo_write (void *closure,
279 const unsigned char *data,
282 GIOChannel *io = (GIOChannel *)closure;
289 g_print ("FILE Backend: Writting %i byte chunk to temp file\n", length));
293 g_io_channel_write_chars (io, (const gchar *) data, length, &written, &error);
298 g_print ("FILE Backend: Error writting to temp file, %s\n", error->message));
300 g_error_free (error);
301 return CAIRO_STATUS_WRITE_ERROR;
305 g_print ("FILE Backend: Wrote %i bytes to temp file\n", written));
311 return CAIRO_STATUS_SUCCESS;
315 static cairo_surface_t *
316 file_printer_create_cairo_surface (GtkPrinter *printer,
317 GtkPrintSettings *settings,
320 GIOChannel *cache_io)
322 cairo_surface_t *surface;
324 const cairo_svg_version_t *versions;
325 int num_versions = 0;
327 format = format_from_settings (settings);
333 surface = cairo_pdf_surface_create_for_stream (_cairo_write, cache_io, width, height);
336 surface = cairo_ps_surface_create_for_stream (_cairo_write, cache_io, width, height);
339 surface = cairo_svg_surface_create_for_stream (_cairo_write, cache_io, width, height);
340 cairo_svg_get_versions (&versions, &num_versions);
341 if (num_versions > 0)
342 cairo_svg_surface_restrict_to_version (surface, versions[num_versions - 1]);
346 cairo_surface_set_fallback_resolution (surface,
347 2.0 * gtk_print_settings_get_printer_lpi (settings),
348 2.0 * gtk_print_settings_get_printer_lpi (settings));
354 GtkPrintBackend *backend;
355 GtkPrintJobCompleteFunc callback;
357 GFileOutputStream *target_io_stream;
359 GDestroyNotify dnotify;
363 file_print_cb (GtkPrintBackendFile *print_backend,
367 _PrintStreamData *ps = (_PrintStreamData *) user_data;
369 GDK_THREADS_ENTER ();
371 if (ps->target_io_stream != NULL)
372 g_output_stream_close (G_OUTPUT_STREAM (ps->target_io_stream), NULL, NULL);
375 ps->callback (ps->job, ps->user_data, error);
378 ps->dnotify (ps->user_data);
380 gtk_print_job_set_status (ps->job,
381 (error != NULL)?GTK_PRINT_STATUS_FINISHED_ABORTED:GTK_PRINT_STATUS_FINISHED);
384 g_object_unref (ps->job);
388 GDK_THREADS_LEAVE ();
392 file_write (GIOChannel *source,
396 gchar buf[_STREAM_MAX_CHUNK_SIZE];
399 GIOStatus read_status;
400 _PrintStreamData *ps = (_PrintStreamData *) user_data;
405 g_io_channel_read_chars (source,
407 _STREAM_MAX_CHUNK_SIZE,
411 if (read_status != G_IO_STATUS_ERROR)
415 g_output_stream_write_all (G_OUTPUT_STREAM (ps->target_io_stream),
423 if (error != NULL || read_status == G_IO_STATUS_EOF)
425 file_print_cb (GTK_PRINT_BACKEND_FILE (ps->backend), error, user_data);
430 g_print ("FILE Backend: %s\n", error->message));
432 g_error_free (error);
439 g_print ("FILE Backend: Writting %i byte chunk to target file\n", bytes_read));
445 gtk_print_backend_file_print_stream (GtkPrintBackend *print_backend,
448 GtkPrintJobCompleteFunc callback,
450 GDestroyNotify dnotify)
452 GError *internal_error = NULL;
453 _PrintStreamData *ps;
454 GtkPrintSettings *settings;
458 settings = gtk_print_job_get_settings (job);
460 ps = g_new0 (_PrintStreamData, 1);
461 ps->callback = callback;
462 ps->user_data = user_data;
463 ps->dnotify = dnotify;
464 ps->job = g_object_ref (job);
465 ps->backend = print_backend;
467 internal_error = NULL;
468 uri = output_file_from_settings (settings, NULL);
473 file = g_file_new_for_uri (uri);
474 ps->target_io_stream = g_file_replace (file, NULL, FALSE, G_FILE_CREATE_NONE, NULL, &internal_error);
476 g_object_unref (file);
480 if (internal_error != NULL)
482 file_print_cb (GTK_PRINT_BACKEND_FILE (print_backend),
485 g_error_free (internal_error);
489 g_io_add_watch (data_io,
490 G_IO_IN | G_IO_PRI | G_IO_ERR | G_IO_HUP,
491 (GIOFunc) file_write,
496 gtk_print_backend_file_init (GtkPrintBackendFile *backend)
500 printer = g_object_new (GTK_TYPE_PRINTER,
501 "name", _("Print to File"),
506 gtk_printer_set_has_details (printer, TRUE);
507 gtk_printer_set_icon_name (printer, "document-save");
508 gtk_printer_set_is_active (printer, TRUE);
510 gtk_print_backend_add_printer (GTK_PRINT_BACKEND (backend), printer);
511 g_object_unref (printer);
513 gtk_print_backend_set_list_done (GTK_PRINT_BACKEND (backend));
517 file_printer_output_file_format_changed (GtkPrinterOption *format_option,
518 GtkPrinterOptionSet *set)
520 GtkPrinterOption *uri_option;
523 if (! format_option->value)
526 uri_option = gtk_printer_option_set_lookup (set,
527 "gtk-main-page-custom-input");
529 if (uri_option && uri_option->value)
531 const gchar *uri = uri_option->value;
532 const gchar *dot = strrchr (uri, '.');
538 /* check if the file extension matches one of the known ones */
539 for (i = 0; i < N_FORMATS; i++)
540 if (strcmp (dot + 1, formats[i]) == 0)
543 if (i < N_FORMATS && strcmp (formats[i], format_option->value))
545 /* the file extension is known but doesn't match the
546 * selected one, strip it away
548 base = g_strndup (uri, dot - uri);
553 /* there's no file extension */
554 base = g_strdup (uri);
560 gchar *tmp = g_strdup_printf ("%s.%s", base, format_option->value);
562 gtk_printer_option_set (uri_option, tmp);
568 static GtkPrinterOptionSet *
569 file_printer_get_options (GtkPrinter *printer,
570 GtkPrintSettings *settings,
571 GtkPageSetup *page_setup,
572 GtkPrintCapabilities capabilities)
574 GtkPrinterOptionSet *set;
575 GtkPrinterOption *option;
576 const gchar *n_up[] = {"1", "2", "4", "6", "9", "16" };
577 const gchar *pages_per_sheet = NULL;
578 const gchar *format_names[N_FORMATS] = { N_("PDF"), N_("Postscript"), N_("SVG") };
579 const gchar *supported_formats[N_FORMATS];
580 gchar *display_format_names[N_FORMATS];
584 gint current_format = 0;
586 format = format_from_settings (settings);
588 set = gtk_printer_option_set_new ();
590 option = gtk_printer_option_new ("gtk-n-up", _("Pages per _sheet:"), GTK_PRINTER_OPTION_TYPE_PICKONE);
591 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
592 (char **) n_up, (char **) n_up /* FIXME i18n (localised digits)! */);
594 pages_per_sheet = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_NUMBER_UP);
596 gtk_printer_option_set (option, pages_per_sheet);
598 gtk_printer_option_set (option, "1");
599 gtk_printer_option_set_add (set, option);
600 g_object_unref (option);
602 if (capabilities & (GTK_PRINT_CAPABILITY_GENERATE_PDF | GTK_PRINT_CAPABILITY_GENERATE_PS))
604 if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PDF)
606 if (format == FORMAT_PDF || format == N_FORMATS)
609 current_format = n_formats;
611 supported_formats[n_formats] = formats[FORMAT_PDF];
612 display_format_names[n_formats] = _(format_names[FORMAT_PDF]);
615 if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PS)
617 if (format == FORMAT_PS || format == N_FORMATS)
618 current_format = n_formats;
619 supported_formats[n_formats] = formats[FORMAT_PS];
620 display_format_names[n_formats] = _(format_names[FORMAT_PS]);
630 current_format = FORMAT_PDF;
633 current_format = FORMAT_PS;
636 current_format = FORMAT_SVG;
640 for (n_formats = 0; n_formats < N_FORMATS; ++n_formats)
642 supported_formats[n_formats] = formats[n_formats];
643 display_format_names[n_formats] = _(format_names[n_formats]);
647 uri = output_file_from_settings (settings, supported_formats[current_format]);
649 option = gtk_printer_option_new ("gtk-main-page-custom-input", _("File"),
650 GTK_PRINTER_OPTION_TYPE_FILESAVE);
651 gtk_printer_option_set_activates_default (option, TRUE);
652 gtk_printer_option_set (option, uri);
654 option->group = g_strdup ("GtkPrintDialogExtension");
655 gtk_printer_option_set_add (set, option);
659 option = gtk_printer_option_new ("output-file-format", _("_Output format"),
660 GTK_PRINTER_OPTION_TYPE_ALTERNATIVE);
661 option->group = g_strdup ("GtkPrintDialogExtension");
663 gtk_printer_option_choices_from_array (option, n_formats,
664 (char **) supported_formats,
665 display_format_names);
666 gtk_printer_option_set (option, supported_formats[current_format]);
667 gtk_printer_option_set_add (set, option);
669 g_signal_connect (option, "changed",
670 G_CALLBACK (file_printer_output_file_format_changed),
673 g_object_unref (option);
680 file_printer_get_settings_from_options (GtkPrinter *printer,
681 GtkPrinterOptionSet *options,
682 GtkPrintSettings *settings)
684 GtkPrinterOption *option;
686 option = gtk_printer_option_set_lookup (options, "gtk-main-page-custom-input");
687 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_URI, option->value);
689 option = gtk_printer_option_set_lookup (options, "output-file-format");
691 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT, option->value);
693 option = gtk_printer_option_set_lookup (options, "gtk-n-up");
695 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_NUMBER_UP, option->value);
697 option = gtk_printer_option_set_lookup (options, "gtk-n-up-layout");
699 gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT, option->value);
703 file_printer_prepare_for_print (GtkPrinter *printer,
704 GtkPrintJob *print_job,
705 GtkPrintSettings *settings,
706 GtkPageSetup *page_setup)
710 print_job->print_pages = gtk_print_settings_get_print_pages (settings);
711 print_job->page_ranges = NULL;
712 print_job->num_page_ranges = 0;
714 if (print_job->print_pages == GTK_PRINT_PAGES_RANGES)
715 print_job->page_ranges =
716 gtk_print_settings_get_page_ranges (settings,
717 &print_job->num_page_ranges);
719 print_job->collate = gtk_print_settings_get_collate (settings);
720 print_job->reverse = gtk_print_settings_get_reverse (settings);
721 print_job->num_copies = gtk_print_settings_get_n_copies (settings);
722 print_job->number_up = gtk_print_settings_get_number_up (settings);
723 print_job->number_up_layout = gtk_print_settings_get_number_up_layout (settings);
725 scale = gtk_print_settings_get_scale (settings);
727 print_job->scale = scale/100.0;
729 print_job->page_set = gtk_print_settings_get_page_set (settings);
730 print_job->rotate_to_orientation = TRUE;
734 file_printer_list_papers (GtkPrinter *printer)
736 GList *result = NULL;
738 GtkPageSetup *page_setup;
740 papers = gtk_paper_size_get_paper_sizes (TRUE);
742 for (p = papers; p; p = p->next)
744 GtkPaperSize *paper_size = p->data;
746 page_setup = gtk_page_setup_new ();
747 gtk_page_setup_set_paper_size (page_setup, paper_size);
748 gtk_paper_size_free (paper_size);
749 result = g_list_prepend (result, page_setup);
752 g_list_free (papers);
754 return g_list_reverse (result);
757 static GtkPageSetup *
758 file_printer_get_default_page_size (GtkPrinter *printer)
760 GtkPageSetup *result = NULL;