BREAK (ObjectScript)

構文

BREAK:pc extend
B:pc extend

BREAK:pc flag
B:pc flag

説明

BREAK コマンドには、以下の 3 つの構文形式があります。

• 引数なしの BREAK は、現在の場所でコードの実行を中断します。

• BREAK extend は、一定のブレークポイント間隔でコードの実行を中断します。

• BREAK flag は、CTRL-C の中断を有効または無効にします。

引数

引数なしの BREAK

引数なしの BREAK は、遭遇時にコードの実行を中断します。引数なしの BREAK は、プログラムのソース・コードで使用できます。後置条件式は付けても付けなくてもかまいません。このコマンドは、その時点でプログラムの実行を中断し、制御をターミナル・プロンプトに戻します。引数なしの BREAK は、デバッグ目的で使用されます。

ルーチン内に引数なしの BREAK を含めると、ブレークポイントが設定されます。ブレークポイントはルーチンの実行を中断し、プロセスをターミナル・プロンプトに戻します。コードにブレークポイントを埋め込むことによって、デバッグを行う特定のコンテキストを設定できます。実行中に BREAK に遭遇すると、InterSystems IRIS はルーチンを中断し、ターミナルに戻ります。そして、他の ObjectScript コマンドを使用して、デバッグを実行できます。例えば、WRITE コマンドを使用して、中断中の箇所の変数値を調べ、SET コマンドを使用して、これらの変数やそれ以外の変数に新しい値を指定することができます。ルーチン行エディタ (XECUTE ^%) を呼び出して、ルーチンを修正することもできます。BREAK を使用してルーチンの実行を中断した後、引数なしの GOTO を使用して、通常の実行を再開することができます。または、GOTO コマンドの引数としてこの場所を指定して、他の場所から実行を再開することもできます。

You can configure argumentless BREAK behavior for the current process using the BreakMode()Opens in a new tab method of the %SYSTEM.ProcessOpens in a new tab class. You can configure argumentless BREAK behavior system-wide by setting the BreakModeOpens in a new tab property in the Config.MiscellaneousOpens in a new tab class.

すべての引数なしのコマンドと同様に、引数なしの BREAK と、同じ行にあるその直後のコマンドとの間に少なくとも 2 つの空白を挿入する必要があります。

引数なしの BREAK を条件付きで使用する

コード内の引数なしの BREAK コマンドに条件を指定すると、ルーチンを変更しなくても、単に変数を設定するだけで同じコードを再実行できるので便利です。例えば、ルーチンに以下の行があるとします。

   BREAK:$DATA(debug)

変数 debug を設定すると、ルーチンを中断し、ジョブをターミナル・プロンプトに戻すことができます。また、変数 debug をクリアすると、ルーチンの実行を継続できます。

標準のブレークポイントを設定する BREAK の拡張引数

中断したいルーチンのすべての位置に、引数なし BREAK コマンドを置く必要はありません。BREAK には "拡張された" 一連の引数 (extend) があり、この引数を使用して、引数なしの BREAK コマンドがコード全体に散在しているかのように、定期的にルーチンを中断させることができます。以下のテーブルは、さまざまな BREAK コマンド拡張引数です。

BREAK "S" および BREAK "L" は、トークンを生成する文で中断します。すべての ObjectScript コマンドおよび行がトークンを生成するわけではありません。例えば、BREAK "S" および BREAK "L" は、どちらもラベル行、コメント、および TRY 文を無視します。BREAK "S" は CATCH 文でブレークしますが (CATCH ブロックが入力された場合)、BREAK "L" はブレークしません。

BREAK "S" と BREAK "L" 間で 1 つ異なる点は、多くのコマンド行が複数のトークンを生成するため、複数のステップで構成されることです。必ずしもこれが明白であるとは限りません。例えば、以下はすべて 1 つの行 (および 1つの ObjectScript コマンド) で記述されていますが、BREAK "S" は、それぞれを 2 つのステップとして解析します。

  KILL x,y
  SET x=1,y=2
  IF x=1,y=2 {
     WRITE "hello",! }

