Moonmile Solutions Blog

常々、C# では C/C++ のようにマクロが使えん…と思っていたのですが、実は Visual Studio 2008/2010 上であれば、T4(TextTemplatingFilePreprocessor)を使ってマクロっぽい動きができる（＝コードの自動生成ができる）ってことを今頃再確認して、ああ、なるほどと思って作ってみた次第です。

コード生成と T4 テキスト テンプレート
http://msdn.microsoft.com/ja-jp/library/bb126445.aspx
T4 TemplateでViewModelの生成をするアイテムテンプレートを作りました – かずきのBlog@Hatena
http://d.hatena.ne.jp/okazuki/20110325/1301070808
宣言的にクラスを宣言しT4 Templateでコードを生成する – かずきのBlog@Hatena
http://d.hatena.ne.jp/okazuki/20110408/1302275410

を参考にして、*.tt ファイルを作って、ViewModel を作ってみます。ViewModel クラスは、Silverlight + MVVM モデルで DataGrid をバインドの落とし穴（その２） | Moonmile Solutions Blog で書いていたときのパターンを使ってみます。チープすぎて実用的ではないのですが、T4 の自動生成の確認として。

宣言的にクラスを宣言しT4 Templateでコードを生成する – かずきのBlog@Hatena なところでは、設定ファイルを作っていますが、こちらでは、

/// <summary>
/// ViewModel クラス
/// </summary>
 [ViewModelTarget]
public class _ViewModel
{
	public int id { get; set; }
	public string name { get; set; }
	public int age { get; set; }
	public DateTime UpdateAt { get; set; }
}

な風に、クラスを定義しておけば勝手に INotifyPropertyChanged を継承した ViewModel クラスを作る、ってところを目指してみます。設定自体が生のクラスを使うってことろがミソです。

実は、テンプレートから自分のアセンブリを参照する方法が不明なので（もう少しトリッキーなことをやればできそうなんですが）、ViewModel を参照させるためだけのアセンブリを別に用意しています。

• SampleT4 に、テンプレートがあります。
• SampleT4Target は、アセンブリを参照するために用意しています。
• SampleT4 から SampleT4Target をプロジェクト参照します。
• _ViewModel.cs には、先の元になるクラスがはいっていて、2つのプロジェクトで共有（リンク）させています。

■ターゲットとなる ViewModel クラス

ちょっと無理矢理ですが、解析用のための MakeViewModel クラスを作成しています。
属性「ViewModelTarget」が付いているクラスを探すのですが、_ViewModel.cs 自体が共有されているので、無理矢理、文字列で属性値を調べています。

namespace SampleT4Target
{
	/// <summary>
	/// ViewModel クラス
	/// </summary>
	[ViewModelTarget]
	public class _ViewModel
	{
		public int id { get; set; }
		public string name { get; set; }
		public int age { get; set; }
		public DateTime UpdateAt { get; set; }
	}

	public class MakeViewModel
	{
		public string className;
		public List<Prop> props;
		public MakeViewModel( Type c )
		{
			this.className = c.Name;
			this.props = new List<Prop>();
			foreach (var p in c.GetProperties())
			{
				props.Add(new Prop { name = p.Name, type = p.PropertyType });
			}
		}
		public class Prop
		{
			public string name { get; set; }
			public Type type { get; set; }
		}
		public static List<Type> TargetTypes(string fname = "")
		{
			var lst = new List<Type>();

			Assembly asm = (fname == "")?
				Assembly.GetExecutingAssembly():
				Assembly.LoadFile(fname);

			foreach (var t in asm.GetTypes())
			{
				foreach (var at in t.GetCustomAttributes(false))
				{
					if ( at.GetType().ToString().IndexOf("ViewModelTarget") >= 0 ) 
					// var attr = at as ViewModelTargetAttribute;
					// if (attr != null)
					{
						lst.Add(t);
					}
				}
			}
			
			return lst;
		}
	}
	public class ViewModelTargetAttribute : Attribute
	{
	}
}

■ViewModel のテンプレート

テンプレートファイル「ViewModel.tt」は、以下のようになります。
アセンブリを直接参照させているので、ここが嫌なんですが（プロジェクト名が変わると変更しないといけないので）ひとまず、これでコンパイルが通ります。

<#@ template debug="false" hostspecific="false" language="C#" #>
<#@ output extension=".cs" #>
<#@ assembly name="$(SolutionDir)\SampleT4Target\bin\Debug\SampleT4Target.dll" #>
<#@ import namespace="SampleT4Target" #>
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel;

