usr.bin/tip/tip.h

   1 /*      $NetBSD: tip.h,v 1.29 2007/02/16 20:25:33 hubertf Exp $ */
   2
   3 /*
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)tip.h       8.1 (Berkeley) 6/6/93
  33  */
  34
  35 /*
  36  * tip - terminal interface program
  37  */
  38
  39 #include <sys/param.h>
  40 #include <sys/ioctl.h>
  41 #include <sys/time.h>
  42 #include <sys/wait.h>
  43 #include <machine/endian.h>
  44
  45 #include <err.h>
  46 #include <fcntl.h>
  47 #include <errno.h>
  48 #include <dirent.h>
  49 #include <pwd.h>
  50 #include <setjmp.h>
  51 #include <signal.h>
  52 #include <stdio.h>
  53 #include <stdlib.h>
  54 #include <string.h>
  55 #include <termios.h>
  56 #include <time.h>
  57 #include <unistd.h>
  58
  59 /*
  60  * Remote host attributes
  61  */
  62 char    *DV;                    /* UNIX device(s) to open */
  63 char    *EL;                    /* chars marking an EOL */
  64 char    *CM;                    /* initial connection message */
  65 char    *IE;                    /* EOT to expect on input */
  66 char    *OE;                    /* EOT to send to complete FT */
  67 char    *CU;                    /* call unit if making a phone call */
  68 char    *AT;                    /* acu type */
  69 char    *PN;                    /* phone number(s) */
  70 char    *DI;                    /* disconnect string */
  71 char    *PA;                    /* parity to be generated */
  72
  73 char    *PH;                    /* phone number file */
  74 char    *RM;                    /* remote file name */
  75 char    *HO;                    /* host name */
  76
  77 long    BR;                     /* line speed for conversation */
  78 long    FS;                     /* frame size for transfers */
  79
  80 long    DU;                     /* this host is dialed up */
  81 long    HW;                     /* this device is hardwired, see hunt.c */
  82 char    *ES;                    /* escape character */
  83 char    *EX;                    /* exceptions */
  84 char    *FO;                    /* force (literal next) char*/
  85 char    *RC;                    /* raise character */
  86 char    *RE;                    /* script record file */
  87 char    *PR;                    /* remote prompt */
  88 long    DL;                     /* line delay for file transfers to remote */
  89 long    CL;                     /* char delay for file transfers to remote */
  90 long    ET;                     /* echocheck timeout */
  91 long    HD;                     /* this host is half duplex - do local echo */
  92 char    DC;                     /* this host is directly connected. */
  93
  94 /*
  95  * String value table
  96  */
  97 typedef
  98         struct {
  99                 const char *v_name;     /* whose name is it */
 100                 uint8_t v_type;         /* for interpreting set's */
 101                 uint8_t v_access;       /* protection of touchy ones */
 102                 const char *v_abrev;    /* possible abreviation */
 103                 void *v_value;          /* casted to a union later */
 104                                 /*
 105                                  * XXX: this assumes that the storage space
 106                                  *      of a pointer >= that of a long
 107                                  */
 108         }
 109         value_t;
 110
 111 #define STRING  01              /* string valued */
 112 #define BOOL    02              /* true-false value */
 113 #define NUMBER  04              /* numeric value */
 114 #define CHAR    010             /* character value */
 115
 116 #define WRITE   01              /* write access to variable */
 117 #define READ    02              /* read access */
 118
 119 #define CHANGED 01              /* low bit is used to show modification */
 120 #define PUBLIC  1               /* public access rights */
 121 #define PRIVATE 03              /* private to definer */
 122 #define ROOT    05              /* root defined */
 123
 124 #define TRUE    1
 125 #define FALSE   0
 126
 127 #define ENVIRON 020             /* initialize out of the environment */
 128 #define IREMOTE 040             /* initialize out of remote structure */
 129 #define INIT    0100            /* static data space used for initialization */
 130 #define TMASK   017
 131
 132 /*
 133  * Definition of ACU line description
 134  */
 135 typedef
 136         struct {
 137                 const char *acu_name;
 138                 int     (*acu_dialer)(char *, char *);
 139                 void    (*acu_disconnect)(void);
 140                 void    (*acu_abort)(void);
 141         }
 142         acu_t;
 143
 144 #define equal(a, b)     (strcmp(a,b)==0)/* A nice function to string compare */
 145
 146 /*
 147  * variable manipulation stuff --
 148  *   if we defined the value entry in value_t, then we couldn't
 149  *   initialize it in vars.c, so we cast it as needed to keep lint
 150  *   happy.
 151  */
 152
 153 #define value(v)        vtable[v].v_value
 154
 155 #define number(v)       ((int)(intptr_t)(v))
 156 #define boolean(v)      ((short)(intptr_t)(v))
 157 #define character(v)    ((char)(intptr_t)(v))
 158 #define address(v)      ((long *)(intptr_t)(v))
 159
 160 #define setnumber(v,n)          do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
 161 #define setboolean(v,n)         do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
 162 #define setcharacter(v,n)       do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
 163 #define setaddress(v,n)         do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
 164
 165 /*
 166  * Escape command table definitions --
 167  *   lookup in this table is performed when ``escapec'' is recognized
 168  *   at the begining of a line (as defined by the eolmarks variable).
 169 */
 170
 171 typedef
 172         struct {
 173                 char    e_char;                 /* char to match on */
 174                 char    e_flags;                /* experimental, privileged */
 175                 const char *e_help;             /* help string */
 176                 void    (*e_func)(char);        /* command */
 177         }
 178         esctable_t;
 179
 180 #define NORM    00              /* normal protection, execute anyone */
 181 #define EXP     01              /* experimental, mark it with a `*' on help */
 182 #define PRIV    02              /* privileged, root execute only */
 183
 184 extern int      vflag;          /* verbose during reading of .tiprc file */
 185 extern value_t  vtable[];       /* variable table */
 186
 187 /*
 188  * Definition of indices into variable table so
 189  *  value(DEFINE) turns into a static address.
 190  *
 191  * XXX: keep in sync with vtable[] in vars.c
 192  */
 193
 194 #define BEAUTIFY        0
 195 #define BAUDRATE        1
 196 #define DIALTIMEOUT     2
 197 #define EOFREAD         3
 198 #define EOFWRITE        4
 199 #define EOL             5
 200 #define ESCAPE          6
 201 #define EXCEPTIONS      7
 202 #define FORCE           8
 203 #define FRAMESIZE       9
 204 #define HOST            10
 205 #define PHONES          11
 206 #define PROMPT          12
 207 #define RAISE           13
 208 #define RAISECHAR       14
 209 #define RECORD          15
 210 #define REMOTE          16
 211 #define SCRIPT          17
 212 #define TABEXPAND       18
 213 #define VERBOSE         19
 214 #define SHELL           20
 215 #define HOME            21
 216 #define ECHOCHECK       22
 217 #define DISCONNECT      23
 218 #define TAND            24
 219 #define LDELAY          25
 220 #define CDELAY          26
 221 #define ETIMEOUT        27
 222 #define RAWFTP          28
 223 #define HALFDUPLEX      29
 224 #define LECHO           30
 225 #define PARITY          31
 226 #define HARDWAREFLOW    32
 227
 228 struct termios  term;           /* current mode of terminal */
 229 struct termios  defterm;        /* initial mode of terminal */
 230 struct termios  defchars;       /* current mode with initial chars */
 231
 232 FILE    *fscript;               /* FILE for scripting */
 233
 234 int     attndes[2];             /* coprocess wakeup channel */
 235 int     fildes[2];              /* file transfer synchronization channel */
 236 int     repdes[2];              /* read process synchronization channel */
 237 int     FD;                     /* open file descriptor to remote host */
 238 #ifndef __lint__  /* not used by hayes.c, but used by some other dialers */
 239 int     AC;                     /* open file descriptor to dialer (v831 only) */
 240 #endif /*__lint__*/
 241 int     vflag;                  /* print .tiprc initialization sequence */
 242 int     sfd;                    /* for ~< operation */
 243 int     pid;                    /* pid of tipout */
 244 uid_t   uid, euid;              /* real and effective user id's */
 245 gid_t   gid, egid;              /* real and effective group id's */
 246 int     stop;                   /* stop transfer session flag */
 247 int     quit;                   /* same; but on other end */
 248 int     stoprompt;              /* for interrupting a prompt session */
 249 int     timedout;               /* ~> transfer timedout */
 250 int     cumode;                 /* simulating the "cu" program */
 251 int     bits8;                  /* terminal is is 8-bit mode */
 252 #define STRIP_PAR       (bits8 ? 0377 : 0177)
 253
 254 char    fname[80];              /* file name buffer for ~< */
 255 char    copyname[80];           /* file name buffer for ~> */
 256 char    ccc;                    /* synchronization character */
 257
 258 int     odisc;                  /* initial tty line discipline */
 259
 260 extern acu_t            acutable[];
 261 extern esctable_t       etable[];
 262 extern unsigned char    evenpartab[];
 263
 264 void    alrmtimeout(int);
 265 int     any(char, const char *);
 266 void    chdirectory(char);
 267 void    cleanup(int);
 268 const char   *tip_connect(void);
 269 void    consh(char);
 270 char   *ctrl(char);
 271 void    cumain(int, char **);
 272 void    cu_put(char);
 273 void    cu_take(char);
 274 void    disconnect(const char *);
 275 char   *expand(char *);
 276 void    finish(char);
 277 void    genbrk(char);
 278 void    getfl(char);
 279 char   *getremote(char *);
 280 void    hardwareflow(const char *);
 281 void    help(char);
 282 int     hunt(char *);
 283 char   *interp(const char *);
 284 void    pipefile(char);
 285 void    pipeout(char);
 286 int     prompt(const char *, char *, size_t);
 287 void    xpwrite(int, char *, size_t);
 288 void    raw(void);
 289 void    sendchar(char);
 290 void    sendfile(char);
 291 void    setparity(const char *);
 292 void    setscript(void);
 293 void    shell(char);
 294 void    suspend(char);
 295 void    tandem(const char *);
 296 void    tipabort(const char *);
 297 void    tipout(void);
 298 int     ttysetup(speed_t);
 299 void    unraw(void);
 300 void    variable(char);
 301 void    vinit(void);
 302 char   *vinterp(char *, char);
 303 void    vlex(char *);
 304 int     vstring(const char *, char *);
 305
 306 void    biz22_abort(void);
 307 void    biz22_disconnect(void);
 308 int     biz22f_dialer(char *, char *);
 309 int     biz22w_dialer(char *, char *);
 310 void    biz31_abort(void);
 311 void    biz31_disconnect(void);
 312 int     biz31f_dialer(char *, char *);
 313 int     biz31w_dialer(char *, char *);
 314 void    cour_abort(void);
 315 int     cour_dialer(char *, char *);
 316 void    cour_disconnect(void);
 317 int     df02_dialer(char *, char *);
 318 int     df03_dialer(char *, char *);
 319 void    df_abort(void);
 320 void    df_disconnect(void);
 321 void    dn_abort(void);
 322 int     dn_dialer(char *, char *);
 323 void    dn_disconnect(void);
 324 void    hay_abort(void);
 325 int     hay_dialer(char *, char *);
 326 void    hay_disconnect(void);
 327 void    t3000_abort(void);
 328 int     t3000_dialer(char *, char *);
 329 void    t3000_disconnect(void);
 330 void    v3451_abort(void);
 331 int     v3451_dialer(char *, char *);
 332 void    v3451_disconnect(void);
 333 void    v831_abort(void);
 334 int     v831_dialer(char *, char *);
 335 void    v831_disconnect(void);
 336 void    ven_abort(void);
 337 int     ven_dialer(char *, char *);
 338 void    ven_disconnect(void);