indexer.hpp

Go to the documentation of this file.

/*
 *      Interactive disassembler (IDA).
 *      Copyright (c) 1990-2026 Hex-Rays
 *      ALL RIGHTS RESERVED.
 */

 
#ifndef INDEXER_HPP
#define INDEXER_HPP
 
#include <pro.h>
#include <bytes.hpp>
#include <name.hpp>
 
//-------------------------------------------------------------------------
using subindex_typeid_t = size_t;

enum builtin_idxes_t ENUM_SIZE(subindex_typeid_t)
{
  INVALID_SUBIDX_ID = 0,                       
  SUBIDX_FUNCTIONS,                            
  SUBIDX_LTYPES,                               
  SUBIDX_NAMES,                                
  SUBIDX_SEGMENTS,                             
  SUBIDX_FUNCTION_COMMENTS,                    
  SUBIDX_REPEATABLE_FUNCTION_COMMENTS,         
#ifdef __KERNEL__
  SUBIDX_MAX,
#endif
};

struct match_range_t
{
  size_t start; 
  size_t end;   
};
DECLARE_TYPE_AS_MOVABLE(match_range_t);
 
//-------------------------------------------------------------------------
 
// Indexer API
//-------------------------------------------------------------------------

enum match_mode_t
{
  STR_MATCH, 
  FUZZY,     
};

struct match_config_t
{
  size_t cb = sizeof(match_config_t); 
  match_mode_t mode      = match_mode_t::STR_MATCH; 
  int score_cutoff       = 0;   
  int max_results        = 500; 
};
DECLARE_TYPE_AS_MOVABLE(match_config_t);

struct search_result_data_t
{
  virtual ~search_result_data_t() {}
  virtual size_t size() const = 0;
  virtual std::string_view get_name(size_t index) const = 0;
  virtual const qstring &get_name_str(size_t index) const = 0;
  virtual int get_score(size_t index) const = 0;
  virtual ea_t get_ea(size_t index) const = 0;
  virtual nodeidx_t get_netnode_idx(size_t index) const = 0;
  virtual int get_ltype_ordinal(size_t index) const = 0;
  virtual type_t get_ltype_type(size_t index) const = 0;
  virtual subindex_typeid_t get_subindex(size_t index) const = 0;
  virtual size_t get_match_ranges_count(size_t index) const = 0;
  virtual match_range_t get_match_range(size_t index, size_t range_idx) const = 0;
  virtual match_range_t get_match_line_range([[maybe_unused]] size_t index) const { return {0, 0}; }
 
  bool empty() const { return size() == 0; }
};

idaman bool ida_export indexer_is_enabled();

idaman search_result_data_t *ida_export indexer_match_all(
        const qstring &query,
        const match_config_t &config);

idaman search_result_data_t *ida_export indexer_match(
        subindex_typeid_t subindex_id,
        const qstring &query,
        const match_config_t &config);
 
#endif // INDEXER_HPP