Visual Studio Code での Polyspace as You Code Analysis のビルドオプションの生成

Polyspace^® as You Code は、Visual Studio^® Code エディターで現在アクティブなソースコードファイルを調べ、バグやコーディング規約違反をチェックします。

解析がエラーなしで実行されるようにするためには、Polyspace as You Code に、データ型のサイズやコンパイラマクロ定義などのビルド構成の詳細を提供します。ビルド構成情報を提供するには、次のいずれかの方法を使用します。

ビルドタスクまたはビルドコマンド、あるいは JSON コンパイルデータベースからビルド構成情報を抽出するように Polyspace as You Code を構成します。
オプションファイルのビルド構成をエミュレートする解析オプションを手動で指定します。Polyspace 解析のオプションファイル (Polyspace Bug Finder)を参照してください。
Polyspace デスクトップ製品プロジェクトファイルから解析オプションをインポートします。

ビルド構成を抽出するための Polyspace as You Code の構成

ビルドタスクまたはビルドコマンドからビルド構成を抽出するように Polyspace as You Code を構成します。この方法では、Polyspace がビルドタスクまたはビルドコマンドを実行し、実行されたプロセスからビルドオプションを収集します。あるいは、JSON コンパイルデータベースからビルド構成を抽出します。この方法では、Polyspace は必要なビルド構成をコンパイルデータベースから読み取ることができます。

メモ

Windows^® で、リモート開発を有効にしており、リモートマシンのプロジェクトファイルまたはフォルダーがネットワークドライブ上にある場合には、そのネットワークドライブの UNC パスを入力してください。Configure Polyspace as You Code for Remote Developmentを参照してください。リモート開発を有効にしている場合、Polyspace as You Code 拡張機能はドライブ文字にマップされているネットワークドライブのパスを解決できないため、Polyspace: Generate Build Options コマンドが失敗する可能性があります。

ビルド構成の抽出後に、Polyspace as You Code 解析エンジンが以降の解析で使用するオプションファイルが Polyspace によって生成されます。このファイルには、ビルド構成をエミュレートする解析オプションが含まれています。

生成されたオプションファイルは、workingDirectory/projectName フォルダーの中にある .polyspace-configure フォルダーまたはそのサブフォルダーの 1 つに保存されます。

workingDirectory は、[Polyspace] 、 [Analysis Engine:Result Folder] のパスです。このパスは、Polyspace as You Code 拡張機能の設定で指定します。projectName は、現在解析中のファイルが含まれている [エクスプローラー] の最上位フォルダーの名前です。

ビルドタスクからのビルド構成の取得

Visual Studio Code を使用すると、Visual Studio Code から外部ツールを実行するためのタスクを定義できます。Integrate with External Tools via Tasks を参照してください。

コンパイラを呼び出してプロジェクトの完全なビルドを実行するカスタムタスクを定義する場合、Polyspace はこのビルドタスクからビルド構成を抽出できます。

Ctrl+コンマ (,) を押して Visual Studio Code の設定を開きます。
設定の検索バーに polyspace.analysisoptions と入力します。

[Polyspace] 、 [解析オプション] 設定で、以下のように指定します。

設定値

Analysis Setup 手動設定

Manual Setup: Build ビルドタスクから取得

[Manual Setup] 、 [Build Setting: Build Task]

ビルドタスクの名前を指定します。これは tasks.json ファイルのタスク定義の "label" フィールドに対応しています。指定するタスクは、完全なビルドを実行する必要があります。

Polyspace では、タスク定義で、次の Visual Studio Code の事前定義変数のみサポートしています。

${workspaceFolder}
${workspaceFolderBasename}

Ctrl+Shift+P を押して [コマンドパレット] を開き、Polyspace: Generate Build Options と入力します。

Polyspace はタスクで指定されているビルドコマンドを実行し、ビルドをトレースして構成情報を抽出し、オプションファイルを生成します。Polyspace as You Code 解析エンジンは、生成されたオプションファイルを以降の解析で使用します。

ビルドコマンドからのビルド構成の取得

ビルドコマンドからビルド構成情報を抽出するには、次のようにします。

Ctrl+コンマ (,) を押して Visual Studio Code の設定を開きます。
設定の検索バーに polyspace.analysisoptions と入力します。

[Polyspace] 、 [解析オプション] 設定で、以下のように指定します。

設定値

Analysis Setup 手動設定

Manual Setup: Build ビルドコマンドから取得

[Manual Setup] 、 [Build Setting: Build Command]

ビルドコマンドを指定します。以下に例を示します。

gcc -g -o helloworld hello.c main.c

完全なビルドを実行するコマンドを指定する必要があります。

Ctrl+Shift+P を押して [コマンドパレット] を開き、Polyspace: Generate Build Options と入力します。

Polyspace はビルドコマンドを実行し、ビルドをトレースして構成情報を抽出し、オプションファイルを生成します。Polyspace as You Code 解析エンジンは、生成されたオプションファイルを以降の解析で使用します。

JSON コンパイルデータベースからのビルド構成の取得

ビルドシステムで JSON コンパイルデータベースファイルの生成がサポートされている場合にはこのワークフローを使用します。JSON コンパイルデータベースには、プロジェクト内のすべての翻訳単位のコンパイラ呼び出しが含まれています。JSON コンパイルデータベースを参照してください。

JSON コンパイルデータベースからビルド構成情報を抽出するには、次のようにします。

