Commands

Detailed Description

Classes
struct	FieldResolutionState
struct	BinaryViewWriteTarget

Functions
bool	undefineForAddress (BinaryViewRef data, uint64_t addr)
bool	undefineNameForAddress (BinaryViewRef data, uint64_t addr)
bool	undefineNameForLocalVariable (BinaryViewRef data, FunctionRef func, const BinaryNinja::Variable &var)
bool	inputNameForAddress (QWidget *parent, BinaryViewRef data, uint64_t addr)
bool	inputNameForLocalVariable (QWidget *parent, BinaryViewRef data, FunctionRef function, const BinaryNinja::Variable &var)
bool	inputNameForType (QWidget *parent, std::string &name, const QString &title="Set Name", const QString &msg="Enter name:")
std::optional< BinaryNinja::QualifiedNameAndType >	getNameAndTypeForDisplayName (BinaryViewRef data, const std::string &displayName)
std::optional< BinaryNinja::QualifiedNameAndType >	getNameAndTypeForDisplayName (const BinaryNinja::TypeContainer &container, const std::string &displayName)
BinaryNinja::QualifiedName	qualifiedNameForDisplayName (BinaryViewRef data, const std::string &displayName)
bool	renameTypeForToken (QWidget *parent, BinaryViewRef data, const std::string &displayName)
bool	InferArraySize (TypeRef &type, size_t selectionSize)
bool	askForNewType (QWidget *parent, std::optional< BinaryNinja::TypeContainer > container, const std::string &title, bool allowZeroSize, TypeRef &type, BinaryNinja::QualifiedName &name)
bool	inputNewType (QWidget *parent, BinaryViewRef data, FunctionRef currentFunction, uint64_t currentAddr, size_t selectionSize, HighlightTokenState &highlight)
bool	createInferredMember (QWidget *parent, BinaryViewRef data, HighlightTokenState &highlight, FunctionRef func, const BinaryNinja::FunctionViewType &ilType, size_t instrIndex)
bool	createStructMembers (QWidget *parent, BinaryViewRef data, HighlightTokenState &highlight, FunctionRef func)
bool	inputPossibleValueSet (QWidget *parent, BinaryViewRef data, FunctionRef currentFunction, const BinaryNinja::FunctionViewType &funcType, const BinaryNinja::Variable &var, size_t ilInstructionIndex=BN_INVALID_EXPR)
bool	inputUserVariableValue (View *parent, HighlightTokenState &highlight)
bool	eligibleForUserVariableValue (View *parent, HighlightTokenState &highlight)
bool	clearUserVariableValue (View *parent, HighlightTokenState &highlight)
bool	eligibleToClearUserVariableValue (View *parent, HighlightTokenState &highlight)
bool	forceVariableVersion (View *parent, HighlightTokenState &highlight)
bool	eligibleToForceVariableVersion (View *parent, HighlightTokenState &highlight)
bool	clearVariableVersion (View *parent, HighlightTokenState &highlight)
bool	eligibleToClearVariableVersion (View *parent, HighlightTokenState &highlight)
bool	getEnumSelection (QWidget *parent, BinaryViewRef data, FunctionRef func, uint64_t constValue, TypeRef &selectedEnum, bool checkValue, bool canTruncate)
bool	overwriteCode (BinaryViewRef data, ArchitectureRef arch, uint64_t addr, size_t len, const BinaryNinja::DataBuffer &buffer)
bool	overwriteCode (BinaryViewRef data, ArchitectureRef arch, uint64_t addr, const BinaryNinja::DataBuffer &buffer)
StructureRef	getInnerMostStructureContaining (BinaryViewRef data, StructureRef structure, size_t &memberIndex, const std::vector< std::string > &nameList, size_t nameIndex, TypeRef &type, BinaryNinja::QualifiedName &typeName)
StructureRef	getInnerMostStructureContainingOffset (BinaryViewRef data, StructureRef structure, const std::vector< std::string > &nameList, size_t nameIndex, size_t offset, TypeRef &type, BinaryNinja::QualifiedName &typeName)
uint64_t	getInnerMostStructureOffset (BinaryViewRef data, StructureRef structure, const std::vector< std::string > &nameList, size_t nameIndex)
std::string	createStructureName (BinaryNinja::TypeContainer types, const std::string &prefix="struct_")
std::optional< BinaryNinja::Variable >	getSplitVariableForAssignment (FunctionRef func, const BinaryNinja::FunctionViewType &ilType, uint64_t location, const BinaryNinja::Variable &var)
std::optional< size_t >	getVariableDefinitionInstructionIndex (FunctionRef func, const BinaryNinja::FunctionViewType &funcType, const BinaryNinja::Variable &var, size_t ilInstructionIndex)
std::optional< size_t >	getVariableDefinitionAddress (FunctionRef func, const BinaryNinja::FunctionViewType &funcType, const BinaryNinja::Variable &var, size_t ilInstructionIndex)
bool	IsDefaultArgumentOrParameterName (const std::string &name)
std::optional< std::string >	GetVariableNameFromExpr (BinaryNinja::Function *func, const BinaryNinja::HighLevelILInstruction &instr)
TypeRef	GetFunctionType (BinaryViewRef data, TypeRef type)
std::optional< uint64_t >	getFoldableExprAddress (BinaryNinja::HighLevelILFunction *hlil, const HighlightTokenState &highlight)
std::optional< uint64_t >	getInvertableConditionAddress (BinaryNinja::HighLevelILFunction *hlil, size_t instrIndex)
std::optional< uint64_t >	getEarlyReturnAddress (BinaryNinja::HighLevelILFunction *hlil, size_t instrIndex)
std::optional< uint64_t >	getSwitchRecoveryAddress (BinaryNinja::HighLevelILFunction *hlil, size_t instrIndex)
BinaryViewWriteTarget	resolveTargetWriteBinaryView (BinaryViewRef view, uint64_t addr)
void	updateBinaryViewMemoryMap (BinaryViewRef view, uint64_t writeAddr, size_t writeLen, uint64_t dataOffset)

