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.
22 #include <libdjvu/miniexp.h>
24 #include "djvu-document-private.h"
25 #include "djvu-document.h"
26 #include "djvu-text.h"
27 #include "djvu-text-page.h"
28 #include "ev-document-find.h"
29 #include "ev-document.h"
34 DjvuDocument *document;
35 gboolean case_sensitive;
44 * djvu_text_idle_callback:
45 * @data: #DjvuText instance
47 * Idle callback that processes one page at a time.
49 * Returns: whether there are more pages to be processed
52 djvu_text_idle_callback (void *data)
54 DjvuText *djvu_text = (DjvuText *) data;
55 DjvuDocument *djvu_document = djvu_text->document;
59 ev_document_doc_mutex_lock ();
61 ddjvu_document_get_pagetext (djvu_document->d_document,
62 djvu_text->search_page,
63 "char")) == miniexp_dummy)
64 djvu_handle_events (djvu_document, TRUE);
66 if (page_text != miniexp_nil) {
67 DjvuTextPage *page = djvu_text_page_new (page_text);
68 djvu_text_page_prepare_search (page, djvu_text->case_sensitive);
69 if (page->links->len > 0) {
70 djvu_text_page_search (page, djvu_text->text);
71 djvu_text->pages[djvu_text->search_page] = page->results;
72 ev_document_find_changed (EV_DOCUMENT_FIND
74 djvu_text->search_page);
76 djvu_text_page_free (page);
77 ddjvu_miniexp_release (djvu_document->d_document,
80 ev_document_doc_mutex_unlock ();
83 djvu_document_get_n_pages (EV_DOCUMENT (djvu_text->document));
84 djvu_text->search_page += 1;
85 if (djvu_text->search_page == n_pages) {
87 djvu_text->search_page = 0;
90 if (djvu_text->search_page != djvu_text->start_page)
95 /* will return FALSE to remove */
101 * @djvu_document: document to search
102 * @start_page: first page to search
103 * @case_sensitive: uses g_utf8_case_fold() to enable case-insensitive
105 * @text: text to search
107 * Creates a new #DjvuText instance to enable searching. An idle call
108 * is used to process all pages starting from @start_page.
110 * Returns: newly created instance
113 djvu_text_new (DjvuDocument *djvu_document,
115 gboolean case_sensitive,
122 n_pages = djvu_document_get_n_pages (EV_DOCUMENT (djvu_document));
124 djvu_text = g_new0 (DjvuText, 1);
127 djvu_text->text = g_strdup (text);
129 djvu_text->text = g_utf8_casefold (text, -1);
130 djvu_text->pages = g_new0 (GList *, n_pages);
131 for (i = 0; i < n_pages; i++) {
132 djvu_text->pages[i] = NULL;
135 djvu_text->document = djvu_document;
137 /* We add at low priority so the progress bar repaints */
138 djvu_text->idle = g_idle_add_full (G_PRIORITY_LOW,
139 djvu_text_idle_callback,
142 djvu_text->case_sensitive = case_sensitive;
143 djvu_text->start_page = start_page;
144 djvu_text->search_page = start_page;
151 * @djvu_document: document to search
152 * @page: page to search
153 * @rectangle: rectangle to copy
155 * Copies and returns the text in the given rectangle.
157 * Returns: newly allocated text or NULL of none is available
160 djvu_text_copy (DjvuDocument *djvu_document,
162 EvRectangle *rectangle)
168 ddjvu_document_get_pagetext (djvu_document->d_document,
169 page, "char")) == miniexp_dummy)
170 djvu_handle_events (djvu_document, TRUE);
172 if (page_text != miniexp_nil) {
173 DjvuTextPage *page = djvu_text_page_new (page_text);
174 text = djvu_text_page_copy (page, rectangle);
175 djvu_text_page_free (page);
176 ddjvu_miniexp_release (djvu_document->d_document, page_text);
184 * @djvu_text: instance to free
186 * Frees the given #DjvuText instance.
188 void djvu_text_free (DjvuText * djvu_text)
190 DjvuDocument *djvu_document = djvu_text->document;
194 if (djvu_text->idle != 0)
195 g_source_remove (djvu_text->idle);
197 n_pages = djvu_document_get_n_pages (EV_DOCUMENT (djvu_document));
198 for (i = 0; i < n_pages; i++) {
199 g_list_foreach (djvu_text->pages[i], (GFunc) g_free, NULL);
200 g_list_free (djvu_text->pages[i]);
203 g_free (djvu_text->text);
207 * djvu_text_get_text:
208 * @djvu_text: #DjvuText instance
210 * Returns the search text. This is mainly to be able to avoid reinstantiation
211 * for the same search text.
213 * Returns: the text this instance of #DjvuText is looking for
216 djvu_text_get_text (DjvuText *djvu_text)
218 return djvu_text->text;
222 * djvu_text_n_results:
223 * @djvu_text: #DjvuText instance
226 * Returns the number of search results available for the given page.
228 * Returns: number of search results
231 djvu_text_n_results (DjvuText *djvu_text,
234 return g_list_length (djvu_text->pages[page]);
238 * djvu_text_has_results:
239 * @djvu_text: #DjvuText instance
242 * Returns whether there are search results available for the given page.
243 * This method executes faster than djvu_text_n_results().
245 * Returns: whether there are search results
248 djvu_text_has_results (DjvuText *djvu_text,
251 return djvu_text->pages[page] != NULL;
255 * djvu_text_get_result:
256 * @djvu_text: #DjvuText instance
258 * @n_result: result number
260 * Returns the n-th search result of a given page. The coordinates are
261 * Djvu-specific and need to be processed to be compatible with the Evince
262 * coordinate system. The result may span several lines!
264 * Returns: the rectangle for the search result
267 djvu_text_get_result (DjvuText *djvu_text,
271 return (EvRectangle *) g_list_nth_data (djvu_text->pages[page],
276 * djvu_text_get_progress:
277 * @djvu_text: #DjvuText instance
279 * Returns the percentage of pages done searching.
281 * Returns: the progress as value between 0 and 1
284 djvu_text_get_progress (DjvuText *djvu_text)
290 djvu_document_get_n_pages (EV_DOCUMENT (djvu_text->document));
291 if (djvu_text->search_page > djvu_text->start_page) {
292 pages_done = djvu_text->search_page - djvu_text->start_page + 1;
293 } else if (djvu_text->search_page == djvu_text->start_page) {
294 pages_done = n_pages;
297 n_pages - djvu_text->start_page + djvu_text->search_page;
299 return pages_done / (double) n_pages;