prompt.h revision 102227 
1/*-
2 * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/usr.sbin/ppp/prompt.h 102227 2002-08-21 16:20:02Z mike $
27 */
28
29#define LOCAL_AUTH	0x01
30#define LOCAL_NO_AUTH	0x02
31#define LOCAL_DENY	0x03
32#define LOCAL_CX	0x04	/* OR'd value - require a context */
33#define LOCAL_CX_OPT	0x08	/* OR'd value - optional context */
34
35struct server;
36struct datalink;
37struct bundle;
38struct cmdargs;
39
40struct prompt {
41  struct fdescriptor desc;
42  int fd_in, fd_out;
43  struct datalink *TermMode;	/* The modem we're talking directly to */
44  FILE *Term;			/* sits on top of fd_out */
45  u_char auth;			/* Local Authorized status */
46  struct server *owner;         /* who created me */
47  struct bundle *bundle;	/* who I'm controlling */
48  unsigned nonewline : 1;	/* need a newline before our prompt ? */
49  unsigned needprompt : 1;	/* Show a prompt at the next UpdateSet() */
50  unsigned active : 1;		/* Is the prompt active (^Z) */
51  unsigned readtilde : 1;	/* We've read a ``~'' from fd_in */
52
53  struct {
54    const char *type;		/* Type of connection */
55    char from[40];		/* Source of connection */
56  } src;
57
58  struct prompt *next;		/* Maintained in log.c */
59  u_long logmask;		/* Maintained in log.c */
60
61  struct termios oldtio;	/* Original tty mode */
62  struct termios comtio;	/* Command level tty mode */
63};
64
65#define descriptor2prompt(d) \
66  ((d)->type == PROMPT_DESCRIPTOR ? (struct prompt *)(d) : NULL)
67
68#define PROMPT_STD (-1)
69extern struct prompt *prompt_Create(struct server *, struct bundle *, int);
70extern void prompt_Destroy(struct prompt *, int);
71extern void prompt_Required(struct prompt *);
72#ifdef __GNUC__
73extern void prompt_Printf(struct prompt *, const char *, ...)
74                          __attribute__ ((format (printf, 2, 3)));
75#else
76extern void prompt_Printf(struct prompt *, const char *, ...);
77#endif
78#ifdef __GNUC__
79extern void prompt_vPrintf(struct prompt *, const char *, __va_list)
80			   __attribute__ ((format (printf, 2, 0)));
81#else
82extern void prompt_vPrintf(struct prompt *, const char *, __va_list);
83#endif
84#define PROMPT_DONT_WANT_INT 1
85#define PROMPT_WANT_INT 0
86extern void prompt_TtyInit(struct prompt *);
87extern void prompt_TtyCommandMode(struct prompt *);
88extern void prompt_TtyTermMode(struct prompt *, struct datalink *);
89extern void prompt_TtyOldMode(struct prompt *);
90extern pid_t prompt_pgrp(struct prompt *);
91extern int PasswdCommand(struct cmdargs const *);
92extern void prompt_Suspend(struct prompt *);
93extern void prompt_Continue(struct prompt *);
94#define prompt_IsTermMode(p, dl) ((p)->TermMode == (dl) ? 1 : 0)
95#define prompt_IsController(p) (!(p) || (p)->owner ? 0 : 1)
96#define prompt_Required(p) ((p)->needprompt = 1)
97