iridium-c/src/fuzzy.h

/* fuzzy.h
 *
 * Copyright (C) 2013 Christian Hergert <christian@hergert.me>
 *
 * This file is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at
 * your option) any later version.
 * 
 * This file 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 Lesser 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/>.
 */

#ifndef FUZZY_H
#define FUZZY_H

#include <glib.h>

G_BEGIN_DECLS

typedef struct _Fuzzy      Fuzzy;
typedef struct _FuzzyMatch FuzzyMatch;

struct _FuzzyMatch
{
   const gchar *key;
   gpointer     value;
   gfloat       score;
};

Fuzzy     *fuzzy_new                (gboolean        case_sensitive);
Fuzzy     *fuzzy_new_with_free_func (gboolean        case_sensitive,
                                     GDestroyNotify  free_func);
void       fuzzy_set_free_func      (Fuzzy          *fuzzy,
                                     GDestroyNotify  free_func);
void       fuzzy_begin_bulk_insert  (Fuzzy          *fuzzy);
void       fuzzy_end_bulk_insert    (Fuzzy          *fuzzy);
void       fuzzy_insert             (Fuzzy          *fuzzy,
                                     const gchar    *key,
                                     gpointer        value);
GArray    *fuzzy_match              (Fuzzy          *fuzzy,
                                     const gchar    *needle,
                                     gsize           max_matches);
void       fuzzy_free               (Fuzzy          *fuzzy);

G_END_DECLS

#endif /* FUZZY_H */