More documentation

[Lucu.git] / Network / HTTP / Lucu / MIMEType / Guess.hs

diff --git a/Network/HTTP/Lucu/MIMEType/Guess.hs b/Network/HTTP/Lucu/MIMEType/Guess.hs
index db51e65cdce31d6bef85c93aeb32fe786ed51af1..93a1479837fb4c98f015faa163f48430d9778dd3 100644 (file)
--- a/Network/HTTP/Lucu/MIMEType/Guess.hs
+++ b/Network/HTTP/Lucu/MIMEType/Guess.hs
@@ -1,9 +1,13 @@
+-- |MIME Type guesser which guesses by a file extension. This is a
+-- poor man's way of guessing MIME Types. It is simple and fast.
+--
+-- In general you don't have to use this module directly.
 module Network.HTTP.Lucu.MIMEType.Guess
     ( ExtMap
-    , guessTypeByFileName -- ExtMap -> FilePath -> Maybe MIMEType
+    , guessTypeByFileName
 
-    , parseExtMapFile  -- FilePath -> IO ExtMap
-    , outputExtMapAsHS -- ExtMap -> FilePath -> IO ()
+    , parseExtMapFile
+    , serializeExtMap
     )
     where
 
@@ -20,16 +24,17 @@ import           Network.HTTP.Lucu.Parser.Http
 import           Network.HTTP.Lucu.Utils
 import           System.IO
 
+-- |Map from extension to MIME Type.
 type ExtMap = Map String MIMEType
 
-
+-- |Guess the MIME Type of file.
 guessTypeByFileName :: ExtMap -> FilePath -> Maybe MIMEType
 guessTypeByFileName extMap fpath
     = let ext = last $ splitBy (== '.') fpath
       in
         M.lookup ext extMap >>= return
 
-
+-- |Read an Apache mime.types and parse it.
 parseExtMapFile :: FilePath -> IO ExtMap
 parseExtMapFile fpath
     = do file <- B.readFile fpath
@@ -67,29 +72,38 @@ compile = M.fromList . foldr (++) [] . map tr
       tr :: (MIMEType, [String]) -> [ (String, MIMEType) ]
       tr (mime, exts) = [ (ext, mime) | ext <- exts ]
 
-
-outputExtMapAsHS :: ExtMap -> FilePath -> IO ()
-outputExtMapAsHS extMap fpath
+-- |@'serializeExtMap' extMap moduleName variableName@ generates a
+-- Haskell source code which contains the following things:
+--
+-- * A definition of module named @moduleName@.
+--
+-- * @variableName :: 'ExtMap'@ whose content is a serialization of
+--   @extMap@.
+--
+-- The module "Network.HTTP.Lucu.MIMEType.DefaultExtensionMap" is
+-- surely generated using this function.
+serializeExtMap :: ExtMap -> String -> String -> String
+serializeExtMap extMap moduleName variableName
     = let hsModule = HsModule undefined modName (Just exports) imports decls
-          modName  = Module "Network.HTTP.Lucu.MIMEType.DefaultExtensionMap"
-          exports  = [HsEVar (UnQual (HsIdent "defaultExtensionMap"))]
+          modName  = Module moduleName
+          exports  = [HsEVar (UnQual (HsIdent variableName))]
           imports  = [ HsImportDecl undefined (Module "Network.HTTP.Lucu.MIMEType") False Nothing Nothing
+                     , HsImportDecl undefined (Module "Network.HTTP.Lucu.MIMEType.Guess") False Nothing Nothing
                      , HsImportDecl undefined (Module "Data.Map") True (Just (Module "M")) Nothing
                      , HsImportDecl undefined (Module "Data.Map") False Nothing (Just (False, [HsIAbs (HsIdent "Map")]))
                      ]
-          decls    = [ HsTypeSig undefined [HsIdent "defaultExtensionMap"]
-                                     (HsQualType [] (HsTyApp (HsTyApp (HsTyCon (UnQual (HsIdent "Map")))
-                                                                      (HsTyCon (UnQual (HsIdent "String"))))
-                                                             (HsTyCon (UnQual (HsIdent "MIMEType")))))
-                     , HsFunBind [HsMatch undefined (HsIdent "defaultExtensionMap")
+          decls    = [ HsTypeSig undefined [HsIdent variableName]
+                                     (HsQualType []
+                                      (HsTyCon (UnQual (HsIdent "ExtMap"))))
+                     , HsFunBind [HsMatch undefined (HsIdent variableName)
                                   [] (HsUnGuardedRhs extMapExp) []]
                      ]
           extMapExp = HsApp (HsVar (Qual (Module "M") (HsIdent "fromList"))) (HsList records)
           comment =    "{- !!! WARNING !!!\n"
-                    ++ "   This file is automatically generated from data/mime.types.\n"
+                    ++ "   This file is automatically generated.\n"
                     ++ "   DO NOT EDIT BY HAND OR YOU WILL REGRET -}\n\n"
       in
-        writeFile fpath $ comment ++ prettyPrint hsModule ++ "\n"
+        comment ++ prettyPrint hsModule ++ "\n"
     where
       records :: [HsExp]
       records = map record $ M.assocs extMap