srecord 1.65.0
 
Loading...
Searching...
No Matches
srecord::input_filter_unfill Class Reference

The srecord::input_filter_unfill class is used to represent a filter which makes holes in the data wherever a specified data byte value appears. More...

#include <unfill.h>

Inheritance diagram for srecord::input_filter_unfill:
Collaboration diagram for srecord::input_filter_unfill:

Public Member Functions

virtual ~input_filter_unfill ()
 The destructor.
 
- Public Member Functions inherited from srecord::input_filter
virtual ~input_filter ()
 The destructor.
 
std::string filename () const
 The filename method is used to get the name of the input file being processed.
 
std::string filename_and_line () const
 The filename_and_line method is used to get the name and current line number within the file.
 
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.
 
void disable_checksum_validation ()
 The disable_checksum_validation method is used to have this input stream ignore checksum errors.
 
- Public Member Functions inherited from srecord::input
virtual ~input ()
 The destructor.
 
virtual void fatal_error (const char *,...) const FORMAT_PRINTF(2
 The fatal_error method is used to report problems parsing the file.
 
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.
 
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.
 
void set_quit (quit &)
 The set_quit method is used to set the disposition of the error messages, and the "exit" implementation.
 
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.
 
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.
 

Static Public Member Functions

static pointer create (const input::pointer &deeper, int value, int minimum)
 The create class method is used to create new dynamically allocated instances of this class.
 

Protected Member Functions

bool read (record &record)
 The read method is used to read one record from the input.
 
- Protected Member Functions inherited from srecord::input_filter
 input_filter (input::pointer deeper)
 The constructor.
 
- Protected Member Functions inherited from srecord::input
 input ()
 The default constructor.
 

Additional Inherited Members

- Public Types inherited from srecord::input
typedef std::shared_ptr< inputpointer
 
- Protected Attributes inherited from srecord::input_filter
pointer ifp
 

Detailed Description

The srecord::input_filter_unfill class is used to represent a filter which makes holes in the data wherever a specified data byte value appears.

This is the inverse of the srecord::input_filter_fill class.

Usually this is used to find the actual limits of data from an extracted EPROM image; you can specify a minimum run length of the same byte, so that you don't simply get a 1/256 reduction in density in the middle of "real" data.

Definition at line 41 of file unfill.h.

Constructor & Destructor Documentation

◆ ~input_filter_unfill()

virtual srecord::input_filter_unfill::~input_filter_unfill ( )
virtual

The destructor.

Member Function Documentation

◆ create()

static pointer srecord::input_filter_unfill::create ( const input::pointer & deeper,
int value,
int minimum )
static

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

Parameters
deeperThe incoming data source to be filtered
valueThe value of the bytes to be turned into holes.
minimumThe minimum run length to be considered a hole.

◆ read()

bool srecord::input_filter_unfill::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
recWhere to put the returned data.
Returns
bool; true if data was read, false if at end-of-file

Reimplemented from srecord::input_filter.


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