summaryrefslogtreecommitdiff
path: root/ui/commands.h
blob: 72ede767be842ed20f471cf0a346352c4b42ba57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
#pragma once

#include <QtWidgets/QWidget>
#include "binaryninjaapi.h"
#include "render.h"
#include "uicontext.h"

/*!
    @addtogroup commands
    \ingroup uiapi
    @{
*/

bool BINARYNINJAUIAPI undefineForAddress(BinaryViewRef data, uint64_t addr);
bool BINARYNINJAUIAPI undefineNameForAddress(BinaryViewRef data, uint64_t addr);
bool BINARYNINJAUIAPI undefineNameForLocalVariable(
    BinaryViewRef data, FunctionRef func, const BinaryNinja::Variable& var);
bool BINARYNINJAUIAPI inputNameForAddress(QWidget* parent, BinaryViewRef data, uint64_t addr);
bool BINARYNINJAUIAPI inputNameForLocalVariable(
    QWidget* parent, BinaryViewRef data, FunctionRef function, const BinaryNinja::Variable& var);
bool BINARYNINJAUIAPI inputNameForType(
    QWidget* parent, std::string& name, const QString& title = "Set Name", const QString& msg = "Enter name:");

bool BINARYNINJAUIAPI InferArraySize(TypeRef& type, size_t selectionSize);
bool BINARYNINJAUIAPI askForNewType(QWidget* parent, std::optional<BinaryNinja::TypeContainer> container, const std::string& title,
    bool allowZeroSize, TypeRef& type, BinaryNinja::QualifiedName& name);
bool BINARYNINJAUIAPI inputNewType(QWidget* parent, BinaryViewRef data, FunctionRef currentFunction,
    uint64_t currentAddr, size_t selectionSize, HighlightTokenState& highlight);
bool BINARYNINJAUIAPI createInferredMember(QWidget* parent, BinaryViewRef data, HighlightTokenState& highlight,
    FunctionRef func, const BinaryNinja::FunctionViewType& ilType, size_t instrIndex);
bool BINARYNINJAUIAPI createStructMembers(
    QWidget* parent, BinaryViewRef data, HighlightTokenState& highlight, FunctionRef func);

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


bool BINARYNINJAUIAPI inputUserVariableValue(View* parent, HighlightTokenState& highlight);
bool BINARYNINJAUIAPI eligibleForUserVariableValue(View* parent, HighlightTokenState& highlight);

bool BINARYNINJAUIAPI clearUserVariableValue(View* parent, HighlightTokenState& highlight);
bool BINARYNINJAUIAPI eligibleToClearUserVariableValue(View* parent, HighlightTokenState& highlight);

bool BINARYNINJAUIAPI forceVariableVersion(View* parent, HighlightTokenState& highlight);
bool BINARYNINJAUIAPI eligibleToForceVariableVersion(View* parent, HighlightTokenState& highlight);

bool BINARYNINJAUIAPI clearVariableVersion(View* parent, HighlightTokenState& highlight);
bool BINARYNINJAUIAPI eligibleToClearVariableVersion(View* parent, HighlightTokenState& highlight);

struct BINARYNINJAUIAPI FieldResolutionState
{
	std::vector<std::pair<std::string, FieldResolutionInfoRef>> goodFieldResolutions = {};
	std::vector<std::pair<std::string, FieldResolutionInfoRef>> badFieldResolutions = {};

	size_t registeredGoodFieldResolutions = 0;
	size_t registeredBadFieldResolutions = 0;

	void bindDynamicActions(View* view, HighlightTokenState& highlight);
};

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

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

StructureRef BINARYNINJAUIAPI getInnerMostStructureContaining(BinaryViewRef data, StructureRef structure,
    size_t& memberIndex, const std::vector<std::string>& nameList, size_t nameIndex, TypeRef& type,
    std::string& typeName);
StructureRef BINARYNINJAUIAPI getInnerMostStructureContainingOffset(BinaryViewRef data, StructureRef structure,
    const std::vector<std::string>& nameList, size_t nameIndex, size_t offset, TypeRef& type, std::string& typeName);
// Get the offset of the inner most structure, ralative to the supplied outer most structure
uint64_t BINARYNINJAUIAPI getInnerMostStructureOffset(
    BinaryViewRef data, StructureRef structure, const std::vector<std::string>& nameList, size_t nameIndex);

// Auto generate a usable type name with the given prefix
std::string BINARYNINJAUIAPI createStructureName(BinaryNinja::TypeContainer types, const std::string& prefix = "struct_");

std::optional<BinaryNinja::Variable> BINARYNINJAUIAPI 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);

// Return a function type for a given type. The input type can be a function type itself, or a pointer to a function
// type, or a NTR to a pointer to a function type. This is used when the user set the type of function using a
// typedef-ed type
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);


struct BINARYNINJAUIAPI BinaryViewWriteTarget
{
	BinaryViewRef view;
	uint64_t address;
	bool updateMemoryMap;
};

BinaryViewWriteTarget BINARYNINJAUIAPI resolveTargetWriteBinaryView(BinaryViewRef view, uint64_t addr);
void BINARYNINJAUIAPI updateBinaryViewMemoryMap(BinaryViewRef view, uint64_t writeAddr, size_t writeLen, uint64_t dataOffset);

/*!
    @}
*/