root/usr.bin/telnet/externs.h
/*      $OpenBSD: externs.h,v 1.32 2024/05/21 05:00:48 jsg Exp $        */
/* $KTH: externs.h,v 1.16 1997/11/29 02:28:35 joda Exp $ */

/*
 * Copyright (c) 1988, 1990, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      @(#)externs.h   8.3 (Berkeley) 5/30/95
 */

#define SUBBUFSIZE      256

extern int
    autologin,          /* Autologin enabled */
    skiprc,             /* Don't process the ~/.telnetrc file */
    eight,              /* use eight bit mode (binary in and/or out */
    binary,
    family,             /* address family of peer */
    flushout,           /* flush output */
    connections,
    connected,          /* Are we connected to the other side? */
    globalmode,         /* Mode tty should be in */
    telnetport,         /* Are we connected to the telnet port? */
    localflow,          /* Flow control handled locally */
    restartany,         /* If flow control, restart output on any character */
    localchars,         /* we recognize interrupt/quit */
    donelclchars,       /* the user has set "localchars" */
    showoptions,
    net,                /* Network file descriptor */
    tin,                /* Terminal input file descriptor */
    tout,               /* Terminal output file descriptor */
    crlf,               /* Should '\r' be mapped to <CR><LF> (or <CR><NUL>)? */
    autoflush,          /* flush output when interrupting? */
    autosynch,          /* send interrupt characters with SYNCH? */
    SYNCHing,           /* Is the stream in telnet SYNCH mode? */
    donebinarytoggle,   /* the user has put us in binary */
    dontlecho,          /* do we suppress local echoing right now? */
    crmod,
    netdata,            /* Print out network data flow */
    prettydump,         /* Print "netdata" output in user readable format */
    termdata,           /* Print out terminal data flow */
    resettermname,
    linemode,
    kludgelinemode,
    want_status_response;

extern cc_t escape;     /* Escape to command mode */
extern cc_t rlogin;     /* Rlogin mode escape character */
#ifdef  KLUDGELINEMODE
extern cc_t echoc;      /* Toggle local echoing */
#endif

extern char
    *prompt;            /* Prompt for command. */

extern char
    will_wont_resp[],
    do_dont_resp[],
    options[],          /* All the little options */
    *hostname;          /* Who are we connected to? */

extern int      rtableid;       /* routing table to use */

/*
 * We keep track of each side of the option negotiation.
 */

#define MY_STATE_WILL           0x01
#define MY_WANT_STATE_WILL      0x02
#define MY_STATE_DO             0x04
#define MY_WANT_STATE_DO        0x08

/*
 * Macros to check the current state of things
 */

#define my_state_is_do(opt)             (options[opt]&MY_STATE_DO)
#define my_state_is_will(opt)           (options[opt]&MY_STATE_WILL)
#define my_want_state_is_do(opt)        (options[opt]&MY_WANT_STATE_DO)
#define my_want_state_is_will(opt)      (options[opt]&MY_WANT_STATE_WILL)

#define my_state_is_dont(opt)           (!my_state_is_do(opt))
#define my_state_is_wont(opt)           (!my_state_is_will(opt))
#define my_want_state_is_dont(opt)      (!my_want_state_is_do(opt))
#define my_want_state_is_wont(opt)      (!my_want_state_is_will(opt))

#define set_my_state_do(opt)            {options[opt] |= MY_STATE_DO;}
#define set_my_state_will(opt)          {options[opt] |= MY_STATE_WILL;}
#define set_my_want_state_do(opt)       {options[opt] |= MY_WANT_STATE_DO;}
#define set_my_want_state_will(opt)     {options[opt] |= MY_WANT_STATE_WILL;}

#define set_my_state_dont(opt)          {options[opt] &= ~MY_STATE_DO;}
#define set_my_state_wont(opt)          {options[opt] &= ~MY_STATE_WILL;}
#define set_my_want_state_dont(opt)     {options[opt] &= ~MY_WANT_STATE_DO;}
#define set_my_want_state_wont(opt)     {options[opt] &= ~MY_WANT_STATE_WILL;}

/*
 * Make everything symmetrical
 */

#define HIS_STATE_WILL                  MY_STATE_DO
#define HIS_WANT_STATE_WILL             MY_WANT_STATE_DO
#define HIS_STATE_DO                    MY_STATE_WILL
#define HIS_WANT_STATE_DO               MY_WANT_STATE_WILL

#define his_state_is_do                 my_state_is_will
#define his_state_is_will               my_state_is_do
#define his_want_state_is_do            my_want_state_is_will
#define his_want_state_is_will          my_want_state_is_do

