Visual Studio 2005 にカスタムウィザードを追加するには

解説

Visual C++ 2005 に、カスタムウィザード（あるプログラムのソースコードをスケルトンとしたプロジェクトテンプレート）を追加する方法をまとめます。

Visual C++ 2005 に、カスタムウィザードを追加するには、以下を行います。

スケルトンとなるプログラムのソースコードを用意する。
カスタムウィザードテンプレートを用いて、プロジェクトを作成する。
カスタムウィザードプロジェクトのTemplatesフォルダに、用意したソースコードファイルを配置する。
Templates.inf ファイルを編集する。
スケルトンとするソースコードを編集する。
default.js ファイルの GetTargetName 関数を編集する。
default.vcproj ファイルを編集する。
default.js ファイルの AddConfig 関数を編集する。
default.js ファイルの PchSettings 関数を編集する。
default.js ファイルの AddFilters 関数を編集する。
vszファイルのフィルタに関する設定を編集する。
作成したカスタムウィザードプロジェクトを、Visual C++ 2005 のウィザードファイル用フォルダの下に移動する。
vszファイルのウィザードファイルの場所に関する設定を編集する。
default.js ファイルの CreateCustomProject 関数を編集する。
vsdirファイルを編集する。
作成したカスタムウィザードプロジェクトのicoファイル、vsdirファイル、vszファイルを、Visual C++ 2005 のプロジェクトファイル用フォルダの下に移動する。

サンプルコード

スケルトンとなるプログラムのソースコードを用意する。

本サンプルでは、「タスクトレイに常駐するアプリケーションを作成するには」のソースコードを利用することとします。

カスタムウィザードテンプレートを用いて、プロジェクトを作成する。

「メニュー／新規作成／プロジェクト」を選択します。

プロジェクトの種類：Visual C++
テンプレート：カスタムウィザード
プロジェクト名：適当な名前（今回は「TrayApplicationWizard」）
場所：適当なフォルダを指定
ソリューションのディレクトリの作成：チェックしない
でOKボタンを押します。

次へボタンを押します。

ユーザーインターフェイス：チェックを外す
その他の設定は変更せず次へボタンを押します。

プロジェクトが作成されました。

カスタムウィザードプロジェクトのTemplatesフォルダに、用意したソースコードファイルを配置する。

作成したプロジェクトの、「Templates\1041」に、用意したソースコードのフォルダ、ファイルをすべコピーします。
ReadMe.txtは上書きコピーします。
コピーしたフォルダのうち、Releaseフォルダと、Debugフォルダは削除します。
コピーしたファイルのうち、拡張子が、「ncb」「suo」「user」のファイルは削除します。

結果、「Templates\1041」の中身は、
res\MyApplication.ico
res\MyApplication.rc2
AboutDlg.cpp
AboutDlg.h
MyApplication.cpp
MyApplication.h
MyApplication.rc
MyApplication.sln
MyApplication.vcproj
MyApplicationTrayWnd.cpp
MyApplicationTrayWnd.h
ReadMe.txt ← 「Templates\1041」フォルダにもともとあるが上書きコピー
Resource.h
stdafx.cpp
stdafx.h
Templates.inf ← 「Templates\1041」フォルダにもともとある
TrayWnd.cpp
TrayWnd.h

配置したファイルを、プロジェクトに追加する。

ソリューションエクスプローラーの「テンプレートフォルダ」の下に、「Templates\1041」フォルダ内の、拡張子が「sln」「vcproj」「inf」以外のファイルを追加します。「Templates\1041\res」フォルダ内のファイルも追加します。

Templates.inf ファイルを編集する。

ソリューションエクスプローラーの「その他のファイル」の下の、Templates.inf に、「テンプレートフォルダ」の下に追加したファイル名を列挙します。

res\MyApplication.ico res\MyApplication.rc2 AboutDlg.cpp AboutDlg.h MyApplication.cpp MyApplication.h MyApplication.rc MyApplicationTrayWnd.cpp MyApplicationTrayWnd.h ReadMe.txt Resource.h stdafx.cpp stdafx.h TrayWnd.cpp TrayWnd.h

スケルトンとするソースコードを編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトのクラス名に、そのプロジェクトの名前が反映されるように、スケルトンとするソースコードを編集します。

すべきことは、スケルトンとするスースコードの中の、プロジェクト名にしたい部分を、
[!output PROJECT_NAME]
に置換します。

ソリューションエクスプローラーの「テンプレートファイル」のファイルに関して、
MyApplication を [!output PROJECT_NAME] に置換します。（「大文字と小文字を区別する」にチェックを入れます。「単語単位」にはチェックをいれません。）

