ProSource

Source

data Source

Information about a source file.

The Show instance for ths class does not include the LineMap or Text fields, as those are rather noisy.

Constructors

Source

Fields

• sourceName :: String

  The reported file-name of the Source.

  When read from file handles, a non-filepath description such as "<stdin>" is typically chosen. This field doesn't have semantic meaning, and should only be used to enrich the output displayed to users.

• sourceText :: Text

  The full source, as Text.

• sourceLineMap :: LineMap

  A mapping of the start position of each line in the Source.

Instances

Eq Source

Defined in ProSource.Source

Methods

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

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

Show Source

Defined in ProSource.Source

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

Generic Source

Defined in ProSource.Source

Associated Types

type Rep Source :: Type -> Type

Methods

from :: Source -> Rep Source x

to :: Rep Source x -> Source

NFData Source

Defined in ProSource.Source

Methods

rnf :: Source -> ()

Hashable Source

Defined in ProSource.Source

Methods

hashWithSalt :: Int -> Source -> Int

hash :: Source -> Int

Pretty Source

Defined in ProSource.Source

Methods

pretty :: Source -> Doc ann

prettyList :: [Source] -> Doc ann

type Rep Source

Defined in ProSource.Source

type Rep Source = D1 ('MetaData "Source" "ProSource.Source" "pro-source-0.1.0.0-Aka5hIIzvNFHIHVEFICznz" 'False) (C1 ('MetaCons "Source" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String) :*: (S1 ('MetaSel ('Just "sourceText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceLineMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LineMap))))

makeSource :: String -> LText -> Source

Create a Source from a descriptive name and a body. The source name is typically a FilePath, but this is not guaranteed. For instance, when read from standard-input, a common choice is to name the source <stdin>.

getSourceLine :: Line -> Source -> Maybe Text

Fetch a single line from a source.

getLocation :: Offset -> Source -> Maybe Location

Convert an Offset into a Location.

Location

data Location

A location in a Source, with the line and column number computed lazily.

Constructors

Location

Fields

• locationSource :: Source

  The Source this location references.

• locationOffset :: Offset

  The position in the Source, counted by Unicode codepoints.

• locationLine :: ~Line

  The line number in the Source.

• locationColumn :: ~Column

  The column number in the Source.

Instances

Eq Location

Defined in ProSource.Location

Methods

(==) :: Location -> Location -> Bool

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

Show Location

Defined in ProSource.Location

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

Generic Location

Defined in ProSource.Location

Associated Types

type Rep Location :: Type -> Type

Methods

from :: Location -> Rep Location x

to :: Rep Location x -> Location

NFData Location

Defined in ProSource.Location

Methods

rnf :: Location -> ()

Hashable Location

Defined in ProSource.Location

Methods

hashWithSalt :: Int -> Location -> Int

hash :: Location -> Int

Pretty Location

Defined in ProSource.Location

Methods

pretty :: Location -> Doc ann

prettyList :: [Location] -> Doc ann

HasLocation Location

Defined in ProSource.HasLocation

Methods

location :: AffineTraversal' Location Location

type Rep Location

Defined in ProSource.Location

type Rep Location = D1 ('MetaData "Location" "ProSource.Location" "pro-source-0.1.0.0-Aka5hIIzvNFHIHVEFICznz" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locationSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Source) :*: S1 ('MetaSel ('Just "locationOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset)) :*: (S1 ('MetaSel ('Just "locationLine") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Line) :*: S1 ('MetaSel ('Just "locationColumn") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Column))))

data SparseLocation

A location in a Source. The line and column numbers of this type are not attached to this type; convert to a Location to access those values.

Constructors

SparseLocation

Fields

• sparseLocationSource :: Source

  The Source this location references.

• sparseLocationOffset :: Offset

  The position in the Source, counted by Unicode codepoints.

Instances

Eq SparseLocation

Defined in ProSource.SparseLocation

Methods

(==) :: SparseLocation -> SparseLocation -> Bool

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

Show SparseLocation

Defined in ProSource.SparseLocation

Methods

showsPrec :: Int -> SparseLocation -> ShowS

show :: SparseLocation -> String

showList :: [SparseLocation] -> ShowS

Generic SparseLocation

Defined in ProSource.SparseLocation

Associated Types

type Rep SparseLocation :: Type -> Type

Methods

from :: SparseLocation -> Rep SparseLocation x

to :: Rep SparseLocation x -> SparseLocation

NFData SparseLocation

Defined in ProSource.SparseLocation

Methods

rnf :: SparseLocation -> ()

Hashable SparseLocation

Defined in ProSource.SparseLocation

Methods

hashWithSalt :: Int -> SparseLocation -> Int

hash :: SparseLocation -> Int

type Rep SparseLocation

Defined in ProSource.SparseLocation

type Rep SparseLocation = D1 ('MetaData "SparseLocation" "ProSource.SparseLocation" "pro-source-0.1.0.0-Aka5hIIzvNFHIHVEFICznz" 'False) (C1 ('MetaCons "SparseLocation" 'PrefixI 'True) (S1 ('MetaSel ('Just "sparseLocationSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Source) :*: S1 ('MetaSel ('Just "sparseLocationOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset)))

enrichLocation :: SparseLocation -> Location

Add lazily computed line and column number information to a SparseLocation.

stripLocation :: Location -> SparseLocation

Remove line and column number information from a Location.

sparse :: Iso' Location SparseLocation

An isomorphism between Location and SparseLocation. This is allowed because although a Location has strictly more data than a SparseLocation, those values are denormalizations of values within SparseLocation.

Units

newtype Offset

An offset into a Source, counted by UTF-8 codepoint.

Constructors

Offset Word

Instances

Enum Offset

Defined in ProSource.Offset

Methods

succ :: Offset -> Offset

pred :: Offset -> Offset

toEnum :: Int -> Offset

fromEnum :: Offset -> Int

enumFrom :: Offset -> [Offset]

enumFromThen :: Offset -> Offset -> [Offset]

enumFromTo :: Offset -> Offset -> [Offset]

enumFromThenTo :: Offset -> Offset -> Offset -> [Offset]

Eq Offset

Defined in ProSource.Offset

Methods

(==) :: Offset -> Offset -> Bool

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

Ord Offset

Defined in ProSource.Offset

Methods

compare :: Offset -> Offset -> Ordering

(<) :: Offset -> Offset -> Bool

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

(>) :: Offset -> Offset -> Bool

(>=) :: Offset -> Offset -> Bool

max :: Offset -> Offset -> Offset

min :: Offset -> Offset -> Offset

Show Offset

Defined in ProSource.Offset

Methods

showsPrec :: Int -> Offset -> ShowS

show :: Offset -> String

showList :: [Offset] -> ShowS

Generic Offset

Defined in ProSource.Offset

Associated Types

type Rep Offset :: Type -> Type

Methods

from :: Offset -> Rep Offset x

to :: Rep Offset x -> Offset

NFData Offset

Defined in ProSource.Offset

Methods

rnf :: Offset -> ()

Hashable Offset

Defined in ProSource.Offset

Methods

hashWithSalt :: Int -> Offset -> Int

hash :: Offset -> Int

Pretty Offset

Defined in ProSource.Offset

Methods

pretty :: Offset -> Doc ann

prettyList :: [Offset] -> Doc ann

Unbox Offset

Defined in ProSource.Offset

Vector Vector Offset

Defined in ProSource.Offset

Methods

basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) Offset -> m (Vector Offset)

basicUnsafeThaw :: PrimMonad m => Vector Offset -> m (Mutable Vector (PrimState m) Offset)

basicLength :: Vector Offset -> Int

basicUnsafeSlice :: Int -> Int -> Vector Offset -> Vector Offset

basicUnsafeIndexM :: Monad m => Vector Offset -> Int -> m Offset

basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) Offset -> Vector Offset -> m ()

elemseq :: Vector Offset -> Offset -> b -> b

MVector MVector Offset

Defined in ProSource.Offset

Methods

basicLength :: MVector s Offset -> Int

basicUnsafeSlice :: Int -> Int -> MVector s Offset -> MVector s Offset

basicOverlaps :: MVector s Offset -> MVector s Offset -> Bool

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) Offset)

basicInitialize :: PrimMonad m => MVector (PrimState m) Offset -> m ()

basicUnsafeReplicate :: PrimMonad m => Int -> Offset -> m (MVector (PrimState m) Offset)

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) Offset -> Int -> m Offset

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) Offset -> Int -> Offset -> m ()

basicClear :: PrimMonad m => MVector (PrimState m) Offset -> m ()

basicSet :: PrimMonad m => MVector (PrimState m) Offset -> Offset -> m ()

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) Offset -> MVector (PrimState m) Offset -> m ()

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) Offset -> MVector (PrimState m) Offset -> m ()

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) Offset -> Int -> m (MVector (PrimState m) Offset)

type Rep Offset

Defined in ProSource.Offset

type Rep Offset = D1 ('MetaData "Offset" "ProSource.Offset" "pro-source-0.1.0.0-Aka5hIIzvNFHIHVEFICznz" 'True) (C1 ('MetaCons "Offset" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

newtype Vector Offset

Defined in ProSource.Offset

newtype Vector Offset = V_Offset (Vector Word)

newtype MVector s Offset

Defined in ProSource.Offset

newtype MVector s Offset = MV_Offset (MVector s Word)

newtype Line

A line number.

The Show instance for Line counts from one, while the internal implementation counts from zero.

Constructors

Line Word

Instances

Enum Line

Defined in ProSource.Line

Methods

succ :: Line -> Line

pred :: Line -> Line

toEnum :: Int -> Line

fromEnum :: Line -> Int

enumFrom :: Line -> [Line]

enumFromThen :: Line -> Line -> [Line]

enumFromTo :: Line -> Line -> [Line]

enumFromThenTo :: Line -> Line -> Line -> [Line]

Eq Line

Defined in ProSource.Line

Methods

(==) :: Line -> Line -> Bool

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

Ord Line

Defined in ProSource.Line

Methods

compare :: Line -> Line -> Ordering

(<) :: Line -> Line -> Bool

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

(>) :: Line -> Line -> Bool

(>=) :: Line -> Line -> Bool

max :: Line -> Line -> Line

min :: Line -> Line -> Line

Show Line

Defined in ProSource.Line

Methods

showsPrec :: Int -> Line -> ShowS

show :: Line -> String

showList :: [Line] -> ShowS

Generic Line

Defined in ProSource.Line

Associated Types

type Rep Line :: Type -> Type

Methods

from :: Line -> Rep Line x

to :: Rep Line x -> Line

NFData Line

Defined in ProSource.Line

Methods

rnf :: Line -> ()

Hashable Line

Defined in ProSource.Line

Methods

hashWithSalt :: Int -> Line -> Int

hash :: Line -> Int

Pretty Line

Defined in ProSource.Line

Methods

pretty :: Line -> Doc ann

prettyList :: [Line] -> Doc ann

type Rep Line

Defined in ProSource.Line

type Rep Line = D1 ('MetaData "Line" "ProSource.Line" "pro-source-0.1.0.0-Aka5hIIzvNFHIHVEFICznz" 'True) (C1 ('MetaCons "Line" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

newtype Column

A column number.

Constructors

Column Word

Instances

Enum Column

Defined in ProSource.Column

Methods

succ :: Column -> Column

pred :: Column -> Column

toEnum :: Int -> Column

fromEnum :: Column -> Int

enumFrom :: Column -> [Column]

enumFromThen :: Column -> Column -> [Column]

enumFromTo :: Column -> Column -> [Column]

enumFromThenTo :: Column -> Column -> Column -> [Column]

Eq Column

Defined in ProSource.Column

Methods

(==) :: Column -> Column -> Bool

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

Ord Column

Defined in ProSource.Column

Methods

compare :: Column -> Column -> Ordering

(<) :: Column -> Column -> Bool

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

(>) :: Column -> Column -> Bool

(>=) :: Column -> Column -> Bool

max :: Column -> Column -> Column

min :: Column -> Column -> Column

Show Column

Defined in ProSource.Column

Methods

showsPrec :: Int -> Column -> ShowS

show :: Column -> String

showList :: [Column] -> ShowS

Generic Column

Defined in ProSource.Column

Associated Types

type Rep Column :: Type -> Type

Methods

from :: Column -> Rep Column x

to :: Rep Column x -> Column

NFData Column

Defined in ProSource.Column

Methods

rnf :: Column -> ()

Hashable Column

Defined in ProSource.Column

Methods

hashWithSalt :: Int -> Column -> Int

hash :: Column -> Int

Pretty Column

Defined in ProSource.Column

Methods

pretty :: Column -> Doc ann

prettyList :: [Column] -> Doc ann

type Rep Column

Defined in ProSource.Column

type Rep Column = D1 ('MetaData "Column" "ProSource.Column" "pro-source-0.1.0.0-Aka5hIIzvNFHIHVEFICznz" 'True) (C1 ('MetaCons "Column" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

Line map

data LineMap

A dense vector containing offsets poiting to the start of each line. That is, the starting position of the third line of a file can be found at position 2.

Instances

Eq LineMap

Defined in ProSource.LineMap

Methods

(==) :: LineMap -> LineMap -> Bool

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

Show LineMap

Defined in ProSource.LineMap

Methods

showsPrec :: Int -> LineMap -> ShowS

show :: LineMap -> String

showList :: [LineMap] -> ShowS

Generic LineMap

Defined in ProSource.LineMap

Associated Types

type Rep LineMap :: Type -> Type

Methods

from :: LineMap -> Rep LineMap x

to :: Rep LineMap x -> LineMap

NFData LineMap

Defined in ProSource.LineMap

Methods

rnf :: LineMap -> ()

Hashable LineMap

Defined in ProSource.LineMap

Methods

hashWithSalt :: Int -> LineMap -> Int

hash :: LineMap -> Int

type Rep LineMap

Defined in ProSource.LineMap

type Rep LineMap = D1 ('MetaData "LineMap" "ProSource.LineMap" "pro-source-0.1.0.0-Aka5hIIzvNFHIHVEFICznz" 'True) (C1 ('MetaCons "LineMap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Offset))))

lineOffsets :: LineMap -> [Offset]

Convert a LineMap into a list of Offsets, corresponding to the first character of a line. Note that the initial offset is omitted-- the offset at index 0 will be the offset of the second line.

lineToOffset :: Line -> LineMap -> Maybe Offset

Fetch the Offset for the given Line. Evaluates to Nothing if the given Line does not appear in the LineMap

offsetToLine :: Offset -> LineMap -> Line

Fetch the Line number for a given Offset. Newlines will be attributed the line that they terminate, rather than the line started immediately afterwards.

Polymorphic Location optics

class HasLocation t where

A classy optic for selecting the Location from a value. Note that location is affine: a Location can't be attached to a value which does not -- already have one, and not all values with an instance of HasLocation have a location.

Methods

location :: AffineTraversal' t Location

Instances

HasLocation Location

Defined in ProSource.HasLocation

Methods

location :: AffineTraversal' Location Location

offset :: HasLocation l => AffineTraversal' l Offset

Focus on the Offset from a value parsed from a source file. If the Offset is modified, note that the resulting column and line will also be modified as they are denormalizations of this value.

column :: HasLocation l => AffineFold l Column

Fetch the Column from a value parsed from a source file. Modifications are not allowed as the offset and line may become inconsistent.

line :: HasLocation l => AffineFold l Line

Fetch the Line from a value parsed from a source file. Modifications are not allowed as the offset and column may become inconsistent.

source :: HasLocation l => AffineFold l Source

Fetch the Source a value was parsed from. Modifications are not allowed as the line, offset, and column may become inconsistent.