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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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;
144 klass->get_backend_info = NULL;
146 g_object_class->finalize = ev_document_finalize;
150 ev_document_get_doc_mutex (void)
152 if (ev_doc_mutex == NULL) {
153 ev_doc_mutex = g_mutex_new ();
159 ev_document_doc_mutex_lock (void)
161 g_mutex_lock (ev_document_get_doc_mutex ());
165 ev_document_doc_mutex_unlock (void)
167 g_mutex_unlock (ev_document_get_doc_mutex ());
171 ev_document_doc_mutex_trylock (void)
173 return g_mutex_trylock (ev_document_get_doc_mutex ());
177 ev_document_get_fc_mutex (void)
179 if (ev_fc_mutex == NULL) {
180 ev_fc_mutex = g_mutex_new ();
186 ev_document_fc_mutex_lock (void)
188 g_mutex_lock (ev_document_get_fc_mutex ());
192 ev_document_fc_mutex_unlock (void)
194 g_mutex_unlock (ev_document_get_fc_mutex ());
198 ev_document_fc_mutex_trylock (void)
200 return g_mutex_trylock (ev_document_get_fc_mutex ());
205 * @document: a #EvDocument
206 * @uri: the document's URI
207 * @error: a #GError location to store an error, or %NULL
209 * Loads @document from @uri.
211 * On failure, %FALSE is returned and @error is filled in.
212 * If the document is encrypted, EV_DEFINE_ERROR_ENCRYPTED is returned.
213 * If the backend cannot load the specific document, EV_DOCUMENT_ERROR_INVALID
214 * is returned. Other errors are possible too, depending on the backend
215 * used to load the document and the URI, e.g. #GIOError, #GFileError, and
218 * Returns: %TRUE on success, or %FALSE on failure.
221 ev_document_load (EvDocument *document,
225 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
229 retval = klass->load (document, uri, &err);
232 g_propagate_error (error, err);
234 g_warning ("%s::EvDocument::load returned FALSE but did not fill in @error; fix the backend!\n",
235 G_OBJECT_TYPE_NAME (document));
237 /* So upper layers don't crash */
238 g_set_error_literal (error,
240 EV_DOCUMENT_ERROR_INVALID,
241 "Internal error in backend");
245 EvDocumentPrivate *priv = document->priv;
247 /* Cache some info about the document to avoid
248 * going to the backends since it requires locks
250 priv->uri = g_strdup (uri);
251 priv->n_pages = _ev_document_get_n_pages (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 priv->max_width = priv->uniform_width;
266 priv->max_height = priv->uniform_height;
267 } else if (priv->uniform &&
268 (priv->uniform_width != page_width ||
269 priv->uniform_height != page_height)) {
270 /* It's a different page size. Backfill the array. */
273 priv->page_sizes = g_new0 (EvPageSize, priv->n_pages);
275 for (j = 0; j < i; j++) {
276 page_size = &(priv->page_sizes[j]);
277 page_size->width = priv->uniform_width;
278 page_size->height = priv->uniform_height;
280 priv->uniform = FALSE;
282 if (!priv->uniform) {
283 page_size = &(priv->page_sizes[i]);
285 page_size->width = page_width;
286 page_size->height = page_height;
288 if (page_width > priv->max_width)
289 priv->max_width = page_width;
291 if (page_height > priv->max_height)
292 priv->max_height = page_height;
295 page_label = _ev_document_get_page_label (document, page);
297 if (!priv->page_labels)
298 priv->page_labels = g_new0 (gchar *, priv->n_pages);
300 priv->page_labels[i] = page_label;
301 priv->max_label = MAX (priv->max_label,
302 g_utf8_strlen (page_label, 256));
305 g_object_unref (page);
308 priv->info = _ev_document_get_info (document);
317 * @uri: the target URI
318 * @error: a #GError location to store an error, or %NULL
320 * Saves @document to @uri.
322 * Returns: %TRUE on success, or %FALSE on error with @error filled in
325 ev_document_save (EvDocument *document,
329 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
331 return klass->save (document, uri, error);
335 ev_document_get_page (EvDocument *document,
338 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
340 return klass->get_page (document, index);
344 _ev_document_get_n_pages (EvDocument *document)
346 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
348 return klass->get_n_pages (document);
352 ev_document_get_n_pages (EvDocument *document)
354 g_return_val_if_fail (EV_IS_DOCUMENT (document), 0);
356 return document->priv->n_pages;
360 _ev_document_get_page_size (EvDocument *document,
365 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
367 klass->get_page_size (document, page, width, height);
371 ev_document_get_page_size (EvDocument *document,
376 g_return_if_fail (EV_IS_DOCUMENT (document));
377 g_return_if_fail (page_index >= 0 || page_index < document->priv->n_pages);
380 *width = document->priv->uniform ?
381 document->priv->uniform_width :
382 document->priv->page_sizes[page_index].width;
384 *height = document->priv->uniform ?
385 document->priv->uniform_height :
386 document->priv->page_sizes[page_index].height;
390 _ev_document_get_page_label (EvDocument *document,
393 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
395 return klass->get_page_label ?
396 klass->get_page_label (document, page) : NULL;
400 ev_document_get_page_label (EvDocument *document,
403 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
404 g_return_val_if_fail (page_index >= 0 || page_index < document->priv->n_pages, NULL);
406 return (document->priv->page_labels && document->priv->page_labels[page_index]) ?
407 g_strdup (document->priv->page_labels[page_index]) :
408 g_strdup_printf ("%d", page_index + 1);
411 static EvDocumentInfo *
412 _ev_document_get_info (EvDocument *document)
414 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
416 return klass->get_info (document);
420 ev_document_get_info (EvDocument *document)
422 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
424 return document->priv->info;
428 ev_document_get_backend_info (EvDocument *document, EvDocumentBackendInfo *info)
430 g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
432 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
433 if (klass->get_backend_info == NULL)
436 return klass->get_backend_info (document, info);
440 ev_document_render (EvDocument *document,
443 EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
445 return klass->render (document, rc);
449 ev_document_get_uri (EvDocument *document)
451 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
453 return document->priv->uri;
457 ev_document_get_title (EvDocument *document)
459 g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
461 return (document->priv->info->fields_mask & EV_DOCUMENT_INFO_TITLE) ?
462 document->priv->info->title : NULL;
466 ev_document_is_page_size_uniform (EvDocument *document)
468 g_return_val_if_fail (EV_IS_DOCUMENT (document), TRUE);
470 return document->priv->uniform;
474 ev_document_get_max_page_size (EvDocument *document,
478 g_return_if_fail (EV_IS_DOCUMENT (document));
481 *width = document->priv->max_width;
483 *height = document->priv->max_height;
487 ev_document_check_dimensions (EvDocument *document)
489 g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
491 return (document->priv->max_width > 0 && document->priv->max_height > 0);
495 ev_document_get_max_label_len (EvDocument *document)
497 g_return_val_if_fail (EV_IS_DOCUMENT (document), -1);
499 return document->priv->max_label;
503 ev_document_has_text_page_labels (EvDocument *document)
505 g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
507 return document->priv->page_labels != NULL;
511 ev_document_find_page_by_label (EvDocument *document,
512 const gchar *page_label,
517 gchar *endptr = NULL;
518 EvDocumentPrivate *priv = document->priv;
520 g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
521 g_return_val_if_fail (page_label != NULL, FALSE);
522 g_return_val_if_fail (page_index != NULL, FALSE);
524 /* First, look for a literal label match */
525 for (i = 0; priv->page_labels && i < priv->n_pages; i ++) {
526 if (priv->page_labels[i] != NULL &&
527 ! strcmp (page_label, priv->page_labels[i])) {
533 /* Second, look for a match with case insensitively */
534 for (i = 0; priv->page_labels && i < priv->n_pages; i++) {
535 if (priv->page_labels[i] != NULL &&
536 ! strcasecmp (page_label, priv->page_labels[i])) {
542 /* Next, parse the label, and see if the number fits */
543 value = strtol (page_label, &endptr, 10);
544 if (endptr[0] == '\0') {
545 /* Page number is an integer */
546 page = MIN (G_MAXINT, value);
548 /* convert from a page label to a page offset */
550 if (page >= 0 && page < priv->n_pages) {
560 EV_DEFINE_BOXED_TYPE (EvDocumentInfo, ev_document_info, ev_document_info_copy, ev_document_info_free)
563 ev_document_info_copy (EvDocumentInfo *info)
565 EvDocumentInfo *copy;
567 g_return_val_if_fail (info != NULL, NULL);
569 copy = g_new0 (EvDocumentInfo, 1);
570 copy->title = g_strdup (info->title);
571 copy->format = g_strdup (info->format);
572 copy->author = g_strdup (info->author);
573 copy->subject = g_strdup (info->subject);
574 copy->keywords = g_strdup (info->keywords);
575 copy->security = g_strdup (info->security);
576 copy->creator = g_strdup (info->creator);
577 copy->producer = g_strdup (info->producer);
578 copy->linearized = g_strdup (info->linearized);
580 copy->creation_date = info->creation_date;
581 copy->modified_date = info->modified_date;
582 copy->layout = info->layout;
583 copy->mode = info->mode;
584 copy->ui_hints = info->ui_hints;
585 copy->permissions = info->permissions;
586 copy->n_pages = info->n_pages;
587 copy->license = ev_document_license_copy (info->license);
589 copy->fields_mask = info->fields_mask;
595 ev_document_info_free (EvDocumentInfo *info)
600 g_free (info->title);
601 g_free (info->format);
602 g_free (info->author);
603 g_free (info->subject);
604 g_free (info->keywords);
605 g_free (info->creator);
606 g_free (info->producer);
607 g_free (info->linearized);
608 g_free (info->security);
609 ev_document_license_free (info->license);
614 /* EvDocumentLicense */
615 EV_DEFINE_BOXED_TYPE (EvDocumentLicense, ev_document_license, ev_document_license_copy, ev_document_license_free)
618 ev_document_license_new (void)
620 return g_new0 (EvDocumentLicense, 1);
624 ev_document_license_copy (EvDocumentLicense *license)
626 EvDocumentLicense *new_license;
631 new_license = ev_document_license_new ();
634 new_license->text = g_strdup (license->text);
636 new_license->uri = g_strdup (license->uri);
637 if (license->web_statement)
638 new_license->web_statement = g_strdup (license->web_statement);
644 ev_document_license_free (EvDocumentLicense *license)
649 g_free (license->text);
650 g_free (license->uri);
651 g_free (license->web_statement);
657 ev_document_license_get_text (EvDocumentLicense *license)
659 return license->text;
663 ev_document_license_get_uri (EvDocumentLicense *license)
669 ev_document_license_get_web_statement (EvDocumentLicense *license)
671 return license->web_statement;
675 EV_DEFINE_BOXED_TYPE (EvRectangle, ev_rectangle, ev_rectangle_copy, ev_rectangle_free)
678 ev_rectangle_new (void)
680 return g_new0 (EvRectangle, 1);
684 ev_rectangle_copy (EvRectangle *rectangle)
686 EvRectangle *new_rectangle;
688 g_return_val_if_fail (rectangle != NULL, NULL);
690 new_rectangle = g_new (EvRectangle, 1);
691 *new_rectangle = *rectangle;
693 return new_rectangle;
697 ev_rectangle_free (EvRectangle *rectangle)
702 /* Compares two rects. returns 0 if they're equal */
703 #define EPSILON 0.0000001
706 ev_rect_cmp (EvRectangle *a,
711 if (a == NULL || b == NULL)
714 return ! ((ABS (a->x1 - b->x1) < EPSILON) &&
715 (ABS (a->y1 - b->y1) < EPSILON) &&
716 (ABS (a->x2 - b->x2) < EPSILON) &&
717 (ABS (a->y2 - b->y2) < EPSILON));