Moonmile Solutions Blog

手元にあるものがレガシー（遺産）と言う訳ではないのですが、15年程まえの技術で作ってあるので、これに機能を追加するのに苦労しています。
まあ、業務的には「元のコードスタイルに合わせてコーディングする」のが良い訳で、そこそこ手を加える量が少なければそれでも良いのですが、がっつりとコーディングしないといけないとなると、ひと苦労ってことになります。

そうなると、レガシーならばレガシーなりに捨て去ってしまう、というのもひとつの選択肢に上がるわけですが、現実的にはそうも言えません。予算的な問題とか、実現可能性の問題などがありもともとのコードを継承しないと駄目なわけです。COBOL やホストコンピュータの世界では普通に起こっている話で、ぼちぼち10年前のコード自体も辛くなってきていますよね、って話です。そういう分野の「考察」も必要かと思い始めていますが、そのあたりは別の機会に。

さて、既存のデータが「単純な構造体」と「ビット配列」で出来ていたとします。機能追加をするときには、このデータにアクセスしなければいけないのですが、ばらばらに保存されている「単純な構造体」と「ビット配列」はちょっとアクセスが手間です。あらかじめクラス構造になっていればよいのですが、諸々の事情があってそうもいかなかった模様です。

■データアクセスを #define マクロで包む

ひとつの方法としては「#define」マクロを使ってデータアクセスを包みます。

// conbiniance macro function
#define GRID_MAX()		GETNTGRID()
#define GRID_ID(_idx)		CPLOT2.GPTS[_idx][0]
#define GRID_X(_idx)		CPLOT2.GPTS[_idx][1]
#define GRID_Y(_idx)		CPLOT2.GPTS[_idx][2]
#define GRID_Z(_idx)		CPLOT2.GPTS[_idx][3]
#define TO_GRID_INDEX(_gid)	(_gid-1)

#define CQUAD4_MAX()	GETNTELEM()
static bool IS_CQUAD4(long index) {
	long n = index+1;
	int type = GETELETYPE(&n);
	return ( type == 5 || type == 6 );
}
#define CQUAD4_EID(_idx)	CPLOT2.IDCELM[_idx][4]
#define CQUAD4_GID1(_idx)	CPLOT2.IDCELM[_idx][0]
#define CQUAD4_GID2(_idx)	CPLOT2.IDCELM[_idx][1]
#define CQUAD4_GID3(_idx)	CPLOT2.IDCELM[_idx][2]
#define CQUAD4_GID4(_idx)	CPLOT2.IDCELM[_idx][3]
#define CQUAD4_PID(_idx)	CPLOT2.IDCELM[_idx][5]
#define CQUAD4_K(_idx)	CPLOT2.IDCELM[_idx][5]

見ると分かりますが、CPLOT2.GPTS と CPLOT2.IDCELM は単純な配列です。データ自体は Fortran 領域にあるので「配列」でアクセスしないと難しいという当時の理由がありました。これを直接アクセスするのは大変なので、#define マクロを作ってみたわけです。

これは結構定番な方法なのですが、関数アクセス風になってしまうのが難点です。アクセスする配列が増えるたびに、何らかの命名規約を作ってひとつひとつマクロを作らないといけません。作るのも面倒ですし、アクセスの方法も面倒です。

int idx   = 10;
int eid   = CQUAD4_EID(idx);
int gid1  = CQUAD4_GID1(idx);
int gid2  = CQUAD4_GID2(idx);
...

分かり易いと言えば分かり易いのですが、オブジェクト指向的には次のように書きたいのです。

int idx = 10;
int eid = CQUAD4(idx).EID;
int gid1 = CQUAD4(idx).GID(0);
int gid2 = CQUAD4(idx).GID(1);
...

更に参照を使って、こんな風に書きたい訳です。

int idx = 10;
auto &el = CQUAD4(idx);
int eid  = el.EID;
int gid1 = el.GID(0);
int gid2 = el.GID(1);
...

■データアクセスを一時オブジェクトを使って包む

C# の場合は、別に CQUAD4 クラスを作成してひとつひとつ作り込むことになるのですが、C++ の場合はもうちょっと便利な方法があります。
基本的に一時オブジェクト扱いで使うようにしてスコープが外れると自動的に解放される、という前提でクラスを作ります。C# の場合は、using を使うところですね。

