clues::item::ReturnValue Class Reference

Base class for a system call return values. More...

#include <items.hxx>

Inheritance diagram for clues::item::ReturnValue:

Public Member Functions
	ReturnValue (const std::string_view short_name, const std::string_view long_name={})
Public Member Functions inherited from clues::SystemCallItem
	SystemCallItem (const ItemType type, const std::string_view short_name={}, const std::string_view long_name={})
	Constructs a new SystemCallItem.
auto	type () const
bool	isIn () const
bool	isOut () const
bool	isInOut () const
bool	isReturnValue () const
void	fill (const Tracee &proc, const Word word)
	Fills the item from the given register data.
bool	needsUpdate () const
	Returns whether the item needs to be updated after the system call is finished.
std::string_view	shortName () const
	Returns the friendly short name for this item.
std::string_view	longName () const
	Returns the friendly long name for this item, if available, else the short name.
auto	hasLongName () const
virtual std::string	str () const
	Returns a human readable string representation of the item.
bool	isZero () const
	Returns whether the parameter is set to 0 / NULL.
Word	value () const
	Returns the currently stored raw value of the item.
template<typename OTHER>
OTHER	valueAs () const
	Helper to cast the strongly typed Word m_val to other strong enum types.
ForeignPtr	asPtr () const
Flags	flags () const
bool	deferFill () const

Additional Inherited Members
Public Types inherited from clues::SystemCallItem
enum class	Flag { DEFER_FILL = 1 << 0 }
using	Flags = cosmos::BitMask<Flag>
Protected Member Functions inherited from clues::SystemCallItem
virtual void	processValue (const Tracee &)
	Processes the value stored in m_val acc. to the actual item type.
virtual void	updateData (const Tracee &t)
	Called upon exit of the system call to update possible out parameters.
void	setSystemCall (const SystemCall &sc)
	Sets the system call context this item is a part of.
Protected Attributes inherited from clues::SystemCallItem
const SystemCall *	m_call = nullptr
	The system call context this item part of.
const ItemType	m_type
	The type of item.
std::string_view	m_short_name
	A human readable short name for the item, should be one word only.
std::string_view	m_long_name
	A human readable longer name for the item.
Word	m_val
	The raw register value for the item.
Flags	m_flags
	Flags influencing the processing of the item.

Detailed Description

Base class for a system call return values.

Definition at line 16 of file items.hxx.

Constructor & Destructor Documentation

ReturnValue()

clues::item::ReturnValue::ReturnValue ( const std::string_view short_name, const std::string_view long_name = {} )

inlineexplicit

Definition at line 19 of file items.hxx.

                                                                                               {}) :
                SystemCallItem{ItemType::RETVAL, short_name, long_name}
        {}

---

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

• include/items/items.hxx