]> Pileus Git - ~andy/gtk/blob - modules/printbackends/file/gtkprintbackendfile.c
Include "config.h" instead of <config.h> Command used: find -name
[~andy/gtk] / modules / printbackends / file / gtkprintbackendfile.c
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.
5  *
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.
10  *
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.
15  *
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.
20  */
21
22 #include "config.h"
23
24 #include <unistd.h>
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <fcntl.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #include <errno.h>
32 #include <cairo.h>
33 #include <cairo-pdf.h>
34 #include <cairo-ps.h>
35
36 #include <glib/gi18n-lib.h>
37
38 #include "gtk/gtk.h"
39 #include "gtk/gtkprinter-private.h"
40
41 #include "gtkprintbackendfile.h"
42
43 typedef struct _GtkPrintBackendFileClass GtkPrintBackendFileClass;
44
45 #define GTK_PRINT_BACKEND_FILE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
46 #define GTK_IS_PRINT_BACKEND_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_FILE))
47 #define GTK_PRINT_BACKEND_FILE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
48
49 #define _STREAM_MAX_CHUNK_SIZE 8192
50
51 static GType print_backend_file_type = 0;
52
53 struct _GtkPrintBackendFileClass
54 {
55   GtkPrintBackendClass parent_class;
56 };
57
58 struct _GtkPrintBackendFile
59 {
60   GtkPrintBackend parent_instance;
61 };
62
63 typedef enum
64 {
65   FORMAT_PDF,
66   FORMAT_PS,
67   N_FORMATS
68 } OutputFormat;
69
70 static const gchar* formats[N_FORMATS] =
71 {
72   "pdf",
73   "ps"
74 };
75
76 static GObjectClass *backend_parent_class;
77
78 static void                 gtk_print_backend_file_class_init      (GtkPrintBackendFileClass *class);
79 static void                 gtk_print_backend_file_init            (GtkPrintBackendFile      *impl);
80 static void                 file_printer_get_settings_from_options (GtkPrinter              *printer,
81                                                                     GtkPrinterOptionSet     *options,
82                                                                     GtkPrintSettings        *settings);
83 static GtkPrinterOptionSet *file_printer_get_options               (GtkPrinter              *printer,
84                                                                     GtkPrintSettings        *settings,
85                                                                     GtkPageSetup            *page_setup,
86                                                                     GtkPrintCapabilities     capabilities);
87 static void                 file_printer_prepare_for_print         (GtkPrinter              *printer,
88                                                                     GtkPrintJob             *print_job,
89                                                                     GtkPrintSettings        *settings,
90                                                                     GtkPageSetup            *page_setup);
91 static void                 gtk_print_backend_file_print_stream    (GtkPrintBackend         *print_backend,
92                                                                     GtkPrintJob             *job,
93                                                                     GIOChannel              *data_io,
94                                                                     GtkPrintJobCompleteFunc  callback,
95                                                                     gpointer                 user_data,
96                                                                     GDestroyNotify           dnotify);
97 static cairo_surface_t *    file_printer_create_cairo_surface      (GtkPrinter              *printer,
98                                                                     GtkPrintSettings        *settings,
99                                                                     gdouble                  width,
100                                                                     gdouble                  height,
101                                                                     GIOChannel              *cache_io);
102
103 static GList *              file_printer_list_papers               (GtkPrinter              *printer);
104 static GtkPageSetup *       file_printer_get_default_page_size     (GtkPrinter              *printer);
105
106 static void
107 gtk_print_backend_file_register_type (GTypeModule *module)
108 {
109   static const GTypeInfo print_backend_file_info =
110   {
111     sizeof (GtkPrintBackendFileClass),
112     NULL,               /* base_init */
113     NULL,               /* base_finalize */
114     (GClassInitFunc) gtk_print_backend_file_class_init,
115     NULL,               /* class_finalize */
116     NULL,               /* class_data */
117     sizeof (GtkPrintBackendFile),
118     0,          /* n_preallocs */
119     (GInstanceInitFunc) gtk_print_backend_file_init,
120   };
121
122   print_backend_file_type = g_type_module_register_type (module,
123                                                          GTK_TYPE_PRINT_BACKEND,
124                                                          "GtkPrintBackendFile",
125                                                          &print_backend_file_info, 0);
126 }
127
128 G_MODULE_EXPORT void 
129 pb_module_init (GTypeModule *module)
130 {
131   gtk_print_backend_file_register_type (module);
132 }
133
134 G_MODULE_EXPORT void 
135 pb_module_exit (void)
136 {
137
138 }
139   
140 G_MODULE_EXPORT GtkPrintBackend * 
141 pb_module_create (void)
142 {
143   return gtk_print_backend_file_new ();
144 }
145
146 /*
147  * GtkPrintBackendFile
148  */
149 GType
150 gtk_print_backend_file_get_type (void)
151 {
152   return print_backend_file_type;
153 }
154
155 /**
156  * gtk_print_backend_file_new:
157  *
158  * Creates a new #GtkPrintBackendFile object. #GtkPrintBackendFile
159  * implements the #GtkPrintBackend interface with direct access to
160  * the filesystem using Unix/Linux API calls
161  *
162  * Return value: the new #GtkPrintBackendFile object
163  **/
164 GtkPrintBackend *
165 gtk_print_backend_file_new (void)
166 {
167   return g_object_new (GTK_TYPE_PRINT_BACKEND_FILE, NULL);
168 }
169
170 static void
171 gtk_print_backend_file_class_init (GtkPrintBackendFileClass *class)
172 {
173   GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
174
175   backend_parent_class = g_type_class_peek_parent (class);
176
177   backend_class->print_stream = gtk_print_backend_file_print_stream;
178   backend_class->printer_create_cairo_surface = file_printer_create_cairo_surface;
179   backend_class->printer_get_options = file_printer_get_options;
180   backend_class->printer_get_settings_from_options = file_printer_get_settings_from_options;
181   backend_class->printer_prepare_for_print = file_printer_prepare_for_print;
182   backend_class->printer_list_papers = file_printer_list_papers;
183   backend_class->printer_get_default_page_size = file_printer_get_default_page_size;
184 }
185
186 /* return N_FORMATS if no explicit format in the settings */
187 static OutputFormat
188 format_from_settings (GtkPrintSettings *settings)
189 {
190   const gchar *value;
191   gint i;
192
193   if (settings == NULL)
194     return N_FORMATS;
195
196   value = gtk_print_settings_get (settings,
197                                   GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT);
198   if (value == NULL)
199     return N_FORMATS;
200
201   for (i = 0; i < N_FORMATS; ++i)
202     if (strcmp (value, formats[i]) == 0)
203       break;
204
205   g_assert (i < N_FORMATS);
206
207   return (OutputFormat) i;
208 }
209
210 static gchar *
211 output_file_from_settings (GtkPrintSettings *settings,
212                            const gchar      *default_format)
213 {
214   gchar *uri = NULL;
215   
216   if (settings)
217     uri = g_strdup (gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_OUTPUT_URI));
218
219   if (uri == NULL)
220     { 
221       const gchar *extension;
222       gchar *name, *locale_name, *path;
223
224       if (default_format)
225         extension = default_format;
226       else
227         {
228           OutputFormat format;
229
230           format = format_from_settings (settings);
231           extension = format == FORMAT_PS ? "ps" : "pdf";
232         }
233  
234       /* default filename used for print-to-file */ 
235       name = g_strdup_printf (_("output.%s"), extension);
236       locale_name = g_filename_from_utf8 (name, -1, NULL, NULL, NULL);
237       g_free (name);
238
239       if (locale_name != NULL)
240         {
241           path = g_build_filename (g_get_current_dir (), locale_name, NULL);
242           g_free (locale_name);
243
244           uri = g_filename_to_uri (path, NULL, NULL);
245           g_free (path);
246         }
247     }
248
249   return uri;
250 }
251
252 static cairo_status_t
253 _cairo_write (void                *closure,
254               const unsigned char *data,
255               unsigned int         length)
256 {
257   GIOChannel *io = (GIOChannel *)closure;
258   gsize written;
259   GError *error;
260
261   error = NULL;
262
263   GTK_NOTE (PRINTING,
264             g_print ("FILE Backend: Writting %i byte chunk to temp file\n", length));
265
266   while (length > 0) 
267     {
268       g_io_channel_write_chars (io, (const gchar *) data, length, &written, &error);
269
270       if (error != NULL)
271         {
272           GTK_NOTE (PRINTING,
273                      g_print ("FILE Backend: Error writting to temp file, %s\n", error->message));
274
275           g_error_free (error);
276           return CAIRO_STATUS_WRITE_ERROR;
277         }    
278
279       GTK_NOTE (PRINTING,
280                 g_print ("FILE Backend: Wrote %i bytes to temp file\n", written));
281       
282       data += written;
283       length -= written;
284     }
285
286   return CAIRO_STATUS_SUCCESS;
287 }
288
289
290 static cairo_surface_t *
291 file_printer_create_cairo_surface (GtkPrinter       *printer,
292                                    GtkPrintSettings *settings,
293                                    gdouble           width, 
294                                    gdouble           height,
295                                    GIOChannel       *cache_io)
296 {
297   cairo_surface_t *surface;
298   OutputFormat format;
299
300   format = format_from_settings (settings);
301
302   if (format == FORMAT_PS)
303     surface = cairo_ps_surface_create_for_stream (_cairo_write, cache_io, width, height);
304   else
305     surface = cairo_pdf_surface_create_for_stream (_cairo_write, cache_io, width, height);
306
307   /* TODO: DPI from settings object? */
308   cairo_surface_set_fallback_resolution (surface, 300, 300);
309
310   return surface;
311 }
312
313 typedef struct {
314   GtkPrintBackend *backend;
315   GtkPrintJobCompleteFunc callback;
316   GtkPrintJob *job;
317   GIOChannel *target_io;
318   gpointer user_data;
319   GDestroyNotify dnotify;
320 } _PrintStreamData;
321
322 static void
323 file_print_cb (GtkPrintBackendFile *print_backend,
324                GError              *error,
325                gpointer            user_data)
326 {
327   _PrintStreamData *ps = (_PrintStreamData *) user_data;
328
329   GDK_THREADS_ENTER ();
330
331   if (ps->target_io != NULL)
332     g_io_channel_unref (ps->target_io);
333
334   if (ps->callback)
335     ps->callback (ps->job, ps->user_data, error);
336
337   if (ps->dnotify)
338     ps->dnotify (ps->user_data);
339
340   gtk_print_job_set_status (ps->job,
341                             (error != NULL)?GTK_PRINT_STATUS_FINISHED_ABORTED:GTK_PRINT_STATUS_FINISHED);
342
343   if (ps->job)
344     g_object_unref (ps->job);
345  
346   g_free (ps);
347
348   GDK_THREADS_LEAVE ();
349 }
350
351 static gboolean
352 file_write (GIOChannel   *source,
353             GIOCondition  con,
354             gpointer      user_data)
355 {
356   gchar buf[_STREAM_MAX_CHUNK_SIZE];
357   gsize bytes_read;
358   GError *error;
359   GIOStatus read_status;
360   _PrintStreamData *ps = (_PrintStreamData *) user_data;
361
362   error = NULL;
363
364   read_status = 
365     g_io_channel_read_chars (source,
366                              buf,
367                              _STREAM_MAX_CHUNK_SIZE,
368                              &bytes_read,
369                              &error);
370
371   if (read_status != G_IO_STATUS_ERROR)
372     {
373       gsize bytes_written;
374
375       g_io_channel_write_chars (ps->target_io, 
376                                 buf, 
377                                 bytes_read, 
378                                 &bytes_written, 
379                                 &error);
380     }
381
382   if (error != NULL || read_status == G_IO_STATUS_EOF)
383     {
384       file_print_cb (GTK_PRINT_BACKEND_FILE (ps->backend), error, user_data);
385
386       if (error != NULL)
387         {
388           GTK_NOTE (PRINTING,
389                     g_print ("FILE Backend: %s\n", error->message));
390
391           g_error_free (error);
392         }
393
394       return FALSE;
395     }
396
397   GTK_NOTE (PRINTING,
398             g_print ("FILE Backend: Writting %i byte chunk to target file\n", bytes_read));
399
400   return TRUE;
401 }
402
403 static void
404 gtk_print_backend_file_print_stream (GtkPrintBackend        *print_backend,
405                                      GtkPrintJob            *job,
406                                      GIOChannel             *data_io,
407                                      GtkPrintJobCompleteFunc callback,
408                                      gpointer                user_data,
409                                      GDestroyNotify          dnotify)
410 {
411   GError *internal_error = NULL;
412   GtkPrinter *printer;
413   _PrintStreamData *ps;
414   GtkPrintSettings *settings;
415   gchar *uri, *filename;
416
417   printer = gtk_print_job_get_printer (job);
418   settings = gtk_print_job_get_settings (job);
419
420   ps = g_new0 (_PrintStreamData, 1);
421   ps->callback = callback;
422   ps->user_data = user_data;
423   ps->dnotify = dnotify;
424   ps->job = g_object_ref (job);
425   ps->backend = print_backend;
426
427   internal_error = NULL;
428   uri = output_file_from_settings (settings, NULL);
429   filename = g_filename_from_uri (uri, NULL, &internal_error);
430   g_free (uri);
431
432   if (filename == NULL)
433     goto error;
434
435   ps->target_io = g_io_channel_new_file (filename, "w", &internal_error);
436
437   g_free (filename);
438
439   if (internal_error == NULL)
440     g_io_channel_set_encoding (ps->target_io, NULL, &internal_error);
441
442 error:
443   if (internal_error != NULL)
444     {
445       file_print_cb (GTK_PRINT_BACKEND_FILE (print_backend),
446                     internal_error, ps);
447
448       g_error_free (internal_error);
449       return;
450     }
451
452   g_io_add_watch (data_io, 
453                   G_IO_IN | G_IO_PRI | G_IO_ERR | G_IO_HUP,
454                   (GIOFunc) file_write,
455                   ps);
456 }
457
458 static void
459 gtk_print_backend_file_init (GtkPrintBackendFile *backend)
460 {
461   GtkPrinter *printer;
462   
463   printer = g_object_new (GTK_TYPE_PRINTER,
464                           "name", _("Print to File"),
465                           "backend", backend,
466                           "is-virtual", TRUE,
467                           NULL); 
468
469   gtk_printer_set_has_details (printer, TRUE);
470   gtk_printer_set_icon_name (printer, "gtk-floppy");
471   gtk_printer_set_is_active (printer, TRUE);
472
473   gtk_print_backend_add_printer (GTK_PRINT_BACKEND (backend), printer);
474   g_object_unref (printer);
475
476   gtk_print_backend_set_list_done (GTK_PRINT_BACKEND (backend));
477 }
478
479 static void
480 file_printer_output_file_format_changed (GtkPrinterOption    *format_option,
481                                          GtkPrinterOptionSet *set)
482 {
483   GtkPrinterOption *uri_option;
484   gchar            *base = NULL;
485
486   if (! format_option->value)
487     return;
488
489   uri_option = gtk_printer_option_set_lookup (set,
490                                               "gtk-main-page-custom-input");
491
492   if (uri_option && uri_option->value)
493     {
494       const gchar *uri = uri_option->value;
495       const gchar *dot = strrchr (uri, '.');
496
497       if (dot)
498         {
499           gint i;
500
501           /*  check if the file extension matches one of the known ones  */
502           for (i = 0; i < N_FORMATS; i++)
503             if (strcmp (dot + 1, formats[i]) == 0)
504               break;
505
506           if (i < N_FORMATS && strcmp (formats[i], format_option->value))
507             {
508               /*  the file extension is known but doesn't match the
509                *  selected one, strip it away
510                */
511               base = g_strndup (uri, dot - uri);
512             }
513         }
514       else
515         {
516           /*  there's no file extension  */
517           base = g_strdup (uri);
518         }
519     }
520
521   if (base)
522     {
523       gchar *tmp = g_strdup_printf ("%s.%s", base, format_option->value);
524
525       gtk_printer_option_set (uri_option, tmp);
526       g_free (tmp);
527       g_free (base);
528     }
529 }
530
531 static GtkPrinterOptionSet *
532 file_printer_get_options (GtkPrinter           *printer,
533                           GtkPrintSettings     *settings,
534                           GtkPageSetup         *page_setup,
535                           GtkPrintCapabilities  capabilities)
536 {
537   GtkPrinterOptionSet *set;
538   GtkPrinterOption *option;
539   const gchar *n_up[] = {"1", "2", "4", "6", "9", "16" };
540   const gchar *pages_per_sheet = NULL;
541   const gchar *format_names[N_FORMATS] = { N_("PDF"), N_("Postscript") };
542   const gchar *supported_formats[N_FORMATS];
543   gchar *display_format_names[N_FORMATS];
544   gint n_formats = 0;
545   OutputFormat format;
546   gchar *uri;
547   gint current_format = 0;
548
549   format = format_from_settings (settings);
550
551   set = gtk_printer_option_set_new ();
552
553   option = gtk_printer_option_new ("gtk-n-up", _("Pages per _sheet:"), GTK_PRINTER_OPTION_TYPE_PICKONE);
554   gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
555                                          (char **) n_up, (char **) n_up /* FIXME i18n (localised digits)! */);
556   if (settings)
557     pages_per_sheet = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_NUMBER_UP);
558   if (pages_per_sheet)
559     gtk_printer_option_set (option, pages_per_sheet);
560   else
561     gtk_printer_option_set (option, "1");
562   gtk_printer_option_set_add (set, option);
563   g_object_unref (option);
564
565   if (capabilities & (GTK_PRINT_CAPABILITY_GENERATE_PDF | GTK_PRINT_CAPABILITY_GENERATE_PS))
566     {
567       if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PDF)
568         {
569           if (format == FORMAT_PDF || format == N_FORMATS)
570             {
571               format = FORMAT_PDF;
572               current_format = n_formats;
573             }
574           supported_formats[n_formats] = formats[FORMAT_PDF];
575           display_format_names[n_formats] = _(format_names[FORMAT_PDF]);
576           n_formats++;
577         }
578       if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PS)
579         {
580           if (format == FORMAT_PS || format == N_FORMATS)
581             current_format = n_formats;
582           supported_formats[n_formats] = formats[FORMAT_PS];
583           display_format_names[n_formats] = _(format_names[FORMAT_PS]);
584           n_formats++;
585         }
586     }
587   else
588     {
589       current_format = format == FORMAT_PS ? FORMAT_PS : FORMAT_PDF;
590       for (n_formats = 0; n_formats < N_FORMATS; ++n_formats)
591         {
592           supported_formats[n_formats] = formats[n_formats];
593           display_format_names[n_formats] = _(format_names[n_formats]);
594         }
595     }
596
597   uri = output_file_from_settings (settings, supported_formats[current_format]);
598
599   option = gtk_printer_option_new ("gtk-main-page-custom-input", _("File"), 
600                                    GTK_PRINTER_OPTION_TYPE_FILESAVE);
601   gtk_printer_option_set (option, uri);
602   g_free (uri);
603   option->group = g_strdup ("GtkPrintDialogExtension");
604   gtk_printer_option_set_add (set, option);
605
606   if (n_formats > 1)
607     {
608       option = gtk_printer_option_new ("output-file-format", _("_Output format"), 
609                                        GTK_PRINTER_OPTION_TYPE_ALTERNATIVE);
610       option->group = g_strdup ("GtkPrintDialogExtension");
611
612       gtk_printer_option_choices_from_array (option, n_formats,
613                                              (char **) supported_formats,
614                                              display_format_names);
615       gtk_printer_option_set (option, supported_formats[current_format]);
616       gtk_printer_option_set_add (set, option);
617
618       g_signal_connect (option, "changed",
619                         G_CALLBACK (file_printer_output_file_format_changed),
620                         set);
621
622       g_object_unref (option);
623     }
624
625   return set;
626 }
627
628 static void
629 file_printer_get_settings_from_options (GtkPrinter          *printer,
630                                         GtkPrinterOptionSet *options,
631                                         GtkPrintSettings    *settings)
632 {
633   GtkPrinterOption *option;
634
635   option = gtk_printer_option_set_lookup (options, "gtk-main-page-custom-input");
636   gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_URI, option->value);
637
638   option = gtk_printer_option_set_lookup (options, "output-file-format");
639   if (option)
640     gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT, option->value);
641
642   option = gtk_printer_option_set_lookup (options, "gtk-n-up");
643   if (option)
644     gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_NUMBER_UP, option->value);
645 }
646
647 static void
648 file_printer_prepare_for_print (GtkPrinter       *printer,
649                                 GtkPrintJob      *print_job,
650                                 GtkPrintSettings *settings,
651                                 GtkPageSetup     *page_setup)
652 {
653   gdouble scale;
654
655   print_job->print_pages = gtk_print_settings_get_print_pages (settings);
656   print_job->page_ranges = NULL;
657   print_job->num_page_ranges = 0;
658   
659   if (print_job->print_pages == GTK_PRINT_PAGES_RANGES)
660     print_job->page_ranges =
661       gtk_print_settings_get_page_ranges (settings,
662                                           &print_job->num_page_ranges);
663   
664   print_job->collate = gtk_print_settings_get_collate (settings);
665   print_job->reverse = gtk_print_settings_get_reverse (settings);
666   print_job->num_copies = gtk_print_settings_get_n_copies (settings);
667
668   scale = gtk_print_settings_get_scale (settings);
669   if (scale != 100.0)
670     print_job->scale = scale/100.0;
671
672   print_job->page_set = gtk_print_settings_get_page_set (settings);
673   print_job->rotate_to_orientation = TRUE;
674 }
675
676 static GList *
677 file_printer_list_papers (GtkPrinter *printer)
678 {
679   GList *result = NULL;
680   GList *papers, *p;
681   GtkPageSetup *page_setup;
682
683   papers = gtk_paper_size_get_paper_sizes (TRUE);
684
685   for (p = papers; p; p = p->next)
686     {
687       GtkPaperSize *paper_size = p->data;
688
689       page_setup = gtk_page_setup_new ();
690       gtk_page_setup_set_paper_size (page_setup, paper_size);
691       gtk_paper_size_free (paper_size);
692       result = g_list_prepend (result, page_setup);
693     }
694
695   g_list_free (papers);
696
697   return g_list_reverse (result);
698 }
699
700 static GtkPageSetup *
701 file_printer_get_default_page_size (GtkPrinter *printer)
702 {
703   GtkPageSetup *result = NULL;
704
705   return result;
706 }