.. dbgCommentInserter.

dbgCommentInserter
==================

概要
----

dbgCommentInserterはアセンブラリスティング内のデバッグ用コメントを抽出し、ISIMトレースログファイル内の該当位置に挿入するツールです。
このツールにより、デバッグすべきポイントを膨大なトレースログの中で簡単に見つけ出すことができます。
なお、特定コアについてデバッグする場合は、あらかじめISIMログからgrep等のツールで特定のコア部分のみを抜き出してから本ツールで処理すると効果的です。


リビジョン
----------

dbgCommentInserter.py v01r02

コマンドライン
--------------

.. code-block:: none

	python dbgCommentInserter.py [option [option_parameter]]...

以下のようなオプションをつけて動作させることで所望の結果を得ることができます。

**コマンドラインオプション**

    +-----------+------------------------------------+
    |オプション | 意味                               |
    +===========+====================================+
    |-h         | ヘルプ表示                         |
    +-----------+------------------------------------+
    |--ILOG log | ISIM出力のLOGファイルを指定        |
    +-----------+------------------------------------+
    |--OLOG log | 本ツールによりコメント挿入されたLOG|
    +-----------+------------------------------------+
    |--LST lst  | デバッグコメントの含まれるLST      |
    +-----------+------------------------------------+
    |--MARK M   | LOG中のデバッグコメントマーク      |
    +-----------+------------------------------------+
    |-v         | 処理の途中経過を詳細に出力         |
    +-----------+------------------------------------+
    |-V         | バージョンのみ表示して終了         |
    +-----------+------------------------------------+
    |-d         | デバッグ用オプション               |
    +-----------+------------------------------------+

デバッグコメントとデバッグコメントマーク
----------------------------------------

デバッグコメントは、リスティング中のコメントのうち、;++>なる文字列で始まるコメント文字列です。
LOGファイルに挿入する場合には、;++>文字列をデバッグコメントマークで置き換えた文字列として挿入されます。
コマンドラインで指定しない場合、デフォルトのデバッグコメントマークは●となります。
通常、ユーザーのデバッグコメントは、VPPLソース中にdebug_commentコンパイラディレクティブによって記述します。
また、デバッグコメントは、作用の大きな演算子などに対してコンパイラが自動挿入する場合もあります。


構造
----

.. automodule:: dbgCommentInserter

.. autoclass:: dbgCommentInserter.LstFileReader
   :members:

.. autoclass:: dbgCommentInserter.LogFileReaderWriter
   :members: