F#の文法は非常に簡潔で、短いタイプ量でコードを記述できるようになっています。このため、いったんF#のコーディングになれてしまうとC#でのコーディングが少し億劫になってしまいがちです（異論は認めません）。PowerShell用にバイナリーモジュールを書くときも同様です。できればF#で書きたい！

バイナリモジュールをF#で書くことそのもはそれほどむつかしくありません。C#で書くときと同じようにPSCmdletを継承したクラスを定義してアセンブリを生成するだけです（C#によるバイナリモジュールの生成の詳細については、ぎたぱそ先生の「PowerShell のモジュール詳解とモジュールへのコマンドレット配置手法を考える」をご覧ください）。

以下は、パイプラインを通じて与えられた整数の中から最大値を返すコマンドレットSelect-MaxをF#で定義した例です。

    namespace sample
    open System.Management.Automation

    [<Cmdlet("Select", "Max")>]
    type SelectMax() = 
        inherit PSCmdlet()
        [<DefaultValue>]
        val mutable private result : int
        [<DefaultValue>]
        val mutable private _InputValue : int
        [<Parameter(Mandatory=false,ValueFromPipeline=true)>]
        member public this.InputValue
            with get() = this._InputValue
            and set value = this._InputValue <- value
        override this.BeginProcessing() =
            do this.result <- 0
        override this.ProcessRecord() =
            do this.result <- max this.result this._InputValue
        override this.EndProcessing() =
            do base.WriteObject(this.result)

