CSourceView クラスの実装

それでは、早速 Source を表示する View を作成していきます。

今回は、テキストをキーワードごとに着色することも考えて RichEditCtrl を使用します。定義は、AtlCtrls.h にあります。そのまま CSplitterWindow に割り当ててもいいのですが、ファイルのロードとセーブにストリームを使ったコールバックを使ってみたかったのと、その辺の記述を MainFrame に記述したくないこともあります。

こうすることのメリットには、CRichEditCｔｒｌ の各メソッドを使った一連の流れを、MainFrm に書くよりは、一連の処理を CRichEditCtrl のほうにメソッドとして用意しておいて、MainFrm からはそのメソッドを呼ぶだけで済むように記述できる点が挙げられると思います。

では、早速 RichEditCtrl を使っていきます。RichEditCtrl はコモンコントロールとは別の ｄｌｌ になっているので、使う前に dll をロードしてやる必要があります。これは、WTL でこのような作業を行う際にはほとんど定型処理のようなものなので、この機会に覚えてしまいましょう。

プロジェクトのメインソース（<プロジェクト名>.CPP）にロードするコードを書きます（今回は S2H_Conv.cpp）

int WINAPI _tWinMain(HINSTANCE hInstance, HINSTANCE /*hPrevInstance*/, LPTSTR lpstrCmdLine, int nCmdShow)
{
    HRESULT hRes = ::CoInitialize(NULL);
    // If you are running on NT 4.0 or higher you can use the following call instead to 
    // make the EXE free threaded. This means that calls come in on a random RPC thread.
    // HRESULT hRes = ::CoInitializeEx(NULL, COINIT_MULTITHREADED);
    ATLASSERT(SUCCEEDED(hRes));

    // this resolves ATL window thunking problem when Microsoft Layer for Unicode (MSLU) is used
    ::DefWindowProc(NULL, 0, 0, 0L);

    AtlInitCommonControls(ICC_COOL_CLASSES | ICC_BAR_CLASSES); // add flags to support other controls

    hRes = _Module.Init(NULL, hInstance);
    ATLASSERT(SUCCEEDED(hRes));

    /// リッチエディットをロード
    HINSTANCE hInstRich = ::LoadLibrary(CRichEditCtrl::GetLibraryName());

    int nRet = Run(lpstrCmdLine, nCmdShow);

    ::FreeLibrary(hInstRich);

    _Module.Term();
    ::CoUninitialize();

    return nRet;
}

上記は S2H_Conv.cpp の開始部分ですが、Run で始まる部分がメインスレッド（要はプログラム本体のようなもの）になります。ですから、この前にライブラリをロードし、この後でライブラリを開放します。ロードには LoadLibrary、開放には FreeLibrary という API を使います。詳しくは MSDN を見てください。

次に、RichEdit を使った View を作成します。とりあえずここでは、CSourceView としました。Wizard で作成したときに作られた、S2H_ConvView のヘッダファイルとソースファイルをそれぞれリネームしてプロジェクトに読み込みます。大きな変化があるのはクラス宣言の部分です。

class CSourceView : public CWindowImpl<CSourceView, CRichEditCtrl, CSourceViewWinTraits>
{
public:
    DECLARE_WND_SUPERCLASS(NULL, CRichEditCtrl::GetWndClassName())

CSourceView も CWindowImpl を継承するのですが、2つ目のテンプレート引数の TBase、つまりベースとなるクラスには CWindow ではなく、CRichEditCtrl を指定します。また、RichEditCtrl に指定するウィンドウスタイルは、CWinTraits を使って指定し、3つ目のテンプレート引数に指定します。

また、クラスの最初に DECLARE_WND_SUPERCLASS というマクロが使われています。ATL ではデフォルトでは DECLARE_WND_CLASS（） で指定された新しいクラスに基づくウィンドウを生成しますが、DECLARE_WND_SUPERCLASS マクロの場合は、2番目の引数で指定されたクラスに基づく（つまり今回の場合は CRichEditCtrl） 新しい名前のウィンドウを作成することになります。

ただし、DECLARE_WND_SUPERCLASS の最初の引数に NULL を指定した場合は ATL***** という名前を勝手につけられます。自分の好みのウィンドウ名にしたい場合は名前を指定します。DECLARE_WND_SUPERCLASS　では、RichEditCtrl に基づいたウィンドウを作成しますが、ウィンドウプロシージャは RichEdit のものではなく、独自のものを利用します。

