auto.hpp

Go to the documentation of this file.

/*
 *      Interactive disassembler (IDA).
 *      Copyright (c) 1990-2025 Hex-Rays
 *      ALL RIGHTS RESERVED.
 *
 */
 
#ifndef _AUTO_HPP
#define _AUTO_HPP
#include <ida.hpp>

 
typedef int atype_t; 

const atype_t
  AU_NONE = 00,         
  AU_UNK  = 10,         
  AU_CODE = 20,         
  AU_WEAK = 25,         
  AU_PROC = 30,         
  AU_TAIL = 35,         
  AU_FCHUNK=38,         
  AU_USED = 40,         
  AU_USD2 = 45,         
  AU_TYPE = 50,         
  AU_LIBF = 60,         
  AU_LBF2 = 70,         
  AU_LBF3 = 80,         
  AU_CHLB = 90,         
  AU_FINAL=200;         
 
 
typedef int idastate_t; 

const idastate_t
                         //                      meaning
  st_Ready   = 0,        
  st_Think   = 1,        
  st_Waiting = 2,        
  st_Work    = 3;        
 

 
idaman atype_t ida_export get_auto_state(void);
 

 
idaman atype_t ida_export set_auto_state(atype_t new_state);
 

struct auto_display_t
{
  atype_t type = AU_NONE;
  ea_t ea = BADADDR;
  idastate_t state = st_Ready;
};

 
idaman bool ida_export get_auto_display(auto_display_t *auto_display);
 

 
idaman void ida_export show_auto(ea_t ea, atype_t type=AU_NONE);
 

 
inline void show_addr(ea_t ea) { show_auto(ea); }
 

 
idaman idastate_t ida_export set_ida_state(idastate_t st);
 

 
inline bool may_create_stkvars(void)
{
  return inf_should_create_stkvars() && get_auto_state() == AU_USED;
}
 

 
inline bool may_trace_sp(void)
{
  if ( inf_should_trace_sp() )
  {
    atype_t auto_state = get_auto_state();
    return auto_state == AU_USED;
  }
  return false;
}
 

 
idaman void ida_export auto_mark_range(ea_t start, ea_t end, atype_t type);
 

 
inline void auto_mark(ea_t ea, atype_t type)
{
  auto_mark_range(ea, ea+1, type);
}
 

 
idaman void ida_export auto_unmark(ea_t start, ea_t end, atype_t type);
 
// Convenience functions

inline void plan_ea(ea_t ea)
{
  auto_mark(ea, AU_USED);
}

inline void plan_range(ea_t sEA, ea_t eEA)
{
  auto_mark_range(sEA, eEA, AU_USED);
}

inline void auto_make_code(ea_t ea)
{
  auto_mark(ea, AU_CODE);
}

inline void auto_make_proc(ea_t ea)
{
  auto_make_code(ea);
  auto_mark(ea, AU_PROC);
}

inline bool auto_postpone_analysis(ea_t ea)
{
  atype_t state = get_auto_state();
  if ( state == AU_USD2 )
    return false;
  if ( state == AU_USED )
    auto_mark(ea, AU_USD2);
  return true;
}

 
idaman void ida_export reanalyze_callers(ea_t ea, bool noret);
 

 
idaman void ida_export revert_ida_decisions(ea_t ea1, ea_t ea2);
 

 
idaman void ida_export auto_apply_type(ea_t caller, ea_t callee);

 
idaman void ida_export auto_apply_tail(ea_t tail_ea, ea_t parent_ea);

 
idaman int ida_export plan_and_wait(ea_t ea1, ea_t ea2, bool final_pass=true);
 

 
idaman bool ida_export auto_wait(void);
 

 
idaman ssize_t ida_export auto_wait_range(ea_t ea1, ea_t ea2);
 

 
idaman bool ida_export auto_make_step(ea_t ea1, ea_t ea2);
 

 
idaman void ida_export auto_cancel(ea_t ea1, ea_t ea2);
 

 
idaman bool ida_export auto_is_ok(void);
 

 
idaman ea_t ida_export peek_auto_queue(ea_t low_ea, atype_t type);
 

 
idaman ea_t ida_export auto_get(atype_t *type, ea_t lowEA, ea_t highEA);
 

 
idaman int ida_export auto_recreate_insn(ea_t ea);
 

 
idaman bool ida_export is_auto_enabled(void);
 

 
idaman bool ida_export enable_auto(bool enable);
 
 
 
#endif  //  _AUTO_HPP