| Copyright | (c) 2009 Bernie Pope |
|---|---|
| License | BSD-style |
| Maintainer | bjpop@csse.unimelb.edu.au |
| Stability | experimental |
| Portability | ghc |
| Safe Haskell | Safe-Inferred |
| Language | Haskell98 |
Language.Python.Common.SrcLocation
Description
Source location information for the Python lexer and parser. This module provides single-point locations and spans, and conversions between them.
- data SrcLocation
- = Sloc {
- sloc_filename :: !String
- sloc_row :: !Int
- sloc_column :: !Int
- | NoLocation
- = Sloc {
- data SrcSpan
- = SpanCoLinear {
- span_filename :: !String
- span_row :: !Int
- span_start_column :: !Int
- span_end_column :: !Int
- | SpanMultiLine {
- span_filename :: !String
- span_start_row :: !Int
- span_start_column :: !Int
- span_end_row :: !Int
- span_end_column :: !Int
- | SpanPoint {
- span_filename :: !String
- span_row :: !Int
- span_column :: !Int
- | SpanEmpty
- = SpanCoLinear {
- class Span a where
- spanning :: (Span a, Span b) => a -> b -> SrcSpan
- mkSrcSpan :: SrcLocation -> SrcLocation -> SrcSpan
- combineSrcSpans :: SrcSpan -> SrcSpan -> SrcSpan
- initialSrcLocation :: String -> SrcLocation
- spanStartPoint :: SrcSpan -> SrcSpan
- incColumn :: Int -> SrcLocation -> SrcLocation
- decColumn :: Int -> SrcLocation -> SrcLocation
- incLine :: Int -> SrcLocation -> SrcLocation
- incTab :: SrcLocation -> SrcLocation
- endCol :: SrcSpan -> Int
- endRow :: SrcSpan -> Int
- startCol :: SrcSpan -> Int
- startRow :: SrcSpan -> Int
Construction
data SrcLocation Source
A location for a syntactic entity from the source code. The location is specified by its filename, and starting row and column.
Constructors
| Sloc | |
Fields
| |
| NoLocation | |
Source location spanning a contiguous section of a file.
Constructors
| SpanCoLinear | A span which starts and ends on the same line. |
Fields
| |
| SpanMultiLine | A span which starts and ends on different lines. |
Fields
| |
| SpanPoint | A span which is actually just one point in the file. |
Fields
| |
| SpanEmpty | No span information. |
Instances
Types which have a span.
Minimal complete definition
Nothing
Instances
spanning :: (Span a, Span b) => a -> b -> SrcSpan Source
Create a new span which encloses two spanned things.
mkSrcSpan :: SrcLocation -> SrcLocation -> SrcSpan Source
Make a span from two locations. Assumption: either the arguments are the same, or the left one preceeds the right one.
combineSrcSpans :: SrcSpan -> SrcSpan -> SrcSpan Source
Combines two SrcSpan into one that spans at least all the characters
within both spans. Assumes the "file" part is the same in both inputs
initialSrcLocation :: String -> SrcLocation Source
Construct the initial source location for a file.
spanStartPoint :: SrcSpan -> SrcSpan Source
Make a point span from the start of a span
Modification
incColumn :: Int -> SrcLocation -> SrcLocation Source
Increment the column of a location.
decColumn :: Int -> SrcLocation -> SrcLocation Source
Decrement the column of a location, only if they are on the same row.
incLine :: Int -> SrcLocation -> SrcLocation Source
Increment the line number (row) of a location by one.
incTab :: SrcLocation -> SrcLocation Source
Increment the column of a location by one tab stop.