blob: f94bcdb427211728344d05c04cb1fc9beaebe749 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*
* Copyright 2009 Mark Benjamin <netsurf-browser.org.MarkBenjamin@dfgh.net>
*
* This file is part of NetSurf, http://www.netsurf-browser.org/
*
* NetSurf is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* NetSurf is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file
* Interface to HTML searching.
*/
#ifndef NETSURF_CONTENT_SEARCH_H
#define NETSURF_CONTENT_SEARCH_H
#include <ctype.h>
#include <string.h>
#include "desktop/search.h"
struct textsearch_context;
struct content;
/**
* create a search_context
*
* \param c The content the search_context is connected to
* \param context A context pointer passed to the provider routines.
* \param search_out A pointer to recive the new text search context
* \return NSERROR_OK on success and \a search_out updated else error code
*/
nserror content_textsearch_create(struct content *c, void *context, struct textsearch_context **textsearch_out);
/**
* Begins/continues the search process
*
* \note that this may be called many times for a single search.
*
* \param context The search context in use.
* \param flags The flags forward/back etc
* \param string The string to match
*/
nserror content_textsearch_step(struct textsearch_context *textsearch, search_flags_t flags, const char *string);
/**
* Ends the search process, invalidating all state freeing the list of
* found boxes.
*/
nserror content_textsearch_destroy(struct textsearch_context *textsearch);
/**
* Determines whether any portion of the given text box should be
* selected because it matches the current search string.
*
* \param textsearch The search context to hilight entries from.
* \param c The content to highlight within.
* \param start_offset byte offset within text of string to be checked
* \param end_offset byte offset within text
* \param start_idx byte offset within string of highlight start
* \param end_idx byte offset of highlight end
* \return true iff part of the box should be highlighted
*/
bool content_textsearch_ishighlighted(struct textsearch_context *textsearch,
unsigned start_offset,
unsigned end_offset,
unsigned *start_idx,
unsigned *end_idx);
#endif
|
