glib/gcompletion.h

/* GLIB - Library of useful routines for C programming
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library 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 of the License, or (at your option) any later version.
 *
 * This library 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 Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GLib Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GLib at ftp://ftp.gtk.org/pub/gtk/. 
 */

#ifndef __G_COMPLETION_H__
#define __G_COMPLETION_H__

#include <glist.h>
#include <stddef.h>		/* For size_t */

G_BEGIN_DECLS

typedef struct _GCompletion     GCompletion;

typedef gchar*          (*GCompletionFunc)      (gpointer);

/* GCompletion
 */

typedef gint (*GCompletionStrncmpFunc) (const gchar *s1,
					const gchar *s2,
					size_t       n);

struct _GCompletion
{
  GList* items;
  GCompletionFunc func;
 
  gchar* prefix;
  GList* cache;
  GCompletionStrncmpFunc strncmp_func;
};

GCompletion* g_completion_new          (GCompletionFunc func);
void         g_completion_add_items    (GCompletion*    cmp,
                                        GList*          items);
void         g_completion_remove_items (GCompletion*    cmp,
                                        GList*          items);
void         g_completion_clear_items  (GCompletion*    cmp);
GList*       g_completion_complete     (GCompletion*    cmp,
                                        gchar*          prefix,
                                        gchar**         new_prefix);
void         g_completion_set_compare (GCompletion *cmp,
				       GCompletionStrncmpFunc strncmp_func);
void         g_completion_free         (GCompletion*    cmp);

G_END_DECLS

#endif /* __G_COMPLETION_H__ */