Description

template<typename AddressMap>
class Sawyer::Container::AddressMapConstraints< AddressMap >

Constraints are used to select addresses from a memory map.

Users don't normally see this class since it's almost always created as a temporary. In fact, most of the public methods in this class are also present in the AddressMap class, and that's where they're documented.

The purpose of this class is to curry the arguments that would otherwise need to be passed to the various map I/O methods and which would significantly complicate the API since many of these arguments are optional.

Definition at line 76 of file AddressMap.h.

#include <Sawyer/AddressMap.h>

Public Types
typedef AddressMap::Address	Address

typedef AddressMap::Value	Value

typedef Sawyer::Container::Interval< Address >	AddressInterval

Public Member Functions
	AddressMapConstraints (AddressMap *map)
	Construct a constraint that matches everything.

	operator AddressMapConstraints< const AddressMap > () const

void	print (std::ostream &out) const
	Print constraints in a human readable form.

AddressMapConstraints	require (unsigned bits) const
	Require certain access permissions.

AddressMapConstraints	prohibit (unsigned bits) const
	Prohibit certain access permissions.

AddressMapConstraints	access (unsigned bits) const
	Require and prohibit certain access permissions.

AddressMapConstraints	substr (const std::string &s) const
	Require certain segment names.

AddressMapConstraints	any () const
	No constraints.

AddressMapConstraints	none () const
	Constraints that match nothing.

AddressMapConstraints	at (Address x) const
	Anchor at a certain address.

AddressMapConstraints	at (const Sawyer::Container::Interval< Address > &x) const
	Anchor at a certain interval.

AddressMapConstraints	limit (size_t x) const
	Limit matching length.

AddressMapConstraints	atOrAfter (Address least) const
	Limit addresses.

AddressMapConstraints	atOrBefore (Address greatest) const
	Limit addresses.

AddressMapConstraints	within (const Sawyer::Container::Interval< Address > &x) const
	Limit addresses.

AddressMapConstraints	within (Address lo, Address hi) const
	Limit addresses.

AddressMapConstraints	baseSize (Address base, Address size) const
	Limit addresses.

AddressMapConstraints	after (Address x) const
	Limit addresses.

AddressMapConstraints	before (Address x) const
	Limit addreses.

AddressMapConstraints	singleSegment () const
	Limit matching to single segment.

AddressMapConstraints	segmentPredicate (SegmentPredicate< Address, Value > *p) const
	Limit segments.

AddressMapConstraints	segmentPredicates (const Callbacks< SegmentPredicate< Address, Value > * > &predicates) const

unsigned	required () const
	Accessibility bits that are required to be set.

unsigned	prohibited () const
	Accessibility bits that are required to be clear.

const std::string &	substr () const
	Section name substring.

bool	neverMatches () const
	Returns true if the constraint is not allowed to match anything.

bool	isAnchored () const
	Determines whether constraints are anchored to an address.

AddressInterval	anchored () const
	Returns the anchor points.

size_t	limit () const
	Size limit.

const Optional< Address > &	least () const
	Least possible address.

const Optional< Address > &	greatest () const
	Greatest possible address.

bool	isSingleSegment () const
	Returns true if the single-segment constraint is set.

const Callbacks< SegmentPredicate< Address, Value > * >	segmentPredicates () const
	Returns the segment predicates.

AddressMap *	map () const
	Returns a pointer to the memory map for this constraint object.

bool	hasNonAddressConstraints () const
	Determines whether non-address constraints are present.

AddressMapConstraints	addressConstraints () const
	Construct new constraints from existing address constraints.

boost::iterator_range< typename AddressMapTraits< AddressMap >::NodeIterator >	nodes (MatchFlags flags=0) const

boost::iterator_range< typename AddressMapTraits< AddressMap >::SegmentIterator >	segments (MatchFlags flags=0) const

Optional< typename AddressMap::Address >	next (MatchFlags flags=0) const

Sawyer::Container::Interval< Address >	available (MatchFlags flags=0) const

bool	exists (MatchFlags flags=0) const

AddressMapTraits< AddressMap >::NodeIterator	findNode (MatchFlags flags=0) const

template<typename Functor >
void	traverse (Functor &functor, MatchFlags flags=0) const

void	traverse (typename AddressMap::Visitor &visitor, MatchFlags flags=0) const

Sawyer::Container::Interval< Address >	read (typename AddressMap::Value *buf, MatchFlags flags=0) const

Sawyer::Container::Interval< Address >	read (std::vector< typename AddressMap::Value > &buf, MatchFlags flags=0) const

Sawyer::Container::Interval< Address >	write (const typename AddressMap::Value *buf, MatchFlags flags=0) const

Sawyer::Container::Interval< Address >	write (const std::vector< typename AddressMap::Value > &buf, MatchFlags flags=0)

void	prune (MatchFlags flags=0) const

void	keep (MatchFlags flags=0) const

void	changeAccess (unsigned requiredAccess, unsigned prohibitedAccess, MatchFlags flags=0) const

Description

Public Types

Public Member Functions

Member Typedef Documentation

◆ Address

◆ Value

◆ AddressInterval

Constructor & Destructor Documentation

◆ AddressMapConstraints()

Member Function Documentation

◆ operator AddressMapConstraints< const AddressMap >()

◆ print()

◆ require()

◆ prohibit()

◆ access()

◆ substr() [1/2]

◆ any()

◆ none()

◆ at() [1/2]

◆ at() [2/2]

◆ limit() [1/2]

◆ atOrAfter()

◆ atOrBefore()

◆ within() [1/2]

◆ within() [2/2]

◆ baseSize()

◆ after()

◆ before()

◆ singleSegment()

◆ segmentPredicate()

◆ segmentPredicates() [1/2]

◆ required()

◆ prohibited()

◆ substr() [2/2]

◆ neverMatches()

◆ isAnchored()

◆ anchored()

◆ limit() [2/2]

◆ least()

◆ greatest()

◆ isSingleSegment()

◆ segmentPredicates() [2/2]

◆ map()

◆ hasNonAddressConstraints()

◆ addressConstraints()

◆ nodes()

◆ segments()

◆ next()

◆ available()

◆ exists()

◆ findNode()

◆ traverse() [1/2]

◆ traverse() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ write() [1/2]

◆ write() [2/2]

◆ prune()

◆ keep()

◆ changeAccess()