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

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

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

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

コマンドラインで適切な値を直接指定した解析オプションを使用して、選択するチェッカーとコーディングルールを指定できます。チェッカーに関連する解析オプションのリストについては、コーディング規約およびコードメトリクス (Polyspace Bug Finder)およびBug Finder 解析 (Polyspace Bug Finder)を参照してください。

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

polyspace-bug-finder-access -sources sourceFile -checkers performance -misra-c-2023 all

ここで sourceFile は、解析するソースファイルです。各オプションのコマンドライン構文については、Polyspace Bug Finder 解析エンジンのすべてのオプションのリスト (Polyspace Bug Finder)を参照してください。結果を表示するには、polyspace-results-export (Polyspace Bug Finder) を使用します。

オプションファイルにチェッカーとコーディングルールオプションを指定して、別の解析でこのオプションファイルを再利用できます。オプションファイルは、各行に 1 つの解析オプションを含んでいるテキストファイルです。たとえば、前述の解析を実行する場合、以下のオプションが入ったオプションファイル CheckersOptions.txt を作成します。

-checkers performance
-misra-c-2023 all

コマンドラインでこのオプションファイルを指定します。

polyspace-bug-finder-access -options-file CheckersOptions.txt

オプションファイルの詳細については、Polyspace 解析のオプションファイル (Polyspace Bug Finder)を参照してください。

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

既存のチェッカーアクティベーションファイルの使用

チェッカーアクティベーションファイル (XML) またはユーザー定義のコーディング規約 (.pschk) を使用してチェッカーを構成できます。チェッカーアクティベーションファイルにより、一連の Bug Finder の欠陥と外部コーディングルールが有効になります。ユーザー定義のコーディング規約では、既存のコーディング規約がニーズに厳密に対応していない場合に、特にプロジェクトに関係するコーディングルールを 1 つの規約にまとめることができます。これらのアーティファクトのいずれかがある場合は、オプション -checkers-activation-file の入力としてこのファイルを指定します。

Linux^® コマンドラインでは以下を入力します。

polyspace-bug-finder-access -sources sourceFile \
-checkers-activation-file PathToCreatedCheckerFile

Windows^® コマンドラインでは以下を入力します。

polyspace-bug-finder-access -sources sourceFile ^
-checkers-activation-file PathToCreatedCheckerFile

ここで、PathToCreatedCheckerFile は XML チェッカーアクティベーションファイルまたはユーザー定義のコーディング規約 (.pschk) ファイルの絶対パスです。

必要に応じてこれらのファイルのチェッカーの選択を変更できます。コマンドラインで以下のコマンドを使用して、[チェッカーの選択] ウィンドウを開きます。

polyspace-checkers-selection

チェッカーアクティベーションファイルまたはユーザー定義のコーディング規約に移動して、チェッカーの選択を変更します。変更内容を保存して、これ以降の解析でこのファイルを再利用します。

プロジェクトからのチェッカー構成のインポート

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

ps-migrate-checkers-selection -import-options-from-psprj PathToProject

コマンド ps-migrate-checkers-selection はフォルダー polyspaceroot\polyspace\bin\arch にあります。polyspaceroot は、使用している開発環境の Polyspace インストールフォルダーの場所であり、arch は win64、glnxa64、maci64 のいずれかです。
PathToProject.psprj は Polyspace デスクトッププロジェクトの絶対パスです。

コマンドの実行後に、Polyspace により、インポートされたチェッカー構成を使用してチェッカーアクティベーションファイルが作成されます。このチェッカーアクティベーションファイルは、.psprj ファイルと同じ場所の import という名前のサブフォルダーに格納されます。コマンドラインで Polyspace as You Code を実行する場合、-checkers-activation-file への入力としてチェッカーアクティベーションファイルを使用します。

あるいは、Polyspace Platform ユーザーインターフェイスで .psprj ファイルを開いて、この .psprj プロジェクトファイルを .psprjx プロジェクトファイルとしてインポートできます。Polyspace は .psprj ファイルのチェッカー構成を使用してチェッカーアクティベーションファイルを作成します。チェッカーアクティベーションファイルのパスを取得するには、[構成] に移動して [静的解析] タブを選択します。[欠陥とコーディング規約] 、 [チェッカーアクティベーションファイル] にこのパスがあります。コマンドラインで Polyspace as You Code を実行する場合、-checkers-activation-file への入力としてチェッカーアクティベーションファイルのパスを指定します。

詳細は、Generate Build Options for Polyspace as You Code Analysis at the Command Lineを参照してください。

チェッカー構成の作成

チェッカーアクティベーションファイル (XML) がない場合は、[チェッカーの選択] ウィンドウを使用してこのファイルを作成できます。[チェッカーの選択] ウィンドウからユーザー定義のコーディング規約 (.pschk) を作成する操作はサポートされていません。独自のユーザー定義のコーディング規約を作成する方法の詳細については、Create User-Defined Coding Standard by Using Polyspace Bug Finder Checkers (Polyspace Bug Finder)を参照してください。

[チェッカーの選択] ウィンドウを開くには、コマンドラインで以下を入力します。
```
polyspace-checkers-selection
```
[チェッカーの選択] ウィンドウで、有効にするチェッカーを選択します。また、事前定義された欠陥チェッカーカテゴリを有効にすることもできます ([すべて]、[既定]、[高]、[中]、[低] など)。影響度による欠陥の分類 (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 チェッカーにのみ適用されます。
[変更の保存] をクリックして、再利用可能なチェッカーアクティベーションファイルとして選択を保存します。[終了] をクリックしてウィンドウを閉じます。

後でこのチェッカーアクティベーションファイルをオプション -checkers-activation-file の入力として再利用できます。

チェック動作の変更

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

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

コマンドラインでオプションを使用します。たとえば解析の信頼境界を変更する場合、Linux コマンドラインでは以下を実行します。
```
polyspace-bug-finder-access -sources sourceFile -checkers-activation-file CreatedCheckerFile\
 -consider-analysis-perimeter-as-trust-boundary
```
Windows コマンドラインでは以下を入力します。
```
polyspace-bug-finder-access -sources sourceFile -checkers-activation-file CreatedCheckerFile^
 -consider-analysis-perimeter-as-trust-boundary
```
ここで、CreatedCheckerFile は XML チェッカーアクティベーションファイルであり、sourceFile は解析するソースファイルの絶対パスです。1 つのコマンドで複数の動作変更オプションを指定できます。
オプションファイルで解析オプションを追加します。オプションファイルは、各行に 1 つの解析オプションを含んでいるテキストファイルです。たとえば、解析オプション -code-behavior-specifications (Polyspace Bug Finder) および[有効な boolean 型] (-boolean-types) (Polyspace Bug Finder) を追加するには、オプションファイルで次の行を追加します。
```
-code-behavior-specifications file1
-boolean-types boolean1_t,boolean2_t
```
ここで、file1 はコード動作仕様 (.XML) ファイルのパスであり、boolean1_t,boolean2_t は boolean 型です。
既存のオプションファイルがない場合は、必要なオプションが入ったオプションファイルを作成してください。Polyspace 解析のオプションファイル (Polyspace Bug Finder)を参照してください。

参考

トピック

既定で有効な Polyspace Bug Finder 欠陥チェッカー (Polyspace Bug Finder)
Polyspace 解析のオプションファイル (Polyspace Bug Finder)
Polyspace as You Code 解析で非アクティブにされるチェッカー
Bug Finder チェッカーの既定の動作の変更 (Polyspace Bug Finder)
コマンドラインから Polyspace as You Code を実行して、結果をエクスポートする