module Language.Haskell.Tools.Refactor.Predefined.RenameDefinition (renameDefinition, renameDefinition', DomainRenameDefinition) where
import qualified GHC (RealSrcSpan, NamedThing(..), Name)
import Name (OccName(..), NamedThing(..), occNameString)
import SrcLoc (RealSrcSpan)
import Control.Monad.State
import Control.Reference as Ref
import Data.Generics.Uniplate.Data ()
import Data.List
import Data.List.Split (splitOn)
import Data.Maybe
import Language.Haskell.Tools.Refactor
type DomainRenameDefinition dom = ( HasNameInfo dom, HasScopeInfo dom, HasDefiningInfo dom
, HasImplicitFieldsInfo dom, HasModuleInfo dom )
renameDefinition' :: forall dom . DomainRenameDefinition dom => RealSrcSpan -> String -> Refactoring dom
renameDefinition' sp str mod mods
= case (getNodeContaining sp (snd mod) :: Maybe (QualifiedName dom)) >>= (fmap getName . semanticsName) of
Just name -> do let sameNames = bindsWithSameName name (snd mod ^? biplateRef)
renameDefinition name sameNames str mod mods
where bindsWithSameName :: GHC.Name -> [FieldWildcard dom] -> [GHC.Name]
bindsWithSameName name wcs = catMaybes $ map ((lookup name) . semanticsImplicitFlds) wcs
Nothing -> case getNodeContaining sp (snd mod) of
Just modName -> renameModule (modName ^. moduleNameString) str mod mods
Nothing -> refactError "No name is selected"
renameModule :: forall dom . DomainRenameDefinition dom => String -> String -> Refactoring dom
renameModule from to m mods
| any (nameConflict to) (map snd $ m:mods) = refactError "Name conflict when renaming module"
| isJust (validModuleName to) = refactError $ "The given name is not a valid module name: " ++ fromJust (validModuleName to)
| otherwise =
fmap (\ls -> map (alterChange from to) ls ++ [ModuleRemoved from])
$ mapM (\(name,mod) -> ContentChanged . (name,) <$> localRefactoringRes id mod (replaceModuleNames =<< alterNormalNames mod)) (m:mods)
where alterChange from to (ContentChanged (mod,res))
| (mod ^. sfkModuleName) == from
= ModuleCreated to res (SourceFileKey NormalHs from)
alterChange _ _ c = c
replaceModuleNames :: LocalRefactoring dom
replaceModuleNames = biplateRef @_ @(ModuleName dom) & filtered (\e -> (e ^. moduleNameString) == from) != mkModuleName to
alterNormalNames :: LocalRefactoring dom
alterNormalNames mod = if from `elem` moduleQualifiers mod
then biplateRef @_ @(QualifiedName dom) & filtered (\e -> concat (intersperse "." (e ^? qualifiers&annList&simpleNameStr)) == from)
!- (\e -> mkQualifiedName (splitOn "." to) (e ^. unqualifiedName&simpleNameStr)) $ mod
else return mod
moduleQualifiers :: Module dom -> [String]
moduleQualifiers mod = mod ^? modImports & annList & filtered (\m -> isAnnNothing (m ^. importAs))
& importModule & moduleNameString
nameConflict :: String -> Module dom -> Bool
nameConflict to mod
= let modName = mod ^? modHead&annJust&mhName&moduleNameString
imports = mod ^? modImports&annList
importNames = map (\imp -> fromMaybe (imp ^. importModule) (imp ^? importAs&annJust&importRename) ^. moduleNameString) imports
in modName == Just to || to `elem` importNames
renameDefinition :: DomainRenameDefinition dom => GHC.Name -> [GHC.Name] -> String -> Refactoring dom
renameDefinition toChangeOrig toChangeWith newName mod mods
= do nameCls <- classifyName toChangeOrig
(changedModules,defFound) <- runStateT (catMaybes <$> mapM (renameInAModule toChangeOrig toChangeWith newName) (mod:mods)) False
if | isJust (nameValid nameCls newName) -> refactError $ "The new name is not valid: " ++ fromJust (nameValid nameCls newName)
| not defFound -> refactError "The definition to rename was not found. Maybe it is in another package."
| otherwise -> return $ map ContentChanged changedModules
where
renameInAModule :: DomainRenameDefinition dom => GHC.Name -> [GHC.Name] -> String -> ModuleDom dom -> StateT Bool Refactor (Maybe (ModuleDom dom))
renameInAModule toChangeOrig toChangeWith newName (name, mod)
= mapStateT (localRefactoringRes (\f (a,s) -> (fmap (\(n,r) -> (n, f r)) a,s)) mod) $
do (res, isChanged) <- runStateT (biplateRef !~ changeName toChangeOrig toChangeWith newName $ mod) False
if isChanged then return $ Just (name, res)
else return Nothing
changeName :: DomainRenameDefinition dom => GHC.Name -> [GHC.Name] -> String -> QualifiedName dom
-> StateT Bool (StateT Bool (LocalRefactor dom)) (QualifiedName dom)
changeName toChangeOrig toChangeWith str name
| maybe False (`elem` toChange) actualName
&& semanticsDefining name == False
&& any @[] ((str ==) . occNameString . getOccName) (semanticsScope name ^? Ref.element 0 & traversal & filtered (sameNamespace toChangeOrig))
= refactError $ "The definition clashes with an existing one at: " ++ shortShowSpan (getRange name)
| maybe False (`elem` toChange) actualName
= do put True
when (actualName == Just toChangeOrig)
$ lift $ modify (|| semanticsDefining name)
return $ unqualifiedName .= mkNamePart str $ name
| let namesInScope = semanticsScope name
in case semanticsName name of
Just (getName -> exprName) -> str == occNameString (getOccName exprName) && sameNamespace toChangeOrig exprName
&& conflicts toChangeOrig exprName namesInScope
Nothing -> False
= refactError $ "The definition clashes with an existing one: " ++ shortShowSpan (getRange name)
| otherwise = return name
where toChange = toChangeOrig : toChangeWith
actualName = fmap getName (semanticsName name)
conflicts :: GHC.Name -> GHC.Name -> [[GHC.Name]] -> Bool
conflicts overwrites overwritten (scopeBlock : scope)
| overwritten `elem` scopeBlock && overwrites `notElem` scopeBlock = False
| overwrites `elem` scopeBlock = True
| otherwise = conflicts overwrites overwritten scope
conflicts _ _ [] = False
sameNamespace :: GHC.Name -> GHC.Name -> Bool
sameNamespace n1 n2 = occNameSpace (getOccName n1) == occNameSpace (getOccName n2)