BREAK "S" parses command postconditionals. 後置条件式が True (コマンドを実行する) の場合、カーソルは後置条件式の後をポイントするように再配置されます。

ブレークポイント後のコード実行を再開するには、ターミナル・プロンプトで GOTO コマンド (短縮形は G) を発行します。詳細は、"コマンド行ルーチンのデバッグ" を参照してください。

BREAK "OFF" コマンドの使用法は、以下の一連のコマンドの使用法と類似しています。

  ZBREAK /CLEAR
  ZBREAK /TRACE:OFF
  ZBREAK /DEBUG:""
  ZBREAK /ERRORTRAP:ON
  BREAK "C-"

中断を有効または無効にする BREAK フラグ

BREAK flag を使用して、CTRL-C などのユーザの中断を有効にするか無効にするかを制御できます。これらの無効/有効オプション間の実質的な相違点は以下のとおりです。

BREAK 0 および BREAK 1 は、重要な一連のコマンドが CTRL-C シグナルによって中断されないコード・ブロックを作成するために使用できます。ただし、そのようなブロックでのループは、インタラクティブ・ユーザが CTRL-C を使用して中断するのが難しくなる場合があります。これは、CTRL-C トラップの検出と CTRL-C シグナルのポーリングとの間にわずかな遅延が存在するためです。この遅延により、次の BREAK コマンド・ループで CTRL-C のユーザの中断を破棄できる場合があります。

BREAK 4 および BREAK 5 を含むプログラム・ブロックは、インタラクティブ・ユーザが CTRL-C を使用してこのブロックでのループ処理を中断できる機能に影響を与えることなく、重要な一連のコマンドが CTRL-C シグナルによって中断されないコードを作成するために使用できます。

BREAK の既定の flag 動作は、以下のようにログイン・モードに依存します。

• ターミナル・プロンプトでログインする場合、既定は BREAK 1 となります。CTRL-C などの割り込みは、常に有効化されています。OPEN コマンドまたは USE コマンドに指定された B (/break) プロトコルには何も効果がありません。

• ルーチンからコードを実行する場合、既定は BREAK 0 となります。CTRL-C などの割り込みは、OPEN または USE コマンドで指定される B (/break) プロトコルによって有効または無効にされています。

OPEN および USE モード・プロトコルの詳細は、"ターミナル入出力" を参照してください。

BREAK flag の例

以下の例では、$ZJOB を使用して、中断を有効にするか無効にするかを決定します。

  BREAK 0
    DO InterruptStatus
  BREAK 1
    DO InterruptStatus
    WRITE "all done"
InterruptStatus()
  IF $ZJOB\4#2=1 {WRITE "Interrupts enabled",!}
  ELSE {WRITE "Interrupts disabled",!}

以下の例では、一連の数値のユーザ入力のために FOR ループで READ を使用します。これにより、READ 処理中のユーザの中断を無効にするように BREAK 0 が設定されます。ただし、ユーザが数値以外の値を入力する場合、BREAK 1 は、ユーザが入力値を拒否したり受け入れたりできるようにユーザの中断を有効にします。

  SET y="^" 
InputLoop
  TRY {
      FOR {
           BREAK 0
           READ "input a number ",x
           IF x="" { WRITE !,"all done"  QUIT }
           ELSEIF 0=$ISVALIDNUM(x) {
             BREAK 1
             WRITE !,x," is not a number",!
             WRITE "you have four seconds to press CTRL-C",!
             WRITE "or accept this input value",!
             HANG 4 }
           ELSE {  }
           SET y=y_x_"^"
           WRITE !,"the number list is ",y,!
      }
   }
   CATCH { WRITE "Rejecting bad input",!
           DO InputLoop
   }

関連項目

• ZBREAK コマンド

• GOTO コマンド

• OPEN コマンド

• USE コマンド

• コマンド行ルーチンのデバッグ

• ターミナル入出力