Haskellにてstackでiconvパッケージを利用する方法【Windows環境】

Question

###前提・実現したいこと
Windows環境でHaskellのiconvパッケージを使って
文字コード変換を行うプログラムを作りたいと考えています。

stackを使ってiconvパッケージのインストールは成功したのですが
このiconvを使用したプログラムをビルドするとエラーが発生し、
ビルドに失敗してしまいました。

###発生している問題・エラーメッセージ

C:\develop\haskell\encoding3>stack build
encoding-0.1.0.0: build (exe)
Preprocessing executable 'encoding-exe' for encoding-0.1.0.0...
Linking .stack-work\dist\ca59d0ab\build\encoding-exe\encoding-exe.exe ...
C:\sr\snapshots\518da490\lib\x86_64-windows-ghc-8.0.2\iconv-0.4.1.3-I85O545vzBcKCsc6STHSc0/libHSiconv-0.4.1.3-I85O545vzBcKCsc6STHSc0.a(hsiconv.o):hsiconv.c:(.text+0x1): `libiconv_open' に対する定義されていない参照です
C:\sr\snapshots\518da490\lib\x86_64-windows-ghc-8.0.2\iconv-0.4.1.3-I85O545vzBcKCsc6STHSc0/libHSiconv-0.4.1.3-I85O545vzBcKCsc6STHSc0.a(hsiconv.o):hsiconv.c:(.text+0x11): `libiconv' に対する定義されていない参照です
C:\sr\snapshots\518da490\lib\x86_64-windows-ghc-8.0.2\iconv-0.4.1.3-I85O545vzBcKCsc6STHSc0/libHSiconv-0.4.1.3-I85O545vzBcKCsc6STHSc0.a(hsiconv.o):hsiconv.c:(.text+0x21): `libiconv_close' に対する定義されていない参照です
collect2.exe: error: ld returned 1 exit status
`gcc.exe' failed in phase `Linker'. (Exit code: 1)

--  While building package encoding-0.1.0.0 using:
      C:\sr\setup-exe-cache\x86_64-windows\Cabal-simple_Z6RU0evB_1.24.2.0_ghc-8.0.2.exe --builddir=.stack-work\dist\ca59d0ab build exe:encoding-exe --ghc-options " -ddump-hi -ddump-to-file"
    Process exited with code: ExitFailure 1

###該当のソースコード

module Main where

import Codec.Text.IConv
import Data.ByteString.Lazy
import Data.ByteString.Builder

main :: IO ()
main = print $ unpack $ convert "UTF-8" "Shift_JIS" (toLazyByteString $ stringUtf8 "ほげ")

###Cabalファイルの設定

executable encoding-exe
  hs-source-dirs:      app
  main-is:             Main.hs
  ghc-options:         -threaded -rtsopts -with-rtsopts=-N
  build-depends:       base
                     , bytestring
                     , iconv
  default-language:    Haskell2010

###試したこと
調べたところ、下記のURLによるとstackageにあるiconvのcabalファイルには外部ライブラリであるiconvのヘッダーファイルとライブラリを
指定する項目がないことが原因とありました。

https://github.com/commercialhaskell/stack/issues/1767

そこで次の２つを試してみました。
１．stack.yamlにヘッダファイルとライブラリを指定

extra-include-dirs:
- C:\Users\Owner\AppData\Local\Programs\stack\x86_64-windows\ghc-8.0.2\mingw\include
extra-lib-dirs:
- C:\Users\Owner\AppData\Local\Programs\stack\x86_64-windows\ghc-8.0.2\mingw\lib

設定後、stack buildを実行しましたが同じエラーでビルドに
失敗しました。

２．iconvパッケージをダウンロードしてCabalファイルを修正
自プロジェクトにiconvパッケージのソースを配置し
cabalファイルに以下の設定を追加しビルド。

