Input file device class. More...

#include <file_device.h>

Inheritance diagram for InputFileDevice:

Public Member Functions
	InputFileDevice (const char *const STR_FileName, OutputDevice &CLI_Out, const bool B_AutoDelete)
	Constructor. More...

virtual	~InputFileDevice (void)
	Destructor. More...

InputFileDevice &	EnableSpecialCharacters (const bool B_EnableSpecialCharacters)
	Special character enabling. More...

virtual const KEY	GetKey (void) const
	Input key capture handler. More...

virtual const ResourceString	GetLocation (void) const
	Input location accessor. More...

virtual void	PutString (const char *const STR_Out) const
	Output handler. More...

virtual void	Beep (void) const
	Beep handler. More...

virtual void	CleanScreen (void) const
	Clean screen. More...

virtual const bool	WouldOutput (const OutputDevice &CLI_Device) const
	Stack overflow protection. More...

const tk::String	GetFileName (void) const
	File name accessor. More...

const int	GetCurrentLine (void) const
	Current line accessor. More...

const int	GetCurrentColumn (void) const
	Current column accessor. More...

Public Member Functions inherited from IODevice
	IODevice (const char *const STR_DbgName, const bool B_AutoDelete)
	Constructor. More...

virtual	~IODevice (void)
	Destructor. More...

virtual const bool	WouldInput (const IODevice &CLI_Device) const
	Stack overflow protection. More...

Public Member Functions inherited from OutputDevice
const tk::String	GetDebugName (void) const
	Debug name accessor. More...

const int	UseInstance (const CallInfo &CLI_CallInfo)
	Ensures instance validity. More...

const int	FreeInstance (const CallInfo &CLI_CallInfo)
	Releases the instance. More...

const int	GetInstanceUsers (void) const
	Instance user count accessor. More...

const bool	OpenUp (const CallInfo &CLI_CallInfo)
	Checks the device is opened. More...

const bool	CloseDown (const CallInfo &CLI_CallInfo)
	Indicates the device the client does not need the device to opened anymore. More...

const int	GetOpenUsers (void) const
	Open state user count accessor. More...

const OutputDevice &	operator<< (const std::string &STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const tk::String &STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const char *const STR_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const char C_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const KEY E_Key) const
	Output operator. More...

const OutputDevice &	operator<< (const uint8_t UI8_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int16_t I16_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint16_t UI16_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int32_t I32_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint32_t UI32_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const int64_t I64_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const uint64_t UI64_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const float F_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const double D_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const void *const PV_Out) const
	Output operator. More...

const OutputDevice &	operator<< (const IOEndl &CLI_IOEndl) const
	Output operator. More...

const ResourceString	GetLastError (void) const
	Last error accessor. More...

virtual const ScreenInfo	GetScreenInfo (void) const
	Screen info accessor. More...

Public Member Functions inherited from Object
virtual	~Object (void)=0
	Pure virtual destructor. More...

Protected Member Functions
virtual const bool	OpenDevice (void)
	Device opening handler. More...

virtual const bool	CloseDevice (void)
	Device closure handler. More...

Protected Member Functions inherited from IODevice
const KEY	Char2Key (const int I_Char) const
	Common char translation. More...

Protected Member Functions inherited from OutputDevice
	OutputDevice (const char *const STR_DbgName, const bool B_AutoDelete)
	Constructor. More...

virtual	~OutputDevice (void)
	Destructor. More...

Protected Member Functions inherited from Object
	Object (void)
	Default constructor only available to sub-classes. More...

Additional Inherited Members
Static Public Member Functions inherited from IODevice
static IODevice &	GetNullDevice (void)
	Null device singleton. More...

static IODevice &	GetStdIn (void)
	Standard input device singleton. More...

Static Public Member Functions inherited from OutputDevice
static OutputDevice &	GetNullDevice (void)
	Null device singleton. More...

static OutputDevice &	GetStdOut (void)
	Standard output device singleton. More...

