lib.h File Reference

Fuzzy matching library. More...

#include <stdbool.h>

Include dependency graph for lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	FuzzyOptions
	Options for fuzzy matching. More...
struct	FuzzyResult
	Result of a fuzzy match. More...

Enumerations
enum	FuzzyAlgo { FUZZY_ALGO_SUBSEQ = 0 }
	Fuzzy matching algorithm types. More...

Functions
void	fuzzy_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Fuzzy Keybindings - Implements ::init_keys_api.
struct SubMenu *	fuzzy_get_submenu (void)
	Get the Fuzzy SubMenu.
int	fuzzy_match (const char *pattern, const char *candidate, enum FuzzyAlgo algo, const struct FuzzyOptions *opts, struct FuzzyResult *out)
	Perform fuzzy matching.

Detailed Description

Fuzzy matching library.

Authors

• Richard Russon

Copyright

This program 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, either version 2 of the License, or (at your option) any later version.

This program 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/.

Definition in file lib.h.

Enumeration Type Documentation

FuzzyAlgo

enum FuzzyAlgo

Fuzzy matching algorithm types.

Enumerator
FUZZY_ALGO_SUBSEQ	Subsequence matching algorithm.

Definition at line 80 of file lib.h.

{
  FUZZY_ALGO_SUBSEQ = 0, 
  // extensible
  // FUZZY_ALGO_EDIT,
  // FUZZY_ALGO_TOKEN,
};

Function Documentation

fuzzy_init_keys()

void fuzzy_init_keys	(	struct NeoMutt *	n,
		struct SubMenu *	sm_generic )

Initialise the Fuzzy Keybindings - Implements ::init_keys_api.

Definition at line 70 of file functions.c.

{
  struct FuzzyModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_FUZZY);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
 
  sm = km_register_submenu(OpFuzzy);
  md = km_register_menu(MENU_FUZZY, "fuzzy");
  km_menu_add_submenu(md, sm);
  km_menu_add_bindings(md, FuzzyDefaultBindings);
 
  mod_data->md_fuzzy = md;
  mod_data->sm_fuzzy = sm;
}

Here is the call graph for this function:

Here is the caller graph for this function:

fuzzy_get_submenu()

struct SubMenu * fuzzy_get_submenu

(

void

)

Get the Fuzzy SubMenu.

Return values

ptr	Fuzzy SubMenu

Definition at line 91 of file functions.c.

{
  struct FuzzyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_FUZZY);
  ASSERT(mod_data);
 
  return mod_data->sm_fuzzy;
}

Here is the call graph for this function:

Here is the caller graph for this function:

fuzzy_match()

int fuzzy_match	(	const char *	pattern,
		const char *	candidate,
		enum FuzzyAlgo	algo,
		const struct FuzzyOptions *	opts,
		struct FuzzyResult *	out )

Perform fuzzy matching.

Parameters

pattern	Pattern to match
candidate	Candidate string to match against
algo	Fuzzy matching algorithm to use
opts	Fuzzy matching options
out	Output result structure

Return values

>=0	Match score
-1	Error or no match

Definition at line 58 of file fuzzy.c.

{
  if (!pattern || !candidate)
    return -1;
 
  if (algo == FUZZY_ALGO_SUBSEQ)
    return fuzzy_subseq_match(pattern, candidate, opts, out);
 
  return -1;
}

Here is the call graph for this function:

Here is the caller graph for this function: