*** empty log message ***

[h316.git] / pc-tools / ldc2 / src / tape_block.hh

#ifndef TAPE_BLOCK_H
#define TAPE_BLOCK_H

#include <string>
#include <vector>

using namespace std;

/*!
 *\brief Tape data block base class.
 *
 * This class represents a Honeywell paper tape block.
 * That may be some kind of data block or a end of tape mark.
 */
class tape_block{

public: // types

  /*!
   *\brief Initialisation state.
   */
  typedef enum {
    TBS_OK,          //!< Block successfully initialised
    TBS_EOF_LEGAL,   //!< Legal EOF while initialising
    TBS_EOF_ILLEGAL, //!< Illegal EOF while initialising
    TBS_CHECKSUM,    //!< Checksum error 
    TBS_IOERR,       //!< I/O-Error while reading
    TBS_DEFAULT      //!< Block not initialised.
  } tb_state_t;

  /*!
   * Tape block types.
   */
  typedef enum {
    TBT_DATA=0x10,   //!< Data block
    TBT_EOT,         //!< End of tape block
    TBT_DISCARD      //!< Invalid block, check block_type
  } tb_type_t;

public: // methods
  virtual ~tape_block();
  
  tape_block(tape_block &);
  void operator=(tape_block &);

  tb_state_t get_state();
  virtual int get_type();
  virtual int get_subtype();
  virtual vector<string> get_description();
  int get_raw_size();
  int get_discarded_bytes();
  unsigned char * get_raw_data();
  
  static tape_block * gen_from_fd(int  fd,
				  void(*input_start)(void *)=0,
				  void (*input_stop)(void *)=0,
				  void * start_stop_arg=0
				  );
 
protected:   // methods
  tape_block();
  string get_typestring();

private:   // methods
  tape_block (int  fd_p,
	      void(*input_start)(void *)=0,
	      void (*input_stop)(void *)=0,
	      void * start_stop_arg=0
	      );
  
  int init_words(void);
  int test_checksum(); 

protected: // members
  int block_type;             //!< Type of this block.
  tb_state_t init_state;      //!< Initialisation state.
  int discarded_bytes;        //!< Amount of bytes discarded before beginning.
  unsigned char * raw_data;   //!< Raw block data in bytes.
  int raw_size;               //!< Size of the raw data.
  unsigned short * word_data; //!< Data organized in machine words.
  int word_size;              //!< Size of the blocks in machine words.
  int poolsize;               //!< Amount of data malloc'ed 
}; // class tape_block


#endif