Main Content

コマンド ラインでの Polyspace as You Code 用チェッカーの構成

サポートされていない IDE を使用している場合には、コマンド ラインから Polyspace® as You Code を使用して、さまざまなタイプの欠陥とコーディング ルール違反をチェックできます。欠陥 (Polyspace Bug Finder)コーディング規約 (Polyspace Bug Finder)を参照してください。既定の解析では、欠陥のサブセットがチェックされます。既定で有効な Polyspace Bug Finder 欠陥チェッカー (Polyspace Bug Finder)を参照してください。その他の欠陥とコーディング ルール違反をチェックするには、Polyspace as You Code を構成します。

チェッカーを構成するには、チェッカー ファイルを作成した後、コマンド ラインでそのチェッカー ファイルを指定します。Polyspace デスクトップおよびサーバーでの同等のワークフローについては、Polyspace Bug Finder 解析用のチェッカー構成の準備 (Polyspace Bug Finder)を参照してください。

コマンド ラインでチェッカーとコーディング ルールを直接構成する

サポートされていない IDE で Polyspace as You Code を実行している場合は、コマンド ラインで適切な値を直接指定した解析オプションを使用して、チェッカーとコーディング ルールを選択して指定できます。

たとえば、パフォーマンス チェッカーと MISRA C:2012 コーディング ルールを有効にするには、コマンド ライン インターフェイスで以下を実行します。

polyspace-bug-finder-access -sources <source.c> -checkers performance -misra3 all
解析オプションのコマンド ライン構文については、解析オプションのドキュメントを参照してください。結果を表示するには、polyspace-results-export (Polyspace Bug Finder) を使用します。

チェッカーとコーディング ルールを選択して指定すると、チェッカーとコーディング ルールの事前定義のサブセットを選択できます。チェッカーとコーディング ルールのカスタム サブセットを選択するには、チェッカー ファイルを使用してチェッカーを構成します。

チェッカー ファイルでのチェッカーの構成

チェッカーを構成するには、最初にチェッカー ファイルでチェッカーを選択します。次に [設定] ペインでそのチェッカー ファイルを指定します。

手順 1: チェッカーとコーディング ルールの選択

既定以外の欠陥およびコーディング ルールを有効にするには、次のいずれかを行います。

  • チェッカー ファイルを作成または変更する。

  • Polyspace デスクトップ プロジェクトからチェッカーの選択をインポートする。

チェッカー構成の作成または変更.  [チェッカーの選択] ウィンドウで、チェッカーとコーディング ルールの選択を新しく作成するか、既存の選択を変更します。再利用可能なチェッカー ファイルに新しい構成を保存します。チェッカーの選択を変更せずに既存のチェッカー ファイルを使用するには、コマンド ラインでそのファイルを指定します。手順 2: コマンド ラインでのチェッカー ファイルの指定を参照してください。

  1. [チェッカーの選択] ユーザー インターフェイスを開くには、コマンド ラインで以下を実行します。

    polyspace-checkers-selection
    [チェッカーの選択] インターフェイスが開きます。

    Checkers selection interface with all defects selected

  2. 新しい選択を作成するには、[チェッカーの選択] ウィンドウで、有効にする欠陥およびコーディング ルール チェッカーを選択します。既存の選択を変更するには、[参照] をクリックし、既存のチェッカー ファイルを参照して、チェッカーを選択します。

    また、事前定義された欠陥チェッカー カテゴリを有効にすることもできます ([すべて][既定][高][中][低] など)。影響度による欠陥の分類 (Polyspace Bug Finder)を参照してください。同様に、対応する規約によって定義されているコーディング ルールの事前定義済みセットを有効にすることができます。

    • [Guidelines][Software Complexity] チェッカーを選択する場合、それぞれのしきい値をレビューします。既定のしきい値が許容できない場合、[しきい値] 列で適切なしきい値を指定します。ガイドラインをチェック (-guidelines) (Polyspace Bug Finder) を参照してください。

    • [カスタム] ルールを選択した場合、ルールの [パターン] および [規則] をレビューします。カスタム ルールのチェック (-custom-rules) (Polyspace Bug Finder) を参照してください。

    • カスタム コーディング規約分類を作成する場合、または Bug Finder あるいは対象のコーディング ルール チェッカーにタグ付けする場合、[チェッカーの選択] ウィンドウの [コメント] 列にテキストを入力します。Polyspace では、デスクトップ インターフェイス、Polyspace Access™、または Polyspace as You Code プラグインで結果を確認するとき、入力したそのテキストが [結果の詳細] ペインおよび (使用できる場合) [結果のリスト][詳細] 列に表示されます。

      メモ

      [チェッカーの選択] インターフェイスで入力するカスタム テキストは、以下では省略されます。

      • 生成されるレポート。

      • Polyspace デスクトップ インターフェイス (このデスクトップ インターフェイスで Polyspace Access から結果を開く場合)。この制限は Bug Finder チェッカーにのみ適用されます。

  3. 選択した内容を再利用可能なチェッカー XML ファイル (CreatedCheckerFile.xml) として保存し、[終了] をクリックします。後で CreatedCheckerFile.xml[チェッカー アクティベーション ファイル] (-checkers-activation-file) (Polyspace Bug Finder) の値として再利用できます。