MyApplication.cpp の場合

// [!output PROJECT_NAME].cpp : アプリケーションのクラス動作を定義します。 // #include "stdafx.h" #include "[!output PROJECT_NAME].h" #include "[!output PROJECT_NAME]TrayWnd.h" #ifdef _DEBUG #define new DEBUG_NEW #endif // C[!output PROJECT_NAME]App BEGIN_MESSAGE_MAP(C[!output PROJECT_NAME]App, CWinApp) ON_COMMAND(ID_HELP, &CWinApp::OnHelp) END_MESSAGE_MAP() // C[!output PROJECT_NAME]App コンストラクション C[!output PROJECT_NAME]App::C[!output PROJECT_NAME]App() { // TODO: この位置に構築用コードを追加してください。 // ここに InitInstance 中の重要な初期化処理をすべて記述してください。 } // 唯一の C[!output PROJECT_NAME]App オブジェクトです。 C[!output PROJECT_NAME]App theApp; // C[!output PROJECT_NAME]App 初期化 BOOL C[!output PROJECT_NAME]App::InitInstance() { // アプリケーションマニフェストが visual スタイルを有効にするために、 // ComCtl32.dll Version 6 以降の使用を指定する場合は、 // Windows XP に InitCommonControlsEx() が必要です。さもなければ、ウィンドウ作成はすべて失敗します。 INITCOMMONCONTROLSEX InitCtrls; InitCtrls.dwSize = sizeof(InitCtrls); // アプリケーションで使用するすべてのコモンコントロールクラスを含めるには、 // これを設定します。 InitCtrls.dwICC = ICC_WIN95_CLASSES; InitCommonControlsEx(&InitCtrls); CWinApp::InitInstance(); AfxEnableControlContainer(); // 標準初期化 // これらの機能を使わずに最終的な実行可能ファイルの // サイズを縮小したい場合は、以下から不要な初期化 // ルーチンを削除してください。 // 設定が格納されているレジストリキーを変更します。 // TODO: 会社名または組織名などの適切な文字列に // この文字列を変更してください。 SetRegistryKey(_T("アプリケーションウィザードで生成されたローカルアプリケーション")); C[!output PROJECT_NAME]TrayWnd* pWnd = new C[!output PROJECT_NAME]TrayWnd(); pWnd->Create(); m_pMainWnd = pWnd; return TRUE; // ダイアログは閉じられました。アプリケーションのメッセージポンプを開始しないで // アプリケーションを終了するために FALSE を返してください。 // return FALSE; }

MyApplication.rc、MyApplication.rc2 は、「コードの表示」で開いて、置換します。
MyApplication.rc の場合

// Microsoft Visual C++ generated resource script. // （中略） 3 TEXTINCLUDE BEGIN "#define _AFX_NO_SPLITTER_RESOURCES\r\n" "#define _AFX_NO_OLE_RESOURCES\r\n" "#define _AFX_NO_TRACKER_RESOURCES\r\n" "#define _AFX_NO_PROPERTY_RESOURCES\r\n" "\r\n" "#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_JPN)\r\n" "LANGUAGE 17, 1\r\n" "#pragma code_page(932)\r\n" "#include ""res\\[!output PROJECT_NAME].rc2"" // Microsoft Visual C++ 以外で編集されたリソース\r\n" "#include ""afxres.rc"" // 標準コンポーネント\r\n" "#endif\r\n" "\0" END ///////////////////////////////////////////////////////////////////////////// // // Icon // // Icon with lowest ID value placed first to ensure application icon // remains consistent on all systems. IDR_MAINFRAME ICON "res\\[!output PROJECT_NAME].ico" ///////////////////////////////////////////////////////////////////////////// // // Dialog // IDD_ABOUTBOX DIALOGEX 0, 0, 235, 55 STYLE DS_SETFONT | DS_MODALFRAME | DS_FIXEDSYS | WS_POPUP | WS_CAPTION | WS_SYSMENU CAPTION "バージョン情報 [!output PROJECT_NAME]" FONT 9, "MS UI Gothic", 0, 0, 0x1 BEGIN ICON IDR_MAINFRAME,IDC_STATIC,11,17,20,20 LTEXT "[!output PROJECT_NAME] Version 1.0",IDC_STATIC,40,10,119,8,SS_NOPREFIX LTEXT "Copyright (C) 2009",IDC_STATIC,40,25,119,8 DEFPUSHBUTTON "OK",IDOK,178,7,50,16,WS_GROUP END ///////////////////////////////////////////////////////////////////////////// // // Version // VS_VERSION_INFO VERSIONINFO FILEVERSION 1,0,0,1 PRODUCTVERSION 1,0,0,1 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L #else FILEFLAGS 0x0L #endif FILEOS 0x4L FILETYPE 0x1L FILESUBTYPE 0x0L BEGIN BLOCK "StringFileInfo" BEGIN BLOCK "041103a4" BEGIN VALUE "CompanyName", "TODO: <会社名>" VALUE "FileDescription", "TODO: <ファイルの説明>" VALUE "FileVersion", "1.0.0.1" VALUE "InternalName", "[!output PROJECT_NAME].exe" VALUE "LegalCopyright", "TODO: (C) <会社名>. All rights reserved." VALUE "OriginalFilename", "[!output PROJECT_NAME].exe" VALUE "ProductName", "TODO: <製品名>" VALUE "ProductVersion", "1.0.0.1" END END BLOCK "VarFileInfo" BEGIN VALUE "Translation", 0x411, 932 END END （以下略）

