Prosidy.Optics.Source

Classy optics; implementable on all types with a location

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 :: Affine' t Location

Instances

HasLocation Location

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Location Location

HasLocation Paragraph

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Paragraph Location

HasLocation Inline

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Inline Location

HasLocation Fragment

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Fragment Location

HasLocation Block

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Block Location

HasLocation (Tag a)

Defined in Prosidy.Optics.Source

Methods

location :: Affine' (Tag a) Location

HasLocation (Region a)

Defined in Prosidy.Optics.Source

Methods

location :: Affine' (Region a) Location

offset :: HasLocation l => Affine' 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.

Read-only optics.

column :: (HasLocation l, Contravariant f, Applicative f) => Optic' (->) f 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, Contravariant f, Applicative f) => Optic' (->) f 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, Contravariant f, Applicative f) => Optic' (->) f l Source

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

Conversion utilities

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.