CabalFmt.Comments

Copyright: Oleg Grenrus

Documentation

newtype Comments

Constructors

Comments [ByteString]

Instances

Show Comments

Defined in CabalFmt.Comments

Methods

showsPrec :: Int -> Comments -> ShowS

show :: Comments -> String

showList :: [Comments] -> ShowS

Semigroup Comments

Defined in CabalFmt.Comments

Methods

(<>) :: Comments -> Comments -> Comments

sconcat :: NonEmpty Comments -> Comments

stimes :: Integral b => b -> Comments -> Comments

Monoid Comments

Defined in CabalFmt.Comments

Methods

mempty :: Comments

mappend :: Comments -> Comments -> Comments

mconcat :: [Comments] -> Comments

unComments :: Comments -> [ByteString]

nullComments :: Comments -> Bool

attachComments

Arguments

:: ByteString

source with comments

-> [Field Position]

parsed source fields

-> ([Field Comments], Comments)

Returns a Field forest with comments attached.

• Comments are attached to the field after it.
• A glitch: comments "inside" the field are attached to the field after it.
• End-of-file comments are returned separately.

overAnn :: forall a b. (FieldPath -> a -> b) -> [Field a] -> [Field b]

extractComments :: ByteString -> [(Int, Comments)]

data FieldPath

Paths input paths. Essentially a list of offsets. Own type ofr safety.

Constructors

End

Nth Int FieldPath

Instances

Eq FieldPath

Defined in CabalFmt.Comments

Methods

(==) :: FieldPath -> FieldPath -> Bool

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

Ord FieldPath

Defined in CabalFmt.Comments

Methods

compare :: FieldPath -> FieldPath -> Ordering

(<) :: FieldPath -> FieldPath -> Bool

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

(>) :: FieldPath -> FieldPath -> Bool

(>=) :: FieldPath -> FieldPath -> Bool

max :: FieldPath -> FieldPath -> FieldPath

min :: FieldPath -> FieldPath -> FieldPath

Show FieldPath

Defined in CabalFmt.Comments

Methods

showsPrec :: Int -> FieldPath -> ShowS

show :: FieldPath -> String

showList :: [FieldPath] -> ShowS

fieldPathSize :: FieldPath -> Int

fieldUniverseN :: [Field ann] -> [(FieldPath, Field ann)]

fieldUniverse :: Field ann -> [(FieldPath, Field ann)]

findPath :: (a -> Position) -> Int -> [(FieldPath, a)] -> Maybe FieldPath