///<summary>
/// CPLOT2.GPTS easy access class
///</summary>
class GRID {
protected:
	int _idx;
public:
	GRID(int idx) { _idx = idx; }
public:
	int GID() { return CPLOT2.GPTS[_idx][0]; }
	double X()  { return CPLOT2.GPTS[_idx][1]; }
	double Y()  { return CPLOT2.GPTS[_idx][2]; }
	double Z()  { return CPLOT2.GPTS[_idx][3]; }
	static int Size() { return GETNTGRID(); }
};

///<summary>
/// CPLOT2.IDCELM easy access class
///</summary>
class CQUAD4 {
protected:
	int _idx;
public:
	CQUAD4(int idx) { _idx = idx; }
public:
	int EID() { return CPLOT2.IDCELM[_idx][4]; }
	int GID(int n) { return CPLOT2.IDCELM[_idx][n]; }
	int PID() { return CPLOT2.IDCELM[_idx][5]; }
	int K() { return CPLOT2.IDCELM[_idx][5]; }
	static int Size() { return GETNTELEM(); }
};

それぞれのメソッドは #define マクロの時と変わりません。

int idx = 10;
auto &el = CQUAD4(idx);
int eid  = el.EID();
int gid1 = el.GID(0);
int gid2 = el.GID(1);
...

一見、プロパティのように見えますがメンバアクセスのメソッドです。実は、VC++の場合は独自にプロパティが作れるのですが、今回はやめておきます。プロパティを作りたい場合は、下記な記事で説明してあります。

MS-C++ では __declspec(property()) でプロパティを作れるよ | Moonmile Solutions Blog
http://www.moonmile.net/blog/archives/3557

内部的に一時オブジェクトが作られるのでスピードが問題ですが、まぁ、そのあたりは大丈夫みたいです。最近の CPU は早いですから。

HtmlDom は LINQ to HTML を目指していますが、かつ HTML が楽に編集できるように更新系（Update/Delete/Insertなど）のメソッドも準備します。

まあ、内部的には XML に直しているので操作は楽なのですが、なんと HTML のパース部分がちと面倒で。

もともとある System.Forms.HtmlDocument 自体には、Children に相当するコレクションがないので、全 DOM を取ることができないんですよね。

HtmlDocument クラス (System.Windows.Forms)
http://msdn.microsoft.com/ja-jp/library/system.windows.forms.htmldocument(v=vs.110).aspx

トリッキーな作りをすれば、これに沿って LINQ ぐらいは作れるのですが、ちょっと使いづらいということで、独自に HtmlDocument, HtmlNode を作っています。
このとき、HTML 文字列から COM の IHTMLDocument2 を使ってパースするのはこんな感じ。

/// <summary>
/// Loading method
/// HtmlDocument to create a HTML string
/// </summary>
/// <param name=&quot;html&quot;>HTML string</param>
/// <returns></returns>
public HtmlDocument LoadHtml(string html)
{
	// Creating an object using a mshtml.HTMLDocument
	var doc = new HTMLDocument() as IHTMLDocument2;
	doc.write(new object[] { html });
	Load(doc);
	return this;
}

非常に簡単で、IHTMLDocument2 インターフェースにキャストして、COM の write メソッドを呼び出すだけです。これは HTML DOM の document.write に対応しているので、javascript まで実行されてしまうのですが、まぁ、大丈夫みたいです。何故か、COM で直接呼び出した時は、javascript 実行でエラーになる（画面のUIコントロールを探してエラーになるという不具合のようです）らしいのですが、実は大丈夫です。

	CComPtr<IHTMLDocument2> pDoc;
	HRESULT hr = CoCreateInstance(CLSID_HTMLDocument, NULL, CLSCTX_INPROC_SERVER, IID_IHTMLDocument2, (void**)&pDoc);
	//put the code into SAFEARRAY and write it into document
	SAFEARRAY* psa = SafeArrayCreateVector(VT_VARIANT, 0, 1);
	VARIANT *param;
	hr = SafeArrayAccessData(psa, (LPVOID*)&param);
	param->vt = VT_BSTR;
	param->bstrVal = CComBSTR(strHTMLCode).Copy();
	hr = pDoc->write(psa);
	hr = pDoc->close();
	SafeArrayDestroy(psa);

