fcml::EntryPoint Class Reference

Holds instruction pointer, processor operating mode and memory segment flags. More...

#include <fcml_common.hpp>

Public Types
enum	OperatingMode {   OM_16_BIT = FCML_OM_16_BIT,   OM_32_BIT = FCML_OM_32_BIT,   OM_64_BIT = FCML_OM_64_BIT }
	Supported operating modes. More...

Public Member Functions
	EntryPoint ()
	Creates an empty entry point instance. More...
	EntryPoint (OperatingMode opMode, fcml_ip ip=0, fcml_usize addressSizeAttribute=FCML_DS_UNDEF, fcml_usize operandSizeAttribute=FCML_DS_UNDEF)
	Creates an entry point instance for given processor operating mode, instruction pointer and optionally size attributes. More...
bool	operator== (const EntryPoint &ep) const
	Checks if two entry points are equal. More...
bool	operator!= (const EntryPoint &ep) const
	Checks if two entry points are not equal. More...
fcml_usize	getAddressSizeAttribute () const
	Gets address size attribute held by the entry point. More...
void	setAddressSizeAttribute (fcml_usize addressSizeAttribute)
	Sets a new address size attribute for the entry point. More...
fcml_usize	getOperandSizeAttribute () const
	Gets operand size attribute held by the entry point. More...
void	setOperandSizeAttribute (fcml_usize operandSizeAttribute)
	Sets a new operand size attribute for the entry point. More...
fcml_ip	getIP () const
	Gets instruction pointer held by the entry point. More...
void	setIP (fcml_ip ip)
	Sets a new instruction pointer for the entry point. More...
OperatingMode	getOpMode () const
	Gets processor operating mode. More...
void	setOpMode (OperatingMode opMode)
	Sets a new processor operating mode for the entry point. More...
void	incrementIP (fcml_ip ip)
	Increments the instruction pointer by given number of bytes. More...

Detailed Description

Holds instruction pointer, processor operating mode and memory segment flags.

Since

1.1.0

Member Enumeration Documentation

OperatingMode

enum fcml::EntryPoint::OperatingMode

Supported operating modes.

Since

1.1.0

Constructor & Destructor Documentation

EntryPoint() [1/2]

fcml::EntryPoint::EntryPoint ( )

inline

Creates an empty entry point instance.

Since

1.1.0

EntryPoint() [2/2]

fcml::EntryPoint::EntryPoint ( OperatingMode  opMode, fcml_ip  ip = 0, fcml_usize  addressSizeAttribute = FCML_DS_UNDEF, fcml_usize  operandSizeAttribute = FCML_DS_UNDEF  )

inline

Creates an entry point instance for given processor operating mode, instruction pointer and optionally size attributes.

Parameters

opMode	The processor operating mode.
ip	The instruction pointer.
addressSizeAttribute	The optional address size attribute.
operandSizeAttribute	The optional operand size attribute.

Since

1.1.0

Member Function Documentation

getAddressSizeAttribute()

fcml_usize fcml::EntryPoint::getAddressSizeAttribute ( ) const

inline

Gets address size attribute held by the entry point.

Returns

Address size attribute.

Since

1.1.0

getIP()

fcml_ip fcml::EntryPoint::getIP ( ) const

inline

Gets instruction pointer held by the entry point.

Returns

Instruction pointer.

Since

1.1.0

getOperandSizeAttribute()

fcml_usize fcml::EntryPoint::getOperandSizeAttribute ( ) const

inline

Gets operand size attribute held by the entry point.

Returns

Operand size attribute.

Since

1.1.0

getOpMode()

OperatingMode fcml::EntryPoint::getOpMode ( ) const

inline

Gets processor operating mode.

Returns

Processor operating mode.

Since

1.1.0

incrementIP()

void fcml::EntryPoint::incrementIP ( fcml_ip  ip )

inline

Increments the instruction pointer by given number of bytes.

Parameters

ip	Number for bytes the instruction pointer should be incremented by.

Since

1.1.0

operator!=()

bool fcml::EntryPoint::operator!= ( const EntryPoint &  ep ) const

inline

Checks if two entry points are not equal.

Parameters

ep	The source entry point.

Returns

True if they are not equal; otherwise false.

Since

1.1.0

operator==()

bool fcml::EntryPoint::operator== ( const EntryPoint &  ep ) const

inline

Checks if two entry points are equal.

Parameters

ep	The source entry point.

Returns

True if they are equal; otherwise false.

Since

1.1.0

setAddressSizeAttribute()

void fcml::EntryPoint::setAddressSizeAttribute ( fcml_usize  addressSizeAttribute )

inline

Sets a new address size attribute for the entry point.

Parameters

addressSizeAttribute

The address size attribute.

Since

1.1.0

setIP()

void fcml::EntryPoint::setIP ( fcml_ip  ip )

inline

Sets a new instruction pointer for the entry point.

Parameters

ip	The new instruction pointer.

Since

1.1.0

setOperandSizeAttribute()

void fcml::EntryPoint::setOperandSizeAttribute ( fcml_usize  operandSizeAttribute )

inline

Sets a new operand size attribute for the entry point.

Parameters

operandSizeAttribute

The operand size attribute.

Since

1.1.0

setOpMode()

void fcml::EntryPoint::setOpMode ( OperatingMode  opMode )

inline

Sets a new processor operating mode for the entry point.

Parameters

opMode

The new processor operating mode.

Since

1.1.0

---

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

• include/fcml_common.hpp