////////////////////////////////////////////////////////////////////////////////

unit pmm_plugin;

Windows;

/// <summary>

/// версия API на которой был собран плагин, должна возвращаться в TPlugin.VersionApi

/// </summary>

PMM_API_VER = 1;

/// <summary>

/// плагин должен экспортировать эту функцию, возвращающую структуру TPlugin

/// </summary>

PMM_PLUGIN_ENTRYPOINT_NAME = 'pmm_get_plugin_info';

/// <summary>

/// двусвязный список передаваемый на вход TPluginOpenProcess

/// </summary>

PProcessModule = ^TProcessModule;

TProcessModule = record

BLink: PProcessModule; // ссылка на предыдущую структуру (или nil)

FLink: PProcessModule; // ссылка на следующую структуру (nil - конец списка)

Instance: ULONG64; // база загрузки модуля в открытом хостом процессе

ImagePath: PWideChar; // полный путь к модулю

LoadAsDataFile: BOOL; // флаг присутствия модуля в списках лоадера (исполняемый или отмапленый)

end;

/// <summary>

/// команда плагину об открытии нового процесса (нужно инициализароваться)

/// в случае успеха фунция должна вернуть NO_ERROR

/// </summary>

TPluginOpenProcess =

function(AProcessID: DWORD; AModuleList: PProcessModule): DWORD; stdcall;

/// <summary>

/// команда плагину о закрытии процесса (нужно освободить ресурсы)

/// </summary>

TPluginCloseProcess = procedure(); stdcall;

/// <summary>

/// запрос о количестве известных плагину дескрипторов

/// в случае неуспеха функция должна вернуть ноль!

/// </summary>

TPluginDescriptorCount = function(): Integer; stdcall;

/// <summary>

/// Тип дескриптора

/// </summary>

TDescriptorType = (

/// <summary>

/// Флаг типа дескриптора, означающий произвольные данные, описываемые им, например коментарий

/// </summary>

PMM_DESCR_TYPE_UNKNOWN = 0,

/// <summary>

/// Флаг типа дескриптора, означающий что дескриптор описывает поле структуры

/// При это в TDescriptorData желательно заполнение наименования структуры в поле NameSpace

/// </summary>

PMM_DESCR_TYPE_STRUCT = 1,

/// <summary>

/// Флаг типа дескриптора, означающий что дескриптор описывает функцию

/// </summary>

PMM_DESCR_TYPE_FUNCTION = 2

);

/// <summary>

/// уникальный описатель известной плагину информации по адресу

/// </summary>

PDescriptor = ^TDescriptor;

TDescriptor = record

AddrVA: ULONG64; // описываемый адрес

Handle: THandle; // уникальный маркер задаваемый плагином

DescrType: TDescriptorType; // тип дескриптора

end;

/// <summary>

/// запрос дескриптора по индексу

/// </summary>

TPluginGetDescriptor = function(Index: Integer; pDesc: PDescriptor): DWORD; stdcall;

/// <summary>

/// данные описываемые дескриптором

/// </summary>

PDescriptorData = ^TDescriptorData;

TDescriptorData = record

Caption: PWideChar; // описание адреса, например имя функции или имя поля структуры

// необязательные поля (не используются в режиме дизассемблера)

NameSpace: PWideChar; // принадлежность адреса к более обьемному блоку (например структуре или таблице)

Description: PWideChar; // коментарий к адресу

Size: DWORD; // размер описываемого блока

end;

/// <summary>

/// запрос данных дескриптора. Память должна быть выделена вызывающей стороной.

/// необходимый размер данных возвращается в параметре pSize

/// AHandle - параметр полученый ранее из структуры TDescriptor

/// Если pDescData равна NIL или pSize содержит недостаточный размер

/// функция обязана вернуть ERROR_INSUFFICIENT_BUFFER

/// В случае успеха функция должна вернуть NO_ERROR

/// </summary>

TPluginGetDescriptorData = function(AHandle: THandle;

pDescData: PDescriptorData; pSize: PInteger): DWORD; stdcall;

/// <summary>

/// адреса функций посредством которых идет работа с плагином

/// Close является не обязательны и может быть не назначен.

/// </summary>

TPluginCallGate = record

Open: TPluginOpenProcess;

Close: TPluginCloseProcess;

DescriptorCount: TPluginDescriptorCount;

GetDescriptor: TPluginGetDescriptor;

GetDescriptorData: TPluginGetDescriptorData;

end;

/// <summary>

/// структура возвращаемая pmm_get_plugin_info()

/// </summary>

TPlugin = record

VersionApi: DWORD; // поле должно быть заполнено значением PMM_API_VER

PluginUID: DWORD; // уникальный идентификатор плагина.

// не должен быть равен нулю и

// не должен меняться при выпуске новой версии плагина!!!

Gate: TPluginCallGate; // шлюз вызовов плагина

// следующие поля не обязательны и могут быть равны nil

PluginName: PWideChar; // имя плагина (используется в диалоге прогресса)

PluginAuthor: PWideChar; // автор плагина

PluginHomePage: PWideChar; // домашняя страницы плагина

PluginDesсription: PWideChar; // краткое описание плагина

end;

/// <summary>

/// точка входа в плагин. именно с неё начинается работа

/// </summary>

Tpmm_get_plugin_info = function(): TPlugin; stdcall;

end.