Class to build and manage IDA command line options. Provides a fluent interface to set options and generate command lines for IDA Pro/IDA Free based on the available command line switches. More...

#include <ida_command_builder.hpp>

Public Member Functions
	IdaCommandBuilder ()
	Initialize IDA command line options. More...

IdaCommandBuilder &	use_text_mode ()
	Use idat (text interface) instead of ida. More...

IdaCommandBuilder &	auto_analysis (bool enabled=true)
	Enable or disable auto analysis. More...

IdaCommandBuilder &	autonomous (bool enabled=true)
	Enable or disable autonomous mode (no dialog boxes). More...

IdaCommandBuilder &	set_loading_address (unsigned int address)
	Set loading address in paragraphs (hexadecimal). More...

IdaCommandBuilder &	new_database (bool enabled=true)
	Disassemble a new file (delete old database). More...

IdaCommandBuilder &	set_compiler (const std::string &name, const std::string &abi="")
	Set compiler in format name:abi. More...

IdaCommandBuilder &	add_first_pass_directive (const std::string &directive)
	Add a configuration directive processed at first pass. More...

IdaCommandBuilder &	add_second_pass_directive (const std::string &directive)
	Add a configuration directive processed at second pass. More...

IdaCommandBuilder &	disable_fpp_instructions (bool disabled=true)
	Disable FPP instructions (IBM PC only). More...

IdaCommandBuilder &	set_entry_point (unsigned int address)
	Set program entry point (hex). More...

IdaCommandBuilder &	set_jit_debugger (bool enabled=true)
	Set IDA as just-in-time debugger. More...

IdaCommandBuilder &	set_log_file (const std::string &filename)
	Set the name of the log file. More...

IdaCommandBuilder &	disable_mouse (bool disabled=true)
	Disable mouse (text mode only). More...

IdaCommandBuilder &	set_plugin_options (const std::string &options)
	Set options to pass to plugins. More...

IdaCommandBuilder &	set_output_database (const std::string &path)
	Specify the output database (implies -c). More...

IdaCommandBuilder &	set_processor (const std::string &processor_type)
	Set processor type. More...

IdaCommandBuilder &	compress_database ()
	Compress database (create zipped idb). More...

IdaCommandBuilder &	pack_database ()
	Pack database (create unzipped idb). More...

IdaCommandBuilder &	no_pack_database ()
	Do not pack database (not recommended). More...

IdaCommandBuilder &	run_debugger (const std::string &options="")
	Immediately run the built-in debugger with optional parameters. More...

IdaCommandBuilder &	load_resources (bool enabled=true)
	Load MS Windows exe file resources. More...

IdaCommandBuilder &	run_script (const std::string &script_file, const std::vector< std::string > &args={})
	Execute a script file when the database is opened. More...

IdaCommandBuilder &	set_file_type (const std::string &file_type, const std::string &member="")
	Interpret the input file as the specified file type. More...

IdaCommandBuilder &	empty_database (bool enabled=true)
	Create an empty database. More...

IdaCommandBuilder &	set_windows_directory (const std::string &directory)
	Specify MS Windows directory. More...

IdaCommandBuilder &	no_segmentation (bool enabled=true)
	Do not create segmentation (used with Dump database command). More...

IdaCommandBuilder &	set_debug_flags (unsigned int flags)
	Set debug flags using a raw integer value. More...

IdaCommandBuilder &	set_debug_flags (const std::vector< std::string > &flag_names)
	Set debug flags using a list of flag names. More...

std::string	build_args () const
	Build the command line arguments based on the set options. More...

bool	get_auto_analysis () const
	Get auto-analysis option status. More...

Detailed Description

Class to build and manage IDA command line options. Provides a fluent interface to set options and generate command lines for IDA Pro/IDA Free based on the available command line switches.

Constructor & Destructor Documentation

◆ IdaCommandBuilder()

IdaCommandBuilder::IdaCommandBuilder ( )

Initialize IDA command line options.

Member Function Documentation

◆ add_first_pass_directive()

IdaCommandBuilder & IdaCommandBuilder::add_first_pass_directive ( const std::string & directive )