namespace SampleT4
{
<#
var types = MakeViewModel.TargetTypes();
foreach (var t in types) {
	var mk = new MakeViewModel(t);
#>
	/// <summary>
	/// <#= mk.className #> クラス
	/// </summary>
	public class <#= mk.className #> : INotifyPropertyChanged
	{
<# foreach ( var p in mk.props ) { #>
		private <#= p.type.ToString() #> _<#= p.name #>;
		public <#= p.type.ToString() #> <#= p.name #>
		{
			get { return _<#= p.name #>; }
			set
			{
				if (_<#= p.name #> != value)
				{
					_<#= p.name #> = value;
					OnPropertyChanged("<#= p.name #>");
				}
			}
		}
<# } #>
		#region INotifyPropertyChanged メンバ
		/// <summary>
		/// プロパティ変更時のイベント
		/// </summary>
		public event PropertyChangedEventHandler PropertyChanged;
		protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
		{
			if (PropertyChanged != null)
				PropertyChanged(this, e);
		}
		protected virtual void OnPropertyChanged(string name)
		{
			if (PropertyChanged != null)
				PropertyChanged(this, new PropertyChangedEventArgs(name));
		}
		#endregion
	}
<# } #>
}

テンプレートの中身自体は、インテリセンスが効かない状態なので（T4用の拡張プラグインを入れると効きます）、一度 *.cs ファイルに書き出してからちまちまと移しています。PHP か ASP.NET 風に書けば ok です。

Devart T4 Editor for Visual Studio 2010 sample
http://visualstudiogallery.msdn.microsoft.com/a42a8538-8d6e-491b-8097-5a8a00174d37
でダウンロードができます。

■自動生成された ViewModel.cs

テンプレートを保存すると、T4(TextTemplatingFileGenerator)が実行されて、ViewModel.cs ファイルが作成されます。本来は、partial にしてカスタマイズ部分と分離させると良いかなと。クラス名が元ネタのクラスと同じなので、実際は何らかのルールで変えたほうがよいでしょう。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel;

namespace SampleT4
{
	/// <summary>
	/// _ViewModel クラス
	/// </summary>
	public class _ViewModel : INotifyPropertyChanged
	{
		private System.Int32 _id;
		public System.Int32 id
		{
			get { return _id; }
			set
			{
				if (_id != value)
				{
					_id = value;
					OnPropertyChanged("id");
				}
			}
		}
		private System.String _name;
		public System.String name
		{
			get { return _name; }
			set
			{
				if (_name != value)
				{
					_name = value;
					OnPropertyChanged("name");
				}
			}
		}
		private System.Int32 _age;
		public System.Int32 age
		{
			get { return _age; }
			set
			{
				if (_age != value)
				{
					_age = value;
					OnPropertyChanged("age");
				}
			}
		}
		private System.DateTime _UpdateAt;
		public System.DateTime UpdateAt
		{
			get { return _UpdateAt; }
			set
			{
				if (_UpdateAt != value)
				{
					_UpdateAt = value;
					OnPropertyChanged("UpdateAt");
				}
			}
		}
		#region INotifyPropertyChanged メンバ
		/// <summary>
		/// プロパティ変更時のイベント
		/// </summary>
		public event PropertyChangedEventHandler PropertyChanged;
		protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
		{
			if (PropertyChanged != null)
				PropertyChanged(this, e);
		}
		protected virtual void OnPropertyChanged(string name)
		{
			if (PropertyChanged != null)
				PropertyChanged(this, new PropertyChangedEventArgs(name));
		}
		#endregion
	}
}

と、ここまで生成ができます。

本当は、別プロジェクトを作るのではなくて自前のアセンブリを参照して、対象の ViewModel クラスを見つけたいですよね。一度、「ViewModelTarget」の属性がない状態でビルドをした後に、別のところに保存。それを一時的に参照させればよいかな、と考えていますが。

ふと、|演算子（パイプ演算子）を使って、データベースのストリームを検索できたら、何かできるのではなかろうか…と骨休めがてらちょっと。

public class Test
{
	public void test001()
	{
		var db = new DB{ ConnectionString=""};
		RESULT items = db | "person" |
			"familyname".EQ("masuda") |
			"age".GE(20) |
			"*";
		RESULT items2 = db | "person" |
			"familyname".EQ("masuda") |
			"age".GE(20) |
			"id" | "familyname" | "lastname";
	}
	public void test002()
	{
		var db = new DB { ConnectionString = "" };
		RESULT items = 
			db | "person" |
			(EQ)"familyname" % "masuda" |	// familyname == "masuda" と同じ
			(UP)"age" % 20 |				// age >= 20 と同じ
			"*";
	}
	public void test003()
	{
		// これが直感的で良い
		var db = new DB { ConnectionString = "" };
		RESULT items =
			db | "person" |					// テーブルを指定
			(OP)"familyname" == "masuda" |	// 検索条件
			(OP)"age" >= 20 |				
			"*";							// 出力
	}
}

データストリームというよりも、擬似LINQ構文になっちゃった感じで、あまり意味がありませんが。|演算子のオーバーライドと、暗黙の型変換(implicit)を駆使すると、こんな風に書けますという例です。
データの比較を行うときに、”カラム名”.EQ(値) のように、最初はメソッド名を考えてみたのですが、あまり可読性がよくないので、「==演算子」等もオーバーライドすることにしました。

OP クラスのところが肝で、テーブルのカラム名（文字列）を一度 OP クラスにキャストしてから使うという妙な技をつかっています。このあたりは、もう少ししっかりと作れば、LINQ と同じになるんでしょうが、しっかり作ってしまうと LINQ と同じになりそうなんで、このあたりで止めておきます。

上記のコードをコンパイルするためのクラス群は以下になります。コンパイルするためだけなので、中身は作っていませんが、まあ、構造が分かるかと。本来はパイプで使うわけだから、グラフィック系のフィルターのようにしたいですよね。ちょっとそのあたりの例は思案中ということで。

public class DB
{
	private SqlConnection _cn;
	public string ConnectionString { get; set; }
	public static DB operator |(DB db, string name)
	{
		return db;
	}
	public static DB operator |(DB db, OP op)
	{
		return db;
	}
	public static implicit operator RESULT(DB db)
	{
		return new RESULT();
	}
}

public static class DPipeExtentions
{
	public static OP EQ( this string cname, object val )
	{
		return new OP { ColumnName = cname, Value= val, OpCode = OP.OPRATOR.EQ };
	}
	public static OP NE( this string cname, object val )
	{
		return new OP { ColumnName = cname, Value= val, OpCode = OP.OPRATOR.NE };
	}
	public static OP LE(this string cname, object val)
	{
		return new OP { ColumnName = cname, Value = val, OpCode = OP.OPRATOR.LE };
	}
	public static OP LT(this string cname, object val)
	{
		return new OP { ColumnName = cname, Value = val, OpCode = OP.OPRATOR.LT };
	}
	public static OP GE(this string cname, object val)
	{
		return new OP { ColumnName = cname, Value = val, OpCode = OP.OPRATOR.GE };
	}
	public static OP GT(this string cname, object val)
	{
		return new OP { ColumnName = cname, Value = val, OpCode = OP.OPRATOR.GT };
	}
}
public class OP
{
	public enum OPRATOR {
		EQ, NE, LT, LE, GT,GE,
	}
	public OPRATOR OpCode { get; set; }
	public string ColumnName { get; set; }
	public object Value { get; set; }
	public static OP operator %(OP op, object val)
	{
		op.Value = val;
		return op;
	}
	public static implicit operator OP(string name ) {
		return new OP{ ColumnName = name };
	}
	public static OP operator ==(OP op, object val) { 
		return new OP { ColumnName = op.ColumnName, Value = val, OpCode = OPRATOR.EQ };
	}
	public static OP operator !=(OP op, object val)
	{
		return new OP { ColumnName = op.ColumnName, Value = val, OpCode = OPRATOR.NE };
	}
	public static OP operator <(OP op, object val)
	{
		return new OP { ColumnName = op.ColumnName, Value = val, OpCode = OPRATOR.LT };
	}
	public static OP operator <=(OP op, object val)
	{
		return new OP { ColumnName = op.ColumnName, Value = val, OpCode = OPRATOR.LE };
	}
	public static OP operator >(OP op, object val)
	{
		return new OP { ColumnName = op.ColumnName, Value = val, OpCode = OPRATOR.GT };
	}
	public static OP operator >=(OP op, object val)
	{
		return new OP { ColumnName = op.ColumnName, Value = val, OpCode = OPRATOR.GE };
	}
	public override bool Equals(object obj)
	{
		return base.Equals(obj);
	}
	public override int GetHashCode()
	{
		return base.GetHashCode();
	}
}
public class RESULT : List<object>
{
}
public class EQ : OP
{
	public static implicit operator EQ(string name)
	{
		return (EQ)new OP { ColumnName = name, OpCode = OPRATOR.EQ };
	}
}
public class UP : OP
{
	public static implicit operator UP(string name)
	{
		return (UP)new OP { ColumnName = name, OpCode = OPRATOR.GE };
	}
}

VB6.0の頃は、デフォルトプロパティというものがあって、
http://akihitoyamashiro.com/VBA/CreateDefaultProperty.htm

なところにあるように、「Attribute Value.VB_UserMemId = 0 」という属性（みたいなもの）を設定して、オブジェクトのプロパティを決めていました。まあ、大ざっぱに言えば、「obj.Item(10)」のように配列にアクセスするときに、「obj(10)」のように、Itemメソッドを省略できるという技です。普通は Item というメソッドが使われるのですが、このメソッド名は「Attribute Value.VB_UserMemId = 0 」を付けメソッド（プロパティ）の場合は、これが省略できるという仕組みです。

で、これを C#, VB ならばどうやるか、という話を少し。

private void button1_Click(object sender, EventArgs e)
{
	DefaultClass obj = new DefaultClass();
	Debug.Print(obj[10]);
	Debug.Print(obj.Item(10));
	Debug.Print(obj["key"]);
	Debug.Print(obj.Item("key"));
}

private void button2_Click(object sender, EventArgs e)
{
	DefaultClass obj = new DefaultClass();
	// string 型に暗黙の変換
	string name = obj;
	Debug.Print("name:{0}", name);
	// int 型に暗黙の変換
	int num = obj;
	Debug.Print("num:{0}", num);
}

「既定のプロパティ」という機能をちょっと拡大解釈して、添え字（あるいは添え文字列？）で扱う時のメソッドと、単純にオブジェクトから別の型に変換されるときのプロパティ、という風に分けてみました。

■添え字を使う場合

「obj.Item[10]」と「obj(10)」が同じような動作をするためには、次なように、this[…] のように書きます。[] 演算子は多重定義が効くので、int型とstring型の両方を一度に作れます。配列風なものと連想配列風なものですね。これは、string型だけじゃなくて、任意のobject型も使えるので結構不思議な使い方ができます。

public string Item(int i)
{
	return string.Format("item-int:{0}", i);
}
public string Item(string name)
{
	return string.Format("item-str:{0}", name);
}
// Default と同じ扱いが可能
public string this[int i]
{
	get { return this.Item(i); }
}
// 連想配列風に
public string this[string name]
{
	get { return this.Item(name); }
}

ちなみに、[] 演算子は、ふたつ以上の引数を持つことができるので、obj[x,y] のようなアクセスの仕方もできます。定義は↓のようですね。

// 引数が二つある場合
public string this[int x, int y]
{
	get { return string.Format("{0} {1}", x, y); }
}

■暗黙の変換を使う

もうひとつ、implicit を使って暗黙的に変換させることができます。普通は、自前で作成したクラスからstring型のプロパティを取り出すには、ToString メソッドをオーバーライドしたりしますが、もっと端的にキャストを使っても良いわけです。↓のように、DefaultClass 型から、string型やint型に自動で変換してくれます。

rivate void button2_Click(object sender, EventArgs e)
{
	DefaultClass obj = new DefaultClass();
	// string 型に暗黙の変換
	string name = obj;
	Debug.Print("name:{0}", name);
	// int 型に暗黙の変換
	int num = obj;
	Debug.Print("num:{0}", num);
}

これを実装するためには、implicit を使って、string型や int型に自動的に変換されるようにします。ちなみに、implicit は暗黙変換なので、明示的な変換（キャスト）を使いたい場合は、explicit を使えば ok です。

public string ItemName { get;  set; }
public int ItemNum { get;  set; }

/// <summary>
/// 暗黙変換(string型)
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
public static implicit operator string( DefaultClass obj ) 
{
	return obj.ItemName;
}
/// <summary>
/// 暗黙変換(int型)
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
public static implicit operator int(DefaultClass obj)
{
	return obj.ItemNum;
}

これが何に役に立つかというと…あまりにトリッキー過ぎて役に立たないというか、文法的に不思議な感じになってしまというか、妙な感じになるので、多用するのはちょっと、という気になります。

…が、いま作っている ExDoc という XML をパースするライブラリは、このあたりを使っていて配列をstring型に自動変換したり、コレクションから単一のオブジェクトに代入するときに暗黙にキャストをしていたりします、という詳細は別の機会に。ソースコードは git にあるので、moonmile/ExDoc – GitHub ご覧ください。ただ今、HTML のパースを準備中。