Language.Haskell.Refact.Utils.Variables

Variable analysis

isFieldName :: Name -> Bool

True if the name is a field name

isClassName :: Name -> Bool

True if the name is a field name

isInstanceName :: Name -> Bool

True if the name is a class instance

isDeclaredIn :: HsValBinds t Name => Name -> t -> Bool

isDeclaredInRdr :: NameMap -> Name -> [LHsDecl RdrName] -> Bool

data FreeNames

For free variables

Constructors

FN

Fields

fn :: [Name]

Instances

Show FreeNames

Monoid FreeNames

data DeclaredNames

For declared variables

Constructors

DN

Fields

dn :: [Name]

Instances

Show DeclaredNames

Monoid DeclaredNames

hsFreeAndDeclaredPNsOld :: Data t => t -> ([Name], [Name])

Collect the free and declared variables (in the GHC.Name format) in a given syntax phrase t. In the result, the first list contains the free variables, and the second list contains the declared variables. Expects RenamedSource

hsFreeAndDeclaredRdr :: Data t => NameMap -> t -> (FreeNames, DeclaredNames)

Collect the free and declared variables (in the GHC.Name format) in a given syntax phrase t. In the result, the first list contains the free variables, and the second list contains the declared variables. Expects RenamedSource

hsFreeAndDeclaredNameStrings :: (Data t, Outputable t) => t -> RefactGhc ([String], [String])

The same as hsFreeAndDeclaredPNs except that the returned variables are in the String format.

hsFreeAndDeclaredPNs :: Data t => t -> RefactGhc ([Name], [Name])

hsFreeAndDeclaredGhc :: Data t => t -> RefactGhc (FreeNames, DeclaredNames)

Collect the free and declared variables (in the GHC.Name format) in a given syntax phrase t. In the result, the first list contains the free variables, and the second list contains the declared variables. TODO: use GHC.NameSet instead of lists for FreeNames/DeclaredNames NOTE: The GHC fvs fields only carry non-GHC values, as they are used in the renaming process hsFreeAndDeclaredGhc :: (SYB.Data t,GHC.Outputable t)

getDeclaredTypes :: LTyClDecl Name -> [Name]

Get the names of all types declared in the given declaration

getDeclaredTypesRdr :: LHsDecl RdrName -> RefactGhc [Name]

Get the names of all types declared in the given declaration getDeclaredTypesRdr :: GHC.LTyClDecl GHC.RdrName -> RefactGhc [GHC.Name]

getFvs :: [LHsBind Name] -> [([Name], NameSet)]

Experiment with GHC fvs stuff

getFreeVars :: [LHsBind Name] -> [Name]

getDeclaredVars :: [LHsBind Name] -> [Name]

hsVisiblePNs :: (FindEntity e, HsValBinds t Name, Outputable e) => e -> t -> RefactGhc [Name]

Given syntax phrases e and t, if e occurs in t, then return those variables which are declared in t and accessible to e, otherwise return [].

hsVisiblePNsRdr :: (FindEntity e, Data t, Outputable e) => NameMap -> e -> t -> RefactGhc [Name]

Given syntax phrases e and t, if e occurs in t, then return those variables which are declared in t and accessible to e, otherwise return [].

hsVisibleNames :: (FindEntity t1, HsValBinds t2 Name, Outputable t1) => t1 -> t2 -> RefactGhc [String]

Same as hsVisiblePNs except that the returned identifiers are in String format.

hsVisibleNamesRdr :: (FindEntity t1, Data t2, Outputable t1) => t1 -> t2 -> RefactGhc [String]

Same as hsVisiblePNs except that the returned identifiers are in String format.

hsFDsFromInsideRdr :: Data t => NameMap -> t -> RefactGhc (FreeNames, DeclaredNames)

hsFDsFromInsideRdr is different from hsFreeAndDeclaredPNs in that: given an syntax phrase t, hsFDsFromInsideRdr returns not only the declared variables that are visible from outside of t, but also those declared variables that are visible to the main expression inside t. NOTE: Expects to be given RenamedSource

hsFDNamesFromInsideRdr :: Data t => t -> RefactGhc ([String], [String])

The same as hsFDsFromInside except that the returned variables are in the String format

hsFDsFromInside :: Data t => t -> RefactGhc ([Name], [Name])

hsFDsFromInside is different from hsFreeAndDeclaredPNs in that: given an syntax phrase t, hsFDsFromInside returns not only the declared variables that are visible from outside of t, but also those declared variables that are visible to the main expression inside t. NOTE: Expects to be given RenamedSource

hsFDNamesFromInside :: Data t => t -> RefactGhc ([String], [String])

The same as hsFDsFromInside except that the returned variables are in the String format

hsVisibleDs :: (FindEntity e, Outputable e, Data t, HsValBinds t Name) => e -> t -> RefactGhc DeclaredNames

Given syntax phrases e and t, if e occurs in t, then return those variables which are declared in t and accessible to e, otherwise return [].

hsVisibleDsRdr :: (FindEntity e, Outputable e, Data t) => NameMap -> e -> t -> RefactGhc DeclaredNames

Given syntax phrases e and t, if e occurs in t, then return those variables which are declared in t and accessible to e, otherwise return [].

