The srecord::output class is used to represent an abstract output vector. More...

#include <output.h>

Inheritance diagram for srecord::output:

[legend]

Public Types
typedef std::shared_ptr< output >	pointer

Public Member Functions
virtual	~output ()
	The destructor. More...

virtual void	write (const record &rec)=0
	The write method is used to write a recordonto an output. More...

virtual void	write_header (const record *=0)
	The write_header method is used to write a header record to the output. More...

virtual void	write_data (unsigned long, const void *, size_t)
	The write_data method is used to write data to the output. More...

virtual void	write_execution_start_address (const record *=0)
	The write_execution_start_address method is used to write an execution start address record to the output. More...

virtual void	line_length_set (int cols)=0
	The set_line_length method is used to set the maximum length of an output line, for those formats for which this is a meaningful concept, and the line length is at all controllable. More...

virtual void	address_length_set (int nbytes)=0
	The address_length_set method is used to set the minimum number of bytes to be written for addresses in the output, for those formats for which this is a meaningful concept, and the address length is at all controllable. More...

virtual int	preferred_block_size_get (void) const =0
	The preferred_block_size_get method is used to get the proferred block size of the output fformat. More...

virtual bool	preferred_block_size_set (int nbytes)=0
	The preferred_block_size_set method is is to set a precific number of bytes for the preferred block size. More...

