Bricks.Source

Source information is some form of description of where a Bricks expression or term came from. This information is used to tag Expressions and Terms so that our error messages can tell the user what parts of the Bricks source code are relevant to the problem.

Overview of the types involved:

• SourcePosition - a line and column number
• SourceRange - a pair of SourcePositions indicating the start and end of some expression
• SourceName - a description of where the top-level expression was parsed from, such as a file path or a part of a REPL session.
• '()' can be used as the source information type in cases where we do not actually care to retain any source information.

Documentation

data SourcePosition

An endpoint of a SourceRange.

Constructors

SourcePosition

Fields

• sourcePosition'line :: Natural
• sourcePosition'column :: Natural

Instances

Eq SourcePosition

Methods

(==) :: SourcePosition -> SourcePosition -> Bool

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

Ord SourcePosition

Methods

compare :: SourcePosition -> SourcePosition -> Ordering

(<) :: SourcePosition -> SourcePosition -> Bool

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

(>) :: SourcePosition -> SourcePosition -> Bool

(>=) :: SourcePosition -> SourcePosition -> Bool

max :: SourcePosition -> SourcePosition -> SourcePosition

min :: SourcePosition -> SourcePosition -> SourcePosition

Show SourcePosition

Methods

showsPrec :: Int -> SourcePosition -> ShowS

show :: SourcePosition -> String

showList :: [SourcePosition] -> ShowS

show'sourcePosition :: SourcePosition -> Text

data SourceRange

Start and end points for a span of text. When we parse text into an Expression, we annotate it with source ranges so error messages that refer to specific expressions can tell the user where in their Bricks code those expressions are defined.

Constructors

SourceRange

Fields

• sourceRange'start :: SourcePosition
• sourceRange'end :: SourcePosition

Instances

Show SourceRange

Methods

showsPrec :: Int -> SourceRange -> ShowS

show :: SourceRange -> String

showList :: [SourceRange] -> ShowS

Semigroup SourceRange

Methods

(<>) :: SourceRange -> SourceRange -> SourceRange

sconcat :: NonEmpty SourceRange -> SourceRange

stimes :: Integral b => b -> SourceRange -> SourceRange

show'sourceRange :: SourceRange -> Text

sourceRange'join :: SourceRange -> SourceRange -> SourceRange

sourceRangeMaybe'join :: Maybe SourceRange -> Maybe SourceRange -> Maybe SourceRange

newtype SourceName a

Constructors

SourceName a