ATL COM を使っています。どっかのサンプルから取ってきたので、実は SafeArrayCreateVector は必要ないかもしれません。サンプルを動作させるとエラーになっていたのですが「CComBSTR(strHTMLCode).Copy();」のように、一度コピーを取ることで、うまく実行できます。ためしに、自分の twitter サイトから HTML をダウンロードして来てパースするとうまく動きました。twitter サイトは javascript を多用しているので、これが大丈夫ならば大抵のサイトは大丈夫だと思います。

肝心のスピードですが、C# 経由の COM アクセスは何故か属性の配列を取るところが非常に遅くなっています。

	// append attributes
	IHTMLAttributeCollection attrs = node.attributes;
	if (attrs != null)
	{
		foreach (IHTMLDOMAttribute at in attrs)
		{
			if (at.specified)
			{
				string nodeValue = "";
				if (at.nodeValue != null)
					nodeValue = at.nodeValue.ToString();
				nn.Attrs.Add(new HtmlAttr { Key = at.nodeName, Value = nodeValue });
			}
		}
	}

部分的なコードですが、foreach のループのところで、attrs の要素を 150 程度廻るのが問題なようです。実は、IHTMLDocument がパースした後の要素では、何故か属性のコレクションが非常にたくさん用意されているのですよね。おそらく onclick などのフック関数のために用意されていると思うのですが、静的なデータを取りたい場合には、これが不要ですし非常に邪魔です。要素数が2,3しかないので、150程度のループを廻すものだから、耐えきれない位おそくなります。
これは、簡単な HTML の場合には問題がなくて、twitter の HTML のように大量な HTML の場合に発覚した現象です。これでは実用に耐えません。

なので、じゃあ、COM アクセス自体を高速化するためにひとまず、C++ で書いてみたのが以下です。

list<XAttr*> *getAttrs( CComQIPtr<IHTMLDOMNode> node )
{
	auto *xattrs = new list<XAttr*>();

	CComPtr<IDispatch> disp;
	node->get_attributes( &disp );
	CComQIPtr<IHTMLAttributeCollection> attrs = disp;
	if ( attrs ) {
		long length = 0;
		attrs->get_length( &length );
		CComPtr<IDispatch> dispa;
		for ( int i=0; i<length; i++ ) {
			CComVariant vt(i);
			attrs->item( &vt, &dispa );
			CComQIPtr<IHTMLDOMAttribute> attr = dispa ;
			if ( attr ) {
				VARIANT_BOOL vtb;
				attr->get_specified( &vtb );
				if ( vtb ) {
					CComBSTR key;
					attr->get_nodeName( &key );
					CComVariant value;
					attr->get_nodeValue( &value );

					xattrs->push_back(new XAttr( CString(key), CString(value.bstrVal)));
				}
			}
			attr.Release();
			dispa.Release();
		}
	}
	attrs.Release();
	disp.Release();
	return xattrs;
}

ループ変数となる length の値は 150 程度なので同じぐらいループが廻っていますが、非常に高速に動きます。多分、CComBSTR か CComVariant と .NET との相互変換の部分で遅くなっている感じがします。これは後で実測してみるつもりです。

という訳で、IE で使っている IHTMLDocument2 を直接使って自前で DOM を作ることができました。
ですが、このパース部分は C++ となっているので、C# の HtmlNode オブジェクトにしないと LINQ が使えないですよね。

って訳で、C++/CLI の出番なんですよ。ええ、VS2010 では C++/CLI のインテリセンスが効かないので、VS2012 で書いたものを VS2010 に戻しますってな感じです。本当は 2008 が良いんですが、間違ってアンインストールしちゃったんですよね。なので、仕方が無く別マシンの VS2012 を借りるという罰ゲームに（VS2010 に VS2012 を入れると MSTest が正常に動かないんですが、これは RTM でなおっているんでしょうか？）

VC++2010 の bool 値の動きが、false -> true -> true なのだから、それに合わせてデクリメントを作ってみる。