---

Class Documentation

FieldResolutionState

struct FieldResolutionState

Public Member Functions
void	bindDynamicActions (View *view, HighlightTokenState &highlight)
Public Attributes
std::vector< std::pair< std::string, FieldResolutionInfoRef > >	goodFieldResolutions = {}
std::vector< std::pair< std::string, FieldResolutionInfoRef > >	badFieldResolutions = {}
size_t	registeredGoodFieldResolutions = 0
size_t	registeredBadFieldResolutions = 0

Member Function Documentation

bindDynamicActions()

void FieldResolutionState::bindDynamicActions	(	View *	view,
		HighlightTokenState &	highlight )

Member Data Documentation

goodFieldResolutions

std::vector<std::pair<std::string, FieldResolutionInfoRef> > FieldResolutionState::goodFieldResolutions = {}

badFieldResolutions

std::vector<std::pair<std::string, FieldResolutionInfoRef> > FieldResolutionState::badFieldResolutions = {}

registeredGoodFieldResolutions

size_t FieldResolutionState::registeredGoodFieldResolutions = 0

registeredBadFieldResolutions

size_t FieldResolutionState::registeredBadFieldResolutions = 0

BinaryViewWriteTarget

struct BinaryViewWriteTarget

Class Members
BinaryViewRef	view
uint64_t	address
bool	updateMemoryMap

Function Documentation

undefineForAddress()

bool undefineForAddress	(	BinaryViewRef	data,
		uint64_t	addr )

undefineNameForAddress()

bool undefineNameForAddress	(	BinaryViewRef	data,
		uint64_t	addr )

undefineNameForLocalVariable()

bool undefineNameForLocalVariable	(	BinaryViewRef	data,
		FunctionRef	func,
		const BinaryNinja::Variable &	var )

