Debug¶
Debug クラスは 吉里吉里のデバッグに関する機能を提供するクラスです。このクラスからオブジェクトを作成することはできません。
吉里吉里のコンソールのログの名前は krkr.console.log になります。また、ハードウェア例外が発生したときに作成されるファイルは hwexcept.log となります。
これらのログファイルは、デフォルトではプロジェクトディレクトリになります。ただし、プロジェクトディレクトリがアーカイブなど、書き込みができないディレクトリの場合は出力されません。
ログファイルの出力先は logLocation プロパティで変更することができます (KAGの場合は栞データの保存先に設定されます)。
メンバー一覧¶
プロパティ¶
メソッド¶
- message
- notice
- startLogToFile
- logAsError
- addLoggingHandler
- removeLoggingHandler
- getLastLog
- prettyPrint
logLocation¶
プロパティ \ アクセス: r/w
解説
ログファイルの出力先
ログファイルの出力先ディレクトリを表します。値を書き込むこともできます。
デフォルトではデータ保存場所 (コマンドラインオプションの -datapath) に設定されています。
この値を変更すると、以降のログはそのディレクトリ下の *.console.log として出力されるようになります。
logToFileOnError¶
プロパティ \ アクセス: r/w
解説
エラー発生時にコンソールのログをファイルに出力するか
真の場合、エラーが発生したときにコンソールのログのファイルへの出力を開始するように なります。
偽の場合はエラーが発生してもログのファイルへの出力は開始されません。
関連: Debug.startLogToFile / Debug.clearLogFileOnError
clearLogFileOnError¶
プロパティ \ アクセス: r/w
解説
エラー発生時にコンソールのログファイルをクリアするかどうか
真の場合、エラーが発生したときにコンソールのログを自動的にクリアするようになります。
偽の場合はクリアはされず、既存のログファイルに追加されます。
関連: Debug.startLogToFile / Debug.logToFileOnError
message¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
message |
|
出力するメッセージを指定します。 |
解説
コンソールへメッセージを出力
コンソールへメッセージを出力します。
notice¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
message |
|
出力するメッセージを指定します。 |
解説
コンソールへ重要なメッセージを出力
コンソールへメッセージを出力します。
Debug.message と違い、ここで出力したメッセージは ログファイルへの書き出しを途中から開始したとしても、 必ずログファイルに書き出されます ( Debug.message で出力したメッセージは、ある程度さかのぼってまでしか 書き込まれません )。ログファイルを回収したときに有用になるような重要な情報を出力するために使います。
startLogToFile¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
clear |
false |
真を指定するとログファイルはクリアされます。 偽を指定すると既存のファイルに追加されます。 |
解説
コンソールのログの出力開始
コンソールのログのファイルへの出力を開始します。
関連: Debug.logToFileOnError / Debug.clearLogFileOnError
logAsError¶
メソッド
解説
エラー時と同じようにログをファイルに出力開始する
エラーログファイルに関し、吉里吉里がエラーが発生したときと同じ動作をさせます。 つまり、 Debug.logToFileOnError が真ならばファイルにコンソールのログの出力を 開始します。その際、Debug.clearLogFileOnError が真ならばファイルを クリアします。
これに対し、Debug.startLogToFile は無条件でコンソールのログの ファイルへの出力を開始します。
関連: Debug.startLogToFile / Debug.logToFileOnError / Debug.clearLogFileOnError
addLoggingHandler¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
handler |
|
ログハンドラを指定します。 |
解説
ログハンドラを追加します
エラーログが出力されるごとに呼び出されるハンドラを登録します。
ハンドラはログメッセージを引数に与えられて呼び出されます。
登録メソッド内でログを出力しても、再帰的な呼び出しは行われず無視されます。
removeLoggingHandler¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
handler |
|
ログハンドラを指定します。 |
解説
ログハンドラを削除します
登録したログハンドラを削除します。
getLastLog¶
メソッド
解説
未出力のログを取得します
出力していないログを取得します。
prettyPrint¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
value |
|
整形対象の値を指定します。 |
depth |
2 |
再帰的に展開する深さを指定します。既定値は 2 。 |
compact |
false |
真を指定するとコンパクトな 1 行表記になります。既定値は偽。 |
戻り値
整形結果の文字列が返ります。
解説
値の整形表示
任意の TJS 値を、辞書配列やオブジェクトの内容を含めて読みやすい文字列に 整形して返します。REPL やログ出力でのデバッグ用途に使用します。