Class AbstractStreamEmuUnixFileHandle<T>

java.lang.Object

ghidra.pcode.emu.unix.AbstractStreamEmuUnixFileHandle<T>

Type Parameters:

T - the type of values in the file

All Implemented Interfaces:

EmuUnixFileDescriptor<T>

Direct Known Subclasses:

IOStreamEmuUnixFileHandle

public abstract class AbstractStreamEmuUnixFileHandle<T>
extends Object
implements EmuUnixFileDescriptor<T>

An abstract file descriptor having no "offset," typically for stream-like files

Field Summary

Fields

Change	Modifier and Type	Field	Description
	protected final PcodeArithmetic<T>	arithmetic
	protected final int	offsetBytes

Fields inherited from interface EmuUnixFileDescriptor

FD_STDERR, FD_STDIN, FD_STDOUT

Constructor Summary

Constructors

Change	Constructor	Description
	AbstractStreamEmuUnixFileHandle(PcodeMachine<T> machine, CompilerSpec cSpec)	Construct a new handle

Method Summary

Change	Modifier and Type	Method	Description
	T	getAbstractOffset()	Returns the current offset of the file, or 0 if not applicable.
	long	getOffset()	Returns the current offset of the file, or 0 if not applicable.
	T	readAbstract(T buf)	Read from the file opened by this handle
	void	seek(long offset)	Seek to the given offset
	void	seek(T offset)	Seek to the given offset
	EmuUnixFileStat	stat()	Returns the stat structure of the file opened by this handle.
	T	writeAbstract(T buf)	Write into the file opened by this handle

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface EmuUnixFileDescriptor

close, read, write

Field Details

arithmetic

protected final PcodeArithmetic<T> arithmetic

offsetBytes

protected final int offsetBytes

Constructor Details

AbstractStreamEmuUnixFileHandle

public AbstractStreamEmuUnixFileHandle(PcodeMachine<T> machine,
 CompilerSpec cSpec)

Construct a new handle

Parameters:

machine - the machine emulating the hardware

cSpec - the ABI of the target platform

See Also:

• AbstractEmuUnixSyscallUseropLibrary.createHandle(EmuUnixFile, int)

Method Details

getAbstractOffset NEW

public T getAbstractOffset()

Description copied from interface: EmuUnixFileDescriptor

Returns the current offset of the file, or 0 if not applicable.

Specified by:

getAbstractOffset in interface EmuUnixFileDescriptor<T>

Returns:

the current offset of the file, or 0 if not applicable

getOffset MODIFIED

public long getOffset()

return type: T → long

-T getOffset()

+long getOffset()

Description copied from interface: EmuUnixFileDescriptor

Returns the current offset of the file, or 0 if not applicable.

Specified by:

getOffset in interface EmuUnixFileDescriptor<T>

Returns:

the current offset of the file, or 0 if not applicable

seek

public void seek(T offset)
          throws EmuIOException

Description copied from interface: EmuUnixFileDescriptor

Seek to the given offset

Specified by:

seek in interface EmuUnixFileDescriptor<T>

Parameters:

offset - the desired offset

Throws:

EmuIOException - if an error occurred

seek NEW

public void seek(long offset)
          throws EmuIOException

Description copied from interface: EmuUnixFileDescriptor

Seek to the given offset

Specified by:

seek in interface EmuUnixFileDescriptor<T>

Parameters:

offset - the desired offset

Throws:

EmuIOException - if an error occurred

readAbstract NEW

public T readAbstract(T buf)
               throws EmuIOException

Description copied from interface: EmuUnixFileDescriptor

Read from the file opened by this handle

Specified by:

readAbstract in interface EmuUnixFileDescriptor<T>

Parameters:

buf - the destination buffer

Returns:

the number of bytes read

Throws:

EmuIOException - if an error occurred

writeAbstract NEW

public T writeAbstract(T buf)
                throws EmuIOException

Description copied from interface: EmuUnixFileDescriptor

Write into the file opened by this handle

Specified by:

writeAbstract in interface EmuUnixFileDescriptor<T>

Parameters:

buf - the source buffer

Returns:

the number of bytes written

Throws:

EmuIOException - if an error occurred

stat

public EmuUnixFileStat stat()

Description copied from interface: EmuUnixFileDescriptor

Returns the stat structure of the file opened by this handle.

Specified by:

stat in interface EmuUnixFileDescriptor<T>

Returns:

the stat structure of the file opened by this handle