i-bash/pcomplete.h
2009-09-12 16:46:53 +00:00

146 lines
4.1 KiB
C

/* pcomplete.h - structure definitions and other stuff for programmable
completion. */
/* Copyright (C) 1999 Free Software Foundation, Inc.
This file is part of GNU Bash, the Bourne Again SHell.
Bash 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, or (at your option) any later
version.
Bash 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 Bash; see the file COPYING. If not, write to the Free Software
Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
#if !defined (_PCOMPLETE_H_)
# define _PCOMPLETE_H_
#include "stdc.h"
#include "hashlib.h"
typedef struct compspec {
int refcount;
unsigned long actions;
char *globpat;
char *words;
char *prefix;
char *suffix;
char *funcname;
char *command;
char *filterpat;
} COMPSPEC;
/* Values for COMPSPEC actions. These are things the shell knows how to
build internally. */
#define CA_ALIAS (1<<0)
#define CA_ARRAYVAR (1<<1)
#define CA_BINDING (1<<2)
#define CA_BUILTIN (1<<3)
#define CA_COMMAND (1<<4)
#define CA_DIRECTORY (1<<5)
#define CA_DISABLED (1<<6)
#define CA_ENABLED (1<<7)
#define CA_EXPORT (1<<8)
#define CA_FILE (1<<9)
#define CA_FUNCTION (1<<10)
#define CA_HELPTOPIC (1<<11)
#define CA_HOSTNAME (1<<12)
#define CA_JOB (1<<13)
#define CA_KEYWORD (1<<14)
#define CA_RUNNING (1<<15)
#define CA_SETOPT (1<<16)
#define CA_SHOPT (1<<17)
#define CA_SIGNAL (1<<18)
#define CA_STOPPED (1<<19)
#define CA_USER (1<<20)
#define CA_VARIABLE (1<<21)
/* This is a general-purpose argv-style array struct that should be used
elsewhere. */
typedef struct _list_of_strings {
char **list;
int list_size;
int list_len;
} STRINGLIST;
/* List of items is used by the code that implements the programmable
completions. */
typedef struct _list_of_items {
int flags;
Function *list_getter; /* function to call to get the list */
STRINGLIST *slist;
/* These may or may not be used. */
STRINGLIST *genlist; /* for handing to the completion code one item at a time */
int genindex; /* index of item last handed to completion code */
} ITEMLIST;
/* Values for ITEMLIST -> flags */
#define LIST_DYNAMIC 0x001
#define LIST_DIRTY 0x002
#define LIST_INITIALIZED 0x004
#define LIST_MUSTSORT 0x008
#define LIST_DONTFREE 0x010
#define LIST_DONTFREEMEMBERS 0x020
extern HASH_TABLE *prog_completes;
extern int prog_completion_enabled;
/* Not all of these are used yet. */
extern ITEMLIST it_aliases;
extern ITEMLIST it_arrayvars;
extern ITEMLIST it_bindings;
extern ITEMLIST it_builtins;
extern ITEMLIST it_commands;
extern ITEMLIST it_directories;
extern ITEMLIST it_disabled;
extern ITEMLIST it_enabled;
extern ITEMLIST it_exports;
extern ITEMLIST it_files;
extern ITEMLIST it_functions;
extern ITEMLIST it_hostnames;
extern ITEMLIST it_jobs;
extern ITEMLIST it_keywords;
extern ITEMLIST it_running;
extern ITEMLIST it_setopts;
extern ITEMLIST it_shopts;
extern ITEMLIST it_signals;
extern ITEMLIST it_stopped;
extern ITEMLIST it_users;
extern ITEMLIST it_variables;
/* Functions from pcomplib.c */
extern COMPSPEC *alloc_compspec __P((void));
extern void free_compspec __P((COMPSPEC *));
extern COMPSPEC *copy_compspec __P((COMPSPEC *));
extern void initialize_progcomp __P((void));
extern void clear_progcomps __P((void));
extern int remove_progcomp __P((char *));
extern int add_progcomp __P((char *, COMPSPEC *));
extern int num_progcomps __P((void));
extern COMPSPEC *find_compspec __P((char *));
extern void print_all_compspecs __P((VFunction *));
/* Functions from pcomplete.c */
extern void set_itemlist_dirty __P((ITEMLIST *));
extern STRINGLIST *gen_compspec_completions __P((COMPSPEC *, char *, char *, int, int));
extern char **programmable_completions __P((char *, char *, int, int, int *));
#endif /* _PCOMPLETE_H_ */