class BOOL
{
	bool _b ;	// 内部でブール値を持つwww
public:
	BOOL( bool b = false ) {
		_b = b;
	}
	// bool型へキャスト
	operator bool() {
		return _b ;
	}
	// bool型から代入
	BOOL& operator =( bool b ) {
		_b = b;
		return *this;
	}
	// 前置インクリメント
	BOOL& operator ++() {
		_b = true;
		return *this;
	}
	// 後置インクリメント
	BOOL operator ++(int) {
		BOOL b; b._b = _b;
		_b = true;
		return b;
	}
	// 前置デクリメント
	BOOL& operator --() {
		_b = false;
		return *this;
	}
	// 後置デクリメント
	BOOL operator --(int) {
		BOOL b; b._b = _b;
		_b = false;
		return b;
	}
};

内部的に、bool 値を持っているのは GAG というかなんというか、意外と詰まらないコードになってしまいました。
最初は b |= 1; b &= 0; なことをやるつもりだったのですが、実は 0/1 しか値を取らないのだから、直接 false/ture を入れてしまえば良いわけです。

■結果

	// デクリメントが可能なbool値
	BOOL bl = false;
	cout << ++bl << endl;
	cout << --bl << endl;

bool値をインクリメントする……？ – Togetter
http://togetter.com/li/356718
c++ – bool operator ++ and — – Stack Overflow
http://stackoverflow.com/questions/3450420/bool-operator-and

3.2 Increment and decrement [expr.pre.incr]
1 The operand of prefix ++ is modified by adding 1, or set to true if it is bool (this use is deprecated).
The operand shall be a modifiable lvalue. The type of the operand shall be an arithmetic type or a pointer
to a completely-defined object type. The value is the new value of the operand; it is an lvalue. If x is not
of type bool, the expression ++x is equivalent to x+=1. [Note: see the discussions of addition (5.7) and
assignment operators (5.17) for information on conversions. ]

を見て「えーッ!!! インクリメントすれば true/false を繰り返すほうが対称性が高いし、他との互換性も高いッ!!! 当然の規約だろう。昔 bool 型が int で実装されていたのはマシンの制約に関わる部分が多くて、コーディング的には、true/false が交互になるほうがよい」というのをぴきーんと考えたのですが…タイトルを見て分かるように「こじつけ」です。

実は手元にある VC++2010, VC++2012, G++4.5.2 で試したところ、bool をインクリメントすると true(1) -> ture(1) なんですわー、というわけで「非推奨」ですね、つーか、処理系に依存するコードを書いちゃダメですね。

■実験コードを作る

int main( void )
{
	bool b = false;

	// 後置型
	cout << &quot;bool: &quot; << b++ << endl;	// false
	cout << &quot;bool: &quot; << b++ << endl;	// true
	cout << &quot;bool: &quot; << b   << endl;	// false
	cout << endl;

	b = false;
	// 前置型
	cout << &quot;bool: &quot; << ++b << endl;	// true
	cout << &quot;bool: &quot; << ++b << endl;	// false
	cout << &quot;bool: &quot; << b   << endl;	// true
	cout << endl;

	b = false;
	for ( int i=0; i<5; i++ ) {
		cout << b << endl;
		b = !b ;	// 反転
	}
	cout << endl;
	// 利点としてはインクリメントを使うと1行で書ける
	b = false;
	for ( int i=0; i<5; i++ ) {
		cout << b++ << endl;	// 後でインクリメント
	}
	cout << endl;

	return 0;
}

期待するところは、コメントにある通り true/false を繰り返します。
期待通りに動くのであれば、「!b」で反転させるよりも、b++ にすると1行で済むことが分かります。

bool 値は、一見「論理式」のために用意されている on/off の状態を示すように見えますが、。反転を表す「!」演算子を使う場合 on <-> off の交互になる、つまりは、

• on であれば off になる
• off であれば on になる

のようになります。しかし bool 値を一般的な int 型と考えてみると、int型のように 0 -> 1 -> 2 -> … -> MAX -> 0 のように最大値を過ぎたら 0 に戻るとうのが普通なのです。となると、0,1 の値しか持たない＝1ビットで表すことができる数値として bool をとらえると、

• 0 に 1 を加えて 1 になる
• 1 に 1 を加えて 0 になる

という論法になります。この考え方は、欧米の家電のスイッチが「0」と「1」になっていることから分かりますね。

