Ormolu.Parser.CommentStream

Functions for working with comment stream.

Documentation

newtype CommentStream

A stream of RealLocated Comments in ascending order with respect to beginning of corresponding spans.

Constructors

CommentStream [RealLocated Comment]

Instances

Eq CommentStream

Defined in Ormolu.Parser.CommentStream

Methods

(==) :: CommentStream -> CommentStream -> Bool

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

Data CommentStream

Defined in Ormolu.Parser.CommentStream

Methods

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

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

toConstr :: CommentStream -> Constr

dataTypeOf :: CommentStream -> DataType

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

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

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

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

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

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

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

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

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

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

Semigroup CommentStream

Defined in Ormolu.Parser.CommentStream

Methods

(<>) :: CommentStream -> CommentStream -> CommentStream

sconcat :: NonEmpty CommentStream -> CommentStream

stimes :: Integral b => b -> CommentStream -> CommentStream

Monoid CommentStream

Defined in Ormolu.Parser.CommentStream

Methods

mempty :: CommentStream

mappend :: CommentStream -> CommentStream -> CommentStream

mconcat :: [CommentStream] -> CommentStream

newtype Comment

A wrapper for a single comment. The NonEmpty list inside contains lines of multiline comment {- … -} or just single item/line otherwise.

Constructors

Comment (NonEmpty String)

Instances

Eq Comment

Defined in Ormolu.Parser.CommentStream

Methods

(==) :: Comment -> Comment -> Bool

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

Data Comment

Defined in Ormolu.Parser.CommentStream

Methods

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

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

toConstr :: Comment -> Constr

dataTypeOf :: Comment -> DataType

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

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

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

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

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

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

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

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

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

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

Show Comment

Defined in Ormolu.Parser.CommentStream

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

mkCommentStream

Arguments

:: [Located String]

Extra comments to include

-> PState

Parser state to use for comment extraction

-> (CommentStream, [Pragma])

Comment stream and a set of extracted pragmas

Create CommentStream from PState. We also create a Set of extensions here, which is not sorted in any way. The pragma comment are removed from the CommentStream.

isPrevHaddock :: Comment -> Bool

Test whether a Comment looks like a Haddock following a definition, i.e. something starting with -- ^.

isMultilineComment :: Comment -> Bool

Is this comment multiline-style?

showCommentStream :: CommentStream -> String

Pretty-print a CommentStream.