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
  33 G_BEGIN_DECLS
  34
  35 typedef struct _GCompletion     GCompletion;
  36
  37 typedef gchar*          (*GCompletionFunc)      (gpointer);
  38
  39 /* GCompletion
  40  */
  41
  42 typedef gint (*GCompletionStrncmpFunc) (const gchar *s1,
  43                                         const gchar *s2,
  44                                         size_t       n);
  45
  46 struct _GCompletion
  47 {
  48   GList* items;
  49   GCompletionFunc func;
  50
  51   gchar* prefix;
  52   GList* cache;
  53   GCompletionStrncmpFunc strncmp_func;
  54 };
  55
  56 GCompletion* g_completion_new          (GCompletionFunc func);
  57 void         g_completion_add_items    (GCompletion*    cmp,
  58                                         GList*          items);
  59 void         g_completion_remove_items (GCompletion*    cmp,
  60                                         GList*          items);
  61 void         g_completion_clear_items  (GCompletion*    cmp);
  62 GList*       g_completion_complete     (GCompletion*    cmp,
  63                                         gchar*          prefix,
  64                                         gchar**         new_prefix);
  65 void         g_completion_set_compare (GCompletion *cmp,
  66                                        GCompletionStrncmpFunc strncmp_func);
  67 void         g_completion_free         (GCompletion*    cmp);
  68
  69 G_END_DECLS
  70
  71 #endif /* __G_COMPLETION_H__ */
  72