Экспорт и импорт перегруженных функций в Delphi: работа с пространствами имен линкера

Delphi , Файловая система , DLL и PlugIns

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

При разработке DLL-библиотек на Object Pascal (Delphi/Free Pascal) часто возникает необходимость экспортировать функции для использования в других приложениях. Однако при попытке экспорта перегруженных функций (функций с одинаковыми именами, но разными параметрами) разработчики сталкиваются с ограничениями линкера.

Как показано в исходном обсуждении, следующий код не может быть корректно экспортирован:

function CharArrToAnsiStr(const A: array of AnsiChar): AnsiString; overload; stdcall; export;
function CharArrToAnsiStr(const A: array of AnsiChar; BufLen: Integer): AnsiString; overload; stdcall; export;
function CharArrToAnsiStr(P: PAnsiChar; BufLen: Integer): AnsiString; overload; stdcall; export;

Проблема заключается в том, что линкер работает с именами функций на низком уровне и не поддерживает перегрузку имен в том виде, как это делает компилятор Pascal.

Решение проблемы: использование уникальных имен для экспорта

Основное решение, предложенное участниками обсуждения, заключается в экспорте функций под разными именами, а затем их повторном объявлении как перегруженных при импорте.

Пример реализации решения

{$mode delphi}
unit SysUtils;

interface
uses Windows;

{$ifdef DLLEXPORT}
function ChATAStr1(const A: array of AnsiChar): AnsiString;                  overload; stdcall; export;
function ChATAStr2(const A: array of AnsiChar; BufLen: Integer): AnsiString; overload; stdcall; export;
function ChATAStr3(P: PAnsiChar; BufLen: Integer): AnsiString;               overload; stdcall; export;
{$endif DLLEXPORT}

{$ifdef DLLIMPORT}
function CharArrToAnsiStr(const A: array of AnsiChar): AnsiString;                  overload; stdcall; external 'rtllib.dll' name 'ChATAStr1';
function CharArrToAnsiStr(const A: array of AnsiChar; BufLen: Integer): AnsiString; overload; stdcall; external 'rtllib.dll' name 'ChATAStr2';
function CharArrToAnsiStr(P: PAnsiChar; BufLen: Integer): AnsiString;               overload; stdcall; external 'rtllib.dll' name 'ChATAStr3';
{$endif DLLIMPORT}

implementation

{$ifdef DLLEXPORT}
function ChATAStr1(const A: array of AnsiChar): AnsiString; overload; stdcall;
begin
  // реализация первой версии функции
  Result := AnsiString(A);
end;

function ChATAStr2(const A: array of AnsiChar; BufLen: Integer): AnsiString; overload; stdcall;
begin
  // реализация второй версии функции
  if BufLen > Length(A) then
    Result := AnsiString(A)
  else
    SetString(Result, PAnsiChar(@A[0]), BufLen);
end;

function ChATAStr3(P: PAnsiChar; BufLen: Integer): AnsiString; overload; stdcall;
begin
  // реализация третьей версии функции
  SetString(Result, P, BufLen);
end;
{$endif DLLEXPORT}

{$ifdef DLLEXPORT}
exports
  ChATAStr1 name 'ChATAStr1',
  ChATAStr2 name 'ChATAStr2',
  ChATAStr3 name 'ChATAStr3';
{$endif DLLEXPORT}

end.

Сборка DLL и приложения

Для сборки DLL и тестового приложения можно использовать следующие команды:

fpc -dDLLEXPORT -n -B -Os -CD RTLLib.pas
dlltool --input-def rtllib_dll.def --dllname rtllib.dll --output-lib librtllib_dll.a
fpc -dDLLIMPORT -n -B -Os test.pas
strip test.exe
strip rtllib.dll

Альтернативные подходы к решению проблемы

1. Использование единой функции с параметром-перечислением

Вместо перегруженных функций можно создать единую функцию с дополнительным параметром, указывающим вариант поведения:

type
  TConversionMode = (cmAutoLength, cmFixedLength, cmPointer);

function CharArrToAnsiStrEx(Mode: TConversionMode; const A: array of AnsiChar; 
  BufLen: Integer = 0; P: PAnsiChar = nil): AnsiString; stdcall; export;
begin
  case Mode of
    cmAutoLength: Result := AnsiString(A);
    cmFixedLength: 
      if BufLen > Length(A) then
        Result := AnsiString(A)
      else
        SetString(Result, PAnsiChar(@A[0]), BufLen);
    cmPointer: SetString(Result, P, BufLen);
  end;
end;

2. Использование объектно-ориентированного подхода

Можно создать класс с методами преобразования, а экспортировать только фабричную функцию для создания экземпляра:

type
  IStringConverter = interface
    function ConvertFromArray(const A: array of AnsiChar): AnsiString; stdcall;
    function ConvertFromArrayWithLength(const A: array of AnsiChar; BufLen: Integer): AnsiString; stdcall;
    function ConvertFromPointer(P: PAnsiChar; BufLen: Integer): AnsiString; stdcall;
  end;

function CreateStringConverter: IStringConverter; stdcall; export;

3. Использование префиксов для имен функций

Можно ввести префиксы, отражающие типы параметров:

function CharArrToAnsiStr_Array(const A: array of AnsiChar): AnsiString; stdcall; export;
function CharArrToAnsiStr_ArrayLen(const A: array of AnsiChar; BufLen: Integer): AnsiString; stdcall; export;
function CharArrToAnsiStr_PointerLen(P: PAnsiChar; BufLen: Integer): AnsiString; stdcall; export;

Рекомендации по работе с экспортом функций в Delphi

1. Используйте соглашение о вызовах stdcall: Это стандартное соглашение для Windows API и межмодульного взаимодействия.

2. Избегайте сложных типов параметров: Для экспортируемых функций лучше использовать простые типы (PChar, Integer, Pointer и т.д.).

3. Документируйте экспортируемые функции: Создавайте .def-файлы или подробные комментарии для каждой экспортируемой функции.

4. Тестируйте совместимость: Убедитесь, что ваши DLL могут быть использованы из других языков программирования, если это требуется.

5. Учитывайте управление памятью: Решите, кто будет отвечать за освобождение памяти - вызывающий или вызываемый код.

Заключение

Хотя перегруженные функции являются мощным инструментом в Object Pascal, их экспорт требует специального подхода из-за ограничений линкера. Представленные решения позволяют обойти эти ограничения, сохраняя удобство использования перегруженных функций в клиентском коде. Выбор конкретного метода зависит от требований проекта и предпочтений разработчика.

Для большинства случаев оптимальным решением будет первый подход - экспорт под уникальными именами с последующим объединением в перегруженные функции при импорте. Это сохраняет читаемость кода и не требует значительных изменений в существующей кодовой базе.

Создано по материалам из источника по ссылке.

Статья описывает решение проблемы экспорта перегруженных функций в Delphi через использование уникальных имен для линкера и их последующего объединения при импорте, а также рассматривает альтернативные подходы.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: DLL и PlugIns ::