xref: /freebsd/usr.sbin/ppp/prompt.h (revision 2764b86afdc99a30f4b1a4da2c04db8aa7aa785d)
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  *	$Id: prompt.h,v 1.1.2.5 1998/04/05 18:25:34 brian Exp $
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 
35 struct server;
36 struct datalink;
37 struct bundle;
38 struct cmdargs;
39 
40 struct prompt {
41   struct descriptor 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 
52   char who[40];			/* Where do I come from */
53 
54   struct prompt *lognext;	/* Maintained in log.c */
55   u_long logmask;		/* Maintained in log.c */
56 
57   struct termios oldtio;	/* Original tty mode */
58   struct termios comtio;	/* Command level tty mode */
59 };
60 
61 #define prompt2descriptor(p) (&(p)->desc)
62 #define descriptor2prompt(d) \
63   ((d)->type == PROMPT_DESCRIPTOR ? (struct prompt *)(d) : NULL)
64 
65 #define PROMPT_STD (-1)
66 extern struct prompt *prompt_Create(struct server *, struct bundle *, int);
67 extern void prompt_Destroy(struct prompt *, int);
68 extern void prompt_DestroyUnclean(struct prompt *);
69 extern void prompt_Required(struct prompt *);
70 extern void prompt_Printf(struct prompt *, const char *, ...);
71 extern void prompt_vPrintf(struct prompt *, const char *, _BSD_VA_LIST_);
72 #define PROMPT_DONT_WANT_INT 1
73 #define PROMPT_WANT_INT 0
74 extern void prompt_TtyInit(struct prompt *, int);
75 extern void prompt_TtyCommandMode(struct prompt *);
76 extern void prompt_TtyTermMode(struct prompt *, struct datalink *);
77 extern void prompt_TtyOldMode(struct prompt *);
78 extern pid_t prompt_pgrp(struct prompt *);
79 extern int PasswdCommand(struct cmdargs const *);
80 extern void prompt_Suspend(struct prompt *);
81 extern void prompt_Continue(struct prompt *);
82 #define prompt_IsTermMode(p, dl) ((p)->TermMode == (dl) ? 1 : 0)
83 #define prompt_IsController(p) (!(p) || (p)->owner ? 0 : 1)
84 #define prompt_Required(p) ((p)->needprompt = 1)
85