usr.sbin/ppp/prompt.h

   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: src/usr.sbin/ppp/prompt.h,v 1.5.2.3 2002/09/01 02:12:32 brian Exp $
  27  * $DragonFly: src/usr.sbin/ppp/prompt.h,v 1.2 2003/06/17 04:30:01 dillon Exp $
  28  */
  29
  30 #define LOCAL_AUTH      0x01
  31 #define LOCAL_NO_AUTH   0x02
  32 #define LOCAL_DENY      0x03
  33 #define LOCAL_CX        0x04    /* OR'd value - require a context */
  34 #define LOCAL_CX_OPT    0x08    /* OR'd value - optional context */
  35
  36 struct server;
  37 struct datalink;
  38 struct bundle;
  39 struct cmdargs;
  40
  41 struct prompt {
  42   struct fdescriptor desc;
  43   int fd_in, fd_out;
  44   struct datalink *TermMode;    /* The modem we're talking directly to */
  45   FILE *Term;                   /* sits on top of fd_out */
  46   u_char auth;                  /* Local Authorized status */
  47   struct server *owner;         /* who created me */
  48   struct bundle *bundle;        /* who I'm controlling */
  49   unsigned nonewline : 1;       /* need a newline before our prompt ? */
  50   unsigned needprompt : 1;      /* Show a prompt at the next UpdateSet() */
  51   unsigned active : 1;          /* Is the prompt active (^Z) */
  52   unsigned readtilde : 1;       /* We've read a ``~'' from fd_in */
  53
  54   struct {
  55     const char *type;           /* Type of connection */
  56     char from[40];              /* Source of connection */
  57   } src;
  58
  59   struct prompt *next;          /* Maintained in log.c */
  60   u_long logmask;               /* Maintained in log.c */
  61
  62   struct termios oldtio;        /* Original tty mode */
  63   struct termios comtio;        /* Command level tty mode */
  64 };
  65
  66 #define descriptor2prompt(d) \
  67   ((d)->type == PROMPT_DESCRIPTOR ? (struct prompt *)(d) : NULL)
  68
  69 #define PROMPT_STD (-1)
  70 extern struct prompt *prompt_Create(struct server *, struct bundle *, int);
  71 extern void prompt_Destroy(struct prompt *, int);
  72 extern void prompt_Required(struct prompt *);
  73 #ifdef __GNUC__
  74 extern void prompt_Printf(struct prompt *, const char *, ...)
  75                           __attribute__ ((format (printf, 2, 3)));
  76 #else
  77 extern void prompt_Printf(struct prompt *, const char *, ...);
  78 #endif
  79 #ifdef __GNUC__
  80 extern void prompt_vPrintf(struct prompt *, const char *, va_list)
  81                            __attribute__ ((format (printf, 2, 0)));
  82 #else
  83 extern void prompt_vPrintf(struct prompt *, const char *, va_list);
  84 #endif
  85 #define PROMPT_DONT_WANT_INT 1
  86 #define PROMPT_WANT_INT 0
  87 extern void prompt_TtyInit(struct prompt *);
  88 extern void prompt_TtyCommandMode(struct prompt *);
  89 extern void prompt_TtyTermMode(struct prompt *, struct datalink *);
  90 extern void prompt_TtyOldMode(struct prompt *);
  91 extern pid_t prompt_pgrp(struct prompt *);
  92 extern int PasswdCommand(struct cmdargs const *);
  93 extern void prompt_Suspend(struct prompt *);
  94 extern void prompt_Continue(struct prompt *);
  95 #define prompt_IsTermMode(p, dl) ((p)->TermMode == (dl) ? 1 : 0)
  96 #define prompt_IsController(p) (!(p) || (p)->owner ? 0 : 1)
  97 #define prompt_Required(p) ((p)->needprompt = 1)