virtual void	fatal_error (const char *fmt,...) const FORMAT_PRINTF(2
	The fatal_error method is used to report fatal errors. More...

virtual void virtual void	fatal_error_v (const char *fmt, va_list ap) const
	The fatal_error_v method is used to report fatal errors. More...

virtual void	fatal_error_errno (const char *fmt,...) const FORMAT_PRINTF(2
	The fatal_error_errno method is used to report fatal errors, and append the string equivalent of errno. More...

virtual void virtual void	fatal_error_errno_v (const char *fmt, va_list ap) const
	The fatal_error_errno_v method is used to report fatal errors. More...

virtual void	warning (const char *fmt,...) const FORMAT_PRINTF(2
	The warning method is used to likely but non-fatal errors. More...

virtual void virtual void	warning_v (const char *fmt, va_list ap) const
	The warning_v method is used to report likely but non-fatal errors. More...

virtual const std::string	filename (void) const =0
	The filename method is used to determine the name of the output file. More...

virtual const char *	format_name (void) const =0
	The format_name method is used to obtain the name of this output format. More...

virtual void	notify_upper_bound (unsigned long addr)
	The notify_upper_bound method is used to notify the output class of the upper bound (highest address plus one) of the output to come. More...

virtual void	command_line (arglex_tool *cmdln)
	The command_line method is used by arglex_srec::get_output when parsing the command line, to give the format an opportunity to grab extra arguments off the command line. More...

Protected Member Functions
	output ()
	The default constructor. More...

Detailed Description

The srecord::output class is used to represent an abstract output vector.

It could be a file, it could be a filter first, before it reaches a file.

Definition at line 38 of file output.h.

Member Typedef Documentation

◆ pointer

typedef std::shared_ptr<output> srecord::output::pointer

Definition at line 41 of file output.h.

Constructor & Destructor Documentation

◆ ~output()

virtual srecord::output::~output ( )

virtual

The destructor.

◆ output()

srecord::output::output ( )

protected

The default constructor.

Only derived classes may use.

Member Function Documentation

◆ write()

virtual void srecord::output::write ( const record & rec )

pure virtual

The write method is used to write a recordonto an output.

Derived classes must implement this method.

Parameters

rec	The record to be written.

◆ write_header()

virtual void srecord::output::write_header ( const record * = 0 )

virtual

The write_header method is used to write a header record to the output.

If no record is specified, a default record will be supplied. The write method will be called.

◆ write_data()

virtual void srecord::output::write_data	(	unsigned long	,
		const void *	,
		size_t
	)

virtual

The write_data method is used to write data to the output.

A suitable data record wil be produced. The write method will be called.

◆ write_execution_start_address()

virtual void srecord::output::write_execution_start_address ( const record * = 0 )

virtual

The write_execution_start_address method is used to write an execution start address record to the output.

If no record is specified, a default record will be supplied. The write method will be called.

◆ line_length_set()

virtual void srecord::output::line_length_set ( int cols )

pure virtual

The set_line_length method is used to set the maximum length of an output line, for those formats for which this is a meaningful concept, and the line length is at all controllable.

Derived classes must implement this method.

Parameters

cols	The page width in fixed width text columns.

◆ address_length_set()

virtual void srecord::output::address_length_set ( int nbytes )

pure virtual

The address_length_set method is used to set the minimum number of bytes to be written for addresses in the output, for those formats for which this is a meaningful concept, and the address length is at all controllable.

Derived classes must implement this method.

Parameters

nbytes The number of byte to use for the address (2..4).

◆ preferred_block_size_get()

virtual int srecord::output::preferred_block_size_get ( void ) const

pure virtual

The preferred_block_size_get method is used to get the proferred block size of the output fformat.

Often, but not always, influenced by the line_lebgth_set method. Derived classes must implement this method.

◆ preferred_block_size_set()

virtual bool srecord::output::preferred_block_size_set ( int nbytes )

pure virtual

The preferred_block_size_set method is is to set a precific number of bytes for the preferred block size.

Parameters

nbytes The exact number of bytes to be returned by the preferred_block_size_get method.

Returns: There are format-specific limitations on block sizes, this method will return true if the setting was acceptable, false if the format is incapable of using the specified block size.

◆ fatal_error()

virtual void srecord::output::fatal_error	(	const char *	fmt,
			...
	)		const

virtual

The fatal_error method is used to report fatal errors.

The 'fmt' string is in the same style a standard C printf function. It calls the fatal_error_v method. This method does not return.

◆ fatal_error_v()

virtual void virtual void srecord::output::fatal_error_v	(	const char *	fmt,
		va_list	ap
	)		const

virtual

The fatal_error_v method is used to report fatal errors.

The 'fmt' string is in the same style a standard C vprintf function. It calls global exit. This method does not return.

◆ fatal_error_errno()

virtual void srecord::output::fatal_error_errno	(	const char *	fmt,
			...
	)		const

virtual

The fatal_error_errno method is used to report fatal errors, and append the string equivalent of errno.

The 'fmt' string is in the same style a standard C printf function. It calls global exit(). This method does not return.

◆ fatal_error_errno_v()

virtual void virtual void srecord::output::fatal_error_errno_v	(	const char *	fmt,
		va_list	ap
	)		const

virtual

The fatal_error_errno_v method is used to report fatal errors.

The 'fmt' string is in the same style a standard C vprintf function. It calls the global exit function. This method does not return.

◆ warning()

virtual void srecord::output::warning	(	const char *	fmt,
			...
	)		const

virtual

The warning method is used to likely but non-fatal errors.

The 'fmt' string is in the same style a standard C printf function. It calls the warning_v method.

◆ warning_v()

virtual void virtual void srecord::output::warning_v	(	const char *	fmt,
		va_list	ap
	)		const

virtual

The warning_v method is used to report likely but non-fatal errors.

The 'fmt' string is in the same style a standard C vprintf function.

◆ filename()

virtual const std::string srecord::output::filename ( void ) const

pure virtual

The filename method is used to determine the name of the output file.

It is used for the various error messages. Derived classes must implement this method.

Implemented in srecord::output_file, and srecord::output_filter.

◆ format_name()

virtual const char* srecord::output::format_name ( void ) const

pure virtual

The format_name method is used to obtain the name of this output format.

◆ notify_upper_bound()

virtual void srecord::output::notify_upper_bound ( unsigned long addr )

virtual

The notify_upper_bound method is used to notify the output class of the upper bound (highest address plus one) of the output to come.

Shall be called before the head or any data records are written.

Parameters

addr	One past the highest used memory byte.

Reimplemented in srecord::output_filter, srecord::output_file_msbin, srecord::output_file_mif, srecord::output_file_mem, and srecord::output_file_coe.

◆ command_line()

virtual void srecord::output::command_line ( arglex_tool * cmdln )

virtual

The command_line method is used by arglex_srec::get_output when parsing the command line, to give the format an opportunity to grab extra arguments off the command line.

The default implementation does nothing.

Parameters

cmdln Where to obtain information about the curreent parse stat of the command line.

Reimplemented in srecord::output_filter, srecord::output_file_vmem, srecord::output_file_vhdl, srecord::output_file_motorola, srecord::output_file_mif, srecord::output_file_mem, srecord::output_file_hexdump, srecord::output_file_forth, srecord::output_file_coe, srecord::output_file_c, and srecord::output_file_asm.

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

output.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ pointer

Constructor & Destructor Documentation

◆ ~output()

◆ output()

Member Function Documentation

◆ write()

◆ write_header()

◆ write_data()

◆ write_execution_start_address()

◆ line_length_set()

◆ address_length_set()

◆ preferred_block_size_get()

◆ preferred_block_size_set()

◆ fatal_error()

◆ fatal_error_v()

◆ fatal_error_errno()

◆ fatal_error_errno_v()

◆ warning()

◆ warning_v()

◆ filename()

◆ format_name()

◆ notify_upper_bound()

◆ command_line()