oF - openFrameworks SolutionSetting for VC++

openFrameworks SolutionSetting for VC++（以下oF_Setting） は openFrameworks を Microsoft Visual C++ 2008 （ExpressEdition含む）で使用するためのプロジェクト支援ツールです。

これから制作に取り掛かろうとする時やちょっとテストをしたい時、準備段階で時間の掛かる作業は避けたいものです。

WindowsでopenFrameworksプロジェクトを作成する時、emptyExampleをコピーする方法もありますが、いろいろとアドオンを追加しようとするととたんに面倒になります。

oFのフォーラム(ofProject script for windows)ではPythonによる支援スクリプトが紹介されていますが、対象はv2.5用であり、自分の環境v2.6ではパッケージが対応せず使用出来ませんでした。

クロスな環境としてはPythonは良いかもしれませんが、VC++ですとWindows環境が対象になりますし、コマンドラインもまた面倒です。そして、このためだけにv2.5をインストールするのもなんですし、Pythonをインストールしてないユーザーにとってちょっと手間がかかります。

そこで、それらの作業を軽減するためのGUIツールを作成しました。

必要環境は .Net Framework 2.0 以上で、VisualStudio 2008（Visual C++ 2008） または Visual C++ 2008 Express Edition が対象です。

OSは Windows XP(x86)、Windows 7(x64) で動作確認しました。

まずは oF_Setting の各機能を説明し、後半では ofxBox2d を対象とした操作手順の例を紹介します。

■Project

作成するアプリケーションの情報を登録します。

• Solution File

  ソリューション・ファイルを指定します。
  上にあるドロップダウン・リストは履歴が登録されています。初期状態では何もありません。
  ※右横のアイコンについてはSettingの「アイコンについて」を参照。

• Project File

  プロジェクト・ファイルを指定します。
  ※右横のアイコンについてはSettingの「アイコンについて」を参照。

• Add specified folder.

  プロジェクト下の指定フォルダ内にあるソース(*.cpp,*.h)ファイルを自動的に追加する場合にチェックします。
  右横のテキストボックスで指定された名前が対象のフォルダ名です。初期値は「src」です。
  例えば TestProject というフォルダに Test.vcproj が存在した場合、TestProject –> src をルートとしてファイルを探索します。存在しなければ何もしません。
  また、空欄にすることで TestProject をルートにして探索します。

• Clear Filter field, then add the file.

  ソリューションエクスプローラにあるフォルダは、vcprojファイル内では Filter項目 として記述されています。
  新規にプロジェクトを作成すると「ソース ファイル」「ヘッダー ファイル」「リソース ファイル」が初期登録されますが、これら既にあるFilter項目を全て削除し、新たにファイルを再登録する場合にチェックします。通常はチェックしたままで大丈夫です。

• Search sub folders.

  探索ルート下にある全てのサブフォルダを探索し追加対象とします。

• Output sample code.

  「Add specified folder」の対象フォルダに、ファイルが１つも存在しない場合に限り、初期のサンプルファイルを追加します。
  サンプルファイルはoF_Settingの起動フォルダにある、「src」フォルダ内を探索して追加します。
  よって、このオプションを使用する場合は、先に oF_Setting起動フォルダ –> srcフォルダ にコピーする元ファイルを入れておいて下さい。
  例えば、標準サンプルにある emptyExample のソースファイル(main.cpp, testApp.cpp, testApph)をコピーしておくと良いでしょう。

• Create backup.

  Build時にソリューション・ファイルとプロジェクト・ファイルのバックアップを作成します。
  バックアップは、それぞれ *.日時.bak というファイル名で同じフォルダに作成されます。
  「Convert only.」でBuildする場合は作成しません。

• Convert only.

  Buildを実行すると実際にファイルを書き換えますが、書き換えずに結果のみを知りたい場合にチェックします。

• Build

  処理を実行し書き換えます。
  「Convert only.」がチェックされている場合は書き換えません。

• About

  バージョン情報を表示します。

• Exit

  終了します。
  ProjectタブとSettingタブで設定した内容は、次回起動時に自動的に読み込まれます。また、履歴にはソリューション名で登録されます。

■Setting

openFrameworksの基本情報を登録します。

• Root

  openFrameworksのルートとなるフォルダを指定します。
  新規設定した場合や、場所を変更した場合は、必ず横のリフレッシュ を実行して下さい。(下層フォルダのチェックを行います)
  初期状態のままなら、最低限ここだけを設定してリフレッシュするだけになります。

• Libs Directory

  Libsフォルダを指定します。
  ※初期の階層構造を変更していない場合はそのままで構いません。

