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;
65 PdfDocumentSearch *search;
68 static void pdf_document_document_iface_init (EvDocumentIface *iface);
69 static void pdf_document_security_iface_init (EvDocumentSecurityIface *iface);
70 static void pdf_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface);
71 static void pdf_document_document_links_iface_init (EvDocumentLinksIface *iface);
72 static void pdf_document_find_iface_init (EvDocumentFindIface *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);
94 G_IMPLEMENT_INTERFACE (EV_TYPE_PS_EXPORTER,
95 pdf_document_ps_exporter_iface_init);
105 pdf_document_get_property (GObject *object,
110 PdfDocument *pdf_document = PDF_DOCUMENT (object);
115 if (pdf_document->document == NULL)
116 g_value_set_string (value, NULL);
118 g_object_get_property (G_OBJECT (pdf_document->document), "title", value);
124 pdf_document_class_init (PdfDocumentClass *klass)
126 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
128 gobject_class->get_property = pdf_document_get_property;
130 g_object_class_override_property (gobject_class, PROP_TITLE, "title");
134 pdf_document_init (PdfDocument *pdf_document)
136 pdf_document->page = NULL;
137 pdf_document->scale = 1.0;
138 pdf_document->password = NULL;
142 convert_error (GError *poppler_error,
145 if (poppler_error == NULL)
148 if (poppler_error->domain == POPPLER_ERROR) {
149 /* convert poppler errors into EvDocument errors */
150 gint code = EV_DOCUMENT_ERROR_INVALID;
151 if (poppler_error->code == POPPLER_ERROR_INVALID)
152 code = EV_DOCUMENT_ERROR_INVALID;
153 else if (poppler_error->code == POPPLER_ERROR_ENCRYPTED)
154 code = EV_DOCUMENT_ERROR_ENCRYPTED;
160 poppler_error->message,
163 g_propagate_error (error, poppler_error);
170 pdf_document_save (EvDocument *document,
175 GError *poppler_error = NULL;
177 retval = poppler_document_save (PDF_DOCUMENT (document)->document,
181 convert_error (poppler_error, error);
187 pdf_document_load (EvDocument *document,
191 GError *poppler_error = NULL;
192 PdfDocument *pdf_document = PDF_DOCUMENT (document);
194 pdf_document->document =
195 poppler_document_new_from_file (uri, pdf_document->password, &poppler_error);
197 if (pdf_document->document == NULL) {
198 convert_error (poppler_error, error);
206 pdf_document_get_n_pages (EvDocument *document)
208 return poppler_document_get_n_pages (PDF_DOCUMENT (document)->document);
212 pdf_document_set_page (EvDocument *document,
215 page = CLAMP (page, 0, poppler_document_get_n_pages (PDF_DOCUMENT (document)->document) - 1);
217 PDF_DOCUMENT (document)->page = poppler_document_get_page (PDF_DOCUMENT (document)->document, page);
221 pdf_document_get_page (EvDocument *document)
223 PdfDocument *pdf_document;
225 pdf_document = PDF_DOCUMENT (document);
227 if (pdf_document->page)
228 return poppler_page_get_index (pdf_document->page);
234 pdf_document_set_scale (EvDocument *document,
237 PDF_DOCUMENT (document)->scale = scale;
242 get_size_from_page (PopplerPage *poppler_page,
247 gdouble width_d, height_d;
248 poppler_page_get_size (poppler_page, &width_d, &height_d);
250 *width = (int) (width_d * scale);
252 *height = (int) (height_d * scale);
257 pdf_document_get_page_size (EvDocument *document,
262 PopplerPage *poppler_page = NULL;
265 poppler_page = PDF_DOCUMENT (document)->page;
267 poppler_page = poppler_document_get_page (PDF_DOCUMENT (document)->document,
270 if (poppler_page == NULL)
271 poppler_document_get_page (PDF_DOCUMENT (document)->document, 0);
273 get_size_from_page (poppler_page,
274 PDF_DOCUMENT (document)->scale,
279 pdf_document_get_page_label (EvDocument *document,
282 PopplerPage *poppler_page = NULL;
286 poppler_page = PDF_DOCUMENT (document)->page;
288 poppler_page = poppler_document_get_page (PDF_DOCUMENT (document)->document,
291 g_object_get (poppler_page,
299 pdf_document_get_links (EvDocument *document)
301 PdfDocument *pdf_document;
302 GList *retval = NULL;
307 pdf_document = PDF_DOCUMENT (document);
308 g_return_val_if_fail (pdf_document->page != NULL, NULL);
310 mapping_list = poppler_page_get_link_mapping (pdf_document->page);
311 get_size_from_page (pdf_document->page, 1.0, NULL, &height);
313 for (list = mapping_list; list; list = list->next) {
314 PopplerLinkMapping *link_mapping;
315 EvLinkMapping *ev_link_mapping;
317 link_mapping = (PopplerLinkMapping *)list->data;
318 ev_link_mapping = g_new (EvLinkMapping, 1);
319 ev_link_mapping->link = ev_link_from_action (link_mapping->action);
320 ev_link_mapping->x1 = link_mapping->area.x1;
321 ev_link_mapping->x2 = link_mapping->area.x2;
322 /* Invert this for X-style coordinates */
323 ev_link_mapping->y1 = height - link_mapping->area.y2;
324 ev_link_mapping->y2 = height - link_mapping->area.y1;
326 retval = g_list_prepend (retval, ev_link_mapping);
329 poppler_page_free_link_mapping (mapping_list);
331 return g_list_reverse (retval);
336 pdf_document_render_pixbuf (EvDocument *document)
338 PdfDocument *pdf_document;
342 pdf_document = PDF_DOCUMENT (document);
343 g_return_val_if_fail (pdf_document->page != NULL, NULL);
345 get_size_from_page (pdf_document->page,
349 pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB,
353 poppler_page_render_to_pixbuf (pdf_document->page,
363 /* EvDocumentSecurity */
366 pdf_document_has_document_security (EvDocumentSecurity *document_security)
368 /* FIXME: do we really need to have this? */
373 pdf_document_set_password (EvDocumentSecurity *document_security,
374 const char *password)
376 PdfDocument *document = PDF_DOCUMENT (document_security);
378 if (document->password)
379 g_free (document->password);
381 document->password = g_strdup (password);
387 pdf_document_document_iface_init (EvDocumentIface *iface)
389 iface->save = pdf_document_save;
390 iface->load = pdf_document_load;
391 iface->get_n_pages = pdf_document_get_n_pages;
392 iface->set_page = pdf_document_set_page;
393 iface->get_page = pdf_document_get_page;
394 iface->set_scale = pdf_document_set_scale;
395 iface->get_page_size = pdf_document_get_page_size;
396 iface->get_page_label = pdf_document_get_page_label;
397 iface->get_links = pdf_document_get_links;
398 iface->render_pixbuf = pdf_document_render_pixbuf;
402 pdf_document_security_iface_init (EvDocumentSecurityIface *iface)
404 iface->has_document_security = pdf_document_has_document_security;
405 iface->set_password = pdf_document_set_password;
409 pdf_document_links_has_document_links (EvDocumentLinks *document_links)
411 PdfDocument *pdf_document = PDF_DOCUMENT (document_links);
412 PopplerIndexIter *iter;
414 g_return_val_if_fail (PDF_IS_DOCUMENT (document_links), FALSE);
416 iter = poppler_index_iter_new (pdf_document->document);
419 poppler_index_iter_free (iter);
425 ev_link_from_action (PopplerAction *action)
430 title = action->any.title;
432 if (action->type == POPPLER_ACTION_GOTO_DEST) {
433 link = ev_link_new_page (title, action->goto_dest.dest->page_num - 1);
434 } else if (action->type == POPPLER_ACTION_URI) {
435 link = ev_link_new_external (title, action->uri.uri);
437 link = ev_link_new_title (title);
445 build_tree (PdfDocument *pdf_document,
448 PopplerIndexIter *iter)
452 GtkTreeIter tree_iter;
453 PopplerIndexIter *child;
454 PopplerAction *action;
457 action = poppler_index_iter_get_action (iter);
459 gtk_tree_store_append (GTK_TREE_STORE (model), &tree_iter, parent);
460 link = ev_link_from_action (action);
461 poppler_action_free (action);
463 gtk_tree_store_set (GTK_TREE_STORE (model), &tree_iter,
464 EV_DOCUMENT_LINKS_COLUMN_MARKUP, ev_link_get_title (link),
465 EV_DOCUMENT_LINKS_COLUMN_LINK, link,
467 child = poppler_index_iter_get_child (iter);
469 build_tree (pdf_document, model, &tree_iter, child);
470 poppler_index_iter_free (child);
472 } while (poppler_index_iter_next (iter));
476 static GtkTreeModel *
477 pdf_document_links_get_links_model (EvDocumentLinks *document_links)
479 PdfDocument *pdf_document = PDF_DOCUMENT (document_links);
480 GtkTreeModel *model = NULL;
481 PopplerIndexIter *iter;
483 g_return_val_if_fail (PDF_IS_DOCUMENT (document_links), NULL);
485 iter = poppler_index_iter_new (pdf_document->document);
486 /* Create the model iff we have items*/
488 model = (GtkTreeModel *) gtk_tree_store_new (EV_DOCUMENT_LINKS_COLUMN_NUM_COLUMNS,
491 build_tree (pdf_document, model, NULL, iter);
492 poppler_index_iter_free (iter);
501 pdf_document_document_links_iface_init (EvDocumentLinksIface *iface)
503 iface->has_document_links = pdf_document_links_has_document_links;
504 iface->get_links_model = pdf_document_links_get_links_model;
509 make_thumbnail_for_size (PdfDocument *pdf_document,
514 PopplerPage *poppler_page;
517 int x_offset, y_offset;
519 gdouble unscaled_width, unscaled_height;
521 poppler_page = poppler_document_get_page (pdf_document->document, page);
523 g_return_val_if_fail (poppler_page != NULL, NULL);
525 pdf_document_thumbnails_get_dimensions (EV_DOCUMENT_THUMBNAILS (pdf_document), page, size, &width, &height);
526 poppler_page_get_size (poppler_page, &unscaled_width, &unscaled_height);
527 scale = width / unscaled_width;
530 pixbuf = ev_document_misc_get_thumbnail_frame (width, height, NULL);
534 pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, TRUE, 8,
536 gdk_pixbuf_fill (pixbuf, 0xffffffff);
541 poppler_page_render_to_pixbuf (poppler_page, 0, 0,
550 pdf_document_thumbnails_get_thumbnail (EvDocumentThumbnails *document_thumbnails,
555 PdfDocument *pdf_document;
556 PopplerPage *poppler_page;
559 pdf_document = PDF_DOCUMENT (document_thumbnails);
561 poppler_page = poppler_document_get_page (pdf_document->document, page);
562 g_return_val_if_fail (poppler_page != NULL, NULL);
564 pixbuf = poppler_page_get_thumbnail (poppler_page);
565 if (pixbuf != NULL) {
566 /* The document provides its own thumbnails. */
568 GdkPixbuf *real_pixbuf;
570 real_pixbuf = ev_document_misc_get_thumbnail_frame (-1, -1, pixbuf);
571 g_object_unref (pixbuf);
572 pixbuf = real_pixbuf;
575 /* There is no provided thumbnail. We need to make one. */
576 pixbuf = make_thumbnail_for_size (pdf_document, page, size, border);
582 pdf_document_thumbnails_get_dimensions (EvDocumentThumbnails *document_thumbnails,
588 PdfDocument *pdf_document;
589 PopplerPage *poppler_page;
592 pdf_document = PDF_DOCUMENT (document_thumbnails);
593 poppler_page = poppler_document_get_page (pdf_document->document, page);
595 g_return_if_fail (width != NULL);
596 g_return_if_fail (height != NULL);
597 g_return_if_fail (poppler_page != NULL);
599 has_thumb = poppler_page_get_thumbnail_size (poppler_page, width, height);
602 int page_width, page_height;
604 get_size_from_page (poppler_page, 1.0, &page_width, &page_height);
606 if (page_width > page_height) {
608 *height = (int) (size * page_height / page_width);
610 *width = (int) (size * page_width / page_height);
617 pdf_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface)
619 iface->get_thumbnail = pdf_document_thumbnails_get_thumbnail;
620 iface->get_dimensions = pdf_document_thumbnails_get_dimensions;
625 pdf_document_search_idle_callback (void *data)
627 PdfDocumentSearch *search = (PdfDocumentSearch*) data;
628 PdfDocument *pdf_document = search->document;
629 int n_pages, changed_page;
633 page = poppler_document_get_page (search->document->document,
634 search->search_page);
636 g_mutex_lock (EV_DOC_MUTEX);
637 matches = poppler_page_find_text (page, search->text);
638 g_mutex_unlock (EV_DOC_MUTEX);
640 search->pages[search->search_page] = matches;
641 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (search->document));
643 changed_page = search->start_page;
645 search->search_page += 1;
646 if (search->search_page == n_pages) {
648 search->search_page = 0;
651 if (search->search_page != search->start_page) {
652 ev_document_find_changed (EV_DOCUMENT_FIND (pdf_document),
658 search->idle = 0; /* will return FALSE to remove */
663 static PdfDocumentSearch *
664 pdf_document_search_new (PdfDocument *pdf_document, const char *text)
666 PdfDocumentSearch *search;
670 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (pdf_document));
672 search = g_new0 (PdfDocumentSearch, 1);
674 search->text = g_strdup (text);
675 search->pages = g_new0 (GList *, n_pages);
676 for (i = 0; i < n_pages; i++) {
677 search->pages[i] = NULL;
680 search->document = pdf_document;
682 /* We add at low priority so the progress bar repaints */
683 search->idle = g_idle_add_full (G_PRIORITY_LOW,
684 pdf_document_search_idle_callback,
688 search->start_page = pdf_document_get_page (EV_DOCUMENT (pdf_document));
689 search->search_page = search->start_page;
695 pdf_document_search_free (PdfDocumentSearch *search)
697 PdfDocument *pdf_document = search->document;
701 if (search->idle != 0)
702 g_source_remove (search->idle);
704 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (pdf_document));
705 for (i = 0; i < n_pages; i++) {
706 g_list_foreach (search->pages[i], (GFunc) g_free, NULL);
707 g_list_free (search->pages[i]);
710 g_free (search->text);
714 pdf_document_find_begin (EvDocumentFind *document,
715 const char *search_string,
716 gboolean case_sensitive)
718 PdfDocument *pdf_document = PDF_DOCUMENT (document);
720 /* FIXME handle case_sensitive (right now XPDF
721 * code is always case insensitive for ASCII
722 * and case sensitive for all other languaages)
725 if (pdf_document->search &&
726 strcmp (search_string, pdf_document->search->text) == 0)
729 if (pdf_document->search)
730 pdf_document_search_free (pdf_document->search);
732 pdf_document->search = pdf_document_search_new (pdf_document,
737 pdf_document_find_get_n_results (EvDocumentFind *document_find)
739 PdfDocumentSearch *search = PDF_DOCUMENT (document_find)->search;
742 current_page = pdf_document_get_page (EV_DOCUMENT (document_find));
745 return g_list_length (search->pages[current_page]);
752 pdf_document_find_get_result (EvDocumentFind *document_find,
754 GdkRectangle *rectangle)
756 PdfDocument *pdf_document = PDF_DOCUMENT (document_find);
757 PdfDocumentSearch *search = pdf_document->search;
765 current_page = pdf_document_get_page (EV_DOCUMENT (pdf_document));
766 r = (PopplerRectangle *) g_list_nth_data (search->pages[current_page],
771 scale = pdf_document->scale;
772 rectangle->x = (gint) floor (r->x1 * scale);
773 rectangle->y = (gint) floor (r->y1 * scale);
774 rectangle->width = (gint) ceil (r->x2 * scale) - rectangle->x;
775 rectangle->height = (gint) ceil (r->y2 * scale) - rectangle->y;
781 pdf_document_find_page_has_results (EvDocumentFind *document_find,
784 PdfDocumentSearch *search = PDF_DOCUMENT (document_find)->search;
786 g_return_val_if_fail (search != NULL, FALSE);
788 return search->pages[page] != NULL;
792 pdf_document_find_get_progress (EvDocumentFind *document_find)
794 PdfDocumentSearch *search;
795 int n_pages, pages_done;
797 search = PDF_DOCUMENT (document_find)->search;
799 if (search == NULL) {
803 n_pages = pdf_document_get_n_pages (EV_DOCUMENT (document_find));
804 if (search->search_page > search->start_page) {
805 pages_done = search->search_page - search->start_page + 1;
806 } else if (search->search_page == search->start_page) {
807 pages_done = n_pages;
809 pages_done = n_pages - search->start_page + search->search_page;
812 return pages_done / (double) n_pages;
816 pdf_document_find_cancel (EvDocumentFind *document)
818 PdfDocument *pdf_document = PDF_DOCUMENT (document);
820 if (pdf_document->search) {
821 pdf_document_search_free (pdf_document->search);
822 pdf_document->search = NULL;
827 pdf_document_find_iface_init (EvDocumentFindIface *iface)
829 iface->begin = pdf_document_find_begin;
830 iface->get_n_results = pdf_document_find_get_n_results;
831 iface->get_result = pdf_document_find_get_result;
832 iface->page_has_results = pdf_document_find_page_has_results;
833 iface->get_progress = pdf_document_find_get_progress;
834 iface->cancel = pdf_document_find_cancel;
839 pdf_document_new (void)
841 return PDF_DOCUMENT (g_object_new (PDF_TYPE_DOCUMENT, NULL));