デスクトップ プロジェクトからチェッカー構成をインポートする.  Polyspace デスクトップ プロジェクト (*.psprj) ファイルがある場合は、このファイルからチェッカー選択をインポートできます。コマンド ラインで以下を実行します。

#Linux command
polyspace-checkers-selection -checkers-selection-output-file PathToOutputFile.json \
-import-options-from-psprj PathToProject.psprj

#DOS command
polyspace-checkers-selection -checkers-selection-output-file PathToOutputFile.json ^
-import-options-from-psprj PathToProject.psprj
ここで、PathToProject.psprj は Polyspace デスクトップ プロジェクト ファイルの絶対パスであり、PathToOutputFile.json は JSON ファイルの絶対パスです。JSON ファイルは書き込み可能なフォルダーに含まれていなければなりません。JSON ファイルには、作成されたチェッカー ファイルの場所が次の形式で記述されています。
    {
        "checkers-activation-file": "PathToCreatedCheckerFile",
        "analysis-options-file": "CreatedOptionsFile"
    }
PathToCreatedCheckerFile のチェッカー ファイルには、Polyspace デスクトップ プロジェクト ファイルのチェッカー構成が含まれています。

手順 2: コマンド ラインでのチェッカー ファイルの指定

チェッカー ファイルを取得したら、その絶対パスを [チェッカー アクティベーション ファイル] (-checkers-activation-file) (Polyspace Bug Finder) の引数として指定します。次に例を示します。

#Linux command
polyspace-bug-finder-access -sources <source.c> \
-checkers-activation-file PathToCreatedCheckerFile

#DOS command

polyspace-bug-finder-access -sources <source.c> ^
-checkers-activation-file PathToCreatedCheckerFile
ここで、PathToCreatedCheckerFile はチェッカー ファイルの絶対パスです。

チェック動作の変更

Bug Finder 欠陥チェッカーとコーディング ルールの既定の動作を変更するには、解析オプションを使用します。チェッカーの既定の動作を変更する解析オプションのリストについては、Bug Finder チェッカーの既定の動作の変更 (Polyspace Bug Finder)を参照してください。

Polyspace as You Code で解析オプションを指定するには、次のようにします。

  • コマンド ラインでオプションを使用します。たとえば解析の信頼境界を変更するには、コマンド ラインで以下を実行します。

    #Linux Command
    polyspace-bug-finder-access -sources <source.c> -checkers-activation-file CreatedCheckerFile\
     -consider-analysis-perimeter-as-trust-boundary
    
    #DOS command
    
    polyspace-bug-finder-access -sources <source.c> -checkers-activation-file CreatedCheckerFile^
     -consider-analysis-perimeter-as-trust-boundary
    コマンド ラインに複数の動作変更オプションを指定できます。

  • [Analysis options file] フィールドで指定されたオプション ファイルで解析オプションを追加します。オプション ファイルは、各行に 1 つの解析オプションを含んでいるテキスト ファイルです。たとえば、解析オプション -code-behavior-specifications (Polyspace Bug Finder) および[有効な boolean 型] (-boolean-types) (Polyspace Bug Finder) を追加するには、オプション ファイルで次の行を追加します。

    -code-behavior-specifications file1
    -boolean-types boolean1_t,boolean2_t

  • 既存のオプション ファイルがない場合は、必要なオプションが入ったオプション ファイルを作成してください。Polyspace 解析のオプション ファイル (Polyspace Bug Finder)を参照してください。

関連するトピック