Search

Data Structures
struct	lws_fts_result_filepath
struct	lws_fts_result_autocomplete
struct	lws_fts_result
struct	lws_fts_search_params

Macros
#define	LWSFTS_F_QUERY_AUTOCOMPLETE   (1 << 0)
#define	LWSFTS_F_QUERY_FILES   (1 << 1)
#define	LWSFTS_F_QUERY_FILE_LINES   (1 << 2)
#define	LWSFTS_F_QUERY_QUOTE_LINE   (1 << 3)

Functions
LWS_VISIBLE LWS_EXTERN struct lws_fts *	lws_fts_create (int fd)
LWS_VISIBLE LWS_EXTERN void	lws_fts_destroy (struct lws_fts **trie)
LWS_VISIBLE LWS_EXTERN int	lws_fts_file_index (struct lws_fts *t, const char *filepath, int filepath_len, int priority)
LWS_VISIBLE LWS_EXTERN int	lws_fts_fill (struct lws_fts *t, uint32_t file_index, const char *buf, size_t len)
LWS_VISIBLE LWS_EXTERN int	lws_fts_serialize (struct lws_fts *t)
LWS_VISIBLE LWS_EXTERN struct lws_fts_file *	lws_fts_open (const char *filepath)
LWS_VISIBLE LWS_EXTERN struct lws_fts_result *	lws_fts_search (struct lws_fts_file *jtf, struct lws_fts_search_params *ftsp)
LWS_VISIBLE LWS_EXTERN void	lws_fts_close (struct lws_fts_file *jtf)

Detailed Description

Full-text search

Lws provides superfast indexing and fulltext searching from index files on storage.

---

Data Structure Documentation

lws_fts_result_filepath

struct lws_fts_result_filepath

Definition at line 45 of file lws-fts.h.

Collaboration diagram for lws_fts_result_filepath:

Data Fields
struct lws_fts_result_filepath *	next
int	matches
int	matches_length
int	lines_in_file
int	filepath_length

lws_fts_result_autocomplete

struct lws_fts_result_autocomplete

Definition at line 58 of file lws-fts.h.

Collaboration diagram for lws_fts_result_autocomplete:

Data Fields
struct lws_fts_result_autocomplete *	next
int	instances
int	agg_instances
int	ac_length
char	elided
char	has_children

lws_fts_result

struct lws_fts_result

Definition at line 74 of file lws-fts.h.

Collaboration diagram for lws_fts_result:

Data Fields
struct lws_fts_result_filepath *	filepath_head
struct lws_fts_result_autocomplete *	autocomplete_head
int	duration_ms
int	effective_flags

lws_fts_search_params

struct lws_fts_search_params

Definition at line 166 of file lws-fts.h.

Collaboration diagram for lws_fts_search_params:

Data Fields
const char *	needle
const char *	only_filepath
struct lwsac *	results_head
int	flags
int	max_autocomplete
int	max_files
int	max_lines

Macro Definition Documentation

LWSFTS_F_QUERY_AUTOCOMPLETE

#define LWSFTS_F_QUERY_AUTOCOMPLETE   (1 << 0)

#include <include/libwebsockets/lws-fts.h>

Definition at line 161 of file lws-fts.h.

LWSFTS_F_QUERY_FILES

#define LWSFTS_F_QUERY_FILES   (1 << 1)

#include <include/libwebsockets/lws-fts.h>

Definition at line 162 of file lws-fts.h.

LWSFTS_F_QUERY_FILE_LINES

#define LWSFTS_F_QUERY_FILE_LINES   (1 << 2)

#include <include/libwebsockets/lws-fts.h>

Definition at line 163 of file lws-fts.h.

LWSFTS_F_QUERY_QUOTE_LINE

#define LWSFTS_F_QUERY_QUOTE_LINE   (1 << 3)

#include <include/libwebsockets/lws-fts.h>

Definition at line 164 of file lws-fts.h.

Function Documentation

lws_fts_create()

LWS_VISIBLE LWS_EXTERN struct lws_fts* lws_fts_create

(

int

fd

)

#include <include/libwebsockets/lws-fts.h>

lws_fts_create() - Create a new index file

Parameters

fd	The fd opened for write

Inits a new index file, returning a struct lws_fts to represent it

lws_fts_destroy()

LWS_VISIBLE LWS_EXTERN void lws_fts_destroy

(

struct lws_fts **

trie

)

#include <include/libwebsockets/lws-fts.h>

lws_fts_destroy() - Finalize a new index file / destroy the trie lwsac

Parameters

trie	The previously opened index being finalized

Finalizes an index file that was being created, and frees the memory involved *trie is set to NULL afterwards.

lws_fts_file_index()

LWS_VISIBLE LWS_EXTERN int lws_fts_file_index	(	struct lws_fts *	t,
		const char *	filepath,
		int	filepath_len,
		int	priority
	)

#include <include/libwebsockets/lws-fts.h>

lws_fts_file_index() - Create a new entry in the trie file for an input path

Parameters

t	The previously opened index being written
filepath	The filepath (which may be virtual) associated with this file
filepath_len	The number of chars in the filepath
priority	not used yet

Returns an ordinal that represents this new filepath in the index file.

lws_fts_fill()

LWS_VISIBLE LWS_EXTERN int lws_fts_fill	(	struct lws_fts *	t,
		uint32_t	file_index,
		const char *	buf,
		size_t	len
	)

#include <include/libwebsockets/lws-fts.h>

lws_fts_fill() - Process all or a bufferload of input file

Parameters

t	The previously opened index being written
file_index	The ordinal representing this input filepath
buf	A bufferload of data from the input file
len	The number of bytes in buf

Indexes a buffer of data from the input file.

lws_fts_serialize()

LWS_VISIBLE LWS_EXTERN int lws_fts_serialize

(

struct lws_fts *

t

)

#include <include/libwebsockets/lws-fts.h>

lws_fts_serialize() - Store the in-memory trie into the index file

Parameters

t	The previously opened index being written

The trie is held in memory where it can be added to... after all the input filepaths and data have been processed, this is called to serialize / write the trie data into the index file.

lws_fts_open()

LWS_VISIBLE LWS_EXTERN struct lws_fts_file* lws_fts_open

(

const char *

filepath

)

#include <include/libwebsockets/lws-fts.h>

lws_fts_open() - Open an existing index file to search it

Parameters

filepath

The filepath to the index file to open

Opening the index file returns an opaque struct lws_fts_file * that is used to perform other operations on it, or NULL if it can't be opened.

lws_fts_search()

LWS_VISIBLE LWS_EXTERN struct lws_fts_result* lws_fts_search	(	struct lws_fts_file *	jtf,
		struct lws_fts_search_params *	ftsp
	)

#include <include/libwebsockets/lws-fts.h>

lws_fts_search() - Perform a search operation on an index

Parameters

jtf	The index file struct returned by lws_fts_open
ftsp	The struct lws_fts_search_params filled in by the caller

The caller should memset the ftsp struct to 0 to ensure members that may be introduced in later versions contain known values, then set the related members to describe the kind of search action required.

ftsp->results_head is the results lwsac, or NULL. It should be freed with lwsac_free() when the results are finished with.

Returns a pointer into the results lwsac that is a struct lws_fts_result containing the head pointers into linked-lists of results for autocomplete and filepath data, along with some sundry information. This does not need to be freed since freeing the lwsac will also remove this and everything it points to.

lws_fts_close()

LWS_VISIBLE LWS_EXTERN void lws_fts_close

(

struct lws_fts_file *

jtf

)

#include <include/libwebsockets/lws-fts.h>

lws_fts_close() - Close a previously-opened index file

Parameters

jtf	The pointer returned from the open

Closes the file handle on the index and frees any allocations