Getting Started with C++ SDK

loader.hpp: Definitions of IDP, LDR, and PLUGIN module interfaces. This file also contains:

• functions to load files into the database

• functions to generate output files

• high level functions to work with the database (open, save, close)

ua.hpp: Functions that deal with the disassembling of program instructions. Disassembly of an instruction is made in three steps:

• analysis

• emulation

• conversion to text

kernwin.hpp: Defines the interface between the kernel and the UI. Some string processing functions are also kept in this header.

idd.hpp: Debugger plugin API for debugger module writers. Contains definition of the interface to IDD modules.

bytes.hpp: Functions and definitions used to describe and manipulate each byte of the disassembled program. Information about the byte includes associated features (comments, names, references, etc), data types (dword, qword, string literal, etc), instruction operands, status (mapped, loaded, patched, etc), among others.

netnode.hpp: Functions that provide the lowest level public interface to the database. Modules can use this to keep some private information in the database. A description of the concept is available in the header file itself.

allins.hpp: List of instructions available from all processor modules.

auto.hpp: Auto-analysis related functions.

compress.hpp: Data compression functions.

config.hpp: Functions that deal with configuration options and files.

dbg.hpp: Contains functions to control the debugging of a process.

diskio.hpp: File I/O functions for IDA. You should not use standard C file I/O functions in modules. Use functions from this header, pro.h, and fpro.h instead.

entry.hpp: Functions that deal with entry points to the program being disassembled.

enum.hpp: Enumeration type management (assembly level types).

err.h: Thread safe functions that deal with error codes.

expr.hpp: Functions that deal with C-like expressions, external languages, and the built-in IDC language.

fixup.hpp: Functions that deal with fixup (relocation) information.

fpro.h: System independent counterparts of file I/O functions. These functions do check errors but never exit even if an error occurs. They return extended error code in qerrno variable. NOTE: You must use these functions instead of the C standard I/O functions.

frame.hpp: Routines to manipulate function stack frames, stack variables, register variables and local labels.

funcs.hpp: Routines for working with functions within the disassembled program. This file also contains routines for working with library signatures (e.g. FLIRT).

gdl.hpp: Low level graph drawing operations.

graph.hpp: Graph view management.

help.h: Help subsystem. This subsystem is not used in IDP files. We put it just in case.

ieee.h: IEEE floating point functions.

intel.hpp: Header file from the IBM PC module. For information only. It will not compile because it contains references to internal files!

lex.hpp: Tools for parsing C-like input.

lines.hpp: High level functions that deal with the generation of the disassembled text lines.

nalt.hpp: Definitions of various information kept in netnodes. These functions should not be used directly since they are very low level.

moves.hpp: Functions and classes related to location history.

name.hpp: Functions that deal with names (setting, deleting, getting, validating, etc).

offset.hpp: Functions that deal with offsets.

problems.hpp: Functions that deal with the list of problems.

prodir.h: Low level functions to find files in the file system. It is better to use enumerate_files2() from diskio.hpp.

pronet.h: Network related functions.

range.hpp: Contains the definition of the 'range_t' class. This is a base class used by many parts of IDA, such as the 'segment_t' and 'segreg_range_t' (segment register) classes.

registry.hpp: Registry related functions. IDA uses the registry to store global configuration options that must persist after IDA has been closed.

segment.hpp: Functions that deal with program segmentation.

segregs.hpp: Functions that deal with the segment registers. If your processor doesn't use segment registers, then you don't need this file.

strlist.hpp: Functions that deal with the strings list.

struct.hpp: Structure type management (assembly level types).

typeinf.hpp: Describes the type information records in IDA.

xref.hpp: Functions that deal with cross-references.