srecord  1.65.0
srecord::input_file_hp64k Class Reference

The srecord::input_file_hp64k class is used to represent the parse state of a HP64000 Absolute formatted input file. More...

#include <hp64k.h>

Inheritance diagram for srecord::input_file_hp64k:
Collaboration diagram for srecord::input_file_hp64k:

Public Member Functions

virtual ~input_file_hp64k ()
 The destructor. More...
 
- Public Member Functions inherited from srecord::input_file
virtual ~input_file ()
 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...
 

Static Public Member Functions

static pointer create (const std::string &file_name)
 The create class method is used to create new dynamically allocated instances of this class. More...
 
- Static Public Member Functions inherited from srecord::input_file
static pointer guess (const std::string &file_name, arglex &cmdln)
 The guess class method is used to open a file of an unknown type. More...
 
static void ignore_all_checksums (void)
 The ignore_all_checksums method is used to set the global ignore checksums flag. More...
 

Protected Member Functions

bool read (record &record)
 The read method is used to read one record from the input. More...
 
const char * get_file_format_name (void) const
 The get_file_format_name method is used to find out the name of the file format being read. More...
 
void command_line (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...
 
int format_option_number (void) const
 The format_option_number method is used to obtain the option number, which can then be turned into text via the arglex::token_name method. More...
 
- Protected Member Functions inherited from srecord::input_file
virtual std::string filename (void) const
 The filename method is used to get the name of the input file being processed. More...
 
virtual std::string filename_and_line (void) const
 The filename_and_line method is used to get the name and current line number within the file. More...
 
void disable_checksum_validation (void)
 The disable_checksum_validation method is used to have this input stream ignore checksum errors. More...
 
 input_file (const std::string &file_name)
 The constructor. More...
 
virtual int get_char (void)
 The get_char method is used to fetch a character from the input. More...
 
virtual void get_char_undo (int)
 The get_char_undo method is used to return a character to the input. More...
 
int peek_char (void)
 The peek_char method is used to look at the next character of input, without actually consuming it (a later get_char or peak_char method will still see it). More...
 
virtual int get_nibble (void)
 The get_nibble method is used to fetch one hexadecimal digit from the input, via the get_char method. More...
 
virtual int get_byte (void)
 The get_byte method is used to fetch a byte value from the input. More...
 
unsigned get_word_be (void)
 The get_word_be method is used to fetch a 16-bit value from the input. More...
 
unsigned get_word_le (void)
 The get_word_le method is used to fetch a 16-bit value from the input. More...
 
unsigned long get_3bytes_be (void)
 The get_3bytes_be method is used to fetch a 24-bit value from the input. More...
 
unsigned long get_3bytes_le (void)
 The get_3bytes_le method is used to fetch a 24-bit value from the input. More...
 
unsigned long get_4bytes_be (void)
 The get_4bytes_be method is used to fetch a 32-bit value from the input. More...
 
unsigned long get_4bytes_le (void)
 The get_4bytes_le method is used to fetch a 32-bit value from the input. More...
 
int checksum_get (void) const
 The checksum_get method is used to get the current value of the running checksum (added to by the checksum_add method, usually called by the get_byte method). More...
 
int checksum_get16 (void) const
 The checksum_get16 method is used to get the current value of the running checksum (added to by the checksum_add method, usually called by the get_byte method). More...
 
virtual void checksum_add (unsigned char n)
 The checksum_add method is used to add another 8-bit value to the running checksum. More...
 
void checksum_reset (void)
 The checksum_rest method is used to set the running checksum to zero. More...
 
void seek_to_end (void)
 The seek_to_end method is used to move the input position to the end of the file. More...
 
bool use_checksums (void) const
 The use_checksums method is used to determine whether or not to validate checksums when data is read. More...
 
- Protected Member Functions inherited from srecord::input
 input ()
 The default constructor. More...
 

Additional Inherited Members

- Public Types inherited from srecord::input_file
typedef std::shared_ptr< input_filepointer
 
- Public Types inherited from srecord::input
typedef std::shared_ptr< inputpointer
 
- Static Protected Member Functions inherited from srecord::input_file
static int get_nibble_value (int c)
 The get_nibble_value class method is used to translate a character into its hexadecimal value. More...
 
- Protected Attributes inherited from srecord::input_file
int checksum
 The checksum instance variable is used record the running checksum. More...
 

Detailed Description

The srecord::input_file_hp64k class is used to represent the parse state of a HP64000 Absolute formatted input file.

Definition at line 31 of file hp64k.h.

Constructor & Destructor Documentation

◆ ~input_file_hp64k()

virtual srecord::input_file_hp64k::~input_file_hp64k ( )
virtual

The destructor.

Member Function Documentation

◆ create()

static pointer srecord::input_file_hp64k::create ( const std::string &  file_name)
static

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

Parameters
file_nameThe name of the file to be read.
Returns
smart pointer to new instance

◆ read()

bool srecord::input_file_hp64k::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

Implements srecord::input.

◆ get_file_format_name()

const char* srecord::input_file_hp64k::get_file_format_name ( void  ) 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.

◆ command_line()

void srecord::input_file_hp64k::command_line ( arglex_tool cmdln)
protectedvirtual

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.

The default implementation does nothing.

Parameters
cmdlnWhere to obtain information about the curreent parse state of the command line.

Reimplemented from srecord::input.

◆ format_option_number()

int srecord::input_file_hp64k::format_option_number ( void  ) const
protectedvirtual

The format_option_number method is used to obtain the option number, which can then be turned into text via the arglex::token_name method.

Implements srecord::input_file.


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