#define his_state_is_dont               my_state_is_wont
#define his_state_is_wont               my_state_is_dont
#define his_want_state_is_dont          my_want_state_is_wont
#define his_want_state_is_wont          my_want_state_is_dont

#define set_his_state_do                set_my_state_will
#define set_his_state_will              set_my_state_do
#define set_his_want_state_do           set_my_want_state_will
#define set_his_want_state_will         set_my_want_state_do

#define set_his_state_dont              set_my_state_wont
#define set_his_state_wont              set_my_state_dont
#define set_his_want_state_dont         set_my_want_state_wont
#define set_his_want_state_wont         set_my_want_state_dont


extern jmp_buf
    peerdied,
    toplevel;           /* For error conditions. */

/* commands.c */

struct  env_lst *env_define (const char *, const char *);
void    env_init (void);
char    *env_default(int init, int welldefined);
char    *env_getvalue(const char *var, int exported_only);

void set_escape_char(char *s);

#ifdef SIGINFO
void ayt_status(int sig);
#endif
int tn(int argc, char **argv);
void command(int top, char *tbuf, int cnt);

/* main.c */

void tninit(void);

/* network.c */

void init_network(void);
int stilloob(void);
void setneturg(void);
int netflush(void);

/* sys_bsd.c */

void init_sys(void);
int TerminalSpecialChars(int c);
void TerminalDefaultChars(void);
cc_t *tcval(int func);
void TerminalSpeeds(long *input_speed, long *output_speed);
int TerminalWindowSize(long *rows, long *cols);
void TerminalNewMode(int);
void TerminalSaveState(void);
void sys_telnet_init(void);
int process_rings(int netin, int netout, int netex, int ttyin, int ttyout,
                  int poll);

/* telnet.c */

void init_telnet(void);

void tel_leave_binary(int rw);
void tel_enter_binary(int rw);
int opt_welldefined(const char *ep);
void telnet(char *);
int telrcv(void);
int rlogin_susp(void);
void intp(void);
void sendbrk(void);
void sendabort(void);
void sendsusp(void);
void sendeof(void);
void sendayt(void);
void sendnaws(void);

void xmitAO(void);
void xmitEL(void);
void xmitEC(void);

void     send_do (int, int);
void     send_dont (int, int);
void     send_will (int, int);
void     send_wont (int, int);

void     lm_mode (unsigned char *, int, int);

void     slcstate (void);
void     slc_mode_export (int);
void     slc_mode_import (int);
void     slc_check (void);

void     env_opt_start_info (void);
void     env_opt_add (char *);
void     env_opt_end (int);

int get_status (void);
int dosynch (void);

cc_t *tcval (int);

__dead void quit(void);

/* genget.c */

char    **genget(char *name, char **table, int stlen);
int     isprefix(char *s1, char *s2);
int     Ambiguous(void *s);

/* terminal.c */

void init_terminal(void);
int ttyflush(int drop);
int getconnmode(void);
void setconnmode(int);
void setcommandmode(void);

/* utilities.c */

extern char NetTraceFile[];
void SetNetTrace(const char *file);
void Dump(char direction, unsigned char *buffer, int length);
void printoption(char *direction, int cmd, int option);
void optionstatus(void);
void printsub(char direction, unsigned char *pointer, int length);
void EmptyTerminal(void);
void SetForExit(void);
__dead void Exit(int returnCode);
__dead void ExitString(char *string, int returnCode);

extern struct   termios new_tc;

# define termEofChar            new_tc.c_cc[VEOF]
# define termEraseChar          new_tc.c_cc[VERASE]
# define termIntChar            new_tc.c_cc[VINTR]
# define termKillChar           new_tc.c_cc[VKILL]
# define termQuitChar           new_tc.c_cc[VQUIT]
# define termSuspChar           new_tc.c_cc[VSUSP]
# define termFlushChar          new_tc.c_cc[VDISCARD]
# define termWerasChar          new_tc.c_cc[VWERASE]
# define termRprntChar          new_tc.c_cc[VREPRINT]
# define termLiteralNextChar    new_tc.c_cc[VLNEXT]
# define termStartChar          new_tc.c_cc[VSTART]
# define termStopChar           new_tc.c_cc[VSTOP]
# define termForw1Char          new_tc.c_cc[VEOL]
# define termForw2Char          new_tc.c_cc[VEOL]
# define termAytChar            new_tc.c_cc[VSTATUS]

/* Ring buffer structures which are shared */

extern Ring
    netoring,
    netiring,
    ttyoring,
    ttyiring;