Magic-Mirror/capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/capstone.git synced 2025-03-06 13:29:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add some comments on the availability of some APIs relying on detail = ON

Browse Source
This commit is contained in:
Nguyen Anh Quynh 2014-01-15 11:07:28 +08:00
parent 0941042274
commit 2f05ab2af5
1 changed files with 10 additions and 0 deletions

10
include/capstone.h

@ -317,6 +317,8 @@ const char *cs_insn_name(csh handle, unsigned int insn_id);
Find the group id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
Internally, this simply verifies if @group_id matches any member of insn->groups array.
NOTE: this API is only valid when detail option is ON (which is OFF by default)
@handle: handle returned by cs_open()
@insn: disassembled instruction structure received from cs_disasm() or cs_disasm_ex()
@group_id: group that you want to check if this instruction belong to.
@ -330,6 +332,8 @@ bool cs_insn_group(csh handle, cs_insn *insn, unsigned int group_id);
Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
Internally, this simply verifies if @reg_id matches any member of insn->regs_read array.
NOTE: this API is only valid when detail option is ON (which is OFF by default)
@insn: disassembled instruction structure received from cs_disasm() or cs_disasm_ex()
@reg_id: register that you want to check if this instruction used it.
@ -342,6 +346,8 @@ bool cs_reg_read(csh handle, cs_insn *insn, unsigned int reg_id);
Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
Internally, this simply verifies if @reg_id matches any member of insn->regs_write array.
NOTE: this API is only valid when detail option is ON (which is OFF by default)
@insn: disassembled instruction structure received from cs_disasm() or cs_disasm_ex()
@reg_id: register that you want to check if this instruction modified it.
@ -353,6 +359,8 @@ bool cs_reg_write(csh handle, cs_insn *insn, unsigned int reg_id);
Count the number of operands of a given type.
Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
NOTE: this API is only valid when detail option is ON (which is OFF by default)
@handle: handle returned by cs_open()
@insn: disassembled instruction structure received from cs_disasm() or cs_disasm_ex()
@op_type: Operand type to be found.
@ -367,6 +375,8 @@ int cs_op_count(csh handle, cs_insn *insn, unsigned int op_type);
Later, the operand can be accessed using the returned position.
Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
NOTE: this API is only valid when detail option is ON (which is OFF by default)
@handle: handle returned by cs_open()
@insn: disassembled instruction structure received from cs_disasm() or cs_disasm_ex()
@op_type: Operand type to be found.