Vty.h

// This is part of tacppd project (extended tacacs++ daemon)
// (c) Copyright in 2000-2004 by tacppd team and contributors
// see http://tacppd.org for more information
//
// file: Vty.h
// description:

//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

// modifications:
//

// all comments which start from /** - this is comments for KDoc */
//  for classes
//    @short [short description of the class]
//    @author [class author]
//    @version [class version]
//    @see [references to other classes or methods]
//  for methods
//    @see [references]
//    @return [sentence describing the return value]
//    @exception [list the exeptions that could be thrown]
//    @param [name id] [description]    - can be multiple
#ifndef __VTY_H__
#define __VTY_H__

#include "global.h"

namespace tacpp {

#define TERMINAL_TIMEOUT        10000
enum command {
  T_KEY_INSERT_CHAR=0,
  T_KEY_BEGINNING_OF_LINE,      
  T_KEY_BACKWARD_CHAR,  
  T_KEY_DELETE_CHAR,
  T_KEY_END_OF_LINE,
  T_KEY_FORWARD_CHAR,
  T_KEY_DELETE_BACKWARD_CHAR,
  T_KEY_CLEAR_LINE,
  T_KEY_NEXT_COMMAND,
  T_KEY_PREVIOUS_COMMAND,
  T_KEY_CLEAR_LINE_FROM_BEGINNING,
  T_KEY_KILL_WORD,
  T_KEY_EXECUTE_COMMAND,
  T_KEY_COMPLETE_COMMAND,
  T_KEY_GET_HELP,

  T_KEY_UP,
  T_KEY_DOWN,
  T_KEY_LEFT,
  T_KEY_RIGHT,

  T_KEY_EOF
};

enum telnetOpt {
  TELOPT_BINARY=0,
  TELOPT_ECHO=1,
  TELOPT_SGA=3,
  TELOPT_STATUS=5,
  TELOPT_NAOFFD=13,
  TELOPT_NAWS=31,
};
enum telnetCmd {
  SE=240,
  NOP,
  DMARK,
  BRK,
  IP,
  AO,
  AYT,
  EC,
  EL,
  GA,
  SB,
  WILL,
  WONT,
  DO,
  DONT,
  IAC
};

const int maxVtyInput=512;
class VtyLineSplitter;
class Vty {
 protected:
  char vty_line[maxVtyInput+1];
  int vtylinepos;
 public:
  bool isChanged;
  VtyLineSplitter *vtSplit;
  virtual string vty_get_line();
  virtual int vty_get_linepos();
  virtual void vty_cleanup();
  virtual void vty_set_line(const char *);
  virtual bool twriteErr(const char*);
  virtual bool twrite(const char*);
  virtual int treadstr()=0;
  virtual char * readstr()=0;
};

class VtyStream : public Vty {
 private:
  std::istream * cfstr;
 public:
  VtyStream(const char * fileName)throw(VtyErr);
  VtyStream(const  string strAsBuffer);
  virtual ~VtyStream();
  virtual int treadstr()throw(VtyErr);
  virtual bool twriteErr(const char*)throw(VtyErr);
  virtual char * readstr()throw(VtyErr) ;
};

class VtyTerm : public Packet,public Vty {
 private:
  int handle;
  struct in_addr in_address;
  char address[100];
  int vty_height;
  int vty_width;

 public:
  bool local_echo;
  void vty_clear_input();
  void vty_insert_char(unsigned char);
  void vty_del_char();
  void vty_del_backward_char();
  void vty_clear_line_from_beg();
  void vty_redraw_line();
  void vty_move_forward();
  void vty_move_backward();
  void vty_move_beginning_of_line();
  void vty_move_end_of_line();
  void vty_move_to(int pos);
  virtual int treadstr();
  char * readstr();
  virtual bool twriteErr(const char*);
  bool twrite(const char*);
  bool twrite(unsigned char );
  void twrite_marker_at(int pos,char a='^');
  unsigned char tsymbol(int &);
  void echo(bool);
  void linemode(bool);
  void toptions();
  void tset();
  void pager(const char*sourcePage,int height=0);
  int get_handle();
  VtyTerm(int,struct in_addr);
  virtual ~VtyTerm();
};

};

#endif //__VTY_H__

---