default.js ファイルの GetTargetName 関数を編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトのファイル名に、そのプロジェクトの名前が反映されるように、default.js ファイルのGetTargetName関数を編集します。

ソリューションエクスプローラーの「スクリプトファイル」のdefault.js を開いて、GetTargetName関数の記述部を探します。
Templates.inf に記述したファイル名の中の、プロジェクト名にしたい部分が、プロジェクト名になるように、変数 strProjectName を用いた処理を記述します。

function GetTargetName(strName, strProjectName) { try { // TODO: テンプレートファイル名を基に提出されたファイルの名前を設定する var strTarget = strName; if (strName == 'res\\MyApplication.ico') strTarget = 'res\\' + strProjectName + '.ico'; if (strName == 'res\\MyApplication.rc2') strTarget = 'res\\' + strProjectName + '.rc2'; if (strName == 'MyApplication.cpp') strTarget = strProjectName + '.cpp'; if (strName == 'MyApplication.h') strTarget = strProjectName + '.h'; if (strName == 'MyApplication.rc') strTarget = strProjectName + '.rc'; if (strName == 'MyApplicationTrayWnd.cpp') strTarget = strProjectName + 'TrayWnd.cpp'; if (strName == 'MyApplicationTrayWnd.h') strTarget = strProjectName + 'TrayWnd.h'; return strTarget; } catch(e) { throw e; } }

default.vcproj ファイルを編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトのプロジェクト設定に、スケルトンプロジェクトの設定が反映されるように、default.vcproj ファイルを編集します。「Templates\1041」の MyApplication.vcproj ファイルをテキストエディタで開き、すべてを選択、コピーします。
ソリューションエクスプローラーの「その他のファイル」のdefault.vcproj を開いて、すべてを選択、削除し、
コピーした MyApplication.vcproj の内容を貼り付けます。

「追加したカスタムウィザード」を利用して作成したプロジェクト固有の情報が埋め込まれる、以下の情報行を削除します。
・VisualStudioProject タグ内の、Name 属性行
・VisualStudioProject タグ内の、ProjectGUID 属性行
・VisualStudioProject タグ内の、RootNamespace属性行
・Files タグ内の全行
・Globals タグ内の全行

<?xml version="1.0" encoding="shift_jis"?> <VisualStudioProject ProjectType="Visual C++" Version="8.00" Name="MyApplication" ProjectGUID="{F6B9E161-85ED-4EB6-9A37-90C20DAF1B3F}" RootNamespace="MyApplication" Keyword="MFCProj" > <Platforms> <Platform Name="Win32" /> </Platforms> <ToolFiles> </ToolFiles> <Configurations> <Configuration Name="Debug|Win32" OutputDirectory="$(SolutionDir)$(ConfigurationName)" IntermediateDirectory="$(ConfigurationName)" ConfigurationType="1" UseOfMFC="2" CharacterSet="1" > （中略） <Tool Name="VCPostBuildEventTool" /> </Configuration> </Configurations> <References> </References> <Files> </Files> <Globals> </Globals> </VisualStudioProject>

default.js ファイルの AddConfig 関数を編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトのプロジェクト設定は、default.vcproj の設定のみが反映されるように、default.js ファイルのプロジェクト設定に関する記述を削除します。

ソリューションエクスプローラーの「スクリプトファイル」のdefault.js を開いて、AddConfig関数の記述部を探します。
try の内側の記述をすべて削除します。

function AddConfig(proj, strProjectName) { try { } catch(e) { throw e; } }

default.js ファイルの PchSettings 関数を編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトの stdafx.cpp が、「プリコンパイル済みヘッダーを作成する」設定になるように、default.js ファイルを編集します。

ソリューションエクスプローラーの「スクリプトファイル」のdefault.js を開いて、PchSettings関数の記述部を探します。
PchSettings関数の内容を以下のようにします。

function PchSettings(proj) { // TODO: pch 設定を指定する try { var files = proj.Object.Files; var fStdafx = files("stdafx.cpp"); var config = fStdafx.FileConfigurations("Debug"); config.Tool.UsePrecompiledHeader = pchCreateUsingSpecific; config = fStdafx.FileConfigurations("Release"); config.Tool.UsePrecompiledHeader = pchCreateUsingSpecific; } catch(e) { throw e; } }

default.js ファイルの AddFilters 関数を編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトのソリューションエクスプローラーに、ファイル振り分け用のフォルダが作成されるように、default.js ファイルを編集します。

ソリューションエクスプローラーの「スクリプトファイル」のdefault.js を開いて、AddFilters関数の記述部を探します。
AddFilters関数の内容を以下のようにします。

function AddFilters(proj) { try { // プロジェクトにフォルダを追加する var strSrcFilter1 = wizard.FindSymbol('SOURCE_FILTER'); var group1 = proj.Object.AddFilter('ソースファイル'); group1.Filter = strSrcFilter1; var strSrcFilter2 = wizard.FindSymbol('HEADER_FILTER'); var group2 = proj.Object.AddFilter('ヘッダーファイル'); group2.Filter = strSrcFilter2; var strSrcFilter3 = wizard.FindSymbol('RESOURCE_FILTER'); var group3 = proj.Object.AddFilter('リソースファイル'); group3.Filter = strSrcFilter3; } catch(e) { throw e; } }

vszファイルのフィルタに関する設定を編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトのソリューションエクスプローラーのファイル振り分け用のフォルダにファイルが振り分けられるように、vszファイルを編集します。

ソリューションエクスプローラーの「その他のファイル」のTrayApplicationWizard.vsz を開いて、
Param="SOURCE_FILTER = txt"
を、
Param="SOURCE_FILTER = cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx"
に置換します。
また、
Param="HEADER_FILTER = h;hpp;hxx;hm;inl;inc;xsd"
Param="RESOURCE_FILTER = rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav"
を追加します。

VSWIZARD 7.0 Wizard=VsWizard.VsWizardEngine.8.0 Param="WIZARD_NAME = TrayApplicationWizard" Param="ABSOLUTE_PATH = D:\temp\TrayApplicationWizard" Param="FALLBACK_LCID = 1041" Param="WIZARD_UI = FALSE" Param="SOURCE_FILTER = cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx" Param="HEADER_FILTER = h;hpp;hxx;hm;inl;inc;xsd" Param="RESOURCE_FILTER = rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav"

作成したカスタムウィザードプロジェクトを、Visual C++ 2005 のウィザードファイル用フォルダに移動する。

一旦、作業中のカスタムウィザードプロジェクトを閉じます。

作成したカスタムウィザードプロジェクトを、プロジェクトフォルダごと、Visual C++ 2005 のウィザードファイル用フォルダの下に移動します。

Visual C++ 2005 のウィザードファイル用フォルダは、Visual C++ 2005 をデフォルトのインストール先にインストールした場合、
C:\Program Files\Microsoft Visual Studio 8\VC\VCWizards\AppWiz\
です。

本サンプルでは、新規プロジェクト作成の、プロジェクトの種類「MFC」に、プロジェクトテンプレートが追加されることを想定し、
C:\Program Files\Microsoft Visual Studio 8\VC\VCWizards\AppWiz\MFC\
の下に、作成したカスタムウィザードプロジェクトのプロジェクトフォルダを移動します。

移動後、作業中のカスタムウィザードプロジェクトを再度開きます。

vszファイルのウィザードファイルの場所に関する設定を編集する。

vszファイルのウィザードファイルの場所に関する設定を編集します。

ソリューションエクスプローラーの「その他のファイル」のTrayApplicationWizard.vsz を開いて、
Param="ABSOLUTE_PATH =
の行を削除し、
Param="RELATIVE_PATH = VCWizards\AppWiz\MFC"
を追加します。（ウィザードファイルの移動先に合わせたフォルダパスにします）

VSWIZARD 7.0 Wizard=VsWizard.VsWizardEngine.8.0 Param="WIZARD_NAME = TrayApplicationWizard" Param="RELATIVE_PATH = VCWizards\AppWiz\MFC" Param="FALLBACK_LCID = 1041" Param="WIZARD_UI = FALSE" Param="SOURCE_FILTER = cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx" Param="HEADER_FILTER = h;hpp;hxx;hm;inl;inc;xsd" Param="RESOURCE_FILTER = rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav"

default.js ファイルの CreateCustomProject 関数を編集する。

「追加したカスタムウィザード」を利用して作成したプロジェクトのプロジェクト設定として、default.vcproj が利用されるように、default.js ファイルのCreateCustomProject関数を編集します。

ソリューションエクスプローラーの「スクリプトファイル」のdefault.js を開いて、CreateCustomProject関数の記述部を探します。
var strProjTemplatePath = wizard.FindSymbol('PROJECT_TEMPLATE_PATH');
の
PROJECT_TEMPLATE_PATH
を
START_PATH
に置換します。

function CreateCustomProject(strProjectName, strProjectPath) { try { var strProjTemplatePath = wizard.FindSymbol('START_PATH'); var strProjTemplate = ''; strProjTemplate = strProjTemplatePath + '\\default.vcproj'; （以下略）

ちなみに、
var strProjTemplatePath = wizard.FindSymbol('PROJECT_TEMPLATE_PATH');
のままだと、
「追加したカスタムウィザード」を利用して作成したプロジェクトのプロジェクト設定として、
C:\Program Files\Microsoft Visual Studio 8\VC\VCWizards\default.vcproj
が使われてしまいます。
var strProjTemplatePath = wizard.FindSymbol('PROJECT_TEMPLATE_PATH');
にすると、
「追加したカスタムウィザード」を利用して作成したプロジェクトのプロジェクト設定として、
vszファイル内で指定される、RELATIVE_PATH または ABSOLUTE_PATH にある、default.vcproj
が使われます。

vsdirファイルを編集する。

プロパティウィンドウを用いて、CMyApplicationTrayWndクラスに ID_APP_EXIT、ID_APP_ABOUT、のCOMMANDメッセージ応答関数を追加します。

ソリューションエクスプローラーの「その他のファイル」のTrayApplicationWizard.vsdir を開いて、
TODO: ウィザードの説明です。
を
タスクトレイ常駐アプリケーションを作成するためのプロジェクトです
に書き換え、
行末の
TrayApplicationWizard
を
|TrayApplication
に書き換えます。

TrayApplicationWizard.vsz| |TrayApplicationWizard|1|タスクトレイ常駐アプリケーションを作成するためのプロジェクトです| |6777| |TrayApplication

作成したカスタムウィザードプロジェクトのicoファイル、vsdirファイル、vszファイルを、Visual C++ 2005 のプロジェクトファイル用フォルダの下に移動する。

作業中のカスタムウィザードプロジェクトを閉じます。

新規プロジェクト作成の、プロジェクトの種類「MFC」に、プロジェクトテンプレートが追加されるように、作成したカスタムウィザードプロジェクトのicoファイル、vsdirファイル、vszファイルを、Visual C++ 2005 のプロジェクトファイル用フォルダの下に移動します。

Visual C++ 2005 のプロジェクトファイル用フォルダは、Visual C++ 2005 をデフォルトのインストール先にインストールした場合、
C:\Program Files\Microsoft Visual Studio 8\VC\vcprojects\
です。

本サンプルでは、新規プロジェクト作成の、プロジェクトの種類「MFC」に、プロジェクトテンプレートが追加されることを想定し、
C:\Program Files\Microsoft Visual Studio 8\VC\vcprojects\MFC\
の下に、作成したカスタムウィザードプロジェクトのicoファイル、vsdirファイル、vszファイルをコピーします。

また、カスタムウィザードプロジェクトの新規作成時に、勝手に、
C:\Program Files\Microsoft Visual Studio 8\VC\vcprojects\
に、icoファイル、vsdirファイル、vszファイルがコピーされるので、これを削除します。
（C:\Program Files\Microsoft Visual Studio 8\VC\vcprojects\
　の下の
　TrayApplicationWizard.ico、TrayApplicationWizard.vsdir、TrayApplicationWizard.vsz、を削除します）

実行

実行結果

Visual Studio のメインメニューの「ファイル／新規作成／プロジェクト新規」を選択し、プロジェクトの種類「MFC」を選択すると、テンプレートのリストに、「TrayApplicationWizard」が追加されています。

テンプレートのリストの TrayApplicationWizard を選択し、プロジェクト名に適当な名前を入力し、場所に適当なフォルダを指定し、ＯＫボタンを押すと、タスクトレイに常駐するアプリケーションのプロジェクトが作成されます。

ビルドし、エラー、警告がないことを確認します。

ビルド結果を実行し、タスクトレイに常駐するアプリケーションを作成するにはと同様の実行結果となることを確認します。

ダウンロード

サンプルプロジェクト

Visual Studio 2005 に カスタムウィザード を追加するには

解説