Weeder

Analysis

data Analysis

All information maintained by analyseHieFile.

Constructors

Analysis

Fields

• dependencyGraph :: Graph Declaration

  A graph between declarations, capturing dependencies.

• declarationSites :: Map Declaration (Set RealSrcSpan)

  A partial mapping between declarations and their definition site. This Map is partial as we don't always know where a Declaration was defined (e.g., it may come from a package without source code). We capture a set of spans, because a declaration may be defined in multiple locations, e.g., a type signature for a function separate from its definition.

• implicitRoots :: Set Declaration

  The Set of all Declarations that are always reachable. This is used to capture knowledge not yet modelled in weeder, such as instance declarations depending on top-level functions.

• exports :: Map Module (Set Declaration)

  All exports for a given module.

• modulePaths :: Map Module FilePath

  A map from modules to the file path to the .hs file defining them.

Instances

Generic Analysis

Defined in Weeder

Associated Types

type Rep Analysis :: Type -> Type

Methods

from :: Analysis -> Rep Analysis x

to :: Rep Analysis x -> Analysis

type Rep Analysis

Defined in Weeder

type Rep Analysis = D1 ('MetaData "Analysis" "Weeder" "weeder-2.4.1-6lVu1100nffiiuyEZwy9w" 'False) (C1 ('MetaCons "Analysis" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dependencyGraph") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Graph Declaration)) :*: S1 ('MetaSel ('Just "declarationSites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Declaration (Set RealSrcSpan)))) :*: (S1 ('MetaSel ('Just "implicitRoots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Declaration)) :*: (S1 ('MetaSel ('Just "exports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Module (Set Declaration))) :*: S1 ('MetaSel ('Just "modulePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Module FilePath))))))

analyseHieFile :: MonadState Analysis m => HieFile -> m ()

Incrementally update Analysis with information in a HieFile.

emptyAnalysis :: Analysis

The empty analysis - the result of analysing zero .hie files.

allDeclarations :: Analysis -> Set Declaration

The set of all known declarations, including usages.

Reachability

data Root

A root for reachability analysis.

Constructors

DeclarationRoot Declaration

A given declaration is a root.

ModuleRoot Module

All exported declarations in a module are roots.

Instances

Eq Root

Defined in Weeder

Methods

(==) :: Root -> Root -> Bool

(/=) :: Root -> Root -> Bool

Ord Root

Defined in Weeder

Methods

compare :: Root -> Root -> Ordering

(<) :: Root -> Root -> Bool

(<=) :: Root -> Root -> Bool

(>) :: Root -> Root -> Bool

(>=) :: Root -> Root -> Bool

max :: Root -> Root -> Root

min :: Root -> Root -> Root

reachable :: Analysis -> Set Root -> Set Declaration

Determine the set of all declaration reachable from a set of roots.

Declarations

data Declaration

Constructors

Declaration

Fields

• declModule :: Module

  The module this declaration occurs in.

• declOccName :: OccName

  The symbol name of a declaration.

Instances

Show Declaration

Defined in Weeder

Methods

showsPrec :: Int -> Declaration -> ShowS

show :: Declaration -> String

showList :: [Declaration] -> ShowS

Eq Declaration

Defined in Weeder

Methods

(==) :: Declaration -> Declaration -> Bool

(/=) :: Declaration -> Declaration -> Bool

Ord Declaration

Defined in Weeder

Methods

compare :: Declaration -> Declaration -> Ordering

(<) :: Declaration -> Declaration -> Bool

(<=) :: Declaration -> Declaration -> Bool

(>) :: Declaration -> Declaration -> Bool

(>=) :: Declaration -> Declaration -> Bool

max :: Declaration -> Declaration -> Declaration

min :: Declaration -> Declaration -> Declaration