Sync usage with man page.
[netbsd-mini2440.git] / lib / libedit / prompt.h
blob9f33b0b78d8b23fcc29171d58e7b38bda8f57bc1
1 /* $NetBSD: prompt.h,v 1.9 2009/03/31 17:38:27 christos Exp $ */
3 /*-
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Christos Zoulas of Cornell University.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
34 * @(#)prompt.h 8.1 (Berkeley) 6/4/93
38 * el.prompt.h: Prompt printing stuff
40 #ifndef _h_el_prompt
41 #define _h_el_prompt
43 #include "histedit.h"
45 typedef Char *(*el_pfunc_t)(EditLine *);
47 typedef struct el_prompt_t {
48 el_pfunc_t p_func; /* Function to return the prompt */
49 coord_t p_pos; /* position in the line after prompt */
50 Char p_ignore; /* character to start/end literal */
51 int p_wide;
52 } el_prompt_t;
54 protected void prompt_print(EditLine *, int);
55 protected int prompt_set(EditLine *, el_pfunc_t, Char, int, int);
56 protected int prompt_get(EditLine *, el_pfunc_t *, Char *, int);
57 protected int prompt_init(EditLine *);
58 protected void prompt_end(EditLine *);
60 #endif /* _h_el_prompt */