• Addons Directory

  Addonsフォルダを指定します。
  ※初期の階層構造を変更していない場合はそのままで構いません。

• DLL Directory

  DLLのあるフォルダを指定します。oFフォルダ –> export\vs2008 なら vs2008 を指定して下さい。
  ※初期の階層構造を変更していない場合はそのままで構いません。

• Solution File

  oFのソリューション・ファイルを指定します。通常は oFフォルダ –> libs\openFrameworksCompiled\project\vs2008 にあります。
  ※初期の階層構造やファイル名を変更していない場合はそのままで構いません。

• Project File

  oFのプロジェクト・ファイルを指定します。通常は oFフォルダ –> libs\openFrameworksCompiled\project\vs2008 にあります。
  ※初期の階層構造やファイル名を変更していない場合はそのままで構いません。

◆アイコンについて

ファイル・フォルダの各入力エリアは、エクスプローラからドラッグ＆ドロップして登録することが出来ます。

また、右隣のアイコンをクリックするとファイル・フォルダ選択ダイアログが表示されます。

 
×印のアイコンは何も設定されていない状態です。

 
！印のアイコンは参照先が不一致等の状態です。

チェック印のアイコンは正常なリンク先であることを意味します。

■Include Dir

追加のインクルード用フォルダを登録します。

デバッグ用とリリース用と別々に指定可能で、両方とも兼用であれば「same Debug」をチェックします。

初期状態で必要な部分は自動的に追加されるので、通常は記述する必要はありません。

■Lib Dir

追加のライブラリ用フォルダを登録します。

デバッグ用とリリース用と別々に指定可能で、両方とも兼用であれば「same Debug」をチェックします。

初期状態で必要な部分は自動的に追加されるので、通常は記述する必要はありません。

■Lib

リンクするライブラリを登録します。

デバッグ用とリリース用と別々に指定可能です。

必要な基本ライブラリは記載済みなので、必要に応じて追加・削除して下さい。

■Addon

プロジェクトに必要なアドオンを登録します。

アドオン(Addons Directoryで登録)フォルダ下を探索して、そこから得られた全ソース(*.cpp,*.h)ファイルがここに反映されています。

ここでプロジェクトに登録するファイル全てをチェックします。

• SubTree is selected togerther
  選択した項目から下の階層全てをチェック・解除します。
  １つずつチェック・解除したい場合は、このチェックを外して下さい。
• リフレッシュ・アイコン
  途中でフォルダ構造が変化した場合など、再読込が必要な時に使用します。
  ※Addon Libタブのリフレッシュと動作は共通です。

■Addon Lib

必要なアドオン用ライブラリを登録します。

アドオン(Addons Directoryで登録)フォルダを探索して、そこから得られた全ライブラリ(*.lib)ファイルがここに反映されています。

ここでプロジェクトに登録するライブラリ(アドオン側で用意されたもの)全てをチェックします。

• SubTree is selected togerther
  選択した項目から下の階層全てをチェック・解除します。
  １つずつチェック・解除したい場合は、このチェックを外して下さい。
• リフレッシュ・アイコン
  途中でフォルダ構造が変化した場合など、再読込が必要な時に使用します。
  ※Addonタブのリフレッシュと動作は共通です。

　

Libファイルにはデバッグ用とリリース用があると思いますので、項目をダブルクリックするか、項目上の右クリックで表示されるコンテクストメニューからどちらかを選択して下さい。

両方同じライブラリの場合もあるので、近いうちに両対応出来る修正版を出します。問題無い方は現状のままお使い下さい。
2010.04.12-06:35に修正版をアップしました。

[D] はデバッグ用、[R] はリリース用、[B]は兼用、[-]は指定無し（兼用とする）として設定されます。

■Log

実行結果を表示します。

ソリューション・ファイルの結果に続き、プロジェクト・ファイルの結果がまとめて表示されます。

プロジェクト・ファイルは実際にはXML形式ですが、Log表示では簡易的に表示されますのでご注意下さい。(あくまでも確認用です)

ダウンロード

●2010.07.12 - oF_Setting v1.0.3.1

インクルード先の一覧がプロジェクトに反映されてなかったバグを修正しました。

●2010.06.28 - oF_Setting v1.0.3.0

これまでAddonで取得するファイルは *.c *.h の２種類だけでしたが、*.hpp等の拡張子が存在する場合があるためユーザー指定としました。
Addonタブ上部のテキストボックスに拡張子を記述します。
※各拡張子は | で区切って下さい。

●2010.04.12 - oF_Setting v1.0.1.0

-----

■操作手順

前回でも使用した ofxBox2d を例に新規で作成していく手順を説明していきます。

