Различия между DelphiScript и Delphi

Краткий обзор

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

- Разберитесь, как работают переменные типа Variant и преобразования типов во время выполнения, а также как они влияют на тестирование и производительность.
- Узнайте, какие возможности Delphi не поддерживаются или работают иначе, включая массивы, операторы над множествами, вложенные подпрограммы и обработку исключений.
- Посмотрите, как использовать существующие классы и интерфейсы объектов Altium Designer, на примере создания переходного отверстия на печатной плате.
Узнайте больше с ИИ:

Различия между DelphiScript и Delphi

В этом разделе рассматриваются основные различия между языком сценариев DelphiScript и языком программирования Delphi компании Embarcadero, а также их влияние на использование API Altium Designer.

Система сценариев Altium Designer использует нетипизированный язык DelphiScript, поэтому в сценариях нет типов данных. Хотя для удобства чтения можно объявлять переменные и их типы, а также указывать типы для функций/процедур или параметров методов, DelphiScript выполняет преобразование необъявленных переменных во время выполнения сценария. Так, например, вы не можете определять записи или классы.

Переменные DelphiScript

Все переменные в сценарии имеют тип Variant, а типы в объявлениях переменных игнорируются, и их можно не указывать. Поэтому все три приведенных объявления корректны:

Var
a : Integer;
 
Var
b : Integer;
 
Var
  c, d;

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

Function Sum(a, b) : Integer;
Begin
  Result := a + b;
End;

В целом переменные типа Variant могут хранить данные любого типа и поддерживают множество операций и преобразований типов. Проверка типов и вычисление значений Variant выполняются во время выполнения. Компилятор не предупреждает о возможных ошибках в коде, которые можно выявить только путем всестороннего тестирования. В целом участки кода, использующие Variant, можно считать интерпретируемым кодом, поскольку многие операции невозможно разрешить до момента выполнения. Это может влиять на скорость выполнения кода.

В результате после объявления переменной типа Variant и присвоения ей значения ее можно скопировать в переменную любого совместимого или несовместимого типа данных:

Var
V;
Begin
  // variable V can be assigned values of several different types:
  V := 10;
  V := 'Hello, World';
  V := 45.55;
End;

Если переменной присвоены данные несовместимого типа, интерпретатор DelphiScript по возможности выполняет преобразование. В противном случае выдается ошибка времени выполнения. На практике Variant хранит информацию о типе вместе с данными, поэтому DelphiScript работает медленнее, чем эквивалентный скомпилированный код Embarcadero Delphi.

Множества в сценариях

В DelphiScript нет типов множеств (Set), и он не поддерживает операторы над множествами, в отличие от языка Delphi, в котором такие типы и операторы предусмотрены.

Для работы с множествами в сценариях DelphiScript используйте встроенные функции управления множествами.

Дополнительные сведения см. в разделе Использование множеств в DelphiScript

Внутренние функции и процедуры

При использовании функций и процедур inside функции или процедуры рекомендуется писать отдельные функции/процедуры, хотя рекурсивные процедуры/функции допускаются.

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

Function A
Function B
Begin
// blah
End;
Begin
B;
End;

Рекомендуемая структура функции:

Function B
Begin
// blah
End;

Function A
Begin
B;
End;

Ключевое слово Result

Используйте ключевое слово Result для задания возвращаемого значения внутри блока функции. Например:

Function Foo : String;
Begin
Result := 'Foo Foo';
End;

Вложенные подпрограммы

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

Элементы массива

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

Var
x : array [1..2] of double;

Var
x : array [1..2];

Обратите внимание: объявлять типы массивов нельзя, но можно объявлять переменные-массивы.

Illegal example:

Type
TVertices = Array [1..50] Of TLocation;
Var
NewVertices : TVertices;

Legal example:

Var
NewVertices : Array [1..50] of TLocation;

Объявление открытого массива

Объявление Open Array не поддерживается.

Ключевое слово Case

Ключевое слово Case можно использовать с любым типом. Поэтому следующий код допустим:

Case UserName of
'Alex', 'John' : IsAdministrator := true;
'Peter' : IsAdministrator := false;
Else
Raise('Unknown user');
End;

Объявления классов

В DelphiScript нельзя определять новые классы, но можно использовать существующие классы DelphiScript и создавать их экземпляры. Например, в сценариях можно создавать и использовать экземпляры классов TList и TStringList.
See also
TList
TStringList

Функция CreateObject

Функцию CreateObject можно использовать для создания объектов, которые будут автоматически освобождены, когда перестанут использоваться.

Поэтому вместо:

Procedure Proc;
Var
  l;
Begin
    l := TList.Create;
  Try
    // do something with l
  Finally
  L.Free;
End;

...можно написать:

Procedure Proc;
Var
  l;
Begin
  l := CreateObject(TList);
  // Do something with l
End;

See also
Функция CreateObject.

Генерация исключений

Ключевое слово Raise можно использовать без параметров для повторной генерации последнего исключения. Raise также можно использовать со строковым параметром для генерации исключения с указанным текстом сообщения. Объекты Exception в DelphiScript не поддерживаются, поскольку ключевое слово On не поддерживается.

Example:

Raise(Format('Invalid value : %d', [Height]));

See also
Ключевые слова Try, Finally и Raise.

ThreadVar

В DelphiScript ключевое слово Threadvar обрабатывается как Var. Обратите внимание: в Embarcadero Delphi переменные, объявленные с помощью ключевого слова Threadvar, имеют отдельные значения в каждом потоке.

