変数

名前付け規約

"識別子のルールとガイドライン" では詳細を説明していますが、簡潔に説明すると、以下のようになります。

• ローカル変数名の最初の文字は、必ず、文字、もしくはパーセント記号 (%) のいずれかです。

  % 記号で始まる変数名は、"パーセント変数" と呼ばれ、その有効範囲の規則は異なります。コードでは、ローカル・パーセント変数の名前は、%Z または %z で初めます。他の名前はシステムで使用するために予約されています。

• ローカル変数名を含め、すべての変数名では、大文字と小文字が区別されます。例えば、MYVAR、MyVar および myvar は、3 つの異なるローカル変数となります。

• ローカル変数名は、現在のプロセスに一意であることが必要です。その他のプロセスは、同じ名前のローカル変数を持つことができます。

• プロセス・プライベート・グローバルまたはグローバルは、ローカル変数と同じ (見かけ上の) 名前を持つことができます。例えば、myvar、^||myvar、^myvar は、3 つの異なる変数となります。

• ローカル変数には、添え字を使用できます。"添え字に関する規則" を参照してください。

規則に準拠しないローカル変数名の場合、<SYNTAX> エラーが生成されます。ただし例外が 1 つあり、先頭がアンダースコア文字でその後に文字が続く変数名を作成しようとすると、<_CALLBACK SYNTAX> エラーが生成されます。例えば、SET x=_a です。

ローカル変数の範囲

ObjectScript コードでは、ローカル変数はすべてパブリックです。このため、現在のコンテキスト内で ObjectScript コードのプロセスによって実行されるいずれの処理からもローカル変数にアクセスできます。ローカル変数値へのアクセスには、以下のような制約があります。

• NEW コマンドは、新しいローカル変数コンテキストを作成します。引数なしの NEW は、既存のローカル変数に何も定義されていない新しいコンテキストを作成します。NEW var は、ローカル変数 var が定義されていない新しいコンテキストを作成します。QUIT コマンドは、前のローカル変数コンテキストに戻します。

• プロシージャ・ブロック内では、ローカル変数は既定でプライベートです。プライベート・ローカル変数は、そのプロシージャ・ブロック内でのみ定義されます。

  プロシージャ・ブロック内のローカル変数は以下のように動作します。

  • プライベート変数。プロシージャ・ブロック内で使用されるローカル変数は、プライベート変数です。パブリック変数として宣言されるか % 変数でない限り、そのプロシージャ・ブロック内でのみ定義されます。既定では、スタジオで生成されるすべてのオブジェクト・メソッドがプロシージャ・ブロックを使用するため (プロシージャ・ブロック・クラス・キーワードは、クラス定義内で設定されます)、メソッドで生成されるすべての変数がプライベート変数です。プロシージャ・ブロック内のプライベート変数に NEW コマンドを使用することはできません。

  • パブリック変数。プロシージャ・ブロックでは、ローカル変数のリストをパブリック変数として明示的に宣言できます。パブリック変数として宣言された変数の値にはプロシージャ・ブロックの外部からアクセスできます。パブリック変数のこのコンマ区切りリストには、存在しない変数や % 変数を含めることができます。プロシージャ・ブロック内のパブリック変数には NEW コマンドを使用できます。

    2 つのローカル変数 var1 と var2 のパブリック変数リストは、MyProc(x,y) [var1,var2] PUBLIC { code body } のように指定します (PUBLIC キーワードはプロシージャがパブリックであることを指定するもので、パブリック変数リストとは関係ないことに注意してください)。パブリック変数は、コンマ区切りのリストで指定します。添え字なしのローカル変数のみを指定できます。パブリック変数リストに添え字なしの変数を指定すると、その添え字レベルもすべてパブリックになります。単純なオブジェクト参照 (OREF) のみを指定できます。パブリック変数リストに OREF を指定すると、そのオブジェクト・プロパティもすべてパブリックになります。パブリック変数リストには、未定義の変数を含めることができます。

  • % 変数。名前が “%” で始まるローカル変数は、自動的にパブリック変数として宣言されます。これにより、プロセス内のすべてのコードから参照できる変数を、パブリックとして明示的にリストすることなく定義できます。“%Z” または “%z” で始まる変数のみをアプリケーション・コードで使用できます。その他すべての % 変数は、規則に従ってシステムで使用するために予約されています。この規則の詳細は、"識別子のルールとガイドライン" を参照してください。プロシージャ・ブロック内の % 変数には NEW コマンドを使用できます。

  これらのメカニズムの詳細は、"プロシージャ変数" を参照してください。

• XECUTE コマンドは、既定でローカル変数をパブリックとして定義します。XECUTE コマンド内で、明示的にローカル変数をプライベートとして定義できます。ローカル変数をプライベートまたはパブリックのいずれかとして明示的に定義する方法の詳細は、"XECUTE" を参照してください。

