[Enhancement] Add an installable CMake library package

Aperta
#12 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
cmake, cpp
Ambito
build-system

Direzione di ricerca

Start in CMakeLists.txt, which defines caraxes_elf, caraxes_disasm, caraxes_analysis, caraxes_decompiler and the CLI targets but has no install() or export rules, then read the public headers that expose elf::parse_file, disasm::disassemble and analysis::analyze. Done means a temporary-prefix install works, find_package(Caraxes CONFIG REQUIRED) resolves the namespaced targets, a consumer example builds against the installed package, and the in-tree build and CLI executables still pass.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Summary

Provide an installable CMake package and documented reusable-library API so applications can embed Caraxes without copying the repository or linking against build-tree paths.

Current state

CMakeLists.txt defines the layered libraries (caraxes_elf, caraxes_disasm, caraxes_analysis, and caraxes_decompiler) and CLI executables, but it has no install() rules, exported targets, package configuration, installed public headers, or consumer example. The README documents only in-tree build outputs under build/.

The public headers already expose useful value types and entry points, including elf::parse_file, disasm::disassemble, and analysis::analyze, so downstream tooling currently has to depend on the source layout and build directory.

Proposed capability

Add a supported installation and packaging surface:

  • Install CLI binaries and public headers under standard prefixes.
  • Export namespaced targets such as Caraxes::ELF, Caraxes::Disasm, Caraxes::Analysis, and Caraxes::Decompiler.
  • Generate a versioned CaraxesConfig.cmake/CaraxesConfigVersion.cmake package, with Capstone represented as a transitive dependency.
  • Provide a clear static/shared-library option and preserve the existing command-line targets.
  • Separate or document stable public headers from implementation-only headers.
  • Add a minimal external-consumer example that loads an ELF, disassembles a section, and runs analysis.

Acceptance criteria

  • A clean external project can run find_package(Caraxes CONFIG REQUIRED) and link a documented target without referring to the source or build tree.
  • The installed package works with both a system Capstone installation discovered through the package configuration and the supported fallback discovery path.
  • Installed headers and exported targets match the documented API and version.
  • CI/test coverage installs the package into a temporary prefix and builds the consumer example against it.
  • Existing in-tree builds and all three CLI executables continue to work.
Lingua principale
C++
Stelle
0
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TiElixir/caraxes

Tutte le issue di TiElixir/caraxes

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.