+/***************************************************************/
+/*!
+ *\brief Determine the block's type
+ *
+ * This routine returns the block's type.\\
+ *\retval TBT_DATA if it's a data block
+ *\retval TBT_EOT if it's an end of tape mark
+ *
+ *\note This function is virtual. That means that if the tape block in
+ * question is of the subtype data_block which overwrites this method,
+ * it will return the block type contained in the upper 4 bits of the
+ * first data word! Try to avoid testing for TBT_DATA. \n
+ * Blocks generated by gen_from_fd should never have TBT_DATA.
+ */
+int tape_block::get_type(){
+ return block_type;
+}
+
+/***************************************************************/
+/*!
+ *\brief Determine the block's subtype
+ *
+ * Some data block types have a subtype.
+ *\note This is a virtual method and to be used in derived classes.
+ *\return Always 0
+ */
+int tape_block::get_subtype(){
+ return 0;
+}
+
+/***************************************************************/
+/*!
+ *\brief Get a cleartext description of the block.
+ *\return ldc style descriptive line for the block
+ */
+vector<string> tape_block:: get_description(){
+ vector<string> result;
+ result.insert(result.end(),
+ "***** "+get_typestring()+"Untyped tape block");
+ return result;
+}
+
+/***************************************************************/
+/*!
+ *\brief Get size of the internal raw data buffer
+ *\return The size of the internal raw data buffer
+ */
+int tape_block::get_raw_size(){
+ return raw_size;
+}
+
+/***************************************************************/
+/*!
+ *\brief Get amount of bytes discarded before beginning
+ * of block sensed.
+ *\return Length of unusable tape before block start delimiter.
+ */
+int tape_block::get_discarded_bytes(){
+ return discarded_bytes;
+}
+
+/***************************************************************/
+/*!
+ *\brief Access internal raw data buffer
+ *
+ * The raw data buffer contains all block data except the
+ * block start and end delimiters.
+ *\return Pointer to internal raw data buffer of the block
+ */
+unsigned char * tape_block::get_raw_data(){
+ return raw_data;
+}
+
+/***************************************************************/
+/*!
+ *\brief Dump contents of the block to a file descriptor.
+ *
+ *\param fd A writable file descriptor.
+ *\return Always zero.
+ *\throw io_error_exception A write error occured.
+ */
+int tape_block::dump_to_fd(int fd){
+ int to_write=raw_size;
+ unsigned char * dump_ptr=raw_data;
+ int written;
+ while (to_write) {
+ written=write(fd,dump_ptr,to_write);
+ if (written < 0) throw io_error_exception();
+ to_write-=written;
+ dump_ptr+=written;
+ }
+ return 0;
+}
+
+/***************************************************************/
+/*!
+ *\brief Determine if the block marks the end of an object
+ *\retval true The block marks the end of an object.
+ *\retval false The block does not mark the end of an object.
+ *\note This is only a virtual method returning always false.
+ * Classes which can be the legal last block of an object
+ * will overwrite this method so that it returns true.
+ */
+bool tape_block::is_endblock(){
+ return false;
+}
+
+/***************************************************************/
+/*!
+ *\brief Get exported symbols.
+ *\return A vector containing any symbols exported in this block.
+ *\note This is only a virtual method returning always an empty
+ * vector. Classes describing appropriate data blocks
+ * will override this method.
+ */
+vector<string> tape_block::get_exported_symbols(){
+ vector<string> result;
+ return result;
+}
+
+/***************************************************************/
+/*!
+ *\brief Get called symbols.
+ *\return A vector containing any symbols called in this block.
+ *\note This is only a virtual method returning always an empty
+ * vector. Classes describing appropriate data blocks
+ * will override this method.
+ */
+vector<string> tape_block::get_called_symbols(){
+ vector<string> result;
+ return result;
+}
+
+/***************************************************************/
+/*!
+ *\brief Dump block contents
+ *\return A vector containing Information about the block's
+ * content.
+ */
+vector<string> tape_block::dump_contents(){
+ vector<string> result;
+ result.insert(result.end(),"No known contents.");
+ return result;
+}
+
+/***************************************************************/
+/*!
+ *\brief Determine if the block has a known type.
+ *\return true if type and subtype are known.
+ *\return false if the block type is not one of the valid end
+ * nodes of the type tree.
+ */
+bool tape_block::has_known_type(){
+ return m_has_known_type;
+}
+
+/***************************************************************/
+/*!
+ *\brief Static factory method for tape blocks.
+ *
+ * This method creates a tape_block by using the private
+ * constructor with file descriptor support.\n
+ *
+ * The factory method tries to determine the block's type and then
+ * looks for appropriate subclasses. If there's an appropriate
+ * subclass fitting the newly-created object, an
+ * object of the subclass will be created and a pointer to this
+ * object will be returned to the caller.\n
+ * This allows for easy use of the object using it's virtual
+ * interface methods or a cast of the pointer to a sub type pointer
+ * according to the type information, and then using the subtype's
+ * methods not already present in tape_block.\n
+ * Objects of the following subclasses are automagically generated:\n
+ * - eot_block
+ * - data_block
+ * - data_block_0
+ * - data_block_0_0
+ * - data_block_0_1
+ * - data_block_0_2
+ * - data_block_0_3
+ * - data_block_0_4
+ * - data_block_0_10
+ * - data_block_0_14
+ * - data_block_0_24
+ * - data_block_0_30
+ * - data_block_0_50
+ * - data_block_0_54
+ * - data_block_0_60
+ * - data_block_0_64
+ * - data_block_1
+ * - data_block_2
+ * - data_block_3
+ * - data_block_4
+ * - data_block_5
+ * - data_block_6
+ * - data_block_7
+ *
+ *\return Pointer to an instance of tape_block or a subclass.
+ *\param fd A file descriptor where data can be read from.
+ *\param input_start A pointer to a function
+ * called before reading data from fd.
+ *\param input_stop A pointer to a function
+ * called after reading data from fd.
+ *
+ *\param start_stop_arg A pointer passed to input_start
+ * and input_stop(). Can be anything.
+ */
+tape_block * tape_block::gen_from_fd(int fd,
+ void(*input_start)(void *),
+ void (*input_stop)(void *),
+ void * start_stop_arg)
+{
+ tape_block * n_tape_block=0;
+ data_block * n_data_block=0;
+ data_block * n_data_block_x=0;
+ data_block_0 * n_data_block_0=0;
+ data_block_0 * n_data_block_0_x=0;
+ eot_block * n_eot_block=0;
+ broken_block * n_broken_block=0;
+
+ //Use the private constructor which reads in the block from a file descriptor
+ try{
+ n_tape_block=new tape_block(fd,input_start,input_stop,start_stop_arg);
+ }
+
+ catch(checksum_error_exception e){
+ n_broken_block=new broken_block(*(e.get_block()));
+ delete e.get_block();
+ throw checksum_error_exception(n_broken_block);
+ }
+
+ // Retype to data_block, eot_block - if possible
+ switch(n_tape_block->get_type()){
+ case tape_block::TBT_DATA:
+ n_data_block = new data_block(*n_tape_block);
+ break;
+ case tape_block::TBT_EOT:
+ n_eot_block=new eot_block(*n_tape_block);
+ delete n_tape_block;
+ n_eot_block->m_has_known_type=true;
+ return n_eot_block;
+ default: // Unknown block, a bad thing!
+ return n_tape_block;
+ }
+ delete n_tape_block;
+
+ // Now only data blocks are left
+
+ switch(n_data_block->get_type()){
+ case 00: n_data_block_0=new data_block_0(*n_data_block); break;
+ case 01: n_data_block_x=new data_block_1(*n_data_block); break;
+ case 02: n_data_block_x=new data_block_2(*n_data_block); break;
+ case 03: n_data_block_x=new data_block_3(*n_data_block); break;
+ case 04: n_data_block_x=new data_block_4(*n_data_block); break;
+ case 05: n_data_block_x=new data_block_5(*n_data_block); break;
+ case 06: n_data_block_x=new data_block_6(*n_data_block); break;
+ case 07: n_data_block_x=new data_block_7(*n_data_block); break;
+ default:
+ return n_data_block;
+ }
+ if (n_data_block_0==0){ // So we must have found another one
+ delete n_data_block;
+ n_data_block_x->m_has_known_type=true;
+ return n_data_block_x;
+ }
+
+ // Here only type 0 left
+ switch(n_data_block_0->get_subtype()){
+ case 000: n_data_block_0_x=new data_block_0_0(*n_data_block_0); break;
+ case 001: n_data_block_0_x=new data_block_0_1(*n_data_block_0); break;
+ case 002: n_data_block_0_x=new data_block_0_2(*n_data_block_0); break;
+ case 003: n_data_block_0_x=new data_block_0_3(*n_data_block_0); break;
+ case 004: n_data_block_0_x=new data_block_0_4(*n_data_block_0); break;
+ case 010: n_data_block_0_x=new data_block_0_10(*n_data_block_0); break;
+ case 014: n_data_block_0_x=new data_block_0_14(*n_data_block_0); break;
+ case 024: n_data_block_0_x=new data_block_0_24(*n_data_block_0); break;
+ case 044: n_data_block_0_x=new data_block_0_44(*n_data_block_0); break;
+ case 030: n_data_block_0_x=new data_block_0_30(*n_data_block_0); break;
+ case 054: n_data_block_0_x=new data_block_0_54(*n_data_block_0); break;
+ case 060: n_data_block_0_x=new data_block_0_60(*n_data_block_0); break;
+ case 064: n_data_block_0_x=new data_block_0_64(*n_data_block_0); break;
+ case 050: n_data_block_0_x=new data_block_0_50(*n_data_block_0); break;
+ default:
+ return n_data_block_0;
+ }
+ delete n_data_block_0;
+ n_data_block_0_x->m_has_known_type=true;
+ return n_data_block_0_x;
+}
+
+/***************************************************************/
+/*!
+ *\brief Default constructor.
+ */
+tape_block::tape_block(){}
+
+/***************************************************************/
+/*!
+ *\brief get a short type description string.
+ *\return A small string to be used in description methods.
+ *
+ * The string is always 19 characters long.\n
+ * An example is "(99-99) ".
+ */
+string tape_block::get_typestring(){
+ char buffer[13];
+ sprintf(buffer,"(%o-%o) ",get_type(),get_subtype());
+ buffer[10]=0;
+ return string(buffer);
+}
+
+/***************************************************************/
+/*!
+ *\brief Automatic constructor with file descriptor support
+ *
+ * This constructor is used to initialise the block read in the
+ * block's data via a file descriptor.\n
+ * This is done in the following way:
+ * - input_start() is called.
+ * - Data is read from fd. Stops on end of file or end of block
+ * or IO error. On EOF or IO error input_stop() is NOT called.
+ * - If there was no IO error the block's checksum is calculated
+ * and checked.
+ * - The block's type field is initialised.
+ * - input_stop() is called.
+ *
+ *\param fd A file descriptor where the read is taken from
+ *\param input_stop A pointer to a function called at the end of input
+ *\param input_start A pointer to a function called at the beginning
+ * of input
+ *\param start_stop_arg A pointer passed to input_start and input_stop().
+ */