static OutputDevice &	GetStdErr (void)
	Standard error device singleton. More...

Protected Attributes inherited from OutputDevice
ResourceString	m_cliLastError

Detailed Description

Input file device class.

Definition at line 45 of file file_device.h.

Constructor & Destructor Documentation

◆ InputFileDevice()

InputFileDevice::InputFileDevice	(	const char *const	STR_FileName,
		OutputDevice &	CLI_Out,
		const bool	B_AutoDelete
	)

explicit

Constructor.

Parameters

STR_FileName	Input file name.
CLI_Out	Output device. This output device will be opened automatically when the input device is opened.
B_AutoDelete	Auto-deletion flag.

◆ ~InputFileDevice()

virtual InputFileDevice::~InputFileDevice ( void )

virtual

Destructor.

Member Function Documentation

◆ Beep()

virtual void InputFileDevice::Beep ( void ) const

virtual

Beep handler.

Reimplemented from OutputDevice.

◆ CleanScreen()

virtual void InputFileDevice::CleanScreen ( void ) const

virtual

Clean screen.

Reimplemented from OutputDevice.

◆ CloseDevice()

virtual const bool InputFileDevice::CloseDevice ( void )

protectedvirtual

Device closure handler.

Returns: true for success, false otherwise.

Note: Devices have to be prepared to be called several times through this method. They should do the closure once only (unless they have been opened between CloseDevice() calls), and indicate no failure thereafter.

Implements OutputDevice.

◆ EnableSpecialCharacters()

InputFileDevice& InputFileDevice::EnableSpecialCharacters ( const bool B_EnableSpecialCharacters )

Special character enabling.

Returns: Same InputFileDevice instance reference.

Parameters

B_EnableSpecialCharacters true for enabling. false otherwise.

◆ GetCurrentColumn()

const int InputFileDevice::GetCurrentColumn ( void ) const

Current column accessor.

Returns: Current column, starting from 0.

◆ GetCurrentLine()

const int InputFileDevice::GetCurrentLine ( void ) const

Current line accessor.

Returns: Current line, starting from 0.

◆ GetFileName()

const tk::String InputFileDevice::GetFileName ( void ) const

File name accessor.

Returns: File name.

◆ GetKey()

virtual const KEY InputFileDevice::GetKey ( void ) const

virtual

Input key capture handler.

Warning: Blocking call.

Returns: KEY code captured.

Implements IODevice.

◆ GetLocation()

virtual const ResourceString InputFileDevice::GetLocation ( void ) const

virtual

Input location accessor.

Returns: Input location resource string.

Reimplemented from IODevice.

◆ OpenDevice()

virtual const bool InputFileDevice::OpenDevice ( void )

protectedvirtual

Device opening handler.

Returns: true for success, false otherwise.

Note: Devices have to be prepared to be called several times through this method. They should do the opening once only (unless they have been closed between OpendDevice() calls), and indicate no failure thereafter.

Implements OutputDevice.

◆ PutString()

virtual void InputFileDevice::PutString ( const char *const STR_Out ) const

virtual

Output handler.

Parameters

STR_Out Output string.

Implements OutputDevice.

◆ WouldOutput()

virtual const bool InputFileDevice::WouldOutput ( const OutputDevice & CLI_Device ) const

virtual

Stack overflow protection.

Parameters

CLI_Device Other device that the callee device should check it would output characters to.

Returns: true if the callee device would redirect characters to the given device for output.

Determines whether the current device would output the given device in any way. Default implementation checks whether CLI_Device is the self device.

Reimplemented from OutputDevice.

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

file_device.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InputFileDevice()

◆ ~InputFileDevice()

Member Function Documentation

◆ Beep()

◆ CleanScreen()

◆ CloseDevice()

◆ EnableSpecialCharacters()

◆ GetCurrentColumn()

◆ GetCurrentLine()

◆ GetFileName()

◆ GetKey()

◆ GetLocation()

◆ OpenDevice()

◆ PutString()

◆ WouldOutput()