Add a configuration directive processed at first pass.

Parameters

directive Directive string (e.g., "VPAGESIZE=8192")

Returns: Reference to this object for method chaining

◆ add_second_pass_directive()

IdaCommandBuilder & IdaCommandBuilder::add_second_pass_directive ( const std::string & directive )

Add a configuration directive processed at second pass.

Parameters

directive Directive string

Returns: Reference to this object for method chaining

◆ auto_analysis()

IdaCommandBuilder & IdaCommandBuilder::auto_analysis ( bool enabled = true )

Enable or disable auto analysis.

Parameters

enabled True to enable, false to disable

Returns: Reference to this object for method chaining

◆ autonomous()

IdaCommandBuilder & IdaCommandBuilder::autonomous ( bool enabled = true )

Enable or disable autonomous mode (no dialog boxes).

Parameters

enabled True to enable, false to disable

Returns: Reference to this object for method chaining

◆ build_args()

std::string IdaCommandBuilder::build_args ( ) const

Build the command line arguments based on the set options.

Returns: The command line arguments as a string

◆ compress_database()

IdaCommandBuilder & IdaCommandBuilder::compress_database ( )

Compress database (create zipped idb).

Returns: Reference to this object for method chaining

◆ disable_fpp_instructions()

IdaCommandBuilder & IdaCommandBuilder::disable_fpp_instructions ( bool disabled = true )

Disable FPP instructions (IBM PC only).

Parameters

disabled True to disable, false to enable

Returns: Reference to this object for method chaining

◆ disable_mouse()

IdaCommandBuilder & IdaCommandBuilder::disable_mouse ( bool disabled = true )

Disable mouse (text mode only).

Parameters

disabled True to disable, false to enable

Returns: Reference to this object for method chaining

◆ empty_database()

IdaCommandBuilder & IdaCommandBuilder::empty_database ( bool enabled = true )

Create an empty database.

Parameters

enabled True to enable, false to disable

Returns: Reference to this object for method chaining

◆ get_auto_analysis()

bool IdaCommandBuilder::get_auto_analysis ( ) const

inline

Get auto-analysis option status.

Returns: True if auto-analysis is enabled

◆ load_resources()

IdaCommandBuilder & IdaCommandBuilder::load_resources ( bool enabled = true )

Load MS Windows exe file resources.

Parameters

enabled True to enable, false to disable

Returns: Reference to this object for method chaining

◆ new_database()

IdaCommandBuilder & IdaCommandBuilder::new_database ( bool enabled = true )

Disassemble a new file (delete old database).

Parameters

enabled True to enable, false to disable

Returns: Reference to this object for method chaining

◆ no_pack_database()

IdaCommandBuilder & IdaCommandBuilder::no_pack_database ( )

Do not pack database (not recommended).

Returns: Reference to this object for method chaining

◆ no_segmentation()

IdaCommandBuilder & IdaCommandBuilder::no_segmentation ( bool enabled = true )

Do not create segmentation (used with Dump database command).

Parameters

enabled True to enable, false to disable

Returns: Reference to this object for method chaining

◆ pack_database()

IdaCommandBuilder & IdaCommandBuilder::pack_database ( )

Pack database (create unzipped idb).

Returns: Reference to this object for method chaining

◆ run_debugger()

IdaCommandBuilder & IdaCommandBuilder::run_debugger ( const std::string & options = "" )

Immediately run the built-in debugger with optional parameters.

Parameters

options Optional debugger parameters

Returns: Reference to this object for method chaining

◆ run_script()

IdaCommandBuilder & IdaCommandBuilder::run_script	(	const std::string &	script_file,
		const std::vector< std::string > &	args = `{}`
	)

Execute a script file when the database is opened.

Parameters

script_file	Path to the script file
args	Optional list of arguments for the script

Returns: Reference to this object for method chaining

◆ set_compiler()

IdaCommandBuilder & IdaCommandBuilder::set_compiler	(	const std::string &	name,
		const std::string &	abi = `""`
	)

Set compiler in format name:abi.

Parameters

name	Compiler name
abi	Optional ABI specification

Returns: Reference to this object for method chaining