引数の指定なしで WRITE または ZWRITE コマンドを使用すると、現在定義されているローカル変数をすべてリストできます。また、KILL コマンドを使用して、ローカル変数を削除できます。

名前付け規約

プロセス・プライベート・グローバル名は、次のいずれかの形式となります。

^||name 
^|"^"|name 
^["^"]name 
^["^",""]name

これらの 4 つの接頭語は同等で、4 つはいずれも同じプロセス・プライベート・グローバルを参照します。最初の形式 (^||name) がもっとも一般的で、新しいコードに推奨されるものです。2 番目 ～ 4 番目の形式は、グローバルを定義する既存のコードとの互換性のために提供されています。

接頭語を除き、プロセス・プライベート・グローバルは、"識別子のルールとガイドライン" で説明するように、通常のグローバルと同じ名前付け規約を使用します。概要は以下のようになります。

• 最初の文字 (2 番目の垂直バーの後) は、文字、もしくはパーセント記号 (%) のいずれかにする必要があります。

  % で始まるプロセス・プライベート変数名は、"パーセント変数" と呼ばれ、その有効範囲の規則は異なります。コードでは、これらの変数の名前は、%Z または %z で始めます。他の名前はシステムで使用するために予約されています。例えば、^||%zmyvar のようになります。

• ローカル変数とは異なり、グローバル名 (プロセス・プライベート・グローバルを含む) には、Unicode 文字 (ASCII 255 よりもコード値が大きい文字) を使用できません。プロセス・プライベート・グローバル名に Unicode 文字を使用すると <WIDE CHAR> エラーが発生します。

• このプロセス・プライベート・グローバル名を含め、すべての変数名では、大文字と小文字が区別されます。

• プロセス・プライベート・グローバル名は、プロセス内で一意である必要があります。

• ローカル変数とは異なり、プロセス・プライベート・グローバル名は、接頭語を除き最大 31 文字です。31 文字より長い名前を指定することもできますが、最初の 31 文字のみが使用されます。このため、プロセス・プライベート・グローバル名は最初の 31 文字内で一意である必要があります。

• その他の変数と同様に、プロセス・プライベート・グローバルには添え字を使用できます。"添え字に関する規則" を参照してください。

プロセス・プライベート・グローバルのリスト

^$GLOBAL() の ^$||GLOBAL() 構文形式を使用して、現在のプロセスに属するプロセス・プライベート・グローバルに関する情報を返すことができます。

^GETPPGINFO ルーチンを使用して、現在のすべてのプロセス・プライベート・グローバルの名前およびそれらのスペース割り当てをブロック単位で表示できます。^GETPPGINFO はプロセス・プライベート・グローバルの添え字も値もリストしません。プロセス ID (pid) を指定することで、特定プロセスのプロセス・プライベート・グローバルを表示できます。また、ワイルドカード文字列 (*) を指定することで、すべてのプロセスのプロセス・プライベート・グローバルを表示できます。^GETPPGINFO を呼び出すには %SYS ネームスペースで作業する必要があります。

以下の例では、^GETPPGINFO を使用して、現在のすべてのプロセスのプロセス・プライベート・グローバルをリストします。

  SET ^||flintstones(1)="Fred"
  SET ^||flintstones(2)="Wilma"
  NEW $NAMESPACE
  SET $NAMESPACE="%SYS"
  DO ^GETPPGINFO("*")

^GETPPGINFO ルーチンは、以下のように引数を取ります。

 do ^GETPPGINFO("pdf","options","outfile")

これらの引数は以下のとおりです。

• pdf はプロセス ID または * ワイルドカードにすることができます。

• options は次の文字列のあらゆる組み合わせにすることができます。

  • b (バイト数で値を返す)

  • Mnn (nn 個以上のブロックを使用するプロセス・プライベート・グローバルがあるプロセスのみをリストする)

    プロセス・プライベート・グローバルがないプロセスをリストに含めるには M0 を使用します。

    プロセス・プライベート・グローバルがないプロセスはリストから除外し、グローバル・ディレクトリ・ブロックのみがあるプロセスを含めるには M1 を使用します (これが既定です)。

    プロセス・プライベート・グローバルがないプロセスをリストから除外し、グローバル・ディレクトリ・ブロックのみがあるプロセスも除外するには M2 を使用します。

  • S (outfile と共に使用して画面表示を抑制)

  • T (プロセスの合計数のみを表示)

• outfile は、^GETPPGINFO 出力を受け取る CSV (コンマ区切り値) 形式ファイルのファイル・パスです。

次の例では、プロセス・プライベート・グローバルを ppgout という名前の出力ファイルに書き込みます。S オプションで画面表示を抑制し、出力を 500 ブロック以上使用するプロセス・プライベート・グローバルがあるプロセスのみを M500 オプションで表示します。

  NEW $NAMESPACE
  SET $NAMESPACE="%SYS"
  DO ^GETPPGINFO("*","SM500","/home/myspace/ppgout")