1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
#!/usr/bin/env runhaskell
{-# LANGUAGE CPP #-}
{-# LANGUAGE RecordWildCards #-}
import Control.Monad
import Data.Maybe
import Distribution.InstalledPackageInfo
import Distribution.Package
import Distribution.Simple.Compiler hiding (Flag)
import Distribution.Simple.GHC
import Distribution.Simple.PackageIndex
import Distribution.Simple.Program
import Distribution.Simple.Utils
import Distribution.Verbosity
import System.Console.GetOpt
import System.Directory
import System.Environment
import System.Exit
import System.FilePath
import System.IO
import System.Process
baseDir, rootDir :: FilePath
baseDir = takeDirectory __FILE__
rootDir = baseDir </> ".."
srcDir, refDir, outDir :: FilePath
srcDir = baseDir </> "src"
refDir = baseDir </> "ref"
outDir = baseDir </> "out"
resDir :: FilePath
resDir = rootDir </> "resources"
data Config = Config
{ cfgHaddockPath :: FilePath
, cfgGhcPath :: FilePath
, cfgFiles :: [FilePath]
, cfgHaddockArgs :: [String]
, cfgEnv :: Environment
}
main :: IO ()
main = do
cfg <- uncurry loadConfig =<< checkOpt =<< getArgs
runHaddock cfg
checkOutput cfg
checkOutput :: Config -> IO ()
checkOutput _ = return () -- TODO.
runHaddock :: Config -> IO ()
runHaddock (Config { .. }) = do
handle <- runProcess' cfgHaddockPath $ processConfig
{ pcArgs = cfgHaddockArgs
, pcEnv = Just $ cfgEnv
}
waitForSuccess "Failed to run Haddock on specified test files" handle
checkOpt :: [String] -> IO ([Flag], [String])
checkOpt args = do
let (flags, files, errors) = getOpt Permute options args
unless (null errors) $ do
hPutStr stderr $ concat errors
exitFailure
when (FlagHelp `elem` flags) $ do
hPutStrLn stderr $ usageInfo "" options
exitSuccess
return (flags, files)
loadConfig :: [Flag] -> [String] -> IO Config
loadConfig flags files = do
cfgEnv <- (:) ("haddock_datadir", resDir) <$> getEnvironment
cfgHaddockPath <- pure $ flip fromMaybe (flagsHaddockPath flags) $
rootDir </> "dist" </> "build" </> "haddock" </> "haddock"
printVersions cfgEnv cfgHaddockPath
cfgGhcPath <- flip fromMaybe (flagsGhcPath flags) <$>
init <$> rawSystemStdout normal cfgHaddockPath ["--print-ghc-path"]
cfgFiles <- processFileArgs files
cfgHaddockArgs <- liftM concat . sequence $
[ pure ["--no-warnings"]
, pure ["--odir=" ++ outDir]
, pure ["--pretty-html"]
, pure ["--optghc=-w"]
, pure $ flagsHaddockOptions flags
, baseDependencies cfgGhcPath
]
return $ Config { .. }
printVersions :: Environment -> FilePath -> IO ()
printVersions env haddockPath = do
handle <- runProcess' haddockPath $ processConfig
{ pcEnv = Just env
, pcArgs = ["--version"]
}
waitForSuccess "Failed to run `haddock --version`" handle
handle <- runProcess' haddockPath $ processConfig
{ pcEnv = Just env
, pcArgs = ["--ghc-version"]
}
waitForSuccess "Failed to run `haddock --ghc-version`" handle
baseDependencies :: FilePath -> IO [String]
baseDependencies ghcPath = do
(_, _, cfg) <- configure normal (Just ghcPath) Nothing
defaultProgramConfiguration
pkgIndex <- getInstalledPackages normal [GlobalPackageDB] cfg
mapM (getDependency pkgIndex) ["base", "process", "ghc-prim"]
where
getDependency pkgIndex name = case ifaces pkgIndex name of
[] -> do
hPutStrLn stderr $ "Couldn't find base test dependency: " ++ name
exitFailure
(ifArg:_) -> pure ifArg
ifaces pkgIndex name = do
pkg <- join $ snd <$> lookupPackageName pkgIndex (PackageName name)
iface <$> haddockInterfaces pkg <*> haddockHTMLs pkg
iface file html = "--read-interface=" ++ html ++ "," ++ file
processFileArgs :: [String] -> IO [FilePath]
processFileArgs [] = filter isSourceFile <$> getDirectoryContents srcDir
processFileArgs args = pure $ map processFileArg args
processFileArg :: String -> FilePath
processFileArg arg
| isSourceFile arg = arg
| otherwise = srcDir </> arg <.> "hs"
isSourceFile :: FilePath -> Bool
isSourceFile path = takeExtension path `elem` [".hs", ".lhs"]
data Flag
= FlagHaddockPath FilePath
| FlagGhcPath FilePath
| FlagHaddockOptions String
| FlagHelp
deriving Eq
options :: [OptDescr Flag]
options =
[ Option [] ["haddock-path"] (ReqArg FlagHaddockPath "FILE")
"path to Haddock executable to exectue tests with"
, Option [] ["ghc-path"] (ReqArg FlagGhcPath "FILE")
"path to GHC executable"
, Option [] ["haddock-options"] (ReqArg FlagHaddockOptions "OPTS")
"additional options to run Haddock with"
, Option ['h'] ["help"] (NoArg FlagHelp)
"display this help end exit"
]
flagsHaddockPath :: [Flag] -> Maybe FilePath
flagsHaddockPath flags = mlast [ path | FlagHaddockPath path <- flags ]
flagsGhcPath :: [Flag] -> Maybe FilePath
flagsGhcPath flags = mlast [ path | FlagGhcPath path <- flags ]
flagsHaddockOptions :: [Flag] -> [String]
flagsHaddockOptions flags = concat
[ words opts | FlagHaddockOptions opts <- flags ]
type Environment = [(String, String)]
data ProcessConfig = ProcessConfig
{ pcArgs :: [String]
, pcWorkDir :: Maybe FilePath
, pcEnv :: Maybe Environment
, pcStdIn :: Maybe Handle
, pcStdOut :: Maybe Handle
, pcStdErr :: Maybe Handle
}
processConfig :: ProcessConfig
processConfig = ProcessConfig
{ pcArgs = []
, pcWorkDir = Nothing
, pcEnv = Nothing
, pcStdIn = Nothing
, pcStdOut = Nothing
, pcStdErr = Nothing
}
runProcess' :: FilePath -> ProcessConfig -> IO ProcessHandle
runProcess' path (ProcessConfig { .. }) = runProcess
path pcArgs pcWorkDir pcEnv pcStdIn pcStdOut pcStdErr
waitForSuccess :: String -> ProcessHandle -> IO ()
waitForSuccess msg handle = do
result <- waitForProcess handle
unless (result == ExitSuccess) $ do
hPutStrLn stderr $ msg
exitFailure
mlast :: [a] -> Maybe a
mlast = listToMaybe . reverse
|