library
  exposed-modules: Lib.Codec.Text.IConv
  other-modules:   Lib.Codec.Text.IConv.Internal
  build-depends:   base >= 3 && < 5,
                   bytestring == 0.9.* || ==0.10.*
  extensions:      ForeignFunctionInterface
  includes:        hsiconv.h
  include-dirs:    Lib/cbits, C:\Users\Owner\AppData\Local\Programs\stack\x86_64-windows\ghc-8.0.2\mingw\include
  extra-lib-dirs:  C:\Users\Owner\AppData\Local\Programs\stack\x86_64-windows\ghc-8.0.2\mingw\lib
  c-sources:       Lib/cbits/hsiconv.c
  if os(darwin) || os(freebsd) || os(windows)
    -- on many systems the iconv api is part of the standard C library
    -- but on some others we have to link to an external libiconv:
    extra-libraries: iconv

  ghc-options: -Wall

従来のCabalファイルとの変更点は
・include-dirs、extra-lib-dirsにパスを追加
・「os(windows)」を追加
です。

ビルドは成功し、実行は正常にできましたが
stackにパッケージがあるのに
手動でダウンロードしなければならないのが気になります。

stackだけでうまくiconvパッケージを利用する方法は
ないのでしょうか？

宜しくお願いします。

###補足情報(言語/FW/ツール等のバージョンなど)
OS: Windows 10 Pro 64bit
Haskell: Haskell Platform 8.2.1
stack: Version 1.5.1, Git revision 600c1f01435a10d127938709556c1682ecfd694e x86_64 hpack-0.17.1

Answer 1

sasakikj さんの調査通り、iconv パッケージは Windows で利用するには修正が必要なようです。

iconv パッケージの公式リポジトリーはこちらですが、そこからフォークして Windows で動くようにしたものが GitHub にありましたのでそちらを利用する方法を紹介します。

修正済みリポジトリーはこちらで、差分は下記です。

--- a/iconv.cabal
+++ b/iconv.cabal
@@ -30,5 +30,7 @@ library
     -- on many systems the iconv api is part of the standard C library
     -- but on some others we have to link to an external libiconv:
     extra-libraries: iconv
+  if os(windows)
+    extra-libraries: iconv-2
 
   ghc-options: -Wall

コミットコメントによると下記の理由によるそうです。

This way it's usable on Windows with mingw and ghc-7.10.3.
libiconv-2.dll is taken from mingw that comes with ghc.
linking with libiconv.a does not work even when building
a binary, not to mention interactive mode where shared library
is the only viable option for linking with foreign code on windows.

さて、これを利用する方法ですが、作ろうとしている encoding パッケージの encoding.cabal のあるディレクトリーに下記のような stack.yaml ファイルを作成します。

resolver: lts-9.14
packages:
- '.'
- location:
    git: [e-mail]:gzh/iconv.git
    commit: cfb368834e48938182457716183f542ddedbf7a0
  extra-dep: true

そして、下記のように stack build でビルドが成功し、stack exec encoding-exe で実行ができるはずです。（“λ” はプロンプトです。）

λ Get-ChildItem
    ディレクトリ: C:\Users\kazuki\Temp\encoding

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----       2017/11/29      0:12                app
-a----       2017/11/29      0:11            380 encoding.cabal
-a----       2017/11/29      0:39            161 stack.yaml
λ stack build
λ stack exec encoding-exe
[130,217,130,176]

stack.yaml の意味ですが、packages の . で encoding パッケージを指し、location の箇所で GitHub 上の特定のコミットを指定することで Stackage にある iconv パッケージよりもそちらを優先して利用するようにしています。

以上で、質問の回答になりますが、本来なら本家のライブラリーで対処してほしいところで、本家の方は Darcs でバージョン管理しているようでイシュートラッカーもないようですので、Hackage に掲載のメールアドレス（Duncan Coutts [e-mail]）にパッチを送るのがよいと思います。

Comments

[akiratto]

とても丁寧な回答ありがとうございます！
ご教示頂いた手順でビルドと実行が成功しました！

>（Duncan Coutts <[e-mail]>）にパッチを送るのがよいと思います。

恥ずかしながら英語は苦手なのですが
頂いた回答を基に、本家の方にパッチを送ってみます。

本当にありがとうございました！