inputNameForAddress()

bool inputNameForAddress	(	QWidget *	parent,
		BinaryViewRef	data,
		uint64_t	addr )

inputNameForLocalVariable()

bool inputNameForLocalVariable	(	QWidget *	parent,
		BinaryViewRef	data,
		FunctionRef	function,
		const BinaryNinja::Variable &	var )

inputNameForType()

bool inputNameForType	(	QWidget *	parent,
		std::string &	name,
		const QString &	title = "Set Name",
		const QString &	msg = "Enter name:" )

getNameAndTypeForDisplayName() [1/2]

std::optional< BinaryNinja::QualifiedNameAndType > getNameAndTypeForDisplayName	(	BinaryViewRef	data,
		const std::string &	displayName )

getNameAndTypeForDisplayName() [2/2]

std::optional< BinaryNinja::QualifiedNameAndType > getNameAndTypeForDisplayName	(	const BinaryNinja::TypeContainer &	container,
		const std::string &	displayName )

qualifiedNameForDisplayName()

BinaryNinja::QualifiedName qualifiedNameForDisplayName	(	BinaryViewRef	data,
		const std::string &	displayName )

renameTypeForToken()

bool renameTypeForToken	(	QWidget *	parent,
		BinaryViewRef	data,
		const std::string &	displayName )

InferArraySize()

bool InferArraySize	(	TypeRef &	type,
		size_t	selectionSize )

askForNewType()

bool askForNewType	(	QWidget *	parent,
		std::optional< BinaryNinja::TypeContainer >	container,
		const std::string &	title,
		bool	allowZeroSize,
		TypeRef &	type,
		BinaryNinja::QualifiedName &	name )

inputNewType()

bool inputNewType	(	QWidget *	parent,
		BinaryViewRef	data,
		FunctionRef	currentFunction,
		uint64_t	currentAddr,
		size_t	selectionSize,
		HighlightTokenState &	highlight )

createInferredMember()

bool createInferredMember	(	QWidget *	parent,
		BinaryViewRef	data,
		HighlightTokenState &	highlight,
		FunctionRef	func,
		const BinaryNinja::FunctionViewType &	ilType,
		size_t	instrIndex )

createStructMembers()

bool createStructMembers	(	QWidget *	parent,
		BinaryViewRef	data,
		HighlightTokenState &	highlight,
		FunctionRef	func )

inputPossibleValueSet()

bool inputPossibleValueSet	(	QWidget *	parent,
		BinaryViewRef	data,
		FunctionRef	currentFunction,
		const BinaryNinja::FunctionViewType &	funcType,
		const BinaryNinja::Variable &	var,
		size_t	ilInstructionIndex = BN_INVALID_EXPR )

inputUserVariableValue()

bool inputUserVariableValue	(	View *	parent,
		HighlightTokenState &	highlight )

eligibleForUserVariableValue()

bool eligibleForUserVariableValue	(	View *	parent,
		HighlightTokenState &	highlight )

clearUserVariableValue()

bool clearUserVariableValue	(	View *	parent,
		HighlightTokenState &	highlight )

eligibleToClearUserVariableValue()

bool eligibleToClearUserVariableValue	(	View *	parent,
		HighlightTokenState &	highlight )

forceVariableVersion()

bool forceVariableVersion	(	View *	parent,
		HighlightTokenState &	highlight )

eligibleToForceVariableVersion()

bool eligibleToForceVariableVersion	(	View *	parent,
		HighlightTokenState &	highlight )

clearVariableVersion()

bool clearVariableVersion	(	View *	parent,
		HighlightTokenState &	highlight )

eligibleToClearVariableVersion()

bool eligibleToClearVariableVersion	(	View *	parent,
		HighlightTokenState &	highlight )

getEnumSelection()

bool getEnumSelection	(	QWidget *	parent,
		BinaryViewRef	data,
		FunctionRef	func,
		uint64_t	constValue,
		TypeRef &	selectedEnum,
		bool	checkValue,
		bool	canTruncate )