1. VC++で新規プロジェクトを作成します。
   ここではappsフォルダに Test というフォルダを作成し、その中に TestBox2d というプロジェクトを作成することにします。
   

           apps –> Test –> TestBox2d
   
   「Win32コンソール アプリケーション」を選択して、追加のオプションを「空のプロジェクト」で作成します。
   「ソリューションのディレクトリを作成」は任意で構いません。

2. ofxBox2dのサンプルをコピーしてきます。
   

         addons/ofxBox2d/example/src

   のsrcフォルダをまるごとプロジェクトにコピーしておきます。
   
   ソリューションのディレクトリを作成していた場合は、上図のようになります。
3. oF_Setting.exe を起動します。初回の場合はSettingタブでopenFrameworks関係の設定をします。
   「Root」にルートなるフォルダをドラッグドロップするか、右端のアイコンをクリックしてフォルダの選択をして下さい。
    
   Rootが設定出来たら、リフレッシュ を押してチェックします。全てが緑のアイコンになれば大丈夫です。
   
   今後oFのフォルダ構成が変更されたり、名前が変わったりした時に対処しやすくするため、設定項目を多く設けてます。
   次回起動からは省略出来ます。環境が変わった場合は再設定して下さい。
4. Projectタブを開き、作成したソリューションとプロジェクト・ファイルの設定とOptionを設定します。
   
   Option項目はそのままで構いません。
   次回起動からは省略出来ます。環境が変わった場合は再設定して下さい。
5. Addonタブを開き、必要なアドオンをチェックします。
   今回は ofxBox2d と ofxVectorMath を使用するので、下図のようにチェックします。
   １つ１つは面倒なので、上段にあるSubTree項目がチェックされているのを確認し、ofxBox2d をチェックした後に example のチェックを外します。
   
   チェックし終えたら念のため、必要ファイルがチェックされているか確認してみて下さい。
6. 設定が終わったら Buildボタンを押して構築します。
   無事に完了すると成功した旨のメッセージが出て、自動的にLogタブが開きます。
   
   特に理解する必要はありませんが、書き換えに心配な方はProjectタブの「Convert only.」をチェックしてからBuildすればログのみ確認出来ます。
7. VC++を起動し、ソリューションを開きます。
   もしVC++を起動したままであれば、VC++をアクティブにしたと同時に下図のメッセージが表示されます。
   
   これはソリューションに関わるファイルに対して、外部から変更が加えられた場合に表示されるメッセージなので、そのまま「再読み込み」を実行します。
8. 無事にプロジェクトが構築されているか確認します。
   
   確認項目は以下の通りです。
   ・「openFrameworksLib」プロジェクトが追加されている
   ・指定したアドオンが追加されている
   ・「src」フォルダ以下のファイルが追加されている（追加する設定にしていた場合）
   ・依存関係の順番が合っている
9. これで一通り準備が整いましたが、ofxBox2dのサンプルはVC++でのエラーを含んでいます。
   testApp::setup() 関数内の cos(i) と sin(i) で、int型の i をキャストする必要があります。
   それぞれ (float)i でキャストしておきましょう。
   VCのコンパイラは頭固いですが、明示的に変換しておく癖を付けておくのは悪くありません。ただ、ちょっとうるさいというか。。。
10. コンパイルして実行して下さい。

これにて無事構築完了です。

一度Settingタブを設定してしまえば、次回以降はProjectタブとAddonタブ（Addon Libタブ）が主な設定項目となります。

手動で行うよりは楽になったと思いますし、慣れればかなり早く作業に取り掛かれます。

余談ですが、アドオンを追加する場合、そのアドオンが他のアドオンを利用しているケースがあります。例えば今回の ofxBox2d は ofxVectorMath を利用しています。

これはソースを見ればどれを利用しているのか判断出来ますが、自分の場合は、利用したいアドオンを追加し、コンパイルでエラーが出たらメッセージを元に別のアドオンを追加し直す、という手抜きをしています。悪い例ですが。。。。

と、この様なケースがあるので、無事コンパイルが通るまで oF_Setting は終了させないようにしておけば、追加して再読込の繰り返しをスムーズに行えます。

もちろん、終了させても前回の状態を維持してますので大丈夫です。

以上、Visual C++を対象に書きましたが、前回のようにコンパイラの問題を避けることも含め、こだわりが無ければ公式サイトで紹介されている Code::Blocks を利用してみるのも良いかもしれません。（まだ少ししか触れてませんが、いつか比較など出来ればと思っています）

Code::Blocks

Code::Blocks 日本語化

厳密なエラーチェック等は行っておりませんが、何か不具合等ありましたらコメントよりお知らせ頂ければ幸いです。