識別子の命名規則
この章では、4D ランゲージにおけるさまざまな要素 (変数、テーブル、オブジェクト、フォームなど) の命名規則について説明します。
基本ルール
以下の命名規則は 4D フレームワークにおいて全般的に適用されます:
- 識別子の 1文字目は、半角アルファベット、アンダースコア ("_")、あるいはドル記号 ("$") で始めます。
- その後の文字には、半角アルファベット文字・数字・スペース・アンダースコアを使用ができます。
- ピリオド (".") および大カッコ ("[ ]") は、テーブル・フィールド・メソッド・変数の名称に使用できません。
- カンマ (,)・スラッシュ(/)・引用符(")・コロン(:) の使用は禁止されています。
- 演算子として用いられる記号 ("*" や "+" など) の使用は禁止されています。
- 予約語を使用しないでください。予約語にはコマンド名 (
Date
,Time
等)、キーワード (If, For 等)、そして定数が含まれます。 - 名前の最後につけたスペースは無視されます。
ORDA やオブジェクトプロパティに適用される追加ルール
- スペースは使えません。
- ピリオド (".") および大カッコ ("[ ]") は使用できません。
- 大文字・小文字は区別されます。
SQL で処理する場合の追加ルール
- 文字 _0123456789abcdefghijklmnopqrstuvwxyz のみを使用できます。
- 名前に SQLキーワード (コマンド、属性 等) が含まれていてはなりません。
注: ストラクチャーエディターのインスペクター下部にある ”SQL” エリアには、テーブル名やフィールド名として許可されない文字があると警告が表示されます。
テーブル
大カッコ内 [...] に名前を入れることで、テーブルを表します。 テーブル名は、31文字以内で指定します。
例:
DEFAULT TABLE([Orders])
FORM SET INPUT([Clients];"Entry")
ADD RECORD([Letters])
フィールド
フィールドが属するテーブルを最初に指定することで、フィールドを表します。 フィールド名はテーブル名のすぐ後に続けます。 フィールド名は31文字以内で指定します。
例:
[Orders]Total:=Sum([Line]Amount)
QUERY([Clients];[Clients]Name="Smith")
[Letters]Text:=Capitalize text([Letters]Text)
インタープロセス変数
名前の先頭にインタープロセス記号 (<>
) を付けることによって、インタープロセス変数を表します。
インタープロセス変数名は、<>
記号を除いて最大31文字以内で指定することができます。
例:
<>vlProcessID:=Current process
<>vsKey:=Char(KeyCode)
If(<>vtName#"")
プロセス変数
(<>
記号や $ 記号から始まらない) 名前を使用して、プロセス変数を表します。 プロセス変数の名前は、最大31文字までの長さで指定できます。
例:
<>vrGrandTotal:=Sum([Accounts]Amount)
If(bValidate=1)
vsCurrentName:=""
ローカル変数
ドル記号 ($) を名前の先頭につけてローカル変数を表します。 ローカル変数名は、ドル記号 ($) を除いて31文字まで指定することができます。
例:
For($vlRecord;1;100)
If($vsTempVar="No")
$vsMyString:="Hello there"
配列
配列は、配列作成時に配列宣言コマンド (ARRAY LONGINT 等) に渡す名前でもって表されます。 配列は変数であり、スコープに基づいて次の3種類があります:
- インタープロセス配列
- プロセス配列
- ローカル配列
インタープロセス配列
インタープロセス配列の名前は、先頭にインタープロセス記号 (<>
) が付きます。
インタープロセス配列名は、インタープロセス記号 (<>
) を除いて31文字以内で指定します。
例:
ARRAY TEXT(<>atSubjects;Records in table([Topics]))
SORT ARRAY(<>asKeywords;>)
ARRAY INTEGER(<>aiBigArray;10000)
プロセス配列
(<>
記号や $ 記号から始まらない) 名前を使用して、プロセス配列を表します。 プロセス配列名は31文字以内で指定します。
例:
ARRAY TEXT(atSubjects;Records in table([Topics]))
SORT ARRAY(asKeywords;>)
ARRAY INTEGER(aiBigArray;10000)
ローカル配列
配列名がドル記号 ($) で始まるものは、ローカル配列です。 ローカル配列名は、ドル ($) 記号を除いて31文字以内で指定します。
例:
ARRAY TEXT($atSubjects;Records in table([Topics]))
SORT ARRAY($asKeywords;>)
ARRAY INTEGER($aiBigArray;10000)
配列の要素
中カッコ ("{ }") を使用して、インタープロセス配列、プロセス配列、ローカル配列の要素を参照します。 参照される配列要素は数式で表されます。
例:
// インタープロセス配列の要素を指定します
If(<>asKeywords{1}="Stop")
<>atSubjects{$vlElem}:=[Topics]Subject
$viNextValue:=<>aiBigArray{Size of array(<>aiBigArray)}
// プロセス配列の要素を指定します
If(asKeywords{1}="Stop")
atSubjects{$vlElem}:=[Topics]Subject
$viNextValue:=aiBigArray{Size of array(aiBigArray)}
// ローカル配列の要素を指定します
If($asKeywords{1}="Stop")
$atSubjects{$vlElem}:=[Topics]Subject
$viNextValue:=$aiBigArray{Size of array($aiBigArray)}
二次元配列の要素
中カッコ {...} を 2回使用して、2次元配列の要素を参照 します。 参照される要素は2組の中カッコ内の2つの数式で表されます。
例:
// 2次元インタープロセス配列の要素を指定します
If(<>asKeywords{$vlNextRow}{1}="Stop")
<>atSubjects{10}{$vlElem}:=[Topics]Subject
$viNextValue:=<>aiBigArray{$vlSet}{Size of array(<>aiBigArray{$vlSet})}
// 2次元プロセス配列の要素を指定します
If(asKeywords{$vlNextRow}{1}="Stop")
atSubjects{10}{$vlElem}:=[Topics]Subject
$viNextValue:=aiBigArray{$vlSet}{Size of array(aiBigArray{$vlSet})}
// 2次元ローカル配列の要素を指定します
If($asKeywords{$vlNextRow}{1}="Stop")
$atSubjects{10}{$vlElem}:=[Topics]Subject
$viNextValue:=$aiBigArray{$vlSet}{Size of array($aiBigArray{$vlSet})}
オブジェクト属性
オブジェクト記法が有効化されているとき、ドット (".") をオブジェクト名 (あるいは属性名) と属性名の間に置くことでオブジェクト属性 (オブジェクトプロパティとも呼びます) を指定します。 属性名は255文字以内の文字列で指定し、また大文字と小文字を区別することに注意してください。
例:
myObject.myAttribute:="10"
$value:=$clientObj.data.address.city
注: オブジェクト属性名にはさらにルールが適用されます (オブジェクト属性は ECMAScript の仕様に沿う必要があります)。 詳細については、オブジェクト記法の使用 を参照ください。
フォーム
フォームの名前は文字列を使用して表します。 フォーム名は31文字以内で指定します。
例:
FORM SET INPUT([People];"Input")
FORM SET OUTPUT([People];"Output")
DIALOG([Storage];"Note box"+String($vlStage))
フォームオブジェクト
フォームオブジェクトを引数としてコマンドに渡すには、文字列の名称の前に、任意パラメーターである * 記号を使います。 オブジェクト名には最大で255バイトまで含めることができます。
例:
OBJECT SET FONT(*;"Binfo";"Times")
注: フォームオブジェクト (ボタン、リストボックス、入力可能な変数など) と 4Dランゲージのオブジェクト型を混同しないようにしてください。 4Dランゲージのオブジェクト型はオブジェクト記法と専用のコマンドを使用して作成し、管理されます。
プロジェクトメソッド
プロジェクトメソッド (プロシージャーおよび関数) は名前によって表されます。 メソッド名は31文字以内で指定します。
注: 結果を返さないプロジェクトメソッドはプロシージャーとも呼ばれます。 結果を返すプロジェクトメソッドを関数と呼びます。
例:
If(New client)
DELETE DUPLICATED VALUES
APPLY TO SELECTION([Employees];INCREASE SALARIES)
Tip: 4Dのビルトインコマンドと同じ命名規約を利用することは良いプログラミングテクニックです。 メソッド名には大文字を使用しますが、メソッドが関数の場合には最初の文字だけを大文字にします。 このように命名することにより、数ヶ月後に保守のためデータベースを再度開いたときに、エクスプローラーウィンドウでその名前を見ただけで、メソッドが結果を返すかどうかがわかります。
注: メソッドを呼び出すには、そのメソッド名を入力します。 しかし ON EVENT CALL
など一部の 4Dのビルトインコマンドやプラグインコマンドにメソッド名を引数として渡す場合には文字列 (ダブルクォートで括る) として渡します。 例:
例:
// このコマンドはメソッド (関数) またはフォーミュラを受け取ります
QUERY BY FORMULA([aTable];Special query)
// このコマンドはメソッド (プロシージャ) またはステートメントを受け取ります
APPLY TO SELECTION([Employees];INCREASE SALARIES)
// このコマンドはメソッド名を文字列で受け取ります
ON EVENT CALL("HANDLE EVENTS")
プロジェクトメソッドには引数を渡すことができます。 メソッドに引数を渡す場合は、メソッド名の後の括弧 () に引数を入れ、 セミコロン (;) で区切ります。 引数は受け取り側のメソッドにて、受け取り順に番号を振られたローカル変数 ($1, $2, ...$n) に格納されます。 さらに、連続する複数の引数は、${n}というシンタックスを用いて使用できます。nは数値で引数の番号を示します。
関数の戻り値は、ローカル変数 $0 に代入することで指定します。
例:
// DROP SPACES メソッド内で、$1 はフィールド [People]Name へのポインターです
DROP SPACES(->[People]Name)
// Calc creator メソッド内で、
//- $1 は数値の 1
//- $2 は数値の 5
//- $3 テキストまたは文字列の "Nice"
//- 戻り値は $0 に代入されます
$vsResult:=Calc creator(1;5;"Nice")
// Dump メソッド内で、
//- 3つの引数はテキストまたは文字列です
//- これらの引数は $1, $2, $3 で参照できます
//- また、これらの引数を ${$vlParam} で間接的に参照することもできます ($vlParamは1, 2, 3)
//- 戻り値は $0 に代入されます
vtClone:=Dump("is";"the";"it")
プラグインコマンド
プラグインにより定義された名前を使用して、プラグインコマンドを表します。 プラグインコマンド名は 31文字以内で指定します。
例:
$error:=SMTP_From($smtp_id;"henry@gmail.com")
セット
スコープに基づき、2種類のセットがあります:
- インタープロセスセット
- プロセスセット
4D Server には以下もあります:
- クライアントセット
インタープロセスセット
インタープロセスセットの名前は、先頭にインタープロセス記号 (<>
) が付きます。
インタープロセスセット名は、インタープロセス記号 (<>
) を除いて255文字以内で指定します。
プロセスセット
セットの名前を表す文字列を使用してプロセスセットを表します (<>
記号も $ 記号も名前の先頭につきません) 。 プロセスセット名は、255文字以内で指定します。
クライアントセット
クライアントセット名は、先頭にドル記号 ($) を指定します。 クライアントセット名は、ドル記号を除いて255文字以内で指定します。
注: セットはサーバーマシン上で保守されます。 効率や特殊目的のために、クライアントマシン上でローカルにセットを使用したい場合があります。 このような場合にクライアントセットを使用します。
例:
// インタープロセスセット
USE SET("<>Deleted Records")
CREATE SET([Customers];"<>Customer Orders")
If(Records in set("<>Selection"+String($i))>0)
// プロセスセット
USE SET("Deleted Records")
CREATE SET([Customers];"Customer Orders")
If(Records in set("<>Selection"+String($i))>0)
// クライアントセット
USE SET("$Deleted Records")
CREATE SET([Customers];"$Customer Orders")
If(Records in set("$Selection"+String($i))>0)
命名セレクション
スコープに基づき、2種類の命名セレクションが存在します:
- インタープロセス命名セレクション
- プロセス命名セレクション
インタ-プロセス命名セレクション
インタープロセス命名セレクションの名前は、先頭にインタープロセス記号 (<>
) が付きます。
インタープロセス命名セレクション名は、インタープロセス記号 (<>
) を除いて255文字以内で指定します。
プロセス命名セレクション
プロセス命名セレクションの名前を表す文字列式を使用してプロセスセットを表します (<>
記号も $ 記号も名前の先頭につきません) 。 インタープロセスセット名は255文字以内で指定します。
例:
// インタープロセス命名セレクション
USE NAMED SELECTION([Customers];"<>ByZipcode")
// プロセス命名セレクション
USE NAMED SELECTION([Customers];"<>ByZipcode")
プロセス
シングルユーザー版およびクライアント/サーバー版のクライアント側において、2種類のプロセスがあります:
- グロ-バルプロセス
- ロ-カルプロセス
グロ-バルプロセス
$記号以外から始まる文字列を使用してグローバルプロセスの名前を表します。 グローバルプロセス名は、255文字以内で指定します。
ローカルプロセス
名前の前にドル記号 ($) をつけてローカルプロセスを表します。 ローカルプロセス名は、ドル記号 ($) を除いて255文字以内で指定します。
例:
// グローバルプロセス "Add Customers" を開始します
$vlProcessID:=New process("P_ADD_CUSTOMERS";48*1024;"Add Customers")
// ローカルプロセス "$Follow Mouse Moves" を開始します
$vlProcessID:=New process("P_MOUSE_SNIFFER";16*1024;"$Follow Mouse Moves")
命名規則のまとめ
次の表は、4Dの命名規則についてまとめています。
識別子 | 最大 長 | 例題 |
---|---|---|
テーブル | 31 | [Invoices] |
フィールド | 31 | [Employees]Last Name |
インタープロセス変数/配列 | <> + 31 | <>vlNextProcessID |
プロセス変数/配列 | 31 | vsCurrentName |
ローカル変数/配列 | $ + 31 | $vlLocalCounter |
オブジェクト属性 | 255 | $o.myAttribute |
フォーム | 31 | "My Custom Web Input" |
フォームオブジェクト | 255 | "MyButton" |
プロジェクトメソッド | 31 | M_ADD_CUSTOMERS |
プラグインコマンド | 31 | PDF SET ROTATION |
インタープロセスセット | <> + 255 | "<>Records to be Archived" |
プロセスセット | 255 | "Current selected records" |
クライアントセット | $ + 255 | "$Previous Subjects" |
命名セレクション | 255 | "Employees A to Z" |
インタ-プロセス命名セレクション | <> + 255 | "<>Employees Z to A" |
ローカルプロセス | $ + 255 | "$Follow Events" |
グロ-バルプロセス | 255 | "P_INVOICES_MODULE" |
セマフォー | 255 | "mysemaphore" |
注: 非ローマ文字 (日本語など) が識別子に使用された場合、その最大長は短かくなることがあります。
名前が重複する場合
データベース内の要素に対して、ぞれぞれ重複しない名前を使用するようにしてください。 特定の要素が別タイプの要素と同じ名前を持つ場合 (たとえばフィールドが Person という名前で、変数も Person という名前の場合)、4Dは優先順位システムを使用します。
4Dは、メソッドで使用される名前を次の順位で識別します:
- フィールド
- コマンド
- メソッド
- プラグインコマンド
- 定義済み定数
- 変数
たとえば、4Dには Date
というビルトインコマンドがあります。 メソッドに Date という名前を付けても、4Dはビルトインコマンドの Date
として認識し、メソッドとしては認識しません。 つまり、そのメソッドの呼び出しはできないということです。 しかしながら、フィールドを "Date" と命名した場合には、4Dは Date
コマンドの代わりにフィールドとしての使用を試みます。