xref: /aosp_15_r20/external/capstone/bindings/ocaml/README (revision 9a0e4156d50a75a99ec4f1653a0e9602a5d45c18)
1*9a0e4156SSadaf EbrahimiTo compile Ocaml binding, Ocaml toolchain is needed. On Ubuntu Linux,
2*9a0e4156SSadaf Ebrahimiyou can install Ocaml with:
3*9a0e4156SSadaf Ebrahimi
4*9a0e4156SSadaf Ebrahimi    $ sudo apt-get install ocaml-nox
5*9a0e4156SSadaf Ebrahimi
6*9a0e4156SSadaf EbrahimiTo compile Ocaml binding, simply run "make" on the command line.
7*9a0e4156SSadaf Ebrahimi
8*9a0e4156SSadaf Ebrahimi
9*9a0e4156SSadaf EbrahimiThis directory also contains some test code to show how to use Capstone API.
10*9a0e4156SSadaf Ebrahimi
11*9a0e4156SSadaf Ebrahimi- test_basic.ml
12*9a0e4156SSadaf Ebrahimi  This code shows the most simple form of API where we only want to get basic
13*9a0e4156SSadaf Ebrahimi  information out of disassembled instruction, such as address, mnemonic and
14*9a0e4156SSadaf Ebrahimi  operand string.
15*9a0e4156SSadaf Ebrahimi
16*9a0e4156SSadaf Ebrahimi- test_detail.ml:
17*9a0e4156SSadaf Ebrahimi  This code shows how to access to architecture-neutral information in disassembled
18*9a0e4156SSadaf Ebrahimi  instructions, such as implicit registers read/written, or groups of instructions
19*9a0e4156SSadaf Ebrahimi  that this instruction belong to.
20*9a0e4156SSadaf Ebrahimi
21*9a0e4156SSadaf Ebrahimi- test_<arch>.ml
22*9a0e4156SSadaf Ebrahimi  These code show how to access architecture-specific information for each
23*9a0e4156SSadaf Ebrahimi  architecture.
24