VSCode での利用

VSCode では、コード解釈 (IntelliSense) 機能があるため、コード編集が効率的に行えます。またタスク機能によりビルドコマンドの実行を VSCode から行うことができます。

プロジェクトを開く

TWELITE のアプリをビルドするためにプロジェクトを Visual Studio Code で開く必要があります。 プロジェクトを開く手順は下記の通りです。

メニューバーの "ファイル" → "フォルダーを開く"を選択します。
開きたいプリジェクトのフォルダを選択します。
エクスプローラー上に開いたプロジェクトのフォルダが追加されます。

アプリをビルドする

アプリのビルドは下記の手順で行います。VSCode 上から make ユーティリティを実行しています。make の詳細については「ビルド方法」や「Makefileについて」を参照してください。

例えば、超簡単!TWELITE標準アプリをビルドする場合、VSCode のタスク”Build App_Twelite_Master (BLUE)” を選択します。

メニューバーの”タスク” → ”タスクの実行” を選択します。
右図の赤枠内よりビルドしたい定義を選択します。
ターミナルより右図の赤枠内のような出力がされればビルド成功です。

VSCode からはコマンドラインの make を実行しているため、エラー等もコマンドラインのエラーメッセージが出力されます。

コード解釈を切り替える

TWELITE BLUE 用のコード解釈と TWELITE RED 用のコード解釈を切り替えることができます。 コード解釈を切り替えるには図の示す場所をクリックして開発対象にあった TWELITE のモデルを選択してください。

TWELITE モジュールの種別ごとに特有の C 定義を切り替えます。

コード解釈とコンパイラ解釈が完全に一致することを保証するわけではありません。またヘッダファイルの記述などにより一部解釈できない定義も発生します。

コード解釈を切り替えます。

TWELITE モジュールの種別ごとに特有の C 定義を切り替えます。

コード解釈とコンパイラ解釈が完全に一致することを保証するわけではありません。またヘッダファイルの記述などにより一部解釈できない定義も発生します。

読み込むヘッダファイルは、コンパイラやライブラリのヘッダファイルを直接参照するわけではなく {SDKディレクトリ}/Tools/VSCode/include 以下のコピーを参照します。

JSON ファイルについて

上記のビルドやコード解釈については JSON ファイルに定義があります。

.vscode/c_cpp_properties.json

ビルド時の暗黙定義などの定義やインクルードディレクトリの指定を行っています。

追加の定義が必要な場合は、すでにあるファイル中の "name" : "TWELITE_BLUE" または "name" : "TWELITE_RED" のエントリを複製または編集して使用します。

編集が必要になるのは "name" "includePath" などです。 特有のビルド定義が必要な場合は "defines" にエントリを追加します。

.vscode/tasks.json

ビルドタスクの定義を行なっています。

新たにビルド定義を追加する場合は、すでにあるエントリをコピーして編集します。各ビルドタスクには windows, linux, osx 用のエントリーがあります。

編集が必要になるのは "label" "options" の "cwd" などです。

"tasks": [
{
"label": "Build Samp_PingPong,PingPong (BLUE)",
"type": "shell",
..
"windows": {
"command": "make",
"args": [ "TWELITE=BLUE", "clean", "all" ],
"options": { "env": { "PATH": "${workspaceRoot}\\..\\..\\Tools\\MinGW\\msys\\1.0\\bin" } }
},
"problemMatcher": { "base": "$gcc", "fileLocation": [ "absolute" ] },
"options": { "cwd": "${workspaceRoot}/PingPong/Build" }
},
..
  • "options": { "cwd" ... } の設定でビルドディレクトリを指定しています。

  • make 引数を追加したい場合は、 "args" TWELITE=???" の後にエントリを追加します。

既存のビルドタスクに設定する

以下の例のようにgroup": { "kind": "build", "isDefault": true } を追加します。そのタスクがデフォルトのビルド定義になり、[タスク]>[ビルドタスクの実行] やショートカットキーによる実行ができるようになります。

"tasks": [
{
"label": "Build Samp_PingPong,PingPong (BLUE)",
"type": "shell",
..
"options": { "cwd": "${workspaceRoot}/PingPong/Build"},
"group": { "kind": "build", "isDefault": true }
},
..