このF#のソースファイルをバイナリモジュールとして利用するには、まずコンパイルし、生成されたアセンブリをImport-Moduleで読みこんでやる必要があります。以下はコマンドラインコンパイラfsc.exeを利用してコンパイルしている例です。

    fsc.exe --out:sample.dll --target:library `
        --reference:System.Management.Automation sample.fs
    Import-Module .\sample.dll

これで以下のようにF#のソースファイルに記述したコマンドレットを利用できます。

    PS C:\> @(1,2,3) | Select-Max
    3

さて、これで一応使えるのですが、fsc.exeでわざわざコンパイルするのが少し面倒です。特にfsc.exeには標準でパスが通っていないので、上記のように普通にfsc.exeとだけ入力するだけでは通常エラーになりますし、出来上がったモジュールを配布する時のことを考えると、環境変数PATHの設定をしてもらうのも少し億劫です（F#を利用していない人にとってはfsc.exeをインストールするのがそもそも億劫なのでは、といった疑問は思っても口には出さない）。

F#のソースファイルをモジュールのようにあつかう

そこでF#のソースファイル、上記の例でいえばsample.fsですが、これをあたかもモジュールのように扱うことはできないでしょうか。例えば以下のようにです。

    Import-Module sample.fs

さすがにいろいろな制約があって、これはそのままに実現するのはちょっとむつかしいのですが、これにかなり近い形なら可能です。今回ここで紹介するPowerShellモジュールFSharpを用いると、以下のような形でF#のソースをモジュールとしてロードできるようになります。

    Import FSharp
    New-FsModule sample.fs | Import-Module

New-FsModuleでまずモジュールを生成し、それをImport-Moduleで読みこむという二段階の処理になっていますが、fsc.exeでコンパイルして……という手順と比較すればかなり手軽に使えるのではないでしょうか。

実装の概要

興味のある方もいるかもしれませんので、念のためFSharpの概要についも簡単に触れておきましょう。ソースを見てわかるように、このモジュールでは以下の3つの関数が定義されています。

解説が必要な箇所はほとんどないかと思います。Find-FsxExeのロジックがいくぶんアドホックに見えますが、こちらはFSharp.Compiler.CodeDomパッケージのCompilerLocationUtil.fsを参考にしています。

NOTE:サンプルを含めたソースファイル一式はgithubから入手可能です。

function Watch-PipeLine {

  param (
    [Parameter(Mandatory=$true)]
    [ScriptBlock] $ScriptBlock,
    [Parameter(Mandatory=$true,ValueFromPipeLine=$true)]
    [PSObject] $Object
  )

  process {
    $Object | Foreach $ScriptBlock
    $Object
  }

}

New-Alias Watch Watch-PipeLine 

これを使うと、パイプラインを流れるオブジェクトを簡単にのぞき見できます。たとえば以下のようなファイル名の一覧を取得している処理があったとしましょう。

$logFiles = dir -Recurse Logs |
 Where PSIsContainer -eq $false |
 Foreach Name |
 Sort-Object

ここでファイルサイズを合計もとりたいという要望があったので、以下のように書き換えたとします。

$total = 0

$logFiles = dir -Recurse Logs |
 Where PSIsContainer -eq $false |
 Foreach {
   $total += $_.Length
   $_.Name
 } |
 Sort-Object

これで問題はまったくないのですが、パイプラインの流れがちょっとみづらくなりました。Foreach のところで最終的に $_.Name を emit していることが読み取りやすいかどうかがポイントです。ここで、上記の Watch-PipeLine を用いると、以下のように書き換えることができます。

$total = 0

$logFiles = dir -Recurse Logs |
 Where PSIsContainer -eq $false |
 Watch { $total += $_.Length } |
 Foreach Name |
 Sort-Object

パイプラインの各段の処理にはまったく手をいれておらず、Watch の一行を追加しただけです。Watch はパイプラインの値をのぞき見して何か処理をしている、ということがわかっているので、パイプラインのメインの流れをみるうえでは Watch の部分を気にする必要はありません。

実のところ、ここで用いた Watch は以下のような Foreach  と等価です。

Foreach { $total += $_.Length; $_ }

これで十分なのでは、という話もあるんですが、これはこれで最後の $_ を付け忘れたりすることがあります。

というか付け忘れたので、こういう案をひとつ思いついた、というエントリでした。

$custom = [pscustomobject] @{ Message = 'Hello, world!' } |
  Add-Member -PassThru -MemberType ScriptMethod -Name Hello -Value {
    Write-Host -Foreground Green $this.Message
  }

この例は、Message というプロパティと、その値をホストに緑色で表示する Hello というメソッドをもったカスタムオブジェクトを定義しています。少し複雑な処理をするときなどは、このようなカスタムオブジェクトを積極的に活用する機会が多くなりますが、いかんせん記述が煩雑なことに加えて、メンバーのスコープを制御できないという欠点があります。

そんな場合は、動的モジュールを利用してカスタムオブジェクトを定義するといいですよ、というのが今回のネタです。

動的モジュールとは、その名のとおり、メモリ空間内に動的に生成されるモジュールのことで、New-Module を用いて生成します。試しに、動的モジュールをひとつ定義してみましょう。

New-Module {
  $Message = 'Hello, world!'
  function Hello { Write-Host -Foreground Green $Message }
}

これを実行するとモジュールが動的に生成され、モジュール内で定義したメンバーがセッションにインポートされ、利用可能になります。

これだけだと動的にモジュールを定義できました、というだけの話であまり面白くありません。興味深くなるのは New-Module に -AsCustomObject オプションを指定してからです。

$custom = New-Module  {
   …
} -AsCustomObject

このオプションを指定すると、エクスポートしたモジュールメンバーは現在のセッションのスコープにインポートされなくなります。そのかわり、モジュールのオブジェクトのメンバーとしてアクセスできるようになります。

$custom.Hello()

ここで気づかれたかと思いますが、このように生成した動的モジュールのインスタンスの振る舞いはカスタムオブジェクトそのものです。しかも、Export-ModuleMember を利用することで、メンバー変数や関数のスコープを自由にコントロールできるという利点があります。たとえば、モジュールで定義した変数は、デフォルトではエクスポートされません（上記の例でいうと$Messageという変数）。エクスポートさせるには以下のように明示的に指示する必要があります。

$custom = New-Module  {
   …
  Export-ModuleMember -Function Hello
  Export-ModuleMember -Variable Message

} -AsCustomObject

Export-ModuleMember を用いて明示的に Message をエクスポートしていることに加え、先ほどは暗黙的にエクスポートされていた Hello も明示的にエクスポートしている点に注意してください。明示的なエクスポートを用いる場合、公開したいメンバーを明示的にすべてエクスポートする必要があります。

モジュール定義にもちいるスクリプトブロックは、scriptblockのインスタンスであることには変わりないので、paramを用いて引数をとることができます。これを利用すると、以下のようなコンストラクター的関数を定義することも可能です。

function New-Greeter {
  param ([string] $ToWhom = 'World')
  New-Module {
    param ([string] $ToWhom)
    $Message = "Hello, $ToWhom!"
    Function Hello { Write-Host -Foreground Green $Message }
  } -AsCustomObject -ArgumentList $ToWhom
}

というわけで、New-Module を用いたカスタムオブジェクトの定義方法について簡単にまとめてみました。大規模なスクリプトを書くときにカスタムオブジェクトは非常に有用なので、ぜひ利用を検討してみてください。

明日は αετος さんの担当です。お楽しみに！ 

PowerShell で標準で用意されている XML のサポートは、DOM をベースにした XmlDocument クラスを用いるものです。当然ながら、この仕組みを用いてスクリプトを書くことに全然問題はありません。

しかし、シンプルかつよりスマートな System.XML.Linq が使える現在、PowerShell ベースとはいえ今更 DOM ベースの XmlDocument を使うのは、少し心理的に抵抗がある人もいるでしょう（例えば筆者）。XmlDocument と XDocument で、機能的に大きな違いはないのですが、XML 標準の DOM という考え方には幾分クセがあり、XmlDocument のその独特の使用方法に馴染むまで少しムズムズする可能性があります（ちなみに私は10年来ずっとムズムズしたままです）。

そういうわけで、XDocument を手軽に扱うための PowerShell モジュールを作ってみました（最後にソースを貼り付けてあります）、というのが今回のお題です。基本的にはコンストラクターをラップしたコマンドレットが中心で、以下のような形で使うことを想定しています。

$doc = New-XDocument ( `
  New-XElement users `
    (New-XElement user (New-XAttribute name ichiro)) `
    (New-XElement user (New-XAttribute name andrej)) `
)

これは新規に以下のような XML 文書のオブジェクトである XDocument を生成しています。

<?xml version='1.0'? encoding='utf-8'>
<users>
  <user name='ichiro' />
  <user name='andrej' />
</users>

さすがにこれだとちょっとタイプ量が半端ないので、alias も仕込んでみました。これで以下のようにスッキリと書けます。

$doc = xd (xe users (xe user (xa name ichiro)) (xe user (xa name andrej)))

ユーザーを追加してみましょう。XPath を使って users のノードを取り出し、そのノードに新しい user ノードを子供として追加します。

$users = $doc | Select-XNode users
$users.Add((xe user (xa name taro)))

Select-XNode は [System.Xml.Linq.Extensions]::XPathEvaluate のラッパーです。ただそのままラップすると芸が無いので、PowerShell っぽく引数をパイプラインから取れるように細工しています。

ファイルへの保存およびファイルからの読み出しも用意してあります。

$doc | Set-XDocument .\users.xml 
$doc = Get=XDocument .\users.xml

さて、生成したり、変更したり、といった観点で XDocument は非常に使い勝手がいいのですが、XmlDocument の使い勝手のほうが遥かによい場合があります。これは PowerShell 限定の話なのですが、PSObject として XmlDocument がラップされる際、属性や子供の要素の値を簡単にアクセスできるように、属性や子供の要素の名前のプロパティが自動で生成されます。例えば、さきほどのユーザーリストの XML 文書、ユーザーの名前を取り出したい場合、XmlDocument だと以下のように直感的にかけます。

[xml] $doc = Get-Content .\users.xml 
$names = @($doc.users.user | Foreach { $_.name })

最初、これと同じことを XDocument で出来るといいかなぁ、と思い、生成した XDocument / XElement に NoteProperty を後からくっつける……ようなことをちょっと考えていたんですが、ちょいと面倒、というか不毛な感じがしてきたのでやめました。

代わりに、もっと簡単な方法ですが、XmlDocument と XDocument を相互変換できるようにしてみました。利用シーンに応じて適切に使い分けるといいでしょう。

$doc = xd (xe users (xa version 1) (xe user (xa name ichiro)) (xe user (xa name andrej))) |
  ConvertFrom-XDocument

$names = $doc.users.user | Foreach {$_.name }

逆に、XmlDocument を取り扱っているときに、更新の場合だけ XDocument に変更するのもありです。

明日は Jolly.Jive さんの番です。お楽しみに！

モジュールのソースコード

[void] [System.Reflection.Assembly]::LoadWithPartialName("System.Xml")
[void] [System.Reflection.Assembly]::LoadWithPartialName("System.Xml.Linq")

function New-XAttribute (
  [parameter(Mandatory=$true)]
  [PSObject] $Name,
  [parameter(Mandatory=$true)]
  [string] $Value
) {
  New-Object System.Xml.Linq.XAttribute @($Name, $Value)
}

function New-XElement (
  [parameter(Mandatory=$true,Position=0)]
  [string] $Name,
  [parameter(Mandatory=$false,ValueFromRemainingArguments=$true)]
  [PSObject[]] $Children = @()
) {
  $xname = [System.Xml.Linq.XName]::Get($Name)
  $element = New-Object System.Xml.Linq.XElement $xname
  $Children | Foreach { $element.Add($_) }
  $element
}

function New-XDocument (
  [parameter(Mandatory=$false,ValueFromRemainingArguments=$true)]
  [PSObject[]] $Children = @()
) {
  $doc = New-Object System.Xml.Linq.XDocument
  $Children | Foreach { $doc.Add($_) }
  $doc
}

function Select-XNode (
  [parameter(Mandatory=$true)]
  [string] $XPath,
  [parameter(Mandatory=$true,ValueFromPipeline=$true)]
  [System.Xml.Linq.XNode] $Node
) {
  process {
    [System.Xml.XPath.Extensions]::XPathEvaluate($Node, $XPath)
  }
}

function ConvertTo-XDocument (
  [parameter(Mandatory=$true,ValueFromPipeline=$true)]
  [xml] $Source
) {

  process {
    $reader = New-Object System.Xml.XmlNodeReader $Source
    try {
      [void] $reader.MoveToContent()
      [System.Xml.Linq.XDocument]::Load($reader)
    } finally {
      $reader.Close()
    }
  }
}

function ConvertFrom-XDocument (
  [parameter(Mandatory=$true,ValueFromPipeline=$true)]
  [System.Xml.Linq.XDocument] $Source
) {

  process {
    $reader = $Source.CreateReader()
    try {
      $doc = New-Object System.Xml.XmlDocument
      $doc.Load($reader)
      $doc
    } finally {
      $reader.Close()
    }
  }
}

function Get-XDocument (
  [parameter(Mandatory=$true)]
  [string] $Path,
  [parameter(Mandatory=$false)]
  [System.Text.Encoding] $Encoding = [System.Text.Encoding]::UTF8
) {

  if (-not (Test-Path $Path)) {
    throw "Unable to find '$Path'."
  }

  $Path = @(Get-ChildItem $Path)[0].FullName
  $reader = New-Object System.IO.StreamReader @($Path, $Encoding)
  
  try {
    [System.Xml.Linq.XDocument]::Load($reader)
  } finally {
    $reader.Close()
  }
}

function Set-XDocument (
  [parameter(Mandatory=$true)]
  [string] $Path,
  [parameter(Mandatory=$true,ValueFromPipeline=$true)]
  [System.Xml.Linq.XDocument] $Document
) {
  process {
    $Document.Save($Path)
  }
}

New-Alias xe New-XElement
New-Alias xa New-XAttribute
New-Alias xd New-XDocument
New-Alias sx Select-XNode

Export-ModuleMember -Function '*'
Export-ModuleMember -Alias '*'