Prosidy.Source

Documentation

data Source

Information about Prosidy 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 Prosidy.Source

Methods

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

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

Show Source

Defined in Prosidy.Source

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

Generic Source

Defined in Prosidy.Source

Associated Types

type Rep Source :: Type -> Type

Methods

from :: Source -> Rep Source x

to :: Rep Source x -> Source

Hashable Source

Defined in Prosidy.Source

Methods

hashWithSalt :: Int -> Source -> Int

hash :: Source -> Int

Binary Source

Defined in Prosidy.Source

Methods

put :: Source -> Put

get :: Get Source

putList :: [Source] -> Put

NFData Source

Defined in Prosidy.Source

Methods

rnf :: Source -> ()

type Rep Source

Defined in Prosidy.Source

type Rep Source = D1 ('MetaData "Source" "Prosidy.Source" "prosidy-1.5.0.1-inplace" '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))))

data Location

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

Instances

Eq Location

Defined in Prosidy.Source

Methods

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

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

Show Location

Defined in Prosidy.Source

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

Generic Location

Defined in Prosidy.Source

Associated Types

type Rep Location :: Type -> Type

Methods

from :: Location -> Rep Location x

to :: Rep Location x -> Location

Hashable Location

Defined in Prosidy.Source

Methods

hashWithSalt :: Int -> Location -> Int

hash :: Location -> Int

Binary Location

Defined in Prosidy.Source

Methods

put :: Location -> Put

get :: Get Location

putList :: [Location] -> Put

NFData Location

Defined in Prosidy.Source

Methods

rnf :: Location -> ()

HasLocation Location

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Location Location

type Rep Location

Defined in Prosidy.Source

