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 Int)

  A partial mapping between declarations and their line numbers. 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 sites, because a declaration may be defined in multiple locations, e.g., a type signature for a function separate from its definition.

• implicitRoots :: Set Root

  Stores information on Declarations that may be automatically marked as always reachable. This is used, for example, to capture knowledge not yet modelled in weeder, or to mark all instances of a class as roots.

• 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.

• prettyPrintedType :: Map Declaration String

  Used to match against the types of instances and to replace the appearance of declarations in the output

• requestedEvidence :: Map Declaration (Set Name)

  Map from declarations to the names containing evidence uses that should be followed and treated as dependencies of the declaration. We use this to be able to delay analysing evidence uses until later, allowing us to begin the rest of the analysis before we have read all hie files.

Instances

Monoid Analysis

Defined in Weeder

Methods

mempty :: Analysis

mappend :: Analysis -> Analysis -> Analysis

mconcat :: [Analysis] -> Analysis

Semigroup Analysis

Defined in Weeder

Methods

(<>) :: Analysis -> Analysis -> Analysis

sconcat :: NonEmpty Analysis -> Analysis

stimes :: Integral b => b -> Analysis -> Analysis

Generic Analysis

Defined in Weeder

Associated Types

type Rep Analysis :: Type -> Type

Methods

from :: Analysis -> Rep Analysis x

to :: Rep Analysis x -> Analysis

NFData Analysis

Defined in Weeder

Methods

rnf :: Analysis -> ()

type Rep Analysis

Defined in Weeder

type Rep Analysis = D1 ('MetaData "Analysis" "Weeder" "weeder-2.8.0-LLWyvDLkfMUFuW7r7YiEQF" '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 Int))) :*: S1 ('MetaSel ('Just "implicitRoots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Root)))) :*: ((S1 ('MetaSel ('Just "exports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Module (Set Declaration))) :*: S1 ('MetaSel ('Just "modulePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Module FilePath))) :*: (S1 ('MetaSel ('Just "prettyPrintedType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Declaration String)) :*: S1 ('MetaSel ('Just "requestedEvidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Declaration (Set Name)))))))

analyseEvidenceUses :: RefMap TypeIndex -> Analysis -> Analysis

Follow evidence uses listed under requestedEvidence back to their instance bindings, and connect their corresponding declaration to those bindings.

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

Incrementally update Analysis with information in a HieFile.

emptyAnalysis :: Analysis

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

outputableDeclarations :: Analysis -> Set Declaration

The set of all declarations that could possibly appear in the output.

Reachability

data Root

A root for reachability analysis.

Constructors

DeclarationRoot Declaration

A given declaration is a root.

InstanceRoot

We store extra information for instances in order to be able to specify e.g. all instances of a class as roots.

Fields

• Declaration

  Declaration of the instance

• Declaration

  Declaration of the parent class

ModuleRoot Module

All exported declarations in a module are roots.

Instances

Generic Root

Defined in Weeder

Associated Types

type Rep Root :: Type -> Type

Methods

from :: Root -> Rep Root x

to :: Rep Root x -> Root

NFData Root

Defined in Weeder

Methods

rnf :: Root -> ()

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

type Rep Root

Defined in Weeder

type Rep Root = D1 ('MetaData "Root" "Weeder" "weeder-2.8.0-LLWyvDLkfMUFuW7r7YiEQF" 'False) (C1 ('MetaCons "DeclarationRoot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Declaration)) :+: (C1 ('MetaCons "InstanceRoot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Declaration) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Declaration)) :+: C1 ('MetaCons "ModuleRoot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Module))))

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

Generic Declaration

Defined in Weeder

Associated Types

type Rep Declaration :: Type -> Type

Methods

from :: Declaration -> Rep Declaration x

to :: Rep Declaration x -> Declaration

Show Declaration

Defined in Weeder

Methods

showsPrec :: Int -> Declaration -> ShowS

show :: Declaration -> String

showList :: [Declaration] -> ShowS

NFData Declaration

Defined in Weeder

Methods

rnf :: Declaration -> ()

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

type Rep Declaration

Defined in Weeder

type Rep Declaration = D1 ('MetaData "Declaration" "Weeder" "weeder-2.8.0-LLWyvDLkfMUFuW7r7YiEQF" 'False) (C1 ('MetaCons "Declaration" 'PrefixI 'True) (S1 ('MetaSel ('Just "declModule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Module) :*: S1 ('MetaSel ('Just "declOccName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OccName)))