Операторы над множествами

Оператор над множествами In не поддерживается. Оператор InSet можно использовать для проверки принадлежности значения множеству. Например:

If InSet(fsBold, Font.Style) then
ShowMessage('Bold');

Обратите внимание: операторы Delphi для работы с множествами +, -, *, <=, >= работают некорректно. Вместо них используются встроенные функции DelphiScript MkSet, MkSetRange, SetUnion, SetDifference, SetIntersection, SubSet and InSet:

ASet := BSet + CSet; \\ should be changed to
ASet := SetUnion(BSet, CSet);

Конструкторы множеств [...] не поддерживаются — для создания множества используйте функцию MkSet:

Font.Style := MkSet(fsBold, fsItalic); 

See also
Ключевое слово MkSet
Ключевое слово MkSetRange
Ключевое слово InSet
Ключевое слово SetDifference
Ключевое слово SetIntersection
Ключевое слово SetUnion
Ключевое слово SubSet
Ключевое слово InSet

Операторы

Операторы ^ и @ не поддерживаются.

Директивы

Следующие директивы не поддерживаются (обратите внимание: некоторые из них устарели и также не поддерживаются в Embarcadero Delphi): absolute, abstract, assembler, automated, cdecl, contains, default, dispid, dynamic, export, external, far, implements, index, message, name, near, nodefault, overload, override, package, pascal, private protected, public, published, read, readonly, register, reintroduce, requires, resident, safecall, stdcall, stored, virtual, write, writeonly.

Также обратите внимание: директива in в конструкции Uses игнорируется.

Игнорируемые ключевые слова

Ключевые слова interface, implementation, program и unit игнорируются в DelphiScript. Они могут присутствовать в сценариях, но не оказывают никакого действия. Однако эти ключевые слова могут улучшить читаемость сценариев.

Неподдерживаемые ключевые слова

Следующие ключевые слова не поддерживаются в DelphiScript:

  • as, asm, class, dispinterface, exports, finalization, inherited, initialization, inline, interface, is, library, object, out, property, record, resourcestring, set, supports, type.

Следующие функции Delphi RTL не поддерживаются в DelphiScript:

  • Abort, Addr, Assert, Dec, FillChar, Finalize, Hi, High, Inc, Initialize, Lo, Low, New, Ptr, SetString, SizeOf, Str, UniqueString, VarArrayRedim, VarArrayRef, VarCast, VarClear, VarCopy.

Функции из модуля Windows языка Delphi (файл windows.pas) не поддерживаются (например, функция RGB не поддерживается).

Использование API Altium Designer в сценариях

В DelphiScript нельзя создавать собственные типы записей или классов и их экземпляры в сценарии, однако можно использовать некоторые классы из API Altium Designer. Например, можно создавать экземпляры классов TStringList и TList и использовать их как контейнеры для хранения данных (обычно одного типа) в соответствии с задачами сценария.

Объектные интерфейсы API, представляющие объекты Altium Designer, доступны для использования в сценариях. Например, с помощью интерфейсов объектов схемы и печатной платы можно изменять объекты проекта в документах схем и печатных плат.

По соглашению в начало имен интерфейсов добавляется буква I. Например, IPCB_Board представляет интерфейс существующего документа печатной платы.

Пример использования интерфейсов печатной платы в сценарии:

Procedure ViaCreation;
Var
  Board : IPCB_Board;
  Via : IPCB_Via;
Begin
  Board := PCBServer.GetCurrentPCBBoard;
  If Board = Nil Then Exit;
 
  (\* Create a Via object\* )
  Via           := PCBServer.PCBObjectFactory(eViaObject, eNoDimension, eCreate_Default);
  Via.X         := MilsToCoord(7500);
  Via.Y         := MilsToCoord(7500);
  Via.Size      := MilsToCoord(50);
  Via.HoleSize  := MilsToCoord(20);
  Via.LowLayer  := eTopLayer;
  Via.HighLayer := eBottomLayer;
 
  (* Put this via in the Board object*)
  Board.AddPCBObject(Via);
End;

В сценариях можно использовать следующие API:

  • Некоторые функции и классы Embarcadero Delphi™, а также расширения DelphiScript
  • API клиента
  • API сервера печатных плат
  • API сервера схем
  • API сервера диспетчера рабочей области
  • API интегрированной библиотеки
  • Функции API Altium Designer
  • Параметрические процессы

Дополнительная информация

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

Информацию о написании скриптов для Altium Designer см. в основной документации по написанию скриптов.

Подробные сведения об использовании объектов проекта и их интерфейсов в скриптах см. в руководстве Использование API Altium Designer.

Информацию о доступных API Altium Designer и их интерфейсных объектах для скриптов см. в справочнике по API Altium Designer.

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Меню
Contents
Доступность функций

Доступные вам функции зависят от того, какое решение Altium вы используете: Altium Develop, Altium Agile Teams, Altium Agile Enterprise или Altium Designer (при активной подписке).

Если вы не видите описанную функцию в используемом вами программном обеспечении, свяжитесь с отделом продаж Altium, чтобы узнать больше.

Устаревшая документация

Документация Altium Designer больше не разделена по версиям ПО. Если вам необходим доступ к документации по старым версиям Altium Designer, посетите раздел Устаревшая документация на странице Прочие установщики.

Contents