QuickFill.h

Go to the documentation of this file.

/********************************************************************\
 * QuickFill.h -- the quickfill tree data structure                 *
 *                                                                  *
 * 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, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/
#ifndef QUICKFILL_H
#define QUICKFILL_H

#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    QUICKFILL_LIFO,
    QUICKFILL_ALPHA
} QuickFillSort;

typedef struct _QuickFill QuickFill;


/* PROTOTYPES ******************************************************/

QuickFill *  gnc_quickfill_new (void);
void         gnc_quickfill_destroy (QuickFill *qf);
void         gnc_quickfill_purge (QuickFill *qf);

const char * gnc_quickfill_string (QuickFill *qf);

QuickFill *  gnc_quickfill_get_char_match (QuickFill *qf, gunichar c);

QuickFill *  gnc_quickfill_get_string_match (QuickFill *qf,
        const char *str);

QuickFill *  gnc_quickfill_get_string_len_match (QuickFill *qf,
        const char *str, int len);

QuickFill *  gnc_quickfill_get_unique_len_match (QuickFill *qf, int *len);

void         gnc_quickfill_insert (QuickFill *root, const char *text,
                                   QuickFillSort sort_code);

void         gnc_quickfill_remove (QuickFill *root, const gchar *text,
                                   QuickFillSort sort_code);

#ifdef __cplusplus
}
#endif

#endif /* QUICKFILL_H */