Skip to content

Latest commit

 

History

History
54 lines (50 loc) · 5.29 KB

api_reference.md

File metadata and controls

54 lines (50 loc) · 5.29 KB

idax API Reference Index

Public headers:

Header Description
include/ida/idax.hpp Master include — pulls in all domain headers
include/ida/error.hpp Error model: Result<T>, Status, Error, ErrorCategory
include/ida/core.hpp Shared option structs and cross-cutting type aliases
include/ida/diagnostics.hpp Logging levels, counters, diagnostic message helpers
include/ida/address.hpp Address predicates, item traversal, range iteration, predicate search
include/ida/data.hpp Read/write/patch/define bytes, typed values, string extraction, binary pattern search
include/ida/database.hpp Open/save/close, runtime/plugin policy init options, metadata (file type/compiler/imports/processor+ABI/endian), snapshots, file/memory transfer
include/ida/segment.hpp Segment CRUD, properties, permissions, iteration, default segment-register seeding
include/ida/function.hpp Function CRUD, chunks, frames, register variables, callers/callees, outlined-flag helpers
include/ida/instruction.hpp Decode/create, operand access + structured operand metadata (byte_width, register_name, register_category), representation controls (including struct-offset helpers), xref conveniences
include/ida/name.hpp Set/get/force/remove names, demangling, resolution, properties
include/ida/xref.hpp Unified reference model, typed code/data refs, add/remove/enumerate
include/ida/comment.hpp Regular/repeatable comments, anterior/posterior lines, bulk operations
include/ida/search.hpp Text (with regex), immediate, binary pattern, structural search
include/ida/analysis.hpp Auto-analysis control, scheduling, waiting
include/ida/lumina.hpp Lumina connection helpers and metadata pull/push wrappers
include/ida/type.hpp Type construction, structs/unions/members, apply/retrieve, type libraries (ensure_named_type, import/apply named helpers)
include/ida/entry.hpp Entry point enumeration, add/rename, forwarders
include/ida/fixup.hpp Fixup descriptors, traversal, custom fixup handlers
include/ida/plugin.hpp Plugin base class, action registration, menu/toolbar/popup attachment, action-context host bridges
include/ida/loader.hpp Loader base class, InputFile abstraction, registration macro
include/ida/processor.hpp Processor base class, typed analysis details, tokenized output context, switch detection
include/ida/debugger.hpp Process lifecycle, backend discovery/selection, breakpoints, memory, registers, appcall/executor APIs, typed event subscriptions
include/ida/ui.hpp Messages, dialogs, choosers, timers, UI event subscriptions
include/ida/graph.hpp Graph objects, node/edge CRUD, flow charts, basic blocks
include/ida/event.hpp Typed IDB subscriptions, generic filtering/routing, RAII guards
include/ida/decompiler.hpp Decompile (with structured failure details), pseudocode/microcode extraction, maturity subscriptions, cache-dirty helpers, typed decompiler-view sessions (DecompilerView, view_from_host, view_for_function, current_view), microcode-filter registration, typed instruction/operand emission (including nested/block/local-variable forms), policy-aware low-level emits, microblock lifecycle helpers (block_instruction_count, has_instruction_at_index, remove_instruction_at_index, tracked last-emitted query/remove), microcode introspection (instruction, instruction_at_index, last_emitted_instruction), typed helper-call builders (register/operand/micro-operand destinations), and advanced call-shaping/location hints (calling convention, role, return location/type, register-list + visible-memory controls).
include/ida/lines.hpp Tagged text/color helpers (colstr, tag_remove, tag_advance, tag_strlen, address-tag encode/decode) used by decompiler/listing filters
include/ida/storage.hpp Netnode abstraction, alt/sup/hash/blob operations

See also:

  • docs/quickstart/ — Plugin, loader, processor module skeletons
  • docs/cookbook/ — Common task recipes and disassembly workflows
  • docs/cookbook/microcode_lifting.md — Custom microcode lifting and Hex-Rays filters
  • docs/migration/ — Legacy SDK to idax migration map and snippets
  • docs/tutorial/first_contact.md — 5-step beginner walkthrough
  • docs/tutorial/function_discovery_events.md — event-hook lifecycle for new-function workflows
  • docs/tutorial/rust_plugin_refs_to.md — Rust plugin action wiring for incoming-xref analysis
  • docs/tutorial/call_graph_traversal.md — transitive caller traversal patterns
  • docs/tutorial/multi_binary_signature_generation.md — multi-sample signature generation pipeline
  • docs/tutorial/distributed_analysis_consistency.md — distributed consistency and merge design
  • docs/tutorial/safety_performance_tradeoffs.md — idax-wrapper vs raw-SDK trade-offs and recovery
  • docs/surface_selection_guide.md — choose between C++ wrapper, safe Rust, and raw FFI
  • docs/namespace_topology.md — Complete namespace/type inventory map
  • docs/compatibility_matrix.md — OS/compiler validation matrix and commands
  • docs/storage_migration_caveats.md — Netnode migration safety notes
  • docs/port_gap_audit_examples.md — consolidated real-world port audits and remaining parity gaps