module Language.Haskell.Modules.Split
( splitModule
) where
import Control.Exception (throw)
import Control.Monad (when)
import Control.Monad.Trans (liftIO)
import Data.Char (isAlpha, isAlphaNum, toUpper)
import Data.Default (Default(def))
import Data.Foldable as Foldable (fold)
import Data.List as List (filter, intercalate, map, nub)
import Data.Map as Map (delete, elems, empty, filter, insertWith, lookup, Map, mapWithKey)
import Data.Maybe (fromMaybe, mapMaybe)
import Data.Monoid ((<>), mempty)
import Data.Sequence ((|>), (<|))
import Data.Set as Set (delete, difference, empty, filter, fold, insert, intersection, map, member, null, Set, singleton, toList, union, unions)
import Data.Set.Extra as Set (gFind, mapM)
import Language.Haskell.Exts (fromParseResult, ParseResult(ParseOk, ParseFailed))
import qualified Language.Haskell.Exts.Annotated as A (Decl, ImportDecl(..), ImportSpecList(..), Module(Module), ModuleHead(ModuleHead), Name)
import Language.Haskell.Exts.Annotated.Simplify (sImportDecl, sImportSpec, sModuleName, sName)
import Language.Haskell.Exts.Pretty (defaultMode, prettyPrint, prettyPrintWithMode)
import Language.Haskell.Exts.SrcLoc (SrcSpanInfo(..))
import qualified Language.Haskell.Exts.Syntax as S (ImportDecl(..), ModuleName(..), Name(..))
import Language.Haskell.Modules.Common (withCurrentDirectory)
import Language.Haskell.Modules.Fold (ModuleInfo, echo, echo2, foldDecls, foldExports, foldHeader, foldImports, foldModule, ignore, ignore2)
import Language.Haskell.Modules.Imports (cleanImports)
import Language.Haskell.Modules.Internal (doResult, modifyParams, modulePath, ModuleResult(..), MonadClean(getParams), Params(moduVerse, sourceDirs, testMode), parseFileWithComments, runMonadClean)
import Language.Haskell.Modules.Params (modifyModuVerse)
import Language.Haskell.Modules.Util.QIO (quietly, qLnPutStr)
import Language.Haskell.Modules.Util.Symbols (exports, imports, symbols)
import Language.Haskell.Modules.Util.Test (diff, repoModules)
import Prelude hiding (writeFile)
import System.Cmd (system)
import System.Exit (ExitCode(ExitSuccess, ExitFailure))
import System.FilePath ((<.>))
import Test.HUnit (assertEqual, Test(TestCase, TestList, TestLabel))
data DeclName
= Exported S.Name
| Internal S.Name
| ReExported S.Name
| Instance
deriving (Eq, Ord, Show)
setAny :: Ord a => (a -> Bool) -> Set a -> Bool
setAny f s = not (Set.null (Set.filter f s))
setMapMaybe :: Ord b => (a -> Maybe b) -> Set a -> Set b
setMapMaybe p s = Set.fold f Set.empty s
where f x s' = maybe s' (\ y -> Set.insert y s') (p x)
setMapM_ :: (Monad m, Ord b) => (a -> m b) -> Set a -> m ()
setMapM_ f s = do _ <- Set.mapM f s
return ()
splitModule :: MonadClean m => S.ModuleName -> m ()
splitModule old =
do univ <- getParams >>= return . fromMaybe (error "moduVerse not set, use modifyModuVerse") . moduVerse
path <- modulePath old
text <- liftIO $ readFile path
(parsed, comments) <- parseFileWithComments path >>= return . fromParseResult
newFiles <- doSplit univ (parsed, text, comments) >>= return . collisionCheck univ
setMapM_ doResult newFiles
setMapM_ doClean newFiles
modifyParams (\ p -> p {moduVerse = Just (Set.delete old (union (created newFiles) univ))})
where
collisionCheck univ s =
if not (Set.null illegal)
then error ("One or more module to be created by splitModule already exists: " ++ show (Set.toList illegal))
else s
where
illegal = Set.intersection univ (created s)
created :: Set ModuleResult -> Set S.ModuleName
created = setMapMaybe (\ x -> case x of Created m _ -> Just m; _ -> Nothing)
doClean :: MonadClean m => ModuleResult -> m ()
doClean (Created m _) = doClean' m
doClean (Modified m _) = doClean' m
doClean (Removed _) = return ()
doClean (Unchanged _) = return ()
doClean' m =
do flag <- getParams >>= return . not . testMode
when flag (modulePath m >>= cleanImports >> return ())
justs :: Ord a => Set (Maybe a) -> Set a
justs = Set.fold (\ mx s -> maybe s (`Set.insert` s) mx) Set.empty
doSplit :: MonadClean m => Set S.ModuleName -> ModuleInfo -> m (Set ModuleResult)
doSplit _ (A.Module _ _ _ _ [], _, _) = return Set.empty
doSplit _ (A.Module _ _ _ _ [_], _, _) = return Set.empty
doSplit _ (A.Module _ Nothing _ _ _, _, _) = throw $ userError $ "splitModule: no explicit header"
doSplit univ m@(A.Module _ (Just (A.ModuleHead _ moduleName _ _)) _ _ _, _, _) =
qLnPutStr ("Splitting " ++ show moduleName) >>
Set.mapM (updateImports reExported internal (sModuleName moduleName) symbolToModule) univ' >>=
return . union splitModules
where
symbolToModule = defaultSymbolToModule m reExported internal old
old = sModuleName moduleName
declared :: Set (Maybe S.Name)
declared = foldDecls (\ d _pref _s _suff r -> Set.union (symbols d) r) ignore2 m Set.empty
exported :: Set S.Name
exported = foldExports ignore2 (\ e _pref _s _suff r -> Set.union (justs (symbols e)) r) ignore2 m Set.empty
reExported :: Set S.Name
reExported = difference exported (justs declared)
internal :: Set S.Name
internal = difference (justs declared) exported
univ' = Set.delete old univ
newModuleNames :: Set S.ModuleName
newModuleNames = Set.map (subModuleName reExported internal old) (union declared (Set.map Just exported))
splitModules :: Set ModuleResult
splitModules =
union (Set.map newModule newModuleNames)
(if member old newModuleNames then Set.empty else singleton (Removed old))
newModule :: S.ModuleName -> ModuleResult
newModule name'@(S.ModuleName modName) =
(if member name' univ then Modified else Created) name' $
case Map.lookup name' moduleDeclMap of
Nothing ->
Foldable.fold (foldHeader echo2 echo (\ _n pref _ suff r -> r |> pref <> modName <> suff) echo m mempty) <>
Foldable.fold (foldExports echo2 ignore ignore2 m mempty) <>
doSeps (Foldable.fold (foldExports ignore2
(\ e pref s suff r -> if setAny (`member` reExported) (justs (symbols e)) then r |> [(pref, s <> suff)] else r)
(\ s r -> r |> [("", s)]) m mempty)) <>
Foldable.fold (foldImports (\ _i pref s suff r -> r |> pref <> s <> suff) m mempty)
Just modDecls ->
Foldable.fold (foldHeader echo2 echo (\ _n pref _ suff r -> r |> pref <> modName <> suff) echo m mempty) <>
(let mh = let (A.Module _ x _ _ _, _, _) = m in x
me = maybe Nothing (\ h -> let (A.ModuleHead _ _ _ x) = h in x) mh in
maybe "\n ( " (\ _ -> Foldable.fold $ foldExports (<|) ignore ignore2 m mempty) me <>
intercalate "\n , " (nub (List.map (prettyPrintWithMode defaultMode) (newExports modDecls))) <> "\n" <>
maybe " ) where\n" (\ _ -> Foldable.fold $ foldExports ignore2 ignore (<|) m mempty) me) <>
fromMaybe "" (foldImports (\ _i pref _ _ r -> maybe (Just pref) Just r) m Nothing) <>
unlines (List.map (prettyPrintWithMode defaultMode) (elems (newImports modDecls))) <> "\n" <>
fromMaybe "" (foldImports (\ _i pref s suff r -> Just (maybe (s <> suff) (\ l -> l <> pref <> s <> suff) r)) m Nothing) <>
concatMap snd (reverse modDecls)
where
newExports modDecls = nub (concatMap (exports . fst) modDecls)
newImports modDecls =
mapWithKey toImportDecl (Map.delete name'
(Map.filter (\ pairs ->
let declared = justs (Set.unions (List.map (symbols . fst) pairs)) in
not (Set.null (Set.intersection declared (referenced modDecls)))) moduleDeclMap))
referenced modDecls = Set.map sName (gFind modDecls :: Set (A.Name SrcSpanInfo))
moduleDeclMap :: Map S.ModuleName [(A.Decl SrcSpanInfo, String)]
moduleDeclMap = foldDecls (\ d pref s suff r -> Set.fold (\ sym mp -> insertWith (++) (subModuleName reExported internal old sym) [(d, pref <> s <> suff)] mp) r (symbols d)) ignore2 m Map.empty
doSeps :: [(String, String)] -> String
doSeps [] = ""
doSeps ((_, hd) : tl) = hd <> concatMap (\ (a, b) -> a <> b) tl
updateImports :: MonadClean m => Set S.Name -> Set S.Name -> S.ModuleName -> Map DeclName S.ModuleName -> S.ModuleName -> m ModuleResult
updateImports reExported internal old symbolToModule name =
do path <- modulePath name
quietly $ qLnPutStr $ "updateImports " ++ show name
text' <- liftIO $ readFile path
parsed <- parseFileWithComments path
case parsed of
ParseOk (m', comments') ->
let text'' = Foldable.fold (foldModule echo2 echo echo echo echo2 echo echo2
(\ i pref s suff r -> r |> pref <> updateImportDecl s i <> suff)
echo echo2 (m', text', comments') mempty) in
return $ if text' /= text'' then Modified name text'' else Unchanged name
ParseFailed _ _ -> error $ "Parse error in " ++ show name
where
updateImportDecl :: String -> A.ImportDecl SrcSpanInfo -> String
updateImportDecl s i =
if sModuleName (A.importModule i) == old
then intercalate "\n" (List.map prettyPrint (updateImportSpecs i (A.importSpecs i)))
else s
updateImportSpecs :: A.ImportDecl SrcSpanInfo -> Maybe (A.ImportSpecList SrcSpanInfo) -> [S.ImportDecl]
updateImportSpecs i Nothing = List.map (\ x -> (sImportDecl i) {S.importModule = x}) (Map.elems symbolToModule)
updateImportSpecs i (Just (A.ImportSpecList _ flag specs)) =
concatMap (\ spec -> let xs = mapMaybe (\ sym -> Map.lookup (declName reExported internal sym) symbolToModule) (toList (symbols spec)) in
List.map (\ x -> (sImportDecl i) {S.importModule = x, S.importSpecs = Just (flag, [sImportSpec spec])}) xs) specs
defaultSymbolToModule :: ModuleInfo -> Set S.Name -> Set S.Name -> S.ModuleName -> Map DeclName S.ModuleName
defaultSymbolToModule m reExported internal old =
mp'
where
mp' = foldExports ignore2 (\ e _ _ _ r -> Set.fold f r (symbols e)) ignore2 m mp
mp = foldDecls (\ d _ _ _ r -> Set.fold f r (symbols d)) ignore2 m Map.empty
f sym mp'' =
Map.insertWith
(\ a b -> if a /= b then error ("symbolToModule - two modules for " ++ show sym ++ ": " ++ show (a, b)) else a)
(declName reExported internal sym)
(subModuleName reExported internal old sym)
mp''
subModuleName :: Set S.Name -> Set S.Name -> S.ModuleName -> Maybe S.Name -> S.ModuleName
subModuleName reExported internal (S.ModuleName moduleName) name =
S.ModuleName (moduleName <.> f (case name of
Nothing -> "Instances"
Just (S.Symbol s) -> s
Just (S.Ident s) -> s))
where
f x =
case name of
Nothing -> "Instances"
Just name' | member name' reExported -> "ReExported"
Just name' ->
(if member name' internal then "Internal." else "") <>
case x of
(c : s) | isAlpha c -> toUpper c : List.filter isAlphaNum s
_ -> "OtherSymbols"
declName :: Set S.Name -> Set S.Name -> Maybe S.Name -> DeclName
declName reExported internal name =
case name of
Nothing -> Instance
Just name' ->
if member name' reExported
then ReExported name'
else if member name' internal
then Internal name'
else Exported name'
toImportDecl :: S.ModuleName -> [(A.Decl SrcSpanInfo, String)] -> S.ImportDecl
toImportDecl (S.ModuleName modName) decls =
S.ImportDecl {S.importLoc = def,
S.importModule = S.ModuleName modName,
S.importQualified = False,
S.importSrc = False,
S.importPkg = Nothing,
S.importAs = Nothing,
S.importSpecs = Just (False, nub (concatMap (imports . fst) decls))}