rdrName2Name :: Located RdrName -> RefactGhc Name

rdrName2NamePure :: NameMap -> Located RdrName -> Name

eqRdrNamePure :: NameMap -> Located RdrName -> Name -> Bool

rdrName2Name' :: Located RdrName -> RefactGhc Name

Identifiers, expressions, patterns and declarations

class (Data a, Typeable a) => FindEntity a where

Methods

findEntity :: Data b => a -> b -> Bool

Returns True is a syntax phrase, say a, is part of another syntax phrase, say b. NOTE: very important: only do a shallow check

Instances

FindEntity Name

FindEntity (LHsExpr RdrName)

FindEntity (LHsExpr Name)

FindEntity (Located (HsDecl Name))

FindEntity (Located (HsBindLR Name Name))

FindEntity (Located RdrName)

FindEntity (Located Name)

sameOccurrence :: Located t -> Located t -> Bool

Return True if syntax phrases t1 and t2 refer to the same one.

definedPNs :: LHsBind Name -> [Name]

Return the list of identifiers (in PName format) defined by a function/pattern binding.

definedPNsRdr :: LHsDecl RdrName -> [Located RdrName]

definedNamesRdr :: NameMap -> LHsDecl RdrName -> [Name]

definingDeclsRdrNames

Arguments

:: NameMap

-> [Name]

The specified identifiers.

-> [LHsDecl RdrName]

A collection of declarations.

-> Bool

True means to include the type signature.

-> Bool

True means to look at the local declarations as well.

-> [LHsDecl RdrName]

The result.

Find those declarations(function/pattern binding) which define the specified GHC.Names. incTypeSig indicates whether the corresponding type signature will be included.

definingDeclsRdrNames'

Arguments

:: Data t

=> NameMap

-> [Name]

The specified identifiers.

-> t

A collection of declarations.

-> [LHsDecl RdrName]

The result.

Find those declarations(function/pattern binding) which define the specified GHC.Names. incTypeSig indicates whether the corresponding type signature will be included.

definingSigsRdrNames

Arguments

:: Data t

=> NameMap

-> [Name]

The specified identifiers.

-> t

A collection of declarations.

-> [LSig RdrName]

The result.

Find those type signatures for the specified GHC.Names.

definingDeclsNames

Arguments

:: [Name]

The specified identifiers.

-> [LHsBind Name]

A collection of declarations.

-> Bool

True means to include the type signature.

-> Bool

True means to look at the local declarations as well.

-> [LHsBind Name]

The result.

Find those declarations(function/pattern binding) which define the specified GHC.Names. incTypeSig indicates whether the corresponding type signature will be included.

definingDeclsNames'

Arguments

:: Data t

=> [Name]

The specified identifiers.

-> t

A collection of declarations.

-> [LHsBind Name]

The result.

Find those declarations(function/pattern binding) which define the specified GHC.Names. incTypeSig indicates whether the corresponding type signature will be included.

definingSigsNames

Arguments

:: Data t

=> [Name]

The specified identifiers.

-> t

A collection of declarations.

-> [LSig Name]

The result.

Find those type signatures for the specified GHC.Names.

definingTyClDeclsNames

Arguments

:: Data t

=> [Name]

The specified identifiers.

-> t

A collection of declarations.

-> [LTyClDecl Name]

The result.

Find those declarations which define the specified GHC.Names.

defines :: Name -> LHsBind Name -> Bool

Return True if the function/pattern binding defines the specified identifier.

definesRdr :: NameMap -> Name -> LHsBind RdrName -> Bool

Return True if the function/pattern binding defines the specified identifier.

definesDeclRdr :: NameMap -> Name -> LHsDecl RdrName -> Bool

Unwraps a LHsDecl and calls definesRdr on the result if a HsBind

definesTypeSig :: Name -> LSig Name -> Bool

Return True if the declaration defines the type signature of the specified identifier.

definesTypeSigRdr :: NameMap -> Name -> Sig RdrName -> Bool

Return True if the declaration defines the type signature of the specified identifier.

definesSigDRdr :: NameMap -> Name -> LHsDecl RdrName -> Bool

Unwraps a LHsDecl and calls definesRdr on the result if a Sig

definesP :: PName -> HsDeclP -> Bool

allNames

Arguments

:: Data t

=> t

The syntax phrase

-> [Located Name]

The result

Find all Located Names in the given Syntax phrase.

hsPNs :: Data t => t -> [PName]

Collect the identifiers (in PName format) in a given syntax phrase.

hsNamess :: Data t => t -> [Name]

Get all the names in the given syntax element

hsNamessRdr :: Data t => t -> [Located RdrName]

Get all the names in the given syntax element

locToName

Arguments

:: Data t

=> SimpPos

The row and column number

-> t

The syntax phrase

-> Maybe (Located Name)

The result

Find the identifier(in GHC.Name format) whose start position is (row,col) in the file specified by the fileName, and returns Nothing if such an identifier does not exist.

locToRdrName

Arguments

:: Data t

=> SimpPos

The row and column number

-> t

The syntax phrase

-> Maybe (Located RdrName)

The result

Find the identifier(in GHC.RdrName format) whose start position is (row,col) in the file specified by the fileName, and returns Nothing if such an identifier does not exist.