1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
3 * Copyright (C) 2009 Carlos Garcia Campos
4 * Copyright (C) 2004 Marco Pesenti Gritti
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
11 * This program 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
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 #include "ev-document.h"
29 #define EV_DOCUMENT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EV_TYPE_DOCUMENT, EvDocumentPrivate))
31 typedef struct _EvPageSize
37 struct _EvDocumentPrivate
44 gdouble uniform_width;
45 gdouble uniform_height;
52 EvPageSize *page_sizes;
56 static gint _ev_document_get_n_pages (EvDocument *document);
57 static void _ev_document_get_page_size (EvDocument *document,
61 static gchar *_ev_document_get_page_label (EvDocument *document,
63 static EvDocumentInfo *_ev_document_get_info (EvDocument *document);
65 GMutex *ev_doc_mutex = NULL;
66 GMutex *ev_fc_mutex = NULL;
68 G_DEFINE_ABSTRACT_TYPE (EvDocument, ev_document, G_TYPE_OBJECT)
71 ev_document_error_quark (void)
75 q = g_quark_from_static_string ("ev-document-error-quark");
81 ev_document_impl_get_page (EvDocument *document,
84 return ev_page_new (index);
87 static EvDocumentInfo *
88 ev_document_impl_get_info (EvDocument *document)
90 return g_new0 (EvDocumentInfo, 1);
94 ev_document_finalize (GObject *object)
96 EvDocument *document = EV_DOCUMENT (object);
98 if (document->priv->uri) {
99 g_free (document->priv->uri);
100 document->priv->uri = NULL;
103 if (document->priv->page_sizes) {
104 g_free (document->priv->page_sizes);
105 document->priv->page_sizes = NULL;
108 if (document->priv->page_labels) {
111 for (i = 0; i < document->priv->n_pages; i++) {
112 g_free (document->priv->page_labels[i]);
114 g_free (document->priv->page_labels);
115 document->priv->page_labels = NULL;
118 if (document->priv->info) {
119 ev_document_info_free (document->priv->info);
120 document->priv->info = NULL;
123 G_OBJECT_CLASS (ev_document_parent_class)->finalize (object);
127 ev_document_init (EvDocument *document)
129 document->priv = EV_DOCUMENT_GET_PRIVATE (document);
131 /* Assume all pages are the same size until proven otherwise */
132 document->priv->uniform = TRUE;
136 ev_document_class_init (EvDocumentClass *klass)
138 GObjectClass *g_object_class = G_OBJECT_CLASS (klass);
140 g_type_class_add_private (g_object_class, sizeof (EvDocumentPrivate));
142 klass->get_page = ev_document_impl_get_page;
143 klass->get_info = ev_document_impl_get_info;
145 g_object_class->finalize = ev_document_finalize;
149 ev_document_get_doc_mutex (void)
151 if (ev_doc_mutex == NULL) {
152 ev_doc_mutex = g_mutex_new ();
158 ev_document_doc_mutex_lock (void)
160 g_mutex_lock (ev_document_get_doc_mutex ());
164 ev_document_doc_mutex_unlock (void)
166 g_mutex_unlock (ev_document_get_doc_mutex ());
170 ev_document_doc_mutex_trylock (void)
172 return g_mutex_trylock (ev_document_get_doc_mutex ());
176 ev_document_get_fc_mutex (void)
178 if (ev_fc_mutex == NULL) {
179 ev_fc_mutex = g_mutex_new ();
185 ev_document_fc_mutex_lock (void)
187 g_mutex_lock (ev_document_get_fc_mutex ());
191 ev_document_fc_mutex_unlock (void)
193 g_mutex_unlock (ev_document_get_fc_mutex ());
197 ev_document_fc_mutex_trylock (void)
199 return g_mutex_trylock (ev_document_get_fc_mutex ());
204 * @document: a #EvDocument
205 * @uri: the document's URI
206 * @error: a #GError location to store an error, or %NULL
208 * Loads @document from @uri.
210 * On failure, %FALSE is returned and @error is filled in.
211 * If the document is encrypted, EV_DEFINE_ERROR_ENCRYPTED is returned.
212 * If the backend cannot load the specific document, EV_DOCUMENT_ERROR_INVALID
213 * is returned. Other errors are possible too, depending on the backend
214 * used to load the document and the URI, e.g. #GIOError, #GFileError, and
217 * Returns: %TRUE on success, or %FALSE on failure.
220 ev_document_load (EvDocument *document,
224 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
228 retval = klass->load (document, uri, &err);
231 g_propagate_error (error, err);
233 g_warning ("%s::EvDocument::load returned FALSE but did not fill in @error; fix the backend!\n",
234 G_OBJECT_TYPE_NAME (document));
236 /* So upper layers don't crash */
237 g_set_error_literal (error,
239 EV_DOCUMENT_ERROR_INVALID,
240 "Internal error in backend");
244 EvDocumentPrivate *priv = document->priv;
246 /* Cache some info about the document to avoid
247 * going to the backends since it requires locks
249 priv->uri = g_strdup (uri);
250 priv->n_pages = _ev_document_get_n_pages (document);
251 priv->info = _ev_document_get_info (document);
253 for (i = 0; i < priv->n_pages; i++) {
254 EvPage *page = ev_document_get_page (document, i);
255 gdouble page_width = 0;
256 gdouble page_height = 0;
257 EvPageSize *page_size;
260 _ev_document_get_page_size (document, page, &page_width, &page_height);
263 priv->uniform_width = page_width;
264 priv->uniform_height = page_height;
265 } else if (priv->uniform &&
266 (priv->uniform_width != page_width ||
267 priv->uniform_height != page_height)) {
268 /* It's a different page size. Backfill the array. */
271 priv->page_sizes = g_new0 (EvPageSize, priv->n_pages);
273 for (j = 0; j < i; j++) {
274 page_size = &(priv->page_sizes[j]);
275 page_size->width = priv->uniform_width;
276 page_size->height = priv->uniform_height;
278 priv->uniform = FALSE;
280 if (!priv->uniform) {
281 page_size = &(priv->page_sizes[i]);
283 page_size->width = page_width;
284 page_size->height = page_height;
286 if (page_width > priv->max_width)
287 priv->max_width = page_width;
289 if (page_height > priv->max_height)
290 priv->max_height = page_height;
293 page_label = _ev_document_get_page_label (document, page);
295 if (priv->page_labels) {
296 priv->page_labels[i] = page_label;
298 gchar *numeric_label;
300 numeric_label = g_strdup_printf ("%d", i + 1);
301 if (strcmp (numeric_label, page_label) != 0) {
302 priv->page_labels = g_new0 (gchar *, priv->n_pages);
303 priv->page_labels[i] = page_label;
305 g_free (numeric_label);
307 priv->max_label = MAX (priv->max_label,
308 g_utf8_strlen (page_label, 256));
311 g_object_unref (page);
315 priv->max_width = priv->uniform_width;
316 priv->max_height = priv->uniform_height;
326 * @uri: the target URI
327 * @error: a #GError location to store an error, or %NULL
329 * Saves @document to @uri.
331 * Returns: %TRUE on success, or %FALSE on error with @error filled in
334 ev_document_save (EvDocument *document,
338 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
340 return klass->save (document, uri, error);
344 ev_document_get_page (EvDocument *document,
347 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
349 return klass->get_page (document, index);
353 _ev_document_get_n_pages (EvDocument *document)
355 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
357 return klass->get_n_pages (document);
361 ev_document_get_n_pages (EvDocument *document)
363 g_return_val_if_fail (EV_IS_DOCUMENT (document), 0);
365 return document->priv->n_pages;
369 _ev_document_get_page_size (EvDocument *document,
374 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
376 klass->get_page_size (document, page, width, height);
380 ev_document_get_page_size (EvDocument *document,
385 g_return_if_fail (EV_IS_DOCUMENT (document));
386 g_return_if_fail (page_index >= 0 || page_index < document->priv->n_pages);
389 *width = document->priv->uniform ?
390 document->priv->uniform_width :
391 document->priv->page_sizes[page_index].width;
393 *height = document->priv->uniform ?
394 document->priv->uniform_height :
395 document->priv->page_sizes[page_index].height;
399 _ev_document_get_page_label (EvDocument *document,
402 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
404 return klass->get_page_label ?
405 klass->get_page_label (document, page) : NULL;
409 ev_document_get_page_label (EvDocument *document,
412 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
413 g_return_val_if_fail (page_index >= 0 || page_index < document->priv->n_pages, NULL);
415 return (document->priv->page_labels && document->priv->page_labels[page_index]) ?
416 g_strdup (document->priv->page_labels[page_index]) :
417 g_strdup_printf ("%d", page_index + 1);
420 static EvDocumentInfo *
421 _ev_document_get_info (EvDocument *document)
423 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
425 return klass->get_info (document);
429 ev_document_get_info (EvDocument *document)
431 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
433 return document->priv->info;
437 ev_document_render (EvDocument *document,
440 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
442 return klass->render (document, rc);
446 ev_document_get_uri (EvDocument *document)
448 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
450 return document->priv->uri;
454 ev_document_get_title (EvDocument *document)
456 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
458 return (document->priv->info->fields_mask & EV_DOCUMENT_INFO_TITLE) ?
459 document->priv->info->title : NULL;
463 ev_document_is_page_size_uniform (EvDocument *document)
465 g_return_val_if_fail (EV_IS_DOCUMENT (document), TRUE);
467 return document->priv->uniform;
471 ev_document_get_max_page_size (EvDocument *document,
475 g_return_if_fail (EV_IS_DOCUMENT (document));
478 *width = document->priv->max_width;
480 *height = document->priv->max_height;
484 ev_document_check_dimensions (EvDocument *document)
486 g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
488 return (document->priv->max_width > 0 && document->priv->max_height > 0);
492 ev_document_get_max_label_len (EvDocument *document)
494 g_return_val_if_fail (EV_IS_DOCUMENT (document), -1);
496 return document->priv->max_label;
500 ev_document_has_text_page_labels (EvDocument *document)
502 g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
504 return document->priv->page_labels != NULL;
508 ev_document_find_page_by_label (EvDocument *document,
509 const gchar *page_label,
514 gchar *endptr = NULL;
515 EvDocumentPrivate *priv = document->priv;
517 g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
518 g_return_val_if_fail (page_label != NULL, FALSE);
519 g_return_val_if_fail (page_index != NULL, FALSE);
521 /* First, look for a literal label match */
522 for (i = 0; priv->page_labels && i < priv->n_pages; i ++) {
523 if (priv->page_labels[i] != NULL &&
524 ! strcmp (page_label, priv->page_labels[i])) {
530 /* Second, look for a match with case insensitively */
531 for (i = 0; priv->page_labels && i < priv->n_pages; i++) {
532 if (priv->page_labels[i] != NULL &&
533 ! strcasecmp (page_label, priv->page_labels[i])) {
539 /* Next, parse the label, and see if the number fits */
540 value = strtol (page_label, &endptr, 10);
541 if (endptr[0] == '\0') {
542 /* Page number is an integer */
543 page = MIN (G_MAXINT, value);
545 /* convert from a page label to a page offset */
547 if (page >= 0 && page < priv->n_pages) {
557 EV_DEFINE_BOXED_TYPE (EvDocumentInfo, ev_document_info, ev_document_info_copy, ev_document_info_free)
560 ev_document_info_copy (EvDocumentInfo *info)
562 EvDocumentInfo *copy;
564 g_return_val_if_fail (info != NULL, NULL);
566 copy = g_new0 (EvDocumentInfo, 1);
567 copy->title = g_strdup (info->title);
568 copy->format = g_strdup (info->format);
569 copy->author = g_strdup (info->author);
570 copy->subject = g_strdup (info->subject);
571 copy->keywords = g_strdup (info->keywords);
572 copy->security = g_strdup (info->security);
573 copy->creator = g_strdup (info->creator);
574 copy->producer = g_strdup (info->producer);
575 copy->linearized = g_strdup (info->linearized);
577 copy->creation_date = info->creation_date;
578 copy->modified_date = info->modified_date;
579 copy->layout = info->layout;
580 copy->mode = info->mode;
581 copy->ui_hints = info->ui_hints;
582 copy->permissions = info->permissions;
583 copy->n_pages = info->n_pages;
584 copy->fields_mask = info->fields_mask;
590 ev_document_info_free (EvDocumentInfo *info)
595 g_free (info->title);
596 g_free (info->format);
597 g_free (info->author);
598 g_free (info->subject);
599 g_free (info->keywords);
600 g_free (info->creator);
601 g_free (info->producer);
602 g_free (info->linearized);
603 g_free (info->security);
609 EV_DEFINE_BOXED_TYPE (EvRectangle, ev_rectangle, ev_rectangle_copy, ev_rectangle_free)
612 ev_rectangle_new (void)
614 return g_new0 (EvRectangle, 1);
618 ev_rectangle_copy (EvRectangle *rectangle)
620 EvRectangle *new_rectangle;
622 g_return_val_if_fail (rectangle != NULL, NULL);
624 new_rectangle = g_new (EvRectangle, 1);
625 *new_rectangle = *rectangle;
627 return new_rectangle;
631 ev_rectangle_free (EvRectangle *rectangle)
636 /* Compares two rects. returns 0 if they're equal */
637 #define EPSILON 0.0000001
640 ev_rect_cmp (EvRectangle *a,
645 if (a == NULL || b == NULL)
648 return ! ((ABS (a->x1 - b->x1) < EPSILON) &&
649 (ABS (a->y1 - b->y1) < EPSILON) &&
650 (ABS (a->x2 - b->x2) < EPSILON) &&
651 (ABS (a->y2 - b->y2) < EPSILON));