d6c1e0df08
CMake installs the "common headers" for Capstone into a capstone/
subdirectory of the system's includedir:
install(
FILES ${HEADERS_COMMON}
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/capstone
)
The pkg-config file, on the other hand, omits the subdirectory:
includedir=${prefix}/include
Cflags: -I${includedir}
This means that consumers of the library would need to include the
"capstone/" prefix when including those headers. For example,
#include <capstone/capstone.h>
rather than
#include <capstone.h>
Neither is "wrong" -- it's a design choice, but one that breaks the
public API when it changes. This has happened before:
https://github.com/capstone-engine/capstone/commit/0a39b785
https://github.com/capstone-engine/capstone/commit/02e33f8b
And (for example) PHP was updated to reflect that, i.e. to work with
capstone-4.x:
https://github.com/php/php-src/commit/ffc2a53a
But now in the 5.x series of Capstone, the path (or the -I flag,
relative to that path) has reverted,
https://github.com/capstone-engine/capstone/commit/6656bcb6
breaking PHP once again. This commit re-fixes it by updating the
directory passed via Cflags.
Closes: https://github.com/capstone-engine/capstone/issues/1982
|
||
|---|---|---|
| .github/workflows | ||
| arch | ||
| bindings | ||
| contrib | ||
| cstool | ||
| docs | ||
| include | ||
| msvc | ||
| packages | ||
| suite | ||
| tests | ||
| windows | ||
| windowsce | ||
| xcode | ||
| .appveyor.yml | ||
| .clang-format | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| capstone-config.cmake.in | ||
| capstone.pc.in | ||
| ChangeLog | ||
| cmake_uninstall.cmake.in | ||
| cmake.sh | ||
| CMakeLists.txt | ||
| CMakePresets.json | ||
| COMPILE_CMAKE.TXT | ||
| COMPILE_MSVC.TXT | ||
| COMPILE.TXT | ||
| config.mk | ||
| CREDITS.TXT | ||
| cs_priv.h | ||
| cs_simple_types.h | ||
| cs.c | ||
| functions.mk | ||
| HACK.TXT | ||
| LEB128.h | ||
| LICENSE_LLVM.TXT | ||
| LICENSE.TXT | ||
| make.sh | ||
| Makefile | ||
| Mapping.c | ||
| Mapping.h | ||
| MathExtras.h | ||
| MCDisassembler.h | ||
| MCFixedLenDisassembler.h | ||
| MCInst.c | ||
| MCInst.h | ||
| MCInstrDesc.c | ||
| MCInstrDesc.h | ||
| MCRegisterInfo.c | ||
| MCRegisterInfo.h | ||
| nmake.bat | ||
| pkgconfig.mk | ||
| README.md | ||
| RELEASE_NOTES | ||
| SPONSORS.TXT | ||
| SStream.c | ||
| SStream.h | ||
| TODO | ||
| utils.c | ||
| utils.h | ||
Capstone Engine
Capstone is a disassembly framework with the target of becoming the ultimate disasm engine for binary analysis and reversing in the security community.
Created by Nguyen Anh Quynh, then developed and maintained by a small community, Capstone offers some unparalleled features:
-
Support multiple hardware architectures: ARM, ARM64 (ARMv8), BPF, Ethereum VM, M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc, SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86 (16, 32, 64).
-
Having clean/simple/lightweight/intuitive architecture-neutral API.
-
Provide details on disassembled instruction (called “decomposer” by others).
-
Provide semantics of the disassembled instruction, such as list of implicit registers read & written.
-
Implemented in pure C language, with lightweight bindings for Swift, D, Clojure, F#, Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python, Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala ready either in main code, or provided externally by the community).
-
Native support for all popular platforms: Windows, Mac OSX, iOS, Android, Linux, *BSD, Solaris, etc.
-
Thread-safe by design.
-
Special support for embedding into firmware or OS kernel.
-
High performance & suitable for malware analysis (capable of handling various X86 malware tricks).
-
Distributed under the open source BSD license.
Further information is available at http://www.capstone-engine.org
Compile
See COMPILE.TXT file for how to compile and install Capstone.
Documentation
See docs/README for how to customize & program your own tools with Capstone.
Hack
See HACK.TXT file for the structure of the source code.
Fuzz
See suite/fuzz/README.md for more information.
License
This project is released under the BSD license. If you redistribute the binary or source code of Capstone, please attach file LICENSE.TXT with your products.