import enum
[docs]
class ActionType(enum.IntEnum):
TemporaryAction = 0
DataModificationAction = 1
AnalysisAction = 2
DataModificationAndAnalysisAction = 3
[docs]
class AnalysisMode(enum.IntEnum):
FullAnalysisMode = 0
IntermediateAnalysisMode = 1
BasicAnalysisMode = 2
ControlFlowAnalysisMode = 3
[docs]
class AnalysisSkipReason(enum.IntEnum):
NoSkipReason = 0
AlwaysSkipReason = 1
ExceedFunctionSizeSkipReason = 2
ExceedFunctionAnalysisTimeSkipReason = 3
ExceedFunctionUpdateCountSkipReason = 4
NewAutoFunctionAnalysisSuppressedReason = 5
BasicAnalysisSkipReason = 6
IntermediateAnalysisSkipReason = 7
AnalysisPipelineSuspendedReason = 8
[docs]
class AnalysisState(enum.IntEnum):
InitialState = 0
HoldState = 1
IdleState = 2
DiscoveryState = 3
DisassembleState = 4
AnalyzeState = 5
ExtendedAnalyzeState = 6
[docs]
class AnalysisWarningActionType(enum.IntEnum):
NoAnalysisWarningAction = 0
ForceAnalysisWarningAction = 1
ShowStackGraphWarningAction = 2
DisableGuidedAnalysisWarningAction = 3
[docs]
class BaseAddressDetectionConfidence(enum.IntEnum):
NoConfidence = 0
LowConfidence = 1
HighConfidence = 2
[docs]
class BaseAddressDetectionPOISetting(enum.IntEnum):
POIAnalysisStringsOnly = 0
POIAnalysisFunctionsOnly = 1
POIAnalysisAll = 2
[docs]
class BaseAddressDetectionPOIType(enum.IntEnum):
POIString = 0
POIFunction = 1
POIDataVariable = 2
POIFileStart = 3
POIFileEnd = 4
[docs]
class BinaryViewEventType(enum.IntEnum):
BinaryViewFinalizationEvent = 0
BinaryViewInitialAnalysisCompletionEvent = 1
[docs]
class BraceRequirement(enum.IntEnum):
OptionalBraces = 0
BracesNotAllowed = 1
BracesAlwaysRequired = 2
[docs]
class BranchType(enum.IntEnum):
UnconditionalBranch = 0
FalseBranch = 1
TrueBranch = 2
CallDestination = 3
FunctionReturn = 4
SystemCall = 5
IndirectBranch = 6
ExceptionBranch = 7
UnresolvedBranch = 127
UserDefinedBranch = 128
[docs]
class BuiltinType(enum.IntEnum):
BuiltinNone = 0
BuiltinMemcpy = 1
BuiltinMemset = 2
BuiltinStrncpy = 3
BuiltinStrcpy = 4
BuiltinWcscpy = 5
BuiltinWmemcpy = 6
[docs]
class CallingConventionName(enum.IntEnum):
NoCallingConvention = 0
CdeclCallingConvention = 1
PascalCallingConvention = 2
ThisCallCallingConvention = 3
STDCallCallingConvention = 4
FastcallCallingConvention = 5
CLRCallCallingConvention = 6
EabiCallCallingConvention = 7
VectorCallCallingConvention = 8
SwiftCallingConvention = 9
SwiftAsyncCallingConvention = 10
[docs]
class CollaborationPermissionLevel(enum.IntEnum):
AdminPermission = 1
EditPermission = 2
ViewPermission = 3
[docs]
class DataFlowQueryOption(enum.IntEnum):
FromAddressesInLookupTableQueryOption = 0
AllowReadingWritableMemoryQueryOption = 1
[docs]
class DeadStoreElimination(enum.IntEnum):
DefaultDeadStoreElimination = 0
PreventDeadStoreElimination = 1
AllowDeadStoreElimination = 2
[docs]
class DerivedStringLocationType(enum.IntEnum):
DataBackedStringLocation = 0
CodeStringLocation = 1
[docs]
class DisassemblyAddressMode(enum.IntEnum):
AbsoluteDisassemblyAddressMode = 0
RelativeToBinaryStartDisassemblyAddressMode = 1
RelativeToSegmentStartDisassemblyAddressMode = 2
RelativeToSectionStartDisassemblyAddressMode = 3
RelativeToFunctionStartDisassemblyAddressMode = 4
RelativeToAddressBaseOffsetDisassemblyAddressMode = 5
RelativeToDataStartDisassemblyAddressMode = 6
DisassemblyAddressModeMask = 65535
IncludeNameDisassemblyAddressModeFlag = 65536
DecimalDisassemblyAddressModeFlag = 131072
DisassemblyAddressModeFlagsMask = -65536
[docs]
class DisassemblyBlockLabels(enum.IntEnum):
NeverShowDefaultBlockLabels = 0
AlwaysShowBlockLabels = 1
NeverShowBlockLabels = 2
[docs]
class DisassemblyCallParameterHints(enum.IntEnum):
NeverShowMatchingParameterHints = 0
AlwaysShowParameterHints = 1
NeverShowParameterHints = 2
[docs]
class DisassemblyOption(enum.IntEnum):
ShowAddress = 0
ShowOpcode = 1
ExpandLongOpcode = 2
ShowVariablesAtTopOfGraph = 3
ShowVariableTypesWhenAssigned = 4
ShowRegisterHighlight = 7
ShowFunctionAddress = 8
ShowFunctionHeader = 9
ShowTypeCasts = 10
GroupLinearDisassemblyFunctions = 64
HighLevelILLinearDisassembly = 65
WaitForIL = 66
IndentHLILBody = 67
DisableLineFormatting = 68
ShowFlagUsage = 128
ShowStackPointer = 129
ShowILTypes = 130
ShowILOpcodes = 131
ShowCollapseIndicators = 132
[docs]
class EarlyReturn(enum.IntEnum):
DefaultEarlyReturn = 0
PreventEarlyReturn = 1
SmallestSideEarlyReturn = 2
TrueSideEarlyReturn = 3
FalseSideEarlyReturn = 4
[docs]
class EdgePenStyle(enum.IntEnum):
NoPen = 0
SolidLine = 1
DashLine = 2
DotLine = 3
DashDotLine = 4
DashDotDotLine = 5
[docs]
class Endianness(enum.IntEnum):
LittleEndian = 0
BigEndian = 1
[docs]
class ExprFolding(enum.IntEnum):
DefaultExprFolding = 0
PreventExprFolding = 1
AllowExprFolding = 2
[docs]
class FindFlag(enum.IntEnum):
FindCaseSensitive = 0
FindCaseInsensitive = 1
FindIgnoreWhitespace = 2
[docs]
class FindRangeType(enum.IntEnum):
AllRangeType = 0
CustomRangeType = 1
CurrentFunctionRangeType = 2
[docs]
class FindType(enum.IntEnum):
FindTypeRawString = 0
FindTypeEscapedString = 1
FindTypeText = 2
FindTypeConstant = 3
FindTypeBytes = 4
[docs]
class FirmwareNinjaMemoryAccessType(enum.IntEnum):
NoMemoryAccessType = 0
ReadMemoryAccessType = 1
WriteMemoryAccessType = 2
[docs]
class FirmwareNinjaMemoryHeuristic(enum.IntEnum):
NoMemoryHeuristic = 0
HasReadBarrierMemoryHeuristic = 1
HasWriteBarrierMemoryHeuristic = 2
StoreToOOBMemoryMemoryHeuristic = 3
LoadFromOOBMemoryMemoryHeuristic = 4
RepeatLoadStoreMemoryHeuristic = 5
CallParamOOBPointerMemoryHeuristic = 6
[docs]
class FirmwareNinjaSectionAnalysisMode(enum.IntEnum):
DefaultSectionAnalysisMode = 0
IgnorePaddingSectionAnalysisMode = 1
DetectStringsSectionAnalysisMode = 2
[docs]
class FirmwareNinjaSectionType(enum.IntEnum):
CodeSectionType = 0
DataSectionType = 1
CompressionSectionType = 2
PaddingSectionType = 3
[docs]
class FlagRole(enum.IntEnum):
SpecialFlagRole = 0
ZeroFlagRole = 1
PositiveSignFlagRole = 2
NegativeSignFlagRole = 3
CarryFlagRole = 4
OverflowFlagRole = 5
HalfCarryFlagRole = 6
EvenParityFlagRole = 7
OddParityFlagRole = 8
OrderedFlagRole = 9
UnorderedFlagRole = 10
CarryFlagWithInvertedSubtractRole = 11
[docs]
class FlowGraphOption(enum.IntEnum):
FlowGraphUsesBlockHighlights = 0
FlowGraphUsesInstructionHighlights = 1
FlowGraphIncludesUserComments = 2
FlowGraphAllowsPatching = 3
FlowGraphAllowsInlineInstructionEditing = 4
FlowGraphShowsSecondaryRegisterHighlighting = 5
FlowGraphIsAddressable = 6
FlowGraphIsWorkflowGraph = 7
[docs]
class FunctionAnalysisSkipOverride(enum.IntEnum):
DefaultFunctionAnalysisSkip = 0
NeverSkipFunctionAnalysis = 1
AlwaysSkipFunctionAnalysis = 2
[docs]
class FunctionGraphType(enum.IntEnum):
InvalidILViewType = -1
NormalFunctionGraph = 0
LowLevelILFunctionGraph = 1
LiftedILFunctionGraph = 2
LowLevelILSSAFormFunctionGraph = 3
MediumLevelILFunctionGraph = 4
MediumLevelILSSAFormFunctionGraph = 5
MappedMediumLevelILFunctionGraph = 6
MappedMediumLevelILSSAFormFunctionGraph = 7
HighLevelILFunctionGraph = 8
HighLevelILSSAFormFunctionGraph = 9
HighLevelLanguageRepresentationFunctionGraph = 10
[docs]
class FunctionUpdateType(enum.IntEnum):
UserFunctionUpdate = 0
FullAutoFunctionUpdate = 1
IncrementalAutoFunctionUpdate = 2
[docs]
class HighLevelILOperation(enum.IntEnum):
HLIL_NOP = 0
HLIL_BLOCK = 1
HLIL_IF = 2
HLIL_WHILE = 3
HLIL_DO_WHILE = 4
HLIL_FOR = 5
HLIL_SWITCH = 6
HLIL_CASE = 7
HLIL_BREAK = 8
HLIL_CONTINUE = 9
HLIL_JUMP = 10
HLIL_RET = 11
HLIL_NORET = 12
HLIL_GOTO = 13
HLIL_LABEL = 14
HLIL_VAR_DECLARE = 15
HLIL_VAR_INIT = 16
HLIL_ASSIGN = 17
HLIL_ASSIGN_UNPACK = 18
HLIL_FORCE_VER = 19
HLIL_ASSERT = 20
HLIL_VAR = 21
HLIL_STRUCT_FIELD = 22
HLIL_ARRAY_INDEX = 23
HLIL_SPLIT = 24
HLIL_DEREF = 25
HLIL_DEREF_FIELD = 26
HLIL_ADDRESS_OF = 27
HLIL_CONST = 28
HLIL_CONST_DATA = 29
HLIL_CONST_PTR = 30
HLIL_EXTERN_PTR = 31
HLIL_FLOAT_CONST = 32
HLIL_IMPORT = 33
HLIL_ADD = 34
HLIL_ADC = 35
HLIL_SUB = 36
HLIL_SBB = 37
HLIL_AND = 38
HLIL_OR = 39
HLIL_XOR = 40
HLIL_LSL = 41
HLIL_LSR = 42
HLIL_ASR = 43
HLIL_ROL = 44
HLIL_RLC = 45
HLIL_ROR = 46
HLIL_RRC = 47
HLIL_MUL = 48
HLIL_MULU_DP = 49
HLIL_MULS_DP = 50
HLIL_DIVU = 51
HLIL_DIVU_DP = 52
HLIL_DIVS = 53
HLIL_DIVS_DP = 54
HLIL_MODU = 55
HLIL_MODU_DP = 56
HLIL_MODS = 57
HLIL_MODS_DP = 58
HLIL_NEG = 59
HLIL_NOT = 60
HLIL_SX = 61
HLIL_ZX = 62
HLIL_LOW_PART = 63
HLIL_CALL = 64
HLIL_CMP_E = 65
HLIL_CMP_NE = 66
HLIL_CMP_SLT = 67
HLIL_CMP_ULT = 68
HLIL_CMP_SLE = 69
HLIL_CMP_ULE = 70
HLIL_CMP_SGE = 71
HLIL_CMP_UGE = 72
HLIL_CMP_SGT = 73
HLIL_CMP_UGT = 74
HLIL_TEST_BIT = 75
HLIL_BOOL_TO_INT = 76
HLIL_ADD_OVERFLOW = 77
HLIL_SYSCALL = 78
HLIL_TAILCALL = 79
HLIL_INTRINSIC = 80
HLIL_BP = 81
HLIL_TRAP = 82
HLIL_UNDEF = 83
HLIL_UNIMPL = 84
HLIL_UNIMPL_MEM = 85
HLIL_FADD = 86
HLIL_FSUB = 87
HLIL_FMUL = 88
HLIL_FDIV = 89
HLIL_FSQRT = 90
HLIL_FNEG = 91
HLIL_FABS = 92
HLIL_FLOAT_TO_INT = 93
HLIL_INT_TO_FLOAT = 94
HLIL_FLOAT_CONV = 95
HLIL_ROUND_TO_INT = 96
HLIL_FLOOR = 97
HLIL_CEIL = 98
HLIL_FTRUNC = 99
HLIL_FCMP_E = 100
HLIL_FCMP_NE = 101
HLIL_FCMP_LT = 102
HLIL_FCMP_LE = 103
HLIL_FCMP_GE = 104
HLIL_FCMP_GT = 105
HLIL_FCMP_O = 106
HLIL_FCMP_UO = 107
HLIL_UNREACHABLE = 108
HLIL_WHILE_SSA = 109
HLIL_DO_WHILE_SSA = 110
HLIL_FOR_SSA = 111
HLIL_VAR_INIT_SSA = 112
HLIL_ASSIGN_MEM_SSA = 113
HLIL_ASSIGN_UNPACK_MEM_SSA = 114
HLIL_FORCE_VER_SSA = 115
HLIL_ASSERT_SSA = 116
HLIL_VAR_SSA = 117
HLIL_ARRAY_INDEX_SSA = 118
HLIL_DEREF_SSA = 119
HLIL_DEREF_FIELD_SSA = 120
HLIL_CALL_SSA = 121
HLIL_SYSCALL_SSA = 122
HLIL_INTRINSIC_SSA = 123
HLIL_VAR_PHI = 124
HLIL_MEM_PHI = 125
[docs]
class HighlightColorStyle(enum.IntEnum):
StandardHighlightColor = 0
MixedHighlightColor = 1
CustomHighlightColor = 2
[docs]
class HighlightStandardColor(enum.IntEnum):
NoHighlightColor = 0
BlueHighlightColor = 1
GreenHighlightColor = 2
CyanHighlightColor = 3
RedHighlightColor = 4
MagentaHighlightColor = 5
YellowHighlightColor = 6
OrangeHighlightColor = 7
WhiteHighlightColor = 8
BlackHighlightColor = 9
[docs]
class ILBranchDependence(enum.IntEnum):
NotBranchDependent = 0
TrueBranchDependent = 1
FalseBranchDependent = 2
[docs]
class ILInstructionAttribute(enum.IntEnum):
ILAllowDeadStoreElimination = 1
ILPreventDeadStoreElimination = 2
MLILAssumePossibleUse = 4
MLILUnknownSize = 8
SrcInstructionUsesPointerAuth = 16
ILPreventAliasAnalysis = 32
ILIsCFGProtected = 64
MLILPossiblyUnusedIntermediate = 128
HLILFoldableExpr = 256
HLILInvertableCondition = 512
HLILEarlyReturnPossible = 1024
HLILSwitchRecoveryPossible = 2048
ILTransparentCopy = 4096
[docs]
class ImplicitRegisterExtend(enum.IntEnum):
NoExtend = 0
ZeroExtendToFullWidth = 1
SignExtendToFullWidth = 2
[docs]
class InstructionTextTokenContext(enum.IntEnum):
NoTokenContext = 0
LocalVariableTokenContext = 1
DataVariableTokenContext = 2
FunctionReturnTokenContext = 3
InstructionAddressTokenContext = 4
ILInstructionIndexTokenContext = 5
ConstDataTokenContext = 6
ConstStringDataTokenContext = 7
StringReferenceTokenContext = 8
StringDataVariableTokenContext = 9
StringDisplayTokenContext = 10
ContentCollapsedContext = 11
ContentExpandedContext = 12
ContentCollapsiblePadding = 13
DerivedStringReferenceTokenContext = 14
[docs]
class InstructionTextTokenType(enum.IntEnum):
TextToken = 0
InstructionToken = 1
OperandSeparatorToken = 2
RegisterToken = 3
IntegerToken = 4
PossibleAddressToken = 5
BeginMemoryOperandToken = 6
EndMemoryOperandToken = 7
FloatingPointToken = 8
AnnotationToken = 9
CodeRelativeAddressToken = 10
ArgumentNameToken = 11
HexDumpByteValueToken = 12
HexDumpSkippedByteToken = 13
HexDumpInvalidByteToken = 14
HexDumpTextToken = 15
OpcodeToken = 16
StringToken = 17
CharacterConstantToken = 18
KeywordToken = 19
TypeNameToken = 20
FieldNameToken = 21
NameSpaceToken = 22
NameSpaceSeparatorToken = 23
TagToken = 24
StructOffsetToken = 25
StructOffsetByteValueToken = 26
StructureHexDumpTextToken = 27
GotoLabelToken = 28
CommentToken = 29
PossibleValueToken = 30
PossibleValueTypeToken = 31
ArrayIndexToken = 32
IndentationToken = 33
UnknownMemoryToken = 34
EnumerationMemberToken = 35
OperationToken = 36
BaseStructureNameToken = 37
BaseStructureSeparatorToken = 38
BraceToken = 39
CodeSymbolToken = 64
DataSymbolToken = 65
LocalVariableToken = 66
ImportToken = 67
AddressDisplayToken = 68
IndirectImportToken = 69
ExternalSymbolToken = 70
StackVariableToken = 71
AddressSeparatorToken = 72
CollapsedInformationToken = 73
CollapseStateIndicatorToken = 74
NewLineToken = 75
[docs]
class IntegerDisplayType(enum.IntEnum):
DefaultIntegerDisplayType = 0
BinaryDisplayType = 1
SignedOctalDisplayType = 2
UnsignedOctalDisplayType = 3
SignedDecimalDisplayType = 4
UnsignedDecimalDisplayType = 5
SignedHexadecimalDisplayType = 6
UnsignedHexadecimalDisplayType = 7
CharacterConstantDisplayType = 8
PointerDisplayType = 9
FloatDisplayType = 10
DoubleDisplayType = 11
EnumerationDisplayType = 12
InvertedCharacterConstantDisplayType = 13
[docs]
class IntrinsicClass(enum.IntEnum):
GeneralIntrinsicClass = 0
MemoryIntrinsicClass = 1
[docs]
class LinearDisassemblyLineType(enum.IntEnum):
BlankLineType = 0
BasicLineType = 1
CodeDisassemblyLineType = 2
DataVariableLineType = 3
HexDumpLineType = 4
FunctionHeaderLineType = 5
FunctionHeaderStartLineType = 6
FunctionHeaderEndLineType = 7
FunctionContinuationLineType = 8
LocalVariableLineType = 9
LocalVariableListEndLineType = 10
FunctionEndLineType = 11
NoteStartLineType = 12
NoteLineType = 13
NoteEndLineType = 14
SectionStartLineType = 15
SectionEndLineType = 16
SectionSeparatorLineType = 17
NonContiguousSeparatorLineType = 18
AnalysisWarningLineType = 19
CollapsedFunctionEndLineType = 20
[docs]
class LinearViewObjectIdentifierType(enum.IntEnum):
SingleLinearViewObject = 0
AddressLinearViewObject = 1
AddressRangeLinearViewObject = 2
[docs]
class LogLevel(enum.IntEnum):
DebugLog = 0
InfoLog = 1
WarningLog = 2
ErrorLog = 3
AlertLog = 4
[docs]
class LowLevelILFlagCondition(enum.IntEnum):
LLFC_E = 0
LLFC_NE = 1
LLFC_SLT = 2
LLFC_ULT = 3
LLFC_SLE = 4
LLFC_ULE = 5
LLFC_SGE = 6
LLFC_UGE = 7
LLFC_SGT = 8
LLFC_UGT = 9
LLFC_NEG = 10
LLFC_POS = 11
LLFC_O = 12
LLFC_NO = 13
LLFC_FE = 14
LLFC_FNE = 15
LLFC_FLT = 16
LLFC_FLE = 17
LLFC_FGE = 18
LLFC_FGT = 19
LLFC_FO = 20
LLFC_FUO = 21
[docs]
class LowLevelILOperation(enum.IntEnum):
LLIL_NOP = 0
LLIL_SET_REG = 1
LLIL_SET_REG_SPLIT = 2
LLIL_SET_FLAG = 3
LLIL_SET_REG_STACK_REL = 4
LLIL_REG_STACK_PUSH = 5
LLIL_ASSERT = 6
LLIL_FORCE_VER = 7
LLIL_LOAD = 8
LLIL_STORE = 9
LLIL_PUSH = 10
LLIL_POP = 11
LLIL_REG = 12
LLIL_REG_SPLIT = 13
LLIL_REG_STACK_REL = 14
LLIL_REG_STACK_POP = 15
LLIL_REG_STACK_FREE_REG = 16
LLIL_REG_STACK_FREE_REL = 17
LLIL_CONST = 18
LLIL_CONST_PTR = 19
LLIL_EXTERN_PTR = 20
LLIL_FLOAT_CONST = 21
LLIL_FLAG = 22
LLIL_FLAG_BIT = 23
LLIL_ADD = 24
LLIL_ADC = 25
LLIL_SUB = 26
LLIL_SBB = 27
LLIL_AND = 28
LLIL_OR = 29
LLIL_XOR = 30
LLIL_LSL = 31
LLIL_LSR = 32
LLIL_ASR = 33
LLIL_ROL = 34
LLIL_RLC = 35
LLIL_ROR = 36
LLIL_RRC = 37
LLIL_MUL = 38
LLIL_MULU_DP = 39
LLIL_MULS_DP = 40
LLIL_DIVU = 41
LLIL_DIVU_DP = 42
LLIL_DIVS = 43
LLIL_DIVS_DP = 44
LLIL_MODU = 45
LLIL_MODU_DP = 46
LLIL_MODS = 47
LLIL_MODS_DP = 48
LLIL_NEG = 49
LLIL_NOT = 50
LLIL_SX = 51
LLIL_ZX = 52
LLIL_LOW_PART = 53
LLIL_JUMP = 54
LLIL_JUMP_TO = 55
LLIL_CALL = 56
LLIL_CALL_STACK_ADJUST = 57
LLIL_TAILCALL = 58
LLIL_RET = 59
LLIL_NORET = 60
LLIL_IF = 61
LLIL_GOTO = 62
LLIL_FLAG_COND = 63
LLIL_FLAG_GROUP = 64
LLIL_CMP_E = 65
LLIL_CMP_NE = 66
LLIL_CMP_SLT = 67
LLIL_CMP_ULT = 68
LLIL_CMP_SLE = 69
LLIL_CMP_ULE = 70
LLIL_CMP_SGE = 71
LLIL_CMP_UGE = 72
LLIL_CMP_SGT = 73
LLIL_CMP_UGT = 74
LLIL_TEST_BIT = 75
LLIL_BOOL_TO_INT = 76
LLIL_ADD_OVERFLOW = 77
LLIL_SYSCALL = 78
LLIL_BP = 79
LLIL_TRAP = 80
LLIL_INTRINSIC = 81
LLIL_UNDEF = 82
LLIL_UNIMPL = 83
LLIL_UNIMPL_MEM = 84
LLIL_FADD = 85
LLIL_FSUB = 86
LLIL_FMUL = 87
LLIL_FDIV = 88
LLIL_FSQRT = 8