overwriteCode() [1/2]

bool overwriteCode	(	BinaryViewRef	data,
		ArchitectureRef	arch,
		uint64_t	addr,
		size_t	len,
		const BinaryNinja::DataBuffer &	buffer )

overwriteCode() [2/2]

bool overwriteCode	(	BinaryViewRef	data,
		ArchitectureRef	arch,
		uint64_t	addr,
		const BinaryNinja::DataBuffer &	buffer )

getInnerMostStructureContaining()

StructureRef getInnerMostStructureContaining	(	BinaryViewRef	data,
		StructureRef	structure,
		size_t &	memberIndex,
		const std::vector< std::string > &	nameList,
		size_t	nameIndex,
		TypeRef &	type,
		BinaryNinja::QualifiedName &	typeName )

getInnerMostStructureContainingOffset()

StructureRef getInnerMostStructureContainingOffset	(	BinaryViewRef	data,
		StructureRef	structure,
		const std::vector< std::string > &	nameList,
		size_t	nameIndex,
		size_t	offset,
		TypeRef &	type,
		BinaryNinja::QualifiedName &	typeName )

getInnerMostStructureOffset()

uint64_t getInnerMostStructureOffset	(	BinaryViewRef	data,
		StructureRef	structure,
		const std::vector< std::string > &	nameList,
		size_t	nameIndex )

createStructureName()

std::string createStructureName	(	BinaryNinja::TypeContainer	types,
		const std::string &	prefix = "struct_" )

getSplitVariableForAssignment()

std::optional< BinaryNinja::Variable > getSplitVariableForAssignment	(	FunctionRef	func,
		const BinaryNinja::FunctionViewType &	ilType,
		uint64_t	location,
		const BinaryNinja::Variable &	var )

getVariableDefinitionInstructionIndex()

std::optional< size_t > getVariableDefinitionInstructionIndex	(	FunctionRef	func,
		const BinaryNinja::FunctionViewType &	funcType,
		const BinaryNinja::Variable &	var,
		size_t	ilInstructionIndex )

getVariableDefinitionAddress()

std::optional< size_t > getVariableDefinitionAddress	(	FunctionRef	func,
		const BinaryNinja::FunctionViewType &	funcType,
		const BinaryNinja::Variable &	var,
		size_t	ilInstructionIndex )

IsDefaultArgumentOrParameterName()

bool IsDefaultArgumentOrParameterName

(

const std::string &

name

)

GetVariableNameFromExpr()

std::optional< std::string > GetVariableNameFromExpr	(	BinaryNinja::Function *	func,
		const BinaryNinja::HighLevelILInstruction &	instr )

GetFunctionType()

TypeRef GetFunctionType	(	BinaryViewRef	data,
		TypeRef	type )

getFoldableExprAddress()

std::optional< uint64_t > getFoldableExprAddress	(	BinaryNinja::HighLevelILFunction *	hlil,
		const HighlightTokenState &	highlight )

getInvertableConditionAddress()

std::optional< uint64_t > getInvertableConditionAddress	(	BinaryNinja::HighLevelILFunction *	hlil,
		size_t	instrIndex )

getEarlyReturnAddress()

std::optional< uint64_t > getEarlyReturnAddress	(	BinaryNinja::HighLevelILFunction *	hlil,
		size_t	instrIndex )

getSwitchRecoveryAddress()

std::optional< uint64_t > getSwitchRecoveryAddress	(	BinaryNinja::HighLevelILFunction *	hlil,
		size_t	instrIndex )

resolveTargetWriteBinaryView()

BinaryViewWriteTarget resolveTargetWriteBinaryView	(	BinaryViewRef	view,
		uint64_t	addr )

updateBinaryViewMemoryMap()

void updateBinaryViewMemoryMap	(	BinaryViewRef	view,
		uint64_t	writeAddr,
		size_t	writeLen,
		uint64_t	dataOffset )