DelphiScriptとDelphiの違い
概略
- Variant型に基づく変数、実行時の型変換、およびそれらがテストやパフォーマンスに与える影響を理解します。
- 配列、集合演算子、入れ子のルーチン、例外処理など、Delphiの機能のうち、サポートされていないものや動作が異なるものを学びます。
- PCB上にビアを作成する例を通じて、既存のクラスやAltium Designerのオブジェクトインターフェースの使い方を確認します。
DelphiScriptとDelphiの違い
このセクションでは、DelphiScriptスクリプト言語とEmbarcaderoのDelphiプログラミング言語の主な違い、およびそれらがAltium Designer APIの使用にどのように関わるかを説明します。
Altium Designerのスクリプトシステムは型なしのDelphiScript言語を使用するため、スクリプトにはデータ型がありません。可読性を高めるために変数とその型を宣言したり、関数、プロシージャ、メソッドのパラメーターの型を指定したりすることはできますが、DelphiScriptはスクリプトの実行時に未宣言の変数を変換します。そのため、たとえばレコードやクラスを定義することはできません。
DelphiScriptの変数
スクリプト内の変数はすべてVariant型であり、変数宣言の型は無視されるため、省略できます。したがって、次の3つの宣言はいずれも有効です。
Var
a : Integer;
Var
b : Integer;
Var
c, d;
プロシージャや関数の宣言におけるパラメーターの型も無視されるため、省略できます。たとえば、次のコードは有効です。
Function Sum(a, b) : Integer;
Begin
Result := a + b;
End;
一般に、Variantはあらゆるデータ型の格納に使用でき、さまざまな演算や型変換を実行できます。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のコンパイル済みコードよりも低速です。
スクリプト内の集合
Delphi言語には集合型があり、集合演算子もサポートされていますが、DelphiScriptには集合型がなく、集合演算子もサポートされていません。
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;
ネストされたルーチン
ネストされたルーチンはサポートされていますが、最上位の関数の変数をネストされたルーチンから使用することはできません。
配列要素
配列要素の型は無視されるため、省略できます。したがって、次の2つの宣言は同等です。
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に文字列パラメーターを指定すると、指定したメッセージ文字列で例外を発生させることができます。DelphiScriptではOnキーワードがサポートされていないため、Exceptionオブジェクトはサポートされていません。
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.
また、Uses句内のinディレクティブは無視されます。
無視されるキーワード
DelphiScriptでは、interface、implementation、program、unitキーワードは無視されます。スクリプト内に記述しても効果はありませんが、これらのキーワードによってスクリプトの可読性を高めることができます。
サポートされていないキーワード
DelphiScriptでは、次のキーワードはサポートされていません。
-
as, asm, class, dispinterface, exports, finalization, inherited, initialization, inline, interface, is, library, object, out, property, record, resourcestring, set, supports, type.
DelphiScriptでは、次のDelphi RTL関数はサポートされていません。
-
Abort, Addr, Assert, Dec, FillChar, Finalize, Hi, High, Inc, Initialize, Lo, Low, New, Ptr, SetString, SizeOf, Str, UniqueString, VarArrayRedim, VarArrayRef, VarCast, VarClear, VarCopy.
DelphiのWindowsユニット(windows.pasファイル)の関数はサポートされていません(たとえば、RGB関数はサポートされていません)。
スクリプトでのAltium Designer APIの使用
DelphiScriptを使用して独自のレコード型やクラス型を作成し、スクリプト内でインスタンス化することはできませんが、Altium Designer APIの一部のクラスは使用できます。たとえば、TStringListクラスとTListクラスをインスタンス化し、スクリプトの要件に合わせて、データ(通常は同じ型のデータ)を格納するコンテナーとして使用できます。
Altium Designerのオブジェクトを表すAPIのオブジェクトインターフェースは、スクリプトで使用できます。たとえば、回路図オブジェクトインターフェースとPCBオブジェクトインターフェースを使用して、回路図ドキュメントやPCBドキュメント上の設計オブジェクトを更新できます。
慣例として、インターフェース名の先頭には「I」が付けられます。たとえば、IPCB_Boardは既存のPCBドキュメントのインターフェースを表します。
スクリプト内でのPCBインターフェースの使用例:
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
- PCBサーバーAPI
- 回路図サーバーAPI
- ワークスペースマネージャーサーバーAPI
- 統合ライブラリAPI
- Altium Designer API関数
- パラメトリックプロセス
詳細情報
ダウンロード可能なスクリプト集に含まれるスクリプトを参照すると、Altium Designerのオブジェクトインターフェースや関数、およびDelphiのオブジェクトや関数がスクリプト内でどのように使用されているかを確認できます。
Altium Designer用のスクリプトの作成については、メインのスクリプティングドキュメントを参照してください。
スクリプトでの設計オブジェクトとそのインターフェースの使用方法については、Altium Designer APIの使用ガイドを参照してください。
Altium Designerの各種APIと、スクリプトで使用するインターフェースオブジェクトについては、Altium Designer APIリファレンスを参照してください。