◆ set_debug_flags() [1/2]

IdaCommandBuilder & IdaCommandBuilder::set_debug_flags ( const std::vector< std::string > & flag_names )

Set debug flags using a list of flag names.

Parameters

flag_names List of flag names

Returns: Reference to this object for method chaining

◆ set_debug_flags() [2/2]

IdaCommandBuilder & IdaCommandBuilder::set_debug_flags ( unsigned int flags )

Set debug flags using a raw integer value.

Parameters

flags Integer with debug flags

Returns: Reference to this object for method chaining

◆ set_entry_point()

IdaCommandBuilder & IdaCommandBuilder::set_entry_point ( unsigned int address )

Set program entry point (hex).

Parameters

address Entry point address

Returns: Reference to this object for method chaining

◆ set_file_type()

IdaCommandBuilder & IdaCommandBuilder::set_file_type	(	const std::string &	file_type,
		const std::string &	member = `""`
	)

Interpret the input file as the specified file type.

Parameters

file_type	File type prefix as seen in 'load file' dialog
member	Optional archive member (e.g., "classes.dex" for ZIP)

Returns: Reference to this object for method chaining

◆ set_jit_debugger()

IdaCommandBuilder & IdaCommandBuilder::set_jit_debugger ( bool enabled = true )

Set IDA as just-in-time debugger.

Parameters

enabled True to enable, false to disable

Returns: Reference to this object for method chaining

◆ set_loading_address()

IdaCommandBuilder & IdaCommandBuilder::set_loading_address ( unsigned int address )

Set loading address in paragraphs (hexadecimal).

Parameters

address Loading address in paragraphs (16 bytes each)

Returns: Reference to this object for method chaining

◆ set_log_file()

IdaCommandBuilder & IdaCommandBuilder::set_log_file ( const std::string & filename )

Set the name of the log file.

Parameters

filename Log file name

Returns: Reference to this object for method chaining

◆ set_output_database()

IdaCommandBuilder & IdaCommandBuilder::set_output_database ( const std::string & path )

Specify the output database (implies -c).

Parameters

path	Path to the output database

Returns: Reference to this object for method chaining

◆ set_plugin_options()

IdaCommandBuilder & IdaCommandBuilder::set_plugin_options ( const std::string & options )

Set options to pass to plugins.

Parameters

options Options string

Returns: Reference to this object for method chaining

◆ set_processor()

IdaCommandBuilder & IdaCommandBuilder::set_processor ( const std::string & processor_type )

Set processor type.

Parameters

processor_type Processor type string

Returns: Reference to this object for method chaining

◆ set_windows_directory()

IdaCommandBuilder & IdaCommandBuilder::set_windows_directory ( const std::string & directory )

Specify MS Windows directory.

Parameters

directory Windows directory path

Returns: Reference to this object for method chaining

◆ use_text_mode()

IdaCommandBuilder & IdaCommandBuilder::use_text_mode ( )

Use idat (text interface) instead of ida.

Returns: Reference to this object for method chaining

The documentation for this class was generated from the following files:

/home/runner/work/ida-api-domain/ida-api-domain/include/ida_command_builder.hpp
/home/runner/work/ida-api-domain/ida-api-domain/src/ida_command_builder.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IdaCommandBuilder()

Member Function Documentation

◆ add_first_pass_directive()

◆ add_second_pass_directive()

◆ auto_analysis()

◆ autonomous()

◆ build_args()

◆ compress_database()

◆ disable_fpp_instructions()

◆ disable_mouse()

◆ empty_database()

◆ get_auto_analysis()

◆ load_resources()

◆ new_database()

◆ no_pack_database()

◆ no_segmentation()

◆ pack_database()

◆ run_debugger()

◆ run_script()

◆ set_compiler()

◆ set_debug_flags() [1/2]

◆ set_debug_flags() [2/2]

◆ set_entry_point()

◆ set_file_type()

◆ set_jit_debugger()

◆ set_loading_address()

◆ set_log_file()

◆ set_output_database()

◆ set_plugin_options()

◆ set_processor()

◆ set_windows_directory()

◆ use_text_mode()