srecord::input_catenate Class Reference

The srecord::input_catenate class is used to represent an input source which presents two inoput sources as if they were a single input source. More...

#include <catenate.h>

Inheritance diagram for srecord::input_catenate:

Collaboration diagram for srecord::input_catenate:

Public Member Functions
virtual	~input_catenate ()
	The destructor. More...
Public Member Functions inherited from srecord::input
virtual	~input ()
	The destructor. More...
virtual void	fatal_error (const char *,...) const FORMAT_PRINTF(2
	The fatal_error method is used to report problems parsing the file. More...
virtual void virtual void	fatal_error_errno (const char *,...) const FORMAT_PRINTF(2
	The fatal_error_errno method is used to report problems reading the input file. More...
virtual void virtual void virtual void	warning (const char *,...) const FORMAT_PRINTF(2
	The warning method is used to report potential (but non-fatal) problems parsing the file. More...
void	set_quit (quit &)
	The set_quit method is used to set the disposition of the error messages, and the "exit" implementation. More...
void	reset_quit (void)
	The reset_quit method is used to cause the disposition of the error messages, and the "exit" back to the default. More...
virtual void	command_line (srecord::arglex_tool *cmdln)
	The command_line method is used by arglex_srec::get_input when parsing the command line, to give a format or filter an opportunity to grab extra arguments off the command line. More...

Static Public Member Functions
static pointer	create (const pointer &in1, const pointer &in2)
	The create class method is used to create new dynamically allocated instances of this class. More...

Protected Member Functions
bool	read (record &record)
	The read method is used to read one record from the input. More...
std::string	filename () const
	The filename method is used to get the name of the input file being processed. More...
std::string	filename_and_line () const
	The filename_and_line method is used to get the name and current line number within the file. More...
const char *	get_file_format_name () const
	The get_file_format_name method is used to find out the name of the file format being read. More...
void	disable_checksum_validation ()
	The disable_checksum_validation method is used to have this input stream ignore checksum errors. More...
Protected Member Functions inherited from srecord::input
	input ()
	The default constructor. More...

Additional Inherited Members
Public Types inherited from srecord::input
typedef std::shared_ptr< input >	pointer

Detailed Description

The srecord::input_catenate class is used to represent an input source which presents two inoput sources as if they were a single input source.

Definition at line 31 of file catenate.h.

Constructor & Destructor Documentation

~input_catenate()

virtual srecord::input_catenate::~input_catenate ( )

virtual

The destructor.

Member Function Documentation

create()

static pointer srecord::input_catenate::create ( const pointer &  in1, const pointer &  in2  )

static

The create class method is used to create new dynamically allocated instances of this class.

Parameters

in1	The first of the inputs to be read.
in2	The second of the inputs to be read.

read()

bool srecord::input_catenate::read ( record &  rec )

protectedvirtual

The read method is used to read one record from the input.

It returns 0 at the end of the input, and 1 if a record is read successfully.

See the srecord::record documentation (header file) for details of the various record types.

Note: there is no guarantee that a header record will appear first, or that a execution start address record will appear last.

Parameters

rec	Where to put the returned data.

Returns

bool; true if data was read, false if at end-of-file

Implements srecord::input.

filename()

std::string srecord::input_catenate::filename ( ) const

protectedvirtual

The filename method is used to get the name of the input file being processed.

Derived classes must supply this method.

Implements srecord::input.

filename_and_line()

std::string srecord::input_catenate::filename_and_line ( ) const

protectedvirtual

The filename_and_line method is used to get the name and current line number within the file.

The default implementation simply calls the filename method and returns that. Text formats should be cleverer.

Reimplemented from srecord::input.

get_file_format_name()

const char* srecord::input_catenate::get_file_format_name ( ) const

protectedvirtual

The get_file_format_name method is used to find out the name of the file format being read.

Derived classes must supply this method.

Implements srecord::input.

disable_checksum_validation()

void srecord::input_catenate::disable_checksum_validation ( )

protectedvirtual

The disable_checksum_validation method is used to have this input stream ignore checksum errors.

Implements srecord::input.

---

The documentation for this class was generated from the following file:

• input/catenate.h