pcomplete.h

   1 /* pcomplete.h - structure definitions and other stuff for programmable
   2                  completion. */
   3
   4 /* Copyright (C) 1999 Free Software Foundation, Inc.
   5
   6    This file is part of GNU Bash, the Bourne Again SHell.
   7
   8    Bash is free software; you can redistribute it and/or modify it under
   9    the terms of the GNU General Public License as published by the Free
  10    Software Foundation; either version 2, or (at your option) any later
  11    version.
  12
  13    Bash is distributed in the hope that it will be useful, but WITHOUT ANY
  14    WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16    for more details.
  17
  18    You should have received a copy of the GNU General Public License along
  19    with Bash; see the file COPYING.  If not, write to the Free Software
  20    Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
  21
  22 #if !defined (_PCOMPLETE_H_)
  23 #  define _PCOMPLETE_H_
  24
  25 #include "stdc.h"
  26 #include "hashlib.h"
  27
  28 typedef struct compspec {
  29   int refcount;
  30   unsigned long actions;
  31   unsigned long options;
  32   char *globpat;
  33   char *words;
  34   char *prefix;
  35   char *suffix;
  36   char *funcname;
  37   char *command;
  38   char *filterpat;
  39 } COMPSPEC;
  40
  41 /* Values for COMPSPEC actions.  These are things the shell knows how to
  42    build internally. */
  43 #define CA_ALIAS        (1<<0)
  44 #define CA_ARRAYVAR     (1<<1)
  45 #define CA_BINDING      (1<<2)
  46 #define CA_BUILTIN      (1<<3)
  47 #define CA_COMMAND      (1<<4)
  48 #define CA_DIRECTORY    (1<<5)
  49 #define CA_DISABLED     (1<<6)
  50 #define CA_ENABLED      (1<<7)
  51 #define CA_EXPORT       (1<<8)
  52 #define CA_FILE         (1<<9)
  53 #define CA_FUNCTION     (1<<10)
  54 #define CA_GROUP        (1<<11)
  55 #define CA_HELPTOPIC    (1<<12)
  56 #define CA_HOSTNAME     (1<<13)
  57 #define CA_JOB          (1<<14)
  58 #define CA_KEYWORD      (1<<15)
  59 #define CA_RUNNING      (1<<16)
  60 #define CA_SETOPT       (1<<17)
  61 #define CA_SHOPT        (1<<18)
  62 #define CA_SIGNAL       (1<<19)
  63 #define CA_STOPPED      (1<<20)
  64 #define CA_USER         (1<<21)
  65 #define CA_VARIABLE     (1<<22)
  66
  67 /* Values for COMPSPEC options field. */
  68 #define COPT_RESERVED   (1<<0)          /* reserved for other use */
  69 #define COPT_DEFAULT    (1<<1)
  70 #define COPT_FILENAMES  (1<<2)
  71 #define COPT_DIRNAMES   (1<<3)
  72
  73 /* List of items is used by the code that implements the programmable
  74    completions. */
  75 typedef struct _list_of_items {
  76   int flags;
  77   int (*list_getter) __P((struct _list_of_items *));    /* function to call to get the list */
  78
  79   STRINGLIST *slist;
  80
  81   /* These may or may not be used. */
  82   STRINGLIST *genlist;  /* for handing to the completion code one item at a time */
  83   int genindex;         /* index of item last handed to completion code */
  84
  85 } ITEMLIST;
  86
  87 /* Values for ITEMLIST -> flags */
  88 #define LIST_DYNAMIC            0x001
  89 #define LIST_DIRTY              0x002
  90 #define LIST_INITIALIZED        0x004
  91 #define LIST_MUSTSORT           0x008
  92 #define LIST_DONTFREE           0x010
  93 #define LIST_DONTFREEMEMBERS    0x020
  94
  95 extern HASH_TABLE *prog_completes;
  96 extern int prog_completion_enabled;
  97
  98 /* Not all of these are used yet. */
  99 extern ITEMLIST it_aliases;
 100 extern ITEMLIST it_arrayvars;
 101 extern ITEMLIST it_bindings;
 102 extern ITEMLIST it_builtins;
 103 extern ITEMLIST it_commands;
 104 extern ITEMLIST it_directories;
 105 extern ITEMLIST it_disabled;
 106 extern ITEMLIST it_enabled;
 107 extern ITEMLIST it_exports;
 108 extern ITEMLIST it_files;
 109 extern ITEMLIST it_functions;
 110 extern ITEMLIST it_groups;
 111 extern ITEMLIST it_hostnames;
 112 extern ITEMLIST it_jobs;
 113 extern ITEMLIST it_keywords;
 114 extern ITEMLIST it_running;
 115 extern ITEMLIST it_setopts;
 116 extern ITEMLIST it_shopts;
 117 extern ITEMLIST it_signals;
 118 extern ITEMLIST it_stopped;
 119 extern ITEMLIST it_users;
 120 extern ITEMLIST it_variables;
 121
 122 /* Functions from pcomplib.c */
 123 typedef void sh_csprint_func_t __P((char *, COMPSPEC *));
 124
 125 extern COMPSPEC *alloc_compspec __P((void));
 126 extern void free_compspec __P((COMPSPEC *));
 127
 128 extern COMPSPEC *copy_compspec __P((COMPSPEC *));
 129
 130 extern void initialize_progcomp __P((void));
 131 extern void clear_progcomps __P((void));
 132
 133 extern int remove_progcomp __P((char *));
 134 extern int add_progcomp __P((char *, COMPSPEC *));
 135
 136 extern int num_progcomps __P((void));
 137
 138 extern COMPSPEC *find_compspec __P((const char *));
 139
 140 extern void print_all_compspecs __P((sh_csprint_func_t *));
 141
 142 /* Functions from pcomplete.c */
 143 extern void set_itemlist_dirty __P((ITEMLIST *));
 144
 145 extern STRINGLIST *completions_to_stringlist __P((char **));
 146
 147 extern STRINGLIST *gen_compspec_completions __P((COMPSPEC *, const char *, const char *, int, int));
 148 extern char **programmable_completions __P((const char *, const char *, int, int, int *));
 149
 150 #endif /* _PCOMPLETE_H_ */