Source.Source

Source models source code, represented as a thin wrapper around a ByteString with conveniences for splitting by line, slicing, etc.

This module is intended to be imported qualified to avoid name clashes with Prelude:

import qualified Source.Source as Source

Documentation

data Source

The contents of a source file. This is represented as a UTF-8 ByteString under the hood. Construct these with fromUTF8; obviously, passing fromUTF8 non-UTF8 bytes will cause crashes.

Instances

IsString Source

Defined in Source.Source

Methods

fromString :: String -> Source

Monoid Source

Defined in Source.Source

Methods

mempty :: Source

mappend :: Source -> Source -> Source

mconcat :: [Source] -> Source

Semigroup Source

Defined in Source.Source

Methods

(<>) :: Source -> Source -> Source

sconcat :: NonEmpty Source -> Source

stimes :: Integral b => b -> Source -> Source

Generic Source

Defined in Source.Source

Associated Types

type Rep Source :: Type -> Type

Methods

from :: Source -> Rep Source x

to :: Rep Source x -> Source

Show Source

Defined in Source.Source

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

NFData Source

Defined in Source.Source

Methods

rnf :: Source -> ()

Eq Source

Defined in Source.Source

Methods

(==) :: Source -> Source -> Bool

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

FromJSON Source

Defined in Source.Source

Methods

parseJSON :: Value -> Parser Source

parseJSONList :: Value -> Parser [Source]

type Rep Source

Defined in Source.Source

type Rep Source = D1 ('MetaData "Source" "Source.Source" "semantic-source-0.1.0.2-inplace" 'True) (C1 ('MetaCons "Source" 'PrefixI 'True) (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

bytes :: Source -> ByteString

fromUTF8 :: ByteString -> Source

Measurement

length :: Source -> Int

null :: Source -> Bool

totalRange :: Source -> Range

Return a Range that covers the entire text.

totalSpan :: Source -> Span

Return a Span that covers the entire text.

En/decoding

fromText :: Text -> Source

Return a Source from a Text.

toText :: Source -> Text

Return the Text contained in the Source.

Slicing

slice :: Source -> Range -> Source

Return a Source that contains a slice of the given Source.

drop :: Int -> Source -> Source

take :: Int -> Source -> Source

Splitting

lines :: Source -> [Source]

Split the contents of the source after newlines.

lineRanges :: Source -> [Range]

Compute the Ranges of each line in a Source.

lineRangesWithin :: Source -> Range -> [Range]

Compute the Ranges of each line in a Range of a Source.

newlineIndices :: ByteString -> [Int]

Return all indices of newlines ('n', 'r', and 'rn') in the ByteString.