type Rep Location = D1 ('MetaData "Location" "Prosidy.Source" "prosidy-1.5.0.1-inplace" '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 Prosidy.Source

Methods

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

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

Show SparseLocation

Defined in Prosidy.Source

Methods

showsPrec :: Int -> SparseLocation -> ShowS

show :: SparseLocation -> String

showList :: [SparseLocation] -> ShowS

Generic SparseLocation

Defined in Prosidy.Source

Associated Types

type Rep SparseLocation :: Type -> Type

Methods

from :: SparseLocation -> Rep SparseLocation x

to :: Rep SparseLocation x -> SparseLocation

Hashable SparseLocation

Defined in Prosidy.Source

Methods

hashWithSalt :: Int -> SparseLocation -> Int

hash :: SparseLocation -> Int

Binary SparseLocation

Defined in Prosidy.Source

Methods

put :: SparseLocation -> Put

get :: Get SparseLocation

putList :: [SparseLocation] -> Put

NFData SparseLocation

Defined in Prosidy.Source

Methods

rnf :: SparseLocation -> ()

type Rep SparseLocation

Defined in Prosidy.Source

type Rep SparseLocation = D1 ('MetaData "SparseLocation" "Prosidy.Source" "prosidy-1.5.0.1-inplace" 'False) (C1 ('MetaCons "SparseLocation" 'PrefixI 'True) (S1 ('MetaSel ('Just "sparseLocationSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Source) :*: S1 ('MetaSel ('Just "sparseLocationOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset)))

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 Prosidy.Source

Methods

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

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

Show LineMap

Defined in Prosidy.Source

Methods

showsPrec :: Int -> LineMap -> ShowS

show :: LineMap -> String

showList :: [LineMap] -> ShowS

Generic LineMap

Defined in Prosidy.Source

Associated Types

type Rep LineMap :: Type -> Type

Methods

from :: LineMap -> Rep LineMap x

to :: Rep LineMap x -> LineMap

Hashable LineMap

Defined in Prosidy.Source

Methods

hashWithSalt :: Int -> LineMap -> Int

hash :: LineMap -> Int

Binary LineMap

Defined in Prosidy.Source

Methods

put :: LineMap -> Put

get :: Get LineMap

putList :: [LineMap] -> Put

NFData LineMap

Defined in Prosidy.Source

Methods

rnf :: LineMap -> ()

type Rep LineMap

Defined in Prosidy.Source

type Rep LineMap = D1 ('MetaData "LineMap" "Prosidy.Source" "prosidy-1.5.0.1-inplace" 'True) (C1 ('MetaCons "LineMap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Offset))))

newtype Offset

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

Constructors

Offset Word

Instances

Enum Offset

Defined in Prosidy.Source

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 Prosidy.Source

Methods

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

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

Ord Offset

Defined in Prosidy.Source

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 Prosidy.Source

Methods

showsPrec :: Int -> Offset -> ShowS

show :: Offset -> String

showList :: [Offset] -> ShowS

Generic Offset

Defined in Prosidy.Source

Associated Types

type Rep Offset :: Type -> Type

Methods

from :: Offset -> Rep Offset x

to :: Rep Offset x -> Offset

Hashable Offset

Defined in Prosidy.Source

Methods

hashWithSalt :: Int -> Offset -> Int

hash :: Offset -> Int

ToJSON Offset

Defined in Prosidy.Source

Methods

toJSON :: Offset -> Value

toEncoding :: Offset -> Encoding

toJSONList :: [Offset] -> Value

toEncodingList :: [Offset] -> Encoding

FromJSON Offset

Defined in Prosidy.Source

Methods

parseJSON :: Value -> Parser Offset

parseJSONList :: Value -> Parser [Offset]

Binary Offset

Defined in Prosidy.Source

Methods

put :: Offset -> Put

get :: Get Offset

putList :: [Offset] -> Put

NFData Offset

Defined in Prosidy.Source

Methods

rnf :: Offset -> ()

Unbox Offset

Defined in Prosidy.Source

Vector Vector Offset

Defined in Prosidy.Source

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 Prosidy.Source

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 Prosidy.Source

type Rep Offset = D1 ('MetaData "Offset" "Prosidy.Source" "prosidy-1.5.0.1-inplace" 'True) (C1 ('MetaCons "Offset" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

newtype Vector Offset

Defined in Prosidy.Source

newtype Vector Offset = V_Offset (Vector Word)

newtype MVector s Offset

Defined in Prosidy.Source

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 Prosidy.Source

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 Prosidy.Source

Methods

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

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

Ord Line

Defined in Prosidy.Source

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 Prosidy.Source

Methods

showsPrec :: Int -> Line -> ShowS

show :: Line -> String

showList :: [Line] -> ShowS

Generic Line

Defined in Prosidy.Source

Associated Types

type Rep Line :: Type -> Type

Methods

from :: Line -> Rep Line x

to :: Rep Line x -> Line

Hashable Line

Defined in Prosidy.Source

Methods

hashWithSalt :: Int -> Line -> Int

hash :: Line -> Int

ToJSON Line

Defined in Prosidy.Source

Methods

toJSON :: Line -> Value

toEncoding :: Line -> Encoding

toJSONList :: [Line] -> Value

toEncodingList :: [Line] -> Encoding

FromJSON Line

Defined in Prosidy.Source

Methods

parseJSON :: Value -> Parser Line

parseJSONList :: Value -> Parser [Line]

Binary Line

Defined in Prosidy.Source

Methods

put :: Line -> Put

get :: Get Line

putList :: [Line] -> Put

NFData Line

Defined in Prosidy.Source

Methods

rnf :: Line -> ()

type Rep Line

Defined in Prosidy.Source

type Rep Line = D1 ('MetaData "Line" "Prosidy.Source" "prosidy-1.5.0.1-inplace" '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 Prosidy.Source

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 Prosidy.Source

Methods

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

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

Ord Column

Defined in Prosidy.Source

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 Prosidy.Source

Methods

showsPrec :: Int -> Column -> ShowS

show :: Column -> String

showList :: [Column] -> ShowS

Generic Column

Defined in Prosidy.Source

Associated Types

type Rep Column :: Type -> Type

Methods

from :: Column -> Rep Column x

to :: Rep Column x -> Column

Hashable Column

Defined in Prosidy.Source

Methods

hashWithSalt :: Int -> Column -> Int

hash :: Column -> Int

ToJSON Column

Defined in Prosidy.Source

Methods

toJSON :: Column -> Value

toEncoding :: Column -> Encoding

toJSONList :: [Column] -> Value

toEncodingList :: [Column] -> Encoding

FromJSON Column

Defined in Prosidy.Source

Methods

parseJSON :: Value -> Parser Column

parseJSONList :: Value -> Parser [Column]

Binary Column

Defined in Prosidy.Source

Methods

put :: Column -> Put

get :: Get Column

putList :: [Column] -> Put

NFData Column

Defined in Prosidy.Source

Methods

rnf :: Column -> ()

type Rep Column

Defined in Prosidy.Source

type Rep Column = D1 ('MetaData "Column" "Prosidy.Source" "prosidy-1.5.0.1-inplace" 'True) (C1 ('MetaCons "Column" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

locationSource :: Location -> Source

The Source this location references.

locationColumn :: Location -> Column

The column number in the Source.

locationLine :: Location -> Line

The line number in the Source.

locationOffset :: Location -> Offset

The position in the Source, counted by Unicode codepoints.

makeSource :: String -> Text -> Source

Create a Source from a descriptive name and a body. The source name is typically a FilePath, but this is not guarenteed. For instance, when read from standard-input, Prosidy chooses 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.

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.

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.