JSON コンパイルデータベースファイルを生成します。このファイルを生成する方法の例は、JSON コンパイルデータベースからの Polyspace オプションファイルの作成 (Polyspace Bug Finder)を参照してください。
ローカルマシンで生成されたものではない JSON コンパイルデータベースを使用する場合は、Polyspace as You Code を実行している場所から、ファイルに記述されているパスにアクセスできることを確認してください。
Ctrl+コンマ (,) を押して Visual Studio Code の設定を開きます。
設定の検索バーに polyspace.analysisoptions と入力します。

[Polyspace] 、 [解析オプション] 設定で、以下のように指定します。

設定	値
Analysis Setup	`手動設定`
Manual Setup: Build	`JSON コンパイルデータベースファイルから取得`
[Manual Setup] 、 [Build Setting: JSON Compilation Database File]	手順 1 で生成したファイルの絶対パスを指定します。ファイル名は通常 `compile_commands.json` です。

Polyspace はコンパイルデータベースからビルド構成情報を自動的に抽出し、オプションファイルを生成します。Polyspace as You Code 解析エンジンは、生成されたオプションファイルを以降の解析で使用します。

生成されたビルドオプションファイルの更新

プロジェクトやワークスペースへのソースファイルの追加や既存のファイル名の変更など、ビルド構成の変更を行った場合は、生成されたオプションファイルを更新し、行った変更を反映します。オプションファイルを更新する前に、新しい構成でビルドが正常に完了していることを確認してください。

オプションファイルを更新するには、Ctrl+Shift+P を押して [コマンドパレット] を開き、Polyspace: Generate Build Options と入力します。

JSON コンパイルデータベースファイルからビルド情報を抽出する場合は、ビルドオプションファイルを更新する前に、コンパイルデータベースを再生成しておいてください。

Polyspace as You Code での解析失敗または予期しない結果のトラブルシューティングも参照してください。

手動での解析オプションの指定

以下の状況では、作成するオプションファイルで解析オプションを手動で指定します。

ビルドシステムの詳細を把握しており、オプションファイルのビルド構成をエミュレートする Polyspace 解析オプションを指定する場合。Polyspace 解析のオプションファイル (Polyspace Bug Finder)を参照してください。
使用可能な解析オプションのリストについては、Polyspace Bug Finder 解析エンジンのすべてのオプションのリスト (Polyspace Bug Finder)を参照してください。
ユーザーまたはチーム内の他のユーザーがビルドシステムに対して構成した Polyspace オプションファイルを再利用する場合。
ローカルマシンで構成または生成されたものではないオプションファイルを再利用する場合には、Polyspace as You Code を実行する場所から、ファイルに記述されているパスにアクセスできることを確認してください。

解析オプションファイルを指定するには、次のようにします。

"Ctrl"+"コンマ" (,) を押して Visual Studio Code の設定を開きます。
設定の検索バーに polyspace.analysisoptions と入力します。

[Polyspace] 、 [解析オプション] 設定で、以下のように指定します。

設定	値
Analysis Setup	`手動設定`
Manual Setup: Build	`Polyspace ビルドオプションファイルから取得`
[Manual Setup] 、 [Build Setting: Polyspace Build Options File]	Polyspace オプションファイルの絶対パスを指定します。

Polyspace as You Code 解析エンジンは、指定されたオプションファイルを以降の解析で使用します。

ビルド構成を変更する場合は、オプションファイルを編集して変更を反映します。ターゲット環境とコンパイラの動作の指定 (Polyspace Bug Finder)を参照してください。

Polyspace デスクトッププロジェクトからの解析オプションのインポート

Polyspace デスクトップ製品で解析を構成する場合は、生成される Polyspace デスクトップ .psprj ファイルの情報を使用して Polyspace as You Code 解析を構成できます。

Polyspace デスクトップ .psprj ファイルから解析オプションをインポートするには、Visual Studio Code でターミナルを開き、次のコマンドを入力します。

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

ps-migrate-checkers-selection コマンドは Polyspace as You Code インストールフォルダー内の polyspace/bin/arch フォルダーにあります。ここで、arch は win64、glnxa64、maci64 のいずれかです。このインストールフォルダーを PATH 環境変数に追加していない場合は、バイナリの絶対パスを含めてこのコマンドを実行してください。

パス pathToPsprjFile は .psprj ファイルの絶対パスです。

Polyspace によりオプションファイル analysis_options.txt と XML チェッカーアクティベーションファイル checkers_activation_file.xml が生成されます。生成されたファイルは、.psprj ファイルと同じ場所にある import フォルダーに保存されます。

Polyspace as You Code 解析の構成を行うには、次のようにします。

"Ctrl"+"コンマ" (,) を押して Visual Studio Code の設定を開きます。
設定の検索バーに polyspace.analysisoptions と入力します。

[Polyspace] 、 [解析オプション] 設定で、以下のように指定します。

設定	値
Analysis Setup	`手動設定`
Manual Setup: Build	`ビルドオプションファイルは不要` この設定では、[Build Setting: Polyspace Build Options File] フィールドに指定されたファイルは無視されます。
Manual Setup: Checkers File	`checkers_activation_file.xml` の絶対ファイルパス
Manual Setup: Other Analysis Options	`analysis_options.txt` の絶対ファイルパス

Polyspace as You Code 解析エンジンは、以降の解析でこれらのファイルを使用します。