Language.Haskell.Stylish.Module

Data types

data Module

Concrete module type

Constructors

Module

Fields

• parsedComments :: [RealLocated AnnotationComment]
• parsedAnnotations :: [(ApiAnnKey, [SrcSpan])]
• parsedAnnotSrcs :: Map RealSrcSpan [AnnKeywordId]
• parsedModule :: Located (HsModule GhcPs)

Instances

Data Module

Defined in Language.Haskell.Stylish.Module

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Module -> c Module

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Module

toConstr :: Module -> Constr

dataTypeOf :: Module -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Module)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Module)

gmapT :: (forall b. Data b => b -> b) -> Module -> Module

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r

gmapQ :: (forall d. Data d => d -> u) -> Module -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Module -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Module -> m Module

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module

data ModuleHeader

A module header is its name, exports and haddock docstring

data Import

Import declaration in module

Instances

Eq Import

Defined in Language.Haskell.Stylish.Module

Methods

(==) :: Import -> Import -> Bool

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

Ord Import

Defined in Language.Haskell.Stylish.Module

Methods

compare :: Import -> Import -> Ordering

(<) :: Import -> Import -> Bool

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

(>) :: Import -> Import -> Bool

(>=) :: Import -> Import -> Bool

max :: Import -> Import -> Import

min :: Import -> Import -> Import

Outputable Import

Defined in Language.Haskell.Stylish.Module

Methods

ppr :: Import -> SDoc

pprPrec :: Rational -> Import -> SDoc

data Decls

Declarations in module

data Comments

Comments associated with module

type Lines = [String]

makeModule :: PState -> Located (HsModule GhcPs) -> Module

Create a module from GHC internal representations

Getters

moduleHeader :: Module -> ModuleHeader

Get module header

moduleImports :: Module -> [Located Import]

Get module imports

moduleImportGroups :: Module -> [NonEmpty (Located Import)]

Get groups of imports from module

moduleDecls :: Module -> Decls

Get all declarations in module

moduleComments :: Module -> Comments

Get comments in module

moduleLanguagePragmas :: Module -> [(RealSrcSpan, NonEmpty Text)]

Get module language pragmas

queryModule :: Typeable a => (a -> [b]) -> Module -> [b]

Query the module AST using f

Imports

canMergeImport :: Import -> Import -> Bool

Returns true if the two import declarations can be merged

mergeModuleImport :: Located Import -> Located Import -> Located Import

Merge two import declarations, keeping positions from the first

As alluded, this highlights an issue with merging imports. The GHC annotation comments aren't attached to any particular AST node. This means that right now, we're manually reconstructing the attachment. By merging two import declarations, we lose that mapping.

It's not really a big deal if we consider that people don't usually comment imports themselves. It _is_ however, systemic and it'd be better if we processed comments beforehand and attached them to all AST nodes in our own representation.

Annotations

lookupAnnotation :: SrcSpan -> Module -> [AnnKeywordId]

Query for annotations associated with a SrcSpan

Internal API getters

rawComments :: Comments -> [RealLocated AnnotationComment]

Getter for internal module comments representation

rawImport :: Import -> ImportDecl GhcPs

Getter for internal components in imports newtype

rawModuleAnnotations :: Module -> [(ApiAnnKey, [SrcSpan])]

Getter for internal module annotation representation

rawModuleDecls :: Decls -> [LHsDecl GhcPs]

Getter for internal module decls representation

rawModuleExports :: ModuleHeader -> Maybe (Located [LIE GhcPs])

Getter for internal module exports representation

rawModuleHaddocks :: ModuleHeader -> Maybe LHsDocString

Getter for internal module haddocks representation

rawModuleName :: ModuleHeader -> Maybe (Located ModuleName)

Getter for internal module name representation