2 * Implements search and copy functionality for Djvu files.
3 * Copyright (C) 2006 Michael Hofmann <mh21@piware.de>
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.
23 #include <libdjvu/miniexp.h>
25 #include "djvu-document-private.h"
26 #include "djvu-document.h"
27 #include "djvu-text.h"
28 #include "djvu-text-page.h"
29 #include "ev-document-find.h"
30 #include "ev-document.h"
35 DjvuDocument *document;
36 gboolean case_sensitive;
45 * djvu_text_idle_callback:
46 * @data: #DjvuText instance
48 * Idle callback that processes one page at a time.
50 * Returns: whether there are more pages to be processed
53 djvu_text_idle_callback (void *data)
55 DjvuText *djvu_text = (DjvuText *) data;
56 DjvuDocument *djvu_document = djvu_text->document;
60 ev_document_doc_mutex_lock ();
62 ddjvu_document_get_pagetext (djvu_document->d_document,
63 djvu_text->search_page,
64 "char")) == miniexp_dummy)
65 djvu_handle_events (djvu_document, TRUE);
67 if (page_text != miniexp_nil) {
68 DjvuTextPage *page = djvu_text_page_new (page_text);
69 djvu_text_page_prepare_search (page, djvu_text->case_sensitive);
70 if (page->links->len > 0) {
71 djvu_text_page_search (page, djvu_text->text);
72 djvu_text->pages[djvu_text->search_page] = page->results;
73 ev_document_find_changed (EV_DOCUMENT_FIND
75 djvu_text->search_page);
77 djvu_text_page_free (page);
78 ddjvu_miniexp_release (djvu_document->d_document,
81 ev_document_doc_mutex_unlock ();
84 djvu_document_get_n_pages (EV_DOCUMENT (djvu_text->document));
85 djvu_text->search_page += 1;
86 if (djvu_text->search_page == n_pages) {
88 djvu_text->search_page = 0;
91 if (djvu_text->search_page != djvu_text->start_page)
96 /* will return FALSE to remove */
102 * @djvu_document: document to search
103 * @start_page: first page to search
104 * @case_sensitive: uses g_utf8_case_fold() to enable case-insensitive
106 * @text: text to search
108 * Creates a new #DjvuText instance to enable searching. An idle call
109 * is used to process all pages starting from @start_page.
111 * Returns: newly created instance
114 djvu_text_new (DjvuDocument *djvu_document,
116 gboolean case_sensitive,
123 n_pages = djvu_document_get_n_pages (EV_DOCUMENT (djvu_document));
125 djvu_text = g_new0 (DjvuText, 1);
128 djvu_text->text = g_strdup (text);
130 djvu_text->text = g_utf8_casefold (text, -1);
131 djvu_text->pages = g_new0 (GList *, n_pages);
132 for (i = 0; i < n_pages; i++) {
133 djvu_text->pages[i] = NULL;
136 djvu_text->document = djvu_document;
138 /* We add at low priority so the progress bar repaints */
139 djvu_text->idle = g_idle_add_full (G_PRIORITY_LOW,
140 djvu_text_idle_callback,
143 djvu_text->case_sensitive = case_sensitive;
144 djvu_text->start_page = start_page;
145 djvu_text->search_page = start_page;
152 * @djvu_document: document to search
153 * @page: page to search
154 * @rectangle: rectangle to copy
156 * Copies and returns the text in the given rectangle.
158 * Returns: newly allocated text or NULL of none is available
161 djvu_text_copy (DjvuDocument *djvu_document,
163 EvRectangle *rectangle)
169 ddjvu_document_get_pagetext (djvu_document->d_document,
170 page, "char")) == miniexp_dummy)
171 djvu_handle_events (djvu_document, TRUE);
173 if (page_text != miniexp_nil) {
174 DjvuTextPage *page = djvu_text_page_new (page_text);
175 text = djvu_text_page_copy (page, rectangle);
176 djvu_text_page_free (page);
177 ddjvu_miniexp_release (djvu_document->d_document, page_text);
185 * @djvu_text: instance to free
187 * Frees the given #DjvuText instance.
189 void djvu_text_free (DjvuText * djvu_text)
191 DjvuDocument *djvu_document = djvu_text->document;
195 if (djvu_text->idle != 0)
196 g_source_remove (djvu_text->idle);
198 n_pages = djvu_document_get_n_pages (EV_DOCUMENT (djvu_document));
199 for (i = 0; i < n_pages; i++) {
200 g_list_foreach (djvu_text->pages[i], (GFunc) g_free, NULL);
201 g_list_free (djvu_text->pages[i]);
204 g_free (djvu_text->text);
208 * djvu_text_get_text:
209 * @djvu_text: #DjvuText instance
211 * Returns the search text. This is mainly to be able to avoid reinstantiation
212 * for the same search text.
214 * Returns: the text this instance of #DjvuText is looking for
217 djvu_text_get_text (DjvuText *djvu_text)
219 return djvu_text->text;
223 * djvu_text_n_results:
224 * @djvu_text: #DjvuText instance
227 * Returns the number of search results available for the given page.
229 * Returns: number of search results
232 djvu_text_n_results (DjvuText *djvu_text,
235 return g_list_length (djvu_text->pages[page]);
239 * djvu_text_has_results:
240 * @djvu_text: #DjvuText instance
243 * Returns whether there are search results available for the given page.
244 * This method executes faster than djvu_text_n_results().
246 * Returns: whether there are search results
249 djvu_text_has_results (DjvuText *djvu_text,
252 return djvu_text->pages[page] != NULL;
256 * djvu_text_get_result:
257 * @djvu_text: #DjvuText instance
259 * @n_result: result number
261 * Returns the n-th search result of a given page. The coordinates are
262 * Djvu-specific and need to be processed to be compatible with the Evince
263 * coordinate system. The result may span several lines!
265 * Returns: the rectangle for the search result
268 djvu_text_get_result (DjvuText *djvu_text,
272 return (EvRectangle *) g_list_nth_data (djvu_text->pages[page],
277 * djvu_text_get_progress:
278 * @djvu_text: #DjvuText instance
280 * Returns the percentage of pages done searching.
282 * Returns: the progress as value between 0 and 1
285 djvu_text_get_progress (DjvuText *djvu_text)
291 djvu_document_get_n_pages (EV_DOCUMENT (djvu_text->document));
292 if (djvu_text->search_page > djvu_text->start_page) {
293 pages_done = djvu_text->search_page - djvu_text->start_page + 1;
294 } else if (djvu_text->search_page == djvu_text->start_page) {
295 pages_done = n_pages;
298 n_pages - djvu_text->start_page + djvu_text->search_page;
300 return pages_done / (double) n_pages;