Ключевые слова
Краткий обзор
- Изучите синтаксис и особенности работы распространённых ключевых слов DelphiScript.
- Ознакомьтесь с примерами управления потоком выполнения, объявлений и обработки ошибок.
- Узнайте об ограничениях языка, включая отсутствие поддержки объявлений открытых массивов и указателей на функции.
В этом справочнике описаны ключевые слова DelphiScript, используемые в системе сценариев Altium Designer. Система сценариев поддерживает язык DelphiScript, который очень похож на язык программирования Embarcadero Delphi™. Основное отличие состоит в том, что DelphiScript — это нетипизированный язык сценариев.
В этом разделе приведены распространенные ключевые слова DelphiScript с подробными описаниями и примерами. Дополнительные сведения о ключевых словах, например о подпрограммах Delphi для работы с файлами, математическими операциями и строками, см. в разделах Функции и Справочник Embarcadero Delphi.
And
Declaration
Оператор And выполняет логическую или побитовую операцию И.
Description
Оператор And выполняет логическую операцию И, если операнды имеют логический тип, или побитовую операцию И, если операнды — целые числа.
Example of a boolean And evaluation:
Var
I, J : Integer
Begin
I := $F0;
J := $8F;
ShowMessage(IntToStr(I and J));
End;
Example of a logical And evaluation:
Var
S : String;
Begin
S := '';
If (Length(S) > 0) and (S[1\] = 'X') Then Delete(S,1,1);
End;
See also
Ключевое слово Or
Ключевое слово Xor
Array
Declaration
Array [index range];
Description
DelphiScript — нетипизированный язык, поэтому необходимо указать размер или диапазон индексов массива. Тип элементов, которые может содержать массив, также можно задать, но это необязательно. Объявление Open array не поддерживается.
Example:
var x : array [1..2];
Begin
Declaration
Begin
statement
End;
Description
Ключевое слово begin начинает блок в сценарии. Блок представляет собой основное тело сценария и может содержать любое количество операторов. Его можно использовать везде, где требуется один оператор, например в качестве тела условного оператора или цикла.
Example:
Var
Test : Integer;
Begin
Test := Test + 4;
ShowMessage(IntToStr(Test));
End;
See also
Ключевое слово End
Break
Declaration
Break;
Description
Оператор Break выполняет выход из цикла аналогично оператору Goto.
Example:
While Condition Do
Begin
DoSomething;
Begin
If AnotherCondition Then
Break;
End;
End;
See also
Ключевое слово While
Ключевое слово Continue
Ключевое слово Do
Ключевое слово Repeat
Case
Declaration
Case expression Of
Value range : Expression;
Else Expression;
End;
Description
Операторы Case выбирают одну из нескольких возможных ветвей в зависимости от значения выражения.
Во многих случаях сложный набор операторов If можно упростить, заменив их операторами Case. Оператор case используется для выбора по значению, списку возможных значений или диапазону значений выражения. В операторе case можно использовать любые типы, поскольку DelphiScript — нетипизированный язык. Операторы Case могут содержать оператор else, который выполняется, если ни одна из меток не соответствует значению селектора в условии Case Of.
Example 1:
Case Char Of
'+' : Text := 'Plus sign';
'-' : Text := 'Minus sign';
'*', '/': Text := 'Multiplication or division';
'0'..'9': Text := 'Number';
'a'..'z': Text := 'Lowercase character';
'A'..'Z': Text := 'Uppercase character';
Else
Text := 'Unknown character';
End;
Example 2:
Case UserName Of
Jack', 'Joe' : IsAdministrator := true;
'Fred' : IsAdministrator := false;
Else
Raise('Unknown User');
End;
See also
Ключевое слово Of
Continue
Declaration
Continue
Description
Оператор Continue пропускает оставшуюся часть тела цикла аналогично оператору Goto;
Example:
Var
I := 0; s:= 1;
Begin
While True Do
Begin
S := S \* 2;
I := I \\+ 1;
If I <> 4 then continue;
Break;
End;
See also
Ключевое слово Break
Ключевое слово While
Ключевое слово Continue
Ключевое слово Do
Ключевое слово Repeat
Const
Declaration
Const
Name = Expression;
Description
Ключевое слово Const задает константное выражение в качестве значения константы. Если попытаться изменить в сценарии выражение типа const, система сценариев выдаст ошибку «Необъявленный идентификатор».
Example:
Const
b = 30;
Begin
ShowMessage(IntTtStr(b));
End;
Попытка изменить значение параметра b const приведет к ошибке, например:
Const
b = 30;
Begin
b := 40;
ShowMessage(IntToStr(b));
End;
Div
Declaration
dividend div divisor
Description
Оператор Div выполняет целочисленное деление, отбрасывая дробную часть результата без округления. Если делитель равен нулю, DelphiScript сообщает об ошибке.
See also
Оператор Mod
Оператор Div
Do
Declaration
-
For variable := expression1 to expression2 doоператор -
While expression doоператор -
With expression doоператор.
Description
Ключевое слово Do входит в состав операторов For, While and With языка DelphiScript.
Example:
For i := 0 To AnIndex - 1 Do
S := S + #13 + AString;
See also
Ключевое слово For
Ключевое слово To
Ключевое слово While
Ключевое слово With
Ключевое слово DownTo
DownTo
Declaration
For variable := expression1 DownTo expression2 Do statement.
Description
Используйте DownTo в цикле For для обратного отсчета.
See also
Ключевое слово For
Ключевое слово To
Ключевое слово Do
Else
Declaration
-
If condition then statement Else statement -
Try statement except exception Else statement end -
Case expression of Else end;
Description
Ключевое слово Else начинает ветвь, обрабатывающую все остальные случаи, в нескольких операторах. Обратите внимание: за else в операторе if следует один оператор, тогда как часть else операторов try-except и case может содержать несколько операторов.
See also
Ключевое слово If
Ключевое слово Then
Ключевое слово Try
Ключевое слово Case
End
Declaration
-
Begin statements End; -
Try statements Except Exception clauses... else Statements... End; -
Try statements Finally statements End; -
Case Expression of clauses Else statements... End;
Description
Ключевое слово End завершает блок или составную конструкцию, например объявления, операторы Case и т. д.
See also
Ключевое слово Begin
Ключевое слово Case
Ключевое слово Try
Except
Declaration
Try statements Except statements End;
Description
Используйте блоки Try-Except для обработки исключительных ситуаций, например для перехвата определенных исключений и выполнения полезных действий с ними, таких как запись в журнал ошибок или вывод понятного пользователю диалогового окна. Поскольку ключевое слово On не поддерживается в DelphiScript, используйте оператор Raise внутри блока Except и выводите только текстовое сообщение.
Example:
Try
X := Y/Z;
Except
Raise('A divide by zero error!');
End;
See also
Ключевое слово End
Ключевое слово Finally
Ключевое слово Try
Finally
Declaration
Try statements... Finally statements... End;
Description
Ключевое слово finally начинает часть finally блока try-finally. Операторы в блоке finally выполняются всегда, независимо от способа выхода из блока try: из-за исключения, exit или break. Использовать блок try-finally рекомендуется при создании и уничтожении объектов, а также при файловом вводе-выводе.
See also
Ключевое слово End
Ключевое слово Raise
Ключевое слово Try
For
Declaration
-
for variable := expression1 to expression2 do statement -
for variable := expression1 downto expression2 do statement
Description
Цикл for вычисляет выражения, задающие его границы, а затем многократно выполняет тело цикла, используя управляющую переменную, которая обновляется после каждой итерации.
Example:
For i := 0 to AnIndex - 1 Do
Begin
S := S + #13 + AString;
End;
ShowMessage(S);
See also
Ключевое слово Do
Ключевое слово DownTo
Ключевое слово Repeat
Ключевое слово To
Ключевое слово While
Ключевое слово With
Forward
Declaration
subroutine header; forward;
Description
Директива Forward позволяет объявить функцию или процедуру до ее вызова, указав заголовок (имя, параметры и тип возвращаемого значения) с директивой forward.
Function
Declaration
Function name (parameters) : return type;
Description
Function — это подпрограмма, возвращающая значение. Обратите внимание: указатели на функции в сценариях не допускаются, то есть определять функциональные типы нельзя. Переменные, объявленные внутри функции, недоступны за ее пределами.
Example
Function TestFunc(Min, Max : integer) : integer;
Begin
Result := Random(Max - Min +1);
End;
Goto
Declaration
goto label
Description
Оператор goto передает управление указанной метке. Меткой может быть любой идентификатор или строка цифр длиной до четырех знаков.
Example
Label StartHere;
// code
StartHere: //do anything;
Goto StartHere;
See also
Ключевое слово Label
If
Declaration
-
if condition then statement; -
if condition then statement1 else statement2;
Description
Условие для ключевого слова If должно быть логическим выражением. Ключевое слово Else необязательно.
Example
If A > B Then
ShowMessage('X>Y and A > B');
Else
ShowMessage('X>Y and A <=B');
End;
See also
Ключевое слово And
Ключевое слово Begin
Ключевое слово Or
Ключевое слово Then
Ключевое слово Else
Interface
Declaration
Interface
// Globally unique identifier string.
Methods
Properties
End;
Description
Ключевое слово interface обеспечивает доступ к существующему объекту в памяти и вызов его методов. Интерфейс может содержать только свойства и методы, но не данные. Поскольку интерфейсы не могут содержать данные, чтение и запись их свойств должны выполняться через методы. Важно отметить, что интерфейсы не имеют реализации: они лишь определяют контракт взаимодействия с существующим объектом в памяти.
Интерфейс можно рассматривать как точку доступа к существующему объекту в памяти компьютера, позволяющую читать и записывать данные через свойства интерфейса. Интерфейс запрашивает данные у связанного с ним объекта.
DelphiScript — это язык без типов, поэтому в нем нельзя определять новые типы, такие как записи, массивы или классы, а также связанные с ними интерфейсы.
Label
Declaration
label digits, identifier, ...;
Description
Ключевое слово label объявляет одну или несколько меток. Метка может быть последовательностью не более чем из четырех цифр или идентификатором. В пределах того же блока метку можно использовать для обозначения оператора, к которому выполняется переход с помощью оператора goto.
Example:
Label StartHere;
// code
StartHere: //do anything;
Goto StartHere;
See also
Ключевое слово Goto
Mod
Declaration
Integer expression mod integer expression
Description
Оператор mod выполняет операцию вычисления остатка от целочисленного деления. Результат A mod B — A - (A div B) * B.
See also
Функция Div
Nil
Declaration
const nil = pointer(0);
Description
Ключевое слово nil — это особое значение указателя, которое гарантированно отличается от любого действительного указателя и ни на что не указывает.
Not
Declaration
-
not boolean expression -
not integer expression
Description
Оператор not выполняет отрицание. Если операнд имеет логический тип, выполняется логическое отрицание. Not False = True и not true = false. Если операнд — целое число, оператор not выполняет инверсию каждого бита целочисленного значения, то есть операцию побитового дополнения.
Of
Declaration
case expression of
selector: expression1
...
end
Description
Ключевое слово Of используется в операторе case.
See also
Оператор Case
Or
Declaration
-
boolean expression or boolean expression -
integer expression or integer expression
Description
Оператор or выполняет логическое ИЛИ, если операнды имеют логический тип, или побитовое ИЛИ, если операнды — целые числа. Результат логического ИЛИ ложен, только если оба операнда ложны; в остальных случаях, когда хотя бы один операнд истинен, результат истинен.
See also
Ключевое слово And
Ключевое слово Not
Ключевое слово Shl
Ключевое слово Shr
Ключевое слово Xor
Procedure
Declaration
-
Procedure name; -
Procedure Name (Parameter, ...);
Description
Ключевое слово procedure объявляет подпрограмму, которая не возвращает значение. Переменные, объявленные внутри процедуры, недоступны за ее пределами. Обратите внимание: это ключевое слово можно использовать, но система выполнения скриптов его игнорирует.
Example:
Procedure TestRand(Var Rand: Integer; Max : Integer);
Begin
Rand := Random(Max);
End;
See also
Ключевое слово Function
Program
Declaration
Program Name;
declarations...
Block
Description
Ключевое слово program обозначает начало скрипта. Расширение файла скрипта — *.pas. Обратите внимание: это ключевое слово можно использовать, но система выполнения скриптов его игнорирует.
See also
Ключевое слово Function
Raise
Declaration
Raise statement;
Description
Ключевое слово raise связано с ключевым словом Try. Ключевое слово Raise можно использовать без параметров для повторного возбуждения последнего исключения. Его также можно использовать со строковым параметром, чтобы возбудить исключение с указанным сообщением.
Example:
Raise(Format('Invalid Value Entered : %d', \[Height]));
Обратите внимание, что ключевое слово On не поддерживается в DelphiScript, поэтому объекты Exception нельзя использовать в скриптах.
Repeat
Declaration
repeat
statements;
until boolean expression
Description
Операторы внутри блока Repeat Until выполняются повторно, пока логическое выражение не станет истинным.
Example:
Repeat
Write('Enter a value (0..9): ');
ShowMessage(IntToStr(I));
Until (I >= 0) and (I <= 9);
See also
Ключевое слово Until
Result
Declaration
Var result : Function return type;
Description
Каждая функция в скрипте должна использовать ключевое слово Result для возврата результата. Тип этой переменной соответствует типу возвращаемого значения функции.
See also
Ключевое слово Function
Shl
Declaration
value shl bits
Description
Оператор shl выполняет сдвиг целочисленного значения влево на Bits битовых позиций. Освободившиеся справа биты заполняются нулями.
See also
Ключевое слово And
Ключевое слово Not
Ключевое слово Or
Ключевое слово Shr
Ключевое слово Xor
Shr
Declaration
value shr bits
Description
Оператор shr выполняет сдвиг целочисленного значения вправо на Bits битовых позиций. Освободившиеся слева биты заполняются нулями.
See also
Ключевое слово And
Ключевое слово Not
Ключевое слово Or
Ключевое слово Shl
Ключевое слово Xor
String
Declaration
-
type string; -
type Name = string[Constant]
Description
Ключевое слово string обозначает строковый тип.
Then
Declaration
If expression then statement
Description
Ключевое слово Then является частью оператора If.
See also
Ключевое слово If
To
Declaration
For variable := expression1 to expression2 do statement
Description
Ключевое слово to является частью цикла for с возрастающим счетчиком.
Example
For i := 0 to AnIndex - 1 do
S := S + #13 + AString;
See also
Ключевое слово Downto
Ключевое слово For
Try
Declaration
-
Try statements finally statements end; -
Try statements except statements end;
Description
Ключевое слово try начинает оператор try-except или оператор try-finally. Эти два оператора связаны между собой, но предназначены для разных целей.
Try Finally
Операторы в блоке finally выполняются всегда, независимо от того, как происходит выход из блока try: из-за исключения, Exit или Break. Используйте блок try-finally для освобождения временных объектов и других ресурсов, а также для выполнения операций очистки. Обычно в подпрограмме достаточно одного оператора try-finally.
Example:
Reset(F);
Try
... // process file F
Finally
CloseFile(F);
End;
Try Except
Используйте try-except для обработки исключительных ситуаций, например для перехвата определенных исключений и выполнения полезных действий: записи в журнал ошибок или вывода понятного пользователю диалогового окна. Поскольку ключевое слово On не поддерживается в DelphiScript, используйте оператор Raise внутри блока Except.
Example:
Try
X := Y/Z;
Except
Raise('A divide by zero error!');
End;
See also
Ключевое слово Raise
Type
Declaration
Type Name = type declaration ...
Description
Ключевое слово Type объявляет тип переменной. Поскольку DelphiScript — язык без типов, объявлять переменные определенного типа необязательно, но это можно делать для улучшения читаемости скриптов. Все переменные в скрипте всегда имеют тип Variant. Основное ограничение при написании скриптов заключается в том, что нельзя объявлять записи или классы.
Приведение типов в скриптах игнорируется, поэтому типы в объявлениях переменных также игнорируются и могут быть опущены. Следовательно, следующие объявления корректны:
Example:
var a : integer;
var b : integer;
var c, d;
Типы параметров в объявлении процедуры или функции игнорируются и могут быть опущены. Например, следующий код корректен:
Function sum(a, b) : integer;
Begin
Result := a + b;
End;
В общем случае переменные типа Variant можно использовать для хранения данных любого типа, выполнения многочисленных операций и преобразований типов. Проверка типа и вычисление значения Variant выполняются во время выполнения. Компилятор не предупреждает о возможных ошибках в коде, которые можно обнаружить только при тщательном тестировании. В целом фрагменты кода, использующие Variant, можно считать интерпретируемым кодом, поскольку многие операции не могут быть определены до момента выполнения. Это может повлиять на скорость выполнения кода.
Example:
Var
V
Begin
// you can assign to it values of several different types:
V := 10;
V := 'Hello, World';
V := 45.55;
End;
See also
Ключевое слово Var
Unit
Declaration
-
Unit Name;
interface
declarations
implementation
declarations
statements
Initialization
statements
finalization
statements
end.
-
Unit Name;
interface
declarations
implementation
declarations
statements
begin
statements
end.
Ключевое слово unit начинает модуль — основную структурную единицу скрипта. Обратите внимание: это ключевое слово можно использовать, но система выполнения скриптов его игнорирует.
See also
Ключевое слово Function
Ключевое слово Program
Until
Declaration
Repeat
Statements;
Until boolean expression
Description
Ключевое слово until обозначает конец блока Repeat-Until. Операторы внутри блока Repeat-Until выполняются повторно, пока логическое выражение не станет истинным.
Example:
Repeat
Write('Enter a value (0..9): ');
ShowMessage(IntToStr(I));
Until (I >= 0) and (I <= 9);
See also
Ключевое слово Repeat
Uses
Declaration
Uses Unit Name, ...;
Description
Ключевое слово uses перечисляет имена модулей, импортируемых в текущий модуль. Объявление uses необязательно, поскольку система выполнения скриптов уже поддерживает модули, импортируемые в Altium Designer. Объявление uses можно добавить для улучшения читаемости.
Все модули одного проекта имеют доступ к глобальным переменным любого из этих модулей. Учитывайте это при объявлении переменных в модулях одного проекта.
API Client, PCB, Schematic и WorkSpace Manager в Altium Designer, а также модули SysUtils, Classes и другие модули Delphi импортированы и доступны для использования в скриптах, поэтому специально объявлять эти модули в скриптах не требуется.
See also
Более подробную информацию об API Altium Designer см. в документации Использование API Altium Designer.
Var
Declaration
Name : Type
Name : Type = Expression;
DelphiScript Variables
Все переменные в скрипте всегда имеют тип 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
// you can assign to it values of several different types:
V := 10;
V := 'Hello, World';
V := 45.55;
End;
Array elements
Тип элементов массива игнорируется и может быть опущен, поэтому следующие объявления эквивалентны:
Var x : array [1..2] of double;
Var x : array [1..2];
Illegal array example:
Type
TVertices = Array [1..50] Of TLocation;
Var
NewVertices : TVertices;
Legal array example:
Var
NewVertices : Array [1..50] of TLocation;
While
Declaration
while expression do statement
Description
Оператор while многократно выполняет инструкцию, пока выражение истинно.
See also
Ключевое слово Break
Ключевое слово Continue
Ключевое слово Do
Ключевое слово DownTo
Ключевое слово For
Ключевое слово Repeat
Ключевое слово To
Ключевое слово With
With
Declaration
with expression do statement
Description
Оператор With добавляет запись либо ссылку на объект, класс или интерфейс в область видимости для разрешения имён символов.
Normal version example:
Form.Canvas.Pen.Width := 2;
Form.Canvas.Pen.Color := clSilver;
With version example:
With Form.Canvas.Pen do
Begin
Width := 2;
Color := clSilver;
End;
See also
Ключевое слово Do
Xor
Declaration
- логическое выражение Xor логическое выражение
-
integer expression Xor integer expression
Description
Оператор xor выполняет операцию «исключающее ИЛИ» над своими операндами. Если операнды имеют логический тип, он возвращает логический результат: true, если операнды различаются, и false, если они одинаковы.
Для целых чисел оператор xor обрабатывает каждый бит своих операндов, устанавливая бит результата в 1, если соответствующие биты обоих операндов различаются, и в 0, если они одинаковы. Если один операнд имеет меньшую разрядность, чем другой, он дополняется слева битами 0.
See also
Ключевое слово And
Ключевое слово Not
Ключевое слово Or
Ключевое слово Shl
Ключевое слово Shr