glib/gcompletion.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_COMPLETION_H__
  28 #define __G_COMPLETION_H__
  29
  30 #include <glist.h>
  31 #include <stddef.h>             /* For size_t */
  32 #ifdef G_OS_UNIX
  33 #include <unistd.h>
  34 #endif
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GCompletion     GCompletion;
  39
  40 typedef gchar*          (*GCompletionFunc)      (gpointer);
  41
  42 /* GCompletion
  43  */
  44
  45 typedef int (*GCompletionStrncmpFunc)(const char *s1, const char *s2, size_t n);
  46
  47 struct _GCompletion
  48 {
  49   GList* items;
  50   GCompletionFunc func;
  51
  52   gchar* prefix;
  53   GList* cache;
  54   GCompletionStrncmpFunc strncmp_func;
  55 };
  56
  57 GCompletion* g_completion_new          (GCompletionFunc func);
  58 void         g_completion_add_items    (GCompletion*    cmp,
  59                                         GList*          items);
  60 void         g_completion_remove_items (GCompletion*    cmp,
  61                                         GList*          items);
  62 void         g_completion_clear_items  (GCompletion*    cmp);
  63 GList*       g_completion_complete     (GCompletion*    cmp,
  64                                         gchar*          prefix,
  65                                         gchar**         new_prefix);
  66 void         g_completion_set_compare (GCompletion *cmp,
  67                                        GCompletionStrncmpFunc strncmp_func);
  68 void         g_completion_free         (GCompletion*    cmp);
  69
  70 G_END_DECLS
  71
  72 #endif /* __G_COMPLETION_H__ */
  73