• スイッチが入っいない状態＝0の状態
• スイッチが入っている状態＝1の状態

という訳です。

■3値のクラスを作る

さて、この論法を確認するために 3値のクラスを考えてみましょう。

// 例えば3値のクラスを作る
class Value
{
	int _v;
public:
	Value() : _v(0) {}
	// 前置
	Value& operator ++() {
		if ( ++_v >= 3 ) _v=0;
		return *this;
	}
	// 後置
	Value operator ++(int) {
		Value v;
		v._v = this->_v;
		if ( ++_v >= 3 ) _v=0;
		return v;
	}
	// int型へキャスト
	operator int() {
		return _v;
	}
};
ostream& operator << ( ostream &s, Value v )
{
	switch ((int)v) {
	case 0: s << &quot;one&quot; ; break;
	case 1: s << &quot;two&quot; ; break;
	case 2: s << &quot;three&quot; ; break;
	}
	return s;
}

0, 1, 2 の3つの値を取る整数値の場合には、++演算子は普通に使える、というのが期待されます。

	// 3値クラスを使う
	Value v ;
	cout << v++ << endl;		// one
	cout << v++ << endl;		// two
	cout << v++ << endl;		// three
	cout << v++ << endl;		// one
	cout << endl;

これは期待通りに、one -> two -> three -> one のように動きます。
チェックボックスの値も、unenabled -> off -> on -> unenabled のように動くことが期待できるわけです（まあ、内実がint型だからというのもありますが）。

■任意の値を最大値とするテンプレートを作る

3値ではなくて、任意の値「MAX」が取れるようにテンプレートクラスにします。

// 任意の値までのテンプレートクラス
template<int MAX>
class TValue
{
	int _v;
public:
	TValue<MAX>() : _v(0) {
	}
	// 前置
	TValue<MAX>& operator ++() {
		if ( ++_v >= MAX ) _v=0;
		return *this;
	}
	// 後置
	TValue<MAX> operator ++(int) {
		TValue<MAX> v;
		v._v = this->_v;
		if ( ++_v >= MAX ) _v=0;
		return v;
	}
	// int型へキャスト
	operator int() {
		return _v;
	}
};

この場合も期待通りに動きます。MAX の次が 0 なので、サイクリックな値として使えますね？

	TValue<3> v3 ;
	cout << v3++ << endl;		// one
	cout << v3++ << endl;		// two
	cout << v3++ << endl;		// three
	cout << v3++ << endl;		// one
	cout << endl;

■Bool へ typedef する

先のテンプレートに MAX=2 を指定すると、ほら、規約にある bool と同じ動作をしますね。

	typedef TValue<2> Bool;		// 2値のBoolクラス
	Bool bb;
	cout << bb++ << endl;		// 0
	cout << bb++ << endl;		// 1
	cout << bb++ << endl;		// 0
	cout << endl;

つまりは、bool 型というのは、true/false という特別な型ではなくて、int 型や char 型と同じように「最大値を指定してサイクリックにインクリメントできる型」の特殊なものして、定義できる訳です。これはなんか「数学的」で綺麗でいいですよね。

■で、最初に戻って bool 型をインクリメントすると

さて、ここまで薀蓄を含めて bool 値の考察をしていきましたが、実装はどうなっているでしょうか？

	bool b = false;

	// 後置型
	cout << &quot;bool: &quot; << b++ << endl;	// false
	cout << &quot;bool: &quot; << b++ << endl;	// true
	cout << &quot;bool: &quot; << b   << endl;	// false
	cout << endl;

	b = false;
	// 前置型
	cout << &quot;bool: &quot; << ++b << endl;	// true
	cout << &quot;bool: &quot; << ++b << endl;	// false
	cout << &quot;bool: &quot; << b   << endl;	// true
	cout << endl;

の結果は、VC++2010, VC++2012 で実行すると、

bool: 0
bool: 1
bool: 1

bool: 1
bool: 1
bool: 1

あーあー、うん、あーあ、どうでもいいや、ってな気分です。

# ちなみに、VC++2010 の場合はデクリメントをしようとするとコンパイルエラーになります。

処理としては、0 -> 1, 1 -> 1 という実装みたいですね。

もしデクリメントを実装するとすると、1 -> 0, 0 -> 0 が素直かと。