 Stream コールバックを利用した読み込みと保存の実装

どちらかというと、SDK 的な内容で特に WTL というわけではないのですが、せっかくですから RichiEdit の Stream を利用してみましょう。

Stream を使う利点にはいくつかありますが、RTF 形式で保存できたり、コールバックを使って読み込み書き込みのコントロールをすることができます。たとえば、何バイト転送されてきたとか、その間にプログレスバーを表示させて経過を表示させるといったことができます。

また、CPU やメモリと比較して DISK への I/O はコストが大きいので、CPU が遊んでしまう可能性があります。Stream ではこある程度ずつ読み込むことができるので、読み込みながら構文解析とか、何らかの処理を行って CPU を活用するということが考えられます。

ということで、読み込み側は以下のようになります。

BOOL CSourceView::LoadFile(BOOL bShowDialog, LPTSTR lpstrFilePath)
{
    CString sPath(lpstrFilePath);

    if ( FALSE == bShowDialog ) {
        /// ファイル名が決められない場合はエラー
        ATLASSERT(sPath.IsEmpty() != FALSE);
    } else {
        /// 「ファイルを開く」ダイアログを表示
        CFileDialog cFileDialog(TRUE, m_sDefaultExt);

        if ( IDOK == cFileDialog.DoModal()) {
            sPath = cFileDialog.m_szFileName;
        }
    }

    if ( sPath.IsEmpty()) {
        MessageBox(_T("ファイル名が指定されませんでした。"), _T("エラー"), MB_OK | MB_ICONEXCLAMATION);
        return FALSE;
    }

    HANDLE hFile = ::CreateFile(lpstrFilePath, GENERIC_READ, 0, NULL, OPEN_EXISTING,
                                                FILE_ATTRIBUTE_NORMAL | FILE_FLAG_SEQUENTIAL_SCAN, NULL);

    if( hFile == INVALID_HANDLE_VALUE )
        return FALSE;

    /// ストリームを使って読み込む
    EDITSTREAM es;
    es.dwCookie = (DWORD)hFile;
    es.dwError = 0;
    es.pfnCallback = StreamReadCallback;
    StreamIn(SF_TEXT, es);

    ::CloseHandle(hFile);

    return !(BOOL)es.dwError;
}

DWORD CALLBACK CSourceView::StreamReadCallback(DWORD dwCookie, LPBYTE pbBuff, LONG cb, LONG FAR *pcb)
{
    ATLASSERT(dwCookie != 0);
    ATLASSERT(pcb != NULL);

    return !::ReadFile((HANDLE)dwCookie, pbBuff, cb, (LPDWORD)pcb, NULL);
}

外部（この場合は CMainFrame）から操作することを考えて、読み込み操作は LoadFile というメソッドにしました。 CMainFrame とこのメソッドの内のどちらでコモンダイアログに対応するか迷いましたが、CMainFrame では二つの View に操作を割り当てる部分があるので、今回は View でコモンダイアログを制御するようにしてみました。

コールバック関数は、MSDN の EditStreamCallback という項目を調べていただければわかるのですが、static で宣言してあることに注意してください。指定されたものとまったく同じ引数をもち、任意の名前をつけることが可能です。

同様に書き込みのほうも実装します。

BOOL CSourceView::SaveFile(BOOL bShowDialog, LPTSTR lpstrFilePath)
{
    CString sPath(lpstrFilePath);

    if ( FALSE == bShowDialog ) {
        /// ファイル名が決められないのでエラー
        ATLASSERT(sPath.IsEmpty() != FALSE || m_sDefaultFile.IsEmpty() != FALSE);
    } else {
        /// 「名前を付けて保存」のダイアログを表示
       CFileDialog cFileDialog(FALSE, m_sDefaultExt, m_sDefaultFile);

        if ( IDOK == cFileDialog.DoModal()) {
            sPath = cFileDialog.m_szFileName;
        }
    }

    HANDLE hFile = ::CreateFile(sPath, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS,
                                                FILE_ATTRIBUTE_ARCHIVE | FILE_FLAG_SEQUENTIAL_SCAN, NULL);

    if(hFile == INVALID_HANDLE_VALUE) {
        MessageBox(_T("ファイルの作成に失敗しました。"), _T("エラー"), MB_OK | MB_ICONERROR);

        return FALSE;
    }

    EDITSTREAM es;
    es.dwCookie = (DWORD)hFile;
    es.dwError = 0;
    es.pfnCallback = StreamWriteCallback;
    StreamOut(SF_TEXT, es);

    ::CloseHandle(hFile);

    return !(BOOL)es.dwError;
}

DWORD CALLBACK CSourceView::StreamWriteCallback(DWORD dwCookie, LPBYTE pbBuff, LONG cb, LONG FAR *pcb)
{
    ATLASSERT(dwCookie != 0);
    ATLASSERT(pcb != NULL);

    return !::WriteFile((HANDLE)dwCookie, pbBuff, cb, (LPDWORD)pcb, NULL);
}

読み込みのときも書き込みのときも、Stream への情報のセットには EDITSTREAM 構造体を利用します。また、StreamIn, StreamOut という関数が実際の読み書き開始のトリガーになります。Stream Callback 関数は任意の回数呼ばれますので、そのつど読み込みの場合は ReaFile API、書き込みの際は WriteFile API を呼んで対処します。

CFileDialog はコモンダイアログの特にファイルの読み書きに特化したラッパークラスです。コンストラクタで作成時の1つ目の引数に TRUE を設定すれば「ファイルを開く」ダイアログ、FALSE を指定すれば「名前をつけて保存」ダイアログが表示されます。

その他、デフォルトのファイル名を決めたり、CEdit のすべて削除（SetSel で全選択して、Clear）といった操作のラッパーメソッドなどを実装しています。詳しくはソースを読んでください。