1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
2 /* pdfdocument.h: Implementation of EvDocument for PDF
3 * Copyright (C) 2004, Red Hat, Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2, or (at your option)
10 * This program 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
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 #include <poppler-document.h>
25 #include <poppler-page.h>
27 #include "ev-poppler.h"
28 #include "ev-ps-exporter.h"
29 #include "ev-document-find.h"
30 #include "ev-document-misc.h"
31 #include "ev-document-links.h"
32 #include "ev-document-security.h"
33 #include "ev-document-thumbnails.h"
43 PdfDocument *document;
51 struct _PdfDocumentClass
53 GObjectClass parent_class;
58 GObject parent_instance;
60 PopplerDocument *document;
61 PopplerPSFile *ps_file;
64 PdfDocumentSearch *search;
67 static void pdf_document_document_iface_init (EvDocumentIface *iface);
68 static void pdf_document_security_iface_init (EvDocumentSecurityIface *iface);
69 static void pdf_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface);
70 static void pdf_document_document_links_iface_init (EvDocumentLinksIface *iface);
71 static void pdf_document_find_iface_init (EvDocumentFindIface *iface);
72 static void pdf_document_ps_exporter_iface_init (EvPSExporterIface *iface);
73 static void pdf_document_thumbnails_get_dimensions (EvDocumentThumbnails *document_thumbnails,
78 static EvLink * ev_link_from_action (PopplerAction *action);
81 G_DEFINE_TYPE_WITH_CODE (PdfDocument, pdf_document, G_TYPE_OBJECT,
83 G_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT,
84 pdf_document_document_iface_init);
85 G_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_SECURITY,
86 pdf_document_security_iface_init);
87 G_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_THUMBNAILS,
88 pdf_document_document_thumbnails_iface_init);
89 G_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_LINKS,
90 pdf_document_document_links_iface_init);
91 G_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_FIND,
92 pdf_document_find_iface_init);
93 G_IMPLEMENT_INTERFACE (EV_TYPE_PS_EXPORTER,
94 pdf_document_ps_exporter_iface_init);
99 pdf_document_get_property (GObject *object,
104 PdfDocument *pdf_document = PDF_DOCUMENT (object);
109 if (pdf_document->document == NULL)
110 g_value_set_string (value, NULL);
112 g_object_get_property (G_OBJECT (pdf_document->document), "title", value);
118 pdf_document_class_init (PdfDocumentClass *klass)
120 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
122 gobject_class->get_property = pdf_document_get_property;
124 g_object_class_override_property (gobject_class, PROP_TITLE, "title");
128 pdf_document_init (PdfDocument *pdf_document)
130 pdf_document->password = NULL;
134 convert_error (GError *poppler_error,
137 if (poppler_error == NULL)
140 if (poppler_error->domain == POPPLER_ERROR) {
141 /* convert poppler errors into EvDocument errors */
142 gint code = EV_DOCUMENT_ERROR_INVALID;
143 if (poppler_error->code == POPPLER_ERROR_INVALID)
144 code = EV_DOCUMENT_ERROR_INVALID;
145 else if (poppler_error->code == POPPLER_ERROR_ENCRYPTED)
146 code = EV_DOCUMENT_ERROR_ENCRYPTED;
152 poppler_error->message,
155 g_propagate_error (error, poppler_error);
162 pdf_document_save (EvDocument *document,
167 GError *poppler_error = NULL;
169 retval = poppler_document_save (PDF_DOCUMENT (document)->document,
173 convert_error (poppler_error, error);
179 pdf_document_load (EvDocument *document,
183 GError *poppler_error = NULL;
184 PdfDocument *pdf_document = PDF_DOCUMENT (document);
186 pdf_document->document =
187 poppler_document_new_from_file (uri, pdf_document->password, &poppler_error);
189 if (pdf_document->document == NULL) {
190 convert_error (poppler_error, error);
198 pdf_document_get_n_pages (EvDocument *document)
200 return poppler_document_get_n_pages (PDF_DOCUMENT (document)->document);
204 pdf_document_get_page_size (EvDocument *document,
209 PopplerPage *poppler_page;
211 poppler_page = poppler_document_get_page (PDF_DOCUMENT (document)->document,
214 poppler_page_get_size (poppler_page, width, height);
218 pdf_document_get_page_label (EvDocument *document,
221 PopplerPage *poppler_page;
224 poppler_page = poppler_document_get_page (PDF_DOCUMENT (document)->document,
227 g_object_get (poppler_page,
235 pdf_document_get_links (EvDocument *document,
238 PdfDocument *pdf_document;
239 PopplerPage *poppler_page;
240 GList *retval = NULL;
245 pdf_document = PDF_DOCUMENT (document);
246 poppler_page = poppler_document_get_page (pdf_document->document,
248 mapping_list = poppler_page_get_link_mapping (poppler_page);
249 poppler_page_get_size (poppler_page, NULL, &height);
251 for (list = mapping_list; list; list = list->next) {
252 PopplerLinkMapping *link_mapping;
253 EvLinkMapping *ev_link_mapping;
255 link_mapping = (PopplerLinkMapping *)list->data;
256 ev_link_mapping = g_new (EvLinkMapping, 1);
257 ev_link_mapping->link = ev_link_from_action (link_mapping->action);
258 ev_link_mapping->x1 = link_mapping->area.x1;
259 ev_link_mapping->x2 = link_mapping->area.x2;
260 /* Invert this for X-style coordinates */
261 ev_link_mapping->y1 = height - link_mapping->area.y2;
262 ev_link_mapping->y2 = height - link_mapping->area.y1;
264 retval = g_list_prepend (retval, ev_link_mapping);
267 poppler_page_free_link_mapping (mapping_list);
269 return g_list_reverse (retval);
274 pdf_document_render_pixbuf (EvDocument *document,
278 PdfDocument *pdf_document;
279 PopplerPage *poppler_page;
281 double width_points, height_points;
284 pdf_document = PDF_DOCUMENT (document);
285 poppler_page = poppler_document_get_page (pdf_document->document,
288 poppler_page_get_size (poppler_page, &width_points, &height_points);
289 width = (int) ceil (width_points * scale);
290 height = (int) ceil (height_points * scale);
292 pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB,
296 poppler_page_render_to_pixbuf (poppler_page,
306 /* EvDocumentSecurity */
309 pdf_document_has_document_security (EvDocumentSecurity *document_security)
311 /* FIXME: do we really need to have this? */
316 pdf_document_set_password (EvDocumentSecurity *document_security,
317 const char *password)
319 PdfDocument *document = PDF_DOCUMENT (document_security);
321 if (document->password)
322 g_free (document->password);
324 document->password = g_strdup (password);
328 pdf_document_can_get_text (EvDocument *document)
334 pdf_document_get_text (EvDocument *document, int page, EvRectangle *rect)
336 PdfDocument *pdf_document = PDF_DOCUMENT (document);
337 PopplerPage *poppler_page;
341 poppler_page = poppler_document_get_page (pdf_document->document, page);
342 g_return_val_if_fail (poppler_page != NULL, NULL);
344 poppler_page_get_size (poppler_page, NULL, &height);
346 r.y1 = height - rect->y2;
348 r.y2 = height - rect->y1;
350 return poppler_page_get_text (poppler_page, &r);
354 pdf_document_document_iface_init (EvDocumentIface *iface)
356 iface->save = pdf_document_save;
357 iface->load = pdf_document_load;
358 iface->get_n_pages = pdf_document_get_n_pages;
359 iface->get_page_size = pdf_document_get_page_size;
360 iface->get_page_label = pdf_document_get_page_label;
361 iface->get_links = pdf_document_get_links;
362 iface->render_pixbuf = pdf_document_render_pixbuf;
363 iface->get_text = pdf_document_get_text;
364 iface->can_get_text = pdf_document_can_get_text;
368 pdf_document_security_iface_init (EvDocumentSecurityIface *iface)
370 iface->has_document_security = pdf_document_has_document_security;
371 iface->set_password = pdf_document_set_password;
375 pdf_document_links_has_document_links (EvDocumentLinks *document_links)
377 PdfDocument *pdf_document = PDF_DOCUMENT (document_links);
378 PopplerIndexIter *iter;
380 g_return_val_if_fail (PDF_IS_DOCUMENT (document_links), FALSE);
382 iter = poppler_index_iter_new (pdf_document->document);
385 poppler_index_iter_free (iter);
391 ev_link_from_action (PopplerAction *action)
396 title = action->any.title;
398 if (action->type == POPPLER_ACTION_GOTO_DEST) {
399 link = ev_link_new_page (title, action->goto_dest.dest->page_num - 1);
400 } else if (action->type == POPPLER_ACTION_URI) {
401 link = ev_link_new_external (title, action->uri.uri);
403 link = ev_link_new_title (title);
411 build_tree (PdfDocument *pdf_document,
414 PopplerIndexIter *iter)
418 GtkTreeIter tree_iter;
419 PopplerIndexIter *child;
420 PopplerAction *action;
423 action = poppler_index_iter_get_action (iter);
425 gtk_tree_store_append (GTK_TREE_STORE (model), &tree_iter, parent);
426 link = ev_link_from_action (action);
427 poppler_action_free (action);
429 gtk_tree_store_set (GTK_TREE_STORE (model), &tree_iter,
430 EV_DOCUMENT_LINKS_COLUMN_MARKUP, ev_link_get_title (link),
431 EV_DOCUMENT_LINKS_COLUMN_LINK, link,
433 child = poppler_index_iter_get_child (iter);
435 build_tree (pdf_document, model, &tree_iter, child);
436 poppler_index_iter_free (child);
438 } while (poppler_index_iter_next (iter));
442 static GtkTreeModel *
443 pdf_document_links_get_links_model (EvDocumentLinks *document_links)
445 PdfDocument *pdf_document = PDF_DOCUMENT (document_links);
446 GtkTreeModel *model = NULL;
447 PopplerIndexIter *iter;
449 g_return_val_if_fail (PDF_IS_DOCUMENT (document_links), NULL);
451 iter = poppler_index_iter_new (pdf_document->document);
452 /* Create the model iff we have items*/
454 model = (GtkTreeModel *) gtk_tree_store_new (EV_DOCUMENT_LINKS_COLUMN_NUM_COLUMNS,
457 build_tree (pdf_document, model, NULL, iter);
458 poppler_index_iter_free (iter);
467 pdf_document_document_links_iface_init (EvDocumentLinksIface *iface)
469 iface->has_document_links = pdf_document_links_has_document_links;
470 iface->get_links_model = pdf_document_links_get_links_model;
475 make_thumbnail_for_size (PdfDocument *pdf_document,
480 PopplerPage *poppler_page;
483 int x_offset, y_offset;
485 gdouble unscaled_width, unscaled_height;
487 poppler_page = poppler_document_get_page (pdf_document->document, page);
489 g_return_val_if_fail (poppler_page != NULL, NULL);
491 pdf_document_thumbnails_get_dimensions (EV_DOCUMENT_THUMBNAILS (pdf_document), page, size, &width, &height);
492 poppler_page_get_size (poppler_page, &unscaled_width, &unscaled_height);
493 scale = width / unscaled_width;
496 pixbuf = ev_document_misc_get_thumbnail_frame (width, height, NULL);
500 pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, TRUE, 8,
502 gdk_pixbuf_fill (pixbuf, 0xffffffff);
507 poppler_page_render_to_pixbuf (poppler_page, 0, 0,
516 pdf_document_thumbnails_get_thumbnail (EvDocumentThumbnails *document_thumbnails,
521 PdfDocument *pdf_document;
522 PopplerPage *poppler_page;
525 pdf_document = PDF_DOCUMENT (document_thumbnails);
527 poppler_page = poppler_document_get_page (pdf_document->document, page);
528 g_return_val_if_fail (poppler_page != NULL, NULL);
530 pixbuf = poppler_page_get_thumbnail (poppler_page);
531 if (pixbuf != NULL) {
532 /* The document provides its own thumbnails. */
534 GdkPixbuf *real_pixbuf;
536 real_pixbuf = ev_document_misc_get_thumbnail_frame (-1, -1, pixbuf);
537 g_object_unref (pixbuf);
538 pixbuf = real_pixbuf;
541 /* There is no provided thumbnail. We need to make one. */
542 pixbuf = make_thumbnail_for_size (pdf_document, page, size, border);
548 pdf_document_thumbnails_get_dimensions (EvDocumentThumbnails *document_thumbnails,
554 PdfDocument *pdf_document;
555 PopplerPage *poppler_page;
558 pdf_document = PDF_DOCUMENT (document_thumbnails);
559 poppler_page = poppler_document_get_page (pdf_document->document, page);
561 g_return_if_fail (width != NULL);
562 g_return_if_fail (height != NULL);
563 g_return_if_fail (poppler_page != NULL);
565 has_thumb = poppler_page_get_thumbnail_size (poppler_page, width, height);
568 double page_width, page_height;
570 poppler_page_get_size (poppler_page, &page_width, &page_height);
571 if (page_width > page_height) {
573 *height = (int) (size * page_height / page_width);
575 *width = (int) (size * page_width / page_height);
582 pdf_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface)
584 iface->get_thumbnail = pdf_document_thumbnails_get_thumbnail;
585 iface->get_dimensions = pdf_document_thumbnails_get_dimensions;
590 pdf_document_search_idle_callback (void *data)
592 PdfDocumentSearch *search = (PdfDocumentSearch*) data;
593 PdfDocument *pdf_document = search->document;
594 int n_pages, changed_page;
598 page = poppler_document_get_page (search->document->document,
599 search->search_page);
601 g_mutex_lock (EV_DOC_MUTEX);
602 matches = poppler_page_find_text (page, search->text);
603 g_mutex_unlock (EV_DOC_MUTEX);
605 search->pages[search->search_page] = matches;
606 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (search->document));
608 changed_page = search->search_page;
609 search->search_page += 1;
610 if (search->search_page == n_pages) {
612 search->search_page = 0;
615 if (search->search_page != search->start_page) {
616 ev_document_find_changed (EV_DOCUMENT_FIND (pdf_document),
622 search->idle = 0; /* will return FALSE to remove */
627 static PdfDocumentSearch *
628 pdf_document_search_new (PdfDocument *pdf_document,
632 PdfDocumentSearch *search;
636 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (pdf_document));
638 search = g_new0 (PdfDocumentSearch, 1);
640 search->text = g_strdup (text);
641 search->pages = g_new0 (GList *, n_pages);
642 for (i = 0; i < n_pages; i++) {
643 search->pages[i] = NULL;
646 search->document = pdf_document;
648 /* We add at low priority so the progress bar repaints */
649 search->idle = g_idle_add_full (G_PRIORITY_LOW,
650 pdf_document_search_idle_callback,
654 search->start_page = start_page;
655 search->search_page = start_page;
661 pdf_document_search_free (PdfDocumentSearch *search)
663 PdfDocument *pdf_document = search->document;
667 if (search->idle != 0)
668 g_source_remove (search->idle);
670 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (pdf_document));
671 for (i = 0; i < n_pages; i++) {
672 g_list_foreach (search->pages[i], (GFunc) g_free, NULL);
673 g_list_free (search->pages[i]);
676 g_free (search->text);
680 pdf_document_find_begin (EvDocumentFind *document,
682 const char *search_string,
683 gboolean case_sensitive)
685 PdfDocument *pdf_document = PDF_DOCUMENT (document);
687 /* FIXME handle case_sensitive (right now XPDF
688 * code is always case insensitive for ASCII
689 * and case sensitive for all other languaages)
692 if (pdf_document->search &&
693 strcmp (search_string, pdf_document->search->text) == 0)
696 if (pdf_document->search)
697 pdf_document_search_free (pdf_document->search);
699 pdf_document->search = pdf_document_search_new (pdf_document,
705 pdf_document_find_get_n_results (EvDocumentFind *document_find, int page)
707 PdfDocumentSearch *search = PDF_DOCUMENT (document_find)->search;
711 return g_list_length (search->pages[page]);
718 pdf_document_find_get_result (EvDocumentFind *document_find,
721 EvRectangle *rectangle)
723 PdfDocument *pdf_document = PDF_DOCUMENT (document_find);
724 PdfDocumentSearch *search = pdf_document->search;
725 PopplerPage *poppler_page;
733 r = (PopplerRectangle *) g_list_nth_data (search->pages[page],
738 poppler_page = poppler_document_get_page (pdf_document->document, page);
739 poppler_page_get_size (poppler_page, NULL, &height);
740 rectangle->x1 = r->x1;
741 rectangle->y1 = height - r->y2;
742 rectangle->x2 = r->x2;
743 rectangle->y2 = height - r->y1;
749 pdf_document_find_page_has_results (EvDocumentFind *document_find,
752 PdfDocumentSearch *search = PDF_DOCUMENT (document_find)->search;
754 g_return_val_if_fail (search != NULL, FALSE);
756 return search->pages[page] != NULL;
760 pdf_document_find_get_progress (EvDocumentFind *document_find)
762 PdfDocumentSearch *search;
763 int n_pages, pages_done;
765 search = PDF_DOCUMENT (document_find)->search;
767 if (search == NULL) {
771 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (document_find));
772 if (search->search_page > search->start_page) {
773 pages_done = search->search_page - search->start_page + 1;
774 } else if (search->search_page == search->start_page) {
775 pages_done = n_pages;
777 pages_done = n_pages - search->start_page + search->search_page;
780 return pages_done / (double) n_pages;
784 pdf_document_find_cancel (EvDocumentFind *document)
786 PdfDocument *pdf_document = PDF_DOCUMENT (document);
788 if (pdf_document->search) {
789 pdf_document_search_free (pdf_document->search);
790 pdf_document->search = NULL;
795 pdf_document_find_iface_init (EvDocumentFindIface *iface)
797 iface->begin = pdf_document_find_begin;
798 iface->get_n_results = pdf_document_find_get_n_results;
799 iface->get_result = pdf_document_find_get_result;
800 iface->page_has_results = pdf_document_find_page_has_results;
801 iface->get_progress = pdf_document_find_get_progress;
802 iface->cancel = pdf_document_find_cancel;
806 pdf_document_ps_exporter_begin (EvPSExporter *exporter, const char *filename)
808 PdfDocument *pdf_document = PDF_DOCUMENT (exporter);
811 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (exporter));
812 pdf_document->ps_file = poppler_ps_file_new (pdf_document->document,
817 pdf_document_ps_exporter_do_page (EvPSExporter *exporter, int page)
819 PdfDocument *pdf_document = PDF_DOCUMENT (exporter);
820 PopplerPage *poppler_page;
822 g_return_if_fail (pdf_document->ps_file != NULL);
824 poppler_page = poppler_document_get_page (pdf_document->document, page);
825 poppler_page_render_to_ps (poppler_page, pdf_document->ps_file);
829 pdf_document_ps_exporter_end (EvPSExporter *exporter)
831 PdfDocument *pdf_document = PDF_DOCUMENT (exporter);
833 poppler_ps_file_free (pdf_document->ps_file);
834 pdf_document->ps_file = NULL;
838 pdf_document_ps_exporter_iface_init (EvPSExporterIface *iface)
840 iface->begin = pdf_document_ps_exporter_begin;
841 iface->do_page = pdf_document_ps_exporter_do_page;
842 iface->end = pdf_document_ps_exporter_end;
846 pdf_document_new (void)
848 return PDF_DOCUMENT (g_object_new (PDF_TYPE_DOCUMENT, NULL));